# Incode Developer Hub — full documentation

> Public developer documentation and REST API reference for the Incode Omni identity platform — onboarding, SDKs, and integration guides.

1043 pages. Each block below is one page: a metadata line, then the page's Markdown source. Blocks are separated by `---`.

---

- Path: `api-reference/add-address-statement`
- URL: https://developer.incode.com/api-reference/add-address-statement/
- Markdown: https://developer.incode.com/api-reference/add-address-statement.md
- Endpoint: `POST /omni/add/address-statement`

# Add proof of address

`POST /omni/add/address-statement`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add a proof of address statement as a blob. OCR data from statement will be automatically extracted

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `format` | query | string |  | Enum: `image`, `pdf` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/address-statement?format=%3Cformat%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-address-statement-v2`
- URL: https://developer.incode.com/api-reference/add-address-statement-v2/
- Markdown: https://developer.incode.com/api-reference/add-address-statement-v2.md
- Endpoint: `POST /omni/add/address-statement/v2`

# Add proof of address v2

`POST /omni/add/address-statement/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add a proof of address statement as a base64 string. OCR data from statement will be automatically extracted

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `format` | query | string |  | Enum: `image`, `pdf` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Base64 string representation of the image |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E", headers=headers, json={
  "base64Image": "<base64Image>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/address-statement/v2?format=%3Cformat%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-back-id-v2`
- URL: https://developer.incode.com/api-reference/add-back-id-v2/
- Markdown: https://developer.incode.com/api-reference/add-back-id-v2.md
- Endpoint: `POST /omni/add/back-id/v2`

# Add back side of ID

`POST /omni/add/back-id/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for storing back side of id for further processing. Image quality check is performed during that call.
Number of retries is not limited.

Once [process-id](/api-reference/process-id/) is finished, this endpoint cannot be called for retries.

**Note**: Front-side of id should be uploaded before back side.

In case of passport or only front sided documents, this endpoint should not be called.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `retry` | query | boolean |  | Flag stating that this is retry attempt for add/back-id Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

In case there's some issue when calling the endpoint due to classification failed, an issue such as bad quality, or any of the fail reasons the response will always have the field: - classification - failReason - sharpness - glare - horizontalResolution We recommend considering the call as failed if there's a failReason in the response or if the classification is false. Possible values for fail reason: - UNKNOWN_DOCUMENT_TYPE: document classification failed - WRONG_DOCUMENT_SIDE: can happen when uploading back side of id when front id is required or the other way around - WRONG_ONE_SIDED_DOCUMENT: uploading wrong document with only one side - WRONG_UNFOLDED_DOCUMENT: uploading unfolded document with unrecognizable sides - UNFOLDED_DOCUMENT_PAGE_MISMATCH: uploading unfolded document with mismatching sides - DOCUMENT_NOT_READABLE: document couldn't be read, probably due to image quality - UNABLE_TO_ALIGN_DOCUMENT: alignment failed - ID_TYPE_UNACCEPTABLE: invalid type of id - UNEXPECTED_ERROR_OCCURRED: unexpected error Whenever the classification is done successfully the fields that will always be present are: - classification - sharpness - glare - horizontalResolution - readibility - typeOfId - sessionStatus The remaining fields could be optional depending on the specific type of id and country of origin.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `correctSharpness` | boolean |  | It's true if the sharpness of the ID meets the requirements. |
| `correctGlare` | boolean |  | It's true if the glare of the ID meets the requirements. |
| `horizontalResolution` | integer (int32) |  | Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155. |
| `shadowConfidence` | number (float) |  | Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1. |
| `classification` | boolean |  | If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored. |
| `readability` | boolean |  | If true, server can properly read ID. If false server failed to read some key places of the ID. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `issueYear` | integer (int32) |  | Issue year of the ID. |
| `issueName` | string |  | Description of the ID. Could contain country code, state, type of ID, subtype of ID. |
| `curpCheck` | boolean |  | Only for Mexican IDs. Flag stating if curp was properly read. |
| `sessionStatus` | string |  | Session Status Enum: `Alive`, `Closed`, `Deleted` |
| `countryCode` | string |  | Valid ISO alpha-2 or alpha-3 code of the ID issuing country. |
| `state` | string |  | Issuing state of the ID. |
| `failReason` | string |  | Classification fail reason Enum: `UNKNOWN_DOCUMENT_TYPE`, `WRONG_DOCUMENT_SIDE`, `WRONG_ONE_SIDED_DOCUMENT`, `UNFOLDED_DOCUMENT_PAGE_MISMATCH`, `WRONG_UNFOLDED_DOCUMENT`, `DOCUMENT_NOT_READABLE`, `UNABLE_TO_ALIGN_DOCUMENT`, `ID_TYPE_UNACCEPTABLE`, `UNEXPECTED_ERROR_OCCURRED`, `DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED` |
| `skipBackIdCapture` | boolean |  | Flag that signals if back id capture should be skipped or not. |
| `forceFrontIdCapture` | boolean |  | Flag that signals if front id capture must be executed after back. |
| `showMandatoryConsent` | boolean |  | Render mandatory consent page based on this parameter value. |
| `regulationType` | string |  | Regulation type for the mandatory consent (only if showMandatoryConsent set to true). |
| `skipGlareFront` | boolean |  | Flag that signals if front side glare should be ignored. |
| `skipGlareBack` | boolean |  | Flag that signals if back side glare should be ignored. |
| `documentIsOnTheEdge` | boolean |  | Flag that signals if document is on the edge on the full frame image. |
| `acceptedDocuments` | array[string] |  | List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason. Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `imageRedacted` | boolean |  | Flag that signals if image was redacted as part of the ID capture. |
| `idFaceExtractionSkipped` | boolean |  | True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted). |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `idQualityAttemptApproved` | boolean |  | ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.9, false otherwise. |
| `isDocumentExpired` | boolean |  | Flag indicating if the document side is expired. |
| `attemptId` | string |  | Created attempt id. |

### 400

Custom error statuses: - 4004: Could not find user - 5003: Unsatisfied image size - 4092: Image format is unsupported or the image is unreadable

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 503

Image conversion temporarily unavailable; retry after the Retry-After header

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/back-id/v2?retry=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "correctSharpness": true,
  "correctGlare": true,
  "horizontalResolution": 0,
  "shadowConfidence": 0,
  "classification": true,
  "readability": true,
  "typeOfId": "Unknown",
  "issueYear": 0,
  "issueName": "string",
  "curpCheck": true,
  "sessionStatus": "Alive",
  "countryCode": "string",
  "state": "string",
  "failReason": "UNKNOWN_DOCUMENT_TYPE",
  "skipBackIdCapture": true,
  "forceFrontIdCapture": true,
  "showMandatoryConsent": true,
  "regulationType": "string",
  "skipGlareFront": true,
  "skipGlareBack": true,
  "documentIsOnTheEdge": true,
  "acceptedDocuments": [
    "Unknown"
  ],
  "imageRedacted": true,
  "idFaceExtractionSkipped": true,
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "idQualityAttemptApproved": true,
  "isDocumentExpired": true,
  "attemptId": "string"
}
```

---

- Path: `api-reference/add-back-second-id-v2`
- URL: https://developer.incode.com/api-reference/add-back-second-id-v2/
- Markdown: https://developer.incode.com/api-reference/add-back-second-id-v2.md
- Endpoint: `POST /omni/add/back-second-id/v2`

# Add back side of Second ID

`POST /omni/add/back-second-id/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Image quality check is performed during that call. Number of retries is not limited. Once id processing is finished,
this endpoint cannot be called for retries. Front side of id should be uploaded before back side. In case of passport,
this endpoint should not be called.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `captureType` | query | string |  | Enum: `AUTO`, `MANUAL`, `NATIVE`, `UPLOAD` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `correctSharpness` | boolean |  | It's true if the sharpness of the ID meets the requirements. |
| `correctGlare` | boolean |  | It's true if the glare of the ID meets the requirements. |
| `horizontalResolution` | integer (int32) |  | Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155. |
| `shadowConfidence` | number (float) |  | Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1. |
| `classification` | boolean |  | If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored. |
| `readability` | boolean |  | If true, server can properly read ID. If false server failed to read some key places of the ID. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `issueYear` | integer (int32) |  | Issue year of the ID. |
| `issueName` | string |  | Description of the ID. Could contain country code, state, type of ID, subtype of ID. |
| `curpCheck` | boolean |  | Only for Mexican IDs. Flag stating if curp was properly read. |
| `sessionStatus` | string |  | Session Status Enum: `Alive`, `Closed`, `Deleted` |
| `countryCode` | string |  | Valid ISO alpha-2 or alpha-3 code of the ID issuing country. |
| `state` | string |  | Issuing state of the ID. |
| `failReason` | string |  | Classification fail reason Enum: `UNKNOWN_DOCUMENT_TYPE`, `WRONG_DOCUMENT_SIDE`, `WRONG_ONE_SIDED_DOCUMENT`, `UNFOLDED_DOCUMENT_PAGE_MISMATCH`, `WRONG_UNFOLDED_DOCUMENT`, `DOCUMENT_NOT_READABLE`, `UNABLE_TO_ALIGN_DOCUMENT`, `ID_TYPE_UNACCEPTABLE`, `UNEXPECTED_ERROR_OCCURRED`, `DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED` |
| `skipBackIdCapture` | boolean |  | Flag that signals if back id capture should be skipped or not. |
| `forceFrontIdCapture` | boolean |  | Flag that signals if front id capture must be executed after back. |
| `showMandatoryConsent` | boolean |  | Render mandatory consent page based on this parameter value. |
| `regulationType` | string |  | Regulation type for the mandatory consent (only if showMandatoryConsent set to true). |
| `skipGlareFront` | boolean |  | Flag that signals if front side glare should be ignored. |
| `skipGlareBack` | boolean |  | Flag that signals if back side glare should be ignored. |
| `documentIsOnTheEdge` | boolean |  | Flag that signals if document is on the edge on the full frame image. |
| `acceptedDocuments` | array[string] |  | List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason. Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `imageRedacted` | boolean |  | Flag that signals if image was redacted as part of the ID capture. |
| `idFaceExtractionSkipped` | boolean |  | True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted). |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `idQualityAttemptApproved` | boolean |  | ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.9, false otherwise. |
| `isDocumentExpired` | boolean |  | Flag indicating if the document side is expired. |
| `attemptId` | string |  | Created attempt id. |

### 400

Custom error statuses: - 4092: Image format is unsupported or the image is unreadable

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 503

Image conversion temporarily unavailable; retry after the Retry-After header

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/back-second-id/v2?captureType=%3CcaptureType%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "correctSharpness": true,
  "correctGlare": true,
  "horizontalResolution": 0,
  "shadowConfidence": 0,
  "classification": true,
  "readability": true,
  "typeOfId": "Unknown",
  "issueYear": 0,
  "issueName": "string",
  "curpCheck": true,
  "sessionStatus": "Alive",
  "countryCode": "string",
  "state": "string",
  "failReason": "UNKNOWN_DOCUMENT_TYPE",
  "skipBackIdCapture": true,
  "forceFrontIdCapture": true,
  "showMandatoryConsent": true,
  "regulationType": "string",
  "skipGlareFront": true,
  "skipGlareBack": true,
  "documentIsOnTheEdge": true,
  "acceptedDocuments": [
    "Unknown"
  ],
  "imageRedacted": true,
  "idFaceExtractionSkipped": true,
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "idQualityAttemptApproved": true,
  "isDocumentExpired": true,
  "attemptId": "string"
}
```

---

- Path: `api-reference/add-barcode`
- URL: https://developer.incode.com/api-reference/add-barcode/
- Markdown: https://developer.incode.com/api-reference/add-barcode.md
- Endpoint: `POST /omni/add/barcode`

# Add Barcode

`POST /omni/add/barcode`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add raw barcode and parse it to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `rawBarcode` | string |  | Barcode in raw format |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/barcode \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/barcode", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/barcode", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/barcode"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/barcode")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/barcode");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-barcode-v2`
- URL: https://developer.incode.com/api-reference/add-barcode-v2/
- Markdown: https://developer.incode.com/api-reference/add-barcode-v2.md
- Endpoint: `POST /omni/add/barcode/v2`

# Add Base64 Barcode

`POST /omni/add/barcode/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add Base64 barcode and parse it to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Barcode` | string |  | Barcode in base64 format. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/barcode/v2 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/barcode/v2", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/barcode/v2", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/barcode/v2"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/barcode/v2")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/barcode/v2");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-barcode-v3`
- URL: https://developer.incode.com/api-reference/add-barcode-v3/
- Markdown: https://developer.incode.com/api-reference/add-barcode-v3.md
- Endpoint: `POST /omni/add/barcode/v3`

# Add Base64 Barcode

`POST /omni/add/barcode/v3`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add Base64 barcode and parse it to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `processId` | query | boolean |  | Flag stating if id validation should be automatically performed Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Barcode` | string |  | Barcode in base64 format. |

## Responses

### 200

Response: - forceFrontIdCapture: Boolean. Flag that signals if front id capture must be executed after barcode being added. - sessionStatus: SessionStatus. Session status

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `countryCode` | string |  | Valid ISO alpha-2 or alpha-3 code of the barcode issuing country. |
| `forceFrontIdCapture` | boolean |  | Flag that signals if front id capture must be executed after barcode being added. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `idValidationCompleted` | boolean |  | Flag that indicates whether ID validation has been completed. |
| `isDocumentExpired` | boolean |  | Flag indicating if the document is expired. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/barcode/v3?processId=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "countryCode": "string",
  "forceFrontIdCapture": true,
  "sessionStatus": "Alive",
  "idValidationCompleted": true,
  "isDocumentExpired": true
}
```

---

- Path: `api-reference/add-conference-consent`
- URL: https://developer.incode.com/api-reference/add-conference-consent/
- Markdown: https://developer.incode.com/api-reference/add-conference-consent.md
- Endpoint: `POST /omni/add/conference-consent`

# Save user consent

`POST /omni/add/conference-consent`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Save information indicating that user has accepted terms and conditions and other checks on conference.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes | ID of interview for which consent needs to be given. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conferenceTermAndConditionsAccepted` | boolean |  | User accepts terms and conditions. |
| `creditBureauConsentGiven` | boolean |  | User accepts credit bureau check. |
| `applicantDataConfirmed` | boolean |  | Executive has verified user data. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/conference-consent?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-conference-feedback`
- URL: https://developer.incode.com/api-reference/add-conference-feedback/
- Markdown: https://developer.incode.com/api-reference/add-conference-feedback.md
- Endpoint: `POST /omni/add/conference/feedback`

# Add conference feedback

`POST /omni/add/conference/feedback`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for adding conference feedback for the interview/session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `feedback` | string |  | Feedback to save |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/conference/feedback?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-conference-module`
- URL: https://developer.incode.com/api-reference/add-conference-module/
- Markdown: https://developer.incode.com/api-reference/add-conference-module.md
- Endpoint: `POST /omni/add/conference-module`

# Add conference module

`POST /omni/add/conference-module`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add conference module with name, url and icon (base64).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  |  |
| `url` | string |  |  |
| `iconBase64` | string |  |  |
| `index` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/conference-module \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/conference-module", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/conference-module", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/conference-module"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/conference-module")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/conference-module");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-conference-notes`
- URL: https://developer.incode.com/api-reference/add-conference-notes/
- Markdown: https://developer.incode.com/api-reference/add-conference-notes.md
- Endpoint: `POST /omni/add/conference/notes`

# Add notes

`POST /omni/add/conference/notes`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for adding notes for interview/session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `notes` | string |  | Notes to save |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/conference/notes \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/conference/notes", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/conference/notes", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/conference/notes"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/conference/notes")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/conference/notes");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-curp`
- URL: https://developer.incode.com/api-reference/add-curp/
- Markdown: https://developer.incode.com/api-reference/add-curp.md
- Endpoint: `POST /omni/add/curp`

# Add curp

`POST /omni/add/curp`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add curp and the validation process result to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes |  |

## Request body

Content-Type: `application/json`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used. |

## Responses

### 200

Respuesta con validación de CURP

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/curp \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/curp", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/curp", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/curp"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/curp")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/curp");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/add-curp-v2`
- URL: https://developer.incode.com/api-reference/add-curp-v2/
- Markdown: https://developer.incode.com/api-reference/add-curp-v2.md
- Endpoint: `POST /omni/add/curp/v2`

# Add curp v2

`POST /omni/add/curp/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add CURP and validation result based on a person data.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used. |
| `name` | string |  |  |
| `firstLastName` | string |  |  |
| `secondLastName` | string |  |  |
| `gender` | string |  | Valid gender values are "H" (Hombre, male), "M" (mujer, female) and "X" (otro, other) Enum: `H`, `M`, `X` |
| `birthDate` | string (dd/mm/yyyy) |  |  |
| `state` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

Respuesta con validación de CURP

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/curp/v2?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/add-custom-fields`
- URL: https://developer.incode.com/api-reference/add-custom-fields/
- Markdown: https://developer.incode.com/api-reference/add-custom-fields.md
- Endpoint: `POST /omni/add/custom-fields`

# Add custom fields

`POST /omni/add/custom-fields`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for adding custom fields to current onboarding session.
The key must match one of the keys that are defined for the Organization, and the value must be of the type
that is defined for the corresponding key.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `customFields` | object |  | Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength} |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/custom-fields \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/custom-fields", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/custom-fields", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/custom-fields"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/custom-fields")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/custom-fields");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-device-fingerprint`
- URL: https://developer.incode.com/api-reference/add-device-fingerprint/
- Markdown: https://developer.incode.com/api-reference/add-device-fingerprint.md
- Endpoint: `POST /omni/add/device-fingerprint`

# Add device fingerprint

`POST /omni/add/device-fingerprint`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Sends information about device from which endpoint is called

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `deviceType` | string | yes | Platform of device Enum: `IOS`, `ANDROID`, `WEBAPP` |
| `hash` | string | yes | Hash code of the device fingerprint |
| `ip` | string | yes | IP address of the device |
| `ipLocation` | IpLocationDto |  | Location info based on IP address |
| `ipLocation.ipCountry` | string |  | Country from IP address |
| `ipLocation.ipRegion` | string |  | Region from IP address |
| `ipLocation.ipCity` | string |  | City from IP address |
| `ipLocation.ipLatitude` | number (double) |  | Latitude from IP address |
| `ipLocation.ipLongitude` | number (double) |  | Longitude from IP address |
| `data` | string | yes | Additional data about device |
| `osVersion` | string |  | OS version. If omitted it is parsed from user agent |
| `deviceModel` | string |  | Device model. If omitted it is parsed from user agent |
| `sdkVersion` | string |  | Version of SDK used |
| `hostingApp` | string |  | hostingApp. Name of the hosting application |
| `algorithmName` | string |  | Name of the fingerprinting algorithm used to produce the hash |
| `algorithmVersion` | string |  | Version of the fingerprinting algorithm used to produce the hash |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `ipCountry` | string |  | Current country based on the geolocation Api |
| `ipState` | string |  | Current state based on the geolocation Api |
| `showMandatoryConsent` | boolean |  | Render mandatory consent page based on this parameter value. |
| `regulationType` | string |  | Regulation type for the mandatory consent (only if showMandatoryConsent set to true). |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/device-fingerprint \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "deviceType": "<deviceType>",
    "hash": "<hash>",
    "ip": "<ip>",
    "data": "<data>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/device-fingerprint", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "deviceType": "<deviceType>",
      "hash": "<hash>",
      "ip": "<ip>",
      "data": "<data>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/device-fingerprint", headers=headers, json={
  "deviceType": "<deviceType>",
  "hash": "<hash>",
  "ip": "<ip>",
  "data": "<data>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/device-fingerprint"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"deviceType\": \"<deviceType>\",\n  \"hash\": \"<hash>\",\n  \"ip\": \"<ip>\",\n  \"data\": \"<data>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/device-fingerprint")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "deviceType": "<deviceType>",
  "hash": "<hash>",
  "ip": "<ip>",
  "data": "<data>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/device-fingerprint");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "deviceType": "<deviceType>",
  "hash": "<hash>",
  "ip": "<ip>",
  "data": "<data>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "ipCountry": "string",
  "ipState": "string",
  "showMandatoryConsent": true,
  "regulationType": "string"
}
```

---

- Path: `api-reference/add-device-fingerprint-signals`
- URL: https://developer.incode.com/api-reference/add-device-fingerprint-signals/
- Markdown: https://developer.incode.com/api-reference/add-device-fingerprint-signals.md
- Endpoint: `POST /omni/add/device-fingerprint-signals`

# Add device fingerprint signals

`POST /omni/add/device-fingerprint-signals`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Records signals (device, network, behaviour, or PID) captured during an interview event

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `metadata` | string | yes | HMAC-signed Base64-encoded metadata blob. Format: <hmac>.<base64-encoded-json>. Inner JSON shape: DeviceFingerprintSignalsMetadataDto (fields: timestamp, signalsType, payload, sdkPlatform, sdkVersion, signalsVersion). Server verifies HMAC via the service-configured `hmac_key` and rejects expired/replayed signatures based on the per-tenant CaptureMetadataConfig timestamp threshold. |
| `interviewEvent` | string | yes | Frontend interview-event code categorizing these signals; resolved against the interview-event dictionary (must be a FRONTEND-sender code, e.g. "captureAttemptFinished"). |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": "<metadata>",
    "interviewEvent": "<interviewEvent>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "metadata": "<metadata>",
      "interviewEvent": "<interviewEvent>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals", headers=headers, json={
  "metadata": "<metadata>",
  "interviewEvent": "<interviewEvent>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"metadata\": \"<metadata>\",\n  \"interviewEvent\": \"<interviewEvent>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "metadata": "<metadata>",
  "interviewEvent": "<interviewEvent>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/device-fingerprint-signals");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "metadata": "<metadata>",
  "interviewEvent": "<interviewEvent>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-diagnostics-data`
- URL: https://developer.incode.com/api-reference/add-diagnostics-data/
- Markdown: https://developer.incode.com/api-reference/add-diagnostics-data.md
- Endpoint: `POST /omni/add/diagnostics-data`

# Forward diagnostics data

`POST /omni/add/diagnostics-data`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Accepts an encrypted TrueSight diagnostics envelope from the SDK, enriches it with server-resolved clientId and environment, and forwards it to TrueSight.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `version` | integer (int32) |  | Envelope format version |
| `alg` | string |  | Encryption algorithm |
| `compression` | string |  | Compression algorithm |
| `kid` | string |  | Key identifier |
| `iv` | string |  | Initialization vector (Base64) |
| `ciphertext` | string |  | Encrypted diagnostics payload (Base64) |
| `tag` | string |  | Authentication tag (Base64) |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `forwarded` | boolean |  | True when the diagnostics envelope was forwarded to TrueSight. False when diagnostics ingest is not enabled in this environment. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/diagnostics-data \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/diagnostics-data", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/diagnostics-data", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/diagnostics-data"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/diagnostics-data")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/diagnostics-data");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "forwarded": true
}
```

---

- Path: `api-reference/add-document`
- URL: https://developer.incode.com/api-reference/add-document/
- Markdown: https://developer.incode.com/api-reference/add-document.md
- Endpoint: `POST /omni/add/document`

# Add document

`POST /omni/add/document`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload document image and store data.

**Note**: Make sure to put the 'Content-Type' header as 'Content-Type: image/jpeg' or 'Content-Type: image/png'.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `type` | query | string | yes | - **signature**: Upload user's digital signature. This can be later fetched in get images endpoint. - **document**: Upload user's proof of address document. This can be later fetched in get images endpoint. - **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead. - **contract**: Upload contract image. Enum: `signature`, `document`, `contract` |
| `title` | query | string |  | Only if type is contract. Title of contract. |
| `format` | query | string |  | Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image. Enum: `image`, `pdf` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/document?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-document-async`
- URL: https://developer.incode.com/api-reference/add-document-async/
- Markdown: https://developer.incode.com/api-reference/add-document-async.md
- Endpoint: `POST /omni/add/document/async`

# Add document asynchronously

`POST /omni/add/document/async`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload document image and store data asynchronously.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `type` | query | string | yes | - **signature**: Upload user's digital signature. This can be later fetched in get images endpoint. - **document**: Upload user's proof of address document. This can be later fetched in get images endpoint. - **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead. - **contract**: Upload contract image. Enum: `signature`, `document`, `contract` |
| `title` | query | string |  | Only if type is contract. Title of contract. |
| `format` | query | string |  | Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image. Enum: `image`, `pdf` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/document/async?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-document-id`
- URL: https://developer.incode.com/api-reference/add-document-id/
- Markdown: https://developer.incode.com/api-reference/add-document-id.md
- Endpoint: `POST /omni/add/document-id`

# Add document id

`POST /omni/add/document-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload document identifier. For Mexican id it is cic from the back of id.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documentIdentifier` | string |  | Document id. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/document-id \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/document-id", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/document-id", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/document-id"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/document-id")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/document-id");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-document-v2`
- URL: https://developer.incode.com/api-reference/add-document-v2/
- Markdown: https://developer.incode.com/api-reference/add-document-v2.md
- Endpoint: `POST /omni/add/document/v2`

# Add document V2

`POST /omni/add/document/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload document image and store data.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `type` | query | string | yes | - **signature**: Upload user's digital signature. This can be later fetched in get images endpoint. - **document**: Upload user's proof of address document. This can be later fetched in get images endpoint. - **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead. - **contract**: Upload contract image. Enum: `signature`, `document`, `contract` |
| `title` | query | string |  | Only if type is contract. Title of contract. |
| `format` | query | string |  | Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image. Enum: `image`, `pdf` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/document/v2?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-document-v3`
- URL: https://developer.incode.com/api-reference/add-document-v3/
- Markdown: https://developer.incode.com/api-reference/add-document-v3.md
- Endpoint: `POST /omni/add/document/v3`

# Add document V3

`POST /omni/add/document/v3`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload document image gathered and store data.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `type` | query | string | yes | - **signature**: Upload user's digital signature. This can be later fetched in get images endpoint. - **document**: Upload user's proof of address document. This can be later fetched in get images endpoint. - **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead. - **contract**: Upload contract image. - **v5cMultiPageLogbook**: Upload single page (image) of V5C logbook multi page document. - **carInvoice**: Upload single page (image) of two pages car invoice document. - **financeSettlement**: Upload single page (image) of two pages finance settlement letter. - **w8Ben**: Upload IRS W-8BEN form as a single page image or a PDF. - **w8BenE**: Upload one page (image) of the multi page IRS W-8BEN-E form, or the complete form as a PDF. Finish with the finalize document endpoint. Enum: `signature`, `document`, `contract`, `v5cMultiPageLogbook`, `carInvoice`, `financeSettlement`, `w8Ben`, `w8BenE` |
| `title` | query | string |  | Only if type is contract. Title of contract. |
| `format` | query | string |  | Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image. Enum: `image`, `pdf` |
| `processingMethod` | query | string |  | Only applicable for some documents. Possible values are sync and async. Default is sync. Default: `sync` Enum: `sync`, `async` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string |  | AddDocumentStatus Enum: `SUCCESS`, `PROCESS_DOC_ERROR`, `SESSION_ERROR`, `ADD_NEXT_PAGE`, `OPTIONAL_PAGE_CAPTURE`, `CLASSIFICATION_ERROR`, `MULTI_PAGE_CLASSIFICATION_ERROR`, `V5C_REGISTRATION_NUMBER_MISMATCH`, `V5C_REFERENCE_NUMBER_MISMATCH`, `V5C_NUMBER_MISMATCH`, `FSL_AGREEMENT_REFERENCE_MISMATCH`, `FSL_NAME_MISMATCH`, `NOT_W8_BEN`, `NOT_W8_BEN_E`, `MANDATORY_FIELD_MISSING`, `UNSUPPORTED_PAGE_NUMBERS`, `VALIDATION_ERROR`, `UNEXPECTED_ERROR`, `FINALIZE_ERROR_NO_PAGES`, `UNSUPPORTED_MP_DOCUMENT_TYPE` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/document/v3?type=%3Ctype%3E&title=%3Ctitle%3E&format=%3Cformat%3E&processingMethod=sync");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "status": "SUCCESS"
}
```

---

- Path: `api-reference/add-email`
- URL: https://developer.incode.com/api-reference/add-email/
- Markdown: https://developer.incode.com/api-reference/add-email.md
- Endpoint: `POST /omni/add/email`

# Add email

`POST /omni/add/email`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add email to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string |  | User's email. Has to be in valid format. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/email \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/email", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/email", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/email"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/email")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/email");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-face-third-party`
- URL: https://developer.incode.com/api-reference/add-face-third-party/
- Markdown: https://developer.incode.com/api-reference/add-face-third-party.md
- Endpoint: `POST /omni/add/face/third-party`

# Add face/Selfie image

`POST /omni/add/face/third-party`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Uploads selfie image for onboarding session. Response will contain data regarding liveness — if that is the photo of a real person.
Number of retries is not limited.

**Note**: After selfie and front-id are uploaded, endpoint for comparing faces process-face on those two images can be called.

It is required that person is alone on the photo.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `imageType` | query | string |  | Image type. Default is selfie Enum: `selfie`, `videoSelfie`, `id`, `nfc` |
| `captureType` | query | string |  | Enum: `AUTO`, `MANUAL`, `NATIVE`, `UPLOAD` |
| `externalCaptureId` | query | string |  |  |
| `recordingId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image of user's face represented in base64. |
| `imageUrl` | string |  | URL of face image, required to belong to a whitelisted domain |
| `faceCoordinates` | FaceCoordinatesDto |  | Face coordinates |
| `faceCoordinates.leftEyeX` | number (float) | yes | Left eye coordinates for X |
| `faceCoordinates.leftEyeY` | number (float) | yes | Left eye coordinates for Y |
| `faceCoordinates.rightEyeX` | number (float) | yes | Right eye coordinates for X |
| `faceCoordinates.rightEyeY` | number (float) | yes | Right eye coordinates for Y |
| `faceCoordinates.mouthX` | number (float) |  | Left mouth coordinates for X. Note: the field is deprecated, use leftMouthX instead |
| `faceCoordinates.leftMouthX` | number (float) |  | Left mouth coordinates for X |
| `faceCoordinates.mouthY` | number (float) |  | Left mouth coordinates for Y. Note: the field is deprecated, use leftMouthY instead |
| `faceCoordinates.leftMouthY` | number (float) |  | Left mouth coordinates for Y |
| `faceCoordinates.rightMouthX` | number (float) | yes | Right mouth coordinates for X |
| `faceCoordinates.rightMouthY` | number (float) | yes | Right mouth coordinates for Y |
| `faceCoordinates.noseTipX` | number (float) | yes | Nose coordinates for X |
| `faceCoordinates.noseTipY` | number (float) | yes | Nose coordinates for Y |
| `faceCoordinates.x` | number (float) | yes | X coordinate of face rectangle. |
| `faceCoordinates.y` | number (float) | yes | Y coordinate of face rectangle. |
| `faceCoordinates.width` | number (float) | yes | Width of face rectangle. |
| `faceCoordinates.height` | number (float) | yes | Height of face rectangle. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `age` | integer (int32) |  | Age of th person in the photo. |
| `isBright` | boolean |  | We recommend capturing another photo if value is false. |
| `confidence` | number (float) |  | Value 0 means that person on photo is alive. We recommend capturing another photo if value is 1. |
| `hasLenses` | boolean |  | We recommend capturing another photo if value is true. |
| `hasFaceMask` | boolean |  | Checked only if configured in the session flow. We recommend capturing another photo if value is true. |
| `hasClosedEyes` | boolean |  | Checked only if configured in the session flow. We recommend capturing another photo if value is true. |
| `hasHeadCover` | boolean |  | Checked only if configured in the session flow. We recommend capturing another photo if value is true. |
| `faceOccluded` | boolean |  | Checked only if configured in the session flow. We recommend capturing another photo if value is true. |
| `sessionStatus` | string |  | SessionStatus Enum: `Alive`, `Closed`, `Deleted` |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |

### 400

Custom error statuses: - 4010: More than one face detected - 4019: Face not found - 4077: Selfie image has low quality - 4078: Selfie face is occluded or partially covered

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "faceCoordinates": {
      "leftEyeX": "<leftEyeX>",
      "leftEyeY": "<leftEyeY>",
      "rightEyeX": "<rightEyeX>",
      "rightEyeY": "<rightEyeY>",
      "rightMouthX": "<rightMouthX>",
      "rightMouthY": "<rightMouthY>",
      "noseTipX": "<noseTipX>",
      "noseTipY": "<noseTipY>",
      "x": "<x>",
      "y": "<y>",
      "width": "<width>",
      "height": "<height>"
    }
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "faceCoordinates": {
        "leftEyeX": "<leftEyeX>",
        "leftEyeY": "<leftEyeY>",
        "rightEyeX": "<rightEyeX>",
        "rightEyeY": "<rightEyeY>",
        "rightMouthX": "<rightMouthX>",
        "rightMouthY": "<rightMouthY>",
        "noseTipX": "<noseTipX>",
        "noseTipY": "<noseTipY>",
        "x": "<x>",
        "y": "<y>",
        "width": "<width>",
        "height": "<height>"
      }
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E", headers=headers, json={
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"faceCoordinates\": {\n    \"leftEyeX\": \"<leftEyeX>\",\n    \"leftEyeY\": \"<leftEyeY>\",\n    \"rightEyeX\": \"<rightEyeX>\",\n    \"rightEyeY\": \"<rightEyeY>\",\n    \"rightMouthX\": \"<rightMouthX>\",\n    \"rightMouthY\": \"<rightMouthY>\",\n    \"noseTipX\": \"<noseTipX>\",\n    \"noseTipY\": \"<noseTipY>\",\n    \"x\": \"<x>\",\n    \"y\": \"<y>\",\n    \"width\": \"<width>\",\n    \"height\": \"<height>\"\n  }\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=%3CimageType%3E&captureType=%3CcaptureType%3E&externalCaptureId=%3CexternalCaptureId%3E&recordingId=%3CrecordingId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "age": 0,
  "isBright": true,
  "confidence": 0,
  "hasLenses": true,
  "hasFaceMask": true,
  "hasClosedEyes": true,
  "hasHeadCover": true,
  "faceOccluded": true,
  "sessionStatus": "Alive",
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  }
}
```

---

- Path: `api-reference/add-fingerprints`
- URL: https://developer.incode.com/api-reference/add-fingerprints/
- Markdown: https://developer.incode.com/api-reference/add-fingerprints.md
- Endpoint: `POST /omni/add/fingerprints`

# Add fingerprints

`POST /omni/add/fingerprints`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add fingerprints blobs and metadata to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | integer (int32) |  |  |
| `fingerprints` | array[Fingerprint] | yes |  |
| `fingerprints.index` | integer (int32) |  |  |
| `fingerprints.base64Fingerprint` | string |  |  |
| `fingerprints.fingerprintMetadata` | FingerprintMetadata |  |  |
| `fingerprints.fingerprintMetadata.device` | string |  |  |
| `fingerprints.fingerprintMetadata.resolution` | string |  |  |
| `fingerprints.fingerprintMetadata.qualityScore` | string |  |  |

## Responses

### 200

Respuesta con validación de CURP

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/fingerprints \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/fingerprints", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/fingerprints", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/fingerprints"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/fingerprints")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/fingerprints");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/add-fiscal-qr-url`
- URL: https://developer.incode.com/api-reference/add-fiscal-qr-url/
- Markdown: https://developer.incode.com/api-reference/add-fiscal-qr-url.md
- Endpoint: `POST /omni/add/fiscal-qr-url`

# Add fiscal qr url

`POST /omni/add/fiscal-qr-url`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload the url extracted from a fiscal qr code. Data from the given url will be available via the [Get fiscal qr url response](ref:getfiscalqrurlresponse) endpoint.
(México only)

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `poaUrl` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `rfc` | string |  |  |
| `curp` | string |  |  |
| `name` | string |  |  |
| `firstLastName` | string |  |  |
| `secondLastName` | string |  |  |
| `birthdate` | string |  |  |
| `denomination` | string |  |  |
| `regime` | string |  |  |
| `constitutionDate` | string |  |  |
| `operationStartDate` | string |  |  |
| `personStatus` | string |  |  |
| `lastSituationChangeDate` | string |  |  |
| `state` | string |  |  |
| `delegation` | string |  |  |
| `colony` | string |  |  |
| `streetType` | string |  |  |
| `streetName` | string |  |  |
| `extNumber` | string |  |  |
| `intNumber` | string |  |  |
| `postalCode` | string |  |  |
| `email` | string |  |  |
| `al` | string |  |  |
| `fiscalRegime` | string |  |  |
| `fiscalStartDate` | string |  |  |
| `error` | string |  |  |
| `result` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/fiscal-qr-url \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "rfc": "string",
  "curp": "string",
  "name": "string",
  "firstLastName": "string",
  "secondLastName": "string",
  "birthdate": "string",
  "denomination": "string",
  "regime": "string",
  "constitutionDate": "string",
  "operationStartDate": "string",
  "personStatus": "string",
  "lastSituationChangeDate": "string",
  "state": "string",
  "delegation": "string",
  "colony": "string",
  "streetType": "string",
  "streetName": "string",
  "extNumber": "string",
  "intNumber": "string",
  "postalCode": "string",
  "email": "string",
  "al": "string",
  "fiscalRegime": "string",
  "fiscalStartDate": "string",
  "error": "string",
  "result": "string"
}
```

---

- Path: `api-reference/add-fiscal-qr-url-image`
- URL: https://developer.incode.com/api-reference/add-fiscal-qr-url-image/
- Markdown: https://developer.incode.com/api-reference/add-fiscal-qr-url-image.md
- Endpoint: `POST /omni/add/fiscal-qr-url-image`

# Add fiscal qr image

`POST /omni/add/fiscal-qr-url-image`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload a fiscal qr image as base64 to session. The data available in the url embedded in the qr will be available via the [Get fiscal qr url response](ref:getfiscalqrurlresponse) endpoint.
(México only)

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `rfc` | string |  |  |
| `curp` | string |  |  |
| `name` | string |  |  |
| `firstLastName` | string |  |  |
| `secondLastName` | string |  |  |
| `birthdate` | string |  |  |
| `denomination` | string |  |  |
| `regime` | string |  |  |
| `constitutionDate` | string |  |  |
| `operationStartDate` | string |  |  |
| `personStatus` | string |  |  |
| `lastSituationChangeDate` | string |  |  |
| `state` | string |  |  |
| `delegation` | string |  |  |
| `colony` | string |  |  |
| `streetType` | string |  |  |
| `streetName` | string |  |  |
| `extNumber` | string |  |  |
| `intNumber` | string |  |  |
| `postalCode` | string |  |  |
| `email` | string |  |  |
| `al` | string |  |  |
| `fiscalRegime` | string |  |  |
| `fiscalStartDate` | string |  |  |
| `error` | string |  |  |
| `result` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/fiscal-qr-url-image");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "rfc": "string",
  "curp": "string",
  "name": "string",
  "firstLastName": "string",
  "secondLastName": "string",
  "birthdate": "string",
  "denomination": "string",
  "regime": "string",
  "constitutionDate": "string",
  "operationStartDate": "string",
  "personStatus": "string",
  "lastSituationChangeDate": "string",
  "state": "string",
  "delegation": "string",
  "colony": "string",
  "streetType": "string",
  "streetName": "string",
  "extNumber": "string",
  "intNumber": "string",
  "postalCode": "string",
  "email": "string",
  "al": "string",
  "fiscalRegime": "string",
  "fiscalStartDate": "string",
  "error": "string",
  "result": "string"
}
```

---

- Path: `api-reference/add-front-id-v2`
- URL: https://developer.incode.com/api-reference/add-front-id-v2/
- Markdown: https://developer.incode.com/api-reference/add-front-id-v2.md
- Endpoint: `POST /omni/add/front-id/v2`

# Add front side of ID

`POST /omni/add/front-id/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for storing front side of id for further processing. Image quality check is performed during that call.
Number of retries is not limited.

Once [process-id](/api-reference/process-id/) is finished, this endpoint cannot be called for retries.

**Note: Front side of id should be uploaded before [back-side](/api-reference/add-back-id-v2/)**

**Image requirements**: the smallest side of the image must be at least 200 px.
A smaller image can pass this capture step, but [process-id](/api-reference/process-id/) rejects it with error status 4085 ("ID image is too small.").
Images larger than 2048 px on the longest side are scaled down automatically.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `onlyFront` | query | boolean |  | Flag stating if document is one-sided (like Passport) Default: `false` |
| `extractIdFace` | query | boolean |  | When false, skips biometric face extraction and template creation from the front ID. Default true. Default: `true` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

In case there's some issue when calling the endpoint due to classification failed, an issue such as bad quality, or any of the fail reasons the response will always have the field: - classification - failReason - sharpness - glare - horizontalResolution We recommend considering the call as failed if there's a failReason in the response or if the classification is false. Possible values for fail reason: - UNKNOWN_DOCUMENT_TYPE: document classification failed - WRONG_DOCUMENT_SIDE: can happen when uploading back side of id when front id is required or the other way around - WRONG_ONE_SIDED_DOCUMENT: uploading wrong document with only one side - WRONG_UNFOLDED_DOCUMENT: uploading unfolded document with unrecognizable sides - UNFOLDED_DOCUMENT_PAGE_MISMATCH: uploading unfolded document with mismatching sides - DOCUMENT_NOT_READABLE: document couldn't be read, probably due to image quality - UNABLE_TO_ALIGN_DOCUMENT: alignment failed - ID_TYPE_UNACCEPTABLE: invalid type of id - UNEXPECTED_ERROR_OCCURRED: unexpected error Whenever the classification is done successfully the fields that will always be present are: - classification - sharpness - glare - horizontalResolution - readability - typeOfId - sessionStatus The remaining fields could be optional depending on the specific type of id and country of origin.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `correctSharpness` | boolean |  | It's true if the sharpness of the ID meets the requirements. |
| `correctGlare` | boolean |  | It's true if the glare of the ID meets the requirements. |
| `horizontalResolution` | integer (int32) |  | Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155. |
| `shadowConfidence` | number (float) |  | Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1. |
| `classification` | boolean |  | If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored. |
| `readability` | boolean |  | If true, server can properly read ID. If false server failed to read some key places of the ID. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `issueYear` | integer (int32) |  | Issue year of the ID. |
| `issueName` | string |  | Description of the ID. Could contain country code, state, type of ID, subtype of ID. |
| `curpCheck` | boolean |  | Only for Mexican IDs. Flag stating if curp was properly read. |
| `sessionStatus` | string |  | Session Status Enum: `Alive`, `Closed`, `Deleted` |
| `countryCode` | string |  | Valid ISO alpha-2 or alpha-3 code of the ID issuing country. |
| `state` | string |  | Issuing state of the ID. |
| `failReason` | string |  | Classification fail reason Enum: `UNKNOWN_DOCUMENT_TYPE`, `WRONG_DOCUMENT_SIDE`, `WRONG_ONE_SIDED_DOCUMENT`, `UNFOLDED_DOCUMENT_PAGE_MISMATCH`, `WRONG_UNFOLDED_DOCUMENT`, `DOCUMENT_NOT_READABLE`, `UNABLE_TO_ALIGN_DOCUMENT`, `ID_TYPE_UNACCEPTABLE`, `UNEXPECTED_ERROR_OCCURRED`, `DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED` |
| `skipBackIdCapture` | boolean |  | Flag that signals if back id capture should be skipped or not. |
| `forceFrontIdCapture` | boolean |  | Flag that signals if front id capture must be executed after back. |
| `showMandatoryConsent` | boolean |  | Render mandatory consent page based on this parameter value. |
| `regulationType` | string |  | Regulation type for the mandatory consent (only if showMandatoryConsent set to true). |
| `skipGlareFront` | boolean |  | Flag that signals if front side glare should be ignored. |
| `skipGlareBack` | boolean |  | Flag that signals if back side glare should be ignored. |
| `documentIsOnTheEdge` | boolean |  | Flag that signals if document is on the edge on the full frame image. |
| `acceptedDocuments` | array[string] |  | List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason. Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `imageRedacted` | boolean |  | Flag that signals if image was redacted as part of the ID capture. |
| `idFaceExtractionSkipped` | boolean |  | True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted). |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `idQualityAttemptApproved` | boolean |  | ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.9, false otherwise. |
| `isDocumentExpired` | boolean |  | Flag indicating if the document side is expired. |
| `attemptId` | string |  | Created attempt id. |

### 400

Custom error statuses: - 1003: Face cropping failure - 4004: Could not find user - 4019: Face not found - 4092: Image format is unsupported or the image is unreadable

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 503

Image conversion temporarily unavailable; retry after the Retry-After header

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/front-id/v2?onlyFront=false&extractIdFace=true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "correctSharpness": true,
  "correctGlare": true,
  "horizontalResolution": 0,
  "shadowConfidence": 0,
  "classification": true,
  "readability": true,
  "typeOfId": "Unknown",
  "issueYear": 0,
  "issueName": "string",
  "curpCheck": true,
  "sessionStatus": "Alive",
  "countryCode": "string",
  "state": "string",
  "failReason": "UNKNOWN_DOCUMENT_TYPE",
  "skipBackIdCapture": true,
  "forceFrontIdCapture": true,
  "showMandatoryConsent": true,
  "regulationType": "string",
  "skipGlareFront": true,
  "skipGlareBack": true,
  "documentIsOnTheEdge": true,
  "acceptedDocuments": [
    "Unknown"
  ],
  "imageRedacted": true,
  "idFaceExtractionSkipped": true,
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "idQualityAttemptApproved": true,
  "isDocumentExpired": true,
  "attemptId": "string"
}
```

---

- Path: `api-reference/add-front-second-id-v2`
- URL: https://developer.incode.com/api-reference/add-front-second-id-v2/
- Markdown: https://developer.incode.com/api-reference/add-front-second-id-v2.md
- Endpoint: `POST /omni/add/front-second-id/v2`

# Add front side of Second ID

`POST /omni/add/front-second-id/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for storing front side of second id for further processing

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `onlyFront` | query | boolean |  | Flag stating if document is one-sided (like Passport). Default value is false, in case it is not sent. Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image in base64 format. One of base64Image or imageUrl is required |
| `imageUrl` | string |  | URL of the image. One of base64Image or imageUrl is required |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `correctSharpness` | boolean |  | It's true if the sharpness of the ID meets the requirements. |
| `correctGlare` | boolean |  | It's true if the glare of the ID meets the requirements. |
| `horizontalResolution` | integer (int32) |  | Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155. |
| `shadowConfidence` | number (float) |  | Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1. |
| `classification` | boolean |  | If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored. |
| `readability` | boolean |  | If true, server can properly read ID. If false server failed to read some key places of the ID. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `issueYear` | integer (int32) |  | Issue year of the ID. |
| `issueName` | string |  | Description of the ID. Could contain country code, state, type of ID, subtype of ID. |
| `curpCheck` | boolean |  | Only for Mexican IDs. Flag stating if curp was properly read. |
| `sessionStatus` | string |  | Session Status Enum: `Alive`, `Closed`, `Deleted` |
| `countryCode` | string |  | Valid ISO alpha-2 or alpha-3 code of the ID issuing country. |
| `state` | string |  | Issuing state of the ID. |
| `failReason` | string |  | Classification fail reason Enum: `UNKNOWN_DOCUMENT_TYPE`, `WRONG_DOCUMENT_SIDE`, `WRONG_ONE_SIDED_DOCUMENT`, `UNFOLDED_DOCUMENT_PAGE_MISMATCH`, `WRONG_UNFOLDED_DOCUMENT`, `DOCUMENT_NOT_READABLE`, `UNABLE_TO_ALIGN_DOCUMENT`, `ID_TYPE_UNACCEPTABLE`, `UNEXPECTED_ERROR_OCCURRED`, `DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED` |
| `skipBackIdCapture` | boolean |  | Flag that signals if back id capture should be skipped or not. |
| `forceFrontIdCapture` | boolean |  | Flag that signals if front id capture must be executed after back. |
| `showMandatoryConsent` | boolean |  | Render mandatory consent page based on this parameter value. |
| `regulationType` | string |  | Regulation type for the mandatory consent (only if showMandatoryConsent set to true). |
| `skipGlareFront` | boolean |  | Flag that signals if front side glare should be ignored. |
| `skipGlareBack` | boolean |  | Flag that signals if back side glare should be ignored. |
| `documentIsOnTheEdge` | boolean |  | Flag that signals if document is on the edge on the full frame image. |
| `acceptedDocuments` | array[string] |  | List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason. Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `imageRedacted` | boolean |  | Flag that signals if image was redacted as part of the ID capture. |
| `idFaceExtractionSkipped` | boolean |  | True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted). |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `idQualityAttemptApproved` | boolean |  | ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.9, false otherwise. |
| `isDocumentExpired` | boolean |  | Flag indicating if the document side is expired. |
| `attemptId` | string |  | Created attempt id. |

### 400

Custom error statuses: - 4019: Face not found - 1003: Face cropping failure - 4092: Image format is unsupported or the image is unreadable

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 503

Image conversion temporarily unavailable; retry after the Retry-After header

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/front-second-id/v2?onlyFront=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "correctSharpness": true,
  "correctGlare": true,
  "horizontalResolution": 0,
  "shadowConfidence": 0,
  "classification": true,
  "readability": true,
  "typeOfId": "Unknown",
  "issueYear": 0,
  "issueName": "string",
  "curpCheck": true,
  "sessionStatus": "Alive",
  "countryCode": "string",
  "state": "string",
  "failReason": "UNKNOWN_DOCUMENT_TYPE",
  "skipBackIdCapture": true,
  "forceFrontIdCapture": true,
  "showMandatoryConsent": true,
  "regulationType": "string",
  "skipGlareFront": true,
  "skipGlareBack": true,
  "documentIsOnTheEdge": true,
  "acceptedDocuments": [
    "Unknown"
  ],
  "imageRedacted": true,
  "idFaceExtractionSkipped": true,
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "idQualityAttemptApproved": true,
  "isDocumentExpired": true,
  "attemptId": "string"
}
```

---

- Path: `api-reference/add-geolocation`
- URL: https://developer.incode.com/api-reference/add-geolocation/
- Markdown: https://developer.incode.com/api-reference/add-geolocation.md
- Endpoint: `POST /omni/add/geolocation`

# Add geolocation

`POST /omni/add/geolocation`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Send location to store in database, or send coordinates and fetch location and store it

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `longitude` | number (float) | yes | User's geolocation longitude |
| `latitude` | number (float) | yes | User's geolocation latitude |
| `location` | string |  | User's current location |
| `madminArea` | string |  |  |
| `msubAdminArea` | string |  |  |
| `mlocality` | string |  |  |
| `msubLocality` | string |  |  |
| `mthoroughfare` | string |  |  |
| `msubThoroughfare` | string |  |  |
| `mpostalCode` | string |  |  |
| `mcountryCode` | string |  |  |
| `mcountryName` | string |  |  |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/geolocation \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "longitude": "<longitude>",
    "latitude": "<latitude>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/geolocation", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "longitude": "<longitude>",
      "latitude": "<latitude>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/geolocation", headers=headers, json={
  "longitude": "<longitude>",
  "latitude": "<latitude>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/geolocation"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"longitude\": \"<longitude>\",\n  \"latitude\": \"<latitude>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/geolocation")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "longitude": "<longitude>",
  "latitude": "<latitude>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/geolocation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "longitude": "<longitude>",
  "latitude": "<latitude>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/add-name`
- URL: https://developer.incode.com/api-reference/add-name/
- Markdown: https://developer.incode.com/api-reference/add-name.md
- Endpoint: `POST /omni/add/name`

# Add name

`POST /omni/add/name`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for adding user's name for current onboarding session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | User's name. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/name \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/name", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/name", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/name"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/name")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/name");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-notes`
- URL: https://developer.incode.com/api-reference/add-notes/
- Markdown: https://developer.incode.com/api-reference/add-notes.md
- Endpoint: `POST /omni/add/notes`

# Add notes

`POST /omni/add/notes`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for adding notes for interview/session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `notes` | string |  | Notes to save |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/notes \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/notes", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/notes", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/notes"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/notes")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/notes");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-phone`
- URL: https://developer.incode.com/api-reference/add-phone/
- Markdown: https://developer.incode.com/api-reference/add-phone.md
- Endpoint: `POST /omni/add/phone`

# Add phone

`POST /omni/add/phone`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

> **Deprecated** — this endpoint is marked deprecated in the Omni API specification.

Add phone to interview. Deprecated, use POST /phone instead.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string |  | User's phone number. E.164 number convention. |
| `optInGranted` | boolean |  | Indicates whether opt-in is granted Default: `false` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `existingCustomer` | boolean |  | Flag indicating if this user with given phone already exists in the system. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/phone \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/phone", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/phone", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/phone"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/phone")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "existingCustomer": true
}
```

---

- Path: `api-reference/add-qr-code-text`
- URL: https://developer.incode.com/api-reference/add-qr-code-text/
- Markdown: https://developer.incode.com/api-reference/add-qr-code-text.md
- Endpoint: `POST /omni/add/qr-code-text`

# Add QR code raw text

`POST /omni/add/qr-code-text`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add QR code raw text to interview. It will be saved in customFields named 'qrCodeText', this fields needs to be present
in organization's custom fields schema.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `qrCodeText` | string |  | QR code raw text. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/qr-code-text \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/qr-code-text", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/qr-code-text", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/qr-code-text"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/qr-code-text")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/qr-code-text");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-user-consent`
- URL: https://developer.incode.com/api-reference/add-user-consent/
- Markdown: https://developer.incode.com/api-reference/add-user-consent.md
- Endpoint: `POST /omni/add/user-consent`

# Add user consent

`POST /omni/add/user-consent`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add user consent with title, content and status to session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `title` | string |  | Title of the consent. |
| `content` | string |  | Text content. |
| `status` | boolean |  | Status |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/user-consent \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/user-consent", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/user-consent", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/user-consent"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/user-consent")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/user-consent");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-watchlist-identity`
- URL: https://developer.incode.com/api-reference/add-watchlist-identity/
- Markdown: https://developer.incode.com/api-reference/add-watchlist-identity.md
- Endpoint: `POST /omni/add/watchlist/identity`

# Add custom watchlist entry from identity

`POST /omni/add/watchlist/identity`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `identityId` | string |  |  |
| `watchlistType` | string |  | Enum: `WHITELIST`, `BLACKLIST` |
| `recordExpiresAt` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/watchlist/identity \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/watchlist/identity", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/watchlist/identity", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/watchlist/identity"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/watchlist/identity")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/watchlist/identity");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-watchlist-session`
- URL: https://developer.incode.com/api-reference/add-watchlist-session/
- Markdown: https://developer.incode.com/api-reference/add-watchlist-session.md
- Endpoint: `POST /omni/add/watchlist/session`

# Add custom watchlist entry from session

`POST /omni/add/watchlist/session`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  |  |
| `watchlistType` | string |  | Enum: `WHITELIST`, `BLACKLIST` |
| `recordExpiresAt` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/watchlist/session \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/watchlist/session", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/watchlist/session", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/watchlist/session"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/watchlist/session")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/watchlist/session");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/add-watchlist-single-record`
- URL: https://developer.incode.com/api-reference/add-watchlist-single-record/
- Markdown: https://developer.incode.com/api-reference/add-watchlist-single-record.md
- Endpoint: `POST /omni/add/watchlist/single-record`

# Add custom watchlist entry

`POST /omni/add/watchlist/single-record`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | Name of person that is being uploaded to Watchlist |
| `birthDate` | string |  | Birthdate (timestamp) of person that is being uploaded to Watchlist |
| `idNumber` | string |  | Id number of person that is being uploaded to Watchlist |
| `email` | string |  | Email of person that is being uploaded to Watchlist |
| `phone` | string |  | Phone of person that is being uploaded to Watchlist |
| `personalIdNumber` | string |  | Personal Id Number of person that is being uploaded to Watchlist |
| `externalId` | string |  | External id of person that is being uploaded to Watchlist |
| `imageBase64` | string |  | Base64 representation of face image of person that is being uploaded to Watchlist |
| `frontIdBase64` | string |  | Base64 representation of front side of document image that is being processed to gather OCR data and uploaded to Watchlist |
| `backIdBase64` | string |  | Base64 representation of back side of document image that is being processed to gather OCR data and uploaded to Watchlist |
| `watchlistType` | string |  | Defines type of Watchlist to use Enum: `WHITELIST`, `BLACKLIST` |
| `recordExpiresAt` | string |  | Date (timestamp) until the watchlist entry is active. When searched after this date, score of watchlist match will be 0. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `customerId` | string |  |  |
| `watchlistId` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/watchlist/single-record \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/watchlist/single-record", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/watchlist/single-record", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/watchlist/single-record"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/watchlist/single-record")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/watchlist/single-record");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "customerId": "string",
  "watchlistId": "string"
}
```

---

- Path: `api-reference/api-calculate-rfc`
- URL: https://developer.incode.com/api-reference/api-calculate-rfc/
- Markdown: https://developer.incode.com/api-reference/api-calculate-rfc.md
- Endpoint: `POST /api/calculate/rfc`

# Calculate RFC

`POST /api/calculate/rfc`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Calculate and return the RFC based on a person data.

Once you obtain the calculated RFC it doesn't necessarily mean it's a valid one. You could use the validate RFC method to check if it exists.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes |  |
| `firstLastName` | string | yes |  |
| `secondLastName` | string | yes |  |
| `birthDate` | string (dd/mm/yyyy) | yes |  |

## Responses

### 200

Successfully calculated RFC

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `calculatedRFC` | string |  |  |

### 400

Invalid input data

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal server error during calculation

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/calculate/rfc \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "<name>",
    "firstLastName": "<firstLastName>",
    "secondLastName": "<secondLastName>",
    "birthDate": "<birthDate>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/calculate/rfc", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "name": "<name>",
      "firstLastName": "<firstLastName>",
      "secondLastName": "<secondLastName>",
      "birthDate": "<birthDate>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/calculate/rfc", headers=headers, json={
  "name": "<name>",
  "firstLastName": "<firstLastName>",
  "secondLastName": "<secondLastName>",
  "birthDate": "<birthDate>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/calculate/rfc"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"name\": \"<name>\",\n  \"firstLastName\": \"<firstLastName>\",\n  \"secondLastName\": \"<secondLastName>\",\n  \"birthDate\": \"<birthDate>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/calculate/rfc")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "name": "<name>",
  "firstLastName": "<firstLastName>",
  "secondLastName": "<secondLastName>",
  "birthDate": "<birthDate>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/calculate/rfc");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "name": "<name>",
  "firstLastName": "<firstLastName>",
  "secondLastName": "<secondLastName>",
  "birthDate": "<birthDate>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "calculatedRFC": "PEPJ870918ABC"
}
```

---

- Path: `api-reference/api-fetch-curp-v3`
- URL: https://developer.incode.com/api-reference/api-fetch-curp-v3/
- Markdown: https://developer.incode.com/api-reference/api-fetch-curp-v3.md
- Endpoint: `GET /api/fetch/curp/v3`

# Fetch CURP scraping results

`GET /api/fetch/curp/v3`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch the results from [/api/validate/curp/v3](#/API%20Validations/validateCurp3). The recommended wait time is 25 secs and retrying every 5 secs after that.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `idResults` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `get_version` | integer (int64) |  |  |
| `scrapingStatus` | string |  | - IN_PROGRESS: Service hasn't finished and should retry in 5 seconds. - FINISHED: Service finished and we got a result. Either a success or an error, such as curp not found. - ERROR: Service had an unhandled error, a new attempt is recommended. Enum: `IN_PROGRESS`, `FINISHED`, `ERROR` |
| `success` | boolean |  |  |
| `result` | string |  | - success: Call finished and data was validated successfully. - error: Invalid curp or data, exact details returned by the website can be found in the resultDetails field. - timeout: Elements needed for scrapping were never found, isolated network issue, website down or website changed. - maintenance: Elements indicating that the website is under maintenance have been found. - unhandledError: Unhandled error occured during scrapping. |
| `resultDetails` | string |  |  |
| `screenshotUrl` | string |  |  |
| `curp` | string |  |  |
| `nombre` | string |  |  |
| `primerApellido` | string |  |  |
| `segundoApellido` | string |  |  |
| `sexo` | string |  |  |
| `nacionalidad` | string |  |  |
| `entidadNacimiento` | string |  |  |
| `documentoProbatorio` | string |  |  |
| `datosDocumentoProbatorio` | object |  | - municipioRegistro: String. - entidadRegistro: String. - numeroActa: Integer. - anioRegistro: Integer. |
| `curpHistoricas` | string |  |  |
| `statusCurp` | string |  |  |
| `transactionId` | string |  |  |
| `codigoRespuestaCCB` | string |  |  |
| `descripcionRespuestaCCB` | string |  |  |
| `codigoRespuestaRENAPO` | string |  |  |
| `descripcionRespuestaRENAPO` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/fetch/curp/v3?idResults=%3CidResults%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "get_version": 0,
  "scrapingStatus": "IN_PROGRESS",
  "success": true,
  "result": "string",
  "resultDetails": "string",
  "screenshotUrl": "string",
  "curp": "string",
  "nombre": "string",
  "primerApellido": "string",
  "segundoApellido": "string",
  "sexo": "string",
  "nacionalidad": "string",
  "entidadNacimiento": "string",
  "documentoProbatorio": "string",
  "datosDocumentoProbatorio": {},
  "curpHistoricas": "string",
  "statusCurp": "string",
  "transactionId": "string",
  "codigoRespuestaCCB": "string",
  "descripcionRespuestaCCB": "string",
  "codigoRespuestaRENAPO": "string",
  "descripcionRespuestaRENAPO": "string"
}
```

---

- Path: `api-reference/api-fetch-ine`
- URL: https://developer.incode.com/api-reference/api-fetch-ine/
- Markdown: https://developer.incode.com/api-reference/api-fetch-ine.md
- Endpoint: `GET /api/fetch/ine`

# Fetch INE scraping results

`GET /api/fetch/ine`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch the results from [/api/validate/ine](#/API%20Validations/validateIne). The recommended wait time is 20 sec and retrying every 5 sec after that.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `idResults` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

scrapingStatus possible values are: - IN_PROGRESS: service hasn't finished and should retry in 5 seconds. - FINISHED: scrapping service finished and we got either a successful response or an error such as curp not found. - ERROR: scrapping service had an unhandled error, another attempt should be sent to validate curp. If INE is not found or an error occurs (such as service being in maintenance) then the success field will be false and the field resultDetails will have additional information.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `get_version` | integer (int64) |  |  |
| `scrapingStatus` | string |  | Scraping status Enum: `IN_PROGRESS`, `FINISHED`, `ERROR` |
| `success` | boolean |  | Flag indicating if the process finished successfully. |
| `result` | string |  | Result Enum: `success`, `error` |
| `resultDetails` | string |  |  |
| `screenshotUrl` | string |  |  |
| `cic` | string |  | Cic value. |
| `claveElector` | string |  | Clave de elector. |
| `numeroEmision` | string |  | Emission number. |
| `ocr` | string |  | Ocr number. |
| `anioRegistro` | string |  | Registration year. |
| `anioEmision` | string |  | Emission year. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/fetch/ine?idResults=%3CidResults%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "get_version": 0,
  "scrapingStatus": "IN_PROGRESS",
  "success": true,
  "result": "success",
  "resultDetails": "string",
  "screenshotUrl": "string",
  "cic": "string",
  "claveElector": "string",
  "numeroEmision": "string",
  "ocr": "string",
  "anioRegistro": "string",
  "anioEmision": "string"
}
```

---

- Path: `api-reference/api-key`
- URL: https://developer.incode.com/api-reference/api-key/
- Markdown: https://developer.incode.com/api-reference/api-key.md
- Endpoint: `GET /omni/api-key`

# Fetch

`GET /omni/api-key`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch all API keys of current user's organization. If user is super admin, parameter apiKey can be provided to specify
organization for which the keys should be fetched (ignored otherwise).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `apiKey` | query | string |  | Organization reference. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/api-key?apiKey=%3CapiKey%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
[
  {
    "name": "key1",
    "value": "f35844c8bcb417be1a64fd6e8d622cc93b0fcfaa",
    "clientId": "key1254",
    "valid": true,
    "createdAt": 1678185005948,
    "updatedAt": 1678185005948
  }
]
```

---

- Path: `api-reference/api-key-post`
- URL: https://developer.incode.com/api-reference/api-key-post/
- Markdown: https://developer.incode.com/api-reference/api-key-post.md
- Endpoint: `POST /omni/api-key`

# Create

`POST /omni/api-key`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Create new API key for current user's organization. If user is super admin, parameter apiKey can be provided to specify
organization for which the key should be created (ignored otherwise).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | Key name. |
| `apiKey` | string |  | Organization reference. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | Key name. |
| `value` | string |  | Key value, sha1(clientId). |
| `clientId` | string |  | Key clientId, name + random 3 digits. |
| `valid` | boolean |  | Key validity. |
| `createdAt` | integer (int64) |  | Key creation timestamp. |
| `updatedAt` | integer (int64) |  | Key adjustment timestamp. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/api-key \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/api-key", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/api-key", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/api-key"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/api-key")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/api-key");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "name": "key1",
  "value": "f35844c8bcb417be1a64fd6e8d622cc93b0fcfaa",
  "clientId": "key1254",
  "valid": true,
  "createdAt": 1678185005948,
  "updatedAt": 1678185005948
}
```

---

- Path: `api-reference/api-key-put`
- URL: https://developer.incode.com/api-reference/api-key-put/
- Markdown: https://developer.incode.com/api-reference/api-key-put.md
- Endpoint: `PUT /omni/api-key`

# Update

`PUT /omni/api-key`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Validate/invalidate API key for current user's organization. If user is super admin, parameter apiKey can be provided
to specify organization for which the key should be adjusted (ignored otherwise). User is not allowed to invalidate last
valid key of the belonging organization. Super admin user can invalidate last valid keys of other organizations
(effectively revoking their access to the application).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `valid` | boolean | yes | Key validity. |
| `name` | string |  | Key name. |
| `apiKey` | string |  | Organization reference. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | Key name. |
| `value` | string |  | Key value, sha1(clientId). |
| `clientId` | string |  | Key clientId, name + random 3 digits. |
| `valid` | boolean |  | Key validity. |
| `createdAt` | integer (int64) |  | Key creation timestamp. |
| `updatedAt` | integer (int64) |  | Key adjustment timestamp. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/api-key \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "valid": "<valid>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/api-key", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "valid": "<valid>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/api-key", headers=headers, json={
  "valid": "<valid>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/api-key"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\n  \"valid\": \"<valid>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/api-key")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "valid": "<valid>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/api-key");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "valid": "<valid>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "name": "key1",
  "value": "f35844c8bcb417be1a64fd6e8d622cc93b0fcfaa",
  "clientId": "key1254",
  "valid": true,
  "createdAt": 1678185005948,
  "updatedAt": 1678185005948
}
```

---

- Path: `api-reference/api-validate-bank-statement`
- URL: https://developer.incode.com/api-reference/api-validate-bank-statement/
- Markdown: https://developer.incode.com/api-reference/api-validate-bank-statement.md
- Endpoint: `POST /api/validate/bank-statement`

# Validate bank statement

`POST /api/validate/bank-statement`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used to validate and get the information from a bank statement.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `dummy` | query | boolean |  | Enables sending any pdf and will return a dummy response. Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

fields are optional, based on the bank statement format - name: String. - account_num: String. - clabe: String. - summary: String. - bank: String. - rfc: String. - starting_balance: Float. - ending_balance: Float. - pdf_quality: Number. - summary: Object. Object with detailed information on balance, deposits, withdrawals and fees. - txs: Array of transactions.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/bank-statement?dummy=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-bank-statement-v2`
- URL: https://developer.incode.com/api-reference/api-validate-bank-statement-v2/
- Markdown: https://developer.incode.com/api-reference/api-validate-bank-statement-v2.md
- Endpoint: `POST /api/validate/bank-statement/v2`

# Validate bank statement v2

`POST /api/validate/bank-statement/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used to validate and get the information from a bank statement.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `dummy` | query | boolean |  | Enables sending any pdf and will return a dummy response. Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64File` | string | yes | Base64 string representation of the bank statement pdf. |

## Responses

### 200

Fields are optional, based on the bank statement format - name: String. - account_num: String. - clabe: String. - summary: String. - bank: String. - rfc: String. - starting_balance: Float. - ending_balance: Float. - pdf_quality: Number. - summary: Object. Object with detailed information on balance, deposits, withdrawals and fees. - txs: Array of transactions.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64File": "<base64File>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64File": "<base64File>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false", headers=headers, json={
  "base64File": "<base64File>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64File\": \"<base64File>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64File": "<base64File>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/bank-statement/v2?dummy=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64File": "<base64File>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-curp-by-data-v3`
- URL: https://developer.incode.com/api-reference/api-validate-curp-by-data-v3/
- Markdown: https://developer.incode.com/api-reference/api-validate-curp-by-data-v3.md
- Endpoint: `POST /api/validate/curp-by-data/v3`

# CURP scraping validation by data

`POST /api/validate/curp-by-data/v3`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid CURP directly with an automated search in [https://www.gob.mx/curp/](https://www.gob.mx/curp/) and return
corresponding curp of that person. Parameters are the person's details.

Scraping service will start working asynchronously and this service will return a resultsId to fetch the results in
[/api/fetch/curp/v3](#/API%20Validations/fetchCurp3). The recommended wait time is 25 sec.

Valid values for state are the ones listed by renapo in this link: [https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México](https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México)

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used. |
| `name` | string |  |  |
| `firstLastName` | string |  |  |
| `secondLastName` | string |  |  |
| `gender` | string |  | Valid gender values are "H" (Hombre, male), "M" (mujer, female) and "X" (otro, other) Enum: `H`, `M`, `X` |
| `birthDate` | string (dd/mm/yyyy) |  |  |
| `state` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

idResults: String.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/curp-by-data/v3 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/curp-by-data/v3", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/curp-by-data/v3", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/curp-by-data/v3"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/curp-by-data/v3")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/curp-by-data/v3");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-curp-by-data-v4`
- URL: https://developer.incode.com/api-reference/api-validate-curp-by-data-v4/
- Markdown: https://developer.incode.com/api-reference/api-validate-curp-by-data-v4.md
- Endpoint: `POST /api/validate/curp-by-data/v4`

# CURP by data validation v4

`POST /api/validate/curp-by-data/v4`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid CURP based on a person data and return corresponding values of that person including the CURP.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used. |
| `name` | string |  |  |
| `firstLastName` | string |  |  |
| `secondLastName` | string |  |  |
| `gender` | string |  | Valid gender values are "H" (Hombre, male), "M" (mujer, female) and "X" (otro, other) Enum: `H`, `M`, `X` |
| `birthDate` | string (dd/mm/yyyy) |  |  |
| `state` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

If data doesn't match any CURP then the field renapo_valid will be false. If there is an error with the request data an error object is returned with the details, example:" ``` { "error": { "descripcionRespuesta": "DATOS INCORRECTOS: [El campo no cumple con el formato.]", "codigoRespuesta": "02", } } ```

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `curp` | string |  | Curp |
| `sex` | string |  | Sex Enum: `Mujer`, `Hombre`, `X` |
| `nationality` | string |  | Nationality |
| `result` | string |  |  |
| `transactionId` | string |  |  |
| `renapo_valid` | boolean |  | Flag indicating if CURP validation passed - tipoError present in response |
| `names` | string |  | Names |
| `paternal_surname` | string |  | Paternal surname |
| `mothers_maiden_name` | string |  | Mother maiden name |
| `birthdate` | string |  | Birth Date in format DD/MM/YYYY |
| `entity_birth` | string |  | Birth State |
| `probation_document` | string |  | Probation Document |
| `probation_document_data` | object |  | Key/Value structure. All keys are type of string. Available Key values: - anioReg - foja - tomo - libro - numActa - CRIP - numEntidadReg - cveMunicipioReg - NumRegExtranjeros - FolioCarta - cveEntidadNac - cveEntidadEmisora |
| `status_curp` | string |  | Status Curp |
| `deceasedStatus` | string |  | Deceased Status |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/curp-by-data/v4 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/curp-by-data/v4", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/curp-by-data/v4", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/curp-by-data/v4"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/curp-by-data/v4")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/curp-by-data/v4");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "string",
  "sex": "Mujer",
  "nationality": "string",
  "result": "string",
  "transactionId": "string",
  "renapo_valid": true,
  "names": "string",
  "paternal_surname": "string",
  "mothers_maiden_name": "string",
  "birthdate": "string",
  "entity_birth": "string",
  "probation_document": "string",
  "probation_document_data": {},
  "status_curp": "string",
  "deceasedStatus": "string"
}
```

---

- Path: `api-reference/api-validate-curp-v3`
- URL: https://developer.incode.com/api-reference/api-validate-curp-v3/
- Markdown: https://developer.incode.com/api-reference/api-validate-curp-v3.md
- Endpoint: `POST /api/validate/curp/v3`

# CURP scraping validation

`POST /api/validate/curp/v3`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid CURP directly with an automated search in [https://www.gob.mx/curp/](https://www.gob.mx/curp/) and return
corresponding values of that person. Parameter must be "curp".

Scraping service will start working asynchronously and this service will return a resultsId to fetch the results in
[/api/fetch/curp/v3](#/API%20Validations/fetchCurp3). The recommended wait time is 25 sec.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

idResults: String

### 400

Invalid curp: a 400 error will be thrown if the curp provided does not match the correct pattern.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/curp/v3 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/curp/v3", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/curp/v3", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/curp/v3"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/curp/v3")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/curp/v3");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-curp-v4`
- URL: https://developer.incode.com/api-reference/api-validate-curp-v4/
- Markdown: https://developer.incode.com/api-reference/api-validate-curp-v4.md
- Endpoint: `POST /api/validate/curp/v4`

# CURP validation v4

`POST /api/validate/curp/v4`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid CURP and return corresponding values of that person.

If CURP is not found then renapo_valid field will be false.

if CURP has invalid format or is not found an error object with details will be returned, for example:

```
{

    "error": { "codigoError": "06", "message": "La CURP no se encuentra en la base de datos" },

    "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",

}
```

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

Respuesta con validación de CURP

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/curp/v4 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/curp/v4", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/curp/v4", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/curp/v4"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/curp/v4")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/curp/v4");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/api-validate-ine`
- URL: https://developer.incode.com/api-reference/api-validate-ine/
- Markdown: https://developer.incode.com/api-reference/api-validate-ine.md
- Endpoint: `POST /api/validate/ine`

# INE scraping validation

`POST /api/validate/ine`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid INE directly with an automated search in [https://listanominal.ine.mx/scpln/](https://listanominal.ine.mx/scpln/)
and return corresponding values of that ID.

Scraping service will start working asynchronously and this service will return a resultsId to fetch the results in
[/api/fetch/ine](#/API%20Validations/fetchIne). The recommended wait time is 20 sec.

Possible parameters are ocr, cic, claveElector and numeroEmision but the parameters sent depend on the model of the INE/IFE
to be consulted.

Model C: IFE with emission year from 2008 to 2013, should send claveElector, numeroEmision and ocr from the back of ID.

Model D: INE with emission year from 2013, should send cic from back of ID (9 characters) and OCR from the back of the ID (13 characters).

Model E,F,G,H: INE with emission year from 2014 onwards, should send CIC from the back of the ID (9 characters) and
citizen id (ocr) from the back of the ID (9 characters).

Additional indications and information on the models of the credentials can be found in [https://listanominal.ine.mx/scpln/](https://listanominal.ine.mx/scpln/)

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ocr` | string | yes |  |
| `identificadorCiudadano` | string |  |  |
| `cic` | string |  | Mandatory for model D,E,F,G,H |
| `claveElector` | string |  | Mandatory for model C |
| `numeroEmision` | string |  | Mandatory for model C, should have a length of 2: ex 02 |

## Responses

### 200

idResults: String

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/ine \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "ocr": "<ocr>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/ine", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "ocr": "<ocr>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/ine", headers=headers, json={
  "ocr": "<ocr>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/ine"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"ocr\": \"<ocr>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/ine")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "ocr": "<ocr>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/ine");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "ocr": "<ocr>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-registraduria`
- URL: https://developer.incode.com/api-reference/api-validate-registraduria/
- Markdown: https://developer.incode.com/api-reference/api-validate-registraduria.md
- Endpoint: `POST /api/validate/registraduria`

# Registraduria validation - Colombian id

`POST /api/validate/registraduria`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid Colombian ID and return corresponding values of that person.
Optionally, you can set isForeign flag to true to check for foreign people living in Colombia.
An example could be a Mexican person with a Colombian ID.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string |  |  |
| `emissionDate` | string (dd/mm/yyyy) |  | mandatory if isForeign is true, otherwise optional |
| `fullName` | string |  |  |
| `isForeign` | boolean |  |  |
| `nameBean` | NameBean |  |  |
| `nameBean.fullName` | string |  |  |
| `nameBean.fullNameNativeScript` | string |  |  |
| `nameBean.firstNameNativeScript` | string |  |  |
| `nameBean.paternalLastNameNativeScript` | string |  |  |
| `nameBean.maternalLastNameNativeScript` | string |  |  |
| `nameBean.machineReadableFullName` | string |  | Full name from Barcode or MRZ |
| `nameBean.firstName` | string |  |  |
| `nameBean.middleName` | string |  |  |
| `nameBean.givenName` | string |  |  |
| `nameBean.givenNameMrz` | string |  |  |
| `nameBean.initials` | string |  | Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide |
| `nameBean.nameSuffix` | string |  |  |
| `nameBean.paternalLastName` | string |  |  |
| `nameBean.maternalLastName` | string |  |  |
| `nameBean.lastNameMrz` | string |  |  |
| `nameBean.familyName` | string |  |  |

## Responses

### 200

Response: - data: Object with following fields. - anio_resolucion: Integer. - codigo_error_datos_cedula: Integer. - codigo_respuesta: Integer. - date: String. - departamento_expedicion: String. - descripcion_estado: String. - estado_cedula: Integer. - fecha_expedicion: String. - informacion_adicional: String. - municipio_expedicion: String. - nombre_completo: String. - nuip: Integer. - numero_resolucion: Integer. - particula: String. - primer_apellido: String. - primer_nombre: String. - segundo_apellido: String. - segundo_nombre: String. - error: String. - findings: String []. - status: Boolean. A response example for foreigners is: ``` { "data": { "ce": "456123", "estado": "VIGENTE", "fecha_expedicion": "02/10/2019", "fecha_nacimiento": "05/03/1956", "fecha_vencimiento": "01/10/2024", "nacionalidad": "CHILENA", "nombre_completo": "JUAN ALEJANDRO PEREZ LOPEZ" }, "error": "", "findings": [], "status": true } ```

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/registraduria \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/registraduria", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/registraduria", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/registraduria"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/registraduria")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/registraduria");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-registraduria-ppt`
- URL: https://developer.incode.com/api-reference/api-validate-registraduria-ppt/
- Markdown: https://developer.incode.com/api-reference/api-validate-registraduria-ppt.md
- Endpoint: `POST /api/validate/registraduria-ppt`

# Colombia - Temporary Residency / PPT Validation

`POST /api/validate/registraduria-ppt`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for a valid Colombian temporary residency ID and return the corresponding values of that person.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string |  |  |
| `emissionDate` | string (dd/mm/yyyy) |  | mandatory if isForeign is true, otherwise optional |
| `fullName` | string |  |  |
| `isForeign` | boolean |  |  |
| `nameBean` | NameBean |  |  |
| `nameBean.fullName` | string |  |  |
| `nameBean.fullNameNativeScript` | string |  |  |
| `nameBean.firstNameNativeScript` | string |  |  |
| `nameBean.paternalLastNameNativeScript` | string |  |  |
| `nameBean.maternalLastNameNativeScript` | string |  |  |
| `nameBean.machineReadableFullName` | string |  | Full name from Barcode or MRZ |
| `nameBean.firstName` | string |  |  |
| `nameBean.middleName` | string |  |  |
| `nameBean.givenName` | string |  |  |
| `nameBean.givenNameMrz` | string |  |  |
| `nameBean.initials` | string |  | Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide |
| `nameBean.nameSuffix` | string |  |  |
| `nameBean.paternalLastName` | string |  |  |
| `nameBean.maternalLastName` | string |  |  |
| `nameBean.lastNameMrz` | string |  |  |
| `nameBean.familyName` | string |  |  |

## Responses

### 200

- data: Object with following fields. - estado: String. - fecha_entrega: String. - identidad_venezolana: String. - lugar_entrega: String. - nombre_completo: String. - ppt: String. - tipo_documento: String. - error: String. - findings: String []. - status: Boolean.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/registraduria-ppt \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/registraduria-ppt", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/registraduria-ppt", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/registraduria-ppt"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/registraduria-ppt")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/registraduria-ppt");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-rfc`
- URL: https://developer.incode.com/api-reference/api-validate-rfc/
- Markdown: https://developer.incode.com/api-reference/api-validate-rfc.md
- Endpoint: `POST /api/validate/rfc`

# RFC validation

`POST /api/validate/rfc`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid RFC. If RFC is not found then validRFC field will be false.

`rfcMessageCode` gives the machine-readable reason for the outcome. `RFC_VALID` is the only value for which `validRFC` is true. `RFC_PROVIDER_UNAVAILABLE` means the RFC could NOT be checked — the provider failed — and must not be treated as a negative verdict on the RFC. The full catalog is `RFC_VALID`, `RFC_VALID_NOT_INVOICEABLE`, `RFC_NOT_FOUND`, `RFC_FORMAT_INVALID`, `RFC_PROVIDER_UNAVAILABLE`, `RFC_UNKNOWN`.

A malformed RFC supplied by the caller is rejected with HTTP 400 before any provider call, so `RFC_FORMAT_INVALID` is not returned on this endpoint — see the 400 example below.

`status`, `message` and `errorMessage` are unchanged; `rfcMessageCode`, and `messageCode`/`rfcType` on the error path, are additive.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `rfc` | string |  |  |

## Responses

### 200

RFC validation result

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `validRFC` | boolean |  |  |
| `status` | string |  |  |
| `message` | string |  |  |
| `rfcType` | string |  |  |
| `messageCode` | string |  |  |
| `errorMessage` | string |  |  |
| `rfcMessageCode` | string |  | Machine-readable reason for the validation outcome. Populated on both the success and the error paths. RFC_PROVIDER_UNAVAILABLE means the RFC could not be checked, not that it is invalid. Enum: `RFC_VALID`, `RFC_VALID_NOT_INVOICEABLE`, `RFC_NOT_FOUND`, `RFC_FORMAT_INVALID`, `RFC_PROVIDER_UNAVAILABLE`, `CURP_PROVIDER_UNAVAILABLE`, `CURP_NOT_FOUND`, `CURP_INVALID`, `CURP_DATA_INSUFFICIENT`, `RFC_UNKNOWN` |

### 400

Invalid RFC format

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal server error during validation

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/rfc \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/rfc", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/rfc", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/rfc"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/rfc")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/rfc");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "validRFC": true,
  "status": "OK",
  "message": "RFC Valido",
  "rfcType": "F",
  "messageCode": "0",
  "rfcMessageCode": "RFC_VALID"
}
```

---

- Path: `api-reference/api-validate-rfc-by-curp-v2`
- URL: https://developer.incode.com/api-reference/api-validate-rfc-by-curp-v2/
- Markdown: https://developer.incode.com/api-reference/api-validate-rfc-by-curp-v2.md
- Endpoint: `POST /api/validate/rfc-by-curp/v2`

# RFC validation by CURP v2

`POST /api/validate/rfc-by-curp/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check for valid CURP, use obtained data to calculate RFC and then validate the RFC.
If CURP is not found then renapo_valid field will be false.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  |  |
| `externalId` | string |  |  |

## Responses

### 200

Respuesta con validación de CURP

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/rfc-by-curp/v2");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/api-validate-ssn`
- URL: https://developer.incode.com/api-reference/api-validate-ssn/
- Markdown: https://developer.incode.com/api-reference/api-validate-ssn.md
- Endpoint: `POST /api/validate/ssn`

# SSN Validation

`POST /api/validate/ssn`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Validate a social security number and the person associated with it.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ssn` | string |  | Person's social security number |
| `dateOfBirth` | string (YYYY-MM-DD) |  | Person's birthdate |
| `firstName` | string |  | Person's first name |
| `lastName` | string |  | Person's last name |
| `middleName` | string |  | Person's middle name |
| `email` | string |  | Person's email |

## Responses

### 200

- requestId: Int. Response's status, check catalog. - ssnValid: Boolean. Indicates if ssn information sent is valid. - deceasedPerson: Boolean. Indicates if information sent corresponds to a deceased person. - errorCode: String. Error code in case something goes wrong. - errorCodeDescription: String. Error description in case something goes wrong or if ssn is not valid.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/ssn \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/ssn", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/ssn", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/ssn"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/ssn")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/ssn");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/api-validate-vin`
- URL: https://developer.incode.com/api-reference/api-validate-vin/
- Markdown: https://developer.incode.com/api-reference/api-validate-vin.md
- Endpoint: `POST /api/validate/vin`

# Vehicle Identification Number Validation

`POST /api/validate/vin`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Validate a VIN number and obtain data related to reports about crashes, theft, etc.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `vin` | string |  | Vehicle Identification Number |
| `getPdf` | boolean |  | Obtains pdf with details in base64 format. Default: `false` |

## Responses

### 200

- id: String. - vin: String. - attributes: Object with following fields. - vin: String. - year: String. - make: String. - model: String. - type: String. - made_In: String. - style: String. - engine: String. - success: Boolean. - error: String. - base64PDF: String.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/vin \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/vin", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/vin", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/vin"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/api/validate/vin")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/api/validate/vin");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/attach-signature-on-annotation`
- URL: https://developer.incode.com/api-reference/attach-signature-on-annotation/
- Markdown: https://developer.incode.com/api-reference/attach-signature-on-annotation.md
- Endpoint: `POST /omni/attach-signature-on-annotation`

# Attach signature on annotation

`POST /omni/attach-signature-on-annotation`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Attach signature from interview to previously uploaded PDF contracts at all places annotated with text from request,
with desired height on pdf. Annotations must contain text with either preselected values, or alternative can be supplied.
If user wishes to use signature supplied during onboarding, DEFAULT signature type should be used.

Preselected values are: DEFAULT, INITIALS, PATIENTS_SIGNATURE, NON_MEDICAL_SIGNATURE_1, NON_MEDICAL_SIGNATURE_2,
MEDICAL_SIGNATURE_1, MEDICAL_SIGNATURE_2

Endpoint is intended to be used as fluent api. One call to the api gives in responses id of the signed document which
can then be used in the subsequent call to continuously add another signature on a different annotation.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `contractId` | string | yes | IDs of previously added contract (ID is returned on /add/document?imageType=contract) |
| `signedContractId` | string |  | IDs of previously signed contract (ID is returned as response from the previous /attach/signature/on/annotation) |
| `signatureType` | string |  | One of the preselected values for annotation text Enum: `DEFAULT`, `INITIALS`, `PATIENTS_SIGNATURE`, `NON_MEDICAL_SIGNATURE_1`, `NON_MEDICAL_SIGNATURE_2`, `MEDICAL_SIGNATURE_1`, `MEDICAL_SIGNATURE_2`, `MEDICAL_SIGNATURE_3`, `PATIENTS_SIGNATURE_NAME`, `NON_MEDICAL_SIGNATURE_1_NAME`, `NON_MEDICAL_SIGNATURE_2_NAME`, `MEDICAL_SIGNATURE_1_NAME`, `MEDICAL_SIGNATURE_2_NAME` |
| `alternativeSignatureType` | string |  | If annotation text is none of the preselected values, pass in here the alternative value (signature must be inserted with the alternative value into database as it's signature type) |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "contractId": "<contractId>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "contractId": "<contractId>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E", headers=headers, json={
  "contractId": "<contractId>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"contractId\": \"<contractId>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "contractId": "<contractId>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/attach-signature-on-annotation?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "contractId": "<contractId>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "signedDocumentId": "new signed document ID",
  "signedDocumentURL": "temporary URL to new signed document"
}
```

---

- Path: `api-reference/attach-signature-to-pdf`
- URL: https://developer.incode.com/api-reference/attach-signature-to-pdf/
- Markdown: https://developer.incode.com/api-reference/attach-signature-to-pdf.md
- Endpoint: `POST /omni/attach-signature-to-pdf`

# Attach signature to pdf document

`POST /omni/attach-signature-to-pdf`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Attach signature from interview to supplied pdf at (x, y) coordinates with desired height to desired page on pdf.
Coordinates are relative to left bottom corner of page.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x` | query | integer (int32) | yes | The x axis where to place the signature image (from the left bottom corner of page) |
| `y` | query | integer (int32) | yes | The y axis where to place the signature image (from the left bottom corner of page) |
| `height` | query | integer (int32) | yes | Height of the image when placed in the pdf, keeps aspect ratio. |
| `pageNumber` | query | integer (int32) |  | number of page on which to put the signature image (pages numbering start from 1, default value is 1) |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

Stream of new pdf document file

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf?x=%3Cx%3E&y=%3Cy%3E&height=%3Cheight%3E&pageNumber=%3CpageNumber%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

---

- Path: `api-reference/attach-signature-to-pdf-v2`
- URL: https://developer.incode.com/api-reference/attach-signature-to-pdf-v2/
- Markdown: https://developer.incode.com/api-reference/attach-signature-to-pdf-v2.md
- Endpoint: `POST /omni/attach-signature-to-pdf/v2`

# Attach signature to multiple pdf documents

`POST /omni/attach-signature-to-pdf/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Attach signature from interview to previously uploaded PDF contracts at (x, y) coordinates with desired height to
desired page on pdf. Coordinates are relative to left bottom corner of page. Every document id can have multiple signature
attached to it, hence the array of signature positions for every document.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `signaturePositionsOnContracts` | object |  |  |
| `includeSignedDocumentInResponse` | boolean |  | Includes the signed document in base64 in response. |
| `includeNom151SignatureInResponse` | boolean |  | Includes the Nom 151 signature of the signed document in the response. |
| `includeSignedDocumentWithNom151InResponse` | boolean |  | Includes the signed document with the Nom 151 signature attached in the pdf in the response. |
| `includeCertificateDetailsInResponse` | boolean |  | Include the certificate details with which the Nom151 signature was created. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/attach-signature-to-pdf/v2?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "additionalInformation": {
    "signingDetails": {
      "providedBy": "Advantage Security, S. de R.L. de C.V.",
      "requestedBy": "Incode Technologies Inc.",
      "policyValue": "2.16.484.101.10.316.2.1.1.2.",
      "signingHash": "AHm8P/i2AnvdM8vKfVLWe5xCovA2v/7l3zmWc1+N4HE=",
      "certificateSerial": "2C",
      "signingTimestamp": "1651076647389"
    },
    "signedDocumentBase64": "base64 of pdf document",
    "signedDocumentWithNomSignatureBase64": "base64 of pdf document with nom151"
  }
}
```

---

- Path: `api-reference/attach-stamp-on-annotation`
- URL: https://developer.incode.com/api-reference/attach-stamp-on-annotation/
- Markdown: https://developer.incode.com/api-reference/attach-stamp-on-annotation.md
- Endpoint: `POST /omni/attach-stamp-on-annotation`

# Attach stamp on annotation

`POST /omni/attach-stamp-on-annotation`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Substitute stamps from interview to previously uploaded PDF contracts at all places with pdf text annotations. Annotations
must contain text with preselected values. Preselected values are:
- NAME (NAME_STAMP),
- ADDRESS (ADDRESS_STAMP),
- DATE #ZoneId# #Format#,
- AGE,
- SEX,
- DOB #Format#,
- COUNTRY,
- STATE,
- PHONE,
- TIME #ZoneId# #Format#,
- SECOND_NAME*

Replace parameter ZoneId with full size zone using time zones used in Java8 TimeDate API Replace parameter Format with format
you wish to display the time and date

Stamps are added in Helvetica, size 13. Endpoint is intended to be used as fluent api. One call to the api gives in
responses id of the signed document which can then be used in the subsequent call to continuously add another signature on a different annotation.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `contractId` | string | yes | IDs of previously added contract (ID is returned on /add/document?imageType=contract |
| `customFields` | object |  | Use to add substitute text for stamps with asterisk Eg: `{ "contractId": "e81cd044-98fd-47b0-b0c5-937b22b69977#contract1", "customFields": { "SECOND_NAME": "Luke Skywalker" } }` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "contractId": "<contractId>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "contractId": "<contractId>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation", headers=headers, json={
  "contractId": "<contractId>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"contractId\": \"<contractId>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "contractId": "<contractId>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/attach-stamp-on-annotation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "contractId": "<contractId>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "additionalInformation": {}
}
```

---

- Path: `api-reference/authentication-verify`
- URL: https://developer.incode.com/api-reference/authentication-verify/
- Markdown: https://developer.incode.com/api-reference/authentication-verify.md
- Endpoint: `POST /omni/authentication/verify`

# Verify authentication attempt

`POST /omni/authentication/verify`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Verify the authenticity of an authentication attempt.
Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `transactionId` | string |  |  |
| `token` | string |  |  |
| `interviewToken` | string |  |  |
| `customerId` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `verified` | boolean |  |  |
| `reason` | integer (int32) |  |  |
| `customerId` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/authentication/verify \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/authentication/verify", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/authentication/verify", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/authentication/verify"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/authentication/verify")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/authentication/verify");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "verified": true,
  "reason": 0,
  "customerId": "string"
}
```

---

- Path: `api-reference/authentications-external-search`
- URL: https://developer.incode.com/api-reference/authentications-external-search/
- Markdown: https://developer.incode.com/api-reference/authentications-external-search.md
- Endpoint: `POST /omni/authentications/external/search`

# Fetch authentication attempts

`POST /omni/authentications/external/search`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This API allows for searching through stored authentication records, providing insight into both 1:1 (one to one) and 1:N (one to many) authentication modes. It includes data for successful and failed login attempts, enabling an overview of authentication activity within the organization. 
Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `offset` | query | integer (int32) |  | Default: `0` |
| `limit` | query | integer (int32) |  | Default: `30` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `authenticationAttempts` | array[AuthenticationAttemptExternalDto] |  |  |
| `authenticationAttempts.customerId` | string |  |  |
| `authenticationAttempts.deviceType` | string |  | Enum: `IOS`, `ANDROID`, `WEBAPP` |
| `authenticationAttempts.deviceName` | string |  |  |
| `authenticationAttempts.version` | string |  |  |
| `authenticationAttempts.isSpoof` | boolean |  |  |
| `authenticationAttempts.get_updatedAt` | integer (int64) |  |  |
| `authenticationAttempts.url` | string |  |  |
| `authenticationAttempts.isAuthenticated` | boolean |  |  |
| `authenticationAttempts.recognitionConfidence` | number (float) |  |  |
| `authenticationAttempts.source` | string |  |  |
| `authenticationAttempts.transactionId` | string |  |  |
| `authenticationAttempts.authenticationType` | string |  | Enum: `ONE_TO_ONE`, `ONE_TO_N` |
| `authenticationAttempts.authenticationMethod` | string |  | Enum: `server`, `local`, `hybrid` |
| `authenticationAttempts.faceEnrollmentForced` | boolean |  |  |
| `authenticationAttempts.isBlocklisted` | boolean |  |  |
| `authenticationAttempts.clientRecognitionThreshold` | number (float) |  |  |
| `authenticationAttempts.clientLivenessThreshold` | number (float) |  |  |
| `authenticationAttempts.blocklistConfidence` | number (float) |  |  |
| `authenticationAttempts.videoRecordingUrl` | string |  |  |
| `total` | integer (int32) |  |  |
| `more` | boolean |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/authentications/external/search?offset=0&limit=30");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "authenticationAttempts": [
    {
      "customerId": "string",
      "deviceType": "IOS",
      "deviceName": "string",
      "version": "string",
      "isSpoof": true,
      "get_updatedAt": 0,
      "url": "string",
      "isAuthenticated": true,
      "recognitionConfidence": 0,
      "source": "string",
      "transactionId": "string",
      "authenticationType": "ONE_TO_ONE",
      "authenticationMethod": "server",
      "faceEnrollmentForced": true,
      "isBlocklisted": true,
      "clientRecognitionThreshold": 0,
      "clientLivenessThreshold": 0,
      "blocklistConfidence": 0,
      "videoRecordingUrl": "string"
    }
  ],
  "total": 0,
  "more": true
}
```

---

- Path: `api-reference/b2b-onboarding-request-new`
- URL: https://developer.incode.com/api-reference/b2b-onboarding-request-new/
- Markdown: https://developer.incode.com/api-reference/b2b-onboarding-request-new.md
- Endpoint: `POST /omni/b2b/onboarding/request-new`

# Request new onboarding for integrations

`POST /omni/b2b/onboarding/request-new`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint starts new onboarding session for integration and generates onboarding link.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `integrationReference` | string | yes | Integration reference for the onboarding request. |
| `loginHint` | string |  | User login hint. |
| `applicantId` | string |  | Existing applicant id. |
| `externalCustomerId` | string |  | Id that identifies user in clients external system. |
| `name` | string |  | Applicant name. |
| `meetingLink` | string |  | Meeting link. |
| `linkValidityInMinutes` | integer (int32) |  | Link validity in minutes. |
| `notification` | NotificationDelivery | yes | Notification configuration |
| `notification.type` | string | yes | Notification type, can be SMS, EMAIL or URL. Enum: `SMS`, `EMAIL`, `URL` |
| `notification.email` | string |  | Applicant email. Required for notification type EMAIL. |
| `notification.phone` | string |  | Applicant phone. Required for notification type SMS. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string |  | Generated onboarding URL. |
| `interviewId` | string |  | Interview identifier. |

### 400

Custom error statuses: - 4300: Integration not found by id - 4301: Employee by login factor cannot be found

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "integrationReference": "<integrationReference>",
    "notification": {
      "type": "<type>"
    }
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "integrationReference": "<integrationReference>",
      "notification": {
        "type": "<type>"
      }
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new", headers=headers, json={
  "integrationReference": "<integrationReference>",
  "notification": {
    "type": "<type>"
  }
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"integrationReference\": \"<integrationReference>\",\n  \"notification\": {\n    \"type\": \"<type>\"\n  }\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "integrationReference": "<integrationReference>",
  "notification": {
    "type": "<type>"
  }
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "integrationReference": "<integrationReference>",
  "notification": {
    "type": "<type>"
  }
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "url": "string",
  "interviewId": "string"
}
```

---

- Path: `api-reference/b2b-v1-authentications-add-selfie-to-identity`
- URL: https://developer.incode.com/api-reference/b2b-v1-authentications-add-selfie-to-identity/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-authentications-add-selfie-to-identity.md
- Endpoint: `POST /omni/b2b/v1/authentications/add-selfie-to-identity`

# Add selfie to identity template

`POST /omni/b2b/v1/authentications/add-selfie-to-identity`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Adds the selfie from the specified or latest authentication attempt to the user's identity template set.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  |  |
| `attemptId` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/authentications/add-selfie-to-identity");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/b2b-v1-devices-info`
- URL: https://developer.incode.com/api-reference/b2b-v1-devices-info/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-devices-info.md
- Endpoint: `GET /omni/b2b/v1/devices/info`

# Fetch device info list

`GET /omni/b2b/v1/devices/info`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch all device information entries associated with the given onboarding Session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string | yes | Represents Session id for which device data are requested. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/devices/info?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
[
  {
    "ipAddress": "string",
    "hash": "string",
    "deviceType": "IOS",
    "osVersion": "string",
    "deviceModel": "string",
    "sdkVersion": "string",
    "browser": "string",
    "hasLiedBrowser": true,
    "longitude": 0,
    "latitude": 0,
    "location": "string",
    "getmAdminArea": "CA",
    "getmSubAdminArea": "Santa Clara",
    "getmLocality": "string",
    "getmSubLocality": "Mission District",
    "getmThoroughfare": "string",
    "getmSubThoroughfare": "string",
    "getmPostalCode": 95014,
    "getmCountryCode": "US",
    "getmCountryName": "United States",
    "hostingApp": "Onboarding"
  }
]
```

---

- Path: `api-reference/b2b-v1-identities`
- URL: https://developer.incode.com/api-reference/b2b-v1-identities/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-identities.md
- Endpoint: `GET /omni/b2b/v1/identities/{id}`

# Fetch Identity data

`GET /omni/b2b/v1/identities/{id}`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches data associated with identity, which was gathered in onboarding.
Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `identityId` | string |  |  |
| `originalSessionId` | string |  |  |
| `ocrData` | IdentityOcrData |  |  |
| `ocrData.name` | string |  |  |
| `ocrData.phone` | string |  |  |
| `ocrData.email` | string |  |  |
| `ocrData.dateOfBirth` | string |  |  |
| `ocrData.personalIdNumber` | string |  |  |
| `ocrData.address` | string |  |  |
| `ocrData.nationalNumber` | string |  |  |
| `ocrData.countryCode` | string |  |  |
| `ocrData.documentType` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `ocrData.docExpiryDate` | integer (int32) |  |  |
| `ocrData.displayName` | string |  |  |
| `ocrData.fullNameMrz` | string |  |  |
| `ocrData.gender` | string |  |  |
| `documents` | array[IdentityDocument] |  |  |
| `documents.documentNumber` | string |  |  |
| `documents.issuingCountry` | string |  |  |
| `documents.documentType` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `documents.documentExpiryDate` | integer (int32) |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/identities/%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "identityId": "string",
  "originalSessionId": "string",
  "ocrData": {
    "name": "string",
    "phone": "string",
    "email": "string",
    "dateOfBirth": "string",
    "personalIdNumber": "string",
    "address": "string",
    "nationalNumber": "string",
    "countryCode": "string",
    "documentType": "Unknown",
    "docExpiryDate": 0,
    "displayName": "string",
    "fullNameMrz": "string",
    "gender": "string"
  },
  "documents": [
    {
      "documentNumber": "string",
      "issuingCountry": "string",
      "documentType": "Unknown",
      "documentExpiryDate": 0
    }
  ]
}
```

---

- Path: `api-reference/b2b-v1-sessions-continue`
- URL: https://developer.incode.com/api-reference/b2b-v1-sessions-continue/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-sessions-continue.md
- Endpoint: `POST /omni/b2b/v1/sessions/continue`

# Continue onboarding session

`POST /omni/b2b/v1/sessions/continue`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Issues a new token for an ACTIVE existing onboarding session.
The session is located by exactly one of: its sessionId, or its externalId
(the value supplied as externalId on /omni/start).
Providing zero or both identifiers is rejected with 400.

Notes:
- Continuations count against the same per-session limits as end-user continuations.
Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  | Id of the session to continue. Exactly one of sessionId or externalId must be provided. |
| `externalId` | string |  | Id that identifies the user in the client's system; matches the externalId supplied on /omni/start. Exactly one of sessionId or externalId must be provided. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  | Identifies the onboarding session that is continued. Can be used for fetching data about that session in future calls. |
| `token` | string |  | Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls. |
| `interviewCode` | string |  | This value is used for connecting to conference call. |
| `flowType` | string |  | Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore). Enum: `configuration`, `flow`, `workflow` |
| `idCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected. |
| `idDetectionTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, if ID is not detected. |
| `selfieCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing selfie. |
| `idCaptureRetries` | integer (int32) |  | Number of ID captures after which user should be taken to next screen. |
| `selfieCaptureRetries` | integer (int32) |  | Number of selfie captures after which user should be taken to next screen. |
| `curpValidationRetries` | integer (int32) |  | Number of curp validations after which user should be taken to next screen. (only for Mexico) |

### 400

Custom error statuses: - 4086: Current session continuation period is expired. - 4087: Max number of session continuations reached - 4088: Session is not active - 4089: Zero or both of sessionId / externalId provided

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 404

Session not found for the given sessionId or externalId within the api key's organization

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  | Identifies the onboarding session that is continued. Can be used for fetching data about that session in future calls. |
| `token` | string |  | Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls. |
| `interviewCode` | string |  | This value is used for connecting to conference call. |
| `flowType` | string |  | Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore). Enum: `configuration`, `flow`, `workflow` |
| `idCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected. |
| `idDetectionTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, if ID is not detected. |
| `selfieCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing selfie. |
| `idCaptureRetries` | integer (int32) |  | Number of ID captures after which user should be taken to next screen. |
| `selfieCaptureRetries` | integer (int32) |  | Number of selfie captures after which user should be taken to next screen. |
| `curpValidationRetries` | integer (int32) |  | Number of curp validations after which user should be taken to next screen. (only for Mexico) |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/continue");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "sessionId": "string",
  "token": "string",
  "interviewCode": "string",
  "flowType": "configuration",
  "idCaptureTimeout": 0,
  "idDetectionTimeout": 0,
  "selfieCaptureTimeout": 0,
  "idCaptureRetries": 0,
  "selfieCaptureRetries": 0,
  "curpValidationRetries": 0
}
```

---

- Path: `api-reference/b2b-v1-sessions-listing`
- URL: https://developer.incode.com/api-reference/b2b-v1-sessions-listing/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-sessions-listing.md
- Endpoint: `GET /omni/b2b/v1/sessions/listing`

# Fetch session listing

`GET /omni/b2b/v1/sessions/listing`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch onboarding sessions listing.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `loginHint` | query | string | yes | Login hint to search onboarding sessions by (e.g. email). |
| `maxItems` | query | integer (int32) |  | Maximum number of items to retrieve (has to be positive). Optional, defaults to 10. Default: `10` |
| `sessionScore` | query | string |  | Filter by session score: PASS matches OK and MANUAL_OK, FAIL matches FAIL and MANUAL_FAIL. Optional. Enum: `PASS`, `FAIL` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/sessions/listing?loginHint=%3CloginHint%3E&maxItems=10&sessionScore=%3CsessionScore%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
[
  {
    "sessionId": "string",
    "updatedAt": 0,
    "onboardingStatus": "UNKNOWN",
    "totalScoreStatus": "OK"
  }
]
```

---

- Path: `api-reference/b2b-v1-watchlist-integrator-batch`
- URL: https://developer.incode.com/api-reference/b2b-v1-watchlist-integrator-batch/
- Markdown: https://developer.incode.com/api-reference/b2b-v1-watchlist-integrator-batch.md
- Endpoint: `POST /omni/b2b/v1/watchlist/integrator/batch`

# Add custom watchlist entries for child organizations

`POST /omni/b2b/v1/watchlist/integrator/batch`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Imports custom watchlist entries from a CSV file and assigns each row to the child organization identified by clientId.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `file` | string (binary) |  | CSV file with integrator watchlist rows. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/b2b/v1/watchlist/integrator/batch");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/batch-auth-stats`
- URL: https://developer.incode.com/api-reference/batch-auth-stats/
- Markdown: https://developer.incode.com/api-reference/batch-auth-stats.md
- Endpoint: `POST /omni/batch/auth-stats`

# Insert authentications in batch

`POST /omni/batch/auth-stats`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Inserts face authentications in batch.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array[QRScanAttempt] |  |  |
| `data.id` | string |  | Identity (customer) id. |
| `data.photo` | string |  | Base64 of photo. |
| `data.confidence` | number (float) |  | Match confidence. |
| `data.timestamp` | integer (int64) |  | Timestamp |
| `data.sourceId` | string |  | Source identifier of batch of authentications |
| `data.deviceId` | string |  | User device id |
| `data.reasonCodes` | array[string] |  | Reason codes |
| `data.blocked` | boolean |  | Flag indicating if user is on a blocklist |
| `data.blocklistConfidence` | number (float) |  | Confidence score related to block list |
| `data.matchedWatchlistId` | string |  | Id of the matched watchlist entry when blocklist validation exceeds the confidence threshold |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/batch/auth-stats \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/batch/auth-stats", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/batch/auth-stats", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/batch/auth-stats"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/batch/auth-stats")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/batch/auth-stats");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/calculate-contract-nom151-signature`
- URL: https://developer.incode.com/api-reference/calculate-contract-nom151-signature/
- Markdown: https://developer.incode.com/api-reference/calculate-contract-nom151-signature.md
- Endpoint: `POST /omni/calculate-contract-nom151-signature`

# Calculate contract Nom151 signature

`POST /omni/calculate-contract-nom151-signature`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This api endpoint calculates the Nom151 signature of an already signed contract and returns the signature.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `includeSignedDocumentInResponse` | boolean |  | Includes the signed document in base64 in response |
| `includeCertificateDetailsInResponse` | boolean |  | Includes the signed document with the Nom 151 signature attached in the pdf in the response |
| `signedContractId` | string | yes | The id of the already signed contract |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "signedContractId": "<signedContractId>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "signedContractId": "<signedContractId>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature", headers=headers, json={
  "signedContractId": "<signedContractId>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"signedContractId\": \"<signedContractId>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "signedContractId": "<signedContractId>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/calculate-contract-nom151-signature");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "signedContractId": "<signedContractId>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "additionalInformation": {
    "signedDocumentNom151": "nom151 signature",
    "signedDocumentBase64": "base64 of signed document",
    "signedDocumentWithNomSignatureBase64": "base64 of signed contract with attached nom151 signature"
  }
}
```

---

- Path: `api-reference/chat`
- URL: https://developer.incode.com/api-reference/chat/
- Markdown: https://developer.incode.com/api-reference/chat.md
- Endpoint: `POST /omni/chat`

# Send conference chat

`POST /omni/chat`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Store conference chat. The executive should send the whole chat at the end of conference call (just before finish is called).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | Interview id. |
| `chat` | array[ChatDto] | yes |  |
| `chat.date` | integer (int64) | yes | UTC timestamp. |
| `chat.body` | string | yes | Single message in chat. |
| `chat.author` | string |  | Author of the message. Enum: `user`, `interviewer` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/chat \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/chat", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/chat", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/chat"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/chat")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/chat");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/code-generate`
- URL: https://developer.incode.com/api-reference/code-generate/
- Markdown: https://developer.incode.com/api-reference/code-generate.md
- Endpoint: `GET /omni/code/generate`

# Generate interview code

`GET /omni/code/generate`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Generate interview code for this session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

interviewCode: String. 6 characters. Newly generated code to be verified before connecting to video conference.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/code/generate \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/code/generate", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/code/generate", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/code/generate"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/code/generate")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/code/generate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/code-verify`
- URL: https://developer.incode.com/api-reference/code-verify/
- Markdown: https://developer.incode.com/api-reference/code-verify.md
- Endpoint: `POST /omni/code/verify`

# Verify interview code

`POST /omni/code/verify`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Verify interview code before connecting to video conference.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewCode` | string |  | Interview code to be verified against given session. |

## Responses

### 200

Custom error status: - 4014: Invalid interview code

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/code/verify \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/code/verify", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/code/verify", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/code/verify"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/code/verify")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/code/verify");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/compare-sms-otp`
- URL: https://developer.incode.com/api-reference/compare-sms-otp/
- Markdown: https://developer.incode.com/api-reference/compare-sms-otp.md
- Endpoint: `GET /omni/compare/sms-otp`

# Compare/Validate OTP code obtained through SMS for onboarding

`GET /omni/compare/sms-otp`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Send OTP code obtained through SMS to validate an onboarding.
Phone number is obtained from interview data, so phone step it's required.
Success will be false if code sent doesn't match.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `code` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/compare/sms-otp?code=%3Ccode%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/conference-add-event`
- URL: https://developer.incode.com/api-reference/conference-add-event/
- Markdown: https://developer.incode.com/api-reference/conference-add-event.md
- Endpoint: `POST /omni/conference/add/event`

# Add conference event

`POST /omni/conference/add/event`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Send (OpenTok) conference event. Any connection issue caught by webapp could be reported using this call.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `get_version` | integer (int64) |  |  |
| `interviewId` | string | yes | Interview ID for which event is reported. |
| `opentokSessionId` | string | yes | Opentok session ID of current video conference. |
| `eventType` | string | yes | Opentok event type. Could be anything that Opentok sends, e.g. StreamDisconnected, StreamReconnected, VideoDisabled, VideoEnabled... |
| `details` | string |  | Any description that Opentok sends. |
| `eventSource` | string | yes | Indicate event caught on customer or executive side. Enum: `customer`, `executive` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/conference/add/event \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "interviewId": "<interviewId>",
    "opentokSessionId": "<opentokSessionId>",
    "eventType": "<eventType>",
    "eventSource": "<eventSource>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/conference/add/event", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "interviewId": "<interviewId>",
      "opentokSessionId": "<opentokSessionId>",
      "eventType": "<eventType>",
      "eventSource": "<eventSource>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/conference/add/event", headers=headers, json={
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "eventType": "<eventType>",
  "eventSource": "<eventSource>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/conference/add/event"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"interviewId\": \"<interviewId>\",\n  \"opentokSessionId\": \"<opentokSessionId>\",\n  \"eventType\": \"<eventType>\",\n  \"eventSource\": \"<eventSource>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/conference/add/event")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "eventType": "<eventType>",
  "eventSource": "<eventSource>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/conference/add/event");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "eventType": "<eventType>",
  "eventSource": "<eventSource>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/conference-get-events`
- URL: https://developer.incode.com/api-reference/conference-get-events/
- Markdown: https://developer.incode.com/api-reference/conference-get-events.md
- Endpoint: `GET /omni/conference/get/events`

# Fetch conference events

`GET /omni/conference/get/events`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch conference events for given 'interviewId'.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes | Interview id. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/conference/get/events?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/conference-photo`
- URL: https://developer.incode.com/api-reference/conference-photo/
- Markdown: https://developer.incode.com/api-reference/conference-photo.md
- Endpoint: `POST /omni/conference/photo`

# Store conference photos

`POST /omni/conference/photo`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

A bank executive can ask the customer to additionally capture his face or document. These will be stored in DB.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Base64 string representation of the image. |
| `interviewId` | string |  | ID of interview. |
| `origin` | string | yes | This parameter indicates which type of photo is taken Enum: `selfie`, `front`, `back`, `poa` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/conference/photo \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "<origin>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/conference/photo", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "origin": "<origin>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/conference/photo", headers=headers, json={
  "origin": "<origin>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/conference/photo"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"origin\": \"<origin>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/conference/photo")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "origin": "<origin>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/conference/photo");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "origin": "<origin>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/conference-report-issue`
- URL: https://developer.incode.com/api-reference/conference-report-issue/
- Markdown: https://developer.incode.com/api-reference/conference-report-issue.md
- Endpoint: `POST /omni/conference/report-issue`

# Report conference issue

`POST /omni/conference/report-issue`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

An executive can report any issue by this call.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string | yes | Interview ID for which issue is reported. |
| `opentokSessionId` | string | yes | Opentok session ID of current video conference. |
| `details` | string | yes | Any description that Opentok sends. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/conference/report-issue \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "interviewId": "<interviewId>",
    "opentokSessionId": "<opentokSessionId>",
    "details": "<details>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/conference/report-issue", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "interviewId": "<interviewId>",
      "opentokSessionId": "<opentokSessionId>",
      "details": "<details>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/conference/report-issue", headers=headers, json={
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "details": "<details>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/conference/report-issue"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"interviewId\": \"<interviewId>\",\n  \"opentokSessionId\": \"<opentokSessionId>\",\n  \"details\": \"<details>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/conference/report-issue")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "details": "<details>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/conference/report-issue");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "interviewId": "<interviewId>",
  "opentokSessionId": "<opentokSessionId>",
  "details": "<details>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/credentials-mdl`
- URL: https://developer.incode.com/api-reference/credentials-mdl/
- Markdown: https://developer.incode.com/api-reference/credentials-mdl.md
- Endpoint: `POST /omni/credentials/mdl`

# Issue a device-bound mDL for the current interview

`POST /omni/credentials/mdl`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Builds credential claims from the interview identified by the access token and issues a device-bound ISO/IEC 18013-5 mDL bound to the supplied device public key.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `devicePublicKey` | string |  | Holder device public key as Base64 (standard) X.509 SubjectPublicKeyInfo DER, EC P-256. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `docType` | string |  | mdoc docType, e.g. org.iso.18013.5.1.mDL. |
| `issuerSigned` | string |  | Base64 (standard) of the CBOR-encoded IssuerSigned (nameSpaces + issuerAuth). |
| `expiresAt` | string (date-time) |  | When the mDL stops being valid (MSO validityInfo.validUntil). |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/credentials/mdl \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/credentials/mdl", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/credentials/mdl", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/credentials/mdl"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/credentials/mdl")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/credentials/mdl");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "docType": "string",
  "issuerSigned": "string",
  "expiresAt": "string"
}
```

---

- Path: `api-reference/cross-doc-data-check-results`
- URL: https://developer.incode.com/api-reference/cross-doc-data-check-results/
- Markdown: https://developer.incode.com/api-reference/cross-doc-data-check-results.md
- Endpoint: `GET /omni/cross-doc-data-check/results`

# Get cross-document comparison results

`GET /omni/cross-doc-data-check/results`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch cross-document data check results for a given interview ID. If no ID is provided, it defaults to the user's ID from the JWT.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

Response contains a map of results with detailed comparison information.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/cross-doc-data-check/results?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "additionalProp1": [
    {
      "interviewId": "string",
      "comparisonName": "string",
      "comparisonId": "string",
      "result": "OK",
      "leftValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "rightValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "severity": "ultra_low"
    }
  ],
  "additionalProp2": [
    {
      "interviewId": "string",
      "comparisonName": "string",
      "comparisonId": "string",
      "result": "OK",
      "leftValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "rightValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "severity": "ultra_low"
    }
  ]
}
```

---

- Path: `api-reference/curp-validation-error-codes`
- URL: https://developer.incode.com/api-reference/curp-validation-error-codes/
- Markdown: https://developer.incode.com/api-reference/curp-validation-error-codes.md
- Endpoint: `POST /omni/add/curp`

# CURP Validation Error Codes

`POST /omni/add/curp`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add curp and the validation process result to interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used. |

## Responses

### 200

Respuesta con validación de CURP

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 500

Internal error during CURP validation.

### 504

The request to validate the CURP exceeded the allowed time limit

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/add/curp \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/add/curp", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/add/curp", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/add/curp"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/add/curp")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/add/curp");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "curp": "XXXX820814HDFABC01",
  "sex": "MUJER",
  "nationality": "MEX",
  "result": "success",
  "requestData": {
    "name": "JUANA",
    "firstLastName": "PEREZ",
    "secondLastName": "LOPEZ",
    "gender": "M",
    "birthDate": "14/08/1982",
    "state": "DF"
  },
  "transactionId": "transaction1234567890",
  "renapo_valid": true,
  "names": "JUANA",
  "paternal_surname": "PEREZ",
  "mothers_maiden_name": "LOPEZ",
  "birthdate": "14/08/1982",
  "entity_birth": "DF",
  "probation_document": "1",
  "probation_document_data": {
    "foja": "",
    "numEntidadReg": "09",
    "libro": "",
    "NumRegExtranjeros": "",
    "cveEntidadNac": "DF",
    "numActa": "00001",
    "CRIP": "",
    "tomo": "",
    "cveEntidadEmisora": "",
    "anioReg": "1982",
    "cveMunicipioReg": "001",
    "FolioCarta": ""
  },
  "status_curp": "RCN",
  "deceasedStatus": "ALIVE"
}
```

---

- Path: `api-reference/delete-interviews`
- URL: https://developer.incode.com/api-reference/delete-interviews/
- Markdown: https://developer.incode.com/api-reference/delete-interviews.md
- Endpoint: `POST /omni/delete/interviews`

# Delete Multiple onboarding sessions with multiple options.

`POST /omni/delete/interviews`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

> **Deprecated** — this endpoint is marked deprecated in the Omni API specification.

Delete all onboarding sessions by given array of interview ids. The endpoint is executed asynchronously.
Note:
Requires admin login token reference - /executive/log-in
Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.
Finally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewIds` | array[string] |  |  |
| `cleanerConfiguration` | CleanerConfigurationDto |  |  |
| `cleanerConfiguration.deletePiiFieldsOnly` | boolean |  | Flag indicating if this is partial delete, where only PII fields should be removed. Default: `false` |
| `cleanerConfiguration.piiFieldsToKeep` | array[string] |  |  |
| `cleanerConfiguration.keepEnrolledUser` | boolean |  | Flag indicating if user that was previously enrolled from this session should stay enrolled in the system after this session is deleted Default: `false` |
| `cleanerConfiguration.keepTemplates` | boolean |  | Flag indicating if face templates created during onboarding process, should remain in DB Default: `false` |
| `cleanerConfiguration.keepImages` | boolean |  | Flag indicating if images captured during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.keepDeviceFingerprints` | boolean |  | Flag indicating if device fingerprint stored during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.keepEvents` | boolean |  | Flag indicating if events stored during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.keepValidationTests` | boolean |  | Flag indicating if validation tests stored during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.keepVideoArchives` | boolean |  | Flag indicating if video archives stored during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.keepConferenceEvents` | boolean |  | Flag indicating if events stored during conference video call should remain in the system Default: `false` |
| `cleanerConfiguration.keepChats` | boolean |  | Flag indicating if chat stored during conference video call should remain in the system Default: `false` |
| `cleanerConfiguration.keepStats` | boolean |  | Flag indicating if statistics stored during onboarding process should remain in the system Default: `false` |
| `cleanerConfiguration.deletionMode` | string |  | Specifies the type of deletion to perform. Enum: `BIOMETRICS`, `PII`, `FULL` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `taskId` | string |  |  |
| `statusUri` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/delete/interviews \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/delete/interviews", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/delete/interviews", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/delete/interviews"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/delete/interviews")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/delete/interviews");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "taskId": "string",
  "statusUri": "string"
}
```

---

- Path: `api-reference/delete-watchlist-single-record`
- URL: https://developer.incode.com/api-reference/delete-watchlist-single-record/
- Markdown: https://developer.incode.com/api-reference/delete-watchlist-single-record.md
- Endpoint: `POST /omni/delete/watchlist/single-record`

# Delete custom watchlist entry

`POST /omni/delete/watchlist/single-record`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string |  | Id of entry in watchlist database |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/delete/watchlist/single-record \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/delete/watchlist/single-record", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/delete/watchlist/single-record", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/delete/watchlist/single-record"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/delete/watchlist/single-record")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/delete/watchlist/single-record");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/device-stats`
- URL: https://developer.incode.com/api-reference/device-stats/
- Markdown: https://developer.incode.com/api-reference/device-stats.md
- Endpoint: `POST /omni/device/stats`

# Update device stats

`POST /omni/device/stats`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Sends information about collected capture frame statistics

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `inspectorOpened` | boolean |  | Flag indicating web browser inspector detected |
| `frontIdStatsAnalysisStatus` | string |  | Status of the front ID capture analysis Enum: `PASS`, `UNCLEAR`, `FAIL` |
| `backIdStatsAnalysisStatus` | string |  | Status of the back ID capture analysis Enum: `PASS`, `UNCLEAR`, `FAIL` |
| `selfieStatsAnalysisStatus` | string |  | Status of the selfie ID capture analysis Enum: `PASS`, `UNCLEAR`, `FAIL` |
| `motionStatus` | string |  | Status of motion analysis Enum: `PASS`, `UNCLEAR`, `FAIL` |
| `virtualCameraDetected` | boolean |  | Flag indicating virtual camera was detected |
| `cameraLabelInspectionStatus` | string |  | Status of the camera label inspection Enum: `PASS`, `UNCLEAR`, `FAIL` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/device/stats \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/device/stats", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/device/stats", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/device/stats"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/device/stats")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/device/stats");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/es-documents-signed-v2`
- URL: https://developer.incode.com/api-reference/es-documents-signed-v2/
- Markdown: https://developer.incode.com/api-reference/es-documents-signed-v2.md
- Endpoint: `GET /omni/es/documents/signed/v2`

# Get signed documents

`GET /omni/es/documents/signed/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used to get signed documents for a session

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `pageNo` | query | integer (int32) |  | Default: `0` |
| `pageSize` | query | integer (int32) |  | Default: `20` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documents` | array[ESignedDocumentDto] |  |  |
| `documents.documentRef` | string |  |  |
| `documents.documentUrl` | string |  |  |
| `documents.qesAttemptId` | string |  |  |
| `total` | integer (int32) |  |  |
| `more` | boolean |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/es/documents/signed/v2?interviewId=%3CinterviewId%3E&pageNo=0&pageSize=20");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "documents": [
    {
      "documentRef": "string",
      "documentUrl": "string",
      "qesAttemptId": "string"
    }
  ],
  "total": 0,
  "more": true
}
```

---

- Path: `api-reference/executive-events-find`
- URL: https://developer.incode.com/api-reference/executive-events-find/
- Markdown: https://developer.incode.com/api-reference/executive-events-find.md
- Endpoint: `POST /omni/executive-events/find`

# Fetch audit logs

`POST /omni/executive-events/find`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Use this API to retrieve records of activities performed within your organization. These logs include key events such as changes to organization settings, executive actions, updates to flows, workflows and user identities, as well as changes made to organization’s watchlist.
Note: Requires admin login token.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `avoidCounting` | query | boolean |  |  |
| `pageable` | query | Pageable | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `codes` | array[string] |  | Enum: `SESSION_DELETED`, `IDENTITY_DELETED`, `SESSION_FACE_ADDED`, `IDENTITY_FACE_ADDED`, `SESSION_MANUALLY_APPROVED`, `SESSION_MANUALLY_REJECTED`, `SESSION_VIEWED`, `SESSIONS_VIEWED`, `SESSION_PDF_DOWNLOADED`, `LOGIN_ATTEMPT`, `LOGOUT`, `USER_CREATED`, `USER_DELETED`, `USER_UPDATED`, `USER_API_ACCESS_BLOCKED`, `USER_API_ACCESS_UNBLOCKED`, `USER_IAM_MIGRATION_INITIATED`, `CONFIGURATION_CREATE`, `CONFIGURATION_CLONED`, `CONFIGURATION_RESET`, `CONFIGURATION_UPDATE`, `FLOW_CREATE`, `FLOW_UPDATE`, `FLOW_DELETE`, `FLOW_CLONE`, `IDENTITIES_REPORT_GENERATED`, `SESSIONS_REPORT_GENERATED`, `AUTHENTICATIONS_REPORT_GENERATED`, `WATCH_LISTS_REPORT_GENERATED`, `USERS_REPORT_GENERATED`, `DOUBLE_CHECK_RECORD_FETCHED`, `DOUBLE_CHECK_RECORD_UPDATED`, `DOUBLE_CHECK_FINISHED`, `SESSION_ANTIFRAUD_RESOLVED`, `WATCH_LISTS_ENTRY_CREATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_UPDATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_CREATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_DELETED`, `WATCHLIST_PROVIDER_SETTINGS_CREATED`, `WATCHLIST_PROVIDER_SETTINGS_UPDATED`, `WATCHLIST_PROVIDER_SETTINGS_DELETED`, `PAYMENTS_PROVIDER_SETTINGS_CREATED`, `PAYMENTS_PROVIDER_SETTINGS_UPDATED`, `PAYMENTS_PROVIDER_SETTINGS_DELETED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_UPDATED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_DELETED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_CREATED`, `EKYB_PROVIDERS_UPDATED`, `EKYB_PROVIDERS_CREATED`, `EKYB_PROVIDERS_DELETED`, `EKYC_PROVIDERS_CREATED`, `EKYC_PROVIDERS_UPDATED`, `EKYC_PROVIDERS_DELETED`, `QES_PROVIDERS_UPDATED`, `QES_PROVIDERS_DELETED`, `QES_PROVIDERS_CREATED`, `GENERAL_PROVISIONING_SETTINGS_UPDATED`, `MODULES_PROVISIONING_SETTINGS_UPDATED`, `ORGANIZATION_IAM_MIGRATION_INITIATED`, `SIGN_IN_URL_UPDATED`, `WORKFLOW_CREATED`, `WORKFLOW_IMPORTED`, `WORKFLOW_EDITED`, `WORKFLOW_UPDATED`, `WORKFLOW_DELETED`, `WORKFLOW_ACTIVATED`, `WORKFLOW_PAUSED`, `CONSENT_CREATED`, `CONSENT_UPDATED`, `CONSENT_DELETED`, `FRAUD_REPORTED`, `FRAUD_REPORT_REVOKED`, `WEBHOOK_CREATED`, `WEBHOOK_UPDATE`, `WEBHOOK_DELETE`, `WEBHOOK_AUTH_CONFIG_CREATE`, `WEBHOOK_AUTH_CONFIG_UPDATE`, `DATA_DELETION_UPDATE`, `WATCHLIST_ENTRY_DELETED`, `WATCHLIST_ENTRY_UPDATED`, `WATCHLIST_LIST_VIEWED`, `AUTHENTICATION_LIST_VIEWED`, `IDENTITY_VIEWED`, `SESSION_LIST_VIEWED`, `IDENTITY_LIST_VIEWED`, `AUDIT_LOG_REPORT_GENERATED`, `SINGLE_SESSION_REPORT_GENERATED`, `DATA_DELETION_DISABLE`, `FACE_ADDED_TO_DATABASE`, `SELFIE_ADDED_TO_IDENTITY_TEMPLATE`, `FRAUD_RING_RENAMED`, `FRAUD_RING_NOTE_ADDED`, `TRUSTGRAPH_SESSION_EXCLUDED`, `TRUSTGRAPH_SESSION_EXCLUSION_REVOKED`, `USER_DEACTIVATED`, `USER_ACTIVATED`, `ROLE_CREATED`, `ROLE_UPDATED`, `ROLE_DELETED`, `ROLE_ASSIGNED`, `ROLE_UNASSIGNED`, `GROUP_ROLE_MAPPING_UPDATED`, `ROLE_SOURCE_UPDATED`, `SSO_CONFIGURED`, `SSO_UPDATED`, `SSO_REMOVED`, `SCIM_ENABLED`, `SCIM_SECRET_ROTATED`, `SCIM_DISABLED`, `MFA_SETTINGS_UPDATED`, `PASSWORD_POLICY_UPDATED`, `LOGIN_FAILED`, `ACCOUNT_LOCKED`, `USER_INVITATION_ACCEPTED`, `PASSWORD_CHANGED`, `PASSWORD_RESET_REQUESTED`, `PASSWORD_RESET_COMPLETED`, `MFA_METHOD_ENROLLED`, `MFA_METHOD_REMOVED` |
| `before` | string (date-time) |  |  |
| `after` | string (date-time) |  |  |
| `executiveIds` | array[string] |  |  |
| `entityTypes` | array[string] |  | Enum: `SESSION`, `IDENTITY`, `EXECUTIVE`, `FLOW`, `CONFIGURATION`, `WORKFLOW`, `WATCHLIST`, `PROVISIONING`, `CONSENT`, `DATA`, `WEBHOOK`, `AUDIT_LOG`, `AUTHENTICATION`, `USER`, `FRAUD_RING`, `ROLE`, `ORGANIZATION` |
| `entityIds` | array[string] |  |  |
| `applications` | array[string] |  | Enum: `USER_SERVICE`, `IAM_SERVICE` |
| `email` | string |  |  |
| `ipAddress` | string |  |  |
| `userAgent` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `content` | array[ExecutiveEventDto] |  |  |
| `content.id` | string |  |  |
| `content.code` | string |  | Enum: `SESSION_DELETED`, `IDENTITY_DELETED`, `SESSION_FACE_ADDED`, `IDENTITY_FACE_ADDED`, `SESSION_MANUALLY_APPROVED`, `SESSION_MANUALLY_REJECTED`, `SESSION_VIEWED`, `SESSIONS_VIEWED`, `SESSION_PDF_DOWNLOADED`, `LOGIN_ATTEMPT`, `LOGOUT`, `USER_CREATED`, `USER_DELETED`, `USER_UPDATED`, `USER_API_ACCESS_BLOCKED`, `USER_API_ACCESS_UNBLOCKED`, `USER_IAM_MIGRATION_INITIATED`, `CONFIGURATION_CREATE`, `CONFIGURATION_CLONED`, `CONFIGURATION_RESET`, `CONFIGURATION_UPDATE`, `FLOW_CREATE`, `FLOW_UPDATE`, `FLOW_DELETE`, `FLOW_CLONE`, `IDENTITIES_REPORT_GENERATED`, `SESSIONS_REPORT_GENERATED`, `AUTHENTICATIONS_REPORT_GENERATED`, `WATCH_LISTS_REPORT_GENERATED`, `USERS_REPORT_GENERATED`, `DOUBLE_CHECK_RECORD_FETCHED`, `DOUBLE_CHECK_RECORD_UPDATED`, `DOUBLE_CHECK_FINISHED`, `SESSION_ANTIFRAUD_RESOLVED`, `WATCH_LISTS_ENTRY_CREATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_UPDATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_CREATED`, `GOVERNMENT_VERIFICATION_PROVIDERS_DELETED`, `WATCHLIST_PROVIDER_SETTINGS_CREATED`, `WATCHLIST_PROVIDER_SETTINGS_UPDATED`, `WATCHLIST_PROVIDER_SETTINGS_DELETED`, `PAYMENTS_PROVIDER_SETTINGS_CREATED`, `PAYMENTS_PROVIDER_SETTINGS_UPDATED`, `PAYMENTS_PROVIDER_SETTINGS_DELETED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_UPDATED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_DELETED`, `PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_CREATED`, `EKYB_PROVIDERS_UPDATED`, `EKYB_PROVIDERS_CREATED`, `EKYB_PROVIDERS_DELETED`, `EKYC_PROVIDERS_CREATED`, `EKYC_PROVIDERS_UPDATED`, `EKYC_PROVIDERS_DELETED`, `QES_PROVIDERS_UPDATED`, `QES_PROVIDERS_DELETED`, `QES_PROVIDERS_CREATED`, `GENERAL_PROVISIONING_SETTINGS_UPDATED`, `MODULES_PROVISIONING_SETTINGS_UPDATED`, `ORGANIZATION_IAM_MIGRATION_INITIATED`, `SIGN_IN_URL_UPDATED`, `WORKFLOW_CREATED`, `WORKFLOW_IMPORTED`, `WORKFLOW_EDITED`, `WORKFLOW_UPDATED`, `WORKFLOW_DELETED`, `WORKFLOW_ACTIVATED`, `WORKFLOW_PAUSED`, `CONSENT_CREATED`, `CONSENT_UPDATED`, `CONSENT_DELETED`, `FRAUD_REPORTED`, `FRAUD_REPORT_REVOKED`, `WEBHOOK_CREATED`, `WEBHOOK_UPDATE`, `WEBHOOK_DELETE`, `WEBHOOK_AUTH_CONFIG_CREATE`, `WEBHOOK_AUTH_CONFIG_UPDATE`, `DATA_DELETION_UPDATE`, `WATCHLIST_ENTRY_DELETED`, `WATCHLIST_ENTRY_UPDATED`, `WATCHLIST_LIST_VIEWED`, `AUTHENTICATION_LIST_VIEWED`, `IDENTITY_VIEWED`, `SESSION_LIST_VIEWED`, `IDENTITY_LIST_VIEWED`, `AUDIT_LOG_REPORT_GENERATED`, `SINGLE_SESSION_REPORT_GENERATED`, `DATA_DELETION_DISABLE`, `FACE_ADDED_TO_DATABASE`, `SELFIE_ADDED_TO_IDENTITY_TEMPLATE`, `FRAUD_RING_RENAMED`, `FRAUD_RING_NOTE_ADDED`, `TRUSTGRAPH_SESSION_EXCLUDED`, `TRUSTGRAPH_SESSION_EXCLUSION_REVOKED`, `USER_DEACTIVATED`, `USER_ACTIVATED`, `ROLE_CREATED`, `ROLE_UPDATED`, `ROLE_DELETED`, `ROLE_ASSIGNED`, `ROLE_UNASSIGNED`, `GROUP_ROLE_MAPPING_UPDATED`, `ROLE_SOURCE_UPDATED`, `SSO_CONFIGURED`, `SSO_UPDATED`, `SSO_REMOVED`, `SCIM_ENABLED`, `SCIM_SECRET_ROTATED`, `SCIM_DISABLED`, `MFA_SETTINGS_UPDATED`, `PASSWORD_POLICY_UPDATED`, `LOGIN_FAILED`, `ACCOUNT_LOCKED`, `USER_INVITATION_ACCEPTED`, `PASSWORD_CHANGED`, `PASSWORD_RESET_REQUESTED`, `PASSWORD_RESET_COMPLETED`, `MFA_METHOD_ENROLLED`, `MFA_METHOD_REMOVED` |
| `content.timestamp` | string (date-time) |  |  |
| `content.executiveId` | string |  |  |
| `content.managedEntityType` | string |  | Enum: `SESSION`, `IDENTITY`, `EXECUTIVE`, `FLOW`, `CONFIGURATION`, `WORKFLOW`, `WATCHLIST`, `PROVISIONING`, `CONSENT`, `DATA`, `WEBHOOK`, `AUDIT_LOG`, `AUTHENTICATION`, `USER`, `FRAUD_RING`, `ROLE`, `ORGANIZATION` |
| `content.managedEntityId` | string |  |  |
| `content.payload` | object |  |  |
| `content.apiKey` | string |  |  |
| `content.role` | string |  | Enum: `OPEN`, `STATISTICS`, `LIMITED`, `INCODE_IDENTITY`, `INCODE_ID_USER`, `ACCESS`, `AUTHENTICATOR`, `REFRESH`, `REGISTER`, `INCODE_ID_CLIENT`, `EXECUTIVE`, `ADMIN`, `SCIM_ADMIN`, `MULTI_ORG_ADMIN`, `INTEGRATOR`, `INCODE_EXECUTIVE`, `INCODE_ADMIN`, `WIDGET_CLIENT`, `INTERNAL_SERVICE`, `AUTHORIZATION_SERVER`, `KEYCLOAK_SESSION`, `HIPAA_ADMIN`, `HIPAA_VIEWER`, `WORKFORCE_ADMIN`, `WORKFORCE_HELPDESK_STAFF`, `WORKFORCE_RECRUITER`, `SERVER`, `IDENTITY_SERVICE`, `TRUST_GRAPH_DATA_LOADER` |
| `content.application` | string |  | Enum: `USER_SERVICE`, `IAM_SERVICE` |
| `content.ipAddress` | string |  |  |
| `content.userAgent` | string |  |  |
| `content.email` | string |  |  |
| `page` | Page |  |  |
| `page.size` | integer (int32) |  |  |
| `page.totalElements` | integer (int64) |  |  |
| `page.totalPages` | integer (int64) |  |  |
| `page.currentPageNumber` | integer (int32) |  |  |
| `total` | integer (int64) |  |  |
| `more` | boolean |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/executive-events/find?avoidCounting=%3CavoidCounting%3E&pageable=%3Cpageable%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "content": [
    {
      "id": "string",
      "code": "SESSION_DELETED",
      "timestamp": "string",
      "executiveId": "string",
      "managedEntityType": "SESSION",
      "managedEntityId": "string",
      "payload": {},
      "apiKey": "string",
      "role": "OPEN",
      "application": "USER_SERVICE",
      "ipAddress": "string",
      "userAgent": "string",
      "email": "string"
    }
  ],
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPageNumber": 0
  },
  "total": 0,
  "more": true
}
```

---

- Path: `api-reference/executive-log-in`
- URL: https://developer.incode.com/api-reference/executive-log-in/
- Markdown: https://developer.incode.com/api-reference/executive-log-in.md
- Endpoint: `POST /executive/log-in`

# Login admin token

`POST /executive/log-in`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Logs in an user and provides a token with high-privileges

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string | yes |  |
| `password` | string | yes |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `token` | string |  | Access token for next calls |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/executive/log-in \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "<email>",
    "password": "<password>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/executive/log-in", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "email": "<email>",
      "password": "<password>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/executive/log-in", headers=headers, json={
  "email": "<email>",
  "password": "<password>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/executive/log-in"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"email\": \"<email>\",\n  \"password\": \"<password>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/executive/log-in")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "email": "<email>",
  "password": "<password>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/executive/log-in");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "email": "<email>",
  "password": "<password>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "token": "eyJhbGciOasfasiJ9.eyJleHRl2OTg5NX0.zdbAC-kE-I71"
}
```

---

- Path: `api-reference/expire-interviews`
- URL: https://developer.incode.com/api-reference/expire-interviews/
- Markdown: https://developer.incode.com/api-reference/expire-interviews.md
- Endpoint: `POST /omni/expire/interviews`

# Expire onboarding sessions by interviewIds.

`POST /omni/expire/interviews`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Expire onboarding sessions given by interviewIds array, and cleanerConfiguration parameter.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewIds` | array[string] |  |  |
| `cleanerConfiguration` | ExpireInterviewConfigurationDto |  | Configuration for expiring interview |
| `cleanerConfiguration.expirationConditions` | array[string] | yes | Enum: `INCOMPLETE`, `NEEDS_REVIEW` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/expire/interviews \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "cleanerConfiguration": {
      "expirationConditions": []
    }
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/expire/interviews", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "cleanerConfiguration": {
        "expirationConditions": []
      }
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/expire/interviews", headers=headers, json={
  "cleanerConfiguration": {
    "expirationConditions": []
  }
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/expire/interviews"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"cleanerConfiguration\": {\n    \"expirationConditions\": []\n  }\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/expire/interviews")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "cleanerConfiguration": {
    "expirationConditions": []
  }
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/expire/interviews");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "cleanerConfiguration": {
    "expirationConditions": []
  }
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/external-send-sms`
- URL: https://developer.incode.com/api-reference/external-send-sms/
- Markdown: https://developer.incode.com/api-reference/external-send-sms.md
- Endpoint: `POST /omni/external/send-sms`

# Send SMS with the link for onboarding

`POST /omni/external/send-sms`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Used by Admins or Executives to send SMS containing generated onboarding link.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string | yes | Id of onboarding session for which link is being generated. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `smsText` | string |  | Text to be shown with URL. Needs to have {0} placeholder inside for URL. |
| `clientId` | string | yes |  |
| `shortUrl` | boolean |  | Indicates whether the link should be shortened. If set to true, the link will be converted to a shortened version. |
| `queryParams` | SendSmsExternalUrlParams |  | Additional onboarding url query params allowed: lang |
| `queryParams.lang` | string |  |  |
| `uuid` | string |  | Optional UUID to be reused for linking the onboarding session. If not provided or invalid, a new one will be generated. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Custom error status: - 4004: Could not find user

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "<clientId>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "clientId": "<clientId>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E", headers=headers, json={
  "clientId": "<clientId>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"clientId\": \"<clientId>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "clientId": "<clientId>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/external/send-sms?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "clientId": "<clientId>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/externalverification-ekyb`
- URL: https://developer.incode.com/api-reference/externalverification-ekyb/
- Markdown: https://developer.incode.com/api-reference/externalverification-ekyb.md
- Endpoint: `POST /omni/externalVerification/ekyb`

# eKYB

`POST /omni/externalVerification/ekyb`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint performs an eKYB check for the business specified

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `plugins` | array[string] |  |  |
| `businessName` | string |  | Name of the business |
| `addressLine1` | string |  | Address line 1 of the business |
| `street` | string |  | Street name of the business address |
| `houseNo` | string |  | The exterior number of the business address |
| `addressLine2` | string |  | Address line 2 of the business |
| `city` | string |  | City of the business address. |
| `state` | string |  | State or province of the business address. Send the form the local registry uses: a two-letter code for the United States, the full province name for Canada. |
| `postalCode` | string |  | Postal code of the business address. |
| `country` | string |  | Two-letter country code of the business address |
| `taxId` | string |  | The tax or company registration id of the business. Many countries require it and answer 400 when it is missing. Canada takes the Corporations Canada corporation number, a provincial registration number or the CRA business number. The United Arab Emirates takes any value that contains a letter or a digit, because each emirate and free zone issues its own format. |
| `uboName` | string |  | Ultimate Beneficial Owner name. Deprecated — use uboNames instead. |
| `uboNames` | array[string] |  | Ultimate Beneficial Owners names |
| `directors` | array[string] |  | Names of the directors of the business |

## Responses

### 200

The `kyb` array carries one entry per check that ran. Which keys appear depends on the country and the provider behind it, and on which fields the request supplied, so read the array by key rather than by position and treat an absent key as "not checked". `sub_label` holds the outcome of the check. `status` and `message` are populated by some providers only and are absent elsewhere. On most providers the "directors_name_match" and "ubo_name_match" keys repeat once per name supplied in `directors` and `uboNames`, and each entry names the value it reports on in `directorsName_input` or `uboName_input`. Match entries on that field rather than keeping one entry per key. In the United States there is at most one "ubo_name_match" entry. It reports on the first name in `uboNames` only and carries no `uboName_input`. Outcomes for a name or address check: - sub_label: Verified, the submitted value matched - sub_label: Approximate Match, a close but inexact match - sub_label: Unverified, the submitted value did not match. Most providers also return it when no company matched or they hold no value to compare - sub_label: Unknown, nothing was compared. Some providers return it when no company matched the request, when the registry holds no value for that field, or when the check does not apply to that country or to the fields supplied The `registrationStatus` key reports Active, Inactive or Unknown, and the `entityType` key carries the legal entity type in its own `entityType` object rather than in `sub_label`. The "address_property_type" and "address_deliverability" keys are returned for the United States only, and carry both a status and a message: - sub_label: Commercial, message: Submitted Office Address is a Commercial property - sub_label: Residential, message: Submitted Office Address is a Residential property - sub_label: Deliverable, message: The USPS is able to deliver mail to the submitted Office Address - sub_label: Undeliverable, message: The USPS is unable to deliver mail to the submitted Office Address Example: ``` { "kyb": [ { "key": "name", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Business Name" }, { "key": "address_verification", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Office Address" }, { "key": "address_deliverability", "status": "success", "sub_label": "Deliverable", "message": "The USPS is able to deliver mail to the submitted Office Address" }, { "key": "address_property_type", "status": "success", "sub_label": "Commercial", "message": "Submitted Office Address is a Commercial property" } ] } ```

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kyb` | array[EkybVerification] |  |  |
| `kyb.key` | string |  | The name of test |
| `kyb.status` | string |  | Whether the test ows passed. |
| `kyb.sub_label` | string |  | Additional info on the status. |
| `kyb.message` | string |  | Human readable description of the status. |
| `kyb.reasonCodes` | array[string] |  | Machine-readable qualifiers for this check, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational. |
| `kyb.uboName_input` | string |  | The beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent. |
| `kyb.directorsName_input` | string |  | The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field. |
| `kyb.entityType` | EntityTypeInfo |  | Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix. |
| `kyb.entityType.entityType` | string |  | Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix. |
| `kybSource` | EkybSourceInfo |  |  |
| `kybSource.uboNames` | array[UboName] |  |  |
| `kybSource.uboNames.id` | string |  |  |
| `kybSource.uboNames.uboName` | string |  |  |
| `businessClassification` | array[EkybVerification] |  |  |
| `businessClassification.key` | string |  | The name of test |
| `businessClassification.status` | string |  | Whether the test ows passed. |
| `businessClassification.sub_label` | string |  | Additional info on the status. |
| `businessClassification.message` | string |  | Human readable description of the status. |
| `businessClassification.reasonCodes` | array[string] |  | Machine-readable qualifiers for this check, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational. |
| `businessClassification.uboName_input` | string |  | The beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent. |
| `businessClassification.directorsName_input` | string |  | The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field. |
| `businessClassification.entityType` | EntityTypeInfo |  | Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix. |
| `businessClassification.entityType.entityType` | string |  | Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix. |
| `status` | string |  | Only present on a 202 async dispatch: PENDING until the verification finishes and the result is delivered via the EKYB_VERIFICATION_RESULT webhook. Enum: `PENDING`, `COMPLETED`, `FAILED` |
| `referenceId` | string |  | Only present on a 202 async dispatch: id correlating the webhook notification and the result-poll endpoint with this request. |

### 202

Async verification is enabled for the organization; the request is processed in the background and the result is delivered via the EKYB_VERIFICATION_RESULT webhook. Body carries only referenceId and status=PENDING.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kyb` | array[EkybVerification] |  |  |
| `kyb.key` | string |  | The name of test |
| `kyb.status` | string |  | Whether the test ows passed. |
| `kyb.sub_label` | string |  | Additional info on the status. |
| `kyb.message` | string |  | Human readable description of the status. |
| `kyb.reasonCodes` | array[string] |  | Machine-readable qualifiers for this check, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational. |
| `kyb.uboName_input` | string |  | The beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent. |
| `kyb.directorsName_input` | string |  | The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field. |
| `kyb.entityType` | EntityTypeInfo |  | Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix. |
| `kyb.entityType.entityType` | string |  | Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix. |
| `kybSource` | EkybSourceInfo |  |  |
| `kybSource.uboNames` | array[UboName] |  |  |
| `kybSource.uboNames.id` | string |  |  |
| `kybSource.uboNames.uboName` | string |  |  |
| `businessClassification` | array[EkybVerification] |  |  |
| `businessClassification.key` | string |  | The name of test |
| `businessClassification.status` | string |  | Whether the test ows passed. |
| `businessClassification.sub_label` | string |  | Additional info on the status. |
| `businessClassification.message` | string |  | Human readable description of the status. |
| `businessClassification.reasonCodes` | array[string] |  | Machine-readable qualifiers for this check, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational. |
| `businessClassification.uboName_input` | string |  | The beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent. |
| `businessClassification.directorsName_input` | string |  | The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field. |
| `businessClassification.entityType` | EntityTypeInfo |  | Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix. |
| `businessClassification.entityType.entityType` | string |  | Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix. |
| `status` | string |  | Only present on a 202 async dispatch: PENDING until the verification finishes and the result is delivered via the EKYB_VERIFICATION_RESULT webhook. Enum: `PENDING`, `COMPLETED`, `FAILED` |
| `referenceId` | string |  | Only present on a 202 async dispatch: id correlating the webhook notification and the result-poll endpoint with this request. |

### 400

Validation failures and provider failures both answer 400. The body's `status` field carries the classification: 400 when the request was rejected because a field the country requires is missing or blank, 503 when the provider did not return a complete result in time and the request can be retried later, 502 when the provider answered the search but not the company profile. `message` carries the reason.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/externalVerification/ekyb \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/ekyb", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/externalVerification/ekyb", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/ekyb"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/ekyb")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/ekyb");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "kyb": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "NO_SHAREHOLDER_DATA"
      ],
      "uboName_input": "Sample Holding Company",
      "directorsName_input": "Sample Director",
      "entityType": {
        "entityType": "Business Corporation"
      }
    }
  ],
  "kybSource": {
    "uboNames": [
      {
        "id": "string",
        "uboName": "string"
      }
    ]
  },
  "businessClassification": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "NO_SHAREHOLDER_DATA"
      ],
      "uboName_input": "Sample Holding Company",
      "directorsName_input": "Sample Director",
      "entityType": {
        "entityType": "Business Corporation"
      }
    }
  ],
  "status": "PENDING",
  "referenceId": "string"
}
```

---

- Path: `api-reference/externalverification-ekyb-session`
- URL: https://developer.incode.com/api-reference/externalverification-ekyb-session/
- Markdown: https://developer.incode.com/api-reference/externalverification-ekyb-session.md
- Endpoint: `GET /omni/externalVerification/ekyb/session`

# Get eKYB session data for the current session

`GET /omni/externalVerification/ekyb/session`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns stored eKYB verification request/response data for the interview associated with the
caller's session token. Intended for downstream onboarding steps (e.g. the business watchlist
screen) to reuse data the user already entered on the eKYB form, such as `businessName`,
`country` and `taxId`, without requiring an executive token.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `requestData` | BusinessVerificationRequestData |  |  |
| `requestData.plugins` | array[string] |  |  |
| `requestData.businessName` | string |  |  |
| `requestData.address` | string |  |  |
| `requestData.addressLine1` | string |  |  |
| `requestData.street` | string |  |  |
| `requestData.houseNo` | string |  |  |
| `requestData.addressLine2` | string |  |  |
| `requestData.city` | string |  |  |
| `requestData.state` | string |  |  |
| `requestData.postalCode` | string |  |  |
| `requestData.country` | string |  | Enum: `US`, `BR`, `CA`, `CN`, `UK`, `GB`, `DE`, `FR`, `RO`, `ES`, `IT`, `IL`, `AR`, `IE`, `JP`, `SE`, `NO`, `VN`, `NL`, `NG`, `KE`, `CM`, `HK`, `IN`, `MX`, `DK`, `BG`, `MT`, `LT`, `KM`, `TR`, `EG`, `AE`, `SA`, `AU`, `GR`, `PT`, `BE`, `AT` |
| `requestData.taxId` | string |  |  |
| `requestData.uboNames` | array[string] |  |  |
| `requestData.directors` | array[string] |  |  |
| `verificationResult` | BusinessVerificationResultData |  |  |
| `verificationResult.businessName` | string |  |  |
| `verificationResult.businessClassification` | string |  |  |
| `verificationResult.addressVerification` | string |  |  |
| `verificationResult.cityVerification` | string |  |  |
| `verificationResult.postalCodeVerification` | string |  |  |
| `verificationResult.stateVerification` | string |  |  |
| `verificationResult.addressPropertyType` | string |  |  |
| `verificationResult.addressDeliverability` | string |  |  |
| `verificationResult.tinVerification` | string |  |  |
| `verificationResult.uboNameMatch` | string |  |  |
| `verificationResult.registrationStatus` | string |  | Enum: `Active`, `Inactive`, `Unknown` |
| `verificationResult.entityType` | EntityTypeData |  |  |
| `verificationResult.entityType.entityType` | string |  |  |
| `verificationResult.uboNameVerificationResults` | array[UboNameVerificationResultData] |  |  |
| `verificationResult.uboNameVerificationResults.name` | string |  |  |
| `verificationResult.uboNameVerificationResults.uboNameMatch` | string |  |  |
| `verificationResult.uboNameVerificationResults.matchId` | string |  |  |
| `verificationResult.uboNameVerificationResults.ownershipPercentage` | string |  |  |
| `verificationResult.directorsVerificationResults` | array[UboNameVerificationResultData] |  |  |
| `verificationResult.directorsVerificationResults.name` | string |  |  |
| `verificationResult.directorsVerificationResults.uboNameMatch` | string |  |  |
| `verificationResult.directorsVerificationResults.matchId` | string |  |  |
| `verificationResult.directorsVerificationResults.ownershipPercentage` | string |  |  |
| `verificationResult.people` | array[PeopleData] |  |  |
| `verificationResult.people.name` | string |  |  |
| `verificationResult.people.titles` | array[TitleData] |  |  |
| `verificationResult.people.titles.title` | string |  |  |
| `verificationResult.people.memberType` | string |  |  |
| `verificationResult.verificationMessages` | VerificationMessages |  |  |
| `verificationResult.verificationMessages.tinVerificationMessage` | string |  |  |
| `externalVerificationThirdPartyRequest` | object |  |  |
| `externalVerificationThirdPartyResponse` | object |  |  |
| `providerInteractions` | array[ProviderInteraction] |  |  |
| `providerInteractions.providerName` | string |  | Enum: `MIDDESK`, `OPEN_CORPS_US`, `OPEN_CORPS_CA`, `SERPRO`, `OPENDATA`, `CREDITSAFE_UK`, `CREDITSAFE_RO`, `CREDITSAFE_IT`, `CREDITSAFE_ES`, `CREDITSAFE_FR`, `CREDITSAFE_DE`, `CREDITSAFE_AR`, `CREDITSAFE_IE`, `CREDITSAFE_JP`, `CREDITSAFE_SE`, `CREDITSAFE_NO`, `CREDITSAFE_NL`, `CREDITSAFE_VN`, `CREDITSAFE_NG`, `CREDITSAFE_CM`, `CREDITSAFE_KE`, `CREDITSAFE_MX`, `CREDITSAFE_DK`, `CREDITSAFE_BG`, `CREDITSAFE_MT`, `CREDITSAFE_LT`, `CREDITSAFE_AU`, `CREDITSAFE_GR`, `CREDITSAFE_PT`, `THE_KYB_NL`, `THE_KYB_KM`, `THE_KYB_TR`, `THE_KYB_EG`, `THE_KYB_AE`, `THE_KYB_SA`, `THE_KYB_CA`, `NUBARIUM_MX`, `ASIAVERIFY_CN`, `ASIAVERIFY_IN`, `ASIAVERIFY_HK`, `MONO_NG`, `IDENTIFY_AFRICA_KE`, `IDMERIT_MX`, `THE_KYB_SA_PREFILL`, `THE_KYB_AE_PREFILL`, `CREDITSAFE_AU_PREFILL`, `CREDITSAFE_GB_PREFILL`, `BASELAYER_US_PREFILL`, `CREDITSAFE_IN_PREFILL`, `CREDITSAFE_DE_PREFILL`, `CREDITSAFE_ES_PREFILL`, `CREDITSAFE_FR_PREFILL`, `CREDITSAFE_IT_PREFILL`, `CREDITSAFE_NL_PREFILL`, `CREDITSAFE_GR_PREFILL`, `CREDITSAFE_PT_PREFILL`, `CREDITSAFE_BE_PREFILL`, `CREDITSAFE_AT_PREFILL`, `CREDITSAFE_IE_PREFILL` |
| `providerInteractions.interactionType` | string |  | Enum: `token_fetch`, `verification`, `business_classification`, `entity_lookup`, `prefill` |
| `providerInteractions.timestamp` | string (date-time) |  |  |
| `providerInteractions.externalVerificationThirdPartyRequest` | object |  |  |
| `providerInteractions.externalVerificationThirdPartyResponse` | object |  |  |
| `providerInteractions.status` | string |  | Enum: `SUCCESS`, `NO_RESULT`, `DEFERRED` |
| `providerInteractions.errorMessage` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/ekyb/session");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "requestData": {
    "plugins": [
      "string"
    ],
    "businessName": "string",
    "address": "string",
    "addressLine1": "string",
    "street": "string",
    "houseNo": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "US",
    "taxId": "string",
    "uboNames": [
      "string"
    ],
    "directors": [
      "string"
    ]
  },
  "verificationResult": {
    "businessName": "string",
    "businessClassification": "string",
    "addressVerification": "string",
    "cityVerification": "string",
    "postalCodeVerification": "string",
    "stateVerification": "string",
    "addressPropertyType": "string",
    "addressDeliverability": "string",
    "tinVerification": "string",
    "uboNameMatch": "string",
    "registrationStatus": "Active",
    "entityType": {
      "entityType": "string"
    },
    "uboNameVerificationResults": [
      {
        "name": "string",
        "uboNameMatch": "string",
        "matchId": "string",
        "ownershipPercentage": "string"
      }
    ],
    "directorsVerificationResults": [
      {
        "name": "string",
        "uboNameMatch": "string",
        "matchId": "string",
        "ownershipPercentage": "string"
      }
    ],
    "people": [
      {
        "name": "string",
        "titles": [
          {
            "title": "string"
          }
        ],
        "memberType": "string"
      }
    ],
    "verificationMessages": {
      "tinVerificationMessage": "string"
    }
  },
  "externalVerificationThirdPartyRequest": {},
  "externalVerificationThirdPartyResponse": {},
  "providerInteractions": [
    {
      "providerName": "MIDDESK",
      "interactionType": "token_fetch",
      "timestamp": "string",
      "externalVerificationThirdPartyRequest": {},
      "externalVerificationThirdPartyResponse": {},
      "status": "SUCCESS",
      "errorMessage": "string"
    }
  ]
}
```

---

- Path: `api-reference/externalverification-ekyc`
- URL: https://developer.incode.com/api-reference/externalverification-ekyc/
- Markdown: https://developer.incode.com/api-reference/externalverification-ekyc.md
- Endpoint: `POST /omni/externalVerification/ekyc`

# External Verification (eKYC)

`POST /omni/externalVerification/ekyc`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint verifies phone, email, address, date of birth and tax numbers, specifically social security number (ssn).
When making a request use "kyc" in the plugins array. To have the API return specific risk scores for phone, email, ssn (taxId)
and address, see examples below.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `plugins` | array[string] |  | Enum: `kyc` |
| `firstName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `surName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `middleName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `maternalSurname` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `email` | string |  |  |
| `street` | string |  |  |
| `streetNo` | string |  |  |
| `floor` | string |  |  |
| `apartment` | string |  |  |
| `postalCode` | string |  |  |
| `countryCode` | string |  | ISO 3166-1 alpha-2 format |
| `phone` | string |  | Use E.164 format. Hyphens are optional |
| `state` | string |  |  |
| `city` | string |  |  |
| `idNumber` | string |  |  |
| `idNumber1` | string |  |  |
| `idNum` | string |  | Brazilian CPF number for BR_TAX_PHONE_REGISTER (IDmerit BR1) |
| `gender` | string |  |  |
| `taxId` | string |  |  |
| `dateOfBirth` | string (YYYY-MM-DD) |  |  |
| `dlExpireAt` | string (YYYY-MM-DD) |  |  |
| `fullName` | string |  |  |
| `panNumber` | string |  | Indian Permanent Account Number (PAN), format: AAAAANNNNA |
| `district` | string |  | District or Barangay (neighbourhood), used for Philippines KYC |
| `idType` | string |  | National ID type. Supported for Philippines KYC: SSS, TIN, GSIS |
| `issueDate` | string (YYYY-MM-DD) |  | ID document issue date. Required for Colombia Civil Register (CO_CIVIL_REGISTER_1) KYC |
| `fileNumber` | string |  | Indian passport file number (PRFN), format: 2 letters followed by 13 digits |
| `dateOfIssue` | string (YYYY-MM-DD) |  | Passport issue date, used for INDIA_PASSPORT_1 KYC |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kyc` | array[EkycVerification] |  |  |
| `kyc.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `kyc.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `kyc.sub_label` | string |  | Additional info on the status. |
| `kyc.message` | string |  |  |
| `kyc.reasonCodes` | array[string] |  |  |
| `income` | array[EkycVerification] |  |  |
| `income.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `income.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `income.sub_label` | string |  | Additional info on the status. |
| `income.message` | string |  |  |
| `income.reasonCodes` | array[string] |  |  |
| `riskAddons` | array[object] |  |  |
| `riskAddons.type` | string |  | Enum: `phoneCheck`, `advancedPhoneCheck`, `emailCheck`, `phoneProfile` |
| `riskAddons.checkStatus` | string |  | Outcome of the check for the provided phone number: found or notFound. |
| `riskAddons.message` | string |  | Explanation returned when checkStatus is notFound. |
| `riskAddons.confidenceLevel` | string |  | Confidence in the returned identity match: low, medium or high. |
| `riskAddons.phoneFirstName` | string |  | First name on file for the phone number. |
| `riskAddons.phoneLastName` | string |  | Last name on file for the phone number. |
| `riskAddons.phoneDob` | string |  | Date of birth on file, yyyy-MM-dd. Availability varies by country. |
| `riskAddons.phoneValid` | boolean |  | Whether the provider considers the phone number valid. |
| `riskAddons.phoneCountry` | string |  | Country of the phone number as reported by the provider. |
| `riskAddons.phoneAddresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.phoneAddresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.nameReturned` | boolean |  | True only when both phoneFirstName and phoneLastName were returned. |
| `riskAddons.phonePersonAge` | integer (int32) |  | Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable. |
| `riskAddons.isAdult` | boolean |  | True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned. |
| `riskAddons.additionalProfiles` | array[PhoneProfileAdditionalProfileResponse] |  |  |
| `riskAddons.additionalProfiles.firstName` | string |  | First name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.lastName` | string |  | Last name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.dob` | string |  | Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it. |
| `riskAddons.additionalProfiles.addresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.additionalProfiles.addresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.reasonCodes` | array[string] |  |  |
| `additionalVerificationInfo` | AdditionalVerificationInfo |  |  |
| `additionalVerificationInfo.creditFileDetails` | CreditFileDetails |  |  |
| `additionalVerificationInfo.creditFileDetails.creditFileNumber` | string |  |  |
| `additionalVerificationInfo.creditFileDetails.creditFileCreationDate` | string |  |  |
| `sot` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/externalVerification/ekyc \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/ekyc", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/externalVerification/ekyc", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/ekyc"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/ekyc")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/ekyc");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "kyc": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "income": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "riskAddons": [
    {
      "type": "phoneCheck",
      "checkStatus": "string",
      "message": "string",
      "confidenceLevel": "string",
      "phoneFirstName": "string",
      "phoneLastName": "string",
      "phoneDob": "string",
      "phoneValid": true,
      "phoneCountry": "string",
      "phoneAddresses": [
        {
          "address1": "string"
        }
      ],
      "nameReturned": true,
      "phonePersonAge": 0,
      "isAdult": true,
      "additionalProfiles": [
        {
          "firstName": "string",
          "lastName": "string",
          "dob": "string",
          "addresses": [
            {
              "address1": null
            }
          ]
        }
      ],
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "additionalVerificationInfo": {
    "creditFileDetails": {
      "creditFileNumber": "string",
      "creditFileCreationDate": "string"
    }
  },
  "sot": "string"
}
```

---

- Path: `api-reference/externalverification-ekyc-session`
- URL: https://developer.incode.com/api-reference/externalverification-ekyc-session/
- Markdown: https://developer.incode.com/api-reference/externalverification-ekyc-session.md
- Endpoint: `GET /omni/externalVerification/ekyc/session`

# Get eKYC session data for the current session

`GET /omni/externalVerification/ekyc/session`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns stored eKYC verification request/response data for the interview associated with the caller's session token.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `userData` | ExternalVerificationRequest |  |  |
| `userData.plugins` | array[string] |  |  |
| `userData.source` | string |  | Enum: `US_DRIVERS_LICENSE_1`, `US_TELCO_1`, `US_TELCO_2`, `US_TELCO_4`, `US_TELCO_5`, `US_CREDIT_BUREAU_1`, `US_CREDIT_BUREAU_3`, `US_ADDRESS_1`, `US_CONSUMER_1`, `MX_CONSUMER_1`, `MX_CONSUMER_2`, `BR_GOVT_1`, `BR_CPF_1`, `CA_RES_CREDIT`, `CA_CREDIT_FINTRAC`, `UK_CREDIT_BUREAU_1`, `UK_VOTER_REGISTER`, `ES_PHONE_REGISTER_2`, `CL_1`, `AR_1`, `AR_RES_REGISTER`, `AR_CREDIT_BUR_1`, `GR_1`, `GT_1`, `CR_1`, `CO_1`, `PHONE_RISK_1`, `PHONE_RISK_2`, `PHONE_PROFILE`, `EMAIL_RISK_1`, `RISK_ADDONS_ONLY`, `GH_CARD_VERIFY_1`, `PE_MIGRATION_INSTITUTE`, `KE_IDENTIFYAFRICA`, `INDIA_PAN`, `IN_DMV`, `NG_MONO_BVN`, `NG_MONO_NIN`, `US_CREDIT_TELCO`, `PH_RES_CREDIT`, `VE_CIVIL_REGISTER`, `CO_CIVIL_REGISTER_1`, `MX_CIVIL_REGISTER_2`, `BR_TAX_PHONE_REGISTER`, `NL_CONSUMER_POP_REG_TELCO`, `NL_CIVIL_REG_CREDIT_TELCO`, `FI_NATIONAL_ID`, `FI_CONSUMER_POP_REG_TELCO`, `BE_CREDIT_TELCO`, `DK_CIVIL_REG_CREDIT_TELCO`, `GB_2X2`, `PE_CIVIL_REGISTER_2`, `NO_CONS_POP_REG`, `DE_PHONE_MOBILE_REGISTER`, `IT_CIVIL_REG_CREDIT_TELCO` |
| `userData.fullName` | string |  |  |
| `userData.firstName` | string |  |  |
| `userData.middleName` | string |  |  |
| `userData.surName` | string |  |  |
| `userData.email` | string |  |  |
| `userData.street` | string |  |  |
| `userData.houseNo` | string |  |  |
| `userData.postalCode` | string |  |  |
| `userData.countryCode` | string |  |  |
| `userData.phone` | string |  |  |
| `userData.state` | string |  |  |
| `userData.city` | string |  |  |
| `userData.ssn` | string |  |  |
| `userData.dateOfBirth` | string |  |  |
| `userData.ipAddress` | string |  |  |
| `userData.taxIdStatus` | string |  |  |
| `userData.nationality` | string |  |  |
| `userData.dlNumber` | string |  |  |
| `userData.dlExpireAt` | string |  |  |
| `userData.dlState` | string |  |  |
| `userData.last4SSN` | string |  |  |
| `userData.idNumber` | string |  |  |
| `userData.panNumber` | string |  |  |
| `riskData` | PremiumExternalVerification |  |  |
| `riskData.level` | string |  |  |
| `riskData.verifications` | object |  |  |
| `riskData.income` | Income |  |  |
| `riskData.income.status` | string |  |  |
| `riskData.income.range` | string |  |  |
| `riskData.employment` | Employment |  |  |
| `riskData.employment.status` | string |  |  |
| `riskData.employment.type` | string |  |  |
| `riskData.employment.sector` | string |  |  |
| `riskData.reasonCodes` | array[VerificationReasonCodes] |  |  |
| `riskData.reasonCodes.key` | string |  |  |
| `riskData.reasonCodes.reasonCodes` | array[ReasonCode] |  |  |
| `riskData.reasonCodes.reasonCodes.reasonCode` | string |  | Enum: `A40SS`, `A70SS`, `A4070SS`, `AASE`, `ACV`, `ADC`, `ADCMS`, `ADCUD`, `AFAEI`, `AFM`, `AFMNCC`, `AFMSCC`, `AHNI`, `AHR`, `AIA`, `AII`, `AIR`, `AMCC`, `AMI`, `AMICC`, `AMICCMM`, `AMICCSE`, `ANA`, `AND`, `ANF`, `APA`, `APAI`, `APCC`, `APNV`, `ARNF`, `ASC`, `ASCV`, `ASDL`, `ASU`, `AUICCM`, `AWS`, `EA1Y`, `EA2Y`, `EA4M`, `EA4Y`, `EA6M`, `EAC1F`, `EACMF`, `EADP`, `EAF1`, `EAF2`, `EAF3`, `EAF4Y`, `EAFC`, `EAG1`, `EAG2`, `EAG3`, `EAG4`, `EAG5`, `EAG6`, `EAHF`, `EALLI`, `EALSM`, `EALTW`, `EAM`, `EAMC`, `EAMF`, `EAMI`, `EAMP`, `EANA`, `EANE`, `EANI`, `EANP`, `EAPF`, `EAQ3`, `EAQ4`, `EAQM`, `EASI`, `EAVQ`, `EAW`, `EAY`, `ED4M`, `EDCH`, `EDCO`, `EDDN`, `EDHA`, `EDHC`, `EDHI`, `EDHN`, `EDI`, `EDL`, `EDLC`, `EDM`, `EDNP`, `EDPR`, `EDVH`, `EDVHC`, `EDVHI`, `EE24`, `EE90`, `EEPEII`, `EMA24`, `EMA90`, `ESG24`, `ESG90`, `EVS24`, `EVS90`, `P2OSOV`, `P3OSOV`, `P4OSOV`, `P5OSOV`, `PA2M`, `PA3M`, `PA15`, `PA24`, `PABA`, `PABM`, `PACF`, `PADU`, `PAE`, `PAHR`, `PAIN`, `PALT`, `PAM`, `PAMA`, `PAML`, `PANN`, `PANV`, `PAPM`, `PAPO`, `PAUD`, `PAV`, `PAVN`, `PAW`, `PBL`, `PBOT`, `PCC`, `PDI`, `PDL`, `PDLA`, `PE24`, `PE90`, `PECD`, `PELT`, `PES90`, `PES`, `PFIS`, `PFN`, `PFOI`, `PFOS`, `PFRD`, `PH90`, `PHAI`, `PHAO`, `PHLT`, `PHRL`, `PHSLT`, `PILE`, `PINV`, `PLEA`, `PLLT`, `PLS`, `PLST`, `PMA24`, `PMA90`, `PMAE`, `PMAIC`, `PMAOC`, `PMAOP`, `PMAOT`, `PML`, `PMNA`, `PMO`, `PMS`, `PMST`, `PMU`, `PMVS`, `PN3M`, `PNC`, `PNMB`, `PNN`, `PNNS`, `PNO`, `PNPB`, `PNRR`, `PNS`, `PNU`, `POD`, `PPC3`, `PPC5`, `PPC6`, `PPC9`, `PPGR`, `PPN`, `PPPH`, `PPRT`, `PPV`, `PRC`, `PRCO`, `PRM`, `PROM`, `PRP`, `PRSA`, `PRSK`, `PRSV`, `PSCD`, `PSDBM`, `PSFE`, `PSG24`, `PSG90`, `PSHRSN`, `PSM90`, `PSMDB`, `PSMRN`, `PSMSN`, `PSTF`, `PTFN`, `PTL`, `PTO`, `PVLA`, `PVLS`, `PVMN`, `PVOIP`, `PVRC`, `PVS24`, `PVS90`, `PVST`, `PVSTF`, `TANO`, `TDDA`, `TFAD1`, `TFADF`, `TFADI`, `TFVE`, `TFVI`, `TH3AA`, `TH3AH`, `TH3AI`, `TH3AO`, `TH3AS`, `TH3BO`, `TH3CH`, `TH3DB`, `TH3DI`, `TH3ED`, `TH3FG`, `TH3FR`, `TH3IT`, `TH3MR`, `TH3NN`, `TH3OM`, `TH3PB`, `TH3PH`, `TH3PR`, `TH3RI`, `TH3SA`, `TH3SF`, `TH3SM`, `THAAA`, `THAAH`, `THAAI`, `THAAO`, `THAAS`, `THABO`, `THACH`, `THADB`, `THADI`, `THAED`, `THAFG`, `THAFR`, `THAIT`, `THAMR`, `THANN`, `THAOM`, `THAPB`, `THAPH`, `THAPR`, `THARI`, `THASA`, `THASF`, `THASM`, `THPAA`, `THPAH`, `THPAI`, `THPAO`, `THPAS`, `THPBO`, `THPCH`, `THPDB`, `THPDI`, `THPED`, `THPFG`, `THPFR`, `THPIT`, `THPMR`, `THPNN`, `THPOM`, `THPPB`, `THPPH`, `THPPR`, `THPRI`, `THPSA`, `THPSF`, `THPSM`, `THTAH`, `THTAV`, `THTBE`, `THTBP`, `THTDI`, `THTED`, `THTES`, `THTFG`, `THTFR`, `THTGP`, `THTHE`, `THTIA`, `THTIH`, `THTIP`, `THTMX`, `THTNN`, `THTOM`, `THTPR`, `THTRP`, `THTSG`, `THTVP`, `TIAWB`, `TIAWF`, `TINO`, `TL3AA`, `TL3AH`, `TL3AI`, `TL3AO`, `TL3AS`, `TL3BO`, `TL3CH`, `TL3DB`, `TL3DI`, `TL3ED`, `TL3FG`, `TL3FR`, `TL3IT`, `TL3MR`, `TL3NN`, `TL3OM`, `TL3PB`, `TL3PH`, `TL3PR`, `TL3RI`, `TL3SA`, `TL3SF`, `TL3SM`, `TLAAA`, `TLAAH`, `TLAAI`, `TLAAO`, `TLAAS`, `TLABO`, `TLACH`, `TLADB`, `TLADI`, `TLAED`, `TLAFG`, `TLAFR`, `TLAIT`, `TLAMR`, `TLANN`, `TLAOM`, `TLAPB`, `TLAPH`, `TLAPR`, `TLARI`, `TLASA`, `TLASF`, `TLASM`, `TLGPD`, `TLPAA`, `TLPAH`, `TLPAI`, `TLPAO`, `TLPAS`, `TLPBO`, `TLPCH`, `TLPDB`, `TLPDI`, `TLPED`, `TLPFG`, `TLPFR`, `TLPIT`, `TLPMR`, `TLPNN`, `TLPOM`, `TLPPB`, `TLPPH`, `TLPPR`, `TLPRI`, `TLPSA`, `TLPSF`, `TLPSM`, `TLTAH`, `TLTAV`, `TLTBE`, `TLTBP`, `TLTDI`, `TLTED`, `TLTES`, `TLTFG`, `TLTFR`, `TLTGP`, `TLTHE`, `TLTIA`, `TLTIH`, `TLTIP`, `TLTMX`, `TLTNN`, `TLTOM`, `TLTPR`, `TLTRP`, `TLTSG`, `TLTVP`, `TMAI`, `TMFSI`, `TNAPD`, `TNASM`, `TNPID`, `TNPIE`, `TNPIN`, `TNPIP`, `TNPIR`, `TNPIS`, `TNPIZ`, `TNPMS`, `TOAB`, `TOAF`, `TPAI`, `TPDNV`, `TPSMT`, `TSAC`, `TSAF`, `TSBF`, `TSBG`, `TSBH`, `TSBI`, `TSBJ`, `TBK`, `TSBN`, `TSBO`, `TSCG`, `TSCH`, `TSDC`, `TSDD`, `TSDE`, `TSDF`, `TSDG`, `TSDH`, `TSDI`, `TSDJ`, `TSDK`, `TSDL`, `TSDM`, `TSDN`, `TSDO`, `TSDP`, `TSMA`, `TSMB`, `TSMC`, `TNSA`, `TSNB`, `TSNC`, `TSOA`, `TSKU`, `TSLI`, `TSLJ`, `TSLK`, `TSLN`, `TSLO`, `TSDV`, `TSNA`, `TSNV`, `TSOD`, `TSOP`, `TSPNA`, `TSPNM`, `TSR`, `TSRD`, `TSRF`, `TSSF`, `TSTUT`, `TTIQ`, `TXHR`, `TXMTW`, `TXNA`, `TXR`, `TXTW`, `TXVHR`, `TSRP` |
| `riskData.reasonCodes.reasonCodes.description` | string |  |  |
| `riskData.additionalVerificationInfo` | AdditionalVerificationInfo |  |  |
| `riskData.additionalVerificationInfo.creditFileDetails` | CreditFileDetails |  |  |
| `riskData.additionalVerificationInfo.creditFileDetails.creditFileNumber` | string |  |  |
| `riskData.additionalVerificationInfo.creditFileDetails.creditFileCreationDate` | string |  |  |
| `riskAddons` | array[object] |  |  |
| `riskAddons.type` | string |  | Enum: `phoneCheck`, `advancedPhoneCheck`, `emailCheck`, `phoneProfile` |
| `riskAddons.checkStatus` | string |  | Outcome of the check for the provided phone number: found or notFound. |
| `riskAddons.message` | string |  | Explanation returned when checkStatus is notFound. |
| `riskAddons.confidenceLevel` | string |  | Confidence in the returned identity match: low, medium or high. |
| `riskAddons.phoneFirstName` | string |  | First name on file for the phone number. |
| `riskAddons.phoneLastName` | string |  | Last name on file for the phone number. |
| `riskAddons.phoneDob` | string |  | Date of birth on file, yyyy-MM-dd. Availability varies by country. |
| `riskAddons.phoneValid` | boolean |  | Whether the provider considers the phone number valid. |
| `riskAddons.phoneCountry` | string |  | Country of the phone number as reported by the provider. |
| `riskAddons.phoneAddresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.phoneAddresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.nameReturned` | boolean |  | True only when both phoneFirstName and phoneLastName were returned. |
| `riskAddons.phonePersonAge` | integer (int32) |  | Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable. |
| `riskAddons.isAdult` | boolean |  | True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned. |
| `riskAddons.additionalProfiles` | array[PhoneProfileAdditionalProfileResponse] |  |  |
| `riskAddons.additionalProfiles.firstName` | string |  | First name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.lastName` | string |  | Last name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.dob` | string |  | Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it. |
| `riskAddons.additionalProfiles.addresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.additionalProfiles.addresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.reasonCodes` | array[string] |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/session");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "userData": {
    "plugins": [
      "string"
    ],
    "source": "US_DRIVERS_LICENSE_1",
    "fullName": "string",
    "firstName": "string",
    "middleName": "string",
    "surName": "string",
    "email": "string",
    "street": "string",
    "houseNo": "string",
    "postalCode": "string",
    "countryCode": "string",
    "phone": "string",
    "state": "string",
    "city": "string",
    "ssn": "string",
    "dateOfBirth": "string",
    "ipAddress": "string",
    "taxIdStatus": "string",
    "nationality": "string",
    "dlNumber": "string",
    "dlExpireAt": "string",
    "dlState": "string",
    "last4SSN": "string",
    "idNumber": "string",
    "panNumber": "string"
  },
  "riskData": {
    "level": "string",
    "verifications": {},
    "income": {
      "status": "string",
      "range": "string"
    },
    "employment": {
      "status": "string",
      "type": "string",
      "sector": "string"
    },
    "reasonCodes": [
      {
        "key": "string",
        "reasonCodes": [
          {
            "reasonCode": "A40SS",
            "description": "string"
          }
        ]
      }
    ],
    "additionalVerificationInfo": {
      "creditFileDetails": {
        "creditFileNumber": "string",
        "creditFileCreationDate": "string"
      }
    }
  },
  "riskAddons": [
    {
      "type": "phoneCheck",
      "checkStatus": "string",
      "message": "string",
      "confidenceLevel": "string",
      "phoneFirstName": "string",
      "phoneLastName": "string",
      "phoneDob": "string",
      "phoneValid": true,
      "phoneCountry": "string",
      "phoneAddresses": [
        {
          "address1": "string"
        }
      ],
      "nameReturned": true,
      "phonePersonAge": 0,
      "isAdult": true,
      "additionalProfiles": [
        {
          "firstName": "string",
          "lastName": "string",
          "dob": "string",
          "addresses": [
            {
              "address1": null
            }
          ]
        }
      ],
      "reasonCodes": [
        "string"
      ]
    }
  ]
}
```

---

- Path: `api-reference/externalverification-ekyc-unified`
- URL: https://developer.incode.com/api-reference/externalverification-ekyc-unified/
- Markdown: https://developer.incode.com/api-reference/externalverification-ekyc-unified.md
- Endpoint: `POST /omni/externalVerification/ekyc/unified`

# Unified start + eKYC + finish (low-latency)

`POST /omni/externalVerification/ekyc/unified`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Runs session start and eKYC verification in parallel and fires finish-status asynchronously,
returning once both the start and eKYC legs have resolved.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `start` | StartRequest | yes | Fields used to initialize the onboarding session (same shape as /omni/start). |
| `start.language` | string |  | Language code to be used when doing speech to text. Possible values: en-US, es-ES, pt-BR. |
| `start.externalId` | string |  | Id that identifies user in clients system should be used for externalId. (Deprecated, use externalCustomerId instead) |
| `start.externalCustomerId` | string |  | Id that identifies user in clients external system. |
| `start.uuid` | string |  | uuid key used in redis, can be used as an alternative to sending interviewId. |
| `start.configurationId` | string |  | Id of the flow to be used for this onboarding. |
| `start.redirectionUrl` | string |  | Url the user will be redirected to after finishing the onboarding successfully. |
| `start.integrationReference` | string |  | Optional integration reference. |
| `start.urlUuid` | string |  | Url uuid key used in redis. Will be validated in start if qrPhishingResistance is ON. |
| `start.customFields` | object |  | Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength} |
| `ekyc` | EkycVerificationRequest | yes | Fields used for the eKYC verification (same shape as /omni/externalVerification/ekyc). |
| `ekyc.plugins` | array[string] |  | Enum: `kyc` |
| `ekyc.firstName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `ekyc.surName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `ekyc.middleName` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `ekyc.maternalSurname` | string |  | The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\|=` |
| `ekyc.email` | string |  |  |
| `ekyc.street` | string |  |  |
| `ekyc.streetNo` | string |  |  |
| `ekyc.floor` | string |  |  |
| `ekyc.apartment` | string |  |  |
| `ekyc.postalCode` | string |  |  |
| `ekyc.countryCode` | string |  | ISO 3166-1 alpha-2 format |
| `ekyc.phone` | string |  | Use E.164 format. Hyphens are optional |
| `ekyc.state` | string |  |  |
| `ekyc.city` | string |  |  |
| `ekyc.idNumber` | string |  |  |
| `ekyc.idNumber1` | string |  |  |
| `ekyc.idNum` | string |  | Brazilian CPF number for BR_TAX_PHONE_REGISTER (IDmerit BR1) |
| `ekyc.gender` | string |  |  |
| `ekyc.taxId` | string |  |  |
| `ekyc.dateOfBirth` | string (YYYY-MM-DD) |  |  |
| `ekyc.dlExpireAt` | string (YYYY-MM-DD) |  |  |
| `ekyc.fullName` | string |  |  |
| `ekyc.panNumber` | string |  | Indian Permanent Account Number (PAN), format: AAAAANNNNA |
| `ekyc.district` | string |  | District or Barangay (neighbourhood), used for Philippines KYC |
| `ekyc.idType` | string |  | National ID type. Supported for Philippines KYC: SSS, TIN, GSIS |
| `ekyc.issueDate` | string (YYYY-MM-DD) |  | ID document issue date. Required for Colombia Civil Register (CO_CIVIL_REGISTER_1) KYC |
| `ekyc.fileNumber` | string |  | Indian passport file number (PRFN), format: 2 letters followed by 13 digits |
| `ekyc.dateOfIssue` | string (YYYY-MM-DD) |  | Passport issue date, used for INDIA_PASSPORT_1 KYC |
| `finishAsync` | boolean |  | When true (default), finish-session runs asynchronously after the response is sent. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | Identifier of the onboarding session created by /start. |
| `token` | string |  | JWT token for subsequent calls (X-Incode-Hardware-Id header). |
| `interviewCode` | string |  | Short onboarding code from /start. |
| `flowType` | string |  | Flow type of the configuration used. Enum: `configuration`, `flow`, `workflow` |
| `ekyc` | EkycVerificationResponse |  | eKYC verification result. |
| `ekyc.kyc` | array[EkycVerification] |  |  |
| `ekyc.kyc.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `ekyc.kyc.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `ekyc.kyc.sub_label` | string |  | Additional info on the status. |
| `ekyc.kyc.message` | string |  |  |
| `ekyc.kyc.reasonCodes` | array[string] |  |  |
| `ekyc.income` | array[EkycVerification] |  |  |
| `ekyc.income.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `ekyc.income.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `ekyc.income.sub_label` | string |  | Additional info on the status. |
| `ekyc.income.message` | string |  |  |
| `ekyc.income.reasonCodes` | array[string] |  |  |
| `ekyc.riskAddons` | array[object] |  |  |
| `ekyc.riskAddons.type` | string |  | Enum: `phoneCheck`, `advancedPhoneCheck`, `emailCheck`, `phoneProfile` |
| `ekyc.riskAddons.checkStatus` | string |  | Outcome of the check for the provided phone number: found or notFound. |
| `ekyc.riskAddons.message` | string |  | Explanation returned when checkStatus is notFound. |
| `ekyc.riskAddons.confidenceLevel` | string |  | Confidence in the returned identity match: low, medium or high. |
| `ekyc.riskAddons.phoneFirstName` | string |  | First name on file for the phone number. |
| `ekyc.riskAddons.phoneLastName` | string |  | Last name on file for the phone number. |
| `ekyc.riskAddons.phoneDob` | string |  | Date of birth on file, yyyy-MM-dd. Availability varies by country. |
| `ekyc.riskAddons.phoneValid` | boolean |  | Whether the provider considers the phone number valid. |
| `ekyc.riskAddons.phoneCountry` | string |  | Country of the phone number as reported by the provider. |
| `ekyc.riskAddons.phoneAddresses` | array[PhoneProfileAddressResponse] |  |  |
| `ekyc.riskAddons.phoneAddresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `ekyc.riskAddons.nameReturned` | boolean |  | True only when both phoneFirstName and phoneLastName were returned. |
| `ekyc.riskAddons.phonePersonAge` | integer (int32) |  | Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable. |
| `ekyc.riskAddons.isAdult` | boolean |  | True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned. |
| `ekyc.riskAddons.additionalProfiles` | array[PhoneProfileAdditionalProfileResponse] |  |  |
| `ekyc.riskAddons.additionalProfiles.firstName` | string |  | First name of the alternate candidate identity. |
| `ekyc.riskAddons.additionalProfiles.lastName` | string |  | Last name of the alternate candidate identity. |
| `ekyc.riskAddons.additionalProfiles.dob` | string |  | Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it. |
| `ekyc.riskAddons.additionalProfiles.addresses` | array[PhoneProfileAddressResponse] |  |  |
| `ekyc.riskAddons.additionalProfiles.addresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `ekyc.riskAddons.reasonCodes` | array[string] |  |  |
| `ekyc.additionalVerificationInfo` | AdditionalVerificationInfo |  |  |
| `ekyc.additionalVerificationInfo.creditFileDetails` | CreditFileDetails |  |  |
| `ekyc.additionalVerificationInfo.creditFileDetails.creditFileNumber` | string |  |  |
| `ekyc.additionalVerificationInfo.creditFileDetails.creditFileCreationDate` | string |  |  |
| `ekyc.sot` | string |  |  |
| `ekycStatus` | string |  | Status of the eKYC verification: SUCCESS, TIMEOUT, or ERROR. Enum: `SUCCESS`, `TIMEOUT`, `ERROR` |
| `finishQueued` | boolean |  | True when finish-session was queued for asynchronous processing. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/ekyc/unified");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "interviewId": "string",
  "token": "string",
  "interviewCode": "string",
  "flowType": "configuration",
  "ekyc": {
    "kyc": [
      {
        "key": "string",
        "status": "string",
        "sub_label": "string",
        "message": "string",
        "reasonCodes": [
          "string"
        ]
      }
    ],
    "income": [
      {
        "key": "string",
        "status": "string",
        "sub_label": "string",
        "message": "string",
        "reasonCodes": [
          "string"
        ]
      }
    ],
    "riskAddons": [
      {
        "type": "phoneCheck",
        "checkStatus": "string",
        "message": "string",
        "confidenceLevel": "string",
        "phoneFirstName": "string",
        "phoneLastName": "string",
        "phoneDob": "string",
        "phoneValid": true,
        "phoneCountry": "string",
        "phoneAddresses": [
          {
            "address1": "string"
          }
        ],
        "nameReturned": true,
        "phonePersonAge": 0,
        "isAdult": true,
        "additionalProfiles": [
          {
            "firstName": "string",
            "lastName": "string",
            "dob": "string",
            "addresses": []
          }
        ],
        "reasonCodes": [
          "string"
        ]
      }
    ],
    "additionalVerificationInfo": {
      "creditFileDetails": {
        "creditFileNumber": "string",
        "creditFileCreationDate": "string"
      }
    },
    "sot": "string"
  },
  "ekycStatus": "SUCCESS",
  "finishQueued": true
}
```

---

- Path: `api-reference/externalverification-income`
- URL: https://developer.incode.com/api-reference/externalverification-income/
- Markdown: https://developer.incode.com/api-reference/externalverification-income.md
- Endpoint: `POST /omni/externalVerification/income`

# eKYC Income verification

`POST /omni/externalVerification/income`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint performs an eKYC income check

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `taxId` | string | yes | 11 digit CPF |
| `country` | string | yes | Two letter Alpha-2 country code. (Must be BR). |

## Responses

### 200

Example: ``` { "income": [ { "key": "employment_type", "status": "success", "sub_label": "Type", "message": "ENTREPRENEUR \| BUSINESS OWNER" }, { "key": "employment_sector", "status": "success", "sub_label": "Sector", "message": "PRIVATE - 4639701 - COMERCIO ATACADISTA DE PRODUTOS ALIMENTICIOS EM GERAL" }, { "key": "income_range", "status": "success", "sub_label": "Estimated Income Range", "message": "9240-13200" } ] } ```

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kyc` | array[EkycVerification] |  |  |
| `kyc.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `kyc.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `kyc.sub_label` | string |  | Additional info on the status. |
| `kyc.message` | string |  |  |
| `kyc.reasonCodes` | array[string] |  |  |
| `income` | array[EkycVerification] |  |  |
| `income.key` | string |  | Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set. |
| `income.status` | string |  | Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN. |
| `income.sub_label` | string |  | Additional info on the status. |
| `income.message` | string |  |  |
| `income.reasonCodes` | array[string] |  |  |
| `riskAddons` | array[object] |  |  |
| `riskAddons.type` | string |  | Enum: `phoneCheck`, `advancedPhoneCheck`, `emailCheck`, `phoneProfile` |
| `riskAddons.checkStatus` | string |  | Outcome of the check for the provided phone number: found or notFound. |
| `riskAddons.message` | string |  | Explanation returned when checkStatus is notFound. |
| `riskAddons.confidenceLevel` | string |  | Confidence in the returned identity match: low, medium or high. |
| `riskAddons.phoneFirstName` | string |  | First name on file for the phone number. |
| `riskAddons.phoneLastName` | string |  | Last name on file for the phone number. |
| `riskAddons.phoneDob` | string |  | Date of birth on file, yyyy-MM-dd. Availability varies by country. |
| `riskAddons.phoneValid` | boolean |  | Whether the provider considers the phone number valid. |
| `riskAddons.phoneCountry` | string |  | Country of the phone number as reported by the provider. |
| `riskAddons.phoneAddresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.phoneAddresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.nameReturned` | boolean |  | True only when both phoneFirstName and phoneLastName were returned. |
| `riskAddons.phonePersonAge` | integer (int32) |  | Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable. |
| `riskAddons.isAdult` | boolean |  | True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned. |
| `riskAddons.additionalProfiles` | array[PhoneProfileAdditionalProfileResponse] |  |  |
| `riskAddons.additionalProfiles.firstName` | string |  | First name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.lastName` | string |  | Last name of the alternate candidate identity. |
| `riskAddons.additionalProfiles.dob` | string |  | Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it. |
| `riskAddons.additionalProfiles.addresses` | array[PhoneProfileAddressResponse] |  |  |
| `riskAddons.additionalProfiles.addresses.address1` | string |  | Single concatenated address string, not split into street, city, state or postal code. |
| `riskAddons.reasonCodes` | array[string] |  |  |
| `additionalVerificationInfo` | AdditionalVerificationInfo |  |  |
| `additionalVerificationInfo.creditFileDetails` | CreditFileDetails |  |  |
| `additionalVerificationInfo.creditFileDetails.creditFileNumber` | string |  |  |
| `additionalVerificationInfo.creditFileDetails.creditFileCreationDate` | string |  |  |
| `sot` | string |  |  |

### 400

Example: ``` { "timestamp": 1722948860110, "status": 400, "error": "Both country and taxId are mandatory fields must be submitted for successful request", "message": "Both country and taxId are mandatory fields must be submitted for successful request", "path": "/omni/externalVerification/income" } ```

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/externalVerification/income \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "taxId": "<taxId>",
    "country": "<country>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/externalVerification/income", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "taxId": "<taxId>",
      "country": "<country>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/externalVerification/income", headers=headers, json={
  "taxId": "<taxId>",
  "country": "<country>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/externalVerification/income"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"taxId\": \"<taxId>\",\n  \"country\": \"<country>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/externalVerification/income")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "taxId": "<taxId>",
  "country": "<country>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/externalVerification/income");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "taxId": "<taxId>",
  "country": "<country>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "kyc": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "income": [
    {
      "key": "string",
      "status": "string",
      "sub_label": "string",
      "message": "string",
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "riskAddons": [
    {
      "type": "phoneCheck",
      "checkStatus": "string",
      "message": "string",
      "confidenceLevel": "string",
      "phoneFirstName": "string",
      "phoneLastName": "string",
      "phoneDob": "string",
      "phoneValid": true,
      "phoneCountry": "string",
      "phoneAddresses": [
        {
          "address1": "string"
        }
      ],
      "nameReturned": true,
      "phonePersonAge": 0,
      "isAdult": true,
      "additionalProfiles": [
        {
          "firstName": "string",
          "lastName": "string",
          "dob": "string",
          "addresses": [
            {
              "address1": null
            }
          ]
        }
      ],
      "reasonCodes": [
        "string"
      ]
    }
  ],
  "additionalVerificationInfo": {
    "creditFileDetails": {
      "creditFileNumber": "string",
      "creditFileCreationDate": "string"
    }
  },
  "sot": "string"
}
```

---

- Path: `api-reference/finalize-document`
- URL: https://developer.incode.com/api-reference/finalize-document/
- Markdown: https://developer.incode.com/api-reference/finalize-document.md
- Endpoint: `POST /omni/finalize/document`

# Finalize document processing

`POST /omni/finalize/document`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Finalize document processing for multi-page documents with optional page capture

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | yes | Type of document image for which processing is being finalized. Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string |  | AddDocumentStatus Enum: `SUCCESS`, `PROCESS_DOC_ERROR`, `SESSION_ERROR`, `ADD_NEXT_PAGE`, `OPTIONAL_PAGE_CAPTURE`, `CLASSIFICATION_ERROR`, `MULTI_PAGE_CLASSIFICATION_ERROR`, `V5C_REGISTRATION_NUMBER_MISMATCH`, `V5C_REFERENCE_NUMBER_MISMATCH`, `V5C_NUMBER_MISMATCH`, `FSL_AGREEMENT_REFERENCE_MISMATCH`, `FSL_NAME_MISMATCH`, `NOT_W8_BEN`, `NOT_W8_BEN_E`, `MANDATORY_FIELD_MISSING`, `UNSUPPORTED_PAGE_NUMBERS`, `VALIDATION_ERROR`, `UNEXPECTED_ERROR`, `FINALIZE_ERROR_NO_PAGES`, `UNSUPPORTED_MP_DOCUMENT_TYPE` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/finalize/document \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "<type>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/finalize/document", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "type": "<type>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/finalize/document", headers=headers, json={
  "type": "<type>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/finalize/document"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"type\": \"<type>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/finalize/document")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "type": "<type>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/finalize/document");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "type": "<type>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "status": "SUCCESS"
}
```

---

- Path: `api-reference/finish`
- URL: https://developer.incode.com/api-reference/finish/
- Markdown: https://developer.incode.com/api-reference/finish.md
- Endpoint: `PUT /omni/finish`

# Finish interview

`PUT /omni/finish`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Finish the interview and remove customer from the queue.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | Interview id. |
| `status` | string |  | Status of finished interview Default: `NEEDS_REVIEW` Enum: `NO_CONFERENCE`, `APPROVED`, `REJECTED`, `ABANDONED`, `NEEDS_REVIEW`, `REJECTED_BY_RISK`, `COMPLETED` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `urls` | array[string] |  |  |
| `uuid` | string |  | ID of newly created customer (if onboarding was approved). |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/finish \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/finish", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/finish", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/finish"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/finish")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/finish");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "urls": [
    "string"
  ],
  "uuid": "string"
}
```

---

- Path: `api-reference/finish-status`
- URL: https://developer.incode.com/api-reference/finish-status/
- Markdown: https://developer.incode.com/api-reference/finish-status.md
- Endpoint: `GET /omni/finish-status`

# Mark onboarding complete

`GET /omni/finish-status`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

> **Deprecated** — this endpoint is marked deprecated in the Omni API specification.

Mark onboarding done.
    NOTE: This call is **deprecated**, use [POST /finish-status](#/Onboarding/finishSessionPost) instead.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `flowId` | query | string |  |  |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

Response: - redirectionUrl: String. Url to be redirected when onboarding is done - action: String. Possible values: none, approved, manualReview, rejected. Refers to the action performed based on the flow score configurations if applicable.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `redirectionUrl` | string |  |  |
| `action` | string |  |  |
| `customerId` | string |  |  |
| `scoreStatus` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "redirectionUrl": "string",
  "action": "string",
  "customerId": "string",
  "scoreStatus": "OK"
}
```

---

- Path: `api-reference/finish-status-post`
- URL: https://developer.incode.com/api-reference/finish-status-post/
- Markdown: https://developer.incode.com/api-reference/finish-status-post.md
- Endpoint: `POST /omni/finish-status`

# Mark onboarding complete

`POST /omni/finish-status`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Mark onboarding done

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `flowId` | query | string |  |  |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

Response: - redirectionUrl: String. Url to be redirected when onboarding is done - action: String. Possible values: none, approved, manualReview, rejected. Refers to the action performed based on the flow score configurations if applicable.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `redirectionUrl` | string |  |  |
| `action` | string |  |  |
| `customerId` | string |  |  |
| `scoreStatus` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/finish-status?flowId=%3CflowId%3E&interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "redirectionUrl": "string",
  "action": "string",
  "customerId": "string",
  "scoreStatus": "OK"
}
```

---

- Path: `api-reference/fiscal-qr-url-response`
- URL: https://developer.incode.com/api-reference/fiscal-qr-url-response/
- Markdown: https://developer.incode.com/api-reference/fiscal-qr-url-response.md
- Endpoint: `GET /omni/fiscal-qr-url-response/{interviewId}`

# Get fiscal qr url response

`GET /omni/fiscal-qr-url-response/{interviewId}`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get the information obtained from a fiscal qr url added to the session.
(México only)

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | path | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/fiscal-qr-url-response/%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/form-answers`
- URL: https://developer.incode.com/api-reference/form-answers/
- Markdown: https://developer.incode.com/api-reference/form-answers.md
- Endpoint: `GET /omni/form/answers`

# Fetch Form Answers

`GET /omni/form/answers`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Retrieves all questions and answers that a user has responded to during a session, regardless of the form module configurations used.

Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `answers` | array[FormAnswerDto] |  | The answers provided by the user |
| `answers.question` | string |  | The question presented to the user |
| `answers.answerDetails` | FormAnswerDetailsDto |  | Details on user's answer |
| `answers.answerDetails.singleAnswer` | string |  | The user's answer to the question. Date Format: Dates in responses are returned as milliseconds since the Unix epoch (UTC) Country Code Format: Country codes in responses are returned using ISO 3166-1 alpha-3 format. For example, "USA" for the United States of America, "GBR" for Great Britain. |
| `answers.answerDetails.selectedAnswers` | array[string] |  | Field intended to support multiple selected answers by the user. Currently, this functionality is not supported and will always return as an empty array. |
| `answers.inputType` | string |  | Indicates the type of input used for the answer Enum: `NUMBER`, `CPF`, `COUNTRY`, `NATIONALITY`, `DATE`, `PHONE`, `EMAIL`, `TEXT`, `MULTISELECT`, `YESNO`, `SELECT` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/form/answers?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "answers": [
    {
      "question": "string",
      "answerDetails": {
        "singleAnswer": "string",
        "selectedAnswers": [
          "string"
        ]
      },
      "inputType": "NUMBER"
    }
  ]
}
```

---

- Path: `api-reference/frame-analysis-analyze`
- URL: https://developer.incode.com/api-reference/frame-analysis-analyze/
- Markdown: https://developer.incode.com/api-reference/frame-analysis-analyze.md
- Endpoint: `POST /omni/frame-analysis/analyze`

# Analysis of all faces from selfie image

`POST /omni/frame-analysis/analyze`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Authenticate users by comparing base64 image from request and user's existing face templates.
Each face from the image is analyzed, and relevant attributes are extracted. In case of failure, error description is returned.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Base64 representation of image. |
| `videoRef` | string |  | Reference of video from which frame is extracted. |
| `frameRef` | string |  | Reference of frame that should be analyzed. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `identities` | array[AnalyzedIdentityDto] |  | List of identities analyzed from input base64image. |
| `identities.identityId` | string |  | Id of recognized customer. |
| `identities.estimatedAge` | integer (int32) |  | Estimated age based on extracted face. |
| `identities.error` | FrameAnalysisErrorDto |  | Error name. Possible error names are: LENSES_DETECTED, FACE_MASK_DETECTED, HEAD_COVER_DETECTED, CLOSED_EYES_DETECTED, SPOOF_ATTEMPT_DETECTED, USER_IS_NOT_RECOGNIZED |
| `identities.error.name` | string |  |  |
| `videoRef` | string |  | Reference of video from which frame is extracted. |
| `frameRef` | string |  | Reference of frame that is analyzed. |
| `error` | FrameAnalysisErrorDto |  | Error name. Possible error name is: FACE_EXTRACTION_FAILED |
| `error.name` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/frame-analysis/analyze \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/frame-analysis/analyze", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/frame-analysis/analyze", headers=headers, json={
  "base64Image": "<base64Image>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/frame-analysis/analyze"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/frame-analysis/analyze")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/frame-analysis/analyze");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "identities": [
    {
      "identityId": "string",
      "estimatedAge": 0,
      "error": {
        "name": "string"
      }
    }
  ],
  "videoRef": "string",
  "frameRef": "string",
  "error": {
    "name": "string"
  }
}
```

---

- Path: `api-reference/frame-analysis-analyze-third-party`
- URL: https://developer.incode.com/api-reference/frame-analysis-analyze-third-party/
- Markdown: https://developer.incode.com/api-reference/frame-analysis-analyze-third-party.md
- Endpoint: `POST /omni/frame-analysis/analyze/third-party`

# Analysis of all faces from selfie image

`POST /omni/frame-analysis/analyze/third-party`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Authenticate users by comparing base64 image from request and user's existing face templates.
Each face from the image is analyzed, and relevant attributes are extracted. In case of failure, error description is returned.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Base64 representation of image. |
| `videoRef` | string |  | Reference of video from which frame is extracted. |
| `frameRef` | string |  | Reference of frame that should be analyzed. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `identities` | array[AnalyzedIdentityDto] |  | List of identities analyzed from input base64image. |
| `identities.identityId` | string |  | Id of recognized customer. |
| `identities.estimatedAge` | integer (int32) |  | Estimated age based on extracted face. |
| `identities.error` | FrameAnalysisErrorDto |  | Error name. Possible error names are: LENSES_DETECTED, FACE_MASK_DETECTED, HEAD_COVER_DETECTED, CLOSED_EYES_DETECTED, SPOOF_ATTEMPT_DETECTED, USER_IS_NOT_RECOGNIZED |
| `identities.error.name` | string |  |  |
| `videoRef` | string |  | Reference of video from which frame is extracted. |
| `frameRef` | string |  | Reference of frame that is analyzed. |
| `error` | FrameAnalysisErrorDto |  | Error name. Possible error name is: FACE_EXTRACTION_FAILED |
| `error.name` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party", headers=headers, json={
  "base64Image": "<base64Image>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/frame-analysis/analyze/third-party");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "identities": [
    {
      "identityId": "string",
      "estimatedAge": 0,
      "error": {
        "name": "string"
      }
    }
  ],
  "videoRef": "string",
  "frameRef": "string",
  "error": {
    "name": "string"
  }
}
```

---

- Path: `api-reference/generatesessionrecordingdownloadurl`
- URL: https://developer.incode.com/api-reference/generatesessionrecordingdownloadurl/
- Markdown: https://developer.incode.com/api-reference/generatesessionrecordingdownloadurl.md
- Endpoint: `GET /omni/generateSessionRecordingDownloadUrl`

# Get url to download session recording

`GET /omni/generateSessionRecordingDownloadUrl`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get url to download session recording

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `type` | query | string | yes | Enum: `frontId`, `backId`, `merged`, `selfie`, `authenticationattempt`, `videoselfie` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/generateSessionRecordingDownloadUrl?interviewId=%3CinterviewId%3E&type=%3Ctype%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "url": "string"
}
```

---

- Path: `api-reference/generatevideoselfiedownloadurl`
- URL: https://developer.incode.com/api-reference/generatevideoselfiedownloadurl/
- Markdown: https://developer.incode.com/api-reference/generatevideoselfiedownloadurl.md
- Endpoint: `GET /omni/generateVideoSelfieDownloadUrl`

# Get download URL of videoselfie

`GET /omni/generateVideoSelfieDownloadUrl`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get URL for downloading video recording of video selfie. This is temporary pre-signed url, that expires in 1 hour

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  | Session ID for which url is generated. In case not set, interviewId will be determined from token from header. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/generateVideoSelfieDownloadUrl?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-archives`
- URL: https://developer.incode.com/api-reference/get-archives/
- Markdown: https://developer.incode.com/api-reference/get-archives.md
- Endpoint: `GET /omni/get/archives`

# Fetch video archive urls

`GET /omni/get/archives`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch URLs of video archives from given 'interviewId' or if omitted for given 'since' timestamp. If not provided,
'since' will be defaulted to time of first created archive. The maximum fetch size is 1000. In case maximum fetch size
is reached, a new fetch should be triggered, using 'startTime' of last record from previous fetch as 'since'. URLs returned are
temporary URLs, which expire in 5 days.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  | In case this parameter is provided, 'since' is ignored, and response will contain single interview requested. |
| `since` | query | integer (int64) |  | Timestamp — beginning of export. If omitted, it will be defaulted to time of first created archive. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

- archives: Array of archive objects - interviewId: String. ID of interview. - name: String. Name of the user in conference call. - url: String. URL of archive file. - startTime: Long. Timestamp of archive creation.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/archives?interviewId=%3CinterviewId%3E&since=%3Csince%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-chat`
- URL: https://developer.incode.com/api-reference/get-chat/
- Markdown: https://developer.incode.com/api-reference/get-chat.md
- Endpoint: `GET /omni/get/chat`

# Fetch conference chat

`GET /omni/get/chat`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch conference chat for given 'interviewId'.Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes | Interview id. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/chat?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-combined-consent`
- URL: https://developer.incode.com/api-reference/get-combined-consent/
- Markdown: https://developer.incode.com/api-reference/get-combined-consent.md
- Endpoint: `GET /omni/get/combined-consent`

# Get combined consent for requested language

`GET /omni/get/combined-consent`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches combined consent for requested language.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Consent id |
| `language` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string |  |  |
| `languageCode` | string |  | Enum: `ps-AF`, `sv-AX`, `sq-AL`, `ar-DZ`, `en-AS`, `ca-AD`, `pt-AO`, `en-AI`, `en-AQ`, `en-AG`, `es-AR`, `hy-AM`, `nl-AW`, `en-AU`, `de-AT`, `az-AZ`, `en-BS`, `ar-BH`, `bn-BD`, `en-BB`, `be-BY`, `nl-BE`, `en-BZ`, `fr-BJ`, `en-BM`, `dz-BT`, `es-BO`, `nl-BQ`, `bs-BA`, `en-BW`, `no-BV`, `pt-BR`, `en-IO`, `ms-BN`, `bg-BG`, `fr-BF`, `rn-BI`, `pt-CV`, `km-KH`, `fr-CM`, `en-CA`, `fr-CA`, `en-KY`, `fr-CF`, `fr-TD`, `es-CL`, `zh-CN`, `en-CX`, `ms-CC`, `es-CO`, `ar-KM`, `fr-CG`, `fr-CD`, `en-CK`, `es-CR`, `fr-CI`, `hr-HR`, `es-CU`, `nl-CW`, `el-CY`, `cs-CZ`, `da-DK`, `fr-DJ`, `en-DM`, `es-DO`, `es-EC`, `ar-EG`, `es-SV`, `es-GQ`, `aa-ER`, `et-EE`, `am-ET`, `en-FK`, `fo-FO`, `en-FJ`, `fi-FI`, `fr-FR`, `fr-GF`, `fr-PF`, `fr-TF`, `fr-GA`, `en-GM`, `ka-GE`, `de-DE`, `en-GH`, `en-GI`, `el-GR`, `kl-GL`, `en-GD`, `fr-GP`, `en-GU`, `es-GT`, `en-GG`, `fr-GN`, `pt-GW`, `en-GY`, `fr-HT`, `en-HM`, `it-VA`, `es-HN`, `zh-HK`, `hu-HU`, `is-IS`, `hi-IN`, `id-ID`, `fa-IR`, `ar-IQ`, `ga-IE`, `en-IM`, `he-IL`, `it-IT`, `en-JM`, `ja-JP`, `en-JE`, `ar-JO`, `kk-KZ`, `sw-KE`, `en-KI`, `ko-KP`, `ko-KR`, `ar-KW`, `ky-KG`, `lo-LA`, `lv-LV`, `ar-LB`, `en-LS`, `en-LR`, `ar-LY`, `de-LI`, `lt-LT`, `fr-LU`, `zh-MO`, `mg-MG`, `ny-MW`, `ms-MY`, `dv-MV`, `fr-ML`, `mt-MT`, `mh-MH`, `fr-MQ`, `ar-MR`, `en-MU`, `fr-YT`, `es-MX`, `en-FM`, `ro-MD`, `fr-MC`, `mn-MN`, `sr-ME`, `en-MS`, `ar-MA`, `pt-MZ`, `my-MM`, `en-NA`, `na-NR`, `ne-NP`, `nl-NL`, `fr-NC`, `en-NZ`, `es-NI`, `fr-NE`, `en-NG`, `en-NU`, `en-NF`, `mk_MK`, `en-MP`, `no-NO`, `ar-OM`, `ur-PK`, `en-PW`, `ar-PS`, `es-PA`, `en-PG`, `es-PY`, `es-PE`, `en-PH`, `en-PN`, `pl-PL`, `pt-PT`, `es-PR`, `ar-QA`, `fr-RE`, `ro-RO`, `ru-RU`, `rw-RW`, `fr-BL`, `en-SH`, `en-KN`, `en-LC`, `fr-MF`, `fr-PM`, `en-VC`, `sm-WS`, `it-SM`, `pt-ST`, `ar-SA`, `fr-SN`, `sr-RS`, `en-SC`, `en-SL`, `en-SG`, `nl-SX`, `sk-SK`, `sl-SI`, `en-SB`, `so-SO`, `en-ZA`, `en-GS`, `en-SS`, `es-ES`, `si-LK`, `ar-SD`, `nl-SR`, `no-SJ`, `en-SZ`, `sv-SE`, `de-CH`, `ar-SY`, `zh-TW`, `tg-TJ`, `sw-TZ`, `th-TH`, `pt-TL`, `fr-TG`, `en-TK`, `to-TO`, `en-TT`, `ar-TN`, `tr-TR`, `tk-TM`, `en-TC`, `tvl`, `sw-UG`, `uk-UA`, `ar-AE`, `en-GB`, `en-US`, `en-UM`, `es-UY`, `uz-UZ`, `bi-VU`, `es-VE`, `vi-VN`, `en-VG`, `en-VI`, `fr-WF`, `ar-EH`, `ar-YE`, `en-ZM`, `en-ZW`, `en`, `es`, `pt`, `fr`, `de`, `ar` |
| `title` | string |  |  |
| `terms` | string |  |  |
| `isDefault` | boolean |  |  |
| `consents` | array[ConsentCheckbox] |  |  |
| `consents.checkboxId` | string |  |  |
| `consents.consentText` | string |  |  |
| `consents.consentType` | string |  |  |
| `consents.origin` | string |  | Enum: `USER`, `SHARED` |
| `consents.optional` | boolean |  |  |
| `consents.editable` | boolean |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/combined-consent?id=%3Cid%3E&language=%3Clanguage%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "id": "string",
  "languageCode": "ps-AF",
  "title": "string",
  "terms": "string",
  "isDefault": true,
  "consents": [
    {
      "checkboxId": "string",
      "consentText": "string",
      "consentType": "string",
      "origin": "USER",
      "optional": true,
      "editable": true
    }
  ]
}
```

---

- Path: `api-reference/get-concatenated-images`
- URL: https://developer.incode.com/api-reference/get-concatenated-images/
- Markdown: https://developer.incode.com/api-reference/get-concatenated-images.md
- Endpoint: `POST /omni/get/concatenated-images`

# Fetch concatenated images

`POST /omni/get/concatenated-images`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Concatenates requested images from user. Resulting image keep the largest width of the requested images and preserves the order.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which images are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `images` | array[string] | yes | Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

For each requested image type, response contains line in format: {imageType}: String (base64) Base64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "images": []
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "images": []
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E", headers=headers, json={
  "images": []
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"images\": []\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "images": []
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/concatenated-images?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "images": []
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-conference-feedback`
- URL: https://developer.incode.com/api-reference/get-conference-feedback/
- Markdown: https://developer.incode.com/api-reference/get-conference-feedback.md
- Endpoint: `GET /omni/get/conference/feedback`

# Fetch conference feedback

`GET /omni/get/conference/feedback`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for fetching conference feedback for the interview/session. Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | ID of interview. If omitted the interview ID from token is used (current session) |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

conferenceFeedback: String. Feedback saved for interview.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/conference/feedback?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-conference-notes`
- URL: https://developer.incode.com/api-reference/get-conference-notes/
- Markdown: https://developer.incode.com/api-reference/get-conference-notes.md
- Endpoint: `GET /omni/get/conference/notes`

# Fetch notes

`GET /omni/get/conference/notes`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for fetching conference notes for interview/session. Works with <Glossary>Admin Token</Glossary>.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | ID of interview. If omitted, the interview ID from teh token is used (current session) |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

notes: String. Notes saved for interview.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/conference/notes?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-conference-status`
- URL: https://developer.incode.com/api-reference/get-conference-status/
- Markdown: https://developer.incode.com/api-reference/get-conference-status.md
- Endpoint: `GET /omni/get/conference-status`

# Fetch conference status

`GET /omni/get/conference-status`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns data about conference session for given ID.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  | ID of onboarding for which data is requested. If not present, it will be extracted from the token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conferenceStatus` | string |  | Enum: `NO_CONFERENCE`, `APPROVED`, `REJECTED`, `ABANDONED`, `NEEDS_REVIEW`, `REJECTED_BY_RISK`, `COMPLETED` |
| `executiveId` | string |  |  |
| `conferenceStartTime` | integer (int64) |  | UTC timestamp |
| `conferenceEndTime` | integer (int64) |  | UTC timestamp |
| `conferenceDuration` | integer (int64) |  | Conference duration in milliseconds. |
| `conferenceTermAndConditionsAccepted` | boolean |  |  |
| `creditBureauConsentGiven` | boolean |  |  |
| `applicantDataConfirmed` | boolean |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/conference-status?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "conferenceStatus": "NO_CONFERENCE",
  "executiveId": "string",
  "conferenceStartTime": 0,
  "conferenceEndTime": 0,
  "conferenceDuration": 0,
  "conferenceTermAndConditionsAccepted": true,
  "creditBureauConsentGiven": true,
  "applicantDataConfirmed": true
}
```

---

- Path: `api-reference/get-contracts-links`
- URL: https://developer.incode.com/api-reference/get-contracts-links/
- Markdown: https://developer.incode.com/api-reference/get-contracts-links.md
- Endpoint: `GET /omni/get/contracts-links`

# Get contracts links

`GET /omni/get/contracts-links`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches temporary link of the contracts uploaded for the current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/contracts-links?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "additionalInformation": {
    "document ID1": "Temporary URL to uploaded document with ID1",
    "document ID2": "Temporary URL to uploaded document with ID2",
    "document ID3": "Temporary URL to uploaded document with ID3"
  }
}
```

---

- Path: `api-reference/get-custom-fields`
- URL: https://developer.incode.com/api-reference/get-custom-fields/
- Markdown: https://developer.incode.com/api-reference/get-custom-fields.md
- Endpoint: `GET /omni/get/custom-fields`

# Get custom fields

`GET /omni/get/custom-fields`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for fetching custom fields for current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `customFields` | object |  | Map<String, Object>. Map of custom fields with type that was inserted. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/custom-fields \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/custom-fields", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/custom-fields", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/custom-fields"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/custom-fields")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/custom-fields");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "customFields": {}
}
```

---

- Path: `api-reference/get-device-info`
- URL: https://developer.incode.com/api-reference/get-device-info/
- Markdown: https://developer.incode.com/api-reference/get-device-info.md
- Endpoint: `GET /omni/get/device-info`

# Fetch device info

`GET /omni/get/device-info`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch information about device user was using during onboarding

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Represents interview id for which device data are requested. If it is not present it will be read from token. |
| `returnData` | query | boolean |  | If it is set to true, string representation of map which contains all data that enters the hash will be returned. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ipAddress` | string |  | IP address of the device from which onboarding is being executed. |
| `hash` | string |  | Hash is generated out of data specific to user device and browser: userAgent, webdriver, language, colorDepth, deviceMemory, hardwareConcurrency, screenResolution, availableScreenResolution, timezoneOffset, timezone, sessionStorage, localStorage, indexedDb, cpuClass, platform, plugins, canvas, webgl, webglVendorAndRenderer, adBlock, hasLiedLanguages, hasLiedResolution, hasLiedOs, hasLiedBrowser, touchSupport, fonts, audio. |
| `deviceType` | string |  | Device type Enum: `IOS`, `ANDROID`, `WEBAPP` |
| `osVersion` | string |  |  |
| `deviceModel` | string |  |  |
| `sdkVersion` | string |  |  |
| `browser` | string |  |  |
| `hasLiedBrowser` | boolean |  |  |
| `longitude` | number (float) |  | User's geolocation longitude. |
| `latitude` | number (float) |  | User's geolocation latitude. |
| `location` | string |  | User's location at the moment of onboarding process. |
| `getmAdminArea` | string |  | State |
| `getmSubAdminArea` | string |  | County |
| `getmLocality` | string |  | City |
| `getmSubLocality` | string |  | Neighborhood, common name |
| `getmThoroughfare` | string |  | Street name. |
| `getmSubThoroughfare` | string |  | Number. |
| `getmPostalCode` | string |  | Zip code |
| `getmCountryCode` | string |  | Country code |
| `getmCountryName` | string |  | Country name |
| `hostingApp` | string |  | Hosting App |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/device-info?id=%3Cid%3E&returnData=%3CreturnData%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "ipAddress": "string",
  "hash": "string",
  "deviceType": "IOS",
  "osVersion": "string",
  "deviceModel": "string",
  "sdkVersion": "string",
  "browser": "string",
  "hasLiedBrowser": true,
  "longitude": 0,
  "latitude": 0,
  "location": "string",
  "getmAdminArea": "CA",
  "getmSubAdminArea": "Santa Clara",
  "getmLocality": "string",
  "getmSubLocality": "Mission District",
  "getmThoroughfare": "string",
  "getmSubThoroughfare": "string",
  "getmPostalCode": 95014,
  "getmCountryCode": "US",
  "getmCountryName": "United States",
  "hostingApp": "Onboarding"
}
```

---

- Path: `api-reference/get-email`
- URL: https://developer.incode.com/api-reference/get-email/
- Markdown: https://developer.incode.com/api-reference/get-email.md
- Endpoint: `GET /omni/get/email`

# Get email

`GET /omni/get/email`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get email from interview previously added via [Add email](ref:addemail) endpoint

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/email?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "email": "string"
}
```

---

- Path: `api-reference/get-fingerprints`
- URL: https://developer.incode.com/api-reference/get-fingerprints/
- Markdown: https://developer.incode.com/api-reference/get-fingerprints.md
- Endpoint: `GET /omni/get/fingerprints`

# Get Fingerprints

`GET /omni/get/fingerprints`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used for fetching fingerprints for current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | integer (int32) |  |  |
| `fingerprints` | array[Fingerprint] | yes |  |
| `fingerprints.index` | integer (int32) |  |  |
| `fingerprints.base64Fingerprint` | string |  |  |
| `fingerprints.fingerprintMetadata` | FingerprintMetadata |  |  |
| `fingerprints.fingerprintMetadata.device` | string |  |  |
| `fingerprints.fingerprintMetadata.resolution` | string |  |  |
| `fingerprints.fingerprintMetadata.qualityScore` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/fingerprints \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/fingerprints", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/fingerprints", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/fingerprints"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/fingerprints")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/fingerprints");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "type": 0,
  "fingerprints": [
    {
      "index": 0,
      "base64Fingerprint": "string",
      "fingerprintMetadata": {
        "device": "string",
        "resolution": "string",
        "qualityScore": "string"
      }
    }
  ]
}
```

---

- Path: `api-reference/get-id-summary`
- URL: https://developer.incode.com/api-reference/get-id-summary/
- Markdown: https://developer.incode.com/api-reference/get-id-summary.md
- Endpoint: `GET /omni/get/id-summary`

# Get ID Summary

`GET /omni/get/id-summary`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns success information about addFront and addBack. Also returns onlyFront flag.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `onlyFront` | boolean |  |  |
| `addFrontResult` | IdSummaryDocumentSideResult |  |  |
| `addFrontResult.classification` | boolean |  |  |
| `addFrontResult.readability` | boolean |  |  |
| `addFrontResult.sharpness` | integer (int32) |  |  |
| `addFrontResult.glare` | integer (int32) |  |  |
| `addBackResult` | IdSummaryDocumentSideResult |  |  |
| `addBackResult.classification` | boolean |  |  |
| `addBackResult.readability` | boolean |  |  |
| `addBackResult.sharpness` | integer (int32) |  |  |
| `addBackResult.glare` | integer (int32) |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/id-summary?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "onlyFront": true,
  "addFrontResult": {
    "classification": true,
    "readability": true,
    "sharpness": 0,
    "glare": 0
  },
  "addBackResult": {
    "classification": true,
    "readability": true,
    "sharpness": 0,
    "glare": 0
  }
}
```

---

- Path: `api-reference/get-images`
- URL: https://developer.incode.com/api-reference/get-images/
- Markdown: https://developer.incode.com/api-reference/get-images.md
- Endpoint: `POST /omni/get/images`

# Fetch images

`POST /omni/get/images`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns images for user

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which images are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `images` | array[string] | yes | Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

For each requested image type, response contains line in format: {imageType}: String (base64) Base64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "images": []
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "images": []
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E", headers=headers, json={
  "images": []
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"images\": []\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "images": []
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/images?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "images": []
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-images-second-id`
- URL: https://developer.incode.com/api-reference/get-images-second-id/
- Markdown: https://developer.incode.com/api-reference/get-images-second-id.md
- Endpoint: `POST /omni/get/images-second-id`

# Fetch images second id

`POST /omni/get/images-second-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns images for second id of user

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which images are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `images` | array[string] | yes | Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

For each requested image type, response contains line in format: {imageType}: String (base64) Base64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "images": []
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "images": []
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E", headers=headers, json={
  "images": []
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"images\": []\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "images": []
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/images-second-id?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "images": []
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-images-second-id-v2`
- URL: https://developer.incode.com/api-reference/get-images-second-id-v2/
- Markdown: https://developer.incode.com/api-reference/get-images-second-id-v2.md
- Endpoint: `POST /omni/get/images-second-id/v2`

# Fetch image links for second id

`POST /omni/get/images-second-id/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns seconnd id images temporary links for requested images. Links are valid for one hour

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `images` | array[string] | yes | Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

For each requested image type, response contains line in format: {imageType}: String (base64). Base64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "images": []
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "images": []
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E", headers=headers, json={
  "images": []
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"images\": []\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "images": []
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/images-second-id/v2?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "images": []
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-images-v2`
- URL: https://developer.incode.com/api-reference/get-images-v2/
- Markdown: https://developer.incode.com/api-reference/get-images-v2.md
- Endpoint: `POST /omni/get/images/v2`

# Fetch image links

`POST /omni/get/images/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns images temporary links for requested images. Links are valid for one hour

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which images are requested. If not present, it will be extracted from token |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `images` | array[string] | yes | Enum: `selfie`, `authenticationSelfie`, `sorSelfie`, `videoSelfie`, `externalFace`, `croppedFace`, `croppedAuthenticationSelfie`, `croppedFrameAnalysisSelfie`, `croppedExternalFace`, `croppedIDFace`, `croppedNfcFace`, `document`, `originalSignature`, `signature`, `initials`, `fullFrameFrontID`, `fullFrameBackID`, `croppedFrontID`, `refCroppedFrontID`, `croppedBackID`, `refCroppedBackID`, `croppedOriginalFrontID`, `croppedOriginalBackID`, `confSelfie`, `confFrontID`, `confBackID`, `confPoa`, `addressStatement`, `medicalDoc`, `secondId`, `thirdId`, `contract`, `signedContract`, `videoSelfieCompareID`, `videoSelfieCompareOcr`, `videoSelfieCompareBackID`, `videoSelfieCompareBackOcr`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `paymentProof`, `consent`, `annotationImg`, `externalScreen`, `eSignDocument`, `sessionExport`, `zoomedFrontId`, `zoomedBackId`, `zoomedSelfie`, `regionBasedTemplate`, `renaperCropped`, `voiceConsentSelfie`, `v5cLogbook`, `v5cMultiPageLogbook`, `carInvoice`, `circulationCard`, `financeSettlement`, `w8Ben`, `w8BenE`, `faceRecordingFrame`, `signatureImageID`, `ghostSignatureImageID`, `ghostPortraitImageID`, `fingerprintImageID`, `documentNumberCropImageID`, `ineMexScan`, `originalNfcFace` |

## Responses

### 200

For each requested image type, response contains line in format: {imageType}: String (base64). Base64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "images": []
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "images": []
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E", headers=headers, json={
  "images": []
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"images\": []\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "images": []
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/images/v2?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "images": []
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-imss`
- URL: https://developer.incode.com/api-reference/get-imss/
- Markdown: https://developer.incode.com/api-reference/get-imss.md
- Endpoint: `GET /omni/get/imss`

# Fetch IMSS labor history

`GET /omni/get/imss`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch user's labor history from IMSS. Interview id is extracted from jwt token.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  |  |
| `requestId` | string |  |  |
| `workHistory` | WorkHistoryDto |  |  |
| `workHistory.name` | string |  |  |
| `workHistory.curp` | string |  |  |
| `workHistory.apiKey` | string |  |  |
| `workHistory.nss` | string |  |  |
| `workHistory.quotedWeeks` | QuotedWeeksDto |  |  |
| `workHistory.quotedWeeks.discountedWeeks` | integer (int32) |  |  |
| `workHistory.quotedWeeks.listedWeeks` | integer (int32) |  |  |
| `workHistory.quotedWeeks.reinstatedWeeks` | integer (int32) |  |  |
| `workHistory.laborHistoryList` | array[LaborHistory] |  |  |
| `workHistory.laborHistoryList.nombrePatron` | string |  |  |
| `workHistory.laborHistoryList.entidadFederativa` | string |  |  |
| `workHistory.laborHistoryList.fechaAlta` | string |  |  |
| `workHistory.laborHistoryList.fechaBaja` | string |  |  |
| `workHistory.laborHistoryList.salarioBaseCotizacion` | string |  |  |
| `workHistory.laborHistoryList.registroPatronal` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/imss?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "interviewId": "string",
  "requestId": "string",
  "workHistory": {
    "name": "string",
    "curp": "string",
    "apiKey": "string",
    "nss": "string",
    "quotedWeeks": {
      "discountedWeeks": 0,
      "listedWeeks": 0,
      "reinstatedWeeks": 0
    },
    "laborHistoryList": [
      {
        "nombrePatron": "string",
        "entidadFederativa": "string",
        "fechaAlta": "string",
        "fechaBaja": "string",
        "salarioBaseCotizacion": "string",
        "registroPatronal": "string"
      }
    ]
  }
}
```

---

- Path: `api-reference/get-interviewer-info`
- URL: https://developer.incode.com/api-reference/get-interviewer-info/
- Markdown: https://developer.incode.com/api-reference/get-interviewer-info.md
- Endpoint: `GET /omni/get/interviewer-info`

# Connect to conference call

`GET /omni/get/interviewer-info`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get interviewer name for given interview ID read from token. If the interviewer is not yet assigned to interview, null
will be returned. This method also returns credentials for OpenTok session. It is recommended to call this method
after [Get-user's-position](#/Conference/getQueueIndex) returns 0 in response.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewerName` | string |  | The name of the executive who is on a conference call with the user. |
| `apiKey` | integer (int32) |  | Used for establishing a conference connection via OpenTok. |
| `interviewToken` | string |  | Used for establishing a conference connection via OpenTok. |
| `sessionId` | string |  | Used for establishing a conference connection via OpenTok. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/interviewer-info \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/interviewer-info", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/interviewer-info", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/interviewer-info"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/interviewer-info")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/interviewer-info");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "interviewerName": "string",
  "apiKey": 0,
  "interviewToken": "string",
  "sessionId": "string"
}
```

---

- Path: `api-reference/get-ocr-data`
- URL: https://developer.incode.com/api-reference/get-ocr-data/
- Markdown: https://developer.incode.com/api-reference/get-ocr-data.md
- Endpoint: `GET /omni/get/ocr-data`

# Fetch ocr data

`GET /omni/get/ocr-data`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns data about user read from id and address statement.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | NameBean |  |  |
| `name.fullName` | string |  |  |
| `name.fullNameNativeScript` | string |  |  |
| `name.firstNameNativeScript` | string |  |  |
| `name.paternalLastNameNativeScript` | string |  |  |
| `name.maternalLastNameNativeScript` | string |  |  |
| `name.machineReadableFullName` | string |  | Full name from Barcode or MRZ |
| `name.firstName` | string |  |  |
| `name.middleName` | string |  |  |
| `name.givenName` | string |  |  |
| `name.givenNameMrz` | string |  |  |
| `name.initials` | string |  | Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide |
| `name.nameSuffix` | string |  |  |
| `name.paternalLastName` | string |  |  |
| `name.maternalLastName` | string |  |  |
| `name.lastNameMrz` | string |  |  |
| `name.familyName` | string |  |  |
| `address` | string |  | Address as read from id. Address can have two or three lines. Lines are separated by \\n |
| `addressFields` | AddressBean |  |  |
| `addressFields.street` | string |  | Street line in the way it is read from address string. |
| `addressFields.streetName` | string |  | Street name without exterior and interior numbers. |
| `addressFields.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `addressFields.postalCode` | string |  | Postal code in the way it is read from address string. |
| `addressFields.city` | string |  | City in the way it is read from address string. |
| `addressFields.state` | string |  | State in the way it is read from address string. |
| `addressFields.stateName` | string |  | Full StateName. |
| `addressFields.district` | string |  | District in the way it is read from address string. |
| `addressFields.stateCode` | string |  | State code if applicable. |
| `addressFields.addressCountryCode` | string |  | Address country code if applicable. |
| `addressFields.label` | string |  | Full address label. |
| `addressFields.exteriorNumber` | string |  | Exterior street number. |
| `addressFields.interiorNumber` | string |  | Interior street number. |
| `addressFields.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `addressFields.streetType` | string |  | Street type |
| `fullAddress` | boolean |  | This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only). |
| `invalidAddress` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and that both colony and city have values. (Only checked for Mexican IDs) |
| `checkedAddress` | string |  | Address as obtained after processing with geocoder geolocation api. |
| `checkedAddressBean` | AddressBean |  |  |
| `checkedAddressBean.street` | string |  | Street line in the way it is read from address string. |
| `checkedAddressBean.streetName` | string |  | Street name without exterior and interior numbers. |
| `checkedAddressBean.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `checkedAddressBean.postalCode` | string |  | Postal code in the way it is read from address string. |
| `checkedAddressBean.city` | string |  | City in the way it is read from address string. |
| `checkedAddressBean.state` | string |  | State in the way it is read from address string. |
| `checkedAddressBean.stateName` | string |  | Full StateName. |
| `checkedAddressBean.district` | string |  | District in the way it is read from address string. |
| `checkedAddressBean.stateCode` | string |  | State code if applicable. |
| `checkedAddressBean.addressCountryCode` | string |  | Address country code if applicable. |
| `checkedAddressBean.label` | string |  | Full address label. |
| `checkedAddressBean.exteriorNumber` | string |  | Exterior street number. |
| `checkedAddressBean.interiorNumber` | string |  | Interior street number. |
| `checkedAddressBean.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `checkedAddressBean.streetType` | string |  | Street type |
| `exteriorNumber` | string |  | Exterior street number. |
| `interiorNumber` | string |  | Interior street number. |
| `addressFromStatement` | string |  | Address as read from address statement. Lines are separated by \\n. |
| `addressFieldsFromStatement` | AddressBean |  |  |
| `addressFieldsFromStatement.street` | string |  | Street line in the way it is read from address string. |
| `addressFieldsFromStatement.streetName` | string |  | Street name without exterior and interior numbers. |
| `addressFieldsFromStatement.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `addressFieldsFromStatement.postalCode` | string |  | Postal code in the way it is read from address string. |
| `addressFieldsFromStatement.city` | string |  | City in the way it is read from address string. |
| `addressFieldsFromStatement.state` | string |  | State in the way it is read from address string. |
| `addressFieldsFromStatement.stateName` | string |  | Full StateName. |
| `addressFieldsFromStatement.district` | string |  | District in the way it is read from address string. |
| `addressFieldsFromStatement.stateCode` | string |  | State code if applicable. |
| `addressFieldsFromStatement.addressCountryCode` | string |  | Address country code if applicable. |
| `addressFieldsFromStatement.label` | string |  | Full address label. |
| `addressFieldsFromStatement.exteriorNumber` | string |  | Exterior street number. |
| `addressFieldsFromStatement.interiorNumber` | string |  | Interior street number. |
| `addressFieldsFromStatement.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `addressFieldsFromStatement.streetType` | string |  | Street type |
| `invalidAddressFromStatement` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and tha both colony and city have values. (Only checked for Mexican POA) |
| `addressStatementEmissionDate` | integer (int64) |  | Issue date of address statement. The value is presented in UTC milliseconds. |
| `documentType` | string |  | Type of address statement document. Possible values: - Mexico: liverpool, citibanamex, cfe, telcel, izzi, axtel, telmex, oapas, sacmex, opdm, naturgy, drenaje, totalplay, dhc, att, cea, smapa, megacable, jmas, amicsa, caev - Bolivia: cre - Uruguay: ute - Unknown document: otherPoa Enum: `aysa`, `edelap`, `edenor`, `edesur`, `epec`, `metrogas`, `a1`, `aggm`, `apg`, `energieAg`, `cre`, `eaab`, `enel`, `vanti`, `aforeAzteca`, `aforeBanorte`, `amd`, `amicsa`, `att`, `axtel`, `bancoppel`, `bancoAzteca`, `banorte`, `bbva`, `cab`, `caev`, `capa`, `cea`, `cfe`, `citibanamex`, `cmapa`, `cmapaGrande`, `cmapas`, `cmas`, `cmasBlue`, `comapa`, `comapaRed`, `coppel`, `dapa`, `dhc`, `drenaje`, `ecogas`, `engie`, `gasNatural`, `h`, `hsbc`, `inbursa`, `infonavit`, `interapas`, `isagas`, `izzi`, `jad`, `japam`, `japama`, `japami`, `japay`, `jiapaz`, `jmas`, `jras`, `jumapac`, `jumapam`, `lerdo`, `liverpool`, `mas`, `megacable`, `naturgy`, `oapas`, `odapas`, `ooapas`, `opdm`, `oroapa`, `sacmex`, `sacmexCdmx`, `santander`, `sapa`, `sapal`, `sapamuy`, `sapasa`, `sapasma`, `scotiabank`, `seapal`, `siapa`, `siapaTepic`, `simapag`, `simapas`, `simas`, `smapa`, `smapac`, `smapam`, `smapas`, `spectrum`, `stori`, `sura`, `tam`, `telcel`, `telmex`, `totalplay`, `veolia`, `victoria`, `wizz`, `asylumSeeker`, `refugeeId`, `refugeeStatus`, `ute`, `telkom`, `tmobile`, `verizon`, `xfinity`, `aforeCoppel`, `americanExpress`, `ap`, `telnor`, `wellsFargo`, `otherPoa` |
| `addressStatementTimestamps` | array[AddressStatementDate] |  |  |
| `addressStatementTimestamps.get_version` | integer (int64) |  |  |
| `addressStatementTimestamps.dateType` | string |  | Description of timestamp. |
| `addressStatementTimestamps.addressStatementTimestamp` | integer (int64) |  | UTC timestamp. |
| `poaName` | string |  | Extracted name from address statement. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `documentFrontSubtype` | string |  | Additional info about ID type (front side) |
| `documentBackSubtype` | string |  | Additional info about ID type (back side) |
| `issueFront` | integer (int32) |  | Issue year (per classification model) of the ID (front side) |
| `issueBack` | integer (int32) |  | Issue year (per classification model) of the ID (back side) |
| `birthDate` | integer (int64) |  | Date of birth is presented in UTC milliseconds. |
| `gender` | string |  | Gender values are presented in English. "M" for male, "F" for female and "X" for non-binary. Enum: `M`, `F`, `X` |
| `claveDeElector` | string |  | Clave de elector as read from id. For Mexican IDs only. |
| `curp` | string |  | Curp as read form id. For Mexican IDs only. |
| `numeroEmisionCredencial` | string |  | Numero Emision Credencial as read from id. (For Mexican IDs only). |
| `cic` | string |  | Cic as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `ocr` | string |  | Ocr as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `documentNumber` | string |  | Document number. |
| `documentNumberSource` | string |  | Document number source. Enum: `FORM`, `OCR` |
| `personalNumber` | string |  | Personal number. |
| `nationalNumber` | string |  | National number. |
| `refNumber` | string |  | Document Reference Number. |
| `familyNumber` | string |  | Family or household registry number printed on the document. |
| `taxIdNumber` | string |  | Personal tax identification number. |
| `nue` | string |  | NUE number as read from id. (for Resident Cards) |
| `externalId` | string |  | External user id. |
| `issuedAt` | string |  | Date of issue UTC timestamp. |
| `expireAt` | string |  | Expiration date UTC timestamp. |
| `expirationDate` | integer (int32) |  | Expiration year of id. |
| `issueDate` | integer (int32) |  | Issue year of id. |
| `registrationDate` | integer (int32) |  | Registration date read from id. |
| `dlClassDetails` | array[DLClassDetails] |  |  |
| `dlClassDetails.dlClass` | string |  | Driver's license class. |
| `dlClassDetails.validFromDate` | integer (int64) |  | DL class valid from UTC timestamp |
| `dlClassDetails.validToDate` | integer (int64) |  | DL class valid to UTC timestamp. |
| `dlClassDetails.additionalCodes` | string |  | Additional codes associated with DL class. |
| `dlClassDetails.restrictions` | array[string] |  | Restriction codes associated with DL class. |
| `issuingCountry` | string |  | Issuing country of document. |
| `issuingState` | string |  | Issuing state of document. |
| `birthPlace` | string |  | Birth place as read from id. |
| `printingNumber` | string |  | Printing number (número de impresión) printed below the barcode on Colombian IDs. |
| `duplicateNumber` | string |  | Number of duplicates (número de duplicados) printed below the barcode on Colombian IDs. |
| `preparationNumber` | string |  | Preparation number (número de preparación) printed below the barcode on Colombian IDs. |
| `issuingAuthority` | string |  | Issuing Authority as read from id. |
| `height` | string |  | Person's height as read from id. |
| `weight` | string |  | Person's weight. |
| `eyeColor` | string |  | Person's eye color. |
| `hairColor` | string |  | Person's hair color. |
| `religion` | string |  | Person's religion. |
| `bloodType` | string |  | Person's blood type. |
| `maritalStatus` | string |  | Person's marital status. |
| `nationality` | string |  | Person's nationality. |
| `race` | string |  | Person's race. |
| `nationalityMrz` | string |  | Person's nationality as it appears in MRZ (if present). |
| `nationalityAlpha3` | string |  | Person's nationality Alpha3 code format. Only for Brazilian IDs. |
| `governmentComparisonResults` | GovernmentComparisonResults |  | Government validation data. Only for supported government validation countries. |
| `governmentComparisonResults.paternalLastNameValid` | boolean |  | Indicates validity of person's paternal last name through government validation apis. |
| `governmentComparisonResults.maternalLastNameValid` | boolean |  | Indicates validity of person's maternal last name through government validation apis. |
| `governmentComparisonResults.firstNameValid` | boolean |  | Indicates validity of person's first name through government validation apis. |
| `governmentComparisonResults.curpValid` | boolean |  | Indicates CURP validity through RENAPO/CURP provider validation. |
| `governmentComparisonResults.ineCurpValid` | boolean |  | Indicates CURP validity through INE government validation (separate from RENAPO). |
| `governmentComparisonResults.ocrValid` | boolean |  | Indicates ocr validity through government validation apis. |
| `governmentComparisonResults.claveDeElectorValid` | boolean |  | Indicates "clave de elector" validity through government validation apis. |
| `governmentComparisonResults.numeroEmisionCredencialValid` | boolean |  | Indicates "numero emision credencial" validity through government validation apis. |
| `governmentComparisonResults.registrationDateValid` | boolean |  | Indicates registration date validity through government validation apis. |
| `governmentComparisonResults.issueDateValid` | boolean |  | Indicates issue date validity through government validation apis. |
| `notExtracted` | integer (int32) |  | Number of not extracted OCR fields. Only for Mexican IDs. |
| `notExtractedDetails` | array[string] |  |  |
| `classes` | string |  | Person's driver licence classes. |
| `cond` | string |  | Person's driver licence conditions. |
| `mentions` | string |  | Person's driver licence mentions. |
| `restrictions` | string |  | Person's driver licence restrictions. |
| `mrz1` | string |  | First MRZ line. |
| `mrz2` | string |  | Second MRZ line. |
| `mrz3` | string |  | Third MRZ line. |
| `fullNameMrz` | string |  | Person's full name read from MRZ. |
| `documentNumberCheckDigit` | string |  | Document number check digit read from MRZ. |
| `dateOfBirthCheckDigit` | string |  | Date of birth check digit read from MRZ. |
| `expirationDateCheckDigit` | string |  | Expiration date check digit read from MRZ. |
| `barcodeRawData` | string |  | Full unformatted data read from 2D barcode. |
| `qrFrontContents` | array[string] |  | Raw QR code payloads read from the front of the document, unparsed. Omitted when the capture was redacted. |
| `qrBackContents` | array[string] |  | Raw QR code payloads read from the back of the document, unparsed. Omitted when the capture was redacted. |
| `fathersName` | string |  | Person's father's name. Only for Brazilian and Indian IDs. |
| `mothersName` | string |  | Person's mother's name. Only for Brazilian IDs. |
| `fathersIdNumber` | string |  | Person's father's Id Number. In the context of minors identity validation. |
| `mothersIdNumber` | string |  | Person's mother's Id Number. In the context of minors identity validation. |
| `spouseName` | string |  | Person's spouse's name. |
| `federalRevenueNumber` | string |  | Federal revenue number. Only for Brazilian IDs. |
| `originDocumentId` | string |  | Origin document ID. Only for Brazilian IDs. |
| `driversLicenseCategory` | string |  | Driver's licence category. Only for Brazilian IDs. |
| `controlNumber` | string |  | Control number. Only for Brazilian IDs. |
| `renach` | string |  | Renach. Only for Brazilian IDs. |
| `additionalAttrs` | array[string] |  | Additional document attributes. Enum: `DOCUMENTO_INFANTIL`, `IDADE_PRE_ESCOLAR`, `MENOR_DE_ANOS`, `NAO_ASSINA`, `EM_FASE_DE_ALFABETIZACAO`, `IMPOSSIBILITADO_DE_ASSINAR`, `LIMITED_TERM`, `FEDERAL_LIMITS_APPLY`, `PERMISO_PARA_TRABAJAR`, `EXTRANJERO`, `INDIA_DIGITAL_VID`, `VETERAN`, `MOTORCYCLE_LICENSE`, `NON_DOMICILED`, `COMMERCIAL_LICENSE`, `RESIDENTE`, `MIGRANTE`, `TEMPORAL`, `VISITANTE`, `TRAMITE`, `RUEX`, `INDIGENA`, `AFROMEXICANA`, `INDIA_DIGITAL_TAXID` |
| `ocrDataConfidence` | OcrDataConfidence |  | Structure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1. |
| `ocrDataConfidence.birthDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.firstNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.paternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.maternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.givenNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.firstNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.middleNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameSuffixConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersSurnameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersSurnameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nickNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fullNameMrzConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.spouseNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.birthNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.addressConfidence` | number (float) |  |  |
| `ocrDataConfidence.streetConfidence` | number (float) |  |  |
| `ocrDataConfidence.colonyConfidence` | number (float) |  |  |
| `ocrDataConfidence.postalCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.cityConfidence` | number (float) |  |  |
| `ocrDataConfidence.stateConfidence` | number (float) |  |  |
| `ocrDataConfidence.districtConfidence` | number (float) |  |  |
| `ocrDataConfidence.stateCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.countryCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.genderConfidence` | number (float) |  |  |
| `ocrDataConfidence.issueDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.expirationDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.issuedAtConfidence` | number (float) |  |  |
| `ocrDataConfidence.expireAtConfidence` | number (float) |  |  |
| `ocrDataConfidence.issuingAuthorityConfidence` | number (float) |  |  |
| `ocrDataConfidence.mrz1Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrz2Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrz3Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrzFullConfidence` | number (float) |  |  |
| `ocrDataConfidence.documentNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.backNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.personalNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.claveDeElectorConfidence` | number (float) |  |  |
| `ocrDataConfidence.numeroEmisionCredencialConfidence` | number (float) |  |  |
| `ocrDataConfidence.curpConfidence` | number (float) |  |  |
| `ocrDataConfidence.nueConfidence` | number (float) |  |  |
| `ocrDataConfidence.registrationDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.heightConfidence` | number (float) |  |  |
| `ocrDataConfidence.birthPlaceConfidence` | number (float) |  |  |
| `ocrDataConfidence.bloodTypeConfidence` | number (float) |  |  |
| `ocrDataConfidence.eyeColorConfidence` | number (float) |  |  |
| `ocrDataConfidence.classesConfidence` | number (float) |  |  |
| `ocrDataConfidence.condConfidence` | number (float) |  |  |
| `ocrDataConfidence.mentionsConfidence` | number (float) |  |  |
| `ocrDataConfidence.refNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.weightConfidence` | number (float) |  |  |
| `ocrDataConfidence.hairConfidence` | number (float) |  |  |
| `ocrDataConfidence.restrictionsConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityMrzConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityAlpha3Confidence` | number (float) |  |  |
| `ocrDataConfidence.maritalStatusConfidence` | number (float) |  |  |
| `ocrDataConfidence.raceConfidence` | number (float) |  |  |
| `ocrDataConfidence.taxIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.jurisdictionCodeConfidence` | number (float) |  |  |
| `additionalDocumentAttempts` | array[AdditionalDocumentAttemptDto] |  |  |
| `additionalDocumentAttempts.status` | string |  | Enum: `SUCCESS`, `VALIDATION_ERROR`, `FAIL` |
| `additionalDocumentAttempts.attemptTimestamp` | integer (int64) |  |  |
| `additionalDocumentAttempts.imagesUrl` | array[string] |  |  |
| `additionalDocumentAttempts.attemptType` | string |  | Enum: `POA`, `DOCUMENT_CAPTURE` |
| `additionalDocumentAttempts.antiSpoofResult` | PoaAntiSpoofResult |  |  |
| `additionalDocumentAttempts.antiSpoofResult.status` | string |  | Enum: `PASS`, `FAIL`, `NOT_EXECUTED` |
| `additionalDocumentAttempts.antiSpoofResult.kinds` | array[string] |  |  |
| `additionalDocumentAttempts.antiSpoofResult.confidence` | number (float) |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details` | array[Detail] |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.kind` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.error` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.loc` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.explanation` | string |  |  |
| `additionalDocumentAttempts.documentType` | string | yes |  |
| `documentSubmissionMethod` | string |  | Method used to submit the document. Enum: `CAPTURED_DOCUMENT`, `UPLOADED_FILE`, `IMPORTED_CREDENTIAL` |
| `credentialsProvider` | string |  | Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL. Enum: `APPLE`, `GOOGLE`, `DIGILOCKER`, `SAMSUNG`, `DIGITAL_ID`, `NETHERLANDS_IDIN`, `FINNISH_TRUST_NETWORK` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/ocr-data?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "name": {
    "fullName": "string",
    "fullNameNativeScript": "string",
    "firstNameNativeScript": "string",
    "paternalLastNameNativeScript": "string",
    "maternalLastNameNativeScript": "string",
    "machineReadableFullName": "string",
    "firstName": "string",
    "middleName": "string",
    "givenName": "string",
    "givenNameMrz": "string",
    "initials": "string",
    "nameSuffix": "string",
    "paternalLastName": "string",
    "maternalLastName": "string",
    "lastNameMrz": "string",
    "familyName": "string"
  },
  "address": "string",
  "addressFields": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "fullAddress": true,
  "invalidAddress": true,
  "checkedAddress": "string",
  "checkedAddressBean": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "exteriorNumber": "string",
  "interiorNumber": "string",
  "addressFromStatement": "string",
  "addressFieldsFromStatement": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "invalidAddressFromStatement": true,
  "addressStatementEmissionDate": 0,
  "documentType": "aysa",
  "addressStatementTimestamps": [
    {
      "get_version": 0,
      "dateType": "string",
      "addressStatementTimestamp": 0
    }
  ],
  "poaName": "string",
  "typeOfId": "Unknown",
  "documentFrontSubtype": "string",
  "documentBackSubtype": "string",
  "issueFront": 0,
  "issueBack": 0,
  "birthDate": 0,
  "gender": "M",
  "claveDeElector": "string",
  "curp": "string",
  "numeroEmisionCredencial": "string",
  "cic": "string",
  "ocr": "string",
  "documentNumber": "string",
  "documentNumberSource": "FORM",
  "personalNumber": "string",
  "nationalNumber": "string",
  "refNumber": "string",
  "familyNumber": "string",
  "taxIdNumber": "string",
  "nue": "string",
  "externalId": "string",
  "issuedAt": "string",
  "expireAt": "string",
  "expirationDate": 0,
  "issueDate": 0,
  "registrationDate": 0,
  "dlClassDetails": [
    {
      "dlClass": "string",
      "validFromDate": 0,
      "validToDate": 0,
      "additionalCodes": "string",
      "restrictions": [
        "string"
      ]
    }
  ],
  "issuingCountry": "string",
  "issuingState": "string",
  "birthPlace": "string",
  "printingNumber": "string",
  "duplicateNumber": "string",
  "preparationNumber": "string",
  "issuingAuthority": "string",
  "height": "string",
  "weight": "string",
  "eyeColor": "string",
  "hairColor": "string",
  "religion": "string",
  "bloodType": "string",
  "maritalStatus": "string",
  "nationality": "string",
  "race": "string",
  "nationalityMrz": "string",
  "nationalityAlpha3": "string",
  "governmentComparisonResults": {
    "paternalLastNameValid": true,
    "maternalLastNameValid": true,
    "firstNameValid": true,
    "curpValid": true,
    "ineCurpValid": true,
    "ocrValid": true,
    "claveDeElectorValid": true,
    "numeroEmisionCredencialValid": true,
    "registrationDateValid": true,
    "issueDateValid": true
  },
  "notExtracted": 0,
  "notExtractedDetails": [
    "string"
  ],
  "classes": "string",
  "cond": "string",
  "mentions": "string",
  "restrictions": "string",
  "mrz1": "string",
  "mrz2": "string",
  "mrz3": "string",
  "fullNameMrz": "string",
  "documentNumberCheckDigit": "string",
  "dateOfBirthCheckDigit": "string",
  "expirationDateCheckDigit": "string",
  "barcodeRawData": "string",
  "qrFrontContents": [
    "string"
  ],
  "qrBackContents": [
    "string"
  ],
  "fathersName": "string",
  "mothersName": "string",
  "fathersIdNumber": "string",
  "mothersIdNumber": "string",
  "spouseName": "string",
  "federalRevenueNumber": "string",
  "originDocumentId": "string",
  "driversLicenseCategory": "string",
  "controlNumber": "string",
  "renach": "string",
  "additionalAttrs": [
    "DOCUMENTO_INFANTIL"
  ],
  "ocrDataConfidence": {
    "birthDateConfidence": 0,
    "nameConfidence": 0,
    "nameNativeScriptConfidence": 0,
    "firstNameNativeScriptConfidence": 0,
    "paternalLastNameNativeScriptConfidence": 0,
    "maternalLastNameNativeScriptConfidence": 0,
    "givenNameConfidence": 0,
    "firstNameConfidence": 0,
    "middleNameConfidence": 0,
    "nameSuffixConfidence": 0,
    "mothersSurnameConfidence": 0,
    "fathersSurnameConfidence": 0,
    "nickNameConfidence": 0,
    "fullNameMrzConfidence": 0,
    "mothersNameConfidence": 0,
    "fathersNameConfidence": 0,
    "mothersIdNumberConfidence": 0,
    "fathersIdNumberConfidence": 0,
    "spouseNameConfidence": 0,
    "birthNameConfidence": 0,
    "addressConfidence": 0,
    "streetConfidence": 0,
    "colonyConfidence": 0,
    "postalCodeConfidence": 0,
    "cityConfidence": 0,
    "stateConfidence": 0,
    "districtConfidence": 0,
    "stateCodeConfidence": 0,
    "countryCodeConfidence": 0,
    "genderConfidence": 0,
    "issueDateConfidence": 0,
    "expirationDateConfidence": 0,
    "issuedAtConfidence": 0,
    "expireAtConfidence": 0,
    "issuingAuthorityConfidence": 0,
    "mrz1Confidence": 0,
    "mrz2Confidence": 0,
    "mrz3Confidence": 0,
    "mrzFullConfidence": 0,
    "documentNumberConfidence": 0,
    "backNumberConfidence": 0,
    "personalNumberConfidence": 0,
    "nationalNumberConfidence": 0,
    "claveDeElectorConfidence": 0,
    "numeroEmisionCredencialConfidence": 0,
    "curpConfidence": 0,
    "nueConfidence": 0,
    "registrationDateConfidence": 0,
    "heightConfidence": 0,
    "birthPlaceConfidence": 0,
    "bloodTypeConfidence": 0,
    "eyeColorConfidence": 0,
    "classesConfidence": 0,
    "condConfidence": 0,
    "mentionsConfidence": 0,
    "refNumberConfidence": 0,
    "weightConfidence": 0,
    "hairConfidence": 0,
    "restrictionsConfidence": 0,
    "nationalityConfidence": 0,
    "nationalityMrzConfidence": 0,
    "nationalityAlpha3Confidence": 0,
    "maritalStatusConfidence": 0,
    "raceConfidence": 0,
    "taxIdNumberConfidence": 0,
    "jurisdictionCodeConfidence": 0
  },
  "additionalDocumentAttempts": [
    {
      "status": "SUCCESS",
      "attemptTimestamp": 0,
      "imagesUrl": [
        "string"
      ],
      "attemptType": "POA",
      "antiSpoofResult": {
        "status": "PASS",
        "kinds": [
          "string"
        ],
        "confidence": 0,
        "details": [
          {
            "kind": "string",
            "error": "string",
            "loc": "string",
            "explanation": "string"
          }
        ]
      },
      "documentType": "string"
    }
  ],
  "documentSubmissionMethod": "CAPTURED_DOCUMENT",
  "credentialsProvider": "APPLE"
}
```

---

- Path: `api-reference/get-ocr-data-second-id`
- URL: https://developer.incode.com/api-reference/get-ocr-data-second-id/
- Markdown: https://developer.incode.com/api-reference/get-ocr-data-second-id.md
- Endpoint: `GET /omni/get/ocr-data-second-id`

# Fetch ocr data for second id

`GET /omni/get/ocr-data-second-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns data about user read from the second id.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | NameBean |  |  |
| `name.fullName` | string |  |  |
| `name.fullNameNativeScript` | string |  |  |
| `name.firstNameNativeScript` | string |  |  |
| `name.paternalLastNameNativeScript` | string |  |  |
| `name.maternalLastNameNativeScript` | string |  |  |
| `name.machineReadableFullName` | string |  | Full name from Barcode or MRZ |
| `name.firstName` | string |  |  |
| `name.middleName` | string |  |  |
| `name.givenName` | string |  |  |
| `name.givenNameMrz` | string |  |  |
| `name.initials` | string |  | Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide |
| `name.nameSuffix` | string |  |  |
| `name.paternalLastName` | string |  |  |
| `name.maternalLastName` | string |  |  |
| `name.lastNameMrz` | string |  |  |
| `name.familyName` | string |  |  |
| `address` | string |  | Address as read from id. Address can have two or three lines. Lines are separated by \\n |
| `addressFields` | AddressBean |  |  |
| `addressFields.street` | string |  | Street line in the way it is read from address string. |
| `addressFields.streetName` | string |  | Street name without exterior and interior numbers. |
| `addressFields.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `addressFields.postalCode` | string |  | Postal code in the way it is read from address string. |
| `addressFields.city` | string |  | City in the way it is read from address string. |
| `addressFields.state` | string |  | State in the way it is read from address string. |
| `addressFields.stateName` | string |  | Full StateName. |
| `addressFields.district` | string |  | District in the way it is read from address string. |
| `addressFields.stateCode` | string |  | State code if applicable. |
| `addressFields.addressCountryCode` | string |  | Address country code if applicable. |
| `addressFields.label` | string |  | Full address label. |
| `addressFields.exteriorNumber` | string |  | Exterior street number. |
| `addressFields.interiorNumber` | string |  | Interior street number. |
| `addressFields.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `addressFields.streetType` | string |  | Street type |
| `fullAddress` | boolean |  | This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only). |
| `invalidAddress` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and that both colony and city have values. (Only checked for Mexican IDs) |
| `checkedAddress` | string |  | Address as obtained after processing with geocoder geolocation api. |
| `checkedAddressBean` | AddressBean |  |  |
| `checkedAddressBean.street` | string |  | Street line in the way it is read from address string. |
| `checkedAddressBean.streetName` | string |  | Street name without exterior and interior numbers. |
| `checkedAddressBean.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `checkedAddressBean.postalCode` | string |  | Postal code in the way it is read from address string. |
| `checkedAddressBean.city` | string |  | City in the way it is read from address string. |
| `checkedAddressBean.state` | string |  | State in the way it is read from address string. |
| `checkedAddressBean.stateName` | string |  | Full StateName. |
| `checkedAddressBean.district` | string |  | District in the way it is read from address string. |
| `checkedAddressBean.stateCode` | string |  | State code if applicable. |
| `checkedAddressBean.addressCountryCode` | string |  | Address country code if applicable. |
| `checkedAddressBean.label` | string |  | Full address label. |
| `checkedAddressBean.exteriorNumber` | string |  | Exterior street number. |
| `checkedAddressBean.interiorNumber` | string |  | Interior street number. |
| `checkedAddressBean.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `checkedAddressBean.streetType` | string |  | Street type |
| `exteriorNumber` | string |  | Exterior street number. |
| `interiorNumber` | string |  | Interior street number. |
| `addressFromStatement` | string |  | Address as read from address statement. Lines are separated by \\n. |
| `addressFieldsFromStatement` | AddressBean |  |  |
| `addressFieldsFromStatement.street` | string |  | Street line in the way it is read from address string. |
| `addressFieldsFromStatement.streetName` | string |  | Street name without exterior and interior numbers. |
| `addressFieldsFromStatement.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `addressFieldsFromStatement.postalCode` | string |  | Postal code in the way it is read from address string. |
| `addressFieldsFromStatement.city` | string |  | City in the way it is read from address string. |
| `addressFieldsFromStatement.state` | string |  | State in the way it is read from address string. |
| `addressFieldsFromStatement.stateName` | string |  | Full StateName. |
| `addressFieldsFromStatement.district` | string |  | District in the way it is read from address string. |
| `addressFieldsFromStatement.stateCode` | string |  | State code if applicable. |
| `addressFieldsFromStatement.addressCountryCode` | string |  | Address country code if applicable. |
| `addressFieldsFromStatement.label` | string |  | Full address label. |
| `addressFieldsFromStatement.exteriorNumber` | string |  | Exterior street number. |
| `addressFieldsFromStatement.interiorNumber` | string |  | Interior street number. |
| `addressFieldsFromStatement.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `addressFieldsFromStatement.streetType` | string |  | Street type |
| `invalidAddressFromStatement` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and tha both colony and city have values. (Only checked for Mexican POA) |
| `addressStatementEmissionDate` | integer (int64) |  | Issue date of address statement. The value is presented in UTC milliseconds. |
| `documentType` | string |  | Type of address statement document. Possible values: - Mexico: liverpool, citibanamex, cfe, telcel, izzi, axtel, telmex, oapas, sacmex, opdm, naturgy, drenaje, totalplay, dhc, att, cea, smapa, megacable, jmas, amicsa, caev - Bolivia: cre - Uruguay: ute - Unknown document: otherPoa Enum: `aysa`, `edelap`, `edenor`, `edesur`, `epec`, `metrogas`, `a1`, `aggm`, `apg`, `energieAg`, `cre`, `eaab`, `enel`, `vanti`, `aforeAzteca`, `aforeBanorte`, `amd`, `amicsa`, `att`, `axtel`, `bancoppel`, `bancoAzteca`, `banorte`, `bbva`, `cab`, `caev`, `capa`, `cea`, `cfe`, `citibanamex`, `cmapa`, `cmapaGrande`, `cmapas`, `cmas`, `cmasBlue`, `comapa`, `comapaRed`, `coppel`, `dapa`, `dhc`, `drenaje`, `ecogas`, `engie`, `gasNatural`, `h`, `hsbc`, `inbursa`, `infonavit`, `interapas`, `isagas`, `izzi`, `jad`, `japam`, `japama`, `japami`, `japay`, `jiapaz`, `jmas`, `jras`, `jumapac`, `jumapam`, `lerdo`, `liverpool`, `mas`, `megacable`, `naturgy`, `oapas`, `odapas`, `ooapas`, `opdm`, `oroapa`, `sacmex`, `sacmexCdmx`, `santander`, `sapa`, `sapal`, `sapamuy`, `sapasa`, `sapasma`, `scotiabank`, `seapal`, `siapa`, `siapaTepic`, `simapag`, `simapas`, `simas`, `smapa`, `smapac`, `smapam`, `smapas`, `spectrum`, `stori`, `sura`, `tam`, `telcel`, `telmex`, `totalplay`, `veolia`, `victoria`, `wizz`, `asylumSeeker`, `refugeeId`, `refugeeStatus`, `ute`, `telkom`, `tmobile`, `verizon`, `xfinity`, `aforeCoppel`, `americanExpress`, `ap`, `telnor`, `wellsFargo`, `otherPoa` |
| `addressStatementTimestamps` | array[AddressStatementDate] |  |  |
| `addressStatementTimestamps.get_version` | integer (int64) |  |  |
| `addressStatementTimestamps.dateType` | string |  | Description of timestamp. |
| `addressStatementTimestamps.addressStatementTimestamp` | integer (int64) |  | UTC timestamp. |
| `poaName` | string |  | Extracted name from address statement. |
| `typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `documentFrontSubtype` | string |  | Additional info about ID type (front side) |
| `documentBackSubtype` | string |  | Additional info about ID type (back side) |
| `issueFront` | integer (int32) |  | Issue year (per classification model) of the ID (front side) |
| `issueBack` | integer (int32) |  | Issue year (per classification model) of the ID (back side) |
| `birthDate` | integer (int64) |  | Date of birth is presented in UTC milliseconds. |
| `gender` | string |  | Gender values are presented in English. "M" for male, "F" for female and "X" for non-binary. Enum: `M`, `F`, `X` |
| `claveDeElector` | string |  | Clave de elector as read from id. For Mexican IDs only. |
| `curp` | string |  | Curp as read form id. For Mexican IDs only. |
| `numeroEmisionCredencial` | string |  | Numero Emision Credencial as read from id. (For Mexican IDs only). |
| `cic` | string |  | Cic as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `ocr` | string |  | Ocr as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `documentNumber` | string |  | Document number. |
| `documentNumberSource` | string |  | Document number source. Enum: `FORM`, `OCR` |
| `personalNumber` | string |  | Personal number. |
| `nationalNumber` | string |  | National number. |
| `refNumber` | string |  | Document Reference Number. |
| `familyNumber` | string |  | Family or household registry number printed on the document. |
| `taxIdNumber` | string |  | Personal tax identification number. |
| `nue` | string |  | NUE number as read from id. (for Resident Cards) |
| `externalId` | string |  | External user id. |
| `issuedAt` | string |  | Date of issue UTC timestamp. |
| `expireAt` | string |  | Expiration date UTC timestamp. |
| `expirationDate` | integer (int32) |  | Expiration year of id. |
| `issueDate` | integer (int32) |  | Issue year of id. |
| `registrationDate` | integer (int32) |  | Registration date read from id. |
| `dlClassDetails` | array[DLClassDetails] |  |  |
| `dlClassDetails.dlClass` | string |  | Driver's license class. |
| `dlClassDetails.validFromDate` | integer (int64) |  | DL class valid from UTC timestamp |
| `dlClassDetails.validToDate` | integer (int64) |  | DL class valid to UTC timestamp. |
| `dlClassDetails.additionalCodes` | string |  | Additional codes associated with DL class. |
| `dlClassDetails.restrictions` | array[string] |  | Restriction codes associated with DL class. |
| `issuingCountry` | string |  | Issuing country of document. |
| `issuingState` | string |  | Issuing state of document. |
| `birthPlace` | string |  | Birth place as read from id. |
| `printingNumber` | string |  | Printing number (número de impresión) printed below the barcode on Colombian IDs. |
| `duplicateNumber` | string |  | Number of duplicates (número de duplicados) printed below the barcode on Colombian IDs. |
| `preparationNumber` | string |  | Preparation number (número de preparación) printed below the barcode on Colombian IDs. |
| `issuingAuthority` | string |  | Issuing Authority as read from id. |
| `height` | string |  | Person's height as read from id. |
| `weight` | string |  | Person's weight. |
| `eyeColor` | string |  | Person's eye color. |
| `hairColor` | string |  | Person's hair color. |
| `religion` | string |  | Person's religion. |
| `bloodType` | string |  | Person's blood type. |
| `maritalStatus` | string |  | Person's marital status. |
| `nationality` | string |  | Person's nationality. |
| `race` | string |  | Person's race. |
| `nationalityMrz` | string |  | Person's nationality as it appears in MRZ (if present). |
| `nationalityAlpha3` | string |  | Person's nationality Alpha3 code format. Only for Brazilian IDs. |
| `governmentComparisonResults` | GovernmentComparisonResults |  | Government validation data. Only for supported government validation countries. |
| `governmentComparisonResults.paternalLastNameValid` | boolean |  | Indicates validity of person's paternal last name through government validation apis. |
| `governmentComparisonResults.maternalLastNameValid` | boolean |  | Indicates validity of person's maternal last name through government validation apis. |
| `governmentComparisonResults.firstNameValid` | boolean |  | Indicates validity of person's first name through government validation apis. |
| `governmentComparisonResults.curpValid` | boolean |  | Indicates CURP validity through RENAPO/CURP provider validation. |
| `governmentComparisonResults.ineCurpValid` | boolean |  | Indicates CURP validity through INE government validation (separate from RENAPO). |
| `governmentComparisonResults.ocrValid` | boolean |  | Indicates ocr validity through government validation apis. |
| `governmentComparisonResults.claveDeElectorValid` | boolean |  | Indicates "clave de elector" validity through government validation apis. |
| `governmentComparisonResults.numeroEmisionCredencialValid` | boolean |  | Indicates "numero emision credencial" validity through government validation apis. |
| `governmentComparisonResults.registrationDateValid` | boolean |  | Indicates registration date validity through government validation apis. |
| `governmentComparisonResults.issueDateValid` | boolean |  | Indicates issue date validity through government validation apis. |
| `notExtracted` | integer (int32) |  | Number of not extracted OCR fields. Only for Mexican IDs. |
| `notExtractedDetails` | array[string] |  |  |
| `classes` | string |  | Person's driver licence classes. |
| `cond` | string |  | Person's driver licence conditions. |
| `mentions` | string |  | Person's driver licence mentions. |
| `restrictions` | string |  | Person's driver licence restrictions. |
| `mrz1` | string |  | First MRZ line. |
| `mrz2` | string |  | Second MRZ line. |
| `mrz3` | string |  | Third MRZ line. |
| `fullNameMrz` | string |  | Person's full name read from MRZ. |
| `documentNumberCheckDigit` | string |  | Document number check digit read from MRZ. |
| `dateOfBirthCheckDigit` | string |  | Date of birth check digit read from MRZ. |
| `expirationDateCheckDigit` | string |  | Expiration date check digit read from MRZ. |
| `barcodeRawData` | string |  | Full unformatted data read from 2D barcode. |
| `qrFrontContents` | array[string] |  | Raw QR code payloads read from the front of the document, unparsed. Omitted when the capture was redacted. |
| `qrBackContents` | array[string] |  | Raw QR code payloads read from the back of the document, unparsed. Omitted when the capture was redacted. |
| `fathersName` | string |  | Person's father's name. Only for Brazilian and Indian IDs. |
| `mothersName` | string |  | Person's mother's name. Only for Brazilian IDs. |
| `fathersIdNumber` | string |  | Person's father's Id Number. In the context of minors identity validation. |
| `mothersIdNumber` | string |  | Person's mother's Id Number. In the context of minors identity validation. |
| `spouseName` | string |  | Person's spouse's name. |
| `federalRevenueNumber` | string |  | Federal revenue number. Only for Brazilian IDs. |
| `originDocumentId` | string |  | Origin document ID. Only for Brazilian IDs. |
| `driversLicenseCategory` | string |  | Driver's licence category. Only for Brazilian IDs. |
| `controlNumber` | string |  | Control number. Only for Brazilian IDs. |
| `renach` | string |  | Renach. Only for Brazilian IDs. |
| `additionalAttrs` | array[string] |  | Additional document attributes. Enum: `DOCUMENTO_INFANTIL`, `IDADE_PRE_ESCOLAR`, `MENOR_DE_ANOS`, `NAO_ASSINA`, `EM_FASE_DE_ALFABETIZACAO`, `IMPOSSIBILITADO_DE_ASSINAR`, `LIMITED_TERM`, `FEDERAL_LIMITS_APPLY`, `PERMISO_PARA_TRABAJAR`, `EXTRANJERO`, `INDIA_DIGITAL_VID`, `VETERAN`, `MOTORCYCLE_LICENSE`, `NON_DOMICILED`, `COMMERCIAL_LICENSE`, `RESIDENTE`, `MIGRANTE`, `TEMPORAL`, `VISITANTE`, `TRAMITE`, `RUEX`, `INDIGENA`, `AFROMEXICANA`, `INDIA_DIGITAL_TAXID` |
| `ocrDataConfidence` | OcrDataConfidence |  | Structure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1. |
| `ocrDataConfidence.birthDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.firstNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.paternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.maternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrDataConfidence.givenNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.firstNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.middleNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nameSuffixConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersSurnameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersSurnameConfidence` | number (float) |  |  |
| `ocrDataConfidence.nickNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fullNameMrzConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.mothersIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.fathersIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.spouseNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.birthNameConfidence` | number (float) |  |  |
| `ocrDataConfidence.addressConfidence` | number (float) |  |  |
| `ocrDataConfidence.streetConfidence` | number (float) |  |  |
| `ocrDataConfidence.colonyConfidence` | number (float) |  |  |
| `ocrDataConfidence.postalCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.cityConfidence` | number (float) |  |  |
| `ocrDataConfidence.stateConfidence` | number (float) |  |  |
| `ocrDataConfidence.districtConfidence` | number (float) |  |  |
| `ocrDataConfidence.stateCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.countryCodeConfidence` | number (float) |  |  |
| `ocrDataConfidence.genderConfidence` | number (float) |  |  |
| `ocrDataConfidence.issueDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.expirationDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.issuedAtConfidence` | number (float) |  |  |
| `ocrDataConfidence.expireAtConfidence` | number (float) |  |  |
| `ocrDataConfidence.issuingAuthorityConfidence` | number (float) |  |  |
| `ocrDataConfidence.mrz1Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrz2Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrz3Confidence` | number (float) |  |  |
| `ocrDataConfidence.mrzFullConfidence` | number (float) |  |  |
| `ocrDataConfidence.documentNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.backNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.personalNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.claveDeElectorConfidence` | number (float) |  |  |
| `ocrDataConfidence.numeroEmisionCredencialConfidence` | number (float) |  |  |
| `ocrDataConfidence.curpConfidence` | number (float) |  |  |
| `ocrDataConfidence.nueConfidence` | number (float) |  |  |
| `ocrDataConfidence.registrationDateConfidence` | number (float) |  |  |
| `ocrDataConfidence.heightConfidence` | number (float) |  |  |
| `ocrDataConfidence.birthPlaceConfidence` | number (float) |  |  |
| `ocrDataConfidence.bloodTypeConfidence` | number (float) |  |  |
| `ocrDataConfidence.eyeColorConfidence` | number (float) |  |  |
| `ocrDataConfidence.classesConfidence` | number (float) |  |  |
| `ocrDataConfidence.condConfidence` | number (float) |  |  |
| `ocrDataConfidence.mentionsConfidence` | number (float) |  |  |
| `ocrDataConfidence.refNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.weightConfidence` | number (float) |  |  |
| `ocrDataConfidence.hairConfidence` | number (float) |  |  |
| `ocrDataConfidence.restrictionsConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityMrzConfidence` | number (float) |  |  |
| `ocrDataConfidence.nationalityAlpha3Confidence` | number (float) |  |  |
| `ocrDataConfidence.maritalStatusConfidence` | number (float) |  |  |
| `ocrDataConfidence.raceConfidence` | number (float) |  |  |
| `ocrDataConfidence.taxIdNumberConfidence` | number (float) |  |  |
| `ocrDataConfidence.jurisdictionCodeConfidence` | number (float) |  |  |
| `additionalDocumentAttempts` | array[AdditionalDocumentAttemptDto] |  |  |
| `additionalDocumentAttempts.status` | string |  | Enum: `SUCCESS`, `VALIDATION_ERROR`, `FAIL` |
| `additionalDocumentAttempts.attemptTimestamp` | integer (int64) |  |  |
| `additionalDocumentAttempts.imagesUrl` | array[string] |  |  |
| `additionalDocumentAttempts.attemptType` | string |  | Enum: `POA`, `DOCUMENT_CAPTURE` |
| `additionalDocumentAttempts.antiSpoofResult` | PoaAntiSpoofResult |  |  |
| `additionalDocumentAttempts.antiSpoofResult.status` | string |  | Enum: `PASS`, `FAIL`, `NOT_EXECUTED` |
| `additionalDocumentAttempts.antiSpoofResult.kinds` | array[string] |  |  |
| `additionalDocumentAttempts.antiSpoofResult.confidence` | number (float) |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details` | array[Detail] |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.kind` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.error` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.loc` | string |  |  |
| `additionalDocumentAttempts.antiSpoofResult.details.explanation` | string |  |  |
| `additionalDocumentAttempts.documentType` | string | yes |  |
| `documentSubmissionMethod` | string |  | Method used to submit the document. Enum: `CAPTURED_DOCUMENT`, `UPLOADED_FILE`, `IMPORTED_CREDENTIAL` |
| `credentialsProvider` | string |  | Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL. Enum: `APPLE`, `GOOGLE`, `DIGILOCKER`, `SAMSUNG`, `DIGITAL_ID`, `NETHERLANDS_IDIN`, `FINNISH_TRUST_NETWORK` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/ocr-data-second-id?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "name": {
    "fullName": "string",
    "fullNameNativeScript": "string",
    "firstNameNativeScript": "string",
    "paternalLastNameNativeScript": "string",
    "maternalLastNameNativeScript": "string",
    "machineReadableFullName": "string",
    "firstName": "string",
    "middleName": "string",
    "givenName": "string",
    "givenNameMrz": "string",
    "initials": "string",
    "nameSuffix": "string",
    "paternalLastName": "string",
    "maternalLastName": "string",
    "lastNameMrz": "string",
    "familyName": "string"
  },
  "address": "string",
  "addressFields": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "fullAddress": true,
  "invalidAddress": true,
  "checkedAddress": "string",
  "checkedAddressBean": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "exteriorNumber": "string",
  "interiorNumber": "string",
  "addressFromStatement": "string",
  "addressFieldsFromStatement": {
    "street": "string",
    "streetName": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateName": "string",
    "district": "string",
    "stateCode": "string",
    "addressCountryCode": "string",
    "label": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressLine1": "string",
    "streetType": "string"
  },
  "invalidAddressFromStatement": true,
  "addressStatementEmissionDate": 0,
  "documentType": "aysa",
  "addressStatementTimestamps": [
    {
      "get_version": 0,
      "dateType": "string",
      "addressStatementTimestamp": 0
    }
  ],
  "poaName": "string",
  "typeOfId": "Unknown",
  "documentFrontSubtype": "string",
  "documentBackSubtype": "string",
  "issueFront": 0,
  "issueBack": 0,
  "birthDate": 0,
  "gender": "M",
  "claveDeElector": "string",
  "curp": "string",
  "numeroEmisionCredencial": "string",
  "cic": "string",
  "ocr": "string",
  "documentNumber": "string",
  "documentNumberSource": "FORM",
  "personalNumber": "string",
  "nationalNumber": "string",
  "refNumber": "string",
  "familyNumber": "string",
  "taxIdNumber": "string",
  "nue": "string",
  "externalId": "string",
  "issuedAt": "string",
  "expireAt": "string",
  "expirationDate": 0,
  "issueDate": 0,
  "registrationDate": 0,
  "dlClassDetails": [
    {
      "dlClass": "string",
      "validFromDate": 0,
      "validToDate": 0,
      "additionalCodes": "string",
      "restrictions": [
        "string"
      ]
    }
  ],
  "issuingCountry": "string",
  "issuingState": "string",
  "birthPlace": "string",
  "printingNumber": "string",
  "duplicateNumber": "string",
  "preparationNumber": "string",
  "issuingAuthority": "string",
  "height": "string",
  "weight": "string",
  "eyeColor": "string",
  "hairColor": "string",
  "religion": "string",
  "bloodType": "string",
  "maritalStatus": "string",
  "nationality": "string",
  "race": "string",
  "nationalityMrz": "string",
  "nationalityAlpha3": "string",
  "governmentComparisonResults": {
    "paternalLastNameValid": true,
    "maternalLastNameValid": true,
    "firstNameValid": true,
    "curpValid": true,
    "ineCurpValid": true,
    "ocrValid": true,
    "claveDeElectorValid": true,
    "numeroEmisionCredencialValid": true,
    "registrationDateValid": true,
    "issueDateValid": true
  },
  "notExtracted": 0,
  "notExtractedDetails": [
    "string"
  ],
  "classes": "string",
  "cond": "string",
  "mentions": "string",
  "restrictions": "string",
  "mrz1": "string",
  "mrz2": "string",
  "mrz3": "string",
  "fullNameMrz": "string",
  "documentNumberCheckDigit": "string",
  "dateOfBirthCheckDigit": "string",
  "expirationDateCheckDigit": "string",
  "barcodeRawData": "string",
  "qrFrontContents": [
    "string"
  ],
  "qrBackContents": [
    "string"
  ],
  "fathersName": "string",
  "mothersName": "string",
  "fathersIdNumber": "string",
  "mothersIdNumber": "string",
  "spouseName": "string",
  "federalRevenueNumber": "string",
  "originDocumentId": "string",
  "driversLicenseCategory": "string",
  "controlNumber": "string",
  "renach": "string",
  "additionalAttrs": [
    "DOCUMENTO_INFANTIL"
  ],
  "ocrDataConfidence": {
    "birthDateConfidence": 0,
    "nameConfidence": 0,
    "nameNativeScriptConfidence": 0,
    "firstNameNativeScriptConfidence": 0,
    "paternalLastNameNativeScriptConfidence": 0,
    "maternalLastNameNativeScriptConfidence": 0,
    "givenNameConfidence": 0,
    "firstNameConfidence": 0,
    "middleNameConfidence": 0,
    "nameSuffixConfidence": 0,
    "mothersSurnameConfidence": 0,
    "fathersSurnameConfidence": 0,
    "nickNameConfidence": 0,
    "fullNameMrzConfidence": 0,
    "mothersNameConfidence": 0,
    "fathersNameConfidence": 0,
    "mothersIdNumberConfidence": 0,
    "fathersIdNumberConfidence": 0,
    "spouseNameConfidence": 0,
    "birthNameConfidence": 0,
    "addressConfidence": 0,
    "streetConfidence": 0,
    "colonyConfidence": 0,
    "postalCodeConfidence": 0,
    "cityConfidence": 0,
    "stateConfidence": 0,
    "districtConfidence": 0,
    "stateCodeConfidence": 0,
    "countryCodeConfidence": 0,
    "genderConfidence": 0,
    "issueDateConfidence": 0,
    "expirationDateConfidence": 0,
    "issuedAtConfidence": 0,
    "expireAtConfidence": 0,
    "issuingAuthorityConfidence": 0,
    "mrz1Confidence": 0,
    "mrz2Confidence": 0,
    "mrz3Confidence": 0,
    "mrzFullConfidence": 0,
    "documentNumberConfidence": 0,
    "backNumberConfidence": 0,
    "personalNumberConfidence": 0,
    "nationalNumberConfidence": 0,
    "claveDeElectorConfidence": 0,
    "numeroEmisionCredencialConfidence": 0,
    "curpConfidence": 0,
    "nueConfidence": 0,
    "registrationDateConfidence": 0,
    "heightConfidence": 0,
    "birthPlaceConfidence": 0,
    "bloodTypeConfidence": 0,
    "eyeColorConfidence": 0,
    "classesConfidence": 0,
    "condConfidence": 0,
    "mentionsConfidence": 0,
    "refNumberConfidence": 0,
    "weightConfidence": 0,
    "hairConfidence": 0,
    "restrictionsConfidence": 0,
    "nationalityConfidence": 0,
    "nationalityMrzConfidence": 0,
    "nationalityAlpha3Confidence": 0,
    "maritalStatusConfidence": 0,
    "raceConfidence": 0,
    "taxIdNumberConfidence": 0,
    "jurisdictionCodeConfidence": 0
  },
  "additionalDocumentAttempts": [
    {
      "status": "SUCCESS",
      "attemptTimestamp": 0,
      "imagesUrl": [
        "string"
      ],
      "attemptType": "POA",
      "antiSpoofResult": {
        "status": "PASS",
        "kinds": [
          "string"
        ],
        "confidence": 0,
        "details": [
          {
            "kind": "string",
            "error": "string",
            "loc": "string",
            "explanation": "string"
          }
        ]
      },
      "documentType": "string"
    }
  ],
  "documentSubmissionMethod": "CAPTURED_DOCUMENT",
  "credentialsProvider": "APPLE"
}
```

---

- Path: `api-reference/get-ocr-data-v2`
- URL: https://developer.incode.com/api-reference/get-ocr-data-v2/
- Markdown: https://developer.incode.com/api-reference/get-ocr-data-v2.md
- Endpoint: `GET /omni/get/ocr-data/v2`

# Fetch ocr data v2

`GET /omni/get/ocr-data/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns data about user read from id and address statement wrapped in ocrData object.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ocrData` | OcrDataResponse |  |  |
| `ocrData.name` | NameBean |  |  |
| `ocrData.name.fullName` | string |  |  |
| `ocrData.name.fullNameNativeScript` | string |  |  |
| `ocrData.name.firstNameNativeScript` | string |  |  |
| `ocrData.name.paternalLastNameNativeScript` | string |  |  |
| `ocrData.name.maternalLastNameNativeScript` | string |  |  |
| `ocrData.name.machineReadableFullName` | string |  | Full name from Barcode or MRZ |
| `ocrData.name.firstName` | string |  |  |
| `ocrData.name.middleName` | string |  |  |
| `ocrData.name.givenName` | string |  |  |
| `ocrData.name.givenNameMrz` | string |  |  |
| `ocrData.name.initials` | string |  | Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide |
| `ocrData.name.nameSuffix` | string |  |  |
| `ocrData.name.paternalLastName` | string |  |  |
| `ocrData.name.maternalLastName` | string |  |  |
| `ocrData.name.lastNameMrz` | string |  |  |
| `ocrData.name.familyName` | string |  |  |
| `ocrData.address` | string |  | Address as read from id. Address can have two or three lines. Lines are separated by \\n |
| `ocrData.addressFields` | AddressBean |  |  |
| `ocrData.addressFields.street` | string |  | Street line in the way it is read from address string. |
| `ocrData.addressFields.streetName` | string |  | Street name without exterior and interior numbers. |
| `ocrData.addressFields.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `ocrData.addressFields.postalCode` | string |  | Postal code in the way it is read from address string. |
| `ocrData.addressFields.city` | string |  | City in the way it is read from address string. |
| `ocrData.addressFields.state` | string |  | State in the way it is read from address string. |
| `ocrData.addressFields.stateName` | string |  | Full StateName. |
| `ocrData.addressFields.district` | string |  | District in the way it is read from address string. |
| `ocrData.addressFields.stateCode` | string |  | State code if applicable. |
| `ocrData.addressFields.addressCountryCode` | string |  | Address country code if applicable. |
| `ocrData.addressFields.label` | string |  | Full address label. |
| `ocrData.addressFields.exteriorNumber` | string |  | Exterior street number. |
| `ocrData.addressFields.interiorNumber` | string |  | Interior street number. |
| `ocrData.addressFields.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `ocrData.addressFields.streetType` | string |  | Street type |
| `ocrData.fullAddress` | boolean |  | This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only). |
| `ocrData.invalidAddress` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and that both colony and city have values. (Only checked for Mexican IDs) |
| `ocrData.checkedAddress` | string |  | Address as obtained after processing with geocoder geolocation api. |
| `ocrData.checkedAddressBean` | AddressBean |  |  |
| `ocrData.checkedAddressBean.street` | string |  | Street line in the way it is read from address string. |
| `ocrData.checkedAddressBean.streetName` | string |  | Street name without exterior and interior numbers. |
| `ocrData.checkedAddressBean.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `ocrData.checkedAddressBean.postalCode` | string |  | Postal code in the way it is read from address string. |
| `ocrData.checkedAddressBean.city` | string |  | City in the way it is read from address string. |
| `ocrData.checkedAddressBean.state` | string |  | State in the way it is read from address string. |
| `ocrData.checkedAddressBean.stateName` | string |  | Full StateName. |
| `ocrData.checkedAddressBean.district` | string |  | District in the way it is read from address string. |
| `ocrData.checkedAddressBean.stateCode` | string |  | State code if applicable. |
| `ocrData.checkedAddressBean.addressCountryCode` | string |  | Address country code if applicable. |
| `ocrData.checkedAddressBean.label` | string |  | Full address label. |
| `ocrData.checkedAddressBean.exteriorNumber` | string |  | Exterior street number. |
| `ocrData.checkedAddressBean.interiorNumber` | string |  | Interior street number. |
| `ocrData.checkedAddressBean.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `ocrData.checkedAddressBean.streetType` | string |  | Street type |
| `ocrData.exteriorNumber` | string |  | Exterior street number. |
| `ocrData.interiorNumber` | string |  | Interior street number. |
| `ocrData.addressFromStatement` | string |  | Address as read from address statement. Lines are separated by \\n. |
| `ocrData.addressFieldsFromStatement` | AddressBean |  |  |
| `ocrData.addressFieldsFromStatement.street` | string |  | Street line in the way it is read from address string. |
| `ocrData.addressFieldsFromStatement.streetName` | string |  | Street name without exterior and interior numbers. |
| `ocrData.addressFieldsFromStatement.colony` | string |  | Colony line the way it is read from address string. (Not applicable for all countries) |
| `ocrData.addressFieldsFromStatement.postalCode` | string |  | Postal code in the way it is read from address string. |
| `ocrData.addressFieldsFromStatement.city` | string |  | City in the way it is read from address string. |
| `ocrData.addressFieldsFromStatement.state` | string |  | State in the way it is read from address string. |
| `ocrData.addressFieldsFromStatement.stateName` | string |  | Full StateName. |
| `ocrData.addressFieldsFromStatement.district` | string |  | District in the way it is read from address string. |
| `ocrData.addressFieldsFromStatement.stateCode` | string |  | State code if applicable. |
| `ocrData.addressFieldsFromStatement.addressCountryCode` | string |  | Address country code if applicable. |
| `ocrData.addressFieldsFromStatement.label` | string |  | Full address label. |
| `ocrData.addressFieldsFromStatement.exteriorNumber` | string |  | Exterior street number. |
| `ocrData.addressFieldsFromStatement.interiorNumber` | string |  | Interior street number. |
| `ocrData.addressFieldsFromStatement.addressLine1` | string |  | The primary line in the address that contains the most essential details for locating a place. |
| `ocrData.addressFieldsFromStatement.streetType` | string |  | Street type |
| `ocrData.invalidAddressFromStatement` | boolean |  | This field checks for a valid street, numeric postal code with 5 digits, and tha both colony and city have values. (Only checked for Mexican POA) |
| `ocrData.addressStatementEmissionDate` | integer (int64) |  | Issue date of address statement. The value is presented in UTC milliseconds. |
| `ocrData.documentType` | string |  | Type of address statement document. Possible values: - Mexico: liverpool, citibanamex, cfe, telcel, izzi, axtel, telmex, oapas, sacmex, opdm, naturgy, drenaje, totalplay, dhc, att, cea, smapa, megacable, jmas, amicsa, caev - Bolivia: cre - Uruguay: ute - Unknown document: otherPoa Enum: `aysa`, `edelap`, `edenor`, `edesur`, `epec`, `metrogas`, `a1`, `aggm`, `apg`, `energieAg`, `cre`, `eaab`, `enel`, `vanti`, `aforeAzteca`, `aforeBanorte`, `amd`, `amicsa`, `att`, `axtel`, `bancoppel`, `bancoAzteca`, `banorte`, `bbva`, `cab`, `caev`, `capa`, `cea`, `cfe`, `citibanamex`, `cmapa`, `cmapaGrande`, `cmapas`, `cmas`, `cmasBlue`, `comapa`, `comapaRed`, `coppel`, `dapa`, `dhc`, `drenaje`, `ecogas`, `engie`, `gasNatural`, `h`, `hsbc`, `inbursa`, `infonavit`, `interapas`, `isagas`, `izzi`, `jad`, `japam`, `japama`, `japami`, `japay`, `jiapaz`, `jmas`, `jras`, `jumapac`, `jumapam`, `lerdo`, `liverpool`, `mas`, `megacable`, `naturgy`, `oapas`, `odapas`, `ooapas`, `opdm`, `oroapa`, `sacmex`, `sacmexCdmx`, `santander`, `sapa`, `sapal`, `sapamuy`, `sapasa`, `sapasma`, `scotiabank`, `seapal`, `siapa`, `siapaTepic`, `simapag`, `simapas`, `simas`, `smapa`, `smapac`, `smapam`, `smapas`, `spectrum`, `stori`, `sura`, `tam`, `telcel`, `telmex`, `totalplay`, `veolia`, `victoria`, `wizz`, `asylumSeeker`, `refugeeId`, `refugeeStatus`, `ute`, `telkom`, `tmobile`, `verizon`, `xfinity`, `aforeCoppel`, `americanExpress`, `ap`, `telnor`, `wellsFargo`, `otherPoa` |
| `ocrData.addressStatementTimestamps` | array[AddressStatementDate] |  |  |
| `ocrData.addressStatementTimestamps.get_version` | integer (int64) |  |  |
| `ocrData.addressStatementTimestamps.dateType` | string |  | Description of timestamp. |
| `ocrData.addressStatementTimestamps.addressStatementTimestamp` | integer (int64) |  | UTC timestamp. |
| `ocrData.poaName` | string |  | Extracted name from address statement. |
| `ocrData.typeOfId` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `ocrData.documentFrontSubtype` | string |  | Additional info about ID type (front side) |
| `ocrData.documentBackSubtype` | string |  | Additional info about ID type (back side) |
| `ocrData.issueFront` | integer (int32) |  | Issue year (per classification model) of the ID (front side) |
| `ocrData.issueBack` | integer (int32) |  | Issue year (per classification model) of the ID (back side) |
| `ocrData.birthDate` | integer (int64) |  | Date of birth is presented in UTC milliseconds. |
| `ocrData.gender` | string |  | Gender values are presented in English. "M" for male, "F" for female and "X" for non-binary. Enum: `M`, `F`, `X` |
| `ocrData.claveDeElector` | string |  | Clave de elector as read from id. For Mexican IDs only. |
| `ocrData.curp` | string |  | Curp as read form id. For Mexican IDs only. |
| `ocrData.numeroEmisionCredencial` | string |  | Numero Emision Credencial as read from id. (For Mexican IDs only). |
| `ocrData.cic` | string |  | Cic as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `ocrData.ocr` | string |  | Ocr as read from id. (This field is read from back side of id; For Mexican IDs only). |
| `ocrData.documentNumber` | string |  | Document number. |
| `ocrData.documentNumberSource` | string |  | Document number source. Enum: `FORM`, `OCR` |
| `ocrData.personalNumber` | string |  | Personal number. |
| `ocrData.nationalNumber` | string |  | National number. |
| `ocrData.refNumber` | string |  | Document Reference Number. |
| `ocrData.familyNumber` | string |  | Family or household registry number printed on the document. |
| `ocrData.taxIdNumber` | string |  | Personal tax identification number. |
| `ocrData.nue` | string |  | NUE number as read from id. (for Resident Cards) |
| `ocrData.externalId` | string |  | External user id. |
| `ocrData.issuedAt` | string |  | Date of issue UTC timestamp. |
| `ocrData.expireAt` | string |  | Expiration date UTC timestamp. |
| `ocrData.expirationDate` | integer (int32) |  | Expiration year of id. |
| `ocrData.issueDate` | integer (int32) |  | Issue year of id. |
| `ocrData.registrationDate` | integer (int32) |  | Registration date read from id. |
| `ocrData.dlClassDetails` | array[DLClassDetails] |  |  |
| `ocrData.dlClassDetails.dlClass` | string |  | Driver's license class. |
| `ocrData.dlClassDetails.validFromDate` | integer (int64) |  | DL class valid from UTC timestamp |
| `ocrData.dlClassDetails.validToDate` | integer (int64) |  | DL class valid to UTC timestamp. |
| `ocrData.dlClassDetails.additionalCodes` | string |  | Additional codes associated with DL class. |
| `ocrData.dlClassDetails.restrictions` | array[string] |  | Restriction codes associated with DL class. |
| `ocrData.issuingCountry` | string |  | Issuing country of document. |
| `ocrData.issuingState` | string |  | Issuing state of document. |
| `ocrData.birthPlace` | string |  | Birth place as read from id. |
| `ocrData.printingNumber` | string |  | Printing number (número de impresión) printed below the barcode on Colombian IDs. |
| `ocrData.duplicateNumber` | string |  | Number of duplicates (número de duplicados) printed below the barcode on Colombian IDs. |
| `ocrData.preparationNumber` | string |  | Preparation number (número de preparación) printed below the barcode on Colombian IDs. |
| `ocrData.issuingAuthority` | string |  | Issuing Authority as read from id. |
| `ocrData.height` | string |  | Person's height as read from id. |
| `ocrData.weight` | string |  | Person's weight. |
| `ocrData.eyeColor` | string |  | Person's eye color. |
| `ocrData.hairColor` | string |  | Person's hair color. |
| `ocrData.religion` | string |  | Person's religion. |
| `ocrData.bloodType` | string |  | Person's blood type. |
| `ocrData.maritalStatus` | string |  | Person's marital status. |
| `ocrData.nationality` | string |  | Person's nationality. |
| `ocrData.race` | string |  | Person's race. |
| `ocrData.nationalityMrz` | string |  | Person's nationality as it appears in MRZ (if present). |
| `ocrData.nationalityAlpha3` | string |  | Person's nationality Alpha3 code format. Only for Brazilian IDs. |
| `ocrData.governmentComparisonResults` | GovernmentComparisonResults |  | Government validation data. Only for supported government validation countries. |
| `ocrData.governmentComparisonResults.paternalLastNameValid` | boolean |  | Indicates validity of person's paternal last name through government validation apis. |
| `ocrData.governmentComparisonResults.maternalLastNameValid` | boolean |  | Indicates validity of person's maternal last name through government validation apis. |
| `ocrData.governmentComparisonResults.firstNameValid` | boolean |  | Indicates validity of person's first name through government validation apis. |
| `ocrData.governmentComparisonResults.curpValid` | boolean |  | Indicates CURP validity through RENAPO/CURP provider validation. |
| `ocrData.governmentComparisonResults.ineCurpValid` | boolean |  | Indicates CURP validity through INE government validation (separate from RENAPO). |
| `ocrData.governmentComparisonResults.ocrValid` | boolean |  | Indicates ocr validity through government validation apis. |
| `ocrData.governmentComparisonResults.claveDeElectorValid` | boolean |  | Indicates "clave de elector" validity through government validation apis. |
| `ocrData.governmentComparisonResults.numeroEmisionCredencialValid` | boolean |  | Indicates "numero emision credencial" validity through government validation apis. |
| `ocrData.governmentComparisonResults.registrationDateValid` | boolean |  | Indicates registration date validity through government validation apis. |
| `ocrData.governmentComparisonResults.issueDateValid` | boolean |  | Indicates issue date validity through government validation apis. |
| `ocrData.notExtracted` | integer (int32) |  | Number of not extracted OCR fields. Only for Mexican IDs. |
| `ocrData.notExtractedDetails` | array[string] |  |  |
| `ocrData.classes` | string |  | Person's driver licence classes. |
| `ocrData.cond` | string |  | Person's driver licence conditions. |
| `ocrData.mentions` | string |  | Person's driver licence mentions. |
| `ocrData.restrictions` | string |  | Person's driver licence restrictions. |
| `ocrData.mrz1` | string |  | First MRZ line. |
| `ocrData.mrz2` | string |  | Second MRZ line. |
| `ocrData.mrz3` | string |  | Third MRZ line. |
| `ocrData.fullNameMrz` | string |  | Person's full name read from MRZ. |
| `ocrData.documentNumberCheckDigit` | string |  | Document number check digit read from MRZ. |
| `ocrData.dateOfBirthCheckDigit` | string |  | Date of birth check digit read from MRZ. |
| `ocrData.expirationDateCheckDigit` | string |  | Expiration date check digit read from MRZ. |
| `ocrData.barcodeRawData` | string |  | Full unformatted data read from 2D barcode. |
| `ocrData.qrFrontContents` | array[string] |  | Raw QR code payloads read from the front of the document, unparsed. Omitted when the capture was redacted. |
| `ocrData.qrBackContents` | array[string] |  | Raw QR code payloads read from the back of the document, unparsed. Omitted when the capture was redacted. |
| `ocrData.fathersName` | string |  | Person's father's name. Only for Brazilian and Indian IDs. |
| `ocrData.mothersName` | string |  | Person's mother's name. Only for Brazilian IDs. |
| `ocrData.fathersIdNumber` | string |  | Person's father's Id Number. In the context of minors identity validation. |
| `ocrData.mothersIdNumber` | string |  | Person's mother's Id Number. In the context of minors identity validation. |
| `ocrData.spouseName` | string |  | Person's spouse's name. |
| `ocrData.federalRevenueNumber` | string |  | Federal revenue number. Only for Brazilian IDs. |
| `ocrData.originDocumentId` | string |  | Origin document ID. Only for Brazilian IDs. |
| `ocrData.driversLicenseCategory` | string |  | Driver's licence category. Only for Brazilian IDs. |
| `ocrData.controlNumber` | string |  | Control number. Only for Brazilian IDs. |
| `ocrData.renach` | string |  | Renach. Only for Brazilian IDs. |
| `ocrData.additionalAttrs` | array[string] |  | Additional document attributes. Enum: `DOCUMENTO_INFANTIL`, `IDADE_PRE_ESCOLAR`, `MENOR_DE_ANOS`, `NAO_ASSINA`, `EM_FASE_DE_ALFABETIZACAO`, `IMPOSSIBILITADO_DE_ASSINAR`, `LIMITED_TERM`, `FEDERAL_LIMITS_APPLY`, `PERMISO_PARA_TRABAJAR`, `EXTRANJERO`, `INDIA_DIGITAL_VID`, `VETERAN`, `MOTORCYCLE_LICENSE`, `NON_DOMICILED`, `COMMERCIAL_LICENSE`, `RESIDENTE`, `MIGRANTE`, `TEMPORAL`, `VISITANTE`, `TRAMITE`, `RUEX`, `INDIGENA`, `AFROMEXICANA`, `INDIA_DIGITAL_TAXID` |
| `ocrData.ocrDataConfidence` | OcrDataConfidence |  | Structure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1. |
| `ocrData.ocrDataConfidence.birthDateConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nameNativeScriptConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.firstNameNativeScriptConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.paternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.maternalLastNameNativeScriptConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.givenNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.firstNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.middleNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nameSuffixConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mothersSurnameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.fathersSurnameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nickNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.fullNameMrzConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mothersNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.fathersNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mothersIdNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.fathersIdNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.spouseNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.birthNameConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.addressConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.streetConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.colonyConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.postalCodeConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.cityConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.stateConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.districtConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.stateCodeConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.countryCodeConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.genderConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.issueDateConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.expirationDateConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.issuedAtConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.expireAtConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.issuingAuthorityConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mrz1Confidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mrz2Confidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mrz3Confidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mrzFullConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.documentNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.backNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.personalNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nationalNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.claveDeElectorConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.numeroEmisionCredencialConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.curpConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nueConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.registrationDateConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.heightConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.birthPlaceConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.bloodTypeConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.eyeColorConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.classesConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.condConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.mentionsConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.refNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.weightConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.hairConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.restrictionsConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nationalityConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nationalityMrzConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.nationalityAlpha3Confidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.maritalStatusConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.raceConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.taxIdNumberConfidence` | number (float) |  |  |
| `ocrData.ocrDataConfidence.jurisdictionCodeConfidence` | number (float) |  |  |
| `ocrData.additionalDocumentAttempts` | array[AdditionalDocumentAttemptDto] |  |  |
| `ocrData.additionalDocumentAttempts.status` | string |  | Enum: `SUCCESS`, `VALIDATION_ERROR`, `FAIL` |
| `ocrData.additionalDocumentAttempts.attemptTimestamp` | integer (int64) |  |  |
| `ocrData.additionalDocumentAttempts.imagesUrl` | array[string] |  |  |
| `ocrData.additionalDocumentAttempts.attemptType` | string |  | Enum: `POA`, `DOCUMENT_CAPTURE` |
| `ocrData.additionalDocumentAttempts.antiSpoofResult` | PoaAntiSpoofResult |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.status` | string |  | Enum: `PASS`, `FAIL`, `NOT_EXECUTED` |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.kinds` | array[string] |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.confidence` | number (float) |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.details` | array[Detail] |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.details.kind` | string |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.details.error` | string |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.details.loc` | string |  |  |
| `ocrData.additionalDocumentAttempts.antiSpoofResult.details.explanation` | string |  |  |
| `ocrData.additionalDocumentAttempts.documentType` | string | yes |  |
| `ocrData.documentSubmissionMethod` | string |  | Method used to submit the document. Enum: `CAPTURED_DOCUMENT`, `UPLOADED_FILE`, `IMPORTED_CREDENTIAL` |
| `ocrData.credentialsProvider` | string |  | Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL. Enum: `APPLE`, `GOOGLE`, `DIGILOCKER`, `SAMSUNG`, `DIGITAL_ID`, `NETHERLANDS_IDIN`, `FINNISH_TRUST_NETWORK` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/ocr-data/v2?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "ocrData": {
    "name": {
      "fullName": "string",
      "fullNameNativeScript": "string",
      "firstNameNativeScript": "string",
      "paternalLastNameNativeScript": "string",
      "maternalLastNameNativeScript": "string",
      "machineReadableFullName": "string",
      "firstName": "string",
      "middleName": "string",
      "givenName": "string",
      "givenNameMrz": "string",
      "initials": "string",
      "nameSuffix": "string",
      "paternalLastName": "string",
      "maternalLastName": "string",
      "lastNameMrz": "string",
      "familyName": "string"
    },
    "address": "string",
    "addressFields": {
      "street": "string",
      "streetName": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string",
      "exteriorNumber": "string",
      "interiorNumber": "string",
      "addressLine1": "string",
      "streetType": "string"
    },
    "fullAddress": true,
    "invalidAddress": true,
    "checkedAddress": "string",
    "checkedAddressBean": {
      "street": "string",
      "streetName": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string",
      "exteriorNumber": "string",
      "interiorNumber": "string",
      "addressLine1": "string",
      "streetType": "string"
    },
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressFromStatement": "string",
    "addressFieldsFromStatement": {
      "street": "string",
      "streetName": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string",
      "exteriorNumber": "string",
      "interiorNumber": "string",
      "addressLine1": "string",
      "streetType": "string"
    },
    "invalidAddressFromStatement": true,
    "addressStatementEmissionDate": 0,
    "documentType": "aysa",
    "addressStatementTimestamps": [
      {
        "get_version": 0,
        "dateType": "string",
        "addressStatementTimestamp": 0
      }
    ],
    "poaName": "string",
    "typeOfId": "Unknown",
    "documentFrontSubtype": "string",
    "documentBackSubtype": "string",
    "issueFront": 0,
    "issueBack": 0,
    "birthDate": 0,
    "gender": "M",
    "claveDeElector": "string",
    "curp": "string",
    "numeroEmisionCredencial": "string",
    "cic": "string",
    "ocr": "string",
    "documentNumber": "string",
    "documentNumberSource": "FORM",
    "personalNumber": "string",
    "nationalNumber": "string",
    "refNumber": "string",
    "familyNumber": "string",
    "taxIdNumber": "string",
    "nue": "string",
    "externalId": "string",
    "issuedAt": "string",
    "expireAt": "string",
    "expirationDate": 0,
    "issueDate": 0,
    "registrationDate": 0,
    "dlClassDetails": [
      {
        "dlClass": "string",
        "validFromDate": 0,
        "validToDate": 0,
        "additionalCodes": "string",
        "restrictions": [
          "string"
        ]
      }
    ],
    "issuingCountry": "string",
    "issuingState": "string",
    "birthPlace": "string",
    "printingNumber": "string",
    "duplicateNumber": "string",
    "preparationNumber": "string",
    "issuingAuthority": "string",
    "height": "string",
    "weight": "string",
    "eyeColor": "string",
    "hairColor": "string",
    "religion": "string",
    "bloodType": "string",
    "maritalStatus": "string",
    "nationality": "string",
    "race": "string",
    "nationalityMrz": "string",
    "nationalityAlpha3": "string",
    "governmentComparisonResults": {
      "paternalLastNameValid": true,
      "maternalLastNameValid": true,
      "firstNameValid": true,
      "curpValid": true,
      "ineCurpValid": true,
      "ocrValid": true,
      "claveDeElectorValid": true,
      "numeroEmisionCredencialValid": true,
      "registrationDateValid": true,
      "issueDateValid": true
    },
    "notExtracted": 0,
    "notExtractedDetails": [
      "string"
    ],
    "classes": "string",
    "cond": "string",
    "mentions": "string",
    "restrictions": "string",
    "mrz1": "string",
    "mrz2": "string",
    "mrz3": "string",
    "fullNameMrz": "string",
    "documentNumberCheckDigit": "string",
    "dateOfBirthCheckDigit": "string",
    "expirationDateCheckDigit": "string",
    "barcodeRawData": "string",
    "qrFrontContents": [
      "string"
    ],
    "qrBackContents": [
      "string"
    ],
    "fathersName": "string",
    "mothersName": "string",
    "fathersIdNumber": "string",
    "mothersIdNumber": "string",
    "spouseName": "string",
    "federalRevenueNumber": "string",
    "originDocumentId": "string",
    "driversLicenseCategory": "string",
    "controlNumber": "string",
    "renach": "string",
    "additionalAttrs": [
      "DOCUMENTO_INFANTIL"
    ],
    "ocrDataConfidence": {
      "birthDateConfidence": 0,
      "nameConfidence": 0,
      "nameNativeScriptConfidence": 0,
      "firstNameNativeScriptConfidence": 0,
      "paternalLastNameNativeScriptConfidence": 0,
      "maternalLastNameNativeScriptConfidence": 0,
      "givenNameConfidence": 0,
      "firstNameConfidence": 0,
      "middleNameConfidence": 0,
      "nameSuffixConfidence": 0,
      "mothersSurnameConfidence": 0,
      "fathersSurnameConfidence": 0,
      "nickNameConfidence": 0,
      "fullNameMrzConfidence": 0,
      "mothersNameConfidence": 0,
      "fathersNameConfidence": 0,
      "mothersIdNumberConfidence": 0,
      "fathersIdNumberConfidence": 0,
      "spouseNameConfidence": 0,
      "birthNameConfidence": 0,
      "addressConfidence": 0,
      "streetConfidence": 0,
      "colonyConfidence": 0,
      "postalCodeConfidence": 0,
      "cityConfidence": 0,
      "stateConfidence": 0,
      "districtConfidence": 0,
      "stateCodeConfidence": 0,
      "countryCodeConfidence": 0,
      "genderConfidence": 0,
      "issueDateConfidence": 0,
      "expirationDateConfidence": 0,
      "issuedAtConfidence": 0,
      "expireAtConfidence": 0,
      "issuingAuthorityConfidence": 0,
      "mrz1Confidence": 0,
      "mrz2Confidence": 0,
      "mrz3Confidence": 0,
      "mrzFullConfidence": 0,
      "documentNumberConfidence": 0,
      "backNumberConfidence": 0,
      "personalNumberConfidence": 0,
      "nationalNumberConfidence": 0,
      "claveDeElectorConfidence": 0,
      "numeroEmisionCredencialConfidence": 0,
      "curpConfidence": 0,
      "nueConfidence": 0,
      "registrationDateConfidence": 0,
      "heightConfidence": 0,
      "birthPlaceConfidence": 0,
      "bloodTypeConfidence": 0,
      "eyeColorConfidence": 0,
      "classesConfidence": 0,
      "condConfidence": 0,
      "mentionsConfidence": 0,
      "refNumberConfidence": 0,
      "weightConfidence": 0,
      "hairConfidence": 0,
      "restrictionsConfidence": 0,
      "nationalityConfidence": 0,
      "nationalityMrzConfidence": 0,
      "nationalityAlpha3Confidence": 0,
      "maritalStatusConfidence": 0,
      "raceConfidence": 0,
      "taxIdNumberConfidence": 0,
      "jurisdictionCodeConfidence": 0
    },
    "additionalDocumentAttempts": [
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "imagesUrl": [
          "string"
        ],
        "attemptType": "POA",
        "antiSpoofResult": {
          "status": "PASS",
          "kinds": [
            "string"
          ],
          "confidence": 0,
          "details": [
            {
              "kind": null,
              "error": null,
              "loc": null,
              "explanation": null
            }
          ]
        },
        "documentType": "string"
      }
    ],
    "documentSubmissionMethod": "CAPTURED_DOCUMENT",
    "credentialsProvider": "APPLE"
  }
}
```

---

- Path: `api-reference/get-onboarding-status`
- URL: https://developer.incode.com/api-reference/get-onboarding-status/
- Markdown: https://developer.incode.com/api-reference/get-onboarding-status.md
- Endpoint: `GET /omni/get/onboarding/status`

# Fetch onboarding status

`GET /omni/get/onboarding/status`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check the status of onboarding session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Represents interview id for which status is requested. If it is not present it will be read from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

onboardingStatus: String. A flag indicating current status of onboarding session. Possible values: - ID_VALIDATION_FINISHED - User finished with capturing of ID, - POST_PROCESSING_FINISHED - ID postprocessing finished on server, - FACE_VALIDATION_FINISHED - User finished with selfie capture, - ONBOARDING_FINISHED - User finished onboarding process, - MANUAL_REVIEW_APPROVED - Session that was in Needs Review state, manually approved by Executive, - MANUAL_REVIEW_REJECTED - Session that was in Needs Review state, manually rejected by Executive, - UNKNOWN - Unable to determine status of onboarding session - user still didn't start onboarding or user is still in the process of capturing ID.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/onboarding/status?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-phone`
- URL: https://developer.incode.com/api-reference/get-phone/
- Markdown: https://developer.incode.com/api-reference/get-phone.md
- Endpoint: `GET /omni/get/phone`

# Get phone

`GET /omni/get/phone`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

> **Deprecated** — this endpoint is marked deprecated in the Omni API specification.

Get the phone previously added to the interview. Deprecated, use GET /phone instead.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/phone?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "phone": "string"
}
```

---

- Path: `api-reference/get-postprocess-isfinished`
- URL: https://developer.incode.com/api-reference/get-postprocess-isfinished/
- Markdown: https://developer.incode.com/api-reference/get-postprocess-isfinished.md
- Endpoint: `GET /omni/get/postprocess/isfinished`

# Fetch processing status

`GET /omni/get/postprocess/isfinished`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check if session processing is done.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

finished: Boolean. A flag stating if processing is done or not.

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/postprocess/isfinished \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/postprocess/isfinished", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/postprocess/isfinished", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/postprocess/isfinished"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/postprocess/isfinished")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/postprocess/isfinished");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-process-batch-status`
- URL: https://developer.incode.com/api-reference/get-process-batch-status/
- Markdown: https://developer.incode.com/api-reference/get-process-batch-status.md
- Endpoint: `GET /omni/get/process-batch-status`

# Get batch processing status

`GET /omni/get/process-batch-status`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns the status of the [/omni/process/batch](#/Onboarding/processBatch) progress

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/process-batch-status \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/process-batch-status", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/process-batch-status", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/process-batch-status"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/process-batch-status")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/process-batch-status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/get-questionandanswer`
- URL: https://developer.incode.com/api-reference/get-questionandanswer/
- Markdown: https://developer.incode.com/api-reference/get-questionandanswer.md
- Endpoint: `GET /omni/get/questionAndAnswer`

# Fetch random questions and answers for video selfie

`GET /omni/get/questionAndAnswer`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch a number random questions and answers for video selfie for given apiKey. If there are no defined QA pairs for the apiKey,
a random QA pair is returned from the default set.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `numberOfQuestions` | query | integer (int32) | yes | Number of questions to be returned to client |
| `returnVoiceConsentQuestion` | query | boolean |  | Flag stating if voice consent question should be included in response Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `questionAndAnswers` | array[QuestionAndAnswerWithId] |  |  |
| `questionAndAnswers.id` | string |  | ID of the given Question-Answer pair. |
| `questionAndAnswers.question` | string |  | Random question to be shown in video selfie. |
| `questionAndAnswers.answer` | string |  | Corresponding answer to the question. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/questionAndAnswer?numberOfQuestions=%3CnumberOfQuestions%3E&returnVoiceConsentQuestion=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "questionAndAnswers": [
    {
      "id": "string",
      "question": "string",
      "answer": "string"
    }
  ]
}
```

---

- Path: `api-reference/get-raw-idv-results`
- URL: https://developer.incode.com/api-reference/get-raw-idv-results/
- Markdown: https://developer.incode.com/api-reference/get-raw-idv-results.md
- Endpoint: `GET /omni/get/raw-idv-results`

# Fetch raw IDV results

`GET /omni/get/raw-idv-results`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns raw id-validation-service check results with original naming preserved (no mapping to user-service key constants, no threshold-binarization), plus the raw checkFraudRisk result.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of interview for which raw IDV results are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checkResults` | array[RawIdvCheckResultDto] |  | Raw id-validation-service check results. Empty when id-validation-service was not invoked for the interview. |
| `checkResults.name` | string |  | Original id-validation-service check name, e.g. checkIdFaceTamper, checkIdScreenLiveness, deep_fraud. |
| `checkResults.severity` | string |  | Check severity: low / medium / high. Enum: `low`, `medium`, `high` |
| `checkResults.version` | string |  | Model version that produced the result. |
| `checkResults.result` | number (float) |  | Raw confidence/result value, Float in [0, 1]. Nullable when the check did not run. |
| `fraudRisk` | FraudRiskDto |  | Raw checkFraudRisk result. Null when no FraudRisk was produced for the interview. |
| `fraudRisk.name` | string |  | Check name, always checkFraudRisk. |
| `fraudRisk.severity` | string |  | Check severity: low / medium / high. Enum: `LOW`, `MEDIUM`, `HIGH` |
| `fraudRisk.version` | string |  | Model version that produced the result. |
| `fraudRisk.result` | number |  | Raw fraud-risk result value (full precision). |
| `fraudRisk.responseText` | string |  | Free-text explanation returned by the fraud-risk model. |
| `fraudRisk.responseCategory` | string |  | Response category returned by the fraud-risk model. |
| `fraudRisk.topNFraudFeatures` | array[string] |  | Top N features that contributed towards a fraud classification. |
| `fraudRisk.topNLegitFeatures` | array[string] |  | Top N features that contributed towards a legitimate classification. |
| `fraudRisk.topNFraudCodes` | array[string] |  | Raw stable feature codes for topNFraudFeatures (same order), as sent by the model. |
| `fraudRisk.topNLegitCodes` | array[string] |  | Raw stable feature codes for topNLegitFeatures (same order), as sent by the model. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/raw-idv-results?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "checkResults": [
    {
      "name": "string",
      "severity": "low",
      "version": "string",
      "result": 0
    }
  ],
  "fraudRisk": {
    "name": "string",
    "severity": "LOW",
    "version": "string",
    "result": 0,
    "responseText": "string",
    "responseCategory": "string",
    "topNFraudFeatures": [
      "string"
    ],
    "topNLegitFeatures": [
      "string"
    ],
    "topNFraudCodes": [
      "string"
    ],
    "topNLegitCodes": [
      "string"
    ]
  }
}
```

---

- Path: `api-reference/get-score`
- URL: https://developer.incode.com/api-reference/get-score/
- Markdown: https://developer.incode.com/api-reference/get-score.md
- Endpoint: `GET /omni/get/score`

# Fetch scores

`GET /omni/get/score`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get id validation, liveness and face recognition results for given interviewId.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which score is requests. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `authentication` | AuthenticationDto |  | The result of authentication containing overall score and list of executed checks. |
| `authentication.overall` | ResultBean |  | Composite result for authentication score. |
| `authentication.overall.value` | string |  |  |
| `authentication.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `authentication.identityId` | string |  |  |
| `authentication.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `authentication.appliedRule.name` | string |  | Name of the rule. |
| `authentication.appliedRule.expression` | string |  | A logical expression of the rule. |
| `authentication.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `authentication.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idValidation` | IdValidation |  | Id validation of its overall score and two lists of executed tests and checks |
| `idValidation.photoSecurityAndQuality` | array[IdResultBean] |  |  |
| `idValidation.photoSecurityAndQuality.value` | string |  |  |
| `idValidation.photoSecurityAndQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idValidation.photoSecurityAndQuality.key` | string |  |  |
| `idValidation.idSpecific` | array[IdResultBean] |  |  |
| `idValidation.idSpecific.value` | string |  |  |
| `idValidation.idSpecific.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idValidation.idSpecific.key` | string |  |  |
| `idValidation.customFields` | array[IdResultBean] |  |  |
| `idValidation.customFields.value` | string |  |  |
| `idValidation.customFields.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idValidation.customFields.key` | string |  |  |
| `idValidation.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `idValidation.appliedRule.name` | string |  | Name of the rule. |
| `idValidation.appliedRule.expression` | string |  | A logical expression of the rule. |
| `idValidation.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `idValidation.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idValidation.overall` | ResultBean |  |  |
| `idValidation.overall.value` | string |  |  |
| `idValidation.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `antifraud` | AntifraudScoreValidation |  | The result of antifraud check where we compare the current interview with existing interviews and customers and detect anomalies than could be signs of fraud |
| `antifraud.overall` | ResultBean |  |  |
| `antifraud.overall.value` | string |  |  |
| `antifraud.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `secondIdValidation` | IdValidation |  | Same as idValidation only applicable if onboarding is configured to capture a second id |
| `secondIdValidation.photoSecurityAndQuality` | array[IdResultBean] |  |  |
| `secondIdValidation.photoSecurityAndQuality.value` | string |  |  |
| `secondIdValidation.photoSecurityAndQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `secondIdValidation.photoSecurityAndQuality.key` | string |  |  |
| `secondIdValidation.idSpecific` | array[IdResultBean] |  |  |
| `secondIdValidation.idSpecific.value` | string |  |  |
| `secondIdValidation.idSpecific.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `secondIdValidation.idSpecific.key` | string |  |  |
| `secondIdValidation.customFields` | array[IdResultBean] |  |  |
| `secondIdValidation.customFields.value` | string |  |  |
| `secondIdValidation.customFields.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `secondIdValidation.customFields.key` | string |  |  |
| `secondIdValidation.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `secondIdValidation.appliedRule.name` | string |  | Name of the rule. |
| `secondIdValidation.appliedRule.expression` | string |  | A logical expression of the rule. |
| `secondIdValidation.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `secondIdValidation.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `secondIdValidation.overall` | ResultBean |  |  |
| `secondIdValidation.overall.value` | string |  |  |
| `secondIdValidation.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness` | LivenessDto |  |  |
| `liveness.hasHeadCover` | ResultBean |  | Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured |
| `liveness.hasHeadCover.value` | string |  |  |
| `liveness.hasHeadCover.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.hasClosedEyes` | ResultBean |  | Returns flag if closed eyes is detected on the image. Only if hats detected option is configured |
| `liveness.hasClosedEyes.value` | string |  |  |
| `liveness.hasClosedEyes.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.physicalAttack` | ResultBean |  | Returns flag if physical attack is detected. Only if this option is configured |
| `liveness.physicalAttack.value` | string |  |  |
| `liveness.physicalAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.digitalAttack` | ResultBean |  | Returns flag if digital attack is detected. Only if this option is configured |
| `liveness.digitalAttack.value` | string |  |  |
| `liveness.digitalAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.evasionAttack` | ResultBean |  | Returns flag if evasion attack is detected. Only if this option is configured |
| `liveness.evasionAttack.value` | string |  |  |
| `liveness.evasionAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.deepfakeAttack` | ResultBean |  | Returns flag if deepfake attack is detected. Only if digital attack is configured |
| `liveness.deepfakeAttack.value` | string |  |  |
| `liveness.deepfakeAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.digitalManipulationAttack` | ResultBean |  | Returns flag if digital manipulation attack is detected. Only if digital attack is configured |
| `liveness.digitalManipulationAttack.value` | string |  |  |
| `liveness.digitalManipulationAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.appliedRule` | AppliedFlowRule |  | Information about applied rule |
| `liveness.appliedRule.name` | string |  | Name of the rule. |
| `liveness.appliedRule.expression` | string |  | A logical expression of the rule. |
| `liveness.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `liveness.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.spoofDetectionMethod` | string |  | Information about method used Enum: `SF`, `SF_MM`, `SF_MM_V` |
| `liveness.overall` | ResultBean |  | Composite result for liveness score. |
| `liveness.overall.value` | string |  |  |
| `liveness.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `liveness.livenessScore` | ResultBean |  | Returns flag if physical attack is detected. Only if this option is configured. Deprecated, use 'physicalAttack' instead. |
| `liveness.livenessScore.value` | string |  |  |
| `liveness.livenessScore.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight` | DeepsightScoreDto |  |  |
| `deepsight.multimodalIntelligence` | MultimodalIntelligenceDto |  |  |
| `deepsight.multimodalIntelligence.physicalAttack` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.physicalAttack.value` | string |  |  |
| `deepsight.multimodalIntelligence.physicalAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.digitalAttack` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.digitalAttack.value` | string |  |  |
| `deepsight.multimodalIntelligence.digitalAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.deepfakeAttack` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.deepfakeAttack.value` | string |  |  |
| `deepsight.multimodalIntelligence.deepfakeAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.digitalManipulationAttack` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.digitalManipulationAttack.value` | string |  |  |
| `deepsight.multimodalIntelligence.digitalManipulationAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.evasionAttack` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.evasionAttack.value` | string |  |  |
| `deepsight.multimodalIntelligence.evasionAttack.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.spoofDetectionMethod` | string |  | Enum: `SF`, `SF_MM`, `SF_MM_V` |
| `deepsight.multimodalIntelligence.faceExplanation` | SpoofResultExplanationDto |  |  |
| `deepsight.multimodalIntelligence.faceExplanation.description` | string |  |  |
| `deepsight.multimodalIntelligence.faceExplanation.keywords` | SpoofDetectionExplanationKeywordsDto |  |  |
| `deepsight.multimodalIntelligence.faceExplanation.keywords.category` | string |  |  |
| `deepsight.multimodalIntelligence.faceExplanation.keywords.isDepthFlat` | boolean |  |  |
| `deepsight.multimodalIntelligence.faceExplanation.keywords.isVideoCorrupted` | boolean |  |  |
| `deepsight.multimodalIntelligence.faceOverall` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.faceOverall.value` | string |  |  |
| `deepsight.multimodalIntelligence.faceOverall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.aiGeneratedDocument` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.aiGeneratedDocument.value` | string |  |  |
| `deepsight.multimodalIntelligence.aiGeneratedDocument.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.visualAnomaly` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.visualAnomaly.value` | string |  |  |
| `deepsight.multimodalIntelligence.visualAnomaly.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.documentOverall` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.documentOverall.value` | string |  |  |
| `deepsight.multimodalIntelligence.documentOverall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.multimodalIntelligence.overall` | ResultBean |  |  |
| `deepsight.multimodalIntelligence.overall.value` | string |  |  |
| `deepsight.multimodalIntelligence.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.deviceTrust` | DeviceTrustScoreDto |  |  |
| `deepsight.deviceTrust.overall` | ResultBean |  |  |
| `deepsight.deviceTrust.overall.value` | string |  |  |
| `deepsight.deviceTrust.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.behavioralTrust` | BehavioralTrustScoreDto |  |  |
| `deepsight.behavioralTrust.overall` | ResultBean |  |  |
| `deepsight.behavioralTrust.overall.value` | string |  |  |
| `deepsight.behavioralTrust.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.cameraTrust` | CameraTrustScoreDto |  |  |
| `deepsight.cameraTrust.overall` | ResultBean |  |  |
| `deepsight.cameraTrust.overall.value` | string |  |  |
| `deepsight.cameraTrust.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.overall` | ResultBean |  |  |
| `deepsight.overall.value` | string |  |  |
| `deepsight.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `deepsight.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `deepsight.appliedRule.name` | string |  | Name of the rule. |
| `deepsight.appliedRule.expression` | string |  | A logical expression of the rule. |
| `deepsight.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `deepsight.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment` | FaceCaptureAssessmentScoreDto |  |  |
| `faceCaptureAssessment.faceAttributes` | FaceAttributesScoreDto |  | Contains face attributes |
| `faceCaptureAssessment.faceAttributes.maskCheck` | ResultBean |  | Shows info if the user was wearing a mask during selfie capture |
| `faceCaptureAssessment.faceAttributes.maskCheck.value` | string |  |  |
| `faceCaptureAssessment.faceAttributes.maskCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.faceAttributes.lensesCheck` | ResultBean |  | Shows info if the user was wearing lenses during selfie capture |
| `faceCaptureAssessment.faceAttributes.lensesCheck.value` | string |  |  |
| `faceCaptureAssessment.faceAttributes.lensesCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.faceAttributes.hasHeadCover` | ResultBean |  | Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured |
| `faceCaptureAssessment.faceAttributes.hasHeadCover.value` | string |  |  |
| `faceCaptureAssessment.faceAttributes.hasHeadCover.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.faceAttributes.hasClosedEyes` | ResultBean |  | Returns flag if closed eyes is detected on the image. Only if hats detected option is configured |
| `faceCaptureAssessment.faceAttributes.hasClosedEyes.value` | string |  |  |
| `faceCaptureAssessment.faceAttributes.hasClosedEyes.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.faceAttributes.faceOcclusion` | ResultBean |  | Returns flag if captured face is occluded on the image. Only if hats detected option is configured |
| `faceCaptureAssessment.faceAttributes.faceOcclusion.value` | string |  |  |
| `faceCaptureAssessment.faceAttributes.faceOcclusion.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.qualityChecks` | QualityChecksScoreDto |  | Contains quality checks |
| `faceCaptureAssessment.qualityChecks.faceBrightness` | ResultBean |  | Shows status of brightness during selfie capture |
| `faceCaptureAssessment.qualityChecks.faceBrightness.value` | string |  |  |
| `faceCaptureAssessment.qualityChecks.faceBrightness.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceCaptureAssessment.qualityChecks.imageQuality` | ResultBean |  | Shows status of image quality check |
| `faceCaptureAssessment.qualityChecks.imageQuality.value` | string |  |  |
| `faceCaptureAssessment.qualityChecks.imageQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition` | FaceRecognitionDto |  |  |
| `faceRecognition.existingUser` | boolean |  | Flag indicating if a user is already enrolled |
| `faceRecognition.customerId` | string |  | Id of enrolled user |
| `faceRecognition.existingInterviewId` | string |  | Session ID, in case the user is approved in another session |
| `faceRecognition.existingExternalId` | string |  | External ID, in case the user is approved in another session |
| `faceRecognition.maskCheck` | ResultBean |  | Shows info if the user was wearing a mask during selfie capture |
| `faceRecognition.maskCheck.value` | string |  |  |
| `faceRecognition.maskCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.lensesCheck` | ResultBean |  | Shows info if the user was wearing lenses during selfie capture |
| `faceRecognition.lensesCheck.value` | string |  |  |
| `faceRecognition.lensesCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.faceBrightness` | ResultBean |  | Shows status and level of brightness during selfie capture |
| `faceRecognition.faceBrightness.value` | string |  |  |
| `faceRecognition.faceBrightness.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.imageQuality` | ResultBean |  | Shows image quality during selfie capture |
| `faceRecognition.imageQuality.value` | string |  |  |
| `faceRecognition.imageQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.nameMatch` | ResultBean |  | Shows if the name matches the previously used (only in case the user is already approved in another session) |
| `faceRecognition.nameMatch.value` | string |  |  |
| `faceRecognition.nameMatch.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.appliedRule` | AppliedFlowRuleDto |  | Specific rule from rule engine for faceValidation |
| `faceRecognition.appliedRule.name` | string |  | Name of the rule. |
| `faceRecognition.appliedRule.expression` | string |  | A logical expression of the rule. |
| `faceRecognition.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `faceRecognition.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.overall` | ResultBean |  | Shows how much face from ID matches the selfie |
| `faceRecognition.overall.value` | string |  |  |
| `faceRecognition.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.hasHeadCover` | ResultBean |  | Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured |
| `faceRecognition.hasHeadCover.value` | string |  |  |
| `faceRecognition.hasHeadCover.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.hasClosedEyes` | ResultBean |  | Returns flag if closed eyes is detected on the image. Only if hats detected option is configured |
| `faceRecognition.hasClosedEyes.value` | string |  |  |
| `faceRecognition.hasClosedEyes.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognition.faceOcclusion` | ResultBean |  | Returns flag if captured face is occluded on the image. Only if hats detected option is configured |
| `faceRecognition.faceOcclusion.value` | string |  |  |
| `faceRecognition.faceOcclusion.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId` | FaceRecognitionDto |  | Same as faceRecognition only applicable if onboarding is configured to capture a second id |
| `faceRecognitionSecondId.existingUser` | boolean |  | Flag indicating if a user is already enrolled |
| `faceRecognitionSecondId.customerId` | string |  | Id of enrolled user |
| `faceRecognitionSecondId.existingInterviewId` | string |  | Session ID, in case the user is approved in another session |
| `faceRecognitionSecondId.existingExternalId` | string |  | External ID, in case the user is approved in another session |
| `faceRecognitionSecondId.maskCheck` | ResultBean |  | Shows info if the user was wearing a mask during selfie capture |
| `faceRecognitionSecondId.maskCheck.value` | string |  |  |
| `faceRecognitionSecondId.maskCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.lensesCheck` | ResultBean |  | Shows info if the user was wearing lenses during selfie capture |
| `faceRecognitionSecondId.lensesCheck.value` | string |  |  |
| `faceRecognitionSecondId.lensesCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.faceBrightness` | ResultBean |  | Shows status and level of brightness during selfie capture |
| `faceRecognitionSecondId.faceBrightness.value` | string |  |  |
| `faceRecognitionSecondId.faceBrightness.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.imageQuality` | ResultBean |  | Shows image quality during selfie capture |
| `faceRecognitionSecondId.imageQuality.value` | string |  |  |
| `faceRecognitionSecondId.imageQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.nameMatch` | ResultBean |  | Shows if the name matches the previously used (only in case the user is already approved in another session) |
| `faceRecognitionSecondId.nameMatch.value` | string |  |  |
| `faceRecognitionSecondId.nameMatch.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.appliedRule` | AppliedFlowRuleDto |  | Specific rule from rule engine for faceValidation |
| `faceRecognitionSecondId.appliedRule.name` | string |  | Name of the rule. |
| `faceRecognitionSecondId.appliedRule.expression` | string |  | A logical expression of the rule. |
| `faceRecognitionSecondId.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `faceRecognitionSecondId.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.overall` | ResultBean |  | Shows how much face from ID matches the selfie |
| `faceRecognitionSecondId.overall.value` | string |  |  |
| `faceRecognitionSecondId.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.hasHeadCover` | ResultBean |  | Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured |
| `faceRecognitionSecondId.hasHeadCover.value` | string |  |  |
| `faceRecognitionSecondId.hasHeadCover.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.hasClosedEyes` | ResultBean |  | Returns flag if closed eyes is detected on the image. Only if hats detected option is configured |
| `faceRecognitionSecondId.hasClosedEyes.value` | string |  |  |
| `faceRecognitionSecondId.hasClosedEyes.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `faceRecognitionSecondId.faceOcclusion` | ResultBean |  | Returns flag if captured face is occluded on the image. Only if hats detected option is configured |
| `faceRecognitionSecondId.faceOcclusion.value` | string |  |  |
| `faceRecognitionSecondId.faceOcclusion.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore` | ExternalFaceMatchScoreDto |  | The result of external face match containing overall score and list of executed checks |
| `externalFaceMatchScore.faceMaskCheck` | ResultBean |  | Shows if mask is detected on the external face |
| `externalFaceMatchScore.faceMaskCheck.value` | string |  |  |
| `externalFaceMatchScore.faceMaskCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.lensesCheck` | ResultBean |  | Shows if lenses are detected on the external face |
| `externalFaceMatchScore.lensesCheck.value` | string |  |  |
| `externalFaceMatchScore.lensesCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.headCoverCheck` | ResultBean |  | Shows info if head cover was detected on the external face |
| `externalFaceMatchScore.headCoverCheck.value` | string |  |  |
| `externalFaceMatchScore.headCoverCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.closedEyeCheck` | ResultBean |  | Shows info if closed eyes are detected on the external face |
| `externalFaceMatchScore.closedEyeCheck.value` | string |  |  |
| `externalFaceMatchScore.closedEyeCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.imageQualityCheck` | ResultBean |  | Shows image quality of external face |
| `externalFaceMatchScore.imageQualityCheck.value` | string |  |  |
| `externalFaceMatchScore.imageQualityCheck.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.faceOccluded` | ResultBean |  | Returns flag if external face is occluded on the image |
| `externalFaceMatchScore.faceOccluded.value` | string |  |  |
| `externalFaceMatchScore.faceOccluded.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.vsIdMatch` | ResultBean |  | Shows how much face from ID matches the external face |
| `externalFaceMatchScore.vsIdMatch.value` | string |  |  |
| `externalFaceMatchScore.vsIdMatch.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.vsSelfieMatch` | ResultBean |  | Shows how much selfie matches the external face |
| `externalFaceMatchScore.vsSelfieMatch.value` | string |  |  |
| `externalFaceMatchScore.vsSelfieMatch.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `externalFaceMatchScore.overall` | ResultBean |  | Composite result for external face match score |
| `externalFaceMatchScore.overall.value` | string |  |  |
| `externalFaceMatchScore.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation` | GovernmentValidation |  | - recognitionConfidence: Only present in case face validation is performed as a part of government check - fingerprintConfidence: Only present in case fingerprint validation is performed as a part of government check - minimumPassingFingerprints: Only present in case fingerprint validation is performed. Maps to configured number of minimum fingerprints configured at the time of score calculation. - validationStatus: Possible values: processingIne, ok, validationError, ineConnectionError, ineInfrastructureError, moduleNotSupported, missingDocumentId, missingSelfie, userNotFound, userNotFoundInIneDb, notEnoughData, livenessFail, ineNotCurrent, ineReportedLost, ineReportedStolen, ineSignaturError, transactionLimitReached, geographicRegionNotSupported Key-value mapping: - -1: processingIne - 0: ok - 1: validationError - 2: ineConnectionError - 3: ineInfrastructureError - 4: moduleNotSupported - 5: missingDocumentId - 6: missingSelfie - 7: userNotFound - 8: userNotFoundInIneDb - 9: notEnoughData - 10: livenessFail - 11: ineNotCurrent - 12: ineReportedLost - 13: ineReportedStolen - 14: ineSignaturError - 99: geographicRegionNotSupported - 205: transactionLimitReached - ocrValidation: List of value, status, key objects. Not all of the following keys are always present: issueDate firstName, maternalLastName, paternalLastName, ocr, personalId, electorsKey, emissionNumber, registrationDate - ocrValidationOverall: Composite result for ocrValidation score - credentialStatus: List of value, status, key objects carrying issuing-authority verdicts about the credential itself, e.g. nonCommercialDriverLicenseStatus, indefiniteExpiration. Informational only - these never affect the government validation score or overall status. An entry is present only when the check was requested; status OK means confirmed, FAIL refuted, UNKNOWN the authority did not report it. - validationSource: Where the validated identity data came from: ID_CAPTURE (captured ID on the session), REQUEST_BODY (data sent in the government validation request) or KYX_PREFILL (eKYC pre-fill). Absent for sessions validated before it was recorded or through the legacy government validation module. - registryData: Values the government source holds for the person (taxIdNumber). Present only when the latest attempt of the provider shown in "provider" reported at least one value. Informational only - never affects the government validation score or overall status. - overall |
| `governmentValidation.recognitionConfidence` | ResultBean |  |  |
| `governmentValidation.recognitionConfidence.value` | string |  |  |
| `governmentValidation.recognitionConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.fingerprintConfidence` | ResultBean |  |  |
| `governmentValidation.fingerprintConfidence.value` | string |  |  |
| `governmentValidation.fingerprintConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.minimumPassingFingerprints` | integer (int32) |  |  |
| `governmentValidation.validationStatus` | IdResultBean |  |  |
| `governmentValidation.validationStatus.value` | string |  |  |
| `governmentValidation.validationStatus.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.validationStatus.key` | string |  |  |
| `governmentValidation.ocrValidation` | array[IdResultBean] |  |  |
| `governmentValidation.ocrValidation.value` | string |  |  |
| `governmentValidation.ocrValidation.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.ocrValidation.key` | string |  |  |
| `governmentValidation.credentialStatus` | array[IdResultBean] |  |  |
| `governmentValidation.credentialStatus.value` | string |  |  |
| `governmentValidation.credentialStatus.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.credentialStatus.key` | string |  |  |
| `governmentValidation.registryData` | GovernmentRegistryData |  | Values the government source holds for the person, under provider-neutral names so the same field reads the same across providers. Present only when the provider shown in "provider" reported at least one value. |
| `governmentValidation.registryData.taxIdNumber` | string |  | Tax identification number the government source holds for the person: Argentina CUIL from RENAPER_PREMIUM and MM_ARGENTINA_RENAPER_EXTENDED. |
| `governmentValidation.ocrValidationOverall` | ResultBean |  |  |
| `governmentValidation.ocrValidationOverall.value` | string |  |  |
| `governmentValidation.ocrValidationOverall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.overall` | ResultBean |  |  |
| `governmentValidation.overall.value` | string |  |  |
| `governmentValidation.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.provider` | string |  |  |
| `governmentValidation.validationSource` | string |  | Enum: `ID_CAPTURE`, `REQUEST_BODY`, `KYX_PREFILL` |
| `governmentValidation.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `governmentValidation.appliedRule.name` | string |  | Name of the rule. |
| `governmentValidation.appliedRule.expression` | string |  | A logical expression of the rule. |
| `governmentValidation.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `governmentValidation.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `videoConference` | VideoSelfie |  | - speechTranscript: Extracted text from speech, during video recording - videoSelfieLiveness: Shows liveness confidence that the person is real based on video conference - videoSelfieFaceRecognition: Shows how much face from id matches the video conference capture - speechRecognition: This shows how much the recognized speech matches the expected result - score: Overall video recording score |
| `videoConference.speechTranscript` | string |  |  |
| `videoConference.speechTranscriptWhisper` | string |  |  |
| `videoConference.videoSelfieLiveness` | ResultBean |  |  |
| `videoConference.videoSelfieLiveness.value` | string |  |  |
| `videoConference.videoSelfieLiveness.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `videoConference.videoSelfieFaceRecognition` | ResultBean |  |  |
| `videoConference.videoSelfieFaceRecognition.value` | string |  |  |
| `videoConference.videoSelfieFaceRecognition.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `videoConference.speechRecognition` | ResultBean |  |  |
| `videoConference.speechRecognition.value` | string |  |  |
| `videoConference.speechRecognition.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `videoConference.score` | ResultBean |  |  |
| `videoConference.score.value` | string |  |  |
| `videoConference.score.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `videoConference.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `videoConference.appliedRule.name` | string |  | Name of the rule. |
| `videoConference.appliedRule.expression` | string |  | A logical expression of the rule. |
| `videoConference.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `videoConference.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `curpVerification` | CurpResponse |  | Only for Mex documents, in case CURP validation was performed |
| `curpVerification.success` | boolean |  | Flag indicating request passed successfully. |
| `curpVerification.curp` | string |  | Curp |
| `curpVerification.sex` | string |  | Sex Enum: `Mujer`, `Hombre`, `X` |
| `curpVerification.nationality` | string |  | Nationality |
| `curpVerification.result` | string |  |  |
| `curpVerification.transactionId` | string |  |  |
| `curpVerification.renapo_valid` | boolean |  | Flag indicating if CURP validation passed - tipoError present in response |
| `curpVerification.names` | string |  | Names |
| `curpVerification.paternal_surname` | string |  | Paternal surname |
| `curpVerification.mothers_maiden_name` | string |  | Mother maiden name |
| `curpVerification.birthdate` | string |  | Birth Date in format DD/MM/YYYY |
| `curpVerification.entity_birth` | string |  | Birth State |
| `curpVerification.probation_document` | string |  | Probation Document |
| `curpVerification.probation_document_data` | object |  | Key/Value structure. All keys are type of string. Available Key values: - anioReg - foja - tomo - libro - numActa - CRIP - numEntidadReg - cveMunicipioReg - NumRegExtranjeros - FolioCarta - cveEntidadNac - cveEntidadEmisora |
| `curpVerification.status_curp` | string |  | Status Curp |
| `curpVerification.deceasedStatus` | string |  | Deceased Status |
| `ineScrapingValidation` | IneResult |  | Only for Mex documents in case INE scraping was performed |
| `ineScrapingValidation.get_version` | integer (int64) |  |  |
| `ineScrapingValidation.scrapingStatus` | string |  | Scraping status Enum: `IN_PROGRESS`, `FINISHED`, `ERROR` |
| `ineScrapingValidation.success` | boolean |  | Flag indicating if the process finished successfully. |
| `ineScrapingValidation.result` | string |  | Result Enum: `success`, `error` |
| `ineScrapingValidation.resultDetails` | string |  |  |
| `ineScrapingValidation.screenshotUrl` | string |  |  |
| `ineScrapingValidation.cic` | string |  | Cic value. |
| `ineScrapingValidation.claveElector` | string |  | Clave de elector. |
| `ineScrapingValidation.numeroEmision` | string |  | Emission number. |
| `ineScrapingValidation.ocr` | string |  | Ocr number. |
| `ineScrapingValidation.anioRegistro` | string |  | Registration year. |
| `ineScrapingValidation.anioEmision` | string |  | Emission year. |
| `idOcrConfidence` | IdOcrConfidence |  | Confidence level for read ocr data from ID |
| `idOcrConfidence.overallConfidence` | ResultBean |  |  |
| `idOcrConfidence.overallConfidence.value` | string |  |  |
| `idOcrConfidence.overallConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `idOcrConfidenceSecondId` | IdOcrConfidence |  | Same as idOcrConfidence only applicable if onboarding is configured to capture a second id |
| `idOcrConfidenceSecondId.overallConfidence` | ResultBean |  |  |
| `idOcrConfidenceSecondId.overallConfidence.value` | string |  |  |
| `idOcrConfidenceSecondId.overallConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `incodeWatchlistScore` | IncodeWatchlistScore |  | Incode watchlist score |
| `incodeWatchlistScore.watchlistScore` | ResultBean |  |  |
| `incodeWatchlistScore.watchlistScore.value` | string |  |  |
| `incodeWatchlistScore.watchlistScore.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `incodeWatchlistScore.dataMatches` | array[string] |  |  |
| `incodeWatchlistScore.incodeWatchlistId` | string |  |  |
| `retryInfo` | RetryInfo |  | Info about failed onboarding attempts (only if 'Onboarding flow attempts' > 0 in ID Capture module) |
| `retryInfo.failedAttemptsCounter` | object |  | Object with counter of failed attempts per step |
| `retryInfo.stepsToRetry` | array[string] |  | Enum: `frontId`, `backId`, `selfie`, `poa`, `governmentValidation` |
| `documentOnEdgeInfo` | DocumentOnEdgeInfo |  | Info about image alignment characteristic (if is on the image edge) |
| `documentOnEdgeInfo.frontDocumentIsOnTheEdge` | boolean |  |  |
| `documentOnEdgeInfo.backDocumentIsOnTheEdge` | boolean |  |  |
| `appliedRule` | AppliedFlowRule |  | Specific rule from rule engine for total |
| `appliedRule.name` | string |  | Name of the rule. |
| `appliedRule.expression` | string |  | A logical expression of the rule. |
| `appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `needsReviewReason` | string |  | In case the overall score status is MANUAL (Needs Review), returns reason Enum: `MANUAL_CAPTURE`, `RULE_APPLIED`, `OLD_ID`, `FLOW_CONFIGURATION`, `FRONT_ID_CAPTURE_ATTEMPTS`, `BACK_ID_CAPTURE_ATTEMPTS`, `SELFIE_CAPTURE_ATTEMPTS`, `ANTIFRAUD`, `MISSING_DEPTH_DATA`, `CUSTOM` |
| `sessionRecording` | SessionRecording |  |  |
| `sessionRecording.mergedRecordingQualityChecks` | SessionRecordingQualityChecksScore |  |  |
| `sessionRecording.mergedRecordingQualityChecks.fileIsPresent` | string |  | Enum: `PRESENT`, `NOT_PRESENT`, `UNKNOWN` |
| `sessionRecording.mergedRecordingQualityChecks.hasVideo` | string |  | Enum: `YES`, `NO`, `UNKNOWN` |
| `sessionRecording.mergedRecordingQualityChecks.hasAudio` | string |  | Enum: `YES`, `NO`, `UNKNOWN` |
| `sessionRecording.mergedRecordingQualityChecks.fileNotEmpty` | string |  | Enum: `NOT_EMPTY`, `EMPTY`, `UNKNOWN` |
| `sessionRecording.mergedRecordingQualityChecks.recordingQuality` | ResultBean |  |  |
| `sessionRecording.mergedRecordingQualityChecks.recordingQuality.value` | string |  |  |
| `sessionRecording.mergedRecordingQualityChecks.recordingQuality.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `trustGraph` | TrustGraph |  | Analysis of trust relationships and signals detected during onboarding, such as connections between devices and identities, used to assess the overall trustworthiness of the onboarding attempt. |
| `trustGraph.riskResults` | TrustGraphRiskResults |  |  |
| `trustGraph.riskResults.overall` | ResultBean |  |  |
| `trustGraph.riskResults.overall.value` | string |  |  |
| `trustGraph.riskResults.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `trustGraph.riskResults.reasonCategoryScores` | object |  |  |
| `identityCrosscheck` | IdentityCrosscheck |  | Simple identity crosscheck that compare names and dates of birth from different sources |
| `identityCrosscheck.overall` | ResultBean |  | Overall validation result |
| `identityCrosscheck.overall.value` | string |  |  |
| `identityCrosscheck.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `identityCrosscheck.checks` | object |  | Individual validation checks |
| `identityCrosscheck.riskLevel` | string |  | Risk level assessment |
| `invoiceValidation` | Invoice |  | Analysis of invoice data |
| `invoiceValidation.overall` | ResultBean |  |  |
| `invoiceValidation.overall.value` | string |  |  |
| `invoiceValidation.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `invoiceValidation.checks` | object |  |  |
| `idValidationDeepCheck` | IdValidationDeepCheckScore |  | Asynchronous secondary ID validation deep check |
| `idValidationDeepCheck.overall` | ResultBean |  |  |
| `idValidationDeepCheck.overall.value` | string |  |  |
| `idValidationDeepCheck.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `autopilot` | AutopilotDto |  | Autopilot is a machine learning based score |
| `autopilot.overall` | ResultBean |  |  |
| `autopilot.overall.value` | string |  |  |
| `autopilot.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `autopilot.failedFeatures` | array[string] |  | Deprecated; use failedFeatureDetails. |
| `autopilot.legitFeatures` | array[string] |  | Deprecated; use legitFeatureDetails. |
| `autopilot.failedFeatureDetails` | array[AutopilotFeatureDetail] |  |  |
| `autopilot.failedFeatureDetails.code` | string |  |  |
| `autopilot.failedFeatureDetails.description` | string |  |  |
| `autopilot.legitFeatureDetails` | array[AutopilotFeatureDetail] |  |  |
| `autopilot.legitFeatureDetails.code` | string |  |  |
| `autopilot.legitFeatureDetails.description` | string |  |  |
| `autopilot.responseText` | string |  |  |
| `autopilot.responseCategory` | string |  |  |
| `overall` | ResultBean |  | Composite result for previous sections |
| `overall.value` | string |  |  |
| `overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 403

Forbidden - Score retrieval is disabled for this organization for session users.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/score?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "authentication": {
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "identityId": "string",
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    }
  },
  "idValidation": {
    "photoSecurityAndQuality": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "idSpecific": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "customFields": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "antifraud": {
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "secondIdValidation": {
    "photoSecurityAndQuality": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "idSpecific": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "customFields": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "liveness": {
    "hasHeadCover": {
      "value": "string",
      "status": "OK"
    },
    "hasClosedEyes": {
      "value": "string",
      "status": "OK"
    },
    "physicalAttack": {
      "value": "string",
      "status": "OK"
    },
    "digitalAttack": {
      "value": "string",
      "status": "OK"
    },
    "evasionAttack": {
      "value": "string",
      "status": "OK"
    },
    "deepfakeAttack": {
      "value": "string",
      "status": "OK"
    },
    "digitalManipulationAttack": {
      "value": "string",
      "status": "OK"
    },
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    },
    "spoofDetectionMethod": "SF",
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "livenessScore": {
      "value": "string",
      "status": "OK"
    }
  },
  "deepsight": {
    "multimodalIntelligence": {
      "physicalAttack": {
        "value": "string",
        "status": "OK"
      },
      "digitalAttack": {
        "value": "string",
        "status": "OK"
      },
      "deepfakeAttack": {
        "value": "string",
        "status": "OK"
      },
      "digitalManipulationAttack": {
        "value": "string",
        "status": "OK"
      },
      "evasionAttack": {
        "value": "string",
        "status": "OK"
      },
      "spoofDetectionMethod": "SF",
      "faceExplanation": {
        "description": "string",
        "keywords": {
          "category": "string",
          "isDepthFlat": true,
          "isVideoCorrupted": true
        }
      },
      "faceOverall": {
        "value": "string",
        "status": "OK"
      },
      "aiGeneratedDocument": {
        "value": "string",
        "status": "OK"
      },
      "visualAnomaly": {
        "value": "string",
        "status": "OK"
      },
      "documentOverall": {
        "value": "string",
        "status": "OK"
      },
      "overall": {
        "value": "string",
        "status": "OK"
      }
    },
    "deviceTrust": {
      "overall": {
        "value": "string",
        "status": "OK"
      }
    },
    "behavioralTrust": {
      "overall": {
        "value": "string",
        "status": "OK"
      }
    },
    "cameraTrust": {
      "overall": {
        "value": "string",
        "status": "OK"
      }
    },
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    }
  },
  "faceCaptureAssessment": {
    "faceAttributes": {
      "maskCheck": {
        "value": "string",
        "status": "OK"
      },
      "lensesCheck": {
        "value": "string",
        "status": "OK"
      },
      "hasHeadCover": {
        "value": "string",
        "status": "OK"
      },
      "hasClosedEyes": {
        "value": "string",
        "status": "OK"
      },
      "faceOcclusion": {
        "value": "string",
        "status": "OK"
      }
    },
    "qualityChecks": {
      "faceBrightness": {
        "value": "string",
        "status": "OK"
      },
      "imageQuality": {
        "value": "string",
        "status": "OK"
      }
    }
  },
  "faceRecognition": {
    "existingUser": true,
    "customerId": "string",
    "existingInterviewId": "string",
    "existingExternalId": "string",
    "maskCheck": {
      "value": "string",
      "status": "OK"
    },
    "lensesCheck": {
      "value": "string",
      "status": "OK"
    },
    "faceBrightness": {
      "value": "string",
      "status": "OK"
    },
    "imageQuality": {
      "value": "string",
      "status": "OK"
    },
    "nameMatch": {
      "value": "string",
      "status": "OK"
    },
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "hasHeadCover": {
      "value": "string",
      "status": "OK"
    },
    "hasClosedEyes": {
      "value": "string",
      "status": "OK"
    },
    "faceOcclusion": {
      "value": "string",
      "status": "OK"
    }
  },
  "faceRecognitionSecondId": {
    "existingUser": true,
    "customerId": "string",
    "existingInterviewId": "string",
    "existingExternalId": "string",
    "maskCheck": {
      "value": "string",
      "status": "OK"
    },
    "lensesCheck": {
      "value": "string",
      "status": "OK"
    },
    "faceBrightness": {
      "value": "string",
      "status": "OK"
    },
    "imageQuality": {
      "value": "string",
      "status": "OK"
    },
    "nameMatch": {
      "value": "string",
      "status": "OK"
    },
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "hasHeadCover": {
      "value": "string",
      "status": "OK"
    },
    "hasClosedEyes": {
      "value": "string",
      "status": "OK"
    },
    "faceOcclusion": {
      "value": "string",
      "status": "OK"
    }
  },
  "externalFaceMatchScore": {
    "faceMaskCheck": {
      "value": "string",
      "status": "OK"
    },
    "lensesCheck": {
      "value": "string",
      "status": "OK"
    },
    "headCoverCheck": {
      "value": "string",
      "status": "OK"
    },
    "closedEyeCheck": {
      "value": "string",
      "status": "OK"
    },
    "imageQualityCheck": {
      "value": "string",
      "status": "OK"
    },
    "faceOccluded": {
      "value": "string",
      "status": "OK"
    },
    "vsIdMatch": {
      "value": "string",
      "status": "OK"
    },
    "vsSelfieMatch": {
      "value": "string",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "governmentValidation": {
    "recognitionConfidence": {
      "value": "string",
      "status": "OK"
    },
    "fingerprintConfidence": {
      "value": "string",
      "status": "OK"
    },
    "minimumPassingFingerprints": 0,
    "validationStatus": {
      "value": "string",
      "status": "OK",
      "key": "string"
    },
    "ocrValidation": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "credentialStatus": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "registryData": {
      "taxIdNumber": 20123456785
    },
    "ocrValidationOverall": {
      "value": "string",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "provider": "string",
    "validationSource": "ID_CAPTURE",
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    }
  },
  "videoConference": {
    "speechTranscript": "string",
    "speechTranscriptWhisper": "string",
    "videoSelfieLiveness": {
      "value": "string",
      "status": "OK"
    },
    "videoSelfieFaceRecognition": {
      "value": "string",
      "status": "OK"
    },
    "speechRecognition": {
      "value": "string",
      "status": "OK"
    },
    "score": {
      "value": "string",
      "status": "OK"
    },
    "appliedRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK"
    }
  },
  "curpVerification": {
    "success": true,
    "curp": "string",
    "sex": "Mujer",
    "nationality": "string",
    "result": "string",
    "transactionId": "string",
    "renapo_valid": true,
    "names": "string",
    "paternal_surname": "string",
    "mothers_maiden_name": "string",
    "birthdate": "string",
    "entity_birth": "string",
    "probation_document": "string",
    "probation_document_data": {},
    "status_curp": "string",
    "deceasedStatus": "string"
  },
  "ineScrapingValidation": {
    "get_version": 0,
    "scrapingStatus": "IN_PROGRESS",
    "success": true,
    "result": "success",
    "resultDetails": "string",
    "screenshotUrl": "string",
    "cic": "string",
    "claveElector": "string",
    "numeroEmision": "string",
    "ocr": "string",
    "anioRegistro": "string",
    "anioEmision": "string"
  },
  "idOcrConfidence": {
    "overallConfidence": {
      "value": "string",
      "status": "OK"
    }
  },
  "idOcrConfidenceSecondId": {
    "overallConfidence": {
      "value": "string",
      "status": "OK"
    }
  },
  "incodeWatchlistScore": {
    "watchlistScore": {
      "value": "string",
      "status": "OK"
    },
    "dataMatches": [
      "string"
    ],
    "incodeWatchlistId": "string"
  },
  "retryInfo": {
    "failedAttemptsCounter": {},
    "stepsToRetry": [
      "frontId"
    ]
  },
  "documentOnEdgeInfo": {
    "frontDocumentIsOnTheEdge": true,
    "backDocumentIsOnTheEdge": true
  },
  "appliedRule": {
    "name": "string",
    "expression": "string",
    "ruleType": "idValidation",
    "status": "OK"
  },
  "needsReviewReason": "MANUAL_CAPTURE",
  "sessionRecording": {
    "mergedRecordingQualityChecks": {
      "fileIsPresent": "PRESENT",
      "hasVideo": "YES",
      "hasAudio": "YES",
      "fileNotEmpty": "NOT_EMPTY",
      "recordingQuality": {
        "value": "string",
        "status": "OK"
      }
    }
  },
  "trustGraph": {
    "riskResults": {
      "overall": {
        "value": "string",
        "status": "OK"
      },
      "reasonCategoryScores": {}
    }
  },
  "identityCrosscheck": {
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "checks": {},
    "riskLevel": "LOW"
  },
  "invoiceValidation": {
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "checks": {}
  },
  "idValidationDeepCheck": {
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "autopilot": {
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "failedFeatures": [
      "string"
    ],
    "legitFeatures": [
      "string"
    ],
    "failedFeatureDetails": [
      {
        "code": "string",
        "description": "string"
      }
    ],
    "legitFeatureDetails": [
      {
        "code": "string",
        "description": "string"
      }
    ],
    "responseText": "string",
    "responseCategory": "string"
  },
  "overall": {
    "value": "string",
    "status": "OK"
  }
}
```

---

- Path: `api-reference/get-signed-contracts-links`
- URL: https://developer.incode.com/api-reference/get-signed-contracts-links/
- Markdown: https://developer.incode.com/api-reference/get-signed-contracts-links.md
- Endpoint: `GET /omni/get/signed-contracts-links`

# Get signed contracts links

`GET /omni/get/signed-contracts-links`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches temporary link of the signed contracts uploaded for the current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `additionalInformation` | object |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/signed-contracts-links?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "additionalInformation": {
    "document ID1": "Temporary URL to signed document with ID1",
    "document ID2": "Temporary URL to signed document with ID2",
    "document ID3": "Temporary URL to signed document with ID3"
  }
}
```

---

- Path: `api-reference/get-signing-ceremony-url`
- URL: https://developer.incode.com/api-reference/get-signing-ceremony-url/
- Markdown: https://developer.incode.com/api-reference/get-signing-ceremony-url.md
- Endpoint: `GET /omni/get/signing-ceremony-url`

# Get signing ceremony URL

`GET /omni/get/signing-ceremony-url`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches signing ceremony URL for the current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `signingCeremonyUrl` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/signing-ceremony-url?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "signingCeremonyUrl": "https://exaple.com"
}
```

---

- Path: `api-reference/get-user-consent`
- URL: https://developer.incode.com/api-reference/get-user-consent/
- Markdown: https://developer.incode.com/api-reference/get-user-consent.md
- Endpoint: `GET /omni/get/user-consent`

# Get user consent

`GET /omni/get/user-consent`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetches user consent with title, content and status from session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Session id |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `title` | string |  | Title of the consent. |
| `content` | string |  | Text content. |
| `status` | boolean |  | Status |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/get/user-consent?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "title": "string",
  "content": "string",
  "status": true
}
```

---

- Path: `api-reference/getevents`
- URL: https://developer.incode.com/api-reference/getevents/
- Markdown: https://developer.incode.com/api-reference/getevents.md
- Endpoint: `GET /omni/interview-events`

# Fetch interview events

`GET /omni/interview-events`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns the list of all events for given interview

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes |  |
| `offset` | query | integer (int32) |  | Default: `0` |
| `limit` | query | integer (int32) |  | Default: `100` |
| `codes` | query | array[string] |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `events` | array[InterviewEventDto] |  |  |
| `events.id` | string |  |  |
| `events.code` | string |  |  |
| `events.timestamp` | integer (int64) |  |  |
| `events.clientTimestamp` | integer (int64) |  |  |
| `events.module` | string |  |  |
| `events.screen` | string |  |  |
| `events.assetUrl` | string |  |  |
| `events.videoUrl` | string |  |  |
| `events.payload` | object |  |  |
| `more` | boolean |  |  |
| `interviewTotalTimeMillis` | integer (int64) |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/interview-events?interviewId=%3CinterviewId%3E&offset=0&limit=100&codes=%3Ccodes%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "events": [
    {
      "id": "string",
      "code": "string",
      "timestamp": 0,
      "clientTimestamp": 0,
      "module": "string",
      "screen": "string",
      "assetUrl": "string",
      "videoUrl": "string",
      "payload": {}
    }
  ],
  "more": true,
  "interviewTotalTimeMillis": 0
}
```

---

- Path: `api-reference/identity-crosscheck`
- URL: https://developer.incode.com/api-reference/identity-crosscheck/
- Markdown: https://developer.incode.com/api-reference/identity-crosscheck.md
- Endpoint: `POST /omni/identity-crosscheck`

# Identity cross-check comparing account creation data with IDV data

`POST /omni/identity-crosscheck`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Cross-checks name and date of birth from account creation against data extracted during IDV.
Compares the provided data with OCR-extracted data and returns validation score with risk assessment.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Full name from account creation |
| `dateOfBirth` | string | yes | Date of birth in YYYY-MM-DD format |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | string |  | Session ID that was cross-checked |
| `score` | IdentityCrosscheck |  | Identity cross-check score results |
| `score.overall` | ResultBean |  | Overall validation result |
| `score.overall.value` | string |  |  |
| `score.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `score.checks` | object |  | Individual validation checks |
| `score.riskLevel` | string |  | Risk level assessment |
| `success` | boolean |  | Success indicator |
| `errorMessage` | string |  | Error message if cross-check failed |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 404

Session or IDV data not found

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "<name>",
    "dateOfBirth": "<dateOfBirth>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "name": "<name>",
      "dateOfBirth": "<dateOfBirth>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E", headers=headers, json={
  "name": "<name>",
  "dateOfBirth": "<dateOfBirth>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"name\": \"<name>\",\n  \"dateOfBirth\": \"<dateOfBirth>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "name": "<name>",
  "dateOfBirth": "<dateOfBirth>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/identity-crosscheck?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "name": "<name>",
  "dateOfBirth": "<dateOfBirth>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "sessionId": "64a7b8c9d1e2f3g4h5i6j7k8",
  "score": {
    "overall": {
      "value": "string",
      "status": "OK"
    },
    "checks": {},
    "riskLevel": "LOW"
  },
  "success": true,
  "errorMessage": "IDV data not found for session"
}
```

---

- Path: `api-reference/identity-reuse-documents`
- URL: https://developer.incode.com/api-reference/identity-reuse-documents/
- Markdown: https://developer.incode.com/api-reference/identity-reuse-documents.md
- Endpoint: `GET /omni/identity-reuse/documents`

# Get identity reuse documents

`GET /omni/identity-reuse/documents`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns all found identity documents across all candidate identities

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documents` | array[IdentityReuseDocumentDto] |  |  |
| `documents.documentId` | string |  |  |
| `documents.type` | string |  |  |
| `documents.countryCode` | string |  |  |
| `documents.documentNumber` | string |  |  |
| `documents.validatedAt` | string (date-time) |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/identity-reuse/documents \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/identity-reuse/documents", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/identity-reuse/documents", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/identity-reuse/documents"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/identity-reuse/documents")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/identity-reuse/documents");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "documents": [
    {
      "documentId": "string",
      "type": "string",
      "countryCode": "string",
      "documentNumber": "string",
      "validatedAt": "string"
    }
  ]
}
```

---

- Path: `api-reference/identity-reuse-submit`
- URL: https://developer.incode.com/api-reference/identity-reuse-submit/
- Markdown: https://developer.incode.com/api-reference/identity-reuse-submit.md
- Endpoint: `POST /omni/identity-reuse/submit`

# Submit identity reuse decision

`POST /omni/identity-reuse/submit`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Accepts or declines reuse of a previously verified identity, on another organization.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documentId` | string |  |  |
| `accepted` | boolean |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/identity-reuse/submit \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/identity-reuse/submit", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/identity-reuse/submit", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/identity-reuse/submit"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/identity-reuse/submit")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/identity-reuse/submit");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/identity-sessionids`
- URL: https://developer.incode.com/api-reference/identity-sessionids/
- Markdown: https://developer.incode.com/api-reference/identity-sessionids.md
- Endpoint: `GET /omni/identity/{customerId}/sessionIds`

# Fetch all passed onboardings ids for the same person

`GET /omni/identity/{customerId}/sessionIds`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get all passed onboardings ids for the same person

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `customerId` | path | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionIds` | array[string] |  |  |
| `count` | integer (int32) |  |  |
| `initialSessionId` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessionIds");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "sessionIds": [
    "string"
  ],
  "count": 0,
  "initialSessionId": "string"
}
```

---

- Path: `api-reference/identity-sessions`
- URL: https://developer.incode.com/api-reference/identity-sessions/
- Markdown: https://developer.incode.com/api-reference/identity-sessions.md
- Endpoint: `GET /omni/identity/{customerId}/sessions`

# Fetch all passed onboardings for the same person

`GET /omni/identity/{customerId}/sessions`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get all passed onboardings for the same person

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `customerId` | path | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/identity/%3CcustomerId%3E/sessions");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
[
  {
    "get_version": 0,
    "secondDocumentInterviewId": "string",
    "parentInterviewId": "string",
    "name": "string",
    "fullNameMrz": "string",
    "displayName": "string",
    "phone": "string",
    "birthDate": "string",
    "address": "string",
    "location": "string",
    "longitude": 0,
    "latitude": 0,
    "gender": "string",
    "typeOfId": "string",
    "externalId": "string",
    "flowWalletAddress": "string",
    "email": "string",
    "mrz1": "string",
    "mrz2": "string",
    "mrz3": "string",
    "street": "string",
    "colony": "string",
    "postalCode": "string",
    "city": "string",
    "state": "string",
    "stateCode": "string",
    "countryCode": "string",
    "cic": "string",
    "ocr": "string",
    "claveDeElector": "string",
    "numeroEmisionCredencial": "string",
    "personalNumber": "string",
    "nationalNumber": "string",
    "personalIdNumber": "string",
    "taxIdNumber": "string",
    "issueFront": 0,
    "issueBack": 0,
    "issuingCountry": "string",
    "registrationDate": 0,
    "documentId": "string",
    "deviceType": "IOS",
    "height": "string",
    "birthPlace": "string",
    "bloodType": "string",
    "curp": "string",
    "recognitionConfidence": 0,
    "nfcRecognitionConfidence": {
      "nfcVsSelfieConfidence": 0,
      "nfcVsSelfieLogConfidence": 0,
      "nfcVsIdConfidence": 0,
      "nfcVsIdLogConfidence": 0
    },
    "spoofConfidence": 0,
    "idValidationScore": "string",
    "tamperedConfidence": 0,
    "tamperedModelVersion": "string",
    "fakeIdConfidence": 0,
    "retouchFrontConfidence": 0,
    "frontClassification": "Unknown",
    "backClassification": "Unknown",
    "frontIdFaceCount": 0,
    "manualIdCheckNeeded": true,
    "manualSelfieCheckNeeded": true,
    "frontSharpness": 0,
    "frontGlare": 0,
    "frontHorizontalResolution": 0,
    "frontShadowConfidence": 0,
    "frontPerFieldReadability": 0,
    "backSharpness": 0,
    "backGlare": 0,
    "backHorizontalResolution": 0,
    "backShadowConfidence": 0,
    "backPerFieldReadability": 0,
    "issueDate": 0,
    "expirationDate": 0,
    "qr": true,
    "manualCorrectionBy": "string",
    "waitingTime": 0,
    "logRecognitionConfidence": 0,
    "readabilityConfidence": 0,
    "frontSeccion": "string",
    "printingNumber": "string",
    "duplicateNumber": "string",
    "preparationNumber": "string",
    "confSelfieConfidence": 0,
    "confSelfieLogConfidence": 0,
    "confFrontIDConfidence": 0,
    "confFrontIDLogConfidence": 0,
    "notes": "string",
    "tags": [
      "string"
    ],
    "croppedIDFaceRef": "string",
    "croppedNfcFaceRef": "string",
    "fullFrameFrontIDRef": "string",
    "fullFrameBackIDRef": "string",
    "croppedFrontIDRef": "string",
    "croppedBackIDRef": "string",
    "croppedFaceRef": "string",
    "confSelfieRef": "string",
    "confFrontIDRef": "string",
    "confBackIDRef": "string",
    "additionalNames": [
      {
        "refNumber": 0,
        "name": "string"
      }
    ],
    "additionalAttrs": [
      "DOCUMENTO_INFANTIL"
    ],
    "additionalTimestamps": [
      {
        "dateType": "string",
        "timestamp": 0
      }
    ],
    "religion": "string",
    "customFields": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "customFieldsValid": [
      {
        "key": "string",
        "value": true
      }
    ],
    "expirationDateCheckDigit": "string",
    "streetName": "string",
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "district": "string",
    "addressCountryCode": "string",
    "issuerCode": "string",
    "redirectionUrl": "string",
    "maritalStatus": "string",
    "race": "string",
    "notExtractedDetails": [
      "string"
    ],
    "issuingAuthority": "string",
    "qrContents": [
      "string"
    ],
    "qrFrontContents": [
      "string"
    ],
    "qrBackContents": [
      "string"
    ],
    "conferenceFeedback": "string",
    "barcodeRawData": "string",
    "nameParsed": true,
    "backClassificationFailReason": "UNKNOWN_DOCUMENT_TYPE",
    "nameBean": {
      "fullName": "string",
      "fullNameNativeScript": "string",
      "firstNameNativeScript": "string",
      "paternalLastNameNativeScript": "string",
      "maternalLastNameNativeScript": "string",
      "machineReadableFullName": "string",
      "firstName": "string",
      "middleName": "string",
      "givenName": "string",
      "givenNameMrz": "string",
      "initials": "string",
      "nameSuffix": "string",
      "paternalLastName": "string",
      "maternalLastName": "string",
      "lastNameMrz": "string",
      "familyName": "string"
    },
    "backTypeOfId": "string",
    "documentFrontSubtype": "string",
    "documentFrontState": "string",
    "documentBackSubtype": "string",
    "documentBackState": "string",
    "documentNumberCheckDigit": "string",
    "dateOfBirthCheckDigit": "string",
    "expireAt": "string",
    "issuedAt": "string",
    "issuingCountryBack": "string",
    "finishStatus": true,
    "videoSelfieTypeOfIdMatch": true,
    "videoSelfieBackTypeOfIdMatch": true,
    "videoSelfieFaceMatched": true,
    "videoSelfieNameOcrMatched": true,
    "videoSelfieBacksideOcrMatched": true,
    "videoSelfieVoiceConsentFaceMatched": true,
    "vendorValidationScore": 0,
    "videoSelfieRecognitionConfidence": 0,
    "videoSelfieLogRecognitionConfidence": 0,
    "videoSelfieSpoofConfidence": 0,
    "paperConfidence": 0,
    "screenConfidence": 0,
    "screenModelVersion": "string",
    "paperModelVersion": "string",
    "idAlterationConfidence": 0,
    "frontClassificationFailReason": "UNKNOWN_DOCUMENT_TYPE",
    "frontCroppingError": "ID_IS_CUT",
    "backCroppingError": "ID_IS_CUT",
    "frontSharpnessSource": "ML_BACKEND",
    "frontGlareSource": "ML_BACKEND",
    "backSharpnessSource": "ML_BACKEND",
    "backGlareSource": "ML_BACKEND",
    "isRealId": true,
    "barcodeMeta": {
      "ecLevel": 0,
      "noSegments": 0,
      "segmentWidth": 0,
      "corners": [
        {
          "x": 0,
          "y": 0
        }
      ],
      "cornersFullFrame": [
        {
          "x": 0,
          "y": 0
        }
      ],
      "rawBytes": "string",
      "pdf417RowNumber": 0,
      "pdf417ColumnNumber": 0,
      "pdf417CodewordLengthMin": 0,
      "pdf417CodewordLengthMax": 0,
      "pdf417CorrectedErrorsCount": 0
    },
    "barcodeReader": "string",
    "barcodeSignatureVerified": true,
    "fullFrameFrontIDRefs": [
      {
        "imageRef": "string",
        "timestamp": 0,
        "exifMetadata": {
          "timestampOriginal": 0,
          "software": "string"
        }
      }
    ],
    "fullFrameBackIDRefs": [
      {
        "imageRef": "string",
        "timestamp": 0,
        "exifMetadata": {
          "timestampOriginal": 0,
          "software": "string"
        }
      }
    ],
    "refCroppedFrontIDRef": "string",
    "refCroppedBackIDRef": "string",
    "croppedOriginalFrontIDRef": "string",
    "croppedOriginalBackIDRef": "string",
    "voiceConsentSelfieRefs": [
      {
        "imageRef": "string",
        "timestamp": 0,
        "confidence": 0,
        "threshold": 0
      }
    ],
    "voiceConsentSelfieRef": "string",
    "originalNfcFaceRef": "string",
    "confPoaRef": "string",
    "idSegmentImagesRefs": {},
    "ocrResultsId": "string",
    "interviewerId": "string",
    "interviewerName": "string",
    "interviewSessionId": "string",
    "interviewCode": "string",
    "oldInterviewId": "string",
    "externalCustomerId": "string",
    "nue": "string",
    "nss": "string",
    "sessionStatus": "Alive",
    "closedAt": 0,
    "deletedAt": 0,
    "speechOpentokSessionId": "string",
    "speechOpentokArchiveId": "string",
    "speechOffset": 0,
    "language": "string",
    "signingCeremonyUrl": "string",
    "videoSelfieFileIsPresent": "PRESENT",
    "videoSelfieHasVideo": "YES",
    "videoSelfieHasAudio": "YES",
    "videoSelfieFileNotEmpty": "NOT_EMPTY",
    "videoWidth": 0,
    "videoHeight": 0,
    "videoBitRate": 0,
    "videoDuration": 0,
    "videoQuality": true,
    "speechTranscript": "string",
    "speechTranscriptWhisper": "string",
    "processSpeechResultWhisper": true,
    "processSpeechResult": true,
    "processSpeechResultGoogleLLM": true,
    "sessionRecordingRefs": {},
    "additionalDocumentAttempts": [
      {
        "documentType": "ASYLUM_SEEKER",
        "format": "IMAGE",
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "classificationConfidence": 0,
        "image": {
          "imageRef": "string",
          "timestamp": 0,
          "exifMetadata": {
            "timestampOriginal": 0,
            "software": "string"
          }
        },
        "multiPageDocImages": [
          {
            "imageRef": "string",
            "timestamp": 0,
            "exifMetadata": {
              "timestampOriginal": null,
              "software": null
            }
          }
        ],
        "attemptType": "POA",
        "antiSpoofResult": {
          "status": "PASS",
          "kinds": [
            "string"
          ],
          "confidence": 0,
          "details": [
            {
              "kind": null,
              "error": null,
              "loc": null,
              "explanation": null
            }
          ]
        },
        "firstName": "string",
        "lastName": "string",
        "countryOfOrigin": "string",
        "dateOfBirth": 0,
        "expiryDate": 0,
        "issueDate": 0,
        "gender": "MALE",
        "nationality": "string",
        "placeOfIssue": "string",
        "referenceNumber": "string",
        "residentialAddressLines": [
          "string"
        ]
      }
    ],
    "poaName": "string",
    "proofOfAddress": "string",
    "proofOfAddressScore": 0,
    "addressStatementTimestamp": 0,
    "addressStatementTimestamps": [
      {
        "get_version": 0,
        "dateType": "string",
        "addressStatementTimestamp": 0
      }
    ],
    "documentType": "aysa",
    "poaFields": {
      "street": "string",
      "streetName": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string",
      "exteriorNumber": "string",
      "interiorNumber": "string",
      "addressLine1": "string",
      "streetType": "string"
    },
    "poaSuccessfullyClassified": true,
    "fullAddress": true,
    "checkedAddress": "string",
    "checkedAddressBean": {
      "street": "string",
      "streetName": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string",
      "exteriorNumber": "string",
      "interiorNumber": "string",
      "addressLine1": "string",
      "streetType": "string"
    },
    "classifier": "INCODE",
    "bankLoginSuccess": true,
    "governmentRecognitionConfidence": 0,
    "governmentRecognitionConfidence2": 0,
    "governmentFingerprintConfidence": {
      "finger1": 0,
      "finger2": 0,
      "finger3": 0,
      "finger4": 0,
      "finger5": 0,
      "finger6": 0,
      "finger7": 0,
      "finger8": 0,
      "finger9": 0,
      "finger10": 0
    },
    "governmentValidationStatus": "PROCESSING",
    "governmentRecognitionThreshold": 0,
    "registralSituation": {
      "tipoSituacionRegistral": "string",
      "tipoReporteRoboExtravio": "string"
    },
    "curpCecobanValidation": {
      "returnCode": "string",
      "description": "string",
      "uniquePopulationRegistrationKeyMatch": true
    },
    "ineTransactionId": "string",
    "existingUser": true,
    "nameMatched": true,
    "existingInterviewId": "string",
    "existingExternalId": "string",
    "customerId": "string",
    "parentCustomerId": "string",
    "incodeIdCustomer": "string",
    "faceAuthCustomerId": "string",
    "incodeIdConsentGiven": true,
    "onlyFront": true,
    "onlyBack": true,
    "forceBackForDob": true,
    "hasNfcChip": true,
    "barcodeCapture": true,
    "usSmartCapture": true,
    "alignment": true,
    "frontAlignment": true,
    "frontAlignmentForced": true,
    "backAlignmentForced": true,
    "alreadyApprovedCustomerConfidence": 0,
    "punchedHolesConfidence": 0,
    "fakeIdInternalConfidence": 0,
    "mandatoryConsentGiven": true,
    "frontDocumentIsOnTheEdge": true,
    "backDocumentIsOnTheEdge": true,
    "backAlignment": true,
    "surveyData": "string",
    "frontIdAttempts": 0,
    "backIdAttempts": 0,
    "selfieAttempts": 0,
    "authenticationAttempts": 0,
    "onboardingAttempts": 0,
    "sessionContinuationCount": 0,
    "failedAttemptsCounter": {},
    "idValidationFinished": true,
    "faceValidationFinished": true,
    "idFaceExtractionSkipped": true,
    "faceMatchingType": "selfieVsId",
    "partialOnboarding": true,
    "frontCaptureRedacted": true,
    "backCaptureRedacted": true,
    "multipleDocumentsInFrame": true,
    "callbackUrl": "string",
    "governmentValidationFinished": true,
    "conferenceStatus": "NO_CONFERENCE",
    "termsAccepted": true,
    "creditBureauConsentGiven": true,
    "applicantDataConfirmed": true,
    "configurationId": "string",
    "configurationName": "string",
    "configurationVersion": 0,
    "flowType": "configuration",
    "queueName": "string",
    "gdcAddressScore": "FullMatch",
    "gdcIdentityScore": "FullMatch",
    "subscribedToWatchlistUpdates": true,
    "onboardingStatus": "UNKNOWN",
    "deletedWithMode": "BIOMETRICS",
    "retentionRegion": {
      "ipRegion": "string",
      "ocrRegion": "string"
    },
    "onboardingCompleteTimestamp": 0,
    "sessionExpiredAt": 0,
    "loginHint": "string",
    "authUuid": "string",
    "integrationReference": "string",
    "validationArchiveRef": "string",
    "validationArchiveNom151": "string",
    "selfieRef": "string",
    "selfieRefs": [
      {
        "imageRef": "string",
        "timestamp": 0,
        "exifMetadata": {
          "timestampOriginal": 0,
          "software": "string"
        }
      }
    ],
    "sorSelfieRef": "string",
    "videoSelfieRef": "string",
    "documentRef": "string",
    "documentRefs": [
      {
        "imageRef": "string",
        "timestamp": 0,
        "exifMetadata": {
          "timestampOriginal": 0,
          "software": "string"
        }
      }
    ],
    "signatureRef": "string",
    "initialsRef": "string",
    "secondIdRef": "string",
    "thirdIdRef": "string",
    "medicalDocImgRef": "string",
    "videoSelfieCompareIDRef": "string",
    "videoSelfieCompareOcrRef": "string",
    "videoSelfieCompareBackIDRef": "string",
    "videoSelfieCompareBackOcrRef": "string",
    "otherDocument1Ref": "string",
    "otherDocument2Ref": "string",
    "otherDocument3Ref": "string",
    "paymentProofRef": "string",
    "consentRef": "string",
    "renaperCroppedRef": "string",
    "signatureRefs": [
      {
        "imageRef": "string",
        "signatureType": "string"
      }
    ],
    "initialsRefs": [
      {
        "imageRef": "string",
        "signatureType": "string"
      }
    ],
    "contractRefs": [
      "string"
    ],
    "signedContractRefs": [
      "string"
    ],
    "governmentValidationProvider": "QUERTIUM",
    "governmentValidationWorkflow": "string",
    "governmentValidationShadowMode": true,
    "governmentValid": true,
    "governmentValidationResponse": {},
    "governmentValidationRequest": {},
    "paternalLastNameValid": true,
    "maternalLastNameValid": true,
    "firstNameValid": true,
    "middleNameValid": true,
    "suffixNameValid": true,
    "fullNameValid": true,
    "curpValid": true,
    "ineCurpValid": true,
    "curpValidationResponse": {
      "success": true,
      "curp": "string",
      "sex": "Mujer",
      "nationality": "string",
      "result": "string",
      "transactionId": "string",
      "renapo_valid": true,
      "names": "string",
      "paternal_surname": "string",
      "mothers_maiden_name": "string",
      "birthdate": "string",
      "entity_birth": "string",
      "probation_document": "string",
      "probation_document_data": {},
      "status_curp": "string",
      "deceasedStatus": "string"
    },
    "curpDataMatch": true,
    "renapoCurp": "string",
    "ineScrapingValid": true,
    "ineValidationResponse": {
      "get_version": 0,
      "scrapingStatus": "IN_PROGRESS",
      "success": true,
      "result": "success",
      "resultDetails": "string",
      "screenshotUrl": "string",
      "cic": "string",
      "claveElector": "string",
      "numeroEmision": "string",
      "ocr": "string",
      "anioRegistro": "string",
      "anioEmision": "string"
    },
    "fiscalQrUrlResponse": {
      "success": true,
      "sessionStatus": "Alive",
      "rfc": "string",
      "curp": "string",
      "name": "string",
      "firstLastName": "string",
      "secondLastName": "string",
      "birthdate": "string",
      "denomination": "string",
      "regime": "string",
      "constitutionDate": "string",
      "operationStartDate": "string",
      "personStatus": "string",
      "lastSituationChangeDate": "string",
      "state": "string",
      "delegation": "string",
      "colony": "string",
      "streetType": "string",
      "streetName": "string",
      "extNumber": "string",
      "intNumber": "string",
      "postalCode": "string",
      "email": "string",
      "al": "string",
      "fiscalRegime": "string",
      "fiscalStartDate": "string",
      "error": "string",
      "result": "string"
    },
    "ocrValid": true,
    "claveDeElectorValid": true,
    "numeroEmisionCredencialValid": true,
    "registrationDateValid": true,
    "issueDateValid": true,
    "birthDateValid": true,
    "documentNumberValid": true,
    "sexValid": true,
    "heightValid": true,
    "weightValid": true,
    "eyeColorValid": true,
    "addressValid": true,
    "addressLine2Valid": true,
    "cityValid": true,
    "stateCodeValid": true,
    "zipCodeValid": true,
    "genderValid": true,
    "personalNumberValid": true,
    "placeOfBirthValid": true,
    "expirationDateValid": true,
    "totalScore": 0,
    "livenessScore": 0,
    "faceRecognitionScore": 0,
    "incodeIdValidationScore": 0,
    "idOcrValidationScore": 0,
    "governmentScore": 0,
    "videoConferenceScore": 0,
    "totalScoreStatus": "OK",
    "livenessScoreStatus": "OK",
    "faceRecognitionScoreStatus": "OK",
    "incodeIdValidationScoreStatus": "OK",
    "idOcrValidationScoreStatus": "OK",
    "governmentScoreStatus": "OK",
    "videoConferenceStatus": "OK",
    "customWatchlistModuleEnabled": true,
    "incodeWatchlistScore": 0,
    "watchlistDataMatches": [
      "string"
    ],
    "incodeWatchlistId": "string",
    "externalVerificationRequest": {
      "plugins": [
        "string"
      ],
      "source": "US_DRIVERS_LICENSE_1",
      "fullName": "string",
      "firstName": "string",
      "middleName": "string",
      "surName": "string",
      "email": "string",
      "street": "string",
      "houseNo": "string",
      "postalCode": "string",
      "countryCode": "string",
      "phone": "string",
      "state": "string",
      "city": "string",
      "ssn": "string",
      "dateOfBirth": "string",
      "ipAddress": "string",
      "taxIdStatus": "string",
      "nationality": "string",
      "dlNumber": "string",
      "dlExpireAt": "string",
      "dlState": "string",
      "last4SSN": "string",
      "idNumber": "string",
      "panNumber": "string"
    },
    "premiumExternalVerification": {
      "level": "string",
      "verifications": {},
      "income": {
        "status": "string",
        "range": "string"
      },
      "employment": {
        "status": "string",
        "type": "string",
        "sector": "string"
      },
      "reasonCodes": [
        {
          "key": "string",
          "reasonCodes": [
            {
              "reasonCode": null,
              "description": null
            }
          ]
        }
      ],
      "additionalVerificationInfo": {
        "creditFileDetails": {
          "creditFileNumber": "string",
          "creditFileCreationDate": "string"
        }
      }
    },
    "externalVerificationThirdPartyRequest": {},
    "externalVerificationThirdPartyResponse": {},
    "businessVerificationRequest": {
      "plugins": [
        "string"
      ],
      "businessName": "string",
      "addressLine1": "string",
      "street": "string",
      "houseNo": "string",
      "addressLine2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "US",
      "taxId": "string",
      "uboNames": [
        "string"
      ],
      "directors": [
        "string"
      ]
    },
    "businessVerification": {
      "businessName": "string",
      "businessClassification": "string",
      "addressVerification": "string",
      "cityVerification": "string",
      "postalCodeVerification": "string",
      "stateVerification": "string",
      "addressPropertyType": "string",
      "addressDeliverability": "string",
      "tinVerification": "string",
      "uboNameMatch": "string",
      "registrationStatus": "Active",
      "entityType": {
        "entityType": "string"
      },
      "verificationMessages": {
        "tinVerificationMessage": "string"
      },
      "uboNameVerificationResults": [
        {
          "name": "string",
          "uboNameMatch": "string",
          "matchId": "string",
          "ownershipPercentage": "string"
        }
      ],
      "directorsVerificationResults": [
        {
          "name": "string",
          "uboNameMatch": "string",
          "matchId": "string",
          "ownershipPercentage": "string"
        }
      ],
      "people": [
        {
          "name": "string",
          "titles": [
            {
              "title": null
            }
          ],
          "memberType": "string"
        }
      ]
    },
    "bavHolders": [
      {
        "holder": "string",
        "id": "string",
        "balance": 0,
        "currency": "string",
        "address": "string",
        "timestamp": 0
      }
    ],
    "bavLinkId": "string",
    "bavNumberOfRetries": 0,
    "rfc": "string",
    "rfcValidationResponse": {
      "validRFC": true,
      "status": "string",
      "message": "string",
      "rfcType": "string",
      "messageCode": "string",
      "errorMessage": "string",
      "rfcMessageCode": "RFC_VALID"
    },
    "federalRevenueNumber": "string",
    "mothersName": "string",
    "mothersIdNumber": "string",
    "originDocumentId": "string",
    "fathersName": "string",
    "fathersIdNumber": "string",
    "spouseName": "string",
    "driversLicenseCategory": "string",
    "controlNumber": "string",
    "renach": "string",
    "eyeColor": "string",
    "classes": "string",
    "cond": "string",
    "mentions": "string",
    "refNumber": "string",
    "familyNumber": "string",
    "restrictions": "string",
    "weight": "string",
    "hairColor": "string",
    "nationality": "string",
    "nationalityMrz": "string",
    "nationalityAlpha3": "string",
    "jurisdictionCode": "string",
    "medicalOcrData": [
      {
        "key": "string",
        "value": {}
      }
    ],
    "interviewRejected": true,
    "approvalSource": "AUTOAPPROVE",
    "manualReviewStatus": "UNSET",
    "manualReviewReasons": [
      "string"
    ],
    "manualReviewComment": "string",
    "faceLenses": true,
    "hasFaceClosedEyes": true,
    "hasFaceHeadCover": true,
    "hasFaceMask": true,
    "faceIsBright": true,
    "faceAge": 0,
    "hasVideoSelfieLenses": true,
    "hasVideoSelfieClosedEyes": true,
    "hasVideoSelfieHeadCover": true,
    "hasVideoSelfieMask": true,
    "digitalAttack": true,
    "digitalAttackSeverity": "ultra low",
    "digitalAttackVersion": "string",
    "evasionAttack": true,
    "evasionAttackSeverity": "ultra low",
    "evasionAttackVersion": "string",
    "spoofDetectionResult": {
      "overallConfidence": 0,
      "isSpoof": true,
      "status": "passed",
      "physicalAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "digitalAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "evasionAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "motionAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "deepfakeAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "digitalManipulationAttack": {
        "confidence": 0,
        "isSpoof": true,
        "status": "passed",
        "severity": "ultra low",
        "version": "string",
        "checkName": "physicalAttack",
        "reason": "FACE_CROPPING_FAILURE"
      },
      "mediaQualityResults": [
        {
          "modality": "depth",
          "name": "depthQuality",
          "result": "passed",
          "parameters": "string"
        }
      ],
      "options": {
        "cameraFacingMode": "FRONTAL",
        "source": "MOBILE",
        "enforceQSV": true,
        "strictVideoChecks": true
      },
      "method": "SINGLE_FRAME",
      "explanation": {
        "description": "string",
        "keywords": {
          "category": "string",
          "isDepthFlat": true,
          "isVideoCorrupted": true
        }
      },
      "spoofDetectionErrorDetails": {
        "error": "BAD_REQUEST",
        "detailMessage": "string"
      }
    },
    "faceCaptureAttemptId": "string",
    "faceCaptureRecordingAttemptId": "string",
    "videoSelfieCaptureAttemptId": "string",
    "authenticationAttemptId": "string",
    "onboardingAttemptId": "string",
    "frontIdCaptureMetadata": {
      "timestamp": 0,
      "sdkPlatform": "WEBAPP",
      "sdkVersion": "string",
      "callerId": "string",
      "device": {
        "kind": "MOBILE",
        "model": "string",
        "os": "string",
        "osVersion": "string",
        "screenDimensions": {
          "width": 0,
          "height": 0
        },
        "numTouchPoints": 0,
        "fingerprintHash": "string",
        "ip": "string",
        "backgroundMode": true,
        "hookDetected": true,
        "emulatorDetected": true,
        "rootDetected": true,
        "virtualEnvironmentDetected": true,
        "jailbreakDetectionDisabled": true
      },
      "browser": {
        "userAgent": "string",
        "getUserMediaAvailability": {
          "webkit": true,
          "mozilla": true,
          "opera": true,
          "microsoft": true
        },
        "webglFingerprint": "string",
        "inspectorOpened": true,
        "isMockedBrowser": true
      },
      "camera": {
        "facingMode": "FRONTAL",
        "settings": {},
        "capabilities": {},
        "labels": [
          "string"
        ]
      },
      "iad": {
        "isDeepsightEnabled": true,
        "deepsightLiveness": "SINGLE_FRAME",
        "zoomCheck": "PASS",
        "exposureCompensationCheck": "PASS",
        "cctCheck": "PASS",
        "genericCheck": "PASS",
        "mobileTemporalCheck": "PASS",
        "contrastSharpnessSaturationCheck": "PASS",
        "frontBackCameraCheck": "PASS",
        "frameDuplicationCheck": "PASS",
        "exposureCheck": "PASS",
        "replayAttackCheck": "PASS",
        "environmentIntegrityCheck": "PASS",
        "extendedDeviceAndBrowserClassificationData": {},
        "deviceEmulationCheck": "PASS",
        "contrastSharpnessSaturationData": {
          "initialValues": {
            "contrast": 0,
            "sharpness": 0,
            "saturation": 0,
            "metrics": 0,
            "isTimeoutReached": true,
            "framePixelDelta": 0
          },
          "appliedValues": [
            {
              "contrast": null,
              "sharpness": null,
              "saturation": null,
              "metrics": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ]
        },
        "genericInjectionData": {
          "streamInitializationTime": [
            0
          ],
          "timeToFirstFrame": [
            0
          ],
          "appliedConstraints": {},
          "isTimeoutReached": true,
          "sitAborted": true,
          "warmInitializationTime": 0
        },
        "iosInjectionData": {
          "createStreamTime": [
            0
          ],
          "frameStats": [
            {
              "frameCount": null,
              "isBlack": null,
              "isUnique": null,
              "timestamp": null,
              "updatedPercentage": null
            }
          ],
          "appliedConstraints": {},
          "isTimeoutReached": true
        },
        "cctInjectionData": {
          "initialCct": 0,
          "minColorTemperatureParameters": [
            {
              "value": null,
              "applicationTime": null,
              "appliedConstraints": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ],
          "maxColorTemperatureParameters": [
            {
              "value": null,
              "applicationTime": null,
              "appliedConstraints": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ]
        },
        "androidInjectionData": {
          "constraintsApplicationTime": [
            0
          ],
          "appliedConstraints": [
            {}
          ]
        },
        "frontBackCameraData": {
          "cameraCheckData": [
            {
              "type": null,
              "isAvailable": null,
              "faceDetected": null,
              "idDetected": null,
              "isTimeoutReached": null
            }
          ],
          "phashMinRotHamming": 0,
          "colorHistChiSqr": 0,
          "noiseMaeRatio": 0,
          "noiseDistroChiSqr": 0,
          "initialFrameCount": 0,
          "oppositeFrameCount": 0,
          "oppositeWithinPhashHammingMean": 0,
          "oppositeWithinPhashHammingMax": 0,
          "oppositeWithinNoiseMaeStdev": 0,
          "oppositeWithinBrightnessStdev": 0,
          "crossPhashHammingMean": 0,
          "crossPhashHammingMin": 0,
          "crossPhashHammingMax": 0,
          "crossColorHistChiSqrMean": 0,
          "crossNoiseMaeDelta": 0,
          "crossNoiseDistroChiSqrMean": 0,
          "crossBrightnessDelta": 0,
          "initialSceneFeatures": [
            0
          ],
          "oppositeSceneFeatures": [
            0
          ],
          "crossSceneFeatureDeltas": [
            0
          ],
          "oppositeTemporalKurtosis": 0,
          "oppositeTemporalKsToGaussian": 0,
          "oppositeTemporalLevelsRatio": 0,
          "oppositeTemporalVarianceMean": 0,
          "oppositeTemporalVarianceStdev": 0,
          "initialDeviceId": "string",
          "oppositeDeviceId": "string",
          "initialGroupId": "string",
          "oppositeGroupId": "string",
          "initialFacingMode": "string",
          "oppositeFacingMode": "string",
          "initialWidth": 0,
          "initialHeight": 0,
          "oppositeWidth": 0,
          "oppositeHeight": 0,
          "initialFrameRate": 0,
          "oppositeFrameRate": 0,
          "deviceIdsDiffer": true,
          "groupIdsMatch": true,
          "experimentIncomplete": true
        },
        "frameDuplicationData": {
          "validDuplicateCount": 0,
          "invalidDuplicateCount": 0,
          "continuousValidDuplicateCount": 0,
          "continuousInvalidDuplicateCount": 0,
          "isTimeoutReached": true,
          "initialDuplicateFramesDetected": true,
          "initialOpenCaptureDuplicateFramesDetected": true,
          "invalidInitialDuplicateFramesDetected": true,
          "continuousDuplicateFramesDetected": true,
          "numInitialDuplicateInstances": 0,
          "numInitialOpenCaptureDuplicateInstances": 0,
          "numInvalidInitialDuplicateInstances": 0,
          "numContinuousDuplicateInstances": 0,
          "preCaptureTotalFrames": 0,
          "preCaptureUniqueHashes": 0,
          "preCaptureMaxConsecutiveRun": 0,
          "preCaptureMaxOccurrenceCount": 0,
          "preCaptureMaxOccurrencePercentage": 0,
          "frameStats": [
            {
              "frameCount": null,
              "isBlack": null,
              "isUnique": null,
              "timestamp": null,
              "updatedPercentage": null
            }
          ],
          "perPhaseStats": [
            {
              "invalidDuplicateCount": null,
              "totalFrames": null,
              "uniqueHashes": null,
              "maxOccurrencePercentage": null
            }
          ]
        },
        "zoomData": {
          "initialConstraints": {},
          "initialZoom": 0,
          "maxZoomParameters": [
            {
              "applicationTime": null,
              "appliedConstraints": null,
              "appliedZoom": null,
              "isTimeoutReached": null
            }
          ],
          "minZoomParameters": [
            {
              "applicationTime": null,
              "appliedConstraints": null,
              "appliedZoom": null,
              "isTimeoutReached": null
            }
          ],
          "zoomInconsistencyDetected": true
        },
        "exposureData": {
          "exposureParams": [
            []
          ],
          "frames": [
            []
          ],
          "sessionDiagnostics": [
            {
              "exposureSupported": null,
              "exposureApplyConstraintError": null,
              "exposureApplyConstraintTimeout": null,
              "invalidTrackStateDetected": null,
              "exposureInconsistencyDetected": null,
              "interruptedCapture": null,
              "cameraCaptureStatus": null,
              "exposureMinDelay": null,
              "exposureInitialDelay": null,
              "baselineBrightness": null
            }
          ]
        },
        "replayAttackData": {
          "collisionCount": 0,
          "isTimeoutReached": true,
          "intraSessionLoop": true,
          "intraSessionLookahead": true,
          "interSessionLookahead": true,
          "totalFrames": 0,
          "uniqueHashes": 0,
          "maxConsecutiveRun": 0,
          "maxOccurrenceCount": 0,
          "storedSessionsCount": 0,
          "storedHashesCount": 0,
          "storedSessionSizes": [
            0
          ],
          "intraIncodeSessionLoop": true,
          "interIncodeSessionLoop": true
        },
        "environmentIntegrity": {
          "rootDetected": true,
          "storageTamperingDetected": true,
          "environmentHookingDetected": true,
          "wasmTamperingDetected": true,
          "challengeInterruptionDetected": true,
          "debugModeDetected": true,
          "rootDetectionLevel": 0
        },
        "isMotionEnabled": true,
        "sensorDataReference": "string"
      },
      "behavior": {
        "detectionValuesDeviation": "PASS",
        "monotonicBorder": "PASS",
        "motionStatus": "PASS"
      },
      "captureMode": "AUTO",
      "hasDepth": true,
      "expectedDepth": true,
      "mediaInfo": {
        "videoChecksum": "string"
      },
      "clientLogs": "string"
    },
    "backIdCaptureMetadata": {
      "timestamp": 0,
      "sdkPlatform": "WEBAPP",
      "sdkVersion": "string",
      "callerId": "string",
      "device": {
        "kind": "MOBILE",
        "model": "string",
        "os": "string",
        "osVersion": "string",
        "screenDimensions": {
          "width": 0,
          "height": 0
        },
        "numTouchPoints": 0,
        "fingerprintHash": "string",
        "ip": "string",
        "backgroundMode": true,
        "hookDetected": true,
        "emulatorDetected": true,
        "rootDetected": true,
        "virtualEnvironmentDetected": true,
        "jailbreakDetectionDisabled": true
      },
      "browser": {
        "userAgent": "string",
        "getUserMediaAvailability": {
          "webkit": true,
          "mozilla": true,
          "opera": true,
          "microsoft": true
        },
        "webglFingerprint": "string",
        "inspectorOpened": true,
        "isMockedBrowser": true
      },
      "camera": {
        "facingMode": "FRONTAL",
        "settings": {},
        "capabilities": {},
        "labels": [
          "string"
        ]
      },
      "iad": {
        "isDeepsightEnabled": true,
        "deepsightLiveness": "SINGLE_FRAME",
        "zoomCheck": "PASS",
        "exposureCompensationCheck": "PASS",
        "cctCheck": "PASS",
        "genericCheck": "PASS",
        "mobileTemporalCheck": "PASS",
        "contrastSharpnessSaturationCheck": "PASS",
        "frontBackCameraCheck": "PASS",
        "frameDuplicationCheck": "PASS",
        "exposureCheck": "PASS",
        "replayAttackCheck": "PASS",
        "environmentIntegrityCheck": "PASS",
        "extendedDeviceAndBrowserClassificationData": {},
        "deviceEmulationCheck": "PASS",
        "contrastSharpnessSaturationData": {
          "initialValues": {
            "contrast": 0,
            "sharpness": 0,
            "saturation": 0,
            "metrics": 0,
            "isTimeoutReached": true,
            "framePixelDelta": 0
          },
          "appliedValues": [
            {
              "contrast": null,
              "sharpness": null,
              "saturation": null,
              "metrics": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ]
        },
        "genericInjectionData": {
          "streamInitializationTime": [
            0
          ],
          "timeToFirstFrame": [
            0
          ],
          "appliedConstraints": {},
          "isTimeoutReached": true,
          "sitAborted": true,
          "warmInitializationTime": 0
        },
        "iosInjectionData": {
          "createStreamTime": [
            0
          ],
          "frameStats": [
            {
              "frameCount": null,
              "isBlack": null,
              "isUnique": null,
              "timestamp": null,
              "updatedPercentage": null
            }
          ],
          "appliedConstraints": {},
          "isTimeoutReached": true
        },
        "cctInjectionData": {
          "initialCct": 0,
          "minColorTemperatureParameters": [
            {
              "value": null,
              "applicationTime": null,
              "appliedConstraints": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ],
          "maxColorTemperatureParameters": [
            {
              "value": null,
              "applicationTime": null,
              "appliedConstraints": null,
              "isTimeoutReached": null,
              "framePixelDelta": null
            }
          ]
        },
        "androidInjectionData": {
          "constraintsApplicationTime": [
            0
          ],
          "appliedConstraints": [
            {}
          ]
        },
        "frontBackCameraData": {
          "cameraCheckData": [
            {
              "type": null,
              "isAvailable": null,
              "faceDetected": null,
              "idDetected": null,
              "isTimeoutReached": null
            }
          ],
          "phashMinRotHamming": 0,
          "colorHistChiSqr": 0,
          "noiseMaeRatio": 0,
          "noiseDistroChiSqr": 0,
          "initialFrameCount": 0,
          "oppositeFrameCount": 0,
          "oppositeWithinPhashHammingMean": 0,
          "oppositeWithinPhashHammingMax": 0,
          "oppositeWithinNoiseMaeStdev": 0,
          "oppositeWithinBrightnessStdev": 0,
          "crossPhashHammingMean": 0,
          "crossPhashHammingMin": 0,
          "crossPhashHammingMax": 0,
          "crossColorHistChiSqrMean": 0,
          "crossNoiseMaeDelta": 0,
          "crossNoiseDistroChiSqrMean": 0,
          "crossBrightnessDelta": 0,
          "initialSceneFeatures": [
            0
          ],
          "oppositeSceneFeatures": [
            0
          ],
          "crossSceneFeatureDeltas": [
            0
          ],
          "oppositeTemporalKurtosis": 0,
          "oppositeTemporalKsToGaussian": 0,
          "oppositeTemporalLevelsRatio": 0,
          "oppositeTemporalVarianceMean": 0,
          "oppositeTemporalVarianceStdev": 0,
          "initialDeviceId": "string",
          "oppositeDeviceId": "string",
          "initialGroupId": "string",
          "oppositeGroupId": "string",
          "initialFacingMode": "string",
          "oppositeFacingMode": "string",
          "initialWidth": 0,
          "initialHeight": 0,
          "oppositeWidth": 0,
          "oppositeHeight": 0,
          "initialFrameRate": 0,
          "oppositeFrameRate": 0,
          "deviceIdsDiffer": true,
          "groupIdsMatch": true,
          "experimentIncomplete": true
        },
        "frameDuplicationData": {
          "validDuplicateCount": 0,
          "invalidDuplicateCount": 0,
          "continuousValidDuplicateCount": 0,
          "continuousInvalidDuplicateCount": 0,
          "isTimeoutReached": true,
          "initialDuplicateFramesDetected": true,
          "initialOpenCaptureDuplicateFramesDetected": true,
          "invalidInitialDuplicateFramesDetected": true,
          "continuousDuplicateFramesDetected": true,
          "numInitialDuplicateInstances": 0,
          "numInitialOpenCaptureDuplicateInstances": 0,
          "numInvalidInitialDuplicateInstances": 0,
          "numContinuousDuplicateInstances": 0,
          "preCaptureTotalFrames": 0,
          "preCaptureUniqueHashes": 0,
          "preCaptureMaxConsecutiveRun": 0,
          "preCaptureMaxOccurrenceCount": 0,
          "preCaptureMaxOccurrencePercentage": 0,
          "frameStats": [
            {
              "frameCount": null,
              "isBlack": null,
              "isUnique": null,
              "timestamp": null,
              "updatedPercentage": null
            }
          ],
          "perPhaseStats": [
            {
              "invalidDuplicateCount": null,
              "totalFrames": null,
              "uniqueHashes": null,
              "maxOccurrencePercentage": null
            }
          ]
        },
        "zoomData": {
          "initialConstraints": {},
          "initialZoom": 0,
          "maxZoomParameters": [
            {
              "applicationTime": null,
              "appliedConstraints": null,
              "appliedZoom": null,
              "isTimeoutReached": null
            }
          ],
          "minZoomParameters": [
            {
              "applicationTime": null,
              "appliedConstraints": null,
              "appliedZoom": null,
              "isTimeoutReached": null
            }
          ],
          "zoomInconsistencyDetected": true
        },
        "exposureData": {
          "exposureParams": [
            []
          ],
          "frames": [
            []
          ],
          "sessionDiagnostics": [
            {
              "exposureSupported": null,
              "exposureApplyConstraintError": null,
              "exposureApplyConstraintTimeout": null,
              "invalidTrackStateDetected": null,
              "exposureInconsistencyDetected": null,
              "interruptedCapture": null,
              "cameraCaptureStatus": null,
              "exposureMinDelay": null,
              "exposureInitialDelay": null,
              "baselineBrightness": null
            }
          ]
        },
        "replayAttackData": {
          "collisionCount": 0,
          "isTimeoutReached": true,
          "intraSessionLoop": true,
          "intraSessionLookahead": true,
          "interSessionLookahead": true,
          "totalFrames": 0,
          "uniqueHashes": 0,
          "maxConsecutiveRun": 0,
          "maxOccurrenceCount": 0,
          "storedSessionsCount": 0,
          "storedHashesCount": 0,
          "storedSessionSizes": [
            0
          ],
          "intraIncodeSessionLoop": true,
          "interIncodeSessionLoop": true
        },
        "environmentIntegrity": {
          "rootDetected": true,
          "storageTamperingDetected": true,
          "environmentHookingDetected": true,
          "wasmTamperingDetected": true,
          "challengeInterruptionDetected": true,
          "debugModeDetected": true,
          "rootDetectionLevel": 0
        },
        "isMotionEnabled": true,
        "sensorDataReference": "string"
      },
      "behavior": {
        "detectionValuesDeviation": "PASS",
        "monotonicBorder": "PASS",
        "motionStatus": "PASS"
      },
      "captureMode": "AUTO",
      "hasDepth": true,
      "expectedDepth": true,
      "mediaInfo": {
        "videoChecksum": "string"
      },
      "clientLogs": "string"
    },
    "ocrDataConfidence": {
      "birthDateConfidence": 0,
      "nameConfidence": 0,
      "nameNativeScriptConfidence": 0,
      "firstNameNativeScriptConfidence": 0,
      "paternalLastNameNativeScriptConfidence": 0,
      "maternalLastNameNativeScriptConfidence": 0,
      "givenNameConfidence": 0,
      "firstNameConfidence": 0,
      "middleNameConfidence": 0,
      "nameSuffixConfidence": 0,
      "mothersSurnameConfidence": 0,
      "fathersSurnameConfidence": 0,
      "nickNameConfidence": 0,
      "fullNameMrzConfidence": 0,
      "mothersNameConfidence": 0,
      "fathersNameConfidence": 0,
      "mothersIdNumberConfidence": 0,
      "fathersIdNumberConfidence": 0,
      "spouseNameConfidence": 0,
      "birthNameConfidence": 0,
      "addressConfidence": 0,
      "streetConfidence": 0,
      "colonyConfidence": 0,
      "postalCodeConfidence": 0,
      "cityConfidence": 0,
      "stateConfidence": 0,
      "districtConfidence": 0,
      "stateCodeConfidence": 0,
      "countryCodeConfidence": 0,
      "genderConfidence": 0,
      "issueDateConfidence": 0,
      "expirationDateConfidence": 0,
      "issuedAtConfidence": 0,
      "expireAtConfidence": 0,
      "issuingAuthorityConfidence": 0,
      "mrz1Confidence": 0,
      "mrz2Confidence": 0,
      "mrz3Confidence": 0,
      "mrzFullConfidence": 0,
      "documentNumberConfidence": 0,
      "backNumberConfidence": 0,
      "personalNumberConfidence": 0,
      "nationalNumberConfidence": 0,
      "claveDeElectorConfidence": 0,
      "numeroEmisionCredencialConfidence": 0,
      "curpConfidence": 0,
      "nueConfidence": 0,
      "registrationDateConfidence": 0,
      "heightConfidence": 0,
      "birthPlaceConfidence": 0,
      "bloodTypeConfidence": 0,
      "eyeColorConfidence": 0,
      "classesConfidence": 0,
      "condConfidence": 0,
      "mentionsConfidence": 0,
      "refNumberConfidence": 0,
      "weightConfidence": 0,
      "hairConfidence": 0,
      "restrictionsConfidence": 0,
      "nationalityConfidence": 0,
      "nationalityMrzConfidence": 0,
      "nationalityAlpha3Confidence": 0,
      "maritalStatusConfidence": 0,
      "raceConfidence": 0,
      "taxIdNumberConfidence": 0,
      "jurisdictionCodeConfidence": 0
    },
    "userConsentTitle": "string",
    "userConsentText": "string",
    "userConsentStatus": true,
    "mlConsentStatus": true,
    "signedConsents": [
      {
        "consentType": "ML",
        "regulationType": "US",
        "signed": true,
        "consentId": "string",
        "signedTime": 0
      }
    ],
    "frontIdCaptureType": "AUTO",
    "backIdCaptureType": "AUTO",
    "selfieCaptureType": "AUTO",
    "omniVersion": "string",
    "clientId": "string",
    "scoresInfoId": "string",
    "shadowScoresInfoId": "string",
    "idAlreadyUsed": true,
    "idAlreadyUsedInterviewId": "string",
    "appliedTotalRule": {
      "name": "string",
      "expression": "string",
      "ruleType": "idValidation",
      "status": "OK",
      "triggered": true
    },
    "needsReviewReason": "MANUAL_CAPTURE",
    "documentSubmissionMethod": "CAPTURED_DOCUMENT",
    "credentialsProvider": "APPLE",
    "formName": "string",
    "formFirstName": "string",
    "formLastName": "string",
    "formCpf": "string",
    "documentNumberSource": "FORM",
    "antifraudResult": {
      "originalStatus": "FAILED",
      "resolved": true,
      "resolvedReason": "string"
    },
    "scannerSignals": {
      "b900InkCheck": true,
      "uvDullnessFront": true,
      "uvDullnessBack": true,
      "motionDetectionFront": true,
      "motionDetectionBack": true
    },
    "elUnsignedDocuments": [
      {
        "uuid": "string",
        "s3location": "string",
        "createdTime": 0,
        "documentName": "string"
      }
    ],
    "elSignedDocuments": [
      {
        "uuid": "string",
        "s3location": "string",
        "createdTime": 0,
        "signerKeyName": "string",
        "externalFileId": "string",
        "qesAttemptId": "string"
      }
    ],
    "elSignedSignerKeyName": "string",
    "otpPhoneVerified": true,
    "otpEmailVerified": true,
    "tamperedSeverity": "low",
    "paperSeverity": "low",
    "screenSeverity": "low",
    "idAlterationModelVersion": "string",
    "idAlterationSeverity": "low",
    "fontAlterationConfidence": 0,
    "fontAlterationModelVersion": "string",
    "fontAlterationSeverity": "low",
    "punchedHolesModelVersion": "string",
    "punchedHolesSeverity": "low",
    "idLaminationModelVersion": "string",
    "idLaminationSeverity": "low",
    "idLaminationConfidence": 0,
    "idDamageDetectionModelVersion": "string",
    "idDamageDetectionSeverity": "low",
    "idDamageDetectionConfidence": 0,
    "aiGeneratedDocumentSeverity": "low",
    "aiGeneratedDocumentModelVersion": "string",
    "aiGeneratedDocumentConfidence": 0,
    "documentVisualAnomalySeverity": "low",
    "documentVisualAnomalyModelVersion": "string",
    "documentVisualAnomalyConfidence": 0,
    "fakeIdSeverity": "low",
    "fakeIdModelVersion": "string",
    "fakeIdInternalSeverity": "low",
    "fakeIdInternalModelVersion": "string",
    "batchId": "string",
    "tamperedConfidenceCorrected": 0,
    "fakeIdConfidenceCorrected": 0,
    "paperConfidenceCorrected": 0,
    "screenConfidenceCorrected": 0,
    "faceSpoofCorrected": true,
    "faceMismatchCorrected": true,
    "labelingComplete": true,
    "personalIdentificationNumberProvider": "UNKNOWN",
    "ineReferenceId": "string",
    "isReportedAsFraud": true,
    "fraudCandidateId": "string",
    "cleanedExceptAuthData": true,
    "isPartOfExperimentGroup": true,
    "featureGates": {},
    "userProvidedName": "string",
    "userProvidedBirthDate": "string",
    "paperFrontConfidence": 0,
    "paperFrontModelVersion": "string",
    "screenFrontConfidence": 0,
    "screenFrontModelVersion": "string",
    "paperBackConfidence": 0,
    "paperBackModelVersion": "string",
    "screenBackConfidence": 0,
    "screenBackModelVersion": "string",
    "paperFrontConfidenceCorrected": 0,
    "screenFrontConfidenceCorrected": 0,
    "paperBackConfidenceCorrected": 0,
    "screenBackConfidenceCorrected": 0,
    "idAlterationFrontConfidence": 0,
    "idAlterationBackConfidence": 0,
    "frontPunchedHoles": {
      "confidence": 0
    },
    "backPunchedHoles": {
      "confidence": 0
    },
    "faceBrightness": 0,
    "dlClassRestrictions": [
      {
        "dlClass": "string",
        "raw": "string",
        "fullRaw": "string",
        "baseCode": "string",
        "subCode": "string",
        "payload": [
          "string"
        ]
      }
    ],
    "idValidationDeepCheck": true,
    "acuantId": "string",
    "mAdminArea": "string",
    "mSubAdminArea": "string",
    "mLocality": "string",
    "mSubLocality": "string",
    "mThoroughfare": "string",
    "mSubThoroughfare": "string",
    "mPostalCode": "string",
    "mCountryCode": "string",
    "mCountryName": "string",
    "gWatchlistType": "person",
    "gWatchlistShareUrl": "string",
    "gWatchlistMatchStatus": "no_match",
    "gWatchlistRiskLevel": "low",
    "gWatchlistTotalHits": 0,
    "gWatchlistTotalMatches": 0,
    "gWatchlistSanctionsMatchScore": 0,
    "gWatchlistWarningMatchScore": 0
  }
]
```

---

- Path: `api-reference/interview`
- URL: https://developer.incode.com/api-reference/interview/
- Markdown: https://developer.incode.com/api-reference/interview.md
- Endpoint: `DELETE /omni/interview`

# Delete PII data for single onboarding session.

`DELETE /omni/interview`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Delete all PII data for onboarding sessions by given array of interview ids.
Note:
Works with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.
Finally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes | Specify which interview. |
| `keepCustomer` | query | boolean |  | True or false. Indicates whether to keep idenity of the customer or not. Default is false(which means session and customer identity both will be deleted). |
| `sendNotification` | query | boolean |  | Flag to send a notification about a change interview status |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X DELETE https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E", {
  method: "DELETE",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.delete("https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E")
req = Net::HTTP::Delete.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/interview?interviewId=%3CinterviewId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/interview-events-dictionary`
- URL: https://developer.incode.com/api-reference/interview-events-dictionary/
- Markdown: https://developer.incode.com/api-reference/interview-events-dictionary.md
- Endpoint: `GET /omni/interview-events/dictionary`

# Fetch interview event dictionary

`GET /omni/interview-events/dictionary`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns the list of all existing interview event types

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/interview-events/dictionary \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/interview-events/dictionary", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/interview-events/dictionary", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/interview-events/dictionary"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/interview-events/dictionary")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/interview-events/dictionary");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
[
  {
    "code": "string",
    "sender": "BACKEND",
    "description": "string",
    "locales": [
      {
        "locale": "string",
        "name": "string"
      }
    ]
  }
]
```

---

- Path: `api-reference/interviews`
- URL: https://developer.incode.com/api-reference/interviews/
- Markdown: https://developer.incode.com/api-reference/interviews.md
- Endpoint: `DELETE /omni/interviews`

# Delete PII data for multiple onboarding sessions with multiple options.

`DELETE /omni/interviews`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Delete all PII data for onboarding sessions by given array of interview ids.
Note:
Works with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.
Finally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filter` | DeleteInterviewsFilterDto | yes | Filter for cleaning interview |
| `filter.ids` | array[string] |  | List of identifiers interviews |
| `filter.flowId` | string |  | Flow id, if passed, then delete all interviews related to this flow |
| `filter.externalId` | string |  | Specify which external-id. |
| `filter.externalCustomerId` | string |  | Specify which external-customer-id. |
| `filter.lastActiveDate` | string (date-time) |  | To delete all interviews active before this date |
| `config` | DeleteInterviewsConfigDto |  | Configuration for cleaning interview |
| `config.deletePiiDataOnly` | boolean |  | Boolean, optional. Flag indicating if this is partial delete, where only PII fields should be removed. Default is true. Note: False is allowed to be used only if this organization has the required setting. Default: `true` |
| `config.deletionMode` | string |  | Specifies the type of deletion to perform. Enum: `BIOMETRICS`, `PII`, `FULL` |
| `config.sendNotification` | boolean |  | Flag indicating to send a notification about a change interview status Default: `false` |
| `config.relatedEntitiesToKeep` | array[string] |  | List of related entities to be saved. Works only when deletePiiDataOnly=true Enum: `identities`, `faceTemplates`, `images`, `stats`, `chats`, `deviceFingerPrints` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `taskId` | string |  |  |
| `statusUri` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X DELETE https://demo-api.incodesmile.com/omni/interviews \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/interviews", {
  method: "DELETE",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.delete("https://demo-api.incodesmile.com/omni/interviews", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/interviews"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/interviews")
req = Net::HTTP::Delete.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/interviews");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "taskId": "string",
  "statusUri": "string"
}
```

---

- Path: `api-reference/kyb`
- URL: https://developer.incode.com/api-reference/kyb/
- Markdown: https://developer.incode.com/api-reference/kyb.md
- Endpoint: `POST /omni/kyb`

# EkybChecks Modular Business Verification

`POST /omni/kyb`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Composable KYB endpoint. Clients specify which modules they need and Incode routes to the correct vendor for the country. Available modules: identity, address, statusEntityType, personAssociation, webPresence, websiteAnalysis, industryInfo, financialIntelligence, groupStructure. Every response carries a referenceId, and every run ends with one EKYB_CHECKS_RESULT webhook carrying the final result (also pollable at GET /omni/verification/async/{referenceId}). webPresence/websiteAnalysis/industryInfo/financialIntelligence may not finish within the synchronous response's wait budget; those are listed in pendingModules and the webhook follows once they resolve.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `plugins` | array[string] |  |  |
| `country` | string | yes | ISO 3166-1 alpha-2 country code |
| `taxId` | string |  | Tax ID or company registration number |
| `businessName` | string |  | Registered legal name of the business |
| `street` | string |  | Street address |
| `city` | string |  | City |
| `state` | string |  | State / province |
| `postalCode` | string |  | Postal code / ZIP |
| `personNames` | array[string] |  | Names of persons to verify association with the business (PERSON_ASSOCIATION module). Each name is matched against the business officer/director registry; one result per name is returned. |
| `website` | string |  | Business website URL |
| `alternativeNames` | array[string] |  | Alternative or trade names for the business |
| `phoneNumber` | string |  | Business phone number |
| `email` | string |  | Business email address |
| `modules` | array[string] |  | Enum: `identity`, `address`, `statusEntityType`, `personAssociation`, `webPresence`, `websiteAnalysis`, `industryInfo`, `financialIntelligence`, `groupStructure` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `identity` | IdentityModuleResult |  |  |
| `identity.taxId` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `identity.name` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `identity.registryName` | string |  |  |
| `identity.registryNames` | array[string] |  |  |
| `identity.tinMatchType` | string |  |  |
| `identity.tinMatchMessage` | string |  |  |
| `identity.error` | EkybChecksError |  |  |
| `identity.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `identity.error.message` | string |  |  |
| `address` | AddressModuleResult |  |  |
| `address.addressVerification` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `address.registryAddress` | string |  |  |
| `address.registryAddresses` | array[string] |  |  |
| `address.officeType` | string |  |  |
| `address.otherAddresses` | array[OtherAddress] |  |  |
| `address.otherAddresses.address` | string |  |  |
| `address.otherAddresses.type` | string |  |  |
| `address.error` | EkybChecksError |  |  |
| `address.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `address.error.message` | string |  |  |
| `statusEntityType` | StatusEntityTypeModuleResult |  |  |
| `statusEntityType.registrationStatus` | string |  |  |
| `statusEntityType.entityType` | string |  |  |
| `statusEntityType.incorporationDate` | string |  |  |
| `statusEntityType.companySize` | string |  |  |
| `statusEntityType.otherInfo` | OtherInfo |  |  |
| `statusEntityType.otherInfo.vatNo` | string |  |  |
| `statusEntityType.otherInfo.otherNames` | array[OtherName] |  |  |
| `statusEntityType.otherInfo.otherNames.name` | string |  |  |
| `statusEntityType.otherInfo.otherNames.businessNameType` | string |  |  |
| `statusEntityType.otherInfo.leiNumber` | string |  |  |
| `statusEntityType.otherInfo.panNumber` | string |  |  |
| `statusEntityType.otherInfo.panName` | string |  |  |
| `statusEntityType.otherInfo.allGSTINs` | array[Gstin] |  |  |
| `statusEntityType.otherInfo.allGSTINs.gstin` | string |  |  |
| `statusEntityType.otherInfo.allGSTINs.state` | string |  |  |
| `statusEntityType.otherInfo.allGSTINs.status` | string |  |  |
| `statusEntityType.error` | EkybChecksError |  |  |
| `statusEntityType.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `statusEntityType.error.message` | string |  |  |
| `personAssociation` | PersonAssociationModuleResult |  |  |
| `personAssociation.personMatches` | array[EkybChecksPersonMatch] |  |  |
| `personAssociation.personMatches.checkedName` | string |  |  |
| `personAssociation.personMatches.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `personAssociation.personMatches.matchedName` | string |  |  |
| `personAssociation.personMatches.matchedPerson` | EkybChecksPersonResult |  |  |
| `personAssociation.personMatches.matchedPerson.name` | string |  |  |
| `personAssociation.personMatches.matchedPerson.titles` | array[string] |  |  |
| `personAssociation.personMatches.matchedPerson.percentSharesHeld` | number (double) |  |  |
| `personAssociation.people` | array[EkybChecksPersonResult] |  |  |
| `personAssociation.people.name` | string |  |  |
| `personAssociation.people.titles` | array[string] |  |  |
| `personAssociation.people.percentSharesHeld` | number (double) |  |  |
| `personAssociation.error` | EkybChecksError |  |  |
| `personAssociation.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `personAssociation.error.message` | string |  |  |
| `webPresence` | WebPresenceModuleResult |  |  |
| `webPresence.socialProfiles` | array[SocialProfile] |  |  |
| `webPresence.socialProfiles.platform` | string |  |  |
| `webPresence.socialProfiles.username` | string |  |  |
| `webPresence.socialProfiles.url` | string |  |  |
| `webPresence.socialProfiles.confidence` | string |  |  |
| `webPresence.socialProfiles.followers` | integer (int64) |  |  |
| `webPresence.socialProfiles.bio` | string |  |  |
| `webPresence.socialProfiles.businessWebsite` | string |  |  |
| `webPresence.socialProfiles.verified` | boolean |  |  |
| `webPresence.websites` | array[string] |  |  |
| `webPresence.phoneNumbers` | array[string] |  |  |
| `webPresence.emailAddresses` | array[string] |  |  |
| `webPresence.error` | EkybChecksError |  |  |
| `webPresence.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `webPresence.error.message` | string |  |  |
| `websiteAnalysis` | WebsiteAnalysisModuleResult |  |  |
| `websiteAnalysis.url` | string |  |  |
| `websiteAnalysis.domainAgeMonths` | integer (int32) |  |  |
| `websiteAnalysis.domainCreatedAt` | string |  |  |
| `websiteAnalysis.domainExpiresAt` | string |  |  |
| `websiteAnalysis.registrar` | string |  |  |
| `websiteAnalysis.parked` | boolean |  |  |
| `websiteAnalysis.buildStatus` | string |  |  |
| `websiteAnalysis.ssl` | Ssl |  |  |
| `websiteAnalysis.ssl.isValid` | boolean |  |  |
| `websiteAnalysis.ssl.issuer` | string |  |  |
| `websiteAnalysis.ssl.certificateType` | string |  |  |
| `websiteAnalysis.ssl.tlsVersion` | string |  |  |
| `websiteAnalysis.ssl.expiryDate` | string |  |  |
| `websiteAnalysis.ssl.daysUntilExpiry` | integer (int32) |  |  |
| `websiteAnalysis.ssl.isWildcard` | boolean |  |  |
| `websiteAnalysis.ssl.isSelfSigned` | boolean |  |  |
| `websiteAnalysis.ssl.isRevoked` | boolean |  |  |
| `websiteAnalysis.structureMetrics` | StructureMetrics |  |  |
| `websiteAnalysis.structureMetrics.depth` | string |  |  |
| `websiteAnalysis.structureMetrics.breadth` | string |  |  |
| `websiteAnalysis.error` | EkybChecksError |  |  |
| `websiteAnalysis.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `websiteAnalysis.error.message` | string |  |  |
| `industryInfo` | IndustryInfoModuleResult |  |  |
| `industryInfo.naicsCode` | string |  |  |
| `industryInfo.title` | string |  |  |
| `industryInfo.accuracy` | number (double) |  |  |
| `industryInfo.riskLevel` | string |  |  |
| `industryInfo.industryCode` | string |  |  |
| `industryInfo.classification` | string |  |  |
| `industryInfo.industryDesc` | string |  |  |
| `industryInfo.activityDesc` | string |  |  |
| `industryInfo.error` | EkybChecksError |  |  |
| `industryInfo.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `industryInfo.error.message` | string |  |  |
| `financialIntelligence` | FinancialIntelligenceModuleResult |  |  |
| `financialIntelligence.liens` | array[Lien] |  |  |
| `financialIntelligence.liens.filingNumber` | string |  |  |
| `financialIntelligence.liens.filingType` | string |  |  |
| `financialIntelligence.liens.filingDate` | string |  |  |
| `financialIntelligence.liens.status` | string |  |  |
| `financialIntelligence.liens.lienAmount` | number (double) |  |  |
| `financialIntelligence.liens.matchLevel` | string |  |  |
| `financialIntelligence.litigation` | array[Litigation] |  |  |
| `financialIntelligence.litigation.docketNumber` | string |  |  |
| `financialIntelligence.litigation.court` | string |  |  |
| `financialIntelligence.litigation.state` | string |  |  |
| `financialIntelligence.litigation.title` | string |  |  |
| `financialIntelligence.litigation.caseType` | string |  |  |
| `financialIntelligence.litigation.dateFiled` | string |  |  |
| `financialIntelligence.litigation.matchLevel` | string |  |  |
| `financialIntelligence.litigation.riskLevel` | string |  |  |
| `financialIntelligence.bankruptcy` | array[Bankruptcy] |  |  |
| `financialIntelligence.bankruptcy.bankruptcyType` | string |  |  |
| `financialIntelligence.bankruptcy.docketNumber` | string |  |  |
| `financialIntelligence.bankruptcy.court` | string |  |  |
| `financialIntelligence.bankruptcy.title` | string |  |  |
| `financialIntelligence.bankruptcy.dateFiled` | string |  |  |
| `financialIntelligence.bankruptcy.riskLevel` | string |  |  |
| `financialIntelligence.bankruptcy.matchLevel` | string |  |  |
| `financialIntelligence.creditRating` | string |  |  |
| `financialIntelligence.creditRatingDescription` | string |  |  |
| `financialIntelligence.creditLimit` | Amount |  |  |
| `financialIntelligence.creditLimit.currency` | string |  |  |
| `financialIntelligence.creditLimit.value` | number (double) |  |  |
| `financialIntelligence.probabilityOfDefault` | number (double) |  |  |
| `financialIntelligence.turnover` | Turnover |  |  |
| `financialIntelligence.turnover.currency` | string |  |  |
| `financialIntelligence.turnover.value` | number (double) |  |  |
| `financialIntelligence.turnover.range` | string |  |  |
| `financialIntelligence.employeeCount` | string |  |  |
| `financialIntelligence.negativeInformation` | object |  |  |
| `financialIntelligence.error` | EkybChecksError |  |  |
| `financialIntelligence.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `financialIntelligence.error.message` | string |  |  |
| `groupStructure` | GroupStructureModuleResult |  |  |
| `groupStructure.ultimateParent` | GroupCompany |  |  |
| `groupStructure.ultimateParent.name` | string |  |  |
| `groupStructure.ultimateParent.country` | string |  |  |
| `groupStructure.ultimateParent.status` | string |  |  |
| `groupStructure.ultimateParent.registrationNumber` | string |  |  |
| `groupStructure.ultimateParent.level` | string |  |  |
| `groupStructure.immediateParent` | GroupCompany |  |  |
| `groupStructure.immediateParent.name` | string |  |  |
| `groupStructure.immediateParent.country` | string |  |  |
| `groupStructure.immediateParent.status` | string |  |  |
| `groupStructure.immediateParent.registrationNumber` | string |  |  |
| `groupStructure.immediateParent.level` | string |  |  |
| `groupStructure.subsidiaryCompanies` | array[GroupCompany] |  |  |
| `groupStructure.subsidiaryCompanies.name` | string |  |  |
| `groupStructure.subsidiaryCompanies.country` | string |  |  |
| `groupStructure.subsidiaryCompanies.status` | string |  |  |
| `groupStructure.subsidiaryCompanies.registrationNumber` | string |  |  |
| `groupStructure.subsidiaryCompanies.level` | string |  |  |
| `groupStructure.affiliatedCompanies` | array[GroupCompany] |  |  |
| `groupStructure.affiliatedCompanies.name` | string |  |  |
| `groupStructure.affiliatedCompanies.country` | string |  |  |
| `groupStructure.affiliatedCompanies.status` | string |  |  |
| `groupStructure.affiliatedCompanies.registrationNumber` | string |  |  |
| `groupStructure.affiliatedCompanies.level` | string |  |  |
| `groupStructure.relatedEntities` | array[GroupCompany] |  |  |
| `groupStructure.relatedEntities.name` | string |  |  |
| `groupStructure.relatedEntities.country` | string |  |  |
| `groupStructure.relatedEntities.status` | string |  |  |
| `groupStructure.relatedEntities.registrationNumber` | string |  |  |
| `groupStructure.relatedEntities.level` | string |  |  |
| `groupStructure.error` | EkybChecksError |  |  |
| `groupStructure.error.status` | string |  | Enum: `verified`, `approximateMatch`, `unverified`, `notFound` |
| `groupStructure.error.message` | string |  |  |
| `scores` | array[EkybChecksScore] |  |  |
| `scores.type` | string |  |  |
| `scores.score` | number (double) |  |  |
| `scores.rating` | string |  |  |
| `pendingModules` | array[string] |  | Enum: `identity`, `address`, `statusEntityType`, `personAssociation`, `webPresence`, `websiteAnalysis`, `industryInfo`, `financialIntelligence`, `groupStructure` |
| `referenceId` | string |  |  |
| `empty` | boolean |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/kyb \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "<country>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/kyb", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "country": "<country>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/kyb", headers=headers, json={
  "country": "<country>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/kyb"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"country\": \"<country>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/kyb")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "country": "<country>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/kyb");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "country": "<country>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "identity": {
    "taxId": "verified",
    "name": "verified",
    "registryName": "string",
    "registryNames": [
      "string"
    ],
    "tinMatchType": "string",
    "tinMatchMessage": "string",
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "address": {
    "addressVerification": "verified",
    "registryAddress": "string",
    "registryAddresses": [
      "string"
    ],
    "officeType": "string",
    "otherAddresses": [
      {
        "address": "string",
        "type": "string"
      }
    ],
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "statusEntityType": {
    "registrationStatus": "string",
    "entityType": "string",
    "incorporationDate": "string",
    "companySize": "string",
    "otherInfo": {
      "vatNo": "string",
      "otherNames": [
        {
          "name": "string",
          "businessNameType": "string"
        }
      ],
      "leiNumber": "string",
      "panNumber": "string",
      "panName": "string",
      "allGSTINs": [
        {
          "gstin": "string",
          "state": "string",
          "status": "string"
        }
      ]
    },
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "personAssociation": {
    "personMatches": [
      {
        "checkedName": "string",
        "status": "verified",
        "matchedName": "string",
        "matchedPerson": {
          "name": "string",
          "titles": [
            "string"
          ],
          "percentSharesHeld": 0
        }
      }
    ],
    "people": [
      {
        "name": "string",
        "titles": [
          "string"
        ],
        "percentSharesHeld": 0
      }
    ],
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "webPresence": {
    "socialProfiles": [
      {
        "platform": "string",
        "username": "string",
        "url": "string",
        "confidence": "string",
        "followers": 0,
        "bio": "string",
        "businessWebsite": "string",
        "verified": true
      }
    ],
    "websites": [
      "string"
    ],
    "phoneNumbers": [
      "string"
    ],
    "emailAddresses": [
      "string"
    ],
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "websiteAnalysis": {
    "url": "string",
    "domainAgeMonths": 0,
    "domainCreatedAt": "string",
    "domainExpiresAt": "string",
    "registrar": "string",
    "parked": true,
    "buildStatus": "string",
    "ssl": {
      "isValid": true,
      "issuer": "string",
      "certificateType": "string",
      "tlsVersion": "string",
      "expiryDate": "string",
      "daysUntilExpiry": 0,
      "isWildcard": true,
      "isSelfSigned": true,
      "isRevoked": true
    },
    "structureMetrics": {
      "depth": "string",
      "breadth": "string"
    },
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "industryInfo": {
    "naicsCode": "string",
    "title": "string",
    "accuracy": 0,
    "riskLevel": "string",
    "industryCode": "string",
    "classification": "string",
    "industryDesc": "string",
    "activityDesc": "string",
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "financialIntelligence": {
    "liens": [
      {
        "filingNumber": "string",
        "filingType": "string",
        "filingDate": "string",
        "status": "string",
        "lienAmount": 0,
        "matchLevel": "string"
      }
    ],
    "litigation": [
      {
        "docketNumber": "string",
        "court": "string",
        "state": "string",
        "title": "string",
        "caseType": "string",
        "dateFiled": "string",
        "matchLevel": "string",
        "riskLevel": "string"
      }
    ],
    "bankruptcy": [
      {
        "bankruptcyType": "string",
        "docketNumber": "string",
        "court": "string",
        "title": "string",
        "dateFiled": "string",
        "riskLevel": "string",
        "matchLevel": "string"
      }
    ],
    "creditRating": "string",
    "creditRatingDescription": "string",
    "creditLimit": {
      "currency": "string",
      "value": 0
    },
    "probabilityOfDefault": 0,
    "turnover": {
      "currency": "string",
      "value": 0,
      "range": "string"
    },
    "employeeCount": "string",
    "negativeInformation": {},
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "groupStructure": {
    "ultimateParent": {
      "name": "string",
      "country": "string",
      "status": "string",
      "registrationNumber": "string",
      "level": "string"
    },
    "immediateParent": {
      "name": "string",
      "country": "string",
      "status": "string",
      "registrationNumber": "string",
      "level": "string"
    },
    "subsidiaryCompanies": [
      {
        "name": "string",
        "country": "string",
        "status": "string",
        "registrationNumber": "string",
        "level": "string"
      }
    ],
    "affiliatedCompanies": [
      {
        "name": "string",
        "country": "string",
        "status": "string",
        "registrationNumber": "string",
        "level": "string"
      }
    ],
    "relatedEntities": [
      {
        "name": "string",
        "country": "string",
        "status": "string",
        "registrationNumber": "string",
        "level": "string"
      }
    ],
    "error": {
      "status": "verified",
      "message": "string"
    }
  },
  "scores": [
    {
      "type": "string",
      "score": 0,
      "rating": "string"
    }
  ],
  "pendingModules": [
    "identity"
  ],
  "referenceId": "string",
  "empty": true
}
```

---

- Path: `api-reference/onboarding-authentications-authenticate`
- URL: https://developer.incode.com/api-reference/onboarding-authentications-authenticate/
- Markdown: https://developer.incode.com/api-reference/onboarding-authentications-authenticate.md
- Endpoint: `POST /omni/onboarding-authentications/authenticate`

# Authentication with face/selfie image

`POST /omni/onboarding-authentications/authenticate`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Authenticate user by comparing base64 image from request and user's existing face template.
In case of One to one authentication, user is first found in DB by hint from request. At least one of criteria parameter must be sent in request.
In case of One to N authentication, hint is not used.
In case face doesn't match error response is returned.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Image of user's face represented in base64. |
| `faceCoordinates` | FaceCoordinatesDto |  | Face coordinates |
| `faceCoordinates.leftEyeX` | number (float) | yes | Left eye coordinates for X |
| `faceCoordinates.leftEyeY` | number (float) | yes | Left eye coordinates for Y |
| `faceCoordinates.rightEyeX` | number (float) | yes | Right eye coordinates for X |
| `faceCoordinates.rightEyeY` | number (float) | yes | Right eye coordinates for Y |
| `faceCoordinates.mouthX` | number (float) |  | Left mouth coordinates for X. Note: the field is deprecated, use leftMouthX instead |
| `faceCoordinates.leftMouthX` | number (float) |  | Left mouth coordinates for X |
| `faceCoordinates.mouthY` | number (float) |  | Left mouth coordinates for Y. Note: the field is deprecated, use leftMouthY instead |
| `faceCoordinates.leftMouthY` | number (float) |  | Left mouth coordinates for Y |
| `faceCoordinates.rightMouthX` | number (float) | yes | Right mouth coordinates for X |
| `faceCoordinates.rightMouthY` | number (float) | yes | Right mouth coordinates for Y |
| `faceCoordinates.noseTipX` | number (float) | yes | Nose coordinates for X |
| `faceCoordinates.noseTipY` | number (float) | yes | Nose coordinates for Y |
| `faceCoordinates.x` | number (float) | yes | X coordinate of face rectangle. |
| `faceCoordinates.y` | number (float) | yes | Y coordinate of face rectangle. |
| `faceCoordinates.width` | number (float) | yes | Width of face rectangle. |
| `faceCoordinates.height` | number (float) | yes | Height of face rectangle. |
| `hint` | string |  | Customer hint. Possible hints are: customer id, email, phone number... |
| `recordingId` | string |  | Id of recording used in spoof detection. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `overallStatus` | string |  | Authentication status: FAIL/PASS. Enum: `PASS`, `FAIL` |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. Shows remaining number of attempts, and maximum number of attempts allowed. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `candidate` | string |  | Id of matched candidate. |
| `error` | OnboardingAuthenticationErrorDto |  | Error name and description pair. Possible error names are: INACTIVE_SESSION, NONEXISTENT_CUSTOMER, LENSES_DETECTED, FACE_MASK_DETECTED, HEAD_COVER_DETECTED, CLOSED_EYES_DETECTED, FACE_TOO_DARK, SPOOF_ATTEMPT_DETECTED, USER_IS_NOT_RECOGNIZED, SELFIE_IMAGE_LOW_QUALITY, MULTIPLE_FACES_DETECTED, HINT_NOT_PROVIDED, FACE_NOT_FOUND, FACE_CROPPING_FAILED, FACE_TOO_SMALL, FACE_TOO_BLURRY, BAD_PHOTO_QUALITY, PROCESSING_ERROR, BAD_REQUEST |
| `error.name` | string |  |  |
| `error.message` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>",
    "faceCoordinates": {
      "leftEyeX": "<leftEyeX>",
      "leftEyeY": "<leftEyeY>",
      "rightEyeX": "<rightEyeX>",
      "rightEyeY": "<rightEyeY>",
      "rightMouthX": "<rightMouthX>",
      "rightMouthY": "<rightMouthY>",
      "noseTipX": "<noseTipX>",
      "noseTipY": "<noseTipY>",
      "x": "<x>",
      "y": "<y>",
      "width": "<width>",
      "height": "<height>"
    }
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>",
      "faceCoordinates": {
        "leftEyeX": "<leftEyeX>",
        "leftEyeY": "<leftEyeY>",
        "rightEyeX": "<rightEyeX>",
        "rightEyeY": "<rightEyeY>",
        "rightMouthX": "<rightMouthX>",
        "rightMouthY": "<rightMouthY>",
        "noseTipX": "<noseTipX>",
        "noseTipY": "<noseTipY>",
        "x": "<x>",
        "y": "<y>",
        "width": "<width>",
        "height": "<height>"
      }
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate", headers=headers, json={
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\",\n  \"faceCoordinates\": {\n    \"leftEyeX\": \"<leftEyeX>\",\n    \"leftEyeY\": \"<leftEyeY>\",\n    \"rightEyeX\": \"<rightEyeX>\",\n    \"rightEyeY\": \"<rightEyeY>\",\n    \"rightMouthX\": \"<rightMouthX>\",\n    \"rightMouthY\": \"<rightMouthY>\",\n    \"noseTipX\": \"<noseTipX>\",\n    \"noseTipY\": \"<noseTipY>\",\n    \"x\": \"<x>\",\n    \"y\": \"<y>\",\n    \"width\": \"<width>\",\n    \"height\": \"<height>\"\n  }\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "overallStatus": "PASS",
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "candidate": "string",
  "error": {
    "name": "string",
    "message": "string"
  }
}
```

---

- Path: `api-reference/onboarding-authentications-authenticate-third-party`
- URL: https://developer.incode.com/api-reference/onboarding-authentications-authenticate-third-party/
- Markdown: https://developer.incode.com/api-reference/onboarding-authentications-authenticate-third-party.md
- Endpoint: `POST /omni/onboarding-authentications/authenticate/third-party`

# Authentication with face/selfie image

`POST /omni/onboarding-authentications/authenticate/third-party`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Authenticate user by comparing base64 image from request and user's existing face template.
In case of One to one authentication, user is first found in DB by hint from request. At least one of criteria parameter must be sent in request.
In case of One to N authentication, hint is not used.
In case face doesn't match error response is returned.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Image of user's face represented in base64. |
| `faceCoordinates` | FaceCoordinatesDto |  | Face coordinates |
| `faceCoordinates.leftEyeX` | number (float) | yes | Left eye coordinates for X |
| `faceCoordinates.leftEyeY` | number (float) | yes | Left eye coordinates for Y |
| `faceCoordinates.rightEyeX` | number (float) | yes | Right eye coordinates for X |
| `faceCoordinates.rightEyeY` | number (float) | yes | Right eye coordinates for Y |
| `faceCoordinates.mouthX` | number (float) |  | Left mouth coordinates for X. Note: the field is deprecated, use leftMouthX instead |
| `faceCoordinates.leftMouthX` | number (float) |  | Left mouth coordinates for X |
| `faceCoordinates.mouthY` | number (float) |  | Left mouth coordinates for Y. Note: the field is deprecated, use leftMouthY instead |
| `faceCoordinates.leftMouthY` | number (float) |  | Left mouth coordinates for Y |
| `faceCoordinates.rightMouthX` | number (float) | yes | Right mouth coordinates for X |
| `faceCoordinates.rightMouthY` | number (float) | yes | Right mouth coordinates for Y |
| `faceCoordinates.noseTipX` | number (float) | yes | Nose coordinates for X |
| `faceCoordinates.noseTipY` | number (float) | yes | Nose coordinates for Y |
| `faceCoordinates.x` | number (float) | yes | X coordinate of face rectangle. |
| `faceCoordinates.y` | number (float) | yes | Y coordinate of face rectangle. |
| `faceCoordinates.width` | number (float) | yes | Width of face rectangle. |
| `faceCoordinates.height` | number (float) | yes | Height of face rectangle. |
| `hint` | string |  | Customer hint. Possible hints are: customer id, email, phone number... |
| `recordingId` | string |  | Id of recording used in spoof detection. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `overallStatus` | string |  | Authentication status: FAIL/PASS. Enum: `PASS`, `FAIL` |
| `captureAttemptsLimit` | CaptureAttemptsLimitDto |  | Checked only if configured in the session flow. Shows remaining number of attempts, and maximum number of attempts allowed. |
| `captureAttemptsLimit.max` | integer (int32) |  | Maximum number of attempts to capture a photo. |
| `captureAttemptsLimit.remaining` | integer (int32) |  | Number of remaining attempts to capture a photo. |
| `candidate` | string |  | Id of matched candidate. |
| `error` | OnboardingAuthenticationErrorDto |  | Error name and description pair. Possible error names are: INACTIVE_SESSION, NONEXISTENT_CUSTOMER, LENSES_DETECTED, FACE_MASK_DETECTED, HEAD_COVER_DETECTED, CLOSED_EYES_DETECTED, FACE_TOO_DARK, SPOOF_ATTEMPT_DETECTED, USER_IS_NOT_RECOGNIZED, SELFIE_IMAGE_LOW_QUALITY, MULTIPLE_FACES_DETECTED, HINT_NOT_PROVIDED, FACE_NOT_FOUND, FACE_CROPPING_FAILED, FACE_TOO_SMALL, FACE_TOO_BLURRY, BAD_PHOTO_QUALITY, PROCESSING_ERROR, BAD_REQUEST |
| `error.name` | string |  |  |
| `error.message` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>",
    "faceCoordinates": {
      "leftEyeX": "<leftEyeX>",
      "leftEyeY": "<leftEyeY>",
      "rightEyeX": "<rightEyeX>",
      "rightEyeY": "<rightEyeY>",
      "rightMouthX": "<rightMouthX>",
      "rightMouthY": "<rightMouthY>",
      "noseTipX": "<noseTipX>",
      "noseTipY": "<noseTipY>",
      "x": "<x>",
      "y": "<y>",
      "width": "<width>",
      "height": "<height>"
    }
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>",
      "faceCoordinates": {
        "leftEyeX": "<leftEyeX>",
        "leftEyeY": "<leftEyeY>",
        "rightEyeX": "<rightEyeX>",
        "rightEyeY": "<rightEyeY>",
        "rightMouthX": "<rightMouthX>",
        "rightMouthY": "<rightMouthY>",
        "noseTipX": "<noseTipX>",
        "noseTipY": "<noseTipY>",
        "x": "<x>",
        "y": "<y>",
        "width": "<width>",
        "height": "<height>"
      }
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party", headers=headers, json={
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\",\n  \"faceCoordinates\": {\n    \"leftEyeX\": \"<leftEyeX>\",\n    \"leftEyeY\": \"<leftEyeY>\",\n    \"rightEyeX\": \"<rightEyeX>\",\n    \"rightEyeY\": \"<rightEyeY>\",\n    \"rightMouthX\": \"<rightMouthX>\",\n    \"rightMouthY\": \"<rightMouthY>\",\n    \"noseTipX\": \"<noseTipX>\",\n    \"noseTipY\": \"<noseTipY>\",\n    \"x\": \"<x>\",\n    \"y\": \"<y>\",\n    \"width\": \"<width>\",\n    \"height\": \"<height>\"\n  }\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-party");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>",
  "faceCoordinates": {
    "leftEyeX": "<leftEyeX>",
    "leftEyeY": "<leftEyeY>",
    "rightEyeX": "<rightEyeX>",
    "rightEyeY": "<rightEyeY>",
    "rightMouthX": "<rightMouthX>",
    "rightMouthY": "<rightMouthY>",
    "noseTipX": "<noseTipX>",
    "noseTipY": "<noseTipY>",
    "x": "<x>",
    "y": "<y>",
    "width": "<width>",
    "height": "<height>"
  }
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "overallStatus": "PASS",
  "captureAttemptsLimit": {
    "max": 0,
    "remaining": 0
  },
  "candidate": "string",
  "error": {
    "name": "string",
    "message": "string"
  }
}
```

---

- Path: `api-reference/onboarding-url`
- URL: https://developer.incode.com/api-reference/onboarding-url/
- Markdown: https://developer.incode.com/api-reference/onboarding-url.md
- Endpoint: `GET /omni/onboarding-url`

# Fetch onboarding url

`GET /omni/onboarding-url`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch onboarding URL generated for specific user and specific flow. Only supply a `clientId`, if a redirect to mobile feature
has been added to the flow configuration and SMS and desktop onboarding is needed. Alternatively, if only a QR code is needed,
it's recommended to supply `clientId`, `components` and `tag` parameters. The alternative will return a highly performant
app launcher screen when redirect to mobile has been ena    bled.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `components` | query | string |  | URL encode String Array of accepted string values Enum: `qr` |
| `tag` | query | string |  | Enum: `payments`, `verification` |
| `shortUrl` | query | string |  | Enum: `true`, `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/onboarding-url?components=%3Ccomponents%3E&tag=%3Ctag%3E&shortUrl=%3CshortUrl%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/oneton-mfa`
- URL: https://developer.incode.com/api-reference/oneton-mfa/
- Markdown: https://developer.incode.com/api-reference/oneton-mfa.md
- Endpoint: `POST /omni/oneToN/mfa`

# Perform MFA

`POST /omni/oneToN/mfa`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This method is used for confirming user identity by sending last four digits of his phone number. transactionId which
was received in [/omni/oneToN/identify](#/Login/oneToNIdentify) response should be used.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `verificationCode` | string |  | The last 4 digits of the user's phone number. |
| `transactionId` | string |  | Authentication identifier received in [/omni/oneToN/identify](#/Login/oneToNIdentify). |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `customerId` | string |  |  |
| `token` | string |  |  |
| `interviewId` | string |  |  |
| `interviewToken` | string |  |  |
| `transactionId` | string |  | Authentication attempt identifier. |
| `externalId` | string |  | External ID of customer, provided by client on /omni/start call. |
| `externalCustomerId` | string |  | External ID of customer, provided by client on /omni/start call. |
| `faceMatch` | boolean |  |  |
| `spoofAttempt` | boolean |  | Flag indicating if this was spoof attempt. |
| `secondFactor` | boolean |  |  |
| `children` | array[object] |  |  |
| `spoofConfidence` | number (float) |  | Score between 0 and 1 that indicates if an image is a spoof. Scores closer to 0 indicate a legitimate session with a live user, whereas scores closer to 1 indicate a higher probability that the provided image is spoofed and that the session may be fraudulent. |
| `overallScore` | number (float) |  | Overall score search, value form 0 to 100. |
| `overallStatus` | string |  | Overall status Enum: `PASS`, `FAIL` |
| `deviceIPLocationData` | DeviceIPLocationDataDto |  |  |
| `deviceIPLocationData.ipAddress` | string |  |  |
| `deviceIPLocationData.ipCountry` | string |  |  |
| `deviceIPLocationData.ipCity` | string |  |  |
| `deviceIPLocationData.ipRegion` | string |  |  |

### 400

Custom error status: - 4004: Couldn't find record with verificationCode and transactionId

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/oneToN/mfa \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/oneToN/mfa", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/oneToN/mfa", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/oneToN/mfa"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/oneToN/mfa")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/oneToN/mfa");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "customerId": "6ea0859301170f0016fbd985",
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJleHRlcm5hbFVzZXJJZCI6IjYx85Mjdh...",
  "interviewId": "6gdftr59301170f0011234567",
  "interviewToken": "eyJhbGciOiJIUzI1NiJ9.eyJleHR6IjYx85Mj6IjYx85Mjlcm...",
  "transactionId": "6128ca6c515d0e0013806d55",
  "externalId": "string",
  "externalCustomerId": "string",
  "faceMatch": true,
  "spoofAttempt": true,
  "secondFactor": true,
  "children": [
    {}
  ],
  "spoofConfidence": 0,
  "overallScore": 0,
  "overallStatus": "PASS",
  "deviceIPLocationData": {
    "ipAddress": "string",
    "ipCountry": "string",
    "ipCity": "string",
    "ipRegion": "string"
  }
}
```

---

- Path: `api-reference/phone`
- URL: https://developer.incode.com/api-reference/phone/
- Markdown: https://developer.incode.com/api-reference/phone.md
- Endpoint: `GET /omni/phone`

# Get phone

`GET /omni/phone`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get the phone previously added to the interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/phone?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "phone": "string"
}
```

---

- Path: `api-reference/phone-post`
- URL: https://developer.incode.com/api-reference/phone-post/
- Markdown: https://developer.incode.com/api-reference/phone-post.md
- Endpoint: `POST /omni/phone`

# Add phone

`POST /omni/phone`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Add phone to interview

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string |  | User's phone number. E.164 number convention. |
| `optInGranted` | boolean |  | Indicates whether opt-in is granted Default: `false` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `existingCustomer` | boolean |  | Flag indicating if this user with given phone already exists in the system. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/phone \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/phone", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/phone", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/phone"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/phone")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "existingCustomer": true
}
```

---

- Path: `api-reference/process-antifraud`
- URL: https://developer.incode.com/api-reference/process-antifraud/
- Markdown: https://developer.incode.com/api-reference/process-antifraud.md
- Endpoint: `GET /omni/process/antifraud`

# Process Antifraud

`GET /omni/process/antifraud`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint should be called only after [process-id](ref:processid) and [process-face](ref:processface) both are over.
This endpoint gives ability to compare current interview with existing interviews and customers and detect anomalies than could be signs of fraud.
**Important: Calling this endpoint affects the total [score](ref:getscores).**

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string |  | Enum: `FAILED`, `PASSED`, `NOT_EXECUTED`, `MANUAL_REVIEW` |
| `stepName` | string |  | Enum: `FuzzyFieldAntifraudExecutor`, `IdFaceAntifraudExecutor`, `SelfieFaceAntifraudExecutor`, `AttemptLimitAntifraudExecutor` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/process/antifraud \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/antifraud", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/process/antifraud", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/antifraud"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/antifraud")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/antifraud");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "status": "FAILED",
  "stepName": "FuzzyFieldAntifraudExecutor"
}
```

---

- Path: `api-reference/process-approve`
- URL: https://developer.incode.com/api-reference/process-approve/
- Markdown: https://developer.incode.com/api-reference/process-approve.md
- Endpoint: `POST /omni/process/approve`

# Approve customer

`POST /omni/process/approve`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Approve customer for omnichannel program. Body is optional and used for auto approve when only specific features
should be approved. It is not possible to approve twice the same user (e.g. with the same phone number).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  | Session id for which approval is requested. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `approveComponents` | array[string] |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `uuid` | string |  | Id of newly created customer if approval was successful. |
| `token` | string |  | Access token to be used for newly created customer, in case approval was successful. |

### 400

Custom error status: - 4006: User with given phone already exists

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/approve?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "uuid": "string",
  "token": "string"
}
```

---

- Path: `api-reference/process-face`
- URL: https://developer.incode.com/api-reference/process-face/
- Markdown: https://developer.incode.com/api-reference/process-face.md
- Endpoint: `POST /omni/process/face`

# Process face

`POST /omni/process/face`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

**Note: This endpoint should be called only after [selfie](#/Onboarding/addFaceByThirdParty)
and [front-id](#/Onboarding/addFrontIdV2) both are over.**

It is validating user's selfie against photo from ID (1:1 recognition).
Also, this call validates if user already exists in the system (1:N recognition).

**It is highly recommended that before calling this process-face endpoint, one should first finish following endpoints:
[add-front](#/Onboarding/addFrontIdV2), [add-back](#/Onboarding/addBackIdV2)(not required in case of passports),
[process-id](#/Onboarding/processId) and [add-selfie](#/Onboarding/addFaceByThirdParty) in order to get complete result view
based on id verification, face recognition and liveness.**

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `imageType` | query | string |  | Enum: `selfie`, `videoSelfie` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `confidence` | number (float) | yes | Value 0 means that selfie doesn't match face photo from ID. |
| `existingUser` | boolean | yes | Flag indicating if this user already exists in the system. |
| `existingInterviewId` | string |  | Session id where user is approved previously (existingUser=true). |
| `existingExternalId` | string |  | In case the session does have an externalId which can be assigned at start call. |
| `nameMatched` | boolean |  | In case user is approved previously (existingUser=true), flag indicating if names are matching. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/face?imageType=%3CimageType%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "confidence": 0,
  "existingUser": true,
  "existingInterviewId": "string",
  "existingExternalId": "string",
  "nameMatched": true
}
```

---

- Path: `api-reference/process-face-vs-second-id`
- URL: https://developer.incode.com/api-reference/process-face-vs-second-id/
- Markdown: https://developer.incode.com/api-reference/process-face-vs-second-id.md
- Endpoint: `POST /omni/process/face-vs-second-id`

# Process face vs second id

`POST /omni/process/face-vs-second-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

**Note**: This endpoint should be called only after [selfie](#/Onboarding/addFaceByThirdParty) and
[front-second-id](#/Onboarding/addFrontSecondIdV2) both are over.

It is validating user's selfie against photo from ID (1:1 recognition). Also, this call validates if user already exists
in the system (1:N recognition).

It is highly recommended that before calling this process-face endpoint, one should first finish following endpoints:
[add-front-secondId](#/Onboarding/addFrontSecondIdV2), [add-back-secondId](#/Onboarding/addBackSecondIdV2) (not required in
case of passports), [process-secondId](#/Onboarding/processSecondId) and [add-selfie](#/Onboarding/addFaceByThirdParty) in order
to get complete result view based on id verification, face recognition and liveness.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `imageType` | query | string |  | Enum: `selfie`, `videoSelfie` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `confidence` | number (float) | yes | Value 0 means that selfie doesn't match face photo from ID. |
| `existingUser` | boolean | yes | Flag indicating if this user already exists in the system. |
| `existingInterviewId` | string |  | Session id where user is approved previously (existingUser=true). |
| `existingExternalId` | string |  | In case the session does have an externalId which can be assigned at start call. |
| `nameMatched` | boolean |  | In case user is approved previously (existingUser=true), flag indicating if names are matching. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/face-vs-second-id?imageType=%3CimageType%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "confidence": 0,
  "existingUser": true,
  "existingInterviewId": "string",
  "existingExternalId": "string",
  "nameMatched": true
}
```

---

- Path: `api-reference/process-global-watchlist`
- URL: https://developer.incode.com/api-reference/process-global-watchlist/
- Markdown: https://developer.incode.com/api-reference/process-global-watchlist.md
- Endpoint: `POST /omni/process/global-watchlist`

# Process global watchlist

`POST /omni/process/global-watchlist`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint processes a global watchlist search for an individual using the watchlist configuration defined in the flow (including settings for subscription to ongoing monitoring).
It performs a comprehensive screening against global watchlists (sanctions, PEPs, adverse media) and saves the results for further processing.
The endpoint returns a basic success/failure response.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `firstName` | string |  |  |
| `surName` | string |  |  |
| `birthYear` | integer (int32) |  | Year of birth, if known |
| `countryCodes` | array |  |  |
| `watchlistTypes` | array |  |  |
| `subscribe` | boolean |  | Subscribes to updates on the watchlists to receive notification for updates on the search. |
| `fuzziness` | number (float) |  | Determines how closely the returned results must match the supplied name. |
| `search_profile` | string |  | Search profile set for the client to use specify what sources they will be searching against. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/global-watchlist \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/global-watchlist", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/global-watchlist", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/global-watchlist"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/global-watchlist")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/global-watchlist");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/process-government-validation`
- URL: https://developer.incode.com/api-reference/process-government-validation/
- Markdown: https://developer.incode.com/api-reference/process-government-validation.md
- Endpoint: `POST /omni/process/government-validation`

# Process government validation

`POST /omni/process/government-validation`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint reads the country code from the interview which can be set at the moment of calling the start endpoint or
is updated based on the processed id. Request body can optionally contain data from id in JSON. If omitted, data from
scanned ID is read.

**Country codes**:

**MEX**: Mexico - INE Validation. When government face validation is enabled this method compares the user's selfie against
the image in the INE database. The method should be called after [add-face](/api-reference/add-face-third-party/) is over and
one of ([process-id](/api-reference/process-id/) or [document-id](/api-reference/add-document-id/)) is over.

Request parameters:
- fallbackEnabled: Boolean, optional. If it is not sent, it will default to false.
- scrapingMethod: Boolean, optional. If it is not sent, it will default to false.

If parameter fallbackEnabled is true and there's some connection or infrastructure error with the INE service, validation by
scraping will start. If parameter scrapingMethod is true, then direct connection to INE service won't be attempted and
the scraping approach will be used instead.

Request Body is optional - if not sent, data will be taken from the session:
- ocr: String, mandatory for INE and IFE.
- cic: String, mandatory for INE.
- nombre: String, optional.
- apellidoPaterno: String, optional.
- apellidoMaterno: String, optional.
- anioRegistro: String, optional.
- anioEmision: String, optional.
- numeroEmisionCredencial: String, mandatory for ife.
- claveElector: String, mandatory for ife.
- curp: String, optional.

**COL**: Colombia - Registraduría Validation. Currently there's no option for face validation. Can validate registraduría or
extranjería (foreign citizens living in colombia). **Note**: Government Validations for Colombia acquired via TusDatos

Request Body is optional - if not sent data will be taken from the session:
- idNumber: String, mandatory.
- fechaEmision: String, mandatory when Nationality is not Columbia. Format dd/mm/yyyy
- nombre: String, optional.
- apellidoPaterno: String, optional.
- apellidoMaterno: String, optional.

**ARG**: Argentina - Renaper Validation. Currently there's no option for face validation.

Request Body:
- idNumber: String, mandatory.

**PER**: Peru - Reniec Validation. Currently there's no option for face validation. Can validate Reniec. **Note**: Government
Validations for Peru obtained by checking against TOC, a risk database. ID must include DNI in order to validate.
Request Body is optional - if not sent data will be taken from the session.
- idNumber: String, mandatory (corresponds to DNI number)
- nombre: String, optional - if not provided ocrValidation for FistName will be UNKNOWN
- apellidoPaterno: String, optional - if not provided ocrValidation for PaternalLastName will be UNKNOWN
- apellidoMaterno: String, optional - if not provided ocrValidation for MaternalLastName will be UNKNOWN
- birthDate: String, optional - if not provided ocrValidation for BirthDate will be UNKNOWN
- gender: String, optional - if not provided ocrValidation for Gender will be UNKNOWN

**CHL**: Chile - Sinacofi Validation. Currently there's no option for face validation. Can validate Sinacofi. **Note**:
Government Validations for Chile obtained by checking against TOC, a risk database. ID must include DNI in order to validate.
Request Body is optional - if not sent data will be taken from the session:
- idNumber: String, mandatory (corresponds Serie)
- personalNumber: String, mandatory (corresponds RUT/RUN)

**AUS**: Australia - Government Validation for Passport and Driver License.
Request Body is optional - if not sent data will be taken from the OCR.

For Passport validation:
- firstName: String, mandatory.
- middleName: String, optional.
- paternalLastName: String, mandatory.
- cic: String, mandatory (corresponds to Passport number).
- documentType: String, mandatory ("Passport").
- birthDate: String, mandatory. Format yyyy/MM/dd.
- address: String, optional.

For Driver License validation:
- firstName: String, mandatory.
- middleName: String, optional.
- paternalLastName: String, mandatory.
- documentType: String, mandatory ( com"DriversLicense").
- birthDate: String, mandatory. Format yyyy/MM/dd.
- refNumber: String, mandatory (corresponds to Card number).
- cic: String, mandatory (corresponds to License number).
- issuerState: String, mandatory (e.g., "NSW").
- address: String, optional.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `fallbackEnabled` | query | boolean |  | Default: `false` |
| `scrapingMethod` | query | boolean |  | Default: `false` |
| `scrapingV2` | query | boolean |  | Default: `false` |
| `scrapingV3` | query | boolean |  | Default: `false` |
| `interviewId` | query | string |  |  |
| `countryCode` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ocr` | string |  |  |
| `cic` | string |  |  |
| `nombre` | string |  |  |
| `apellidoPaterno` | string |  |  |
| `apellidoMaterno` | string |  |  |
| `anioRegistro` | string |  |  |
| `anioEmision` | string |  |  |
| `numeroEmisionCredencial` | string |  |  |
| `claveElector` | string |  |  |
| `curp` | string |  |  |
| `base64Image` | string |  |  |
| `idNumber` | string |  |  |
| `fechaEmision` | string |  |  |
| `personalNumber` | string |  |  |
| `birthDate` | string |  |  |
| `gender` | string |  |  |
| `birthPlace` | string |  |  |
| `address` | string |  |  |
| `addressLine2` | string |  |  |
| `addressState` | string |  |  |
| `latitude` | string |  |  |
| `longitude` | string |  |  |
| `macAddress` | string |  |  |
| `ip` | string |  |  |
| `osVersion` | string |  |  |
| `applicationName` | string |  |  |
| `sufix` | string |  |  |
| `firstName` | string |  |  |
| `givenName` | string |  |  |
| `middleName` | string |  |  |
| `maternalLastName` | string |  |  |
| `paternalLastName` | string |  |  |
| `documentType` | string |  | Enum: `Unknown`, `Passport`, `Visa`, `DriversLicense`, `IdentificationCard`, `Permit`, `Currency`, `ResidenceDocument`, `TravelDocument`, `BirthCertificate`, `VehicleRegistration`, `Other`, `WeaponLicense`, `TribalIdentification`, `VoterIdentification`, `Military`, `TaxIdentification`, `FederalID`, `MedicalCard` |
| `refNumber` | string |  |  |
| `issuerState` | string |  |  |
| `aamvaMessageDestination` | string |  |  |
| `realIdConformantCode` | string |  |  |
| `driverLicenseNonCommercialStatusCode` | string |  |  |
| `documentTypeId` | integer (int32) |  |  |
| `issuedAt` | string |  |  |
| `documentNumber` | string |  |  |
| `expireAt` | string |  |  |
| `eyeColor` | string |  |  |
| `height` | string |  |  |
| `weight` | string |  |  |
| `city` | string |  |  |
| `postalCode` | string |  |  |
| `email` | string |  |  |
| `fullName` | string |  |  |
| `nationality` | string |  |  |
| `dateFormat` | string |  |  |
| `fingerprintsData` | FingerprintsData |  |  |
| `fingerprintsData.type` | integer (int32) |  |  |
| `fingerprintsData.fingerprints` | array[Fingerprint] | yes |  |
| `fingerprintsData.fingerprints.index` | integer (int32) |  |  |
| `fingerprintsData.fingerprints.base64Fingerprint` | string |  |  |
| `fingerprintsData.fingerprints.fingerprintMetadata` | FingerprintMetadata |  |  |
| `fingerprintsData.fingerprints.fingerprintMetadata.device` | string |  |  |
| `fingerprintsData.fingerprints.fingerprintMetadata.resolution` | string |  |  |
| `fingerprintsData.fingerprints.fingerprintMetadata.qualityScore` | string |  |  |

## Responses

### 200

Responses: **MEX**: - statusCode: Integer. Possible values: - OK (0, "ok"), - VALIDATION_ERROR (1, "validationError"), - INE_CONNECTION_ERROR (2, "ineConnectionError"), - INE_INFRASTRUCTURE_ERROR (3, "ineInfrastructureError"), - MODULE_NOT_SUPPORTED (4, "moduleNotSupported"), - MISSING_DOCUMENT_ID (5, "missingDocumentId"), - MISSING_SELFIE (6, "missingSelfie"), - USER_NOT_FOUND (7, "userNotFound"); - USER_NOT_FOUND_IN_INE_DB (8, "userNotFoundInIneDb"), - NOT_ENOUGH_DATA (9, "notEnoughData"), - LIVENESS_FAIL (10, "livenessFail") - INE_NOT_CURRENT (11, "ineNotCurrent") - INE_REPORTED_LOST (12, "ineReportedLost") - INE_REPORTED_STOLEN (13, "ineReportedStolen") - INE_SIGNATURE_ERROR (14, "ineSignaturError") - INE_NOT_VALID (15, "ineNotValid") - PROVIDER_UNAVAILABLE (98, "providerUnavailable"). Also returned for an INE-side service degradation (codigoRespuesta=0 with similitud1=null): the face comparison never produced a score, so recognitionConfidence stays null — distinct from a real face mismatch. In that case errorDescription identifies the cause. - COUNTRY_NOT_SUPPORTED (99, "countryNotSupported") - PROCESSING_INE (-1, "processingIne"). It only applies for Listas Nominales (INE Scraping). - PROCESSING (-4, "processing") - CONNECTION_ERROR (17, "connectionError") - INFRASTRUCTURE_ERROR (18, "infrastructureError") - TRANSACTION_LIMIT_REACHED (205, "transactionLimitReached") - valid: Boolean. Flag stating if request processed successfully. - registralSituation: Structure with following fields: - tipoSituacionRegistral: String. Possible values: [ VIGENTE, NO_VIGENTE, DATOS_NO_ENCONTRADOS ] - tipoReporteRoboExtravio: String, optional. Possible values: [ null, REPORTE_DE_EXTRAVIO, REPORTE_DE_ROBO, REPORTE_DE_ROBO_TEMPORAL, REPORTE_DE_EXTRAVIO_TEMPORAL ] - governmentValidation: Structure with following fields: - validationStatus: Structure with following fields: - value: Look statusCode - status: Look statusCode - key: - ok: when value OK - error: when value VALIDATION_ERROR, INE_INFRASTRUCTURE_ERROR, USER_NOT_FOUND_IN_INE_DB, INE_NOT_CURRENT, INE_REPORTED_LOST, INE_REPORTED_STOLEN, USER_NOT_FOUND, TRANSACTION_LIMIT_REACHED - unknown: otherwise - ocrValidation: Array of structure with following fields: - value: Possible values - true false empty - status: Possible values - OK FAIL UNKNOWN - key: Possible values - issueDate firstName maternalLastName paternalLastName ocr personalId electorsKey emissionNumber registrationDate - ocrValidationOverall: Structure with following fields: - value: Calculated value based on Ocr Validation between 0 and 100 - status: OK or FAIL based on calculation - overall: Same as ocrValidationOverall - ocrData: Look at fetch-OCR - deviceInfo: Look at fetch-deviceInfo - ineTransactionId: String **COL**: - statusCode: 0 - OK, other not OK* - governmentValidation - consists of the following fields: - validationStatus - following values: - OK (0, "ok"), - VALIDATION_ERROR (1, "validationError"), - CONNECTION_ERROR (17, "connectionError"), - USER_NOT_FOUND (7, "userNotFound"), - NOT_ENOUGH_DATA (9, "notEnoughData") - ocrValidation: Array of structure with following fields: - value: Possible values - true false empty - status: Possible values - OK FAIL UNKNOWN - key: Possible values - firstName maternalLastName paternalLastName ocr birthDate gender - governmentValidationResponse (DEPRECATED): - COL1: "governmentValidationResponse": { "codError": "0", "contract_id": 111, "departamentoExpedicion": "ATLANTICO", "descripcionEstado": "VIGENTE", "estadoCedula": "0", "fechaExpedicion": "31/12/1990", "fechaHoraConsulta": "2025-03-12 20:32:29", "municipioExpedicion": "BARRANQUILLA", "nuip": "000000000", "particula": "DE", "primerApellido": "Perez", "primerNombre": "Jose", "segundoApellido": "Perez", "segundoNombre": "Juan" } - COL2: "governmentValidationResponse": { "data": { "anio_resolucion": 0, "codigo_error_datos_cedula": 0, "codigo_respuesta": "", "departamento_expedicion": "ATLANTICO", "descripcion_estado": "Vigente", "estado_cedula": 0, "fecha_expedicion": "Mon, 31 Dec 1990 00:00:00 GMT", "informacion_adicional": "", "municipio_expedicion": "BARRANQUILLA", "nombre_completo": "Jose Juan Perez Perez", "nuip": 000000000, "numero_resolucion": 0, "particula": "DE", "primer_apellido": "Perez", "primer_nombre": "Jose", "segundo_apellido": "Perez", "segundo_nombre": "Juan" } } - ocrValidationOverall: - ocrValidationOverall: 100 - 15 each fail or unknown ocrValidation - status: ocrValidationOverall > 55 => OK, else FAIL - overall: same as ocrValidationOverall **ARG**: - statusCode: Integer. Value 0 means verification Ok. - governmentValidation - consists of following fieds: - validationStatus - following values: - OK (0, "ok") - FACE_COMPARISON_FAILED (207, "faceComparisonFailed") - PROCESSING (-4, "processing") - PROVIDER_NOT_CONFIGURED (96, "providerNotConfigured") - PROVIDER_UNAVAILABLE (98, "providerUnavailable") - USER_NOT_FOUND (7, "userNotFound") - VALIDATION_ERROR (1, "validationError") - NO_INFORMATION (204, "noInformation") **PER**: - statusCode: 0 - OK, other not OK - governmentValidation - consists of following fieds: - validationStatus - following values: - OK (0, "ok"), - VALIDATION_ERROR (1, "validationError"), - INE_CONNECTION_ERROR (2, "ineConnectionError"), - USER_NOT_FOUND (7, "userNotFound"), - NOT_ENOUGH_DATA (9, "notEnoughData") - ocrValidation: Array of structure with following fields: - value: Possible values - true false empty - status: Possible values - OK FAIL UNKNOWN - key: Possible values - documentNumber firstName maternalLastName paternalLastName ocr birthDate gender - governmentValidationResponse: Response received from external source (see example) - ocrValidationOverall: - ocrValidationOverall: 100 - 15*each fail or unknown ocrValidation - status: ocrValidationOverall > 55 => OK, else FAIL - overall: same as ocrValidationOverall **CHL**: - statusCode: 0 - OK, other not OK - governmentValidation - consists of following fieds: - validationStatus - following values: - OK (0, "ok"), - VALIDATION_ERROR (1, "validationError"), - INE_CONNECTION_ERROR (2, "ineConnectionError"), - USER_NOT_FOUND (7, "userNotFound"), - NOT_ENOUGH_DATA (9, "notEnoughData") - ocrValidation: Array of structure with following fields: - value: Possible values - true false empty - status: Possible values - OK FAIL UNKNOWN - key: Possible values - documentNumber firstName maternalLastName paternalLastName ocr birthDate gender - governmentValidationResponse: Response received from external source (see example) - ocrValidationOverall: - ocrValidationOverall: 100 - 15*each fail or unknown ocrValidation - status: ocrValidationOverall > 55 => OK, else FAIL - overall: same as ocrValidationOverall **AUS**: - statusCode: 0 - OK, other not OK - valid: Boolean. Flag stating if request processed successfully. - governmentValidation - consists of following fields: - validationStatus - following values: - OK (0, "ok"), - USER_NOT_FOUND (7, "userNotFound"), - NOT_ENOUGH_DATA (9, "notEnoughData"), - CONNECTION_ERROR (17, "connectionError") - ocrValidation: Array of structure with following fields: - value: Possible values - true false - status: Possible values - OK FAIL - key: Possible values - documentNumber firstName paternalLastName birthDate expirationDate issueDate - ocrValidationOverall: - value: Calculated value between 0 and 100 - status: OK or FAIL based on calculation - overall: Same as ocrValidationOverall - errorDescription: String. Present only in error responses with values like "userNotFound", "notEnoughData", "connectionError" **BRA**: - statusCode: 0 - OK, other not OK. Always mirrors validationStatus and is independent of the overall score. - valid: Boolean. True when validationStatus is OK (statusCode 0), i.e. CPF found. Note this tracks validationStatus, NOT the overall score: an OCR-field mismatch or a SERPRO_FACE face mismatch can leave valid=true while overall is FAIL. - governmentValidation - consists of following fields: - validationStatus - following values: - OK (0, "ok"): CPF found, data and/or face matched - VALIDATION_ERROR (1, "validationError") - MODULE_NOT_SUPPORTED (4, "moduleNotSupported") - MISSING_SELFIE (6, "missingSelfie"): required for SERPRO_FACE - USER_NOT_FOUND (7, "userNotFound"): CPF not found, or face not matched - CPF_NUMBER_INVALID_OR_MISSING (16, "cpfNumberInvalidOrMissing") - CONNECTION_ERROR (17, "connectionError") - PROVIDER_NOT_CONFIGURED (96, "providerNotConfigured") - PROVIDER_UNAVAILABLE (98, "providerUnavailable") - GEOGRAPHIC_REGION_NOT_SUPPORTED (99, "geographicRegionNotSupported") - recognitionConfidence: Present when government face validation is attempted (e.g. SERPRO_FACE). - value: "100.0" when face matched, "0.0" when no match or face not in SERPRO DB - status: OK when matched, FAIL otherwise - ocrValidation: Array of structure with following fields (present for both SERPRO and SERPRO_FACE when validationStatus is OK): - value: Possible values - true false - status: Possible values - OK FAIL UNKNOWN - key: Possible values - documentNumber fullName birthDate Note: fullName is derived from firstName, paternalLastName, and maternalLastName, which all map to the same SERPRO nome field and always share the same status. - ocrValidationOverall: - value: Calculated value between 0 and 100 - status: OK or FAIL based on calculation - overall: Equals ocrValidationOverall for SERPRO. For SERPRO_FACE the face recognitionConfidence can override it (e.g. face not in DB / not matched drives overall to 0.0 FAIL even when ocrValidationOverall is OK). - errorDescription: String. Present only in error responses

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `valid` | boolean |  |  |
| `statusCode` | integer (int32) |  |  |
| `governmentValidation` | GovernmentValidation |  | - recognitionConfidence: Present when government face validation is attempted (e.g. SERPRO_FACE). - value: "100.0" when face matched, "0.0" when no match or face not in SERPRO DB - status: OK when face matched, FAIL when no match or face not in SERPRO DB - validationStatus: Key-value mapping: - OK (0, "ok"): CPF found, data and/or face matched - VALIDATION_ERROR (1, "validationError") - MODULE_NOT_SUPPORTED (4, "moduleNotSupported") - MISSING_SELFIE (6, "missingSelfie"): selfie required for SERPRO_FACE - USER_NOT_FOUND (7, "userNotFound"): CPF not found in government DB, or face not matched - CPF_NUMBER_INVALID_OR_MISSING (16, "cpfNumberInvalidOrMissing") - CONNECTION_ERROR (17, "connectionError") - PROVIDER_NOT_CONFIGURED (96, "providerNotConfigured") - PROVIDER_UNAVAILABLE (98, "providerUnavailable") - GEOGRAPHIC_REGION_NOT_SUPPORTED (99, "geographicRegionNotSupported") - ocrValidation: List of value/status/key objects. Keys present for Brazil: - documentNumber: CPF validity check - fullName: name match (derived from firstName, paternalLastName, maternalLastName — all map to the same SERPRO nome field and always share the same status) - birthDate: date of birth match Not all keys are always present. - ocrValidationOverall: Composite result for ocrValidation score - overall: Equals ocrValidationOverall for SERPRO; for SERPRO_FACE the face recognitionConfidence can override it (e.g. face not in DB / not matched drives overall to 0.0 FAIL even when ocrValidationOverall is OK) |
| `governmentValidation.recognitionConfidence` | ResultBean |  |  |
| `governmentValidation.recognitionConfidence.value` | string |  |  |
| `governmentValidation.recognitionConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.fingerprintConfidence` | ResultBean |  |  |
| `governmentValidation.fingerprintConfidence.value` | string |  |  |
| `governmentValidation.fingerprintConfidence.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.minimumPassingFingerprints` | integer (int32) |  |  |
| `governmentValidation.validationStatus` | IdResultBean |  |  |
| `governmentValidation.validationStatus.value` | string |  |  |
| `governmentValidation.validationStatus.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.validationStatus.key` | string |  |  |
| `governmentValidation.ocrValidation` | array[IdResultBean] |  |  |
| `governmentValidation.ocrValidation.value` | string |  |  |
| `governmentValidation.ocrValidation.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.ocrValidation.key` | string |  |  |
| `governmentValidation.credentialStatus` | array[IdResultBean] |  |  |
| `governmentValidation.credentialStatus.value` | string |  |  |
| `governmentValidation.credentialStatus.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.credentialStatus.key` | string |  |  |
| `governmentValidation.registryData` | GovernmentRegistryData |  | Values the government source holds for the person, under provider-neutral names so the same field reads the same across providers. Present only when the provider shown in "provider" reported at least one value. |
| `governmentValidation.registryData.taxIdNumber` | string |  | Tax identification number the government source holds for the person: Argentina CUIL from RENAPER_PREMIUM and MM_ARGENTINA_RENAPER_EXTENDED. |
| `governmentValidation.ocrValidationOverall` | ResultBean |  |  |
| `governmentValidation.ocrValidationOverall.value` | string |  |  |
| `governmentValidation.ocrValidationOverall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.overall` | ResultBean |  |  |
| `governmentValidation.overall.value` | string |  |  |
| `governmentValidation.overall.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `governmentValidation.provider` | string |  |  |
| `governmentValidation.validationSource` | string |  | Enum: `ID_CAPTURE`, `REQUEST_BODY`, `KYX_PREFILL` |
| `governmentValidation.appliedRule` | AppliedFlowRule |  | Specific rule from rule engine |
| `governmentValidation.appliedRule.name` | string |  | Name of the rule. |
| `governmentValidation.appliedRule.expression` | string |  | A logical expression of the rule. |
| `governmentValidation.appliedRule.ruleType` | string |  | Enum: `idValidation`, `secondIdValidation`, `faceValidation`, `liveness`, `deepsight`, `eKyc`, `videoselfie`, `faceAuthentication`, `total`, `phoneRisk`, `emailRisk`, `governmentValidation` |
| `governmentValidation.appliedRule.status` | string |  | Enum: `OK`, `WARN`, `FAIL`, `UNKNOWN`, `MANUAL`, `MANUAL_OK`, `MANUAL_FAIL`, `MANUAL_PENDING` |
| `errorDescription` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 409

Another government-validation request is already in progress for this interview. Wait for it to finish instead of retrying immediately.

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/government-validation?fallbackEnabled=false&scrapingMethod=false&scrapingV2=false&scrapingV3=false&interviewId=%3CinterviewId%3E&countryCode=%3CcountryCode%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "valid": true,
  "statusCode": 0,
  "registralSituation": {
    "tipoSituacionRegistral": "string",
    "tipoReporteRoboExtravio": "string"
  },
  "governmentValidation": {
    "recognitionConfidence": {
      "value": "string",
      "status": "OK"
    },
    "validationStatus": {
      "value": "string",
      "status": "OK",
      "key": "string"
    },
    "ocrValidation": [
      {
        "value": "string",
        "status": "OK",
        "key": "string"
      }
    ],
    "ocrValidationOverall": {
      "value": "string",
      "status": "OK"
    },
    "overall": {
      "value": "string",
      "status": "OK"
    }
  },
  "curpCecobanValidation": {
    "returnCode": "string",
    "description": "string",
    "uniquePopulationRegistrationKeyMatch": true
  },
  "customFields": {
    "additionalProp": "string"
  },
  "ocrData": {
    "name": {
      "fullName": "string",
      "fullNameNativeScript": "string",
      "machineReadableFullName": "string",
      "firstName": "string",
      "middleName": "string",
      "givenName": "string",
      "givenNameMrz": "string",
      "nameSuffix": "string",
      "paternalLastName": "string",
      "maternalLastName": "string",
      "lastNameMrz": "string"
    },
    "address": "string",
    "addressFields": {
      "street": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string"
    },
    "fullAddress": true,
    "invalidAddress": true,
    "checkedAddress": "string",
    "checkedAddressBean": {
      "street": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string"
    },
    "exteriorNumber": "string",
    "interiorNumber": "string",
    "addressFromStatement": "string",
    "addressFieldsFromStatement": {
      "street": "string",
      "colony": "string",
      "postalCode": "string",
      "city": "string",
      "state": "string",
      "stateName": "string",
      "district": "string",
      "stateCode": "string",
      "addressCountryCode": "string",
      "label": "string"
    },
    "invalidAddressFromStatement": true,
    "addressStatementEmissionDate": 0,
    "documentType": "a1",
    "addressStatementTimestamps": [
      {
        "dateType": "string",
        "addressStatementTimestamp": 0
      }
    ],
    "poaName": "string",
    "typeOfId": "string",
    "documentFrontSubtype": "string",
    "documentBackSubtype": "string",
    "birthDate": 0,
    "gender": "M",
    "claveDeElector": "string",
    "curp": "string",
    "numeroEmisionCredencial": "string",
    "cic": "string",
    "ocr": "string",
    "documentNumber": "string",
    "documentNumberSource": "FORM",
    "personalNumber": "string",
    "nationalNumber": "string",
    "refNumber": "string",
    "taxIdNumber": "string",
    "nue": "string",
    "externalId": "string",
    "issuedAt": "string",
    "expireAt": "string",
    "expirationDate": 0,
    "issueDate": 0,
    "registrationDate": 0,
    "dlClassDetails": [
      {
        "dlClass": "string",
        "validFromDate": 0,
        "validToDate": 0,
        "additionalCodes": "string"
      }
    ],
    "issuingCountry": "string",
    "issuingState": "string",
    "birthPlace": "string",
    "issuingAuthority": "string",
    "height": "string",
    "weight": "string",
    "eyeColor": "string",
    "hairColor": "string",
    "bloodType": "string",
    "maritalStatus": "string",
    "nationality": "string",
    "race": "string",
    "nationalityMrz": "string",
    "nationalityAlpha3": "string",
    "governmentComparisonResults": {
      "paternalLastNameValid": true,
      "maternalLastNameValid": true,
      "firstNameValid": true,
      "curpValid": true,
      "ocrValid": true,
      "claveDeElectorValid": true,
      "numeroEmisionCredencialValid": true,
      "registrationDateValid": true,
      "issueDateValid": true
    },
    "notExtracted": 0,
    "notExtractedDetails": [
      "string"
    ],
    "classes": "string",
    "cond": "string",
    "mentions": "string",
    "restrictions": "string",
    "mrz1": "string",
    "mrz2": "string",
    "mrz3": "string",
    "fullNameMrz": "string",
    "documentNumberCheckDigit": "string",
    "dateOfBirthCheckDigit": "string",
    "expirationDateCheckDigit": "string",
    "barcodeRawData": "string",
    "fathersName": "string",
    "mothersName": "string",
    "spouseName": "string",
    "federalRevenueNumber": "string",
    "originDocumentId": "string",
    "driversLicenseCategory": "string",
    "controlNumber": "string",
    "renach": "string",
    "additionalAttrs": [
      "DOCUMENTO_INFANTIL"
    ],
    "ocrDataConfidence": {
      "birthDateConfidence": 0,
      "nameConfidence": 0,
      "nameNativeScriptConfidence": 0,
      "givenNameConfidence": 0,
      "firstNameConfidence": 0,
      "middleNameConfidence": 0,
      "nameSuffixConfidence": 0,
      "mothersSurnameConfidence": 0,
      "fathersSurnameConfidence": 0,
      "nickNameConfidence": 0,
      "fullNameMrzConfidence": 0,
      "mothersNameConfidence": 0,
      "fathersNameConfidence": 0,
      "spouseNameConfidence": 0,
      "addressConfidence": 0,
      "streetConfidence": 0,
      "colonyConfidence": 0,
      "postalCodeConfidence": 0,
      "cityConfidence": 0,
      "stateConfidence": 0,
      "districtConfidence": 0,
      "stateCodeConfidence": 0,
      "countryCodeConfidence": 0,
      "genderConfidence": 0,
      "issueDateConfidence": 0,
      "expirationDateConfidence": 0,
      "issuedAtConfidence": 0,
      "expireAtConfidence": 0,
      "issuingAuthorityConfidence": 0,
      "mrz1Confidence": 0,
      "mrz2Confidence": 0,
      "mrz3Confidence": 0,
      "mrzFullConfidence": 0,
      "documentNumberConfidence": 0,
      "backNumberConfidence": 0,
      "personalNumberConfidence": 0,
      "nationalNumberConfidence": 0,
      "claveDeElectorConfidence": 0,
      "numeroEmisionCredencialConfidence": 0,
      "curpConfidence": 0,
      "nueConfidence": 0,
      "registrationDateConfidence": 0,
      "heightConfidence": 0,
      "birthPlaceConfidence": 0,
      "bloodTypeConfidence": 0,
      "eyeColorConfidence": 0,
      "classesConfidence": 0,
      "condConfidence": 0,
      "mentionsConfidence": 0,
      "refNumberConfidence": 0,
      "weightConfidence": 0,
      "hairConfidence": 0,
      "restrictionsConfidence": 0,
      "nationalityConfidence": 0,
      "nationalityMrzConfidence": 0,
      "maritalStatusConfidence": 0,
      "raceConfidence": 0,
      "taxIdNumberConfidence": 0,
      "jurisdictionCodeConfidence": 0
    },
    "additionalDocumentAttempts": [
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "firstName": "string",
        "lastName": "string",
        "countryOfOrigin": "string",
        "dateOfBirth": 0,
        "expiryDate": 0,
        "issueDate": 0,
        "gender": "MALE",
        "nationality": "string",
        "placeOfIssue": "string",
        "referenceNumber": "string",
        "residentialAddressLines": [
          "string"
        ]
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "address": "string",
        "accountNumber": "string",
        "bankName": "string",
        "documentDate": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "curpNumber": "string",
        "registrationDate": 0,
        "registrationEntity": "string",
        "idNumber": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "address": "string",
        "issueDate": 0
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "rfcNumber": "string",
        "corporateName": "string",
        "fullName": "string",
        "declarationType": "string",
        "fiscalYear": 0,
        "submissionDate": 0,
        "hasIncomeStatement": true,
        "hasFinancialPositionStatement": true,
        "totalIncome": 0,
        "capitalFromContributions": 0,
        "capitalFromCapitalization": 0,
        "accumulatedLosses": 0,
        "currentYearLosses": 0,
        "accumulatedProfits": 0,
        "currentYearProfits": 0,
        "amountToPay": 0,
        "amountDue": 0,
        "operationNumber": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "issueDate": 0,
        "rfcNumber": "string",
        "corporateName": "string",
        "fullName": "string",
        "registryStatus": "string",
        "addressComponents": {
          "street": "string",
          "colony": "string",
          "postalCode": "string",
          "city": "string",
          "state": "string",
          "stateName": "string",
          "district": "string",
          "stateCode": "string",
          "addressCountryCode": "string",
          "label": "string"
        },
        "economicActivities": [
          {
            "title": "string",
            "percentage": 0,
            "startDate": 0,
            "endDate": 0
          }
        ],
        "regimes": [
          {
            "title": "string",
            "startDate": 0,
            "endDate": 0
          }
        ],
        "barcodes": [
          {
            "format": "string",
            "contentType": "string",
            "text": "string",
            "error": "string"
          }
        ]
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "name": "string",
        "address": "string",
        "timestamp": 0,
        "addressStatementTimestamps": [
          {
            "dateType": "string",
            "addressStatementTimestamp": 0
          }
        ],
        "issuer": "a1",
        "addressComponents": {
          "street": "string",
          "colony": "string",
          "postalCode": "string",
          "city": "string",
          "state": "string",
          "stateName": "string",
          "district": "string",
          "stateCode": "string",
          "addressCountryCode": "string",
          "label": "string"
        }
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "firstNames": "string",
        "lastName": "string",
        "gender": "MALE",
        "countryOfBirth": "string",
        "dateOfBirth": 0,
        "nationality": "string",
        "maritalStatus": "string",
        "issueDate": 0,
        "expiryDate": 0,
        "idNumber": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "gender": "MALE",
        "dateOfBirth": 0,
        "issueDate": 0,
        "countryOfBirth": "string",
        "nationality": "string",
        "maritalStatus": "string",
        "documentNumber": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "rfcNumber": "string",
        "idCIF": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string"
      },
      {
        "status": "SUCCESS",
        "attemptTimestamp": 0,
        "documentType": "string",
        "fullName": "string",
        "address": "string",
        "addressList": [
          "string"
        ],
        "registrationNumber": "string",
        "v5cNumber": "string",
        "referenceNumber": "string"
      }
    ]
  },
  "deviceInfo": {
    "ipAddress": "string",
    "hash": "string",
    "deviceType": "IOS",
    "osVersion": "string",
    "deviceModel": "string",
    "sdkVersion": "string",
    "browser": "string",
    "hasLiedBrowser": true,
    "longitude": 0,
    "latitude": 0,
    "location": "string",
    "getmAdminArea": "CA",
    "getmSubAdminArea": "Santa Clara",
    "getmLocality": "string",
    "getmSubLocality": "Mission District",
    "getmThoroughfare": "string",
    "getmSubThoroughfare": "string",
    "getmPostalCode": 95014,
    "getmCountryCode": "US",
    "getmCountryName": "United States",
    "hostingApp": "Onboarding"
  },
  "ineTransactionId": "string",
  "errorDescription": "string",
  "fallbackCalled": true
}
```

---

- Path: `api-reference/process-id`
- URL: https://developer.incode.com/api-reference/process-id/
- Markdown: https://developer.incode.com/api-reference/process-id.md
- Endpoint: `POST /omni/process/id`

# Process Id

`POST /omni/process/id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

**Note**:This endpoint should be called only after the [front-side](#/Onboarding/addFrontIdV2)
and [back-side](#/Onboarding/addBackIdV2) is over.
And in case of passports or only front sided documents, only [front-side](#/Onboarding/addFrontIdV2) should be over.

Incode validations and ocr parsing are processed during this endpoint. To fetch ocr data call [Fetch-OCR](#/Onboarding/getOcrData).

Once this is called, user is no longer able to upload ID (front or back side).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `queueName` | query | string |  | The name of the queue, user is entering in case conference call will be used. If not set, default queue will be used Enum: `aristotle`, `buddha`, `confucius`, `diogenes` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `isDocumentExpired` | boolean |  | Flag indicating if the document is expired. |

### 400

Custom error statuses: - 4085: ID image is too small. The message contains the received dimensions and the required minimum (the smallest image side must be at least 200 px). - 6000: Processing error (generic failure during ID processing)

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/id?queueName=%3CqueueName%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "isDocumentExpired": true
}
```

---

- Path: `api-reference/process-imss`
- URL: https://developer.incode.com/api-reference/process-imss/
- Markdown: https://developer.incode.com/api-reference/process-imss.md
- Endpoint: `POST /omni/process/imss`

# Process IMSS

`POST /omni/process/imss`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Trigger fetching of work history for curp. This will notify the results to the configured [Work History Webhook](doc:work-history-webhook).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `curp` | string |  | If not specified it will use one from interview |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/imss \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/imss", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/imss", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/imss"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/imss")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/imss");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/process-payment-proof`
- URL: https://developer.incode.com/api-reference/process-payment-proof/
- Markdown: https://developer.incode.com/api-reference/process-payment-proof.md
- Endpoint: `POST /omni/process/payment-proof`

# Process payment proof

`POST /omni/process/payment-proof`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

**Note**: This endpoint should be called once the Qr-code is executed.

It will fetch info from add qr code text call and validate payment proof fields rfc issuer, rfc receiver and fiscal invoice and return response.

It will also call the configured [Payment Proof Webhook](doc:payment-proof-webhook).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `requestId` | string |  | Id associated with request |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/payment-proof \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/payment-proof", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/payment-proof", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/payment-proof"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/payment-proof")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/payment-proof");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "requestId": "string"
}
```

---

- Path: `api-reference/process-second-id`
- URL: https://developer.incode.com/api-reference/process-second-id/
- Markdown: https://developer.incode.com/api-reference/process-second-id.md
- Endpoint: `POST /omni/process/second-id`

# Process Second Id

`POST /omni/process/second-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

**Note**: This endpoint should be called only after the upload of [front-side-secondId](#/Onboarding/addFrontSecondIdV2) and
[back-side-secondId](#/Onboarding/addBackSecondIdV2) is over. And in case of passports or only front sided documents, only
[front-side-secondId](#/Onboarding/addFrontSecondIdV2) should be over.

Incode validations and ocr parsing are processed during this endpoint. To fetch ocr data call
[Fetch-SecondId_OCR](#/Onboarding/getOcrDataSecondId). Parameter queueName is needed so it can be determined in which queue
interview should go. Once this is called, user is no longer able to upload ID (front or back side).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `queueName` | query | string |  | The name of the queue, user is entering in case conference call will be used. If not set, default queue will be used. Enum: `aristotle`, `buddha`, `confucius`, `diogenes` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `isDocumentExpired` | boolean |  | Flag indicating if the document is expired. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/second-id?queueName=%3CqueueName%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "isDocumentExpired": true
}
```

---

- Path: `api-reference/process-watchlist`
- URL: https://developer.incode.com/api-reference/process-watchlist/
- Markdown: https://developer.incode.com/api-reference/process-watchlist.md
- Endpoint: `POST /omni/process/watchlist`

# Process custom watchlist

`POST /omni/process/watchlist`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint fetches data (photo, email, phone, document number) from onboarding session and tries to find a match in custom
watchlist database. If a match on the watchlist is found, then the score influence is calculated based on the number of matched fields.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding session. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `match` | boolean |  | Flag indicating if a match in the watchlist has been found. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/process/watchlist?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "match": true
}
```

---

- Path: `api-reference/qr-refresh`
- URL: https://developer.incode.com/api-reference/qr-refresh/
- Markdown: https://developer.incode.com/api-reference/qr-refresh.md
- Endpoint: `POST /omni/qr/refresh`

# Refresh QR code value

`POST /omni/qr/refresh`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Refresh UUID for already started onboarding with /omni/onboarding-url.
Returns null if not started before this call or if start expired.
Returned UUID is short lived (15sec) and should be refreshed in constant periods (5sec).

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `onboardingId` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `urlUuid` | string |  | Short-lived uuid for validation |

### 400

Custom error statuses: - 4026: Invalid uuid parameter

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/qr/refresh \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/qr/refresh", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/qr/refresh", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/qr/refresh"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/qr/refresh")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/qr/refresh");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "urlUuid": "string"
}
```

---

- Path: `api-reference/qr-validate`
- URL: https://developer.incode.com/api-reference/qr-validate/
- Markdown: https://developer.incode.com/api-reference/qr-validate.md
- Endpoint: `POST /omni/qr/validate`

# Validate QR code uuid

`POST /omni/qr/validate`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Check if provided UUID value is still valid for Interview ID.
If valid, response will contain UUID that is stored on Onboarding cache and have default TTL of 15min
If not valid, response will contain error details

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `urlUuid` | string |  |  |
| `onboardingId` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `urlUuid` | string |  | Short-lived uuid for validation |

### 400

Custom error statuses: - 4026: Invalid uuid parameter - 4081: Invalid parameters for validation

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/qr/validate \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/qr/validate", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/qr/validate", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/qr/validate"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/qr/validate")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/qr/validate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "urlUuid": "string"
}
```

---

- Path: `api-reference/queue-conference-add`
- URL: https://developer.incode.com/api-reference/queue-conference-add/
- Markdown: https://developer.incode.com/api-reference/queue-conference-add.md
- Endpoint: `PUT /omni/queue/conference/add`

# Add user to queue

`PUT /omni/queue/conference/add`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

When data collection is over, users can be added to the queue for joining conference calls with an executive. The average
time for before user joins to conference is given in response.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `queueName` | query | string |  | The name of the queue, user is entering in case a conference call will be used. If not set, default queue will be used. Possible values: aristotle, buddha, confucius, diogenes. Same value for queueName needs to be used across all requests in one onboarding session. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewCode` | string |  | Interview code received in response of [start](#/Onboarding/startInterview) call. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |
| `waitingTimeInSeconds` | integer (int64) |  | Average waiting time before user joins conference call. |

### 400

Custom error status: - 4014: Invalid interview code

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/queue/conference/add?queueName=%3CqueueName%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive",
  "waitingTimeInSeconds": 203
}
```

---

- Path: `api-reference/queue-conference-connection-details`
- URL: https://developer.incode.com/api-reference/queue-conference-connection-details/
- Markdown: https://developer.incode.com/api-reference/queue-conference-connection-details.md
- Endpoint: `GET /omni/queue/conference/connection-details`

# Get connection details

`GET /omni/queue/conference/connection-details`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

An executive can invite the user to join a conference if the connection is lost by sending uuid ID to user.
Using this uuid connection details for that session can be fetched.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `accessToken` | string |  | Access token which needs to be forwarded in header X-Incode-Hardware-Id for future calls. Same purpose as token from [start](#/Onboarding/startInterview) |
| `interviewerName` | string |  | The name of the executive who is on conference call with the user. |
| `sessionId` | string |  | Used for establishing conference connection via OpenTok. |
| `interviewToken` | string |  | Used for establishing conference connection via OpenTok. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/queue/conference/connection-details?uuid=%3Cuuid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "accessToken": "string",
  "interviewerName": "string",
  "sessionId": "string",
  "interviewToken": "string"
}
```

---

- Path: `api-reference/queue-conference-disconnect`
- URL: https://developer.incode.com/api-reference/queue-conference-disconnect/
- Markdown: https://developer.incode.com/api-reference/queue-conference-disconnect.md
- Endpoint: `POST /omni/queue/conference/disconnect`

# Disconnect user from the queue

`POST /omni/queue/conference/disconnect`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Users can disconnect themselves while waiting in the queue at any time.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

success: flag indicating if user was successfully removed from the queue. False in the case the user not found in the queue, true otherwise

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/queue/conference/disconnect \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/queue/conference/disconnect", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/queue/conference/disconnect", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/queue/conference/disconnect"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/queue/conference/disconnect")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/queue/conference/disconnect");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/queue-conference-index`
- URL: https://developer.incode.com/api-reference/queue-conference-index/
- Markdown: https://developer.incode.com/api-reference/queue-conference-index.md
- Endpoint: `GET /omni/queue/conference/index`

# Get user's position in queue

`GET /omni/queue/conference/index`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Use this endpoint to check user's position in waiting queue. Once the index in the response is 0, users can connect to
the conference call. Use endpoint Get position in queue. Once the index becomes 0, the customer can connect to the interview.
Call [Connect](#/Conference/getInterviewerInfo) to fetch connection data.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `queueName` | query | string |  | The name of the queue the user is entering in case a conference call will be used. If not set, the default queue will be used. Possible values: aristotle, buddha, confucius, diogenes. Same value for queueName needs to be used across all requests in one onboarding session. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `index` | integer (int32) |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/queue/conference/index?queueName=%3CqueueName%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "index": 0
}
```

---

- Path: `api-reference/queue-conference-next`
- URL: https://developer.incode.com/api-reference/queue-conference-next/
- Markdown: https://developer.incode.com/api-reference/queue-conference-next.md
- Endpoint: `GET /omni/queue/conference/next`

# Get next customer from the queue

`GET /omni/queue/conference/next`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Fetch next customer from a conference queue. In case no customer in the queue, and empty body is returned.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `queueName` | query | string |  | The name of the queue the user is entering in the case the conference call will be used. If not set, the default queue will be used. Same value for queueName needs to be used across all requests in one onboarding session. Enum: `aristotle`, `buddha`, `confucius`, `diogenes` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | ID of fetched interview. |
| `apiKey` | integer (int32) |  | OpenTok apiKey used for connection to video call. |
| `interviewToken` | string |  | OpenTok token used for connection to video call. |
| `sessionId` | string |  | OpenTok session id used for connection to video call. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/queue/conference/next?queueName=%3CqueueName%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "interviewId": "string",
  "apiKey": 0,
  "interviewToken": "string",
  "sessionId": "string"
}
```

---

- Path: `api-reference/record-start`
- URL: https://developer.incode.com/api-reference/record-start/
- Markdown: https://developer.incode.com/api-reference/record-start.md
- Endpoint: `POST /omni/record-start`

# Start recording

`POST /omni/record-start`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Start recording of the interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | ID of interview for which recording is started. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `opentokArchiveId` | string |  | ID of created OpenTok archive. |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/record-start \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/record-start", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/record-start", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/record-start"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/record-start")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/record-start");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "opentokArchiveId": "string"
}
```

---

- Path: `api-reference/record-stop`
- URL: https://developer.incode.com/api-reference/record-stop/
- Markdown: https://developer.incode.com/api-reference/record-stop.md
- Endpoint: `POST /omni/record-stop`

# Stop recording

`POST /omni/record-stop`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Stop recording the interview.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `opentokArchiveId` | string |  | ID of OpenTok archive for which recording stop is requested. In case omitted, last created archive on given interview will be stopped. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/record-stop \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/record-stop", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/record-stop", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/record-stop"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/record-stop")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/record-stop");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/recordings-import`
- URL: https://developer.incode.com/api-reference/recordings-import/
- Markdown: https://developer.incode.com/api-reference/recordings-import.md
- Endpoint: `POST /omni/recordings/import`

# Import base64Video and return recordingId

`POST /omni/recordings/import`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `video` | string | yes | Video of capture attempt, represented in base64. |
| `type` | string |  | Type of recording that should be stored. Possible values: selfie, frontId, backId. Enum: `frontId`, `backId`, `merged`, `selfie`, `authenticationattempt`, `videoselfie` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `recordingId` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/recordings/import \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "video": "<video>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/recordings/import", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "video": "<video>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/recordings/import", headers=headers, json={
  "video": "<video>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/recordings/import"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"video\": \"<video>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/recordings/import")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "video": "<video>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/recordings/import");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "video": "<video>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "recordingId": "string"
}
```

---

- Path: `api-reference/recordings-import-third-party`
- URL: https://developer.incode.com/api-reference/recordings-import-third-party/
- Markdown: https://developer.incode.com/api-reference/recordings-import-third-party.md
- Endpoint: `POST /omni/recordings/import/third-party`

# Import base64Video and return recordingId

`POST /omni/recordings/import/third-party`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `video` | string | yes | Video of capture attempt, represented in base64. |
| `type` | string |  | Type of recording that should be stored. Possible values: selfie, frontId, backId. Enum: `frontId`, `backId`, `merged`, `selfie`, `authenticationattempt`, `videoselfie` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `recordingId` | string |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/recordings/import/third-party \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "video": "<video>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/recordings/import/third-party", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "video": "<video>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/recordings/import/third-party", headers=headers, json={
  "video": "<video>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/recordings/import/third-party"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"video\": \"<video>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/recordings/import/third-party")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "video": "<video>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/recordings/import/third-party");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "video": "<video>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "recordingId": "string"
}
```

---

- Path: `api-reference/send-otp`
- URL: https://developer.incode.com/api-reference/send-otp/
- Markdown: https://developer.incode.com/api-reference/send-otp.md
- Endpoint: `GET /omni/send/otp`

# Send SMS with One Time Password for onboarding

`GET /omni/send/otp`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Send SMS with an OTP (One Time Password) code to validate an onboarding.
Phone number is obtained from interview data, so phone step it's required.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `communicationchannel` | query | string |  | Enum: `SMS`, `EMAIL` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OTP sent successfully

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Contact Already Verified - The phone/email is already verified for this session

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 429

Too Many Requests - Cooldown period not completed

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/send/otp?communicationchannel=%3Ccommunicationchannel%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/send-sms-otp`
- URL: https://developer.incode.com/api-reference/send-sms-otp/
- Markdown: https://developer.incode.com/api-reference/send-sms-otp.md
- Endpoint: `GET /omni/send/sms-otp`

# Send SMS with One Time Password for onboarding

`GET /omni/send/sms-otp`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Send SMS with an OTP (One Time Password) code to validate an onboarding.
Phone number is obtained from interview data, so phone step it's required.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OTP sent successfully

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Contact Already Verified - The phone/email is already verified for this session

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

### 429

Too Many Requests - Cooldown period not completed

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/send/sms-otp \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/send/sms-otp", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/send/sms-otp", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/send/sms-otp"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/send/sms-otp")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/send/sms-otp");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/session-downloadpdf-v2`
- URL: https://developer.incode.com/api-reference/session-downloadpdf-v2/
- Markdown: https://developer.incode.com/api-reference/session-downloadpdf-v2.md
- Endpoint: `POST /omni/session/downloadpdf/v2`

# Generates single session PDF report

`POST /omni/session/downloadpdf/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used to generate a PDF report for a single session

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `reason` | string |  |  |

## Responses

### 200

OK

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/session/downloadpdf/v2?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/session-externalid`
- URL: https://developer.incode.com/api-reference/session-externalid/
- Markdown: https://developer.incode.com/api-reference/session-externalid.md
- Endpoint: `DELETE /omni/session/externalId`

# Delete PII data for single onboarding session by external ID.

`DELETE /omni/session/externalId`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

> **Deprecated** — this endpoint is marked deprecated in the Omni API specification.

Delete single onboarding session using the external ID as identifier.
Note:
Works with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.
Finally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `externalId` | query | string | yes | Specify which external-id. |
| `keepCustomer` | query | boolean |  | True or false. Indicates whether to keep idenity of the customer or not. Default is false(which means session and customer identity both will be deleted). |
| `sendNotification` | query | boolean |  | Flag to send a notification about a change interview status |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X DELETE https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E", {
  method: "DELETE",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.delete("https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E")
req = Net::HTTP::Delete.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/session/externalId?externalId=%3CexternalId%3E&keepCustomer=%3CkeepCustomer%3E&sendNotification=%3CsendNotification%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/session-status-get`
- URL: https://developer.incode.com/api-reference/session-status-get/
- Markdown: https://developer.incode.com/api-reference/session-status-get.md
- Endpoint: `GET /omni/session/status/get`

# Get session status

`GET /omni/session/status/get`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Get the status of current session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `get_id` | string |  | Session id. |
| `get_createdAt` | integer (int64) |  | Timestamp, when was the session created |
| `get_updatedAt` | integer (int64) |  | Timestamp, when was the session last updated. |
| `closedAt` | integer (int64) |  | Timestamp, when was the session last closed. |
| `frontIdAttempts` | integer (int32) |  | Attempts to save front id. |
| `backIdAttempts` | integer (int32) |  | Attempts to save back id. |
| `selfieAttempts` | integer (int32) |  | Attempts to save selfie. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/session/status/get?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "get_id": "string",
  "get_createdAt": 0,
  "get_updatedAt": 0,
  "closedAt": 0,
  "frontIdAttempts": 0,
  "backIdAttempts": 0,
  "selfieAttempts": 0,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/session-status-set`
- URL: https://developer.incode.com/api-reference/session-status-set/
- Markdown: https://developer.incode.com/api-reference/session-status-set.md
- Endpoint: `POST /omni/session/status/set`

# Set session status

`POST /omni/session/status/set`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Set the status of current session. Possible actions to set the status to are: Alive, Closed or Deleted. Closed status
disables all of the "/add/..." calls so they can no longer make any changes to the system. Deleted status deletes
the important data stored in the session.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `action` | query | string | yes | Enum: `Alive`, `Closed`, `Deleted` |
| `id` | query | string |  | id of the session, optional, if not sent obtained from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `get_id` | string |  | Session id. |
| `get_createdAt` | integer (int64) |  | Timestamp, when was the session created |
| `get_updatedAt` | integer (int64) |  | Timestamp, when was the session last updated. |
| `closedAt` | integer (int64) |  | Timestamp, when was the session last closed. |
| `frontIdAttempts` | integer (int32) |  | Attempts to save front id. |
| `backIdAttempts` | integer (int32) |  | Attempts to save back id. |
| `selfieAttempts` | integer (int32) |  | Attempts to save selfie. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/session/status/set?action=%3Caction%3E&id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "get_id": "string",
  "get_createdAt": 0,
  "get_updatedAt": 0,
  "closedAt": 0,
  "frontIdAttempts": 0,
  "backIdAttempts": 0,
  "selfieAttempts": 0,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/sign-combined-consent`
- URL: https://developer.incode.com/api-reference/sign-combined-consent/
- Markdown: https://developer.incode.com/api-reference/sign-combined-consent.md
- Endpoint: `POST /omni/sign-combined-consent`

# Sign combined consents with checkboxes.

`POST /omni/sign-combined-consent`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Receives information about which checkboxes user signed.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `languageConsentId` | string |  |  |
| `checkboxes` | object |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/sign-combined-consent \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/sign-combined-consent", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/sign-combined-consent", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/sign-combined-consent"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/sign-combined-consent")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/sign-combined-consent");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/sign-document-nom151`
- URL: https://developer.incode.com/api-reference/sign-document-nom151/
- Markdown: https://developer.incode.com/api-reference/sign-document-nom151.md
- Endpoint: `POST /omni/sign-document/nom151`

# Sign document with NOM 151

`POST /omni/sign-document/nom151`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Sign any base64-encoded document with NOM 151.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documentToSign` | string |  | Base64-encoded document to be signed with NOM151 |

## Responses

### 200

Response: - signedString: String. NOM 151 constancia (digital evidence) - reference: String. Reference folio (unique confirmation id)

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/sign-document/nom151 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/sign-document/nom151", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/sign-document/nom151", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/sign-document/nom151"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/sign-document/nom151")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/sign-document/nom151");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/sign-hash-nom151`
- URL: https://developer.incode.com/api-reference/sign-hash-nom151/
- Markdown: https://developer.incode.com/api-reference/sign-hash-nom151.md
- Endpoint: `POST /omni/sign-hash/nom151`

# Sign hash with NOM 151

`POST /omni/sign-hash/nom151`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Sign any SHA-256 hash (64-hex) with NOM 151.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hashToSign` | string |  | Hash to be signed with NOM151 |

## Responses

### 200

Response: - signedString: String. NOM 151 constancia (digital evidence) - reference: String. Reference folio (unique confirmation id)

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/sign-hash/nom151 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/sign-hash/nom151", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/sign-hash/nom151", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/sign-hash/nom151"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/sign-hash/nom151")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/sign-hash/nom151");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/sign-string-nom151`
- URL: https://developer.incode.com/api-reference/sign-string-nom151/
- Markdown: https://developer.incode.com/api-reference/sign-string-nom151.md
- Endpoint: `POST /omni/sign-string/nom151`

# Sign String with NOM 151

`POST /omni/sign-string/nom151`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Sign any String with NOM 151.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `stringToSign` | string |  | String to be signed with NOM151 |

## Responses

### 200

Response: - signedString: String. NOM 151 constancia (digital evidence) - reference: String. Reference folio (unique confirmation id)

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/sign-string/nom151 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/sign-string/nom151", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/sign-string/nom151", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/sign-string/nom151"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/sign-string/nom151")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/sign-string/nom151");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/start`
- URL: https://developer.incode.com/api-reference/start/
- Markdown: https://developer.incode.com/api-reference/start.md
- Endpoint: `POST /omni/start`

# Start onboarding

`POST /omni/start`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is mandatory to start any onboarding session in Incode Omni and session can be monitored on the Incode Dashboard.
And it generates token which should be used for the authentication of future subsequent calls.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `language` | string |  | Language code to be used when doing speech to text. Possible values: en-US, es-ES, pt-BR. |
| `externalId` | string |  | Id that identifies user in clients system should be used for externalId. (Deprecated, use externalCustomerId instead) |
| `externalCustomerId` | string |  | Id that identifies user in clients external system. |
| `uuid` | string |  | uuid key used in redis, can be used as an alternative to sending interviewId. |
| `configurationId` | string |  | Id of the flow to be used for this onboarding. |
| `redirectionUrl` | string |  | Url the user will be redirected to after finishing the onboarding successfully. |
| `integrationReference` | string |  | Optional integration reference. |
| `urlUuid` | string |  | Url uuid key used in redis. Will be validated in start if qrPhishingResistance is ON. |
| `customFields` | object |  | Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength} |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `interviewId` | string |  | Identifies the onboarding session that is initialized. Can be used for fetching data about that session in future calls. |
| `token` | string |  | Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls. |
| `interviewCode` | string |  | This value is used for connecting to conference call. |
| `flowType` | string |  | (only if configurationId is sent in request). Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore). Enum: `configuration`, `flow`, `workflow` |
| `idCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected. |
| `idDetectionTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, if ID is not detected. |
| `selfieCaptureTimeout` | integer (int32) |  | Number of seconds after which manual capture button should be shown to the user, while capturing selfie. |
| `idCaptureRetries` | integer (int32) |  | Number of ID captures after which user should be taken to next screen. |
| `selfieCaptureRetries` | integer (int32) |  | Number of selfie captures after which user should be taken to next screen. |
| `curpValidationRetries` | integer (int32) |  | Number of curp validations after which user should be taken to next screen. (only for Mexico) |
| `clientId` | string |  | Customer specific clientId that corresponds to api key. |
| `env` | string |  | Server environment. Could be one of: stage, demo, saas. |
| `existingSession` | boolean |  | It's true if interviewId corresponds to an existing Onboarding Session. |

### 400

Custom error statuses: - 4026: Invalid uuid parameter - 4027: Invalid configurationId - 4028: Flow is not activated - 4081: Invalid parameters for validation - 4082: Start endpoint version forbidden in flow/workflow

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/start \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/start", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/start", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/start"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/start")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/start");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "interviewId": "string",
  "token": "string",
  "interviewCode": "string",
  "flowType": "configuration",
  "idCaptureTimeout": 0,
  "idDetectionTimeout": 0,
  "selfieCaptureTimeout": 0,
  "idCaptureRetries": 0,
  "selfieCaptureRetries": 0,
  "curpValidationRetries": 0,
  "clientId": "string",
  "env": "string",
  "existingSession": true
}
```

---

- Path: `api-reference/stateless-authentications-provide-reference-selfie`
- URL: https://developer.incode.com/api-reference/stateless-authentications-provide-reference-selfie/
- Markdown: https://developer.incode.com/api-reference/stateless-authentications-provide-reference-selfie.md
- Endpoint: `POST /omni/stateless-authentications/provide/reference-selfie`

# Provide selfie for stateless authentication

`POST /omni/stateless-authentications/provide/reference-selfie`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

A method to provide a reference selfie for stateless authentication.
(A selfie of the original onboarding that was approved but later removed from Incode storage).
This selfie will be used in authentication process if it's configured to be stateless.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Image of user's face represented in base64. |
| `customerId` | string |  | Customer Id. |
| `sessionId` | string |  | Session Id. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Operation result. |
| `candidate` | string |  | Id of the candidate for reference selfie. |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/stateless-authentications/provide/reference-selfie");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "candidate": "string"
}
```

---

- Path: `api-reference/update`
- URL: https://developer.incode.com/api-reference/update/
- Markdown: https://developer.incode.com/api-reference/update.md
- Endpoint: `PUT /omni/update`

# Update interview

`PUT /omni/update`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

If upload of front, back side of id or selfie, was not successful after retries,
use this endpoint to specify that additional manual check is needed.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data will be updated. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string |  | Name of the person obtained from ocr can be updated here. |
| `birthDate` | string |  | Birth date of the person obtained from ocr can be updated here. |
| `address` | string |  | Address of the person obtained from ocr can be updated here. |
| `gender` | string |  | Gender of the person obtained from ocr can be updated here. |
| `manualIdCheckNeeded` | boolean |  | If set to true, indicates that manual check is needed for validating id. |
| `manualSelfieCheckNeeded` | boolean |  | If set to true, indicates that manual check is needed for validating selfie image. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/update?id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/update-editable-ocr-data`
- URL: https://developer.incode.com/api-reference/update-editable-ocr-data/
- Markdown: https://developer.incode.com/api-reference/update-editable-ocr-data.md
- Endpoint: `PUT /omni/update/editable-ocr-data`

# Update editable OCR data in interview

`PUT /omni/update/editable-ocr-data`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Update some of the crucial interview OCR data if needed.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `address` | string |  |  |
| `documentNumber` | string |  |  |
| `name` | string |  |  |
| `firstName` | string |  |  |
| `lastName` | string |  |  |
| `paternalLastName` | string |  |  |
| `maternalLastName` | string |  |  |
| `personalNumber` | string |  |  |
| `curp` | string |  |  |
| `email` | string |  |  |
| `birthDate` | string |  |  |
| `expireAt` | string |  |  |
| `gender` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/update/editable-ocr-data \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/update/editable-ocr-data", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/update/editable-ocr-data", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/update/editable-ocr-data"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/update/editable-ocr-data")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/update/editable-ocr-data");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/update-editable-ocr-data-second-id`
- URL: https://developer.incode.com/api-reference/update-editable-ocr-data-second-id/
- Markdown: https://developer.incode.com/api-reference/update-editable-ocr-data-second-id.md
- Endpoint: `PUT /omni/update/editable-ocr-data-second-id`

# Update editable OCR data in interview for the second Id

`PUT /omni/update/editable-ocr-data-second-id`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Update some of the crucial interview OCR data if needed.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `address` | string |  |  |
| `documentNumber` | string |  |  |
| `name` | string |  |  |
| `firstName` | string |  |  |
| `lastName` | string |  |  |
| `paternalLastName` | string |  |  |
| `maternalLastName` | string |  |  |
| `personalNumber` | string |  |  |
| `curp` | string |  |  |
| `email` | string |  |  |
| `birthDate` | string |  |  |
| `expireAt` | string |  |  |
| `gender` | string |  |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/update/editable-ocr-data-second-id");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/updated-watchlist-result`
- URL: https://developer.incode.com/api-reference/updated-watchlist-result/
- Markdown: https://developer.incode.com/api-reference/updated-watchlist-result.md
- Endpoint: `GET /omni/updated-watchlist-result`

# Updated global watchlist result

`GET /omni/updated-watchlist-result`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint gets the latest result for a previous search created with [watch-list](#/Onboarding/getWatchlistResult)
with refId from it's response, or gathered from an update notification or with interviewId that the search is associated with.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ref` | query | string |  |  |
| `id` | query | string |  |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/updated-watchlist-result?ref=%3Cref%3E&id=%3Cid%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `api-reference/updatemanualreview`
- URL: https://developer.incode.com/api-reference/updatemanualreview/
- Markdown: https://developer.incode.com/api-reference/updatemanualreview.md
- Endpoint: `PUT /omni/manual-review`

# Update manual review

`PUT /omni/manual-review`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Can be used to set an interview as 'needs manual review', 'approved by manual review' or 'rejected by manual review'.
In case manualReviewStatus field in request is set to APPROVED or REJECTED, notification to client side is sent
for onboarding status change - see [notify-status-changed] for more details

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interviewId` | query | string |  | Id of onboarding for which data will be updated. If not present, it will be extracted from token. |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `manualReviewStatus` | string | yes | Enum: `REQUIRED`, `APPROVED`, `REJECTED` |
| `newReason` | string |  | Intended to be use when setting manualReviewStatus as required, it will be added to the list of reasons why a session was flagged as needs manual review. |
| `comment` | string |  | Required comment in written form. |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X PUT https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "manualReviewStatus": "<manualReviewStatus>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E", {
  method: "PUT",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "manualReviewStatus": "<manualReviewStatus>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.put("https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E", headers=headers, json={
  "manualReviewStatus": "<manualReviewStatus>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\n  \"manualReviewStatus\": \"<manualReviewStatus>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E")
req = Net::HTTP::Put.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "manualReviewStatus": "<manualReviewStatus>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/manual-review?interviewId=%3CinterviewId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "manualReviewStatus": "<manualReviewStatus>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/verification-async-referenceid`
- URL: https://developer.incode.com/api-reference/verification-async-referenceid/
- Markdown: https://developer.incode.com/api-reference/verification-async-referenceid.md
- Endpoint: `GET /omni/verification/async/{referenceId}`

# Get async vendor verification status/result

`GET /omni/verification/async/{referenceId}`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Retrieves the status and persisted result of a previously initiated async vendor
verification request. The result field is null while the request is PENDING,
carries the verification response body once COMPLETED, and carries error details
when FAILED. The result is also delivered via the corresponding webhook
(EKYB_VERIFICATION_RESULT / EKYC_VERIFICATION_RESULT); this endpoint is a
read-only status check. Returns 404 if the referenceId is not found or belongs
to a different tenant.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `referenceId` | path | string | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

Request found — status is PENDING, COMPLETED, or FAILED

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `referenceId` | string |  |  |
| `status` | string |  | Enum: `PENDING`, `COMPLETED`, `FAILED` |
| `type` | string |  | Enum: `EKYB`, `EKYC` |
| `result` | object |  |  |

### 404

No async verification request found for the given referenceId

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `referenceId` | string |  |  |
| `status` | string |  | Enum: `PENDING`, `COMPLETED`, `FAILED` |
| `type` | string |  | Enum: `EKYB`, `EKYC` |
| `result` | object |  |  |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/verification/async/%3CreferenceId%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "referenceId": "string",
  "status": "PENDING",
  "type": "EKYB",
  "result": {}
}
```

---

- Path: `api-reference/verifyface`
- URL: https://developer.incode.com/api-reference/verifyface/
- Markdown: https://developer.incode.com/api-reference/verifyface.md
- Endpoint: `POST /omni/verifyFace`

# Verify face

`POST /omni/verifyFace`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

A bank executive can ask the customer to additionally capture his face during an interview and do face recognition.
A face can be captured from selfie or ID that a customer places in front of camera.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string |  | Base64 string representation of the image. |
| `interviewId` | string |  | 5c10c728c7a29d001536ad13 |
| `compareWith` | string | yes | Enum: `selfie`, `videoSelfie`, `id`, `nfc` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `confidence` | number (float) |  | Confidence value of comparing. Number between 0 and 1. |

### 400

Custom error statuses: - 4019: Face not found - 1003: Face cropping failure

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/verifyFace \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "compareWith": "<compareWith>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/verifyFace", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "compareWith": "<compareWith>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/verifyFace", headers=headers, json={
  "compareWith": "<compareWith>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/verifyFace"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"compareWith\": \"<compareWith>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/verifyFace")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "compareWith": "<compareWith>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/verifyFace");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "compareWith": "<compareWith>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "confidence": 0
}
```

---

- Path: `api-reference/video-selfie-upload-complete`
- URL: https://developer.incode.com/api-reference/video-selfie-upload-complete/
- Markdown: https://developer.incode.com/api-reference/video-selfie-upload-complete.md
- Endpoint: `POST /omni/video-selfie/upload/complete`

# Complete multipart video selfie upload

`POST /omni/video-selfie/upload/complete`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Signal that all chunks have been uploaded.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `uploadId` | string | yes |  |
| `parts` | array[PartInfo] |  |  |
| `parts.partNumber` | integer (int32) | yes |  |
| `parts.eTag` | string | yes |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/video-selfie/upload/complete \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "uploadId": "<uploadId>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/video-selfie/upload/complete", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "uploadId": "<uploadId>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/video-selfie/upload/complete", headers=headers, json={
  "uploadId": "<uploadId>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/video-selfie/upload/complete"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"uploadId\": \"<uploadId>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/video-selfie/upload/complete")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "uploadId": "<uploadId>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/video-selfie/upload/complete");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "uploadId": "<uploadId>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "status": "string"
}
```

---

- Path: `api-reference/video-selfie-upload-initiate`
- URL: https://developer.incode.com/api-reference/video-selfie-upload-initiate/
- Markdown: https://developer.incode.com/api-reference/video-selfie-upload-initiate.md
- Endpoint: `POST /omni/video-selfie/upload/initiate`

# Initiate multipart video selfie upload

`POST /omni/video-selfie/upload/initiate`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Start a chunked video upload session. Returns an uploadId for subsequent part uploads and completion.
The entire upload (all parts + complete) must finish within the configured video selfie timeout (default 240 seconds), otherwise the session will receive a fail score for the video selfie module.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `uploadId` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/video-selfie/upload/initiate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "uploadId": "string"
}
```

---

- Path: `api-reference/video-selfie-upload-part`
- URL: https://developer.incode.com/api-reference/video-selfie-upload-part/
- Markdown: https://developer.incode.com/api-reference/video-selfie-upload-part.md
- Endpoint: `POST /omni/video-selfie/upload/part`

# Upload a video selfie chunk

`POST /omni/video-selfie/upload/part`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Upload a single chunk of the video selfie. Chunks must be between 5MB and 10MB, except for the last chunk which can be smaller.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uploadId` | query | string | yes |  |
| `partNumber` | query | integer (int32) | yes |  |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `partNumber` | integer (int32) |  |  |
| `eTag` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/video-selfie/upload/part?uploadId=%3CuploadId%3E&partNumber=%3CpartNumber%3E");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "partNumber": 0,
  "eTag": "string"
}
```

---

- Path: `api-reference/videoselfie-compare-ocr-v2`
- URL: https://developer.incode.com/api-reference/videoselfie-compare-ocr-v2/
- Markdown: https://developer.incode.com/api-reference/videoselfie-compare-ocr-v2.md
- Endpoint: `POST /omni/videoselfie/compare-ocr/v2`

# Compare OCR from videoselfie against OCR from ID v2

`POST /omni/videoselfie/compare-ocr/v2`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint is used to compare OCR from videoselfie frame against OCR from ID.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `base64Image` | string | yes | Base64 string representation of the image |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean |  | Flag indicating request passed successfully. |
| `sessionStatus` | string |  | Session status Enum: `Alive`, `Closed`, `Deleted` |

### 400

Custom error statuses: - 5003: Unsatisfied image size - 5004: Document alignment failed - 5005: Document not found

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2 \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "base64Image": "<base64Image>"
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "base64Image": "<base64Image>"
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2", headers=headers, json={
  "base64Image": "<base64Image>"
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"base64Image\": \"<base64Image>\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"
req.body = '{
  "base64Image": "<base64Image>"
}'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/videoselfie/compare-ocr/v2");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "base64Image": "<base64Image>"
}');

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "success": true,
  "sessionStatus": "Alive"
}
```

---

- Path: `api-reference/videoselfie-hash`
- URL: https://developer.incode.com/api-reference/videoselfie-hash/
- Markdown: https://developer.incode.com/api-reference/videoselfie-hash.md
- Endpoint: `POST /omni/videoselfie/hash`

# Get videoselfie hash

`POST /omni/videoselfie/hash`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Obtain a hash of the video file of the videoselfie. The hash and hashImage fields in the response will be null if the video file is not yet ready.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `withImage` | query | boolean |  | Default: `false` |
| `api-version` | header | string | yes | Default: `1.0` |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hash` | string |  |  |
| `hashimage` | string |  |  |
| `message` | string |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/videoselfie/hash?withImage=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{
  "hash": "string",
  "hashimage": "string",
  "message": "string"
}
```

---

- Path: `api-reference/watchlist-result`
- URL: https://developer.incode.com/api-reference/watchlist-result/
- Markdown: https://developer.incode.com/api-reference/watchlist-result.md
- Endpoint: `POST /omni/watchlist-result`

# Global Watchlist result

`POST /omni/watchlist-result`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

This endpoint calls the global watchlist api (currently only Tier 2), and gets the latest gathered result.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `api-version` | header | string | yes | Default: `1.0` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `firstName` | string |  |  |
| `surName` | string |  |  |
| `birthYear` | integer (int32) |  | Year of birth, if known |
| `countryCodes` | array |  |  |
| `watchlistTypes` | array |  |  |
| `subscribe` | boolean |  | Subscribes to updates on the watchlists to receive notification for updates on the search. |
| `fuzziness` | number (float) |  | Determines how closely the returned results must match the supplied name. |
| `search_profile` | string |  | Search profile set for the client to use specify what sources they will be searching against. |

## Responses

### 200

OK

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/omni/watchlist-result \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/watchlist-result", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "X-Incode-Hardware-Id": "<YOUR_INCODE_HARDWARE_ID>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/omni/watchlist-result", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/watchlist-result"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("X-Incode-Hardware-Id", "<YOUR_INCODE_HARDWARE_ID>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```
require "net/http"
require "json"

uri = URI("https://demo-api.incodesmile.com/omni/watchlist-result")
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = "<YOUR_API_KEY>"
req["X-Incode-Hardware-Id"] = "<YOUR_INCODE_HARDWARE_ID>"
req["api-version"] = "1.0"
req["Content-Type"] = "application/json"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### PHP

```
$ch = curl_init("https://demo-api.incodesmile.com/omni/watchlist-result");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <YOUR_API_KEY>",
    "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>",
    "api-version: 1.0",
    "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);
```

### Example response

```json
{}
```

---

- Path: `concepts-and-architecture/authorization-identity-protocols`
- URL: https://developer.incode.com/concepts-and-architecture/authorization-identity-protocols/
- Markdown: https://developer.incode.com/concepts-and-architecture/authorization-identity-protocols.md

# Authorization and Identity Protocols

Incode supports identity verification as part of an OpenID Connect (OIDC) authentication flow. This page explains how OAuth 2.0 and OIDC work together and describes the two ways to configure OIDC in Dashboard.

***

## OAuth 2.0 and OpenID Connect

OAuth 2.0 and OpenID Connect (OIDC) are related but distinct protocols. They are often used together.

- **OAuth 2.0** is an [authorization](/get-started-with-incode/glossary/#authorization) framework. It controls access to resources. When a user authorizes your application, the authorization server issues an access token. Your application uses that token to make API requests on the user's behalf.
- **OpenID Connect (OIDC)** is an [authentication](/get-started-with-incode/glossary/#authentication) layer built on top of OAuth 2.0. It confirms the user's identity. In addition to an access token, the authorization server issues an ID token. The ID token confirms who the user is. It is a JSON Web Token (JWT) signed by the authorization server, and your application must validate it before trusting its contents.

Together, they work like this:

1. Your application redirects the user to the authorization server.
2. The user authenticates by completing a Flow or Workflow.
3. The authorization server issues an authorization code.
4. Your application exchanges the code for an access token and an ID token.
5. Your application validates the ID token and uses the access token to call Incode APIs.

Incode uses the authorization code flow with Proof Key for Code Exchange (PKCE). This is the recommended flow for web and mobile applications.

***

## Configuration Methods

Incode supports two ways to configure OIDC: automatic and manual. The right choice depends on how your integration is structured.

### Automatic Configuration

Automatic configuration ties OIDC directly to a specific Flow or Workflow. When you enable the **OAuth2 Secured** flag on a Flow or Workflow, Incode automatically generates a dedicated OIDC client for it. You do not need to create or manage the client manually. This client is configured as a public client using PKCE. A client secret is generated but never surfaced or used, since authentication relies only on the PKCE code and verifier.

Use automatic configuration when:

- You want OIDC authentication scoped to a specific Flow or Workflow.
- You want Incode to manage client generation for you.
- You are building a new integration.

For setup instructions, see [OIDC Automatic Configuration](/concepts-and-architecture/oidc-automatic-configuration/).

### Manual Configuration

Manual configuration lets you create and manage OIDC clients directly in Dashboard in **Configuration > Authorization**. You define the client ID, client secret, redirect URIs, authentication methods, and grant types yourself.

Scoping under manual configuration depends on the authentication type. For example, onboarding authentication is scoped to a specific Flow or Workflow, while face authentication is not tied to a Flow or Workflow.

Use manual configuration when:

- You need a standalone OIDC client whose scoping doesn't fit the automatic model
- You require specific authentication methods or grant types not available through automatic configuration.
- You are managing an existing integration.

For setup instructions, see [OIDC Manual Configuration](/concepts-and-architecture/oidc-manual-configuration/).

### Comparison

| OIDC Automatic Configuration                                       | OIDC Manual Configuration              |
| ------------------------------------------------------------------ | -------------------------------------- |
| Incode generates an OIDC client                                    | You create a OIDC client in Dashboard  |
| Scoped to a Flow or Workflow                                       | Scoping depends on authentication type |
| Configured as a public client using PKCE; no client secret is used | You manage the client secret           |
| Recommended for new integrations                                   | Recommended for existing integrations  |

<br />

---

- Path: `concepts-and-architecture/concepts-and-architecture`
- URL: https://developer.incode.com/concepts-and-architecture/
- Markdown: https://developer.incode.com/concepts-and-architecture.md

# Concepts and Architecture

This section explains the concepts and architecture behind every Incode integration: how the platform is structured, how it secures data and requests, the difference between onboarding and authentication, how sessions are scored, and how Workflows and Flows control the verification experience.

Read this section to understand how the platform works before moving on to implementation guides for a specific integration type.

## Verification Concepts

- **[Onboarding or Authentication](/concepts-and-architecture/onboarding-vs-authentication/)**: The two verification journeys the platform supports: onboarding (verifying a new user for the first time) and authentication (confirming a returning user via Face Authentication), and how they relate.
- **[Scoring System Explained](/concepts-and-architecture/understanding-scores/)**: How module-level and overall session scores are calculated, the `ok` / `warn` / `manual` / `fail` / `unknown` status model, and how scores map to approve, manual-review, and deny decisions.
- **[User Consent for PII Data](/concepts-and-architecture/user-consent-considerations/)**: The Privacy Consent and Machine Learning Consent types Incode requires, and how to collect them via Dashboard or API.

## Authentication Protocols (OIDC)

- **[OIDC Automatic Configuration](/concepts-and-architecture/oidc-automatic-configuration/)**:  How OAuth 2.0 and OpenID Connect work together in Incode integrations, and the two ways to configure OIDC: automatic (tied to a Flow or Workflow) or manual.
- **[OIDC Manual Configuration](/concepts-and-architecture/oidc-manual-configuration/)**:  Step-by-step instructions for creating and managing an OIDC client directly in Dashboard when you need control beyond the automatic model.

## Workflow Configuration

- **[Flows and Workflows](/concepts-and-architecture/workflows/)**:  The difference between the legacy Flows model and the recommended Workflows model, and the node types (Module, Process, Condition, Result) used to build a Workflow.
- **[Conditions for Workflows](/concepts-and-architecture/conditions-for-workflows-20/)**:  How Condition nodes branch a user journey based on collected data, with common examples like pass/fail logic and manual review triggers.

---

- Path: `concepts-and-architecture/condition-use-cases`
- URL: https://developer.incode.com/concepts-and-architecture/condition-use-cases/
- Markdown: https://developer.incode.com/concepts-and-architecture/condition-use-cases.md

# Condition Use Cases

This page walks through common ways to use Conditions in a Workflow, from straightforward pass/fail logic to module-specific rules. Use these examples as starting points for building Conditions that fit your verification needs.

You configure a Condition when you add it to a [Workflow](/dashboard-platform-administration/workflows-20/#create-workflows). For configuration instructions, refer to [Configure Workflow Conditions](/dashboard-platform-administration/configure-workflow-conditions/).

## Pass or Fail a Session

You can define specific conditions to determine the session result. In this standard identity verification example, the session passes if:

- The ID is valid
- The user is a live person
- The user's face matches the face on the ID

If any rule is false, the Condition follows the Otherwise path. In this example, this path has been configured to fail the session.

![](https://developer.incode.com/assets/c6ab1b9c1fdd3a771cb7a95e38ae0fa9.png)

![](https://developer.incode.com/assets/29f64c23a7f186e0e804ec2524b9c151.png)

## All capture attempts used

In some cases, you may want to mark sessions for manual review. For example, if you allow five ID capture attempts, you may want to flag any session where the user needed all five.

The following image shows a Condition that sends those sessions to manual review:

![](https://developer.incode.com/assets/491f4fa310b7e706c2e4d8706a49e0fc.png)

![](https://developer.incode.com/assets/4e18c7157ce4658a0ec946a98693b0ab.png)

## Watchlist Business

The Watchlist Business module is an advanced module that allows you to screen business entities against various international and national watchlists during the identity verification process.

Conditions can use this module's results to affect the session result. In the example Condition below, the session is failed if the risk level is unknown or the business entity appears on the watchlist 20 times or more.

![](https://developer.incode.com/assets/be3f32b271b85505c9b7f07d30009ba7.png)

## Condition options by module

The rules available in a Condition depend on which modules are in your Workflow. Each module surfaces its own set of fields, operators, and values that Conditions can evaluate. For the Condition options a specific module supports, see that module's [Dashboard configuration](/dashboard-platform-administration/add-modules/) documentation.

---

- Path: `concepts-and-architecture/conditions-for-workflows-20`
- URL: https://developer.incode.com/concepts-and-architecture/conditions-for-workflows-20/
- Markdown: https://developer.incode.com/concepts-and-architecture/conditions-for-workflows-20.md

# Workflow Conditions

Conditions let you dynamically customize user journeys built using Workflows. They enable verification flows that adapt to the data collected during the verification process, optimizing the experience for each user.

A condition acts as a decision node. It sends the user journey down different paths based on the user data received. This lets you control which modules are presented to the user. Conditions can assess data quality, verification check outcomes, crosschecks, and more.

You configure a condition when you add it to a [Workflow](/dashboard-platform-administration/workflows-20/#create-workflows). For configuration instructions, refer to [Configure Workflow Conditions](/dashboard-platform-administration/configure-workflow-conditions/).

## Sample Condition Nodes

The following images show a simple condition, both in its configuration panel and as it appears on the canvas. In this case, the session passes only if the user presents a document issued by the United States:

![](https://developer.incode.com/assets/9f645a6bd50d14e316dd95348a844425.png)

![](https://developer.incode.com/assets/9351bc3424a5e57f29f99d6207201804.png)

The following image shows a more complex condition. In this case, the user must complete additional steps if their identity cannot be verified using eKYC:

![](https://developer.incode.com/assets/bf0f63aae21b242ea06f9fa735a12bf7.png)

## Best Practices

- **Keep conditions simple**. Instead of creating one complex condition, link multiple simpler conditions in sequence. This makes the Workflow easier to understand and manage, and it makes it easier to see which path the user journey followed.
- **Use logical operators deliberately**. When you do need `AND` or `OR` to combine rules within a single condition, plan the full expression before adding it to your Workflow so it behaves the way you expect.
- **Monitor and adjust**. Regularly review the performance of your Workflows and adjust conditions based on real outcomes.
- **Plan for all outcomes**. Ensure every possible path through the Workflow leads to a clear result. Dead ends can confuse users and disrupt the verification process.

<br />

<br />

---

- Path: `concepts-and-architecture/oidc-automatic-configuration`
- URL: https://developer.incode.com/concepts-and-architecture/oidc-automatic-configuration/
- Markdown: https://developer.incode.com/concepts-and-architecture/oidc-automatic-configuration.md

# OIDC Automatic Configuration

Incode's web-based Onboarding Flows and Workflows that use redirects can be vulnerable to certain security attacks. To address this, you can enable a setting called **OAuth2 Secured**. When you enable that setting, the Flow or Workflow runs as part of a standard OAuth 2.0/OpenID Connect (OIDC) process.

After the user successfully completes the Flow or Workflow, a dedicated OIDC client is automatically generated, configured with:

- An authorization code grant
- A Proof Key for Code Exchange (PKCE) hashed using SHA-256

When you enable **OAuth2 Secured**, a redirect URI is mandatory.

Automatic configuration pre-defaults most other settings for you and does not expose controls for requested scopes,the post-logout redirect URI, or user consent. If you need control over these settings, use [manual configuration](/concepts-and-architecture/oidc-manual-configuration/) instead.

<Callout icon="⚠️" theme="warn">
  ### Warning

  Disabling and re-enabling **OAuth2 Secured** generates a new OAuth client and invalidates the previous `client_id`. You must update all client integrations with the new `client_id`.

  Also, any change to the redirect URI must be updated in your Flow or Workflow configuration and reflected in all authorization and token requests. Mismatched URIs will cause authorization failures.
</Callout>

Follow the steps on this page to implement OIDC authentication for your Flow or Workflow. Complete them in order.

***

## Enable OAuth2 Secured

1. In Dashboard, click **Flow Builder** in the left menu, then click **Flows** or **Workflows**, depending on which you are configuring.
2. Click the **Settings** tab at the top.
3. In the User Experience section, enable **OAuth2 Secured (web only)**.
4. Scroll down to the After Verification section and enter your **Redirect URL**.
5. Click **Save Changes** for a Flow, **Save & Publish** for a Workflow.

After a Flow or Workflow is configured for OAuth security, its `flowid` no longer works with the incodesmile URL scheme. Follow the steps on this page to move to a new URL scheme and authorization pattern.

***

## Prepare the Authorization Request

1. Generate a cryptographically random `code_verifier` secret and store it. Then compute the `code_challenge` by hashing the `code_verifier` using SHA-256. This is the PKCE mechanism.

2) Generate a cryptographically random `state` value. This protects against <Anchor target="_blank" href="https://datatracker.ietf.org/doc/html/rfc6749#section-10.12">CSRF</Anchor> attacks. It must be unique per authorization request and stored securely: in memory for SPA applications, or in a session cookie or in-memory cache for BFF applications.
3) Generate a cryptographically random `nonce` value. This protects against ID token replay attacks. It must be unique per authentication request and stored the same way as `state`. For more information, see <Anchor target="_blank" href="https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes">OpenID Connect Core: Nonce Notes</Anchor>.
4) Fetch your OIDC configuration from the well-known discovery endpoint: [https://auth.incode.com/.well-known/openid-configuration](https://auth.incode.com/.well-known/openid-configuration). This returns all the server endpoints, supported features, and public keys your application needs.

<Accordion title="Expand for descriptions of authorization request parameters">

| Parameter | Description |
|---|---|
| `client_id` | Required. Your OAuth client ID. Find this in Dashboard under your Flow or Workflow settings. |
| `redirect_uri` | Required. The URI the authorization server redirects to after the user completes the flow. Must exactly match the redirect URI configured in Dashboard for your Flow or Workflow. |
| `response_type` | Required. Must be `code`. This requests an authorization code, which your server exchanges for tokens. |
| `scope` | Required. Must include `openid`. This tells the server to return an ID token. Additional scopes may be added depending on your configuration. |
| `state` | Required. A cryptographically random, unguessable value generated per request. Used to prevent Cross-Site Request Forgery (CSRF) attacks. Your application must verify this value matches when the authorization server redirects back. |
| `nonce` | Required. A cryptographically random, unique value generated per request. Embedded in the ID token by the authorization server. Your application must verify this value matches to prevent token replay attacks. |
| `code_challenge_method` | Required. Must be `S256`. This specifies that the `code_challenge` was hashed using SHA-256. |
| `code_challenge` | Required. The PKCE code challenge. Derived by hashing the `code_verifier` using SHA-256. |
| `response_mode` | Required. Must be `form_post`. This tells the authorization server to return the authorization code via an HTTP POST rather than in the URL, which is more secure. |
| `external_customer_id` | Optional. Your identifier for the user. Use this to correlate the Incode session with a user in your own system. |
</Accordion>

***

## Send the Authorization Request

Construct the following URL and redirect the user's browser to it.

```http
https://auth.incode.com/oauth2/authorize
?client_id={client_id}
&redirect_uri={redirect_uri}
&scope=openid
&response_type=code
&response_mode=form_post
&state={state}
&nonce={nonce}
&code_challenge_method=S256
&code_challenge={code_challenge}
&external_customer_id={external_customer_id}
```

After you send the authorization request, the user is redirected to the Incode Authorization Server, where the associated Flow or Workflow runs as part of the `/authorize` endpoint.

After the Flow or Workflow completes, one of the following happens:

- **On failure**: The user is redirected to `redirect_uri` with `error` and `error_description` URL parameters. For details, see the <Anchor target="_blank" href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">OIDC spec</Anchor>.
- **On success**: The user is redirected to `redirect_uri` with an authorization code and `state` returned in the URL. You must verify the `state` parameter before proceeding. Compare the returned value with the one you stored before the request. If the value is missing or doesn't match, abort the process.

***

## Exchange the Authorization Code for Tokens

After the user completes the Flow or Workflow, your application receives an authorization code. Exchange it for tokens using the `/oauth2/token` endpoint.

### Token Request Parameters

| Parameter       | Description                                                                           |
| --------------- | ------------------------------------------------------------------------------------- |
| `grant_type`    | Required. Must be `authorization_code`.                                               |
| `code`          | Required. The authorization code returned from the authorization request.             |
| `client_id`     | Required. Must match the `client_id` used in the authorization request.               |
| `redirect_uri`  | Required. Must match the `redirect_uri` used in the authorization request.            |
| `code_verifier` | Required. The original PKCE code verifier generated before the authorization request. |

### Example Token Response

```json
{
  "access_token": "eyJraWQiOiI2MzM2NjAy....zAZ4-FboQg",
  "scope": "openid profile",
  "id_token": "eyJraWQiOiI2MzM2NjAyYy05....O3dDfO13Yyg",
  "token_type": "Bearer",
  "expires_in": 86399
}
```

### Validate the ID Token

After a successful response, validate the ID token before use. Complete the following checks:

1. Verify the `iss` (issuer) claim exactly matches the Issuer Identifier.
2. Verify the `aud` (audience) claim contains your `client_id`.
3. Verify the JWS signature using:
   - The algorithm specified in the JWT header
   - The corresponding public key from the Issuer's JWKS endpoint. Go to [https://auth.incode.com/.well-known/openid-configuration](https://auth.incode.com/.well-known/openid-configuration) and find the value of `jwks_uri`.
4. Verify the current time is before the time in the `exp` (expiration) claim.
5. Verify the `nonce` claim exactly matches the `nonce` value you sent in the authorization request.

Access token validation is handled by the Incode Platform in the next step.

***

## Access Incode Platform APIs

Use the `access_token` from the previous step to make authenticated requests to the Incode Platform APIs. Include it as a Bearer token in the `Authorization` header.

If you previously sent the `x-incode-hardware-id` header, stop sending it. Use the `Authorization` header with the Bearer token instead.

The access token is bound to a single session. Standard OAuth 2.0 token validation rules apply.

### Example Request

```http
curl --location 'https://saas-api.incodesmile.com/omni/get/score' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <API-KEY>' \
--header 'Authorization: Bearer eyJraWQiOiI2MzM2Nj.....Lf_N7hww'
```

The following endpoints accept this token:

- `omni/get/score`
- `omni/get/custom-fields`
- `omni/get/onboarding/status`
- `omni/get/ocr-data`

<br />

---

- Path: `concepts-and-architecture/oidc-manual-configuration`
- URL: https://developer.incode.com/concepts-and-architecture/oidc-manual-configuration/
- Markdown: https://developer.incode.com/concepts-and-architecture/oidc-manual-configuration.md

# OIDC Manual Configuration

Manual OpenID Connect (OIDC) configuration lets you create and manage OIDC clients directly in Dashboard, giving you control over settings that [automatic configuration](/concepts-and-architecture/oidc-automatic-configuration/) pre-defaults for you, including which scopes to request, the post-logout redirect URI, and whether user consent is required. With automatic configuration, Incode ties the client directly to a Flow or Workflow and only lets you set the redirect URI. With manual configuration, scoping depends on your authentication type: onboarding authentication remains tied to a specific Flow or Workflow, while face authentication does not.

Use this approach when you need more control over your OIDC client's configuration or require specific authentication methods or grant types.

Your OIDC client is configured with:

- An authorization code grant
- A client secret for authentication

The OIDC client supports the following authentication methods:

- `client_secret_basic`

- `client_secret_post`

- `client_secret_jwt`

- `private_key_jwt`

Follow the steps on this page to configure your OIDC client. Complete them in order.

***

## Create an OIDC Client

Create a new OIDC client in Dashboard by [generating a new authorization protocol](/dashboard-platform-administration/configuration-authorization-tab/#generate-new-authorization-protocol). While following those steps:

- Copy the **_Authorize URL_**, **_Client ID_**, and **_Client Secret_**. You need those values for the remaining steps on this page.
- In **_Redirect URIs_** and **_Post Logout Redirect URIs_**, enter `https://oidcdebugger.com/debug`.
- Select any of the following checkboxes under **_Client Authentication Methods:_**
  - `client_secret_basic`
  - `client_secret_post`
  - `client_secret_jwt`
  - `private_key_jwt`

***

## Configure and Send the Authorization Request

Use <Anchor target="_blank" href="https://oidcdebugger.com/">OpenID Connect Debugger</Anchor> to test your authorization request and debug the response.

1. Enter the following values in the debugger:
   | Field         | Value                                                           |
   | ------------- | --------------------------------------------------------------- |
   | Authorize URI | Your Authorize URL from Dashboard.                              |
   | Redirect URI  | `https://oidcdebugger.com/debug`                                |
   | Client ID     | Your Client ID from Dashboard.                                  |
   | Scope         | `openid`. Add any other registered scopes, separated by spaces. |
   | State         | Populated automatically.                                        |
   | Nonce         | Populated automatically.                                        |
   | Response Type | `code`                                                          |
   | Use PKCE      | Select if required by your client configuration.                |
   | Response Mode | `fragment`                                                      |
2. Click **Send Request**. You are redirected to the Incode Authorization Server. What happens next depends on your authentication type:
   - **Face authentication**: Click **Sign In with Incode** and take a selfie. If the user is already enrolled in your organization, authentication succeeds. If not, the user is prompted to sign up. If your Dashboard configuration requires user consent, a consent page appears listing the requested scopes. The user must accept at least one scope to proceed. Consent is saved per scope, so the user is only prompted once per scope.

   - **Onboarding**: Scan the QR code with a mobile phone and complete the onboarding process. If the session status is `PASSED`, an authorization code is issued. If the status is `FAILED`, authentication is denied.
3. After successful authentication, copy the authorization code from the response. You will use it in the next step.

***

## Exchange the Authorization Code for Tokens

Send a `POST` request to `{oidc-base-url}/oauth2/token`. Replace `{oidc-base-url}` with the first part of your Authorize URL from Dashboard, before `/oauth2/authorize`. For example, if your Authorize URL is `oidc-saas.incodesmile.com/oauth2/authorize`, send the request to `oidc-saas.incodesmile.com/oauth2/token`.

Include the following parameters in the request body, formatted as `x-www-form-urlencoded`:&#x20;

| Parameter       | Description                                                                                      |
| --------------- | ------------------------------------------------------------------------------------------------ |
| `grant_type`    | Required. Must be `authorization_code`.                                                          |
| `client_id`     | Required. Your Client ID from Dashboard.                                                         |
| `client_secret` | Required. Your Client Secret from Dashboard.                                                     |
| `redirect_uri`  | Required. Must match the Redirect URI registered in Dashboard: `https://oidcdebugger.com/debug`. |
| `code`          | Required. The authorization code from the previous step.                                         |

The example above uses the `client_secret_post` authentication method. The parameters you send must match the authentication method configured for your OIDC client in Dashboard.

Authorization codes expire after five minutes. After expiration, the user must complete the authorization flow again. Sessions last one hour. During that time, you can retrieve multiple authorization codes, but only the most recent one is valid.

***

## Retrieve User Information

Send a `GET` request to `{oidc-base-url}/userinfo` . Replace `{oidc-base-url}` with the first part of your Authorize URL from Dashboard, before `/oauth2/authorize`. For example, if your Authorize URL is `oidc-saas.incodesmile.com/oauth2/authorize`, send the request to `oidc-saas.incodesmile.com/userinfo`.

Include the access token from the previous step in the Authorization header:

```http
GET {oidc-base-url}/userinfo
Authorization: Bearer {access_token}
```

Use the Postman desktop app for this request, not the web app. You must also configure the <Anchor target="_blank" href="https://learning.postman.com/docs/sending-requests/capturing-request-data/interceptor/">Postman Interceptor</Anchor> before sending.

<Accordion title="Expand for a Postman collection for testing">
  ```json
{
  "info": {
    "_postman_id": "fae0fbcd-5c8f-43e7-8cb4-e08804834f5e",
    "name": "Authorization-Server Stage",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_exporter_id": "9749190"
  },
  "item": [
    {
      "name": "well-known",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/.well-known/openid-configuration",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            ".well-known",
            "openid-configuration"
          ]
        }
      },
      "response": []
    },
    {
      "name": "jwks",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/.well-known/openid-configuration",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            ".well-known",
            "openid-configuration"
          ]
        }
      },
      "response": []
    },
    {
      "name": "/oauth2/introspect",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/oauth2/introspect",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "oauth2",
            "introspect"
          ]
        }
      },
      "response": []
    },
    {
      "name": "authorization",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/oauth2/authorize?client_id=superapp886&scope=openid&state=soa9pjyqdm&redirect_uri=https://jsonlint.com/&response_type=code",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "oauth2",
            "authorize"
          ],
          "query": [
            {
              "key": "client_id",
              "value": "superapp886"
            },
            {
              "key": "scope",
              "value": "openid"
            },
            {
              "key": "state",
              "value": "soa9pjyqdm"
            },
            {
              "key": "redirect_uri",
              "value": "https://jsonlint.com/"
            },
            {
              "key": "response_type",
              "value": "code"
            }
          ]
        }
      },
      "response": []
    },
    {
      "name": "token client_secret_post auth method",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Cookie",
            "value": "Cookie_1=value; XSRF-TOKEN=1e7a9269-bf7b-407d-b3a5-5791d0c7a405",
            "type": "text"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "authorization_code",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "76f9d8f9c4864fa69c68e617e75d435c",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "$LT0AxiQj5W6AqwU#rl_",
              "type": "text"
            },
            {
              "key": "redirect_uri",
              "value": "https://oidcdebugger.com/debug",
              "type": "text"
            },
            {
              "key": "code",
              "value": "MHRSot7hw8GSlSvyHAQrl7Fd6bqXXsL4QiluKp6y00RXKGFt5aVG3LEfXfUxYIlADgkppvIxwOZHDToqDzA3Q0bPtbH_bfRI26h_ENfTq7PEapHDBFF0JWpNaBhpS4u1",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://oidc-stage-us.stage.incodetest.com/oauth2/token",
          "protocol": "https",
          "host": [
            "oidc-stage-us",
            "stage",
            "incodetest",
            "com"
          ],
          "path": [
            "oauth2",
            "token"
          ]
        }
      },
      "response": []
    },
    {
      "name": "token client_secret_post auth method PKCE",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Cookie",
            "value": "Cookie_1=value; XSRF-TOKEN=1e7a9269-bf7b-407d-b3a5-5791d0c7a405",
            "type": "text"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "authorization_code",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "09d6202eb7454348ab4c64d82d61ca5a",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "(V6In#Cm^c@tbB0)bDM5",
              "type": "text"
            },
            {
              "key": "redirect_uri",
              "value": "https://oidcdebugger.com/debug",
              "type": "text"
            },
            {
              "key": "code",
              "value": "JUHf7ffkieiI81Yolu47Fknk1LAg4C8a4akNYPzHbODUlXI7HbPPI7QKawKwf2kigL8jxPFWAsUc5oO5P-BJ6CfJHxiDhmPh5klXVj5ukdehijEQPrh98fQ9BrbqpiQ4",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/oauth2/token",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "oauth2",
            "token"
          ]
        }
      },
      "response": []
    },
    {
      "name": "token jwt",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Cookie",
            "value": "Cookie_1=value; XSRF-TOKEN=1e7a9269-bf7b-407d-b3a5-5791d0c7a405",
            "type": "text"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "redirect_uri",
              "value": "https://oidcdebugger.com/debug",
              "type": "text"
            },
            {
              "key": "code",
              "value": "TGwBAuaexqWZvkVjO0QDGNUC9i7fHyNlcuPw68rSRDVm6VQc-TslA_IB39OV2PGoT8FRrnu20odmdP6HZh_88RJdt8Sx7GbDvZkyk6YUtGAMjLjeKe0t3aV0n8vzGKLN",
              "type": "text"
            },
            {
              "key": "client_assertion_type",
              "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
              "type": "text"
            },
            {
              "key": "client_assertion",
              "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIwOWQ2MjAyZWI3NDU0MzQ4YWI0YzY0ZDgyZDYxY2E1YSIsInN1YiI6IjA5ZDYyMDJlYjc0NTQzNDhhYjRjNjRkODJkNjFjYTVhIiwiYXVkIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAxMi9vYXV0aDIvdG9rZW4iLCJqdGkiOiI1NjQ1MjU0MjIyNDIiLCJleHAiOiIxNjg4ODIwOTE2In0.SZ9eJ0uFOGTtAagLKVl9nax3uYEp62PBVdH3Wo9ti1A",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "09d6202eb7454348ab4c64d82d61ca5a",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/oauth2/token",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "oauth2",
            "token"
          ]
        }
      },
      "response": []
    },
    {
      "name": "token client_secret_basic auth method",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Cookie",
            "value": "Cookie_1=value; XSRF-TOKEN=1e7a9269-bf7b-407d-b3a5-5791d0c7a405",
            "type": "text"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "authorization_code",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "09d6202eb7454348ab4c64d82d61ca5a",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "(V6In#Cm^c@tbB0)bDM5",
              "type": "text"
            },
            {
              "key": "redirect_uri",
              "value": "https://oidcdebugger.com/debug",
              "type": "text"
            },
            {
              "key": "code",
              "value": "JUHf7ffkieiI81Yolu47Fknk1LAg4C8a4akNYPzHbODUlXI7HbPPI7QKawKwf2kigL8jxPFWAsUc5oO5P-BJ6CfJHxiDhmPh5klXVj5ukdehijEQPrh98fQ9BrbqpiQ4",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/oauth2/token",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "oauth2",
            "token"
          ]
        }
      },
      "response": []
    },
    {
      "name": "user info",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer eyJraWQiOiIwOWRiMzI2My0zYWE3LTQwZTQtYTg1NS1lMTIyNmY5NDZlMTgiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2NTQ4Y2RhMDE3MjkwZjI5Y2ZlYjExYjIiLCJhdWQiOiI3NmY5ZDhmOWM0ODY0ZmE2OWM2OGU2MTdlNzVkNDM1YyIsIm5iZiI6MTY5OTI3MDkxMywic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsInNlbGZpZSJdLCJpc3MiOiJodHRwczovL29pZGMtc3RhZ2UtdXMuc3RhZ2UuaW5jb2RldGVzdC5jb20iLCJleHAiOjE2OTkyNzEyMTMsImlhdCI6MTY5OTI3MDkxM30.YInfHrtorh37oij2KIxWMb8cEtTyG9SsaGDsYBWSCEkP74sCJ_nxoqmTtmxL6KryRITZNiRnrScfVCTqacxybZF5bXe7E6kVr6v2Vv-PaPWoueR4wHOiBRfOhecRycZlDzfgf4nWpLfbzV9p0_k-Kier6m1X2T5wQuavYErwQcErQP2YfO_37KXs1JKGTzl2-g5xWwNPwqXVcUuQqqpAM09PVu7ffqngfztLiSXDbg5Hf8XkEhc8hdrEtmuuaoFNJ9jCXjUUxSbHi2skAvCj8aIFZcj64TNL8po6XnNNdcE4b2MLARhQUH8hQl18xk0OLOzyJAjYRSWyiKOyF9KPZQ",
            "type": "text"
          },
          {
            "key": "Cookie",
            "value": "Cookie_1=value; JSESSIONID=C94F8D8057EC9CAA36365D2B2784C98D",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://oidc-stage-us.stage.incodetest.com/userinfo",
          "protocol": "https",
          "host": [
            "oidc-stage-us",
            "stage",
            "incodetest",
            "com"
          ],
          "path": [
            "userinfo"
          ],
          "query": [
            {
              "key": "grant_type",
              "value": "authorization_code",
              "disabled": true
            },
            {
              "key": "client_id",
              "value": "superapp886",
              "disabled": true
            },
            {
              "key": "client_secret",
              "value": "secret",
              "disabled": true
            }
          ]
        }
      },
      "response": []
    },
    {
      "name": "logout",
      "request": {
        "method": "POST",
        "header": [],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "id_token_hint",
              "value": "eyJraWQiOiI0YmJiNTZiMi1lMTM4LTRmNjctOGFhZi0wNjg5MTU5OGE5YjEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2NDkwMzMxMzBiNjVmMmFjM2ZhMDc2MmMiLCJhdXRoX3Bob3RvX3F1YWxpdHlfdmFsdWUiOjEwMi40OTksImlzcyI6Imh0dHA6Ly9pbmNvZGUtZGV2ZWxvcC1vaWRjLTExNjMwMDUzNjEudXMtd2VzdC0yLmVsYi5hbWF6b25hd3MuY29tIiwiYXV0aF9vdmVyYWxsX3Njb3JlIjowLjc0MjE0MSwibm9uY2UiOiI1c2R0ejUwc2F3Iiwic2lkIjoiaEtpT0lPdGxNRk9fcHdoZVRPTTBvQ3dySzFaODJHZ2pYN0NuSVVOYjg3QSIsImF1ZCI6ImEwODY5ZTBiYjIzMDRjZTU4MmE3N2RiMTFkZGM3NWRlIiwiYXV0aF9vdmVyYWxsX3N0YXR1cyI6IlBBU1MiLCJhenAiOiJhMDg2OWUwYmIyMzA0Y2U1ODJhNzdkYjExZGRjNzVkZSIsImF1dGhfdGltZSI6MTY4ODYzNTEyOCwiaW50ZXJ2aWV3X2lkIjoiNjQ5MDI1ZTUwYjY1ZjJhYzNmOWU4ZmI1IiwiZXhwIjoxNjg4NjM2OTQwLCJpYXQiOjE2ODg2MzUxNDB9.XskcaGx1CRTpAE6A4jwSUV180UwCDPiOCStU1Y7NPlc_6-yJeoU6Wc1APmR_B2IXrksL3mEVFsymppk2pIaA32SLK0X-JMoBZlDRL-z4GSUoZhaTcvvBGAbQnCBR5MSHSg9wrG0muCqH-hqx1L9H0MyNMNtGhQk3BSpi47rw1yceUlO308pr_I5PQcMsJ7ho3SOgUV4GnAlkR9h2K-zGZiojdJok9J0f_R_umjAOzlY0kywPZ8na9miGaPLCNLFJA1dGOncbLGb8OgUVhYoij1K73UvPezuTCeRqZsoh6ksaxI_I-EiTiikpxX5694ojXLwBzBOWcOgi4TJV82jD2w",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "a0869e0bb2304ce582a77db11ddc75de",
              "type": "text"
            },
            {
              "key": "post_logout_redirect_uri",
              "value": "https://oidcdebugger.com/debug",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://incode-develop-oidc-1163005361.us-west-2.elb.amazonaws.com/connect/logout",
          "protocol": "https",
          "host": [
            "incode-develop-oidc-1163005361",
            "us-west-2",
            "elb",
            "amazonaws",
            "com"
          ],
          "path": [
            "connect",
            "logout"
          ]
        }
      },
      "response": []
    }
  ]
}
```
</Accordion>

### Test with a Specific User

To test authentication for a specific user, add `login_hint` as a parameter to your `/authorize` request. The value depends on how your OIDC client is configured in Dashboard. Accepted value types are: [UUID](/get-started-with-incode/glossary/#customer-uuid), phone number, email address, and national ID number.

To send the request:

1. Copy the authorization request from the bottom of <Anchor target="_blank" href="https://oidcdebugger.com/">OpenID Connect Debugger</Anchor>.
2. Add `&login_hint={value}` to the end of the URL.
3. Paste the full URL into your browser and press Enter.

<br />

---

- Path: `concepts-and-architecture/onboarding-vs-authentication`
- URL: https://developer.incode.com/concepts-and-architecture/onboarding-vs-authentication/
- Markdown: https://developer.incode.com/concepts-and-architecture/onboarding-vs-authentication.md

# Onboarding or Authentication: When to Use Each

The Incode Platform provides two verification journeys: **Onboarding** and **Authentication**. They serve different purposes, involve different flows, and produce different results. Understanding how they relate is essential before designing your integration.

- **Onboarding** is the process of verifying a new user's identity for the first time and enrolling them in the Incode Platform.
- **Authentication** (using the Face Authentication module) is the process of confirming that a returning user is the same person who previously enrolled.

Authentication cannot happen before onboarding. A user must successfully complete onboarding before they can be authenticated.

***

## Onboarding

Onboarding is Incode's term for an initial identity verification session. It answers the question: **"Is this person who they claim to be?"**

During onboarding, the user provides evidence of their identity. This evidence is typically an ID document and a selfie, though you can require additional evidence. The Incode Platform validates that evidence using a combination of OCR, liveness detection, and face matching. It can also include government database checks.

### Onboarding Results

A successful onboarding session produces one or both of the following results:

- **A verification score**: A calculated confidence measure for each module and an overall session score. Your application uses this score to decide whether to automatically approve, request manual review, or automatically reject the user. Scores are created automatically.
- **An Incode Identity**: A unique identifier linked to the user's facial biometric template. This template is extracted from their selfie. This Identity enables future face authentication. Incode Identities are not created automatically. You must configure them in your Flow or Workflow.

> ⚠️ **Warning**
>
> An Incode Identity is created only when you have configured Identity creation in your Flow or Workflow and all verification modules in the onboarding session pass. If any module fails, no Incode Identity is created, and the user cannot be authenticated in the future without completing a new onboarding session.

### When to Use Onboarding

Use onboarding when:

- A user is new to your platform and has not been verified before.
- You need to confirm that a user holds a valid government-issued ID.
- You need to verify user's identity against a document or government database for [KYC](/get-started-with-incode/glossary/#kyc) or compliance purposes.
- You are enrolling users who will later return and need to be recognized.

***

## Authentication

Authentication is the process of confirming that a returning user is the person whose Incode Identity was created during onboarding. It relies on the Incode Face Authentication module. Authentication answers the question: **"Is this the same person we verified before?"**

During authentication, the user provides only a selfie. The platform compares that selfie's facial biometric template against one or more previously enrolled Incode Identities.

### Prerequisite

Authentication requires a previously created Incode Identity. A user who has not completed a successful onboarding session that created an Identity cannot be authenticated.

### 1:1 and 1:N Authentication

The Face Authentication module has two modes:

- **1:1 (one-to-one) authentication**: The user's selfie is compared against a single known Incode Identity. A second factor, called an **Authentication Hint**, is required to identify which enrolled identity to compare against. The Authentication Hint is typically the `identityID`, a unique customer identifier returned when the user was approved during onboarding. It is associated with their Incode Identity. Other unique values associated with the identity can also be used.

  Use 1:1 authentication when your application already knows which user is attempting to authenticate. This can be a user who has already entered a username or phone number before the face authentication step.
- **1:N (one-to-many) authentication**: The user's selfie is compared against all enrolled Incode Identities in your account's database. The Incode Platform identifies the closest match without requiring the user to provide any other identifying information.

  Use 1:N authentication when your application does not know which user is authenticating in advance. This can be in kiosk setups or passwordless login flows where face recognition is the only input.

### When to Use Authentication

Use authentication when:

- A user has already been onboarded and enrolled.
- You want to verify that a returning user is the same person who was originally verified, without requiring them to re-submit an ID document.
- You are building a passwordless or biometric login flow.
- You want to confirm a user's identity before authorizing a high-value action.

### Authentication Is Not Authorization

**Authentication** and **authorization** are different things:

- **Authentication** verifies an identity, confirms that users are real, and detects common fraudulent behavior.
- **Authorization** grants or denies access or privileges to resources in your application.

**Incode does not provide an authorization layer.&#x20;**&#x44;eciding what users are allowed to do is your application's responsibility. Incode returns a result—such as `faceMatch: true/false` or `verified: true/false`—and your application decides what action to take.

***

## The Full Lifecycle

The relationship between onboarding and authentication follows a pattern: onboarding happens once, and authentication can happen many times after.

The following process is for a new user:

1. An onboarding session is created.
2. The user captures their ID and a selfie.
3. The modules validate data.
4. Their score is calculated.
5. The session is approved.
6. Their Incode Identity is created, and their [customer UUID](/get-started-with-incode/glossary/#customer-uuid) is returned.

The following process is for a returning user:

1. The user captures only a selfie.
2. The Incode Platform compares their selfie to their enrolled Incode Identity.
3. A `faceMatch` result is returned.
4. Your app grants or denies access.

***

## Key Objects

The following objects are created and used across the onboarding and authentication lifecycle:

| Object                         | Created during           | Used for                                                                          |
| ------------------------------ | ------------------------ | --------------------------------------------------------------------------------- |
| `interviewId` / Session ID     | Onboarding               | Identifying the onboarding session; fetching scores and OCR data                  |
| Incode Identity                | Onboarding (on approval) | The enrolled user record that authentication compares against                     |
| `identityID`                   | Onboarding (on approval) | The Authentication Hint for 1:1 face authentication                               |
| Facial biometric template      | Onboarding (from selfie) | Face comparison during authentication; stored in the Incode Identity              |
| Authentication `transactionId` | Face Authentication      | Identifying a specific authentication attempt; required for back-end verification |

***

## Choose the Right Capability

The following scenarios map to the correct capability to use:

| Scenario                                                                                             | Use                           |
| ---------------------------------------------------------------------------------------------------- | ----------------------------- |
| New user; no prior verification                                                                      | **Onboarding**                |
| User holds an ID document you need to validate                                                       | **Onboarding**                |
| KYC or [AML](/get-started-with-incode/glossary/#aml) compliance check required | **Onboarding**                |
| Returning user who knows their `identityID` or alternate                                             | **Face Authentication (1:1)** |
| Returning user who does do not know their identifier                                                 | **Face Authentication (1:N)** |
| Passwordless or biometric login for enrolled users                                                   | **Face Authentication**       |
| Confirming identity before a high-value action                                                       | **Face Authentication (1:1)** |
| Re-verifying an enrolled user's document                                                             | **Onboarding**                |

***

## Integration Paths for Each Capability

Both capabilities are available across the same integration types: no-code/low-code, a supported Incode SDK, and the Incode API.

### **Onboarding Integration Paths**

Onboarding integration paths include:

- **No-code**: Webflow URL
- **Low-code**: Redirect to Webflow URL with a session token
- **Full SDK**: Web SDK or mobile SDK with explicit module steps
- **API-only**: Single or batch onboarding via API endpoints

### **Authentication Integration Paths**

Authentication integration paths include:

- **Hosted**: 1:N Authentication Links, OIDC Authentication Links
- **Web SDK**: `renderLogin()` method
- **Mobile SDK**: `startFaceLogin()` (online 1:1) or offline face login

[Integrate by Platform](/integrate-by-platform/integrate-by-platform/) is the recommended starting point for authentication integrations.

***

## Related Pages

- [What is Identity Verification?](/get-started-with-incode/what-is-identity-verification/): Detailed information about why you need IDV and how it works
- Incode Face Authentication Foundations: Detailed concepts: biometric templates, Incode Identities, 1:1 vs. 1:N
- [Onboarding Session Lifecycle](/get-started-with-incode/onboarding-session-lifecycle/): How a session moves from creation to completion
- [Integrate by Platform](/integrate-by-platform/integrate-by-platform/): Implementation starting point
- [Scoring System Explained](/concepts-and-architecture/understanding-scores/): How onboarding session scores are calculated and used

<br />

---

- Path: `concepts-and-architecture/understanding-scores`
- URL: https://developer.incode.com/concepts-and-architecture/understanding-scores/
- Markdown: https://developer.incode.com/concepts-and-architecture/understanding-scores.md

# Scoring System

Every Incode onboarding session produces a score. This score indicates how confident the Incode Platform is that the user is who they claim to be. Session scores are based on the verification modules in your Flow or Workflow. Your application uses the score to decide whether to approve the user, send the session for manual review, or reject it.

***

## Score Structure

An onboarding session score has two components: a **numeric value** and a **status**.

### Numeric Value

Scores are expressed as a decimal value out of 100, in the format `x.x/100`. For example:

- `95.2/100`: High confidence
- `79.0/100`: Moderate confidence
- `0.0/100`: Zero confidence, or a module that did not run

### Status

Statuses are category labels based on:

- The numeric value.
- The thresholds configured in your Flow or Workflow.

There are five possible statuses:

| Status    | Meaning                                                                                                                                 |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `ok`      | The score meets the passing threshold. The user passed this check.                                                                      |
| `warn`    | The score is below the passing threshold but above the review threshold. The result warrants attention but is not a definitive failure. |
| `manual`  | The session has been flagged for manual human review in Dashboard.                                                                      |
| `fail`    | The score is below the review threshold. The check did not pass.                                                                        |
| `unknown` | The score could not be calculated. For example, a module did not run or a result is pending.                                            |

***

## Module Scores and Overall Session Score

Some modules produce their own independent score. Other don't produce their own score but can still influence the session score based on business logic in your Flow or Workflow. These **module scores** and your business logic work together to produce the overall **session score**.

### Modules with Independent Scores

Each module that contributes to scoring produces a value/status pair. The primary scoring modules are:

| Module           | Score field       | What it measures                                                           |
| ---------------- | ----------------- | -------------------------------------------------------------------------- |
| ID Validation    | `idValidation`    | Document authenticity, OCR quality, and anti-tampering checks              |
| Face Recognition | `faceRecognition` | Match confidence between the selfie and the ID document photo              |
| Liveness         | `liveness`        | Confidence that the selfie was taken from a live person and is not a spoof |

> 📘 **Note**
>
> If no `validationModuleList` is specified when creating a session, the default modules used for scoring are `id`, `faceRecognition`, and `liveness`.

**Example Module Score Response**

```json
{
  "overall":         { "value": "79.0/100", "status": "warn" },
  "faceRecognition": { "value": "0.0/100",  "status": "warn" },
  "liveness":        { "value": "95.2/100", "status": "manual" },
  "idValidation":    { "value": "79.0/100", "status": "fail" }
}
```

### Modules That Influence the Overall Session Score

Some modules collect data and don't produce their own score. These modules can still influence the overall session score when you configure business logic conditions in your Workflow. Their results may not be expressed as an `x.x/100` score.

The `extendedUserScoreJsonData` field in the score response contains the full raw JSON for all score data if you need to inspect non-primary module results.

The following non-scoring modules are common in onboarding sessions:

- [eKYC](/features-and-modules/ekyc/)
- [eKYB](/features-and-modules/ekyb/)
- [Global Watchlist](/features-and-modules/watchlist/)
- [Antifraud Check](/features-and-modules/antifraud-check/)
- [Deepsight](/features-and-modules/deepsight/)

### Overall Session Score

The overall session score (`overall`) is a composite score. It aggregates the module-level results and reflects the combined confidence across all scoring modules in the onboarding session. The overall score uses the same numeric value and status format as module scores.

> 📘 Note
>
> The numeric thresholds that determine whether a score is `ok`, `warn`, or `fail` are set per Flow or Workflow in Dashboard. The thresholds that make sense for your use case depend on your risk tolerance and regulatory requirements. Contact your Incode Representative for guidance on threshold configuration.

### Score Timing

Module scores are calculated as each module completes. These scores may be available before the session finishes, as shown in the following table. Incode recommends waiting for `ONBOARDING_FINISHED` before you fetch scores, because individual module scores do not reflect business rules or the overall session score.

| Session status                   | What scores are available                                     |
| -------------------------------- | ------------------------------------------------------------- |
| `ID_VALIDATION_FINISHED`         | `idValidation` score is available                             |
| `GOVERNMENT_VALIDATION_FINISHED` | Government validation result is available                     |
| `FACE_VALIDATION_FINISHED`       | `faceRecognition` and `liveness` scores are available         |
| `ONBOARDING_FINISHED`            | All scores are finalized; overall session score is calculated |

***

## Retrieve Scores

Scores are available once the session reaches `ONBOARDING_FINISHED` status. You can also view session scores in Dashboard or retrieve them via API or SDK.

### View Scores in Dashboard

Onboarding session scores are visible in **Dashboard** >**Sessions**. Each session view shows:

- The overall score and status
- Per-module details, including module scores where applicable
- The final determination: Approved, Needs Review, Rejected, or Expired
- The session event log

Additional information may be available depending on the modules in your Flow or Workflow.

Dashboard is where reviewers manually examine the session and make an approve or reject decision, which triggers the `MANUAL_REVIEW_APPROVED` or `MANUAL_REVIEW_REJECTED` webhook.

### Retrieve Scores via API

Use the `GET /omni/get/score` endpoint. This requires an admin token in the `X-Incode-Hardware-Id` header and your API key in `x-api-key`.

```http
GET /omni/get/score?id={interviewId}
Content-Type: application/json
api-version: 1.0
x-api-key: YOUR_API_KEY
X-Incode-Hardware-Id: YOUR_ADMIN_TOKEN
```

See the [Get Scores API reference](/reference/getscores/) for the full response schema.

### Retrieve Scores via SDK

In mobile integrations using the full SDK flow, the `getUserScore()` method returns the score at the end of the session. The result includes a parsed `data` object with top-level score fields and the raw `extendedUserScoreJsonData` JSON for full detail.

```javascript
// React Native example
IncodeSdk.getUserScore({ mode: 'fast' })
  .then((result) => {
    // result.data.status: 'warning' | 'unknown' | 'manual' | 'fail'
    // result.data.overallScore: "79.0/100"
    // result.extendedUserScoreJsonData: raw JSON string
    validateResultWithBusinessLogic(result);
  });
```

> 📘 **Tip**
>
> Apply approval logic, such as score thresholds and identity creation, in your back end, not in the SDK callback. The SDK result is useful for immediate UI feedback, but your server should make the final decision using the API response.

***

## Map Session Results to Business Decisions

Your Flow or Workflow configuration determines how overall session results map to business outcomes. The following table shows a typical mapping.

| Outcome           | Session Result | What it means                                                                                                                                                     |
| ----------------- | :------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Approve**       | **Pass**       | The session passed based on your configured thresholds. The user is approved. If configured in your Flow or Workflow, an Incode Identity is created for the user. |
| **Manual Review** | **Warn**       | The session is placed in a review queue based on your configured thresholds. A human reviewer then approves or rejects it in Dashboard.                           |
| **Deny**          | **Fail**       | The session failed based on your configured thresholds. The user is rejected. No Incode Identity is created.                                                      |

In a Flow, this mapping is set in the **Session Score: Pass** setting. In a Workflow, the mapping is determined in the final condition branch.

***

## Related Pages

- [Onboarding Session Lifecycle](/get-started-with-incode/onboarding-session-lifecycle/): Session statuses and how scoring relates to session completion
- [Flows](/dashboard-platform-administration/flows-1/): How to configure score-to-decision mapping in Flows in Dashboard
- [Conditions for Workflows](/concepts-and-architecture/conditions-for-workflows-20/): Workflow-based score conditions and branching logic

<br />

---

- Path: `concepts-and-architecture/user-consent-considerations`
- URL: https://developer.incode.com/concepts-and-architecture/user-consent-considerations/
- Markdown: https://developer.incode.com/concepts-and-architecture/user-consent-considerations.md

# User Consent for PII Data

Businesses must collect customer consent and comply with all regional laws and regulations. Incode gives you the tools to collect and manage consent for customers in all regions, including GDPR-regulated countries. This is a general guide. For the full requirements on which types of consent you must collect and how to collect them, review your Master Service Agreement (MSA). Then contact customer support.

## Types of Consent

There are two primary types of consent that Incode requires: 

* **Privacy Consent**: This is also commonly referred to as User Consent. Collection is required for all customers.
* **Machine Learning Consent**: This consent stipulates that Incode has gathered the informed consent necessary to anonymize collected user data for the purpose of improving our machine learning models.

## Collecting Consent

There are two primary methods for gathering the necessary consent and submitting it to Incode so that it can be stored with a user's identity. Please see your MSA for additional details.

* **Dashboard**: Customers can select the `User Consent` module. 
  * If you have your own custom consent, you can append Incode's privacy consent to your custom consent so that they are collected simultaneously. In the details of the `User Consent` module, input the title and the content of the privacy consent in the appropriate text boxes and save the flow.
* **API**: If consent is collected prior to performing an onboarding, the collected consent (which must include the required Incode consent) can be uploaded to a session via the API. To upload a consent object to an onboarding session, see the <Anchor label="Add User Consent endpoint" target="_blank" href="https://developer.incode.com/reference/adduserconsent">Add User Consent endpoint</Anchor>.

For custom integrations using our SDKs or a completely whitelabeled app that only uses our API, the above consent policies need to be collected and sent to Incode. Most of our SDKs contain built-in modules; however, if an SDK does not have a built-in module, you can collect the consent via a custom screen and use our API to send the consent to Incode.

## Local Laws and Regulations

While Incode provides tools to assist with compliance of local laws and regulations, it is the responsibility of every business to seek legal council and ensure that all local, state, and federal laws are upheld.

---

- Path: `concepts-and-architecture/workflows`
- URL: https://developer.incode.com/concepts-and-architecture/workflows/
- Markdown: https://developer.incode.com/concepts-and-architecture/workflows.md

# Flows and Workflows

Flows are the legacy method for defining onboarding and authentication experiences in Dashboard. They run modules in a fixed order without conditional logic or branching. We recommend [Workflows](/dashboard-platform-administration/workflows-20/) for all new implementations. [Flows](/dashboard-platform-administration/flows-1/) remain fully supported, but new capabilities are being built on Workflows.



***

## Workflows

Workflows allow you to create and customize user journeys, like the one shown below.


<Image src="https://developer.incode.com/assets/6827982d23a9ab5d611e74724d57c0f8.png" alt="A drag-and-drop interface where you can configure the order and conditions of the user journey." align="center" />


Workflows offer a more flexible, no-code solution for building verification experiences in Dashboard. Key capabilities include:

- **Customizable module ordering**: Specify the sequence for verification steps.
- **Conditional branching**: Create dynamic user journeys based on specific criteria, user inputs, or verification results.
- **Multi-layered verification**: Combine multiple verification methods to enhanced reliability.
- **Dynamic interface**: Manage and visualize the verification journey in a user-friendly interface.

Learn how to [configure Workflows in Dashboard](/dashboard-platform-administration/workflows-20/).

### Nodes

Individual elements within a Workflow. There are four types of nodes:

- **Module nodes**: Represent end-user interaction. Every Module node has a specific set of configuration options. Module nodes usually collect user data. They sometimes require a specific Process node to perform data manipulation and additional checks. User Consent and ID Capture are examples of Module nodes.
- **Process nodes**: Non-interactive nodes for data processing. Place a Process node after a relevant Module node. For example, a Face Match Process node would follow a Face Capture and ID Capture Module node. Process nodes have set configuration options.
- **Condition nodes**: Branch the user journey based on collected data. You can combine Condition nodes using the logical operators AND and OR to define different steps in the user journey based on the condition result. Each Yes and No branch can contain any type of Workflow node to collect more data, perform additional processing, or end the user journey. Learn more about <Anchor target="_blank" href="/concepts-and-architecture/conditions-for-workflows-20/">conditions</Anchor>.
- **Result nodes**: Specify the end result of the session. Every Workflow branch must end with a Result node. Session status Result nodes can have one of the following values: `OK`, `FAIL`, `MANUAL`, or `WARN`.

### Templates

Incode offers various Workflow templates for specific use cases that represent common business needs. These include:

- Standard identity verification
- Age verification
- Setup verification

You can [create a Workflow from a template](/dashboard-platform-administration/workflows-20/#workflow-templates) to quickly launch it to your users.

### Integration

Integrating Workflows into your application or website is crucial to using the full capabilities of the Incode Platform. You can integrate using any of the following options, according to your needs:

- Direct onboarding URLs
- iFrame integration
- SDKs for iOS, Android, and hybrid platforms

Each option provides a seamless way to incorporate identity verification into your user flow, enhancing user experience and security. Learn more about [integration options](/integrate-by-platform/workflow-integration/).

<br />

---

- Path: `dashboard-platform-administration/add-modules`
- URL: https://developer.incode.com/dashboard-platform-administration/add-modules/
- Markdown: https://developer.incode.com/dashboard-platform-administration/add-modules.md

# Add Modules


You must add modules to Workflows and Flows in Dashboard. Some modules are only supported in Workflows or Flows. Some are supported in both. The following table indicates this availability.


| Module | Workflows | Flows |
| --- | --- | --- |
| [Advanced Electronic Signature](/dashboard-platform-administration/advanced-electronic-signature-dashboard-1/) | ✅ | ✅ |
| [Antifraud Check](/dashboard-platform-administration/antifraud-check-dashboard/) | ✅ (Process node) | ✅ |
| [Certificate Issuance](/dashboard-platform-administration/certificate-issuance-dashboard/) | _In development_ | _In development_ |
| [Claims Matching](/dashboard-platform-administration/claims-matching-dashboard/) | ✅ (Process node) | ❌ |
| [Cross Check](/dashboard-platform-administration/cross-check-dashboard/) | ✅ (Process node) | ✅ (Setting instead of a module) |
| [CURP Validation](/dashboard-platform-administration/curp-validation-dashboard/) | ✅ | ✅ |
| [Custom Fields](/dashboard-platform-administration/custom-fields-dashboard/) (Deprecated) | ❌ | ✅ |
| [Custom Module](/dashboard-platform-administration/custom-module-dashboard/) | ✅ | ❌ |
| [Custom Watchlist](/dashboard-platform-administration/custom-watchlist-dashboard/) | ✅ (Process node) | ✅ |
| [Data Sharing Consent](/dashboard-platform-administration/data-sharing-consent-dashboard/) | ✅ | ✅ |
| [Document Capture](/dashboard-platform-administration/document-capture-dashboard/) | ✅ | ✅ |
| [eKYB](/dashboard-platform-administration/ekyb-dashboard/) | ✅ | ✅ |
| [eKYC](/dashboard-platform-administration/ekyc-dashboard/) | ✅ | ✅ |
| [eKYC Prefill](https://developer.incode.com/dashboard-platform-administration/ekyc-prefill-dashboard/) | ✅ | ✅ |
| [Electronic Signature](/dashboard-platform-administration/electronic-signature-dashboard/) | ✅ | ✅ |
| [Email Input](/dashboard-platform-administration/email-input-dashboard/) | ✅ | ✅ |
| [External Decision](/dashboard-platform-administration/external-decision-dashboard/) | ✅ | ❌ |
| [Face Authentication](/dashboard-platform-administration/face-authentication-dashboard/) | ✅ | ✅ |
| [Face Capture](/dashboard-platform-administration/face-capture-dashboard/) | ✅ | ✅ |
| [Face Match](/dashboard-platform-administration/face-match-dashboard/) | ✅ (Process node) | ✅ |
| [Face Onboarding](/dashboard-platform-administration/face-onboarding-dashboard/) | ❌ | ✅ |
| [Field Comparison](/dashboard-platform-administration/field-comparison-dashboard/) | ❌ | ✅ |
| [Fiscal QR OCR](/dashboard-platform-administration/fiscal-qr-ocr-dashboard/) | ❌ | ✅ |
| [Forms and Data Entry](/dashboard-platform-administration/forms-and-data-entry-dashboard/) | ✅ | ✅ |
| [Geolocation](/dashboard-platform-administration/geolocation-dashboard/) | ✅ | ✅ |
| [Government Record Verification](/dashboard-platform-administration/government-record-verification-dashboard/) | ✅ (Process node) | ❌ |
| [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) | ✅ | ✅ |
| [ID Validation](/dashboard-platform-administration/id-validation-dashboard/) | ✅ (Process node) | ✅ |
| [Instant BAV](/dashboard-platform-administration/instant-bav-dashboard/) | ❌ | _In development_ |
| [KYB Modules](/dashboard-platform-administration/kyb-modules-dashboard/) | ✅ | ✅ |
| [NFC Scan](/dashboard-platform-administration/nfc-scan-dashboard/) | ✅ | ✅ |
| [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard/) | ✅ | ✅ |
| [Proof of Address Capture](/dashboard-platform-administration/proof-of-address-capture-dashboard/) | ✅ | ✅ |
| [Qualified Electronic Signature](/dashboard-platform-administration/qualified-electronic-signature-dashboard-1/) | _In development_ | _In development_ |
| [Review OCR Data](/dashboard-platform-administration/review-ocr-data-dashboard/) | ✅ | ❌ |
| [TrustGraph](/dashboard-platform-administration/trust-graph-module-configuration/) | ✅ | ✅ |
| [Video Conference](/dashboard-platform-administration/video-conference-dashboard/) | ✅ | ✅ |
| [Video Selfie](/dashboard-platform-administration/video-selfie-dashboard/) | ✅ | ✅ |
| [Watchlist](/dashboard-platform-administration/watchlist-dashboard/) | ✅ (Process node) | ✅ |
| [Watchlist Business](/dashboard-platform-administration/watchlist-business-dashboard/) | ✅ | ✅ |

---

- Path: `dashboard-platform-administration/advanced-electronic-signature-dashboard-1`
- URL: https://developer.incode.com/dashboard-platform-administration/advanced-electronic-signature-dashboard-1/
- Markdown: https://developer.incode.com/dashboard-platform-administration/advanced-electronic-signature-dashboard-1.md

# Advanced Electronic Signature

The Advanced Electronic Signature module shows the user documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant.

For an overview of this module and how it works, see [Advanced Electronic Signature](/features-and-modules/advanced-electronic-signature/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Advanced Electronic Signature to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Electronic signature - Advanced** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Electronic signature - Advanced**.
    - **Classic**: From the Modules list, drag and drop the **Electronic signature - Advanced** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Advanced Electronic Signature to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Electronic signature - Advanced** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of configuration panel">

![Image of Advanced Electronic Signature module configuration in Workflows. Availability listed for Web, iOS, and Android. Has five configuration options](https://developer.incode.com/assets/73cea396-2f0f-4ac5-baa4-d5cb98b40486.png)

</Accordion>

| Setting                                                 | Description                                                                                                                                                                                                                                                |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Allow user to upload document_**                  | Allows the user to upload the document they want signed instead of using a document preconfigured in the session.                                                                                                                                          |
| **_Allow user to download signed document_**                   | Allows the user to download the signed document.                                                                                                                                                                                                           |
| **_Issue a permanent certificate_** | Issues a permanent digital certificate for the signing event.                                     |
| **_Allow signing without a passing score_**                | Allows the advanced electronic signature to be completed without requiring a minimum identity verification score. Use this when you want to permit signing regardless of the user's verification result.                                                   |
| **_Validation to skip_**<br />              | Lets you disable specific verification requirements before signing is allowed: _Total score_, _ID_, _Face recognition_, and _OTP_. |

### Configuration Options: Classic

<Accordion title="View image of Workflow configuration panel" >
  ![Image of the Advanced Electronic Signature module's configuration panel. Has four configuration options.](https://developer.incode.com/assets/fb8367a85fb57e15f4f76818d9688837.png)
</Accordion>

<Accordion title="View image of Flow configuration panel" >
  ![Image of the Advanced Electronic Signature module's configuration panel. Has four configuration options.](https://developer.incode.com/assets/b6acedbc3038b14bdb97582984a1a3a8.png)
</Accordion>



| Setting                                                 | Description                                                                                                                                                                                                                                                |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Allow user to upload document_**                  | Allows the user to upload the document they want signed instead of using a document preconfigured in the session.                                                                                                                                          |
| **_Allow user to download document_**                   | Allows the user to download the signed document.                                                                                                                                                                                                           |
| **_Issue Permanent Certificate_**<br />_Workflows only_ | Issues a permanent digital certificate for the signing event.                                     |
| **_Allow AES without score validation_**                | Allows the advanced electronic signature to be completed without requiring a minimum identity verification score. Use this when you want to permit signing regardless of the user's verification result.                                                   |
| **_Validation to skip_**<br />_Flows only_              | Lets you disable specific verification requirements before signing is allowed: _Total score_, _ID_, _Face recognition_, and _OTP_. |

---

- Path: `dashboard-platform-administration/antifraud-check-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/antifraud-check-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/antifraud-check-dashboard.md

# Antifraud Check

The Antifraud Check module compares the current session against prior sessions and known identities to detect signs of fraud.

For an overview of this module and how it works, see [Antifraud Check](/features-and-modules/antifraud-check/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Antifraud Check to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New&#x20;**&#x6F;r select an existing Workflow.
3. Add the **Antifraud check** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Antifraud check**.
    - **Classic**: From the Processes list, drag and drop the **Antifraud check** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Antifraud Check to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Antifraud check** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of Workflow configuration panel">

![Image of Antifraud Check module configuration in Workflows. Availability listed for Web, iOS, and Android. Has one configuration option](https://developer.incode.com/assets/00201cb0-b5de-4e27-b392-375e022c1988.png)

</Accordion>

<Accordion title="View image of Flow configuration panel">

![Image of Antifraud Check module configuration in Flows. Availability listed for Web, iOS, and Android. Has six configuration options](https://developer.incode.com/assets/5b00cba1-41d9-4ecf-98e5-c3dfea9c3895.png)

</Accordion>

| Setting                                                                                                                 | Description                                                                                                                                                                                                                                                                      |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Auto execute_**<br />_Flows only_                                                                                    | When enabled, the module runs automatically after biometric and document data are collected.                                                                                                                                                                                     |
| **_Exclude sessions with the same external customer id_**                                                               | When enabled, sessions that share the same external customer ID are excluded from the fraud comparison.                                                                                                                                                                          |
| **_Send to manual review after too many failed sessions_**<br />_Flows only_     | When enabled, sends the session to manual review if the count of sessions where the total fraud score failed exceeds the specified threshold. Default: _3_.  |
| **_Fail Antifraud after too many failed sessions_**<br />_Flows only_             | When enabled, causes the Antifraud Check to fail if the count of sessions where the total fraud score failed exceeds the specified threshold. Default: _4_.      |
| **_Fail Antifraud after too many attempts_**<br />_Flows only_                                       | When enabled, causes the Antifraud Check to fail if the total number of attempts exceeds the specified threshold. Default: _4_.                              |
| **_Send to manual review after too many attempts_**<br />_Flows only_                                   | When enabled, sends the session to manual review if the total number of attempts exceeds the specified threshold. Default: _3_.                                        |

### Configuration Options: Classic

<Accordion title="View image of Workflow configuration panel">
  ![Image of Antifraud Check module configuration panel in Workflows. Has one configuration option.](https://developer.incode.com/assets/a7438dfb85088f1d22262c993430b507.png)
</Accordion>

<Accordion title="View image of Flow configuration panel">
  ![Image of Antifraud Check module configuration panel in Flows. Has six configuration options.](https://developer.incode.com/assets/81cea8e8b63a7ca07ec4f2c1e1ab3505.png)
</Accordion>

| Setting                                                                                                                 | Description                                                                                                                                                                                                                                                                      |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Auto execute_**<br />_Flows only_                                                                                    | When enabled, the module runs automatically after biometric and document data are collected.                                                                                                                                                                                     |
| **_Exclude sessions with the same external customer id_**                                                               | When enabled, sessions that share the same external customer ID are excluded from the fraud comparison.                                                                                                                                                                          |
| **_Send to manual review if the number of sessions in which the total score failed is greater than_**<br />_Flows only_ | When enabled, sends the session to manual review if the count of sessions where the total fraud score failed exceeds the specified threshold. Default: _3_.  |
| **_Antifraud fails if the number of sessions in which total score failed is greater than_**<br />_Flows only_           | When enabled, causes the Antifraud Check to fail if the count of sessions where the total fraud score failed exceeds the specified threshold. Default: _4_.      |
| **_Antifraud fails if the number of attempts is greater than_**<br />_Flows only_                                       | When enabled, causes the Antifraud Check to fail if the total number of attempts exceeds the specified threshold. Default: _4_.                              |
| **_Send to manual review if the number of attempts is greater than_**<br />_Flows only_                                 | When enabled, sends the session to manual review if the total number of attempts exceeds the specified threshold. Default: _3_.                                        |

---

- Path: `dashboard-platform-administration/certificate-issuance-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/certificate-issuance-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/certificate-issuance-dashboard.md

# Certificate Issuance

The Certificate Issuance module issues a digital certificate tied to a verified identity, supporting legally binding and compliant document signing.

For an overview of this module and how it works, see [Certificate Issuance](/features-and-modules/certificate-issuance/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Certificate Issuance to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Certificate Issuance** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Certificate Issuance**.
    - **Classic**: From the Modules list, drag and drop the **Certificate Issuance** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Certificate Issuance to Flows

1. In the left menu in Dashboard, **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Certificate Issuance** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of configuration panel">

![Image of Certificate Issuance module configuration in Workflows. Availability listed for Web, iOS, and Android. Has two configuration options](https://developer.incode.com/assets/329c6eb1-987d-4361-a0eb-41689c755867.png)

</Accordion>

| Setting | Description |
|---|---|
| **_Region_** | The region in which the certificate is issued. Select the region for your regulations: for example, _EU_. Contact your Incode Representative to enable this option for your organization. |
| **_Type of Certificate for Signature_** | The certificate validity type used for document signing:<br />• _One Time_: 10 minutes; best for single-document, single-signature scenarios<br />• _Short Term_: 30 minutes to 24 hours; best for multiple transactions or documents within the same session<br />• _Long Term_: 10 days to 2 years in Mexico, and up to 3 years in the EU; best for ongoing use. |

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of Certificate Issuance module configuration in Workflows. Has two configuration options..](https://files.readme.io/e080fecccc3328a8a4ca338b5d1cb0974da8464c1599e30f42cafc7ce6839594-image.png)

</Accordion>

| Setting | Description |
|---|---|
| **_Region_** | The region in which the certificate is issued. Select the region for your regulations: for example, _EU_. Contact your Incode Representative to enable this option for your organization. |
| **_Type of Certificate for Signature_** | The certificate validity type used for document signing:<br />• _One Time_: 10 minutes; best for single-document, single-signature scenarios<br />• _Short Term_: 30 minutes to 24 hours; best for multiple transactions or documents within the same session<br />• _Long Term_: 10 days to 2 years in Mexico, and up to 3 years in the EU; best for ongoing use. |

---

- Path: `dashboard-platform-administration/check-system-status`
- URL: https://developer.incode.com/dashboard-platform-administration/check-system-status/
- Markdown: https://developer.incode.com/dashboard-platform-administration/check-system-status.md

# Check System Status

The **Status** link in the left menu in Dashboard opens <Anchor target="_blank" href="https://status.incode.com/">status.incode.com</Anchor> in a new tab. Use this site to:

- **Check system health:** See if all services are working normally.
- **View uptime history:** See uptime for each service over the past 90 days.
- **Track incidents:** See past and current incidents, with updates on each one.
- **Subscribe to updates:** Get notified when an incident starts, changes, or ends.

If you have a problem, check this page first to see if it's known issue. If the problem is not shown, it may be something specific to your account.

## Subscribe to Updates

Click **Subscribe to Updates** at the top of the page. Choose how you want to be notified:

- **Email:** Enter your email address. Verify it with a code.
- **Phone (SMS):** Select your country code. Enter your phone number. Verify it with a code.
- **Slack:** Connect your Slack workspace.
- **Webhook:** Enter a webhook URL and your email address. Incode will email you if the webhook fails.
- **RSS/Atom feed:** Use the <Anchor target="_blank" href="https://status.incode.com/history.atom">Atom feed</Anchor> or <Anchor target="_blank" href="https://status.incode.com/history.rss">RSS feed</Anchor>.

<br />

---

- Path: `dashboard-platform-administration/choosing-between-standard-and-beta`
- URL: https://developer.incode.com/dashboard-platform-administration/choosing-between-standard-and-beta/
- Markdown: https://developer.incode.com/dashboard-platform-administration/choosing-between-standard-and-beta.md

# Choosing Between Standard and Beta

Dashboard comes in two versions: Standard and Beta. Standard is the default and the one your team uses today. Beta is the same Dashboard, but new features arrive there first. Each user chooses between Standard and Beta for themselves and can switch between them at any time. Throughout this section, pages or information specific to Beta use the <Pill type="beta" /> tag.

***

## The Two Versions

Both versions show the same organization, the same sessions and the same settings. The difference is only how early new features reach you.

<Cards>
<CardRow>
<Card title="Standard (Default)">The Dashboard you know. Features arrive here once they have spent time in Beta. If nobody in your team does anything, this is what everyone keeps using.</Card>
<Card title="Beta (Optional)">The same Dashboard, with new features before they reach Standard. You see changes earlier, and what you tell us shapes them before they are final.</Card>
</CardRow>
</Cards>

***

## How the Choice Works

There are two levels. Your organization decides whether Beta is available at all. Then, each user decides whether to use it.

### Level 1: Whether Beta Is Available in Your Org

First, your Dashboard administrator must contact your Incode representative to enable Beta for your organization. Then, by default, users can choose to move from Standard to Beta. An administrator can choose to restrict users to Standard. Do this if the whole team should stay on one version: for example, if you are training new reviewers or documenting a process.

### Level 2: Which Version You Personally Use

When Beta is available, each user picks their own version. Your choice is yours alone: switching does not change what your colleagues see, and two people on the same team can use different versions.

The first time Beta becomes available to you, a short introduction appears. You can try Beta from there. After that, follow the steps below to switch between versions. Save Flows and Workflows before switching.


:::note
To access the introduction again, collapse the left menu and click **Beta**.
:::

1. In Dashboard, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline) next to your name in the bottom left.
2. Select **Settings**.
3. For **Dashboard version**, choose _Standard_ or _Beta_. The change takes effect immediately.

:::info
While you are on Beta, the bottom of the left menu shows a **Beta** tag. Click **Back to Standard** next to it to quickly switch back.
:::

***

## What's In Beta Right Now

Beta changes one area today. Everything else in Dashboard looks and behaves exactly as it does on Standard.

| Area | Where | What changes |
|---|---|---|
| [Session details](/dashboard-platform-administration/view-session-details/) | Inside **Sessions** | Two distinct views: an Overview for a quicker read on the session, and a Detailed view for investigating each module that ran. |

***

## What Switching Does Not Change

Switching version changes how Dashboard looks, not what it holds. Nothing is migrated, copied, or rebuilt, including:

- Your sessions, identities, and their history.
- Your Flows, Workflows, and module settings.
- Your users, roles, and permissions.
- Your integrations and API behavior.

Because the two versions read the same data, you can move between them mid-task without losing anything.

***

## FAQs

<AccordionGroup>

<Accordion title="Does my choice affect anyone else on my team?">

No. The version is saved against your own account, so it applies only to you. Your colleagues stay on whatever version they have chosen, and a team can run on both versions at once.

</Accordion>

<Accordion title="Does my choice follow me to another computer?">

Yes. It is stored with your account, not in the browser, so signing in somewhere else brings your chosen version with you.

</Accordion>

<Accordion title="Can I go back to Standard?">

Yes, at any time. While you are on Beta, a **Back to Standard** option is available at the bottom of the left menu. If the left menu is collapsed, click **Beta** > **Back to Standard**. You can also switch between versions in your [Settings](#level-2-which-version-you-personally-use). Switching happens automatically. There is no limit on how often you switch.

</Accordion>

<Accordion title="What happens if my organization turns Beta off later?">

Anyone using Beta returns to Standard automatically. No data is affected, and users do not need to do anything themselves.

</Accordion>

<Accordion title="Will features in Beta change before they reach Standard?">

Often, yes—that is the point of Beta. A feature only in Beta is still being refined. If a change negatively impacts you, contact your Incode representative. Feedback from Beta is what shapes the final feature released to Standard.

</Accordion>

</AccordionGroup>

:::note
If you have questions about Beta not answered here, contact your Dashboard admin or Incode representative.
:::

---

- Path: `dashboard-platform-administration/claims-matching-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/claims-matching-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/claims-matching-dashboard.md

# Claims Matching

The Claims Matching module verifies an employee's identity by comparing data from their Session against trusted reference data from one or more connected directories. Sessions that fail are routed to manual evaluation.

For an overview of this module and how it works, see [Claims Matching](/features-and-modules/claims-matching/).

## Supported with:

:white_check_mark: Workflows | :x: Flows

## Add Claims Matching to Workflows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the **Processes** list, drag and drop the **Claims Matching** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

After making changes on any tab, click **Save Configurations** to apply them.



| Setting | Description |
|---|---|
| **_Policy ID_** | Controls how the claims matching policy is applied to this project: _Editable_ (policy ID field can be set or changed in Dashboard to reference an external claims policy), _Enabled_ (policy is active and available), _Disabled_ (policy is shown but locked and cannot be changed), or _Hidden_ (policy option is not displayed in the configuration UI). Contact your Incode Representative to enable this option for your organization. |



<br />

---

- Path: `dashboard-platform-administration/configuration`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration.md

# Configure Settings


On the Configuration page, you can establish your organization settings as well as view and manage the components that make up your Incode Platform.

In the tabs on this page, you can:

- Configure [general](/dashboard-platform-administration/configuration-general-tab/) settings that affect your Incode Platform
- View, create, and manage [authorizations](/dashboard-platform-administration/configuration-authorization-tab/), [webhooks](/dashboard-platform-administration/configuration-webhooks-tab/), [API keys](/dashboard-platform-administration/configuration-api-keys-tab/), [integrations](/dashboard-platform-administration/configuration-integration-tab/), and [consents](/dashboard-platform-administration/configuration-consents-tab/)
- Customize the [look and feel](/dashboard-platform-administration/configuration-customization-tab/) of the Incode-hosted web onboarding experience

To access these settings, click **Configuration** in the left menu in Dashboard.

---

- Path: `dashboard-platform-administration/configuration-api-keys-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-api-keys-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-api-keys-tab.md

# Configuration: API Keys Tab

Your API key authenticates your integration with Incode's APIs and is associated with your account. This tab shows a table with information about the API keys used in your Incode implementation. You cannot change any of the information, but you can:

- Generate new keys
- Copy existing keys
- Revoke existing keys



| Field | Description |
| --- | --- |
| Name | The name Incode assigned to the API key. If the key is active, a green dot appears. If the key has been revoked, a gray dot appears. |
| Client ID | The unique ID of the client the API key belongs to. |
| API Key | The API key value. |
| Last Updated | This field updates only when a key is revoked. If the key is still active, the field shows the same value as ***Time Created***. |
| Time Created | The date and time the key was originally created. |

***

## Generate a New API Key

1. In the left menu, click **Configuration**.
2. Click the **API Keys** tab.
3. Click **Generate New API Key** in the lower right corner of the page.

A notification appears to confirm the API key is being generated. After it's generated, the new key appears at the top of the API keys table.

***

## Copy an Existing API Key

1. In the left menu, click **Configuration**.
2. Click the **API Keys** tab.
3. Find the key you want to copy and click **Copy** in the **_API Key_** column for that key.

***

## Revoke an Existing API Key

> ⚠️ Warning
>
> This action cannot be undone.

1. In the left menu, click **Configuration**.
2. Click the **API Keys** tab.
3. Find the key you want to revoke and click **Revoke** in the **_Name_** column for that key.

***

## API Key Security

Treat your API key like any other credential. Store it securely and keep it server-side instead of client-side or in front-end code. Avoid sharing it in tickets, emails, images, or public repositories. If a key may have been exposed, generate a new key and [revoke the affected one](#revoke-an-existing-api-key).

---

- Path: `dashboard-platform-administration/configuration-authorization-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-authorization-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-authorization-tab.md

# Configuration: Authorization Tab

This tab supports organizations that use OpenID Connect (OIDC) authorization protocols with the Incode Platform. You can view information about your existing OIDC authorization protocols from this tab.

<Accordion title="Expand for descriptions of fields shown as columns in the OIDC list">
| field | Description |
| --- | --- |
| Name | Shows the protocol name. |
| Client ID | Displays the client identifier (ID) generated by Incode. |
| Auth Methods | Displays one or more of these values based on the selections made when the protocol was generated: client secret basic, client secret post, client secret jwt, private key jwt, or none |
| Auth Grant Types | Displays one or more of these values based on the selections made when the protocol was generated: authorization code, refresh token, client credentials |
| Authentication Type | Displays one or more of these values based on the selections made when the protocol was generated: Face authentication, Onboarding, IncodeID, or Okta |
| Login Hint Type | Contains one of these values depending on the selections made when the protocol was generated: None, Unique ID, Phone, Email, or National Number |
| Login Attempt Limit | Displays the number of times a user can attempt to log in. The default and minimum value is *1* and the maximum value is *10* . |
| Redirect URIs | Shows one or more URIs users are redirected to for OIDC authentication. |
| Post Redirect URIs | Shows one or more URIs users are redirected to after their OIDC authentication is complete. |
| Scopes | Displays one or more of the scopes for which this protocol is used, based on the selections made when the protocol was generated.: openid, profile, email, address, selfie, selfie_attestation, fr_attestation, id_attestation, incode_id, roles, or scoring_results |
| Settings | Displays one or more settings for this protocol, based on the selections made when the protocol was generated: require-authorization-consent or require-proof-key |
| Authentication Signing Algorithm | Contains one of these values depending on the selection made when the protocol was generated: HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, or PS512 |
| JWK Set URL | Shows the URL for a JWK set. |
| Actions | Provides icons so you can **Edit** or **Delete** the protocol. |
</Accordion>

On the Authorization tab, you can also:

- Generate new authorization protocols
- Edit existing protocols
- Delete existing protocols

***

## Generate New Authorization Protocol

<Accordion title="Expand for descriptions of fields included in this task">
| field | Description |
| --- | --- |
| ConfigurationName | Allows you to enter the protocol name. |
| Issuer URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Authorize URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Token URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Client ID | Displays the client identifier (ID) generated by Incode. You cannot edit this field, but you can copy the ID. |
| Client Secret | Displays a secure secret generated by Incode. You cannot edit this secret, but you can copy the secret shown. You can also click **Generate** to create an entirely new secret. |
| Authentication Type | Drop-down of authentication types that can be supported with an OIDC protocol. Selections in this field may dynamically add fields when you are generating a new protocol: **Face authentication** adds ***Login Hint Type***, ***Enable Sign Up Flow***, and ***Login Attempt Limit***. Selecting ***Enable Sign Up Flow*** dynamically adds ***Flow Type***, which then adds ***Flow*** or ***Workflow***. **Onboarding** adds ***Flow Type***, which then adds ***Flow*** or ***Workflow***; ***Okta Issue URL***; and ***Okta API Token***. **IncodeID** does not add any fields. **Okta** adds ***Registration ID***. |
| Login Hint | Drop-down of the following login hint values supported with an OIDC protocol: **None**, **Unique ID**, **Phone**, **Email**, or **National Number**. |
| Enable Sign Up Flow | Appears only when ***Authentication Type*** is set to *Face Authentication*. When selected, the ***Flow Type*** field displays. | 
| Login Attempt Limit | Appears only when ***Authentication Type*** is set to *Face Authentication*. It lets you specify the number of times a user can attempt to log in. The default and minimum value is *1* and the maximum value is *10*. |
| Flow Type | Allows you to select whether you want to use a Flow or a Workflow for this protocol. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Signup Flow*** is selected, and ***Flow Type*** is set to *Workflow*. ***Authentication Type*** is set to *Onboarding*. |
| Flow | Allows you to select from a drop-down of your existing Flows. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Sign Up Flow*** is selected, and ***Flow Type*** is set to *Flow*. ***Authentication Type*** is set to *Onboarding* and ***Flow Type*** is set to *Flow*. |
| Workflow | Allows you to select from a drop-down of your existing Workflows. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Sign Up Flow*** is selected, and ***Flow Type*** is set to *Workflow*. ***Authentication Type*** is set to *Onboarding* and ***Flow Type*** is set to *Workflow*. |
| Okta Issue URL | Appears only when ***Authentication Type*** is set to *Onboarding*. |
| Okta API Token | Appears only when ***Authentication Type*** is set to *Onboarding*. |
| Registration ID | Appears only when ***Authentication Type*** is set to *Okta*. |
| Redirect URIs | Allows you to enter one or more URIs to which users are redirected for OIDC authentication. |
| Post Logout Redirect URIs | Allows you to enter one or more URIs to which users are redirected after their OIDC authentication is complete. |
| Client Authentication Methods | Allows you to select or clear one or more of the following values when you create or edit a protocol: **client_secret_basic**, **client_secret_post**, **client_secret_jwt**, **private_key_jwt**, or **none**. |
| Authorization Grant Types | Allows you to select or clear one or more of the following values when you create or edit a protocol: **authorization_code** (this type is selected by default and cannot be cleared), **refresh_token**, or **client_credentials**. |
| Scopes | Allows you to define one or more of these supported scopes for which this protocol will be used: **openid** (this scope is selected by default and cannot be cleared), **profile**, **email**, **address**, **phone**, **selfie**, **selfie_attestation**, **fr_attestation**, **id_attestation**, **incode_id**, **roles**, and **scoring_results**. |
| Settings | Allows you to define one or more of these settings for this protocol: **require-authorization-consent** and **require-proof-key**. |
| Token Endpoint Authentication Signing Algorithm | Drop-down of the following supported signing algorithms: **HS256**, **HS384**, **HS512**, **RS256**, **RS384**, **RS512**, **ES256**, **ES384**, **ES512**, **PS256**, **PS384**, and **PS512**. |
| JWK Set URL | Allows you to enter the URL for a JWK set. |
| Authorize Generated URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
</Accordion>

1. In the left menu, click **Configuration**.
2. Click the **Authorization** tab.
3. Click **Generate New** in the lower right corner to open the Client Configuration dialog.
4. Enter a **_Configuration Name_**.
5. Select an **_Authentication Type_** from the drop-down of supported types. Your selection may cause additional fields to appear in the dialog. Refer to the table in the drop-down above for descriptions of these fields.
6. Enter one or more valid **_Redirect URIs_**.
7. Enter one or more valid **_Post Logout Redirect URIs_** if applicable.
8. Select the checkboxes for any **_Client Authentication Methods_** this protocol will support.
9. Select the checkboxes for any **_Authorization Grant Types_** this protocol will support.
10. Select the checkboxes for the **_Scopes_** this protocol will support.
11. Select the checkboxes for the **_Settings_** this protocol will support.
12. Use the drop-down to select a supported **_Token Endpoint Authentication Signing Algorithm_** if applicable.
13. Enter a valid **_JWK Set URL_** if applicable.
14. When you are finished with your configuration, click **Save**.

***

## Edit Existing Authorization Protocol

<Accordion title="Expand for descriptions of fields included in this task">
| field | Description |
| --- | --- |
| ConfigurationName | Allows you to enter the protocol name. |
| Issuer URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Authorize URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Token URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
| Client ID | Displays the client identifier (ID) generated by Incode. You cannot edit this field, but you can copy the ID. |
| Client Secret | Displays a secure secret generated by Incode. You cannot edit this secret, but you can copy the secret shown. You can also click **Generate** to create an entirely new secret. |
| Authentication Type | Drop-down of authentication types that can be supported with an OIDC protocol. Selections in this field may dynamically add fields when you are generating a new protocol: **Face authentication** adds ***Login Hint Type***, ***Enable Sign Up Flow***, and ***Login Attempt Limit***. Selecting ***Enable Sign Up Flow*** dynamically adds ***Flow Type***, which then adds ***Flow*** or ***Workflow***. **Onboarding** adds ***Flow Type***, which then adds ***Flow*** or ***Workflow***; ***Okta Issue URL***; and ***Okta API Token***. **IncodeID** does not add any fields. **Okta** adds ***Registration ID***. |
| Login Hint | Drop-down of the following login hint values supported with an OIDC protocol: **None**, **Unique ID**, **Phone**, **Email**, or **National Number**. |
| Enable Sign Up Flow | Appears only when ***Authentication Type*** is set to *Face Authentication*. When selected, the ***Flow Type*** field displays. | 
| Login Attempt Limit | Appears only when ***Authentication Type*** is set to *Face Authentication*. It lets you specify the number of times a user can attempt to log in. The default and minimum value is *1* and the maximum value is *10*. |
| Flow Type | Allows you to select whether you want to use a Flow or a Workflow for this protocol. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Signup Flow*** is selected, and ***Flow Type*** is set to *Workflow*. ***Authentication Type*** is set to *Onboarding*. |
| Flow | Allows you to select from a drop-down of your existing Flows. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Sign Up Flow*** is selected, and ***Flow Type*** is set to *Flow*. ***Authentication Type*** is set to *Onboarding* and ***Flow Type*** is set to *Flow*. |
| Workflow | Allows you to select from a drop-down of your existing Workflows. This field appears only when one of the following is met: ***Authentication Type*** is set to *Face Authentication*, ***Enable Sign Up Flow*** is selected, and ***Flow Type*** is set to *Workflow*. ***Authentication Type*** is set to *Onboarding* and ***Flow Type*** is set to *Workflow*. |
| Okta Issue URL | Appears only when ***Authentication Type*** is set to *Onboarding*. |
| Okta API Token | Appears only when ***Authentication Type*** is set to *Onboarding*. |
| Registration ID | Appears only when ***Authentication Type*** is set to *Okta*. |
| Redirect URIs | Allows you to enter one or more URIs to which users are redirected for OIDC authentication. |
| Post Logout Redirect URIs | Allows you to enter one or more URIs to which users are redirected after their OIDC authentication is complete. |
| Client Authentication Methods | Allows you to select or clear one or more of the following values when you create or edit a protocol: **client_secret_basic**, **client_secret_post**, **client_secret_jwt**, **private_key_jwt**, or **none**. |
| Authorization Grant Types | Allows you to select or clear one or more of the following values when you create or edit a protocol: **authorization_code** (this type is selected by default and cannot be cleared), **refresh_token**, or **client_credentials**. |
| Scopes | Allows you to define one or more of these supported scopes for which this protocol will be used: **openid** (this scope is selected by default and cannot be cleared), **profile**, **email**, **address**, **phone**, **selfie**, **selfie_attestation**, **fr_attestation**, **id_attestation**, **incode_id**, **roles**, and **scoring_results**. |
| Settings | Allows you to define one or more of these settings for this protocol: **require-authorization-consent** and **require-proof-key**. |
| Token Endpoint Authentication Signing Algorithm | Drop-down of the following supported signing algorithms: **HS256**, **HS384**, **HS512**, **RS256**, **RS384**, **RS512**, **ES256**, **ES384**, **ES512**, **PS256**, **PS384**, and **PS512**. |
| JWK Set URL | Allows you to enter the URL for a JWK set. |
| Authorize Generated URL | Displays a URL generated by Incode. You cannot edit this field, but you can copy the URL shown. |
</Accordion>

1. In the left menu, click **Configuration**.
2. Click the **Authorization** tab.
3. In the OIDC Authorization table, locate the protocol you want, scroll to the Actions column on the far right, and click **Edit**.
4. Edit the fields and settings as needed.
5. When you are finished with your changes, click **Save**.

***

## Delete Existing Authorization Protocol

1. In the left menu, click **Configuration**.
2. Click the **Authorization** tab.
3. In the OIDC Authorization table, locate the protocol you want, scroll to the Actions column on the far right, and click **Delete**.
4. In the confirmation dialog, click **Confirm**.

<br />

---

- Path: `dashboard-platform-administration/configuration-consents-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-consents-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-consents-tab.md

# Configuration: Consents Tab

This tab shows information about all the consents in your system. Consents obtain the user's permission to collect and process their data. Incode includes a default consent, but you can create and customize additional consents to fit regulatory requirements. On the Consents tab, you can:

- Add new consents
- Edit existing consents
- Delete existing consents

![Consents table with Name, Created On, Updated On, Consent ID, and Actions columns. Each row has edit and delete icons.](https://developer.incode.com/assets/16c504cd81ba036da23dcb8e07938b10.png)

The following table describes the fields in the Consents table.

| Field      | Description                                           |
| ---------- | ----------------------------------------------------- |
| Name       | Consent name defined when it was created.             |
| Created On | Date and time the consent was created.                |
| Updated On | Date and time the consent was last updated.           |
| Consent ID | Unique identifier for the consent.                    |
| Actions    | Provides icons to **Edit** or **Delete** the consent. |

***

## Add a New Consent

1. In the left menu, click **Configuration**.
2. Click the **Consents** tab.
3. Click **Add New Consent**.
4. Enter a name for the consent in **User Consent**, then click **Add New Consent**.
5. Select a **Language** for the consent from the drop-down.
6. Enter a **Title** and the text **Content**. Use HTML or Markdown to format the text. Use the live preview at the top to check the final output.
   <Accordion title="View supported Markdown and HTML Tags">
   - **Hyperlinks**: `[DISPLAY_TEXT](https://your.link.com)`
   - **Emphasis**: `<strong>` for strong importance or bold text, and `<em>` for emphasized or italic text.
   - **Headings**: `<h1>`, `<h2>`, `<h3>` for heading levels, with `<h1>` being the largest.
   - **Paragraphs**: `<p>` defines a paragraph.
   - **Line Breaks**: `<br>` inserts a line break.
   - **Horizontal Rule**: `<hr>` represents a horizontal line.
   - **Lists**: `<ul>` for unordered (bullet) lists, `<ol>` for ordered (numbered) lists, and `<li>` for list items in both.
   - **Markdown Shortcuts**:
     - `*` for bullet points
     - `*text*` for italic text
     - `**text**` for bold text
     - `#`, `##`, `###` for headings
   </Accordion>
7. Under **Checkboxes**, enter the text you want to display next to the first checkbox. Select **Make Optional** to allow users to continue without selecting the checkbox. You can **Delete** the checkbox.
8. Click **Add Checkbox** to add another checkbox. All checkboxes you add display above the mandatory data and privacy consent provided by Incode.
9. Click **Save New Consent Language**.
10. Use the **Default Consent** drop-down to select which configured language for the consent should be the default.
11. Click **Add Language** depending on your needs. Repeat steps 5–9 for each new language you add.
12. Click **Save Settings**.

<Accordion title="View an example consent">
  <Image src="https://developer.incode.com/assets/71070b260031eacd5d535ff3e7230c24.png" alt="An example consent with a Title, Content, and Checkboxes configured." align="center" />
</Accordion>

***

## Edit an Existing Consent

1. In the left menu, click **Configuration**.

2. Click the **Consents** tab.

3. In the Actions column for the consent you want to edit, click **Edit**.

4. To change the name of the consent, enter a new value in **Consent Name**.


   <Image src="https://developer.incode.com/assets/2f5af27ca2a035c88052c15230ae25ef.png" alt="Consent editing screen with Consent Metadata fields, Save settings button, and Languages section with Add language option." align="left" />


5. To change the default language of the consent, select a new language from the **Default Consent** drop-down.

6. To add a new language to the list of available languages for this consent:
   1. Click **Add Language**.
   2. Select a **Language** from the drop-down.
   3. Enter a **Title** and the text **Content**. Use HTML or Markdown to format the text. Use the live preview at the top to check the final output.
      <Accordion title="Supported Markdown and HTML Tags">
      - **Hyperlinks**: `[DISPLAY_TEXT](https://your.link.com)`
      - **Emphasis**: `<strong>` for strong importance or bold text, and `<em>` for emphasized or italic text.
      - **Headings**: `<h1>`, `<h2>`, `<h3>` for heading levels, with `<h1>` being the largest.
      - **Paragraphs**: `<p>` defines a paragraph.
      - **Line Breaks**: `<br>` inserts a line break.
      - **Horizontal Rule**: `<hr>` represents a horizontal line.
      - **Lists**: `<ul>` for unordered (bullet) lists, `<ol>` for ordered (numbered) lists, and `<li>` for list items in both.
      - **Markdown Shortcuts**:
        - `*` for bullet points
        - `*text*` for italic text
        - `**text**` for bold text
        - `#`, `##`, `###` for headings
      </Accordion>
   4. Under **Checkboxes**, enter the text you want to display next to the first checkbox. Select **Make Optional** to allow users to continue without selecting the checkbox. You can **Delete** the checkbox.
   5. Click **Add Checkbox** to add another checkbox. All checkboxes you add display above the mandatory data and privacy consent provided by Incode.
   6. Click **Save New Consent Language**, then click the **\<** icon in the upper left corner of the Edit pane.

7. Click **Save Settings**.

***

## Delete Existing Consent

:::danger
Deleting a consent permanently deletes all associated language consents.
:::

1. In the left menu, click **Configuration**.
2. Click the **Consents** tab.
3. In the Actions column for the consent you want to delete, click **Delete**.
4. In the confirmation dialog, click **Delete**.

<br />

---

- Path: `dashboard-platform-administration/configuration-customization-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-customization-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-customization-tab.md

# Configuration: Customization Tab

Use this tab to customize the look and feel of your verification Flow or Workflow, the finish screen content, and your organization's email template.


***

## Configure the User Interface

This section controls the visual appearance of the screens in your verification Flow or Workflow.

![Configuration page, Customization tab, User interface section. Settings include Logo and Subtitle, Button, and CSS. A phone mockup shows a preview.](https://developer.incode.com/assets/7e8bdcf69376daab5add8fa3f9c7588b.png)

1. In the left menu, click **Configuration**.
2. Click the **Customization** tab.
3. Under Logo and Subtitle, upload a logo.
   1. Click the **Logo** upload area.
   2. Select a JPEG, PNG, or SVG file.
   3. Enter a **Subtitle** to appear under the logo.
4. Under Button, drag the **Corner Radius** slider to set the button's corner roundness. The value is shown in pixels.
5. Click the color swatch next to **Button Color** to set the button background color. Enter a hex value or use the color picker.
6. Click the color swatch next to **Button Color Text** to set the button label color. Enter a hex value or use the color picker.
7. Under CSS, select one of the following:
   - **Don't Include**: Uses default styles.
   - **CSS Format Supported**: Upload a CSS file to apply custom styles.
8. To hide the Incode branding in the footer of your Flow and Workflow screens, select **Hide Footer Branding**.
9. Click **Update UI**.

To reset your changes, click **Reset to Incode Defaults**.

***

## Configure Finish Screen Content

This section controls what customers see when they complete a verification Flow or Workflow.

![Content section of the Customization tab with fields for Finish Screen and SMS Content, and an Update content button.](https://developer.incode.com/assets/05288345253f5ac27f0251184b6db5ba.png)

1. In the left menu, click **Configuration**.
2. Click the **Customization** tab.
3. Scroll to the Content section.
4. Under Finish Screen Content, enter a **Headline**. This is the title shown on the finish screen. For example, _Thank you_.
5. Enter **Body Text**. This is the message shown below the headline on the finish screen. For example, _Your verification has been completed_.
6. Under Start Onboarding SMS Content, enter **SMS Text**. This is the message sent to the user when their onboarding session starts.
7. Click **Update Content**.

***

## Configure the Email Template

This section controls the signature of emails sent from your organization.

1. In the left menu, click **Configuration**.
2. Click the **Customization** tab.
3. Scroll to the Email Template section.
4. Upload a logo:
   1. Click the **Logo** upload area.
   2. Select a JPEG, PNG, or SVG file. A preview of the logo appears on the left under **Preview**.
5. Enter a **Display Name**. This is the sender name shown in emails from your organization.
6. Click **Update Email Template**.

<br />

---

- Path: `dashboard-platform-administration/configuration-general-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-general-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-general-tab.md

# Configuration: General Tab

The General tab in Configuration lets you establish Dashboard and organization settings. This tab displays by default when you click Configuration.

On the General tab, you can:

- Configure Dashboard settings
- Configure Authentications settings
- Configure SSO redirect URL
- Manage custom fields
- Manage Proof of Address (POA) fields
- Configure manual review options
- Manage custom event types
- <Pill type="beta" /> Enable [Beta Dashboard](/dashboard-platform-administration/choosing-between-standard-and-beta/) for users in your organization.

***

## Configure Dashboard Settings

You can configure one or all of the Dashboard settings described in this task.

![General tab of the Configuration page with Timezone, Onboarding, Token Expiration, Session Timeout, and CSV Export settings.](https://developer.incode.com/assets/f4a50f481122fc4bef8ef96d553ede30.png)

<Accordion title="Expand for setting details">
| Setting | Description |
| --- | --- |
| Select Timezone | Sets the time zone for your organization's Incode implementation. |
| Executive Viewing Limits | Sets how long a user with the [Executive role](/dashboard-platform-administration/roles-permissions/#executive) can view Session data. When a Session's age is greater than the number of hours, it is no longer available to that user. |
| Onboarding Link Duration | Sets the length of time in minutes for which an onboarding link is valid and available to the customer. The maximum value is 24 hours (1,440 minutes). |
| Onboarding Screen Capture Settings | ***Enable external analytics*** and ***Enable external screenshots***. |
| CSV Export | Lets you specify whether exported CSV files are sent to an email address or downloaded to the location configured in the user's browser (this is the default). |
| Token Expiration Configuration | ***Token Validity Duration*** and ***Time Unit*** work together to determine the length of time a token is valid before expiring. Enter a number for ***Token Validity Duration***, then use the ***Time Unit*** drop-down to select *Minutes*, *Hours*, *Days*, or *Months*. |
| Session Timeout Duration | Allows you to configure a period of time after which all Dashboard sessions are automatically logged out. The minimum value in minutes is *10* and the maximum is *30* . |
</Accordion>

1. In the left menu, click **Configuration**.
2. Under Timezone, use the drop-down to **_Select timezone_**.
3. Under Executive Viewing Limits, enter a numeric value or use the increase/decrease icons to set the **_Session visibility limit in hours_**.
4. Under Onboarding Link Duration, enter a numeric value or use the increase/decrease icons to set the **_TTL duration in minutes_**.
5. Under Onboarding Screencapture Settings, select the checkbox to **_Enable external analytics_**, **_Enable external screenshots_**, or both.


6. Select the checkbox for **_CSV Export_** if you want exports to be delivered by email.
7. Under Token Expiration Configuration, enter a numeric value in **_Token Validity Duration_** and select a **_Time Unit_** from the drop-down. You must configure both settings.
8. Enter a numeric value for **_Session Timeout Duration_** to specify when sessions automatically log out after inactivity.
9. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Configure Authentications Settings

If you're not using Incode for Authentications, you don't need to configure these settings.

![Authentication section of the General tab with an Auth Redirect URL field and checkboxes for blocklist and recording settings.](https://developer.incode.com/assets/b4fe8b4f2001546a7d5753fe105a8df5.png)

<Accordion title="Expand for setting details">
| Setting | Description |
| --- | --- |
| Auth Redirect URL | Sets a global URL Authentications are redirected to if you are not using the Incode default. You can also choose to enable one or both of these settings: - ***Check if user is blocklisted during authentication*** - ***Enable authentication recording*** |
| Check if user is blocklisted during authentication |  |
| Enable authentication recording |  |
</Accordion>

1. In the left menu, click **Configuration**.
2. Under Authentication, enter a URL for **_Auth Redirect URL_**.
3. Select the first checkbox if you want to **_Check if user is blocklisted during authentication_**.


4. Select the second checkbox if you want to **_Enable authentication recording_**.


5. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Configure SSO Redirect URL

If single sign-on (SSO) is not enabled for your Dashboard users, you don't need to configure this setting.

![The SSO section of the General tab, showing an optional Redirect URL text area.](https://developer.incode.com/assets/27cb028b780cba40fb837adf550162ce.png)

1. In the left menu, click **Configuration**.
2. Under SSO, enter a valid **_Redirect URL_** for your SSO page.
3. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Manage Custom Fields

If you're incorporating custom fields into your Incode Onboarding sessions, you must configure them here. The [Custom Fields](/features-and-modules/custom-fields/) module is only available for Flows.

![Custom Fields section of the General tab with three fields showing Name, Type, and Format inputs and a delete icon per row.](https://developer.incode.com/assets/de54a4e0aec281e4a9b41b459e9c5f17.png)

<Accordion title="Expand for more setting details">
| Setting | Description |
| --- | --- |
| Custom Field Name | The name of the field as you want it to appear to customers. |
| Custom Field Type | You can choose from these types of custom fields: Integer (the field accepts only whole numbers), Double (the field accepts decimal numbers), String (the field accepts alphanumeric values exactly as they are entered), Boolean (the field accepts only yes or no values), and Date (the field accepts dates in the ***Custom Field Format*** you specify). |
| Custom Field Format | This field is enabled only if you select *date* for ***Custom Field Type***.You can choose from these formats for your custom date fields: - yyyy-mm-dd - dd/mm/yyyy - dd.mm.yyyy - mm/dd/yyyy - yyyy.mm.dd - Unix_timestamp_ms - Unix_timestamp_s The first five options use common references to year, month, and date. The last two options use a standard [Unix timestamp](https://www.unixtimestamp.com/). |
</Accordion>


1. In the left menu, click **Configuration**.
2. Under Custom Fields, click the plus sign (+) to create a new custom field.
3. Enter a **_Custom Field Name_**.
4. Select a **_Custom Field Type_** from the drop-down.
5. If you selected _date_, select a **_Custom Field Format_** from the drop-down. Otherwise, this field is unavailable.
6. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Manage POA fields

This section applies and is mandatory only if your onboarding Flow or Workflow captures power of attorney (POA) documents and extracts information from them using optical character recognition (OCR).


![Mandatory POA Fields Configuration section of the General tab with an Add POA Fields dropdown, delete icon, and add button.](https://developer.incode.com/assets/f8695f1457e9f281d85b9a442761bd76.png)

1. In the left menu, click **Configuration**.
2. Under Mandatory POA Fields Configuration, click the plus sign (+) to create a new POA field.
3. Select a field from the **_Add POA Fields_** drop-down.
4. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Configure Manual Review Options

This section lets you configure settings that apply when an onboarding session requires manual review. You can also populate a list of reasons for onboarding rejection, approval, or both.

![Manual Review Options on the General tab with two checkboxes and a Reject/Approve reason field with delete and add buttons.](https://developer.incode.com/assets/b4ac612d16d518f8d58a8014ddaf506a.png)

1. In the left menu, click **Configuration**.

2. Under Manual Review Options Configuration, select the checkbox if you want to **_Allow custom reasons only_**.


3. Select the checkbox if you want to **_Automatically create Identity after manual approval_**.


4. If you want to **_Add Reason for Reject/Approve_**:


1. Click the plus sign (+).

2. Enter a value in the text box.

3. If you are finished making changes, scroll to the bottom of the page and click **Update Organization**.

***

## Manage Custom Event Types

![Event Type Configuration section of the General tab with a Custom Event Type text field, delete icon, and add button.](https://developer.incode.com/assets/101c101cfb5edbf263525ac5c28816b6.png)

<Accordion title="Expand for more setting details">
| Setting | Description |
| --- | --- |
| Add Custom Event Type |  |
</Accordion>

1. In the left menu, click **Configuration**.
2. Under Event Type Configuration, click the plus sign (+).
3. Enter a name in **_Add Custom Event Type_**.


4. If you are finished making changes, click **Update Organization**.

***

## <Pill type="beta" /> Manage Dashboard Version

<Component slug="standard-vs-beta-callout" />

This section allows you to configure if Beta Dashboard is available to users in your organization. Before you can configure this setting, your Incode representative must enable Beta Dashboard for your organization.

1. In the left menu, click **Configuration**.
2. Under Release Channel, select one of the following:
    - _Standard (The dashboard you use today)_: Restrict users to Standard Dashboard. Features arrive here once they have spent time in Beta.
    - _Beta (New features first)_: Allow users to choose Beta Dashboard and use new features before they are final. Users can still choose to use Standard Dashboard.
3. If you are finished making changes, click **Save**.

---

- Path: `dashboard-platform-administration/configuration-integration-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-integration-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-integration-tab.md

# Configuration: Integration Tab

This tab shows a table of organizations and their IDs. Click the arrow in the first column to sort by organization name. You can add new organizations to the table.

***

## Add a New Organization

1. In the left menu, click **Configuration**.
2. Click the **Integration** tab.
3. Scroll down to the Add New Organization section.
4. Enter the **_Organization Name_**.
5. In the **_Organization Type_** drop-down, select _Default_ or _Integrator_.


6. In the **_Access Type_** drop-down, select _Limited_ or _Open_.


7. Click **Add Organization**.

<br />

---

- Path: `dashboard-platform-administration/configuration-webhooks-tab`
- URL: https://developer.incode.com/dashboard-platform-administration/configuration-webhooks-tab/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configuration-webhooks-tab.md

# Configuration: Webhooks Tab

This tab shows information about your configured webhooks.

On the Webhooks tab, you can also:

- Configure general webhook settings
- Configure new webhooks
- Edit existing webhook configurations
- Delete existing webhook configurations

## Understand Webhooks

Webhooks are event notifications. They let your application know when a specific event happens on the Incode Platform or when a process initiated by a user is completed, also known as a callback. Your application can then take action based on the notification.

Webhooks are asynchronous; communication flows only from the Incode Platform to your application. You must configure them before you can use them.

The following webhooks are currently available:

- **Onboarding status webhook**: Triggered every time an Onboarding Session status changes. [Learn more](/general-reference/onboarding-status-webhook/).
- **Videoselfie uploaded webhook**: Triggered when the video selfie recording file becomes available. [Learn more](/general-reference/video-selfie-webhook/).
- **Third party async retries webhook**:&#x20;
- **Watchlist updated webhook**: Triggered when a global watchlist result is updated. [Learn more](/general-reference/global-watchlists-webhook/).
- **Work history callback**: Triggered after a work history search for a user is processed. This webhook is for Mexico only. [Learn more](/general-reference/work-history-webhook/).
- **Proof of payment callback**: Triggered after payment proof validation for a user is processed. This webhook is for Mexico only. [Learn more](/general-reference/payment-proof-webhook/).
- **Face Authentication**: Triggered when face authentication succeeds or fails. <Anchor target="_blank" href="/general-reference/face-authentication-webhook/">Learn more</Anchor>.
- **Session Started**: Triggered when any session from a Flow or Workflow starts. [Learn more](/general-reference/session-webhooks/).
- **Session Failed**: Triggered when any session from a Flow or Workflow fails. <Anchor target="_blank" href="/general-reference/session-webhooks/">Learn more</Anchor>.
- **Session Succeeded**: Triggered when any session from a Flow or Workflow succeeds. [Learn more](/general-reference/session-webhooks/).
- **Session Pending Review**: Triggered when any session from a Flow or Workflow requires manual review. [Learn more](/general-reference/session-webhooks/).
- **KYB Results**: Triggered when a KYB run's final result is ready, including any checks that were still running when the request returned. [Learn more](/general-reference/kyb-results-webhook/).

The following webhooks are deprecated:

- **INE scraping webhook:** Provided INE scraping results.
- **Authentication webhooks:** Contained information about the login attempt, matching identities, and the interview which best matched the biometric of the face used to log in. These webhooks were available for 1:1 and 1:N.

## Webhook Configurations

The Webhook configurations table shows the fields for each configured webhook.

| Field   | Description                                                                                                           |
| ------- | --------------------------------------------------------------------------------------------------------------------- |
| ID      | Unique identifier Incode assigned to the webhook configuration.                                                       |
| Type    | The name of the webhook as shown in the drop-down when it was configured: for example, Onboarding Status Webhook URL. |
| URL     | The URL webhook notifications are sent to. Provided when the webhook was configured.                                  |
| Actions | Icons to **Edit Webhook** or **Delete Webhook**.                                                                      |

## Configure General Webhook Settings

The settings in this section of the Webhooks tab apply to all your webhooks.

| Field                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authentication URL (Optional)     | Only needed if you have configured webhook authorization using OIDC. Incode provides this URL when you set up OIDC authorization.                                                                                                                                                                                                                                                                                                                                            |
| Client ID (Optional)              | Only needed if you have configured webhook authorization using OIDC. When you set up OIDC authorization, Incode provides this value. It's also known as a client secret.                                                                                                                                                                                                                                                                                                     |
| Secret Key (Optional)             | Only needed if you have configured webhook authorization using OIDC. Incode provides this value when you set up OIDC authorization.                                                                                                                                                                                                                                                                                                                                          |
| Client Authentication (Required)  | Select one of the following from the drop-down: **Send as Basic Auth Header** or **Send Client Credentials in Body**.                                                                                                                                                                                                                                                                                                                                                        |
| Scopes (Optional)                 | Only needed if you have configured webhook authorization using OIDC.                                                                                                                                                                                                                                                                                                                                                                                                         |
| Webhook Custom Body Parameters    | Creates key/value pairs that are included in the OAuth token request sent to your authorization server when Incode obtains a token to deliver webhooks. Useful for passing values your identity provider requires, such as `scope`, `audience`, `resource`, or a tenant identifier. Click **Add** to expose the following fields: **Custom Body Parameter Key** and **Custom Body Parameter Value**. `client_id` and `client_secret` are reserved and can't be used as keys. |
| Webhook Custom Headers (Optional) | Creates custom headers that your endpoint receives as part of webhook notifications. All headers are sent for all webhooks. Dynamic values are not supported. Click **Add** to expose the following fields: **Custom Header Key** and **Custom Header Value**. You can add more than one header.                                                                                                                                                                             |

1. In the left menu, click **Configuration**.
2. Click the **Webhooks** tab.
3. If you want to use authentication, enter values in **Authentication URL**, **Client ID**, and **Secret Key**.
4. Select a value from the **Client Authentication** drop-down.
5. Enter values in **Scopes** if needed.
6. To use custom headers, click the plus sign (+) and enter values in **Custom Header Name** and **Custom Header Value**.
7. Click **Update Settings**.

## Configure New Webhook

1. In the left menu, click **Configuration**.
2. Click the **Webhooks** tab.
3. Scroll down and click **Generate New** in the lower right corner.
4. Enter a **_Name_** for the webhook that you can easily identify.
4. Use the drop-down to select the **_Type_** of webhook you want to configure.
5. Enter the **_URL_** for this webhook to use. Only one URL per webhook is supported. If you need to send the webhook notification to more than one endpoint, broadcast it internally after receiving it at this URL.

### Configure Watchlist Update Webhook

To receive notifications when watchlist search results change, configure a webhook and enable the **_Subscribe for updates_** setting in your [Watchlist Business](/dashboard-platform-administration/watchlist-business-dashboard/#configuration-options) module.

1. In the left menu, click **Configuration**.
2. Click the **Webhooks** tab.
3. In the Webhook configurations table, find the _Watchlist update webhook url_**&#x20;**&#x77;ebhook and click **Edit**.
4. Add your webhook URL and click **Save**.
5. Run a search against `POST /omni/businessWatchlist-result` with `"subscribe": true` in the request body. At minimum, the request body must include:
   - **_businessName_**: Required. String. Name of the business.
   - **_country_**: Optional. String. Two-letter ISO 3166-1 alpha-2 country code.
6. Save the `ref` value from the response. This identifies the search when updates arrive.
7. When the search results are updated, Incode sends the saved `ref` to your webhook.
8. Call `GET /omni/updated-watchlist-result?ref=[ref]` to retrieve the updated results.

The webhook request body includes three fields:

| Field       | Type   | Description                             |
| ----------- | ------ | --------------------------------------- |
| interviewId | String | Session ID                              |
| ref         | String | Reference number for the search         |
| search\_id  | String | ID assigned when the search was created |

## Edit Existing Webhook Settings

1. In the left menu, click **Configuration**.
2. Click the **Webhooks** tab.
3. In the Webhook configurations table, locate the webhook you want to change and click **Edit**.
4. Enter new values as needed. Click **Save**.

## Delete Existing Webhook

1. In the left menu, click **Configuration**.
2. Click the **Webhooks** tab.
3. In the Webhook configurations table, locate the webhook you want to delete and click **Delete**.
4. In the confirmation dialog, click **Confirm**.

<br />

---

- Path: `dashboard-platform-administration/configure-workflow-conditions`
- URL: https://developer.incode.com/dashboard-platform-administration/configure-workflow-conditions/
- Markdown: https://developer.incode.com/dashboard-platform-administration/configure-workflow-conditions.md

# Configure Conditions

[Conditions](/concepts-and-architecture/conditions-for-workflows-20/) act as decision nodes that dynamically route users down different paths based on data collected during verification. You can use them to control which modules each user encounters.

:::info
You configure a Condition when you add it to a [Workflow](/dashboard-platform-administration/workflows-20/#create-workflows). This task assumes you are already building a Workflow.
:::

The modules, operators, and values available in a Condition depend on which modules are in your Workflow. See each module's configuration documentation for the Condition options it supports.

The way you set conditions depends on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Workflow.



## Configure Conditions in New View

<Accordion title="Expand to view image">

![The conditions panel in the New view in Workflows)](https://developer.incode.com/assets/20238842-fe97-4765-a6c2-27c2812d340b.png)

</Accordion>

In New view, the Condition panel adapts its fields based on the signal you select. Check-type signals show a single **Select condition** drop-down with pass, fail, and warning options. Numeric signals show an operator drop-down with comparison options plus a value field. Other signal types may present different field combinations.

1. From the Workflow builder, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Conditions**.
2. In the first drop-down under **_IF_**, search for and select the signal you want to drive the condition. Signals are grouped, with a count of signals per group and the total across all groups. Expand a group to browse its signals. When you select a signal, the remaining fields update based on the signal type.
    - For check-type signals, use the **Select condition** drop-down to choose *passes*, *does not pass*, *fails*, *does not fail*, *has a warning*, or *has no warning*.
    - For numeric signals, use the operator drop-down to choose *is*, *is not*, *is more than*, *is less than*, *is at least*, or *is at most*, then enter the comparison value.
3. You can add more rules to the condition. Click **And** or **Or** below the IF expression and follow step 2 again. **And** requires all rules to be met; **Or** requires any one rule to be met.
4. Use the **_THEN_** drop-down to select what happens when the expression evaluates to true. Options are:
    - _Continue to next step_
    - _Pass_
    - _Fail_
    - _Warn_
    - _Manual Review_
5. In the **OTHERWISE** drop-down, select what happens when the expression evaluates to false. The options are the same as for THEN. The default is *Fail*.
6. Click **Save condition**. To clear all fields and start over, click **Reset all**.

The condition node displays the IF expression, with the **THEN** and **OTHERWISE** paths branching horizontally to the outcomes you selected.

<Accordion title="Expand to view image">

![Beta Workflow canvas showing a single-rule condition](https://developer.incode.com/assets/d06df811-24ab-447d-93ba-e91fd8566baf.png)

</Accordion>

## Configure Conditions in Classic View

<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/07b683d45effe619e19dd0f24ef0ad9a.png" align="center" />

</Accordion>

1. From the Workflow builder menu, click **Conditions**. Drag the condition node onto the canvas.
2. In the Condition panel, you can enter **Condition name**. The name appears on the condition node in the canvas.
3. Under **IF**, define the expression that the condition evaluates:
   1. Use the **Select module** drop-down to select the data the condition is based on. Options are organized by the module the data comes from, and you can search or filter by module.
   2. Use the **Operator** drop-down to select an operator.&#x20;
   3. Use the next drop-down to choose how the value should be compared, such as equals, does not equal, greater than, or less than.
   4. Use the next field to set the value for the expression. This field may be a drop-down or a text box, depending on the operator you selected.
4. To add more rules to the condition:
   1. Click **AND** if all rules must be met.
   2. Click **OR** if any one rule must be met.
5. Under **THEN**, select what happens when the expression evaluates to true. Options are:
   - Continue to next step
   - Pass session
   - Fail session
   - Warn session
   - Manual review session
6. Under **OTHERWISE**, select what happens when the expression evaluates to false. The options are the same as for THEN.
7. Click **Save condition**.

### Conditions on the canvas

The condition node displays the IF expression beneath its name, and the THEN and OTHERWISE paths branch to the outcomes you selected.

<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/4681c5f2bd8cf3f7f5598f2a4672539c.png" align="center" />

</Accordion>

If the condition has multiple rules, the node shows the first rule with a **+n more** indicator. Hover over the node to see the full expression.

<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/3fe6d4b84aa88d6a65035ae32f094ede.png" align="center" />

</Accordion>

You can add more modules, processes, or conditions along either path to extend the user journey.

---

- Path: `dashboard-platform-administration/cross-check-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/cross-check-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/cross-check-dashboard.md

# Cross Check

The Cross Check module compares a data field from one source against the same field from a second source and identifies whether the values match. You configure one or more comparisons, each specifying the two sources, the field to compare, and a severity level that controls how strictly the values must match.

In Flows, Cross Check is a configurable setting instead of a module.

For an overview of this module and how it works, see [Cross Check](/features-and-modules/cross-check/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Cross Check to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure the modules that collect the data you want to compare are in your Workflow.
4. Add the **Cross Check** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: After the modules that collect the data you want to compare, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Cross Check**.
    - **Classic**: From the Processes list, drag and drop the **Cross Check** module into the builder after the modules that collect the data you want to compare.
5. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings.

## Add Cross Check to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. Ensure the modules that collect the data you want to compare are in your Flow.
4. Click the **Settings** tab.
5. Under Custom Logic, click **Cross Checks**.
6. Click **Set Crosschecks**.
7. Click **New Comparison** to [create a comparison](#create-a-comparison).

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of Workflow configuration panel">

![Image of Cross Check module configuration in Workflows. Availability listed for Web, iOS, and Android. Has six configuration options](https://developer.incode.com/assets/adeebc32-8ecd-4745-91e3-71fbbc11b413.png)

</Accordion>

Click **Add new comparison** to [create a comparison](#create-a-comparison).

### Configuration Options: Classic



<Accordion title="View image of Workflow configuration panel"> 

![Image of the Cross Check module's configuration page. Has an Add new comparison button.](https://developer.incode.com/assets/8085cc5f6ce6ce4ed04b3a3de8222d4d.png)

</Accordion>

Click **Add new comparison** to [create a comparison](#create-a-comparison). 

### Create a Comparison

Each comparison has the following settings:

| Setting                      | Description                                                                                                                                                                                                           |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Crosscheck name_**        | A label for this comparison. Used to identify the comparison in results and conditions. Maximum 30 characters. Cannot contain special characters: `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `_`, `-`, or `/`. |
| **_First document source_**  | The first source to use in the comparison. You can only select a source available from modules already in the Flow or Workflow.                                                                                       |
| **_Second document source_** | The second source to use in the comparison. You can only select a source available from modules already in the Flow or Workflow.                                                                                      |
| **_Left field_**             | The field from the first document source to compare.                                                                                                                                                                  |
| **_Right field_**            | The field from the second document source to compare.                                                                                                                                                                 |
| **_Comparison severity_**    | Controls how strictly the two field values must match. Options: _Ultra low_, _Low_, _Medium_, _High_, _Exact_. See [Severity Levels](#severity-levels) for details.                                                   |

<Accordion title="View an example comparison">
  This example compares the address in the user's ID to the address in their Proof of Address document.
<Image src="https://developer.incode.com/assets/eaa7ba6729cc2b052e26b28d745e257a.png" alt="ID is the First document source, Proof of Address is the Second document source, and Address is both the Left and Right field." align="center" />
</Accordion>

After configuring each setting, click **Save Comparison**. You can add multiple comparisons to a single Cross Check module using **Add new comparison**. Similarly, you can add multiple comparisons to the Cross Check setting in Flows using **New Comparison**. Each comparison is configured and saved independently.

#### Severity Levels

Severity levels control how strictly two values must match. Higher severity levels require a closer match. Lower levels allow more variation between values, including typos, spelling variants, or transliterations.

| Severity level | Allowance                   |
| -------------- | --------------------------- |
| Ultra low      | \~20–35% difference allowed |
| Low            | \~15–27% difference allowed |
| Medium         | \~10–18% difference allowed |
| High           | \~5–12% difference allowed  |
| Exact          | No difference allowed       |

---

- Path: `dashboard-platform-administration/curp-validation-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/curp-validation-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/curp-validation-dashboard.md

# CURP Validation

The CURP Validation module validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

For an overview of this module and how it works, see [CURP Validation](/features-and-modules/curp-validation/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add CURP Validation to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **CURP Validation** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **CURP Validation**.
    - **Classic**: From the Modules list, drag and drop the **CURP Validation** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add CURP Validation to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Workflow.
3. On the **Select Modules** tab, find the **CURP Validation** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of Workflow configuration panel">

![Image of CURP Validation module configuration in Workflows. Availability listed for Web, iOS, and Android. Has three configuration options](https://developer.incode.com/assets/142c262c-1e70-4163-b8ce-918b306f21b8.png)

</Accordion>

<Accordion title="View image of Flow configuration panel">
![Image of CURP Validation module configuration in Flows. Availability listed for Web, iOS, and Android. Has two configuration options](https://developer.incode.com/assets/8c8908a8-191f-4223-9f60-401b07c79443.png#inline)
</Accordion>

| Setting                                     | Description                                                                                                                                                                                                                                                                                  |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_CURP data match_**<br />_Workflows only_ | When enabled, validates that the CURP data returned by RENAPO matches the personal data captured earlier in the session: for example, name and birthdate from ID Capture.                                                                                                               |
| **_Deceased status verification_**          | When enabled, the module checks the RENAPO response for a deceased status and treats a deceased result as a validation failure.                                                                                                                                                              |
| **_Auto-retry on service errors_**                 | When enabled, activates asynchronous retry logic if the provider call fails or times out, improving reliability when the primary provider is unavailable.  |

### Configuration Options: Classic

<Accordion title="View image of Workflow configuration panel">
  ![Image of CURP Validation module configuration in Workflows. Has three configuration options..](https://developer.incode.com/assets/a2c3609e50aac842bf28a21161b8e1ec.png)
</Accordion>

<Accordion title="View image of Flow configuration panel">
  ![Image of CURP Validation module configuration in Flows. Has two configuration options..](https://developer.incode.com/assets/9fbfc611e313984fe07eb8e5828f79fa.png)
</Accordion>

| Setting                                     | Description                                                                                                                                                                                                                                                                                  |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_CURP data match_**<br />_Workflows only_ | When enabled, validates that the CURP data returned by RENAPO matches the personal data captured earlier in the session: for example, name and birthdate from ID Capture.                                                                                                                   |
| **_Deceased status verification_**          | When enabled, the module checks the RENAPO response for a deceased status and treats a deceased result as a validation failure.                                                                                                                                                              |
| **_Async retries enabled_**                 | When enabled, activates asynchronous retry logic if the provider call fails or times out, improving reliability when the primary provider is unavailable.  |

---

- Path: `dashboard-platform-administration/custom-fields-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/custom-fields-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/custom-fields-dashboard.md

# Custom Fields

The Custom Fields module captures additional user-provided data and saves it to the Session, making it available for reporting, server-side decisions, or cross-checking later in the journey.




:::warning
This module is deprecated. Existing implementations may continue use, but it is not available in new implementations.
:::

Before adding this module, make sure you've [defined your custom fields](/dashboard-platform-administration/configuration-general-tab/#manage-custom-fields) in Dashboard in **Configuration > General**. Each field requires a name and a type. Once defined, those fields appear as selectable options in the module configuration panel.

For an overview of this module and how it works, see [Custom Fields](/features-and-modules/custom-fields/).

## Supported with:

:x: Workflows | :white_check_mark: Flows

## Add Custom Fields to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Custom Fields** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

<Callout icon="📘" theme="info">
  ### Note

  Adding the module enables the UI-collection path. Users will be prompted to complete the fields during the Flow. If you don't add the module, the field values must instead be supplied through the backend [via API](/reference/addcustomfields/).
</Callout>

## Configuration Options

![Image of Custom Fields module configuration in Flows. Has checboxes for each configured custom field.](https://developer.incode.com/assets/a0bd1f9655413a528425e08618cb5279.png)

| Setting                                              | Description                                                                                          |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **_Form Title_**                                     | The heading shown at the top of the form presented to the user.                                      |
| **_Custom field checkboxes (field names variable)_** | The fields available to include. Select the checkbox for each field you want to include in the form. |
| **_Alias_**                                          | An optional override for the field's display label. If left blank, the field's name is used.         |

<br />

---

- Path: `dashboard-platform-administration/custom-module-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/custom-module-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/custom-module-dashboard.md

# Custom Module

The Custom Module pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues.

:::warning
The Custom Module requires an SDK integration to function. The steps on this page cover Dashboard configuration only: adding the module to a Workflow, referencing the callback function name from your SDK, and configuring Conditions to branch on the result. The callback that resumes the Workflow is implemented in your SDK code. See [SDK Reference](/sdk-reference/sdk-reference/) for those instructions.
:::

For an overview of this module and how it works, see [Custom Module](/features-and-modules/custom-module/).

## Supported with:

:white_check_mark: Workflows | :x: Flows

## Add Custom Module to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Custom Module**. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Custom Module**.
    - **Classic**: From the Modules list, drag and drop the **Custom Module** into the builder.
4. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.
5. [Add conditions](#add-conditions) to route sessions based on the result of your custom logic.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of configuration panel">

![Image of Custom Module configuration in Workflows. Availability listed for Web, iOS, and Android. Has one configuration option](https://developer.incode.com/assets/1c1a43de-6d6e-4c52-a92d-97e1d0c76a46.png)

</Accordion>

| Setting                 | Description                                                                                                                                                                                                                                                                                                                                                              |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Callback Function_** | The name of the callback function in your SDK integration that Incode invokes when the Workflow reaches this module. The value is a string and must exactly match the function name implemented in your SDK integration. Your callback must return `onSuccess`, `onFail`, or `onUnknown` to advance the Workflow. If no result is returned, the Workflow remains paused. |

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of Custom Module configuration in Workflows. Has one configuration option](https://files.readme.io/f9f01bad4ad72f923f0a68d3b8ee0da114614980e01dfb60dc41d90095b221cf-image.png)

</Accordion>

| Setting                 | Description                                                                                                                                                                                                                                                                                                                                                              |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Callback Function_** | The name of the callback function in your SDK integration that Incode invokes when the Workflow reaches this module. The value is a string and must exactly match the function name implemented in your SDK integration. Your callback must return `onSuccess`, `onFail`, or `onUnknown` to advance the Workflow. If no result is returned, the Workflow remains paused. |

## Add Conditions

[Conditions](/dashboard-platform-administration/configure-workflow-conditions/) let you branch the Workflow based on a result. Your SDK callback must return one of three results: `onSuccess`, `onFail`, or `onUnknown`. Your Workflow should define a distinct path for each. A common pattern is to route `onUnknown` to a step-up such as [ID Capture](/features-and-modules/id-capture/) or manual review, instead of treating it the same as `onFail`.

The steps below walk through one example configuration: two Conditions in sequence, with `onSuccess` routing to Session Pass, `onFail` routing to Session Failed, and `onUnknown` routing to Manual Review. This is one valid approach; you can structure the Conditions, result nodes, and step-up behavior differently to fit your use case.

The way you set conditions depends on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Workflow.

### Add Conditions: New

#### 1. Condition for onSuccess

The following steps detail the Condition configuration for the `onSuccess` path.

1. Right after Custom Module, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Conditions**.
2. In the first drop-down under **_If_**, search for and select your **_Callback Function_** name.
3. In the second drop-down under **_If_**, select _passes_.
4. Keep the **_Then_** drop-down set to _Continue to next step_ and the **_Otherwise_** drop-down set to _Fail_.
5. Click **Save condition**.

#### 2. Condition for onFail and onUnknown

The following steps detail the Condition configuration for the `onFail` and `onUnknown` paths.

1. On the **Otherwise** branch of the condition you added for `onSuccess`, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Conditions**.
2. In the first drop-down under **_If_**, search for and select your **_Callback Function_** name.
3. In the second drop-down under **_If_**, select _is unknown_.
4. Keep the **_Then_** drop-down set to _Manual review_ and the **_Otherwise_** drop-down set to _Fail_.
5. Click **Save condition**.

<Accordion title="Expand to view image">

Following the example above, the conditions should look like this:

![After a custom module, an OK eligibility check passes the session, UNKNOWN sends it to manual review, and otherwise it fails.](https://developer.incode.com/assets/8aa73cda-99a3-4980-beb0-bfd2a8ed9493.png)

</Accordion>

### Add Conditions: Classic

#### 1. Condition for `onSuccess`

The following steps detail the Condition configuration for the `onSuccess` path.

1. Drag a Condition into the builder from the left panel. Place it directly after the Custom Module node.

<Accordion title="Expand to view image">
   ![](https://files.readme.io/a34283c1929e70f5e61dbec7579325b756098d97cc998873db8ec804a996a598-image.png)
</Accordion>

2. In the first drop-down, search for and select your **_Callback Function_** name.&#x20;
3. In the second drop-down, select _Status_.&#x20;
4. Keep the third drop-down set to _==_.
5. From the final drop-down, select _OK_. This corresponds to an `onSuccess` result.
6. Select the **Yes path** radio button. This routes the Workflow along the Yes path when the callback returns `onSuccess`.
7. Click **Save condition**.

#### 2. Condition for `onFail` and `onUnknown`

The following steps detail the Condition configuration for the `onFail` and `onUnknown` paths.

1. Drag a second Condition into the builder. Connect it to the **No** side of the first Condition, before the result node.
2. In the first drop-down, search for and select your **_Callback Function_** name.
3. In the second drop-down, select _Status_.
4. Keep the third drop-down set to _==_.
5. From the final drop-down, select _UNKNOWN_. This corresponds to an `onUnknown` result.
6. Select the **Yes path** radio button. This routes the Workflow along the Yes path when the callback returns `onUnknown`.
7. Click **Save condition**.

<Accordion title="Expand to view image">
  ![](https://files.readme.io/5f21ede23de9e8d51394fa62e7ea3f40b4103e15a1ee54f53a963b0f89b5d9a3-image.png)
</Accordion>

By default, both the Yes and No paths of the second Condition connect to a Session Failed result node. Update the Yes path result node to reflect your step-up flow:

1. Click the three dots on the result node connected to the **Yes path** of the second Condition.
2. From the **Select Decision** menu, select _Manual Review_.
3. Click **Update Decision**.

<Accordion title="Expand to view image">

  Following this configuration, your Workflow builder should look like this:

  ![](https://files.readme.io/2d5e3541f6b27e122a1fe811f09b89d585cf09ba82dd3b99370ef48d1eeaf372-image.png)
</Accordion>

---

- Path: `dashboard-platform-administration/custom-watchlist-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/custom-watchlist-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/custom-watchlist-dashboard.md

# Custom Watchlist

The Custom Watchlist module screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It runs as a background process and isn't visible to the end user.

For an overview of this module and how it works, see [Custom Watchlist](/features-and-modules/custom-watchlist/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Custom Watchlist to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure that the modules that collect user data, such as [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) and [Face Capture](/dashboard-platform-administration/face-capture-dashboard/), are in your Workflow.
4. Add the **Custom Watchlist** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: After the modules that collect user data, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Custom Watchlist**.
    - **Classic**: From the **Processes** list, drag and drop the **Custom Watchlist** module into the builder after the modules that collect user data.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.
6. [Add conditions](#add-conditions) to route sessions based on whether the user was found on a Blocklist or Allowlist.

## Add Custom Watchlist to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. Ensure that the modules that collect user data, such as [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) and [Face Capture](/dashboard-platform-administration/face-capture-dashboard/), are in your Flow.
4. On the **Select Modules** tab, find the **Custom Watchlist** module and click **Add**.
5. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of Workflow configuration panel">

![Image of Custom Watchlist module configuration in Workflows. Availability listed for Web, iOS, and Android. Has four configuration options](https://developer.incode.com/assets/836cb789-d180-4338-b0a9-873182bfd7f9.png)

</Accordion>

<Accordion title="View image of Flow configuration panel">

![Image of Custom Watchlist module configuration in Flows. Availability listed for Web, iOS, and Android. Has five configuration options](https://developer.incode.com/assets/fc522071-39b2-4723-a84e-578c60fcb55f.png)

</Accordion>

| Setting | Description|
|---|---|
| **_Fail session on Blocklist face match_**<br />_Flows only_ | When enabled, a biometric face match against a Blocklist entry directly fails the Session, regardless of other scoring. |
| **_Add suspected fraud to Blocklist_** | When enabled, the system automatically adds a user to the Blocklist when fraud signals, such as face match failing, are detected. Score updates apply to the current session and all future sessions. Historical sessions are not affected. |
| **_Exclude ID photo from matching_** | When enabled, the ID photo is not used when matching the user against watchlist entries. |
| **_Run automatically_**<br />_Flows only_ | When enabled, the module runs automatically after ID and face data have been collected, without requiring a manual trigger. |
| **_Shared device mode_** | When enabled, device-specific identifiers such as device hash are excluded from watchlist matching. Use this when users access the service on shared devices, such as a branch kiosk. |
| **_Use fallback search_**<br />_Workflows only_ | When enabled, the module performs a fallback search if the primary matching pass does not return a result. |

### Configuration Options: Classic

<Accordion title="View image of Workflow configuration panel" >
  ![Image of the Custom Watchlist module's configuration panel in Workflows. Has four configuration options.](https://developer.incode.com/assets/6643ec8cc04a98178f65510762641427.png)
</Accordion>

<Accordion title="View image of Flow configuration panel" >
  ![Image of the Custom Watchlist module's configuration panel in Flows. Has five configuration options.](https://developer.incode.com/assets/e07a1e9fceb33e5a80fb74f8a1d979e9.png)
</Accordion>

| Setting                                         | Description                                                                                                                                                                                                                                                                                                                                                            |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Fail in face match_**<br />_Flows only_      | When enabled, a biometric face match against a Blocklist entry directly fails the Session, regardless of other scoring.                                                                                                                                                                                                                                                |
| **Automatically add suspected fraud**           | When enabled, the system automatically adds a user to the Blocklist when fraud signals are detected: for example, if a face match fails or if there is a name or date of birth mismatch against a record already linked to the same biometric face template. Score updates apply to the current session and all future sessions. Historical sessions are not affected. |
| **_Auto execute_**<br />_Flows only_            | When enabled, the module runs automatically after ID and face data have been collected, without requiring a manual trigger.                                                                                                                                                                                                                                            |
| **_Shared device mode_**                        | When enabled, device-specific identifiers such as device hash are excluded from watchlist matching. Use this when users access the service on shared devices, such as a branch kiosk.                                                                                                                                                                                  |
| **_Use fallback search_**<br />_Workflows only_ | When enabled, the module performs a fallback search if the primary matching pass does not return a result.                                                                                                                                        |
| **_Exclude ID photo from matching_**            | When enabled, the ID photo is not used when matching the user against watchlist entries.                                                                                                                                                                                                                                                                               |

## Add Conditions

[Conditions](/dashboard-platform-administration/configure-workflow-conditions/) let you branch the Workflow based on a result. Conditions are optional for Custom Watchlist, but you can add one or more Conditions after the module to route the session based on whether the user was found on a Blocklist or Allowlist.

The way you set conditions depends on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Workflow.

### Add Conditions: New

1. Right after Custom Watchlist, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Conditions**.
2. In the first drop-down under **_If_**, expand the Custom Watchlist section and select one of its values:
| Value | Description |
| --- | --- |
| _Watchlist birth date match_ | If the user's date of birth matches a date of birth on a watchlist entry. |
| _Watchlist device hash match_ | If the user's device fingerprint matches a device hash on a watchlist entry. This is a high-impact signal. When **_Shared device mode_** is enabled, device identifiers are excluded from matching. |
| _Watchlist phone match_ | If the user's phone number matches a phone number on a watchlist entry. |
| _Watchlist name match_ | If the user's name matches a name on a watchlist entry. Name matching is scored and fuzzy. |
| _Watchlist type_ | The list classification of the matched entry: _Blocklist_ or _Allowlist_. Include this condition to determine whether a match should restrict or trust the user. Blocklist matches reduce the session score; Allowlist matches increase it. |
| _Watchlist email match_ | If the user's email address matches an email on a watchlist entry. |
| _Watchlist External ID Match_ | If the user's external ID matches an external ID on a watchlist entry. |
| _Watchlist personal id number match_ | If the user's personal ID number matches a personal ID number on a watchlist entry. |
| _Watchlist face match_ | If the user's face matches a face template enrolled in the watchlist. If **_Fail in face match_** is enabled, a match against a Blocklist entry directly fails the session. |
| _Watchlist id number match_ | If the user's document number matches an ID number on a watchlist entry. |
3. Configure the second and third drop-downs under **_If_** to fit the condition you want:
    - In the second drop-down under **_If_**, select _is_ or _is not_.
    - In the third drop-down under **_If_**, select _Matched_ or _Not Matched_. For _Watchlist type_, select _Blocklist_ or _Allowlist_.
:::note
For example, configuring the condition _Watchlist name match_ _is_ _Matched_ will route the session based on if the user's name matches a name on a watchlist entry.
:::
4. Configure the **_Then_** and **_Otherwise_** drop-downs to fit the condition you want.
:::note
For example, with _Watchlist name match_ _is_ _Matched_, you might select _Manual Review_ under **_Then_** to send the session to manual review if the user's name matches a name on a watchlist entry. Then, you might select _Continue to next step_ under **_Otherwise_** to continue the session if the user's name does not match a watchlist entry.
:::
5. Click **Save condition**.

### Add Conditions: Classic

1. Drag a Condition into the builder from the left panel. Place it after the Custom Watchlist module.

2. In the first drop-down, find the Custom Watchlist section and select one of the conditions listed below:
   | Condition                          | Description                                                                                                                                                                                                                                 |
   | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Watchlist birth date match         | If the user's date of birth matches a date of birth on a watchlist entry.                                                                                                                                                                   |
   | Watchlist device hash match        | If the user's device fingerprint matches a device hash on a watchlist entry. This is a high-impact signal. When **_Shared device mode_** is enabled, device identifiers are excluded from matching.                                         |
   | Watchlist phone match              | If the user's phone number matches a phone number on a watchlist entry.                                                                                                                                                                     |
   | Watchlist name match               | If the user's name matches a name on a watchlist entry. Name matching is scored and fuzzy.                                                                                                                                                  |
   | Watchlist type                     | The list classification of the matched entry: _BLOCKLIST_ or _ALLOWLIST_. Include this condition to determine whether a match should restrict or trust the user. Blocklist matches reduce the session score; Allowlist matches increase it. |
   | Watchlist email match              | If the user's email address matches an email on a watchlist entry.                                                                                                                                                                          |
   | Watchlist personal id number match | If the user's personal ID number matches a personal ID number on a watchlist entry.                                                                                                                                                         |
   | Watchlist face match               | If the user's face matches a face template enrolled in the watchlist. If **_Fail in face match_** is enabled, a match against a Blocklist entry directly fails the session.                                                                 |
   | Watchlist id number match          | If the user's document number matches an ID number on a watchlist entry.                                                                                                                                                                    |

3. In the second drop-down, select an operator.

4. In the value field, enter or select the value to compare against.

5. Select the **Yes path** or **No path** radio button to route the Workflow when the Condition is met.

6. Click **Save condition**.

---

- Path: `dashboard-platform-administration/dashboard-platform-administration`
- URL: https://developer.incode.com/dashboard-platform-administration/
- Markdown: https://developer.incode.com/dashboard-platform-administration.md

# Dashboard Platform Administration

Dashboard allows you to build verification experiences, monitor the sessions and identities they produce, review flagged cases, and manage your organization's users, integrations, and settings. This section walks through every page in Dashboard, organized by:
- The order in which you likely want to complete tasks.
- The order of pages in the left menu in Dashboard.

Dashboard comes in two versions: Standard and Beta. Standard is the default and the one your team uses today. Beta is the same Dashboard, but new features arrive there first. Each user chooses between Standard and Beta for themselves and can switch between them at any time. Throughout this section, pages or information specific to Beta use the <Pill type="beta" /> tag. See [Choosing Between Standard and Beta](/dashboard-platform-administration/choosing-between-standard-and-beta/) for more information.



## Configure Workflows and Flows

- **[Workflows](/dashboard-platform-administration/workflows-20/)**: Create, edit, test, and manage Workflows. Workflows are the recommended, no-code way to define an onboarding or authentication journey with conditional branching.
- **[Flows](/dashboard-platform-administration/flows-1/)**: Create and manage Flows, the legacy, linear alternative to Workflows. Flows are being deprecated in favor of Workflows.
- **[Configure Workflow Conditions](/dashboard-platform-administration/configure-workflow-conditions/)**: Add and configure Condition nodes in a Workflow to route users down different paths based on collected data.
- **[Forward Data to Your Workflow](/dashboard-platform-administration/forward-data-to-your-workflow/)**: Forward custom fields, an external customer ID, or a redirect URL override into a Workflow via `/omni/start`, and use it to cross-check ID data or tag sessions with internal identifiers.
- **[Add Modules](/dashboard-platform-administration/add-modules/)**: Select which modules to add to your Workflows or Flows.

## Monitor Sessions, Identities, and Authentications

- **[Sessions](/dashboard-platform-administration/review-verification-sessions/)**: Browse, filter, and export every completed onboarding or authentication session, or start a manual session by sending an SMS link directly from Dashboard.
- **[Identities](/dashboard-platform-administration/view-identities/)**: View every enrolled Incode Identity in your organization. Identities are reusable verified records created when users successfully onboard.
- **[Authentications](/dashboard-platform-administration/review-authentications/)**: Review every 1:1 or 1:N face authentication attempt made against your identity pool, separate from onboarding sessions.

## Manage Assisted Verification Services

- **[Helpdesk Verifications](/dashboard-platform-administration/manage-helpdesk-verifications/)**: Manually trigger identity verification for an employee in real time. This is useful for call-center or help-desk scenarios where an agent needs to confirm identity before granting access.
- **[Candidate Verifications](/dashboard-platform-administration/manage-candidate-verifications/)**: Trigger identity verification for a job candidate on demand, including generating a verification-gated meeting link, to guard against hiring fraud.

## Monitor Risk & Compliance

- **[Custom Watchlists](/dashboard-platform-administration/manage-custom-watchlists/)**: Maintain your organization's own blocklists and allowlists of individuals or entities, independent of Incode's built-in fraud lists.
- **[Compliance](/dashboard-platform-administration/monitor-compliance/)**: Review data deletion records and a full audit trail of Dashboard user and system actions.
- **[Escalations](/dashboard-platform-administration/view-escalations/)**: Track the status of sessions you've escalated to Incode for review, from submission through resolution.
- **[Cases](/dashboard-platform-administration/manage-cases/)**: Assign and resolve sessions that were flagged for manual review.
- <Pill type="beta" /> **[Analytics](/dashboard-platform-administration/view-analytics/)**: Track headline numbers, identify where you lose users, break down outcomes, and more.

## Check System Status

- **[Status](/dashboard-platform-administration/check-system-status/)**: Links out to status.incode.com to check current service health, uptime history, and incident history, and to subscribe to status updates.

## Manage Dashboard Organization and Access

- **[Users](/dashboard-platform-administration/manage-users/)**: Create, edit, and delete Dashboard user accounts, assign roles, and view each user's activity log.
- **[Configuration](/dashboard-platform-administration/configuration/)**: Configure organization-wide settings: general settings, authorization, webhooks, API keys, integrations, consents, and the look and feel of the hosted onboarding experience.
- **[Integrations](/dashboard-platform-administration/manage-integrations/)**: Create, edit, and manage the integrations (such as B2B onboarding or OIDC client credentials) used to trigger and authenticate verification sessions.
- **[Directory Information](/dashboard-platform-administration/view-directory-information/)**: View the people and directories (such as Okta or Microsoft Entra) connected through a directory integration, along with each person's verification sessions.

---

- Path: `dashboard-platform-administration/data-sharing-consent-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/data-sharing-consent-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/data-sharing-consent-dashboard.md

# Data Sharing Consent

The Data Sharing Consent module shows the user one or more preconfigured [consents](/dashboard-platform-administration/configuration-consents-tab/) to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey.

Incode provides a default consent. If you want to add any additional consents, ensure you have [created them](/dashboard-platform-administration/configuration-consents-tab#add-a-new-consent) before configuring this module.

For an overview of this module and how it works, see [Data Sharing Consent](/features-and-modules/combined-consent/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Data Sharing Consent to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Data Sharing Consent** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: At the beginning of your Workflow, right after Session Start, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Data Sharing Consent**.
    - **Classic**: From the Modules list, drag and drop the **Data Sharing Consent** module into the builder. Add it to the beginning of your Workflow.
4. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel to select the consent to use in this Workflow.

## Add Data Sharing Consent to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Data Sharing Consent** module and click **Add**.
4. By default, the [Configuration Options](#configuration-options) panel opens so you can select your consent.&#x20;

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of configuration panel">

![Image of Data Sharing Consent module configuration in Workflows. Availability listed for Web, iOS, and Android. Has one configuration option](https://developer.incode.com/assets/2f0a1261-2a39-4732-801e-72302b017e90.png)

</Accordion>

| Setting       | Description                                               |
| ------------- | --------------------------------------------------------- |
| **_Consent form_** | Use this drop-down to select the consent you want to use. |

If you are building a Workflow and want to offer the user more than one consent screen, you can add the module again and select a different consent from the drop-down. Repeat this for as many consents as you need.

Only one consent is supported when building a Flow.



### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of Data Sharing Consent module configuration in Workflows. Has one configuration option](https://developer.incode.com/assets/c4de2c6afdbdb7ee5b94b80affd65c8f.png)

</Accordion>

| Setting       | Description                                               |
| ------------- | --------------------------------------------------------- |
| **_Consent_** | Use this drop-down to select the consent you want to use. |

If you are building a Workflow and want to offer the user more than one consent screen, you can add the module again and select a different consent from the drop-down. Repeat this for as many consents as you need.

Only one consent is supported when building a Flow.

---

- Path: `dashboard-platform-administration/document-capture-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/document-capture-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/document-capture-dashboard.md

# Document Capture

The Document Capture module captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera.

Submitted documents appear in the **Other** tab in [single Session view](/dashboard-platform-administration/single-session-view/#other).

For an overview of this module and how it works, see [Document Capture](/features-and-modules/document-capture/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Document Capture to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Document Capture** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Document Capture**.
    - **Classic**: From the Modules list, drag and drop the **Document Capture** module into the builder.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Document Capture to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Document Capture** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

<Accordion title="View image of configuration panel">

![The Document Capture module configuration panel, showing Web, iOS, and Android platform tags and a Documentation link at the top, followed by four configurable fields: Screen title, Screen description, Processing type (set to Capture), and an "Allow user to skip document capture" toggle (off).](https://developer.incode.com/assets/8fc6d40d-9c45-413b-ae06-88400375fc48.png)

</Accordion>

| Setting                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Screen title_**                               | Custom title text displayed to the user on the document capture screen. Leave blank to use the default.                                                                                                                                                                                                                                                                                                                                                                                                      |
| **_Screen description_**                                | Custom instructional text displayed to the user on the document capture screen. Leave blank to use the default.                                                                                                                                                                                                                                                                                                                                                                                              |
| **_Processing Type_**                     | Determines how the captured document is processed after submission. Select one of the following options: <br />• _Capture_<br />• _Process Proof Of Address OCR_<br />• _Process Letter Of Authorization OCR_<br />• _Process Asylum Seeker Visa ZAF OCR_<br />• _Process Bank Statement OCR_<br />• _Process Voided Check OCR_<br />• _Process V5C Logbook_<br />• _Process Car Invoice_<br />• _Process Circulation Card_<br />• _Process Finance Settlement_<br />• _Process Mexican INE as POA_ <br />• Process Colombia RUT form<br />• Process W-8BEN OCR<br />• Process W-8BEN-E OCR |
| **_Allow user to skip document capture_** | When enabled, users can bypass the document capture step and continue without submitting a document.                                                                                                                                                                                                                                                                                                                                                                                                         |

### Configuration Options: Classic

<Accordion title="View image of Workflow configuration panel">

![Image of Document Capture module configuration in Workflows. Has four configurable options.](https://developer.incode.com/assets/d4faea82209341b0928cdbf64c854473.png)

</Accordion>

<Accordion title="View image of Flow configuration panel">

![Image of Document Capture module configuration in Flows. Has four configurable options.](https://developer.incode.com/assets/1646ba9d-7556-439d-8451-8ff80666a605.png)

</Accordion>

| Setting                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Title_**                               | Custom title text displayed to the user on the document capture screen. Leave blank to use the default.                                                                                                                                                                                                                                                                                                                                                                                                      |
| **_Text_**                                | Custom instructional text displayed to the user on the document capture screen. Leave blank to use the default.                                                                                                                                                                                                                                                                                                                                                                                              |
| **_Processing Type_**                     | Determines how the captured document is processed after submission. Select one of the following options: <br />• _Capture_<br />• _Process Proof Of Address OCR_<br />• _Process Letter Of Authorization OCR_<br />• _Process Asylum Seeker Visa ZAF OCR_<br />• _Process Bank Statement OCR_<br />• _Process Voided Check OCR_<br />• _Process V5C Logbook_<br />• _Process Car Invoice_<br />• _Process Circulation Card_<br />• _Process Finance Settlement_<br />• _Process Mexican INE as POA_ <br />• Process Colombia RUT form<br />• Process W-8BEN OCR<br />• Process W-8BEN-E OCR |
| **_Allow user to skip document capture_** | When enabled, users can bypass the document capture step and continue without submitting a document.                                                                                                                                                                                                                                                                                                                                                                                                         |

---

- Path: `dashboard-platform-administration/ekyb-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/ekyb-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/ekyb-dashboard.md

# eKYB

This module verifies the identity and legitimacy of a business by matching business details submitted by the end user against records in recognized government and commercial data sources. The fields collected depend on the country the end user selects.

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add eKYB to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **eKYB** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **eKYB**.
    - **Classic**: From the **Modules** list, drag and drop the **eKYB** module into the builder after the modules that collect user data.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add eKYB to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **eKYB** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

In New view, the eKYB configuration panel opens on the **Configuration** tab. Use the **Operation type** toggle at the top to switch between **Verification** and **Prefill**. The settings below the toggle change based on your selection.



### Verification

<Accordion title="View image of configuration panel">

![The eKYB module Configuration tab in New view with Verification selected as the Operation type. Shows toggles and source drop-downs to configure which business fields are verified and where each value comes from.](https://developer.incode.com/assets/fc71feb8-41b2-4b28-bc67-60d3021d6213.png)

</Accordion>

Verification is the core business identity check. The end user submits business details, and the system verifies the submitted values against a source of truth. For request and response schemas, supported countries, and per-country details, see the [eKYB Verification Coverage](https://developer.incode.com/docs/ekyb-verification-coverage) and [eKYB Verification API Reference](https://developer.incode.com/docs/ekyb-verification-api-reference) pages.

With Verification selected, use the toggles to enable each field you want to collect from the end user. For fields with a source drop-down, select where the value comes from. The default is *User input*, which means the value is entered by the end user.

| Setting                              | Description                                                                                              |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| Business name                        | When enabled, the end user is asked to provide the business name.                                        |
| Verify address                       | When enabled, the end user is asked to provide the business address.                                     |
| Verify tax ID                        | When enabled, the end user is asked to provide the business tax ID.                                      |
| Verify unique beneficial owner (UBO) | When enabled, the end user is asked to provide the full legal names of the business's Unique Beneficial Owners. |
| Verify directors                     | When enabled, the end user is asked to provide the full legal names of the business's directors.         |

Not all fields are supported by every country. See the country page for each country's supported fields. Country pages are listed on the [eKYB Verification Coverage](https://developer.incode.com/docs/ekyb-verification-coverage) page.

### Prefill

<Accordion title="View image of configuration panel">

![The eKYB module Configuration tab in New view with Prefill selected as the Operation type. Shows the Prefill source dropdown set to Mexico Prefill and a Verify tax ID toggle with User input source.](https://developer.incode.com/assets/b8e65146-b311-4024-ad3a-7bda4650982d.png)

</Accordion>

Prefill is an enrichment option that reduces end user friction. The end user submits only the tax ID (and business name where required), and the system looks up the business in official registries and returns additional details for pre-fill. Prefill does not verify submitted values against a source of truth; it retrieves and returns data.

For request and response schemas, supported countries, and per-country details, see the [eKYB Prefill Coverage](https://developer.incode.com/docs/ekyb-prefill-coverage) and [eKYB Prefill API Reference](https://developer.incode.com/docs/ekyb-prefill-api-reference) pages.

Select the **Prefill source** for the country you want to use. Each country has mandatory and optional fields available for collection from the end user. Configure the fields as needed; see [eKYB Prefill Field Requirements by Source](https://developer.incode.com/dashboard-platform-administration/ekyb-prefill-field-requirements-by-source/) for a reference of the fields available per source.



### Configuration Options: Classic

The eKYB module supports two configuration options: **Verification** and **Prefill**. Switch between the two using the tabs at the top of the configuration panel.

#### Verification

Verification is the core business identity check. The end user submits business details (business name, tax ID, address, and optionally UBOs and directors), and the system verifies the submitted values against a source of truth. The response includes match results for each submitted field, along with enrichment details (registration status and entity type) where available.

For request and response schemas, supported countries, and per-country details, see the [eKYB Verification Coverage](https://developer.incode.com/docs/ekyb-verification-coverage) and [eKYB Verification API Reference](https://developer.incode.com/docs/ekyb-verification-api-reference) pages.

The field checkboxes control which fields are collected from the end user and submitted for verification. The end user selects the country in the flow itself; there is no country selector in the module configuration.

<Accordion title="View image of Workflow configuration panel">
  ![Image of the Verification tab of the eKYB configuration panel in Workflows. Has five configuration options.](https://developer.incode.com/assets/062e72d769bd5b2726f70910b3c9b896.png)
</Accordion>

<Accordion title="View image of Flow configuration panel">
  ![Image of the Verification tab of the eKYB configuration panel in Flows. Has five configuration options.](https://developer.incode.com/assets/0624a5c6bb2f3eee5ab9d60bdce76619.png)
</Accordion>

| Setting                       | Description                                                                                                     |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------- |
| Business name                 | When enabled, the end user is asked to provide the business name.                                               |
| Address                       | When enabled, the end user is asked to provide the business address.                                            |
| Tax ID                        | When enabled, the end user is asked to provide the business tax ID.                                             |
| Unique Beneficial Owner (UBO) | When enabled, the end user is asked to provide the full legal names of the business's Unique Beneficial Owners. |
| Directors                     | When enabled, the end user is asked to provide the full legal names of the business's directors.                |

Not all fields are supported by every country. See the country page for each country's supported fields. Country pages are listed on the [eKYB Verification Coverage](https://developer.incode.com/docs/ekyb-verification-coverage) page.

#### Prefill

Prefill is an enrichment option that reduces end user friction. The end user submits only the tax ID and business name, and the system looks up the business in official registries and returns additional details (registered address, entity type, and other authoritative data) for pre-fill. Prefill does not verify submitted values against a source of truth; it retrieves and returns data.

For request and response schemas, supported countries, and per-country details, see the [eKYB Prefill Coverage](https://developer.incode.com/docs/ekyb-prefill-coverage) and [eKYB Prefill API Reference](https://developer.incode.com/docs/ekyb-prefill-api-reference) pages.&#x20;

<Accordion title="View image of Workflow configuration panel">

![Image of the Prefill tab of the eKYB configuration panel in Workflows. Has variable configuration options.](https://developer.incode.com/assets/f71fd172-2b37-4469-9acd-b15dd4952b17.png)

</Accordion>

<Accordion title="View image of Flow configuration panel">

![Image of the Prefill tab of the eKYB configuration panel in Flows. Has variable configuration options.](https://developer.incode.com/assets/d1b150570dba54db794ecbe4c138f8f2.png)

</Accordion>

Select the **Prefill source** for the country you want to use. Each country has mandatory and optional fields available for collection from the end user. Configure the fields as needed; see [eKYB Prefill Field Requirements by Source](https://developer.incode.com/dashboard-platform-administration/ekyb-prefill-field-requirements-by-source/) for a reference of the fields available per source.

## Add Conditions

[Conditions](https://developer.incode.com/docs/configure-workflow-conditions) let you branch the Workflow based on the eKYB verification result. When adding a Condition after the eKYB module, search, filter, or browse for the **eKYB** section in the first drop-down and select from the following options:

| Condition                      | Description                                                                                                                             |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| Address deliverability </br> _US only_         | The USPS deliverability status for the submitted business address. Possible values: _DELIVERABLE_, _UNDELIVERABLE_.                     |
| Unique beneficial owners count | The number of Unique Beneficial Owners associated with the business. Supports comparison operators. Possible values: any numeric value. |
| TaxID verification             | The match status for the submitted tax ID. Possible values: _VERIFIED_, _APPROXIMATE MATCH_, _UNVERIFIED_.                              |
| Ubo name match                 | The match status for the submitted UBO names. Possible values: _VERIFIED_, _APPROXIMATE MATCH_, _UNVERIFIED_.                           |
| Address verification           | The match status for the submitted business address. Possible values: _VERIFIED_, _APPROXIMATE MATCH_, _UNVERIFIED_.                    |
| Business name                  | The match status for the submitted business name. Possible values: _VERIFIED_, _APPROXIMATE MATCH_, _UNVERIFIED_.                       |
| Address property type </br> _US only_         | The property type of the submitted business address. Possible values: _RESIDENTIAL_, _COMMERCIAL_.                                      |

---

- Path: `dashboard-platform-administration/ekyb-field-requirements-by-source`
- URL: https://developer.incode.com/dashboard-platform-administration/ekyb-field-requirements-by-source/
- Markdown: https://developer.incode.com/dashboard-platform-administration/ekyb-field-requirements-by-source.md

# eKYB Prefill Field Requirements by Source

This page lists the field requirements for each source available in the Dashboard's eKYB module Prefill configuration. Each country in [eKYB Dashboard configuration](https://developer.incode.com/dashboard-platform-administration/ekyb-dashboard/) supports one Prefill source, and the fields available for collection vary by country. This page lists what appears in the Dashboard for each country and source combination. 

For response schemas and API-level details, see the [eKYB Prefill Coverage](https://developer.incode.com/docs/ekyb-prefill-coverage) and [eKYB Prefill API Reference](https://developer.incode.com/docs/ekyb-prefill-api-reference) pages.

## Australia

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Austria

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Belgium

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## France

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Germany

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Greece

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## India

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Ireland

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Italy

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Mexico

| Field  | Requirement |
| ------ | ----------- |
| Tax ID | Required    |

## Netherlands

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Portugal

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## Saudi Arabia

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |

## Spain

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## United Arab Emirates

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |

## United Kingdom

| Field         | Requirement              |
| ------------- | ------------------------ |
| Tax ID        | Required                 |
| Business name | Optional, off by default |
| Address       | Optional, off by default |

## United States

| Field         | Requirement             |
| ------------- | ----------------------- |
| Business name | Required                |
| Address       | Required                |
| Tax ID        | Optional, on by default |

</br>

---

- Path: `dashboard-platform-administration/ekyc-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/ekyc-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/ekyc-dashboard.md

# eKYC

This module verifies an end user's identity by matching the personal information they provide against records in recognized data sources. The fields collected and the sources available depend on the country selected.

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add eKYC to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **eKYC** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **eKYC**.
    - **Classic**: From the **Modules** list, drag and drop the **eKYC** module into the builder after the modules that collect user data.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add eKYC to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **eKYC** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New



<Accordion title="View image of configuration panel">

![The eKYC module configuration panel in New view, showing the Countries tab. This tab has a search field and a scrollable two-column list of countries to choose from.](https://developer.incode.com/assets/b4c0e1c7-fe2f-49be-a51c-8fecc17df67c.png)

</Accordion>

In New view, the eKYC configuration panel is organized into two tabs: **Countries** and **Additional Configuration**.

#### Countries Tab

Select the country whose data sources will be used to verify the end user. Only one country can be selected per eKYC module instance. Use the search field to filter the list, or click a country tile to select it. Each tile shows the number of sources available for that country.

The **Global** option at the bottom of the list is used for configuring standalone risk checks. Select Global with the *Risk Add-ons Only* source to run the checks on the **Additional configuration** tab without a country-specific verification.

After selecting a country, configure the following:

| Setting | Description |
| --- | --- |
| Source | The specific data source within the selected country to verify against. The available sources depend on the country selected. See [Field Requirements by Source](https://developer.incode.com/dashboard-platform-administration/ekyc-field-requirements-by-source/) for the sources available per country. |
| Mandatory fields | Fields required for the selected country and source. These are always collected and cannot be disabled. For each one, use the drop-down to set where the value comes from. See [Field input sources](#field-input-sources) below for the options available per field. |
| Optional fields | Additional fields you can choose to collect. Use the toggle to enable each one, then use the drop-down (where shown) to set where the value comes from. |

Click **Save configurations** when you're done. To return to the country list, click the back arrow next to the country name.

#### Additional Configuration Tab

Select one or more [Risk Addons](#risk-addons) to run alongside the country-specific verification: *Phone check*, *Advanced phone check*, *Phone profile*, and *Email check*.

#### Field input sources

Each field checkbox has a drop-down specifying where the field's value comes from. The options available depend on the field. The default for all fields is _Input_, which means the value is entered by the end user. The other options pull the value from another module's output or from the end user's proof of address document.

| Field                           | Available input sources                                                                    |
| ------------------------------- | ------------------------------------------------------------------------------------------ |
| Name                            | Input, Auto-fill from ID (OCR), Proof of Address                                           |
| Email                           | Input, Email Module Input, Proof of Address                                                |
| Address                         | Input, Auto-fill from ID (OCR), Proof of Address                                           |
| Phone                           | Input, Phone Module Input, Proof of Address                                                |
| Tax ID                          | Input                                                                                      |
| Date of birth                   | Input, Auto-fill from ID (OCR), Proof of Address                                           |
| Drivers License Number          | Input, Auto-fill from ID (OCR), Proof of Address                                           |
| Drivers License State           | Input, Auto-fill from ID (OCR), Proof of Address                                           |
| Drivers License Expiration Date | Input                                                                                      |
| Last 4 SSN Numbers              |  |
| National ID Number              | Input                                                                                      |
| TAX ID Number                   | Input, Proof of Address                                                                    |
| Gender                          | Input                                                                                      |
| Nationality                     | Input                                                                                      |
| PAN number                      | Input, Auto-fill from ID (OCR)                                                             |
| ID Type                         | Input                                                                                      |



#### Risk Addons

Risk Addons are supplementary checks that evaluate the trust and potential risk of a phone number or email address. They can be added to any eKYC configuration to run alongside the country-specific verification, or configured as standalone checks under the Global country with the _Risk Add-ons Only_ source.

Each add-on returns its own set of API response fields and an overall risk level. See the [eKYC API Reference](/general-reference/ekyc-api-reference/#risk-add-ons) for the full response schema.

#### Phone Check

Evaluates the trust and potential risk of a phone number using signals like validity, activity, carrier information, and fraud indicators. Signals include:

- Line type and carrier
- Whether the number is VOIP or prepaid
- Whether the number has been exposed in recent data breaches
- Whether the number has been reported for spam or harassment

Best suited for standard phone-number risk assessment.

#### Advanced Phone Check

Extends _Phone Check_ with additional intelligence signals including porting history, breach history, social media presence, and digital footprint scoring. Signals include:

- Whether the number has been ported, and the previous and current carriers
- The number's first-seen date in the data partner's network
- Associated social media platforms
- Breach history, including first and last breach dates
- A digital footprint score

Best suited for higher-assurance workflows where extended phone intelligence is required.

#### Phone Profile

Given just a phone number, this check returns the associated person's name, date of birth, and address(es) on file when available, along with any additional candidate identities tied to that number. Returned data includes:

- First and last name of the person associated with the number
- Date of birth, where available
- Address or addresses on file
- Country associated with the number
- Additional candidate identities tied to the same number, each with their own name, date of birth, and address data
- A confidence level for the match and reason codes explaining the outcome

Best suited for enriching a session with identity data when only a phone number is available, or for confirming that a provided phone number is tied to the expected person.

#### Email Check

Evaluates the trust and potential risk of an email address using signals like validity, deliverability, breach exposure, and legitimate user activity. Signals include:

- Whether the email address appears in recent database leaks
- The estimated age of the email address
- The age of the email domain
- A measure of the email address's legitimate user activity (purchases, registrations, and other online behavior)

Best suited for assessing the trust and potential risk of an email address at account creation or high-risk transaction points.

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![The eKYC module configuration panel in Classic view, showing a mobile preview of the eKYC Verification screen on the left, module description and platform availability icons in the center, and configuration options on the right including Country, Source, and a list of selectable attribute fields with input type dropdowns.](https://developer.incode.com/assets/5eaaa511-cb2b-4c14-8e87-1fa30c88a6e3.png)

</Accordion>

| Setting                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Country                                                                   | The country whose data sources will be used to verify the end user. Select one country per eKYC module instance. See [Field Requirements by Source](/dashboard-platform-administration/ekyc-field-requirements-by-source/) for the sources and fields available per country.                                                                                                                                                                                                                                                   |
| Source                                                                    | The specific data source within the selected country to verify against. The available sources depend on the country selected. See [Field Requirements by Source](/dashboard-platform-administration/ekyc-field-requirements-by-source/) for the sources available per country.                                                                                                                                                                                                                                                 |
| Field checkboxes (Name, Email, Address, Phone, Date of birth, and others) | The fields collected from the end user and submitted for verification. The fields available depend on the country and source selected. Some fields may be required for a given country and source and cannot be deselected. See [Field Requirements by Source](/dashboard-platform-administration/ekyc-field-requirements-by-source/) for the sources available per country.  |
| Field input source drop-down                                              | For each field, specifies where the field's value comes from. Options vary per field. See [Field Input Sources](#field-input-sources) below for the options available per field.                                                                                                                                                                                                                                                                                                                                                           |
| Risk Addons                                                               | Additional checks that run alongside the primary eKYC verification. Select one or more of _Phone Check_, _Advanced Phone Check_, _Phone Profile_, and _Email Check_. See [Risk Addons](#risk-addons) below for a description of each.                                                                                                                                                                                                                                                                                                                       |

## Add Conditions

[Conditions](/dashboard-platform-administration/configure-workflow-conditions/) let you branch the Workflow based on the eKYC verification result. When adding a Condition after the eKYC module, search, filter, or browse for the **eKYC** section in the first drop-down and select from the following options:

| Condition                                                                                                                                                                                                                                                                                                         | Description                                                                                                                                  |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Phone level                                                                                                                                                                                                                                                                                                       | The risk level associated with the submitted phone. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                   |
| Phone zipcode match                                                                                                                                                                                                                                                                                               | The match status for the submitted zip code against the phone record. Possible values: _EXACT_, _NO MATCH_.                                  |
| Phone address match                                                                                                                                                                                                                                                                                               | The match status for the submitted address against the phone record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                          |
| TaxID match                                                                                                                                                                                                                                                                                                       | The match status for the submitted tax ID against the record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                                 |
| Phone city match                                                                                                                                                                                                                                                                                                  | The match status for the submitted city against the phone record. Possible values: _EXACT_, _NO MATCH_.                                      |
| Phone email match                                                                                                                                                                                                                                                                                                 | The match status for the submitted email against the phone record. Possible values: _EXACT_, _NO MATCH_.                                     |
| TaxID DOB match                                                                                                                                                                                                                                                                                                   | The match status for the submitted date of birth against the tax ID record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                   |
| Address risk level                                                                                                                                                                                                                                                                                                | The risk level associated with the submitted address. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                 |
| DL state check                                                                                                                   | The match status for the submitted driver's license state against the phone record. Possible values: _EXACT_, _NO MATCH_.                    |
| Email level                                                                                                                                                                                                                                                                                                       | The risk level associated with the submitted email. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                   |
| TaxID level                                                                                                                                                                                                                                                                                                       | The risk level associated with the submitted tax ID. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                  |
| Phone name match                                                                                                                                                                                                                                                                                                  | The match status for the submitted name against the phone record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                             |
| Overall eKYC level                                                                                                                                                                                                                                                                                                | The overall risk level returned by the eKYC check. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                    |
| TaxID state match                                                                                                                                                                                                                                                                                                 | The match status for the submitted state against the tax ID record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                           |
| Phone dob match                                                                                                                                                                                                                                                                                                   | The match status for the submitted date of birth against the phone record. Possible values: _EXACT_, _NO MATCH_.                             |
| DL number check                                                                                                                | The match status for the submitted driver's license number against the phone record. Possible values: _EXACT_, _NO MATCH_.                   |
| Email domain level                                                                                                                                                                                                                                                                                                | The risk level associated with the submitted email's domain. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                          |
| last4SSN                                                                                                                                                                                                                                                                                                          | The match status for the submitted last four digits of SSN against the phone record. Possible values: _EXACT_, _NO MATCH_.                   |
| Adverse media level                                                        | The adverse media risk score returned for the session. Supports comparison operators. Possible values: any numeric value.                    |
| Phone state match                                                                                                                                                                                                                                                                                                 | The match status for the submitted state against the phone record. Possible values: _EXACT_, _NO MATCH_.                                     |
| Sanction level                                                                  | The sanction risk score returned for the session. Supports comparison operators. Possible values: any numeric value.                         |
| Name risk level                                                                                                                                                                                                                                                                                                   | The risk level associated with the submitted name. Possible values: _VERY HIGH_, _HIGH_, _MEDIUM_, _LOW_.                                    |
| Manual review                                                                                                               | Result related to whether the session has flagged for manual review. Supports comparison operators. Possible values: any numeric value.      |
| TaxID name match                                                                                                                                                                                                                                                                                                  | The match status for the submitted name against the tax ID record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                            |
| TaxID address match                                                                                                                                                                                                                                                                                               | The match status for the submitted address against the tax ID record. Possible values: _EXACT_, _FUZZY_, _NO MATCH_.                         |
| Pep level  | The PEP (politically exposed person) risk score returned for the session. Supports comparison operators. Possible values: any numeric value. |

---

- Path: `dashboard-platform-administration/ekyc-field-requirements-by-source`
- URL: https://developer.incode.com/dashboard-platform-administration/ekyc-field-requirements-by-source/
- Markdown: https://developer.incode.com/dashboard-platform-administration/ekyc-field-requirements-by-source.md

# eKYC Field Requirements by Source

This page lists the field requirements for each source available in the Dashboard's eKYC module configuration. Each country in [eKYC Dashboard configuration](/dashboard-platform-administration/ekyc-dashboard/) supports one or more sources, and the fields available for collection vary by country and source. This page lists what appears in the Dashboard for each country and source combination. For response schemas, `overallLevel` calculations, and API-level details, see the eKYC Reference section.

## Argentina

Available sources: Argentina - Official Civil Register, Argentina - Resident Register.

#### Argentina - Official Civil Register

| Field              | Required |
| ------------------ | -------- |
| Name               | Required |
| Address            | Required |
| Gender             | Required |
| Date of birth      | Optional |
| National ID Number | Optional |
| TAX ID Number      | Optional |


#### Argentina - Resident Register

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Optional |
| Date of birth | Optional |
| Gender        | Optional |


## Brazil

Available sources: BR GOVT 1.

#### BR GOVT 1

This source verifies submitted fields against Brazilian government records associated with the provided tax ID (CPF).

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Tax ID        | Required |
| Address       | Optional |
| Date of birth | Optional |
| Nationality   | Optional |

## Canada

Available sources: CA Credit Bureau FINTRAC, CA RES CREDIT.

#### CA Credit Bureau FINTRAC

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Required |
| Date of birth | Required |


#### CA RES CREDIT

This source verifies submitted fields against Canadian credit records.

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Required |
| Date of birth | Required |
| Phone         | Optional |

## Chile

Available sources: Chile - Official Census.

#### Chile - Official Census

This source verifies submitted fields against Chilean census records associated with the provided National ID Number (RUT).

| Field              | Required |
| ------------------ | -------- |
| Name               | Required |
| National ID Number | Required |
| Date of birth      | Optional |

## Colombia

Available sources: CO 1.

#### CO 1

| Field              | Required |
| ------------------ | -------- |
| National ID Number | Required |
| Name               | Optional |


## Costa Rica

Available sources: CR 1.

#### CR 1

| Field              | Required |
| ------------------ | -------- |
| National ID Number | Required |
| Name               | Optional |


## Guatemala

Available sources: GT 1.

#### GT 1

This source verifies submitted fields against Guatemalan records associated with the provided National ID Number (DPI).

| Field              | Required |
| ------------------ | -------- |
| Date of birth      | Required |
| National ID Number | Required |
| Name               | Optional |

## India

Available sources: India DMV, INDIA PAN.

#### India DMV

| Field              | Required |
| ------------------ | -------- |
| Name               | Required |
| Date of birth      | Required |
| National ID Number | Required |
| Address            | Optional |
| Gender             | Optional |


#### INDIA PAN

This source verifies submitted fields against records associated with the provided PAN (Permanent Account Number).

| Field      | Required |
| ---------- | -------- |
| Name       | Required |
| PAN number | Required |

## Mexico

Available sources: MX CONSUMER 1.

#### MX CONSUMER 1

Combines phone and email risk-scoring from third-party providers to produce an overall eKYC risk assessment. **Phone** returns a risk score based on account history, prepaid status, account duration, and monthly bill amount. **Email** returns a predictive risk score based on historical transaction data and behavior patterns.

| Field | Required |
| ----- | -------- |
| Email | Required |
| Phone | Required |
| Name  | Optional |

## Nigeria

Available sources: NG MONO BVN, NG MONO NIN.

#### NG MONO BVN

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Phone         | Required |
| Date of birth | Required |
| TAX ID Number | Required |

#### NG MONO NIN

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Phone         | Required |
| Date of birth | Required |
| TAX ID Number | Required |

## Philippines

Available sources: Philippines Residential + Credit Bureau.

#### Philippines Residential + Credit Bureau

| Field              | Required |
| ------------------ | -------- |
| Name               | Required |
| Date of birth      | Required |
| Address            | Optional |
| National ID Number | Optional |
| ID Type            | Optional |

## Spain

Available sources: Spain Phone Register 2.

#### Spain Phone Register 2

Verifies individuals against Spain's Utility - Phone Register as the source of truth. Supports fuzzy matching on name, date of birth, address components, national ID number (DNI), and phone.

| Field              | Required |
| ------------------ | -------- |
| Name               | Required |
| Address            | Optional |
| Phone              | Optional |
| Date of birth      | Optional |
| National ID Number | Optional |

## United Kingdom

Available sources: UK CREDIT BUREAU 1, UK VOTER REGISTER.

#### UK CREDIT BUREAU 1

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Required |
| Date of birth | Optional |

#### UK VOTER REGISTER

Verifies individuals against the United Kingdom's Voter Register as the source of truth. Supports fuzzy matching on name, address components, date of birth, gender, and phone.

| Field         | Required |
| ------------- | -------- |
| Name          | Optional |
| Address       | Optional |
| Phone         | Optional |
| Date of birth | Optional |
| Gender        | Optional |

## United States

Available sources: US CREDIT BUREAU 1, US CREDIT BUREAU 3, US CREDIT TELCO, US DRIVERS LICENSE 1, US TELCO 1, US TELCO 2, US TELCO 4, US TELCO 5.

#### US CREDIT BUREAU 1

This source verifies submitted fields against credit bureau records associated with the provided tax ID.

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Required |
| Tax ID        | Required |
| Email         | Optional |
| Phone         | Optional |
| Date of birth | Optional |

#### US CREDIT BUREAU 3

This source verifies submitted fields against credit bureau records.

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Email         | Optional |
| Address       | Optional |
| Phone         | Optional |
| Tax ID        | Optional |
| Date of birth | Optional |


#### US CREDIT TELCO

| Field         | Required |
| ------------- | -------- |
| Name          | Required |
| Address       | Optional |
| Phone         | Optional |
| Tax ID        | Optional |
| Date of birth | Optional |


#### US DRIVERS LICENSE 1

This source verifies submitted driver's license details against state driver's license records. Driver's license verification is currently supported in 42 of the 50 US states. The following states are not supported: Alaska, California, Louisiana, Minnesota, New Hampshire, New York, Oklahoma, Pennsylvania, and Utah.

| Field                           | Required |
| ------------------------------- | -------- |
| Drivers License Number          | Required |
| Drivers License State           | Required |
| Name                            | Optional |
| Date of birth                   | Optional |
| Drivers License Expiration Date | Optional |

#### US TELCO 1

This source verifies submitted fields against the record associated with the provided phone number, so Phone is required.

| Field                  | Required |
| ---------------------- | -------- |
| Name                   | Required |
| Phone                  | Required |
| Address                | Optional |
| Date of birth          | Optional |
| Email                  | Optional |
| Drivers License Number | Optional |
| Drivers License State  | Optional |
| Last 4 SSN Numbers     | Optional |

#### US TELCO 2

This source verifies submitted fields against the record associated with the provided phone number, so Phone is required.

| Field         | Required |
| ------------- | -------- |
| Phone         | Required |
| Name          | Optional |
| Address       | Optional |
| Date of birth | Optional |

#### US TELCO 4


#### US TELCO 5

This source verifies submitted fields against the record associated with the provided phone number, so Phone is required.

| Field         | Required |
| ------------- | -------- |
| Phone         | Required |
| Name          | Optional |
| Email         | Optional |
| Address       | Optional |
| Tax ID        | Optional |
| Date of birth | Optional |

#### US ADDRESS 1


## Global

Available sources: Risk Add-ons Only.

#### Risk Add-ons Only

Select Global when no country-specific source of truth is required and the check should run against Risk Add-ons only. No identity fields are collected through this source; configuration is limited to the Risk Add-ons selector.

_See [Risk Addons](/dashboard-platform-administration/ekyc-dashboard/#risk-addons) in the eKYC Dashboard configuration for available add-on options._

<br />

---

- Path: `dashboard-platform-administration/ekyc-prefill-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/ekyc-prefill-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/ekyc-prefill-dashboard.md

# eKYC Prefill
This module looks up the end user in identity data sources from a phone number or a tax ID and returns the personal data the source holds, so it can pre-fill later steps of the onboarding. Which identifiers are needed depends on the country and source configured for the module.

:::info
This is different than [eKYC](/dashboard-platform-administration/ekyc-dashboard/).
:::



## Supported with:

✅ Workflows | ✅ Flows

## Before you start

The source you want to use must be enabled for your organization in its country. Contact your Incode representative to enable it. See [eKYC Prefill Coverage](/general-reference/ekyc-prefill-coverage/) for the available sources.

## Add eKYC Pre-fill to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **eKYC Prefill** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **eKYC Prefill**.
    - **Classic**: From the **Modules** list, drag and drop the **eKYC Prefill** module into the builder after the modules that collect user data.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add eKYC Pre-fill to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the Select Modules tab, find the eKYC Prefill module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The configuration panel looks different depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented here. Contact your Incode representative for more information.

<Accordion title="Configuration panel: New view">


![eKYC Pre-fill config: New view](https://developer.incode.com/assets/95c07411-4554-4dfa-9d35-53fcc3ea47ed.png)


</Accordion>

<Accordion title="Configuration panel: Classic view">


![eKYC Pre-fill config: Classic view](https://developer.incode.com/assets/f392bfcb-1f2c-45fe-ae84-be5a17d3c33e.png)


</Accordion>

| Option | Description | Default |
|---|---|---|
| Country | Country of the end user. Must be the country the source serves. | United States |
| Source | US Pre-fill, US Pre-fill Express or BR Pre-fill. See [eKYC Prefill Coverage](/general-reference/ekyc-prefill-coverage/). | US Pre-fill |
| Phone Number | Send the phone number. Always on for the US sources, which look up by phone. | On |
| Phone number source | Where the phone number comes from. Options are _Phone module input_ or _User input_. | Phone module input |
| Date of birth | Send the date of birth. US Pre-fill only. | On |
| Date of birth source | Where the date of birth comes from. Options are _User input_ or _Auto-fill from ID (OCR)_. This field is hidden if **Date of birth** is _Off_. | User input |
| SSN | Send the SSN. US Pre-fill only | Off |
| SSN source | Where the SSN comes from. The only option is _User input_. This field is hidden if **SSN** is _Off_.  | User input |
| Name | Send the last name (surname). US Pre-fill only. | Off |
| Name source | Where the name comes from. Options are _User input_, _Auto-fill from ID (OCR)_, or _Proof of address_. This field is hidden if **Name** is _Off_. | User Input |
| Include driver's license data | Return the driver's license data the source holds. US sources only. | Off |



Each source in the eKYC Prefill module uses only its own identifiers and ignores the rest.

- **US Pre-fill.** Phone number plus at least one of Date of Birth, SSN, or Name.
- **US Pre-fill Express** (coming soon). Phone number only.
- **BR Pre-fill** (coming soon). CPF only.

The module cannot be saved until **Country** matches the country the **Source** serves and the selected source has enough identifiers turned on to make a lookup:

| Source | Country | Identifiers required |
|---|---|---|
| US Pre-fill | United States | At least one of Date of Birth, SSN, or Name is on |
| US Pre-fill Express | United States | Phone number is on |
| BR Pre-fill | Brazil | None  |





## Add Conditions

Workflow Conditions are not available for this module yet. This section will be updated once they are.

## View results

The [single Session view](/dashboard-platform-administration/single-session-view/) shows the latest answered lookup of the session. The SSN or CPF are masked to their last 4 digits.

---

- Path: `dashboard-platform-administration/electronic-signature-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/electronic-signature-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/electronic-signature-dashboard.md

# Electronic Signature

The Electronic Signature module captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent.

For an overview of this module and how it works, see [Electronic Signature](/features-and-modules/electronic-signature-module/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Electronic Signature to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Electronic Signature** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Electronic Signature to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Electronic Signature** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![Image of the Electronic Signature module's configuration panel. Has two configuration options.](https://developer.incode.com/assets/5e29244dad7a8f2f2e22b0a1ad9e2052.png)

### General

| Setting        | Description                                                                                                                                                                                 |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Title_**    | Custom title displayed to the end user during the signing step. Leave blank to use the default title.                                                                                       |
| **_Subtitle_** | Custom subtitle displayed to the end user during the signing step. Use this field to add instructions or communicate the purpose of the signature. Leave blank to use the default subtitle. |

<br />

---

- Path: `dashboard-platform-administration/email-input-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/email-input-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/email-input-dashboard.md

# Email Input

The Email Input module collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

For an overview of this module and how it works, see [Email Input](/features-and-modules/email-input/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Email Input to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Email Input** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Email Input to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Email Input** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

<Accordion title="Expand to view Workflows configuration">
  ![Image of Email Input module configuration in Workflows. Has three configuration options.](https://developer.incode.com/assets/42b195f0d01363a5efb0a14e2125554e.png)
</Accordion>

<Accordion title="Expand to view Flows configuration">
  ![Image of Email Input module configuration in Flows. Has two configurable options.](https://developer.incode.com/assets/7e5b4cf1f93ec44ddd6f6bc4e8d89922.png)
</Accordion>

| Setting                                                     | Description                                                                                                          |
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **_Enable OTP verification_**                               | When enabled, sends a one-time passcode to the user's email address and requires them to enter it before proceeding. |
| **_Expiration duration for OTP (min)_**                     | The number of minutes before an OTP expires. Default: _10_.                                                          |
| **_Skip if email already collected_**<br />_Workflows only_ | When enabled, skips the Email Input module if an email address has already been collected during the session.        |

<br />

---

- Path: `dashboard-platform-administration/external-decision-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/external-decision-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/external-decision-dashboard.md

# External Decision

The External Decision module calls a configured external endpoint and exposes the returned decision value for routing [Conditions](/dashboard-platform-administration/configure-workflow-conditions/).

For an overview of this module and how it works, see [External Decision](/features-and-modules/external-decision/).

## Supported with:

:white_check_mark: Workflows | :x: Flows

## Prerequisites

Before adding the External Decision node to a Workflow, the client must:

- Expose an endpoint that accepts the Incode payload (`sessionId`, `identityId`, `flowId`, `timestamp`) and returns a single `decision` string.
- Secure the endpoint with OAuth 2.0 (client credentials) and issue Incode a Client ID and Client Secret.
- Define the set of `decision` values the endpoint will return (for example, `valid`, `blocked`, `on_hold`). These exact strings are used when configuring routing conditions.

## Add External Decision to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure you have at least one Module node in the builder.
4. From the **Processes** list, drag and drop the **External Decision** module into the builder. Place it after an authentication module only if the decision depends on `identityId`.
5. Click the three dots > **Edit** on the node to open the [Configuration Options](#configuration-options) panel and configure the endpoint, authentication, and routing.

## Configuration Options

After making changes, click **Save configurations** to apply them.

![](https://developer.incode.com/assets/d72df4f6ab085865b64e1c4e5d5e3c3a.png)

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

| Setting                         | Description                                                                                                                                                                                                                                  |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Node Name_**                 | The reference used for this node in routing conditions (for example, _eligibility\_status_). Conditions act on the returned decision string using this name as the reference.                                                                |
| **_Endpoint URL_**              | The client-owned endpoint that Incode calls when the Workflow reaches this node.                                                                                                                                                             |
| **_Client ID_**                 | The identifier the client issues to Incode for the OAuth client-credentials grant.                                                                                                                                                           |
| **_Saved Client Secret_**       | Displays the masked Client Secret currently saved for this node. Read-only. To change the value, enter a new one in **_Replacement Client Secret_**.                                                                                         |
| **_Replacement Client Secret_** | Enter a new Client Secret value here to replace the one currently saved. Use the visibility toggle to ensure your new secret is correct before saving. After you click **Save configurations**, the value is masked.                         |
| **_Authorization URL_**         | The client's OAuth token endpoint. Incode requests an access token from this URL on each execution.                                                                                                                                          |
| **_Scopes_**                    | The OAuth scopes Incode requests when obtaining an access token.                                                                                                                                                                             |
| **_Auth Method_**               | How Incode presents its credentials to the token endpoint. Options are _Client secret basic_ and _Client secret post_.                                                                                                                       |
| **_Custom Headers_**            | Optional static headers that Incode sends as-is on every request to the endpoint (for example, an API gateway key). Add additional key/value pairs using the **+** button.<br />Custom header values are not masked in the configuration UI. |

## Add a Condition

After configuring the module, add [Condition](/dashboard-platform-administration/configure-workflow-conditions/) nodes that act on the returned `decision` string. Reference the node by the **_Node Name_** configured above (for example, `eligibility_status == "valid"`).

Example routing for a status look-up:

- `valid` → continue to the next module
- `blocked` → block access
- `on_hold` → trigger step-up identity verification
- `INCODE_UNRESOLVED` → handle failure (no response within 30 seconds, error, unavailable endpoint, or unmatched value)

Decision string matching is case-sensitive. Returned values must exactly match the strings configured in conditions, or the outcome maps to `INCODE_UNRESOLVED`.

## Observability

A session event is emitted on every execution, capturing the endpoint called, the decision value, the optional `reason` field if returned, and the branch taken. Credentials are never exposed in logs or the flow definition.

<br />

---

- Path: `dashboard-platform-administration/face-authentication-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/face-authentication-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/face-authentication-dashboard.md

# Face Authentication

The Face Authentication module captures a returning user's face with the device camera and matches it against an enrolled face. It then returns a pass or fail result.

For an overview of this module and how it works, see [Face Authentication](/features-and-modules/face-authentication/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Face Authentication to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New**.
3. Add the **Face Authentication** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Face Authentication**.
    - **Classic**: From the Modules list, drag and drop the **Face Authentication** module into the builder.
4. On the module node, you can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** to change specific settings for the module, like using 1:N, setting image quality, or setting a different number of allowed capture attempts. The [Configuration Options](#configuration-options) section below describes all of these settings. The default settings work as designed, so no changes are needed.
5. Add a Condition after the Face Authentication module and configure it:
   1. IF `Face authentication result` `STATUS` `==` `OK`
   2. Select **Yes path** for _Configure what happens with existing steps after condition_.
   3. Click **Save Condition**.
6. Click **Save & Publish**.

## Add Face Authentication to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New**.
3. On the Select Modules tab, find the Face Authentication module and click **Add**.
4. You can click **Details & Configurations** to change specific settings for the module, like using 1:N, setting image quality, or setting a different number of allowed capture attempts. The [Configuration Options](#configuration-options) section below describes all of these settings. The default settings work as designed, so no changes are needed.
5. Click **Save Changes**.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

In New view, the Face Authentication module's configuration panel has three tabs that categorize its settings:

- **Authentication**: Configure how the captured face is matched to an existing identity and how strictly a match is evaluated.
- **Capture options**: Configure the selfie capture experience, including capture behavior and image-quality requirements.
- **Fraud prevention**: Configure liveness and anti-spoofing checks that detect physical spoofs, digital attacks, and face evasion. If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, [Deepsight settings](#deepsight-settings) appear on this tab as well.

#### Authentication

| Setting | Description |
|---|---|
| **_Authentication type_** | Choose whether to compare the captured face with a specific user’s biometric template (_1:1 verification_) or search for a match across enrolled identities (_1:N search_). |
| **_Auto capture timeout (secs)_** | Set how long the system attempts to capture a suitable selfie automatically before allowing manual capture. The default is _25_ seconds. |
| **_Max authentication attempts_** | Set the maximum number of times a user can retry after an unsuccessful authentication attempt. The suggested value is _3_. This number balances fraud detection with user friction. With fewer retries, real users are more likely to get rejected. With more retries, fraudulent faces have more opportunity to slip past. |
| **_Allow authentication after biometric deletion_** | Allow authentication without a stored biometric template by comparing the captured face with a reference selfie submitted through the API. |


#### Capture options

:::info
By default, these settings are configured to Incode's recommendations for successful face authentication. Changing them may weaken session completion, image quality, and fraud protection.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| **_Show face capture tutorial_** | Show instructions that help the user position their face and prepare for capture. |
| **_Lighting check_** | Detect lighting conditions that are too bright or too dark for a suitable face image. |
| **_Closed eyes check_** | Detect whether the user’s eyes are closed in the captured image. |
| **_Hat check_** | Detect whether the user is wearing headwear that may obscure the face or forehead. |
| **_Lenses check_** | Detect whether the user is wearing glasses or other eyewear that may obscure the eyes. |
| **_Mask check_** | Detect whether the user is wearing a face covering that obscures facial features. |
| **_Face obstruction check_** | Detect whether objects, hands, hair, or other obstructions cover important facial features. |
| **_Minimum image quality_** | Require the captured face image to meet a minimum quality threshold before it is accepted. |
| **_Image quality severity_** | Set how strictly the **_Minimum image quality_** requirement is applied: _Ultra Low_, _Low_, _Medium_, _High_, or _Ultra High_. |

#### Fraud prevention

:::info
By default, these settings are configured to Incode's recommendations for successful face authentication. Changing them may weaken session completion, image quality, and fraud protection.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| **_Block reused face images_** | Detect and block attempts that reuse the same face image from enrollment, instead of capturing a new live image. |
| **_Face match_** | Set how strictly the captured face must match the enrolled or submitted reference image: _Low_, _Medium_, or _High_. |
| **_Digital spoof detection_** | Detect manipulated, AI-generated, or digitally injected face images and videos. Choose _Low_, _Medium_, or _High_ severity. |
| **_Liveness evasion detection_** | Detect attempts to evade liveness checks using techniques such as extreme expressions, makeup, or intentional facial distortion. Choose _Low_, _Medium_, or _High_ severity. |
| **_Physical spoof detection_** | Detect physical presentation attacks such as printed photos, screen replays, and 2D or 3D masks. Choose _Low_, _Medium_, or _High_ severity. |

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of Face Authentication configuration panel, with 15 configuration options](https://developer.incode.com/assets/9e83b69e787032525a4648bb5a47530e.png)

</Accordion>

| Setting | Description |
|---|---|
| **_Mode_** | Determines the mode of comparison. Select one:<br />• _1:1_: Compares the authentication selfie against a specific existing user.<br />• _1:N_: Compares the authentication selfie against all the faces in the customer organization and finds the closest match.<br />Default value: _1:1_.|
| **_Number of attempts_** | The maximum number of auto capture attempts Incode will make. As soon as there is a successful attempt, the module ends. Enter a number. Default value: _3_ |
| **_Auto capture timeout (secs)_** | The maximum number of seconds Incode will attempt to auto capture the selfie. After this time, manual capture is required. Enter a number of seconds. Default value: _25_. |
| **_Show face capture tutorial_** | Controls whether the user sees a tutorial on how to capture the best possible selfie. Selected by default. |
| **_Stateless face match_** | When enabled, allows face authentication for users who have deleted their biometric data. The face match process uses the selfie submitted via API instead of a stored template. |
| **_Exact face match check_** | When enabled, compares the selfie captured during authentication against the selfie from the original onboarding session to detect the reuse of identical images. Face recognition scores above a fixed threshold are failed. This setting is disabled by default. |
| **_Face match_** | Controls the severity on the model that does the face matching process. A high threshold is better for security, but a low threshold is better for conversions. Select one: _Lo_, _Me_, or _Hi_. Default value: _Me_. Note that this setting cannot be deselected; it is a crucial part of the authentication process. |
| **_Checks Liveness_** | Controls the severity on the model that performs liveness checks. A high threshold is better for security, but a low threshold is better for conversions. There are three separate Liveness checks:<br />• **_Physical attack_** is selected by default; its default value is _Me_.<br />• **_Digital attack_** is deselected by default; its default value is _Lo_.<br />• **_Evasion attack_** is deselected by default; its default value is _Me_. |
| **_Image quality_** | Checks for the quality of the captured selfie. A high threshold is better for security, but a low threshold is better for conversions. Select an **_Image Quality Severity_**: _Lo_, _Me_, or _Hi_. Default value: _Me_. |
| **_Occlusion check_** | Detects when part of the face in the captured selfie is covered, such as by a hand or another object. When enabled, it checks the received image before face matching; if occlusion is detected, the session’s face-recognition score fails by default, though Flow rules and Workflow conditions can override that result. Select a threshold: _Lo_, _Me_, or _Hi_. Default value: _Me_. |
| **_Lenses validation_** | In the Face Attributes section. Controls whether the system checks if the user is wearing lenses or sunglasses in the selfie. Selected by default. |
| **_Mask validation_** | In the Face Attributes section. Controls whether the system checks if the user is wearing a mask in the selfie. Selected by default. |
| **_Hat validation_** | In the Face Attributes section. Controls whether the system checks if the user is wearing a hat in the selfie. Selected by default. |
| **_Closed eyes validation_** | In the Face Attributes section. Controls whether the system checks if the user's eyes are closed in the selfie. Selected by default. |
| **_Brightness validation_** | In the Face Attributes section. Controls whether the system checks for minimum necessary brightness of the image. Selected by default. |

### Deepsight Settings

If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, the following settings appear in the Face Authentication configuration panel.

| Deepsight Setting | Description |
| --- | --- |
| **_Multi-Modal Intelligence_** | Select one of the following:<br />• _Single frame_: Analyzes one selfie image.<br />• _Single frame + Depth_: Analyzes one selfie image with depth data.<br />• _Single frame + Depth + Video_: Adds recorded video for analysis across multiple frames.<br /> When _Single frame + Depth + Video_ is enabled, you can also enable **_Strict video checks_**. This requires a face to be detected and match the selfie when video is captured; otherwise, the check fails. |
| **_Ignore missing metadata_** | Prevents missing capture metadata from automatically making the Deepsight result unavailable. Recommended for API integrations. ⁠|
| **_In-browser debugger detection_** | Detects when browser inspection tools are open during capture. |
| **_Mocked browser detection_** | Detects when the browser identity appears altered or simulated. |
| **_Motion_** | Checks for natural device movement during selfie capture. |
| **_Monotonic borders_** | Detects uniform-color borders in the selfie that can occur in some injection attempts. |
| **_Detection values deviation_** | Checks for image patterns that may indicate a static or replayed image. |
| **_Camera label check_** | Detects suspicious camera labels that may indicate a virtual camera. |
| **_Camera challenges_** | Checks camera responses to security challenges to help identify virtual or injected camera feeds. |

### Scoring

Every authentication attempt gets its own score.

When Liveness is OFF:

- The numerical score represents the face recognition/match score.
- The face attributes have binary impact on the scoring; if any fail, the attempt fails.

When Liveness is ON:

- The numerical score represents a combination face recognition/match score and the Liveness score.
- The face attributes have binary impact on the scoring; if any fail, the attempt fails.

---

- Path: `dashboard-platform-administration/face-capture-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/face-capture-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/face-capture-dashboard.md

# Face Capture

The Face Capture module captures a user’s face with their device’s camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using [1:1](/get-started-with-incode/glossary/#11-face-authentication) or [1:N](/get-started-with-incode/glossary/#1n-face-authentication) face authentication.

For an overview of this module and how it works, see [Face Capture](/features-and-modules/face-capture/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Face Capture to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New**.
3. Add the **Face Capture** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Face Capture**.
    - **Classic**: From the Modules list, drag and drop the **Face Capture** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Face Capture to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New**.
3. On the **Select Modules** tab, find the **Face Capture** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

Several liveness and validation checks use a threshold scale (Ultra Low, Low, Medium, High, Ultra High) that controls how strictly the check is applied. A lower threshold matches faces with a higher degree of anomalies (more permissive); a higher threshold matches faces with a lower degree of anomalies (more strict).

### Configuration Options: New



In New view, the Face Capture module's configuration panel has two tabs that categorize its settings:

- **Capture Options**: Configure the selfie capture experience, including user guidance, image quality requirements, and capture behavior.
- **Fraud Prevention**: Configure liveness and anti-spoofing checks that detect physical spoofs, digital attacks, and face evasion. If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, [Deepsight settings](#deepsight-settings) appear on this tab as well.

#### Capture Options

:::info
By default, these settings are configured to Incode's recommendations for successful face capture. Changing them may weaken session completion, image quality, and fraud protection.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| **_Concealment style_** | Choose whether an avatar or privacy lens replaces the user’s live camera preview during capture. This does not alter the captured selfie. Select one:<br />• _None_: Shows the user's face normally.<br />• _3D Avatar_: Shows a 3D avatar in place of the user’s face.<br />• _2D Avatar_: Shows a 2D avatar that mirrors the user’s head movements.<br />• _Privacy Lens_: Blurs the capture preview. |
| **_Face capture tutorial_** | Show instructions that help the user position their face and prepare for selfie capture. |
| **_Allow selfie upload from gallery_** | Allow the user to select an existing selfie from their device instead of capturing one with the camera. |
| **_Show face capture preview_** | Let the user review the captured selfie before submitting it or trying again. |
| **_Rear-camera capture mode_** | Use the device’s rear camera for operator-assisted or kiosk capture scenarios. |
| **_Autocapture timeout (secs)_** | Set how long the system attempts to capture a suitable selfie automatically before allowing manual capture. The default is _25_ seconds. |
| **_Max face capture retries_** | Set the maximum number of times the user can retry after an unsuccessful face capture. The suggested value is _3_. This number balances fraud detection with user friction. With less retries, real users are more likely to get rejected. With more retries, fraudulent faces have more opportunity to slip past. |
| **_Minimum image quality_** | Require the captured selfie to meet a minimum quality threshold before it is accepted. |
| **_Severity_** | Set how strictly the minimum image-quality requirement is applied. |
| **_Face obstruction check_** | Detect whether objects, hands, hair, or other obstructions cover important facial features. |
| **_Lenses check_** | Detect whether the user is wearing glasses or other eyewear that may obscure the eyes. |
| **_Mask check_** | Detect whether the user is wearing a face covering that obscures facial features. |
| **_Hat check_** | Detect whether the user is wearing headwear that may obscure the face or forehead. |
| **_Closed eyes check_** | Detect whether the user’s eyes are closed in the captured selfie. |
| **_Lightning check_** | Detect lighting conditions that are too bright or too dark for a suitable selfie. |

#### Fraud Prevention

:::info
By default, these settings are configured to Incode's recommendations for successful face capture. Changing them may weaken session completion, image quality, and fraud protection.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| **_Physical spoof detection_** | Detect physical presentation attacks such as printed photos, screen replays, and 2D or 3D masks. |
| **_Digital spoof detection_** | Detect manipulated, AI-generated, or digitally injected face images and videos. |
| **_Liveness evasion detection_** | Detect attempts to evade liveness checks using techniques such as extreme expressions, makeup, or intentional facial distortion. |
| **_Age estimate from face_** | Estimate the user’s age from the captured face without relying on a date of birth. |
| **_Record face capture_** | Record the face capture process for additional fraud analysis or manual review. |
| **_Allow manual review_** | Allow the face capture and its verification results to be reviewed manually when needed. |
| **_On-Device Processing_** | Run liveness detection and age estimation on the user’s device and submit only the results, without uploading biometric images. |

</Accordion>

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of the Face Capture module configuration panel. Has 21 configuration options](https://developer.incode.com/assets/cd6a624f528a8fb3d1832c65b2844efe.png)

</Accordion>

| Setting                                | Description                                                                                                                                                                                                               |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Concealment style_** | Controls how the user’s face is hidden in the on-screen preview during capture. It changes only the preview—not the image data used for detection. This setting is only compatible with [Web SDK 2.0](/sdk-reference/incode-web-sdk-2-reference). Select one:<br />• _None_: Shows the user's face normally.<br />• _3D Avatar_: Shows a 3D avatar in place of the user’s face.<br />• _2D Avatar_: Shows a 2D avatar that mirrors the user’s head movements.<br />• _Privacy Lens_: Blurs the capture preview. |
| **_Face capture tutorial_**            | When enabled, displays an instructional screen before the capture step to guide the user through the process.                                                                                                             |
| **_Allow selfie upload from gallery_** | Allows users to select a selfie from their device instead of taking one with the live camera. The upload option appears on the Face Capture tutorial screen; it’s disabled by default and can support users who have difficulty completing live capture. <br />Gallery uploads may increase fraud risk because Incode can’t confirm the image came from a live camera or shows a real, present person. |
| **_Show preview_**                     | When enabled, shows the user a preview of the captured face or selfie.                                                                                                                                                    |
| **_Assisted Onboarding_**              | When enabled, allows face capture using the rear camera.                                                                                                                                                                  |
| **_Enable face recording_**            | When enabled, records the face capture session for review purposes.                                                                                                                                                       |
| **_Autocapture timeout (Seconds)_**    | The number of seconds the camera will attempt automatic capture before timing out. Default: _25_. If autocapture does not succeed within this window, the user is prompted to retry or switch to manual capture.          |
| **_Number of image capture attempts_** | The maximum number of times a user can attempt to capture their face before the session ends. Default: _3_.                                                                                                               |
| **_Reliable age estimation check_**    | When enabled, estimates the user's age from the captured selfie and checks it against a minimum age threshold (set in the adjacent "years old" field; default _18_).                                                      |
| **_Physical attack_**<br />(Liveness)  | When enabled, checks the selfie for signs of a physical presentation attack (e.g., printed photo, mask). Threshold sets the strictness of the check.                                                                      |
| **_Digital attack_**<br />(Liveness)   | When enabled, checks the selfie for signs of a digital presentation attack (e.g., a face displayed on a screen). Threshold sets the strictness of the check.                                                              |
| **_Evasion attack_**<br />(Liveness)   | When enabled, checks the selfie for signs that the user is attempting to evade detection (e.g., obscuring or distorting their face). Threshold sets the strictness of the check.                                          |
| **_Image quality_**                    | When enabled, validates that the captured image meets a minimum quality standard. Severity is configured in the **_Image Quality Severity_** dropdown, with options _Ultra Low_, _Low_, _Medium_, _High_, and _Ultra High_. |
| **_Occlusion check_**                  | When enabled, checks whether the user's face is partially obscured in the captured image. Threshold sets the strictness of the check.                                                                                     |
| **_Lenses validation_**                | When enabled, checks whether the user is wearing glasses or contact lenses that may interfere with capture.                                                                                                               |
| **_Mask validation_**                  | When enabled, checks whether the user is wearing a face mask.                                                                                                                                                             |
| **_Hat validation_**                   | When enabled, checks whether the user is wearing a hat or other headwear that may obscure the face.                                                                                                                       |
| **_Closed eyes validation_**           | When enabled, checks whether the user's eyes are closed in the captured image.                                                                                                                                            |
| **_Brightness validation_**            | When enabled, checks whether the image brightness is within an acceptable range.                                                                                                                                          |
| **_Allow manual review_**              | When enabled, sessions that fail face capture after all attempts are routed for manual review instead of being rejected outright.                                                                                         |
| **_On-Device Processing_**             | When enabled, performs face capture processing on the user's device rather than server-side.                                                                                                                              |

### Deepsight Settings

If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, the following settings appear in the Face Capture configuration panel.

| Deepsight Setting | Description |
| --- | --- |
| **_Multi-Modal Intelligence_** | Select one of the following:<br />• _Single frame_: Analyzes one selfie image.<br />• _Single frame + Depth_: Analyzes one selfie image with depth data.<br />• _Single frame + Depth + Video_: Adds recorded video for analysis across multiple frames.<br /> When _Single frame + Depth + Video_ is enabled, you can also enable **_Strict video checks_**. This requires a face to be detected and match the selfie when video is captured; otherwise, the check fails. |
| **_Ignore missing metadata_** | Prevents missing capture metadata from automatically making the Deepsight result unavailable. Recommended for API integrations. ⁠|
| **_In-browser debugger detection_** | Detects when browser inspection tools are open during capture. |
| **_Mocked browser detection_** | Detects when the browser identity appears altered or simulated. |
| **_Motion_** | Checks for natural device movement during selfie capture. |
| **_Monotonic borders_** | Detects uniform-color borders in the selfie that can occur in some injection attempts. |
| **_Detection values deviation_** | Checks for image patterns that may indicate a static or replayed image. |
| **_Camera label check_** | Detects suspicious camera labels that may indicate a virtual camera. |
| **_Camera challenges_** | Checks camera responses to security challenges to help identify virtual or injected camera feeds. |

---

- Path: `dashboard-platform-administration/face-match-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/face-match-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/face-match-dashboard.md

# Face Match

The Face Match module compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a confidence score.

For an overview of this module and how it works, see [Face Match](/features-and-modules/face-match/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Face Match to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **Face Match** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Face Match**.
    - **Classic**: From the Processes list, drag and drop the **Face Match** module into the builder.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Face Match to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Face Match&#x20;**&#x6D;odule and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New



In New view, the Face Match module's configuration panel has three tabs that categorize its settings:

- **Matching options**: Configure which face images are compared and how strictly they must match.
- **Fraud prevention**: Configure checks that detect facial manipulation, identity substitution, and other attempts to deceive face matching.
- **Image integrity**: Check the submitted images for signs that they are outdated, edited, or otherwise unsuitable for face matching.

:::info
By default, these settings are configured to Incode's recommendations for successful face matching. Changing them may weaken your defense against spoof attacks.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

### Matching Options

| Setting | Description |
|---|---|
| **_Compare face image to_** | Select which captured document provides the reference portrait: the _First ID_ or the _Second ID_. |
| **_Matching source_** | Select which reference image the captured face is compared against. |
| **_Skip face match animation_** | Do not show the face comparison animation while the match is processed. |

### Fraud Prevention

| Setting | Description |
|---|---|
| **_Face recognition severity_** | Set how strictly the captured face must match the reference portrait. Higher severity requires greater facial similarity. |
| **_Exact face match_** | Detect when the exact same image is used for both the selfie and reference portrait, which may indicate a spoofing attempt. |

### Image Integrity

| Setting | Description |
|---|---|
| **_Face image edit detection_** | Check the face image’s metadata for signs that it was modified using image-editing software. |
| **_Face image freshness check_** | Check the image’s original capture time and flag it if it is older than the configured limit. |

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of Face Match configuration panel. Has 7 configurable settings](https://developer.incode.com/assets/1e57130a305248d30925364232e91f17.png)

</Accordion>

| Setting                                                                                             | Description                                                                                                                                                                                                                                                                                                              |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Select ID_**<br />_Workflows only_                                                                                     | Specifies which ID in a multi-ID session this module applies to (_First ID_ or _Second ID_). Use this when your Workflow or Flow captures more than one identity document.                                                                                                                                               |
| **_Disable face match animation_**                                                                  | When enabled, suppresses the animation shown to the user during face matching.                                                                                                                                                                                                                                           |
| **_Face Recognition Severity_**                                                                     | Sets the strictness of face recognition matching, with options _Low_, _Medium_, and _High_. A higher severity requires a closer match between the compared faces.                                                                                                                                                        |
| **_Exact face match_**                                                                              | Scans for unusually high similarity between the selfie and ID portrait, suggesting the ID photo may have been reused as the selfie. If it detects an exact match, the check is marked failed. The selected **_Exact Face Match Severity_** controls the impact on the overall face-recognition score:<br />• _Low_ leaves the score unchanged.<br />• _Medium_ reduces it.<br />• _High_ sets it to zero.                                                                                                                                                                                                          |
| **_Face Matching Type_**<br />_Workflows only_                                                                           | The pair of images compared during face matching. Select one:<br />• _Selfie vs. Id Photo_<br />• _Selfie vs. NFC Photo_<br />• _Selfie vs. ID vs. NFC Photo_  |
| **_Check face EXIF for software modification_**                                                     | When enabled, inspects the EXIF metadata of the captured face image for signs that it was modified by editing software.                                                                                                                           |
| **_Check face EXIF field Data Time Original was not older than the time of addition by more than_** | When enabled, checks that the EXIF `DateTimeOriginal` field on the captured face image is no older than the configured number of seconds before submission.                                 |

---

- Path: `dashboard-platform-administration/face-onboarding-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/face-onboarding-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/face-onboarding-dashboard.md

# Face Onboarding

The Face Onboarding module allows a user to begin or resume Onboarding using face recognition, reusing their data from a previous Session with their consent. This reduces friction for returning users.

For an overview of this module and how it works, see [Face Onboarding](/features-and-modules/face-onboarding/).

## Supported with:

:x: Workflows | :white_check_mark: Flows

## Add Face Onboarding to Flows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Face Onboarding** module and click **Add**.

## Configuration Options

Face Onboarding has no configurable settings.

![Image of Face Onboarding module configuration in Flows. Has no configurable options.](https://developer.incode.com/assets/fe95f870509bae9f5581d500fcaff8e1.png)

<br />

---

- Path: `dashboard-platform-administration/field-comparison-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/field-comparison-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/field-comparison-dashboard.md

# Field Comparison

The Field Comparison module compares fields from different sources, such as OCR data extracted from an ID and information entered by the user, to verify they match. It supports branching, so you can route users down separate paths depending on whether the comparison passes or fails.

For an overview of this module and how it works, see [Field Comparison](/features-and-modules/field-comparison-1/).

## Supported with:

:x: Workflows | :white_check_mark: Flows

## Add Field Comparison to Flows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Field Comparison** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

Field Comparison has no configurable settings.

![Image of Field Comparison module configuration in Flows. Has no configurable options.](https://developer.incode.com/assets/9988a3c89f6d0273f76418b13e83bca1.png)

---

- Path: `dashboard-platform-administration/fiscal-qr-ocr-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/fiscal-qr-ocr-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/fiscal-qr-ocr-dashboard.md

# Fiscal QR OCR

The Fiscal QR OCR module scans the QR code on a Constancia de Situación Fiscal, the SAT tax document issued in Mexico, and extracts the associated fiscal data.

For an overview of this module and how it works, see [Fiscal QR OCR](/features-and-modules/fiscal-qr-ocr/).

## Supported with:

:x: Workflows | :white_check_mark: Flows

## Add Fiscal QR OCR to Flows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Fiscal QR OCR** module and click **Add**.

## Configuration Options

This module has no configurable settings.

![Image of Fiscal QR OCR module configuration in Flows. Has no configurable options.](https://developer.incode.com/assets/dc6aab7d5825c0dc9c9c3dd6af5a046a.png)

<br />

---

- Path: `dashboard-platform-administration/flows-1`
- URL: https://developer.incode.com/dashboard-platform-administration/flows-1/
- Markdown: https://developer.incode.com/dashboard-platform-administration/flows-1.md

# Configure Flows

Flows are the legacy way to build reusable, linear identity verification journeys. They run modules in a fixed order without conditional logic or branching. We recommend [Workflows](/dashboard-platform-administration/workflows-20/) for all new implementations. Flows remains fully supported, but new capabilities are being built on Workflows.

Flows are created and configured in Dashboard. In the left menu, click **Flow Builder** > **Flows**.


<Image src="https://developer.incode.com/assets/4fc6725b-bc5f-460b-b3e5-665c245bf18c.png" alt="The Flows page in Dashboard, showing a table with the names and statuses of Flows." align="center" />


On this page, you can:

- Search the list of Flows
- [Create](#create-flows) or [import](#import-flows) new Flows
- [View Sessions](#view-sessions-for-a-flow) that used a Flow
- [Copy a Flow URL or ID](#other-flow-actions)
- [Edit](#other-flow-actions) a Flow
- [View a list of modules](#other-flow-actions) in a Flow
- [Pause](#other-flow-actions) a Flow
- [Download the Flow configuration](#other-flow-actions)
- [Delete](#other-flow-actions) a Flow

## Create Flows

1. In the left menu, click **Flow Builder** >**Flows**.

2. Click **New**.

3. In the top left, click **Edit**. Enter a name for the Flow and click **Save**.

4. On the Select Modules tab, browse or search for a module you want to add. Hovering over the module name and click **Add**.


   <Image src="https://developer.incode.com/assets/e6e33bda45286187fe7fe303cd127b13.png" alt="The cursor hovers over the ID Capture module, and the Add option appears." align="left" />


5. Hover over the module name and click **Details & Configurations** to open the configuration panel. Each module has its own settings. You can leave the default settings or customize them to meet your needs. Documentation for individual module settings is in progress.

6. Continue adding and configuring modules to complete the Flow. Use the Flow Preview on the right to confirm the modules you added. Hover over module names to edit configurations or remove modules.


   <Image src="https://developer.incode.com/assets/946e4b0c691c802e3090c50463b2c94c.png" alt="The cursor hovers over ID Capture in the Flow Preview, and options to edit or remove the module appear." align="left" />


### Flow Settings
On the Settings tab, you can customize settings to meet your needs. The default settings work for most cases.
   1. If your system is configured with [Deepsight](/features-and-modules/deepsight/), you can enable them for the Flow. Separate licensing is required for each. Contact your Incode Representative for more information.
   2. Customize the Session Results settings.
      
        | Setting                           | Description                                                                                                                                                                                                               |
        | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
        | **Identity creation**             |                                                                                                                                                                                                                           |
        | Session Score: Pass               | If the session ends with Pass, you can **Approve** Identity creation or **Send to manual review**. Click **Reset All** to remove a selection.                                                                             |
        | Session Score: Warn               | If the session ends with Warn, you can **Approve** Identity creation, **Send to manual review**, or **Fail** Identity creation. Click **Reset All** to remove a selection.                                                |
        | Session Score: Failed             | If the session ends with Failed, you can **Send to manual review** or **Fail** Identity creation. Click **Reset All** to remove a selection.                                                                             |
        | **Session completion** *Optional* |                                                                                                                                                                                                                           |
        | Mark Verification as Finished On  | Use this drop-down to define which milestone ends the Session. You can select from the following options: **ID Validation Finished**, **Face Validation Finished**, **EKYC Validation Finished**, or **Government Validation Finished** |
      
   3. Customize the User Experience settings.
      
        | Setting                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Default |
        | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
        | **Getting Started**                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |         |
        | Skip intro screen                             | Sends users directly to verification steps, skipping the launch screen.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Off     |
        | Create Flow template for Onboarding Optimizer | Automatically generates a reusable template based on this Flow to optimize future setups.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Off     |
        | Phishing Resistance                           | Protects against man-in-the-middle phishing attacks using dynamic QR codes and device-session binding. Also enables **Redirect Desktop attempts to Mobile** and its sub-setting **Disable SMS option**.                                                                                                                                                                                                                                                                                                                                                                                                                              | Off     |
        | OAuth2 Secured (web only)                     | Strengthens the security of the user journey against replay attacks with [OAuth2 security protocol](/general-reference/oauth2-secured-sessions/). A **Redirect URL** is required when this setting is enabled. The OAuth clientid is saved in the configuration settings for future reference.                                                                                                                                                                                                                                                                                                                                     | Off     |
        | Redirect Desktop attempts to Mobile           | Redirects users who start the Flow on desktop to continue on their mobile device. You can configure the following sub-settings: **Allow "continue on desktop"** (shows users the option to continue on desktop); **Redirect origin only** (redirects users only at the starting point of the Flow; once they switch to mobile, the Flow ends there); **Display result on desktop** (shows the verification result on the original desktop tab after the mobile Flow completes); **Disable SMS option** (removes the SMS option and shows only the QR code to transfer the Flow to mobile). | Off     |
        | In person or assisted Onboarding              | Indicates that Sessions using this Flow will happen in person or in branch.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Off     |
        | Hide unsupported browser screen               |Lets users continue with any browser. Only Chrome and Safari are officially supported.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Off     |
        | **After Verification**                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |         |
        | Redirect URL                                  | The URL users are sent to after completing the onboarding Session. This field is required if **OAuth2 Secured (web only)** is enabled.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |         |
        | **Session Control**                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |         |
        | Mark Session as "Expired"                     | Labels Sessions as expired in Dashboard after the specified time of inactivity. Enter the number of minutes before a Session is marked expired.                                                                                                                                                                                                                                                                                                                                                                                                                   | Off     |
        | Allow multiple Onboarding completions         |Allows users to complete the onboarding Flow more than once.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Off     |
      
   4. Customize the Compliance & Privacy settings.
      
        | Setting                     | Description                                                                                                             | Default |
        | --------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------- |
        | **Age Verification**        |                                                                                                                         |         |
        | Enhanced privacy protection | Shows a privacy-adjusted tutorial. Incode doesn't save any personally identifiable information (PII) except date of birth.                | Off     |
        | **Compliance**              |                                                                                                                         |         |
        | Require biometric consent   | Shows required consent before biometric capture for users in applicable U.S. states.                           | Off     |
        | Save verification videos    | Merges ID and Face Capture recordings into a single video and stores it with the Session data for audit purposes. | Off     |
      
   5. Customize [Cross Checks](/dashboard-platform-administration/cross-check-dashboard/#add-cross-check-to-flows).
   6. Customize Verification Rules.

8. Click **Save Changes**.

## Import Flows

1. In the left menu, click **Flow Builder** >**Flows**.

2. Click **Import**.


   <Image src="https://developer.incode.com/assets/34335e76655f6ecda5e676ae5a0a688c.png" alt="The Select Flow Configuration File field appears." align="left" />


3. Click **Select Flow Configuration File** and browse to the JSON file on your device.

4. Click **Import**.

## View Sessions for a Flow

1. In the left menu, click **Flow Builder** >**Flows**.
2. Browse or search for the Flow you want.
3. Click **Open Sessions**. You are redirected to the Sessions page, filtered to show only Sessions that used that Flow.

## Other Flow Actions

1. In the left menu, click **Flow Builder** >**Flows**.
2. Browse or search for the Flow you want.
3. Select from the available options:


   <Image src="https://developer.incode.com/assets/fbcb31fff28be696cc590599d91a3ecd.png" alt="Copy Flow URL is an icon of a link; Edit is an icon of a pencil." align="left" />


   - **Copy Flow URL**: Copies the URL needed to start the Flow.
   - **Edit**: Opens the Flow for editing.
   - **Copy Flow ID**: Copies the unique identifier for the Flow.
   - **View Modules**: Hover over this option to see list of modules used in the Flow.
4. Click **Actions&#x20;**&#x66;or more options:


   <Image src="https://developer.incode.com/assets/d7b61223f4197855e0700f13692e13ca.png" alt="There are six more options in the Actions menu." align="left" />


   - **Pause Flow**: Prevents the Flow from being used in Onboarding. When a Flow is paused, the menu displays **Activate Flow** instead.
   - **Download Flow Configuration**: Downloads a JSON file of the Flow configuration.
   - **Copy Embed Code**: Copies the iFrame for the Flow to your clipboard.
   - **See Log**: Opens a panel showing the change history for the Flow. You can select a date range or view all history.
   - **Duplicate**: Makes a copy of the Flow.
   - **Delete Flow**: Permanently deletes the Flow. This cannot be undone. In the confirmation dialog, click **Confirm**.

<br />

---

- Path: `dashboard-platform-administration/forms-and-data-entry-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/forms-and-data-entry-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/forms-and-data-entry-dashboard.md

# Forms and Data Entry

The Forms and Data Entry module presents one or more custom form screens to collect information from a user. You define the questions, their input types, and whether each is required or optional. In Workflows, form responses can be used as [conditions](/dashboard-platform-administration/configure-workflow-conditions/) to route users to different steps based on their answers.

For an overview of this module and how it works, see [Forms and Data Entry](/features-and-modules/forms-and-data-entry/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Forms and Data Entry to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Forms and Data Entry** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Forms and Data Entry to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Forms and Data Entry** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

Each form is made up of one or more pages. Use the numbered page tabs to switch between pages. Click the plus sign (+) to add a new page. Each page has a different title and can contain one or more questions.

![Image of the Forms and Data Entry module's configuration panel. Has two configuration options, plus the option to add a new question.](https://developer.incode.com/assets/257fddd1d3d31da29f44fcbdef51e717.png)

### Title

| Setting          | Description                                                                                                            |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **_Title_**      | The title displayed at the top of the form page. Enter the text you want users to see or leave blank to show no title. |
| **_Hide title_** | When enabled, hides the title from the form page even if a title is configured.                                        |

### Questions

<Accordion title="View image of configurable options for pre-defined questions">
  ![When Pre-defined is selected, options for Select a question, Input type, and Make optional appear.](https://developer.incode.com/assets/bbb2096b392bf48ff6016a1bdf4daa9d.png)
</Accordion>

<Accordion title="View image of configurable options for customized questions">
  ![When Customized is selected, options for Enter question, Input, and Make optional appear.](https://developer.incode.com/assets/593ccd98623f5fb880695cbe5bb7efca.png)
</Accordion>

To add a question, click **New question**. The following settings are available for each question.


| Setting | Description |
|---|---|
| **_Pre-defined_** / **_Customized_** | Determines whether the question uses a pre-defined template or a custom configuration. Select **_Pre-defined_** to choose from a set of common questions with the question text and input type already set. Select **_Customized_** to write your own question text and select the input type manually. |
| **_Select a question_**<br />_Pre-defined only_ | The pre-defined question to add to the form. Choose from the available options in the dropdown: _ID number, Country of residence, Nationality, Date of birth, Phone number, Email address, CPF, Full name, First name, or Last name_. The **_Input type_** is set automatically based on the selected question and cannot be changed. |
| **_Enter Question_**<br />_Customized only_ | The custom question text to display to the user. Allows you to manually change the **_Input type_**. |
| **_Input type_** | The type of input field presented to the user. When using a pre-defined question, this field is read-only. When using a customized question, select the type that matches the data you want to collect:<br />• _Text_: Free-form text input.<br />• _Number_: Numeric input.<br />• _Date_: Date input in DD/MM/YYYY format. Responses are stored as milliseconds since the Unix epoch (UTC).<br />• _Country_: A searchable drop-down showing full country names. Responses are stored as ISO 3166-1 alpha-3 codes: for example, _USA_ and _GBR_.<br />• _Phone_: Phone number input.<br />• _Email_: Email address input with format validation.<br />• _CPF_: Document number input formatted for Brazilian Cadastro de Pessoas Físicas (CPF) numbers.<br />• _Yes or No_: A toggle or drop-down for Boolean responses.<br />• _Select_: A drop-down for single selection from a defined list of options. |
| **_Make optional_** | When enabled, the question is optional and users can proceed without answering it. When disabled, the question is required and **Continue** remains inactive until the user provides a valid response. |

Click **Save** after configuring each question. After saving multiple questions, you can drag and drop to reorder them. Click the three dots next to a saved question to edit or delete it.

<Callout icon="📘" theme="info">
  ### Tip

  **Only ask for what you need**. Every question adds friction and creates privacy obligations. Remove any question that isn't required for compliance, the user journey, or downstream processing.
</Callout>

---

- Path: `dashboard-platform-administration/forward-data-to-your-workflow`
- URL: https://developer.incode.com/dashboard-platform-administration/forward-data-to-your-workflow/
- Markdown: https://developer.incode.com/dashboard-platform-administration/forward-data-to-your-workflow.md

# Forward Data to Your Workflow

You can forward custom data when initializing your integrated Workflows. This option is available when the Workflow is initialized on your side via the `/omni/start` endpoint.

***

## Custom Fields

The `/omni/start` endpoint accepts a key-value map in the `customFields` parameter. To define these key-value pairs, go to **Configuration** > **General** > **Custom Fields**.


<Image src="https://developer.incode.com/assets/8eabaa50ce224b78b634c2f3cd2369a2.png" alt="Define custom fields in Configuration > General." align="center" />


Custom fields appear on the single session view.

***

## Use Cases

The two most common ways to use custom fields are crosschecking collected data and passing internal identifiers.

### Crosscheck Data

If you already have a user's first and last name in your system, you can use that data to confirm that the person completing verification matches the existing user. To do this, set up a crosscheck between the data from the ID and the data in your system.

1. Add a Process node to your Workflow and select **Cross Check** from the drop-down.


<Image src="https://developer.incode.com/assets/6eab7d0abe0d4a482e1244cc14225157.png" alt="Add Cross Check node to Workflow." align="center" width="200px" />


2. Configure the Cross Check node:
   1. Click **Add New Comparison**.
   2. Enter a **_CrossCheck Name_**. Do not include special characters.
   3. Use the drop-downs to select sources and fields to compare. One source should be _CUSTOM\_FIELDS_ and the other is usually _ID_.
   4. Set the **Comparison Severity**. This determines the minimum match level required to pass.
   5. Click **Save Comparison**.
   6. Add more comparisons to the same Cross Check node as needed or return to the Workflow.


<Image src="https://developer.incode.com/assets/775d81c872b863a13855ba8d87444af5.png" alt="Click Add New Comparison to add the Cross Check node." align="center" width="400px" caption="Add new comparison" />



<Image src="https://developer.incode.com/assets/88747b8a405c6aa6994452542bd5cea7.png" alt="The configurable sources and fields for the Cross Check node." align="center" width="400px" />


3. Add a [Condition](/concepts-and-architecture/conditions-for-workflows-20/) to set the Yes and No paths after the Cross Check node. For example, if you are checking that first names match, configure the Condition so that a matching first name returns OK.


<Image src="https://developer.incode.com/assets/ded8ea10f53d91da923c0181ff0823ce.png" alt="First Name crosscheck comparison must equal OK." align="center" width="500px" caption="Use crosscheck in conditions" />


### Pass Internal Identifiers, Tags, and Markers

Internal identifiers, tags, and markers distinguish different Sessions or connect with internal systems.

#### External Customer ID

To connect an Incode Session with your own Session, use the `externalCustomerId` parameter. This is an optional string parameter in the `omni/start` call.

#### Configuration ID

This is the ID of the Workflow the user will go through. To find it, go to the Workflows page in Dashboard, find the Workflow you want, and click **...** > **Copy ID** in the Actions column.


<Image src="https://developer.incode.com/assets/7c9846b13c859ffb2ad213ccfd0e30c1.png" alt="Copy ID is listed third in the Actions column." align="center" width="150px" />


#### Redirect URL

Override the **_Redirect URL_** from a Workflow's settings to redirect per user or group. Use the format: `https://your.url`.

---

- Path: `dashboard-platform-administration/geolocation-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/geolocation-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/geolocation-dashboard.md

# Geolocation

The Geolocation module requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city.

For an overview of this module and how it works, see [Geolocation](/features-and-modules/geolocation-2/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Geolocation to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Geolocation** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Geolocation to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Geolocation** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![Image of the Geolocation module's configuration panel. Has one configuration option.](https://developer.incode.com/assets/8751a1b240a879dd89c257ddde9c3112.png)

### General

| Setting                              | Description                                                                                                 |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| **_Allow user to skip geolocation_** | When enabled, users can skip geolocation. Enable this option to reduce drop-off when users deny permission. |

<br />

---

- Path: `dashboard-platform-administration/government-record-verification-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/government-record-verification-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/government-record-verification-dashboard.md

# Government Record Verification

The Government Record Verification module verifies a person's identity by comparing identity attributes and, where supported, a live selfie against government-held records, producing a match or no-match outcome.

For an overview of this module and how it works, see [Government Record Verification](/features-and-modules/government-record-verification/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Government Record Verification to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the **Processes** list, drag and drop the **Government Record Verification** module into the builder.
4. <Pill type="beta" /> Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Government Record Verification**.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Government Record Verification to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Government Record Verification** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

<Component slug="standard-vs-beta-callout" />

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![](https://developer.incode.com/assets/6a46cf98-1704-4ac3-a5cc-b5a64ac56dc8.png)

| Setting | Description |
| --- | --- |
| **_Validation Countries_** | The countries for which government verification is performed. Select one or more countries from the drop-down menu. Verification will only run for documents issued by the selected countries. If the country you need is not available, contact your Incode representative. |
| **_Data Validation_** | Compares identity attributes extracted from the ID, such as name and date of birth, against the government record for the selected country. |
| **_Facial Validation_** | Compares the live selfie biometric against the government portrait for the selected country. |
| **_Face and Data_** | Performs a biometric comparison of the user's selfie against the photo in the government record alongside identity attribute matching. |
| **_Use Cropped Id Face Photo_** | Only relevant for USA. When selected, the verification uses the photo captured from the front of the ID for biometric comparison instead of a live selfie. |
| **_Face Match Override Data Score_** | Prioritizes the result of the face match check over the data verification score when determining the overall outcome. |
| **_Fingerprint Validation_** | Only relevant for Mexico. The minimum number of fingerprints that must match for the fingerprint validation check to pass. Default: 1. See [INE Fingerprint Validation](/features-and-modules/ine-fingerprint-validation/) for more details. |
| **_Fingerprint Match Override Score_** | Only relevant for Mexico. Prioritizes the result of the fingerprint match check over other scores when determining the overall outcome. See [INE Fingerprint Validation](/features-and-modules/ine-fingerprint-validation/) for more details. |
| **_Auto Execution_** | The verification check runs automatically when the Flow or Workflow reaches this module. |

## <Pill type="beta" /> Beta Configuration Options

<Component slug="standard-vs-beta-callout" />

<Accordion title="Expand to view Beta configuration options">

This section describes the configurable settings for the Government Record Verification module. To access them, click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** next to the Government Record Verification module.

![Government Record Verification configuration (Beta)](https://developer.incode.com/assets/2b509172-c230-4113-be8d-10fc3399be23.png)

| Setting | Description |
|---|---|
| **_Validation countries_** | Select the countries this module validates documents from. Then select the [checks](#checks) the module performs. _Argentina_, _Dominican_Republic_, _Ghana_, and _India_ do not have checks available. |

### Checks

| Check | Description | Countries |
|---|---|---|
| **_Facial validation_** | Compare the user’s captured face against the facial record held by the government source. | Brazil, Nigeria |
| **_Data validation_** | Compare identity information extracted from the document against data held by an authoritative government source. | Australia, Bolivia, Colombia, Nigeria, Peru, Philippines, USA |
| **_Face and data validation_** | Validate the user’s face and identity information together against the government source. | Mexico |
| **_Address validation_** | Compare the address submitted or extracted from the document against the address held by the government source. | USA |
| **_Face match score overrides data match score_** | Allow the government face-match result to override the data-match result when determining the overall validation outcome. | Mexico |
| **_Run automatically_** | Automatically run the module when the session is completed, without requiring a separate API request from the customer’s integration | Australia, Bolivia, Brazil, Colombia, Mexico, Nigeria, Peru, Philippines, USA |
| **_Fingerprint validation_** | Compare captured fingerprints against biometric records held by the government source. | Mexico |
| **_Minimum passing fingerprints_** | Specify the number of fingerprints that must match for this check to pass. | Mexico |
| **_Fingerprint match score overrides data match score_** | Allow the fingerprint match result to override the data-match result when determining the overall validation outcome. | Mexico |

</Accordion>

---

- Path: `dashboard-platform-administration/id-capture-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/id-capture-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/id-capture-dashboard.md

# ID Capture

The ID Capture module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. It also allows users to submit a digital ID they already have saved in their device's wallet (such as Apple or Google Wallet).

For an overview of this module and how it works, see [ID Capture](/features-and-modules/id-capture/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add ID Capture to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **ID Capture** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **ID Capture**.
    - **Classic**: From the Modules list, drag and drop the **ID Capture** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add ID Capture to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **ID Capture** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options



This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

In New view, the ID Capture module's configuration panel has four tabs that categorize its settings:

- **Documents & countries**: Choose which identity documents the module accepts, such as passports and driver's licenses. Set the defaults for all countries, then override them for specific countries and document types.
- **Capture options**: Customize the standard capture experience with elements such as tutorials, automatic capture, and ID-detection timeouts. Enable alternative capture methods, including supported digital ID options.
- **Fraud prevention**: Configure safeguards against fraud. If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, [Deepsight settings](#deepsight-settings) appear on this tab as well.
- **Exceptions**: Handle less common capture requirements and special cases.

Some capture settings must be configured by your Incode representative.

#### Documents & Countries

| Setting | Description |
|---|---|
| ***Accept digital IDs*** | Allow users to verify their identity using a supported government-issued digital ID stored in a device wallet. Enable the method, such as _Apple Wallet_ or _Google Wallet_, then click **View Details** to choose which data points to collect, such as _Given name_ and _Date of birth_. Click **Done** when you've finished enabling and configuring methods. |
| ***Allow digital ID upload*** | Allow users to upload a supported PDF or image of a digital ID, such as a document downloaded from or a screenshot taken in an official government app. |
| ***National IDs*** | Choose the government-issued documents to allow as primary proof of identity: _Drivers License_, _Identification Card_, _Voter Identification_, _Federal ID_, and _Passport_.\*  |
| ***Residency & immigration*** | Accept documents that confirm a person’s residency or immigration status: _Residence Document_, _Travel Document_, and _Visa_.\* |
| ***Permits & licenses*** | Accept government-issued documents granting permission or authorization: _Permit_, _Weapon License_, _Tax Identification_, and _Vehicle Registration_.\* |
| ***Other documents*** | Accept additional supported document types: _Birth Certificate_, _Medical Card_, _Currency_, _Military_, _Tribal Identification_, _Other_, and _Unknown_.\* <br> _Other_ documents are recognized, supported types that Incode deliberately does not classify because they do not fit the processing rules of other classifications. _Unknown_ documents are those the system cannot classify against a supported document template. |

\* Click **Settings** ![Icon of a gear](https://developer.incode.com/assets/9773abfa-00c4-44b2-8a55-379ed8310adc.png#inline) next to each document you enable to specify if the ID should be accepted from _All countries_ or _Specific countries_. If you select _Specific countries_, add countries and click **Add selected**. Then, in the drop-down for each country, enable the document checks you want to run:

| Check | Description |
|---|---|
| *Disable ID alignment correction* | Disable automatic correction of the document’s alignment before processing. Use this when the captured image should be processed in its original orientation. |
| *US barcode classification* | Check that the barcode on the back of a US identity document has the expected format and can be read correctly. The capture fails if the barcode is invalid or unreadable. |
| *Allow manual review* | Send the session for manual review if the document cannot be captured successfully within the allowed number of attempts. |
| *Front side only* | Capture and process only the front of the document without asking the user to capture the back. |
| *Back side only* | Capture only the back or barcode side of the document, typically for barcode-based data extraction. |
| *Capture additional page* | Allow the user to capture an optional additional page when relevant information appears elsewhere in the document. |

#### Capture Options

:::info
By default, these settings are configured to Incode's recommendations for successful ID capture. Changing them may weaken session completion, image quality, and fraud protection.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| ***Document type selector*** | Show a screen where users select the type of document they want to capture, such as an identity card or passport. |
| ***Capture tutorial*** | Show instructions before capture to help users position their document and take a suitable image. |
| ***Document sides*** | Choose which sides of the document the user must capture: _Both sides_, _Front only_, or _Back only_. |
| ***Require date of birth*** | Require the date of birth to be extracted from the document. If it is not found on the front, the user is prompted to capture the back—even when front-only capture is configured. |
| ***Capture attempts*** | Set the number of attempts the user has to capture the document successfully before the capture ends or follows the configured failure path. The suggested value is _3_. This number balances capture success with user friction. With fewer attempts, a valid document may fail because of glare or poor alignment. With more attempts, users are more likely to grow frustrated and drop off. |
| ***Allow a second ID*** | Ask the user to capture a second identity document during the same verification. To ask for a second ID if the first one fails verification, use [Workflow conditions](/dashboard-platform-administration/configure-workflow-conditions/), not this setting. |
| ***Autocapture timeout*** | Set how long the system waits after detecting the document for it to meet the automatic-capture requirements before offering manual capture. |
| ***ID detection timeout*** | Set how long the system waits to detect a document in the camera view before offering manual capture. |

#### Fraud Prevention

| Setting | Description |
|---|---|
| ***Record ID capture*** | Record video during the ID capture process for later review and fraud analysis. This is a separately licensed feature that must be enabled for your organization. |
| ***Allow manual review*** | Send the session for review by an authorized agent when the document cannot be captured successfully within the allowed number of attempts. If disabled, the session follows the configured failure path instead. |

#### Exceptions


| Setting | Description |
|---|---|
| ***Allow a third ID*** | Ask the user to capture a third identity document during the same verification. It is an additional required capture, not a fallback triggered by an earlier ID failing. That can be set using [Workflow conditions](/dashboard-platform-administration/configure-workflow-conditions/). |
| ***Force back side capture on front failure*** | Continue to the back-side capture when the front cannot be captured or classified successfully, allowing the back to provide additional document or barcode information. |
| ***Optional ID page capture*** | Give the user the option to capture an additional document page when relevant information appears on another page, such as the address page of a passport. |
| ***US barcode capture (DMV face match)*** | Enable a guided capture experience optimized for scanning the barcode on US identity documents. This option is available when DMV Face Match is enabled. |
| ***Add watermark to cropped ID*** | Apply a visible watermark to the processed, cropped document image to reduce the risk of unauthorized reuse or reproduction and support local compliance requirements. |
| ***Compliance redaction*** | Redact selected personal data fields from captured document images for supported countries and document types to meet privacy or regulatory requirements. Select a _Country_, then a _State_ if applicable, then a _Document type_, then a _Document subtype_ and _Issuing year_. Finally, select the fields to be redacted. Click **Add country** to repeat. |

### Configuration Options: Classic

In Classic view, the ID Capture module's configuration panel has two tabs that categorize its settings: [General](#general) and [Redaction](#redaction). If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, [Deepsight settings](#deepsight-settings) appear on the General tab as well.

#### General

<Accordion title="View image of Workflow configuration panel">
  ![Image of ID Capture module configuration panel in Workflows. Has many configurable settings.](https://developer.incode.com/assets/829734a0e9b1240a86269fd3c0fa190d.png)
</Accordion>

<Accordion title="View image of Flow configuration panel">
  ![Image of ID Capture module configuration panel in Flows. Has many configurable settings.](https://developer.incode.com/assets/220fe6b4caddcc7da9fe9d29f33822f4.png)
</Accordion>


| Setting                                          | Description                                                                                                                                                                                                                                                                                                        |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Set country specific_**                       | Restricts accepted document types to those issued by a specific country. Enable this when your use case requires country-level document validation.                                                                                                                                                                |
| **_Manage digital IDs_**          | Opens a modal that allows you to select acceptable digital IDs for this Flow or Workflow; see [Manage digital IDs](#manage-digital-ids) below for instructions. This allows users to verify their identity using a digital ID stored in their device wallet (such as Apple Wallet or Google Wallet) as an alternative to camera capture. See [Digital ID Verification](/features-and-modules/digital-id-verification/) and [Supported Digital IDs](/general-reference/supported-digital-ids/) for more information about this capability. |
| **_Accepted Documents_**                         | The document types that users can present for ID capture. Select one or more from the available options (_Drivers License_, _Passport_, _Federal ID_). Only the selected document types will be accepted during the capture flow.                                                                            |
| **_Select ID_**<br />_Workflows only_            | Specifies which ID in a multi-ID session this module applies to (_First ID_ or _Second ID_). Use this when your Workflow captures more than one identity document.                                                                                                                                                 |
| **_Show document chooser screen_**               | When enabled, displays a screen prompting the user to select their document type before capture begins. Recommended when multiple document types are accepted.                                                                                                                                                     |
| **_ID capture tutorial_**                        | When enabled, displays an instructional screen before the capture step to guide the user through the process.                                                                                                                                                                                                      |
| **_Second ID_**<br />_Flows only_                | When enabled, designates this ID Capture module as the second ID in a multi-ID session. Use this when your Flow captures more than one identity document.                                                                                                                                                          |
| **_Third ID_**<br />_Flows only_                 | When enabled, designates this ID Capture module as the third ID in a multi-ID session. Use this when your Flow captures more than two identity documents.                                                                                                                                                          |
| **_Enable ID recording_**                        | When enabled, records the ID capture session for review purposes.                                                                                                                                                                                                                                                  |
| **_Only Front Capture Id_**                      | When enabled, captures only the front of the ID, skipping the back. Use this for document types that do not require a back-side scan.                                                                                                                                                                              |
| **_Back Id Only (barcode)_**                     | When enabled, captures only the back of the ID and reads the barcode. Use this when only barcode data from the back of the ID is required.                                                                                                                                                                         |
| **_Barcode Capture_**                            | When enabled, activates barcode scanning during ID capture.                                                                                                                                                                                                                                                        |
| **_US Smart Capture_**                           | When enabled, uses enhanced capture logic optimized for US-issued identity documents.                                                                                                                                                                                                                              |
| **_Unordered ID Capture_**                       | When enabled, allows the front and back of the ID to be captured in any order, rather than requiring front first.                                                                                                                                                                                                  |
| **_Always capture back of ID_**                  | When enabled, always requires capture of the back of the ID, regardless of document type.                                                                                                                                                                                                                          |
| **_Do not redact unknown images._**                  | When enabled, images that are not recognized are not redacted.                                                                                                                                                                                                                          |
| **_Require date of birth_**                      | When enabled, users will be prompted to scan the back of their ID if date of birth is not detected on the front side. This applies even when the flow is configured as front-only capture, and ensures date of birth is always extracted regardless of document template.                                          |
| **_Add watermark to cropped ID_**                  | When enabled, watermark text is added to cropped ID images to indicate they have been processed.                                                                                                                                                                                                                          |
| **_Capture optional ID page_**                   | When enabled, prompts the user to capture an additional optional page of the ID, such as a visa page.                                                                                                                                                                                                               |
| **_Disable Alignment Classification_**           | When enabled, turns off alignment classification during capture, which checks that the ID is properly aligned before accepting the image. Disabling this may speed up capture but can reduce image quality.                                                                                                        |
| **_US Barcode Classification_**                  | When enabled, uses barcode classification logic specific to US-issued documents.                                                                                                                                                                                                                                   |
| **_Allow manual review_**<br />_Flows only_      | Sends the session to a human reviewer if the ID isn’t captured successfully within the configured attempts. The reviewer can inspect the session and decide whether to approve or reject it.                                                                                                                                                                            |
| **_Enable Digital ID upload_**                   | When enabled, allows users to submit a digital ID file as an alternative to live camera capture. See [Supported Digital IDs](/general-reference/supported-digital-ids/) for supported schemes by region.                                                                                                                         |
| **_Autocapture timeout (Seconds)_**              | The number of seconds the camera will attempt automatic capture before timing out. Default: _25_. If autocapture does not succeed within this window, the user is prompted to retry or switch to manual capture.                                                                                                   |
| **_ID Detection Timeout (Seconds)_**             | The number of seconds the system will attempt to detect an ID in the camera frame before timing out. Default: _60_.                                                                                                                                                                                                |
| **_Onboarding flow attempts_**<br />_Flows only_ | The number of onboarding attempts after which the user drops off. Default: _0_.                                                                           |
| **_Number of image capture attempts_**           | The maximum number of times a user can attempt to capture their ID before the session ends. Default: _3_.                                                                                                                                                                                                          |

##### Manage Digital IDs

This modal allows you to select acceptable digital IDs for this flow. This allows users to verify their identity using a digital ID stored in their device wallet (such as Apple Wallet or Google Wallet) as an alternative to camera capture. See [Digital ID Verification](/features-and-modules/digital-id-verification/) and [Supported Digital IDs](/general-reference/supported-digital-ids/) for more information about this capability.

Click **Manage digital IDs** to open the following modal:



<Accordion title="Expand to view image">

![The Digital ID Acceptance modal, allowing you to select different device wallets acceptable for the flow.](https://developer.incode.com/assets/3da8d40f-6740-4b0e-9e1a-d35eb85d3a18.png)

</Accordion>



1. Find the wallet type you want to enable for the flow. You can search by name or filter by region.
2. Click the toggle to enable the wallet. Some wallets require you to contact support to enable them.
3. You can click **View Details** on an available wallet to select which data points to collect. Users will only be asked to share what you choose.
4. Click **Done**.

#### Redaction

The Redaction tab lets you define which fields should be redacted on captured identity documents, configured per country. Each country entry specifies the document type, the document subtype (the specific version or format of that document), the issuing year (which identifies the document version and determines which fields are available for redaction), and the fields to redact. You can add multiple country configurations to a single session using the **Add country** button.

<Accordion title="View image of configuration panel">

![The Redaction tab in the ID Capture module's configuration panel. Has one configurable option: Country.](https://developer.incode.com/assets/60bd3ece47e157af19ebd7ca8800bba0.png)

</Accordion>

The following countries are available for redaction configuration. All country entries use **State: ALL**.

##### Norway

| Document type       | Subtype               | Issuing year | Fields to be redacted     |
| ------------------- | --------------------- | ------------ | ------------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2015         | `creditCardNumber`, `ccv` |

##### Indonesia

| Document type       | Subtype               | Issuing year     | Fields to be redacted |
| ------------------- | --------------------- | ---------------- | --------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2000             | `documentNumber`      |
| Passport            | `NATIONAL_PASSPORT`   | 2013, 2015, 2022 | `documentNumber`      |

##### Germany

| Document type       | Subtype                 | Issuing year | Fields to be redacted         |
| ------------------- | ----------------------- | ------------ | ----------------------------- |
| Identification Card | `IDENTIFICATION_CARD`   | 2007         | `documentNumber`              |
| Identification Card | `IDENTIFICATION_CARD`   | 2010, 2021   | `documentNumber`, `refNumber` |
| Identification Card | `TEMP_GERMAN_IDCARD`    | 2004         | `documentNumber`              |
| Passport            | `NATIONAL_PASSPORT`     | 2007, 2017   | `documentNumber`              |
| Residence Document  | `RESIDENCE_PERMIT`      | 2011, 2019   | `documentNumber`, `refNumber` |
| Residence Document  | `FICTIONAL_CERTIFICATE` | 2020, 2024   | `documentNumber`              |

##### Hong Kong

| Document type      | Subtype                       | Issuing year | Fields to be redacted              |
| ------------------ | ----------------------------- | ------------ | ---------------------------------- |
| Passport           | `NATIONAL_PASSPORT`           | 2005         | `documentNumber`, `personalNumber` |
| Residence Document | `PERMANENT_RESIDENT_IDENTITY` | 2003, 2018   | `documentNumber`                   |

##### Netherlands

| Document type       | Subtype                          | Issuing year                 | Fields to be redacted |
| ------------------- | -------------------------------- | ---------------------------- | --------------------- |
| Identification Card | `DIPLOMATIC_IDENTIFICATION_CARD` | 2016                         | `personalNumber`      |
| Identification Card | `IDENTIFICATION_CARD`            | 2014                         | `personalNumber`      |
| Passport            | `NATIONAL_PASSPORT`              | 2006, 2014                   | `personalNumber`      |
| Residence Document  | `RESIDENCE_PERMIT`               | 2014, 2020, 2022             | `personalNumber`      |
| Drivers License     | `DRIVER_LICENSE`                 | 1990, 2006, 2013, 2018, 2025 | `personalNumber`      |

##### Japan

| Document type       | Subtype               | Issuing year | Fields to be redacted |
| ------------------- | --------------------- | ------------ | --------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2020         | `personalNumber`      |

##### Thailand

| Document type       | Subtype               | Issuing year | Fields to be redacted |
| ------------------- | --------------------- | ------------ | --------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2001         | `religion`            |

##### Singapore

| Document type       | Subtype                        | Issuing year | Fields to be redacted              |
| ------------------- | ------------------------------ | ------------ | ---------------------------------- |
| Identification Card | `IDENTIFICATION_CARD`          | 2001         | `documentNumber`                   |
| Passport            | `NATIONAL_PASSPORT`            | 2005, 2017   | `documentNumber`, `personalNumber` |
| Residence Document  | `RESIDENCE_PERMIT`             | 2005         | `documentNumber`                   |
| Drivers License     | `DRIVER_LICENSE`               | 2002         | `documentNumber`                   |
| Military            | `MILITARY_IDENTIFICATION_CARD` | 2010         | `documentNumber`                   |

##### India

| Document type       | Subtype               | Issuing year | Fields to be redacted |
| ------------------- | --------------------- | ------------ | --------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2005, 2010, 2015         | `documentNumber`            |
| Identification Card | `MASKED_IDENTIFICATION_CARD` | 2005, 2015         | `documentNumber`            |

##### Korea, Republic of

| Document type       | Subtype               | Issuing year | Fields to be redacted              |
| ------------------- | --------------------- | ------------ | ---------------------------------- |
| Identification Card | `IDENTIFICATION_CARD` | 2000         | `personalNumber`                   |
| Passport            | `NATIONAL_PASSPORT`   | 2008, 2022   | `documentNumber`, `personalNumber` |
| Residence Document  | `RESIDENCE_PERMIT`    | 2018, 2023   | `documentNumber`                   |
| Drivers License     | `DRIVER_LICENSE`      | 2000, 2020   | `documentNumber`, `personalNumber` |

### Deepsight Settings

If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, the following settings appear in the ID Capture configuration panel.

| Deepsight Setting | Description |
| --- | --- |
| **_Ignore missing metadata_** | Prevents missing capture metadata from automatically making the Deepsight result unavailable. Recommended for API integrations. |
| **_In-browser debugger detection_** | Detects when browser inspection tools are open during capture. |
| **_Mocked browser detection_** | Detects when the browser identity appears altered or simulated. |
| **_Motion_** | Checks for natural device movement during selfie capture. |
| **_Monotonic borders_** | Detects uniform-color borders in the selfie that can occur in some injection attempts. |
| **_Detection values deviation_** | Checks for image patterns that may indicate a static or replayed image. |
| **_Camera label check_** | Detects suspicious camera labels that may indicate a virtual camera. |
| **_Camera challenges_** | Checks camera responses to security challenges to help identify virtual or injected camera feeds. |

---

- Path: `dashboard-platform-administration/id-validation-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/id-validation-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/id-validation-dashboard.md

# ID Validation

The ID Validation module determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Capture](/features-and-modules/id-capture/) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result.

For an overview of this module and how it works, see [ID Validation](/features-and-modules/id-validation-module/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add ID Validation to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module is in your Workflow.
4. Add the **ID Validation** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: After the ID Capture module, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **ID Validation**.
    - **Classic**: From the Processes list, drag and drop the **ID Validation** module into the builder after the ID Capture module.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add ID Validation to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, ensure the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module is added to the Flow. After you add ID Capture, the ID Validation module becomes available.
4. For ID Validation, click **Add**.
5. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

In New view, the ID Validation module's configuration panel has three tabs that categorize its settings:

- **Documents & countries**: Choose which document to validate by default, then customize checks for specific countries.
- **Fraud prevention**: Configure checks that assess whether an ID is genuine and unaltered, including checks for tampering, physical copies and screen-based documents.
- **Exceptions**: Handle less common captures and special cases.

Some advanced checks must be configured by your Incode representative.

#### Documents & Countries

| Setting | Description |
|---|---|
| **_Document to validate_** | Choose whether the module validates the _First ID_ or _Second ID_ captured. |
| **_Country-specific validation_** | Apply different validation checks and thresholds for selected issuing countries instead of using the module’s default configuration. Search for and select the countries you want to add, then click **Add selected**. Customize the [document checks](#document-checks) for each ID type for each country. |

##### Document Checks

| Check | Description |
|---|---|
| **_Waive expiration check_** | Do not reject the document because its expiration date has passed. |
| **_Expiration grace period_**<br />_Workflows only_ | Set the number of days after expiration during which the document is still accepted. |
| **_Minimum age check_** | Check the date of birth extracted from the document and flag the user if they are younger than the configured minimum age. |
| **_Type and side cross check_** | Confirm that the captured images show the expected document type and side, and that the front and back belong to the same kind of document. |
| **_ID elements tamper check_** | Detect whether document elements—such as the portrait, text or data fields—have been added, removed, replaced, or moved from their expected positions. |
| **_Barcode-to-document match_** | Compare information decoded from the barcode with information visible or extracted elsewhere on the document and flag inconsistencies. |
| **_ID materials tamper check_** | Check whether the presented document appears to be made from the expected genuine materials and detect signs of physical tampering. |
| **_Printed copy detection_** | Detect whether the user presented a printed copy of an ID instead of the original physical document. |
| **_Voided ID check_** | Detect punched holes or other cancellation markings that indicate the document has been voided or invalidated. |
| **_ID fonts check_** | Check whether the document’s fonts and typography match those expected for the document template. |
| **_ID security features check_** | Check for expected visual security features and template characteristics to identify potentially counterfeit documents. |
| **_Screen display detection_** | Detect whether the document was presented on a phone, computer, or other digital screen instead of as the original physical document. |

#### Fraud Prevention

:::info
By default, these settings are configured to Incode's recommendations for successful ID validation. Changing them may introduce too much or too little severity.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting | Description |
|---|---|
| **_Duplicate ID detection_** | Check whether the same identity document has been used in another verification session and flag possible document reuse. |
| **_Age match: DOB with selfie_** | Compare the age estimated from the selfie with the age calculated from the document’s date of birth and flag a significant mismatch. |
| **_Waive expiration check_** | Do not reject the document because its expiration date has passed. |
| **_Expiration grace period_**<br />_Workflows only_ | Set the number of days after expiration during which the document is still accepted. |
| **_Minimum age check_** | Check the date of birth extracted from the document and flag the user if they are younger than the configured minimum age. |
| **_AI-generated document_** | If [Deepsight](/features-and-modules/deepsight/) is enabled for your organization, and in your Flow or Workflow settings, this setting appears. It detects if the document was generated or manipulated with AI. Configure the severity: _Low_, _Medium_, or _High_. |

#### Exceptions

| Setting | Description |
|---|---|
| **_Barcode-only mode_** | Validate supported documents using decoded barcode data without requiring front or back document images. |
| **_Type and side cross check_** | Confirm that each captured image shows the expected document type and side, and that the front and back belong to the same document. |
| **_Multiple documents check_** | Detect when more than one identity document appears in a single captured image. |
| **_Front image age_** | Check the front image’s metadata for signs that it was created earlier instead of captured during the current session. |
| **_Front image editing check_** | Check the front image’s metadata for signs that it was modified using image-editing software. |
| **_Back image age_** | Check the back image’s metadata for signs that it was created earlier instead of captured during the current session. |
| **_Back image editing check_** | Check the back image’s metadata for signs that it was modified using image-editing software. |

### Configuration Options: Classic



<Accordion title="View image of Workflow configuration Panel">
  ![Image of the ID Validation module's configuration panel in Workflows. Has 28 configuration options.](https://developer.incode.com/assets/127805d6760ca42121b96f7ff248d2eb.png)
</Accordion>

<Accordion title="View image of Flow configuration Panel" >
  ![Image of the ID Validation module's configuration panel in Flows. Has 28 configuration options.](https://developer.incode.com/assets/b5c54cc2504a89ee7006df1f414c8b73.png)
</Accordion>

| Setting                                                                                                 | Description                                                                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Set country specific_**                                                                              | Restricts validation to documents issued by a specific country. Enable this when your use case requires country-level document validation.                                                                                    |
| **_Select ID_**<br />_Workflows only_                                                                   | Specifies which ID in a multi-ID session this module applies to; for example, _First ID_ or _Second ID_. Use this when your Workflow captures more than one identity document.                                                |
| **_Score Severity_**                                                                                    | Sets the strictness threshold used to evaluate the overall validation score: _Soft_, _Relaxed_, _Medium_, or _Conservative_.                      |
| **_Screen ID Liveness Enabled_**                                                                        | When enabled, checks whether the submitted ID was captured from a live physical document rather than a screen or digital display.                                                                                             |
| **_Screen ID Liveness Severity_**                                                                       | Sets the strictness threshold for the Screen ID Liveness check: _Low_, _Medium_, or _High_. In Flows, this is the **_Threshold_** radio button.  |
| **_ID Alteration_**                                                                                     | When enabled, checks whether the ID has been digitally or physically altered.                                                                                                                                                 |
| **_ID Alteration Severity_**                                                                            | Sets the strictness threshold for the ID Alteration check: _Low_, _Medium_, or _High_. In Flows, this is the **_Threshold_** radio button.       |
| **_Font Alteration Enabled_**                                                                           | When enabled, checks for inconsistencies in font rendering that may indicate document tampering.                                                                                                                              |
| **_Paper ID Liveness Enabled_**                                                                         | When enabled, checks whether the submitted ID is a physical paper or card document rather than a photocopy or printout.                                                                                                       |
| **_Paper ID Liveness Severity_**                                                                        | Sets the strictness threshold for the Paper ID Liveness check: _Low_, _Medium_, or _High_. In Flows, this is the **_Threshold_** radio button.   |
| **_Tamper Check Enabled_**                                                                              | When enabled, checks the document for signs of physical or digital tampering.                                                                                                                                                 |
| **_Tamper Severity_**                                                                                   | Sets the strictness threshold for the Tamper check: _Low_, _Medium_, or _High_. In Flows, this is the **_Threshold_** radio button.              |
| **_Age Verification via Selfie & ID_**                                                                  | When enabled, compares the apparent age of the user captured in a selfie against the date of birth on the submitted ID.                                                                                                       |
| **_Fake ID Check_**                                                                                     | When enabled, checks whether the submitted document matches characteristics of known fake or fraudulent IDs.                                                                                                                  |
| **_Fake ID Severity_**                                                                                  | Sets the strictness threshold for the Fake ID Check: _Low_, _Medium_, or _High_. In Flows, this is the **_Threshold_** radio button.             |
| **_Barcode Content_**                                                                                   | When enabled, reads and validates the barcode on the ID as part of the authenticity check.                                                                                                                                    |
| **_Voided ID check_**<br />_Flows only_                                                                 | When enabled, flags IDs that have been canceled.                                                                                                                                                                              |
| **_Lamination Check_**                                                                                  | When enabled, checks for the presence of security lamination on the ID.                                                                                                                                                       |
| **_Damaged ID Check_**                                                                                  | When enabled, flags IDs that appear physically damaged in a way that may affect validation reliability.                                                                                                                       |
| **_Barcode only verification_**                                                                         | When enabled, limits validation to barcode data only, skipping other visual checks.                                                                                                                                           |
| **_Underage Check_**                                                                                    | When enabled, flags sessions where the date of birth on the submitted ID indicates the user is under the configured age threshold.                                                                                            |
| **_Type Side Cross Check_**                                                                             | When enabled, verifies that the document type indicated on the front of the ID is consistent with data on the back.                                                                                                           |
| **_Disable Expiration Date Check_**                                                                     | When enabled, skips validation of the ID's expiration date. Use this to accept expired documents.                                                                                                                             |
| **_Expiration tolerance (in days)_**                                                                    | The number of days past a document's expiration date that the system still accepts as valid. Default: 0.                                                                                                                      |
| **_Check if ID is already used by face_**                                                               | When enabled, checks whether the identity document has previously been submitted in a session associated with a different face.                                                                                               |
| **_Check Front ID EXIF for software modification_**                                                     | When enabled, inspects [EXIF](/get-started-with-incode/glossary/#exif) metadata on the front ID image to detect signs that the image was digitally modified using software.                             |
| **_Check Back ID EXIF for software modification_**                                                      | When enabled, inspects EXIF metadata on the back ID image to detect signs that the image was digitally modified using software.                                                                                               |
| **_Check front ID EXIF field Data Time Original was not older than the time of addition by more than_** | When enabled, validates that the front ID image's EXIF timestamp is within an acceptable window of the time it was submitted. The time window is set in seconds. The default is 30 seconds.                                   |
| **_Check back ID EXIF field Data Time Original was not older than the time of addition by more than_**  | When enabled, validates that the back ID image's EXIF timestamp is within an acceptable window of the time it was submitted. The time window is set in seconds. The default is 30 seconds.                                    |

---

- Path: `dashboard-platform-administration/instant-bav-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/instant-bav-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/instant-bav-dashboard.md

# Instant BAV

The Instant BAV module validates a user's bank account information by checking key details such as name, address, account ID, and balance.

For an overview of this module and how it works, see [Instant BAV](/features-and-modules/instant-bav/).

## Supported with:

:x: Workflows | :white_check_mark: Flows

## Add Instant BAV to Flows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Instant BAV** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

![Image of Instant BAV module configuration in Flows. Has two configuration options.](https://developer.incode.com/assets/24f8034475b6f876d429920a08d474a6.png)

| Setting               | Description                                                                                                     |
| --------------------- | --------------------------------------------------------------------------------------------------------------- |
| **_Country_**         | The country for the bank accounts this module verifies.                                                         |
| **_Number of tries_** | The maximum number of attempts a user is allowed to complete bank account verification before the session ends. |

<br />

---

- Path: `dashboard-platform-administration/kyb-modules-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/kyb-modules-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/kyb-modules-dashboard.md

# KYB
This module runs modular business verification: the business details submitted for a session are checked against government and commercial data sources. Available checks and required fields depend on the country of the business. See [KYB Coverage](/general-reference/kyb-coverage) for more details.

:::note
This module is different than [eKYB](/dashboard-platform-administration/ekyb-dashboard/).
:::



## Supported with

✅ Workflows | ✅ Flows

## Before you start

This module must be enabled for your organization in each country where you want to run business verification. Contact your Incode representative to enable it.

Some checks may run asynchronously depending on the country. Rather than hold up the whole session waiting for every check to finish, results that are available sooner are returned right away, and any outstanding checks arrive later. Configure the [KYB Results Webhook](/general-reference/kyb-results-webhook) to receive the final result of every run.

## Add KYB to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop **KYB** into the builder.
4. <Pill type="beta" /> Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **KYB**.

## Add KYB to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the Select Modules tab, find **KYB** and click **Add**.

## Configuration Options

This module has no configuration options in Dashboard. The checks to run, the country, and the business details are sent with each request to `POST /omni/kyb`. 








## Add Conditions

Workflow Conditions are not available for this module yet. This section will be updated once they are.

## View results

Results will be available in the Business tab of [single Session View](/dashboard-platform-administration/single-session-view/).

---

- Path: `dashboard-platform-administration/manage-candidate-verifications`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-candidate-verifications/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-candidate-verifications.md

# Manage Candidate Verifications

Candidate Verification lets your recruiting team confirm a job candidate's identity during the hiring process, on demand, without requiring the candidate to already exist in a connected directory. This helps protect against hiring fraud, such as someone interviewing under a false identity or having another person perform the job on their behalf. Recruiters can request verification for a new or existing candidate via link, SMS, or email, or generate a protected meeting link that requires identity verification before a candidate can join a video call. All verification requests and their results are tracked directly on this page.

In the left menu, click **Services** > **Candidate Verification** to access the page.

***

## Send a Verification Request

Use the section at the top of the page to start a new verification for a candidate. This section has two tabs: **Existing Candidate** and **New Candidate**.

### Existing Candidate

Use this tab to send a verification request to a candidate you've previously added. You can add candidates on the **New Candidate** tab on this page or by using an external trigger, such as an ATS webhook.

1. In the left menu, click **Services** > **Candidate Verification**.
2. Click the **Existing Candidate** tab.
3. In **Candidate Name**, search for and select the candidate you want to verify.
4. Choose how you want to deliver the verification to the candidate: **Via sharing a Link**, **Via SMS**, **Via Email**, or **Protect meeting with Incode**.
5. Choose how long the verification link remains active before it expires. Enter a number and select a unit: **minutes**, **hours**, or **days**.
6. Depending on the verification method selected, the button at the bottom of the section changes:
   - If you selected **Via sharing a Link**, click **Generate Verification & Copy Link** to create the verification and copy a shareable link to your clipboard. Send this link to the candidate through any channel you choose.
   - If you selected **Via SMS**, click **Send SMS** to text the verification link directly to the candidate's phone number.
   - If you selected **Via Email**, click **Send Email** to email the verification link directly to the candidate's email address.
   - If you selected **Protect meeting with Incode**, click **Generate Verification & Copy Link** to create a verification-gated link for a video meeting. The candidate must complete identity verification before being redirected to the meeting.

### New Candidate

Use this tab to add a candidate who hasn't been verified before and request their first verification. Adding a candidate here creates them in your organization's candidate list.

1. In the left menu, click **Services** > **Candidate Verification**.
2. Click the **New Candidate** tab.
3. In **Candidate Name**, enter the name of the candidate you want to add.
4. Choose how you want to deliver the verification to the candidate: **Via sharing a Link**, **Via SMS**, **Via Email**, or **Protect meeting with Incode**.
5. Choose how long the verification link remains active before it expires. Enter a number and select a unit: **minutes**, **hours**, or **days**.
6. Depending on the verification method selected, the button at the bottom of the section changes:
   - If you selected **Via sharing a Link**, click **Generate Verification & Copy Link** to create the verification and copy a shareable link to your clipboard. Send this link to the candidate through any channel you choose.
   - If you selected **Via SMS**, click **Send SMS** to text the verification link directly to the candidate's phone number.
   - If you selected **Via Email**, click **Send Email** to email the verification link directly to the candidate's email address.
   - If you selected **Protect meeting with Incode**, click **Generate Verification & Copy Link** to create a verification-gated link for a video meeting. The candidate must complete identity verification before being redirected to the meeting.

***

## View Candidates

Below the **Existing Candidate** and **New Candidate** tabs, a table lists your organization's candidates and the verification requests sent to them. Click a row in the table to open a dialog listing every verification session tied to that candidate.

| Column                    | Description                                                                                                                                                                             |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**                  | The candidate's name, entered when they were added.                                                                                                                                     |
| **User Identifier**       | The candidate's unique identifier: their email address or phone number.                                                                                                                 |
| **Sessions**              | The number of verification requests sent to this candidate, including pending, successful, failed, and expired ones.                                                                    |
| **Last Update**           | The date and time the candidate's most recent verification request was last updated.                                                                                                    |
| **Expiration Estimation** | The date and time the candidate's most recent verification link expires, based on the **Valid for** duration selected when the request was created. Shows a dash (-) if not applicable. |
| **Score**                 | The verification result: _Pass_, _Warn_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_.                                             |
| **Session Status**        | The current status of the verification: _Completed_ or _Not Completed_.                                                                                                                 |
| **Action**                | Click the trash icon to permanently [delete](#delete-candidates) this candidate from the table.                                                                                         |

***

## Filter Candidates

You can filter the table by one or more criteria to find the candidates or verification requests you need.

1. In the left menu, click **Services** > **Candidate Verification**.
2. Click one of the filter fields above the table:
   - **Name**: Enter the name of the candidate you want to search for.
   - **User Identifier**: Enter the email address or phone number for the candidate you want to search for.
   - **Last Update**: Select **All dates**, **Last Week**, **Last Month**, **Last Quarter**, or **Custom Date Range**. If you select **Custom Date Range**, select a start and end date.
   - **Score**: Select _Pass_, _Warn_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_.
   - **Session Status**: Select _Completed_ or _Not Completed_.
3. Filters are applied immediately. The table displays the requests that fit your criteria, and the filter appears as a tag above the table.
4. Repeat these steps to add any additional filters. Click the **x** on a filter tag to remove it.

The dialog showing a candidate's individual sessions can be filtered the same way, using the **Name**, **Last Update**, **Score**, and **Session Status** fields above that table.

***

## Delete Candidates

You can permanently delete candidates and their verification history.

1. In the left menu, click **Services** > **Candidate Verification**.
2. In the Action column in the table, click the trash icon.
3. In the confirmation dialog, click **Delete**.

<br />

---

- Path: `dashboard-platform-administration/manage-cases`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-cases/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-cases.md

# Manage Cases



Case Management lets reviewers work through Sessions that need a manual look, such as those that failed automated checks. Each row in the table is a **case** tied to a Session.

The **Case Management** page in Dashboard shows every case in your organization, along with details about each one. When you first open the page, the following columns appear.

| Column            | Description                                                                                                                                              |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Assigned To**   | The reviewer assigned to the case, or _Unassigned_ if no one has claimed it yet.                                                                         |
| **Issue**         | The type of issue flagged on the case, if any: _Incorrect rejection_, _Incorrect approval_, _Bug_, or _Other_.                                           |
| **Opened By**     | The user who opened the case.                                                                                                                            |
| **Opened On**     | The date and time the case was opened.                                                                                                                   |
| **Resolved By**   | The user who resolved the case, if it's been resolved.                                                                                                   |
| **Resolved On**   | The date and time the case was resolved, if it's been resolved.                                                                                          |
| **Case Status**   | The current status of the case: _Unassigned_, _In Progress_, or _Resolved_.                                                                              |
| **Session Score** | The outcome of the case's Session: _Pass (Manual)_, _Fail (Manual)_, _Pending (Manual)_, _Needs Review_, _Pass_, _Warning_, _Not Applicable_, or _Fail_. |
| **ID Type**       | The type of identity document submitted in the Session.                                                                                                  |
| **Country**       | The country associated with the Session.                                                                                                                 |
| **Case Number**   | The unique ID for the case.                                                                                                                              |
| **Session ID**    | The unique ID for the Session tied to the case.                                                                                                          |
| **Comments**      | Any comments left on the case.                                                                                                                           |

On this page, you can:

- Filter the cases that are shown
- Assign a case, or multiple cases at once, to a reviewer
- Review cases assigned to you

***

## Filter Cases

You can filter the list of cases by one or more criteria to find the cases you need. You can also use the status options above the table as quick filters.

### Use the Status Options

1. In the left menu, click **Case Management**.
2. Click **Unassigned**, **In Progress**, or **Resolved** to filter by case status. Click **Pass Manual** or **Fail Manual** to filter by session score. Once applied, the option shows the number of cases matching that filter.

### Use Add Filter

1. In the left menu, click **Case Management**.
2. Click **Add Filter** in the top left.
3. Select the filter you want to add:
   - **Session ID**: Enter the unique ID for the Session tied to the case you want to see.
   - **Assigned To**: Select the reviewer assigned to the cases you want to see.
   - **Opened By**: Select the user who opened the cases you want to see.
   - **Resolved By**: Select the user who resolved the cases you want to see.
   - **Case ID**: Enter the unique ID for the case you want to see.
   - **Issue Type**: Select the type of issue flagged on the case: _Incorrect rejection_, _Incorrect approval_, _Bug_, or _Other_.
   - **Status**: Select the current status of the case: _Unassigned_, _In Progress_, or _Resolved_.
   - **Session Score**: Select the outcome of the Session tied to the case: _Pass (Manual)_, _Fail (Manual)_, _Pending (Manual)_, _Needs Review_, _Pass_, _Warning_, _Not Applicable_, or _Fail_.
   - **Country**: Select a country from the drop-down.
   - **Created At**: Select a start and end date from the calendar to only show cases created in that range.
4. Click **Apply**. The table displays the cases that fit your criteria.
5. Repeat these steps to add any additional filters.

***

## Assign Cases

If you have permission, you can assign a single case, or multiple cases at once, to a reviewer, including yourself. Once you assign a case to a reviewer, you cannot mark it as _Unassigned_ again.

### Assign a Single Case

1. In the left menu, click **Case Management**.
2. Click the value in the **Assigned To** column for the case you want to assign. This works whether the case is currently **Unassigned** or already assigned to someone.
3. In the **Assign a Case** dialog, search for and select a reviewer.
4. Click **Assign**.

### Assign Multiple Cases

1. In the left menu, click **Case Management**.
2. Select the checkbox next to each case you want to assign. Click **Cancel** to clear your selection.
3. Click **Assign Case**.
4. In the **Assign a Case** dialog, search for and select a reviewer.
5. Click **Assign**.

***

## Review Cases

You can review cases that are assigned to you.

1. In the left menu, click **Case Management**.
2. Click the row for the case you want to review. You may want to [filter](#use-add-filter) the table to see all the cases assigned to you.

   The case opens, displaying [single Session view](/dashboard-platform-administration/single-session-view/), plus the following information:

   - **Account Executive**: The name of the account executive for this case's organization.
   - **Days in Review**: The number of days this case has been in review.
3. Click **Case Resolution** at the bottom.
4. In the Case Resolution panel, select an **Issue** from the drop-down: _Screen Selfie_, _Liveness_, _Screen ID_, _Paper_, _Tamper_, _Paper ID_, _Injection_, _FN_ (False Negative), or _Other_.
5. In **Resolve Case Reason**, enter details about the issue you identified and the case resolution.
6. Click one of the following:
   - **Resolve**: Change the case status to _Resolved_, but keep the session score the same.
   - **Fail**: Change the case status to _Resolved_ and the session score to _Fail (Manual)_.
   - **Approve**: Change the case status to _Resolved_ and the session score to _Pass (Manual)_.
7. Click **Next Session to Review** to open the next case assigned to you.

<br />

---

- Path: `dashboard-platform-administration/manage-custom-watchlists`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-custom-watchlists/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-custom-watchlists.md

# Manage Custom Watchlists

The **Custom Watchlists** page lets you maintain your own blocklists and allowlists of individuals, independent of Incode's built-in fraud lists. Use it to review existing entries, add new ones, and control how each entry affects future sessions.

This page uses two related terms:

- **Entity**: The real-world person or business a watchlist record represents (their name, ID numbers, contact details, and so on).
- **Entry**: A single row in the table. One entity can have more than one entry: for example, if they were added to the watchlist more than once, or through different sessions.

The table on **Custom Watchlists** can show the following columns.

| Column | Description |
| --- | --- |
| Image | Face image associated with the entry. Click it to open an expanded view. |
| Name | User's name associated with the entry. |
| Watchlist ID | Unique identifier generated for the entry. |
| Created | Date and time the entry was created. |
| Updated | Date and time the entry was last modified. |
| Block expires on | Date the entry's block expires, if set. |
| Phone | Phone number associated with the entity. |
| Device Hash | Device identifier associated with the entry, if available. |
| Email | Email address associated with the entity. |
| ID Number | User's government-issued identifier on file associated with the entry; this is typically their main document number (the CIC). |
| Personal ID Number | User's personal identifier on file, such as a CURP. Only shown if mapping has been configured for a relevant ID type or region. |
| Birth Date | User's date of birth. |
| Watchlist Type | Whether the entry is on the Blocklist or Allowlist. |
| Actions | Edit or delete the entry. |

On this page, you can:

- [Filter the Custom Watchlists that are shown](#filter-custom-watchlists)
- [Manually add a single watchlist entity](#add-watchlist-entities)
- [Bulk upload watchlist entries](#upload-watchlist-entries)
- [Edit watchlist entries](#edit-watchlist-entries)
- [Export Custom Watchlists to a CSV file](#export-custom-watchlists)
- [Configure your view of the Custom Watchlists table](#configure-custom-watchlists-view)
- [Delete watchlist entries](#delete-watchlist-entries)

## Filter Custom Watchlists

1. In the left menu, click **Custom Watchlists**.
2. Click **Add Filter** in the top left.
3. Select the column you want to filter by:
   - **Name**: Enter the entity name you want to search for.
   - **Watchlist ID**: Enter the unique identifier for the entry you want to search for.
   - **Created At**: Select a start and end date from the calendar to only show Custom Watchlists created in that range.
   - **Updated At**: Select a start and end date from the calendar to only show Custom Watchlists modified in that range.
   - **Phone**: Enter the phone number for the entity you want to search for.
   - **Device Hash**: Enter the device hash for the entry you want to search for.
   - **Email**: Enter the email address for the entity you want to search for.
   - **Watchlist Type**: Select **Blocklist** or **Allowlist**.
   - **ID Number**: Enter the government-issued ID number for the entity you want to search for.
   - **Birthdate**: Select a date from the calendar.
   - **Expires**: Select a date from the calendar.
4. Click **Apply**. The table displays the Custom Watchlists that fit your criteria.
5. Repeat these steps to add additional filters.

## Add Watchlist Entities

You can manually add a single entity to a watchlist.

1. In the left menu, click **Custom Watchlists**.
2. Click the three-dot menu (⋮) in the top right.
3. Select **Add to Watchlist**. The Add Entity to Watchlist dialog opens.
4. Optionally upload a photo, front ID image, and back ID image (JPG, JPEG, or PNG, up to 10 MB each).
5. Enter the entity's details: _**Name**_, _**Birth Date**_, _**ID Number**_, _**Personal ID Number**_, _**Email**_, and _**Phone Number**_. You must include at least a Name or ID Number.
6. Choose the _**Watchlist**_ type (_Blocklist_ or _Allowlist_) and, optionally, a _**Watchlist Expiry**_ date.
7. Click **Add to Watchlist**.

## Upload Watchlist Entries

Add multiple entities at once via CSV import. Bulk upload only adds entity data; you must then add photos manually by editing each entry.

1. In the left menu, click **Custom Watchlists**.
2. Click the three-dot menu (⋮) in the top right.
3. Select **Upload Watchlist**. The Upload Watchlist File dialog opens.
4. If needed, click **Download template CSV** to get the correct file format.
5. Drag and drop your CSV file or click to browse and select it.
6. Click **Add to Watchlist**.

### Other Ways to Add Entities

In addition to the manual and bulk methods above, entities can be added to a Custom Watchlist through:

- **Single Session view**: [Add a user](/dashboard-platform-administration/single-session-view/#risk) directly from the Risk tab in single Session view. This pulls the relevant information from the Session and creates a Custom Watchlist entry automatically.
- **Automatic addition**: Enable **Automatically add suspected fraud** in the [Custom Watchlist module](/dashboard-platform-administration/custom-watchlist-dashboard/) to have suspected fraudulent sessions added as entries without manual action.

## Edit Watchlist Entries

1. In the left menu, click **Custom Watchlists**.
2. Click the pencil icon in the **Actions** column for the entry you want to edit.
3. In the Edit Watchlist Entity dialog, update any field: _**Name**_, _**Birth Date**_, _**ID Number**_, _**Personal ID Number**_, _**Email**_, _**Phone Number**_, _**Watchlist**_, and _**Watchlist Expiry**_.
4. Click **Edit Entity** to save.

## Export Custom Watchlists

1. In the left menu, click **Custom Watchlists**.
2. Click the three-dot menu (⋮) in the top right.
3. Select **Export to CSV** to download the current table data. Download starts immediately; no dialog appears.

## Configure Custom Watchlists View

You can show, hide, and reorder columns in the Custom Watchlists table. This change only affects your account. Other users still see their own view.

1. In the left menu, click **Custom Watchlists**.
2. Click the three-dot menu (⋮) in the top right.
3. Select **Table Settings**.
4. In the Configure Table View panel:
   - Click the eye icon next to a column to show or hide it.
   - Drag a column by its handle (⋮⋮) to reorder it.
5. Click **Save View** to apply your changes. This view of the page is shown on future visits, even after logging out.

## Delete Watchlist Entries

Deletion happens immediately with no confirmation dialog, and it cannot be undone.

1. In the left menu, click **Custom Watchlists**.
2. Click the trash can icon in the Actions column for the entry you want to delete.

---

- Path: `dashboard-platform-administration/manage-helpdesk-verifications`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-helpdesk-verifications/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-helpdesk-verifications.md

# Manage Helpdesk Verifications

Helpdesk Verification lets you manually trigger identity verification for an employee, in real time, without waiting for the employee to initiate the request themselves. This is useful in agent-assisted scenarios such as call center support, in-branch help desk visits, or any time a support agent needs to confirm an employee's identity before granting access, resetting credentials, or resolving an account issue. Support agents can send a verification to the employee via link, SMS, or email, then track the result directly from this same table.

In the left menu, click **Services** > **Helpdesk Verification** to access the page. The employees listed here come from your connected [directory integration](/ecosystem-workforce/directory-integrations/).

***

## Send a Verification Request

Use the New Verification Request section at the top of the page to start a new verification for an employee.

1. In the left menu, click **Services** > **Helpdesk Verification**.
2. Search for and select the **Employee** you want to verify. Type into the field to filter the drop-down by name or email.
3. Choose how you want to deliver the verification to the employee: **Via sharing a Link**, **Via SMS**, or **Via Email**.
4. Depending on the verification method selected, the button at the bottom of the section changes:
   - If you selected **Via sharing a Link**, click **Generate Verification & Copy Link** to create the verification and copy a shareable link to your clipboard. Send this link to the employee through any channel you choose.
   - If you selected **Via SMS**, click **Send SMS** to text the verification link directly to the employee's phone number on file.
   - If you selected **Via Email**, click **Send Email** to email the verification link directly to the employee's email address on file.

***

## View Verification Requests

Below the New Verification Request section, a table lists the Helpdesk verification requests for your organization.

| Column              | Description                                                                                                                                 |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**            | The employee's name recorded in the directory.                                                                                              |
| **User Identifier** | The employee's unique identifier: their email address, username, or directory ID.                                                           |
| **Last Update**     | The date and time the verification request was last updated.                                                                                |
| **Score**           | The verification result: _Pass_, _Warn_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_. |
| **Session Status**  | The current status of the verification: _Completed_ or _Not Completed_.                                                                     |

***

## Filter Verification Requests

You can filter the table by one or more criteria to find the verification requests you need.

1. In the left menu, click **Services** > **Helpdesk Verification**.
2. Click one of the filter fields above the table:
   - **Name**: Enter the name of the employee you want to search for.
   - **User Identifier**: Enter the email address, username, or directory ID for the employee you want to search for.
   - **Last Update**: Select **All dates**, **Last Week**, **Last Month**, **Last Quarter**, or **Custom Date Range**. If you select **Custom Date Range**, select a start and end date.
   - **Score**: Select _Pass_, _Warn_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_.
   - **Session Status**: Select _Completed_ or _Not Completed_.
3. Filters are applied immediately. The table displays the requests that fit your criteria, and the filter appears as a tag above the table.
4. Repeat these steps to add any additional filters. Click the **x** on a filter tag to remove it.

<br />

---

- Path: `dashboard-platform-administration/manage-integrations`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-integrations/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-integrations.md

# Manage Integrations

All integrations are created, configured, and managed from the Integrations page in Dashboard. This page covers the common Dashboard operations that apply to all integration types.

For integration-specific setup instructions, see [the guide for the integration type you're configuring](/ecosystem-workforce/integrations-ecosystem-overview/).

:::note
The Integrations page is only visible when the Integrations Ecosystem feature is enabled for your organization. Contact your Incode Representative if you do not see it.
:::

***

## Create Integrations

1. In the left menu, click **Integrations**.
2. Click **New Integration**.
3. Select from the available integration templates, then click **Continue**.
4. Complete the configuration fields for the selected integration type. The required fields vary by type. Refer to [the guide for your integration](/ecosystem-workforce/integrations-ecosystem-overview/) for details.
5. Click **Save**.

After saving, the integration appears on the Integrations page and is ready to use. An Integration ID is generated automatically.

***

## Edit Integrations

1. In the left menu, click **Integrations**.
2. Locate the integration you want to edit.
3. Click the integration card to open its configuration.
4. Make your changes and click **Update**.

:::note
Changing the Workflow linked to an active integration takes effect immediately. Existing in-progress sessions are not affected, but all new sessions will use the updated Workflow.
:::

***

## Find Integration Details

The sections below cover the credentials and identifiers you may need from Dashboard and where to find them.

### API Key

1. In the left menu, click **Configuration**.
2. Click the **API Keys** tab.
3. Click **Copy** for the key you want to use, or click **Generate New API Key** to create a new one.

### Configuration ID

1. In the left menu, click **Workflows**.
2. Open the Workflow you want to use.
3. Copy the Configuration ID from the Workflow details panel or the page URL.

### Integration ID

1. In the left menu, click **Integrations**.
2. Open the integration card.
3. Click **Copy ID** to copy the Integration ID.

The Integration ID is required when triggering verification sessions via the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/).

### Client ID

1. In the left menu, click **Integrations**.
2. Under **Custom**, open **OIDC Client Credentials**.
3. Copy the Client ID from the integration details.

### Client Secret

1. In the left menu, click **Integrations**.
2. Under **Custom**, open **OIDC Client Credentials**.
3. Click **Generate Secret**.

:::note
The Client Secret is shown only once. Store it securely in a secrets manager or vault. If lost, you must generate a new one.
:::

***

## View the Directory

If you set up a directory-backed integration such as Okta or Microsoft Entra, the **Directory Information** [page](/dashboard-platform-administration/view-directory-information/) appears in the left menu. Click it to see all users synced from the connected directory, as well as each user's enrollment status, identity record, and completed sessions.

***

## Delete an Integration

1. In the left menu, click **Integrations**.
2. Click the integration card to open its details.
3. Select **Delete** and confirm.

:::danger
Deleting an integration cannot be undone. Any systems or automation that reference the deleted integration's Integration ID will stop receiving verification sessions. Update or remove those references before deleting.
:::

---

- Path: `dashboard-platform-administration/manage-users`
- URL: https://developer.incode.com/dashboard-platform-administration/manage-users/
- Markdown: https://developer.incode.com/dashboard-platform-administration/manage-users.md

# Manage Users

**Required role**: [_Admin_](/dashboard-platform-administration/roles-permissions#admin) or higher, or _[Executive with custom permissions](/dashboard-platform-administration/roles-permissions#executive-with-custom-permissions)_ including _users:all_.

The Users page lists all the users in your Dashboard organization, as well as their email and phone number. From this page, you can:

- [Create users](#create-users)
- [Edit users](#edit-existing-users)
- [View an activity log for a user](#view-user-activity-log)
- [Export the list of users](#export-user-list)
- [Delete users](#delete-users)


<Image src="https://developer.incode.com/assets/7625398740d538cb8e32b097cfdca1a4.png" alt="The Users page in Dashboard, showing a list of users, their email addresses, and their phone numbers." align="center" />


***

## Create Users

1. In the left menu, click **Users**.

2. Click **Add User**.

3. Enter the user's **_Name_**, **_Email_**, and an 11-digit **_Phone_** number.


   <Image src="https://developer.incode.com/assets/41ee1fa5742971ba0b6c2a320af9085d.png" alt="Fields for Name, Email, Phone, and Role." align="left" />


4. Use the drop-down to select a **_Role_**. See [Roles & Permissions](/dashboard-platform-administration/roles-permissions/) for details.

5. If the role you selected requires additional configuration, use the drop-downs accordingly.

6. Select **Limited Visibility** if you want the user to only see Sessions from a limited timeframe. You configure this timeframe in **Configuration** > **General**.

7. Click **Register User**.

After the user is created, they can access Dashboard based on the permissions defined by their role.

***

## Edit Existing Users

1. In the left menu, click **Users**.

2. Browse or search for the user you want to edit.

3. In the Actions column, click **Edit**.

4. Modify the user's information. All fields are editable.


   <Image src="https://developer.incode.com/assets/fd38f8601ddda7fbf1fd668bd90ad30d.png" alt="Fields for Name, Email, Phone, and Role." align="left" />


5. Click **Edit User**. A dialog appears confirming your changes were made.

***

## View User Activity Log

1. In the left menu, click **Users**.
2. Browse or search for the user you want.
3. In the Actions column, click **See Log**.
4. In the Activity Log panel, use the drop-down to select a date range:
   - **Week to Date**: Shows user activity from the most recent Monday to the current day.
   - **Last Week**: Shows user activity from the previous full week.
   - **Month to Date**: Shows user activity from the start of the current month to the current day.
   - **Last Month**: Shows user activity from the previous full month.
   - **Year to Date**: Shows user activity from the start of the current calendar year to the current day.
   - **Last Year**: Shows user activity from the previous calendar year.
5. Click **X** to close the Activity Log panel.

***

## Export User List

You can export the list of users to a CSV file. This file includes all users in your organization, along with their creation timestamp, phone number, role, and email. If the user has the Executive with custom permissions role, the file also includes any specific permissions they're assigned. The file is automatically saved to your device's default download location.

1. In the left menu, click **Users**.
2. Click **Export to CSV**. A notification appears with the message "Your download will start soon."

***

## Delete Users

:::danger
You cannot recover a deleted user.
:::

1. In the left menu, click **Users**.
2. Browse or search for the user you want.
3. In the Actions column, click **Delete**.
4. In the confirmation dialog, click **Delete**.

After the user is deleted, they can no longer access Dashboard.

---

- Path: `dashboard-platform-administration/monitor-compliance`
- URL: https://developer.incode.com/dashboard-platform-administration/monitor-compliance/
- Markdown: https://developer.incode.com/dashboard-platform-administration/monitor-compliance.md

# Monitor Compliance

The **Compliance** page in Dashboard supports compliance reviews and incident investigations. It has two tabs:

- **Data Management**: Shows a record for every session or identity whose data has been deleted, whether through automatic data retention rules or an individual deletion request. Use this tab to confirm that a deletion completed successfully.
- **Audit Logs**: Shows a trail of actions taken by users and system processes in Dashboard. Use this tab to see who performed an action, when they performed it, and from which IP address.

On this page, you can:

- Filter the data shown on the Data Management and Audit Logs tabs
- View individual audit logs
- Export audit logs to a CSV file

***

## Data Management

The table on the **Data Management** tab shows the following columns.

| Column          | Description                                                                                                                                                       |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name            | Name associated with the deleted record, if available. To protect privacy, only the first name and last initial are shown.                                        |
| Type            | Whether the deleted record was a _Session_ or an _Identity_.                                                                                                      |
| Entity ID       | Unique identifier of the deleted Session or Identity.                                                                                                             |
| Created On      | Date and time the original record was created.                                                                                                                    |
| Data Deleted On | Date and time the record's data was deleted.                                                                                                                      |
| Status          | Current state of the deletion: _Init_, _Success_, _Processing_, _Failed_, or _Interrupted_. _Init_ means the deletion task has been created and is queued to run. |


Records on this tab cannot be edited or deleted. It provides a read-only trail confirming that deletions occurred.

### Filter Data Management

1. In the left menu, click **Compliance**.
2. Make sure you're on the **Data Management** tab.
3. Click **Add Filter** in the top left.
4. Select the column you want to filter by:
   - **Deleted Name**: Enter the name you want to search for.
   - **Deleted Type**: Select _Session_ or _Identity_.
   - **Deleted ID**: Enter the entity ID you want to search for.
   - **Created At**: Select a start and end date from the calendar to only show records created in that range.
   - **Deleted At**: Select a start and end date from the calendar to only show records deleted in that range.
   - **Status**: Select _Init_, _Success_, _Processing_, _Failed_, or _Interrupted_.
5. Click **Apply**. The table displays the records that fit your criteria.
6. Repeat these steps to add additional filters.

***

## Audit Logs

The **Audit Logs** tab records actions taken by Dashboard users and system processes, so you can trace who performed an action, when, and from which IP address.

The first time you open this tab in a session, the **Audit logs time preview** dialog appears, letting you know that only events from the past 30 days are displayed by default; you can expand the range with the Timestamp filter. Select **Don't show this anymore** to stop seeing this dialog, or click **Continue** to dismiss it.

The table on the **Audit Logs** tab shows the following columns.

| Column    | Description                                                                                                                              |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Timestamp | Date and time the event occurred.                                                                                                        |
| Event ID  | Unique identifier generated for the event.                                                                                               |
| Actor     | User or system process that performed the action, shown with their ID and, if applicable, email.                                         |
| Event     | Action that was performed: _Configuration Create_, _Configuration Update_, _Login Attempt_, _Logout_, _User Created_, or _User Deleted_. |
| Type      | Category of the resource the event affected: _Configuration_, _Executive_, _Flow_, _Workflow_, _Identity_, or _Session_.                 |

Audit log entries cannot be edited or deleted.

### Filter Audit Logs

1. In the left menu, click **Compliance**.
2. Click the **Audit Logs** tab.
3. Click **Add Filter** in the top left.
4. Select the column you want to filter by:
   - **Event**: Select _Configuration Create_, _Configuration Update_, _Login Attempt_, _Logout_, _User Created_, or _User Deleted_.
   - **Type**: Select _Configuration_, _Executive_, _Flow_, _Workflow_, _Identity_, or _Session_.
   - **Actor**: Enter the name or ID of the actor you want to search for.
   - **Email**: Enter the email address of the actor you want to search for.
   - **IP Address**: Enter the IP address you want to search for.
   - **Timestamp**: Select a start and end date from the calendar to only show events that occurred in that range.
5. Click **Apply**. The table displays the events that fit your criteria.
6. Repeat these steps to add additional filters.

### View Audit Logs

Click anywhere in the **Timestamp** column for a row in the Audit Logs table to open a panel with more details about that event. The panel slides out from the right side of the screen.

The panel has four tabs:&#x20;

- **User**: Shows details about the person or system that performed the action.
  | Field        | Description                                             |
  | ------------ | ------------------------------------------------------- |
  | Executive ID | Unique identifier of the user who performed the action. |
  | Email        | Email address of the user who performed the action.     |
  | Role         | Role of the user at the time of the action.             |
- **Event**: Shows details about the action itself.
  | Field             | Description                                                                      |
  | ----------------- | -------------------------------------------------------------------------------- |
  | Timestamp         | Date and time the event happened.                                                |
  | Event IUDD        | Unique identifier generated for the event.                                       |
  | Type              | Category of the resource the event affected, such as _SESSION_.                  |
  | Event             | Name of the action that was performed, such as _Session viewed_.                 |
  | Managed Entity ID | ID of the specific record the action affected, such as a session or identity ID. |
- **Source**: Shows details about where the action came from.
  | Field      | Description                                              |
  | ---------- | -------------------------------------------------------- |
  | IP         | IP address the action came from.                         |
  | User Agent | Browser and operating system used to perform the action. |
- **Location**: Shows details about the part of the system where the action took place.
  | Field       | Description                                                            |
  | ----------- | ---------------------------------------------------------------------- |
  | Application | Internal service where the action took place, such as _USER\_SERVICE_. |
  | API Key     | API key associated with the request.                                   |

### Export Audit Logs

1. In the left menu, click **Compliance**.
2. Click the **Audit Logs** tab.
3. Click **Export to CSV** in the top right to download the current table data. Download starts immediately; no dialog appears.

<br />

---

- Path: `dashboard-platform-administration/nfc-scan-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/nfc-scan-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/nfc-scan-dashboard.md

# NFC Scan

The NFC Scan module reads the secure [NFC](/get-started-with-incode/glossary/#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image.

For an overview of this module and how it works, see [NFC Scan](/features-and-modules/nfc/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add NFC Scan to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add the **NFC Scan** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **NFC Scan**.
    - **Classic**: From the Modules list, drag and drop the **NFC Scan** module into the builder.
4. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add NFC Scan to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **NFC Scan** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

:::info
By default, these settings are configured to Incode's recommendations for successful NFC scan. Changing them may make the module less effective.
:::

To change these settings, click **Customize**, acknowledge the warning, then click **Continue customizing** in the dialog. At any time, you can click **Reset to Recommended** at the top to return to Incode's defaults.

| Setting                                                                       | Description                                                                                                                                  |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **_NFC Validation_**                                                          | Activates NFC chip data extraction for verification. Enabled by default.                                                                     |
| **_Show NFC compatibility check_**     | Displays a screen prompting the user to confirm that the NFC symbol is visible on their document before scanning begins. Enabled by default.  |
| **_Show OCR data confirmation before first scan_** | Shows a screen displaying the data extracted via OCR for the user to confirm before the NFC scan is initiated. Enabled by default.           |

### Configuration Options: Classic

<Accordion title="View image of configuration panel">

![Image of the NFC Scan configuration page in Workflows. Has three configuration options.](https://developer.incode.com/assets/858d3a5a97930e8cc6ade98143164a9c.png)

</Accordion>

| Setting                                                                       | Description                                                                                                                                  |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **_NFC symbol availability check screen_**                                    | Displays a screen prompting the user to confirm that the NFC symbol is visible on their document before scanning begins. Enabled by default. |
| **_NFC Validation_**                                                          | Activates NFC chip data extraction for verification. Enabled by default.                                                                     |
| **_Display document OCR data confirmation screen before the first NFC scan_** | Shows a screen displaying the data extracted via OCR for the user to confirm before the NFC scan is initiated. Enabled by default.           |

---

- Path: `dashboard-platform-administration/phone-number-input-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/phone-number-input-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/phone-number-input-dashboard.md

# Phone Number Input

The Phone Number Input module collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS.

For an overview of this module and how it works, see [Phone Number Input](/features-and-modules/phone-number-input/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Phone Number Input to Workflows

1. In the left menu. Select **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Phone Number Input** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Phone Number Input to Flows

1. In the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Phone Number Input** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

After making changes, click **Save Configurations** to apply them.

<Accordion title="View image of Workflow configuration panel">
  ![Image of the Phone Number Input configuration panel in Workflows. Has four configuration options.](https://developer.incode.com/assets/f6cc16fc90e4956e2b786fb7d2be8c27.png)
</Accordion>

<Accordion title="View image of Flow configuration panel">
  ![Image of the Phone Number Input configuration panel in Flows. Has four configuration options.](https://developer.incode.com/assets/f066c28eaa461a7185d9b3b040a6edef.png)
</Accordion>

| Setting                                                          | Description                                                                                                                                                                                                                 |
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable OTP verification**                                      | The user must confirm their phone number by entering a one-time password (OTP) sent via SMS before the module completes.                                                                                                    |
| **Expiration duration for OTP (min)**                            | The number of minutes an OTP remains valid after it is sent. Default: _10_.                                                                                                                                                 |
| **Enable SNA verification**<br />_Flows only_                    | Activates Silent Network Authentication as the primary verification method, with SMS OTP as an automatic fallback when SNA is unavailable. |
| **Prefill phone number**                                         | Pre-populates the phone number field with a number already associated with the Session. Allows the user to review or edit it before continuing.                                                                             |
| **Skip if phone number already collected**<br />_Workflows only_ | Skips this module if a phone number has already been collected in the Session.                     |

<br />

---

- Path: `dashboard-platform-administration/proof-of-address-capture-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/proof-of-address-capture-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/proof-of-address-capture-dashboard.md

# Proof of Address Capture

The Proof of Address module captures a proof-of-address document, such as a utility bill, bank statement, or telecom agreement, as an image or PDF. It then extracts the address data through [OCR](/get-started-with-incode/glossary/#ocr) to validate the user's residential address.

For an overview of this module and how it works, see [Proof of Address Capture](/features-and-modules/proof-of-address-capture/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Proof of Address Capture to Workflows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Proof of Address Capture** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Proof of Address Capture to Flows

1. In Dashboard, find **Build & Verify** in the left menu. Select **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Proof of Address Capture** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

After making changes on any tab, click **Save Configurations** to apply them.

![Image of the Proof of Address Capture configuration screen. Has six configuration options.](https://developer.incode.com/assets/f33e9d37ae6d4629ed8823df9dbf3b28.png)

| Setting                            | Description                                                                                                                                                                                                                |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Title_**                        | Custom title text displayed to the user on the Proof of Address Capture screen. Leave blank to use the default title.                                                                                                      |
| **_Text_**                         | Custom body text displayed to the user on the Proof of Address Capture screen. Leave blank to use the default text.                                                                                                        |
| **_Address fields are mandatory_** | When enabled, the user must recapture their document if a valid address cannot be extracted from it.                                                                                                                       |
| **_Date field is mandatory_**      | When enabled, the user must recapture their document if a required date cannot be extracted from it.                                                                                                                       |
| **_Disable skip POA step_**        | When enabled, the user cannot skip the Proof of Address Capture step. By default, the step includes a skip option.                                                                                                         |
| **_POA as Bank Statement_**        | When enabled, submitted documents are routed through a bank statement processor instead of the standard proof-of-address processor. Enable this when you expect users to submit bank statements as their proof of address. |

<br />

---

- Path: `dashboard-platform-administration/qualified-electronic-signature-dashboard-1`
- URL: https://developer.incode.com/dashboard-platform-administration/qualified-electronic-signature-dashboard-1/
- Markdown: https://developer.incode.com/dashboard-platform-administration/qualified-electronic-signature-dashboard-1.md

# Qualified Electronic Signature

The Qualified Electronic Signature module shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states.

For an overview of this module and how it works, see [Qualified Electronic Signature](/features-and-modules/qualified-electronic-signature/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Qualified Electronic Signature to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Qualified Electronic Signature** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Qualified Electronic Signature to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Qualified Electronic Signature** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![Image of the Qualified Electronic Signature module's configuration panel. Has five configuration options.](https://developer.incode.com/assets/ae1179dcb9954a6601cc39c9d3b2b1c3.png)

| Setting                                           | Description                                                                                                                                                                                                        |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **_Region_**                                      | The region for which Qualified Electronic Signature is configured. Country-specific configurations are available. Contact your Incode representative for more information.                                         |
| **_Allow user to upload document_**               | Allows the user to upload a PDF document to sign. Disabled by default.                                                                                                                                             |
| **_Allow user to download signed document_**      | Allows the user to download the signed document. Enabled by default.                                                                                                                                               |
| **_Type of certificate for signature_**           | The certificate type used to generate the signature. Select one of the following: _One time_ (single-use certificate), _Short term_ (valid for multiple signers or documents), or _Long term_ (extended validity). |
| **_Display email as part of issued certificate_** | Includes the user's email address in the issued certificate. Disabled by default.                                                                                                                                  |

<br />

---

- Path: `dashboard-platform-administration/review-authentications`
- URL: https://developer.incode.com/dashboard-platform-administration/review-authentications/
- Markdown: https://developer.incode.com/dashboard-platform-administration/review-authentications.md

# Review Authentications

The **Authentications** page in Dashboard shows every authentication attempt in your organization, along with details about each one. Authentications are [1:1](/get-started-with-incode/glossary/#11-face-authentication) or [1:N](/get-started-with-incode/glossary/#1n-face-authentication) face searches performed against your identity pool, separate from onboarding Sessions.

When you first open the page, the following columns appear.

| Column                    | Description                                                                                             |
| ------------------------- | ------------------------------------------------------------------------------------------------------- |
| **User**                  | The profile photo captured during the authentication attempt. Click the photo to see an expanded image. |
| **Transaction ID**        | The unique ID generated for the authentication attempt.                                                 |
| **Identity**              | The unique ID of the identity matched during the authentication, if one was found.                      |
| **Source ID**             | The identifier of the source system that initiated the authentication, or _NA_ if none was provided.    |
| **Device Type**           | The type of device used for the authentication: _iOS_, _Android_, _Webapp_, or _NA_.                    |
| **Device Name**           | The model of the device used for the authentication, or _NA_ if unavailable.                            |
| **Version**               | The operating system version of the device used, or _NA_ if unavailable.                                |
| **Timestamp**             | The date and time the authentication attempt occurred.                                                  |
| **Liveness**              | Whether the liveness check succeeded for the authentication attempt.                                    |
| **Confidence**            | The confidence score of the face match, or _NA_ if a score wasn't generated.                            |
| **Video Record**          | Whether a video recording exists for the authentication attempt.                                        |
| **Blocklisted**           | Whether the matched identity is on a blocklist.                                                         |
| **Blocklist Confidence**  | The confidence score of the blocklist match, or _NA_ if not applicable.                                 |
| **Final Result**          | The outcome of the authentication attempt: _Pass_ or _Fail_.                                            |
| **Authentication Mode**   | The matching mode used for the authentication: _1:1_ or _1:N_.                                          |
| **Authentication Method** | The method used to perform the authentication, such as _server_, or _NA_ if unavailable.                |
| **Recognition Threshold** | The confidence threshold configured for a successful face match, or _NA_ if not configured.             |
| **Spoof Threshold**       | The confidence threshold configured for spoof detection, or _NA_ if not configured.                     |

On this page, you can:

- Filter the authentications that are shown
- Export authentications to a CSV file
- Configure your view of the Authentications table

***

## Filter Authentications

You can filter the list of authentications by one or more criteria to find the authentications you need.

1. In the left menu, click **Authentications**.
2. Click **Add Filter** in the top left.
3. Select the filter you want to add:
   - **Transaction ID**: Enter the unique ID for the authentication attempt you want to see.
   - **Identity**: Enter the unique ID of the identity you want to see.
   - **Identity Availability**: Select _Available_ or _Not Available_.
   - **Source ID**: Enter the source ID you want to search for.
   - **Device Type**: Select _iOS_, _Android_, _Webapp_, or _N/A_.
   - **Device Name**: Enter the device model you want to search for.
   - **Version**: Enter the OS version you want to search for.
   - **Timestamp**: Select a start and end date from the calendar to only show authentications that occurred in that range.
   - **Liveness**: Select _Success_ or _Fail_.
   - **Confidence**: Select _Success_, _Fail_, or _N/A_.
   - **Final Result**: Select _Pass_ or _Fail_.
4. Click **Apply**. The table displays the authentications that fit your criteria.
5. Repeat these steps to add any additional filters.

***

## Export Authentications to CSV

1. In the left menu, click **Authentications**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Export to CSV**. Download starts immediately; no dialog appears.

***

## Configure Authentications View

You can show, hide, and reorder columns in the Authentications table. This change only affects your account. Other users still see their own view.

1. In the left menu, click **Authentications**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Table Settings**. The Configure Table View panel slides out from the left.
4. In the Configure Table View panel:
   - Click the eye icon next to a column to show or hide it.
   - Drag a column by its handle (**⋮⋮**) to reorder it.
5. Click **Save View** to apply your changes. This view of the page is shown on future visits, even after logging out.

---

- Path: `dashboard-platform-administration/review-ocr-data-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/review-ocr-data-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/review-ocr-data-dashboard.md

# Review OCR Data

The Review OCR Data module extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr)​. It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields.

For an overview of this module and how it works, see [Review OCR Data](/features-and-modules/review-ocr-data/).

## Supported with:

:white_check_mark: Workflows | :x: Flows

## Add Review OCR Data to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Review OCR Data** module into the builder. Place it after the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

After changing anything, click **Save Configurations** before closing the configuration panel.

![Image of the Review OCR Data module's configuration page. Has two configuration options.](https://developer.incode.com/assets/5bd9d9ac477333c00cca9afacac5bd38.png)

| Setting            | Description                                                                                                                                                                                                                                                                                                               |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Select ID_**    | Specifies which ID in a multi-ID Session this module applies to: _First ID_ or _Second ID_. Use this when your Workflow captures more than one identity document.                                                                                                                                                         |
| **_Editable OCR_** | Allows the user to edit and correct the OCR-extracted values displayed on the review screen. Useful when a field is missing or was misread: for example, when an address is not detected on the document. Enabling this setting may require back-end enablement. Contact your Incode Representative for more information. |

<br />

---

- Path: `dashboard-platform-administration/review-verification-sessions`
- URL: https://developer.incode.com/dashboard-platform-administration/review-verification-sessions/
- Markdown: https://developer.incode.com/dashboard-platform-administration/review-verification-sessions.md

# Review Verification Sessions

The **Sessions** page in Dashboard provides a [table](#sessions-table) that lists every verification session. You can use it to:

- [Filter](#filter-the-sessions-table) to find specific verification sessions.
- Open an individual session and:
  - Review its decision and supporting evidence.
  - See which checks ran and which failed.
  - Review captured identity and document images.
  - Approve, reject, or escalate a session when action is required.
- Investigate fraudulent, rejected, or stuck sessions.
- [Create manual sessions](#create-manual-sessions).
- [Copy session IDs and URLs](#copy-session-ids-and-urls).
- [Export a list of sessions](#export-sessions-list).

<Accordion title="Expand to view image">

![Sessions page table showing Session ID, CURP, Name, Phone Number, Flow, and Started At columns, with an Add Filter button.](https://developer.incode.com/assets/5f40cf58b157048e75b0d09fa9a1e4f9.png)

</Accordion>

When you open an individual session, single session view appears. The single session view you see depends on your [Dashboard version](/dashboard-platform-administration/choosing-between-standard-and-beta/):

- Standard: [Single session view](/dashboard-platform-administration/single-session-view/)
- <Pill type="beta" /> [View session details](/dashboard-platform-administration/view-session-details/)

***

## Sessions Table

The following table describes each column in the sessions table.

| Column | Definition |
| --- | --- |
| **Session ID** | Unique identifier assigned to the verification session. Use it to investigate the session through APIs and logs. |
| **CURP** | The user’s *Clave Única de Registro de Población*, extracted or collected during a Mexican verification flow. |
| **Name** | The user’s name, normally extracted through OCR from the submitted identity document. |
| **Phone Number** | Mobile phone number associated with the session, including its country code when supplied. |
| **Login Hint** | A value you supply to identify or prefill the user during sign-in or session initialization. Its contents depend on the integration. |
| **Flow** | Name of the [Flow](/get-started-with-incode/glossary/#flow) or [Workflow](/get-started-with-incode/glossary/#workflow) used for the session. |
| **Started At** | Date and time when the session began. |
| **Updated At** | Date and time when the session record was last updated. |
| **Completed At** | Date and time when the user completed the required session steps. Blank if the session has not been completed. |
| **Version** | Version of the SDK, web experience, or Incode platform associated with the session. |
| **Score** | Overall numeric verification score calculated from the modules that ran. <br>**Available values:** *0–100* or blank if scoring has not finished. |
| **Validation** | Indicates whether the session decision was produced automatically or finalized through manual review. <br>**Available values:** *Automatic*, *Manual*. |
| **Session Status** | Indicates whether the user completed all required steps in the Flow. Completion does not necessarily mean that background processing or manual review has finished. <br>**Available values:** *Completed*, *Not Completed*. |
| **Gov Verification** | Overall result from checking the user or document information against an authoritative government source. *N/A/Unknown* means the check did not produce a verdict. <br>**Available values:** *Pass*, *Fail*, *N/A/Unknown*. |
| **Fraud Result** | Overall result returned by the [Antifraud Check](/features-and-modules/antifraud-check/) module. <br>**Available values:** *Pass*, *Fail*, *Not Included*. Older sessions may show *Not Applicable* instead of *Not Included*. |
| **Agent** | Reviewer or reviewer profile assigned to handle a session in manual review. Blank if the session is unassigned or does not require review. |
| **Days in Review** | Number of days the session has remained in the manual-review process. Blank if the session is not under review. |
| **External Customer ID** | Customer-defined identifier used to associate the session with a user or record in the customer’s system. |

### Filter the Sessions Table

You can filter the sessions table to:

- Find a specific user or session.
- Review sessions that failed or require manual review.
- Investigate a verification module, fraud result, or government-verification outcome.
- Monitor sessions from a particular Flow, customer, or date range.
- Identify incomplete, expired, or deleted sessions.
- Prepare a focused [CSV export](#export-sessions-list) or audit sample.

You can filter the sessions table by session data, identification details, personal or location data, submitted documents, device information, video-selfie properties, eKYB information, or risk signals. Some filters apply only when the corresponding module ran or collected that data. Text filters use partial matching: for example, entering _Sam_ returns results such as _Samantha_ and _Samson_.

You can combine filters to create a more specific result set. When you apply multiple filters, Dashboard returns sessions that match all selected criteria.

1. In Dashboard, click **Sessions** in the left menu.
2. Click **Add Filter** in the top left.
3. Select a filter.

<Accordion title="Expand to view image">

![Sessions filter panel with criteria organized by category, including Session Data, Identification, Device Data, and eKYB.](https://developer.incode.com/assets/531fc30a59d5cfcfacb882385e71c3b5.png)

</Accordion>

<Accordion title="Expand to learn more about the filters you can select">

Most selectable filters are self-explanatory. For those that are not, see the following table.

| Filter | Definition |
| --- | --- |
| **_Validation_** | Filters sessions by how the verification decision was produced: automatically by the system or through manual review. |
| **_Status_** | Filters by whether the user completed all required steps in the verification journey. <br>**Available values:** *Completed*, *Not Completed*. |
| **_Session State_** | Filters by the session’s data lifecycle state, independently of whether the verification journey was completed. <br>**Available values:** _Alive_ (the session can still be updated); _Closed_ (no further changes can be made); _Deleted_ (PII has been deleted while limited session metadata remains). |
| **_Gov Verification_** | Filters by the overall result of checking the user or document information against an authoritative government source. <br>**Available values:** *Pass*, *Fail*, *N/A/Unknown*. |
| **_Fraud_** | Filters by the result returned by the [Antifraud Check](/features-and-modules/antifraud-check/) module. This is a system-generated result and is different from a user reporting the session as fraudulent. |
| **_Reported as Fraud_** | Filters by whether a Dashboard user manually reported the session as fraud. It does not indicate whether the Antifraud Check module detected fraud. |
| **_Expired_** | Filters by whether the session expired before it reached a final outcome, based on the expiration period configured for the Flow. This is different from an expired identity document. |
| **_Mismatch_** | Filters for sessions containing a selected cross-session mismatch signal, such as a name mismatch with another approved session. |
| **_Days in review_** | Filters by the number of days a session has remained in manual review. |
| **_CURP Empty_** | Filters by whether the session’s CURP field is empty. This is useful for finding Mexican verification sessions where a CURP was expected but was not collected or extracted. |
| **_Device Location_** | Filters by the geographic location reported by the user’s device during the session. This is distinct from the address extracted from an identity document or proof-of-address document. |
| **_File is present_** | Filters by whether a [Video Selfie](/features-and-modules/video-selfie/) file exists for the session. |
| **_File has video_** | Filters by whether the Video Selfie file contains a video track. A file can exist without containing usable video. |
| **_File has audio_** | Filters by whether the Video Selfie file contains an audio track. |
| **_File is not empty_** | Filters by whether the Video Selfie file contains data rather than being an empty file. |
| **_Video selfie quality_** | Filters by the result of the quality checks applied to the Video Selfie recording. This can help identify recordings that are missing, incomplete, corrupted, or unsuitable for processing. |
| **_Unique Beneficial Owner_** | Filters eKYB sessions using information about a business’s unique beneficial owner: the individual who ultimately owns or controls the business. |

</Accordion>

4. Enter or select the filter value.
5. Click **Apply**. The table displays the sessions that fit the filter criteria.
6. Repeat these steps to add additional filters. To remove a filter, click **X** in its badge.

### Configure the Sessions Table

You can change which columns appear in the sessions table and the order they appear in. These changes are only applied to you; they do not impact the sessions table for other users.

1. In Dashboard, click **Sessions** in the left menu.
2. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Table Settings**. The Configure Table View panel slides out from the right.
3. Click and drag a column by its handle ![Two columns of three dots stacked on top of each other](https://developer.incode.com/assets/aa9fe13a-57f7-4b58-8c77-54c120b44135.png#inline) to reorder it.
4. Click **Hide** ![Icon of an eye colored black](https://developer.incode.com/assets/bb34dbb5-92e7-4078-8689-ed767730f00d.png#inline) to hide a column from the table. Click **Show** ![Icon of an eye colored gray](https://developer.incode.com/assets/0418299d-763c-4749-a2a0-6cab849d5bcb.png#inline) to include it again.
5. Scroll to the bottom and click **Save view**. Your changes are maintained after logging out.

***

## Copy Session IDs and URLs

You can copy a Session ID or URL to:

- Share the exact session with a teammate, reviewer, or Incode Support.
- Look up the session through APIs, logs, or internal reporting.
- Reopen the session later without searching the sessions table.

1. In Dashboard, click **Sessions** in the left menu.
2. Find the row for the session you want.
3. In the left column of that row, click **Copy Session ID** ![Icon of a solid square overlapping a dashed square](https://developer.incode.com/assets/99d7251a-1ac8-4ece-8db1-9e1d4458e973.png#inline) or **Copy Session URL** ![Icon of a chain link](https://developer.incode.com/assets/edd65884-bc72-4e4d-87bf-58dcf151c913.png#inline).

***

## Create Manual Sessions

Manual sessions allow you to initiate verification directly from Dashboard by sending an SMS link to a user instead of triggering it from your application. This is useful for agent-assisted call center support, in-branch verification, and re-onboarding, where the user cannot start verification from your application. You can select the appropriate Flow or Workflow before sending the link.

1. In Dashboard, click **Sessions** in the left menu.
2. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **New Manual Session**.
3. Enter the user's phone number. Change the country calling code if needed.
4. Use the **_Flow Type_** drop-down to select _Flow_ or _Workflow_.
5. If you selected _Flow_, use the **_Select Session Flow_** drop-down to select the [Flow](/dashboard-platform-administration/flows-1/) to send to the user.
6. If you selected _Workflow_, use the **_Workflow_** drop-down to select the [Workflow](/dashboard-platform-administration/workflows-20/) to send to the user.
7. Click **Send SMS**.

***

## Export Sessions List

Exporting the sessions list creates a point-in-time record of verification results outside Dashboard. This is useful for compliance retention, audits, offline review, investigations, and sharing results with authorized stakeholders who do not have Dashboard access. Handle exported files according to your organization’s privacy, access-control, and retention policies.

You can [filter](#filter-the-sessions-table) to export only sessions that fit certain criteria.

1. In Dashboard, click **Sessions** in the left menu.
2. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select one of the following:
    - **Export to CSV**: Prepares a CSV file containing the exported session data.
    - **Export to CSV with PDF links**: Prepares a CSV file containing links to PDF reports for sessions that match the CURPs or names you specify. In the dialog, select the **_Type_**: _CURPs_ (Mexico only) or _Names_. Then paste the corresponding values and click **Submit**.

Dashboard notifies you when the file is ready and when the download is complete. Your browser saves the file to its default download location.

:::note
The **Export to CSV with PDF links** option must be enabled for your organization. Contact your Incode representative.
:::

---

- Path: `dashboard-platform-administration/roles-permissions`
- URL: https://developer.incode.com/dashboard-platform-administration/roles-permissions/
- Markdown: https://developer.incode.com/dashboard-platform-administration/roles-permissions.md

# Roles & Permissions

This page describes the roles and permissions available in Dashboard. Roles are assigned when [creating users](/dashboard-platform-administration/manage-users/#create-users) but can be changed later by [editing the user](/dashboard-platform-administration/manage-users/#edit-existing-users).

***

# Executive

This is the lowest-level role in Dashboard. Users with this role can see and review Sessions they worked on in a single organization.

***

# Executive with Custom Permissions

This role has no default access. You must configure granular permissions for the user based on the sections of Dashboard you want them to access.

Some sections of Dashboard are enabled by feature flags and may not be available for your organization. Contact your Incode Representative with any questions.

The following permissions are available for this role:

| Permission                  | Access Details                                                                                                                                                                                                                                                                                                                                           |
| :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ALL                         | Grants full access to every permission listed in this table, as long as the Dashboard section is enabled for your organization.                                                                                                                                                                                                                          |
| users:all                   | Grants access to the [Users](/dashboard-platform-administration/manage-users/) section and all user management functions. Users with this permission cannot modify their own information or role.                                                                                                                                            |
| sessions:all                | Grants access to the Sessions section and all related functions, including the single session view. You can apply **Limited Visibility** to restrict the timeframe for sessions available for the user.                                                                                                                                                  |
| authentications:all         | Grants access to the Authentications section and all related functions. To access Sessions or Identities related to an Authentication, the user must also have **sessions:all** and **identities:all**.                                                                                                                                                  |
| identities:all              | Grants access to the Identities section and all related functions. To access Sessions or Authentications related to an Identity, the user must also have **sessions:all** and **authentications:all**.                                                                                                                                                   |
| flows:all                   | Grants access to create, edit, and delete [Flows](/dashboard-platform-administration/flows-1/). This includes edit access for all modules enabled in the organization.                                                                                                                                                                       |
| custom-watchlist:all        | Grants access to the Custom Watchlist section of Dashboard. The user can view and edit all watchlist entities, manually add an entry to either the Allowlist or the Blocklist, upload a watchlist from their device, or export the watchlist to their device. To create a watchlist entity from an Identity, the user must also have **identities:all**. |
| status:all                  | Grants access to status.incode.com, which shows system operations and any incidents. Users can subscribe to receive updates about outages.                                                                                                                                                                                                               |
| configuration:all           | Grants access to all tabs in the Configuration section.                                                                                                                                                                                                                                                                                                  |
| analytics:all               | Grants access to the Analytics section. The user can view data and metrics on the organization's performance, monitoring, eKYB, and eKYC.                                                                                                                                                                                                                |
| workflows:all               | Grants access to create, edit, and delete [Workflows](/dashboard-platform-administration/workflows-20/). This includes edit access for all modules enabled in the organization.                                                                                                                                                              |
| cms:agent                   | Grants agent-level access to the Case Management section.                                                                                                                                                                                                                                                                                                |
| cms:reviewer                | Grants reviewer-level access to the Case Management section.                                                                                                                                                                                                                                                                                             |
| compliance:all              | Grants access to the Compliance section. This section includes a table view of data added to the system, including new Sessions and Identities. It also includes an audit log of all user activity in the organization. Users can export the audit log to a CSV.                                                                                         |
| escalations:all             | Grants access to the Escalations section. This section shows a table view of escalated Sessions. The table includes the Session ID, the reason for escalation, the escalation status, the Session decision, and more. To access Sessions related to an Escalation, the user must also have **sessions:all**.                                             |
| directory-information:all   | Grants access to the Directory Information section.                                                                                                                                                                                                                                                                                                      |
| integrations:all            | Grants access to the Integrations section.                                                                                                                                                                                                                                                                                                               |
| helpdesk-verifications:all  | Grants access to the Helpdesk Verification section.                                                                                                                                                                                                                                                                                                      |
| candidate-verifications:all | Grants access to the Candidate Verification section.                                                                                                                                                                                                                                                                                                     |

***

# Admin

This role can:

- Access a single organization
- View all sections in dashboard
- Create and edit users with the following roles: Admin, Executive, and Executive with custom permissions

This role cannot:

- Create new organizations
- Create users with the following roles: Super Admin, Integrator, Admin of multiple organizations

***

# Admin of Multiple Organizations

This role grants the same access as the Admin role but allows this access for multiple organizations. When assigning this role, you must select which organizations the user will have admin access to.

***

# Integrator

This role allows a user to create child organizations.

This role can:

- Create and delete child organizations
- Preview all pages from the organization and child organizations
- Create users with the following roles: Admin of multiple organizations, other roles

This role cannot:

- Create users with the following roles: Super Admin, Integrator (will be changed)

<br />

---

- Path: `dashboard-platform-administration/single-identity-view`
- URL: https://developer.incode.com/dashboard-platform-administration/single-identity-view/
- Markdown: https://developer.incode.com/dashboard-platform-administration/single-identity-view.md

# Single Identity View

Single Identity view contains all the information Incode has stored about a user's Identity, including their documents, Sessions, and Authentications.

:::note
The information and images provided on this page are examples. Specific data or details may differ in your configuration.
:::

***

## Enter Single Identity View

1. In the left menu, click **Identities**.
2. Find the Identity you want to review. You can [use filters](/dashboard-platform-administration/view-identities/#filter-identities) to sort the table.
3. Click an Identity to view its details.

***

## Tabs

Single Identity view is organized into four tabs: **General**, **Documents**, **Sessions**, and **Authentications**.

### General

The General tab shows the Identity holder's selfie, name, status, country, and key details. At the top, next to the identity holder's name, you may see one or both of the following labels:

- **Identity confirmed**: Incode successfully verified the identity based on the completed verification checks.
- **Protected**: The Identity is covered by an Incode Protect guarantee.


Below the name, summary cards show:

- **Date of Entry**: The date this Identity was created.
- **Sessions**: The number of Sessions linked to this Identity.
- **Authentications**: The number of Authentications linked to this Identity.
- **Protect Guarantee**: The guaranteed amount covered by Incode Protect if eligible identity fraud occurs. Only appears for Protected Identities.

**General information** shows the Identity holder's personal data:

- **Phone**: The Identity holder's phone number.
- **Identity**: The unique identifier for the Identity.
- **Date of Birth**: The Identity holder's date of birth.
- **Personal ID Number**: The Identity holder's personal ID number, if collected.
- **Address**: The Identity holder's address.
- **Email**: The Identity holder's email address.
- **National ID Number**: The Identity holder's national ID number, if collected.

**Directory information** shows the directory entries linked to this Identity, with one group per connected directory: for example, an Entra or Okta directory. Each directory group shows:

- **Name**: The Identity holder's name as recorded in that directory.
- **Username**: The Identity holder's username in that directory.
- **Email**: The Identity holder's email address in that directory.
- **User ID**: The unique identifier for the Identity holder within that directory.
- **Phone Number**: The Identity holder's phone number, if collected.
- **Date of Birth**: The Identity holder's date of birth, if collected.
- **Street Address**: The Identity holder's street address, if collected.
- **Location**: The Identity holder's location, if collected.
- **Region**: The Identity holder's region, if collected.
- **Postal Code**: The Identity holder's postal code, if collected.
- **Country**: The Identity holder's country, if collected.

Fields that don't have data show a dash (**-**). If the Identity holder isn't linked to any directory, this section doesn't appear.

**Location** shows a map with pins for the Identity holder's Government ID and Device Location addresses. Beside the map, those addresses appear as text:

- **Government ID**: The address on file from the Identity holder's government-issued ID.
- **Device Location**: The location of the device used during verification. Shows _N/A_ if not available.

### Documents

The Documents tab lists every document type Incode can capture, grouped under **All Documents**. It also shows electronic signatures, verbal signatures, and signed contracts under **Signatures**. Click a document type to expand it, or click **Expand all** / **Collapse all** to open or close every section at once.

If the Identity holder hasn't submitted a document of that type, the section shows _N/A_. If they have, the section shows:

- A photo of the captured document.
- The country that issued the document.
- The document's ID number.
- The document's expiration date, if applicable.

### Sessions

The Sessions tab lists every [Session](/dashboard-platform-administration/review-verification-sessions/) linked to this identity.

| Column          | Description                                                                                                                                                          |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Session ID**  | The unique identifier for the Session. Click it to open [single Session view](/dashboard-platform-administration/single-session-view/) for that Session. |
| **CURP**        | The identity holder's CURP (Clave Única de Registro de Población, a personal identification number issued in Mexico), if collected.                                  |
| **Phone**       | The identity holder's phone number.                                                                                                                                  |
| **Flow**        | The name of the Flow or Workflow used for the Session.                                                                                                               |
| **Date & Time** | The date and time the Session took place.                                                                                                                            |
| **Version**     | The platform used for the Session: for example, _Web_.                                                                                                               |
| **Score**       | The verification result: _Pass_, _Fail_, or _Needs Review_.                                                                                                          |
| **Validation**  | Whether the result was determined automatically or needs manual review.                                                                                              |
| **Status**      | The current status of the Session: _Completed_ or _Not Completed_.                                                                                                   |

### Authentications

The Authentications tab lists every [Authentication](/get-started-with-incode/glossary/#authentication) attempt linked to this identity. If none exist, the tab displays "No authentications."

| Column                    | Description                                                                                                                                                                                                                                                |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **User**                  | The Identity holder's photo.                                                                                                                                                                                                                               |
| **Transaction ID**        | The unique identifier for the Authentication attempt.                                                                                                                                                                                                      |
| **Identity**              | The unique identifier for the Identity.                                                                                                                                                                                                                    |
| **Source ID**             | The identifier of the source Session, if applicable.                                                                                                                                                                                                       |
| **Device Type**           | The type of device used for the attempt.                                                                                                                                                                                                                   |
| **Device Name**           | The name of the device used for the attempt.                                                                                                                                                                                                               |
| **Version**               | The platform version used for the attempt.                                                                                                                                                                                                                 |
| **Timestamp**             | The date and time of the attempt.                                                                                                                                                                                                                          |
| **Liveness**              | Whether the attempt passed liveness detection.                                                                                                                                                                                                             |
| **Confidence**            | The confidence score for the face match.                                                                                                                                                                                                                   |
| **Video Record**          | A link to the video recorded during the attempt, if available.                                                                                                                                                                                             |
| **Blocklisted**           | Whether the Identity holder is on the blocklist.                                                                                                                                                                                                           |
| **Blocklist Confidence**  | The confidence score for the blocklist match, if applicable.                                                                                                                                                                                               |
| **Final Result**          | The overall result of the attempt: _Pass_ or _Fail_.                                                                                                                                                                                                       |
| **Authentication Mode**   | Whether the attempt compared against one record ([1:1](/get-started-with-incode/glossary/#11-face-authentication)) or searched across many ([1:N](/get-started-with-incode/glossary/#1n-face-authentication)). |
| **Authentication Method** | The method used to authenticate the Identity holder.                                                                                                                                                                                                       |
| **Recognition Threshold** | The confidence score required for a match.                                                                                                                                                                                                                 |
| **Spoof Threshold**       | The confidence score required to flag a spoof attempt.                                                                                                                                                                                                     |

***

## Add an Identity to a Watchlist

Use the **Blocklist** and **Allowlist** buttons at the top of single Identity view to add the Identity holder to a watchlist.

1. Enter single Identity view.
2. Click **Blocklist** or **Allowlist** at the top.

***

## Delete Identity PII Data

Delete an identity holder's personally identifiable information (PII) when you no longer need to retain it.

1. Enter single Identity view.
2. Click the three dots (**⋯**) in the top right.
3. Select **Delete Identity PII Data**.

<br />

---

- Path: `dashboard-platform-administration/single-session-view`
- URL: https://developer.incode.com/dashboard-platform-administration/single-session-view/
- Markdown: https://developer.incode.com/dashboard-platform-administration/single-session-view.md

# Single Session View

Single Session view contains all the information about an Onboarding or Authentications attempt, including data, captured images, the Flow or Workflow used, and the result.

:::note
The information and images provided on this page are examples. Specific data or details may differ in your configuration.
:::



## Enter Single Session View

1. In the left menu, click **Sessions**.
2. Find the Session you want to review. You can [use filters](/dashboard-platform-administration/review-verification-sessions/#filter-sessions) to sort the table.
3. Click a Session to view its details.



## Sections

Single Session view contains multiple sections. The sections and information displayed in them depends on the Onboarding Flow or Workflow used for the Session.

### Overview

The section at the top of single Session view shows the user's selfie and the following information:

| Field                              | Description                                                                                 |
| ---------------------------------- | ------------------------------------------------------------------------------------------- |
| **Workflow&#x20;**&#x6F;r **Flow** | The name of the Workflow or Flow used for the verification Session.                         |
| **Session ID**                     | The unique identifier for the Session.                                                      |
| **Session Start**                  | The date and time the Session began.                                                        |
| **Session End**                    | The date and time the Session ended.                                                        |
| **Expired At**                     | The date and time the Session expired. If the Session has not expired, this field is empty. |
| **Organization**                   | The organization associated with the Session.                                               |
| **Session Status**                 | The current status of the Session. For example: Completed.                                  |
| **Total Score**                    | The overall verification result for the Session: Pass or Fail.                              |

### Workflows

The Workflows tab shows the user's progression through the Workflow, including:

- The time they started the Workflow
- Each module they completed
- The conditions they met or did not meet
- The time they completed the Workflow
- The Workflow result, if the user completed the Workflow

![Workflow tab showing Workflow progress with six steps and an OK result.](https://files.readme.io/6f837040befca6e11b5c5dd45882d6862de8e353c848281f5f14e52b25b7f2e7-image.png)

This tab does not appear if the session used a Flow.

### ID Verification

The ID Verification tab includes three sections:

- **ID Verification**: Shows the ID verification tests performed and the result of each. At the top, it indicates the total ID verification score and the severity used when calculating that score. Severity controls how strongly failed ID checks deduct points from the total score by applying a multiplier to the checks’ weights:⁠
  - **Conservative**: Multiplier 1.0 (strictest; full deduction)
  - **Medium**: Multiplier 0.7
  - **Relaxed**: Multiplier 0.5 (more lenient)
  - **Soft**: Multiplier 0.0 (failed checks don’t impact the score)


- **ID OCR**: Shows the data extracted from the ID using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr), including data extracted from the [Machine-Readable Zone (MRZ)](/get-started-with-incode/glossary/#mrz). The total score at the top estimates the accuracy of the OCR-extracted ID data.
- **Capture Attempts**: Shows how many attempts the user took to capture their ID and selfie. Expand each section to see the photo the user took.

### Face Recognition

The Face Recognition tab compares the user's selfie and ID photo. It shows the results of checks for face masks, lenses, closed eyes, and hats, if configured in the Workflow. It also shows the results of brightness and image quality checks. The total score at the top indicates how confident Incode is that the selfie and ID photo match.

### Liveness Detection

The Liveness Detection tab shows the Session's liveness scores. Liveness detection confirms that a selfie was captured from a live person rather than from a photo, video, or synthetic image. Depending on how the Workflow is configured, the tab can show up to three scores:

- **Physical Check**: Confidence that the selfie is not a mask or printed photo
- **Digital Check**: Confidence that the selfie is not a screen replay or injected video
- **Evasion Check**: Confidence that there was no attempt to bypass detection

If [Deepsight](/features-and-modules/deepsight/) is enabled, the Deepsight tab appears instead.

### Deepsight

The Deepsight tab shows [Deepsight](/features-and-modules/deepsight/) results for the Session, including the signals and checks used to detect sophisticated fraud such as injection and deepfake attacks. It includes three sections:

- **Multi-Modal Intelligence (MMI)**: Deepsight's core detection results, broken down by attack category. Only checks enabled in the Flow or Workflow appear as active results. Checks that weren't enabled appear as not applicable.
- **Trust Checks**: Higher-level trust signals summarized as pass/fail results, grouped into three categories:&#x20;
  - Device trust
  - Behavior trust
  - Camera trust
- **Media**: Deepsight-related media, including selfie videos and direct video links. You can also view all capture attempts, which is useful for investigation.

### GovMatch

The GovMatch tab shows government-source verification results for the Session. It includes three sections:

- **GovMatch** (Summary): The overall GovMatch score and the provider used. If the check couldn't run, an error code appears here.
- **Data Match**: A field-level comparison of the Session's captured ID data against government database records, plus a Data Match score.
- **Face Match**: A comparison of the Session's selfie against the government database portrait, plus a Face Match score. This section only appears when the provider supports face comparison.

If GovMatch is running in shadow mode, a banner indicates that results don't affect the session's Total Score.

### Video

The Video tab displays recordings captured during the Session. It includes two sections:

- **Video Selfie**: Appears for Video Selfie Sessions. Shows pass/fail results for basic recording checks, including:
  - File is present
  - Video track is present
  - Audio track is present
  - File is not empty
- **Recordings**: Video recordings from ID Capture and Face Capture. You can view and download these recordings. If recordings aren't enabled for the Session's Flow or Workflow, or weren't successfully uploaded, the tab may be empty.

If [Deepsight](/features-and-modules/deepsight/) is enabled, Deepsight-captured video appears in the Deepsight tab instead.

### Business

The Business tab only appears if the [eKYB](/features-and-modules/ekyb/), [Watchlist Business](/features-and-modules/business-watchlist/), or modular [KYB](/features-and-modules/kyb-modules/) modules ran during the Session. It displays different information, depending on which module ran:

- **eKYB results**: Business identity details (name, address, registration/tax identifier, registration status) and verification outcomes (name, address, city, postal code matches). May also include owners, UBOs, and directors.
- **Business Watchlist results**: Business-specific sanctions and PEP screening results.
- **Modular KYB results**: Results of each check requested in the API call for a business entity.

### Risk

The Risk tab shows fraud and risk signals for the Session that fall outside standard ID and face verification scores. It includes the following sections:

- **Watchlist**: Potential matches against watchlist entries, when a Watchlist module is enabled for the Flow or Workflow. If a user matched any entry in the watchlist, the specific field that triggered the match is indicated. If no results appear, the module may not have run or returned no matches.

  You can add a user to a watchlist in single Session view. Click the three dots in the top right and select **Allowlist** or **Blocklist**. A new watchlist entry is created by extracting data from session.


  <Image src="https://files.readme.io/93709e1-Screenshot_2024-07-03_at_14.33.34.png" alt="Next to Add face to database, the three dots icon is clicked. Options for Allowlist and Blocklist appear." align="center" />


- **Risk Signals**: Device and network risk signals, including device reputation, bot level, VPN/proxy likelihood, emulator detection, OS anomaly, remote software level, incognito mode, and screenshots taken.

- **Behavior Risks**: Interaction pattern signals, including time spent, context switches, copy/paste events, autofill events, and hesitation percentage.

Depending on your organization's configuration, the Risk tab may also include outputs from third-party risk providers.


### Trust Graph

The Trust Graph tab shows the [TrustGraph](/features-and-modules/trust-graph-overview/) signals for the Session: which detection categories fired, which returned clean, and which weren't enabled in the Flow or Workflow. It also links out to [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer/) for a session that connects to a detected ring.

The tab is divided into the following sections:

- **Signal summary.** A count of TrustGraph signals found for the Session (for example, "Found 2 signals"), with a link to in-product education about TrustGraph. A signal is counted when a category returns a match on the Session.

- **Detection category cards.** One card per TrustGraph detection category (Velocity Checks, First Party Fraud, Suspected Repeat Fraud, Unusual Activity, and Fraud Rings). Each card shows the category name, a short description of what it checks, and its result for this Session:

  * **No issues detected** (green check): The category ran and found no matches.
  * **A list of matches** (amber warning icons): The category ran and found one or more matches. Each match is shown as a plain-language description of what was detected (for example, "Face has been associated with activity that exceeds normal usage patterns"). Hover the help icon next to each match for additional context.
  * **This category is disabled in your flow configuration and was not executed**: The category is not enabled in the [module configuration](/dashboard-platform-administration/trust-graph-module-configuration) and does not contribute to the overall TrustGraph result.

- **Fraud Ring Analysis.** A graph view of the Session and its connections into any fraud ring it belongs to, with an **Open in Fraud Ring Explorer** button that opens the full ring in [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer). If the Session does not connect to a known ring, the section shows "This session isn't part of a fraud ring."

At the top of the tab, click **Remove** to remove the Session from future TrustGraph checks. Use this when a session should not contribute to detection on other sessions, for example a known internal test session, an in-branch tablet session, or a session confirmed as a false positive during review. This will impact all categories of TrustGraph. There is an option to undo the removal.


- **Device Details**: Device and network information, including device identifiers, OS, browser, SDK version, and IP location.
- **Device Risk**: An overall Device Risk result with available sub-checks, including device reputation, bot level, VPN/proxy detection, emulator detection, OS anomaly, mocked browser, remote software level, incognito mode, and screenshots taken.
- **Behavioral Risk**: An overall Behavioral Risk result with available sub-checks, including motion status, virtual camera detection, inspector opened, and ID/selfie stats analysis. Interaction signals such as time spent, context switches, copy/paste, and autofill events may also appear.
- **Other Documents:** Captured document artifacts from Document Capture or other document modules, when enabled for the Flow or Workflow.
- **Location**: Document and device location data.
- **Signatures**: Signature artifacts captured during the session. Drawn signatures appear as images. Checkbox signatures are shown as JSON web tokens (JWTs) you can store or share with your compliance or legal team.
- **Forms Answers**: User input provided for the questions configured in the [Forms and Data Entry](/features-and-modules/forms-and-data-entry/) module.
![The Forms Answers section on the Other tab in single Session view shows form questions and answers.](https://files.readme.io/b082a215f9275edb0dfa94fde7c23c5fcc9a8f85fbdff8a09de8290d1820cb4b-image.png)



## Add a Face to the Database

Add face to the database to create an [Incode Identity](/get-started-with-incode/glossary/#incode-identity) record for the user from the session's captured face and ID data. This enrolls the face in Dashboard so it can be referenced in future checks and generates a `FACE_ADDED_TO_DATABASE` event in **Compliance** > **Audit Logs**. The button appears when an identity record doesn't yet exist for the session.

1. Enter single Session view.
2. Click **Add Face to Database** at the top.



## Escalate a Session

Escalate a session when you need Incode's internal teams to review a problem tied to that session. Common reasons include false approvals or rejections, classification or OCR errors, and bugs or incorrect data shown in Dashboard.

1. Enter single Session view.
2. Click **Escalate** at the top.
3. In the Escalation dialog, select an **Escalation Reason** from the drop-down.
4. If the **Issues** drop-down appears, select the issue related to the escalation reason.
5. In **Comments**, enter details about why you're escalating this session.
6. Click **Open Escalation**.

<br />

---

- Path: `dashboard-platform-administration/trust-graph-fraud-ring-explorer`
- URL: https://developer.incode.com/dashboard-platform-administration/trust-graph-fraud-ring-explorer/
- Markdown: https://developer.incode.com/dashboard-platform-administration/trust-graph-fraud-ring-explorer.md

# Fraud Ring Explorer

Fraud Ring Explorer is the Dashboard investigation surface for fraud rings that [TrustGraph](/features-and-modules/trust-graph-overview/) discovers across your organization's sessions. Rings are groups of sessions linked by shared attributes such as face, document, device, name, IP address, and email, exposing the structure behind sessions that look unrelated one at a time.

Fraud Ring Explorer is available in the left menu when the feature is enabled for your organization. If you don't see the Fraud Ring Explorer, contact your Incode representative for more information about TrustGraph.

Fraud rings appear in two places:

- **Real-time signal.** During verification, a session's attributes are evaluated against the rings already discovered in your history. If the session connects to one, the **Fraud Rings Detection** category returns `AT_RISK` and the [reason codes](/general-reference/trust-graph-reason-codes) on the match explain why. This is a TrustGraph detection category like any other. The signal is visible in the [single Session view](/dashboard-platform-administration/single-session-view/#trust-graph).
- **Fraud Ring Explorer.** The investigation surface documented on this page. An analyst uses Fraud Ring Explorer to see the rings TrustGraph has discovered across your organization's sessions, work out what holds each one together, and decide what to do about it.

The two surfaces feed each other. Rings discovered in your history sharpen the real-time signal on new sessions, and a session flagged in real time is a doorway into the ring it belongs to.

## The rings list

The Fraud Ring Explorer landing view is a sortable table of every ring discovered in your organization's history. On this page, you can:

- **Search rings...** for finding a ring by name or ID.
- Use the filter drop-down to find rings by status.
- **Learn how fraud rings work**, which opens a short in-product walkthrough of the rings list and the [ring detail view](#ring-detail-view).



The table has the following columns:

| Column | What it shows |
| --- | --- |
| **Ring name** | An editable name for the ring, defaulting to an auto-generated identifier based on the ring type (for example, `identity_theft`, `document_reuse`, `duplicate_biometrics`). Rename rings to reflect your team's own investigation language. |
| **Ring ID** | The ring's UUID with a copy control. Use it when referencing the ring in your own case management or ticketing systems. |
| **Status** | The ring's current status. Set by analysts from the ring's deep dive view. </br> **Under Review** means the ring is awaiting analyst review; **Validated** means an analyst has reviewed the ring and confirmed it as a genuine ring for your team's records.. |
| **First seen** | The date the ring first appeared in your data. Distinguishes long-running operations from new activity. |
| **Last active** | Relative time since the most recent session in the ring (for example, "3d ago", "2mo ago"). Separates live threats from historical ones. |









Every column is sortable. Sort by **Last active** to see what is happening right now. Sort by **First seen** to find operations that have been running quietly for months. Filter by **Under review** to work the review queue.

## Ring detail view

Clicking a ring name in the list opens its detail view: a deep dive into the ring's identity, evidence, and structure. The detail view is where you assess what's actually going on in the ring, investigate individual sessions and attributes, and record what you found. Use the **All rings** link in the top-left to return to the list.

### Assess the ring

The sidebar on the left summarizes what TrustGraph knows about the ring as a whole and gives you the evidence you need to judge it.

- Read the **Passed sessions count** (for example, "0 / 347 Passed sessions") to gauge the ring's shape. A ring dominated by failed sessions is likely already being caught by your existing checks; a ring dominated by passed sessions is a different kind of risk that made it through.
- Use the **More info** expander to reveal additional metadata about the ring and check the last-updated timestamp to see whether new sessions have joined since your team last reviewed it.
- Use the **Most reused** tab to identify the backbone of the ring. The attributes at the top of the list carry the most sessions and are usually what actually binds the ring, whether that's a single document, a device, or a face on ID.
- Switch to the **By type** tab when you want to categorize the ring by attribute kind (Document, Device, Name, Face, Face on ID, IP Address) rather than by volume. This is faster when you already suspect a specific vector.

### Explore the graph

The graph canvas on the right shows the ring's structure. Labelled hub nodes represent shared attributes; the sessions that reuse each attribute radiate out as dots, with green dots for passed sessions and red dots for failed sessions. The graph is interactive; click any node to open a detail panel and pivot into it.

- Use the canvas controls at the bottom to navigate: pan, fit to view, reset, zoom in and out, export, and toggle the hover behavior.
- Follow the largest hubs first. A hub with many red dots points to a rejected pattern; a hub with many green dots points to sessions that got through despite reusing the same attribute.
- Click an attribute hub node (Device, IP Address, Document, Face, Name, Face on ID) to open its **Node Detail** panel on the right. The panel shows the node's identifier (with a copy control), a summary of its **Fail rate**, **Countries**, and **Peak 24h**, and the full list of **Linked sessions** that use it. Click **Open session** on any session to open its Session Detail panel.
- Click a session dot to open its **Session Detail** panel. The panel shows the person's identity summary (session ID, country, date of birth, session status), the count of **Linked attributes** for that session, and the list itself. Click **Open node** on any attribute to jump to that node's detail panel, or **Open session** to open the full session in Dashboard.
- Use the Session Detail and Node Detail panels together to pivot through the ring: from a suspicious session to the attributes it shares, from a shared attribute to every other session that carries it, and back again. This is how you build the case for why a ring is what you think it is.

### Record what you found

Open the **Notes** workspace from the top-right of the sidebar to capture your reasoning: why you reached your conclusion, what you checked, what you ruled out. Notes stay with the ring so the next analyst, the next shift, or a later audit doesn't repeat work that has already been done.





### Move the ring through its lifecycle

Click the status badge at the top of the sidebar to open the dropdown and set the ring's status. This is how work is handed between analysts and how your team signals that a ring has been dealt with.







## A typical investigation



Investigations vary, but Fraud Ring Explorer supports an investigation workflow along the following shape:

1. **Start from the queue or from a session.** Open a ring from the rings list or click through from the Fraud Rings card on a session flagged in real time in the [single Session view](/dashboard-platform-administration/single-session-view/).
2. **Assess the ring's shape** in the sidebar (passed / failed split, backbone attribute).
3. **Investigate in the graph** by pivoting through Session Detail and Node Detail panels to build the case.
4. **Record your reasoning** in Notes.
5. **Set the ring's status** to signal the outcome to the rest of the team.
6. **Action the connected sessions under your own policy, then report confirmed fraud back.** TrustGraph returns signals and structure; the decision to block, freeze, review, or leave alone is always yours.







- [TrustGraph](/features-and-modules/trust-graph-overview) (Feature Deep Dive): What TrustGraph is, its detection categories, and how the Fraud Rings category fits into the overall status.
- [TrustGraph module configuration](/dashboard-platform-administration/trust-graph-module-configuration): How to enable Fraud Rings Detection in your Flows and Workflows.
- [TrustGraph Reason Codes](/general-reference/trust-graph-reason-codes): The reason codes emitted by Fraud Rings Detection.
- [Single Session View, Trust Graph tab](/dashboard-platform-administration/single-session-view/#trust-graph): Reading Fraud Rings results for an individual session in Dashboard.

---

- Path: `dashboard-platform-administration/trust-graph-module-configuration`
- URL: https://developer.incode.com/dashboard-platform-administration/trust-graph-module-configuration/
- Markdown: https://developer.incode.com/dashboard-platform-administration/trust-graph-module-configuration.md

# Trust Graph
[TrustGraph](/features-and-modules/trust-graph-overview) is Incode's privacy-preserving trust network. It runs on every session in a flow that has it enabled and returns real-time signals when a session's attributes have shown up before in ways worth flagging, in your own history or across the network.

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add TrustGraph to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Add verification modules such as [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) or [Face Capture](/dashboard-platform-administration/face-capture-dashboard/).
4. From the Processes list, drag and drop **TrustGraph** into the builder.
5. <Pill type="beta" /> Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Processes**, then search for and select **Face Authentication**.
6. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Trust Graph to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Trust Graph** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options


<Component slug="standard-vs-beta-callout" />

<Accordion title="View Standard configuration">

![TrustGraph module configuration panel in Standard Dashboard with five fraud detection toggles (First Party Fraud, Suspected Repeat Fraudster, Unusual Activity, Velocity Checks, Fraud Rings), all disabled, and a warning to enable at least one reason category.](https://developer.incode.com/assets/7b48b811-c0d6-4eec-a6d0-9a58a986cbc5.png)

</Accordion>

<Accordion title="View Beta configuration">
<Pill type="beta" />



![TrustGraph module configuration panel in Beta Dashboard with five fraud detection toggles (First Party Fraud, Suspected Repeat Fraudster, Unusual Activity, Velocity Checks, Fraud Rings), all disabled, and a warning to enable at least one reason category.](https://developer.incode.com/assets/f16804af-9abd-49e5-bc2f-fa95863a0492.png)



</Accordion>



This section details all the configuration options available for the TrustGraph module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

Each setting represents a [category](/features-and-modules/trust-graph-overview/#categories). Turning a category on evaluates it against every session in the flow; turning it off returns `NOT_EXECUTED` for that category and excludes it from the overall TrustGraph status. You must enable at least one to add the module to the flow.

| Toggle | Description |
| --- | --- |
| **First Party Fraud Detection** | Checks whether the session has been reported by an Incode customer as associated with first party fraud (rewards abuse, account selling, mule and circular trading patterns, and similar). |
| **Suspected Repeat Fraudster Detection** | Checks whether the identity in this session has been previously marked as fraud by Incode. Compares against the Suspected Fraud List using face, face-on-ID, device hash, and document, personal, or voter numbers. |
| **Unusual Activity Detection** | Checks for inconsistencies across sessions, such as one document appearing with several faces, one face presenting several documents, or one device tied to conflicting identities. |
| **Velocity Checks** | Detects suspicious patterns in verification attempt frequency and timing. Flags the same face, face-on-ID, document number, personal number, voter number, or device onboarding more times than the configured threshold within the configured time window. |
| **Fraud Rings Detection** | Checks whether the session is risky due to association with a fraud ring discovered in your history. See [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer) for the investigation surface. |





## Add Conditions

[Conditions](/dashboard-platform-administration/configure-workflow-conditions/) let you branch the Workflow based on the TrustGraph verification result. When adding a Condition after the TrustGraph process, search, filter, or browse for the **Trust graph** section in the first drop-down and select from the following options:

| Condition | Description |
| --- | --- |
| OVERALLRISK | The overall TrustGraph status for the session. Returns `AT_RISK` when at least one enabled reason category is `AT_RISK`; otherwise returns `OK`. |
| UNUSUALACTIVITYRISK | Whether the Unusual Activity Detection category returned `AT_RISK` for the session. |
| KNOWNFRAUDSTERRISK | Whether the Suspected Repeat Fraudster Detection category returned `AT_RISK` for the session. |
| FIRSTPARTYFRAUDRISK | Whether the First Party Fraud Detection category returned `AT_RISK` for the session. |
| VELOCITYCHECKSRISK | Whether the Velocity Checks category returned `AT_RISK` for the session. |

All TrustGraph Conditions use the same operators (`==`, `!=`) and possible values (`AT_RISK`, `OK`).

---

- Path: `dashboard-platform-administration/video-conference-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/video-conference-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/video-conference-dashboard.md

# Video Conference

The Video Conference module connects the user with a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements.

For an overview of this module and how it works, see [Video Conference](/features-and-modules/video-conference/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Video Conference to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Video Conference** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Video Conference to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Video Conference** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save Configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![Image of the Video Conference module's configuration page. Has one configuration option.](https://developer.incode.com/assets/6c5e02c8855ec1134f334db7e7e801c0.png)

### General

| Setting                     | Description                                                                                                            |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **_Enable conference OTP_** | Requires the user to verify their identity using a one-time passcode (OTP) before the video conference session begins. |

<br />

---

- Path: `dashboard-platform-administration/video-selfie-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/video-selfie-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/video-selfie-dashboard.md

# Video Selfie

The Video Selfie module records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent.

For an overview of this module and how it works, see [Video Selfie](/features-and-modules/video-selfie/).

## Supported With:

:white_check_mark: Flows | :white_check_mark: Workflows

## Add Video Selfie to Workflows

1. In the left menu in Dashboard, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) and [Face Capture](/dashboard-platform-administration/face-capture-dashboard/) modules are in your Workflow.
4. Add the **Video Selfie** module. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: After the ID Capture and Face Capture modules, click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) > **Modules**, then search for and select **Video Selfie**.
    - **Classic**: From the Modules list, drag and drop the **Video Selfie** module into the builder after the ID Capture and Face Capture modules.
5. You can click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

:::info
In Workflows, Dashboard does not enforce that ID Capture and Face Capture are present before Video Selfie. Adding Video Selfie without preceding ID Capture and Face Capture steps will produce unexpected behavior. Additionally, the **Use as Selfie** setting has a known issue in Workflows that may cause session errors. See the setting description below for details.
:::

### Add Async Resolution

Video Selfie is an asynchronous module. It finishes the user interaction quickly, but the final result is not ready immediately. If you run normal branching conditions directly after an asynchronous module, the logic may break.

A Process node called Async Resolution prevents this. It instructs the back end to wait for Video Selfie to finish before evaluating conditions and producing a final score or decision. Every branch of your Workflow that includes Video Selfie must include an Async Resolution node before it ends. You can only add conditions after Async Resolution.

1. Open the Workflow where you added the Video Selfie module.
2. From the **Async** list, drag and drop the **Async Resolution** node into the builder. Place it at the end of each branch that includes a Video Selfie module.

:::note
This is only required for Workflows, not Flows.
:::

## Add Video Selfie to Flows

1. In the left menu in Dashboard, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find Video Selfie and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

:::note
In Flows, Dashboard does not allow you to add Video Selfie if you have not previously selected Face Capture. This prevents misconfigured sessions.
:::

## Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the **New** or **Classic** view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click **Save configuration** before closing the configuration panel.

The settings you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

### Configuration Options: New

In New view, the Video Selfie module's configuration panel has three tabs that categorize its settings:

- **Capture options**: Configure the user experience and recording process for the video selfie.
- **Fraud prevention**:  Configure liveness, quality, and other checks that help detect spoofing and fraudulent recordings.
- **Compliance**: Configure spoken consent requirements.

#### Capture Options

| Setting | Description |
|---|---|
| **_Show videoselfie tutorial_** | Show step-by-step instructions before the user records the video selfie. |
| **_Use as selfie_** | Use the face captured during the video selfie in place of a separate selfie capture. |
| **_Max execution time (seconds)_**<br />_Flows only_ | Set the maximum time allowed to complete and upload the video selfie before the module times out. The default is _240_ seconds. |
| **_Mask check_**<br />_Flows only_ | Check whether the user’s face is covered by a mask during the video selfie. |
| **_Lenses check_**<br />_Flows only_ | Check whether the user is wearing glasses or other lenses that may obstruct the face. |
| **_Hat check_**<br />_Flows only_ | Check whether the user is wearing a hat or other headwear during the video selfie. |
| **_Closed eyes check_**<br />_Flows only_ | Check whether the user’s eyes are closed during the video selfie. |

#### Fraud Prevention

| Setting | Description |
|---|---|
| **_Liveness check_** | Verify that the person in the recording is live and physically present during the video selfie. |
| **_Face recognition severity_** | Set how strictly the face in the video must match the reference face captured earlier in the session: _Low_, _Medium_, or _High_. |
| **_Capture ID during session_** | Prompt the user to present the front and back of their ID during the video selfie. |
| **_Match face to ID photo_** | Compare the user’s face in the video with the portrait on the ID presented during the video selfie. |
| **_Check front of ID text_** | Compare text extracted from the front of the ID presented in the video with the previously captured ID data. |
| **_Check back of ID document type_**<br />_Flows only_ | Verify that the back of the ID presented in the video is the same document type as the previously captured ID. |
| **_Check back of ID text_**<br />_Flows only_ | Compare text extracted from the back of the ID presented in the video with the previously captured ID data. |
| **_Include video quality in score_** | Allow video quality results, such as empty, frozen, or black video, to affect the final video selfie score. |
| **_Quality check window (seconds)_** | Set how many seconds from the end of the recording are analyzed for video quality. |
| **_Capture supporting document_** | Prompt the user to present an additional supporting document during the video selfie. |

#### Compliance

| Setting | Description |
|---|---|
| **_Spoken consent on camera_** | Prompt the user to read a consent statement aloud while being recorded, creating evidence of their agreement. |
| **_Number of questions_**<br />_Flows only_ | The number of random questions the user reads aloud while being recorded. The default is _3_. The higher the number of questions, the stricter the check. |

### Configuration Options: Classic

| Setting                                           | Description                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Face Recognition Severity_**                   | Sets the strictness threshold for the face recognition check. Options: _Low_, _Medium_ (default), _High_. Higher severity requires a closer match between the selfie captured during Video Selfie and the selfie from the prior Face Capture step.                                                                                                                                       |
| **_Use as Selfie_**                               | When enabled, the selfie captured during Video Selfie is used as the Face Capture for the session. This allows Video Selfie to substitute for a separate Face Capture step. **Note:** This option has a known issue in Workflows that causes a session error when no preceding Face Capture step is present. It works correctly in Flows.                                                |
| **_Liveness_**                                    | When enabled, runs a real-time liveness check during the selfie capture to confirm the user is physically present and not a spoof or static image.                                                                                                                                                                                                                                       |
| **_Lenses validation_**<br />_Flows only_ | Detect whether the user is wearing glasses or other eyewear that may obscure the eyes. |
| **_Mask validation_**<br />_Flows only_ | Detect whether the user is wearing a face covering that obscures facial features. |
| **_Hat validation_**<br />_Flows only_ | 	Detect whether the user is wearing headwear that may obscure the face or forehead. |
| **_Closed eyes validation_**<br />_Flows only_ | Detect whether the user’s eyes are closed in the captured selfie. |
| **_ID Scan_**                                     | When enabled, prompts the user to show their identity document during the video recording.                                                                                                                                                                                                                                                                                               |
| **_Compare ID Enabled_**<br />_Workflows only_                          | When enabled, compares the ID shown during Video Selfie against the ID captured in the earlier ID Capture step to verify it is the same document.                                                                                                                                                                                                                                        |
| **_Compare OCR Enabled_**<br />_Workflows only_                         | When enabled, compares the full name extracted via OCR from the ID shown during Video Selfie against the OCR data captured in the earlier ID Capture step.                                                                                                                                                                                                                               |
| **_ID & Face Match Comparison_**<br />_Flows only_ | Checks whether the face in the Video Selfie matches the photo on the ID captured earlier. |
| **_ID OCR Comparison_**<br />_Flows only_ |  Compares text extracted from the ID shown during Video Selfie with text extracted from the ID captured earlier. |
| **_Back ID Type Comparison_**<br />_Flows only_ | Checks whether the back of the ID shown during Video Selfie matches the back ID captured earlier. |
| **_Back ID OCR Comparison_**<br />_Flows only_ | Compares text extracted from the ID’s back during Video Selfie with text extracted from the back captured earlier. |
| **_Tutorials_**                                   | When enabled, displays instructional screens guiding the user through the Video Selfie steps before recording begins.                                                                                                                                                                                                                                                                    |
| **_Allow Video Quality results to affect score_** | When enabled, video quality checks can affect the session score. These checks include whether the video file is present, is non-empty, and contains both video and audio. When disabled (default), these checks are recorded but do not affect scoring. **Note:** This setting is not fully supported in Workflows. Enabling it in a Workflow may not produce the expected score impact. |
| **_Execute video quality check for the last seconds of the video_**                                     | The number of seconds at the end of the video to evaluate. Default: _15_.                                                                                                                                                                                                                            |
| **_Authorization screen_**                        | When enabled, displays a screen to the user before the video recording begins.                                                                                                                                                                                                                              |
| **_Document Scan_** | Lets the user present a document to the camera during Video Selfie. Support for this setting varies across SDKs. |
| **_Voice Consent_**                               | When enabled, prompts the user to read a consent statement aloud during the recording. The spoken text is transcribed and validated against the expected statement. When **_Voice Consent_** is enabled, all video quality checks must pass for the Video Selfie score to have a chance of success.                                                                                      |
| **_Questions Count_**                             | The number of questions presented to the user during the Voice Consent step. Default: 3. Only applicable when **_Voice Consent_** is enabled.                                                              |
| **_Max video selfie execution time in seconds_**<br />_Flows only_ | Sets the time allowed for the user to complete Video Selfie and for its results to process. Default: _240_ seconds. |

---

- Path: `dashboard-platform-administration/view-analytics`
- URL: https://developer.incode.com/dashboard-platform-administration/view-analytics/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-analytics.md

# View Analytics: New

:::info
In Standard Dashboard, [Classic Analytics](/dashboard-platform-administration/view-analytics-classic/) is also available. Switch between **New** and **Classic** using the toggles in the top right. In Beta Dashboard, only New Analytics is available. [Learn more about Standard and Beta](/dashboard-platform-administration/choosing-between-standard-and-beta/) and contact your Incode representative for more information.
:::

The **Analytics** page in Dashboard provides a live view of every session in your Incode environment. You can use it to:

- **Explore focused views**: Switch between [pre-built views](#pre-built-views) for **Overview**, **Fraud**, **Conversion**, and **Users**, each with its own KPIs, trends, and maps.
- **Track performance**: See key verification, fraud, and conversion metrics as soon as you open the page.
- **Filter everything at once**: [Narrow all the data](#filter-your-data) by channel, country, flow, device, ID template, and more.
- **Build custom views**: [Build your own views](#build-custom-views) from a library of widgets, including KPIs, charts, maps, and funnels.

:::note
There is a short delay before new sessions appear in Analytics.
:::

The Analytics page includes:

- **Tabs**: Tabs for the built-in **Overview**, **Fraud**, **Conversion**, and **Users** views appear first, followed by a tab for each custom view you create. Click **New View** to [add a custom view](#build-custom-views).
- **Date picker**: Click the date range in the top right to change it. Select dates on the calendar or one of the preset options: _Yesterday_, _Last 7 days_, _Last 30 days_, _Last 90 days_, or _Last 365 days_. The default is _Last 30 days_. Your selection applies to every view.
- **Filters**: Click **Add filter** to [filter the data](#filter-your-data) that appears. Filters apply to every widget in every view.

***

## How It Works

Every completed session sends its outcome to Analytics. Analytics gathers these outcomes for your chosen time range and filters, then shows them in the pre-built views and any custom views you build.

```mermaid
flowchart LR
  S[Session] --> W[Workflow outcome]
  W --> AG[Analytics aggregates]
  AG --> OV[Pre-built views]
  AG --> CV[Custom views]
```

You don't need to configure anything. Views populate as soon as you have session traffic.

***

## Pre-Built Views

Analytics comes with four pre-built views, each shown as a tab at the top of the page:

- **Overview**: Shows a high-level snapshot of the most critical performance metrics.
- **Fraud**: Shows how much fraud was caught, trends, detection rates, and geographic distribution.
- **Conversion**: Shows approval and rejection rates, trends, and geographic distribution.
- **Users**: Shows verification volume, including total sessions and identities, trends, and geographic distribution.

### Work with Widgets

Each view is made up of widgets. Depending on the widget, you can:

- Hover over a chart, map, or slice to see its exact values.
- Click an item in a chart's legend to hide or show it.
- Use the toggle or drop-down in a widget's header to change how its data is displayed, such as switching between counts and percentages.
- On maps, click the US to see state-level detail. Click the **X** above the US map to return to the world map. 

***

## Filter Your Data

Filters apply to every view in Analytics. To add filters:

1. In Dashboard, click **Analytics** in the left menu.
2. Click **Add filter**.
3. Select a filter:
   - **_Country_**_:_ The country associated with the session. Values come from the countries in your own traffic.
   - **_Device Type_**_:_ The device that ran the capture: _iOS_, _Android_, or _Web App_.
   - **_Flow_**_:_ The Flow or Workflow that the session ran. Values reflect your [Flows](/dashboard-platform-administration/flows-1/) and [Workflows](/dashboard-platform-administration/workflows-20/).
   - **_ID Template_**_:_ The type of identity document: _Driver's License_, _Federal ID_, _Identification Card_, _Medical Card_, _Military_, _Other_, _Passport_, _Permit_, _Residence Document_, _Tax Identification_, _Travel Document_, _Tribal Identification_, _Unknown_, _Visa_, or _Voter Identification_.
   - **_Session Outcome_**_:_ The final status of the session: _Abandoned_, _Approved_, _Failed_, or _Manual Review_.
   - **_Decision Source_**_:_ _Automated_ if the outcome was decided automatically, or _Manual_ if it was decided by a person through manual review.
   - **_Channel_**_:_ The integration surface the session came through: _API_, _Mobile_, or _Web_.
   - **_Issuing State_**_:_ The US state or government body, such as _USCIS_, that issued the identity document.
4. Select the value you want to filter by. You can select only one value per filter.
5. Repeat for all the filters you want to add. You can add each filter once.

The filter appears as a badge, such as `Channel: Web`. It is applied automatically and immediately. Click **X** next to a filter to remove it.

***

## Build Custom Views

Build a custom view to focus on the data that matters most to your organization. Display that data in one place, in the way that best supports your goals. You can also display data from the pre-built views with a different chart type: for example, as a bar chart instead of a donut chart.

:::note
Custom views are visible only to the user who creates them. Other users in your organization can't see your custom views.
:::

1. In Dashboard, click **Analytics** in the left menu.
2. Click **New View**.
3. Click **_Untitled view_** and enter a new, descriptive name for this custom view. Every change saves automatically.
4. Click **Add your first widget**. The Add a widget panel opens on the right side of your screen.
5. Choose a data source from the **_Data_** drop-down.
6. Under **_Chart Type_**, select how to display the data. You can select only charts compatible with the data source you selected.
7. Edit the widget's **_Title_** or leave the default.
8. Click **Add widget**.
9. Repeat for all the widgets you want to add.
10. You can configure how the widgets appear in the view by:

    - Dragging and dropping them.
    - Resizing them using their handle in the bottom right corner.

    Click **Edit** ![Icon of a pencil](https://developer.incode.com/assets/c7e8dede-8700-4f17-89b8-5d4dfdcc219b.png#inline) in the top right of any widget to change its **_Data_** source, **_Chart Type_**, or **_Title_**.

11. When you're satisfied with your view, click **X** to close the builder.

***

## Delete Custom Views

You can delete custom views you no longer use. Deleting a custom view cannot be undone.

1. In Dashboard, click **Analytics** in the left menu.
2. Hover over the tab for the custom view you want to delete and click **Delete** ![Icon of a trash can](https://developer.incode.com/assets/e480c993-a89d-44c1-ae9b-d8a98334644c.png#inline).
3. In the dialog that appears, click **Delete view**.

---

- Path: `dashboard-platform-administration/view-analytics-classic`
- URL: https://developer.incode.com/dashboard-platform-administration/view-analytics-classic/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-analytics-classic.md

# View Analytics: Classic
:::info
In Standard Dashboard, [New Analytics](/dashboard-platform-administration/view-analytics/) is also available. Switch between **Classic** and **New** using the toggles in the top right. In Beta Dashboard, only New Analytics is available. [Learn more about Standard and Beta](/dashboard-platform-administration/choosing-between-standard-and-beta/) and contact your Incode representative for more information.
:::

The **Analytics** page in Dashboard, when set to the Classic version, provides a set of Tableau-based reports on your Incode environment. You can use it to:

- **Review your performance**: See volume, conversion, approval, and fraud metrics for your [Flows](/dashboard-platform-administration/flows-1/) and [Workflows](/dashboard-platform-administration/workflows-20/).
- **Monitor funnels and capture attempts over time**: Track how sessions move through each step and how many capture attempts users make.
- **Review business verification results**: See eKYB verification outcomes for business details and beneficial owners.
- **Review identity verification results**: See eKYC verification outcomes for an individual's identity details.
- **Filter everything at once**: Narrow the data on any tab by client, flow, device, or country.

The Analytics page includes four tabs: **Performance**, **Monitoring**, **eKYB**, and **eKYC**.

:::note
Classic Analytics includes a **Help** [sub-tab](#help) under **Performance**. That sub-tab contains detailed documentation. This page provides a general overview of Classic Analytics.
:::



***

## Performance

The **Performance** tab reports on your onboarding sessions. It includes its own set of sub-tabs: **Overview**, **Completion**, **Approvals**, **Fraud & Risk**, **Transactions**, **Data Dictionary**, and **Help**.

Use the filter bar at the top of the tab to narrow the data by **_Client ID_**, **_Flow_**, **_Device Type_**, and **_Country Code_**.

### Overview

The **Overview** sub-tab shows four cards:

- **Volume**: How many sessions entered, started capture, and completed your onboarding process.
- **Conversion**: How sessions converted at each stage, from capture started through completion.
- **Approval**: How many sessions were approved, and at what rate.
- **Fraud**: How accurately your Flow or Workflow told genuine users and bad actors apart, and how many bad actors it stopped.

### Completion

The **Completion** sub-tab shows two cards:

- **Completed Onboardings**: How many sessions completed your onboarding process, as well as the percentage of completed sessions.
- **Funnel Analysis**: Where sessions drop off across your onboarding steps, for a Flow or Workflow you select.

### Approvals

The **Approvals** sub-tab shows two cards:

- **Approved Onboardings**: How many sessions were approved or rejected, and the percentages of each.
- **Rejected Sessions**: How many sessions were rejected, broken down by reason.

:::note
Correctly Rejected and Incorrectly Rejected rates need a sample of at least 5% to calculate.
:::

### Fraud & Risk

The **Fraud & Risk** sub-tab shows two cards:

- **Fraud & Risk**: How accurately your Flow or Workflow accepted genuine users and rejected bad actors.
- **Attacks from Bad Actors**: How often bad actors attacked your Flow or Workflow, and how often those attacks were caught.

### Transactions

The **Transactions** sub-tab shows a breakdown of your billable transactions: completed sessions, and sessions that did not complete but still triggered a process ID.



### Data Dictionary

The **Data Dictionary** sub-tab lists every field used across the Performance tab's sub-tabs, with its scope, type, and definition. Use it as a reference if you're not sure what a metric measures.

### Help

The **Help** sub-tab provides detailed documentation for Analytics, including how to find the page in Dashboard, how to request access for teammates, and an example of how to interpret the data.

***

## Monitoring

The **Monitoring** tab reports on funnel timing and capture attempts. It includes two sub-tabs: **Funnel Timeline** and **ID Attempts**.

Use the filter bar at the top of the tab to narrow the data by **_Client ID_**, **_Flow_**, and **_Device Type_**.

### Funnel Timeline

The **Funnel Timeline** sub-tab shows the Funnel Timeline Analysis card. Use the **_Country Code_** and **_Type of ID_** drop-downs in the card's header to narrow its data.



### ID Attempts

The **ID Attempts** sub-tab shows the ID Attempt Timeline card, with its own **_Type of ID_** drop-down. It includes four charts:

- **Front ID Attempts Timeline**: How many times users attempted to capture the front of their ID, over time.
- **Back ID Attempts Timeline**: How many times users attempted to capture the back of their ID, over time.
- **Selfie Attempts Timeline**: How many times users attempted a selfie capture, over time.
- **No Front & Back ID Attempts Timeline**: How many sessions had no front or back ID capture attempt at all, over time.

***

## eKYB

The **eKYB** tab reports on business verification results. Use the filter bar at the top of the tab to narrow the data by **_Country_**, **_Date Range_**, **_Client ID_**, and **_Flow_**.

The tab shows a count of eKYB sessions for the selected date range, followed by cards for each verification check:

- **Business taxID**: Verified or Unverified.
- **Business Name**: Verified, Approximate Match, or Unverified.
- **City Verification**: Verified, Approximate Match, or Unverified.
- **Postalcode Verification**: Verified or Unverified.
- **Legal Status**: Activated, Unfitted, or Deactivated.
- **Business unique beneficial owner (UBO 1–4) verification**: Verified, Approximate Match, or Unverified, for up to four beneficial owners or legal representatives.

Each card breaks its result down by day and includes a **_By total daily sessions_** toggle.



***

## eKYC

The **eKYC** tab reports on individual identity verification results. Use the filter bar at the top of the tab to narrow the data by **_Country_**, **_Date Range_**, **_Client ID_**, and **_Flow_**.

The tab shows a count of eKYC sessions for the selected date range, followed by cards for each verification check:

- **Tax ID**: Exact or No Match.
- **Tax ID Level**: Low, Medium, or High risk.
- **Name Match**: Exact or No Match.
- **Date Of Birth Match**: Exact or No Match.
- **Postal Code Match**: Exact or No Match.
- **State Match**: Exact or No Match.
- **City Match**: Exact or No Match.
- **Overall Level**: Low, Medium, or High risk.

Each card breaks its result down by day and includes a **_By total daily sessions_** toggle.

---

- Path: `dashboard-platform-administration/view-directory-information`
- URL: https://developer.incode.com/dashboard-platform-administration/view-directory-information/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-directory-information.md

# View Directory Information

The Directory Information page in Dashboard shows the people and directories connected to your organization through Incode's directory integrations, such as Okta or Microsoft Entra. It also shows the verification Sessions tied to each person.

In the left menu, click **Services&#x20;**> **Directory Information** to access the page. It's organized into two tabs: **People** and **Directories**.

***

## People

The People tab lists everyone found across your connected directories. Use the search bar to look up a person. Click **Name**, **Email**, **Username**, or **Identity ID** above the search bar to choose which field to search by; the search bar's placeholder text updates to match your selection.

| Column          | Description                                                                                                                                                                                                                                                                                                                          |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Name**        | The person's name recorded in the directory.                                                                                                                                                                                                                                                                                         |
| **Email**       | The person's email address, if collected. Shows a dash (-) if not available.                                                                                                                                                                                                                                                         |
| **Username**    | The person's username in the directory.                                                                                                                                                                                                                                                                                              |
| **Identity ID** | The unique identifier for the corresponding [Identity](/dashboard-platform-administration/view-identities/), if one exists. Click it to open [Single Identity view](/dashboard-platform-administration/single-identity-view/) for that Identity. Shows a dash (-) if the person isn't linked to an Identity. |

### View a Directory Profile

Click a row on the People tab to open that person's directory profile. This shows their name, email, and username at the top. The profile is organized into two tabs: **Summary** and **Sessions**.

- **Summary**: Shows a card for each directory the person belongs to, labeled with the directory's name. Each card shows:
  - **Name**: The person's name as recorded in that directory.
  - **Username**: The person's username in that directory.
  - **Email**: The person's email address, if collected.
  - **User ID**: The unique identifier for the person within that directory.
  - **Phone Number**: The person's phone number, if collected.
  - **Date of Birth**: The person's date of birth, if collected.
  - **Street Address**: The person's street address, if collected.
  - **Location**: The person's location, if collected.
  - **Region**: The person's region, if collected.
  - **Postal Code**: The person's postal code, if collected.
  - **Country**: The person's country, if collected.
    Fields that don't have data show a dash (-).
- **Sessions**: Lists every [Session](/dashboard-platform-administration/review-verification-sessions/) linked to this person.
  | Column             | Description                                                                                                                                                          |
  | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | **Session ID**     | The unique identifier for the Session. Click it to open [single Session view](/dashboard-platform-administration/single-session-view/) for that Session. |
  | **Flow**           | The name of the Flow or Workflow used for the Session.                                                                                                               |
  | **Started At**     | The date and time the Session began.                                                                                                                                 |
  | **Updated At**     | The date and time the Session was last updated.                                                                                                                      |
  | **Score**          | The verification result: _Pass_, _Pass (Manual)_, _Fail_, _Fail (Manual)_, _Needs Review_, or _Not Applicable_.                                                      |
  | **Session Status** | The current status of the Session: _Completed_ or _Not Completed_.                                                                                                   |

***

## Directories

The Directories tab shows the directories connected to your organization and when each one last synced.

If no directories are connected, the tab shows **0 directories** and a **Manage Integrations** button. Click **Manage Integrations** to go to the Integrations page, where you can [set up](/dashboard-platform-administration/manage-integrations#create-integrations) a [directory integration](/ecosystem-workforce/directory-integrations/).

Once directories are connected, each one appears with:

- **Status**: The directory's sync status, such as _Active_, _Pending_, or _Expired_.
- **Last synced**: How long ago the directory last synced (for example, _2 hours ago_). Hover over the timestamp to see the exact date and time.

<br />

---

- Path: `dashboard-platform-administration/view-escalations`
- URL: https://developer.incode.com/dashboard-platform-administration/view-escalations/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-escalations.md

# View Escalations

You can [escalate a session](/dashboard-platform-administration/single-session-view/#escalate-a-session) when you need Incode to review a problem tied to that session. Instead of reporting an issue over email or a call, you can submit it directly from Dashboard and get automatic confirmation that it's been received.

The **Escalations** page in Dashboard allows you to track the status of every Session you've escalated. The escalation's status is updated in the table as it moves through review. You'll be notified when a fix is live.

Clicking a row in the table on the **Escalations** page opens single Session view for that escalation. The table can show the following columns.

| Column            | Description                                                                                                                                                                                                                                      |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Session ID        | Unique identifier of the session the escalation was raised for.                                                                                                                                                                                  |
| Opened On         | Date and time the escalation was created.                                                                                                                                                                                                        |
| Resolved On       | Date and time the escalation was resolved, if applicable.                                                                                                                                                                                        |
| Status            | Current stage of the escalation in Incode's review pipeline: _In Progress_, _Closed_, _Released to Demo_, _Resolved_, or _Opened_. _Released to Demo_ means a fix has been deployed to the Demo environment, ahead of its release to production. |
| Issue Found       | Whether Incode's review confirmed an issue with the session: _Found_ or _Not Found_.                                                                                                                                                             |
| Issue Type        | Category of the issue Incode's review identified, such as _Liveness_ or _Face Recognition_.                                                                                                                                                      |
| Resolution Reason | Reason recorded by Incode when the escalation is resolved.                                                                                                                                                                                       |
| Opened By         | Name of the user who opened the escalation. This may be an Incode team member if the escalation was opened on your behalf.                                                                                                                       |
| Session Decision  | Outcome of the underlying session: _Pass_, _Warning_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_.                                                                                         |
| Submitted Reason  | Reason selected when the escalation was opened: _False Approval_, _False Rejection_, _OCR_, _Classification_, _ID Validation Crosscheck_, _Bug_, or _Other_.                                                                                     |
| Submitted Issue   | Issue category selected when the escalation was opened, such as _ID Verification_ or _Missing Data_.                                                                                                                                             |
| Submitted Comment | Optional comment provided when the escalation was opened.                                                                                                                                                                                        |
| Escalation ID     | Unique identifier generated for the escalation.                                                                                                                                                                                                  |

On this page, you can:

- Filter the escalations that are shown
- Upload multiple escalations at once via CSV import
- Configure your view of the Escalations table

***

## Filter Escalations

1. In the left menu, click **Escalations**.
2. Click **Add Filter** in the top left.
3. Select the column you want to filter by:
   - **Session ID**: Enter the session ID you want to search for.
   - **Escalation ID**: Enter the unique identifier for the escalation you want to search for.
   - **Opened By**: Enter the name of the user who opened the escalation.
   - **Opened On**: Select a start and end date from the calendar to only show escalations opened in that range.
   - **Resolved On**: Select a start and end date from the calendar to only show escalations resolved in that range.
   - **Issue Type**: Enter the issue type you want to search for.
   - **Issue Found**: Select _Found_ or _Not Found_.
   - **Status**: Select _In Progress_, _Closed_, _Released to Demo_, _Resolved_, or _Opened_.
   - **Session Decision**: Select _Pass_, _Warning_, _Fail_, _Not Applicable_, _Needs Review_, _Pass (Manual)_, _Fail (Manual)_, or _Pending (Manual)_.
   - **Submitted Reason**: Select _False Approval_, _False Rejection_, _OCR_, _Classification_, _ID Validation Crosscheck_, _Bug_, or _Other_.
   - **Submitted Issue**: Select from the available issue categories (for example, _ID Verification_, _OCR_, _Liveness_, _Face Recognition_, _Missing Data_, or _Other_).
4. Click **Apply**. The table displays the escalations that fit your criteria.
5. Repeat these steps to add additional filters.

***

## Upload Escalations

Add multiple escalations at once via CSV import.

1. In the left menu, click **Escalations**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Upload Escalations**. The Upload Escalation File dialog opens.
4. If needed, click **Download template CSV** to get the correct file format.
5. Drag and drop your CSV file or click to browse and select it.
6. Click **Add to Escalations**.

***

## Configure Escalations View

You can show, hide, and reorder columns in the Escalations table. This change only affects your account. Other users still see their own view.

1. In the left menu, click **Escalations**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Table Settings**. The Configure Table View panel slides out from the left.
4. In the Configure Table View panel:
   - Click the eye icon next to a column to show or hide it.
   - Drag a column by its handle (**⋮⋮**) to reorder it.
5. Click **Save View** to apply your changes. This view of the page is shown on future visits, even after logging out.

<br />

---

- Path: `dashboard-platform-administration/view-identities`
- URL: https://developer.incode.com/dashboard-platform-administration/view-identities/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-identities.md

# View Identities

Incode Identities are reusable, verified identity records. Once a user verifies their identity, the Incode Platform references it across other experiences. The user doesn't have to verify again, and their identity stays accurate and secure. Each user has only one Identity; all their documents, Sessions, and Authentications are contained in it.

The **Identities** page in Dashboard shows every Identity in your organization, along with details about each one. When you first open the page, the following columns appear.

| Column                 | Description                                                          |
| ---------------------- | -------------------------------------------------------------------- |
| **Name**               | The name of the identity holder.                                     |
| **Enabled On**         | The date and time the identity was created.                          |
| **Identity**           | The unique ID for the identity record.                               |
| **Country**            | The country associated with the identity, shown by its country code. |
| **National Number**    | The identity holder's national ID number, if collected.              |
| **Personal ID Number** | The identity holder's personal ID number, if collected.              |
| **Birthdate**          | The identity holder's date of birth. Shows _NA_ if not available.    |

On this page, you can:

- Filter the Identities that are shown
- Configure the view of the page
- Click an Identity to enter [single Identity view](/dashboard-platform-administration/single-identity-view/), which provides detailed data for the Identity
- Export the Identities list

***

## Filter Identities

1. In the left menu, click **Identities**.
2. Click **Add Filter** in the top left.
3. Select the column you want to filter by:
   - **Name**: Enter the name you want to search for.
   - **Enabled On**: Select a date from the calendar.
   - **Identity**: Enter the unique ID you want to search for.
   - **Country**: Select a country from the drop-down.
   - **Birthdate**: Select a date from the calendar.
   - **National Number**: Enter the national number you want to search for.
   - **Personal ID Number**: Enter the personal ID number you want to search for.
4. Click **Apply**. The table displays the Identities that fit your criteria.
5. Repeat these steps to add additional filters.

***

## Configure Identities View

You can change the view of the Identities table by hiding or reordering columns. Changing the view only affects your own account; it doesn't change how others see this page.

1. In the left menu, click **Identities**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Table Settings**.
4. In the **Configure Table View** panel:
   - Click the eye icon next to a column to show or hide it.
   - Drag a column by its handle (**⋮⋮**) to reorder it.
5. Click **Save View** to apply your changes. This view of the page is shown on future visits, even after logging out.

***

## Export Identities

1. In the left menu, click **Identities**.
2. Click the three-dot menu (**⋮**) in the top right.
3. Select **Export to CSV**. Download starts immediately. Find the file in your computer's default Downloads folder.

<br />

---

- Path: `dashboard-platform-administration/view-session-details`
- URL: https://developer.incode.com/dashboard-platform-administration/view-session-details/
- Markdown: https://developer.incode.com/dashboard-platform-administration/view-session-details.md

# View Session Details
:::info
<Pill type="beta" /> The Dashboard functionality described on this page is in Beta. It is not yet generally available. Contact your Incode representative for more information.
:::




The **Sessions** page in Dashboard allows you to open an individual session to see its details. Open a session from the [sessions table](/dashboard-platform-administration/review-verification-sessions/) to review its decision, verification results, captured media, and supporting information.

Using the toggle in the top right, you can switch between two views:

- [Overview](#overview): Quickly understand the session's outcome.
- [Detailed view](#detailed-view): Examine each verification check that ran.

In both views, only information relevant to that session appears.

***

## Overview

The Overview answers the key questions about a session: whether the face and document are real, whether the person is who they say they are, and whether the session is low risk. Its contents depend on the modules enabled in the [Flow](/dashboard-platform-administration/flows-1/) or [Workflow](/dashboard-platform-administration/workflows-20/) and the information collected during the session. Not every session shows the same cards and sections.

At the top of the Overview, you can see:

- **Score**: The session's overall verification score, displayed out of 100. A higher score indicates a stronger verification result. Review the decision and supporting results instead of relying on the score alone.
- **Decision**: The session's overall result, such as _Approved_ or _Rejected_. The score's color reflects this decision.
- **Name**: The name associated with the session.
- **ID photo**: The image of the submitted identity document.
- **Selfie**: The image captured by the person during the session.
- **Risk AI**: When Risk AI Agent is enabled, its result appears as a pill in the header. Click the pill to view its details.

Use the ID photo and selfie to make a quick visual comparison between the document portrait and the person completing the verification. As you scroll, a condensed header stays at the top of the page with the selfie, name, decision, and score.

To copy the session ID, click **Copy Session ID** ![Icon of two squares, one overlapping the other](https://developer.incode.com/assets/27d1edea-4248-4f3b-bc70-690176086016.png#inline) next to it at the top of the page. To escalate the session, view session info, and more, click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline). For more information, see [Additional Options](#additional-options).

### Verification Questions

The cards near the top of the Overview answer the most important questions about the session. Each card shows:

- **Question**: What the card evaluates, such as _Is this a real face?_
- **Answer**: The result for that question, such as _Real Face_ or _Not Real Face_. The answer's color reflects the result: green for a passing answer, red for a failing or inconclusive answer, and gray when the checks did not run and are not affecting the score.
- **Module and check pills**: The modules and checks that contributed to the answer and their status.

At least four cards always appear. Optional cards appear only when their modules are included in the Flow or Workflow.

| Question | Possible Answers | Contributing Modules and Checks |
|---|---|---|
| _Is this a real face?_ | _Real Face_, _Not Real Face_, _Not run_, _Inconclusive_ | `Liveness`, `Deepsight Face` |
| _Is this a real document?_ | _Real Document_, _Not Real Document_, _Not run_, _Inconclusive_ | `ID Validation`, `Deepsight Document` |
| _Is this person who they say they are?_ | _Identity Confirmed_, _Identity Not Confirmed_, _Not run_, _Inconclusive_ | `Face Recognition`, `GovMatch`, `eKYC`, `eKYB`, `CURP Validation`, `Video Selfie` |
| _Is this a low risk session?_ | _Low Risk_, _High Risk_, _Not run_, _Inconclusive_ | `TrustGraph`, `Antifraud`, `Incode Watchlists`, `Custom Watchlists`, `Device and Behavioral Signals` |
| _Is this person above the age threshold?_ <br />(optional) | _Above 18_, _Not Above 18_, _Not run_ | `Age Verification` |
| _Is this person authenticated?_ <br />(optional) | _Authenticated_, _Not Authenticated_, _Not run_ | `Face Authentication` |
| _Did the cross-checks pass?_ <br />(optional) | _Pass_, _Fail_, _Not run_, _Inconclusive_ | Each cross-check is shown as a pill |

### Module Results

Below the cards, the Overview repeats each answered question, green or red. It then lists the modules that answered that question. Each module shows:



- **Name**: The name of the module, such as _ID Validation_.
- **Score or status**: A score out of 100, or one of the following statuses:
    - **Not Run**: The module was included in the Flow or Workflow but could not run.
    - **Not Run – Fail**: The module could not run, and this counted as a failure for the session.
- **Number of checks**: How many checks ran for that particular module.
- **See details**: Opens the module's section in [Detailed view](#detailed-view) to review its checks and related images. If a module failed, its details might open with the failed checks already selected.

### Captured Media

Captured Media contains the visual artifacts collected during the session, such as:

- The selfie
- The front of the identity document
- The back of the identity document

Below each image, its label shows the number of capture attempts. Click an image to view it in a dialog, zoom in, and inspect each attempt. This can help you identify glare, blur, cropping, or other capture issues that affected a result.

### Captured Signals

Captured Signals contains additional information collected or derived during the session. Depending on the Flow or Workflow and the person's device, this can include:

- Extracted document data, such as [OCR](/get-started-with-incode/glossary/#ocr) results
- Consent records
- Signatures
- Device information
- Browser information

### TrustGraph Details

To review the underlying checks and relationship graph, see [TrustGraph](#trustgraph) in Detailed view.

***

## Detailed View

The Detailed view provides a check-by-check breakdown of the session. Use it when you need to investigate an individual result, review the evidence behind a check, or follow the verification in the order it occurred. At the top of the Detailed view, you can see:

- **Selfie**: The image captured by the person during the session.
- **Name**: The name associated with the session.
- **Decision**: The session's overall result, such as _Approved_ or _Rejected_. The score's color reflects this decision.
- **Score**: The session's overall verification score, displayed out of 100. A higher score indicates a stronger verification result. Review the decision and supporting results instead of relying on the score alone.

The tabs underneath correspond to the categories of checks on the page. Select a tab to move directly to that category. The tabs group related checks by purpose: for example, Liveness and Face Recognition appear together under the Face category. The available tabs depend on the [Flow](/dashboard-platform-administration/flows-1/) or [Workflow](/dashboard-platform-administration/workflows-20/) and the [modules](/features-and-modules/modules-overview-and-availability/) that ran. They can include categories such as:

- [Face](#face)
- [Document](#document)
- [Video Selfie](#video-selfie)
- [Deepsight](#deepsight)
- [External Sources](#external-sources)
- [TrustGraph](#trustgraph)
- [Supplementary Data](#supplementary-data)

Select a tab when you already know which type of evidence you want to review.

When [Risk AI Agent](/features-and-modules/risk-ai-agent/) is enabled, its result appears in the header. It is not a separate category. This is because Risk AI  Agent evaluates the session as a whole. Select its result to open the available Risk AI Agent details.

### Category and Module Results



Each category contains the modules, checks, media, and supporting data associated with that part of the verification. A category header shows its overall result. Individual module pills show the score or status returned by each module. Because a category can contain multiple modules, its result can differ from an individual module's result.



#### Face

The Face category contains the evidence used to evaluate the face captured during the session. Depending on the Flow or Workflow, it can include:



- Liveness
- Face Recognition
- Deepsight Face
- A comparison of the selfie and other images captured during the session

The Face category result reflects the applicable biometric checks. Individual score pills allow you to distinguish, for example, the Liveness result from the Face Recognition result.

Use this category to determine:

- Whether a live person completed the session.
- Whether the captured face matches the document portrait or other identity evidence.
- Which specific biometric check produced a failure or inconclusive result.

#### Document

The Document category contains the submitted document images and the checks performed on them. Depending on the session, it can include:

- [ID Validation](/features-and-modules/id-validation-module/)
- Deepsight Document
- Front and back document images
- [OCR](/get-started-with-incode/glossary/#ocr) and extracted document information

Individual score or status pills identify the modules that contribute to the Document result.

OCR data provides supporting information but does not independently determine the Document category's pass-or-fail result. Use it to compare the extracted fields with the visible document and other session data.

#### Video Selfie

When enabled, the Video Selfie category contains the media and checks associated with the video capture. Use this category to review:

- The captured video or representative images.
- The checks performed on the video.
- Face or document evidence collected during the capture.
- The score or status returned by [Video Selfie](/features-and-modules/video-selfie/).

This category appears only when Video Selfie applies to the session.

#### Deepsight

When applicable, the Deepsight category contains the detailed face, document, or trust checks produced by Deepsight. Use it to review:

- The individual checks behind the Deepsight result.
- Associated images or video, when available.

The exact information shown depends on which Deepsight capabilities ran during the session. Unlike the [Overview](#overview), which shows Deepsight Face and Deepsight Document on separate cards, the Detailed view keeps all Deepsight results in one category.

#### External Sources

The External Sources category groups results obtained by checking identity information against authoritative or third-party data sources. Depending on the Flow or Workflow, this can include checks such as:

- [GovMatch](/features-and-modules/government-record-verification/)
- [eKYC](/features-and-modules/ekyc/) checks
- [CURP Validation](/features-and-modules/curp-validation/)
- [Global](/features-and-modules/watchlist/) or [custom](/features-and-modules/custom-watchlist/) watchlists
- Other configured identity-data sources

Review each module's result and details to determine whether the submitted identity information matched the source and whether the source returned any relevant risk indicators.

#### TrustGraph

When TrustGraph is enabled, the TrustGraph category shows how the current session relates to other identities, devices, documents, faces, and sessions. It contains a table for each TrustGraph check:

- **Suspected Repeat Fraudster**: Matches against identities, devices, and documents previously labelled fraudulent.
- **First-Party Fraud**: Catches abuse reported by an institution about users who are who they claim to be but act in bad faith.
- **Unusual Activity**: Surfaces inconsistencies across sessions, like one document appearing with several faces.
- **Velocity**: Flags the same attribute onboarding abnormally often within a configured time window.
- **Fraud Rings**: Evaluates the session against discovered fraud clusters in real time.

Each table shows the check's status, such as _Passed_, _Failed_, or _Error_, along with reason codes and the number of matches found.

TrustGraph also includes an **Explorer** that shows the session's fraud ring as an interactive graph, with the current session and its connected sessions. Click a node to view its details, or expand it to see more connections. If the session isn't part of a fraud ring, the Explorer says so.

#### Supplementary Data

The Supplementary Data category contains supporting information collected or derived during the session. Depending on the Flow or Workflow and the person's device, it can include:

- User consent
- Signatures
- Device information
- Browser information
- Location
- [Cross-check](/features-and-modules/cross-check/) results
- Additional extracted data

This information provides context for the verification but does not necessarily contribute directly to a score or pass-or-fail result.

### Session Journey

The session journey appears on the right side of the Detailed view. On its Flow tab, it lists the modules as timestamped steps in the order they occurred. Use the Flow tab to:

- Follow the person's progress through the verification.
- See which modules ran and when.
- Move directly to the details for a step.
- Identify where a failure, interruption, or missing result occurred.

#### Event Log

When available, the session journey's Event Log tab provides a chronological record of session activity, including when modules were opened and closed. Use it to review steps, transitions, errors, and other events that occurred during the verification.

The Event Log tab complements the session journey's Flow tab: the Flow tab provides direct navigation between verification steps, while the Event Log provides a more complete operational record.

#### Session Info

The session journey's Session Info tab shows:

<Component slug="session-info" />

***

## Additional Options

### View Session Info

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session you want to view.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Session info**.

Session info displays:

<Component slug="session-info" />

### Escalate Sessions

Escalate a session to ask Incode to investigate a suspected issue with its results or data, such as false approvals or rejections, classification or OCR errors, or bugs or incorrect information displayed in Dashboard.

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session you want to escalate.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Escalate**.

After you submit an escalation, it appears in **Escalations** in Dashboard and is routed to the appropriate Incode team for investigation. You can track its status as it moves through review and resolution. No further action is required unless Incode requests additional information.

### Create Identities from Sessions

Select **Add face to Database** to create an [Incode Identity](/get-started-with-incode/glossary/#incode-identity) using the face and identity document data captured during the session. The identity is then available on the [Identities](/dashboard-platform-administration/view-identities/) page in Dashboard and can be used in future identity checks.

Dashboard [records this action](/dashboard-platform-administration/monitor-compliance/#audit-logs) in **Compliance** > **Audit Logs** as `FACE_ADDED_TO_DATABASE`.

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session you want to create an identity from.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Add face to Database**.

### Add Sessions' Identities to Allowlists or Blocklists

Add the identity captured during the session to your [custom watchlists](/dashboard-platform-administration/manage-custom-watchlists/) so it can be recognized in future sessions. The result of a future match depends on your custom watchlist and business-rule configuration.

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session whose identity you want to add to a custom watchlist.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select one of the following:
    - **Allowlist**: Select this option for a trusted identity that should receive favorable treatment under your configured custom watchlist rules.
    - **Blocklist**: Select this option for an identity associated with suspected fraud or one that should be restricted.

### Export Sessions

Export a session to download its verification information for offline review, recordkeeping, audits, or use in another system. Export to PDF for a structured, human-readable session report—not a screenshot of the page. Export to CSV for tabular session data when available. Export options depend on your organization's configuration and permissions.

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session you want to export.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Export to PDF** or **Export to CSV**.

### Download Session Summaries

Download the session summary PDF to save a concise, portable record of the session's key information and verification results. Use it for offline review, authorized sharing, or audit and compliance records when you do not need the session's full exported data. This option is available only when PDF downloads are enabled for your organization.

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session whose summary you want to download.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Download summary PDF**.

### Delete Session PII

Delete session PII to permanently remove the personally identifiable information collected during the session, such as:

- Identity document and selfie images
- Extracted data
- Biometric templates
- Signatures

The non-PII session record is kept. Use this action to fulfill a data-subject deletion request or comply with your organization's privacy and retention policies.

:::danger
This action cannot be undone. It can remove information needed to review sessions, so confirm that PII is no longer required before proceeding.
:::

1. In Dashboard, click **Sessions** in the left menu.
2. Select the session whose PII you want to delete.
3. Click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) and select **Delete Session PII data**.

---

- Path: `dashboard-platform-administration/watchlist-business-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/watchlist-business-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/watchlist-business-dashboard.md

# Watchlist Business

This module screens business entities against global sanctions lists, Politically Exposed Persons (PEP) databases, and adverse media. It is a processing node and must be added to a Workflow or Flow after business data has been collected.

For an overview of this module and how it works, see [Watchlist Business](/features-and-modules/business-watchlist/).

{/ _This module being a processing node makes sense to me, but it isn't listed under the Processes section in the Workflow UI. It's at the end of the Modules section. TODO: Confirm if it's a processing node._ /}

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Watchlist Business to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. From the Modules list, drag and drop the **Watchlist Business** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Watchlist Business to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Watchlist Business** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save Configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode Representative for more information.

![Image of the Watchlist Business module's configuration page. It has six configuration options.](https://developer.incode.com/assets/781d84378e53446bd6d777f0564e406a.png)

| Setting                         | Description                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Business Name_**             | The name of the business to search. This field is mandatory. The value is pulled from data collected earlier in the Session or can be supplied directly via API.                                                                                                                                                                                                                 |
| **_Business Country_**          | The country or countries of operation used to filter search results. This field is mandatory. Filters apply to PEP entities and entities with at least one matching country value. Entities on sanctions lists appear in results regardless of the country filter. Entities with adverse media mentions only, or with no country assigned, are also not affected by this filter. |
| **_Configure Search Profile_**  | Uses a search profile defined in your provider's configuration to determine which watchlist types are searched. You can configure either a search profile or watchlist types, not both.                                                                                                                                                                                          |
| **_Configure Watchlist Types_** | Allows you to select one or more specific watchlist types to search. Options include _sanction_, _warning_, _fitness-probity_, _pep_, _pep-class-1_ through _pep-class-4_, and FATF-aligned adverse media categories. You can configure either a search profile or watchlist types, not both.                                                                                    |
| **_Fuzziness_**                 | Controls how closely search results must match the supplied business name. Ranges from _0.0_ (strict matching) to _1.0_ (loose matching). Default: 1.0.                                                                                                                                                                                                                          |
| **_Subscribe for updates_**     | Subscribes to ongoing updates for this search. When the search results are updated, Incode sends a notification to the webhook URL [configured](/dashboard-platform-administration/configuration-webhooks-tab/#configure-watchlist-update-webhook) in your organization's Dashboard settings.                                                                        |

<br />

---

- Path: `dashboard-platform-administration/watchlist-dashboard`
- URL: https://developer.incode.com/dashboard-platform-administration/watchlist-dashboard/
- Markdown: https://developer.incode.com/dashboard-platform-administration/watchlist-dashboard.md

# Watchlist

The Watchlist Business module screens business entities against global sanctions lists, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. As a processing module, it runs after user data has been collected by a Forms module or by ID Capture followed by ID Validation. Watchlist matches on first name and last name only; middle names are not processed.

For an overview of this module and how it works, see [Watchlist](/features-and-modules/watchlist/).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Watchlist to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure a module that collects the user's name and date of birth (such as ID Capture followed by ID Validation, or a Forms module) is in your Workflow.
4. From the **Processes** list, drag and drop the Watchlist module into the builder after the data-collection module.
5. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Watchlist to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. On the **Select Modules** tab, find the **Watchlist** module and click **Add**.&#x20;
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

![](https://developer.incode.com/assets/cbe9efdd1c2e457435a6d10d2ce3707c.png)

| Setting                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                    |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Include customer's birth year** | When enabled, narrows the search by including the customer's birth year as a filter. Use this to reduce false positives on common names.                                                                                                                                                                                                                                                                                       |
| **Country of operation**          | Filters results by the entity's country of operation or office. Select one or more countries from the drop-down. Country filtering does not apply to entities on sanction lists, entities with adverse media mentions only, or entities with no country assigned—these always appear regardless of the country filter.                                                                                                         |
| **Configure watchlist types**     | When enabled, displays a **_Watchlist Types_** drop-down for selecting which categories the search should cover (such as sanctions, PEP classes, fitness-probity, and FATF-aligned adverse media categories). Configure either watchlist types or a search profile, not both.                                                                                                                                                  |
| **Configure search profile**      | When enabled, displays a **_Search Profile_** input where you can specify a predefined search profile to use for the search. Configure either a search profile or watchlist types, not both.                                                                                                          |
| **Fuzziness**                     | Determines how closely returned results must match the supplied name. The slider ranges from 0 to 1. A value of _0_ requires an exact match, and a value of _1_ allows the loosest matching. Default: _1_.<br /><br />:warning: **Important**: Dashboard configuration for fuzziness does not automatically carry over to direct API calls. To call the endpoint directly, include `fuzziness` explicitly in the request body. |
| **Subscribe for updates**         | When enabled, subscribes the search to ongoing updates. When the underlying watchlist data for a search changes, Incode sends a notification to your configured webhook so the updated result can be retrieved. For setup instructions, see [Watchlist Webhook](/general-reference/global-watchlists-webhook/).                                                                                    |

## Add Conditions

[Conditions](/dashboard-platform-administration/configure-workflow-conditions/) let you branch the Workflow based on a result. Conditions are optional for Watchlist, but you can add one or more Conditions after the module to route the session based on what the search returned.

To add a Condition for Watchlist:

1. Drag a Condition into the builder from the left panel. Place it after the Watchlist module.
2. In the first drop-down, find the **Global Watchlist** section and select one of the conditions listed below.
   | Condition                       | Description                                                                                                                                                                                                                                                               |
   | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Watchlist risk level            | The search risk level, returned as one of: _LOW_, _MEDIUM_, _HIGH_, _UNKNOWN_. :warning:**Deprecated — do not use.&#x20;**                                                                                             |
   | Watchlist warning match score   |                                                                                                                                           |
   | Watchlist match status          | The search match status, returned as one of: _NO MATCH_, _FALSE POSITIVE_, _POTENTIAL MATCH_, _TRUE POSITIVE_, _UNKNOWN_, _TRUE POSITIVE APPROVE_, _TRUE POSITIVE REJECT_. :warning:**Deprecated — do not use.&#x20;** |
   | Watchlist total hits            | The total number of hits returned by the search.                                                                                                                                                                                                                          |
   | Watchlist sanctions match score |                                                                                                                                           |
   | Watchlist total matches         | The total number of matches returned by the search.                                                                                                                                                                                                                       |
3. In the second drop-down, select an operator.
4. In the value field, enter or select the value to compare against.
5. Select the **Yes path** or **No path** radio button to route the Workflow when the Condition is met.
6. Click **Save condition**.

<br />

---

- Path: `dashboard-platform-administration/workflows-20`
- URL: https://developer.incode.com/dashboard-platform-administration/workflows-20/
- Markdown: https://developer.incode.com/dashboard-platform-administration/workflows-20.md

# Configure Workflows

Workflows define the identity verification journeys your users complete. In your Workflows, you can combine user-facing modules, background processes, conditions, and results. Refer to [Workflows Overview](/concepts-and-architecture/workflows/) to understand the core concepts behind Workflows.



Workflows are created and configured in Dashboard. In the left menu, click **Flow Builder** > **Workflows**. You must have the appropriate role and permissions to create and edit Workflows. 


<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/a0bcfb0d0b3108e693ede874de7dfce6.png" alt="The Workflows page in Dashboard, displaying a table of configured workflows, their publish dates, and statuses." align="center" />

</Accordion>


There are two Workflow builder views: **New** and **Classic**. Use the toggles in the top right of your Workflow to set your view. New view introduces a redesigned builder that makes complex workflows easier to create and understand. In New view, you can:

- Follow workflows from left to right on a canvas that arranges itself automatically.
- Identify conditions without opening them.
- Add steps from a searchable catalog.
- Navigate large workflows using zoom and fit-to-screen controls.
- Catch configuration issues before publishing.







***

## Workflows Table

The following table describes the columns in the Workflows table.

| Column | Description |
|---|---|
| Workflow | The name of the Workflow. |
| Date Created | The date the Workflow was created. |
| Last Published | The date the latest version of the Workflow was published. |
| Sessions | The number of identity verification sessions started with the Workflow. |
| Status | Whether the Workflow is active or paused. Active Workflows can start new sessions; paused Workflows cannot. |
| Actions | Displays an icon for [testing](#test-workflows) the Workflow, [copying](#copy-workflow-ids-and-urls) the Workflow's ID and URL, [exporting](#export-workflow-configurations) Workflows, [pausing](#pause-workflows) and [reactivating](#reactivate-workflows) Workflows, and [deleting](#delete-workflows) Workflows. |



### Filter the Workflows Table

You can filter the list of Workflows by one or more criteria to find the Workflow you need.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. Click **Add Filter** in the top left.
3. Select a filter: **_Workflow Name_**, **_Created at_**, **_Published at_**, or **_Number of sessions (more than)_**.

<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/351920035a980f43399a2a899b22d4b2.png" alt="Add Filter is clicked, and the Workflow name, Created at, Published at, and Number of sessions options appear." align="left" wrap={true} />

</Accordion>

<Accordion title="Expand to learn more about filters">

| Filter                         | Instructions |                                                                                                                                     
| ------------------------------ | ----------------------------- |
| Workflow Name                  | Enter the **Workflow Name**.  |                                                                                                                 
| Created at                     | Click **Start Date** and use the calendar to select a date. Do the same for **End Date**. This filter does not allow selecting specific times. |
| Published at                   | Click **Start Date** and use the calendar to select a date. Do the same for **End Date**. This filter does not allow selecting specific times. |
| Number of Sessions (more than) | Enter a number or use the arrows to set the number of Sessions that used a Workflow.                                                   |

</Accordion>

4. Enter or select the filter value.
5. Click **Apply**. The list displays the Workflows that fit the filter criteria.
6. Repeat these steps to add additional filters. To remove a filter, click **X** in its badge.

## Create Workflows

Create a Workflow to define the onboarding or authentication experience your users complete. Build the journey from Session Start to a result by adding:

- **Modules**: Identity verification screens your users interact with, such as capturing a photo of their ID or a selfie.
- **Processes**: Modules for background processes. Your users don't interact with these. They perform checks, such as document classification and authenticity audits, that help determine the Workflow's result.
- **Conditions**: Branching decisions that determine the path the Workflow takes. You can use conditions to present different modules to a user and determine the Workflow's result. For example, if the name on a user's driver's license doesn't match the name on their passport, you can use a condition to send them to a module that asks for a third form of ID. If none of the names match, you can specify a fail result. 

Before you start building, use [this index of modules](/features-and-modules/modules-overview-and-availability/) to determine which modules and processes you want to include in your Workflow.





1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. Click **New** in the top right.
3. Click **Edit** ![Icon of a pencil](https://developer.incode.com/assets/c7e8dede-8700-4f17-89b8-5d4dfdcc219b.png#inline) in the top left and enter a new, descriptive name for this Workflow.
4. Do one of the following, depending on whether you have the **New** or **Classic** view enabled in the toggle in the top right:
    - **New**: Add your first module between Session Start and Session Pass. Choose one of the suggested first steps or click **Browse all modules** to see more options. You can search for a specific module name.
    - **Classic**: In the Modules panel, hover over each module for an overview of what it does and how it appears to the user. Drag modules onto the canvas to build your Workflow. You can also click **Select a template** on the canvas or **Templates** in the bottom left corner to start from a [template](#choose-a-workflow-template-standard-dashboard-only).

<Accordion title="Expand to view image of Classic view">

<Image src="https://developer.incode.com/assets/48967fcee4c710986aec2f2b73c645ce.png" alt="The cursor hovers over the ID Capture module, and a short description and image of the module's user experience appear." align="center" />

</Accordion>

5. Next to the module you added, click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Edit** and configure the module settings.
6. Click **Save configuration**.
7. Click **Add node** ![Icon of a plus sign](https://developer.incode.com/assets/104e9c43-dab0-45e0-a16e-8cf34b9f8715.png#inline) to add another module, a process, or a condition. Processes and conditions must come after a module.

<Accordion title="Expand to view image of Classic view">

<Image src="https://developer.incode.com/assets/ad03a654223d270ca60a51897c3e8ed3.png" alt="A series of module, process, and condition nodes ordered top to bottom, first to last." align="left" wrap={true} />

</Accordion>

9. Configure and save the settings of each module, process, and condition.
10. Configure the overall [Workflow settings](#configure-workflow-settings).
11. To delete a module, process, or condition, click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) > **Delete**.
12. To change a final decision node, click **Options** ![Icon of three dots stacked on top of each other](https://developer.incode.com/assets/aae0f87a-5c54-4fd9-b4a1-cc33d8a95099.png#inline) next to it. Select a decision: _Pass_, _Fail_, _Warn_, or _Manual Review_, then click **Update Decision**.
13. If you have **New** view enabled in the toggle in the top right, click **Validate** in the top right and resolve any reported issues. Use the arrow next to **Validate** to switch between validating _All at once_ or _Step by step_.
14. When your Workflow is ready, click **Save & Publish**.
15. [Test the workflow](#test-workflows) and confirm every path behaves as expected.

### Choose a Workflow Template

Templates give you a starting point for the most common verification use cases. You can customize the Workflow or individual modules as needed. You can choose from the built-in template options or [import](#import-workflows) your own.

If you have **New** view enabled in the toggle in the top right, click **Templates** ![Icon of four white dots with gray borders forming a square](https://developer.incode.com/assets/2b907b22-ea5e-4f94-8363-f58145df8d9b.png#inline) at the bottom of the screen to select a built-in template.


<Accordion title="Expand to view image of Classic view">

<Image src="https://developer.incode.com/assets/7cb77abd1a82dce141afc855ee45c26d.png" alt="The list of built-in templates includes Blank, Identity verification, Step up age verification, one-to-many authentication step up, and one-to-one authentication step up." align="center" />

</Accordion>


The following templates are built in:

- **Identity Verification**: Includes the modules and processes needed to complete a standard ID-to-Face verification.
- **Step Up Age Verification**: Uses Face Capture to determine the user's age. If the user's age meets the condition set, ID Capture is not required for authentication. The default age threshold is 25 or older.
- **1:N Authentication Step Up**: Allows returning users to authenticate using just their face, compared against anyone's previous authentications. If authentication fails, the user is presented with an opportunity to complete ID verification.
- **1:1 Authentication Step Up**: Allows returning users to authenticate using just their face, compared against their own previous authentications. If authentication fails, the user is presented with an opportunity to complete ID verification.
- **Self-Service Reset & Recovery**: Verifies users’ identities for password resets, MFA resets, and Temporary Access Pass requests. It collects a login identifier, finds the user’s directory, and runs identity verification before routing them through the recovery process. This template is available in **New** view only.

## Import Workflows

Import a Workflow to reuse an exported Workflow configuration instead of rebuilding it manually. The import creates a new Workflow from a JSON configuration file.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. Click **Import** in the top right.
3. Click **_Import File_** and select the JSON file you want to upload.

<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/e7854136d4d9c91372ff2f3380edb43c.png" alt="The fields in the Import pop-up include Import File and Workflow Name." align="left" wrap={true} />

</Accordion>

4. Enter a descriptive **_Workflow Name_**.
5. Click **Submit**.
6. Open the imported Workflow and review its modules, module configurations, processes, conditions, results, and [Workflow settings](#configure-workflow-settings).
7. Click **Validate** in the top right and resolve any reported issues. Use the arrow next to **Validate** to switch between validating _All at once_ or _Step by step_.
8. When your Workflow is ready, click **Save & Publish**.
9. [Test the workflow](#test-workflows) and confirm every path behaves as expected.

## Configure Workflow Settings

Workflow settings control the overall behavior and user experience of a Workflow.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. Select a Workflow.
3. Click **Settings** ![Icon of a gear](https://developer.incode.com/assets/9773abfa-00c4-44b2-8a55-379ed8310adc.png#inline) in the top right.
4. Configure the settings in each section. Your changes are saved automatically.

<Accordion title="Expand to view the Workflow settings in each section">

**Deepsight**

| Setting | Description |
|---|---|
| **_Deepsight_** | Enables [Deepsight](/features-and-modules/deepsight/) for this Workflow. This setting is available only when Deepsight is enabled for your organization. It requires separate licensing. |

**Session Result**

| Setting | Description |
|---|---|
| **_Automatically create an identity on successful workflow execution_** | Creates an [Incode Identity](/get-started-with-incode/glossary/#incode-identity) automatically when the Workflow completes successfully. The identity is then available on the [Identities](/dashboard-platform-administration/view-identities/) page in Dashboard. |

**User Experience**

| Setting | Description |
|---|---|
| **_Skip intro screen_** | Sends users directly to the verification steps without displaying the launch screen. |
| **_Show verification result screen_** | Displays a final screen showing whether the user passed or failed verification. |
| **_Phishing Resistance_** | Protects against man-in-the-middle phishing attacks using dynamic QR codes and device-to-session binding. Enabling this setting also enables **_Redirect desktop attempts to mobile_**. |
| **_OAuth2 Secured (web only)_** | Protects the user journey against replay attacks using OAuth 2.0. A Redirect URL is required when this setting is enabled. |
| **_Redirect desktop attempts to mobile_** | Lets users who begin on a desktop transfer the verification to a mobile device. |
| **_Add continue to desktop_** | Gives users the option to continue the verification on their desktop instead of transferring it to a mobile device. |
| **_Redirect origin only_** | Redirects users only on the device where they started the verification. |
| **_Enable SMS_** | Lets users enter a phone number to receive the ID verification link by SMS. |
| **_Hide unsupported browser screen_** | Lets users continue without seeing the unsupported-browser screen. Only Chrome and Safari are officially supported. |
| **_Allowed devices_** | Restricts the Workflow to selected device types: <br>_Mini apps_: Lets users complete identity verification in a lightweight app without installing the full mobile application. <br>_Web mobile_: Lets users complete identity verification in a browser on their mobile device. <br>_Web desktop_: Lets users complete identity verification in a desktop browser, typically for remote or in-branch verification. |
| **_Enable SDK 2.0_** | Runs the web-based Workflow using Web SDK 2.0 instead of SDK 1.x, providing a modular architecture that loads components as needed for faster performance.  |
| **_Redirect URL_** | Specifies the URL users are sent to after completing the Workflow. This setting is required when OAuth2 Secured (web only) is enabled. |
| **_Log session as expired after timeout_** | Adds an expiration timestamp when a session reaches the configured time limit. Use this setting to monitor user behavior and completion rates around the expiration window. |

**Compliance & Privacy**

| Setting | Description |
|---|---|
| **_Age assurance_** | Displays privacy-adjusted tutorials. Incode stores no personally identifiable information other than the user’s date of birth. |
| **_Enable mandatory biometric consent_** | Requires users to provide biometric consent during the Workflow. |
| **_Store video of ID and face capture in session_** | Stores video recorded during the ID Capture and Face Capture modules in the session. |

</Accordion>

## Test Workflows

Test every path through a Workflow to confirm that its modules, conditions, results, and settings behave as expected.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want to text, click **Test workflow** ![Icon of a QR code](https://developer.incode.com/assets/551b60b4-0122-43ea-9707-6fb44fe91063.png#inline).
3. Scan the QR code with your mobile device or click **Copy workflow link** ![Icon of a solid square overlapping a dashed square](https://developer.incode.com/assets/99d7251a-1ac8-4ece-8db1-9e1d4458e973.png#inline) and test in your browser.

## Additional Options


<Accordion title="Expand to view image">

<Image src="https://developer.incode.com/assets/83da446cc0a1282dd507a185a5a49609.png" alt="The three dots are clicked, and the following options appear: Pause Workflow, Copy URL, Copy ID, Export Config, and Delete." align="left" wrap={true} />

</Accordion>

### Copy Workflow IDs and URLs

Copy the Workflow URL to launch the Workflow or share it with users who need to complete it. Copy the Workflow ID when you need the Workflow’s unique identifier for an integration, an API request, or a support case.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline).
3. Select **Copy URL** or **Copy ID**.

### Export Workflow Configurations

Export a Workflow configuration to download its structure and settings as a JSON file. You can keep the file as a backup or [import it](#import-workflows) to create a new Workflow in another organization or environment.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline).
3. Select **Export Config**.

### Pause Workflows

Pause a Workflow to prevent users from starting new identity verification sessions with it. Use this option when you need to make changes or temporarily remove the Workflow from use. You can [activate it again](#reactivate-workflows) when it's ready.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline).
3. Select **Pause workflow**.

### Reactivate Workflows

Reactivate a paused Workflow to make it available for new identity verification sessions again. Before reactivating it, confirm that its configuration is current and [test each path](#test-workflows) to ensure it behaves as expected.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline).
3. Select **Activate workflow**.

### Delete Workflows

Delete a Workflow when it is no longer needed. Deletion is permanent and cannot be undone, so [export the configuration](#export-workflow-configurations) first if you may need to recreate or reference it later.

1. In Dashboard, click **Flow Builder** > **Workflows** in the left menu.
2. In the Actions column for the Workflow you want, click **Options** ![Icon of three dots side by side](https://developer.incode.com/assets/e48bb4fb-08d6-4f8b-a9f7-eb883dc9c705.png#inline).
3. Select **Delete Workflow**.

---

- Path: `design-and-ux/advanced-signature-design`
- URL: https://developer.incode.com/design-and-ux/advanced-signature-design/
- Markdown: https://developer.incode.com/design-and-ux/advanced-signature-design.md

# Advanced Signature 

**Advanced Signature** is a key step in onboarding and agreement workflows. It presents users with a document to review and a set of consent statements to confirm before completing the signing process. The module ensures users have read and agreed to all required terms before their signature is submitted and recorded.

<Image align="center" src="https://developer.incode.com/assets/cdc5315a7b658d4125c4cc14987b71c5.gif" />

***

## Where it fits in the flow

**Advanced Signature** is typically positioned at the end of an onboarding or verification flow, after identity and document checks have been completed, depending on the configured workflow.

***

## User Flow

The **Advanced Signature experience** guides users through a document review, a progressive consent checklist, and a final signing confirmation.

<Image align="center" src="https://developer.incode.com/assets/305b03603bb8cc69674d012770745634.png" />

<br />

***

## Full Flow Map

<Image align="center" src="https://developer.incode.com/assets/6cb4d6d0556bc2bda08343184949608b.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the user reviews the document, checks all required consent statements, and completes signing without interruptions.  
**The happy path** represents the smoothest version of the experience: the user opens and reviews the contract, checks each consent checkbox in sequence, taps "Finish signing," and the system processes and confirms the signature. The user reaches the success screen on the first attempt without encountering any errors or unchecked statements.  
**Light and dark mode** previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/eeab1d24b361920eb12171f6ddc94505.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/fc9067b86adff36e05f9653fe83ea759.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Advanced Signature experience**

✅ Do

* Display the full contract or document with a clear link to open and read it before signing.
* Require each consent checkbox to be checked individually before the "Finish signing" button becomes active.
* Keep consent statements concise, specific, and easy to understand.
* Provide clear visual feedback during processing to prevent duplicate submissions.

❌ Don't

* Don't allow the "Finish signing" button to be tapped unless all checkboxes are checked.
* Don't allow duplicate submissions by leaving the button active while the signature is being processed.

---

- Path: `design-and-ux/button`
- URL: https://developer.incode.com/design-and-ux/button/
- Markdown: https://developer.incode.com/design-and-ux/button.md

# Button

Buttons trigger actions. Prizma has three variants — primary, secondary, and tertiary — each scoped to a different visual weight and use case. All powered by the same token layer.

## Try it live

Hover, press, and tab through them — every state comes straight from the button tokens.

<div class="dh-demo"><p class="dh-demo-label">Interactive — hover / press / focus</p><button class="dh-pz-btn dh-pz-btn-primary" type="button">Verify identity</button><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Cancel</button><button class="dh-pz-btn dh-pz-btn-tertiary" type="button">Skip for now</button><button class="dh-pz-btn dh-pz-btn-primary" type="button" disabled>Verify identity</button></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><button class="dh-pz-btn dh-pz-btn-primary" type="button">Verify identity</button></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Primary</span><code>.btn-primary</code><p>The main call to action. Signals the most important next step — one per screen. Verb-first labels (Verify, Continue, Confirm); full width on mobile flows.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Cancel</button></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Secondary</span><code>.btn-secondary</code><p>Supporting or dismissive action. Sits alongside the primary but never competes with it — go back, cancel, or dismiss a flow.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><button class="dh-pz-btn dh-pz-btn-tertiary" type="button">Skip for now</button></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Tertiary</span><code>.btn-tertiary</code><p>Text-link style. Optional steps or navigation that shouldn’t disrupt the flow.</p></div></div></div>

<div class="dh-rule"><span>States</span><i></i></div>

## Every state, every variant

Hover, pressed, and disabled states are baked into the token layer. They respond automatically — no overrides needed.

<div class="dh-stage"><button class="dh-pz-btn dh-pz-btn-primary" type="button">Default</button><button class="dh-pz-btn dh-pz-btn-primary is-hover" type="button">Hover</button><button class="dh-pz-btn dh-pz-btn-primary is-pressed" type="button">Pressed</button><button class="dh-pz-btn dh-pz-btn-primary" type="button" disabled>Disabled</button></div>

<div class="dh-stage"><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Default</button><button class="dh-pz-btn dh-pz-btn-secondary is-hover" type="button">Hover</button><button class="dh-pz-btn dh-pz-btn-secondary is-pressed" type="button">Pressed</button><button class="dh-pz-btn dh-pz-btn-tertiary" type="button">Tertiary</button></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--btn-primary-surface-default | Primary background — rest | Component
--btn-primary-surface-hover | Primary background — hover | Component
--btn-primary-surface-pressed | Primary background — active | Component
--btn-primary-surface-disabled | Primary background — disabled | Component
--btn-primary-text-default | Primary label — rest | Component
--btn-primary-text-disabled | Primary label — disabled | Component
--btn-secondary-border-default | Secondary border — rest | Component
--btn-secondary-border-hover | Secondary border — hover | Component
--btn-secondary-border-pressed | Secondary border — active | Component
--btn-secondary-border-disabled | Secondary border — disabled | Component
--btn-tertiary-text-default | Tertiary label — rest | Component
--btn-tertiary-text-disabled | Tertiary label — disabled | Component
--radius-button | Corner radius — all variants | Semantic
--font-size-button-m | Label font size — M | Primitive
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/button-group`
- URL: https://developer.incode.com/design-and-ux/button-group/
- Markdown: https://developer.incode.com/design-and-ux/button-group.md

# Button Group

Button groups define how multiple buttons are arranged in a flow. Four orientations — vertical and horizontal, each with a normal and reversed variant — cover every layout pattern in Prizma flows.

<div class="dh-rule"><span>Orientations</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-btngroup"><button class="dh-pz-btn dh-pz-btn-primary" type="button">Continue</button><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Go back</button></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Vertical</span><code>.btn-group--vertical</code><p>Stacked full-width buttons — the default on mobile verification flows. Primary on top.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-btngroup is-horizontal"><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Cancel</button><button class="dh-pz-btn dh-pz-btn-primary" type="button">Confirm</button></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Horizontal</span><code>.btn-group--horizontal</code><p>Side-by-side pair for dialogs and wide layouts. Primary sits on the right.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--scale-12 | Gap between buttons in a group | Primitive
--btn-primary-surface-* | All primary button tokens | Component
--btn-secondary-border-* | All secondary button tokens | Component
--radius-button | Corner radius on all buttons | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/card-list`
- URL: https://developer.incode.com/design-and-ux/card-list/
- Markdown: https://developer.incode.com/design-and-ux/card-list.md

# Card List

Card Lists present a set of selectable verification steps or modules. Each item has an icon, a label, and an optional badge. Used as the main navigation surface at the start of a verification session.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-cardlist"><span class="dh-pz-carditem"><em></em><span>ID Capture</span><i></i></span><span class="dh-pz-carditem is-selected"><em></em><span>Face Capture</span><i></i></span><span class="dh-pz-carditem"><em></em><span>Face Match</span><i></i></span></span></div>

<div class="dh-rule"><span>States</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-carditem" style="min-width:200px"><em></em><span>ID Capture</span><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Default</span><code>.card-item</code><p>A selectable verification step: icon, label, and a chevron affordance.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-carditem is-selected" style="min-width:200px"><em></em><span>Face Capture</span><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Selected</span><code>.card-item.is-selected</code><p>Brand border and tinted surface confirm the choice.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--gc-card-surface | Item background | Component
--gc-card-border | Item border color | Component
--gc-card-text | Item label color | Component
--gc-card-icon-surface | Icon container background | Component
--gc-card-tag-surface | Badge background | Component
--gc-card-tag-text | Badge text color | Component
--radius-card | Card corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/certificate-issuance-design`
- URL: https://developer.incode.com/design-and-ux/certificate-issuance-design/
- Markdown: https://developer.incode.com/design-and-ux/certificate-issuance-design.md

# Certificate Issuance

The **Certificate Issuance** module enables organizations to issue digital certificates that support secure, compliant, and legally binding document signing. By establishing trusted digital identities and strong authentication mechanisms, it helps ensure document integrity, signer verification, and regulatory compliance throughout the signing process.


<Image src="https://developer.incode.com/assets/e1c09214d73711769424ea5132fd904e.gif" align="center" />


***

## Where it fits in the flow

The **Certificate Issuance** module is typically performed after identity verification has been completed, including ID document capture and face capture. Once the user's identity has been successfully verified, a digital certificate can be issued to establish a trusted digital identity for secure, compliant, and legally binding document signing.

***

## User Flow

The **Certificate Issuance&#x20;**&#x65;xperience follows a three-step flow.


<Image src="https://developer.incode.com/assets/633f70bd7b8bee73953140177a2414a5.png" align="center" />


<br />

***

## Full Flow Map


<Image src="https://developer.incode.com/assets/e733167e868b4dbd17b3f2441683bc92.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The Certificate Issuance module is typically performed after identity verification is completed through ID document and face capture. Upon successful verification, a digital certificate is issued to enable secure, compliant, and legally binding document signing.


<Image src="https://developer.incode.com/assets/3084e844f9406d26f9c766940d9d3194.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/11b3509dc45580458fc7e45fd6236d52.png" align="center" caption="Dark mode" />


<br />

<br />

## Best Practices

Recommended guidelines for designing and implementing the Certificate Issuance experience.

**✅ Do**

- Clearly communicate that identity verification has been successfully completed before initiating certificate issuance.
- Provide clear progress indicators while the certificate is being generated and issued.
- Display a confirmation screen once the certificate has been successfully issued so users understand they can proceed to document signing.
- Ensure users understand the purpose of the certificate and how it enables secure, legally binding digital signatures.

**❌ Don't**

- Don't allow certificate issuance until identity verification, including ID capture and face capture, has been successfully completed.
- Don't leave users without feedback during certificate generation or issuance processes.

<br />

---

- Path: `design-and-ux/checkbox`
- URL: https://developer.incode.com/design-and-ux/checkbox/
- Markdown: https://developer.incode.com/design-and-ux/checkbox.md

# Checkbox

Checkboxes allow users to select one or more items from a set, or toggle a single option on or off. Prizma checkboxes support unchecked, checked, and disabled states across S, M, and L container sizes.

## Try it live

Click them — real checkboxes styled with the checkbox tokens.

<div class="dh-demo"><p class="dh-demo-label">Interactive — click to toggle</p><label class="dh-pz-check"><input type="checkbox" checked /> <span>I accept the terms and conditions</span></label><label class="dh-pz-check"><input type="checkbox" /> <span>Send me product updates</span></label></div>

<div class="dh-rule"><span>States</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><label class="dh-pz-check"><input type="checkbox" /> <span>Unchecked</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Unchecked</span><code>.checkbox-wrap</code><p>Default resting state. The checkbox is visible and ready to receive input.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><label class="dh-pz-check"><input type="checkbox" checked /> <span>Checked</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Checked</span><code>.checkbox-wrap.is-selected</code><p>Selected state. The checkmark confirms the user’s choice with brand color.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><label class="dh-pz-check" style="opacity:0.4"><input type="checkbox" /> <span>Disabled</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Disabled</span><code>opacity: 0.4</code><p>Unavailable state. Full opacity reduction signals the option is not interactive.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--checkbox-surface-default | Unchecked background | Component
--checkbox-surface-selected | Checked background | Component
--checkbox-surface-disabled | Disabled background | Component
--checkbox-border-default | Unchecked border | Component
--checkbox-border-selected | Checked border | Component
--checkbox-border-disabled | Disabled border | Component
--checkbox-check-color | Checkmark icon color | Component
--radius-checkbox | Corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/color`
- URL: https://developer.incode.com/design-and-ux/color/
- Markdown: https://developer.incode.com/design-and-ux/color.md

# Color

Prizma's color system is built on semantic tokens: components never reference raw hex values, they reference a role ("surface", "text", "border", "icon") that resolves to the right color for the active mode. Design and code share the same token names, so what's designed in Figma is what ships.

<Tabs>
<Tab title="Overview">

```dh-strip
kind: color
desc: One brand ramp, one gray ramp, and a status set (positive, warning, negative, focus) cover every surface in the product.
| #e5f0ff
| #bfdfff
| #99ceff
| #66a6ff
| #3388ff
| #006aff
| #0055cc
| #e4fbf0
| #189f60
| #fff0f0
| #e71111
| #fff7eb
| #ff9900
```

```dh-principles
#006aff | Semantic, not literal | Components reference roles (surface, text, border, icon) — never a hex, never a primitive. If a needed role is missing, request a token instead of inlining a value.
#189f60 | Adaptive by design | Every semantic token carries a light and a dark value and inverts automatically. Tokens suffixed Static keep the same value in both modes.
#820ad1 | One source of truth | The ramps live in Token Studio and sync to Figma and code. What's designed is what ships — no drift.
```

</Tab>
<Tab title="Palette">

<div class="dh-ramp"><div class="dh-ramp-band"><i style="background:#ffffff"></i><i style="background:#fcfcfd"></i><i style="background:#ebecef"></i><i style="background:#d9dae1"></i><i style="background:#c6c8d2"></i><i style="background:#b5b8c5"></i><i style="background:#a3a8b8"></i><i style="background:#82879a"></i><i style="background:#60667c"></i><i style="background:#4d5264"></i><i style="background:#3a3e4b"></i><i style="background:#30333e"></i><i style="background:#262831"></i><i style="background:#14151a"></i><i style="background:#000000"></i></div><div class="dh-ramp-body"><strong>Gray</strong><div class="dh-ramp-chips"><span class="dh-ramp-chip"><i style="background:#ffffff"></i><em>0</em><code>#ffffff</code></span><span class="dh-ramp-chip"><i style="background:#fcfcfd"></i><em>50</em><code>#fcfcfd</code></span><span class="dh-ramp-chip"><i style="background:#ebecef"></i><em>100</em><code>#ebecef</code></span><span class="dh-ramp-chip"><i style="background:#d9dae1"></i><em>150</em><code>#d9dae1</code></span><span class="dh-ramp-chip"><i style="background:#c6c8d2"></i><em>200</em><code>#c6c8d2</code></span><span class="dh-ramp-chip"><i style="background:#b5b8c5"></i><em>250</em><code>#b5b8c5</code></span><span class="dh-ramp-chip"><i style="background:#a3a8b8"></i><em>300</em><code>#a3a8b8</code></span><span class="dh-ramp-chip"><i style="background:#82879a"></i><em>400</em><code>#82879a</code></span><span class="dh-ramp-chip"><i style="background:#60667c"></i><em>500</em><code>#60667c</code></span><span class="dh-ramp-chip"><i style="background:#4d5264"></i><em>600</em><code>#4d5264</code></span><span class="dh-ramp-chip"><i style="background:#3a3e4b"></i><em>700</em><code>#3a3e4b</code></span><span class="dh-ramp-chip"><i style="background:#30333e"></i><em>750</em><code>#30333e</code></span><span class="dh-ramp-chip"><i style="background:#262831"></i><em>800</em><code>#262831</code></span><span class="dh-ramp-chip"><i style="background:#14151a"></i><em>900</em><code>#14151a</code></span><span class="dh-ramp-chip"><i style="background:#000000"></i><em>1000</em><code>#000000</code></span><span class="dh-ramp-chip"><i style="background:#ffffffcc"></i><em>0 80%</em><code>#ffffffcc</code></span><span class="dh-ramp-chip"><i style="background:#14151acc"></i><em>900 80%</em><code>#14151acc</code></span><span class="dh-ramp-chip"><i style="background:#000000cc"></i><em>1000 80%</em><code>#000000cc</code></span></div></div></div>

<div class="dh-ramp"><div class="dh-ramp-band"><i style="background:#e5f0ff"></i><i style="background:#bfdfff"></i><i style="background:#99ceff"></i><i style="background:#66a6ff"></i><i style="background:#3388ff"></i><i style="background:#006aff"></i><i style="background:#0055cc"></i><i style="background:#21273b"></i></div><div class="dh-ramp-body"><strong>Brand</strong><div class="dh-ramp-chips"><span class="dh-ramp-chip"><i style="background:#e5f0ff"></i><em>50</em><code>#e5f0ff</code></span><span class="dh-ramp-chip"><i style="background:#bfdfff"></i><em>100</em><code>#bfdfff</code></span><span class="dh-ramp-chip"><i style="background:#99ceff"></i><em>200</em><code>#99ceff</code></span><span class="dh-ramp-chip"><i style="background:#66a6ff"></i><em>300</em><code>#66a6ff</code></span><span class="dh-ramp-chip"><i style="background:#3388ff"></i><em>400</em><code>#3388ff</code></span><span class="dh-ramp-chip"><i style="background:#006aff"></i><em>500</em><code>#006aff</code></span><span class="dh-ramp-chip"><i style="background:#0055cc"></i><em>600</em><code>#0055cc</code></span><span class="dh-ramp-chip"><i style="background:#21273b"></i><em>900</em><code>#21273b</code></span></div></div></div>

<div class="dh-ramp"><div class="dh-ramp-band"><i style="background:#e4fbf0"></i><i style="background:#45b380"></i><i style="background:#189f60"></i><i style="background:#0c5030"></i><i style="background:#03190e"></i><i style="background:#fff7eb"></i><i style="background:#ffb647"></i><i style="background:#ff9900"></i><i style="background:#523100"></i><i style="background:#271400"></i><i style="background:#fff0f0"></i><i style="background:#ff5a5f"></i><i style="background:#e71111"></i><i style="background:#240001"></i><i style="background:#0099ff"></i><i style="background:#006aff"></i></div><div class="dh-ramp-body"><strong>Status</strong><div class="dh-ramp-chips"><span class="dh-ramp-chip"><i style="background:#e4fbf0"></i><em>Positive 50</em><code>#e4fbf0</code></span><span class="dh-ramp-chip"><i style="background:#45b380"></i><em>Positive 400</em><code>#45b380</code></span><span class="dh-ramp-chip"><i style="background:#189f60"></i><em>Positive 500</em><code>#189f60</code></span><span class="dh-ramp-chip"><i style="background:#0c5030"></i><em>Positive 750</em><code>#0c5030</code></span><span class="dh-ramp-chip"><i style="background:#03190e"></i><em>Positive 950</em><code>#03190e</code></span><span class="dh-ramp-chip"><i style="background:#fff7eb"></i><em>Warning 50</em><code>#fff7eb</code></span><span class="dh-ramp-chip"><i style="background:#ffb647"></i><em>Warning 400</em><code>#ffb647</code></span><span class="dh-ramp-chip"><i style="background:#ff9900"></i><em>Warning 500</em><code>#ff9900</code></span><span class="dh-ramp-chip"><i style="background:#523100"></i><em>Warning 750</em><code>#523100</code></span><span class="dh-ramp-chip"><i style="background:#271400"></i><em>Warning 950</em><code>#271400</code></span><span class="dh-ramp-chip"><i style="background:#fff0f0"></i><em>Negative 50</em><code>#fff0f0</code></span><span class="dh-ramp-chip"><i style="background:#ff5a5f"></i><em>Negative 400</em><code>#ff5a5f</code></span><span class="dh-ramp-chip"><i style="background:#e71111"></i><em>Negative 500</em><code>#e71111</code></span><span class="dh-ramp-chip"><i style="background:#240001"></i><em>Negative 950</em><code>#240001</code></span><span class="dh-ramp-chip"><i style="background:#0099ff"></i><em>Focus 400</em><code>#0099ff</code></span><span class="dh-ramp-chip"><i style="background:#006aff"></i><em>Focus 500</em><code>#006aff</code></span></div></div></div>

</Tab>
<Tab title="Using color">

> 📘 Adaptive by design
>
> Every token below carries a light and a dark value. Adaptive tokens invert between modes automatically; tokens suffixed **Static** keep the same value in both modes (for elements that must not change, like brand fills or overlays on imagery).

```dh-usage
Surface roles | surface-* | Background fills for frames, cards, and overlays. The gray scale inverts between modes. | Frames, Cards, Overlays, Status tints
Text roles | text-* | Headings, body, labels, links, and status messages. Primary/secondary/tertiary carry the hierarchy. | Headings, Body, Links, Status text
Border roles | border-* | Strokes for inputs, cards, dividers, and status rings — including the focus ring. | Inputs, Dividers, Focus ring, Status rings
Icon roles | icon-* | Glyph fills. Adaptive tokens invert with mode; static tokens never change. | Glyphs, Status icons, Static marks
```

- Components reference semantic tokens, never primitives or raw hex values.
- Never hardcode a hex in product code — if a needed role is missing, request a token instead of inlining a value.
- Static tokens are for surfaces that must not adapt (brand fills, overlays on photography); everything else should invert with the mode.

</Tab>
<Tab title="Tokens">

## Semantic tokens

### Surface

```dh-tokens
desc: Background fills for frames, cards, and overlays. Gray scale inverts between modes.
Neutral 0 | --surface-neutral-0 | #ffffff | #000000
Neutral 50 | --surface-neutral-50 | #fcfcfd | #14151a
Neutral 100 | --surface-neutral-100 | #ebecef | #262831
Neutral 150 | --surface-neutral-150 | #d9dae1 | #30333e
Neutral 200 | --surface-neutral-200 | #c6c8d2 | #3a3e4b
Neutral 250 | --surface-neutral-250 | #b5b8c5 | #4d5264
Neutral 300 | --surface-neutral-300 | #a3a8b8 | #60667c
Neutral 800 | --surface-neutral-800 | #262831 | #ebecef
Brand 50 | --surface-brand-50 | #e5f0ff | #21273b
Brand 500 Static | --surface-brand-500-static | #006aff | #006aff
Status Warning 50 | --surface-status-warning-50 | #fff7eb | #271400
Status Warning 500 | --surface-status-warning-500 | #ff9900 | #ffb647
Status Negative 50 | --surface-status-negative-50 | #fff0f0 | #240001
Status Positive 50 | --surface-status-positive-50 | #e4fbf0 | #03190e
Status Positive 500 | --surface-status-positive-500 | #189f60 | #45b380
```

### Text

```dh-tokens
desc: Text fills for headings, body, labels, links, and status messages.
Primary | --text-primary | #262831 | #fcfcfd
Secondary | --text-secondary | #60667c | #a3a8b8
Tertiary | --text-tertiary | #a3a8b8 | #60667c
Body 400 | --text-body-400 | #82879a | #60667c
Link Default | --text-link-default | #006aff | #3388ff
Link Visited | --text-link-visited | #3a3e4b | #a3a8b8
Accent Brand | --text-accent-brand | #006aff | #006aff
Status Negative | --text-status-negative | #e71111 | #ff5a5f
Status Warning | --text-status-warning | #ff9900 | #ffb647
Status Positive | --text-status-positive | #189f60 | #189f60
```

### Border

```dh-tokens
desc: Stroke colors for inputs, cards, dividers, and status rings.
Neutral 100 | --border-neutral-100 | #ebecef | #3a3e4b
Neutral 200 | --border-neutral-200 | #c6c8d2 | #4d5264
Neutral 250 | --border-neutral-250 | #b5b8c5 | #4d5264
Neutral 300 | --border-neutral-300 | #a3a8b8 | #60667c
Neutral 400 | --border-neutral-400 | #82879a | #60667c
Neutral 500 | --border-neutral-500 | #60667c | #a3a8b8
Brand 500 | --border-brand-500 | #006aff | #006aff
Brand 600 | --border-brand-600 | #0055cc | #3388ff
Status Focus | --border-status-focus | #006aff | #0099ff
Status Warning | --border-status-warning | #ff9900 | #ffb647
Status Warning Static | --border-status-warning-static | #ff9900 | #ff9900
Status Negative | --border-status-negative | #e71111 | #ff5a5f
Status Negative Static | --border-status-negative-static | #e71111 | #e71111
Status Positive Static | --border-status-positive-static | #189f60 | #189f60
Neutral 100 Static | --border-neutral-100-static | #ebecef | #ebecef
```

### Icon

```dh-tokens
desc: Fill colors for icon glyphs. Adaptive tokens invert with mode; static tokens never change.
Neutral 0 | --icon-neutral-0 | #ffffff | #262831
Neutral 300 | --icon-neutral-300 | #a3a8b8 | #60667c
Neutral 500 | --icon-neutral-500 | #60667c | #a3a8b8
Neutral 800 | --icon-neutral-800 | #262831 | #ebecef
Brand 500 | --icon-brand-500 | #006aff | #006aff
Neutral 0 Static | --icon-neutral-0-static | #ffffff | #ffffff
Neutral 50 Static | --icon-neutral-50-static | #fcfcfd | #fcfcfd
Neutral 300 Static | --icon-neutral-300-static | #a3a8b8 | #a3a8b8
Neutral 500 Static | --icon-neutral-500-static | #60667c | #60667c
Neutral 800 Static | --icon-neutral-800-static | #262831 | #262831
Brand 500 Static | --icon-brand-500-static | #006aff | #006aff
Status Warning | --icon-status-warning | #ff9900 | #ffb647
Status Negative | --icon-status-negative | #e71111 | #ff5a5f
Status Positive | --icon-status-positive | #189f60 | #45b380
```

## Component tokens

### Button

```dh-tokens
desc: Primary, secondary, and tertiary button surface, border, and text tokens.
Primary surface — rest | --btn-primary-surface-default | #006aff | #006aff
Primary surface — hover | --btn-primary-surface-hover | #3388ff | #3388ff
Primary surface — pressed | --btn-primary-surface-pressed | #0055cc | #0055cc
Primary surface — disabled | --btn-primary-surface-disabled | #ebecef | #262831
Primary text — rest | --btn-primary-text-default | #ffffff | #ffffff
Primary text — disabled | --btn-primary-text-disabled | #60667c | #a3a8b8
Secondary border — rest | --btn-secondary-border-default | #006aff | #006aff
Secondary border — hover | --btn-secondary-border-hover | #3388ff | #3388ff
Secondary border — pressed | --btn-secondary-border-pressed | #0055cc | #0055cc
Secondary border — disabled | --btn-secondary-border-disabled | #ebecef | #262831
Secondary text — rest | --btn-secondary-text-default | #006aff | #006aff
Secondary text — disabled | --btn-secondary-text-disabled | #60667c | #a3a8b8
Tertiary text — rest | --btn-tertiary-text-default | #006aff | #006aff
Tertiary text — disabled | --btn-tertiary-text-disabled | #60667c | #a3a8b8
```

### Input

```dh-tokens
desc: Text field surface, border, and label tokens across all states.
Surface — rest | --input-surface-default | #fcfcfd | #14151a
Surface — focused | --input-surface-focused | #fcfcfd | #14151a
Surface — disabled | --input-surface-disabled | #ebecef | #262831
Border — rest | --input-border-default | #82879a | #60667c
Border — focused | --input-border-focused | #006aff | #0099ff
Border — disabled | --input-border-disabled | #ebecef | #3a3e4b
Border — negative | --input-border-negative | #e71111 | #ff5a5f
Text — rest | --input-text-default | #262831 | #fcfcfd
Text — placeholder | --input-text-placeholder | #82879a | #60667c
Text — disabled | --input-text-disabled | #82879a | #60667c
```

### Checkbox

```dh-tokens
desc: Box surface, check icon, border, and label tokens.
Surface — rest | --checkbox-surface-default | #fcfcfd | #14151a
Surface — selected | --checkbox-surface-selected | #006aff | #006aff
Surface — disabled | --checkbox-surface-disabled | #82879a | #60667c
Border — rest | --checkbox-border-default | #82879a | #60667c
Border — focused | --checkbox-border-focused | #006aff | #0099ff
Border — disabled | --checkbox-border-disabled | #82879a | #60667c
Icon — check mark | --checkbox-icon-default | #ffffff | #ffffff
Text — rest | --checkbox-text-default | #262831 | #fcfcfd
Text — disabled | --checkbox-text-disabled | #60667c | #a3a8b8
```

### Radio

```dh-tokens
desc: Radio button surface, knob, border, and label tokens.
Surface — rest | --radio-surface-default | #fcfcfd | #14151a
Border — rest | --radio-border-default | #82879a | #60667c
Border — selected | --radio-border-selected | #006aff | #006aff
Knob — selected | --radio-knob-selected | #006aff | #006aff
Surface — disabled | --radio-surface-disabled | #82879a | #60667c
Border — disabled | --radio-border-disabled | #82879a | #60667c
Text — rest | --radio-text-default | #262831 | #fcfcfd
Text — disabled | --radio-text-disabled | #60667c | #a3a8b8
```

### Toggle

```dh-tokens
desc: Track surface in both states and knob color tokens.
Track — on | --toggle-surface-on | #006aff | #006aff
Track — off | --toggle-surface-off | #82879a | #60667c
Track — disabled | --toggle-surface-disabled | #c6c8d2 | #3a3e4b
Knob — on | --toggle-knob-on | #ffffff | #ffffff
Knob — off | --toggle-knob-off | #ffffff | #ffffff
```

### Dropdown

```dh-tokens
desc: Field surface, border, label, and selected item highlight tokens.
Label color | --dropdown-label-color | #262831 | #fcfcfd
Field surface | --dropdown-surface-field | #fcfcfd | #14151a
Border — rest | --dropdown-border-default | #82879a | #60667c
Item — selected fill | --dropdown-item-surface-selected | #ebecef | #262831
```

### Snackbar

```dh-tokens
desc: Surface and border tokens for neutral, warning, negative, and positive variants.
Surface — neutral | --snackbar-surface-neutral | #e5f0ff | #21273b
Surface — warning | --snackbar-surface-warning | #fff7eb | #271400
Surface — negative | --snackbar-surface-negative | #fff0f0 | #240001
Surface — positive | --snackbar-surface-positive | #e4fbf0 | #03190e
Border — neutral | --snackbar-border-neutral | #006aff | #006aff
Border — warning | --snackbar-border-warning | #ff9900 | #ffb647
Border — negative | --snackbar-border-negative | #e71111 | #ff5a5f
Border — positive | --snackbar-border-positive | #189f60 | #189f60
```

### Card

```dh-tokens
desc: Module card surface and text tokens.
Surface primary | --card-surface-primary | #262831 | #ebecef
Text — title | --card-text-title | #ebecef | #262831
Text — subtitle | --card-text-subtitle | #60667c | #a3a8b8
```

### Countdown

```dh-tokens
desc: Timer component uses static dark tokens so it is always dark-on-dark regardless of page mode.
Surface (static) | --timer-surface | #14151a | #14151a
Border (static) | --timer-border | #ebecef | #ebecef
Text (static) | --timer-text | #ffffff | #ffffff
```

### Tooltip

```dh-tokens
desc: Tooltip always renders on a dark background regardless of page mode.
Surface (static) | --tooltip-surface | #14151a | #14151a
Text (static) | --tooltip-text | #ffffff | #ffffff
```

### Stepper

```dh-tokens
desc: Progress stepper track colors. Active track is always brand blue; inactive is always a light gray.
Track — active (static) | --stepper-track-active | #006aff | #006aff
Track — inactive (static) | --stepper-track-inactive | #c6c8d2 | #c6c8d2
```

</Tab>
</Tabs>

---

- Path: `design-and-ux/components`
- URL: https://developer.incode.com/design-and-ux/components/
- Markdown: https://developer.incode.com/design-and-ux/components.md

# Components

This section documents every Prizma component, with its anatomy, variants, states, and tokens. Each component maps one-to-one with its Figma counterpart: same names, same tokens, same behavior.

## Actions

- [Buttons](/design-and-ux/button/): Trigger actions.
- [Button groups](/design-and-ux/button-group/): Define how multiple buttons are arranged in a flow.

## Inputs and Selection

- [Card lists](/design-and-ux/card-list/): Present a set of selectable verification steps or modules.
- [Checkboxes](/design-and-ux/checkbox/): Allow users to select one or more items from a set, or toggle a single option on or off.
- [Dropdowns](/design-and-ux/dropdown/): Allow users to select a single option from a collapsible list.
- [Inputs](/design-and-ux/input/): Collect text from users.
- [Radio buttons](/design-and-ux/radio/): Allow users to select exactly one option from a set.
- [Signature pads](/design-and-ux/signature/): Capture freehand signatures from users.

## Navigation and Wayfinding

- [Lists](/design-and-ux/list/): Show a numbered sequence of steps with clear progress indicators.
- [Navigation bars](/design-and-ux/navigation-bar/): Provide persistent headers on every step of a Prizma verification flow.
- [Steppers](/design-and-ux/stepper/): Show users where they are in a multi-step verification flow.

## Feedback and Status

- [Loading components](/design-and-ux/loading/): Communicate that the system is working.
- [Snackbars](/design-and-ux/snackbar/): Deliver brief, contextual feedback after a user action or system event.
- [State blocks](/design-and-ux/states/): Communicate a process state—loading, success, or error.
- [Timers](/design-and-ux/timer/): Display visible countdowns before a biometric capture event.

## Layout and Structure

- [Modals](/design-and-ux/modal/): Interrupt the current flow to deliver critical information or request a decision.
- [Separators](/design-and-ux/separator/): Create visual breaks between content sections.

---

- Path: `design-and-ux/curp-customization`
- URL: https://developer.incode.com/design-and-ux/curp-customization/
- Markdown: https://developer.incode.com/design-and-ux/curp-customization.md

# Customization

This section outlines the elements you can customize within the **CURP** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Enter your CURP default

This screen appears when the CURP module is first presented to the user. It represents the initial state of the flow, shown before any input is entered.

The input field is empty and the primary action is disabled until a valid CURP is provided. An alternative path is available for users who do not have a CURP.

<Image align="center" src="https://developer.incode.com/assets/ce2290d3d64dfe89fb70d20c5aa28b60.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**          | **Notes**                               |
| :--------------- | :---------------------------------- | :-------------------------------------- |
| **Text**         | Title, subtitle, button label       | Fully localizable; tone can be adapted  |
| **Brand Colors** | Illustration accent, button, header | Uses brand tokens                       |
| **Buttons**      | Label, color                        | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                           |
| :-------------------- | :-------------------------------------------- |
| Layout structure      | Ensures consistency across onboarding modules |
| Spacing & safe areas  | Required for device compatibility             |
| Text hierarchy        | Optimized for readability                     |
| Close icon position   | Standardized for user familiarity             |
| WCAG minimum contrast | Mandatory for accessibility compliance        |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/eefc681c6f0e67cb2fed0a4f86f73811.png" />

<br />

| UI Element                                      | Token                             | Raw Value |
| ----------------------------------------------- | --------------------------------- | --------- |
| Screen background                               | `surface-neutral-0`               | `#FFFFFF` |
| Title text (“Enter your CURP”)                  | `text-body-primary`               | `#262831` |
| Input background                                | `input-surface-default`           | `#FFFFFF` |
| Input border (default)                          | `input-border-default`            | `#E5E7EB` |
| Input placeholder text                          | `input-text-field-placeholder`    | `#9CA3AF` |
| Input text (entered value)                      | `text-body-primary`               | `#262831` |
| Primary button background (disabled)            | `button-primary-surface-disabled` | `#E5E7EB` |
| Primary button text (disabled)                  | `button-primary-text-disabled`    | `#9CA3AF` |
| Secondary button border (“I don’t have a CURP”) | `button-secondary-border-default` | `#006AFF` |
| Secondary button text                           | `button-secondary-text-default`   | `#006AFF` |

### Design Notes

* Keep copy short to minimize cognitive load.
* Display the “verified by Incode” footer as a subtle trust signal while maintaining sufficient contrast for accessibility.

***

## Enter your CURP filled

This state appears once the user has entered a complete and valid CURP. The input is confirmed visually, and the primary action is enabled, allowing the user to continue to the verification step.

<Image align="center" src="https://developer.incode.com/assets/6b50cfbf8dde3deb5bb003469cce8c0c.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**         | **Notes**                               |
| :--------------- | :--------------------------------- | :-------------------------------------- |
| **Text**         | Title, subtitle, button labels     | Fully localizable                       |
| **Brand Colors** | Buttons, links, highlight elements | Uses brand tokens                       |
| **Buttons**      | Label, color                       | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                            |
| :------------------------- | :--------------------------------------------- |
| Layout structure           | Maintains visual continuity with other modules |
| Button spacing & placement | Optimized for tap targets                      |
| Text hierarchy             | Follows global UX standards                    |
| Close icon position        | Consistent across modules                      |
| WCAG minimum contrast      | Required for readability and compliance        |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/98a503d2ff37a0d51359893aee2a0592.png" />

<br />

| **UI Element**                                  | **Token**                                             | **Raw Value** |
| ----------------------------------------------- | ----------------------------------------------------- | ------------- |
| Title text (“Enter your CURP”)                  | `text-body-primary`                                   | `#262831`     |
| Input text (entered CURP)                       | `input-text-field-default`                            | `#262831`     |
| Input surface (focused)                         | `input-surface-focused`                               | `#FCFCFD`     |
| Input border (focused)                          | `input-border-focused` / `border-status-focus`        | `#006AFF`     |
| Background                                      | `surface-neutral-0`                                   | `#FFFFFF`     |
| Primary button background (“Continue”)          | `button-primary-surface-default`                      | `#006AFF`     |
| Primary button text                             | `button-primary-text-default`                         | `#FFFFFF`     |
| Secondary button border (“I don’t have a CURP”) | `button-secondary-border-default`                     | `#006AFF`     |
| Secondary button text                           | `button-secondary-text-default` / `text-accent-brand` | `#006AFF`     |

### Design Notes

* Maintain a clear visual hierarchy between primary and secondary actions to guide user attention and decision-making.

***

## Enter your CURP - Loading

This screen appears after the user submits their CURP and validation is in progress. The entered value is locked and the primary action displays a loading indicator to communicate ongoing processing.

Once verification completes, the flow automatically transitions to the success or error state.

<Image align="center" src="https://developer.incode.com/assets/625b453b526b8c9c1a518215a230f85e.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**         | **Notes**                               |
| :--------------- | :--------------------------------- | :-------------------------------------- |
| **Text**         | Title, subtitle, button labels     | Fully localizable                       |
| **Brand Colors** | Buttons, links, highlight elements | Uses brand tokens                       |
| **Buttons**      | Label, color                       | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                       |
| :-------------------- | :---------------------------------------- |
| Layout structure      | Keeps parity between web and native flows |
| Text hierarchy        | Ensures clarity of instructions           |
| Button placement      | Optimized for quick completion            |
| WCAG minimum contrast | Required for web accessibility standards  |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2fd9d02ef2646924868d779a0f13c993.png" />

<br />

| **UI Element**                                  | **Token**                                             | **Raw Value** |
| ----------------------------------------------- | ----------------------------------------------------- | ------------- |
| Title text (“Enter your CURP”)                  | `text-body-primary`                                   | `#262831`     |
| Input text (disabled)                           | `input-text-field-disabled`                           | `#82879A`     |
| Input surface (disabled)                        | `input-surface-disabled`                              | `#EBECEF`     |
| Input border (disabled)                         | `input-border-disabled` / `border-neutral-100`        | `#EBECEF`     |
| Background                                      | `surface-neutral-0`                                   | `#FFFFFF`     |
| Primary button background (disabled)            | `button-primary-surface-default`                      | `#006AFF`     |
| Primary button text                             | `button-primary-text-default`                         | `#FFFFFF`     |
| Primary button loading indicator                | `surface-brand-400-static`                            | `#3388FF`     |
| Secondary button border (“I don’t have a CURP”) | `button-secondary-border-default`                     | `#006AFF`     |
| Secondary button text                           | `button-secondary-text-default` / `text-accent-brand` | `#006AFF`     |

### Design Notes

* The loading indicator uses brand tokens to signal progress without breaking visual consistency.
* Primary and secondary actions maintain hierarchy through consistent button tokens.

***

<br />

## Error State

This state appears when the entered CURP does not meet the required format or validation rules. The input field is highlighted to indicate an error, and a clear message explains what needs to be corrected.

The primary action remains disabled until a valid CURP is provided, allowing the user to fix the input or choose an alternative path if available.

<Image align="center" src="https://developer.incode.com/assets/467dc15625d340e71127d381424401b4.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                               |
| :--------------- | :------------------------------------------------- | :-------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                       |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                       |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/fc48963241e06fe97d234f73fb0826f7.png" />

<br />

| **UI Element**                                  | **Token**                                             | **Raw Value** |
| :---------------------------------------------- | :---------------------------------------------------- | :------------ |
| Title text (“Enter your CURP”)                  | `text-body-primary`                                   | `#262831`     |
| Input text (error)                              | `input-text-field-default`                            | `#262831`     |
| Input border (error)                            | `input-border-negative` / `border-status-negative`    | `#EF4444`     |
| Input surface (error)                           | `input-surface-negative` / `surface-neutral-100`      | `#EBECEF`     |
| Error icon                                      | `icon-status-negative`                                | `#EF4444`     |
| Error message text (“Invalid CURP”)             | `text-status-negative`                                | `#EF4444`     |
| Background                                      | `surface-neutral-0`                                   | `#FFFFFF`     |
| Primary button background (disabled)            | `button-primary-surface-disabled`                     | `#EBECEF`     |
| Primary button text (disabled)                  | `button-primary-text-disabled`                        | `#9CA3AF`     |
| Secondary button border (“I don’t have a CURP”) | `button-secondary-border-default`                     | `#006AFF`     |
| Secondary button text                           | `button-secondary-text-default` / `text-accent-brand` | `#006AFF`     |

<br />

### Design Notes

* Error states uses semantic error tokens (border, text, icon) to communicate validation clearly and consistenly.

***

## Verifying your CURP

Shown after the user submits their CURP. The system validates the identifier and displays a processing state while verification is in progress.

Once validation completes, the flow automatically proceeds to the success or error state.

<Image align="center" src="https://developer.incode.com/assets/ab3a0cfb4ccd96ec96cde6fc9629c81a.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                                    |
| :--------------- | :------------------------------------------------- | :------------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                            |
| **Illustration** | Colors or full replacement                         | Must clearly represent location confirmation |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                            |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/71b59776aea0c6538a831a68472a2204.png" />

<br />

| **UI Element**                        | **Token**                                              | **Raw Value** |
| ------------------------------------- | ------------------------------------------------------ | ------------- |
| Screen background                     | `surface-neutral-0`                                    | `#FFFFFF`     |
| Close icon                            | `icon-neutral-500`                                     | `#60667C`     |
| Loading spinner (primary surface)     | `spinner-surface-primary` / `surface-brand-500-static` | `#006AFF`     |
| Loading spinner (secondary surface)   | `spinner-surface-secondary` / `surface-brand-50`       | `#E6F0FF`     |
| Spinner text (“Verifying your CURP…”) | `spinner-text-title` / `text-body-primary`             | `#262831`     |
| Status bar icons                      | `icon-neutral-500`                                     | `#60667C`     |

### Design Notes

* The loading state removes interactive elements to prevent user interruption during verification.
* A centered circular progress indicator communicates system activity using brand tokens.

***

<br />

## CURP Not Verified

Shown when verification fails due to incomplete or invalid data, or due to a mismatch with the official database. The user can review and edit their input, or retry the process.

<Image align="center" src="https://developer.incode.com/assets/ca159d78ec39580053ba0303500db820.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                               |
| :--------------- | :------------------------------------------------- | :-------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                       |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                       |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/74c82364fa24da7326b204d9bb4d3f9f.png" />

<br />

| **UI Element**                          | **Token**                        | **Raw Value** |
| --------------------------------------- | -------------------------------- | ------------- |
| Screen background                       | `surface-neutral-0`              | `#FFFFFF`     |
| Status icon (error)                     | `icon-status-negative`           | `#EF4444`     |
| Status text (“CURP not verified”)       | `text-body-primary`              | `#262831`     |
| Primary button background (“Try again”) | `button-primary-surface-default` | `#006AFF`     |
| Primary button text                     | `button-primary-text-default`    | `#FFFFFF`     |
| Status bar icons                        | `icon-neutral-500`               | `#60667C`     |

<br />

### Design Notes

* A semantic error token is used for the icon to ensure immediate recognition of failure.

***

<br />

## CURP Verified

Displayed when the CURP is successfully verified. The user can proceed to the next step in the onboarding or identity flow.

<Image align="center" src="https://developer.incode.com/assets/99f2b4d885dd4c63a8243e48e969c2f3.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                               |
| :--------------- | :------------------------------------------------- | :-------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                       |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                       |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/a79c67b719753b4b2ded1ab26d3caa1a.png" />

<br />

| **UI Element**                 | **Token**              | **Raw Value** |
| ------------------------------ | ---------------------- | ------------- |
| Screen background              | `surface-neutral-0`    | `#FFFFFF`     |
| Status icon (success)          | `icon-status-positive` | `#22C55E`     |
| Status text (“CURP verified!”) | `text-body-primary`    | `#262831`     |
| Status bar icons               | `icon-neutral-500`     | `#60667C`     |

<br />

***

## Generate CURP - Empty form

Allows the user to generate a CURP if they don't have one, by manually entering personal details.

<Image align="center" src="https://developer.incode.com/assets/a5945c665c8bb7d574cd934cde173def.png" />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                               |
| :--------------- | :------------------------------------------------- | :-------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                       |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                       |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards |

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/ccd2ef5710bdd3a0c05a6c1f699f119a.png" />

| **UI Element**                               | **Token**                                        | **Raw Value** |
| :------------------------------------------- | :----------------------------------------------- | :------------ |
| Screen title (“Generate your CURP”)          | `text-body-primary`                              | `#262831`     |
| Close / Back icons                           | `icon-neutral-500`                               | `#60667C`     |
| Screen background                            | `surface-neutral-0`                              | `#FFFFFF`     |
| Text field label                             | `text-body-secondary`                            | `#60667C`     |
| Text field placeholder                       | `input-text-field-placeholder`                   | `#82879A`     |
| Text field input text                        | `text-body-primary`                              | `#262831`     |
| Input surface (default)                      | `input-surface-default`                          | `#FCFCFD`     |
| Input border (default)                       | `input-border-default` / `border-neutral-100`    | `#E5E7EB`     |
| Dropdown surface (default)                   | `dropdown-surface-default`                       | `#FFFFFF`     |
| Dropdown border (default)                    | `dropdown-border-default` / `border-neutral-400` | `#D1D5DB`     |
| Dropdown placeholder text                    | `dropdown-text-input-placeholder`                | `#82879A`     |
| Dropdown selected text                       | `dropdown-text-input-default`                    | `#262831`     |
| Dropdown icon                                | `icon-neutral-500`                               | `#60667C`     |
| Primary button background (“Call to action”) | `button-primary-surface-default`                 | `#006AFF`     |
| Primary button text                          | `button-primary-text-default`                    | `#FFFFFF`     |
| Primary button (disabled state)              | `button-primary-surface-disabled`                | `#EBECEF`     |
| Primary button text (disabled)               | `button-primary-text-disabled`                   | `#9CA3AF`     |

### Design Notes

* The screen follows a structured single-column form layout to support step-by-step data entry.
* Input fields use consistent input tokens to reinfoce visual uniformity.

***

## Generating CURP - Filled form

Shows the form with all required fields completed and ready to generate the CURP.

<Image align="center" src="https://developer.incode.com/assets/0dc35ae091241dc53b1a2fc5c039ef4c.png" />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                               |
| :--------------- | :------------------------------------------------- | :-------------------------------------- |
| **Text**         | Title, button label                                | Fully localizable                       |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                       |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards |

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/1143fe6c95a5dd1dada524542ff3d274.png" />

<br />

| **UI Element**                         | **Token**                                        | **Raw Value** |
| -------------------------------------- | ------------------------------------------------ | ------------- |
| Screen title (“Generate your CURP”)    | `text-body-primary`                              | `#262831`     |
| Close / Back icons                     | `icon-neutral-500`                               | `#60667C`     |
| Screen background                      | `surface-neutral-0`                              | `#FFFFFF`     |
| Input label text                       | `text-body-primary`                              | `#262831`     |
| Input text (filled)                    | `input-text-field-default` / `text-body-primary` | `#262831`     |
| Input surface (default)                | `input-surface-default`                          | `#FCFCFD`     |
| Input border (default)                 | `input-border-default` / `border-neutral-400`    | `#D1D5DB`     |
| Dropdown surface (default)             | `dropdown-surface-default`                       | `#FFFFFF`     |
| Dropdown border (default)              | `dropdown-border-default` / `border-neutral-400` | `#D1D5DB`     |
| Dropdown selected text                 | `dropdown-text-input-default`                    | `#262831`     |
| Dropdown icon                          | `icon-neutral-500`                               | `#60667C`     |
| Primary button background (“Generate”) | `button-primary-surface-default`                 | `#006AFF`     |
| Primary button text                    | `button-primary-text-default`                    | `#FFFFFF`     |
| Status bar icons                       | `icon-neutral-500`                               | `#60667C`     |

<br />

***

## Generating CURP - Error state

Shown when verification fails due to incomplete or invalid data, or due to a mismatch with the official database. The user can review and edit their input, or retry the process..

<Image align="center" src="https://developer.incode.com/assets/f042c8827a22c11531794088f9d83363.png" />

### Customizable Elements

| **Area**         | **What can be customized** | **Notes**                               |
| :--------------- | :------------------------- | :-------------------------------------- |
| **Text**         | Title, button label        | Fully localizable                       |
| **Brand Colors** | button background          | Uses brand tokens                       |
| **Buttons**      | Label and color            | Must follow platform and WCAG standards |

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/fd6e7b4b642bfc95957584edfbbfda15.png" />

<br />

| **UI Element**                                       | **Token**                        | **Raw Value** |
| ---------------------------------------------------- | -------------------------------- | ------------- |
| Status icon (error)                                  | `icon-status-negative`           | `#EF4444`     |
| Title text (“Couldn’t generate CURP”)                | `text-body-primary`              | `#262831`     |
| Supporting text (“Please check entered information”) | `text-body-secondary`            | `#60667C`     |
| Screen background                                    | `surface-neutral-0`              | `#FFFFFF`     |
| Primary button background (“Edit information”)       | `button-primary-surface-default` | `#006AFF`     |
| Primary button text                                  | `button-primary-text-default`    | `#FFFFFF`     |

<br />

### Design Notes

* The result state uses a centered status layout to clearly communicate system feedback.
* A semantic error token (red) is applied to the icon to ensure immediate visual recognition.

***

## Generating CURP - Confirmation

Displays the generated CURP for review before submission. The user can confirm or go back to edit details.

<Image align="center" src="https://developer.incode.com/assets/bd64c3ada4660fb40ba21c4c90f377bc.png" />

### Customizable Elements

| **Area**         | **What can be customized** | **Notes**                               |
| :--------------- | :------------------------- | :-------------------------------------- |
| **Text**         | Title, button label        | Fully localizable                       |
| **Brand Colors** | button background          | Uses brand tokens                       |
| **Buttons**      | Label and color            | Must follow platform and WCAG standards |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/16a5b2a2ba077708486a8dec3c1cb735.png" />

<br />

| **UI Element**                         | **Raw Value** | **Token**                        |
| -------------------------------------- | ------------- | -------------------------------- |
| Title text (“Confirm your CURP”)       | `#262831`     | `text-body-primary`              |
| CURP input text                        | `#262831`     | `input-text-field-default`       |
| Input border (disabled)                | `#EBECEF`     | `input-border-disabled`          |
| Input surface (disabled)               | `#EBECEF`     | `input-surface-disabled`         |
| Screen background                      | `#FFFFFF`     | `surface-neutral-0`              |
| Primary button background (“Continue”) | `#006AFF`     | `button-primary-surface-default` |
| Primary button text                    | `#FFFFFF`     | `button-primary-text-default`    |

---

- Path: `design-and-ux/curp-design`
- URL: https://developer.incode.com/design-and-ux/curp-design/
- Markdown: https://developer.incode.com/design-and-ux/curp-design.md

# CURP

The CURP module captures and validates the user's Clave Única de Registro de Población (CURP). It is used to verify the user's identity as part of identity validation or compliance workflows.  

It is used as a country-specific identity verification step for Mexico, typically after basic personal information input and before final verification or document capture.  

<Image align="center" border={false} src="https://developer.incode.com/assets/a9df416ca86e95723b3adc3b95032ed0.gif" />

***

## Where it fits in the flow

**CURP**  appears as a country-specific step in the verification flow for users in Mexico.

It typically occurs after the user provides basic personal information and before document capture or final verification, ensuring the CURP is validated early in the process.

***

## User Flow

The **CURP** experience guides the user from data entry to validation. The flow begins with an input screen where the user is prompted to enter their CURP. As the user types, the system validates the input format and enables progression once the value is complete. 

After submission, the system verifies the CURP and displays a processing state. Once validation is successful, a confirmation screen is shown and the user continues to the next module in the verification flow. 

It validation fails, the user receives feedback and can correct the input or choose an alternative path if available. 

<Image align="center" border={false} src="https://developer.incode.com/assets/db99bb976da8003708b9234544b47b23.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in the CURP module, from initial screen and real-time validation to processing states, error handling and successful information. 

It visually represents both the ideal and alternative user journeys, helping teams understand all possible user interactions and system states within the module.

<Image align="center" border={false} src="https://developer.incode.com/assets/dd353cdbb37d3a87ff24b0886e02ef11.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the CURP is entered and validates successfully with no interruptions. 

The happy path represents the smoothest version of the experience, where the user enters a valid CURP, the system verifies it successfully and the flow proceeds automatically without requiring corrections or retries. 

Both light and dark mode previews are included so design, product, and engineering teams can validate visual consistency and accessibility across themes.

<Image align="center" alt="Geolocation module - Happy Path in Light mode" border={false} caption="Light mode" src="https://developer.incode.com/assets/d3d2df0e34362038c808bca694053e93.png" />

<Image align="center" alt="Geolocation module - Happy Path in Dark mode" border={false} caption="Dark mode" src="https://developer.incode.com/assets/00e5254abc26746013e7dd03a399d2e9.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **CURP** experience.

**✅ Do**

* Clearly explain why the CURP is requested — transparency builds trust.
* Validate input progressively and provide immediate, clear feedback.
* Use localized copy and terminology appropriate for users in Mexico.
* Provide a visible alternative path (for example, “I don’t have a CURP”) when applicable.

**❌ Don’t**

* Don’t block the flow indefinitely due to formatting or validation errors.
* Avoid unclear error messages or silent failures.

---

- Path: `design-and-ux/curp-screens-states`
- URL: https://developer.incode.com/design-and-ux/curp-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/curp-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the CURP experience. Each state includes a brief description.

***

## Enter CURP

This screen prompts the user to enter their Clave Única de Registro de Población (CURP).  
As the user types, the system validates the input format and enables progression once a complete CURP is provided. Alternative paths, are available when applicable.

<Image align="center" src="https://developer.incode.com/assets/ca7e998b4d7ae3298d0462b536ac1951.png" />

<br />

## Generate CURP

This screen allows users who do not have their CURP to generate it by providing the required personal information, such as name, date of birth, gender and place of birth.

Once the required details are submitted, the system generates the CURP and presents it for confirmation before the user continues in the verification flow.

<Image align="center" src="https://developer.incode.com/assets/6f2517d8c77921d6732a1441515cc8e7.png" />

<br />

## Verify CURP

This screen appears after the user submits their CURP. The system validates the provided identifier and displays processing state while verification is in progress.

Once validation is compete, the flow continues automatically to the success or error state, depending on the result.

<Image align="center" src="https://developer.incode.com/assets/79295bc0757e6d786bf82f979ba9f609.png" />

<br />

## Success

Displayed when the CURP is successfully verified. The user can proceed to the next step in the onboarding or identity flow.

<Image align="center" src="https://developer.incode.com/assets/17b05478027fe5376866a64ff769a095.png" />

<br />

## Error State

Shown when verification fails due to incomplete or invalid data, or due to a mismatch with the official database. The user can review and edit their input or retry the process.

<Image align="center" src="https://developer.incode.com/assets/aec521dc1f39f9bd809248742659f720.png" />

<br />

## Form error

Displayed when the entered CURP is invalid or doesn't match the expected format. The user receives immediate feedback and can correct the input.

<Image align="center" src="https://developer.incode.com/assets/1b65deabc0762ed5cb55dfeefe25ae4f.png" />

---

- Path: `design-and-ux/curp-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/curp-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/curp-specs-guidelines.md

# Specs & Guidelines

The **CURP** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/c5cfcb4957b3fdb57cec03b34d183c80.png" />

<br />

***

## Responsiveness & Viewport Adaptation

The **CURP** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas, such as CTAs, remain visible, accessible, and consistently aligned across platforms.

<Image align="center" src="https://developer.incode.com/assets/5130b0ef45acb8424a2cf9f2ea36da7e.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                  |
| :--------------------------------- | :---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | Reduce vertical spacing; full-width input and buttons;                        |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                    |
| **Tall/narrow Android devices**    | Vertical spacing adapts to maintain balance                                   |
| **Foldables (e.g., Pixel Fold)**   | Centered form with max-width constrains                                       |
| **Tablets**                        | Consistent input and button sizing; Fixed-width container centered on screen. |
| **Desktop web**                    | Centered content with max-width constraint and safe-area padding              |

<br />

### What is responsive (and customizable)

| **Element**              | **Responsive Behavior**                       | **Customizable**            |
| :----------------------- | :-------------------------------------------- | :-------------------------- |
| Form container           | Maintains centered max-width on large screens | Fully localizable           |
| Instruction / title text | Width adapts to container                     | Placeholder and helper text |
| Buttons                  | Width adjusts to container, spacing adapts    | Color & text                |
| Footer / watermark       | Pinned to bottom safe area                    | Optional                    |
| Background surfaces      | Expand to full viewport                       | Yes                         |
| Header area              | Adjusts padding to safe-area insets           | Limited (color only)        |

<br />

### What remains fixed across breakpoints

| **Element**              | **Reason**                                                 |
| :----------------------- | :--------------------------------------------------------- |
| Location detection logic | Must remain consistent for accuracy                        |
| Single column layout     | Preserves clarity and reduces cognitive load in form entry |
| Validation placement     | Must remain inline for usability and accessibility         |
| Minimum text size        | Ensures readability & WCAG compliance                      |
| Minimum tap target sizes | Accessibility requirement on mobile                        |
| Layout hierarchy         | Keeps experience consistent across devices                 |

<br />

### Design Notes

* The form remains the visual focal point across all devices.
* The layout stays single-column to preserve clarity and reduce cognitive load.
* Vertical spacing follows fixed, safe thresholds; horizontal layout adapts fluidly within a max-width container.
* Avoid adding custom elements above or below the module to maintain structural alignment.
* Accessibility standards (minimum tap targets, readable type scale, contrast ratios) must be preserved across breakpoints.

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/1a79e7419ead00f4c022d5d87025c114.png" />

<br />

***

## Prototype & Transitions

CURP includes predefined transition rules and micro-interactions that ensure a smooth user experience. Animation guidelines are documented directly in Figma prototypes.

<br />

<Image align="center" src="https://developer.incode.com/assets/a9df416ca86e95723b3adc3b95032ed0.gif" />

<br />

***

## Localization

The **CURP** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/45adfb3efd7cc7a704febe5698956e83.png" />

<br />

### Key considerations

* Incode supports a variety of languages.
* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.

<br />

---

- Path: `design-and-ux/curp-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/curp-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/curp-v1-vs-v2-comparison.md

# CURP V1 vs V2 Comparison

V1 provides a basic CURP input and validation experience. While it supports correct data entry and basic validation logic, the flow offers limited flexibility for customization and is not fully aligned with the token-based design system.

V2 builds on the same functional foundation but rethinks the experience to be clearer, more structured, and easier to customize. It introduces standardized components, improved UX writing, better defined validations states and full alignment with the token-based design system.

The V2 experience is designed to improve predictability, reduce friction during validation and ensure consistent behavior.

<br />

<Image align="center" caption="V1 provides a basic CURP input experience focused primarily on data submission, with limited validation feedback and customization flexibility." src="https://developer.incode.com/assets/cfdcde511ddd91e70d1610c963ad224d.png" />

<br />

<Image align="center" caption="V2 delivers a clearer, structured CURP validation flow with standardized states, improved feedback, and token-based customization support." src="https://developer.incode.com/assets/888b8eed26de68f988094dd1819300eb.png" />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1      | V2       | Notes                                                              |
| -------------------------- | ------- | -------- | ------------------------------------------------------------------ |
| CURP Validation            | ✅       | ✅        | Core validation logic present in both versions                     |
| Inline validation          | ✅       | ✅        | Both support validation during input.                              |
| Error states coverage      | ✅       | ✅        | Both handle errors, V2 structures them better and improves clarity |
| Customization options      | Limited | Advanced | V2 supports token-based customization                              |
| Documentation completeness | Basic   | Enhanced | V2 provides enhanced, standardized documentation coverage          |

***

## Behavior Differences

How the module behaves during runtime.

| Behavior              | V1                                     | V2                                                        | Notes                                                                        |
| --------------------- | -------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------- |
| Error handling        | Separate error states, less contextual | Clear, actionable error messages with improved UX writing | V2 reduces cognitive load.                                                   |
| State transitions     | Default transitions                    | Defined transitions between states                        | V2 includes transition smoothness and consistency as part of the experience. |
| Flow and UI structure | Functional but less standardized       | Structured and consistent                                 | V2 follows standardized layout and spacing rules.                            |

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/222be7b2bec1e1206dbe68442287a367.gif" />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

---

- Path: `design-and-ux/customization-adsign`
- URL: https://developer.incode.com/design-and-ux/customization-adsign/
- Markdown: https://developer.incode.com/design-and-ux/customization-adsign.md

# Customization AES

This section outlines the elements you can customize within the **Advanced Signature** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Signature empty

Entry point of the Advanced Signature module. This screen presents the user with a consent form titled "Accept and sign," accompanied by a brief instruction to accept the terms before completing the signature.

<Image align="center" src="https://developer.incode.com/assets/8f0311459a5fcf21455d5873fbcfd607.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                      | **Notes**                                                                               |
| -------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Text**             | Title ("Accept and sign"), instruction text, button text        | Fully localizable; tone and terminology can be adapted to match brand voice.            |
| **Background Color** | Screen background                                               | Must maintain strong contrast with inputs, text, and CTAs for accessibility compliance. |
| **Buttons (CTA)**    | Button label (“Finish signing”), background color, text color   | Uses brand tokens                                                                       |
| **Brand Colors**     | Header text, accent color, input focus state, status indicators | Applied via design tokens; avoid reducing clarity in critical validation states.        |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                                |
| ------------------------------ | -------------------------------------------------------------------------------------------------- |
| **CTA state behavior**         | "Done" button remains disabled until a signature stroke is detected, preventing empty submissions. |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture.                |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.                             |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.                              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/c07a23a873f419bc0e07c69d02ad59ca.png" />

<br />

| **UI Element**                          | **Token**                         | **Raw Value** |
| :-------------------------------------- | :-------------------------------- | :------------ |
| Title text (Accept and sign)            | `text-body-primary`               | `#262831`     |
| Instruction text                        | `text-body-secondary`             | `#60667C`     |
| Document row surface                    | `surface-neutral-50`              | `#F5F6F7`     |
| Document row border                     | `border-neutral-100`              | `#E6E8EF`     |
| Document name text                      | `text-body-primary`               | `#262831`     |
| “View” link                             | `button-tertiary-text-default`    | `#0046FF`     |
| Background                              | `surface-neutral-0`               | `#FFFFFF`     |
| Checkbox border (default)               | `checkbox-border-default`         | `#CFCFDF`     |
| Checkbox surface (default)              | `checkbox-surface-default`        | `#FCFCFD`     |
| Checkbox text                           | `checkbox-text-default`           | `#262831`     |
| Checkbox group surface (selected state) | `surface-brand-50`                | `#EAF0FF`     |
| Secondary container border              | `border-neutral-400`              | `#82879A`     |
| Secondary container surface             | `surface-neutral-100`             | `#F5F6F7`     |
| Primary button (disabled) background    | `button-primary-surface-disabled` | `#EBECEF`     |
| Primary button (disabled) text          | `button-primary-text-disabled`    | `#60667C`     |

### Design Notes

* Keep field labels and helper text concise to reduce cognitive load.
* Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
* Preserve sufficient color contrast across all states (idle, focus, error, disabled).

<br />

## Signature Filled

This screen reflects the state after the user has checked all three consent checkboxes. Each checkbox is now marked and highlighted in blue, confirming the user's agreement to the terms.

<Image align="center" src="https://developer.incode.com/assets/545eb9a8bba272dbd6fa4ff443f7f3ac.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                                                         | **Notes**                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, instruction text,  button text, badge text                                  | Fully localizable. Tone and terminology can align with brand and regulatory requirements. |
| **Color Styling** | Background, input surfaces, text color, focus state, CTA background and text color | Applied via design tokens. Must maintain accessibility contrast standards.                |
| **CTA Label**     | Primary button text (e.g., “Finish signing”)                                       | Editable; action meaning must remain consistent with flow behavior.                       |
| **Localization**  | All textual content                                                                | Supports full localization. Layout should accommodate text expansion.                     |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                                            |
| ---------------------------------- | ------------------------------------------------------------------------------ |
| **CTA enabled behavior**           | "Done" button is enabled only when a valid signature is present on the canvas. |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.                            |
| **Text hierarchy**                 | Maintains clear task communication and visual structure.                       |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                                        |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/3f06e5876ca15740c233a84447046a66.png" />

<br />

| **UI Element**                              | **Token**                        | **Raw Value** |
| :------------------------------------------ | :------------------------------- | :------------ |
| Title text (Accept and sign)                | `text-body-primary`              | `#262831`     |
| Instruction text                            | `text-body-secondary`            | `#60667C`     |
| Screen background                           | `surface-neutral-100`            | `#EBECEF`     |
| Modal/card surface                          | `surface-neutral-0`              | `#FFFFFF`     |
| Document row surface                        | `surface-neutral-50`             | `#F5F6F7`     |
| Document name text                          | `text-body-primary`              | `#262831`     |
| “View” link                                 | `button-tertiary-text-default`   | `#0046FF`     |
| Checkbox surface (default)                  | `checkbox-surface-default`       | `#FCFCFD`     |
| Checkbox icon (checkmark)                   | `checkbox-icon-default`          | `#FFFFFF`     |
| Checkbox surface (selected)                 | `checkbox-surface-selected`      | `#0046FF`     |
| Checkbox container surface (group selected) | `surface-brand-50`               | `#EAF0FF`     |
| Checkbox text                               | `checkbox-text-default`          | `#262831`     |
| Primary button background (default)         | `button-primary-surface-default` | `#0046FF`     |
| Primary button text (default)               | `button-primary-text-default`    | `#FFFFFF`     |

## Design notes

* Keep the layout clear and vertically structured to reduce cognitive load.
* The enabled "Finish signing" button signals readiness to submit, using a distinct color shift from its disabled state to reinforce interactivity.

***

<br />

## Signature loading

Transitional state shown after the user taps "Finish signing." The screen retains the consent form layout while a loading spinner appears on the "Finish signing" button, providing visual feedback that the system is processing the request.

<Image align="center" src="https://developer.incode.com/assets/9643a63b63ee2b7187ec18cdcbc63974.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/d4078c08a6477cadb3b2f53d29f924e8.png" />

<br />

| **UI Element**                              | **Token**                        | **Raw Value** |
| :------------------------------------------ | :------------------------------- | :------------ |
| Title text (Accept and sign)                | `text-body-primary`              | `#262831`     |
| Instruction text                            | `text-body-secondary`            | `#60667C`     |
| Background                                  | `surface-neutral-0`              | `#FFFFFF`     |
| Document row surface                        | `surface-neutral-50`             | `#FCFCFD`     |
| Document row border                         | `border-neutral-100`             | `#EBECEF`     |
| Document name text                          | `text-body-primary`              | `#262831`     |
| Main content surface                        | `surface-neutral-0`              | `#FFFFFF`     |
| Checkbox surface (disabled)                 | `checkbox-surface-disabled`      | `#82879A`     |
| Checkbox icon (checkmark)                   | `checkbox-icon-default`          | `#FFFFFF`     |
| Checkbox container surface (disabled group) | `surface-neutral-400`            | `#82879A`     |
| Checkbox text (disabled)                    | `checkbox-text-disabled`         | `#60667C`     |
| Primary button background (loading/default) | `button-primary-surface-default` | `#006AFF`     |
| Primary button text                         | `button-primary-text-default`    | `#FFFFFF`     |
| Loading spinner (on button)                 | `icon-inverse`                   | `#FFFFFF`     |

<br />

## Design notes

* Preserve layout stability when switching to loading state.
* Maintain accessible contrast for spinner and disabled elements.

***

<br />

## Processing screen

Intermediate screen displayed while the system processes the signature submission. The screen shows a spinning progress indicator alongside the text "Processing…", communicating to the user that their action is being handled and they should wait.

<Image align="center" src="https://developer.incode.com/assets/18a3b159e26f60411fe1e980ed64e787.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/d55fce663ce637319342f03b6d73f623.png" />

<br />

| **UI Element**                  | **Token**                  | **Raw Value** |
| :------------------------------ | :------------------------- | :------------ |
| Screen background               | `surface-neutral-0`        | `#FFFFFF`     |
| Spinner (active stroke)         | `surface-brand-500-static` | `#006AFF`     |
| Spinner (track/background)      | `surface-brand-50`         | `#EAF0FF`     |
| Processing text (“Processing…”) | `text-body-primary`        | `#262831`     |

## Success

Final confirmation screen of the Advanced Signature module. After processing completes, the screen displays a green checkmark icon along with the message "Signed successfully!" confirming that the signature has been captured and the process is complete. No further user action is required. 

<Image align="center" src="https://developer.incode.com/assets/55d6a4bf2a41f57f2bf30cc408e037af.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/c739b2387518033c1451d0dbe0a6a687.png" />

<br />

| **UI Element**                      | **Token**              | **Raw Value** |
| :---------------------------------- | :--------------------- | :------------ |
| Screen background                   | `surface-neutral-0`    | `#FFFFFF`     |
| Success icon background             | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)                | `icon-neutral-0`       | `#FFFFFF`     |
| Title text (“Signed successfully!”) | `text-body-primary`    | `#262831`     |

<br />

---

- Path: `design-and-ux/customization-certificate-issuance`
- URL: https://developer.incode.com/design-and-ux/customization-certificate-issuance/
- Markdown: https://developer.incode.com/design-and-ux/customization-certificate-issuance.md

# Customization

This section outlines the elements you can customize within the **Certificate Issuance** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

***

## Create your password - Empty

Entry point of the Certificate Issuance module. This screen allows users to create and confirm their password before proceeding with the certificate issuance process. Clear validation states and password requirements help ensure a secure and successful account setup.


<Image src="https://developer.incode.com/assets/b268ea0ead03f20ab19601c48cc1cf8a.png" align="center" />


<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                                               | **Notes**                                                                                                     |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| **Text**             | Screen title, field labels, placeholders, helper text, validation messages, button text, processing and success messages | Fully localizable; tone and terminology can be adapted to align with brand voice and compliance requirements. |
| **Input States**     | Helper text, inline validation messaging, disabled and focus states                                                      | Validation logic remains fixed to preserve consistency and usability standards.                               |
| **Background Color** | Screen background color                                                                                                  | Must maintain sufficient contrast with text, inputs, and CTAs to support accessibility compliance.            |
| **Buttons (CTA)**    | Button labels, background color, text color, disabled state styling                                                      | Uses brand tokens while preserving visibility and accessibility across states.                                |
| **Brand Colors**     | Accent colors, input focus state, loading indicator, success state colors                                                | Applied via design tokens; avoid reducing clarity in validation, processing, or success states.               |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                    |
| ------------------------------ | ---------------------------------------------------------------------- |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.  |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/818f2fb8df640cc9f952b64c834a6a4c.png" align="center" />


| UI Element                        | Token                           | Raw Value |
| --------------------------------- | ------------------------------- | --------- |
| Screen background                 | surface-neutral-0               | #FFFFFF   |
| Header title text                 | text-body-primary               | #262831   |
| Password label text               | input-text-label-default        | #262831   |
| Password placeholder text         | input-text-input-placeholder    | #B2879A   |
| Password input border             | input-border-default            | #B2879A   |
| Password input background         | input-surface-default           | #FCFCDD   |
| Confirm password label text       | input-text-label-default        | #262831   |
| Confirm password placeholder text | input-text-input-placeholder    | #B2879A   |
| Confirm password input border     | input-border-default            | #B2879A   |
| Confirm password input background | input-surface-default           | #FCFCDD   |
| Continue button background        | button-primary-surface-disabled | #EBECEF   |
| Continue button text              | button-primary-text-disabled    | #60667C   |
| Primary body text                 | text-body-800-primary           | #262831   |
| Secondary body text               | text-body-400                   | #B2879A   |

<br />

## Create a password - Filled

State displayed after the user has successfully entered their password. All required fields have been completed, validation requirements have been met, and the user can proceed to the Certificate Issuance process.


<Image src="https://developer.incode.com/assets/dd5c6e336d1059abd445416bd4cd0835.png" align="center" />


<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                                               | **Notes**                                                                                                     |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| **Text**             | Screen title, field labels, placeholders, helper text, validation messages, button text, processing and success messages | Fully localizable; tone and terminology can be adapted to align with brand voice and compliance requirements. |
| **Input States**     | Helper text, inline validation messaging, disabled and focus states                                                      | Validation logic remains fixed to preserve consistency and usability standards.                               |
| **Background Color** | Screen background color                                                                                                  | Must maintain sufficient contrast with text, inputs, and CTAs to support accessibility compliance.            |
| **Buttons (CTA)**    | Button labels, background color, text color.                                                                             | Uses brand tokens while preserving visibility and accessibility across states.                                |
| **Brand Colors**     | Accent colors, input focus state, loading indicator, success state colors                                                | Applied via design tokens; avoid reducing clarity in validation, processing, or success states.               |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                    |
| ------------------------------ | ---------------------------------------------------------------------- |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.  |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/99f71b1548b66ee3e22ded811e433c05.png" align="center" />


<br />

| UI Element                  | Token                          | Raw Value |
| --------------------------- | ------------------------------ | --------- |
| Screen background           | surface-neutral-0              | #FFFFFF   |
| Header title text           | text-body-primary              | #262831   |
| Password label text         | input-text-label-default       | #262831   |
| Password input text         | input-text-input-default       | #262831   |
| Password input border       | input-border-default           | #B2879A   |
| Password input background   | input-surface-default          | #FCFCDD   |
| Confirm password label text | input-text-label-default       | #262831   |
| Confirm password input text | input-text-input-default       | #262831   |
| Confirm password border     | input-border-default           | #B2879A   |
| Confirm password background | input-surface-default          | #FCFCDD   |
| Continue button background  | button-primary-surface-default | #006AFF   |
| Continue button text        | button-primary-text-default    | #FFFFFF   |
| Primary body text           | text-body-800-primary          | #262831   |
| Brand primary surface       | surface-brand-500-static       | #006AFF   |

## Create a password - Loading

Processing state of the Certificate Issuance module. This screen informs the user that the certificate issuance request is being processed. A loading indicator communicates that the operation is currently in progress while temporarily preventing duplicate submissions or interruptions to ensure a secure and successful issuance experience.


<Image src="https://developer.incode.com/assets/c6c8a3c28147e521ec7e894508d30b9a.png" align="center" />


<br />

### Customizable Elements

| **Area**              | **What can be customized**                                               | **Notes**                                                                                         |
| --------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| **Text Elements**     | Processing title, status message, helper text                            | Fully localizable. Tone and terminology can align with brand and compliance requirements.         |
| **Color Styling**     | Background color, text color, loading indicator color, status icon color | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Branding**          | Logo placement, typography styles, accent colors                         | Branding updates should maintain readability and consistency throughout the verification flow.    |
| **Localization**      | All textual content and regional formatting                              | Supports localization and translation. Layout should account for text expansion across languages. |
| **Loading Indicator** | Spinner style and animation behavior                                     | Customizable within approved motion and accessibility guidelines.                                 |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                    |
| ------------------------------ | ---------------------------------------------------------------------- |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.  |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/aaefda5f1028e7e5d6729c386d174b11.png" align="center" />


<br />

| UI Element                   | Token               | Raw Value |
| ---------------------------- | ------------------- | --------- |
| Screen background            | surface-neutral-0   | #FFFFFF   |
| Processing spinner           | surface-brand-400   | #3388FF   |
| Processing title text        | text-body-primary   | #262831   |
| Processing helper text       | text-body-secondary | #60667C   |
| Loading indicator background | surface-brand-100   | #D6E7FF   |
| Primary status icon          | icon-status-info    | #3388FF   |
| Primary body text            | text-body-primary   | #262831   |

###

# Design Notes

- Keep processing and success messaging concise to reduce cognitive load during the certificate issuance process.
- Preserve sufficient color contrast across all states, including processing, success, disabled, and error states.
- Maintain consistent spacing, typography, and iconography across all Certificate Issuance states to reinforce flow continuity.

<br />

## Processing

The screen displays a loading indicator and processing message, communicating that the certificate issuance request is currently being processed. During this stage, the user is informed that the operation is in progress while duplicate submissions and interruptions are temporarily prevented to ensure a secure and successful issuance experience.


<Image src="https://developer.incode.com/assets/58b84b5ea502133ba12d4e6b9b385947.png" align="center" />


<br />

### Customizable Elements

| **Area**          | **What can be customized**                                      | **Notes**                                                                                         |
| ----------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Color Styling** | Background color, text color, success icon color, accent colors | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Localization**  | All textual content and regional formatting                     | Supports localization and translation. Layout should account for text expansion across languages. |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                      |
| ---------------------------------- | -------------------------------------------------------- |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.      |
| **Text hierarchy**                 | Maintains clear task communication and visual structure. |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                  |

### Token Reference


<Image src="https://developer.incode.com/assets/aed2589d0f933420473c270e4b3c4675.png" align="center" />


| UI Element                   | Token               | Raw Value |
| ---------------------------- | ------------------- | --------- |
| Screen background            | surface-neutral-0   | #FFFFFF   |
| Processing spinner           | surface-brand-400   | #3388FF   |
| Processing title text        | text-body-primary   | #262831   |
| Processing helper text       | text-body-secondary | #60667C   |
| Loading indicator background | surface-brand-100   | #D6E7FF   |
| Primary status icon          | icon-status-info    | #3388FF   |
| Primary body text            | text-body-primary   | #262831   |

## Design notes

- Keep the layout clear, vertically structured, and easy to scan to reduce cognitive load.

***

##

## Create a password - Download certificate&#x20;

The screen indicates that the certificate has been successfully generated and is ready for download. A confirmation message is displayed along with a clear call-to-action allowing the user to download their certificate and complete the Certificate Issuance process.


<Image src="https://developer.incode.com/assets/9018cf7a6f111ce538251b34251c1bb1.png" align="center" />


### Customizable Elements

| **Area**          | **What can be customized**                                      | **Notes**                                                                                         |
| ----------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Color Styling** | Background color, text color, success icon color, accent colors | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Localization**  | All textual content and regional formatting                     | Supports localization and translation. Layout should account for text expansion across languages. |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                      |
| ---------------------------------- | -------------------------------------------------------- |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.      |
| **Text hierarchy**                 | Maintains clear task communication and visual structure. |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                  |

### Token Reference


<Image src="https://developer.incode.com/assets/3e8b9d11e9c84f608a23354872571705.png" align="center" />


| UI Element                    | Token                          | Raw Value |
| ----------------------------- | ------------------------------ | --------- |
| Screen background             | surface-neutral-0              | #FFFFFF   |
| Success title text            | text-body-primary              | #262831   |
| Success helper text           | text-body-secondary            | #60667C   |
| Primary CTA button background | button-primary-surface-default | #006AFF   |
| Primary CTA button text       | button-primary-text-default    | #FFFFFF   |

## Design notes

- Keep the layout clear, vertically structured, and easy to scan to reduce cognitive load.

## Create a password - Done

The screen confirms that the certificate has been successfully generated and downloaded. A success message is displayed to indicate completion of the Certificate Issuance process, along with a final confirmation that the user can exit the flow or proceed with the downloaded certificate.


<Image src="https://developer.incode.com/assets/564af2481757e17a56c2766c569f6907.png" align="center" />


### <br />Customizable Elements

| **Area**          | **What can be customized**                                      | **Notes**                                                                                         |
| ----------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Color Styling** | Background color, text color, success icon color, accent colors | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Localization**  | All textual content and regional formatting                     | Supports localization and translation. Layout should account for text expansion across languages. |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                      |
| ---------------------------------- | -------------------------------------------------------- |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.      |
| **Text hierarchy**                 | Maintains clear task communication and visual structure. |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                  |

### Token Reference


<Image src="https://developer.incode.com/assets/80f1aa481245ed4d592b47354530eda0.png" align="center" />


| UI Element                    | Token                          | Raw Value |
| ----------------------------- | ------------------------------ | --------- |
| Screen background             | surface-neutral-0              | #FFFFFF   |
| Success icon background       | surface-brand-100              | #D6E7FF   |
| Success icon                  | icon-status-positive           | #1E7F11   |
| Success title text            | text-body-primary              | #262831   |
| Success helper text           | text-body-secondary            | #60667C   |
| Primary CTA button background | button-primary-surface-default | #006AFF   |
| Primary CTA button text       | button-primary-text-default    | #FFFFFF   |

<br />

<br />

---

- Path: `design-and-ux/customization-ekyb`
- URL: https://developer.incode.com/design-and-ux/customization-ekyb/
- Markdown: https://developer.incode.com/design-and-ux/customization-ekyb.md

# Customization

This section outlines the elements you can customize within the **eKYB** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Empty form

The Empty Form screen introduces the eKYB Verification step and clearly communicates that the user must provide personal and document information for identity validation.

<Image align="center" src="https://developer.incode.com/assets/36a384cb0077759b10bdd85915fe063e.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                            | **Notes**                                                                                                |
| -------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Text**             | Title (“eKYB Verification”), field labels, placeholders, helper messages, error messages, button text | Fully localizable; tone and terminology can be adapted to match brand voice and regulatory requirements. |
| **Field Set**        | Displayed fields (e.g., Driver’s License, Credit Bureau, Registry source)                             | Defined by selected verification source in dashboard configuration; structure remains consistent.        |
| **Input States**     | Helper text, inline validation messaging                                                              | Validation logic is fixed; messaging style can be customized.                                            |
| **Background Color** | Screen background                                                                                     | Must maintain strong contrast with inputs, text, and CTAs for accessibility compliance.                  |
| **Buttons (CTA)**    | Button label (“Continue”), background color, text color                                               | Uses brand tokens                                                                                        |
| **Brand Colors**     | Header text, accent color, input focus state, status indicators                                       | Applied via design tokens; avoid reducing clarity in critical validation states.                         |

<br />

### Fixed Elements

| **Element**                             | **Why it is fixed**                                                                                 |
| --------------------------------------- | --------------------------------------------------------------------------------------------------- |
| **Verification logic & decision rules** | Defined by backend services and compliance requirements; cannot be modified at the UI level.        |
| **Required field validation rules**     | Ensures data accuracy, fraud prevention, and regulatory compliance.                                 |
| **Form structure hierarchy**            | Designed for clarity, usability, and completion consistency across markets and platforms.           |
| **Processing flow behavior**            | Prevents duplicate submissions, race conditions, and system instability.                            |
| **CTA state behavior**                  | Controls when submission is allowed and manages loading/disabled states to prevent invalid actions. |
| **Error handling logic**                | System-defined to protect data integrity and ensure consistent feedback.                            |
| **Component spacing & safe areas**      | Guarantees cross-device consistency and accessibility across screen sizes.                          |
| **Text hierarchy**                      | Maintains clear task communication and visual clarity within the flow.                              |
| **WCAG contrast requirements**          | Mandatory for accessibility compliance and inclusive user experience.                               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/15757a4d6f8a8d6873734672e31dc129.png" />

<br />

| **UI Element**                         | **Token**                         | **Raw Value** |
| :------------------------------------- | :-------------------------------- | :------------ |
| Title text (eKYB Verification)         | `text-body-primary`               | `#262831`     |
| dropdown label text                    | `dropdown-text-label-default`     | `#262831`     |
| dropdown input text                    | `dropdown-text-input-default`     | `#262831`     |
| Dropdown border                        | `dropdown-border-default`         | `#82879A`     |
| Dropdown surface                       | `dropdown-surface-default`        | `#FCFCFD`     |
| Dropdown chevron icon                  | `icon-neutral-500`                | `#60667C`     |
| Input label text                       | `input-text-label-default`        | `#262831`     |
| Input border                           | `input-border-default`            | `#82879A`     |
| Input surface                          | `input-surface-default`           | `#FCFCFD`     |
| Section heading (Address details)      | `text-body-primary`               | `#262831A`    |
| Tertiary button text (Add another UBO) | `button-tertiary-text-default`    | `#006AFF`     |
| Background surface                     | `surface-neutral-0`               | `#FFFFFF`     |
| Button background (disabled)           | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)                 | `button-primary-text-disabled`    | `#60667C`     |

### Design Notes

* Keep field labels and helper text concise to reduce cognitive load.
* Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
* Preserve sufficient color contrast across all states (idle, focus, error, disabled).

<br />

## Form Filled

This state appears while the user is actively entering business or UBO information. It provides visual feedback for focused fields and ongoing input.

The currently active fields is visually highlighted with a blue border indicating focus. The continue button is fully enabled, allowing the user to submit the form for backend verification.

<Image align="center" src="https://developer.incode.com/assets/451ca3cfd0b649615188c89b4ba21eb4.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                                                         | **Notes**                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, input labels, placeholders, section headers, button text, helper messages   | Fully localizable. Tone and terminology can align with brand and regulatory requirements. |
| **Color Styling** | Background, input surfaces, text color, focus state, CTA background and text color | Applied via design tokens. Must maintain accessibility contrast standards.                |
| **CTA Label**     | Primary button text (e.g., “Continue”)                                             | Editable; action meaning must remain consistent with flow behavior.                       |
| **Icons & Logo**  | Brand logo and informational/status icons                                          | Visual style may follow brand guidelines; placement remains consistent.                   |
| **Localization**  | All textual content                                                                | Supports full localization. Layout should accommodate text expansion.                     |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                                                       |
| ---------------------------------- | ----------------------------------------------------------------------------------------- |
| **Validation logic**               | All required fields must pass system-defined validation rules before enabling submission. |
| **CTA enabled behavior**           | The primary button activates only when all mandatory inputs are valid.                    |
| **Form structure hierarchy**       | Field grouping and order are standardized for clarity and completion consistency.         |
| **Processing transition behavior** | Submission triggers a controlled transition to the processing state.                      |
| **Error handling logic**           | Defined by backend validation and compliance rules.                                       |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.                                       |
| **Text hierarchy**                 | Maintains clear task communication and visual structure.                                  |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                                                   |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/4898e53958feaf6ae9dce55e6b5e80e5.png" />

<br />

| UI Element                       | Token                                          | Raw Value |
| -------------------------------- | ---------------------------------------------- | --------- |
| Title text (eKYB Verification)   | `text-body-800-primary`                        | `#262831` |
| Input label text (Business name) | `text-body-800-primary`                        | `#262831` |
| Input border (focused)           | `input-border-focused` / `border-status-focus` | `#006AFF` |
| Input surface (focused)          | `input-surface-focused` / `surface-neutral-50` | `#FCFCFD` |

## Design notes

* Keep the layout clear and vertically structured to reduce cognitive load.
* The “focused” token reference indicates an actively selected input field (user tap/click), providing visual feedback during data entry.

***

<br />

## Form Processing

This state appears after form submission and indicates that identity verification is in progress. Inputs and the primary CTA are disabled while the system processes and validates the submitted data.

<Image align="center" src="https://developer.incode.com/assets/1966366601aa0a4d7fc997d853b75806.png" />

<br />

### Customizable Elements

| **Area**                       | **What can be customized**                                         | **Notes**                                                                                 |
| ------------------------------ | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| **Text Elements**              | Title, input labels, helper messages, footer text                  | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling**              | Background, input surfaces (disabled state), text color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Processing Indicator Style** | Spinner style and accent color                                     | Animation behavior remains fixed; color must meet accessibility standards.                |
| **Icons & Logo**               | Brand logo and footer trust indicator                              | Visual style may follow brand guidelines; placement remains consistent.                   |
| **Localization**               | All text content                                                   | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                       | **Why it is fixed**                                                           |
| --------------------------------- | ----------------------------------------------------------------------------- |
| **Submission lock behavior**      | Prevents duplicate submissions while verification is in progress.             |
| **Disabled input state**          | Inputs are non-editable during processing to ensure data consistency.         |
| **Processing flow logic**         | Controlled by backend verification services; cannot be modified at UI level.  |
| **Minimum processing duration**   | Prevents abrupt transitions and ensures proper system response handling.      |
| **CTA loading state behavior**    | Displays a loading indicator and blocks further interaction until resolution. |
| **Error & success routing logic** | System-defined transition to next state based on verification outcome.        |
| **Form structure hierarchy**      | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements**    | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2ab8e97ee04ac84d41b593a0cd58d6e7.png" />

<br />

| UI Element                             | Token                                                         | Raw Value |
| -------------------------------------- | ------------------------------------------------------------- | --------- |
| Title text (eKYB Verification)         | `text-body-800-primary`                                       | `#262831` |
| Dropdown label text (Country)          | `dropdown-text-label-default` / `text-body-800-primary`       | `#262831` |
| Dropdown field text (disabled)         | `dropdown-text-field-disabled` / `text-body-400`              | `#82879A` |
| Dropdown chevron icon (disabled)       | `icon-neutral-300`                                            | `#A3A8B8` |
| Input label text (Business name)       | `input-text-label-default` / `text-body-800-primary`          | `#262831` |
| Input field text (disabled)            | `input-text-field-disabled` / `text-body-400`                 | `#82879A` |
| Input border (disabled)                | `input-border-disabled` / `border-neutral-100`                | `#EBECEF` |
| Input surface (disabled)               | `input-surface-disabled` / `surface-neutral-100`              | `#EBECEF` |
| Section heading (Address details)      | `text-body-800-primary`                                       | `#262831` |
| Tertiary button text (Add another UBO) | `button-tertiary-text-default` / `text-accent-brand`          | `#006AFF` |
| Background surface                     | `surface-neutral-0`                                           | `#FFFFFF` |
| Button surface (loading/default)       | `button-primary-surface-default` / `surface-brand-500-static` | `#006AFF` |

<br />

## Design notes

* Disable inputs and CTA interaction during processing.
* Preserve layout stability when switching to loading state.
* Maintain accessible contrast for spinner and disabled elements.

***

<br />

## Form Error

The Form Error state appears when one or more fields contain invalid or non-compliant data. The system provides inline validation feedback, clearly highlighting the affected field and displaying an error message to guide correction.

The primary CTA remains disabled until all validation errors are resolved.

<Image align="center" src="https://developer.incode.com/assets/b40d20bd4d499174921a42479946dad2.png" />

<br />

### Customizable Elements

| **Area**                    | **What can be customized**                                    | **Notes**                                                                                     |
| --------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| **Text Elements**           | Title, field labels, error messages, helper text, button text | Fully localizable. Error tone can align with brand voice while remaining clear and compliant. |
| **Color Styling**           | Background, input surfaces, text color, CTA color             | Applied via design tokens. Error colors must preserve accessibility contrast.                 |
| **Error Messaging Content** | Inline validation copy                                        | Messaging style may vary; validation logic cannot.                                            |
| **Icons**                   | Error icon (if displayed)                                     | Visual style may follow brand guidelines; semantic meaning must remain consistent.            |
| **Localization**            | All textual content                                           | Supports translation; layout must accommodate text expansion.                                 |

### Fixed Elements

<br />

| **Element**                    | **Why it is fixed**                                                       |
| ------------------------------ | ------------------------------------------------------------------------- |
| **Validation logic**           | Defined by backend rules and compliance requirements.                     |
| **Error state behavior**       | Field border, helper text, and status color change are system-controlled. |
| **CTA disabled behavior**      | Prevents submission while invalid data exists.                            |
| **Error placement (inline)**   | Ensures clear association between field and message.                      |
| **Form hierarchy & layout**    | Maintains usability and scanning consistency.                             |
| **WCAG contrast requirements** | Error states must meet accessibility standards.                           |
| **Status color semantics**     | Negative color usage is standardized across the system.                   |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6a9da134cc24337349cc7169ae6b633f.png" />

<br />

| UI Element                     | Token                                                 | Raw Value |
| ------------------------------ | ----------------------------------------------------- | --------- |
| Input field text (default)     | `input-text-field-default` / `text-body-800-primary`  | `#262831` |
| Input border (negative/error)  | `input-border-negative` / `border-status-negative`    | `#E71111` |
| Input surface (negative/error) | `input-surface-negative` / `surface-neutral-100`      | `#EBECEF` |
| Error icon                     | `input-icon-negative` / `surface-status-negative-600` | `#E71111` |
| Error helper text              | `input-text-helper-negative` / `text-status-negative` | `#E71111` |

<br />

## Design notes

* Use negative status color only for validation failures to preserve semantic clarity.
* Maintain layout stability when helper text appears.
* Ensure error color contrast meets accessibility requirements.

***

<br />

## Processing Screen

The Processing Screen appears after form submission when eKYC verification is being completed by backend services. It communicates that validation is in progress and temporarily restricts user interaction until a result is returned.

<Image align="center" src="https://developer.incode.com/assets/0b9310ec4b755cf294231d4b0d726d59.png" />

### Customizable Elements

<br />

| **Area**          | **What can be customized**         | **Notes**                                                            |
| ----------------- | ---------------------------------- | -------------------------------------------------------------------- |
| **Heading Text**  | “Processing…” message              | Fully localizable. Wording can align with brand tone.                |
| **Color Styling** | Background, logo color, text color | Applied via design tokens. Must maintain accessibility contrast.     |
| **Spinner Style** | Spinner design and accent color    | Animation behavior remains fixed; visual style may align with brand. |
| **Brand Logo**    | Logo appearance                    | Must follow brand guidelines; placement remains consistent.          |
| **Localization**  | All textual content                | Supports translation; layout must account for text expansion.        |

### Fixed Elements

| **Element**                    | **Why it is fixed**                                       |
| ------------------------------ | --------------------------------------------------------- |
| **Processing behavior logic**  | Controlled by backend verification services.              |
| **Interaction lock**           | Prevents navigation or modification during verification.  |
| **Minimum display duration**   | Avoids flicker and ensures perceived stability.           |
| **Spinner animation behavior** | Standardized motion timing for consistency.               |
| **Screen layout hierarchy**    | Maintains vertical alignment and focus on status message. |
| **WCAG contrast compliance**   | Required for accessibility across themes.                 |
| **Result routing logic**       | Determines transition to Success or Error states.         |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/77613479df6d9214d612035c8a238bfe.png" />

<br />

| UI Element                       | Token                                                  | Raw Value |
| -------------------------------- | ------------------------------------------------------ | --------- |
| Spinner primary (arc)            | `spinner-surface-primary` / `surface-brand-500-static` | `#006AFF` |
| Spinner secondary (track)        | `spinner-surface-secondary` / `surface-brand-50`       | `#E5F0FF` |
| Spinner title text (Processing…) | `spinner-text-title` / `text-body-800-primary`         | `#262831` |
| Background surface               | `surface-neutral-0`                                    | `#FFFFFF` |

## Design notes

* The spinner must provide immediate feedback after submission.
* Maintain layout simplicity to reduce cognitive load during waiting states.
* Keep messaging concise to avoid uncertainty.

***

<br />

## Failure Screen

The Failure Screen appears when eKYC verification cannot be completed due to validation conflicts, backend errors, or system issues. It clearly communicates that the process was unsuccessful and provides the user with an option to retry.

<Image align="center" src="https://developer.incode.com/assets/aeed43b8060143188f7389aaedb4245d.png" />

### Customizable Elements

| **Area**                   | **What can be customized**                                  | **Notes**                                                                                       |
| -------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| **Heading / Message Text** | Title and supporting message (e.g., “Something went wrong”) | Fully localizable. Messaging tone may align with brand voice while remaining clear and neutral. |
| **CTA Label**              | Button text (e.g., “Try again”)                             | Editable; action must preserve retry behavior.                                                  |
| **Color Styling**          | Background, text color, CTA color                           | Applied via design tokens. Must maintain accessibility contrast.                                |
| **Error Icon Style**       | Icon visual style                                           | Must preserve negative semantic meaning.                                                        |
| **Localization**           | All textual elements                                        | Layout should support text expansion across languages.                                          |

### Fixed Elements

<br />

| **Element**                          | **Why it is fixed**                                         |
| ------------------------------------ | ----------------------------------------------------------- |
| **Failure routing logic**            | Determined by backend verification result.                  |
| **Retry behavior**                   | CTA triggers a controlled restart of the verification flow. |
| **Negative status color usage**      | Standardized to maintain consistent semantic meaning.       |
| **Screen layout hierarchy**          | Centered status layout ensures clarity and focus.           |
| **WCAG contrast requirements**       | Error state must meet accessibility standards.              |
| **Navigation controls (close icon)** | Placement standardized across modules.                      |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/fa489ca2276056fd762b25b261a9821f.png" />

<br />

| UI Element                              | Token                                                         | Raw Value |
| --------------------------------------- | ------------------------------------------------------------- | --------- |
| Error icon (X symbol)                   | `icon-status-negative`                                        | `#E71111` |
| Error icon (inner X mark)               | `icon-neutral-0`                                              | `#FFFFFF` |
| Error title text (Something went wrong) | `spinner-text-title` / `text-body-800-primary`                | `#262831` |
| Background surface                      | `surface-neutral-0`                                           | `#FFFFFF` |
| Button surface (Try again)              | `button-primary-surface-default` / `surface-brand-500-static` | `#006AFF` |
| Button text (Try again)                 | `button-primary-text-default` / `text-body-0-static`          | `#FFFFFF` |

## Design notes

* The spinner must provide immediate feedback after submission.
* Maintain layout simplicity to reduce cognitive load during waiting states.
* Keep messaging concise to avoid uncertainty.

***

<br />

## Success Screen

The Success Screen appears when eKYB verification has been successfully completed. It confirms that the user’s identity has been validated and indicates that the flow will proceed to the next step or module.

<Image align="center" src="https://developer.incode.com/assets/267cbff50c0ade9f148c58456fc4ed09.png" />

### Customizable Elements

| **Area**               | **What can be customized**                    | **Notes**                                                        |
| ---------------------- | --------------------------------------------- | ---------------------------------------------------------------- |
| **Heading Text**       | Confirmation message (e.g., “eKYC verified!”) | Fully localizable. Messaging tone may align with brand voice.    |
| **Color Styling**      | Background, text color, logo color            | Applied via design tokens. Must maintain accessibility contrast. |
| **Success Icon Style** | Icon visual design                            | Must preserve positive semantic meaning.                         |
| **Localization**       | All textual content                           | Layout should support text expansion across languages.           |
| **Text Alignment**     | Center alignment behavior                     | May be adjusted within layout guidelines.                        |

### Fixed Elements

| **Element**                          | **Why it is fixed**                                      |
| ------------------------------------ | -------------------------------------------------------- |
| **Success routing logic**            | Determined by backend verification result.               |
| **Positive status color usage**      | Standardized semantic mapping for success states.        |
| **Screen layout hierarchy**          | Centered status layout ensures clarity and focus.        |
| **Transition behavior**              | Automatically proceeds or triggers next configured step. |
| **Navigation controls (close icon)** | Placement standardized across modules.                   |
| **WCAG contrast requirements**       | Mandatory for accessibility compliance.                  |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2db73d1e28472cb66d7d6f2a682e2c88.png" />

<br />

| UI Element                          | Token                                          | Raw Value |
| ----------------------------------- | ---------------------------------------------- | --------- |
| Success icon (checkmark circle)     | `icon-status-positive`                         | `#E71111` |
| Success icon (inner checkmark)      | `icon-neutral-0`                               | `#FFFFFF` |
| Success title text (eKYB verified!) | `spinner-text-title` / `text-body-800-primary` | `#262831` |
| Background surface                  | `surface-neutral-0`                            | `#FFFFFF` |

## Design notes

* Keep confirmation messaging short and clear.
* Use positive status color exclusively for successful outcomes.

***

<br />

---

- Path: `design-and-ux/customization-ekyc`
- URL: https://developer.incode.com/design-and-ux/customization-ekyc/
- Markdown: https://developer.incode.com/design-and-ux/customization-ekyc.md

# Customization

This section outlines the elements you can customize within the eKYC module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

***



## Enter your details

The image below shows the Enter your details form in its empty state. **_First name_**, **_Last name_**, and **_Date of Birth_** are required fields marked with an asterisk. **_Middle name_** is optional. **Continue** submits the step.

<Image align="center" src="https://developer.incode.com/assets/edf8bad0-f962-48f8-83b7-cb946754aeb7.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Title, subtitle, field labels, button text, footer copy | Fully localizable. Wording can align with brand tone and regulatory language. |
| **Color Styling** | Background, input surfaces, text color, focus and CTA colors | Applied via design tokens. Must maintain accessibility contrast. |
| **CTA Label** | Continue button label | Editable; action meaning must remain consistent with flow behavior. |
| **Icons & Logo** | Date picker icon, brand logo, and footer “verified by” lockup | Visual style may follow brand guidelines; placement remains consistent. |
| **Date of Birth control** | Calendar icon and date-entry presentation | Visual style may follow brand; date format and picker behavior stay consistent. |
| **Localization** | All on-screen text | Supports full translation. Layout should account for text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Required field rules** | **_First name_**, **_Last name_**, and **_Date of Birth_** are mandatory; required markers cannot be removed. |
| **Optional middle name** | **_Middle name_** stays optional; it cannot be marked required. |
| **Empty-state input behavior** | Fields start empty and remain editable in this state. |
| **Field order** | **_First name_**, **_Middle name_**, **_Last name_**, and **_Date of Birth_** stays standardized. |
| **Form structure hierarchy** | Title, subtitle, fields, **Continue**, and footer remain in a fixed vertical order. |
| **CTA role** | **Continue** submits the step and advances to Driver’s License details. |
| **Date of Birth input type** | Date entry stays a date control; it cannot be replaced with a free-text field. |
| **Footer placement** | The “verified by” lockup stays at the bottom. |
| **Component spacing & safe areas** | Guarantees cross-device consistency and accessibility across screen sizes. |
| **Text hierarchy** | Maintains clear task communication and visual clarity within the flow. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/69b97bb3-0002-4e97-bd03-4c3692136a70.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Title text (Enter your details)** | text-body-800-primary | #262831 |
| **Subtitle text** | text-body-500-secondary | #60667C |
| **Input label text** | input-text-label-default | #262831 |
| **Input border (default)** | input-border-default / border-neutral-300 | #A3A8B8 |
| **Input surface (default)** | input-surface-default / surface-neutral-50 | #FCFCFD |
| **Input placeholder** | input-text-field-placeholder | #A3A8B8 |
| **Date picker icon** | icon-neutral-500 | #60667C |
| **Progress track (inactive)** | surface-neutral-250 | #B5B8C5 |
| **Primary button surface (Continue)** | button-primary-surface-default / surface-brand-500-static | #0054FF |
| **Primary button text (Continue)** | button-primary-text-default / text-body-0-static | #FFFFFF |
| **Background surface** | surface-neutral-0 | #FFFFFF |
| **Screen background** | surface-neutral-0 | #FFFFFF |

### Design notes

- Keep field labels and helper text concise to reduce cognitive load.
- Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
- Preserve sufficient color contrast across all states (idle, focus, error, disabled).

***

## Enter your details - Filled

The image below shows the Enter your details form with **_First name_**, **_Last name_**, and **_Date of Birth_** filled in. **Continue** advances to Driver’s License details.

<Image align="center" src="https://developer.incode.com/assets/726b976a-4758-4852-86a2-c16ced4dd3a6.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Title, subtitle, field labels, filled values, button text, footer copy | Fully localizable. Wording can align with brand tone and regulatory language. |
| **Color Styling** | Background, filled input surfaces, text color, focus and CTA colors | Applied via design tokens. Must maintain accessibility contrast standards. |
| **CTA Label** | Continue button label | Editable; action meaning must remain consistent with flow behavior. |
| **Icons & Logo** | Date picker icon, brand logo, and footer “verified by” lockup | Visual style may follow brand guidelines; placement remains consistent. |
| **Localization** | All on-screen text | Supports full localization. Layout should accommodate text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Filled-state input behavior** | Fields show entered values and remain editable; they are not locked in this state. |
| **Required field rules** | **_First name_**, **_Last name_**, and **_Date of Birth_** remain mandatory; required markers cannot be removed. |
| **Optional middle name** | **_Middle name_** stays optional even when filled. |
| **Field order** | **_First name_**, **_Middle name_**, **_Last name_**, and **_Date of Birth_** stays standardized. |
| **Form structure hierarchy** | Title, subtitle, fields, **Continue**, and footer remain in a fixed vertical order. |
| **CTA role** | **Continue** submits the details and advances to Driver’s License details. |
| **Date of Birth input type** | Date entry stays a date control; format is system-defined. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/893fef11-895d-46b8-bd1c-1f19fc182637.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Title text (Enter your details)** | text-body-800-primary | #262831 |
| **Subtitle text** | text-body-500-secondary | #60667C |
| **Input label text** | input-text-label-default | #262831 |
| **Input field text (filled)** | input-text-field-default / text-body-800-primary | #262831 |
| **Input border (default)** | input-border-default / border-neutral-300 | #A3A8B8 |
| **Input surface (default)** | input-surface-default / surface-neutral-50 | #FCFCFD |
| **Date picker icon** | icon-neutral-500 | #60667C |
| **Progress track (inactive)** | surface-neutral-250 | #B5B8C5 |
| **Primary button surface (Continue)** | button-primary-surface-default / surface-brand-500-static | #0054FF |
| **Primary button text (Continue)** | button-primary-text-default / text-body-0-static | #FFFFFF |
| **Background surface** | surface-neutral-0 | #FFFFFF |
| **Input field text (date of birth)** | input-text-field-default / text-body-800-primary | #262831 |
| **Date picker icon (DOB)** | icon-neutral-500 | #60667C |
| **Screen background** | surface-neutral-0 | #FFFFFF |

### Design notes

- Keep the layout clear and vertically structured to reduce cognitive load.
- The “focused” token reference indicates an actively selected input field (user tap/click), providing visual feedback during data entry.

***

## Driver’s License Details

The image below shows the Driver’s License details form in its empty state. **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** are all required. **Continue** submits the step.

<Image align="center" src="https://developer.incode.com/assets/a3cc5881-9002-4c4e-831a-3dd285c56583.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Title, field labels, placeholders, Continue, footer copy | Fully localizable. Wording can align with brand tone and regulatory language. |
| **Color Styling** | Background, input surfaces, text color, focus and CTA colors | Applied via design tokens. Must maintain accessibility contrast. |
| **CTA Label** | Continue button label | Editable; action meaning must remain consistent with flow behavior. |
| **Icons & Logo** | Dropdown chevron, date picker icon, brand logo, and footer “verified by” lockup | Visual style may follow brand guidelines; placement remains consistent. |
| **Localization** | All on-screen text | Supports full translation. Layout should account for text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Required field rules** | **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** are mandatory; this screen has no required asterisks. |
| **Empty-state input behavior** | Fields start empty and remain editable in this state. |
| **Field order** | **_Driver's License number_**, **_Driver's License state_**, then **_Driver's License expiration date_** stays standardized. |
| **Form structure hierarchy** | Title, fields, **Continue**, and footer remain in a fixed vertical order. |
| **CTA role** | **Continue** submits the license details and advances to processing. |
| **Issuing state control** | **_Driver's License state_** stays a dropdown; it cannot be replaced with a free-text field. |
| **Expiration date input type** | **_Driver's License expiration date_** stays a date control; it cannot be replaced with a free-text field. |
| **Footer placement** | The “verified by” lockup stays at the bottom. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/52938c6a-b1a2-47d3-8de3-e6c2371dae48.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Title text (Driver’s License details)** | text-body-800-primary | #262831 |
| **Input label (Driver’s License number)** | input-text-label-default / text-body-800-primary | #262831 |
| **Dropdown label (State)** | dropdown-text-label-default / text-body-800-primary | #262831 |
| **Input label (expiration date)** | input-text-label-default / text-body-800-primary | #262831 |
| **Input surface (default)** | input-surface-default / surface-neutral-50 | #FCFCFD |
| **Input border (default)** | input-border-default / border-neutral-300 | #A3A8B8 |
| **Dropdown surface (State)** | dropdown-surface-default / surface-neutral-50 | #FCFCFD |
| **Dropdown border (State)** | dropdown-border-default / border-neutral-300 | #A3A8B8 |
| **Dropdown chevron** | icon-neutral-500 | #60667C |
| **Date picker icon** | icon-neutral-500 | #60667C |
| **Progress track (active)** | surface-brand-500 | #0054FF |
| **Screen background** | surface-neutral-0 | #FFFFFF |
| **Primary button surface (Continue)** | button-primary-surface-default / surface-brand-500-static | #0054FF |
| **Primary button text (Continue)** | button-primary-text-default / text-body-0-static | #FFFFFF |
| **Input surface (expiration date)** | input-surface-default / surface-neutral-50 | #FCFCFD |

### Design notes

- Disable inputs and CTA interaction during processing.
- Preserve layout stability when switching to loading state.
- Maintain accessible contrast for spinner and disabled elements.

***

## Driver’s License Details- Filled

The image below shows the Driver's License details form with **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** filled in. **Continue** submits the step.

The primary CTA remains disabled until all validation errors are resolved.

<Image align="center" src="https://developer.incode.com/assets/803a1ee6-f4f8-48ad-a096-719a2186bc04.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Title, field labels, filled values, Continue, footer copy | Fully localizable. Wording can align with brand tone and regulatory language. |
| **Color Styling** | Background, filled input surfaces, text color, focus and CTA colors | Applied via design tokens. Must maintain accessibility contrast standards. |
| **CTA Label** | Continue button label | Editable; action meaning must remain consistent with flow behavior. |
| **Icons & Logo** | Dropdown chevron, date picker icon, brand logo, and footer “verified by” lockup | Visual style may follow brand guidelines; placement remains consistent. |
| **Localization** | All on-screen text | Supports full localization. Layout should accommodate text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Filled-state input behavior** | Fields show entered values and remain editable; they are not locked in this state. |
| **Required field rules** | **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** remain mandatory; this screen has no required asterisks. |
| **Field order** | **_Driver's License number_**, **_Driver's License state_**, then **_Driver's License expiration date_** stays standardized. |
| **Form structure hierarchy** | Title, fields, **Continue**, and footer remain in a fixed vertical order. |
| **CTA role** | **Continue** submits the license details and advances to processing. |
| **Issuing state control** | **_Driver's License state_** stays a dropdown; the selected value remains editable until submit. |
| **Expiration date input type** | **_Driver's License expiration date_** stays a date control; format is system-defined. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/626079a6-b934-4f8c-8340-0e24027a72cd.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Title text (Driver’s License details)** | text-body-800-primary | #262831 |
| **Input label text** | input-text-label-default | #262831 |
| **Input field text (filled)** | input-text-field-default / text-body-800-primary | #262831 |
| **Input border (default)** | input-border-default / border-neutral-300 | #A3A8B8 |
| **Input surface (default)** | input-surface-default / surface-neutral-50 | #FCFCFD |
| **Dropdown text (filled)** | dropdown-text-input-default / text-body-800-primary | #262831 |
| **Dropdown chevron / date icon** | icon-neutral-500 | #60667C |
| **Primary button surface (Continue)** | button-primary-surface-default / surface-brand-500-static | #0054FF |
| **Primary button text (Continue)** | button-primary-text-default / text-body-0-static | #FFFFFF |

***

## Processing Screen

A full-screen processing state shown right after submission. The screen reads “Processing…” while the request is in flight.

<Image align="center" src="https://developer.incode.com/assets/894a0c81-1da2-45df-b6c4-1044ecde593b.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Heading Text** | “Processing…” message | Fully localizable. Wording can align with brand tone. |
| **Color Styling** | Background, logo color, text color | Applied via design tokens. Must maintain accessibility contrast. |
| **Spinner Style** | Spinner design and accent color | Animation behavior remains fixed; visual style may align with brand. |
| **Brand Logo** | Logo appearance | Must follow brand guidelines; placement remains consistent. |
| **Localization** | All textual content | Supports translation; layout must account for text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Processing behavior logic** | Controlled by backend verification services. |
| **Interaction lock** | Prevents navigation or modification during verification. |
| **Minimum display duration** | Avoids flicker and ensures perceived stability. |
| **Spinner animation behavior** | Standardized motion timing for consistency. |
| **Screen layout hierarchy** | Maintains vertical alignment and focus on status message. |
| **WCAG contrast compliance** | Required for accessibility across themes. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/266b8445-3ef1-4c18-80c1-f75f8b293ff4.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Spinner primary accent** | spinner-surface-primary | #0054FF |
| **Spinner secondary surface** | spinner-surface-secondary | #E5F0FF |
| **Processing text** | spinner-text-title | #262831 |
| **Screen background** | surface-neutral-0 | #FFFFFF |

### Design notes

- The spinner must provide immediate feedback after submission.
- Maintain layout simplicity to reduce cognitive load during waiting states.
- Keep messaging concise to avoid uncertainty.

***

## Success

The success state that closes the flow. Shows an “Information submitted!” message confirming the eKYC verification was successful.

<Image align="center" src="https://developer.incode.com/assets/22ca8de3-c7b7-4533-a9f6-5c4ef8af2945.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Success title (e.g., “Information submitted!”) | Fully localizable. Wording can align with brand tone while remaining a success confirmation. |
| **Color Styling** | Background, success icon color, title color | Applied via design tokens. Success color must remain clearly positive. |
| **Success icon** | Checkmark or equivalent success icon | Visual style may follow brand guidelines; meaning must remain success. |
| **Icons & Logo** | Close icon, brand logo, and footer “verified by” lockup | Visual style may follow brand guidelines; placement remains consistent. |
| **Localization** | All on-screen text | Supports full translation. Layout should account for text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Success messaging** | Screen must communicate successful submission (“Information submitted!”). It cannot be framed as an error. |
| **No retry CTA** | This state has no Try again action; recovery belongs on the error screen. |
| **Positive status color usage** | Standardized semantic mapping for success states. |
| **Screen layout hierarchy** | Close control, success icon, title, and footer remain in a fixed vertical order. |
| **WCAG contrast requirements** | Success state must meet accessibility standards. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/adaac039-9ff0-4fea-a2a8-4b5188908037.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Success icon** | icon-status-positive | #189F60 |
| **Success icon inner** | icon-neutral-0 | #FFFFFF |
| **Success title (Information submitted!)** | text-body-800-primary | #262831 |
| **Close icon** | icon-neutral-500 | #60667C |
| **Screen background** | surface-neutral-0 | #FFFFFF |
| **Background surface** | surface-neutral-0 | #FFFFFF |

### Design notes

- Keep confirmation messaging short and clear.
- Use positive status color exclusively for successful outcomes.
- Do not offer a retry action; this state confirms completion.

***

## Error

Shown when eKYC verification fails due to backend validation or service errors. Shows a “Something went wrong” message and a **Try again** button to let the user restart the attempt.

<Image align="center" src="https://developer.incode.com/assets/995424a2-4ca9-4185-af1a-b1373ac35c84.png" />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| --- | --- | --- |
| **Text Elements** | Error title, Try again label, and footer copy | Fully localizable. Wording can align with brand tone while remaining an error recovery state. |
| **Color Styling** | Background, error icon color, title color, CTA colors | Applied via design tokens. Error color must remain clearly negative. |
| **CTA Label** | Try again button label | Editable; action meaning must remain a retry of the failed submission. |
| **Error icon** | Warning or equivalent error icon | Visual style may follow brand guidelines; meaning must remain failure. |
| **Localization** | All on-screen text | Supports full translation. Layout should account for text expansion. |

### Fixed Elements

| **Element** | **Why it is fixed** |
| --- | --- |
| **Failure messaging** | Screen must communicate that something went wrong. It cannot be framed as success. |
| **Retry CTA role** | **Try again** retries the submission. This action cannot be removed from the error state. |
| **Negative status color usage** | Standardized to maintain consistent semantic meaning. |
| **Screen layout hierarchy** | Error icon, title, **Try again**, close control, and footer remain in a fixed vertical order. |
| **Footer placement** | The “verified by” lockup stays at the bottom. |
| **WCAG contrast requirements** | Error state must meet accessibility standards. |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/f4a1b905-f321-4f4b-a0ef-773400c6ea0d.png" />

| **UI Element** | **Token** | **Raw Value** |
| --- | --- | --- |
| **Error icon** | icon-status-negative | #E71111 |
| **Error icon inner** | icon-neutral-0 | #FFFFFF |
| **Failure title (Something went wrong)** | text-body-800-primary | #262831 |
| **Primary button surface (Try again)** | button-primary-surface-default / surface-brand-500-static | #0054FF |
| **Primary button text (Try again)** | button-primary-text-default / text-body-0-static | #FFFFFF |
| **Screen background** | surface-neutral-0 | #FFFFFF |

### Design notes

- Communicate the failure clearly and concisely, without blame.
- Use negative status color consistently to signal the error state.
- Make Try again the clear, primary recovery action.

---

- Path: `design-and-ux/customization-esign`
- URL: https://developer.incode.com/design-and-ux/customization-esign/
- Markdown: https://developer.incode.com/design-and-ux/customization-esign.md

# Customization

This section outlines the elements you can customize within the **Electronic Signature** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Signature canva

The Signature Canvas screen is the entry point of the Electronic Signature module. It presents the user with a blank drawing area and clearly communicates that they must draw their signature using a finger or mouse to proceed.

<Image align="center" src="https://developer.incode.com/assets/1ba012897f3f46bbff85b6ddb7bfda54.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                           | **Notes**                                                                               |
| -------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Text**             | Title ("Draw your signature"), instruction text, placeholder ("Sign here"), button text, badge textt | Fully localizable; tone and terminology can be adapted to match brand voice.            |
| **Canvas**           | Border style, background color, placeholder text and color                                           | Canvas dimensions remain consistent; styling can be adapted to match brand design.      |
| **Background Color** | Screen background                                                                                    | Must maintain strong contrast with inputs, text, and CTAs for accessibility compliance. |
| **Buttons (CTA)**    | Button label (“Done”), background color, text color                                                  | Uses brand tokens                                                                       |
| **Brand Colors**     | Header text, accent color, input focus state, status indicators                                      | Applied via design tokens; avoid reducing clarity in critical validation states.        |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                                |
| ------------------------------ | -------------------------------------------------------------------------------------------------- |
| **Canva input detection**      | Stroke detection logic ensures a valid signature is captured before submission is allowed.         |
| **CTA state behavior**         | "Done" button remains disabled until a signature stroke is detected, preventing empty submissions. |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture.                |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.                             |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.                              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/578a670a46e9dca2654c15ddc1df9922.png" />

<br />

| **UI Element**                              | **Token**                         | **Raw Value** |
| :------------------------------------------ | :-------------------------------- | :------------ |
| Title text (Draw your signature)            | `text-body-primary`               | `#262831`     |
| Instruction text (Use your finger or mouse) | `text-body-secondary`             | `#60667C`     |
| Canvas border                               | `input-border-default`            | `#82879A`     |
| Canvas surface                              | `input-surface-default`           | `#FCFCFD`     |
| Placeholder text (Sign here)                | `input-text-field-placeholder`    | `#82879A`     |
| Clear canvas text (disabled)                | `button-tertiary-text-disabled`   | `#60667C`     |
| Background surface                          | `surface-neutral-0`               | `#FFFFFF`     |
| Button background (disabled)                | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)                      | `button-primary-text-disabled`    | `#60667C`     |

### Design Notes

* Keep field labels and helper text concise to reduce cognitive load.
* Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
* Preserve sufficient color contrast across all states (idle, focus, error, disabled).

<br />

## Signature Filled

This state appears after the user has drawn their signature on the canvas. It provides visual feedback for the captured input and confirms the signature is ready to submit. The canvas displays the drawn signature, replacing the placeholder text. The "Clear canvas" link is now active and visually highlighted, allowing the user to erase and redraw.

The "Done" button is fully enabled, allowing the user to submit the signature for processing.

<Image align="center" src="https://developer.incode.com/assets/cb2524fb7258e2978492b19b4a4acbf6.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                                                         | **Notes**                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, instruction text, "Clear canvas" label, button text, badge text             | Fully localizable. Tone and terminology can align with brand and regulatory requirements. |
| **Color Styling** | Background, input surfaces, text color, focus state, CTA background and text color | Applied via design tokens. Must maintain accessibility contrast standards.                |
| **CTA Label**     | Primary button text (e.g., “Done”)                                                 | Editable; action meaning must remain consistent with flow behavior.                       |
| **Icons & Logo**  | Brand logo and informational/status icons                                          | Visual style may follow brand guidelines; placement remains consistent.                   |
| **Localization**  | All textual content                                                                | Supports full localization. Layout should accommodate text expansion.                     |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                                                 |
| ---------------------------------- | ----------------------------------------------------------------------------------- |
| **Signature rendering**            | The drawn signature is displayed as captured to ensure accuracy and legal validity. |
| **CTA enabled behavior**           | "Done" button is enabled only when a valid signature is present on the canvas.      |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.                                 |
| **Text hierarchy**                 | Maintains clear task communication and visual structure.                            |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                                             |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/468280cfa280344af53b7b25569c93c4.png" />

<br />

| **UI Element**                              | **Token**                        | **Raw Value** |
| :------------------------------------------ | :------------------------------- | :------------ |
| Title text (Draw your signature)            | `text-body-primary`              | `#262831`     |
| Instruction text (Use your finger or mouse) | `text-body-secondary`            | `#60667C`     |
| Canvas border                               | `input-border-default`           | `#82879A`     |
| Canvas surface                              | `input-surface-focused`          | `#FCFCFD`     |
| Clear canvas text                           | `button-tertiary-text-default`   | `#006AFF`     |
| Background surface                          | `surface-neutral-0`              | `#FFFFFF`     |
| Button background (Done)                    | `button-primary-surface-default` | `#006AFF`     |
| Button text (Done)                          | `button-primary-text-default`    | `#FFFFFF`     |

## Design notes

* Keep the layout clear and vertically structured to reduce cognitive load.
* The active "Clear canvas" link provides visual feedback that the canvas contains a valid signature and can be reset.
* The enabled "Done" button signals readiness to submit, using a distinct color shift from its disabled state to reinforce interactivity.

***

<br />

## Success

Final confirmation screen of the Electronic Signature module. After the user taps "Done," the system processes the signature and displays a green checkmark icon along with a "Signed successfully!" message.

This screen confirms that the signature has been captured and the process is complete.

<Image align="center" src="https://developer.incode.com/assets/2d1f20d7db661588cfbe8d89292409c6.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/06df291cf074e35fd0c8e8ee75d74125.png" />

<br />

| **UI Element**                    | **Token**              | **Raw Value** |
| :-------------------------------- | :--------------------- | :------------ |
| Success icon (check - fill)       | `icon-status-positive` | `#17B26A`     |
| Success icon (check - mark)       | `icon-neutral-0`       | `#FFFFFF`     |
| Title text (Signed successfully!) | `text-body-primary`    | `#262831`     |
| Background surface                | `surface-neutral-0`    | `#FFFFFF`     |

<br />

## Design notes

* Preserve layout stability when switching to loading state.
* Maintain accessible contrast for spinner and disabled elements.

***

<br />

---

- Path: `design-and-ux/customization-forms`
- URL: https://developer.incode.com/design-and-ux/customization-forms/
- Markdown: https://developer.incode.com/design-and-ux/customization-forms.md

# Customization

This section outlines the elements you can customize within the **Forms and data entry** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

***

<br />

## Forms empty

Entry point of the data entry module. This screen presents the user with a form titled "Enter your information," containing four customizable required fields: ID number, Email, Country of residence, and Date of Birth. All fields are empty and the "Continue" button is disabled until the user provides valid input..

<Image align="center" src="https://developer.incode.com/assets/a8d27b5acba44c837bfe305cd5a934fb.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                  | **Notes**                                                                               |
| -------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Text**             | Title ("Enter your information"), button text                               | Fully localizable; tone and terminology can be adapted to match brand voice.            |
| **Input fields**     | Field order, optional vs required fields, input types, validation messaging | Configurable depending on workflow requirements and supported data collection rules.    |
| **Background Color** | Screen background                                                           | Must maintain strong contrast with inputs, text, and CTAs for accessibility compliance. |
| **Buttons (CTA)**    | Button label (“Continue”), background color, text color                     | Uses brand tokens                                                                       |
| **Brand Colors**     | Header text, accent color, input focus state, status indicators             | Applied via design tokens; avoid reducing clarity in critical validation states.        |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture. |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.              |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/a75e8a83a118cbe5580b7672e75e3831.png" />

<br />

| **UI Element**                       | **Token**                         | **Raw Value** |
| ------------------------------------ | --------------------------------- | ------------- |
| Title text (Enter your information)  | `text-body-primary`               | `#262831`     |
| Field label text                     | `input-text-label-default`        | `#262831`     |
| Field placeholder text               | `input-text-field-placeholder`    | `#82879A`     |
| Input field surface                  | `input-surface-default`           | `#FCFCFD`     |
| Input field border                   | `input-border-default`            | `#82879A`     |
| Dropdown label text                  | `dropdown-text-label-default`     | `#262831`     |
| Dropdown placeholder text            | `dropdown-text-input-placeholder` | `#82879A`     |
| Dropdown surface                     | `dropdown-surface-default`        | `#FCFCFD`     |
| Dropdown border                      | `dropdown-border-default`         | `#82879A`     |
| Screen background                    | `surface-neutral-0`               | `#FFFFFF`     |
| Primary button (disabled) background | `button-primary-surface-disabled` | `#EBECEF`     |
| Primary button (disabled) text       | `button-primary-text-disabled`    | `#60667C`     |

### Design Notes

* Keep field labels and helper text concise to reduce cognitive load.
* Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
* Preserve sufficient color contrast across all states (idle, focus, error, disabled).

<br />

## Forms Filled

This state confirms that the user has completed all required fields in the form. All four customizable fields — ID number, Email, Country of residence, and Date of Birth — contain valid input, and the "Continue" button is now enabled, allowing the user to proceed to the next step.

<Image align="center" src="https://developer.incode.com/assets/b461f586b919b0e77c8d0989b2ecfe73.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                                                         | **Notes**                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, button text, badge text                                                     | Fully localizable. Tone and terminology can align with brand and regulatory requirements. |
| **Color Styling** | Background, input surfaces, text color, focus state, CTA background and text color | Applied via design tokens. Must maintain accessibility contrast standards.                |
| **CTA Label**     | Primary button text (e.g., “Continue”)                                             | Editable; action meaning must remain consistent with flow behavior.                       |
| **Localization**  | All textual content                                                                | Supports full localization. Layout should accommodate text expansion.                     |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                                             |
| ---------------------------------- | ------------------------------------------------------------------------------- |
| **CTA enabled behavior**           | "Continue" button is enabled only when all required fields contain valid input. |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.                             |
| **Text hierarchy**                 | Maintains clear task communication and visual structure.                        |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                                         |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/0761b1e5f9c583f5e62ac07b4ed82449.png" />

<br />

| **UI Element**                      | **Token**                        | **Raw Value** |
| ----------------------------------- | -------------------------------- | ------------- |
| Title text (Enter your information) | `text-body-primary`              | `#262831`     |
| Field label text                    | `input-text-label-default`       | `#262831`     |
| Field input text                    | `input-text-field-default`       | `#262831`     |
| Input field surface                 | `input-surface-default`          | `#FCFCFD`     |
| Input field border                  | `input-border-default`           | `#82879A`     |
| Dropdown label text                 | `dropdown-text-label-default`    | `#262831`     |
| Dropdown input text                 | `dropdown-text-input-default`    | `#262831`     |
| Dropdown surface                    | `dropdown-surface-default`       | `#FCFCFD`     |
| Dropdown border                     | `dropdown-border-default`        | `#82879A`     |
| Screen background                   | `surface-neutral-0`              | `#FFFFFF`     |
| Primary button (enabled) background | `button-primary-surface-default` | `#006AFF`     |
| Primary button (enabled) text       | `button-primary-text-default`    | `#FFFFFF`     |

## Design notes

* Keep the layout clear and vertically structured to reduce cognitive load.
* The enabled "Continue" button signals readiness to submit, using a distinct color shift from its disabled state to reinforce interactivity.

***

<br />

## Forms loading

Transitional state shown after the user taps "Continue." The screen retains the form layout with all filled fields visible, while a loading spinner appears on the primary button, providing visual feedback that the system is processing the request.

<Image align="center" src="https://developer.incode.com/assets/b9615562bd2129f502d913cdc2cdc877.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/eb202bd3a5c2d35ffaad929d1bb318f8.png" />

<br />

| **UI Element**                      | **Token**                        | **Raw Value** |
| ----------------------------------- | -------------------------------- | ------------- |
| Title text (Enter your information) | `text-body-primary`              | `#262831`     |
| Field label text                    | `input-text-label-default`       | `#262831`     |
| Field input text (disabled)         | `input-text-field-disabled`      | `#82879A`     |
| Input field surface (disabled)      | `input-surface-disabled`         | `#EBECEF`     |
| Input field border (disabled)       | `input-border-disabled`          | `#EBECEF`     |
| Dropdown label text                 | `dropdown-text-label-default`    | `#262831`     |
| Dropdown input text (disabled)      | `dropdown-text-input-disabled`   | `#82879A`     |
| Dropdown surface (disabled)         | `dropdown-surface-disabled`      | `#FCFCFD`     |
| Dropdown border (disabled)          | `dropdown-border-disabled`       | `#EBECEF`     |
| Screen background                   | `surface-neutral-0`              | `#FFFFFF`     |
| Primary button (loading) background | `button-primary-surface-default` | `#006AFF`     |
| Primary button (loading) text       | `button-primary-text-default`    | `#FFFFFF`     |
| Primary button (loading) spinner    | `surface-brand-400`              | `#3388FF`     |

## Design notes

* Preserve layout stability when switching to loading state.
* Maintain accessible contrast for spinner and disabled elements.

<br />

## Success

Final confirmation screen of the data entry module. After processing completes, the screen displays a green checkmark icon along with the message "Success!" confirming that the information has been submitted and the process is complete. No further user action is required.

<Image align="center" src="https://developer.incode.com/assets/96b606967ff32d395d2a55bdb09170f4.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message                                | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/355028657411fda591b2bbef11f9f0c4.png" />

<br />

| **UI Element**          | **Token**              | **Raw Value** |
| :---------------------- | :--------------------- | :------------ |
| Screen background       | `surface-neutral-0`    | `#FFFFFF`     |
| Success icon background | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)    | `icon-neutral-0`       | `#FFFFFF`     |
| Title text (“Success!”) | `text-body-primary`    | `#262831`     |

<br />

---

- Path: `design-and-ux/customization-ocr`
- URL: https://developer.incode.com/design-and-ux/customization-ocr/
- Markdown: https://developer.incode.com/design-and-ux/customization-ocr.md

# Customization

This section outlines the elements you can customize within the **OCR Review** module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors, and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

***

## OCR Review&#x20;

This screen allows users to review and edit the information extracted from the identity document before continuing the verification process. In the editable state, users can update inaccurate or incomplete fields such as full name, date of birth, gender, document number, and expiration date to ensure the captured data is correct.


<Image src="https://developer.incode.com/assets/9f9891ac4ec7501b6c8c95e5cce01bb7.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized                                                                | Notes                                                                                                         |
| -------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Text**             | Screen title, field labels, placeholders, validation messages, button text            | Fully localizable; tone and terminology can be adapted to align with brand voice and compliance requirements. |
| **Editable fields**  | Fields such as full name, date of birth, gender, document number, and expiration date | Field availability and edit permissions can vary depending on onboarding and compliance requirements.         |
| **Input States**     | Helper text, inline validation messaging, focus states                                | Validation logic remains fixed to preserve consistency and usability standards.                               |
| **Radio buttons**    | Selected and unselected surface colors, icon and text colors                          | Applied through design tokens; selected state must remain clearly distinguishable.                            |
| **Background Color** | Screen background color                                                               | Must maintain sufficient contrast with text, inputs, and CTAs to support accessibility compliance.            |
| **Buttons (CTA)**    | Button labels, background color, text color                                           | Applied through design tokens to maintain a consistent user experience.                                       |
| **Brand Colors**     | Accent colors, input focus state, radio button selected state                         | Applied via design tokens; avoid reducing clarity in validation or selection states.                          |
| **Footer**           | "Verified by Incode" line                                                             | Optional but recommended.                                                                                     |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                                                |
| ------------------------------ | ---------------------------------------------------------------------------------------------- |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.                         |
| **User photo**                 | Automatically pulled from the document capture; cannot be replaced.                            |
| **Field structure**            | Required fields are defined by onboarding configuration and cannot be removed from the layout. |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.                          |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/7b1bc2e0a614253e34b1f205f9b38eba.png" align="center" />


| UI Element                             | Token                                                                       | Value   |
| -------------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**                         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Input label text**                   | Input/Text/Label/Default → Text/Body/800 (Primary) → Color/Gray/800         | #262831 |
| **Input background**                   | Input/Surface/Default → Surface/Neutral/50 → Color/Gray/50                  | #FCFCFD |
| **Input field text**                   | Input/Text/Field/Default → Text/Body/800 (Primary) → Color/Gray/800         | #262831 |
| **Date picker icon**                   | Icon/Neutral/500 → Color/Gray/500                                           | #60667C |
| **Radio button selected surface**      | Radio button/Surface/Selected → Surface/Brand/500 Static → Color/Brand/500  | #006AFF |
| **Radio button unselected surface**    | Radio button/Surface/Default → Surface/Neutral/50 → Color/Gray/50           | #FCFCFD |
| **Radio button icon (default)**        | Radio button/Icon/Default → Surface/Neutral/0 Static → Color/Gray/0         | #FFFFFF |
| **Radio button label text**            | Radio button/Text/Default → Text/Body/800 (Primary) → Color/Gray/800        | #262831 |
| **Radio button label text (selected)** | Radio button/Text/Default → Text/Body/800 (Primary) → Color/Gray/800        | #262831 |
| **Continue button background**         | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Continue button text**               | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Footer text**                        | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |

Design Notes

- Required fields are marked with an asterisk (\*) and must remain clearly distinguishable from optional fields.
- The radio button selected state must use a color with sufficient contrast against the unselected state to remain accessible.
- Ensure tap targets for radio buttons and date pickers meet accessibility minimum sizes.

<br />

***

<br />

<br />

## OCR Review - Non Editable&#x20;

This screen shows the same OCR Review layout in a read-only or non-editable state, where fields are pre-populated but not editable by the user. This state is used when the data has already been confirmed or when edit permissions are restricted based on onboarding configuration.


<Image src="https://developer.incode.com/assets/4eb2881924eb27efce3da4f9d98e69a4.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized                      | Notes                                                   |
| -------------------- | ------------------------------------------- | ------------------------------------------------------- |
| **Text**             | Screen title, field labels, button text     | Fully localizable.                                      |
| **Background Color** | Screen background color                     | Must maintain sufficient contrast with text and fields. |
| **Buttons (CTA)**    | Button labels, background color, text color | Applied through design tokens.                          |
| **Brand Colors**     | Accent colors                               | Applied via design tokens.                              |
| **Footer**           | "Verified by Incode" line                   | Optional but recommended.                               |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                                 |
| ------------------------------ | ------------------------------------------------------------------------------- |
| **Disabled field appearance**  | Must remain visually consistent to communicate non-editable state clearly.      |
| **Field values**               | Pre-populated from OCR extraction; cannot be overridden when in read-only mode. |
| **User photo**                 | Automatically pulled from the document capture; cannot be replaced.             |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.           |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/419a2ee36012c5851aaf9468e3efb68f.png" align="center" />


| UI Element                             | Token                                                                          | Value   |
| -------------------------------------- | ------------------------------------------------------------------------------ | ------- |
| **Background**                         | Surface/Neutral/0 → Color/Gray/0                                               | #FFFFFF |
| **Title text**                         | Text/Body/800 (Primary) → Color/Gray/800                                       | #262831 |
| **Input label text**                   | Input/Text/Label/Default → Text/Body/800 (Primary) → Color/Gray/800            | #262831 |
| **Input background (disabled)**        | Input/Surface/Disabled → Surface/Neutral/100 → Color/Gray/100                  | #EBECEF |
| **Input field text (disabled)**        | Input/Text/Field/Disabled → Text/Body/400 → Color/Gray/400                     | #82879A |
| **Date picker icon**                   | Icon/Neutral/500 → Color/Gray/500                                              | #60667C |
| **Radio button disabled surface**      | Radio button/Surface/Disabled → Surface/Neutral/400 → Color/Gray/400           | #82879A |
| **Radio button unselected surface**    | Radio button/Surface/Default → Surface/Neutral/50 → Color/Gray/50              | #FCFCFD |
| **Radio button icon (default)**        | Radio button/Icon/Default → Surface/Neutral/0 Static → Color/Gray/0            | #FFFFFF |
| **Radio button label text (disabled)** | Radio button/Text/Disabled → Text/Body/500 Static (Secondary) → Color/Gray/500 | #60667C |
| **Radio button label text**            | Radio button/Text/Default → Text/Body/800 (Primary) → Color/Gray/800           | #262831 |
| **Continue button background**         | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500    | #006AFF |
| **Continue button text**               | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0                | #FFFFFF |
| **Footer text**                        | Text/Body/500 (Secondary) → Color/Gray/500                                     | #60667C |

<br />

Design Notes

- The disabled state must be visually distinct from the active/editable state to prevent user confusion.
- Disabled fields should not use the same background as active fields — the lighter gray surface communicates non-interactivity clearly.
- The Continue button remains active in the read-only state, allowing the user to proceed without making edits.

<br />

---

- Path: `design-and-ux/customization-qsign`
- URL: https://developer.incode.com/design-and-ux/customization-qsign/
- Markdown: https://developer.incode.com/design-and-ux/customization-qsign.md

# Customization

This section outlines the elements you can customize within the **Qualified Signature** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Signature empty

Entry point of the Qualified Signature module. This screen presents the user with a consent form titled "Accept and sign," accompanied by a brief instruction to accept the terms before completing the signature.

<Image align="center" src="https://developer.incode.com/assets/18a2e4e7c69c9d628594cd137fa0e67c.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                      | **Notes**                                                                               |
| -------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Text**             | Title ("Accept and sign"), instruction text, button text        | Fully localizable; tone and terminology can be adapted to match brand voice.            |
| **Background Color** | Screen background                                               | Must maintain strong contrast with inputs, text, and CTAs for accessibility compliance. |
| **Buttons (CTA)**    | Button label (“Finish signing”), background color, text color   | Uses brand tokens                                                                       |
| **Brand Colors**     | Header text, accent color, input focus state, status indicators | Applied via design tokens; avoid reducing clarity in critical validation states.        |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                                |
| ------------------------------ | -------------------------------------------------------------------------------------------------- |
| **CTA state behavior**         | "Done" button remains disabled until a signature stroke is detected, preventing empty submissions. |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture.                |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.                             |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.                              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/55f8d5cc2cebdf5684f51c563c94fa39.png" />

<br />

| **UI Element**                       | **Token**                         | **Raw Value** |
| ------------------------------------ | --------------------------------- | ------------- |
| Title text (Accept and sign)         | `text-body-primary`               | `#26283B`     |
| Instruction text                     | `text-body-secondary`             | `#60657C`     |
| Document row surface                 | `surface-neutral-50`              | `#F5F6F7`     |
| Document row border                  | `border-neutral-100`              | `#E6E8EF`     |
| Document name text                   | `text-body-primary`               | `#26283B`     |
| “View” link                          | `button-tertiary-text-default`    | `#0046FF`     |
| Checkbox border                      | `checkbox-border-default`         | `#82879A`     |
| Checkbox background                  | `checkbox-surface-default`        | `#FFFFFF`     |
| Checkbox label text                  | `text-body-primary`               | `#26283B`     |
| Info box surface                     | `surface-brand-50`                | `#E5F0FF`     |
| Info box text                        | `text-body-primary`               | `#26283B`     |
| Screen background                    | `surface-neutral-0`               | `#FFFFFF`     |
| Primary button (disabled) background | `button-primary-surface-disabled` | `#E9ECEF`     |
| Primary button (disabled) text       | `button-primary-text-disabled`    | `#60657C`     |

### Design Notes

* Keep field labels and helper text concise to reduce cognitive load.
* Use brand colors sparingly for focus states and primary CTAs to maintain clarity.
* Preserve sufficient color contrast across all states (idle, focus, error, disabled).

<br />

## Signature Filled

This screen reflects the state after the user has checked all three consent checkboxes. Each checkbox is now marked and highlighted in blue, confirming the user's agreement to the terms.

<Image align="center" src="https://developer.incode.com/assets/4d3f9df5ed5a9b88b35df7f241e844e4.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                                                         | **Notes**                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, instruction text,  button text, badge text                                  | Fully localizable. Tone and terminology can align with brand and regulatory requirements. |
| **Color Styling** | Background, input surfaces, text color, focus state, CTA background and text color | Applied via design tokens. Must maintain accessibility contrast standards.                |
| **CTA Label**     | Primary button text (e.g., “Finish signing”)                                       | Editable; action meaning must remain consistent with flow behavior.                       |
| **Localization**  | All textual content                                                                | Supports full localization. Layout should accommodate text expansion.                     |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                                            |
| ---------------------------------- | ------------------------------------------------------------------------------ |
| **CTA enabled behavior**           | "Done" button is enabled only when a valid signature is present on the canvas. |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.                            |
| **Text hierarchy**                 | Maintains clear task communication and visual structure.                       |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                                        |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/9bc7e1d61c0bb2152d5590e269c6e1da.png" />

<br />

| **UI Element**                 | **Token**                        | **Raw Value** |
| ------------------------------ | -------------------------------- | ------------- |
| Title text (Accept and sign)   | `text-body-primary`              | `#262831`     |
| Instruction text               | `text-body-secondary`            | `#60667C`     |
| Document row surface           | `surface-neutral-50`             | `#FCFCFD`     |
| Document row border            | `border-neutral-100`             | `#EBECEF`     |
| Document name text             | `text-body-primary`              | `#262831`     |
| “View” link                    | `button-tertiary-text-default`   | `#006AFF`     |
| Checkbox (default) background  | `surface-neutral-0`              | `#FFFFFF`     |
| Checkbox (default) border      | `border-neutral-100`             | `#EBECEF`     |
| Checkbox (selected) background | `surface-brand-500`              | `#006AFF`     |
| Info container background      | `surface-brand-50`               | `#E5F0FF`     |
| Checkbox text                  | `text-body-primary`              | `#262831`     |
| Primary button background      | `button-primary-surface-default` | `#006AFF`     |
| Primary button text            | `button-primary-text-default`    | `#FFFFFF`     |

## Design notes

* Keep the layout clear and vertically structured to reduce cognitive load.
* The enabled "Finish signing" button signals readiness to submit, using a distinct color shift from its disabled state to reinforce interactivity.

***

<br />

## Signature loading

Transitional state shown after the user taps "Finish signing." The screen retains the consent form layout while a loading spinner appears on the "Finish signing" button, providing visual feedback that the system is processing the request.

<Image align="center" src="https://developer.incode.com/assets/2bb29b346e40ca6e623051b9665336b1.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/0c08ddb7a21f034850c4f1b2737da97a.png" />

<br />

| **UI Element**                       | **Token**                        | **Raw Value** |
| ------------------------------------ | -------------------------------- | ------------- |
| Title text (Accept and sign)         | `text-body-primary`              | `#262831`     |
| Instruction text                     | `text-body-secondary`            | `#60667C`     |
| Document row surface                 | `surface-neutral-50`             | `#FCFCFD`     |
| Document row border                  | `border-neutral-100`             | `#EBECEF`     |
| Document name text                   | `text-body-primary`              | `#262831`     |
| Checkbox (disabled) background       | `checkbox-surface-disabled`      | `#82879A`     |
| Checkbox (disabled container)        | `surface-neutral-400`            | `#82879A`     |
| Checkbox text (disabled)             | `checkbox-text-disabled`         | `#60667C`     |
| Checkbox text (alias)                | `text-body-secondary`            | `#60667C`     |
| Checkbox icon                        | `checkbox-icon-default`          | `#FFFFFF`     |
| Card background (checkbox container) | `surface-neutral-0`              | `#FFFFFF`     |
| Inner card surface                   | `surface-neutral-50`             | `#FCFCFD`     |
| Primary button background            | `button-primary-surface-default` | `#006AFF`     |
| Primary button text                  | `button-primary-text-default`    | `#FFFFFF`     |

## Design notes

* Preserve layout stability when switching to loading state.
* Maintain accessible contrast for spinner and disabled elements.

***

<br />

## Processing screen

Intermediate screen displayed while the system processes the signature submission. The screen shows a spinning progress indicator alongside the text "Processing…", communicating to the user that their action is being handled and they should wait.

<Image align="center" src="https://developer.incode.com/assets/14255efc8bd7fff9895399e65c9ccfa1.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/d55fce663ce637319342f03b6d73f623.png" />

<br />

| **UI Element**                  | **Token**                  | **Raw Value** |
| :------------------------------ | :------------------------- | :------------ |
| Screen background               | `surface-neutral-0`        | `#FFFFFF`     |
| Spinner (active stroke)         | `surface-brand-500-static` | `#006AFF`     |
| Spinner (track/background)      | `surface-brand-50`         | `#EAF0FF`     |
| Processing text (“Processing…”) | `text-body-primary`        | `#262831`     |

## Success

Final confirmation screen of the Qualified Signature module. After processing completes, the screen displays a green checkmark icon along with the message "Signed successfully!" confirming that the signature has been captured and the process is complete. No further user action is required.

<Image align="center" src="https://developer.incode.com/assets/55d6a4bf2a41f57f2bf30cc408e037af.png" />

<br />

### Customizable Elements

| **Area**          | **What can be customized**                            | **Notes**                                                                                 |
| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Text Elements** | Title, success message, footer text                   | Fully localizable. Wording can align with brand tone and regulatory language.             |
| **Color Styling** | Background, text color, success icon color, CTA color | Applied via design tokens. Must maintain accessibility contrast, even in disabled states. |
| **Localization**  | All text content                                      | Supports full translation. Layout should account for text expansion.                      |

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                           |
| ------------------------------ | ----------------------------------------------------------------------------- |
| **Processing flow logic**      | Controlled by backend verification services; cannot be modified at UI level.  |
| **Form structure hierarchy**   | Field order and grouping remain standardized for consistency.                 |
| **WCAG contrast requirements** | Accessibility compliance is mandatory, including disabled and loading states. |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/c739b2387518033c1451d0dbe0a6a687.png" />

<br />

| **UI Element**                      | **Token**              | **Raw Value** |
| :---------------------------------- | :--------------------- | :------------ |
| Screen background                   | `surface-neutral-0`    | `#FFFFFF`     |
| Success icon background             | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)                | `icon-neutral-0`       | `#FFFFFF`     |
| Title text (“Signed successfully!”) | `text-body-primary`    | `#262831`     |

<br />

---

- Path: `design-and-ux/customization-watchlist`
- URL: https://developer.incode.com/design-and-ux/customization-watchlist/
- Markdown: https://developer.incode.com/design-and-ux/customization-watchlist.md

# Customization

This section outlines the elements you can customize within the **Watchlist** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Watchlist Processing

Entry point of the Watchlist module. This screen informs the user that their information is being processed and screened against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists. A loading indicator communicates that the verification is currently in progress while temporarily preventing duplicate submissions or interruptions..

<Image align="center" src="https://developer.incode.com/assets/cae327a69ac28c14a8eadaa87fa611ab.png" />

<br />

### Customizable Elements

| **Area**              | **What can be customized**                                               | **Notes**                                                                                         |
| --------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| **Text Elements**     | Processing title, status message, helper text                            | Fully localizable. Tone and terminology can align with brand and compliance requirements.         |
| **Color Styling**     | Background color, text color, loading indicator color, status icon color | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Branding**          | Logo placement, typography styles, accent colors                         | Branding updates should maintain readability and consistency throughout the verification flow.    |
| **Localization**      | All textual content and regional formatting                              | Supports localization and translation. Layout should account for text expansion across languages. |
| **Loading Indicator** | Spinner style and animation behavior                                     | Customizable within approved motion and accessibility guidelines.                                 |
| **Status Messaging**  | Processing and success confirmation copy                                 | Messaging should remain concise, clear, and compliant with regulatory communication standards.    |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture. |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.              |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2aed822ae6ae1a8a4c361f0866abb066.png" />

<br />

| **UI Element**          | **Token**              | **Raw Value** |
| ----------------------- | ---------------------- | ------------- |
| Screen background       | `surface-neutral-0`    | `#FFFFFF`     |
| Processing spinner      | `surface-brand-400`    | `#3388FF`     |
| Processing title text   | `text-body-primary`    | `#262831`     |
| Processing helper text  | `text-body-secondary`  | `#60667C`     |
| Success icon background | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)    | `icon-neutral-0`       | `#FFFFFF`     |
| Success title text      | `text-body-primary`    | `#262831`     |

### Design Notes

* Keep processing and success messaging concise to reduce cognitive load during verification.
* Preserve sufficient color contrast across all states, including processing, success, disabled, and error states.
* Maintain consistent spacing, typography, and iconography across all watchlist states to reinforce flow continuity.

<br />

## Watchlist Success

The screen displays a success indicator and confirmation message, communicating that the user’s information has been successfully screened against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists, allowing the user to proceed to the next step of the onboarding flow..

<Image align="center" src="https://developer.incode.com/assets/744050c3a1a953c1439cfcba1d67d420.png" />

<br />

### Customizable Elements

<br />

| **Area**              | **What can be customized**                                      | **Notes**                                                                                         |
| --------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Text Elements**     | Success title, confirmation message, helper text                | Fully localizable. Messaging can align with brand tone and compliance communication standards.    |
| **Color Styling**     | Background color, text color, success icon color, accent colors | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Localization**      | All textual content and regional formatting                     | Supports localization and translation. Layout should account for text expansion across languages. |
| **Success Indicator** | Success icon style and animation behavior                       | Customizable within approved accessibility and motion guidelines.                                 |
| **Status Messaging**  | Success confirmation copy                                       | Messaging should remain concise, clear, and compliant with regulatory communication requirements. |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                      |
| ---------------------------------- | -------------------------------------------------------- |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.      |
| **Text hierarchy**                 | Maintains clear task communication and visual structure. |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                  |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/948ed5420c3aabe00ffa52a1edcf164c.png" />

<br />

| **UI Element**          | **Token**              | **Raw Value** |
| ----------------------- | ---------------------- | ------------- |
| Screen background       | `surface-neutral-0`    | `#FFFFFF`     |
| Success title text      | `text-body-primary`    | `#262831`     |
| Success icon background | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)    | `icon-neutral-0`       | `#FFFFFF`     |

## Design notes

* Keep the layout clear, vertically structured, and easy to scan to reduce cognitive load.

***

<br />

<br />

---

- Path: `design-and-ux/customization-watchlist-business`
- URL: https://developer.incode.com/design-and-ux/customization-watchlist-business/
- Markdown: https://developer.incode.com/design-and-ux/customization-watchlist-business.md

#  Customization

This section outlines the elements you can customize within the **Watchlist for business** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

***

## Watchlist Empty

Entry point of the **Watchlist for Business** module. This screen allows users to enter the business name and select the country before starting the screening process against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists.

<Image align="center" src="https://developer.incode.com/assets/4932f70bc1f0dc57f8c110921405617f.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                                               | **Notes**                                                                                                     |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| **Text**             | Screen title, field labels, placeholders, helper text, validation messages, button text, processing and success messages | Fully localizable; tone and terminology can be adapted to align with brand voice and compliance requirements. |
| **Field Set**        | Business name field, country selector, optional business identifiers                                                     | Configurable depending on onboarding and compliance requirements; core flow structure remains consistent.     |
| **Input States**     | Helper text, inline validation messaging, disabled and focus states                                                      | Validation logic remains fixed to preserve consistency and usability standards.                               |
| **Background Color** | Screen background color                                                                                                  | Must maintain sufficient contrast with text, inputs, and CTAs to support accessibility compliance.            |
| **Buttons (CTA)**    | Button labels, background color, text color, disabled state styling                                                      | Uses brand tokens while preserving visibility and accessibility across states.                                |
| **Brand Colors**     | Accent colors, input focus state, loading indicator, success state colors                                                | Applied via design tokens; avoid reducing clarity in validation, processing, or success states.               |
| **Loading State**    | Processing message, spinner style, loading animation behavior                                                            | Customizable within approved accessibility and motion guidelines.                                             |
| **Success State**    | Confirmation message, success icon styling                                                                               | Messaging should remain concise, clear, and compliant with regulatory communication standards.                |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture. |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.              |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/ac07916c3b36141e044db23c2ccfd37c.png" />

<br />

| **UI Element**             | **Token**                         | **Raw Value** |
| -------------------------- | --------------------------------- | ------------- |
| Screen background          | `surface-neutral-0`               | `#FFFFFF`     |
| Header title text          | `text-body-primary`               | `#262831`     |
| Country label text         | `dropdown-text-label-default`     | `#262831`     |
| Country placeholder text   | `dropdown-text-input-placeholder` | `#B2879A`     |
| Dropdown border            | `dropdown-border-default`         | `#B2879A`     |
| Dropdown background        | `dropdown-surface-default`        | `#FCFCDD`     |
| Business name label text   | `input-text-label-default`        | `#262831`     |
| Input border               | `input-border-default`            | `#B2879A`     |
| Input background           | `input-surface-default`           | `#FCFCDD`     |
| Continue button background | `button-primary-surface-disabled` | `#EBECEF`     |
| Continue button text       | `button-primary-text-disabled`    | `#60667C`     |
| Primary body text          | `text-body-800-primary`           | `#262831`     |
| Secondary body text        | `text-body-400`                   | `#B2879A`     |

<br />

## Watchlist Filled

State displayed after the user has entered the required business information, including the business name and country, and before the watchlist screening process begins.

<Image align="center" src="https://developer.incode.com/assets/e56dd9cb59916e95aad0d3c68dcf11bc.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                                                                               | **Notes**                                                                                                     |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| **Text**             | Screen title, field labels, placeholders, helper text, validation messages, button text, processing and success messages | Fully localizable; tone and terminology can be adapted to align with brand voice and compliance requirements. |
| **Field Set**        | Business name field, country selector, optional business identifiers                                                     | Configurable depending on onboarding and compliance requirements; core flow structure remains consistent.     |
| **Input States**     | Helper text, inline validation messaging, disabled and focus states                                                      | Validation logic remains fixed to preserve consistency and usability standards.                               |
| **Background Color** | Screen background color                                                                                                  | Must maintain sufficient contrast with text, inputs, and CTAs to support accessibility compliance.            |
| **Buttons (CTA)**    | Button labels, background color, text color.                                                                             | Uses brand tokens while preserving visibility and accessibility across states.                                |
| **Brand Colors**     | Accent colors, input focus state, loading indicator, success state colors                                                | Applied via design tokens; avoid reducing clarity in validation, processing, or success states.               |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture. |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.              |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/3d2b7e649cfd2eaf17526100dbb6f6c2.png" />

<br />

| **UI Element**             | **Token**                        | **Raw Value** |
| -------------------------- | -------------------------------- | ------------- |
| Screen background          | `surface-neutral-0`              | `#FFFFFF`     |
| Header title text          | `text-body-primary`              | `#262831`     |
| Country label text         | `dropdown-text-label-default`    | `#262831`     |
| Country filled text        | `dropdown-text-input-default`    | `#262831`     |
| Dropdown border            | `dropdown-border-default`        | `#B2879A`     |
| Dropdown background        | `dropdown-surface-focused`       | `#FCFCDD`     |
| Business name label text   | `input-text-label-default`       | `#262831`     |
| Business name input text   | `input-text-input-default`       | `#262831`     |
| Input border               | `input-border-default`           | `#B2879A`     |
| Input background           | `input-surface-default`          | `#FCFCDD`     |
| Continue button background | `button-primary-surface-default` | `#006AFF`     |
| Continue button text       | `button-primary-text-default`    | `#FFFFFF`     |
| Primary body text          | `text-body-800-primary`          | `#262831`     |
| Brand primary surface      | `surface-brand-500-static`       | `#006AFF`     |

## Watchlist Processing

Processing state of the **Watchlist for Business** module. This screen informs the user that the submitted business information is being processed and screened against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists. A loading indicator communicates that the verification is currently in progress while temporarily preventing duplicate submissions or interruptions.

<Image align="center" src="https://developer.incode.com/assets/cae327a69ac28c14a8eadaa87fa611ab.png" />

<br />

### Customizable Elements

<br />

| **Area**              | **What can be customized**                                               | **Notes**                                                                                         |
| --------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| **Text Elements**     | Processing title, status message, helper text                            | Fully localizable. Tone and terminology can align with brand and compliance requirements.         |
| **Color Styling**     | Background color, text color, loading indicator color, status icon color | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Branding**          | Logo placement, typography styles, accent colors                         | Branding updates should maintain readability and consistency throughout the verification flow.    |
| **Localization**      | All textual content and regional formatting                              | Supports localization and translation. Layout should account for text expansion across languages. |
| **Loading Indicator** | Spinner style and animation behavior                                     | Customizable within approved motion and accessibility guidelines.                                 |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Processing flow behavior**   | Prevents duplicate submissions and manages loading states during signature capture. |
| **Text hierarchy**             | Maintains clear task communication and visual clarity within the flow.              |
| **WCAG contrast requirements** | Mandatory for accessibility compliance and inclusive user experience.               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2aed822ae6ae1a8a4c361f0866abb066.png" />

<br />

| **UI Element**          | **Token**              | **Raw Value** |
| ----------------------- | ---------------------- | ------------- |
| Screen background       | `surface-neutral-0`    | `#FFFFFF`     |
| Processing spinner      | `surface-brand-400`    | `#3388FF`     |
| Processing title text   | `text-body-primary`    | `#262831`     |
| Processing helper text  | `text-body-secondary`  | `#60667C`     |
| Success icon background | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)    | `icon-neutral-0`       | `#FFFFFF`     |
| Success title text      | `text-body-primary`    | `#262831`     |

### Design Notes

* Keep processing and success messaging concise to reduce cognitive load during verification.
* Preserve sufficient color contrast across all states, including processing, success, disabled, and error states.
* Maintain consistent spacing, typography, and iconography across all watchlist states to reinforce flow continuity.

<br />

## Watchlist Success

The screen displays a success indicator and confirmation message, communicating that the business information has been successfully screened against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists, allowing the user to proceed to the next step of the onboarding flow..

<Image align="center" src="https://developer.incode.com/assets/744050c3a1a953c1439cfcba1d67d420.png" />

<br />

### Customizable Elements

<br />

| **Area**              | **What can be customized**                                      | **Notes**                                                                                         |
| --------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Text Elements**     | Success title, confirmation message, helper text                | Fully localizable. Messaging can align with brand tone and compliance communication standards.    |
| **Color Styling**     | Background color, text color, success icon color, accent colors | Applied via design tokens. Must preserve accessibility contrast across all states.                |
| **Localization**      | All textual content and regional formatting                     | Supports localization and translation. Layout should account for text expansion across languages. |
| **Success Indicator** | Success icon style and animation behavior                       | Customizable within approved accessibility and motion guidelines.                                 |
| **Status Messaging**  | Success confirmation copy                                       | Messaging should remain concise, clear, and compliant with regulatory communication requirements. |

### Fixed Elements

| **Element**                        | **Why it is fixed**                                      |
| ---------------------------------- | -------------------------------------------------------- |
| **Component spacing & safe areas** | Ensures cross-device consistency and accessibility.      |
| **Text hierarchy**                 | Maintains clear task communication and visual structure. |
| **WCAG contrast requirements**     | Mandatory for accessibility compliance.                  |

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/948ed5420c3aabe00ffa52a1edcf164c.png" />

<br />

| **UI Element**          | **Token**              | **Raw Value** |
| ----------------------- | ---------------------- | ------------- |
| Screen background       | `surface-neutral-0`    | `#FFFFFF`     |
| Success title text      | `text-body-primary`    | `#262831`     |
| Success icon background | `icon-status-positive` | `#1E7F11`     |
| Success icon (check)    | `icon-neutral-0`       | `#FFFFFF`     |

## Design notes

* Keep the layout clear, vertically structured, and easy to scan to reduce cognitive load.

***

<br />

<br />

---

- Path: `design-and-ux/data-sharing-consent-customization`
- URL: https://developer.incode.com/design-and-ux/data-sharing-consent-customization/
- Markdown: https://developer.incode.com/design-and-ux/data-sharing-consent-customization.md

# Customization

This section outlines the elements you can customize within the **Data Sharing Consent** module to align with your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as consent copy, illustrations, and brand colors, and which elements remain fixed to ensure transparency, compliance, accessibility, and a consistent user experience across platforms.

<br />

## Consent Screen

The Consent Screen presents the data sharing request and helps users understand what information will be shared, why it is needed, and how it will be used. It promotes transparency, supports informed decision-making, and ensures users can provide consent with confidence before continuing the verification process.


<Image src="https://developer.incode.com/assets/bf0608043f02bbe0f1a515a156a8cffb.png" align="center" />


<br />

### Customizable Elements

| Area             | What can be customized                               | Notes                                                                       |
| ---------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
| Text             | Title, subtitle, consent description, checkbox label | Fully localizable; tone can be adapted to compliance and brand requirements |
| Brand Colors     | Logo, links, checkbox, button, accent elements       | Uses brand tokens                                                           |
| Buttons          | Label, color, radius                                 | Must follow platform guidelines and maintain primary/secondary hierarchy    |
| Consent Checkbox | Label text, selected state color                     | Checkbox is required; must remain clearly visible and accessible            |
| Card Surface     | Background color, corner radius, elevation           | Must maintain readability and WCAG contrast requirements                    |
| Footer           | "Verified by Incode" line                            | Optional but recommended                                                    |

<br />

### Fixed Elements

| Element                      | Why it is fixed                                                            |
| ---------------------------- | -------------------------------------------------------------------------- |
| Consent flow structure       | Ensures users review and acknowledge consent information before proceeding |
| Consent checkbox requirement | Required to capture explicit user consent and meet compliance requirements |
| Layout structure             | Ensures consistency across modules and platforms                           |
| Text hierarchy               | Optimized for readability and comprehension of consent information         |
| Spacing & safe areas         | Required for device compatibility and accessibility                        |
| WCAG minimum contrast        | Mandatory to ensure accessibility compliance                               |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/e4f4f9f42cd1cb2fe9c5b534e5a306a3.png" align="center" />


| # | UI Element                 | Token                                                                     | Value   |
| - | -------------------------- | ------------------------------------------------------------------------- | ------- |
| 1 | Title                      | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| 2 | Consent summary text       | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| 3 | Screen background          | Surface/Neutral/0 → Color/Gray/0                                          | #FFFFFF |
| 5 | Checkbox surface           | Checkbox/Surface/Default → Surface/Neutral/50 → Color/Gray/50             | #FCFCFD |
| 6 | Consent card background    | Surface/Brand/50 → Color/Brand/50                                         | #E5F0FF |
| 7 | Checkbox label text        | Checkbox/Text/Default → Text/Body/800 (Primary) → Color/Gray/800          | #262831 |
| 8 | Disabled button text       | Button/Primary/Text/Disabled → Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| 9 | Disabled button background | Button/Primary/Surface/Disabled → Surface/Neutral/100 → Color/Gray/100    | #EBECEF |

### Design Notes

- Keep consent messaging concise and easy to scan.
- Consent copy, title, description, and checkbox label can be customized to meet branding and compliance requirements.
- Ensure the consent checkbox remains clearly visible and accessible across all states.
- Maintain sufficient color contrast and tap target sizes to meet accessibility guidelines.
- Provide clear focus indicators and screen reader support for interactive elements (Web).

<br />

***

## Consented Screen

The Consented Screen is displayed after the user has successfully granted consent to share their data. It confirms that consent has been recorded, reassures the user that their authorization was successfully received, and clearly indicates that the verification process can continue. This step provides confirmation, reinforces transparency, and helps users proceed with confidence.


<Image src="https://developer.incode.com/assets/ee2be9ea1d74204993bc9ebf792fc3b6.png" align="center" />


<br />

### Customizable Elements

| Area             | What can be customized                               | Notes                                                                       |
| ---------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
| Text             | Title, subtitle, consent description, checkbox label | Fully localizable; tone can be adapted to compliance and brand requirements |
| Brand Colors     | Logo, links, checkbox, button, accent elements       | Uses brand tokens                                                           |
| Buttons          | Label, color, radius                                 | Must follow platform guidelines and maintain primary/secondary hierarchy    |
| Consent Checkbox | Label text, selected state color                     | Checkbox is required; must remain clearly visible and accessible            |
| Card Surface     | Background color, corner radius, elevation           | Must maintain readability and WCAG contrast requirements                    |
| Footer           | "Verified by Incode" line                            | Optional but recommended                                                    |

<br />

### Fixed Elements

| Element                      | Why it is fixed                                                            |
| ---------------------------- | -------------------------------------------------------------------------- |
| Consent flow structure       | Ensures users review and acknowledge consent information before proceeding |
| Consent checkbox requirement | Required to capture explicit user consent and meet compliance requirements |
| Layout structure             | Ensures consistency across modules and platforms                           |
| Text hierarchy               | Optimized for readability and comprehension of consent information         |
| Spacing & safe areas         | Required for device compatibility and accessibility                        |
| WCAG minimum contrast        | Mandatory to ensure accessibility compliance                               |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/e830bf31693f5321201c15b121f269a4.png" align="center" />


| #  | UI Element                | Token                                                                       | Value   |
| -- | ------------------------- | --------------------------------------------------------------------------- | ------- |
| 1  | Title                     | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| 2  | Consent summary text      | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| 3  | Screen background         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| 5  | Selected checkbox surface | Checkbox/Surface/Selected → Surface/Brand/500 Static → Color/Brand/500      | #006AFF |
| 6  | Checkbox icon             | Checkbox/Icon/Default → Surface/Neutral/0 Static → Color/Gray/0             | #FFFFFF |
| 7  | Consent card background   | Surface/Brand/50 → Color/Brand/50                                           | #E5F0FF |
| 8  | Checkbox label text       | Checkbox/Text/Default → Text/Body/800 (Primary) → Color/Gray/800            | #262831 |
| 9  | Primary button text       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| 10 | Primary button background | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |

### Design Notes

- Keep consent messaging concise and easy to scan.
- Consent copy, title, description, and checkbox label can be customized to meet branding and compliance requirements.
- Ensure the consent checkbox remains clearly visible and accessible across all states.
- Maintain sufficient color contrast and tap target sizes to meet accessibility guidelines.
- Provide clear focus indicators and screen reader support for interactive elements (Web).

<br />

---

- Path: `design-and-ux/data-sharing-consent-design`
- URL: https://developer.incode.com/design-and-ux/data-sharing-consent-design/
- Markdown: https://developer.incode.com/design-and-ux/data-sharing-consent-design.md

# Data Sharing Consent

The Data Sharing Consent module allows organizations to request and record the user's consent before collecting, processing, or sharing personal information as part of the verification process.

This module typically appears before identity verification begins or whenever explicit user authorization is required to comply with privacy, regulatory, or business requirements. It helps ensure users understand how their data will be used and provides a clear opportunity to accept consent.


<Image src="https://developer.incode.com/assets/9ff35f6baeb5a5badd89a5e874a1a2c9.gif" align="center" />


***

## Where it fits in the flow

Data Sharing Consent typically appears before identity verification begins or whenever explicit user authorization is required.

Once the user reviews and accepts the consent terms, the flow continues to the next verification step, such as document capture, face capture, or another configured verification process.

***

## User Flow

The Data Sharing Consent experience presents users with the information required to understand and authorize how their personal data will be collected, processed, shared, and protected throughout the verification process.

Users must review the consent terms and actively acknowledge them by selecting the consent checkbox. The Continue button remains disabled until consent is provided, ensuring explicit authorization before proceeding. Once consent is granted, the system records the user's agreement and advances to the next configured verification step, such as document capture, face capture, or another verification process.

<br />


<Image src="https://developer.incode.com/assets/e9b490642d7c859391c532d130f3a4e5.png" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in **Face Capture**, from tutorial and permission handling, to auto/manual capture, uploading, and final feedback.


<Image src="https://developer.incode.com/assets/dd17b87a6b5ebc61557eacb188f89cf3.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey when consent is provided successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user reviews the consent information, understands how their data will be collected and used, provides explicit authorization by selecting the consent checkbox, and continues to the next verification step without encountering errors or additional prompts. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/fffc36fbcf5b6ae991bc4216cf36cf32.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/7ba991b19efa7317231131776ca42d7d.png" align="center" caption="Dark mode - The capture screen uses a white background even in dark mode to ensure proper illumination and optimal face detection during the face capture process." />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the Data Sharing Consent experience.

✅ Do

- Clearly explain what data will be collected, processed, or shared.
- Use concise, easy-to-understand language that avoids legal jargon whenever possible.
- Make consent actions explicit and intentional.
- Ensure users can review the full consent information before making a decision.
- Clearly indicate when consent is required to continue the verification process.
- Provide accessible links to privacy policies or additional information when applicable.
- Ensure consent records are captured and stored accurately.

❌ Don’t

- Don’t pre-select consent checkboxes or assume user agreement.
- Don’t hide important information behind unclear links or expandable sections.
- Don’t use confusing, ambiguous, or overly technical language.
- Don’t make acceptance appear mandatory unless required by the verification flow.
- Don’t rely solely on color to communicate consent status or validation.
- Don’t allow users to continue before providing the required authorization.
- Don’t omit information about how user data will be used, shared, or protected.

<br />

---

- Path: `design-and-ux/data-sharing-screens-states`
- URL: https://developer.incode.com/design-and-ux/data-sharing-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/data-sharing-screens-states.md

# Screens & States

A complete view of all screens the user may encounter throughout the Data Sharing Consent experience. Each state includes a brief description and serves as the source of truth for layouts, visual specifications, interactions, and platform-specific variations.

***

## Consent Screen

Presented to the user to review and acknowledge the data sharing consent terms before continuing with the verification process. Includes required disclosures about data collection, processing, and usage, a mandatory consent checkbox, and access to the privacy notice. The Continue button remains disabled until consent is provided.


<Image src="https://developer.incode.com/assets/ce84d58cde36d9e5059384d01fc0b59c.png" align="center" />


<br />

## **Consented Screen**

Shown after the user has reviewed the data sharing consent information and actively agreed to the terms. The consent checkbox is selected, enabling the **Continue** button and allowing the user to proceed to the next step of the verification flow. Includes consent confirmation, required disclosures, and access to the privacy notice.


<Image src="https://developer.incode.com/assets/68d3e046e6cd37e56d5228dda7114eac.png" align="center" />


<br />

---

- Path: `design-and-ux/data-sharing-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/data-sharing-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/data-sharing-specs-guidelines.md

# Specs & Guidelines

The Data Sharing Consent module includes complete Figma specifications documenting spacing, layout behavior, typography tokens, consent content variations, and localization requirements. These specifications ensure a consistent experience across platforms while allowing organizations to customize consent messaging, branding elements, and data-sharing disclosures without impacting usability, accessibility, or layout integrity.


<Image src="https://developer.incode.com/assets/b3562d34af95ed7a9c9e60be7b839ff4.png" align="center" />


<br />

***

## Responsiveness & Viewport Adaptation

The **Data Sharing Consent** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain readable and accessible whether users are completing the consent flow on a small phone, large phone, foldable device, tablet, or desktop browser.

This ensures that consent information, disclosure text, checkboxes, and action buttons remain visible, accessible, and properly aligned across platforms.


<Image src="https://developer.incode.com/assets/4f3536744ac5fbfb736ea2120635ee61.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                     | Behavior                                                                                         |
| ------------------------------ | ------------------------------------------------------------------------------------------------ |
| Small phones (e.g., iPhone SE) | Consent content scrolls vertically while maintaining readable spacing and accessible tap targets |
| Standard phones (iPhone 12–16) | Full layout displayed with consistent hierarchy, spacing, and content organization               |
| Tall/narrow Android devices    | Vertical spacing adapts to preserve readability and keep consent actions visible                 |
| Foldables (e.g., Pixel Fold)   | Additional whitespace improves readability while keeping consent content centered                |
| Tablets                        | Increased margins and content width while maintaining comfortable reading lengths                |
| Desktop web                    | Centered layout with controlled max-width and additional safe area spacing                       |

<br />

### What is responsive (and customizable)

| Element                 | Responsive Behavior                                    | Customizable         |
| ----------------------- | ------------------------------------------------------ | -------------------- |
| Consent content         | Reflows based on viewport width and available space    | Yes                  |
| Consent disclosure text | Supports multiline expansion and scrolling when needed | Yes                  |
| Checkbox area           | Expands vertically to accommodate localized content    | Checkbox text only   |
| Buttons                 | Width adjusts to available container space             | Color, label, radius |
| Footer / watermark      | Remains aligned within the bottom safe area            | Optional             |
| Header / branding area  | Adjusts spacing based on safe areas and viewport size  | Limited              |

<br />

### What remains fixed across breakpoints

| Element                       | Reason                                                 |
| ----------------------------- | ------------------------------------------------------ |
| Consent flow structure        | Ensures a predictable and compliant consent experience |
| Checkbox interaction behavior | Required for explicit consent capture                  |
| Minimum text size             | Required for readability and accessibility compliance  |
| Minimum tap target sizes      | Ensures accessibility across devices                   |
| Content hierarchy             | Preserves comprehension of consent information         |
| Required consent actions      | Prevents bypassing mandatory consent requirements      |

<br />

### Design Notes

- Consent content should remain easy to scan and understand regardless of screen size.
- Avoid introducing custom layouts that disrupt the reading flow or consent hierarchy.
- Long localized text is supported, but content should remain concise whenever possible.
- Maintain clear separation between disclosure content, consent actions, and primary CTAs.

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/dd2666ea436348a863a4f37b20e79053.png" align="center" />


<br />

<br />

***

## Prototype & Transitions

The Data Sharing Consent module includes predefined interaction patterns and transitions covering consent review, consent confirmation, and progression to the next verification step.


<Image src="https://developer.incode.com/assets/185a1096b4586b61cb7d85383b33f8cd.gif" align="center" />


<br />

<br />

***

## Localization

The **Data Sharing Consent** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/5851bb13dad4089a31e8f09d3f2318a6.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Buttons and CTAs automatically expand to fit translated labels.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
- Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/data-sharing-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/data-sharing-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/data-sharing-v1-vs-v2-comparison.md

# Data Sharing Consent V1 vs V2 Comparison

<br />

In V1, Data Sharing Consent provides a basic consent experience focused on collecting user authorization before continuing. The screen presents essential legal links, a consent checkbox, and a primary action, with limited context about how personal and biometric information will be used.

In V2, Data Sharing Consent introduces a more transparent and informative experience. Users are provided with detailed information about the data being collected, how it will be used, and why consent is required before proceeding. The updated design improves readability, strengthens trust, and provides a clearer path to informed consent through better content hierarchy, branding, and interaction states.

<br />


<Image src="https://developer.incode.com/assets/ab56603e1760ecfea0340887a6dc1323.png" align="center" caption="V1 provides a basic consent collection experience with limited information hierarchy and no token-based customization support." />


<br />


<Image src="https://developer.incode.com/assets/58ffd9a30d67a728f9917da0b0c9c1b5.png" align="center" caption="V2 provides a clearer and more informative consent experience with improved content hierarchy and token-based customization." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities                | V1 | V2 | Notes                                                                                |
| --------------------------- | -- | -- | ------------------------------------------------------------------------------------ |
| Consent collection          | ✅  | ✅  | Both versions allow users to provide explicit consent before continuing.             |
| Consent checkbox validation | ✅  | ✅  | Users must acknowledge consent requirements before proceeding.                       |
| Legal links                 | ✅  | ✅  | Both versions provide access to Privacy Policy and Terms of Use.                     |
| Customization options       | ❌  | ✅  | V2 provides extensive customization for text, colors, buttons, and consent surfaces. |
| Documentation completeness  | ❌  | ✅  | V2 includes complete specifications, guidelines, and customization documentation.    |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior                 | V1                         | V2                                | Notes                                                                  |
| ------------------------ | -------------------------- | --------------------------------- | ---------------------------------------------------------------------- |
| Consent presentation     | Minimal legal agreement    | Detailed consent disclosure       | V2 provides additional context before consent is granted.              |
| Information hierarchy    | Basic                      | Structured content hierarchy      | V2 improves readability and comprehension.                             |
| Consent state visibility | Limited visual distinction | Clear enabled and disabled states | V2 makes completion requirements easier to understand.                 |
| Branding integration     | Limited                    | Fully tokenized                   | V2 follows the standardized design system.                             |
| Content transparency     | Basic                      | Expanded disclosure content       | V2 provides greater visibility into data collection and usage.         |
| State transitions        | Default transitions        | Designed transitions              | V2 includes documented transition behavior and interaction guidelines. |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/dfbad6207f26dc6afc4003a379cbf5de.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/design-and-experience`
- URL: https://developer.incode.com/design-and-ux/
- Markdown: https://developer.incode.com/design-and-ux.md

<div class="dh-px-hero"><div class="dh-px-dots"></div><p class="dh-px-badge"><i></i>Design</p><h1 class="dh-px-title">Design and UX.</h1>

This section is for frontend engineers, designers, and product teams integrating [Incode modules](/features-and-modules/modules-overview-and-availability/) into an onboarding or verification flow. It covers what users see, how modules behave, and what you can customize to match your brand.

</div>

<div class="dh-px-cards"><div class="dh-px-grid2"><a class="dh-px-card" href="/design-and-ux/prizma-design-foundations/"><div><p class="dh-px-eyebrow">Foundations · Tokens · Components</p><p class="dh-px-card-title">Prizma Design System</p><p class="dh-px-card-body">Incode’s design system: components, tokens, and the Prizma Dashboard. Start here if you need foundational design decisions, token references, or component specs.</p></div><span class="dh-px-cta">Explore Prizma<svg width="13" height="13" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><line x1="5" y1="12" x2="19" y2="12"/><polyline points="12 5 19 12 12 19"/></svg></span></a><a class="dh-px-card dh-px-card--purple" href="/design-and-ux/module-customization/"><div><p class="dh-px-eyebrow dh-px-eyebrow--purple">Screens · Customization · Specs</p><p class="dh-px-card-title">Module Customization</p><p class="dh-px-card-body">Per-module documentation covering screens and states, customization options, specs and guidelines, and V1 vs V2 comparisons for every Incode module.</p></div><span class="dh-px-cta dh-px-cta--purple">Explore modules<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><line x1="5" y1="12" x2="19" y2="12"/><polyline points="12 5 19 12 12 19"/></svg></span></a></div></div>

<div class="dh-px-band"><p class="dh-px-band-label">Accessibility</p><p class="dh-px-band-lead">Accessibility is built into every module.</p><p>Each module’s Specs &amp; Guidelines page covers accessibility notes specific to that module, including contrast, screen reader behavior, keyboard navigation, and motion guidelines. For the cross-cutting principles that apply across all modules, see the <a href="/general-reference/accessibility/">Accessibility Overview</a>.</p></div>

<div class="dh-rule"><span>How to use this section</span><i></i></div>

When you’re integrating a module:

<Steps>
<Step title="Open the module under Module Customization">Find it in one of the category grids or in the sidebar.</Step>
<Step title="Review Screens & States">Understand what the user will see at every step of the flow.</Step>
<Step title="Review Customization">Understand your branding options for colors, typography, copy, logos.</Step>
<Step title="Check Specs & Guidelines">Design constraints and accessibility notes for the module.</Step>
<Step title="Check V1 vs V2 Comparison">If the module has both experiences, decide which to integrate.</Step>
</Steps>

If you need help locating a module or want to confirm something about a flow, contact your Incode representative.

---

- Path: `design-and-ux/document-capture-customization`
- URL: https://developer.incode.com/design-and-ux/document-capture-customization/
- Markdown: https://developer.incode.com/design-and-ux/document-capture-customization.md

# Customization

This section outlines the elements you can customize within the **Document Capture** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

<br />

## Document Capture Tutorial

The Document Capture Tutorial Screen introduces users to the document verification process before capture begins. It explains the available upload methods and prepares users for the next steps in the flow.

<Image align="center" src="https://developer.incode.com/assets/647440dd0fc06a524c3634fe47629113.png" />

<br />

### Customizable Elements

<br />

| **Area**             | **What can be customized**        | **Notes**                                |
| -------------------- | --------------------------------- | ---------------------------------------- |
| **Title text**       | “Verify your document”            | Fully localizable.                       |
| **Subtitle text**    | Supporting instructional copy     | Can reference supported upload formats.  |
| **Illustration**     | Document placeholder illustration | Can be adapted to match brand style.     |
| **Primary button**   | Label, color, radius              | Used for the main capture/upload action. |
| **Secondary action** | “Skip this step”                  | Optional depending on flow requirements. |
| **Footer**           | “verified by incode”              | Optional but recommended.                |
| **Brand colors**     | Accent and CTA colors             | Uses brand tokens.                       |

<br />

### Fixed Elements

<br />

| **Element**                             | **Why it is fixed**                                   |
| --------------------------------------- | ----------------------------------------------------- |
| **Tutorial structure**                  | Standardized onboarding step before document capture. |
| **Illustration placement**              | Maintains visual consistency across modules.          |
| **Action hierarchy**                    | Primary action remains visually prioritized.          |
| **Spacing & safe areas**                | Required for responsive compatibility.                |
| **Accessibility contrast requirements** | Mandatory for compliance.                             |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/76d0fcbd15be5f97938cf4c3bcf98af4.png" />

<br />

| **UI Element**                     | **Token**                                                                   | **Value** |
| ---------------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Subtitle text                      | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Screen background                  | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button text                | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Primary button background          | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Secondary action text              | Button/Tertiary/Text/default → Text/Brand/Accent → Color/Brand/500          | #006AFF   |
| Footer text (“verified by incode”) | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Footer brand icon                  | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF   |
| Footer icon                        | Icon/Neutral/0 Static → Color/Gray/0                                        | #FFFFFF   |

<br />

### Design Notes

* Keep instructional messaging concise and action-oriented.
* Ensure upload methods are easy to understand before starting capture.
* The illustration should support comprehension without distracting from the CTA.
* Preserve strong visual emphasis on the primary action.
* Secondary actions should remain accessible but visually less prominent.

<br />

***

## Document Verification Method

The document verification method selection allows users to choose how they want to provide their document for verification, including taking a photo, selecting an image from the camera roll, or uploading a file..

<Image align="center" src="https://developer.incode.com/assets/a5bd10724f9e8f57e0c3c57cff435122.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**  | **Notes**                                            |
| -------------------- | --------------------------- | ---------------------------------------------------- |
| **Sheet background** | Bottom sheet styling        | Must preserve readability and elevation.             |
| **Option labels**    | Upload method labels        | Fully localizable.                                   |
| **Icons**            | Upload method icons         | Can be customized while preserving semantic meaning. |
| **Brand colors**     | Accent colors if applicable | Must remain accessible.                              |

<br />

### Fixed Elements

| **Element**                     | **Why it is fixed**                                      |
| ------------------------------- | -------------------------------------------------------- |
| **Bottom sheet behavior**       | Native interaction pattern consistency.                  |
| **Action layout**               | Standardized spacing and touch target sizing.            |
| **Safe area spacing**           | Required for device compatibility.                       |
| **Overlay interaction**         | Prevents accidental interaction with background content. |
| **Accessibility touch targets** | Required for usability compliance.                       |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/51f5805db52977f226a3a9479023d38d.png" />

<br />

| **UI Element**          | **Token**                                             | **Value** |
| ----------------------- | ----------------------------------------------------- | --------- |
| Overlay background      | Surface/Neutral/1000 80% Static → Color/Gray/1000 80% | #000000   |
| Bottom sheet background | Sheet/Item/Default → Surface/Neutral/0 → Color/Gray/0 | #FFFFFF   |
| Drag handle             | Surface/Neutral/200 → Color/Gray/200                  | #C6C8D2   |
| Option text             | Text/Body/800 (Primary) → Color/Gray/800              | #262831   |
| Option icons            | Icon/Neutral/800 → Color/Gray/800                     | #262831   |

<br />

### Design Notes

* Keep option labels short and scannable.
* Maintain familiar mobile bottom sheet interaction patterns.
* Ensure icons clearly represent each upload method.
* Preserve sufficient contrast between overlay and sheet.
* Touch targets should remain large enough for accessibility.

<br />

***

## Capture Screen

The Capture Screen enables users to capture a clear image of their document using the device camera.

<Image align="center" src="https://developer.incode.com/assets/6cca2a6989e62ed5759f78a13ee90239.png" />

<br />

### Customizable Elements

| **Area**                   | **What can be customized** | **Notes**                                      |
| -------------------------- | -------------------------- | ---------------------------------------------- |
| **Title text**             | “Show your full document”  | Fully localizable.                             |
| **Subtitle text**          | Capture guidance copy      | Should remain short and instructional.         |
| **Capture frame styling**  | Border radius and color    | Must preserve visibility and guidance clarity. |
| **Capture button styling** | Shape, border, color       | Must remain recognizable as capture action.    |
| **Help icon**              | Help/support trigger icon  | Optional depending on flow requirements.       |

<br />

### Fixed Elements

| **Element**                             | **Why it is fixed**                    |
| --------------------------------------- | -------------------------------------- |
| **Camera preview behavior**             | Controlled by native device.           |
| **Capture interaction**                 | Standardized camera experience.        |
| **Frame positioning**                   | Ensures optimal document detection.    |
| **Safe area handling**                  | Required for responsive compatibility. |
| **Accessibility contrast requirements** | Mandatory for compliance.              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6611db5ad24a9e6586608f55941da4c2.png" />

<br />

| **UI Element**                        | **Token**                                 | **Value** |
| ------------------------------------- | ----------------------------------------- | --------- |
| Title text                            | Text/Body/0 Static → Color/Gray/0         | #FFFFFF   |
| Subtitle text                         | Text/Body/300 (Tertiary) → Color/Gray/300 | #A3A8B8   |
| Footer text (“All data is encrypted”) | Text/Body/0 Static → Color/Gray/0         | #FFFFFF   |
| Footer lock icon                      | Icon/Neutral/0 Static → Color/Gray/0      | #FFFFFF   |
| Capture button inner fill             | Icon/Neutral/50 Static → Color/Gray/50    | #FCFCFD   |
| Capture button outer ring             | Icon/Neutral/0 Static → Color/Gray/0      | #FFFFFF   |
| Help icon background                  | Icon/Neutral/0 Static → Color/Gray/0      | #FFFFFF   |
| Help icon symbol                      | Icon/Neutral/800 Static → Color/Gray/800  | #262831   |

<br />

### Design Notes

* Keep instructions visible but lightweight over the camera feed.
* Ensure the capture frame clearly communicates required positioning.
* Footer reassurance messaging should not obstruct capture interactions.
* Maintain high contrast for all overlay UI elements.
* Camera controls should remain large and easy to tap.

<br />

***

## Common Issues

The Common Issues Screen provides guidance when users tap the help icon during document capture. It explains common document capture problems and helps users understand how to achieve a successful capture.

<Image align="center" src="https://developer.incode.com/assets/934d9826a8dd9b842f34db85642df265.png" />

<br />

### Customizable Elements

| **Area**               | **What can be customized**       | **Notes**                               |
| ---------------------- | -------------------------------- | --------------------------------------- |
| **Title text**         | “Common issues”                  | Fully localizable.                      |
| **Issue titles**       | Problem descriptions             | Should remain concise and easy to scan. |
| **Issue descriptions** | Supporting guidance copy         | Can be adapted to client tone of voice. |
| **Issue icons**        | Visual indicators for each issue | Must preserve semantic meaning.         |
| **Primary button**     | Retry action styling             | Used for recapture flow.                |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                            |
| ------------------------------ | ---------------------------------------------- |
| **Issue list structure**       | Optimized for readability and troubleshooting. |
| **Retry flow behavior**        | Required for verification continuity.          |
| **Button hierarchy**           | Maintains consistency across modules.          |
| **Spacing & alignment**        | Required for responsive behavior.              |
| **Accessibility requirements** | Mandatory for compliance.                      |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/11c4fb9c22481074d76898b3dfde183e.png" />

<br />

| **UI Element**            | **Token**                                                                   | **Value** |
| ------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Issue icons               | Icon/Neutral/800 → Color/Gray/800                                           | #262831   |
| Issue title text          | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Issue description text    | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Screen background         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button text       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Primary button background | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |

<br />

### Design Notes

* Keep troubleshooting content actionable and easy to skim.
* Avoid technical or overly complex explanations.
* Icons should support fast visual recognition of problems.
* Ensure enough spacing between issue rows for readability.
* Maintain clear emphasis on the retry action.

<br />

***

## Capture Review Screen

The Capture Review Screen allows users to review the captured document image before submitting it for verification. Users can confirm that the document is fully visible and readable or retake the photo if needed.

<Image align="center" src="https://developer.incode.com/assets/72e765611ab90475b3469086fc36326d.png" />

### Customizable Elements

| **Area**                       | **What can be customized**    | **Notes**                                     |
| ------------------------------ | ----------------------------- | --------------------------------------------- |
| **Title text**                 | “Review your document”        | Fully localizable.                            |
| **Subtitle text**              | Supporting instructional copy | Should remain concise and easy to understand. |
| **Primary button**             | Label, color, radius          | Used to continue the verification flow.       |
| **Secondary button**           | Label, color, radius          | Used to retake the document image.            |
| **Document container styling** | Border radius, shadows        | Must preserve document visibility.            |
| **Footer**                     | “All data is encrypted”       | Optional but recommended.                     |

<br />

### Fixed Elements

| **Element**                             | **Why it is fixed**                                     |
| --------------------------------------- | ------------------------------------------------------- |
| **Document preview behavior**           | Ensures users can properly validate the captured image. |
| **Action hierarchy**                    | Continue action remains visually prioritized.           |
| **Button placement**                    | Standardized across modules for consistency.            |
| **Spacing & safe areas**                | Required for responsive compatibility.                  |
| **Accessibility contrast requirements** | Mandatory for compliance.                               |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/deb4bd068cf316d94fcbc3e6b5c536c7.png" />

| **UI Element**                        | **Token**                                                                   | **Value** |
| ------------------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                            | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Subtitle text                         | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Background                            | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button background             | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Primary button text                   | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Secondary button text                 | Button/Secondary/Text/Default → Text/Brand/Accent → Color/Brand/500         | #006AFF   |
| Secondary button border               | Border/Brand/500 → Color/Brand/500                                          | #006AFF   |
| Footer text (“All data is encrypted”) | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Footer lock icon                      | Icon/Neutral/500 → Color/Gray/500                                           | #60667C   |

<br />

### Design Notes

* Ensure the document preview remains large and readable. 
* Keep instructions concise and action-oriented. 
* Maintain clear visual distinction between primary and secondary actions. 
* Avoid obstructing the document image with overlays or excessive UI. 
* Footer reassurance messaging should remain subtle and non-disruptive.

***

## Image Upload Screens

These screens guide users through the upload flow after capturing a document image. These states provide clear feedback while the document is being processed and confirm when the upload is successful.

<Image align="center" src="https://developer.incode.com/assets/1c90b9f4c997228f2662158e78472112.png" />

### Customizable Elements

| **Area**               | **What can be customized**            | **Notes**                             |
| ---------------------- | ------------------------------------- | ------------------------------------- |
| **Title text**         | “Uploading your document”             | Fully localizable.                    |
| **Subtitle text**      | Processing guidance copy              | Should remain short and reassuring.   |
| **Loading indicator**  | Spinner or progress animation styling | Must remain clearly visible.          |
| **Background styling** | Background colors and surfaces        | Must preserve accessibility contrast. |
| **Brand colors**       | Accent and loader colors              | Uses brand tokens.                    |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                  |
| ------------------------------ | ---------------------------------------------------- |
| **Processing behavior**        | Reflects real-time upload and verification progress. |
| **Loading state interaction**  | Prevents accidental interruption during upload.      |
| **Content hierarchy**          | Keeps focus on upload progress feedback.             |
| **Spacing & safe areas**       | Required for responsive compatibility.               |
| **Accessibility requirements** | Mandatory for compliance.                            |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/e9bd8651f2af42c5df2af3d05c46a679.png" />

| **UI Element**            | **Token**                                                                   | **Value** |
| ------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Subtitle text             | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Success icon              | Icon/Status/Positive → Color/Green/500                                      | #17B26A   |
| Background                | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button background | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Primary button text       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |

<br />

<Image align="center" src="https://developer.incode.com/assets/b521b853bcbd97cbb5f336200add5df1.png" />

| **UI Element**                        | **Token**                                  | **Value** |
| ------------------------------------- | ------------------------------------------ | --------- |
| Title text                            | Text/Body/800 (Primary) → Color/Gray/800   | #262831   |
| Subtitle text                         | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C   |
| Background                            | Surface/Neutral/0 → Color/Gray/0           | #FFFFFF   |
| Loading indicator                     | Surface/Brand/500 → Color/Brand/500        | #006AFF   |
| Footer text (“All data is encrypted”) | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C   |
| Footer lock icon                      | Icon/Neutral/500 → Color/Gray/500          | #60667C   |

<br />

### Design Notes

* Success messaging should feel clear and reassuring. 
* Avoid overly celebratory language or animations. 
* Ensure the next action is immediately visible. 
* Keep the layout lightweight and easy to scan. 
* Maintain accessible contrast and readable typography.

<br />

***

## Upload Review Screen

The Upload Review Screen allows users to confirm that they selected the correct document before uploading it for verification. The screen displays the document file name alongside a small preview of the selected file.

<Image align="center" src="https://developer.incode.com/assets/b62b10595168028073ae72f71672eccf.png" />

### Customizable Elements

| **Area**                       | **What can be customized**     | **Notes**                                 |
| ------------------------------ | ------------------------------ | ----------------------------------------- |
| **Title text**                 | “Review your upload”           | Fully localizable.                        |
| **Subtitle text**              | Supporting review instructions | Should remain concise and instructional.  |
| **Document preview container** | Border radius, background      | Must preserve readability and visibility. |
| **Document filename styling**  | Typography and color           | Must remain legible.                      |
| **Primary button**             | Label, color, radius           | Used to confirm and upload the document.  |
| **Secondary button**           | Label, color, radius           | Used to replace or select another file.   |

<br />

### Fixed Elements

| **Element**                      | **Why it is fixed**                                        |
| -------------------------------- | ---------------------------------------------------------- |
| **Preview behavior**             | Ensures users can validate selected content before upload. |
| **Document filename visibility** | Required for upload confirmation clarity.                  |
| **Action hierarchy**             | Upload action remains visually prioritized.                |
| **Spacing & safe areas**         | Required for responsive compatibility.                     |
| **Accessibility requirements**   | Mandatory for compliance.                                  |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/abaedbe985300a30316fff383d852c8b.png" />

<br />

| **UI Element**                        | **Token**                                                                   | **Value** |
| ------------------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                            | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Subtitle text                         | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Document filename                     | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Preview container background          | Surface/Neutral/50 → Color/Gray/50                                          | #F7F8FA   |
| Preview container border              | Border/Neutral/200 → Color/Gray/200                                         | #C6C8D2   |
| Background                            | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button background             | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Primary button text                   | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Secondary button text                 | Button/Secondary/Text/Default → Text/Brand/Accent → Color/Brand/500         | #006AFF   |
| Footer text (“All data is encrypted”) | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |

<br />

### Design Notes

* Ensure the document filename is easy to read and truncate gracefully if needed. 
* Keep the document preview visible but secondary to the confirmation action. 
* Maintain strong visual emphasis on the upload action. 
* Avoid cluttering the screen with unnecessary metadata. 
* Ensure secondary actions remain accessible but visually less prominent.

<br />

***

## Consecutive Pages Tutorial

The Consecutive Pages Tutorial informs users that additional pages are required for verification. This step can be optional or mandatory depending on the document type and workflow configuration.

<Image align="center" src="https://developer.incode.com/assets/14a866399532dcdbe2f359633f94865c.png" />

### Customizable Elements

| **Area**             | **What can be customized**  | **Notes**                                      |
| -------------------- | --------------------------- | ---------------------------------------------- |
| **Title text**       | Tutorial title              | Fully localizable.                             |
| **Subtitle text**    | Instructional guidance      | Can explain why additional pages are required. |
| **Illustrations**    | Multi-page guidance visuals | Can be adapted to match brand style.           |
| **Primary button**   | Label, color, radius        | Used to continue the capture flow.             |
| **Secondary action** | Optional skip action        | Available only in optional flows.              |
| **Brand colors**     | Accent and CTA colors       | Uses brand tokens.                             |
| **Footer**           | “verified by incode”        | Optional but recommended.                      |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                   |
| ------------------------------ | ----------------------------------------------------- |
| **Tutorial structure**         | Standardized onboarding for multi-page capture flows. |
| **Illustration placement**     | Preserves visual consistency.                         |
| **Action hierarchy**           | Primary action remains visually prioritized.          |
| **Spacing & safe areas**       | Required for responsive compatibility.                |
| **Accessibility requirements** | Mandatory for compliance.                             |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/f19a848e101b6fee0a5b97cb9c6cda62.png" />

<br />

| **UI Element**                     | **Token**                                                                   | **Value** |
| ---------------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Subtitle text                      | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Illustration accents               | Surface/Brand/500 → Color/Brand/500                                         | #006AFF   |
| Background                         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button background          | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Primary button text                | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Secondary action text              | Button/Tertiary/Text/default → Text/Brand/Accent → Color/Brand/500          | #006AFF   |
| Footer text (“verified by incode”) | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |

<br />

### Design Notes

* Clearly communicate whether additional pages are required or optional. 
* Keep instructional copy concise and easy to scan. 
* Illustrations should reinforce sequential page capture behavior. 
* Maintain strong emphasis on the primary CTA. 
* Avoid excessive explanations or technical terminology.

<br />

***

## Error Screen

The Error Screen appears when the uploaded document cannot be processed successfully. By default, users have 3 attempts available to retry the document upload.

<Image align="center" src="https://developer.incode.com/assets/5e5a0e7f06500abf0f34490e092289de.png" />

### Customizable Elements

| **Area**                 | **What can be customized**     | **Notes**                                                |
| ------------------------ | ------------------------------ | -------------------------------------------------------- |
| **Title text**           | Error title                    | Fully localizable; should remain neutral and actionable. |
| **Description text**     | Supporting explanation         | Can be adapted to client tone of voice.                  |
| **Status icon**          | Error indicator                | Can be customized while preserving semantic meaning.     |
| **Primary button**       | Label, color, radius           | Used for retry action.                                   |
| **Attempt counter text** | “2 attempts remaining”         | Fully localizable.                                       |
| **Background styling**   | Background colors and surfaces | Must preserve accessibility contrast.                    |
| **Footer**               | “verified by incode”           | Optional but recommended.                                |

<br />

### Fixed Elements

| **Element**                    | **Why it is fixed**                                  |
| ------------------------------ | ---------------------------------------------------- |
| **Error logic**                | Must accurately reflect backend validation failures. |
| **Attempt counter behavior**   | Controlled by backend retry configuration.           |
| **Action hierarchy**           | Retry action remains visually prioritized.           |
| **Button placement**           | Standardized across modules.                         |
| **Spacing & safe areas**       | Required for responsive compatibility.               |
| **Accessibility requirements** | Mandatory for compliance.                            |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/42eeb0e602a9372fe9813c725ecdf678.png" />

| **UI Element**                     | **Token**                                                                   | **Value** |
| ---------------------------------- | --------------------------------------------------------------------------- | --------- |
| Title text                         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831   |
| Description text                   | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Error icon                         | Icon/Status/Negative → Color/Red/500                                        | #E71111   |
| Attempt counter text               | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |
| Background                         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF   |
| Primary button background          | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF   |
| Primary button text                | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF   |
| Close icon                         | Icon/Neutral/500 → Color/Gray/500                                           | #60667C   |
| Footer text (“verified by incode”) | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C   |

<br />

### Design Notes

* Error messaging should remain clear, concise, and actionable. 
* Avoid technical or overly alarming language. 
* Clearly communicate the remaining retry attempts. 
* Maintain strong emphasis on the retry action. 
* Ensure error states remain visually distinct and accessible.

<br />

---

- Path: `design-and-ux/document-capture-design`
- URL: https://developer.incode.com/design-and-ux/document-capture-design/
- Markdown: https://developer.incode.com/design-and-ux/document-capture-design.md

# Document Capture

Document Capture allows users to upload or capture supporting documents during the verification flow, such as proof of address, bank statements, utility bills, or other required documentation. The module guides users to provide a clear and complete image of the document, ensuring all relevant information is visible and readable before submission.

Document Capture typically occurs after ID and Selfie Capture, and before the final verification result.

<Image align="center" src="https://developer.incode.com/assets/92bc6081b079ede160d116d126f64d05.gif" />

<br />

***

## Where it fits in the flow

**Document Capture** usually appears after the ID Capture and Selfie Capture flows have been completed.

Once identity verification steps are completed, the flow continues to Document Capture, where users are asked to upload or capture supporting documentation such as proof of address, bank statements, utility bills, or other required documents before proceeding to any remaining verification logic.

***

## User Flow

The **Document Capture** module guides users through uploading or capturing supporting documentation. Depending on the integration, users may upload an existing file or capture the document directly using their device camera.

During this step, the system helps users ensure the document is fully visible, readable, and correctly framed before submission. Once the document is provided, users either continue the verification flow seamlessly or receive specific feedback to help them correct any issues and successfully resubmit their document.

<br />

<Image align="center" src="https://developer.incode.com/assets/c1bb5f66c8e05e1c7a590e94a4869c28.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in Document Capture, from document upload or camera capture, to document validation, processing, feedback, and final submission.

<Image align="center" src="https://developer.incode.com/assets/c68bc1691023b085f81cd826131d4330.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the document is captured successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user selects the upload method, captures the file, follows the guidance provided, and submits a clear, readable, and fully visible document without requiring retries or corrections. Both light and dark mode previews are included so teams can validate visual consistency across themes.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/011b12981c8ab0c0c0cba642015d563d.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/b38b4df28aafd71d854d03a778c1fa15.png" />

<br />

***

## Best Practices

<br />

Recommended guidelines for designing and implementing the **Document Capture** experience.

**✅ Do**

Keep instructions short and easy to understand.

Provide clear guidance for framing and positioning the document correctly.

Allow users to retry whenever a capture or upload fails.

Support both upload and camera capture flows consistently when applicable.

**❌ Don’t**

Don’t rely solely on color to communicate status or feedback.

Don’t crop, obscure, or cover important document information.

Don’t skip or reduce essential error and validation states.

---

- Path: `design-and-ux/document-capture-screens-states`
- URL: https://developer.incode.com/design-and-ux/document-capture-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/document-capture-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the Document Capture experience. Each state includes a brief description and a direct link to its source in Figma.



***

## Document Capture Tutorial

The tutorial screen introduces the document capture process. Depending on the available verification methods, the screen may display both capture and upload options, or only a single available method for the user.

<Image align="center" src="https://developer.incode.com/assets/bfdc8b7f0e50bbea2124f3e9d9d457a2.png" />

<br />

## Document Verification Method

This screen allows users to select the method they will use to verify their document.

The selection modal is available on both web and native platforms. On native, users can choose between taking a photo, selecting an image from the camera roll, or choosing a file from the device storage. On web, users are presented with capture and upload options, as the native system modal is displayed afterwards to complete the selection flow.

<Image align="center" src="https://developer.incode.com/assets/601f766c7daacb4a8c1be7d3650ed8ba.png" />

<br />

## Permission Screens

Shown when camera permissions have not been granted. Includes pre-permission context, OS-specific instructions, and fallback steps if the system dialog is dismissed.

<Image align="center" src="https://developer.incode.com/assets/c6a5543635285bd1080d4b618a87e202.png" />

<br />

## Capture Screen

Shown during the document capture process. Users are prompted to position their document within the frame and press the capture button once the document is fully visible. A help button is also available if additional guidance is needed.

<Image align="center" src="https://developer.incode.com/assets/fa9b289e957932718bce708f5799e64b.png" />

<br />

## Common Issues

Shown by tapping on the help icon of the Capture Screen, when users need additional guidance. This screen highlights common capture issues, such as blurry images, glare, shadows, or documents being out of frame, helping users take the photo correctly and avoid verification issues afterwards.

<Image align="center" src="https://developer.incode.com/assets/bccb4a8cf04eb8eeca3f1b5ab84ddf63.png" />

<br />

## Capture Review Screen

Shown after a document has been captured or uploaded, allowing users to review the image before continuing. Users may proceed to the next step or replace the image by recapturing or reuploading the document.

<Image align="center" src="https://developer.incode.com/assets/f2eda8d6f249e840f8b3d9a9ba2d56ce.png" />

<br />

## Image Upload Screens

Shown after the user confirms the captured document and continues with the verification flow. These screens communicate the upload and success states, providing feedback while the document is being processed before moving to the next step.

<Image align="center" src="https://developer.incode.com/assets/bfa50b55bd10e75b0a5442649c6f1461.png" />

<br />

## Upload Review Screen

Shown after the user uploads a document and continues with the verification flow. This screen allows users to review the selected file before proceeding, displaying a small preview of the document along with the file name to confirm the correct file was chosen.

<Image align="center" src="https://developer.incode.com/assets/c890388a34bf962f015aeecd9b0d8b8c.png" />

<br />

## File Upload Screens

Shown after the user uploads and confirms a file to continue with the verification flow. These screens communicate the upload and success states, providing feedback while the file is being processed before moving to the next step.

<Image align="center" src="https://developer.incode.com/assets/0078c9ead6051558a342dff5a75d7b1f.png" />

<br />

## Consecutive Pages Tutorial

Shown when the document requires additional pages or supporting information to complete the verification process. Depending on the flow configuration, users may be required to continue with the next page or optionally add more information before proceeding.

<Image align="center" src="https://developer.incode.com/assets/56de3ff9ddcbf5fe6221fc5174f4f4c1.png" />

<br />

## Error

Shown when the document capture process fails or the uploaded image cannot be processed. Users may retry the capture flow, with 3 attempts available by default before the flow is considered unsuccessful.

<Image align="center" src="https://developer.incode.com/assets/4cd28752b6e153dbeec4e6abdd96b4d2.png" />

<br />

## Connection Error

Displays when connectivity is lost during capture or upload. Users can retry once a stable connection is restored.

<Image align="center" src="https://developer.incode.com/assets/2c1f93d30ddb72ed2a43cb35932dfe2d.png" />

---

- Path: `design-and-ux/document-capture-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/document-capture-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/document-capture-specs-guidelines.md

# Specs & Guidelines

The **Document Capture** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/d2223fe2a6bad2757efbcab5757d0cf4.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Document Capture** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas, such as the silhouette, capture instructions, and CTAs. remain visible, accessible, and properly aligned across platforms.

<Image align="center" src="https://developer.incode.com/assets/44b8013c3ee02d49a43ac33fe6ca038b.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                   |
| ---------------------------------- | ------------------------------------------------------------------------------ |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; illustration scales down to maintain visibility |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                     |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; instructions remain pinned above CTA        |
| **Foldables (e.g., Pixel Fold)**   | Larger visual and more balanced white space; content remains centered          |
| **Tablets**                        | Increased layout margins; visual scales proportionally                         |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding        |

<br />

### What is responsive (and customizable)

| **Element**                    | **Responsive Behavior**                                            | **Customizable**                                |
| ------------------------------ | ------------------------------------------------------------------ | ----------------------------------------------- |
| Document frame / guidance area | Scales proportionally by viewport height and document aspect ratio | Color only (size and detection logic are fixed) |
| Instruction text               | Reflows to one or two lines depending on width                     | Text is fully localizable                       |
| Buttons                        | Width adjusts to container, vertical spacing adapts                | Color & text                                    |
| Footer / watermark             | Pinned to bottom safe area                                         | Optional                                        |
| Background surfaces            | Expand to full viewport                                            | Yes                                             |
| Header area                    | Scales padding according to device safe insets                     | Limited (color only)                            |

<br />

### What remains fixed across breakpoints

| **Element**               | **Reason**                                 |
| ------------------------- | ------------------------------------------ |
| Capture logic & detection | Must remain consistent for accuracy        |
| Capture frame proportions | Crucial for document alignment guidance    |
| Minimum text size         | Required for readability & WCAG compliance |
| Minimum tap target sizes  | Ensures accessibility on mobile            |
| Overall hierarchy         | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The document guidance frame always remains the dominant visual element, regardless of screen size or document type.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/f9c1bce6eb3f34f70cb0205a2344bf35.png" />

<br />

<br />

***

## Prototype & Transitions

Document Capture includes predefined transition rules and micro-interactions that ensure a smooth user experience across tutorial, capture, uploading, and error flows. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/e1f1fcf10d90706d7efdf26fc7a1ab05.gif" />

<br />

<br />

***

## Localization

The **Document Capture** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/26778faf66ea8ce5e451a0c5e715aae9.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/document-capture-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/document-capture-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/document-capture-v1-vs-v2-comparison.md

# Document Capture V1 vs V2 Comparison

<br />

In V1, Document Capture offers a basic experience for the user to capture or upload the document. The camera view has a document overlay for the user to use as a guide, but it may not reflect exactly the format that the user needs to upload. Guidance is limited, and tutorials can sometimes become redundant to users. Customization and behavior can vary.

In V2, Document Capture has refined tutorials that clearly communicate to users what’s expected to complete the process. The camera view has a larger frame without any overlay so the user doesn’t have any distractions. Common issues screens was also refined for clarity, among other steps from the experience that have been reviewed and improved. The UI is cleaner, transitions are smoother, and customization follows a unified UXv2 system, making the flow more predictable and easier to complete.

<br />

<Image align="center" caption="V1 is a basic face capture experience with limited guidance." src="https://developer.incode.com/assets/4d759f2a1cb5e36577726fd93cf1cbfd.png" />

<br />

<Image align="center" caption="V2 is a guided, step-by-step face capture experience with live instructions and clear visual feedback." src="https://developer.incode.com/assets/7a2375c562b4f99d37b95bfb232c0ed1.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities                   | V1 | V2 | Notes                                                                                                                            |
| ------------------------------ | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Manually capture document      | ✅  | ✅  | V2 has a larger capture frame, and introduced instructions to the capture screen for clarity.                                    |
| Upload methods supported       | ✅  | ✅  | Both versions allow the user to choose the upload method and they can be configured.                                             |
| Common Issues                  | ✅  | ✅  | V2 refined the issues displayed and the content for clarity, so users can get a good capture.                                    |
| Dedicated second page tutorial | ❌  | ✅  | V2 has a dedicated tutorial for cases where the user may need to capture following pages.                                        |
| Error States                   | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                |
| Customization options          | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness     | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior             | V1                                                            | V2                                                                | Notes                                                                                                                                           |
| -------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Tutorial behavior    | Basic visual of standard document layout                      | Straightforward and minimal tutorial                              | V2 is intuitive and directs the focus towards the tutorial instructions.                                                                        |
| Multi-page capturing | It repeats the full module unchanged to capture a second page | Dedicated tutorials for the capture of consecutive pages          | V2 features dedicated screens for capturing consecutive pages, complete with tutorials for both optional and mandatory steps.                   |
| State transitions    | Default transitions                                           | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package.                                                                  |
| Capture experience   | Native camera experience                                      | Custom camera view with instructions and common issues            | V2 uses a custom camera experience with instruction text, an overlay for positioning guidance, and access to a help section for better capture. |

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/1431272beefbb80d9133de99037b1ec2.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

**For full details, visit the [Customization](/design-and-ux/document-capture-customization/) tab of this module.**

<br />

<br />

---

- Path: `design-and-ux/dropdown`
- URL: https://developer.incode.com/design-and-ux/dropdown/
- Markdown: https://developer.incode.com/design-and-ux/dropdown.md

# Dropdown

Dropdowns allow users to select a single option from a collapsible list. Used for document types, country selection, and other enumerated choices where a radio group would be too long.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-field"><span style="color:#82879a">Select country</span><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Closed</span><code>.dropdown</code><p>The field shows the placeholder or the current selection, with a chevron affordance.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-menu"><span>Mexico</span><span class="is-selected">Colombia</span><span>Brazil</span></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Open</span><code>.dropdown.is-open</code><p>The menu lists the options; the selected item is highlighted.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-field"><span>Colombia</span><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#189f6014;color:#189f60">Selected</span><code>.dropdown.has-value</code><p>After choosing, the field shows the value in full text color.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--dropdown-surface | Field background | Component
--dropdown-border-default | Border — rest | Component
--dropdown-border-open | Border — open state | Component
--dropdown-text-default | Selected text color | Component
--dropdown-text-placeholder | Placeholder text color | Component
--dropdown-chevron | Chevron icon color | Component
--radius-dropdown | Corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/ekyb-design`
- URL: https://developer.incode.com/design-and-ux/ekyb-design/
- Markdown: https://developer.incode.com/design-and-ux/ekyb-design.md

# eKYB

The **eKYB&#x20;**&#x56;erification module collects business identity information and validates it against official corporate registries and regulatory databases to confirm the legitimacy of a legal entity. It enables compliant, real-time business verification within onboarding and regulatory flows.

Designed to be structured and secure, the module manages logic, processing states, and verification outcomes with clear system feedback.


<Image src="https://developer.incode.com/assets/f874d58bce6325ffb988b49581c1fd3c.gif" align="center" />


***

## Where it fits in the flow

**eKYB** Verification is positioned after initial business representative data collection (such as email or phone verification) and before advanced verification modules, depending on the configured onboarding flow.

***

## User Flow

The eKYB Verification experience guides users through structured data entry and backend validation.


<Image src="https://developer.incode.com/assets/564aca416b229747c19fb87ae8964313.png" align="center" />


<br />

***

## Full Flow Map

This diagram outlines the end-to-end screen sequence of the eKYB Verification module, including data input, validation states, and the success outcome.


<Image src="https://developer.incode.com/assets/6fe2e99e1a9eafa5c7793701138d9010.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when business information is submitted and verified successfully against official records without interruptions.
The happy path represents the smoothest version of the experience: the user completes all required business fields accurately (such as legal entity name, registration number, and jurisdiction), submits the form, and the system validates the information against corporate registries without mismatches or delays. The processing state resolves successfully on the first attempt, and the user reaches the confirmation screen without needing to retry or correct any data.
Light and dark mode previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.


<Image src="https://developer.incode.com/assets/ca5f3ae0405886526c4dbf988a965bc5.png" align="center" caption="Light mode" />



<Image src="https://developer.incode.com/assets/138677fc7e2afdef90cafb5ee381d34d.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the eKYB Verification experience.

✅ Do

- Keep the form structured, clean, and easy to scan.
- Use inline validation to prevent submission errors.
- Clearly indicate required fields and input formats.
- Preserve user-entered data if verification fails.
- Provide clear feedback during the processing state.

❌ Don’t

- Don’t delay validation until after submission.
- Don’t erase completed fields after backend errors.
- Don’t allow duplicate submissions while processing.

<br />

---

- Path: `design-and-ux/ekyc-design`
- URL: https://developer.incode.com/design-and-ux/ekyc-design/
- Markdown: https://developer.incode.com/design-and-ux/ekyc-design.md

# eKYC

The [eKYC module](/features-and-modules/ekyc/) collects user identity information and validates it against official records to confirm identity authenticity. It enables compliant, real-time identity verification within onboarding and regulatory flows.

This module is designed to be structured and secure. The module manages logic, processing states, and verification outcomes with clear system feedback.


![KYC Prototype](https://developer.incode.com/assets/c05f497d-3fd8-43b2-a710-ef09b8c1fe0b.gif)



***

## Where it fits in the flow

eKYC Verification is positioned after initial user data collection (such as phone or email verification) and before advanced verification modules (including document capture or biometric checks), depending on the configured onboarding flow.

***

## User Flow

The eKYC Verification experience guides users through structured data entry and backend validation.

<Image align="center" src="https://developer.incode.com/assets/618838db-a800-4d7e-9fb9-23f666bdf447.png" />

<br />

***

## Full Flow Map

This diagram outlines the end-to-end screen sequence of the eKYC Verification module, including data input, validation states, and the success outcome.

<Image align="center" src="https://developer.incode.com/assets/1873e4e9-ab88-4cfc-a756-dfeafa77460b.png" />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when identity information is submitted and verified successfully without interruptions.

The happy path represents the smoothest version of the experience: the user completes all required fields accurately, submits the form, and the system validates the information without mismatches or delays. The processing state resolves successfully on the first attempt, and the user reaches the confirmation screen without needing to retry or correct any data.

Light and dark mode previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/01f5385b-e07f-42a1-be55-79a23358e3bb.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/a4505bde-bf8c-4f24-a831-e47a6d218edf.png" />

***

## Best Practices

Recommended guidelines for designing and implementing the eKYC Verification experience.

✅ **Do**

* Keep the form structured, clean, and easy to scan.
* Use inline validation to prevent submission errors.
* Clearly indicate required fields and input formats.
* Preserve user-entered data if verification fails.
* Provide clear feedback during the processing state.

❌ **Don’t**

* Don’t delay validation until after submission.
* Don’t erase completed fields after backend errors.
* Don’t allow duplicate submissions while processing.

---

- Path: `design-and-ux/electronic-signature-design`
- URL: https://developer.incode.com/design-and-ux/electronic-signature-design/
- Markdown: https://developer.incode.com/design-and-ux/electronic-signature-design.md

# Electronic Signature

**Electronic Signature** is a key step in onboarding and agreement workflows. It lets users draw their signature directly on screen using a finger or mouse. The module provides a clean signing canvas with the option to clear and redo, and a confirmation step to ensure the signature is captured accurately.

<Image align="center" src="https://developer.incode.com/assets/8e402d5ee7f50e6f0d47a82a48ec66e0.gif" />

***

## Where it fits in the flow

**Electronic Signature** is typically positioned at the end of an onboarding or verification flow, after identity and document checks have been completed, depending on the configured workflow.

***

## User Flow

The **Electronic Signature** experience guides users through a simple signature capture, review, and confirmation process.

<Image align="center" src="https://developer.incode.com/assets/acc83c8e6d81ed304eacedf1fba0760d.png" />

<br />

***

## Full Flow Map

<Image align="center" src="https://developer.incode.com/assets/5dd4100404e011cf0ee58370afe70331.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the signature is drawn and captured successfully without interruptions.

**The happy path** represents the smoothest version of the experience: the user draws their signature on the canvas, reviews it, taps "Done," and the system captures and confirms the signature on the first attempt. The user reaches the success screen without needing to clear and redraw or encountering any errors.

**Light and dark mode** previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/049c48b232f65f87fd9029ed01193d52.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/65feb666125b0c43dd28497834bbd266.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Electronic Signature experience**

✅ Do

* Keep the signature canvas clean, spacious, and easy to interact with on all screen sizes.
* Disable the "Done" button until a signature stroke is detected on the canvas.
* Provide a clear "Clear canvas" option so users can easily redo their signature.
* Give immediate visual feedback when the signature is being captured and processed.
* Ensure the canvas is responsive and works well with both finger and mouse input.

❌ Don't

* Don't allow submission of an empty canvas.
* Don't allow duplicate submissions by leaving the "Done" button active while processing.

---

- Path: `design-and-ux/elevation`
- URL: https://developer.incode.com/design-and-ux/elevation/
- Markdown: https://developer.incode.com/design-and-ux/elevation.md

# Elevation

Five levels of depth, each with a fixed shadow recipe and a clear job. Elevation communicates what floats above what — it is never decoration.

<Tabs>
<Tab title="Overview">

## Shadow scale

```dh-strip
kind: elevation
desc: Shown on a light background — shadows are visible against white.
Flat | --shadow-none | none
Low | --shadow-sm | 0 1px 2px rgba(0,0,0,0.06), 0 1px 3px rgba(0,0,0,0.10)
Mid | --shadow-md | 0 4px 8px rgba(0,0,0,0.08), 0 2px 4px rgba(0,0,0,0.06)
High | --shadow-lg | 0 8px 24px rgba(0,0,0,0.12), 0 4px 8px rgba(0,0,0,0.08)
Overlay | --shadow-xl | 0 20px 48px rgba(0,0,0,0.18), 0 8px 16px rgba(0,0,0,0.10)
```

```dh-principles
#006aff | Shadow signals hierarchy | Higher elevation = more visual weight = content that demands attention. Every level is intentional — don't use Overlay for a tooltip.
#189f60 | Flat uses border, not faint shadow | Flat surfaces are separated by a 1px border token, not a subtle shadow. Faint shadows are hard to control across light and dark modes.
#ff9900 | Dark mode lifts the surface | In dark mode, elevation is often communicated by lightening the surface color — not deepening the shadow. Tokens handle this automatically.
```

</Tab>
<Tab title="Scale">

```dh-elevation
Flat | Elevation.0 · --shadow-none | none | No shadow. Distinguish with a 1px border instead.
Low | Elevation.1 · --shadow-sm | 0 1px 2px rgba(0,0,0,0.06), 0 1px 3px rgba(0,0,0,0.10) | Subtle lift. Interactive or slightly raised surfaces without strong hierarchy.
Mid | Elevation.2 · --shadow-md | 0 4px 8px rgba(0,0,0,0.08), 0 2px 4px rgba(0,0,0,0.06) | Moderate depth. Standard elevation for floating elements and focused surfaces.
High | Elevation.3 · --shadow-lg | 0 8px 24px rgba(0,0,0,0.12), 0 4px 8px rgba(0,0,0,0.08) | Strong depth. Content sits significantly above the base surface.
Overlay | Elevation.4 · --shadow-xl | 0 20px 48px rgba(0,0,0,0.18), 0 8px 16px rgba(0,0,0,0.10) | Maximum elevation. Reserved for full-screen overlays and blocking surfaces.
```

</Tab>
<Tab title="Usage">

```dh-usage
Flat | Elevation.0 | No shadow. Distinguish with a 1px border instead. | Default cards, List items, Table rows, Input fields
Low | Elevation.1 | Subtle lift. Interactive or slightly raised surfaces without strong hierarchy. | Hover state cards, Sticky table headers, Inline action menus
Mid | Elevation.2 | Moderate depth. Standard elevation for floating elements and focused surfaces. | Dropdown menus, Popovers, Focused cards, Tooltips
High | Elevation.3 | Strong depth. Content sits significantly above the base surface. | Modals, Dialogs, Side drawers, Command palettes
Overlay | Elevation.4 | Maximum elevation. Reserved for full-screen overlays and blocking surfaces. | Full-screen modals, Bottom sheets, Context menus with backdrops
```

</Tab>
</Tabs>

---

- Path: `design-and-ux/email-input-customization`
- URL: https://developer.incode.com/design-and-ux/email-input-customization/
- Markdown: https://developer.incode.com/design-and-ux/email-input-customization.md

# Customization

This section outlines the elements you can customize within the **Email Input** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

<br />

## Empty Form Screen

Initial state of the module. The email field is empty, validation hasn’t run yet, and Continue is disabled until a valid format is entered.

<Image align="center" src="https://developer.incode.com/assets/4140e0bec8ce0beff8edfd92af930144.png" />

<br />

### Customizable Elements

| **Area**                      | **What can be customized**        | **Notes**                                         |
| :---------------------------- | :-------------------------------- | :------------------------------------------------ |
| **Text**                      | Title, subtitle, button label     | Fully localizable; keep succinct for scanability  |
| **Email Input (Idle)**        | Border, surface, placeholder text | Maintain clear contrast with focused/error states |
| **Close Icon**                | Color                             | Should remain subtle vs. brand accents            |
| **Primary Button (Disabled)** | Label and disabled colors         | Must remain visually distinct from enabled state  |
| **Brand Colors**              | Header, accents                   | Use existing brand tokens to ensure consistency   |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                                     |
| :------------------------- | :------------------------------------------------------ |
| Layout structure & spacing | Ensures cross-module consistency and predictable rhythm |
| Input height & radius      | Standardized for touch ergonomics and familiarity       |
| Button placement           | Keeps spatial consistency through all states            |
| WCAG minimum contrast      | Mandatory for accessibility compliance                  |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/d17bab7187be7e271a64db3518d95616.png" />

| **UI Element**               | **Token**                         | **Raw Value** |
| :--------------------------- | :-------------------------------- | :------------ |
| Title text                   | `text-body-primary`               | `#262831`     |
| Subtitle text                | `text-body-secondary`             | `#60667C`     |
| Email input border (idle)    | `input-border-default`            | `#EBECEF`     |
| Email input surface (idle)   | `input-surface-default`           | `#FCFCFD`     |
| Email input placeholder      | `input-text-field-placeholder`    | `#A3A8B8`     |
| Email input text             | `input-text-field-default`        | `#262831`     |
| Button background (disabled) | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)       | `button-primary-text-disabled`    | `#A3A8B8`     |
| Background surface           | `surface-neutral-0`               | `#FFFFFF`     |

<br />

### Design Notes

* If customizing text, ensure clarity and brevity (e.g., “Enter your email” instead of “Please provide your email address”).
* When adjusting button color, maintain strong contrast for accessibility.

<br />

***

## Focused Input Screen

State when the user is actively typing and the email format is valid. The input shows a focused style and "Continue" button becomes enabled.

<Image align="center" src="https://developer.incode.com/assets/80c2add322b8f500a3044c17f9af83da.png" />

<br />

### Customizable Elements

| **Area**                     | **What can be customized**          | **Notes**                               |
| :--------------------------- | :---------------------------------- | :-------------------------------------- |
| **Text**                     | Title, subtitle, button label       | Fully localizable; keep concise         |
| **Email Input (Focused)**    | Border, surface, caret, placeholder | Must keep high contrast vs. idle/error  |
| **Close Icon**               | Color                               | Remains secondary to brand accents      |
| **Primary Button (Enabled)** | Label and background/text colors    | Use brand primary; ensure WCAG contrast |

<br />

### Fixed Elements

| **Element**                   | **Why it is fixed**                           |
| :---------------------------- | :-------------------------------------------- |
| Input height, radius, spacing | Touch ergonomics and cross-module consistency |
| Button placement              | Spatial predictability across states          |
| WCAG minimum contrast         | Required for certification and compliance     |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/b70eb36432a8221cb1daa47872247066.png" />

| **UI Element**                | **Token**                        | **Raw Value** |
| :---------------------------- | :------------------------------- | :------------ |
| Title text                    | `text-body-primary`              | `#262831`     |
| Subtitle text                 | `text-body-secondary`            | `#60667C`     |
| Email input border (focused)  | `input-border-focused`           | `#006AFF`     |
| Email input surface (focused) | `input-surface-focused`          | `#FCFCFD`     |
| Email input text              | `input-text-field-default`       | `#262831`     |
| Email input placeholder       | `input-text-field-placeholder`   | `#A3A8B8`     |
| Button background (enabled)   | `button-primary-surface-default` | `#006AFF`     |
| Button text (enabled)         | `button-primary-text-default`    | `#FFFFFF`     |
| Background surface            | `surface-neutral-0`              | `#FFFFFF`     |

<br />

### Design Notes

* You can adjust the focus color to match your brand, but ensure it remains visually distinct from error states.
* If modifying typography, preserve visual differences between title, subtitle, and input to maintain clarity.
* Always test your custom color scheme in light and dark modes for accessibility consistency.

<br />

***

## OTP Entry Screen (Focused State)

This screen appears after the user enters their email and the system sends a one-time passcode (OTP) to this email.

The user is prompted to enter the 6-digit verification code in a single input field. As the field gains focus, the border and surface adapt to indicate active interaction. A countdown below the button communicates when the user can resend the code.

<Image align="center" src="https://developer.incode.com/assets/8f18b24121e59f53e9bc8a353a8c4d14.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**             | **Notes**                                                      |
| :------------------- | :------------------------------------- | :------------------------------------------------------------- |
| **Text**             | Title, helper text, countdown label    | Fully localizable; supports dynamic values (e.g., countdown)   |
| **OTP Fields**       | Border and text color in focused state | Must maintain accessibility contrast and clarity               |
| **Buttons**          | Label, color states (disabled/enabled) | Must meet WCAG 2.1 contrast requirements                       |
| **Resend Code Text** | Color, hover/press state               | Uses tertiary text token, consistent with interaction patterns |
| **Brand Colors**     | Primary accent and focus color         | Derived from `brand-500` and related tokens                    |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Input field layout    | Ensures consistency across all OTP verification steps |
| Field spacing         | Optimized for readability and tap accuracy            |
| Countdown behavior    | Fixed duration to standardize retry experience        |
| Button placement      | Standard alignment for visual rhythm and reachability |
| Typography hierarchy  | Maintains cross-platform readability                  |
| WCAG minimum contrast | Required for accessibility certification              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/4b2ddb2ec047eb3cdf858a29abc6150a.png" />

| **UI Element**               | **Token**                         | **Raw Value** |
| :--------------------------- | :-------------------------------- | :------------ |
| Title text                   | `text-body-primary`               | `#262831`     |
| OTP input border (focused)   | `input-border-focused`            | `#006AFF`     |
| OTP input surface (focused)  | `input-surface-focused`           | `#FCFCFD`     |
| OTP input text               | `input-text-field-default`        | `#262831`     |
| Button background (disabled) | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)       | `button-primary-text-disabled`    | `#A3A8B8`     |
| Countdown text               | `text-body-secondary`             | `#60667C`     |
| Resend link                  | `button-tertiary-text-disabled`   | `#60667C`     |
| Background surface           | `surface-neutral-0`               | `#FFFFFF`     |

<br />

### Design Notes

* You can adjust the focus color to match your brand, but ensure it remains visually distinct from error states.
* If modifying typography, preserve visual differences between title, subtitle, and input to maintain clarity.
* Always test your custom color scheme in light and dark modes for accessibility consistency.

<br />

***

## OTP Checking (Verification Loading) Screen

This screen represents the verification state of the OTP. After the user submits the one-time passcode (OTP), the system verifies the input. The interface locks input fields and transitions the button to a loading spinner, indicating that validation is in progress.
During this state, interaction is temporarily disabled until the verification completes.

<Image align="center" src="https://developer.incode.com/assets/1001407352bfed0b2d8c3941800ac875.png" />

<br />

### Customizable Elements

| **Area**                        | **What can be customized**          | **Notes**                                           |
| :------------------------------ | :---------------------------------- | :-------------------------------------------------- |
| **Text**                        | Title and helper text               | Fully localizable; tone can be adapted              |
| **OTP Fields (Disabled)**       | Border, background, and text color  | Should visually indicate a non-editable state       |
| **Buttons**                     | Spinner color, background, and text | Spinner inherits brand color for visual consistency |
| **Resend / Change Number Text** | Color and link state                | Uses tertiary text token                            |
| **Brand Colors**                | Button and header accents           | Derived from `brand-...` tokens                     |

<br />

### Fixed Elements

| **Element**              | **Why it is fixed**                                        |
| :----------------------- | :--------------------------------------------------------- |
| Layout structure         | Ensures consistency across all verification states         |
| Button position          | Aligned for accessibility and predictable interaction flow |
| Input layout and spacing | Maintains readability during transition states             |
| Loading spinner size     | Standardized for cross-platform consistency                |
| Typography hierarchy     | Maintains readability and balance                          |
| WCAG minimum contrast    | Ensures accessible visual design                           |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/3934421800c588170562cbfbc0244495.png" />

| **UI Element**               | **Token**                        | **Raw Value** |
| :--------------------------- | :------------------------------- | :------------ |
| Title text                   | `text-body-primary`              | `#262831`     |
| OTP input border (disabled)  | `input-border-disabled`          | `#EBECEF`     |
| OTP input surface (disabled) | `input-surface-disabled`         | `#EBECEF`     |
| OTP input text (disabled)    | `input-text-field-disabled`      | `#A3A8B8`     |
| Spinner accent               | `surface-brand-400-static`       | `#3388FF`     |
| Button background (loading)  | `button-primary-surface-default` | `#006AFF`     |
| Button text (loading)        | `button-primary-text-default`    | `#FFFFFF`     |
| Resend / Change Email text   | `button-tertiary-text-disabled`  | `#60667C`     |
| Background surface           | `surface-neutral-0`              | `#FFFFFF`     |

<br />

### Design Notes

* If modifying color schemes, ensure that disabled input states remain visibly distinct.

<br />

***

## Processing Screen

This optional screen appears after the OTP verification is completed and before the module transitions to a success or failure state.
It communicates that the system is finalizing the verification process, providing visual feedback to assure the user that progress is ongoing.

<Image align="center" src="https://developer.incode.com/assets/ba704cce77ef0de0f0c5c81a0ed531c2.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**              | **Notes**                                                     |
| :--------------- | :-------------------------------------- | :------------------------------------------------------------ |
| **Text**         | Loading message (e.g., “Processing...”) | Fully localizable; keep short and neutral                     |
| **Spinner**      | Color, animation speed                  | Must use brand color for recognition; avoid slowing animation |
| **Background**   | Color and safe area padding             | Maintain contrast and visual calmness                         |
| **Brand Colors** | Header and spinner accent               | Should use primary brand token for consistency                |

<br />

### Fixed Elements

| **Element**       | **Why it is fixed**                              |
| :---------------- | :----------------------------------------------- |
| Spinner placement | Centralized for visual focus and balance         |
| Animation timing  | Consistent across all processing states in SDK   |
| Typography size   | Maintains clear hierarchy and visual stability   |
| Button removal    | Reduces confusion during non-interactive state   |
| Layout rhythm     | Matches other module loading states for cohesion |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/ed5a0c406298d39e64d88d349d8343d4.png" />

| **UI Element**             | **Token**                   | **Raw Value** |
| :------------------------- | :-------------------------- | :------------ |
| Spinner accent (primary)   | `spinner-surface-primary`   | `#006AFF`     |
| Spinner accent (secondary) | `spinner-surface-secondary` | `#E5F0FF`     |
| Title text                 | `spinner-text-title`        | `#262831`     |
| Background surface         | `surface-neutral-0`         | `#FFFFFF`     |

<br />

### Design Notes

* Keep the text short; don’t include instructions or next steps here.
* If using customized colors, ensure they don’t reduce the contrast of the spinner icon.

<br />

***

## Success Screen

This screen appears after the user’s email has been successfully verified.
It provides a clear confirmation of success before the flow transitions to the next module or completion step.
The layout is intentionally minimal to maintain focus on the success feedback.

<Image align="center" src="https://developer.incode.com/assets/ae3e6cbabd9ad9a8c3a3be3782c83be9.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                     | **Notes**                                                                            |
| :--------------- | :--------------------------------------------- | :----------------------------------------------------------------------------------- |
| **Text**         | Confirmation message (e.g., “Email verified!”) | Fully localizable; tone should remain concise and positive                           |
| **Success Icon** | Color, animation                               | Should use the positive status color token; simple checkmark animation is acceptable |
| **Brand Colors** | Header and accent                              | Must align with overall brand identity while maintaining readability                 |
| **Background**   | Color                                          | Keep high contrast for the icon and message                                          |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                     |
| :--------------------- | :------------------------------------------------------ |
| Layout structure       | Ensures consistent feedback presentation across modules |
| Icon size and position | Optimized for recognition and accessibility             |
| Text alignment         | Central alignment for visual balance                    |
| Typography hierarchy   | Maintains brand consistency and readability             |
| WCAG minimum contrast  | Required for accessibility compliance                   |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/536c51a3349b4e6eb7097c7d4268c80d.png" />

| **UI Element**     | **Token**              | **Raw Value** |
| :----------------- | :--------------------- | :------------ |
| Title text         | `text-body-primary`    | `#262831`     |
| Success icon       | `icon-status-positive` | `#189F60`     |
| Icon background    | `icon-neutral-0`       | `#FFFFFF`     |
| Background surface | `surface-neutral-0`    | `#FFFFFF`     |

<br />

### Design Notes

* Keep the confirmation text short and positive; don’t include instructions or next steps here.
* If using customized colors, ensure they don’t reduce the contrast of the success message or icon.

<br />

***

## OTP Error Screen

This screen appears when the user enters an incorrect or expired code.
It provides immediate visual feedback through red highlight states and an error message.
The interface allows the user to resend the code or change their email before attempting verification again.

<Image align="center" src="https://developer.incode.com/assets/8ed8bead7690900eb7a5d6680e83a54e.png" />



### Customizable Elements

| **Area**                          | **What can be customized**     | **Notes**                                             |
| :-------------------------------- | :----------------------------- | :---------------------------------------------------- |
| **Text**                          | Error message and helper text  | Fully localizable; keep concise and polite tone       |
| **Input Fields (Error)**          | Border, background, text color | Must maintain strong color contrast for accessibility |
| **Error Icon**                    | Color                          | Uses negative (error) status color token              |
| **Buttons**                       | Label, color state             | Maintain clear disabled and active visual distinction |
| **Links (Resend / Change Email)** | Color and hover states         | Use brand accent color for recognition                |
| **Brand Colors**                  | Header and accents             | Should align with existing brand color tokens         |



### Fixed Elements

| **Element**                   | **Why it is fixed**                           |
| :---------------------------- | :-------------------------------------------- |
| Layout structure              | Maintains consistency across OTP states       |
| Input field shape and spacing | Optimized for error visibility                |
| Button placement              | Standardized for user familiarity             |
| Typography hierarchy          | Preserves consistent hierarchy and legibility |
| Error message position        | Fixed to align directly below input fields    |
| WCAG minimum contrast         | Required for accessibility compliance         |



### Token Reference

<Image align="center" src="https://developer.incode.com/assets/56ac3304a52091c31105faecabc3192a.png" />

| **UI Element**                | **Token**                         | **Raw Value** |
| :---------------------------- | :-------------------------------- | :------------ |
| Title text                    | `text-body-primary`               | `#262831`     |
| Error border                  | `input-border-negative`           | `#E71111`     |
| Error surface                 | `input-surface-negative`          | `#EBECEF`     |
| Error text                    | `input-text-helper-negative`      | `#E71111`     |
| Error icon                    | `input-icon-negative`             | `#E71111`     |
| Input text (default)          | `input-text-field-default`        | `#262831`     |
| Button background (disabled)  | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)        | `button-primary-text-disabled`    | `#A3A8B8`     |
| Links (Resend / Change Email) | `button-tertiary-text-default`    | `#006AFF`     |
| Background surface            | `surface-neutral-0`               | `#FFFFFF`     |



### Design Notes

* Error messaging should remain concise — don’t overload users with explanations.
* Avoid replacing the red border with icons alone; border color communicates immediacy effectively.

<br />

***

## Failure Screen

This screen appears when a critical issue prevents the verification process from completing — for example, a timeout, or unexpected backend failure.
It reassures the user with clear feedback and offers a “Try again” action to quickly restart the verification flow.

<Image align="center" src="https://developer.incode.com/assets/02581cdcb97659f5ee57e9a4054ded38.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**    | **Notes**                                                       |
| :------------------- | :---------------------------- | :-------------------------------------------------------------- |
| **Text**             | Heading and button label      | Fully localizable; tone should remain calm and neutral          |
| **Error Icon**       | Color, size, animation        | Should use negative color token; avoid using motion-heavy icons |
| **Button (Primary)** | Label, background, text color | Use brand accent for consistency; maintain high contrast        |
| **Brand Colors**     | Header, accent                | Must match brand token palette                                  |
| **Background**       | Color                         | Maintain sufficient contrast for visibility and focus           |

<br />

### Fixed Elements

| **Element**             | **Why it is fixed**                                          |
| :---------------------- | :----------------------------------------------------------- |
| Layout and spacing      | Consistent centered hierarchy across all result states       |
| Icon and text alignment | Ensures immediate clarity and minimal scanning effort        |
| Typography weight       | Reinforces error hierarchy; avoids visual noise              |
| Button placement        | Fixed below feedback message to preserve spatial consistency |
| WCAG minimum contrast   | Required for accessibility compliance                        |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/86b185a1d9d9b3b30480d761a1ca5582.png" />

| **UI Element**              | **Token**                        | **Raw Value** |
| :-------------------------- | :------------------------------- | :------------ |
| Title text                  | `text-body-primary`              | `#262831`     |
| Error icon                  | `icon-status-negative`           | `#E71111`     |
| Button background (primary) | `button-primary-surface-default` | `#006AFF`     |
| Button text                 | `button-primary-text-default`    | `#FFFFFF`     |
| Background surface          | `surface-neutral-0`              | `#FFFFFF`     |



### Design Notes

* Error messaging should remain concise — don’t overload users with extra details.
* Avoid specifying is details whether the error is due to network, validation, or server issues to prevent potential reverse-engineering attempts by fraudsters.

---

- Path: `design-and-ux/email-input-design`
- URL: https://developer.incode.com/design-and-ux/email-input-design/
- Markdown: https://developer.incode.com/design-and-ux/email-input-design.md

# Email Input

The **Email Input** module allows users to verify their email address by entering it and confirming a one-time passcode (OTP) sent to their inbox. This module ensures email ownership, a key step in identity verification and account activation flows. It is designed for clarity, speed, and accessibility — optimized for both native and web environments.

<Image align="center" src="https://developer.incode.com/assets/f1c3d156e20b3a6c8469cb23e72c006a.gif" />

***

## Where it fits in the flow

**Email Input** typically appears early in the onboarding or verification process, often as an alternative or complement to Phone Number Input.

Once the user confirms their email, the system proceeds to the next validation stage automatically or transitions to user onboarding logic configured by the client.

***

## User Flow

The **Email Input** experience guides the user from entry to verification. After submitting a valid email address, the system sends a one-time passcode (OTP) to the provided address and prompts the user to enter it for confirmation.

If the email format is invalid or the OTP entry fails, fallback paths allow the user to correct their input, resend the verification code, or change the email address. Once the verification is successful, the user proceeds automatically to the next module or configured step in the flow.

<Image align="center" src="https://developer.incode.com/assets/1dd4d0526d97bc5a1e45803ece51ab34.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in the Email Input module — from the initial email entry and format validation, through OTP verification and system feedback, to final confirmation.

It outlines both the ideal verification path and the alternative user journeys, including error handling for invalid email formats, incorrect codes, network issues, and retry flows.
The map visualizes all possible user interactions and system states within the module, ensuring clarity for design, development, and QA alignment.

<Image align="center" src="https://developer.incode.com/assets/f034b10ce7a76dd8ad763d1e603e7682.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the email is verified successfully without interruptions.

The happy path represents the smoothest version of the experience — the user enters a valid email address, receives the verification code instantly, inputs the correct OTP, and the verification succeeds on the first attempt. No manual retries or format corrections are required.

Both light and dark mode previews are included so that design, product, and engineering teams can validate color contrast, typography consistency, and accessibility across all themes and devices.

<Image align="center" alt="Geolocation module - Happy Path in Light mode" caption="Light mode" src="https://developer.incode.com/assets/19944f5a33866a7b30fd322700f36d8f.png" />

<Image align="center" alt="Geolocation module - Happy Path in Dark mode" caption="Dark mode" src="https://developer.incode.com/assets/fe01566704c8f8a4b6de05ac24cebaf4.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Email Input** experience.

**✅ Do**

* Keep the email input field clearly labeled and accessible.
* Display input validation (e.g., invalid format) immediately to reduce friction.
* Maintain consistent CTA placement (“Continue”) across all screens.

**❌ Don’t**

* Don’t delay validation — instant feedback improves trust and usability.
* Avoid truncating long email addresses.
* Don’t change button positions between steps; spatial consistency aids flow.

<br />

---

- Path: `design-and-ux/email-input-screens-states`
- URL: https://developer.incode.com/design-and-ux/email-input-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/email-input-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the **Email Input** module experience. Each state includes a brief description.

***

## Enter Email

Guides the user from an empty field to a valid email and into submission. The Continue button is disabled until a valid format is detected; it activates once validation passes. While submitting, the button shows a loading state to prevent duplicate requests.

<Image align="center" src="https://developer.incode.com/assets/01b3c5ccd2a7181cc662bcf1232c0d43.png" />

<br />

<br />

## Enter Code (OTP Input)

Displayed after the user submits an email. The system sends an SMS with a one-time code, and this screen prompts the user to enter it. A countdown timer indicates when the “Resend code” option becomes available.

<Image align="center" src="https://developer.incode.com/assets/3201299b431da9f6fe286ad48e2b97f3.png" />

<br />

<br />

## Processing

A short step after the OTP is submitted. Spinner + status text communicates progress while preventing multiple submissions. This state should be brief and non-interruptible (except for closing the module, if allowed by host app).

<Image align="center" src="https://developer.incode.com/assets/86c3461c309a9c12f8e8f4ff7e30ca75.png" />

<br />

<br />

## Success

Confirms verification with a positive icon and concise message (Email verified!). Automatically progresses to the next module or returns control to the host app per integration settings.

<Image align="center" src="https://developer.incode.com/assets/95a53b85d52c228efc89349e50a844f4.png" />

<br />

<br />

## Error States (Email & OTP)

Covers common failures:

* Invalid email format (inline helper text; button remains disabled)
* Incorrect code (inputs marked, helper text provided)
* Code expired (inputs marked, helper text provided)

Recovery affordances (Resend code, Change email) remain visible. Copy is intentionally brief to avoid over-explaining and reduce the risk of aiding malicious testing.

<Image align="center" src="https://developer.incode.com/assets/527c5c3a6908ce293a973a5695c3e7c8.png" />

---

- Path: `design-and-ux/email-input-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/email-input-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/email-input-specs-guidelines.md

# Specs & Guidelines

The **Email Input** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/90bff75d4537c7e726491943ad018ff1.png" />

<br />

***

## Responsiveness & Viewport Adaptation

The **Email Input** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive elements, such as the input field and CTA button, remain visible, accessible, and consistently aligned across all platforms.

<Image align="center" src="https://developer.incode.com/assets/97cb5363208c2211af399e6e5f7ba494.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                     |
| :--------------------------------- | :------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | Input field and button stack vertically; spacing compresses slightly for balance |
| **Standard phones (iPhone 12–16)** | Full layout displayed; consistent alignment between title, field, and CTA        |
| **Tall/narrow Android devices**    | Vertical rhythm adapts to keep the field and button comfortably in view          |
| **Foldables (e.g., Pixel Fold)**   | Content remains centered; additional margin creates visual balance               |
| **Tablets**                        | Wider margins and proportional scaling of text and elements                      |
| **Desktop web**                    | Centered layout with max-width container and safe-area padding                   |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                            | **Customizable**       |
| :------------------ | :------------------------------------------------- | :--------------------- |
| Map / Illustration  | Scales with viewport; adapts to portrait/landscape | Color and style only   |
| Instruction text    | Reflows to one or two lines depending on width     | Yes, fully localizable |
| Buttons             | Width adjusts to container, spacing adapts         | Color & text           |
| Footer / watermark  | Pinned to bottom safe area                         | Optional               |
| Background surfaces | Expand to full viewport                            | Yes                    |
| Header area         | Adjusts padding per device safe insets             | Limited (color only)   |

<br />

### What remains fixed across breakpoints

| **Element**             | **Reason**                                   |
| :---------------------- | :------------------------------------------- |
| Input validation logic  | Ensures consistent verification behavior     |
| Minimum text size       | Maintains readability and WCAG compliance    |
| Tap target dimensions   | Accessibility standard across mobile devices |
| Input-field proportions | Keeps layout balance across modules          |
| Layout hierarchy        | Ensures predictable user experience          |

<br />

### Design Notes

* The input field remains the focal point on all screen sizes — avoid introducing secondary visual elements.
* Maintain generous vertical spacing for clarity, especially on devices with on-screen keyboards.
* Ensure button and input alignment remain vertically stacked — never side-by-side.
* Avoid overlaying or crowding the layout with additional text (e.g., marketing or help tips).
* For localization, test long strings (especially in German, Spanish, or Portuguese) to prevent overflow and maintain rhythm.

<br />

***

## Desktop & Tablet Guidelines

The **Email Input** module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/8efdd3716d1a2a851e355bd2e1a4f489.png" />

<br />

***

## Prototype & Transitions

**Email Input** includes predefined transition rules and micro-interactions that ensure a smooth user experience. Animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/0cf069964101ffc2818a91d0c6053515.gif" />

<br />

***

## Localization

**Email Input** supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/c0c3024fda50b21e3a1131e9e84ec254.png" />

<br />

### Key considerations

* Incode supports a variety of languages.
* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.

<br />

---

- Path: `design-and-ux/email-input-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/email-input-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/email-input-v1-vs-v2-comparison.md

# Email Input V1 vs V2 Comparison

V1 provides a basic email input and verification experience.
While it supports the necessary validation logic, the flow offers less flexibility in adapting the experience to different product needs, markets, or branding requirements.

V2 rethinks the flow to be clearer, and easier to customize, introducing better error handling, and alignment with the token-based system. The V2 experience is designed to reduce user confusion, lower drop-off during verification, and ensure consistent look across platforms and markets.

<br />

<Image align="center" caption="V1 provides a basic email input and verification experience, focused primarily on data submission with limited guidance and flexibility." src="https://developer.incode.com/assets/9cdf30feabaac3cb0632a7c8fceb004f.png" />

<br />

<Image align="center" caption="V2 provides a more guided and consistent input experience. Improved UX writing and standardized components help users complete the flow with less friction." src="https://developer.incode.com/assets/4648f214ffa15abadfac201f849a58e2.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1      | V2       | Notes                                                              |
| -------------------------- | ------- | -------- | ------------------------------------------------------------------ |
| Email verification         | ✅       | ✅        | Core functionality present in both versions                        |
| Inline validation          | ✅       | ✅        | Validation logic during entry supported in both versions           |
| Error states coverage      | ✅       | ✅        | Both handle errors, V2 structures them better and improves clarity |
| Customization options      | Limited | Advanced | V2 supports token-based customization                              |
| Documentation completeness | Basic   | Enhanced | V2 provides enhanced, standardized documentation coverage          |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior              | V1                                     | V2                                                        | Notes                                                                       |
| --------------------- | -------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- |
| Error handling        | Separate error states, less contextual | Clear, actionable error messages with improved UX writing | V2 reduces cognitive load                                                   |
| State transitions     | Default transitions                    | Defined transitions between states                        | V2 includes transition smoothness and consistency as part of the experience |
| Flow and UI structure | Functional but less standardized       | Structured and consistent                                 | Aligned with the tokenized design system                                    |

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/00250b96db7423b991d09a72686d3545.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

---

- Path: `design-and-ux/face-capture-customization`
- URL: https://developer.incode.com/design-and-ux/face-capture-customization/
- Markdown: https://developer.incode.com/design-and-ux/face-capture-customization.md

# Customization

This section outlines the elements you can customize within the **Face Capture** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

<br />

## Tutorial Screen

The Tutorial Screen prepares the user for the Face Capture step. It introduces the action, provides the necessary context, and sets expectations before the camera is activated.

<Image align="center" src="https://developer.incode.com/assets/d492b40641e0ef6c29abf89c00de5db3.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                            | **Notes**                              |
| ---------------- | ----------------------------------------------------- | -------------------------------------- |
| **Text**         | Title, subtitle, body text                            | Fully localizable; tone can be adapted |
| **Illustration** | Full replacement                                      | Must remain clear and represent a face |
| **Brand Colors** | Header, highlight elements, illustration ring, button | Uses brand tokens                      |
| **Buttons**      | Label, color, radius                                  | Must follow platform guidelines        |
| **Footer**       | “Verified by Incode” line                             | Optional but recommended               |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                   |
| --------------------- | ------------------------------------- |
| Layout structure      | Ensures consistency across modules    |
| Silhouette style      | Must remain consistent with global UX |
| Spacing & safe areas  | Required for device compatibility     |
| Text hierarchy        | Optimized for readability             |
| Close icon position   | Standardized for user familiarity     |
| WCAG minimum contrast | Mandatory                             |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/9bc3727378976f3a1f17a1bfc4e4d51c.png" />

| **UI Element**    | **Token**                      | **Value** |
| ----------------- | ------------------------------ | --------- |
| Background        | Surface/Neutral/0              | #FFFFFF   |
| Title text        | Text/Body/800 (Primary)        | #262831   |
| Subtitle text     | Text/Body/500 (Secondary)      | #60667C   |
| Disclaimer        | Text/Body/500 (Secondary)      | #60667C   |
| Button background | Button/Primary/Surface/Default | #006AFF   |
| Button text       | Button/Primary/Text/Default    | #FFFFFF   |
| Footer text       | Text/Body/500 (Secondary)      | #60667C   |

<br />

### Design Notes

* Keep copy short to minimize cognitive load.
* The illustration can be customized using color tokens on Web. For Native platforms, reach out so we can provide a tailored solution.
* Ensure tap targets meet accessibility guidelines.
* Maintain clear focus states for keyboard and screen reader users (Web).

<br />

***

## Fake Permission Screen

The Fake Permission Screen is shown before the operating system displays its native camera permission modal. It prepares the user, explains why camera access is required, and significantly reduces the likelihood of users denying permission. This step increases trust and prevents interruptions during the selfie flow.

<Image align="center" src="https://developer.incode.com/assets/998981834d738d101c6d6c1ce024631c.png" />

<br />

### Customizable Elements

| **Area**           | **What can be customized**                    | **Notes**                                          |
| ------------------ | --------------------------------------------- | -------------------------------------------------- |
| **Text**           | Title, subtitle, permission explanation       | Fully localizable; tone should remain reassuring   |
| **Buttons**        | Label (“Allow”, “Don’t allow”), color, radius | Must maintain primary/secondary hierarchy          |
| **Brand Colors**   | Button accents, icon color, text accents      | Uses brand tokens                                  |
| **Modal Surface**  | Background color, elevation, corner radius    | Must remain high-contrast and readable             |
| **Link/Help Text** | “Learn more” or similar supportive text       | Optional; can adapt tone based on compliance needs |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                             |
| ---------------------- | --------------------------------------------------------------- |
| Background dim opacity | Indicates OS-level permission flow; needed for clarity          |
| Modal position         | Standardized centered layout for all modules                    |
| Button hierarchy       | Mirrors OS expectations; prevents accidental “Don’t allow” taps |
| Safety text hierarchy  | Ensures user comprehension before OS prompt                     |
| Spacing & safe areas   | Required for device consistency                                 |
| WCAG minimum contrast  | Mandatory                                                       |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/f01ed411db1813aafd8e6f98faa93765.png" />

| **UI Element**         | **Token**                       | **Value**   |
| ---------------------- | ------------------------------- | ----------- |
| Dimmed background      | Surface/Neutral/1000 80% Static | #000000 80% |
| Modal background       | Surface/Neutral/0               | #FFFFFF     |
| Title text             | Text/Body/800 (Primary)         | #262831     |
| Subtitle text          | Text/Body/500 (Secondary)       | #60667C     |
| Primary button (Allow) | Button/Primary/Surface/Default  | #006AFF     |
| Primary button text    | Button/Primary/Text/Default     | #FFFFFF     |
| Secondary button       | Button/Secondary/Border/Default | #006AFF     |
| Secondary button text  | Button/Secondary/Text/Default   | #006AFF     |

<br />

### Design Notes

* The pre-permission modal reduces drop-off by providing context before the OS permission.
* Maintain a clear hierarchy between primary (Allow) and secondary (Don’t allow) actions.
* Keep the dim overlay consistent to align with OS modal expectations.
* Ensure high contrast between modal, text, and background elements.
* Avoid adding extra steps or interaction on this screen.

<br />

***

## Capture Screens

During capture, the user aligns their face within the silhouette, and the system evaluates real-time conditions such as lighting, alignment, and distance. Once requirements are met, the photo is taken automatically. Colors and on-screen text can be customized to match your brand, while the silhouette itself is fixed, as it plays an essential role in helping users position their face correctly.

<Image align="center" src="https://developer.incode.com/assets/842fc8af9866c9072081aae68a8c819d.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                          | **Notes**                        |
| ---------------- | --------------------------------------------------- | -------------------------------- |
| **Text**         | Instruction text (“Align your face…”, “Get ready…”) | Fully localizable                |
| **Brand Colors** | Progress indicator, icon colors, header color       | Control via tokens               |
| **Illustration** | Silhouette outline color                            | Color only — shape cannot change |
| **Background**   | Neutral/light surfaces                              | Must maintain contrast           |
| **Footer**       | “Verified by Incode” line                           | Optional                         |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                             |
| ---------------------- | --------------------------------------------------------------- |
| Silhouette shape       | Essential for proper face alignment                             |
| Auto-capture behavior  | Ensures consistency and accuracy across devices                 |
| Detection logic        | Required for system-level validation (lighting, distance, etc.) |
| Layout & hierarchy     | Preserves visual consistency across modules                     |
| Minimum contrast       | Mandatory to meet accessibility standards                       |
| Progress indicator arc | Behavior and animation timing remain fixed                      |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/afef1712d78ec0811f69bf8d2501399b.png" />

| **UI Element**          | **Token**                 | **Value** |
| ----------------------- | ------------------------- | --------- |
| Instruction text        | Text/Body/800 (Primary)   | #262831   |
| Silhouette ring (outer) | Border/Neutral/100        | #EBECEF   |
| Silhouette arc progress | Border/Status/Focus       | #006AFF   |
| Background              | Surface/Neutral/0 Static  | #FFFFFF   |
| Footer text             | Text/Body/500 (Secondary) | #006AFF   |

<br />

### Design Notes

* The silhouette cannot be altered in shape, only color, as it ensures correct face alignment.
* The progress arc represents detection readiness; its behavior should remain consistent to avoid confusing users.
* Use brand colors subtly to avoid distracting from the user’s face.
* Keep instruction text short and focused to reduce cognitive load.
* Maintain clear focus states and large tap areas (for accessibility on Web).

<br />

***

## Manual Capture

Manual capture is triggered after a period of inactivity (default: 30 seconds) when automatic detection conditions are not met. In this mode, the user aligns their face within the silhouette and presses the capture button manually. This ensures the user can still complete the verification even in low-light, complex backgrounds, or edge-case scenarios.

<Image align="center" src="https://developer.incode.com/assets/34527995564d6d1d4f74c29c7b970eaf.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                                    | **Notes**                                             |
| -------------------- | ------------------------------------------------------------- | ----------------------------------------------------- |
| **Text**             | Instructional text (“Align your face… and press the button…”) | Fully localizable                                     |
| **Button**           | Label, color, radius, icon color                              | Must follow platform accessibility & tap-target rules |
| **Brand Colors**     | Header, accent rings, button background, icon accents         | Driven by brand tokens                                |
| **Silhouette Color** | Outer ring color only                                         | Shape/size cannot change                              |
| **Background**       | Light/neutral backgrounds                                     | Must maintain contrast with silhouette                |
| **Footer**           | “Verified by Incode” line                                     | Optional                                              |

<br />

### Fixed Elements

| **Element**                 | **Why it is fixed**                                   |
| --------------------------- | ----------------------------------------------------- |
| Silhouette shape            | Core UX element ensuring proper face alignment        |
| Camera button placement     | Ensures reachability and consistency across platforms |
| Detection logic fallback    | Manual mode must always follow auto mode              |
| Layout spacing & safe areas | Required for compatibility across device sizes        |
| Accessibility contrast      | Must meet WCAG AA requirements                        |
| Tap target size for button  | Required for usability and accessibility              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/c7c47eb91ff429c507814cebfac84b11.png" />

| **UI Element**        | **Token**                      | **Value** |
| --------------------- | ------------------------------ | --------- |
| Silhouette border     | Border/Neutral/100             | #EBECEF   |
| Silhouette background | Surface/Neutral/900 80% Static | #14151A   |
| Button icon           | Icon/Neutral/50 Static         | #FCFCFD   |
| Button background     | Icon/Neutral/800 Static        | #262831   |
| Instruction text      | Text/Body/500 (Secondary)      | #60667C   |
| Background            | Surface/Neutral/0 Static       | #FFFFFF   |
| Footer text/link      | Text/Body/500 (Secondary)      | #60667C   |

<br />

### Design Notes

* Manual mode provides a fail-safe capture method when automatic detection is not possible.
* Ensure the camera button remains highly visible against any background.
* Keep instructional text concise and actionable to reduce friction.
* The silhouette must remain visible at all times; avoid color changes that reduce contrast.
* Button must preserve accessible tap size (minimum 44×44 px on mobile).

<br />

***

## Capture Complete (Uploading & Success)

Once the selfie is captured, either automatically or manually, the user transitions into the Uploading and Success states. These screens reassure the user that the capture is being processed and provide a clear confirmation when the image is accepted. Both the loading ring and the confirmation colors can be branded to match your product’s identity.

<Image align="center" src="https://developer.incode.com/assets/6be4323a33bf99f8de7e8d82ec6908ff.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**             | **Notes**                            |
| ---------------- | -------------------------------------- | ------------------------------------ |
| **Text**         | “Uploading…”, “Success!”, body text    | Fully localizable                    |
| **Brand Colors** | Progress ring, outline, success colors | Should follow brand tokens           |
| **Surfaces**     | Background, circular surface           | Must ensure contrast and clarity     |
| **Footer**       | “Verified by Incode”                   | Optional                             |
| **Animation**    | Progress ring color transitions        | Only color; timing/behavior is fixed |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                        |
| ---------------------- | ---------------------------------------------------------- |
| Progress ring behavior | Ensures consistent feedback cadence across all modules     |
| Success timing         | User feedback consistency / prevents premature transitions |
| Layout structure       | Standardized for readability and predictability            |
| Minimum contrast       | Required for WCAG AA compliance                            |
| Loading animation arc  | Behavior cannot be modified to maintain UX continuity      |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/5b618f5e2c188546a8e9f852329df610.png" />

| **UI Element**       | **Token**                 | **Value** |
| -------------------- | ------------------------- | --------- |
| Loading ring (outer) | Spinner/Surface/Primary   | #006AFF   |
| Loading ring (inner) | Spinner/Surface/Secondary | #E5F0FF   |
| Text (“Uploading…”)  | Text/Body/800 (Primary)   | #262831   |
| Background           | Surface/Neutral/0         | #FFFFFF   |
| Footer text          | Text/Body/500 (Secondary) | #60667C   |

<br />

### Design Notes

* Keep messaging short and neutral, users should feel reassured, not overwhelmed.
* The green ring color communicates a positive state; ensure it remains accessible and high-contrast.
* Background should remain clean and unobtrusive to keep focus on the processing state.
* Avoid adding interaction in these screens; the user should not be able to interrupt this step.
* Maintain consistent ring thickness and spacing to preserve visual rhythm across modules.

<br />

***

## Error Screens

Error screens appear when an issue occurs during capture, such as face misalignment, incorrect lighting, occlusions, or when all attempts have been exhausted. These screens help guide users back into the flow by providing corrective instructions or informing them that manual review will be needed. While text and styling can be branded, error types cannot be removed, as they correspond to specific detection events within the experience.

<Image align="center" src="https://developer.incode.com/assets/356e5d422196ec0b7c6c6297452aadf3.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                 | **Notes**                                      |
| ---------------- | ---------------------------------------------------------- | ---------------------------------------------- |
| **Text**         | Error title, description, remaining attempts label         | Fully localizable                              |
| **Buttons**      | CTA labels (“Try again”, “Continue”), button color, radius | Must keep primary/secondary hierarchy          |
| **Brand Colors** | Header, accent colors, button colors                       | Follows brand token system                     |
| **Icons**        | Icon color (warning, error)                                | Only color, not shape                          |
| **Background**   | Neutral/light surfaces                                     | Must maintain strong contrast with text + icon |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                                          |
| -------------------------- | ------------------------------------------------------------ |
| Error event types          | Linked to detection logic; cannot be removed or reordered    |
| Error icon shapes          | Ensures immediate recognition and consistency across modules |
| Error screen layout        | Preserves visual predictability                              |
| “Attempts remaining” logic | Required for accuracy and flow integrity                     |
| Final error behavior       | Must proceed to next step with manual review                 |
| Accessibility contrast     | Required to meet WCAG AA                                     |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/cf43d232797b68a973973a96138a181d.png" />

| **UI Element**      | **Token**                      | **Value** |
| ------------------- | ------------------------------ | --------- |
| Icon (error circle) | Icon/Status/Negative           | #E71111   |
| Icon (x-mark)       | Icon/Neutral/0                 | #FFFFFF   |
| Title text          | Text/Body/800 (Primary)        | #262831   |
| Description text    | Text/Body/500 (Secondary)      | #60667C   |
| Background          | Surface/Neutral/0              | #FFFFFF   |
| CTA background      | Button/Primary/Surface/Default | #006AFF   |
| CTA text            | Button/Primary/Text/Default    | #FFFFFF   |
| Footer text         | Text/Body/500 (Secondary)      | #006AFF   |

<br />

### Design Notes

* Error messaging should remain clear, direct, and action-oriented.
* Use meaningful icon colors (yellow for warnings, red for errors).
* Maintain consistent spacing and visual hierarchy for readability.
* “Try again” should always feel like the primary action when applicable.
* Final error screens should not offer a retry, only a “Continue” action guiding users into manual review logic.
* Avoid long or overly technical messages; users should understand the issue at a glance.

---

- Path: `design-and-ux/face-capture-design`
- URL: https://developer.incode.com/design-and-ux/face-capture-design/
- Markdown: https://developer.incode.com/design-and-ux/face-capture-design.md

# Face Capture

Face Capture confirms the user’s physical presence by capturing a live selfie that is later used to validate their identity.

This module appears after ID Capture and before verification submission or Face Match, forming a core step in the onboarding and authentication flow.

<Image align="center" src="https://developer.incode.com/assets/3d80129cb095fdf6ec9b7590c9194e96.gif" />

***

## Where it fits in the flow

**Face Capture** usually appears immediately after completing document capture.

Once the user provides a valid selfie, the flow continues to biometric comparison or any downstream verification logic required by the application.

***

## User Flow

The **Face Capture** experience moves through several clear stages that guide the user from preparation to a successful capture. After granting camera permission, the user is introduced to the process through a short tutorial. When capture begins, the system evaluates alignment, lighting, and facial conditions in real time and triggers an automatic capture once all requirements are met.

If automatic capture does not occur within the configured timeframe, the experience transitions to manual capture, allowing the user to take the selfie directly. After the image is captured, it is uploaded and analyzed to confirm quality and usability. The user then receives a success state or an error message with retry options before continuing to the next step.

<br />

<Image align="center" src="https://developer.incode.com/assets/b65ba753cf4b5af41e5d2cd590d8cce0.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in **Face Capture**, from tutorial and permission handling, to auto/manual capture, uploading, and final feedback.

<Image align="center" src="https://developer.incode.com/assets/0a902c73463da3a3c7e37243dce08205.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the selfie is captured successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user grants camera access, follows the tutorial, the system detects proper alignment and lighting, and the selfie is captured automatically without requiring retries or manual intervention. Both light and dark mode previews are included so teams can validate visual consistency across themes.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/c5c67cbc75ffe7b8fbdd73c6b86cffd6.png" />

<Image align="center" caption="Dark mode - The capture screen uses a white background even in dark mode to ensure proper illumination and optimal face detection during the face capture process." src="https://developer.incode.com/assets/d7b6d3aba45ae8a1f93b191cd59d26e9.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Face Capture** experience.

**✅ Do**

* Keep instructions short and easy to understand.
* Maintain a clear, unobstructed silhouette for proper alignment.
* Ensure high contrast and readable text across all steps.
* Provide retry options whenever a capture fails.
* Guide users with actionable feedback (lighting, alignment, visibility).

**❌ Don’t**

* Don’t reduce overlay opacity below 50%, as it affects face visibility.
* Don’t rely solely on color to communicate status or feedback.
* Don’t skip or reduce essential error states.
* Don’t allow UI elements to obstruct the camera area or silhouette.

---

- Path: `design-and-ux/face-capture-screens-states`
- URL: https://developer.incode.com/design-and-ux/face-capture-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/face-capture-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the Face Capture experience. Each state includes a brief description. Source of truth for layout, visual specs, interactions, and platform variations.

***

## Tutorial

Pre-capture instructional screen introducing the selfie step. Includes illustration/video and clear guidance before the camera opens.

<Image align="center" src="https://developer.incode.com/assets/dfb36358ad2e1e8a858f5c9731716c73.png" />

<br />

## Permission Screens

Shown when camera permissions have not been granted. Includes pre-permission context, OS-specific instructions, and fallback steps if the system dialog is dismissed.

<Image align="center" src="https://developer.incode.com/assets/783a8d02983152c1f4d76f788f07dc7a.png" />

<br />

## Auto Capture

Automatic capture triggers when face alignment, lighting, and detection thresholds are met. This is the primary and recommended capture method.

<Image align="center" src="https://developer.incode.com/assets/a543b20301653afd3b14d1471e9805ef.png" />

<br />

## Manual Capture (Fallback)

Fallback option shown after a period of inactivity (default: 30 seconds) or when auto-capture cannot confidently detect a valid frame. Users can take the photo manually.

<Image align="center" src="https://developer.incode.com/assets/ebe199b7c1602b8dfe0c1b08cb321e9c.png" />

<br />

## Feedback Messages (Real-Time Guidance)

Real-time, contextual guidance displayed while the camera is active. Helps users correct lighting, distance, positioning, and visibility issues to ensure a valid capture.

<Image align="center" src="https://developer.incode.com/assets/4a1f6fe910f3e89e82e261424bd346a0.png" />

<br />

## Uploading

Displayed while the captured selfie is uploaded and prepared for server-side validation. Prevents users from interacting until upload is complete.

<Image align="center" src="https://developer.incode.com/assets/495110fbeb48ef2a77a3781a2509a320.png" />

<br />

## Success

Shown when the selfie passes validation. The user can proceed to the next verification step without additional input.

<Image align="center" src="https://developer.incode.com/assets/96173d5ed410be8a5253ad96bd13972c.png" />

<br />

## Retry Errors

Displayed when validation fails but attempts remain. Provides specific corrective guidance and a retry CTA. Attempts reset after a successful capture.

<Image align="center" src="https://developer.incode.com/assets/4b85624100005e7aff6007c57d6cc3c2.png" />

<br />

## Final Errors (No Attempts Remaining)

Shown when all capture attempts have been used. The selfie is submitted for manual review, and the user may continue to the next step.

<Image align="center" src="https://developer.incode.com/assets/14faf871c5224aa2b9033e0944ee10da.png" />

<br />

## Connection Error

Displays when connectivity is lost during capture or upload. Users can retry once a stable connection is restored.

<Image align="center" src="https://developer.incode.com/assets/dc0cedc60d1e935e0d280dbdf179e514.png" />

---

- Path: `design-and-ux/face-capture-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/face-capture-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/face-capture-specs-guidelines.md

# Specs & Guidelines

The **Face Capture** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" border={false} src="https://developer.incode.com/assets/1368b73ffc39ddb2db3e042a9391b26b.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Face Capture** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas, such as the silhouette, capture instructions, and CTAs. remain visible, accessible, and properly aligned across platforms.

<Image align="center" border={false} src="https://developer.incode.com/assets/f3b1d4e15c57c426ba3e903281d2c8d6.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; silhouette scales down to maintain visibility |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; instructions remain pinned above CTA      |
| **Foldables (e.g., Pixel Fold)**   | Larger silhouette and more balanced white space; content remains centered    |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                             | **Customizable**                 |
| ------------------- | --------------------------------------------------- | -------------------------------- |
| Silhouette size     | Scales proportionally by viewport height            | Color only (size is fixed logic) |
| Instruction text    | Reflows to one or two lines depending on width      | Yes, text is fully localizable   |
| Buttons             | Width adjusts to container, vertical spacing adapts | Color & text                     |
| Footer / watermark  | Pinned to bottom safe area                          | Optional                         |
| Background surfaces | Expand to full viewport                             | Yes                              |
| Header area         | Scales padding according to device safe insets      | Limited (color only)             |

<br />

### What remains fixed across breakpoints

| **Element**               | **Reason**                                 |
| ------------------------- | ------------------------------------------ |
| Capture logic & detection | Must remain consistent for accuracy        |
| Silhouette proportions    | Crucial for face alignment guidance        |
| Minimum text size         | Required for readability & WCAG compliance |
| Minimum tap target sizes  | Ensures accessibility on mobile            |
| Overall hierarchy         | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The silhouette always remains the dominant element, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" border={false} src="https://developer.incode.com/assets/f7f4a5ee231cfbfa084df5c9ae9f1f78.png" />

<br />

<br />

***

## Prototype & Transitions

Face Capture includes predefined transition rules and micro-interactions that ensure a smooth user experience across tutorial, capture, uploading, and error flows. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" border={false} src="https://developer.incode.com/assets/3d80129cb095fdf6ec9b7590c9194e96.gif" />

<br />

<br />

***

## Localization

The **Face Capture** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" border={false} src="https://developer.incode.com/assets/b92a16dba0d5c7ed97968eb1933f22d7.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/face-capture-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/face-capture-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/face-capture-v1-vs-v2-comparison.md

# Face Capture V1 vs V2 Comparison

<br />

In V1, Face Capture offers a basic experience to capture the user’s face, with limited guidance during the process.
It focuses on checking the list of conditions that need to be met for a good capture, providing low visual guidance throughout the flow.

In V2, Face Capture guides users step by step. The experience gives live instructions and helps users fix issues as they happen, making the process clearer and easier to complete.
It also introduces a cleaner, more modern UI with clearer hierarchy, smoother transitions, and consistent visual patterns.

<br />

<Image align="center" caption="V1 is a basic face capture experience with limited guidance." src="https://developer.incode.com/assets/add7fdb9048631688ebe72d1f1e692e6.png" />

<br />

<Image align="center" caption="V2 is a guided, step-by-step face capture experience with live instructions and clear visual feedback." src="https://developer.incode.com/assets/baaec0203a1812b3514dbc0f6a80281d.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Auto-capture               | ✅  | ✅  | Both versions capture the image automatically when conditions are met.                                                           |
| Capture Condition Checks   | ✅  | ✅  | V2 has improved live feedback messages for clarity and understandability.                                                        |
| Manual Capture             | ✅  | ✅  | V2 provides instructions to the user on how to take the photo.                                                                   |
| Capture Attempts           | ✅  | ✅  | V2 visually differentiates instances with remaining attempts from those with exhausted ones.                                     |
| Error States               | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior              | V1                                         | V2                                                                | Notes                                                                                      |
| --------------------- | ------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| Tutorial behavior     | Long step-by-step animation                | Straightforward animated tutorial                                 | V2 is intuitive and directs the focus towards the tutorial instructions.                   |
| Permission flow logic | Immediate native popup is triggered        | Pre-permission bottom sheet shown before native popup             | When necessary, V2 adds an explanatory step to reduce permission drop-off.                 |
| Feedback presentation | Brief contextual instructions              | Clear, actionable feedback for a successful capture               | V2 has updated feedback instructions for users to correct their action faster.             |
| State transitions     | Default transitions                        | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package.             |
| Capture experience    | Basic capture animations and user guidance | Enhanced contextual overlay and indicative ring                   | V2 uses an overlay around the silhouette for enhanced positioning guidance when necessary. |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/7834b23c06107540e69a29ecd1a1d276.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

**For full details, visit the [Customization](/design-and-ux/face-capture-customization/) tab of this module.**

<br />

<br />

---

- Path: `design-and-ux/face-match-customization`
- URL: https://developer.incode.com/design-and-ux/face-match-customization/
- Markdown: https://developer.incode.com/design-and-ux/face-match-customization.md

# Customization

This section outlines the elements you can customize within the **Face Match** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible — such as text, brand colors, and buttons — and which elements remain fixed to ensure consistency, accessibility, and a trustworthy result presentation across platforms.

<Image align="center" src="https://developer.incode.com/assets/086dc156ebaf6637ba76a236cc192cda.gif" />

<br />

***

## Comparison Screen

The entry screen shows the selfie and ID portrait side by side under a clear heading. Header, text, and label styling can be branded, while the two source images and their layout stay fixed so users always understand what is being compared.

<Image align="center" src="https://developer.incode.com/assets/6efe1f2c4999e9df0729f3abc491a7e9.png" />

<br />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| -------- | -------------------------- | --------- |
| **Text** | Title (“Verifying identity”), Selfie/ID labels | Fully localizable |
| **Brand Colors** | Logo/header tint, label and text accents | Uses brand tokens |
| **Footer** | “Verified by Incode” line | Optional but recommended |

<br />

### Fixed Elements

| **Element** | **Why it is fixed** |
| ----------- | ------------------- |
| Side-by-side image layout | Ensures users understand which images are compared |
| Image crop & shape | Standardized circular crops for consistency |
| Text hierarchy | Optimized for readability |
| WCAG minimum contrast | Mandatory |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/a9706883ca4785db14e959441238b891.png" />

| **UI Element** | **Token** | **Value** |
| -------------- | --------- | --------- |
| Background | Surface/Neutral/0 | #FFFFFF |
| Logo / header | Brand/500 | #006AFF |
| Title text | Text/Body/800 (Primary) | #262831 |
| Label text | Text/Body/500 (Secondary) | #60667C |
| Footer text | Text/Body/500 (Secondary) | #60667C |

<br />

### Design Notes

* Keep the title short and reassuring.
* Maintain a clear visual distinction between the Selfie and ID labels.
* Ensure both images remain clearly visible and balanced.

<br />

***

## Checking Photos

The processing state reassures the user while the comparison runs. The loading indicator color and supporting text can be branded; the animation behavior and timing remain fixed.

<Image align="center" src="https://developer.incode.com/assets/abbeec41d2b9eb18857cbec3475f7102.png" />

<br />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| -------- | -------------------------- | --------- |
| **Text** | “Checking your photos”, supporting line | Fully localizable |
| **Brand Colors** | Spinner / progress indicator color | Control via tokens |
| **Footer** | “Verified by Incode” line | Optional |

<br />

### Fixed Elements

| **Element** | **Why it is fixed** |
| ----------- | ------------------- |
| Spinner behavior & timing | Ensures consistent feedback cadence across modules |
| Layout structure | Standardized for predictability |
| Minimum contrast | Required for WCAG AA |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/a76434a5c7ecd048b360747962d57e79.png" />

| **UI Element** | **Token** | **Value** |
| -------------- | --------- | --------- |
| Spinner (arc) | Spinner/Surface/Primary | #006AFF |
| Spinner (track) | Spinner/Surface/Secondary | #E5F0FF |
| Title text | Text/Body/800 (Primary) | #262831 |
| Supporting text | Text/Body/500 (Secondary) | #60667C |
| Background | Surface/Neutral/0 | #FFFFFF |

<br />

### Design Notes

* Keep messaging short and neutral so users feel reassured.
* Do not allow interaction during this step.
* Maintain consistent ring thickness to preserve visual rhythm across modules.

<br />

***

## Matched (Success)

The success state confirms a positive match. The confirmation icon accent, success text, and the primary CTA can be branded, while the result icon shape and layout stay fixed.

<Image align="center" src="https://developer.incode.com/assets/a1f240d678726970d18a1986b03236fe.png" />

<br />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| -------- | -------------------------- | --------- |
| **Text** | “Matched!”, body text, CTA label (“Continue”) | Fully localizable |
| **Buttons** | Label, color, radius | Must follow platform guidelines |
| **Brand Colors** | Success icon accent, CTA color | Uses brand tokens |
| **Footer** | “Verified by Incode” line | Optional |

<br />

### Fixed Elements

| **Element** | **Why it is fixed** |
| ----------- | ------------------- |
| Result icon shape | Ensures immediate recognition across modules |
| Success timing | Prevents premature transitions |
| Layout structure | Standardized for readability |
| Minimum contrast | Required for WCAG AA |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/489378fff341c36e8ab584ecfa2acfe5.png" />

| **UI Element** | **Token** | **Value** |
| -------------- | --------- | --------- |
| Success icon | Icon/Status/Positive | #189F60 |
| Title text | Text/Body/800 (Primary) | #262831 |
| CTA background | Button/Primary/Surface/Default | #006AFF |
| CTA text | Button/Primary/Text/Default | #FFFFFF |
| Background | Surface/Neutral/0 | #FFFFFF |

<br />

### Design Notes

* Keep the confirmation message short and positive.
* Ensure the success accent remains accessible and high-contrast.
* “Continue” should read as the clear primary action.

<br />

***

## Faces Do Not Match (Error)

The error state communicates a failed comparison. Text, the error icon color, and the CTA can be branded, while the error icon shape and the result behavior remain fixed.

<Image align="center" src="https://developer.incode.com/assets/93a4df1cf47c9b7a2131580b71f5cee9.png" />

<br />

### Customizable Elements

| **Area** | **What can be customized** | **Notes** |
| -------- | -------------------------- | --------- |
| **Text** | Error title (“Faces do not match”), description, CTA label | Fully localizable |
| **Buttons** | Label, color, radius | Keep primary hierarchy |
| **Brand Colors** | Header / text accents, CTA color | Follows brand token system |
| **Icons** | Icon color (error) | Only color, not shape |

<br />

### Fixed Elements

| **Element** | **Why it is fixed** |
| ----------- | ------------------- |
| Error icon shape | Ensures immediate recognition and consistency |
| Error screen layout | Preserves visual predictability |
| Result behavior | Must hand off to the application’s downstream logic |
| Accessibility contrast | Required to meet WCAG AA |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/12bc54a2d2d16dfd35aa74d93ce58caa.png" />

| **UI Element** | **Token** | **Value** |
| -------------- | --------- | --------- |
| Error icon (circle) | Icon/Status/Negative | #E71111 |
| Error icon (x-mark) | Icon/Neutral/0 | #FFFFFF |
| Title text | Text/Body/800 (Primary) | #262831 |
| Description text | Text/Body/500 (Secondary) | #60667C |
| CTA background | Button/Primary/Surface/Default | #006AFF |
| CTA text | Button/Primary/Text/Default | #FFFFFF |

<br />

### Design Notes

* Keep error messaging clear, direct, and non-technical.
* Use a meaningful error color (red) for the icon.
* Always provide a clear way to continue.

<br />

---

- Path: `design-and-ux/face-match-design`
- URL: https://developer.incode.com/design-and-ux/face-match-design/
- Markdown: https://developer.incode.com/design-and-ux/face-match-design.md

# Face Match

Face Match confirms that the person presenting themselves is the same person shown in the identity document, by comparing the live selfie against the portrait extracted from the ID.

This module typically runs right after the selfie and the ID document have been captured. It acts as the biometric link between the user and their document, returning a clear match / no-match result before the flow continues.

<Image align="center" src="https://developer.incode.com/assets/c700560a9947ef05dae891941f5bf3f8.gif" />

***

## Where it fits in the flow

**Face Match** usually appears immediately after **Face Capture** and **ID Capture**, once both a selfie and an ID portrait are available.

The module compares the two images and surfaces the outcome to the user. On a successful match the flow continues to downstream verification or submission; on a no-match it presents a clear error state before handing control back to the application.

***

## User Flow

The **Face Match** experience is short and reassuring. The user first sees their selfie and ID portrait side by side under a clear “Verifying identity” heading, confirming which two images are being compared. The system then runs the biometric comparison while a brief processing state lets the user know their photos are being checked.

Once the comparison completes, the user receives an explicit result: a success state confirming the faces matched, or an error state indicating the faces do not match. Both outcomes provide a clear next action so the user always knows how to continue.

<br />

<Image align="center" src="https://developer.incode.com/assets/902601c5ee293affd2afbc19b955d2ee.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in **Face Match**, from the side-by-side comparison and processing state through to the match and no-match outcomes.

<Image align="center" src="https://developer.incode.com/assets/6579aaafa59e2a765e93336b0ff64d25.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal journey, where the selfie and ID portrait belong to the same person and the comparison succeeds without interruption.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/b96f24151e745c7848f1f6b4a8bd8385.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/3f02d1c89f018e72734840f374810995.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Face Match** experience.

**✅ Do**

* Make it obvious which two images are being compared (Selfie vs ID).
* Keep the processing state short and reassuring.
* Communicate both match and no-match outcomes explicitly.
* Provide a clear next action on every result screen.
* Maintain high contrast and readable text across light and dark themes.

**❌ Don’t**

* Don’t hide or merge the two source images in a way that obscures what is being compared.
* Don’t rely on color alone to communicate the match result.
* Don’t skip the no-match error state.
* Don’t add interaction during the processing step.

---

- Path: `design-and-ux/face-match-screens-and-states`
- URL: https://developer.incode.com/design-and-ux/face-match-screens-and-states/
- Markdown: https://developer.incode.com/design-and-ux/face-match-screens-and-states.md

# Screens & States

A complete view of all screens the user may encounter during the Face Match experience. Each state includes a brief description and a direct link to its source in Figma.

**Open Full Screen and Specs in [Figma](https://www.figma.com/design/BXeJ6Q3TXahJVWEt8QoMVA/Face-Match---In-Production?node-id=18-19332)**  
Source of truth for layout, visual specs, interactions, and platform variations.

***

## Face Comparison

Comparison screen showing the images from the ID and Selfie. It animates automatically when comparing the images to clearly communicate the step to the user.

<Image align="center" src="https://developer.incode.com/assets/109d700928410263c62bb692d8fe85fa.png" />

<br />

## Compact Mode Face Comparison

This is a configurable alternative to the Face Comparison screen. The images from the ID and Selfie are not shown, and a loader is displayed while the match is performed.

<Image align="center" src="https://developer.incode.com/assets/3ae2c56301b62d96362b147e9cac08c0.png" />

<br />

## Success

Shown when the face match is successful. The user can proceed to the next verification step without additional input.

<Image align="center" src="https://developer.incode.com/assets/f26263209a65a4efe1d9552dd56c9793.png" />

<br />

## Error

Shown when the face match has resulted unsuccessful. The user may continue to the next step, depending on the configuration of the flow.

<Image align="center" src="https://developer.incode.com/assets/a7437e4eca14064807c29d3d31b124b1.png" />

<br />

---

- Path: `design-and-ux/face-match-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/face-match-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/face-match-specs-guidelines.md

# Specs & Guidelines

The **Face Match** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" border={false} src="https://developer.incode.com/assets/53b5681b9d70d025098fa48526dd60b9.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Face Match** module is fully responsive and adapts to a wide range of device sizes and aspect ratios. The comparison images, result icons, instructions, and CTAs remain visible, balanced, and properly aligned across platforms.

<Image align="center" border={false} src="https://developer.incode.com/assets/8a4383e81f198283665c23eb5946edde.png" />

<br />

### What is responsive (and customizable)

| **Element** | **Responsive Behavior** | **Customizable** |
| ----------- | ----------------------- | ---------------- |
| Comparison images | Scale proportionally; circular crops preserved | Not the crop; surrounding styling yes |
| Selfie / ID labels | Reflow above each image | Text & color |
| Result icon & text | Centered; scale with viewport | Color & text |
| Buttons | Width adjusts to container | Color & text |
| Footer / watermark | Pinned to bottom safe area | Optional |
| Background surfaces | Expand to full viewport | Yes |

<br />

### What remains fixed across breakpoints

| **Element** | **Reason** |
| ----------- | ---------- |
| Comparison layout | Users must understand which images are compared |
| Image crop proportions | Consistency and recognizability |
| Minimum text size | Readability & WCAG compliance |
| Minimum tap target sizes | Accessibility on mobile |
| Overall hierarchy | Prevents cognitive load at different sizes |

<br />

<br />

***

## Desktop & Tablet Guidelines

The module adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" border={false} src="https://developer.incode.com/assets/d47fc23379b402f2570aed1d7ab32e4a.png" />

<br />

<br />

***

## Prototype & Transitions

Face Match includes predefined transition rules and micro-interactions that keep the experience smooth across comparison, processing, and result states. Timing and easing are documented directly in the Figma prototypes.

<Image align="center" border={false} src="https://developer.incode.com/assets/c700560a9947ef05dae891941f5bf3f8.gif" />

<br />

<br />

***

## Localization

The **Face Match** module supports full localization and adapts to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" border={false} src="https://developer.incode.com/assets/3a7ed2a7baa1c418adde5bf747d4f8fa.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Buttons and CTAs automatically expand to fit translated labels.
* Selfie / ID labels remain clear across languages.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.

<br />

---

- Path: `design-and-ux/face-match-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/face-match-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/face-match-v1-vs-v2-comparison.md

# Face Match V1 vs V2 Comparison

<br />

In V1, Face Match presents a functional comparison of the selfie and ID portrait under a “Verifying photo based identity” heading, with limited branding and a result conveyed primarily through a tinted photo and a bottom status banner.

In V2, Face Match keeps the same core comparison but wraps it in a cleaner, fully branded experience: an Incode header, a “verified by Incode” trust footer, a simplified “Verifying identity” title, and explicit, dedicated result screens — a green “Matched!” success with a clear **Continue** CTA, and a distinct “Faces do not match” error state.

<br />

<Image align="center" caption="V1 — a functional comparison with limited branding; the result is shown via a tinted photo and a bottom status banner." src="https://developer.incode.com/assets/914908bd0549d6aa7ffb9d9c436962ce.png" />

<br />

<Image align="center" caption="V2 — a fully branded, guided comparison with explicit match and no-match result screens and a clear next action." src="https://developer.incode.com/assets/94a4f464fffc30021abcbfa0af02deab.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities | V1 | V2 | Notes |
| ------------ | -- | -- | ----- |
| Selfie vs ID comparison | ✅ | ✅ | Both versions compare the live selfie against the ID portrait. |
| Match / no-match result | ✅ | ✅ | V2 presents dedicated success and error screens. |
| Result confirmation | ✅ | ✅ | V1 uses a tinted photo + status banner; V2 uses a clear result icon and message. |
| Brand header & trust footer | ❌ | ✅ | V2 adds the Incode logo header and “verified by Incode” footer. |
| Explicit Continue CTA | ❌ | ✅ | V2 adds a primary action on result screens. |
| Dedicated no-match error screen | ❌ | ✅ | V2 introduces a distinct “Faces do not match” state. |
| Customization options | ❌ | ✅ | V2 allows control over text, colors, and buttons via tokens. |
| Documentation completeness | ❌ | ✅ | V2 provides complete, standardized documentation coverage. |

<br />

***

<br />

## Behavior Differences

How the module presents itself and behaves across states.

<br />

| Behavior | V1 | V2 | Notes |
| -------- | -- | -- | ----- |
| Heading | “Verifying photo based identity” | “Verifying identity” | V2 simplifies and lightens the title for clarity. |
| Image labels | Solid dark Selfie/ID pills | Lighter outline labels | V2 reduces visual weight while keeping clarity. |
| Branding | No header or footer | Incode header + “verified by Incode” footer | V2 reinforces trust and brand consistency. |
| Success presentation | Tinted photo + bottom “Liveness success” banner | Green check + “Matched!” + Continue CTA | V2 makes the outcome and next step explicit. |
| No-match handling | Limited / implicit | Dedicated “Faces do not match” screen with CTA | V2 communicates failure clearly and guides the user forward. |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/086dc156ebaf6637ba76a236cc192cda.gif" />

<br />

Instead of isolated options per screen, V2 uses a unified token-based system that controls visuals and behavior with fewer parameters and predictable outcomes. This means less engineering work, consistent branding across modules, and reduced risk of breaking flows.

**For full details, visit the [Customization](/design-and-ux/face-match-customization/) tab of this module.**

<br />

<br />

---

- Path: `design-and-ux/fiscal-qr-ocr-customization`
- URL: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-customization/
- Markdown: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-customization.md

# Customization

This section outlines the elements you can customize within the **Fiscal QR OCR** module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text, scanning frame colors, and brand colors, and which elements remain fixed to ensure consistency, accessibility, and reliable QR detection logic across platforms.

<br />

## Tutorial Screen

This screen prepares the user for the QR scanning step. It displays a dedicated illustration of a fiscal QR code and provides instructions on how to position the document before proceeding.


<Image src="https://developer.incode.com/assets/483a05ac2c0e4a7e3bf4d516d5d8e5ba.png" align="center" />


<br />

### Customizable Elements

| Area                      | What can be customized                                      | Notes                                                       |
| ------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| **Title text**            | Screen title ("Zoom the QR code inside the frame")          | Fully localizable; should remain clear and action-oriented. |
| **Subtitle text**         | Supporting instruction ("QR will be scanned automatically") | Tone can match your brand voice; should remain informative. |
| **QR illustration**       | Fiscal QR code illustration                                 | Can be recolored using brand tokens.                        |
| **QR frame border color** | Illustration frame stroke                                   | Uses brand tokens.                                          |
| **Button**                | Label, color, radius                                        | Must follow platform guidelines.                            |
| **Background Color**      | Screen background                                           | Must maintain strong contrast with text and elements.       |
| **Brand Colors**          | Header text, accent color                                   | Uses brand tokens.                                          |
| **Footer**                | "Verified by Incode" line                                   | Optional but recommended for trust and product consistency. |

<br />

<br />

### Fixed Elements

| Element                            | Why it is fixed                                              |
| ---------------------------------- | ------------------------------------------------------------ |
| **QR detection logic**             | Must remain consistent for accurate fiscal QR code scanning. |
| **Component spacing & safe areas** | Required for device compatibility and visual stability.      |
| **Text hierarchy**                 | Optimized to communicate requirements clearly.               |
| **WCAG contrast requirements**     | Mandatory for accessibility and regulatory compliance.       |

<br />

<br />

### Token Refearence


<Image src="https://developer.incode.com/assets/c4404ca373e85cc3167e27033fc61c76.png" align="center" />


| UI Element            | Token                                                                       | Value   |
| --------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**        | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**        | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**     | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **QR frame border**   | Border Status Focus → Color/Brand/500                                       | #006AFF |
| **Button background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Footer text**       | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Footer icon**       | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Close icon**        | Icon/Neutral/0 Static → Color/Gray/0                                        | #FFFFFF |

<br />

### Design Notes

- Keep the instruction text concise and specific — users should immediately understand what type of document and QR code is expected.
- The QR code illustration should reinforce what the user needs to locate on their document before proceeding.
- Ensure tap targets meet accessibility guidelines.

<br />

***

## Ready to Scan

This screen appears when the camera is active and the module is waiting for the user to align a fiscal QR code within the scanning frame. The frame is in its neutral/searching state.


<Image src="https://developer.incode.com/assets/7ee84d4e104fd40baed77b24c4a2b1ed.png" align="center" />


<br />

### Customizable Elements

| Area            | What can be customized                              | Notes                                                             |
| --------------- | --------------------------------------------------- | ----------------------------------------------------------------- |
| **Title text**  | Scanning instruction ("Align QR code in the frame") | Fully localizable; should remain clear and action-oriented.       |
| **Skip button** | Label, color                                        | Action should allow the user to exit the scanning flow if needed. |
| **Background**  | Camera view overlay                                 | Dark background is standard for camera screens.                   |

<br />

### Fixed Elements

| Element                               | Why it is fixed                                                                                    |
| ------------------------------------- | -------------------------------------------------------------------------------------------------- |
| **Camera view**                       | Live camera feed required for QR code detection.                                                   |
| **Scanning frame shape and position** | Required for accurate QR code alignment and detection.                                             |
| **Frame color states**                | Blue = searching, green = detected, red = error. Logic is fixed; colors can be updated via tokens. |
| **QR detection logic**                | Must remain consistent for accurate fiscal QR code scanning.                                       |
| **Spacing & safe areas**              | Required for device consistency.                                                                   |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/cd3d09aa72f1fe0db5602c3e873b33df.png" align="center" />


| UI Element           | Token                             | Value   |
| -------------------- | --------------------------------- | ------- |
| **Title text**       | Text/Body/0 Static → Color/Gray/0 | #FFFFFF |
| **Skip button text** | Text/Body/0 Static → Color/Gray/0 | #FFFFFF |

<br />

### Design Notes

- Keep messaging short and reassuring; users should feel confident before proceeding.
- The green checkmark and clean layout reinforce the positive outcome without additional explanation needed.
- Background should remain clean to keep focus on the confirmation.

<br />

***

## Scanning - QR Detected&#x20;

This state is shown automatically when the camera successfully detects a fiscal QR code within the scanning frame. The frame border transitions to green to communicate that detection was successful and data extraction is in progress.


<Image src="https://developer.incode.com/assets/17ca97a188f52eca4817bf349d1054bf.png" align="center" />


<br />

### Customizable Elements

| Area                                    | What can be customized               | Notes                               |
| --------------------------------------- | ------------------------------------ | ----------------------------------- |
| **Title text**                          | Scanning instruction text            | Fully localizable.                  |
| **Skip button**                         | Label, color                         | Remains available during detection. |
| **Frame border color (detected state)** | Green border on successful detection | Uses positive status token.         |

<br />

<br />

### Fixed Elements

| Element                  | Why it is fixed                                                                               |
| ------------------------ | --------------------------------------------------------------------------------------------- |
| **Detection trigger**    | Frame color changes automatically upon successful QR detection; cannot be manually triggered. |
| **Status color mapping** | Green = detected/success; required for consistent user feedback.                              |
| **QR detection logic**   | Must remain consistent for accurate data extraction.                                          |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/6084588c535a7ad7160d8b4aa1e4beaf.png" align="center" />


| UI Element                  | Token                                              | Value   |
| --------------------------- | -------------------------------------------------- | ------- |
| **Title text**              | Text/Body/0 Static → Color/Gray/0                  | #FFFFFF |
| **Frame border (detected)** | Border Status Positive Static → Color/Positive/500 | #189F60 |
| **Skip button text**        | Text/Body/0 Static → Color/Gray/0                  | #FFFFFF |

<br />

### Design Notes

- The green frame transition happens automatically — no additional UI elements or animations should be added to this state.
- Keep the interface clean to allow users to focus on holding the document steady while data is being extracted.ity.

<br />

***

## Error — Invalid QR Code

Shown inline within the scanning screen when the detected QR code does not correspond to a valid fiscal document. The frame border changes to red and an error message appears below the frame, allowing the user to reposition and retry without leaving the screen.


<Image src="https://developer.incode.com/assets/2f58bcd47510c7e7cad7c92b2b6caf2b.png" align="center" />


<br />

### Customizable Elements

| Area                                 | What can be customized                           | Notes                                                      |
| ------------------------------------ | ------------------------------------------------ | ---------------------------------------------------------- |
| **Title text**                       | Scanning instruction text                        | Fully localizable.                                         |
| **Inline error message text**        | Error feedback ("Invalid QR scanned, try again") | Fully localizable; tone should be neutral and instructive. |
| **Frame border color (error state)** | Red border on invalid detection                  | Uses negative status token.                                |
| **Skip button**                      | Label, color                                     | Action remains available to exit the flow.                 |

<br />

<br />

### Fixed Elements

| Element                    | Why it is fixed                                               |
| -------------------------- | ------------------------------------------------------------- |
| **Error logic**            | Must accurately reflect the QR validation result.             |
| **Status color mapping**   | Red = negative/invalid; required for clarity and consistency. |
| **Inline error placement** | Positioned directly below the frame for clear attribution.    |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/6084588c535a7ad7160d8b4aa1e4beaf.png" align="center" />


| UI Element               | Token                                       | Value   |
| ------------------------ | ------------------------------------------- | ------- |
| **Title text**           | Text/Body/0 Static → Color/Gray/0           | #FFFFFF |
| **Frame border (error)** | Border Status Negative → Color/Negative/500 | #E71111 |
| **Inline error text**    | Text/Status/Negative → Color/Negative/500   | #E71111 |
| **Skip button text**     | Text/Body/0 Static → Color/Gray/0           | #FFFFFF |

<br />

### Design Notes

- Error messaging should be clear, direct, and action-oriented — users should understand they need to try a different QR code without feeling blamed.
- The red frame provides immediate visual feedback; pair it with the inline text to ensure accessibility.

<br />

***

## Error — Link Expired

Shown as a full-screen state when the onboarding session link the user is trying to access has expired. The user is informed of the issue and prompted to request a new link to continue the process.


<Image src="https://developer.incode.com/assets/7f2d21e436b4ba4814e1f21edabe6b88.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized              | Notes                                                      |
| -------------------- | ----------------------------------- | ---------------------------------------------------------- |
| **Title text**       | Error message ("Your link expired") | Fully localizable; tone should be neutral and non-blaming. |
| **Subtitle text**    | Supporting detail                   | Fully localizable.                                         |
| **Status icon**      | Error indicator                     | Can be replaced; must remain clearly negative.             |
| **Background color** | Full screen                         | Must support strong contrast.                              |

<br />

<br />

### Fixed Elements

| Element                  | Why it is fixed                                                |
| ------------------------ | -------------------------------------------------------------- |
| **Session expiry logic** | Must accurately reflect the session state; cannot be bypassed. |
| **Status color mapping** | Red = negative; required for clarity and consistency.          |
| **Title hierarchy**      | Emphasizes the issue clearly.                                  |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/68f50e79b0b3ff37964eca4a8e37c83e.png" align="center" />


| UI Element                 | Token                                      | Value   |
| -------------------------- | ------------------------------------------ | ------- |
| **Background**             | Surface/Neutral/0 → Color/Gray/0           | #FFFFFF |
| **Title text**             | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Subtitle text**          | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| **Status icon background** | Icon/Status/Negative → Color/Negative/500  | #E71111 |
| **Status icon (X mark)**   | Icon/Neutral/0 → Color/Gray/0              | #FFFFFF |

<br />

### Design Notes

- Messaging should be clear and guide the user toward a concrete next step — requesting a new link.
- Avoid technical language; the user should understand the issue immediately.
- Maintain consistent spacing and visual hierarchy for readability.

<br />

---

- Path: `design-and-ux/fiscal-qr-ocr-design`
- URL: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-design/
- Markdown: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-design.md

# Fiscal QR OCR

F**iscal QR OCR** guides the user through scanning a fiscal QR code from a supported document. Once the code is detected, the module extracts the corresponding URL, retrieves the associated fiscal data, and makes it available for downstream processing as part of the verification flow.

**Fiscal QR OCR** typically occurs during the document verification step, as a complementary or standalone module to capture fiscal information encoded in QR format.

![](https://developer.incode.com/assets/b70338ce838e672966a209db62bbad2f.gif)

<br />

***

## Where it fits in the flow

**Fiscal QR OCR&#x20;**&#x75;sually appears during the document verification step, either as a standalone module or alongside other capture steps.

Once the QR code is successfully scanned and the fiscal data is extracted, the flow continues to the next verification step or presents the final result, depending on the outcome and the downstream logic configured in the application.

***

## User Flow

The **Fiscal QR OCR** experience is designed to be clear and guided. The user is introduced to the scanning step through an intro screen, then directed to align the fiscal QR code within the scanning frame. The module detects and decodes the code automatically — a blue frame indicates the camera is actively searching, while a green frame confirms the code has been detected and data extraction is underway.

Once the scan is complete, the user receives a success state or an error message and the flow continues accordingly.

<br />


<Image src="https://developer.incode.com/assets/bd99d034ea06081f13bc2bcc7e8a2ede.png" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in Fiscal QR OCR, from the intro screen and active scanning state, through detection feedback, to the success and error outcomes.


<Image src="https://developer.incode.com/assets/0df62cbf88cc13acbbfe3d8f404f882b.png" align="center" />


<br />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the fiscal QR code is successfully detected and data is extracted with no interruptions.

The happy path represents the smoothest version of the experience, where the user aligns the QR code correctly within the frame, the module detects and decodes it automatically, and the fiscal data is extracted without errors or retries. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/e8944889d488cd65006850a974a53cfc.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/1f66726aa0dc0dc7e5f7cec3ba4bf177.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the Government Record Verification experience.

**✅ Do**

- Keep the intro screen copy clear about what type of document and QR code is expected.
- Use the scanning frame color states to communicate detection progress — blue for searching, green for detected.
- Provide clear inline error feedback when an invalid QR code is scanned, so the user can retry without leaving the screen.
- Keep the scanning interface clean and distraction-free to help users position the QR code correctly.
- Use the "verified by Incode" footer to maintain trust throughout the flow.

**❌ Don’t**

- Don't remove or skip the intro screen — users need to understand what document and QR code they are expected to scan.
- Don't rely solely on color to communicate scanning status; pair color changes with instructional text where possible.
- Don't remove error states — inline feedback for invalid QR codes and session-level errors must remain intact, as they correspond to specific detection logic.
- Don't add UI elements over the scanning frame that could obstruct the user's view of the QR code.

<br />

---

- Path: `design-and-ux/fiscal-qr-ocr-screens-states`
- URL: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the **Fiscal QR OCR** experience. Each state includes a brief description and a direct link to its source in Figma.

***

## Intro Screen

This screen appears at the beginning of the Fiscal QR OCR flow and prepares the user for the scanning step. It displays a dedicated illustration of a fiscal QR code and provides instructions on how to position the document for scanning. The user taps Continue to proceed to the active scanning screen.


<Image src="https://developer.incode.com/assets/b22b0738564137de4a4837be21ff377d.png" align="center" />


<br />

## Read to Scan

This screen appears when the camera is active and the module is ready to detect a fiscal QR code. The scanning frame is displayed with positioning guidance to help the user align the QR code correctly. At this state, the frame is neutral — the module is initialized but has not yet detected a code.


<Image src="https://developer.incode.com/assets/6055aa6968170e719870208e159a9e39.png" align="center" />


<br />

## Scanning - QR Detected&#x20;

This state is shown when the camera detects a fiscal QR code within the frame. The scanning frame border changes from its neutral state to green, indicating that the code has been successfully detected and data extraction is underway. The transition happens automatically without user action.


<Image src="https://developer.incode.com/assets/32e4d2bf26fbbb0f19d19ea6101a3650.png" align="center" />


<br />

## Verifying

Shown immediately after a successful QR code detection, while the module retrieves the corresponding URL and processes the extracted fiscal data. A loading spinner and a status message keep the user informed while the operation completes in the background.


<Image src="https://developer.incode.com/assets/9ead286b8f3fca589f19d7d720382f31.png" align="center" />


<br />

---

- Path: `design-and-ux/fiscal-qr-ocr-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-specs-guidelines.md

# Specs & Guidelines

The **Fiscal QR OCR** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/93d203650f3fd1c85d57f7525dd9bcc4.png" align="center" />


<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Fiscal QR OCR** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet. The active scanning screen uses the full device viewport to maximize the camera view and scanning frame visibility.


<Image src="https://developer.incode.com/assets/b100de6b56760d85b455369f2e9f1f2d.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                         | Behavior                                                                                      |
| ---------------------------------- | --------------------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; scanning frame scales to maintain usable detection area.       |
| **Standard phones (iPhone 12–16)** | Full layout shown; scanning frame and text hierarchy remain consistent.                       |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; scanning frame remains centered and properly proportioned. |
| **Foldables (e.g., Pixel Fold)**   | Larger scanning area with more balanced white space; content remains centered.                |
| **Tablets**                        | Increased layout margins; scanning frame and intro screen content scale proportionally.       |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding applied.              |

<br />

### What is responsive (and customizable)

| Element                     | Responsive Behavior                                       | Customizable                   |
| --------------------------- | --------------------------------------------------------- | ------------------------------ |
| **Scanning frame**          | Scales proportionally by viewport; remains centered       | Frame border color only        |
| **Title text**              | Remains centered and adapts to container width            | Yes, text is fully localizable |
| **Subtitle text**           | Wraps gracefully for longer translations                  | Yes, text is fully localizable |
| **Skip button**             | Pinned to bottom of the scanning screen                   | Label and color                |
| **QR illustration (intro)** | Scales proportionally within the intro layout             | Color & style                  |
| **Continue button**         | Width adjusts to container                                | Color & text                   |
| **Footer / watermark**      | Pinned to bottom safe area                                | Optional                       |
| **Background surfaces**     | Expand to full viewport                                   | Yes                            |
| **Error message (inline)**  | Positioned directly below the scanning frame at all sizes | Color & text                   |

<br />

### What remains fixed across breakpoints

| Element                      | Reason                                                                                                  |
| ---------------------------- | ------------------------------------------------------------------------------------------------------- |
| **QR detection logic**       | Must remain consistent for accurate fiscal QR code scanning and data extraction.                        |
| **Scanning frame position**  | Required for reliable QR code alignment and detection across all devices.                               |
| **Frame color state logic**  | Blue = searching, green = detected, red = error. Logic is fixed; only colors can be updated via tokens. |
| **Minimum text size**        | Required for readability & WCAG compliance.                                                             |
| **Minimum tap target sizes** | Ensures accessibility on mobile.                                                                        |
| **Overall hierarchy**        | Prevents cognitive load at different sizes.                                                             |

<br />

### Design Notes

- The scanning frame always remains the dominant UI element during the active scanning state, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI elements over the camera view — they may obstruct the user's view of the QR code and affect detection accuracy.
- Multiline text is handled gracefully, but keep localized strings concise for scanning instructions and error messages.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/87cda46834128f0059a53cda4f0b0dd2.png" align="center" />


<br />

<br />

***

## Prototype & Transitions

Fiscal QR OCR includes predefined transition rules and micro-interactions that ensure a smooth user experience from the intro screen and active scanning state, through the QR detection feedback, to the verifying and error outcomes. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/979f0122765b392f79631bd0c6436251.gif" align="center" />


<br />

<br />

***

## Localization

The **Fiscal QR OCR** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/58936cee7cd5a8233743311177cc55b7.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable, including the intro screen title and subtitle, scanning instructions, inline error messages, and session-level error messages.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Scanning instruction text must remain concise regardless of language — long strings on the camera screen can distract from the scanning task.
- Inline error messages should be localized carefully to remain clear and action-oriented in each supported language.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.<br />Incode supports a variety of languages.

<br />

---

- Path: `design-and-ux/fiscal-qr-ocr-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/fiscal-qr-ocr-v1-vs-v2-comparison.md

# Fiscal QR OCR V1 vs V2 Comparison

In V1, Fiscal QR OCR offers a basic scanning experience with minimal user guidance, no dedicated intro screen with contextual illustrations, and limited customization options. The scanning flow runs with standard camera behavior and generic feedback states.

In V2, Fiscal QR OCR delivers a significantly improved experience with a dedicated intro screen, context-specific QR illustrations, live scanning feedback through frame color states, inline error handling, and full alignment with the token-based design system — resulting in a clearer, more guided, and more brandable flow.


<Image src="https://developer.incode.com/assets/22bf05293bfcd270865e25e446559ea7.png" align="center" caption="V1 is a basic QR scanning experience with limited guidance and no tokenized customization." />


<br />


<Image src="https://developer.incode.com/assets/e8338bb6cba2c8a76fe23b88b8e00d4b.png" align="center" caption="V2 delivers a refined scanning experience with a dedicated intro, live detection feedback, inline error states, and full token-based customization." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| QR code scanning           | ✅  | ✅  | Both versions scan and decode fiscal QR codes automatically when the code is detected.                                           |
| Error states               | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                                      | V2                                                                                                 | Notes                                                                                                                    |
| ------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Tutorial behavior   | Basic visual of standard QR code layout | Dedicated intro screen with a fiscal QR illustration providing context specific to the document    | V2 is intuitive and directs the user's focus toward the scanning instructions with a more relevant visual reference.     |
| Scanning experience | Native camera experience                | Custom camera view with a QR targeting frame, live detection feedback, and inline error hints      | V2 uses a custom scanning experience with instruction text, a color-coded positioning frame, and inline error messaging. |
| Detection feedback  | No live feedback during scanning        | Real-time frame color state indicating whether a QR code is being searched for, found, or rejected | V2 actively communicates scanning progress so users understand what the module is doing at each moment.                  |
| State transitions   | Default transitions                     | Specifically designed screen-by-screen transitions for smoothness                                  | V2 includes transition guidelines as part of the module documentation package.                                           |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/7033554071cd202eda1d2ec0262e8f96.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify. This includes the QR illustration color, scanning frame border color states, button styles, instructional text, and error message styling — making it straightforward to align the module with your brand without affecting core scanning and detection logic.

<br />

<br />

---

- Path: `design-and-ux/forms-and-data-entry-design`
- URL: https://developer.incode.com/design-and-ux/forms-and-data-entry-design/
- Markdown: https://developer.incode.com/design-and-ux/forms-and-data-entry-design.md

# Forms and Data Entry

**Forms and data entry**  is a key step in onboarding and identity verification workflows. It presents users with a set of configurable input fields to capture essential personal information — such as ID number, email address, country of residence, and date of birth — before proceeding to document capture or biometric verification..

<Image align="center" src="https://developer.incode.com/assets/2c1cbdf8a6d5fc4b783d0e8ac8bea46f.gif" />

***

## Where it fits in the flow

**Forms and Data Entry** is typically positioned at the beginning of an onboarding or identity verification flow, before document capture and biometric checks are performed, depending on the configured workflow..

***

## User Flow

The **Forms and Data Entry** experience guides users through a set of configurable input fields, inline validation feedback, and a final submission confirmation..

<Image align="center" src="https://developer.incode.com/assets/27ad123a9afd594b4c1540eb2395aed0.png" />

<br />

***

## Full Flow Map

<Image align="center" src="https://developer.incode.com/assets/ea889891e68278ff1a46a80167697c2e.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the user fills in all required fields correctly, without needing to correct any errors, and completes submission on the first attempt.

The **happy path** represents the smoothest version of the experience: the user opens the form, enters their ID number, email, country of residence, and date of birth, taps "Continue," and the system processes and confirms the submission.

The user reaches the next step on the first attempt without encountering any validation errors or incomplete fields. Light and dark mode previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/c33b15adc79fae0a3ea6692385a5a4c7.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/421a130f02238bb7eea1e6cb2899c8ef.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Forms and data entry**

✅ Do

* Clearly indicate required and optional fields so users understand what information is needed before submission.
* Provide immediate visual feedback during submission — display a loading state, disable inputs, and prevent duplicate submissions while processing.

❌ Don't

* Don’t allow users to continue unless all required fields are completed and valid.
* Don’t use inconsistent field formats, spacing, or interaction patterns across the form experience.

---

- Path: `design-and-ux/geolocation-customization`
- URL: https://developer.incode.com/design-and-ux/geolocation-customization/
- Markdown: https://developer.incode.com/design-and-ux/geolocation-customization.md

# Customization

This section outlines the elements you can customize within the **Geolocation** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

## Geo Not Determined Screen

This screen appears when the module first requests permission to access the user's current location. It’s the initial state, shown before any user action.

<Image align="center" src="https://developer.incode.com/assets/03c9faebad2b710290b14621be94fd4d.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**          | **Notes**                                           |
| :--------------- | :---------------------------------- | :-------------------------------------------------- |
| **Text**         | Title, subtitle, button label       | Fully localizable; tone can be adapted              |
| **Illustration** | Colors or full replacement          | Must represent a map/location theme                 |
| **Brand Colors** | Illustration accent, button, header | Uses brand tokens                                   |
| **Buttons**      | Label, color                        | Must follow platform and WCAG standards             |
| **Footer**       | “Verified by Incode” text           | Optional but recommended for transparency and trust |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                               |
| :-------------------- | :------------------------------------------------ |
| Layout structure      | Ensures consistency across onboarding modules     |
| Illustration style    | Must remain consistent with location flow visuals |
| Spacing & safe areas  | Required for device compatibility                 |
| Text hierarchy        | Optimized for readability                         |
| Close icon position   | Standardized for user familiarity                 |
| WCAG minimum contrast | Mandatory for accessibility compliance            |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6b7b394fa54725bae8089d130bc2a2df.png" />

| **UI Element**    | **Token**                        | **Raw Value** |
| :---------------- | :------------------------------- | :------------ |
| Title text        | `text-body-primary`              | `#262831`     |
| Background        | `surface-neutral-0`              | `#FFFFFF`     |
| Button background | `button-primary-surface-default` | `#006AFF`     |
| Button text       | `button-primary-text-default`    | `#FFFFFF`     |

<br />

### Design Notes

* Keep copy short to minimize cognitive load.
* The illustration establishes the concept of location with neutral tones to maintain focus on the button.
* The “verified by Incode” footer reinforces authenticity subtly, maintaining accessibility contrast.

***

## Allow Location Access Screen – Native

Displayed on native platforms when the user denies access to location. It guides them to grant permission manually via device settings or skip the step.

<Image align="center" src="https://developer.incode.com/assets/c5dc4738b18bb638ea5fbf361d1c6cb6.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                         | **Notes**                                        |
| :--------------- | :----------------------------------------------------------------- | :----------------------------------------------- |
| **Text**         | Title, subtitle, button labels (“Open settings”, “Skip this step”) | Fully localizable                                |
| **Icons**        | Warning icon color                                                 | Must preserve meaning and accessibility contrast |
| **Brand Colors** | Buttons, links, highlight elements                                 | Uses brand tokens                                |
| **Buttons**      | Label, color                                                       | Must follow platform and WCAG standards          |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                            |
| :------------------------- | :--------------------------------------------- |
| Layout structure           | Maintains visual continuity with other modules |
| Warning icon shape         | Represents universal alert pattern             |
| Button spacing & placement | Optimized for tap targets                      |
| Text hierarchy             | Follows global UX standards                    |
| Close icon position        | Consistent across modules                      |
| WCAG minimum contrast      | Required for readability and compliance        |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/b3ede04fbb4d515afa39e6ed589d7c29.png" />

| **UI Element**                              | **Token**                         | **Raw Value** |
| :------------------------------------------ | :-------------------------------- | :------------ |
| Title text                                  | `text-body-primary`               | `#262831`     |
| Subtitle text                               | `text-body-secondary`             | `#60667C`     |
| Warning icon                                | `icon-status-warning`             | `#FF9900`     |
| Background                                  | `surface-neutral-0`               | `#FFFFFF`     |
| Primary button background (“Open settings”) | `button-primary-surface-default`  | `#006AFF`     |
| Primary button text                         | `button-primary-text-default`     | `#FFFFFF`     |
| Secondary button border (“Skip this step”)  | `button-secondary-border-default` | `#006AFF`     |
| Secondary button text                       | `text-accent-brand`               | `#006AFF`     |

<br />

### Design Notes

* The layout mirrors other SDK modules for predictable UX and user familiarity.
* Maintain a clear hierarchy between primary and secondary actions.
* The warning icon (icon-status-warning) provides immediate visual feedback but remains minimal to avoid alarm.

<br />

***

## Allow Location Access Screen – Web

This screen provides detailed, step-by-step instructions to enable location permissions in browser settings (for web flows).

<Image align="center" src="https://developer.incode.com/assets/f604873e9388d50c8957fafa16de5bd9.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**                           | **Notes**                                          |
| :------------------- | :--------------------------------------------------- | :------------------------------------------------- |
| **Instruction Text** | Steps and phrasing (“...tap Chrome”, “Tap Location”) | Fully localizable; must remain short and effective |
| **Icons**            | Colors, style, or illustration replacement           | Must clearly indicate action steps                 |
| **Brand Colors**     | Buttons and highlights                               | Uses brand tokens                                  |
| **Buttons**          | Label and color (“Refresh page”, “Skip this step”)   | Must follow platform and WCAG standards            |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                       |
| :-------------------- | :---------------------------------------- |
| Layout structure      | Keeps parity between web and native flows |
| Step order            | Required for browser permission accuracy  |
| Text hierarchy        | Ensures clarity of instructions           |
| Button placement      | Optimized for quick completion            |
| WCAG minimum contrast | Required for web accessibility standards  |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6a0f02f8d3b6973eea2aae7776fc88ec.png" />

| **UI Element**                                     | **Token**                         | **Raw Value** |
| :------------------------------------------------- | :-------------------------------- | :------------ |
| Title text                                         | `text-body-primary`               | `#262831`     |
| Instruction text                                   | `text-body-primary`               | `#262831`     |
| Highlighted text (“Chrome”, “While using the app”) | `text-body-secondary`             | `#60667C`     |
| Background                                         | `surface-neutral-0`               | `#FFFFFF`     |
| Primary button background (“Refresh page”)         | `button-primary-surface-default`  | `#006AFF`     |
| Primary button text                                | `button-primary-text-default`     | `#FFFFFF`     |
| Secondary button border (“Skip this step”)         | `button-secondary-border-default` | `#006AFF`     |
| Secondary button text                              | `text-accent-brand`               | `#006AFF`     |

<br />

### Design Notes

* This screen is tailored for browser-based flows where system permissions differ from native.
* Highlighted phrases (“Chrome”, “While using the app”) use text-body-secondary for emphasis while preserving scanability.
* Layout presents a step-by-step visual hierarchy: clear numbered or iconographic instructions with consistent vertical spacing.
* Visual rhythm relies on consistent spacing between icon + text pairs for each instruction row.
* Minimal use of color outside the brand blue keeps the attention on interactive elements and icons.

<br />

***

## Geo Determined Screen

Shown once the system successfully determines the user’s location. It confirms the current detected city and country before proceeding to the next step.

<Image align="center" src="https://developer.incode.com/assets/c252b06d6a67852faf20a3e1916daff0.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                         | **Notes**                                                        |
| :--------------- | :------------------------------------------------- | :--------------------------------------------------------------- |
| **Text**         | Title (“You are currently in:”), button label      | Fully localizable                                                |
| **Illustration** | Colors or full replacement                         | Must clearly represent location confirmation                     |
| **Brand Colors** | Illustration accent, button background, highlights | Uses brand tokens                                                |
| **Buttons**      | Label and color                                    | Must follow platform and WCAG standards                          |
| **Footer**       | “Verified by Incode” text                          | Optional but recommended for consistency, transparency and trust |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Layout structure      | Maintains consistency with other verification modules |
| Spacing & alignment   | Optimized for layout consistency                      |
| Text hierarchy        | Required for readability and hierarchy                |
| Close icon position   | Standardized for familiarity                          |
| WCAG minimum contrast | Required for web accessibility standards              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/b7b03b523cec385f66f6b5db2b8ae4ac.png" />

| **UI Element**                | **Token**                        | **Raw Value** |
| :---------------------------- | :------------------------------- | :------------ |
| Title text                    | `text-body-primary`              | `#262831`     |
| Subtitle text (location name) | `text-body-secondary`            | `#60667C`     |
| Background                    | `surface-neutral-0`              | `#FFFFFF`     |
| Button background             | `button-primary-surface-default` | `#006AFF`     |
| Button text                   | `button-primary-text-default`    | `#FFFFFF`     |

<br />

### Design Notes

* Represents the confirmation state — a positive closure before transition to the next module.
* The Continue button keeps the same placement and styling as in the initial screen for consistency.
* The location pin illustration reinforces successful completion using brand color for recognition and continuity.

---

- Path: `design-and-ux/geolocation-design`
- URL: https://developer.incode.com/design-and-ux/geolocation-design/
- Markdown: https://developer.incode.com/design-and-ux/geolocation-design.md

# Geolocation

The Geolocation module determines the user's current location through browser or device permissions. It is used to verify the user's geographical position as part of identity validation or compliance workflows.

<Image align="center" border={false} src="https://developer.incode.com/assets/b3eb74a10060464ae8f75fdbbdd57070.gif" />

***

## Where it fits in the flow

**Geolocation** usually appears before ID and Selfie Capture.

After the user’s location is confirmed, the flow continues to biometric or document verification steps depending on the configured process.

***

## User Flow

The **Geolocation** experience guides the user from permission to confirmation. After granting access, the system detects the user’s current location and displays a confirmation screen with the detected city or region.

If detection fails or permission is denied, fallback paths guide the user to adjust their settings or skip the step (if option to skip is enabled via configuration settings). Once access is restored, the user can retry detection or continue to the next module.

<Image align="center" border={false} src="https://developer.incode.com/assets/4c5acb7982a3a5ed148894897f3637e3.png" />

<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in the Geolocation module, from initial screen and location permission handling to successful location detection, fallback paths for denied permissions, and final confirmation.

It visually represents both the ideal and alternative user journeys, helping teams understand all possible user interactions and system states within the module.

<Image align="center" border={false} src="https://developer.incode.com/assets/ac8cb5c6ce65a3d6b72510c023948415.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the geolocation is detected successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user grants location access, the system accurately detects their current position, and the flow proceeds automatically without requiring manual retries or permission troubleshooting.

Both light and dark mode previews are included so design, product, and engineering teams can validate visual consistency and accessibility across themes.

<Image align="center" alt="Geolocation module - Happy Path in Light mode" border={false} caption="Light mode" src="https://developer.incode.com/assets/7cc51c6aade7891b845fe8310964e8eb.png" />

<Image align="center" alt="Geolocation module - Happy Path in Dark mode" border={false} caption="Dark mode" src="https://developer.incode.com/assets/4ad7e518a285aadbc893129c36348478.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Geolocation** experience.

**✅ Do**

* Explain why location data is requested — transparency builds trust.
* Offer a visible “Skip this step” option if location isn’t mandatory.
* Localize all geographic messages and region names.

**❌ Don’t**

* Don’t block progress indefinitely if the user denies permission.
* Avoid long delays.

---

- Path: `design-and-ux/geolocation-screens-states`
- URL: https://developer.incode.com/design-and-ux/geolocation-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/geolocation-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the Geolocation experience. Each state includes a brief description.

***

## Geo not determined

This screen requests permission to access the user’s current location. It is the initial state of the Geolocation step, appearing before any user action is taken.

<Image align="center" border={false} src="https://developer.incode.com/assets/a67b972a3e3be844207d36200072be24.png" />

<br />

<br />

## Allow location access - Native and Web

This screen appears if user rejects location access when the system prompts the user to enable location it. It guides the user to grant permission manually or skip the step if desired.

<Image align="center" border={false} src="https://developer.incode.com/assets/2063f09ca571db7045728e367fc40601.png" />

<br />

<br />

## Geo Determined

Displayed after the user grants permission. The system fetches and confirms the current location before moving to the next step.

<Image align="center" border={false} src="https://developer.incode.com/assets/ee1a1d2497539ce8f81aaa098302fe73.png" />

<br />

---

- Path: `design-and-ux/geolocation-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/geolocation-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/geolocation-specs-guidelines.md

# Specs & Guidelines

The **Geolocation** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" border={false} src="https://developer.incode.com/assets/c2758854fb1525bca680c11ea7a367fa.png" />

<br />

***

## Responsiveness & Viewport Adaptation

The **Geolocation** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas, such as CTAs, remain visible, accessible, and consistently aligned across platforms.

<Image align="center" border={false} src="https://developer.incode.com/assets/9fabb58220d5184eb17dbf6ee8569b8e.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                               |
| :--------------------------------- | :------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | Content stacks vertically; map or location icon scales down for visibility |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                 |
| **Tall/narrow Android devices**    | Vertical spacing adapts to maintain balance                                |
| **Foldables (e.g., Pixel Fold)**   | Map illustration expands; centered layout with even white space            |
| **Tablets**                        | Wider margins and proportional scaling of map and text                     |
| **Desktop web**                    | Centered content with max-width constraint and safe-area padding           |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                            | **Customizable**       |
| :------------------ | :------------------------------------------------- | :--------------------- |
| Map / Illustration  | Scales with viewport; adapts to portrait/landscape | Color and style only   |
| Instruction text    | Reflows to one or two lines depending on width     | Yes, fully localizable |
| Buttons             | Width adjusts to container, spacing adapts         | Color & text           |
| Footer / watermark  | Pinned to bottom safe area                         | Optional               |
| Background surfaces | Expand to full viewport                            | Yes                    |
| Header area         | Adjusts padding per device safe insets             | Limited (color only)   |

<br />

### What remains fixed across breakpoints

| **Element**              | **Reason**                                 |
| :----------------------- | :----------------------------------------- |
| Location detection logic | Must remain consistent for accuracy        |
| Icon proportions         | Maintain visual clarity and recognition    |
| Minimum text size        | Ensures readability & WCAG compliance      |
| Minimum tap target sizes | Accessibility requirement on mobile        |
| Layout hierarchy         | Keeps experience consistent across devices |

<br />

### Design Notes

* The location icon or map remains the visual focal point across all devices.
* Vertical spacing uses fixed-safe thresholds; horizontal layout is fluid.
* Avoid adding custom elements above or below the module to maintain alignment.
* Text reflows smoothly for localization, but long strings should be avoided for clarity.

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" border={false} src="https://developer.incode.com/assets/5c1e49c02bf3f51af0ec53617a5ff95a.png" />

<br />

***

## Prototype & Transitions

Geolocation includes predefined transition rules and micro-interactions that ensure a smooth user experience. Animation guidelines are documented directly in Figma prototypes.

<Image align="center" border={false} src="https://developer.incode.com/assets/6691434d2e203887c08fbcc35fc24044.gif" />

<br />

***

## Localization

The **Geolocation** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" border={false} src="https://developer.incode.com/assets/d5255cfe9b11554e87464fa66562d3a7.png" />

<br />

### Key considerations

* Incode supports a variety of languages.
* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.

<br />

---

- Path: `design-and-ux/geolocation-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/geolocation-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/geolocation-v1-vs-v2-comparison.md

# Geolocation V1 vs V2 Comparison

V1 provides a functional geolocation experience that supports the required validation logic. However, the flow is rigid and offers limited flexibility to adapt to different products, markets or branding needs, which can lead to inconsistencies and higher user friction.

V2 redesigns the geolocation flow to be clearer, more flexible and design-system-aligned. Built on a token-based approach, it enables consistent experiences across platforms while allowing customization, helping reduce user confusion and drop-off during verification.

<br />

<Image align="center" caption="V1 is functional geolocation flow focused on basic location determination." src="https://developer.incode.com/assets/a395cfd7aabb2774d61f50a886f29c26.jpg" />

<Image align="center" caption="V2 is a redesigned geolocation experience focused on clarity, flexibility and consistency across platforms." src="https://developer.incode.com/assets/f5504125fefc710a6f7f2a2ad9e8098b.jpg" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Location detection         | ✅  | ✅  | Core geolocation functionality unchanged.                                                                                        |
| Permission handling        | ✅  | ✅  | V2 supports configurable permission handling and clearer user messaging.                                                         |
| Error States               | ✅  | ✅  | Both versions handle common geolocation and permission error scenarios.                                                          |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior              | V1                               | V2                                                                | Notes                                                                          |
| --------------------- | -------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions     | Default transitions              | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Flow and UI structure | Functional but less standardized | Structure and consistent                                          | Aligned with the tokenized design system architecture.                         |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/e9651c443aff3ecb3750d0918188c5d2.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

<br />

---

- Path: `design-and-ux/government-record-verification-customization`
- URL: https://developer.incode.com/design-and-ux/government-record-verification-customization/
- Markdown: https://developer.incode.com/design-and-ux/government-record-verification-customization.md

# Customization

This section outlines the elements you can customize within the **Government Record Verification** module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text and brand colors, and which elements remain fixed to ensure consistency, accessibility, and reliable verification logic across platforms.

<br />

## Government Record Verification

This screen appears while the module runs a background check against the corresponding government entity records. A spinner and status message keep the user informed while the operation completes.


<Image src="https://developer.incode.com/assets/eebb2820a52fec1a41893920edafe425.png" align="center" />


<br />

### Customizable Elements

| Area                         | What can be customized                                                       | Notes                                                                                    |
| ---------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| **Title text**               | Loading message ("Hold on a sec..")                                          | Fully localizable; should remain concise.                                                |
| **Subtitle text**            | Supporting message ("Checking your information with the government records") | Tone can match your brand voice; should reference the government check for transparency. |
| **Spinner accent color**     | Primary spinner stroke                                                       | Uses brand tokens; must remain visually clear.                                           |
| **Spinner background color** | Secondary spinner stroke                                                     | Should maintain contrast with accent.                                                    |
| **Background Color**         | Screen background                                                            | Must preserve readability and contrast.                                                  |
| **Footer**                   | "Verified by Incode + Government" line                                       | Optional but strongly recommended for trust and transparency.                            |

<br />

<br />

### Fixed Elements

| Element                     | Why it is fixed                                                   |
| --------------------------- | ----------------------------------------------------------------- |
| **Verification logic**      | Must remain consistent for accurate government record comparison. |
| **Processing flow timing**  | Linked to backend processing; cannot be shortened or skipped.     |
| **Spinner animation style** | Standardized across SDK for performance and recognizability.      |
| **Spacing & safe areas**    | Required for device consistency.                                  |
| **Minimum contrast**        | Required for accessibility and compliance.                        |

<br />

<br />

### Token Refearence


<Image src="https://developer.incode.com/assets/2f84a9345923cbd7988bc6df0532711b.png" align="center" />


| UI Element                | Token                                                                | Value   |
| ------------------------- | -------------------------------------------------------------------- | ------- |
| **Background**            | Surface/Neutral/0 → Color/Gray/0                                     | #FFFFFF |
| **Spinner background**    | Spinner/Surface/Secondary → Surface/Brand/50 → Color/Brand/50        | #E5F0FF |
| **Spinner accent**        | Spinner/Surface/Primary → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Title text**            | Spinner/Text/Title → Text/Body/800 (Primary) → Color/Gray/800        | #262831 |
| **Subtitle text**         | Spinner/Text/Subtitle → Text/Body/500 (Secondary) → Color/Gray/500   | #60667C |
| **Footer brand text**     | Icon/Brand/500 Static → Color/Brand/500                              | #006AFF |
| **Footer secondary text** | Text/Body/500 (Secondary) → Color/Gray/500                           | #60667C |
| **Footer icon**           | Icon/Neutral/0 Static → Color/Gray/0                                 | #FFFFFF |

<br />

### Design Notes

- Keep copy short and specific — users should understand verification is actively happening against government records.
- The subtitle must reference the government records source to build trust and reduce uncertainty during the wait.
- Avoid adding imagery or additional UI elements that may distract from the verification state.

<br />

***

## Success Screen

Shown when the identity data has been successfully matched against the government records, confirming that verification passed. The user receives a clear visual confirmation before the flow continues to the next step.


<Image src="https://developer.incode.com/assets/3a53aea519041077043d57f92201bc24.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized                 | Notes                                                               |
| -------------------- | -------------------------------------- | ------------------------------------------------------------------- |
| **Title text**       | Success message ("Identity verified!") | Fully localizable.                                                  |
| **Status icon**      | Green checkmark                        | Can replace with custom success icon; must remain clearly positive. |
| **Background color** | Full-screen background                 | Keep high contrast with icon and text.                              |
| **Footer**           | "Verified by Incode + Government" line | Optional but strongly recommended.                                  |

<br />

### Fixed Elements

| Element                  | Why it is fixed                                       |
| ------------------------ | ----------------------------------------------------- |
| **Verification logic**   | Must reflect actual backend result; not customizable. |
| **Status color mapping** | Green = positive; required for consistent semantics.  |
| **Icon placement**       | Ensures clarity and recognition.                      |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/ede1570392b5b9e6075bf8a9ecb2a655.png" align="center" />


| UI Element                  | Token                                      | Value   |
| --------------------------- | ------------------------------------------ | ------- |
| **Background**              | Surface/Neutral/0 → Color/Gray/0           | #FFFFFF |
| **Title text**              | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Status icon background**  | Icon/Status/Positive → Color/Positive/500  | #189F60 |
| **Status icon (checkmark)** | Icon/Neutral/0 → Color/Gray/0              | #FFFFFF |
| **Footer brand text**       | Icon/Brand/500 Static → Color/Brand/500    | #006AFF |
| **Footer secondary text**   | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| **Footer icon**             | Icon/Neutral/0 Static → Color/Gray/0       | #FFFFFF |

<br />

### Design Notes

- Keep messaging short and reassuring; users should feel confident before proceeding.
- The green checkmark and clean layout reinforce the positive outcome without additional explanation needed.
- Background should remain clean to keep focus on the confirmation.

<br />

***

## Error&#x20;

Shown when no matching record is found for the provided identity data in the government registry. The user is informed with a clear error message and the flow cannot continue until the issue is addressed.


<Image src="https://developer.incode.com/assets/2eef8bb3e096d1424b3dabb6f8ca5180.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized                 | Notes                                                      |
| -------------------- | -------------------------------------- | ---------------------------------------------------------- |
| **Title text**       | Error message ("User not found")       | Fully localizable; tone should be neutral and non-blaming. |
| **Status icon**      | Error indicator                        | Can be replaced; must remain clearly negative.             |
| **Background color** | Full screen                            | Must support strong contrast.                              |
| **Footer**           | "Verified by Incode + Government" line | Optional but recommended.                                  |

<br />

<br />

### Fixed Elements

| Element                  | Why it is fixed                                              |
| ------------------------ | ------------------------------------------------------------ |
| **Error logic**          | Must accurately reflect the government record lookup result. |
| **Status color mapping** | Red = negative; required for clarity and consistency.        |
| **Title hierarchy**      | Emphasizes the issue clearly.                                |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/d5342c15ce0b02507cb8a6214a312ecc.png" align="center" />


| UI Element                 | Token                                      | Value   |
| -------------------------- | ------------------------------------------ | ------- |
| **Background**             | Surface/Neutral/0 → Color/Gray/0           | #FFFFFF |
| **Title text**             | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Status icon background** | Icon/Status/Negative → Color/Negative/500  | #E71111 |
| **Status icon (X mark)**   | Icon/Neutral/0 → Color/Gray/0              | #FFFFFF |
| **Footer brand text**      | Icon/Brand/500 Static → Color/Brand/500    | #006AFF |
| **Footer secondary text**  | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| **Footer icon**            | Icon/Neutral/0 Static → Color/Gray/0       | #FFFFFF |

<br />

### Design Notes

- Error messaging should be clear, direct, and action-oriented without technical language.
- Users should understand the issue at a glance and know what to do next.
- Maintain consistent spacing and visual hierarchy for readability.

<br />

<br />

---

- Path: `design-and-ux/government-record-verification-design`
- URL: https://developer.incode.com/design-and-ux/government-record-verification-design/
- Markdown: https://developer.incode.com/design-and-ux/government-record-verification-design.md

# Government Record Verification

**Government Record Verification** automatically compares the identity data extracted from the user's document against the records held by the corresponding government entity — such as the INE in Mexico or the Registraduría in Colombia. The verification runs in the background and presents the user with a clear outcome once the check is complete.

**Government Record Verification** typically occurs after the document capture or upload step, once identity data has been extracted and is ready to be validated against the official government source.

![](https://developer.incode.com/assets/9098cf7157242883e8e8307782412e7b.gif)

<br />

***

## Where it fits in the flow

Government Record Verification usually appears after the document capture or upload step as part of the identity verification pipeline.

Once the module completes the comparison against the government records, the flow continues to the next verification step or presents the final result, depending on the outcome and the downstream logic configured in the application.

***

## User Flow

The Government Record Verification experience is designed to be transparent and reassuring. The user is informed that their identity is being verified while the module runs a background check against the relevant government source.

Once the verification completes, the user receives a clear success or error state and the flow continues accordingly.

<br />


<Image src="https://developer.incode.com/assets/cdc228f4c56c432d7526a0899bb8f031.jpg" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in Government Record Verification, from the verification loading state through to the success and error outcomes.


<Image src="https://developer.incode.com/assets/3c5437d9368a88e7d9fe49d98e448c6e.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the identity data is successfully matched against the government records with no interruptions.

The happy path represents the smoothest version of the experience, where the user's information is found and matched in the government registry without errors or retries. The flow moves directly from the verification loading state to the success confirmation. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/9b1275a22e51b1b73c0179eb836b53d1.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/e73740ed982ab17e2798ef2d5eb91ae1.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the Government Record Verification experience.

**✅ Do**

- Keep the loading state copy clear and specific — inform the user their information is being checked against government records.
- Display a clean, unambiguous success state so users feel confident before proceeding.
- Provide clear error states that explain the issue without technical language and guide the user on next steps
- Use the "verified by Incode + Government" footer to reinforce trust and transparency.

**❌ Don’t**

- Don't remove or skip the loading state — users need to understand verification is in progress.
- Don't use generic loading copy; always reference the government record check explicitly.
- Don't rely solely on color to communicate the verification outcome.
- Don't remove error states, as they correspond to specific logic that must be surfaced to the user.

<br />

---

- Path: `design-and-ux/government-record-verification-screens-states`
- URL: https://developer.incode.com/design-and-ux/government-record-verification-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/government-record-verification-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the Government Record Verification experience. Each state includes a brief description and a direct link to its source in Figma.

***

## Government Record Verification

This screen appears while the module runs a background check, comparing the identity data extracted from the document against the records held by the corresponding government entity. The user is informed that verification is in progress with a loading spinner and a status message referencing the government records source.


<Image src="https://developer.incode.com/assets/8257044ba0e991a44117b054ac761705.png" align="center" />


<br />

## Success

Shown when the identity data has been successfully matched against the government records, confirming that verification passed. The user receives a clear visual confirmation before the flow continues to the next step.


<Image src="https://developer.incode.com/assets/d91118641c19c41c7b9d39e507b815a7.png" align="center" />


<br />

## Error&#x20;

Shown when no matching record is found for the provided identity data in the government registry. The user is informed with a clear error message and the flow cannot continue until the issue is addressed.


<Image src="https://developer.incode.com/assets/c2d2b53d5e54574931c684e03c36a605.png" align="center" />


<br />

---

- Path: `design-and-ux/government-record-verification-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/government-record-verification-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/government-record-verification-specs-guidelines.md

# Specs & Guidelines

The **Government Record Verification&#x20;**&#x6D;odule includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/3fda484e687ca7730da9eaff4270004f.png" align="center" />


<br />

**Open Screens Specs in [Figma](https://www.figma.com/design/BXeJ6Q3TXahJVWEt8QoMVA/Face-Match---In-Production?node-id=18-19332)**

<br />

***

## Responsiveness & Viewport Adaptation

The **Government Record Verification** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/5e5a3849e9ef00f29539affa2295e144.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                         | Behavior                                                                           |
| ---------------------------------- | ---------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; spinner and text scale down to maintain visibility. |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent.                        |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; spinner and text remain centered.               |
| **Foldables (e.g., Pixel Fold)**   | Larger centered layout with more balanced white space.                             |
| **Tablets**                        | Increased layout margins; spinner and status content scale proportionally.         |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding.           |

<br />

### What is responsive (and customizable)

| Element                 | Responsive Behavior                             | Customizable                   |
| ----------------------- | ----------------------------------------------- | ------------------------------ |
| **Spinner**             | Remains centered in the layout                  | Color only                     |
| **Title text**          | Remains centered and adapts to container width  | Yes, text is fully localizable |
| **Subtitle text**       | Wraps gracefully for longer translations        | Yes, text is fully localizable |
| **Status icon**         | Remains centered and maintains distance to text | Color & style                  |
| **Footer / watermark**  | Pinned to bottom safe area                      | Optional                       |
| **Background surfaces** | Expand to full viewport                         | Yes                            |
| **Header area**         | Scales padding according to device safe insets  | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| Element                      | Reason                                                            |
| ---------------------------- | ----------------------------------------------------------------- |
| **Verification logic**       | Must remain consistent for accurate government record comparison. |
| **Processing flow timing**   | Linked to backend processing; cannot be shortened or skipped.     |
| **Status icon placement**    | Ensures clarity and recognition at all sizes.                     |
| **Minimum text size**        | Required for readability & WCAG compliance.                       |
| **Minimum tap target sizes** | Ensures accessibility on mobile.                                  |
| **Overall hierarchy**        | Prevents cognitive load at different sizes.                       |

<br />

### Design Notes

- The spinner and status icon always remain the dominant visual elements, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI above or below the module — it may break alignment.
- Multiline text is handled gracefully, but keep localized strings concise for the loading and result states.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/a0437b2f1a4b806e645e7b2242297f47.png" align="center" />


<br />

<br />

***

## Prototype & Transitions

**Government Record Verification** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the verification loading state through to the success and error outcomes. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/87e1e300d77722cde5067b2cc74a07e2.gif" align="center" />


<br />

<br />

***

## Localization

The **Government Record Verification** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/d99fff76db5e916eb6499679e6cfdfb7.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable, including the loading message, subtitle, success message, and error message.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- The subtitle referencing government records should be localized carefully to preserve legal and regulatory clarity in each supported region.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
- Incode supports a variety of languages.

<br />

---

- Path: `design-and-ux/government-record-verification-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/government-record-verification-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/government-record-verification-v1-vs-v2-comparison.md

# Government Record Verification V1 vs V2 Comparison

<br />

In V1, Government Record Verification performs a background check against the corresponding government entity but provides no explicit reference to the source during the verification wait. The loading state is basic, result screens are minimal, and UI elements are not tokenized, which makes customization difficult and limits the ability to align the experience with your brand.

In V2, Government Record Verification focuses on transparency and clarity. The loading state explicitly informs the user their information is being checked against government records, result screens are cleaner and more refined, and customization follows a unified token-based system — resulting in a more trustworthy and consistent experience.

<br />


<Image src="https://developer.incode.com/assets/5bc94a9ffb25b772f5d88e2421546d4b.png" align="center" caption="V1 is a basic upload experience with limited guidance and no tokenized customization." />


<br />


<Image src="https://developer.incode.com/assets/4a970eb98f0babf20e6552db5e7699a0.png" align="center" caption="V2 is a refined upload experience with clear per-side validation, inline error feedback, image quality hints, and full token-based customization." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities                        | V1 | V2 | Notes                                                                                                                                       |
| ----------------------------------- | -- | -- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Government record validation        | ✅  | ✅  | Both versions compare OCR-extracted identity data against the corresponding government entity records.                                      |
| Loading state                       | ✅  | ✅  | Both versions display a processing state while the verification request is completed.                                                       |
| Success state                       | ✅  | ✅  | Both versions confirm identity verification with a success screen when the record is found and matched.                                     |
| Error states                        | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                           |
| Government source attribution in UI | ❌  | ✅  | V2 explicitly informs the user that their information is being checked against government records, both in the loading copy and the footer. |
| Customization options               | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior.            |
| Documentation completeness          | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                                  |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                                                                   | V2                                                                                                                    | Notes                                                                                    |
| ------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Loading state       | Basic loading indicator with no reference to the verification source | Refined loading screen that explicitly informs the user their information is being checked against government records | V2 keeps users informed during the verification wait, reducing uncertainty and drop-off. |
| Result presentation | Basic success and error states with no source attribution            | Clearly differentiated success and error screens with the government source referenced in the footer                  | V2 makes it immediately clear to the user what entity validated their identity.          |
| State transitions   | Default transitions                                                  | Specifically designed screen-by-screen transitions for smoothness                                                     | V2 includes transition guidelines as part of the module documentation package.           |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/4cc712165af3b73e763ae6be96b51b3c.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify. This includes loading indicator styles, text content, result screen colors, and status icon styling — making it straightforward to align the module with your brand without affecting the underlying government verification logic.

<br />

<br />

<br />

---

- Path: `design-and-ux/guidelines-ekyb`
- URL: https://developer.incode.com/design-and-ux/guidelines-ekyb/
- Markdown: https://developer.incode.com/design-and-ux/guidelines-ekyb.md

# Specs & Guidelines

The **eKYB** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/f55d7e4de34fecc57ccc989fe8104d66.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **eKYB** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/f2d825e0c4914bfd13ccbb4a5774090a.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/a711ea3e7a4f3825db3b955fdacae640.png" />

<br />

<br />

***

## Prototype & Transitions

**eKYB** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/914b92cf7eee68c85121fc0be29ed23e.gif" />

<br />

<br />

<br />

***

## Localization

The **eKYB** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/144fe2c3dfe279a28df63f82d60112b6.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/icons`
- URL: https://developer.incode.com/design-and-ux/icons/
- Markdown: https://developer.incode.com/design-and-ux/icons.md

# Icons

A custom icon set designed to match the visual weight of DM Sans. All icons are outlined strokes on a 24×24 grid with 1.5px stroke weight — no fills. They scale cleanly at 16px, 20px, and 24px.

<Tabs>
<Tab title="Overview">

## Specifications

```dh-specs
Grid size | 24 × 24px
Stroke weight | 1.5px
Line cap | round
Line join | round
Fill style | Stroke-only (outline)
Optical sizes | 16px · 20px · 24px
```

```dh-principles
#006aff | Optical sizing, not scaling | Use icons at 16px, 20px, or 24px only. These are the three sizes they were designed for. Arbitrary sizes produce blurry renders and mismatched stroke weight.
#189f60 | Color via currentColor | Icons inherit color from the parent's text-color token. Never set fill or stroke directly — let the design token cascade handle it.
#820ad1 | Always pair with a label | Don't use an icon alone for an action unless it's universally recognized (close, search). Always add a visible label or aria-label for accessibility.
```

## Size scale

<div class="dh-icon-sizes"><figure class="dh-icon-size"><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.9844 21.606C11.9844 21.606 19.6564 19.283 19.6564 12.879C19.6564 6.474 19.9344 5.974 19.3194 5.358C18.7034 4.742 12.9904 2.75 11.9844 2.75C10.9784 2.75 5.26544 4.742 4.65044 5.358C4.03444 5.974 4.31244 6.474 4.31244 12.879C4.31244 19.283 11.9844 21.606 11.9844 21.606Z" /><path d="M9.38586 11.8746L11.2779 13.7696L15.1759 9.86963" /></svg><figcaption><code>16px</code><em>Compact / inline</em></figcaption></figure><figure class="dh-icon-size"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.9844 21.606C11.9844 21.606 19.6564 19.283 19.6564 12.879C19.6564 6.474 19.9344 5.974 19.3194 5.358C18.7034 4.742 12.9904 2.75 11.9844 2.75C10.9784 2.75 5.26544 4.742 4.65044 5.358C4.03444 5.974 4.31244 6.474 4.31244 12.879C4.31244 19.283 11.9844 21.606 11.9844 21.606Z" /><path d="M9.38586 11.8746L11.2779 13.7696L15.1759 9.86963" /></svg><figcaption><code>20px</code><em>Default</em></figcaption></figure><figure class="dh-icon-size"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.9844 21.606C11.9844 21.606 19.6564 19.283 19.6564 12.879C19.6564 6.474 19.9344 5.974 19.3194 5.358C18.7034 4.742 12.9904 2.75 11.9844 2.75C10.9784 2.75 5.26544 4.742 4.65044 5.358C4.03444 5.974 4.31244 6.474 4.31244 12.879C4.31244 19.283 11.9844 21.606 11.9844 21.606Z" /><path d="M9.38586 11.8746L11.2779 13.7696L15.1759 9.86963" /></svg><figcaption><code>24px</code><em>Large / hero</em></figcaption></figure></div>

</Tab>
<Tab title="Library">

<div class="dh-icon-cat"><span>Identity</span><i></i><em>6 icons</em></div>

<div class="dh-icon-grid"><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M13.9654 4.13672C14.7905 4.13672 15.5455 4.59207 15.9347 5.31888C16.1877 5.79272 16.465 6.27142 16.643 6.46699C16.9816 6.82212 17.4467 7.03229 17.9381 7.0498C19.6291 7.0498 21 8.42072 21 10.1117V15.756C21 18.024 19.1611 19.8629 16.8941 19.8629H7.10595C4.83795 19.8629 3 18.024 3 15.756V10.1137C3.00195 8.42364 4.37189 7.05564 6.06195 7.05564C6.5533 7.03618 7.01741 6.82699 7.35697 6.47088C7.53892 6.27045 7.83178 5.77326 8.09935 5.28969C8.49243 4.57845 9.23968 4.13672 10.0531 4.13672H13.9654Z" /><path d="M17.173 9.82837V9.88675" /><path fill-rule="evenodd" clip-rule="evenodd" d="M15.0924 13.1048C15.0924 11.3972 13.7079 10.0117 11.9993 10.0117C10.2908 10.0117 8.90625 11.3972 8.90625 13.1048C8.90625 14.8133 10.2908 16.1979 11.9993 16.1979C13.7079 16.1979 15.0924 14.8133 15.0924 13.1048Z" /></svg><figcaption>Camera</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M4.17201 16.1546C3.52012 14.9189 3.15039 13.4984 3.15039 12C3.15039 7.02811 7.1785 3 12.1504 3C17.1223 3 21.1504 7.02811 21.1504 12C21.1504 13.5081 20.7807 14.9384 20.119 16.1838" /><path fill-rule="evenodd" clip-rule="evenodd" d="M15.4161 10.3228C15.4161 12.1432 13.9401 13.6183 12.1207 13.6183C10.3002 13.6183 8.82422 12.1432 8.82422 10.3228C8.82422 8.50237 10.3002 7.02734 12.1207 7.02734C13.9401 7.02734 15.4161 8.50237 15.4161 10.3228Z" /><path fill-rule="evenodd" clip-rule="evenodd" d="M17.2571 19.4036C15.8074 20.4057 14.0463 20.9992 12.149 20.9992C10.2322 20.9992 8.45168 20.396 7.00195 19.3744C7.20628 17.7884 8.61709 16.0273 12.1198 16.0273C15.6614 16.0273 17.0625 17.7982 17.2571 19.4036Z" /></svg><figcaption>Face Capture</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M21 8.59443C21 6.0647 19.4306 4.2793 16.9018 4.2793H7.10595C4.58595 4.2793 3 6.0647 3 8.59443V15.413C3 17.934 4.57719 19.7194 7.10595 19.7194H16.8931C19.4306 19.7194 21 17.934 21 15.413V8.59443Z" /><path d="M6.2085 16.0193C6.2085 15.0473 6.9752 13.8379 9.18482 13.8379C11.3944 13.8379 12.1611 15.0385 12.1611 16.0105" /><path fill-rule="evenodd" clip-rule="evenodd" d="M11.0866 9.88166C11.0866 10.9315 10.2352 11.7828 9.18537 11.7828C8.13553 11.7828 7.28418 10.9315 7.28418 9.88166C7.28418 8.83182 8.13553 7.98047 9.18537 7.98047C10.2352 7.98047 11.0866 8.83182 11.0866 9.88166Z" /><path d="M14.1206 10.3477L17.5931 10.3953M15.4223 14.0496H17.593" /></svg><figcaption>ID Card</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.9844 21.606C11.9844 21.606 19.6564 19.283 19.6564 12.879C19.6564 6.474 19.9344 5.974 19.3194 5.358C18.7034 4.742 12.9904 2.75 11.9844 2.75C10.9784 2.75 5.26544 4.742 4.65044 5.358C4.03444 5.974 4.31244 6.474 4.31244 12.879C4.31244 19.283 11.9844 21.606 11.9844 21.606Z" /><path d="M9.38586 11.8746L11.2779 13.7696L15.1759 9.86963" /></svg><figcaption>Shield</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M20.6235 11.1943C20.6474 11.4597 20.6598 11.7289 20.6598 12C20.6598 16.877 16.7069 20.8299 11.8299 20.8299C6.95293 20.8299 3 16.877 3 12C3 7.12399 6.95293 3.1701 11.8299 3.1701C12.2022 3.1701 12.5697 3.19397 12.9305 3.23884" /><path d="M15.4731 6.18738L17.2792 7.99631L21.0002 4.27344" /><path d="M7.48975 19.6916C7.66253 18.3485 8.85766 16.8574 11.8236 16.8574C14.8219 16.8574 16.0084 18.3571 16.1736 19.7164" /><path fill-rule="evenodd" clip-rule="evenodd" d="M14.3437 11.9656C14.3437 13.3536 13.2183 14.4791 11.8303 14.4791C10.4423 14.4791 9.31689 13.3536 9.31689 11.9656C9.31689 10.5777 10.4423 9.45319 11.8303 9.45319C13.2183 9.45319 14.3437 10.5777 14.3437 11.9656Z" /></svg><figcaption>User Verified</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M20.049 11.4171C20.049 6.76827 16.2807 3 11.6319 3C6.98312 3 3.21484 6.76827 3.21484 11.4171C3.21484 16.0659 6.98312 19.8351 11.6319 19.8351C16.2807 19.8351 20.049 16.0659 20.049 11.4171Z" /><path d="M17.3613 17.584L20.7852 21" /><path d="M9.01172 11.4324L10.9139 13.3336L14.7152 9.53125" /></svg><figcaption>Search Check</figcaption></figure></div>

<div class="dh-icon-cat"><span>People</span><i></i><em>3 icons</em></div>

<div class="dh-icon-grid"><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M5.94141 19.9996C5.94141 17.891 7.60505 15.2656 12.4002 15.2656C17.1944 15.2656 18.858 17.8719 18.858 19.9815" /><path fill-rule="evenodd" clip-rule="evenodd" d="M16.5258 8.12567C16.5258 10.4043 14.6788 12.2513 12.4001 12.2513C10.1224 12.2513 8.27539 10.4043 8.27539 8.12567C8.27539 5.847 10.1224 4 12.4001 4C14.6788 4 16.5258 5.847 16.5258 8.12567Z" /></svg><figcaption>User</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M3.31641 19.9996C3.31641 17.891 4.98005 15.2656 9.77519 15.2656C14.5694 15.2656 16.233 17.8719 16.233 19.9815" /><path fill-rule="evenodd" clip-rule="evenodd" d="M13.9008 8.12567C13.9008 10.4043 12.0538 12.2513 9.77511 12.2513C7.49739 12.2513 5.65039 10.4043 5.65039 8.12567C5.65039 5.847 7.49739 4 9.77511 4C12.0538 4 13.9008 5.847 13.9008 8.12567Z" /><path d="M17.4512 14.9453C20.1586 15.5011 20.9847 17.4608 20.9847 18.965" /><path d="M16.5352 5.66406C17.9276 5.95439 18.9704 7.19018 18.9657 8.66759C18.9609 9.97501 18.1367 11.0886 16.9792 11.5212" /></svg><figcaption>Users</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M3.67773 19.0276C3.67773 16.9345 5.33006 14.3281 10.0886 14.3281" /><path fill-rule="evenodd" clip-rule="evenodd" d="M14.1843 7.24349C14.1843 9.50472 12.3504 11.3386 10.0892 11.3386C7.82798 11.3386 5.99414 9.50472 5.99414 7.24349C5.99414 4.98227 7.82798 3.14844 10.0892 3.14844C12.3504 3.14844 14.1843 4.98227 14.1843 7.24349Z" /><path d="M15.0383 16.7225L15.9583 17.6443L17.8547 15.747" /></svg><figcaption>Genuine User</figcaption></figure></div>

<div class="dh-icon-cat"><span>Actions</span><i></i><em>4 icons</em></div>

<div class="dh-icon-grid"><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M12.0003 14.142V16.309" /><path d="M16.4481 9.46727V7.37127C16.4179 4.91427 14.4007 2.94727 11.9445 2.97827C9.53809 3.00827 7.59199 4.94627 7.55109 7.35127V9.46727" /><path d="M9.30406 21.0221H14.6959C16.2912 21.0221 17.0889 21.0221 17.7046 20.7261C18.3193 20.4311 18.8151 19.9351 19.1103 19.3211C19.4059 18.7051 19.4059 17.9071 19.4059 16.3121V14.1801C19.4059 12.5851 19.4059 11.7871 19.1103 11.1721C18.8151 10.5571 18.3193 10.0611 17.7046 9.76609C17.0889 9.47009 16.2912 9.47009 14.6959 9.47009H9.30406C7.70876 9.47009 6.91105 9.47009 6.29545 9.76609C5.68066 10.0611 5.18486 10.5571 4.88966 11.1721C4.59406 11.7871 4.59406 12.5851 4.59406 14.1801V16.3121C4.59406 17.9071 4.59406 18.7051 4.88966 19.3211C5.18486 19.9351 5.68066 20.4311 6.29545 20.7261C6.91105 21.0221 7.70876 21.0221 9.30406 21.0221Z" /></svg><figcaption>Lock</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M21 12C21 7.02908 16.9709 3 12 3C7.02908 3 3 7.02908 3 12C3 16.9699 7.02908 21 12 21C16.9709 21 21 16.9699 21 12Z" /><path d="M8.53516 12.0003L10.845 14.3091L15.4627 9.69141" /></svg><figcaption>Check Circle</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M4.81397 20.4368H19.197C20.779 20.4368 21.772 18.7268 20.986 17.3528L13.8 4.78781C13.009 3.40481 11.015 3.40381 10.223 4.78681L3.02497 17.3518C2.23897 18.7258 3.23097 20.4368 4.81397 20.4368Z" /><path d="M12.0024 13.4148V10.3148" /><path d="M11.995 16.5H12.005" /></svg><figcaption>Warning</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M13.1043 4.17701L14.9317 7.82776C15.1108 8.18616 15.4565 8.43467 15.8573 8.49218L19.9453 9.08062C20.9554 9.22644 21.3573 10.4505 20.6263 11.1519L17.6702 13.9924C17.3797 14.2718 17.2474 14.6733 17.3162 15.0676L18.0138 19.0778C18.1856 20.0698 17.1298 20.8267 16.227 20.3574L12.5732 18.4627C12.215 18.2768 11.786 18.2768 11.4268 18.4627L7.773 20.3574C6.87023 20.8267 5.81439 20.0698 5.98724 19.0778L6.68385 15.0676C6.75257 14.6733 6.62033 14.2718 6.32982 13.9924L3.37368 11.1519C2.64272 10.4505 3.04464 9.22644 4.05466 9.08062L8.14265 8.49218C8.54354 8.43467 8.89028 8.18616 9.06937 7.82776L10.8957 4.17701C11.3477 3.27433 12.6523 3.27433 13.1043 4.17701Z" /></svg><figcaption>Star</figcaption></figure></div>

<div class="dh-icon-cat"><span>Communication</span><i></i><em>4 icons</em></div>

<div class="dh-icon-grid"><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M18.3748 6.61751L18.3758 17.3815C18.3758 19.38 16.7558 21 14.7573 21H9.24251C7.245 21 5.625 19.38 5.625 17.3825L5.62402 6.61849C5.62402 4.62 7.24402 3 9.24154 3H14.7573C16.7548 3 18.3748 4.62 18.3748 6.61751Z" /><path d="M10.6094 6.68848H13.3931" /></svg><figcaption>Mobile</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M21 15.0944C21 17.8596 19.1552 20.1072 16.4183 20.1004H7.58173C4.84476 20.1072 3 17.8596 3 15.0944V8.91315C3 6.15088 4.84476 3.90039 7.58173 3.90039H16.4183C19.1552 3.90039 21 6.15088 21 8.91315V15.0944Z" /><path d="M17.3046 8.91016L13.3057 12.1618C12.5526 12.7602 11.4853 12.7602 10.7322 12.1618L6.69922 8.91016" /></svg><figcaption>Email</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M17.5988 17.5977C15.179 20.0177 11.596 20.5405 8.66377 19.1845C8.2309 19.0102 7.87601 18.8694 7.53863 18.8694C6.5989 18.8749 5.4292 19.7861 4.82128 19.1789C4.21336 18.5709 5.12524 17.4003 5.12524 16.4549C5.12524 16.1175 4.98997 15.7689 4.81571 15.3352C3.45902 12.4035 3.9826 8.81923 6.40236 6.4C9.4913 3.30991 14.5099 3.30991 17.5988 6.3992C20.6933 9.49406 20.6878 14.5084 17.5988 17.5977Z" /><path d="M15.119 12.327H15.1267M11.9448 12.327H11.9525M8.77063 12.327H8.77832" /></svg><figcaption>Chat</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M21.2498 12.0001C21.2498 17.1081 17.1088 21.2501 11.9998 21.2501C6.89176 21.2501 2.74976 17.1081 2.74976 12.0001C2.74976 6.89112 6.89176 2.75012 11.9998 2.75012C17.1088 2.75012 21.2498 6.89112 21.2498 12.0001Z" /><path d="M16.1906 12.7672L11.6606 12.6932V7.84619" /></svg><figcaption>Clock</figcaption></figure></div>

<div class="dh-icon-cat"><span>System</span><i></i><em>3 icons</em></div>

<div class="dh-icon-grid"><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none"><path d="M17.2029 10.0053L18.7773 10.857L19.1618 11.073C19.9808 11.5331 19.9808 12.7194 19.1618 13.1795L13.9461 16.1098C12.7365 16.7894 11.2635 16.7894 10.0539 16.1098L4.83824 13.1795C4.01925 12.7194 4.01925 11.5331 4.83824 11.073L5.22265 10.857L6.75497 9.97943" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/><path d="M17.2697 14.2414L19.0088 15.1257C19.8697 15.5591 19.8972 16.7857 19.0568 17.2579L13.9454 20.1296C12.7358 20.8092 11.2628 20.8092 10.0532 20.1296L5.01624 17.2998C4.16139 16.8195 4.2085 15.5657 5.09693 15.1519L6.84888 14.3088" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/><path d="M10.0539 3.87035L4.83824 6.80066C4.01925 7.26079 4.01925 8.44706 4.83824 8.9072L10.0539 11.8375C11.2635 12.5171 12.7365 12.5171 13.9461 11.8375L19.1618 8.9072C19.9808 8.44706 19.9808 7.26079 19.1618 6.80066L13.9461 3.87036C12.7365 3.19076 11.2635 3.19076 10.0539 3.87035Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg><figcaption>Layers</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path fill-rule="evenodd" clip-rule="evenodd" d="M21.1143 12.0723C18.3744 12.9605 16.2267 15.1082 15.3384 17.8493C14.4501 15.1082 12.3024 12.9605 9.5625 12.0723C12.3024 11.184 14.4501 9.03627 15.3384 6.29639C16.2267 9.03627 18.3744 11.184 21.1143 12.0723Z" /><path fill-rule="evenodd" clip-rule="evenodd" d="M8.98334 5.56871C8.0275 5.87858 7.27826 6.62783 6.96836 7.58409C6.65846 6.62783 5.90921 5.87858 4.95337 5.56871C5.90921 5.2588 6.65846 4.50955 6.96836 3.55371C7.27826 4.50955 8.0275 5.2588 8.98334 5.56871Z" /><path fill-rule="evenodd" clip-rule="evenodd" d="M9.09278 17.4563C7.67478 17.916 6.56328 19.0275 6.10354 20.4462C5.64379 19.0275 4.53227 17.916 3.11426 17.4563C4.53227 16.9966 5.64379 15.885 6.10354 14.467C6.56328 15.885 7.67478 16.9966 9.09278 17.4563Z" /></svg><figcaption>AI Stars</figcaption></figure><figure class="dh-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M10.4894 7.59979L6.23853 7.93036L4.41943 9.74946C5.56358 10.4218 6.66227 11.169 7.70758 11.9865C9.62135 13.4771 11.3432 15.1995 12.8338 17.1132C13.6491 18.1568 14.3962 19.2519 15.0709 20.3914L16.88 18.5818L17.211 14.3214" /><path d="M7.43478 12.5114C8.34236 10.545 9.52454 8.7174 10.9462 7.08355C10.9462 7.08355 15.7031 2.01654 20.7612 4.04951C22.8039 8.99091 17.7362 13.8641 17.7362 13.8641C16.0988 15.2884 14.2679 16.474 12.2984 17.3854L6.67627 14.5157C6.88359 13.8314 7.13687 13.1614 7.43478 12.5114Z" /><path d="M14.4971 11.7047C15.2384 11.7047 15.8394 11.1037 15.8394 10.3623C15.8394 9.62095 15.2384 9.01996 14.4971 9.01996C13.7557 9.01996 13.1548 9.62095 13.1548 10.3623C13.1548 11.1037 13.7557 11.7047 14.4971 11.7047Z" /></svg><figcaption>Rocket</figcaption></figure></div>

</Tab>
<Tab title="Usage">

<CardGroup>
<Card title="Consistent sizing">Use icons at 16px, 20px, or 24px only. These are the optical sizes they were designed for. Avoid arbitrary sizes.</Card>
<Card title="Color via text color">Icons inherit color via currentColor. Don't set a fill or stroke color directly — use the text color token on the parent element.</Card>
<Card title="Always pair with a label">Don't use an icon alone for an action unless it's universally recognized (close, back, search). Always add a visible label or aria-label.</Card>
<Card title="Weight matching">Icons at 16px pair with Label or Caption text. Icons at 20–24px pair with Body or Button text. Match visual weight.</Card>
<Card title="No arbitrary rotation">Icons are designed for a specific orientation. Don't rotate unless the icon has an explicit direction variant.</Card>
<Card title="Optical alignment">When placing an icon next to text, use a 2–4px gap (Scale.1–Scale.2) and align to the text baseline, not the center of the text block.</Card>
</CardGroup>

</Tab>
</Tabs>

---

- Path: `design-and-ux/id-capture-customization`
- URL: https://developer.incode.com/design-and-ux/id-capture-customization/
- Markdown: https://developer.incode.com/design-and-ux/id-capture-customization.md

# Customization

This section outlines the elements you can customize within the **ID Capture** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

<br />

## Tutorial Screen

The Tutorial Screen prepares the user for the ID Capture step. It introduces the action, provides the necessary context, and sets expectations before the camera is activated.

<Image align="center" src="https://developer.incode.com/assets/debfea830cdb104af5d6dae1622fd618.jpg" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**         | **Notes**                              |
| ---------------- | ---------------------------------- | -------------------------------------- |
| **Text**         | Title, subtitle, body text         | Fully localizable; tone can be adapted |
| **Illustration** | Colors or full replacement         | Must remain clear and represent a face |
| **Brand Colors** | Header, highlight elements, button | Uses brand tokens                      |
| **Buttons**      | Label, color, radius               | Must follow platform guidelines        |
| **Footer**       | “Verified by Incode” line          | Optional but recommended               |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                |
| --------------------- | ---------------------------------- |
| Layout structure      | Ensures consistency across modules |
| Spacing & safe areas  | Required for device compatibility  |
| Text hierarchy        | Optimized for readability          |
| WCAG minimum contrast | Mandatory                          |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/4674e0e3049efe599b086e4095988b0e.jpg" />

<br />

| **UI Element**    | **Token**                      | **Value** |
| :---------------- | :----------------------------- | :-------- |
| Background        | Surface/Neutral/0              | #FFFFFF   |
| Title text        | Text/Body/800 (Primary)        | #262831   |
| Subtitle text     | Text/Body/500 (Secondary)      | #60667C   |
| Helper text       | Text/Body/500 (Secondary)      | #60667C   |
| Button background | Button/Primary/Surface/Default | #006AFF   |
| Button text       | Button/Primary/Text/Default    | #FFFFFF   |
| Footer text       | Text/Body/500 (Secondary)      | #60667C   |

<br />

### Design Notes

* Keep copy short to minimize cognitive load.
* The illustration uses brand 50 and brand 500 to reinforce brand identity without overwhelming the UI.
* Ensure tap targets meet accessibility guidelines.
* Maintain clear focus states for keyboard and screen reader users (Web).

<br />

***

## Fake Permission Screen

The Fake Permission Screen is shown before the operating system displays its native camera permission modal. It prepares the user, explains why camera access is required, and significantly reduces the likelihood of users denying permission. This step increases trust and prevents interruptions during the ID Capture flow.

<Image align="center" src="https://developer.incode.com/assets/c78ab6c3da2ddb27fd64c1bfe75882f1.jpg" />

<br />

### Customizable Elements

| **Area**           | **What can be customized**                    | **Notes**                                          |
| ------------------ | --------------------------------------------- | -------------------------------------------------- |
| **Text**           | Title, subtitle, permission explanation       | Fully localizable; tone should remain reassuring   |
| **Buttons**        | Label (“Allow”, “Don’t allow”), color, radius | Must maintain primary/secondary hierarchy          |
| **Brand Colors**   | Button accents, icon color, text accents      | Uses brand tokens                                  |
| **Modal Surface**  | Background color, elevation, corner radius    | Must remain high-contrast and readable             |
| **Link/Help Text** | “Learn more” or similar supportive text       | Optional; can adapt tone based on compliance needs |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                             |
| ---------------------- | --------------------------------------------------------------- |
| Background dim opacity | Indicates OS-level permission flow; needed for clarity          |
| Modal position         | Standardized centered layout for all modules                    |
| Button hierarchy       | Mirrors OS expectations; prevents accidental “Don’t allow” taps |
| Safety text hierarchy  | Ensures user comprehension before OS prompt                     |
| Spacing & safe areas   | Required for device consistency                                 |
| WCAG minimum contrast  | Mandatory                                                       |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/915d37420c8e20084c36fcb2021b11cf.jpg" />

| **UI Element**        | **Token**                       | **Value** |
| :-------------------- | :------------------------------ | :-------- |
| Background (overlay)  | Surface/Neutral/1000 80% Static | #000000   |
| Modal background      | Surface/Neutral/0               | #FFFFFF   |
| Divider / handle      | Surface/Neutral/200             | #D6CBD2   |
| Title text            | Text/Body/800 (Primary)         | #262831   |
| Subtitle text         | Text/Body/500 (Secondary)       | #60667C   |
| Primary button        | Button/Primary/Surface/Default  | #006AFF   |
| Primary button text   | Button/Primary/Text/Default     | #FFFFFF   |
| Secondary button text | Button/Secondary/Text/Default   | #006AFF   |

<br />

### Design Notes

* The pre-permission modal reduces drop-off by providing context before the OS permission.
* Maintain a clear hierarchy between primary (Allow) and secondary (Don’t allow) actions.
* Keep the dim overlay consistent to align with OS modal expectations.
* Ensure high contrast between modal, text, and background elements.
* Avoid adding extra steps or interaction on this screen.

<br />

***

## Capture Screens

During capture, the user aligns their ID within the frame, and the system evaluates real-time conditions such as glare, blur, lighting, and edge visibility. When all conditions are met, the photo is taken automatically.
Colors and text on screen can be customized to match your brand, while the capture frame and auto-capture behavior remain fixed to preserve system accuracy.

<Image align="center" src="https://developer.incode.com/assets/98161b6855c21c8f192ea1d98476b7f7.jpg" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                                             | **Notes**                         |
| ---------------- | -------------------------------------------------------------------------------------- | --------------------------------- |
| **Text**         | Instruction and helper text (e.g., _“Fill the frame with your ID”_, _“Taking photo…”_) | Fully localizable                 |
| **Brand Colors** | Countdown, borders, and progress indicators                                            | Controlled via design tokens      |
| **Background**   | Dark or neutral surfaces                                                               | Must maintain sufficient contrast |
| **Iconography**  | Help and info icons                                                                    | Color can be customized only      |
| **Footer**       | “All photos are encrypted” or “Verified by Incode” line                                | Optional                          |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                           |
| -------------------------- | --------------------------------------------- |
| ID frame shape & safe area | Ensures correct edge and glare detection      |
| Auto-capture behavior      | Guarantees consistency across devices         |
| Detection logic            | Required for accurate system-level validation |
| Layout & hierarchy         | Preserves visual and functional consistency   |
| Minimum contrast           | Required for accessibility compliance         |
| Countdown behavior         | Animation and timing remain fixed             |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6801c09d0a4cbc5c08d50d76bc572f0b.jpg" />

| **UI Element**       | **Token**                       | **Value** |
| :------------------- | :------------------------------ | :-------- |
| Background           | Surface/Neutral/900 Static      | #14151A   |
| Primary text         | Text/Body/0 Static              | #FFFFFF   |
| Secondary text       | Text/Body/300 Static (Tertiary) | #A3A8B8   |
| Icon                 | Icon/Neutral/0 Static           | #FFFFFF   |
| Countdown background | Countdown/Surface/Default       | #14151A   |
| Countdown text       | Countdown/Text/Default          | #FFFFFF   |
| Focus border         | Border/Status/Focus             | #006AFF   |
| Helper text          | Text/Body/0 Static              | #FFFFFF   |

<br />

### Design Notes

* The ID frame shape is fixed and cannot be altered, as it ensures correct alignment and document edge detection.
* The progress and countdown indicators must retain their default behavior and timing to maintain capture consistency.
* Apply brand colors subtly—use them for accents like borders or buttons, but avoid overpowering the document preview area.
* Keep instruction text short and direct, guiding users with clear, actionable phrases (e.g., “Fill the frame with your ID”).
* Maintain high contrast and accessible tap areas for key controls such as the help icon or retry button

<br />

***

## Manual Capture

Manual capture is triggered after a period of inactivity (default: 30 seconds) when automatic detection conditions are not met. In this mode, the user aligns their ID within the capture frame and presses the button manually.
This ensures users can complete verification even in low light, complex backgrounds, or edge-case scenarios where auto-capture cannot trigger.

<Image align="center" src="https://developer.incode.com/assets/0dd6746f8d8d4d5953dc9e6485eb7338.jpg" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                                              | **Notes**                                               |
| ---------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| **Text**         | Instructional text (e.g., “Fill the frame with your ID”, “Press the button to capture”) | Fully localizable                                       |
| **Button**       | Color, label, radius, and icon color                                                    | Must comply with accessibility and tap-target standards |
| **Brand Colors** | Border, header, and accent elements                                                     | Driven by brand tokens                                  |
| **Background**   | Dark or neutral surfaces                                                                | Must maintain sufficient contrast for ID visibility     |
| **Icons**        | Help/info icons                                                                         | Only icon color may be customized                       |
| **Footer**       | “All photos are encrypted” or “Verified by Incode”                                      | Optional                                                |

<br />

### Fixed Elements

| **Element**                 | **Why it is fixed**                                 |
| --------------------------- | --------------------------------------------------- |
| ID frame shape and position | Ensures accurate alignment and detection            |
| Manual button placement     | Ensures reachability and consistency across devices |
| Detection logic fallback    | Manual mode always follows auto-mode failure        |
| Layout spacing & safe zones | Maintains visual and interaction consistency        |
| Accessibility contrast      | Must meet WCAG AA requirements                      |
| Button size & touch area    | Required for usability and accessibility compliance |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/6532b8609339e1362bab797415d09a77.jpg" />

| **UI Element**     | **Token**                  | **Value** |
| :----------------- | :------------------------- | :-------- |
| Background         | Surface/Neutral/900 Static | #14151A   |
| Primary text       | Text/Body/0 Static         | #FFFFFF   |
| Instruction text   | Text/Body/0 Static         | #FFFFFF   |
| Icon               | Icon/Neutral/0 Static      | #FFFFFF   |
| Tooltip background | Tooltip/Surface/Neutral    | #14151A   |
| Tooltip text       | Tooltip/Text/Neutral       | #FFFFFF   |
| Secondary icon     | Icon/Neutral/50 Static     | #CFCFD0   |
| Helper text        | Text/Body/0 Static         | #FFFFFF   |

<br />

### Design Notes

* The ID frame must remain fixed in shape to preserve detection accuracy.
* Manual capture should always appear as a fallback after auto-capture timeout, never as a default.
* Apply brand color accents sparingly (e.g., borders or buttons) to keep focus on the document.
* Keep instructional copy short and directive (e.g., “Fill the frame and tap capture”).
* Maintain clear tap areas and legible text for accessibility on all device size

<br />

***

## ID Capture Complete (Analzying & Success)

Once the ID photo is captured — either automatically or manually — the user transitions to the Analyzing and Success screens. These stages reassure users that their ID is being securely processed and confirm when the image has passed all validation checks. Both the progress indicators and confirmation visuals can be adapted to match your brand identity..

<Image align="center" src="https://developer.incode.com/assets/45a0cf63abfe8898d7778e84c5960455.jpg" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                            | **Notes**                                                   |
| ---------------- | --------------------------------------------------------------------- | ----------------------------------------------------------- |
| **Text**         | “Analyzing…”, “Successfully processed!”, “Now let’s capture the back” | Fully localizable                                           |
| **Brand Colors** | Progress bar, success icon, and action button                         | Must follow brand tokens                                    |
| **Surfaces**     | Background and card surfaces                                          | Must ensure clarity and contrast against ID image           |
| **Button**       | Color, label, and radius (e.g., _Scan the back_)                      | Must meet accessibility standards                           |
| **Footer**       | “All photos are encrypted” or “Verified by Incode”                    | Optional                                                    |
| **Animation**    | Progress fill color transitions                                       | Only color may change; timing and animation curve are fixed |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                              |
| --------------------- | ---------------------------------------------------------------- |
| Progress bar behavior | Maintains consistent feedback rhythm across capture steps        |
| Success timing        | Ensures users clearly see confirmation before advancing          |
| Layout structure      | Standardized for readability and predictable UX                  |
| Minimum contrast      | Required for WCAG AA compliance                                  |
| Animation pattern     | Fixed to preserve continuity and visual stability across modules |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/145f6565e9ef2764ec799226a090d357.jpg" />

<br />

| **UI Element**        | **Token**               | **Value** |
| :-------------------- | :---------------------- | :-------- |
| Background            | Surface/Neutral/0       | #FFFFFF   |
| Progress bar (active) | Icon/Status/Positive    | #10B060   |
| Card background       | Surface/Neutral/100     | #EBECEF   |
| Primary text          | Text/Body/800 (Primary) | #262831   |
| Secondary surface     | Surface/Secondary/900   | #14151A   |
| Helper text           | Text/Body/800 (Primary) | #262831   |

### Design Notes

* The progress bar and success icon should use brand-positive tones but remain subtle to avoid visual clutter.
* The ID image always remains centered and visible throughout both stages — never obscured by overlays or text.
* Keep status text brief and affirmative (“Analyzing…”, “Success!”) for faster comprehension.
* Maintain high-contrast text against the background and avoid overlaid color effects on ID photos.
* Button CTAs should appear only on success (e.g., Scan the back or Continue), never during analysis.

<br />

<br />

***

## Error Screens

Error screens appear when an issue occurs during ID capture, such as glare, blur, cut-off edges, or when all capture attempts have been exhausted. While text and visual styling can be customized, the error event types are system-defined and cannot be removed or altered.

<Image align="center" src="https://developer.incode.com/assets/9063132b3da9835a81159e920f4d23a0.jpg" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**                                    | **Notes**                                         |
| ---------------- | ------------------------------------------------------------- | ------------------------------------------------- |
| **Text**         | Error titles, descriptions, and remaining attempts text       | Fully localizable                                 |
| **Buttons**      | CTA label (“Try again”, “Continue”), button color, and radius | Must maintain clear primary/secondary hierarchy   |
| **Brand Colors** | Header, accent colors, and button colors                      | Should follow brand token system                  |
| **Icons**        | Warning/error icon color                                      | Only color may change — shapes are fixed          |
| **Background**   | Light or neutral backgrounds                                  | Must maintain strong contrast with text and icons |
| **Footer**       | “All photos are encrypted” or “Verified by Incode”            | Optional                                          |

<br />

### Fixed Elements

| **Element**                | **Why it is fixed**                                          |
| -------------------------- | ------------------------------------------------------------ |
| Error event types          | Linked to detection logic; cannot be reordered or removed    |
| Error icon shapes          | Maintains universal recognition and visual consistency       |
| Error layout structure     | Standardized for clarity and predictable behavior            |
| “Attempts remaining” logic | Ensures accuracy and reliable retry tracking                 |
| Final error behavior       | Must transition to manual review once attempts are exhausted |
| Accessibility contrast     | Must comply with WCAG AA for readability                     |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/9895e6502218f0f4cdeef7d177e70078.jpg" />

| **UI Element**    | **Token**                      | **Value** |
| :---------------- | :----------------------------- | :-------- |
| Background        | Surface/Neutral/0              | #FFFFFF   |
| Error icon        | Icon/Status/Negative           | #FF1111   |
| Title text        | Text/Body/800 (Primary)        | #262831   |
| Subtitle text     | Text/Body/500 (Secondary)      | #60667C   |
| Helper text       | Text/Body/800 (Primary)        | #262831   |
| Secondary text    | Text/Body/500 (Secondary)      | #60667C   |
| Focus icon        | Icon/Neutral/800               | #262831   |
| Button background | Button/Primary/Surface/Default | #006AFF   |
| Button text       | Button/Primary/Text/Default    | #FFFFFF   |

<br />

### Design Notes

* Error messaging should remain clear, direct, and action-oriented.
* Maintain consistent spacing and visual hierarchy for readability.
* “Try again” should always feel like the primary action when applicable.
* Final error screens should not offer a retry, only a “Continue” action guiding users into manual review logic.
* Avoid long or overly technical messages; users should understand the issue at a glance.
* Include the ID image preview where possible — it helps users understand what went wrong.

---

- Path: `design-and-ux/id-capture-design`
- URL: https://developer.incode.com/design-and-ux/id-capture-design/
- Markdown: https://developer.incode.com/design-and-ux/id-capture-design.md

# ID Capture

ID Capture is a core onboarding step. It collects high-quality images of a user’s government-issued ID. For two-sided IDs, both the front and back are captured. The module also extracts data using optical character recognition (OCR) and runs authenticity checks.

<Image align="center" border={false} src="https://developer.incode.com/assets/7a1d75a1516e84ebea5128c3c42ec583.gif" />

***

## Where it fits in the flow

In an onboarding flow or workflow, **ID Capture** usually appears immediately after consent and document type selection and before Selfie Capture and final submission.

Once the user provides valid images, the flow continues to data extraction, document liveness/authenticity checks, and any downstream logic (such as Face Match with later selfie).

***

## User experience flow

The experience guides users from preparation to a successful ID capture. After granting camera permission, users see a short tutorial. During capture, the system evaluates framing, glare, blur, and edge alignment in real time. When requirements are met, the ID is auto-captured. If auto-capture doesn’t trigger in time, manual capture is available. In this case, images are then uploaded for quality checks with retry options on failure.

<br />

<Image align="center" border={false} src="https://developer.incode.com/assets/5e3d9f96551c1ebf153cec371781f726.png" />

<br />

***

## Full Flow Map

This diagram shows all **ID Capture** screens, from tutorial and permissions through front/back auto/manual capture, uploading, and feedback (success/error).

<Image align="center" border={false} src="https://developer.incode.com/assets/ea5a3bc68f6309a945aa6736c2ae0205.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the ID is captured successfully with no interruptions.

The happy path represents the smoothest version of the experience:

* The user grants camera access
* The user follows the tutorial
* The system detects proper alignment and lighting
* The ID is captured automatically without requiring retries or manual intervention.

In these images, both light and dark mode previews are included so teams can validate visual consistency across themes.

<Image align="center" border={false} caption="Light mode" src="https://developer.incode.com/assets/44b43072d9b987c7a43515e6df71a690.png" />

<Image align="center" border={false} caption="Dark mode" src="https://developer.incode.com/assets/db9a98d279ee9e3ae0068e576ca1b19f.png" />

<br />

***

## Best practices for design and implementation

**✅ Do**

* Keep instructions short and actionable (for example, “Place your ID on a flat surface. Avoid glare”).
* Use a high-contrast, uncluttered background. Ensure text remains readable.
* Guide with real-time feedback, like, “Move closer,” “Avoid glare,” or “Show all corners.”
* Provide retry options and clear error messages (for example, “Wrong document side”).
* Respect accessibility with voiceover labels, adequate tap targets, and captions.

**❌ Don’t**

* Don’t reduce overlay opacity so much that the capturing frame edges become hard to see
* Don’t rely solely on color for status. Add icons/text.
* Don’t skip critical error states like glare, blur, or cut-off).
* Don’t let UI elements obstruct the camera area.

---

- Path: `design-and-ux/id-capture-screens-and-states`
- URL: https://developer.incode.com/design-and-ux/id-capture-screens-and-states/
- Markdown: https://developer.incode.com/design-and-ux/id-capture-screens-and-states.md

# Screens & States

A complete view of all screens the user may encounter during the ID Capture experience. Each state includes a brief description and optionally a link to its source in Figma or screen-specs.

***

## Tutorial

Introductory screen shown before the camera opens. It sets expectations (flat surface, good lighting, show full ID, avoid glare) and include an short animation.

<Image align="center" border={false} src="https://developer.incode.com/assets/8f2f7b0e005808c9aa2cc235d212d462.png" />

<br />

## Permission Screens

Shown when camera permissions have not been granted. Includes pre-permission context, OS-specific instructions, and fallback steps if the system dialog is dismissed.

<Image align="center" border={false} src="https://developer.incode.com/assets/783a8d02983152c1f4d76f788f07dc7a.png" />

<br />

## Auto Capture

Primary capture method for the **ID Capture**. The camera view is active and the system monitors real-time quality gates (glare, cut-off, blur, edge visibility, barcode/MRZ presence if applicable). When all thresholds are met, the photo is captured automatically.

<Image align="center" border={false} src="https://developer.incode.com/assets/70794568e39a4daefae7c8d24573fd05.png" />

<br />

## Manual Capture (Fallback)

If auto-capture doesn’t trigger (e.g., complex lighting, slow device, user delay) then after a timeout a manual capture button is shown and user can tap to take photo themselves.

<Image align="center" border={false} src="https://developer.incode.com/assets/b30b2b420cfd219391c641b9e51121a9.png" />

<br />

## Feedback Messages (Real-Time Guidance)

While the camera is active, real-time messages guide the user to correct issues such as: “Move closer”, “Avoid glare”, “Show all four corners”, “Flip to back side”, etc.

<Image align="center" border={false} src="https://developer.incode.com/assets/ff215c22f69f4db7cedad4df5f597172.png" />

<br />

## Analyzing

After capture (front/back) the images are being uploaded and processed (OCR, authenticity check). During this stage the UI prevents further interaction and shows progress.

<Image align="center" border={false} src="https://developer.incode.com/assets/fa345afc8c9904464a946ccd91761188.png" />

<br />

## Success

When the images pass quality checks and upload/processing succeeds, the user sees a success screen. The user can proceed to the next verification step without additional input.

<Image align="center" border={false} src="https://developer.incode.com/assets/c1ec9ef8cc2f4ccdfdba8f0228e947b1.png" />

<br />

## Retry Errors

Displayed when **ID Capture** fails but attempts remain. Provides specific corrective guidance and a retry CTA. Attempts reset after a successful capture.

<Image align="center" border={false} src="https://developer.incode.com/assets/a6b0f23b652b5df03a6bb8fd98a6a590.png" />

<br />

<br />

## Document Not Accepted Errors

Document Not Accepted is a screen shown when the user’s ID can’t be verified—for example, due to an expired ID document or an unsupported document type. It displays a list of accepted documents for that country so the user can see which types are valid for verification.

<Image align="center" border={false} src="https://developer.incode.com/assets/93e5036d6229aa8a1c49bf40b06de4dc.png" />

<br />

## Final Errors (No Attempts Remaining)

When all permitted attempts are exhausted, this screen indicates that manual review will follow (or next steps if applicable).

<Image align="center" border={false} src="https://developer.incode.com/assets/c96ffa81f961dc85fc9985d3f6920eac.png" />

<br />

## Connection Error

Displays when connectivity is lost during capture or upload. Users can retry once a stable connection is restored.

<Image align="center" border={false} src="https://developer.incode.com/assets/dc0cedc60d1e935e0d280dbdf179e514.png" />

---

- Path: `design-and-ux/id-capture-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/id-capture-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/id-capture-specs-guidelines.md

# Specs & Guidelines

The **ID Capture** module includes complete Figma specifications detailing spacing, layout rules, typography tokens, and language variants for **ID Capture** flows. These specifications ensure consistent behavior and appearance across all platforms, while allowing localized versions of the UI to scale correctly without breaking alignment or interfering with the document frame.

They also define how the capture frame, overlay, and instruction text behave in both light and dark modes, ensuring visual clarity and compliance with accessibility and performance standards.

<Image align="center" border={false} src="https://developer.incode.com/assets/aada482a8e0b8ffd312171c163f39a85.png" />

<br />

***

## Responsiveness & Viewport Adaptation

The **ID Capture** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas—such as the capture frame, document preview, instructions, and action buttons—remain visible, accessible, and properly aligned across all platforms. The capture overlay automatically scales to preserve the correct document proportions and maintain edge detection accuracy, regardless of screen dimensions or orientation.

<Image align="center" border={false} src="https://developer.incode.com/assets/a7d8cc18748fd19cece79b86d192e845.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                                                 |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Small phones (e.g., iPhone SE)** | UI elements stack vertically; the **ID frame** scales down to maintain visibility and safe padding.          |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent between tutorial text, frame, and CTAs.           |
| **Tall/narrow Android devices**    | Vertical spacing redistributes; capture instructions stay pinned above the frame and button area.            |
| **Foldables (e.g., Pixel Fold)**   | The **ID frame** enlarges with balanced white space; document preview remains centered.                      |
| **Tablets**                        | Increased layout margins; the **ID frame** scales proportionally without exceeding the 4:3 aspect ratio.     |
| **Desktop web**                    | Centered layout with controlled max-width and added safe-area padding; content stays proportionally aligned. |

<br />

### What is responsive (and customizable)

| **Responsive Behavior**                                                        | **Element**             | **Customizable**                  |
| ------------------------------------------------------------------------------ | ----------------------- | --------------------------------- |
| Scales proportionally with viewport height while maintaining a fixed 4:3 ratio | **ID frame area**       | Color only (size/shape are fixed) |
| Reflows to one or two lines depending on device width                          | **Instruction text**    | Yes, text is fully localizable    |
| Width adjusts to container; vertical spacing adapts by breakpoint              | **Buttons**             | Color and label                   |
| Pinned to bottom safe-area across screen sizes                                 | **Footer / watermark**  | Optional                          |
| Expand to fill the full viewport; maintain contrast against ID image           | **Background surfaces** | Yes                               |
| Adjusts padding according to device safe-area insets                           | **Header area**         | Limited (color only)              |

<br />

### What remains fixed across breakpoints

| **Element**                   | **Reason**                                                                             |
| ----------------------------- | -------------------------------------------------------------------------------------- |
| **Capture logic & detection** | Must remain consistent for accurate glare, blur, and edge validation across devices.   |
| **Frame proportions**         | The 4:3 ratio is fixed to ensure correct document alignment and authenticity analysis. |
| **Minimum text size**         | Required for readability and WCAG AA accessibility compliance.                         |
| **Minimum tap target sizes**  | Ensures accessibility for manual capture and retry actions.                            |
| **Overall hierarchy**         | Maintains a predictable layout and cognitive flow across screen sizes.                 |

<br />

### Design Notes

* The ID frame always remains the primary focal element, scaling proportionally across devices.
* Horizontal spacing is fluid, while vertical spacing follows safe thresholds to avoid overlapping elements.
* Avoid adding custom UI above or below the capture area, as it may disrupt detection accuracy or alignment.
* Multiline instructional text is supported, but extremely long localized strings should be avoided to prevent overflow.

<br />

***

## Desktop & Tablet Guidelines

The ID Capture module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

In desktop and tablet environments, the ID frame automatically scales to preserve the document’s proportions and maintain detection accuracy. Spacing, typography, and button placement adjust to wider layouts, ensuring all key elements—such as the instruction text, capture button, and document preview—remain accessible and visually balanced.

<Image align="center" border={false} src="https://developer.incode.com/assets/cbaa91f339db5be848197c6d253b9a74.png" />

<br />

***

## Prototype & Transitions

ID Capture includes predefined transition rules and micro-interactions that ensure a smooth user experience across tutorial, capture, analyzing, and error flows. Timing, easing, and animation guidelines—such as frame scaling, progress transitions, and feedback states—are documented directly within the Figma prototypes.

<Image align="center" border={false} src="https://developer.incode.com/assets/a40ea72f7e9dc7f87d68baa99f21f5b6.gif" />

<br />

***

## Localization

The **ID Capture** module supports full localization and is designed to adapt seamlessly to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure that layouts remain stable across all regions and scripts.

This ensures that user instructions, document type names, and error messages (such as “Glare present” or “ID scan failed”) remain readable and correctly positioned across languages.

<Image align="center" border={false} src="https://developer.incode.com/assets/4596697f116804c4c03802968738eea6.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/id-capture-v1-vs-v2`
- URL: https://developer.incode.com/design-and-ux/id-capture-v1-vs-v2/
- Markdown: https://developer.incode.com/design-and-ux/id-capture-v1-vs-v2.md

# ID Capture V1 vs V2 Comparison

<br />

In v1, the ID Capture experience begins with a simple tutorial slide followed by a native camera permission request. Once granted, the user enters the capture flow with minimal guidance. Instructions are limited to small tooltip-like titles inside a gray section box, with no dynamic feedback, onboarding messages, or additional support during document alignment.

In v2, the experience introduces a richer and more supportive flow. The tutorial screen includes an animated illustration that sets expectations for the capture process. Camera permission is handled through a dedicated bottom sheet that explains why access is needed before invoking the system dialog. Once in the capture experience, the user sees clear on-screen instructions, supported by a timed guided animation (shown after ~10 seconds, fully configurable) that demonstrates how to properly position their document. Live cues provide real-time textual feedback paired with small illustrations, ensuring users receive immediate guidance when alignment or capture conditions need correction.

<br />

<Image align="center" border={false} caption="In v1, the user moves through a simple two-screen tutorial, receives an immediate system permission pop-up, and enters a basic capture flow with minimal tooltip guidance and no dynamic feedback." src="https://developer.incode.com/assets/9ad5a3bda5f18ff4b03fdeeb0326ae13.jpg" />

<br />

<Image align="center" border={false} caption="In v2, the experience is more guided: the user sees an animated tutorial, a dedicated permission bottom sheet explaining why access is needed, a clearer capture screen with strong instructions, automatic capture with on-screen cues, an analyzing step, and a polished success screen confirming the document was processed." src="https://developer.incode.com/assets/527561cbc7f5af43cfbb40ca5711b4ef.jpg" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| **Capability**                   | **V1**                         | **V2**                              | **Notes**                                                                                         |
| -------------------------------- | ------------------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Auto-capture**                 | ✔️                             | ✔️ (improved)                       | V2 introduces faster, more reliable detection for automatic capture.                              |
| **Supported document types**     | ID, DL, Passport, PoA          | Expanded (incl. barcode scanning)   | V2 adds barcode scanning capabilities.                                                            |
| **Guidance timer**               | ✖️                             | ✔️                                  | V2 supports configurable timed guidance (e.g., animation after 10s).                              |
| **Dynamic live cues**            | ✖️                             | ✔️                                  | V2 includes real-time textual + illustrated feedback; V1 shows static tooltips only.              |
| **Permission flow behavior**     | Direct native permission popup | Pre-permission logic + native popup | V2 introduces an intermediate step explaining why permission is required (behavioral difference). |
| **Customization options**        | Limited                        | Full customization                  | V2 allows full control over text, colors, buttons, illustrations, and behavior.                   |
| **Documentation completeness**   | Minimal (key screens only)     | Full module documentation           | V2 provides complete, standardized documentation coverage.                                        |
| **Error states**                 | Basic                          | Basic (no new logic)                | Error handling behavior remains the same between versions.                                        |
| **Developer events / callbacks** | Unchanged                      | Unchanged (no confirmed additions)  | No known new callbacks or event changes in V2.                                                    |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| **Behavior**                     | **V1**                                                   | **V2**                                                      | **Notes**                                                                 |
| -------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
| **Tutorial behavior**            | Static slides with minimal instruction                   | Animated tutorial explaining the process                    | V2 sets clearer expectations and prepares user for capture flow.          |
| **Permission flow logic**        | Immediate native popup is triggered                      | Pre-permission bottom sheet shown before native popup       | V2 introduces an explanatory step to reduce permission drop-off.          |
| **In-capture guidance**          | Only short static tooltips inside gray area              | Continuous, clear instructions displayed on screen          | V2 actively guides the user instead of relying on passive hints.          |
| **Timed guidance behavior**      | None                                                     | After ~10s (configurable), a guided animation appears       | Helps users correctly position their ID if they struggle initially.       |
| **Live feedback cues**           | None (no dynamic feedback)                               | Real-time textual messages paired with small illustrations  | V2 helps users correct issues such as misalignment or framing.            |
| **Behavior during auto-capture** | Basic auto-capture triggers with limited feedback        | Improved auto-capture with alignment detection and feedback | V2 provides more consistent capture results with clearer state awareness. |
| **Post-capture flow**            | Immediate capture with no intermediate processing screen | Shows “Taking photo…” → “Analyzing…” → success confirmation | V2 communicates system activity, reducing uncertainty.                    |
| **End-of-flow behavior**         | Camera simply closes or proceeds silently                | Explicit success screen with next-step guidance             | V2 provides clarity, especially for multi-step document capture.          |

<br />

***

<br />

<br />

## Performance Improvements

Differences in efficiency, speed, stability, and quality of output.

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" border={false} caption="Incode Brand" src="https://developer.incode.com/assets/c8be8f0464ed1ebcc5786e3d633e6042.jpg" />

<Image align="center" border={false} caption="Your Brand" src="https://developer.incode.com/assets/b4672a4fadb199f45c8fc08a3f5cd1b1.jpg" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

**For full details, visit the Customization tab of this module.**

<br />

<br />

---

- Path: `design-and-ux/input`
- URL: https://developer.incode.com/design-and-ux/input/
- Markdown: https://developer.incode.com/design-and-ux/input.md

# Input

Inputs collect text from users. Prizma includes a standard text field, OTP cells for verification codes, and a multiline variant. All inputs share the same token layer for border, surface, and typography.

## Try it live

Click in and type — focus ring and placeholder come from the input tokens.

<div class="dh-demo"><p class="dh-demo-label">Interactive — focus / type</p><input class="dh-pz-input" type="text" placeholder="Full legal name" /><input class="dh-pz-input" type="text" placeholder="Disabled state" disabled /></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-field">Full name</span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Text field</span><code>.input</code><p>The standard single-line field for names, emails, and free text.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-otp"><b>1</b><b>2</b><b class="is-focus"></b><b></b></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">OTP cells</span><code>.input-otp</code><p>One cell per digit for verification codes. Focus advances automatically.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-field" style="height:88px;align-items:flex-start;padding-top:12px"><span style="color:#82879a">Tell us more…</span></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Multiline</span><code>.input-multiline</code><p>Grows for longer answers; used for notes and feedback.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--input-surface-default | Input background | Component
--input-border-default | Border — rest | Component
--input-border-focus | Border — focused | Component
--input-border-error | Border — error | Component
--input-border-disabled | Border — disabled | Component
--input-text-default | Input text color | Component
--input-placeholder | Placeholder text color | Component
--input-helper-error | Error helper text color | Component
--radius-input | Corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/list`
- URL: https://developer.incode.com/design-and-ux/list/
- Markdown: https://developer.incode.com/design-and-ux/list.md

# List

The List component shows a numbered sequence of steps with clear progress indicators. Each row is independently styled as done, active, or pending, giving users a clear view of where they are in a flow.

<div class="dh-rule"><span>Row states</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#189f6008"><div class="dh-var-stage"><span class="dh-pz-list"><span class="dh-pz-list-row"><span class="dh-pz-list-num is-done">✓</span><span class="dh-pz-list-text">Position document in frame</span></span></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#189f6014;color:#189f60">Done</span><code>.gc-list-row__num--check</code><p>Completed step. The number is replaced by a checkmark in brand success color.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-list"><span class="dh-pz-list-row"><span class="dh-pz-list-num">1</span><span class="dh-pz-list-text">Hold steady while scanning</span></span></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Active</span><code>.gc-list-row (default)</code><p>Current step in progress. The number is displayed normally in the active color.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-list"><span class="dh-pz-list-row"><span class="dh-pz-list-num is-pending">1</span><span class="dh-pz-list-text is-muted">Confirm captured image</span></span></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Pending</span><code>.gc-list-row__num--pending</code><p>Upcoming step. Number and text are muted to reduce visual weight.</p></div></div></div>

<div class="dh-rule"><span>Full list</span><i></i></div>

## All three states together

A typical 3-step list showing steps 1 done, step 2 active, step 3 pending.

<div class="dh-stage"><span class="dh-pz-list"><span class="dh-pz-list-row"><span class="dh-pz-list-num is-done">✓</span><span class="dh-pz-list-text">Position document in frame</span></span><span class="dh-pz-list-row"><span class="dh-pz-list-num">2</span><span class="dh-pz-list-text">Hold steady while scanning</span></span><span class="dh-pz-list-row"><span class="dh-pz-list-num is-pending">3</span><span class="dh-pz-list-text is-muted">Confirm captured image</span></span></span></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--list-num-done | Done step indicator bg | Component
--list-num-active | Active step indicator bg | Component
--list-num-pending | Pending step indicator bg | Component
--list-text-active | Active step text color | Component
--list-text-muted | Pending step text color | Component
--list-connector | Vertical connector line | Component
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/loading`
- URL: https://developer.incode.com/design-and-ux/loading/
- Markdown: https://developer.incode.com/design-and-ux/loading.md

# Loading

Loading components communicate that the system is working. Prizma provides a spinner for indeterminate states and a progress bar for determinate ones. Both are used extensively in biometric capture and verification screens.

## Try it live

<div class="dh-demo"><p class="dh-demo-label">Live — indeterminate spinner and determinate progress</p><span class="dh-pz-spinner"></span><span class="dh-pz-progress"><i></i></span></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-spinner"></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Spinner</span><code>.loading-spinner</code><p>Indeterminate. Use when the wait time is unknown — processing, uploading, verifying.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-progress"><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#189f6014;color:#189f60">Progress bar</span><code>.loading-progress</code><p>Determinate. Use when progress is measurable — multi-step flows, uploads with known size.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--spinner-track-color | Spinner ring — background arc | Component
--spinner-fill-color | Spinner ring — active arc | Component
--loading-bar-track | Progress bar track background | Component
--loading-bar-fill | Progress bar fill color | Component
--loading-bar-height | Bar height | Component
--radius-loading-bar | Bar corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/manual-upload-id-customization`
- URL: https://developer.incode.com/design-and-ux/manual-upload-id-customization/
- Markdown: https://developer.incode.com/design-and-ux/manual-upload-id-customization.md

# Customization

This section outlines the elements you can customize within the **Manual Upload ID** module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text, tab labels, and brand colors, and which elements remain fixed to ensure consistency, accessibility, and reliable document processing across platforms.

<br />

## Upload Your Documents

The Upload Your Document screen is where the user selects their document type and uploads the front and back sides of their identity document. It presents upload prompts per document side, image quality hints, and a disabled Continue button that activates only once all required sides have been validated.


<Image src="https://developer.incode.com/assets/51fd1adc36eb76e56296464246a60ee0.png" align="center" />


<br />

### Customizable Elements

| Area                  | What can be customized                                    | Notes                                                       |
| --------------------- | --------------------------------------------------------- | ----------------------------------------------------------- |
| **Text**              | Title, subtitle, tab labels, upload row labels, hint text | Fully localizable; tone can be adapted to your brand voice. |
| **Button — Upload**   | Label, color, radius                                      | Must follow platform guidelines.                            |
| **Button — Continue** | Label, color, radius (active and disabled states)         | Must follow platform guidelines.                            |
| **Background Color**  | Screen background                                         | Must maintain strong contrast with text and elements.       |
| **Brand Colors**      | Header text, tab indicator, accent color                  | Uses brand tokens.                                          |
| **Footer**            | "Verified by Incode" line                                 | Optional but recommended for trust and product consistency. |

<br />

<br />

### Fixed Elements

| Element                            | Why it is fixed                                                       |
| ---------------------------------- | --------------------------------------------------------------------- |
| **Continue button disabled state** | Must remain inactive until all required document sides are validated. |
| **Upload row structure**           | Required to ensure both document sides are collected consistently.    |
| **Component spacing & safe areas** | Required for device compatibility and visual stability.               |
| **Text hierarchy**                 | Optimized to communicate requirements clearly.                        |
| **WCAG contrast requirements**     | Mandatory for accessibility and regulatory compliance.                |

<br />

<br />

### Token Refearence


<Image src="https://developer.incode.com/assets/ea05394d7ae4f9d207a62dff44e869a7.png" align="center" />


| UI Element                                | Token                                                                       | Value   |
| ----------------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**                            | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                            | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Tab label (active)**                    | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Tab label (inactive)**                  | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Upload row background**                 | Surface/Neutral/50 → Color/Gray/50                                          | #FCFCFD |
| **Upload button background**              | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Upload button text**                    | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Upload row icon**                       | Icon/Neutral/50 Static → Color/Gray/50                                      | #FCFCFD |
| **Row label text**                        | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Row icon**                              | Icon/Neutral/500 → Color/Gray/500                                           | #60667C |
| **Close icon**                            | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Hint area background**                  | Surface/Brand/50 → Color/Brand/50                                           | #E5F0FF |
| **Hint text**                             | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Continue button background (disabled)** | Button/Primary/Surface/Disabled → Surface/Neutral/100 → Color/Gray/100      | #EBECEF |
| **Continue button text (disabled)**       | Button/Primary/Text/Disabled → Text/Body/500 (Secondary) → Color/Gray/500   | #60667C |
| **Footer text**                           | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |

<br />

### Design Notes

- Keep instructions clear about what document sides are required and the expected image quality.
- The Continue button must stay visually distinct in its disabled state to communicate that action is still required.
- Ensure tap targets on Upload buttons meet accessibility guidelines.

<br />

***

## Uploading Documents

This screen appears while a selected file is being uploaded to the system. A spinner and a status message keep the user informed while the operation completes in the background.


<Image src="https://developer.incode.com/assets/d6664cb68061760530afda859958b0bb.png" align="center" />


<br />

### Customizable Elements

| Area                         | What can be customized                     | Notes                                          |
| ---------------------------- | ------------------------------------------ | ---------------------------------------------- |
| **Title text**               | Loading message ("Hold on a sec...")       | Fully localizable; should remain concise.      |
| **Subtitle text**            | Supporting message ("Uploading your file") | Tone can match your brand voice; optional.     |
| **Spinner accent color**     | Primary spinner stroke                     | Uses brand tokens; must remain visually clear. |
| **Spinner background color** | Secondary spinner stroke                   | Should maintain contrast with accent.          |
| **Background Color**         | Screen background                          | Must preserve readability and contrast.        |

<br />

### Fixed Elements

| Element                     | Why it is fixed                                               |
| --------------------------- | ------------------------------------------------------------- |
| **Processing flow timing**  | Linked to backend processing; cannot be shortened or skipped. |
| **Spinner animation style** | Standardized across SDK for performance and recognizability.  |
| **Spacing & safe areas**    | Required for device consistency.                              |
| **Minimum contrast**        | Required for accessibility and compliance.                    |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/b01d81187ac7e433311ffb0b50986128.png" align="center" />


| UI Element             | Token                                                           | Value   |
| ---------------------- | --------------------------------------------------------------- | ------- |
| **Background**         | Surface/Neutral/Light → Color/Neutral/light                     | #FFFFFF |
| **Spinner background** | Spinner/surface/secondary → Surface/Primary/50 → Color/Brand/50 | #E5F0FF |
| **Spinner accent**     | Spinner/surface/primary → Surface/Primary/500 → Color/Brand/500 | #006AFF |
| **Title text**         | Spinner/text/title → Text/Body/primary → Color/Gray/800         | #262831 |
| **Subtitle text**      | Spinner/text/subtitle → Text/Body/secondary → Color/Gray/500    | #60667C |

### Design Notes

- Keep copy short to minimize cognitive load during the wait.
- Use subtitle text to set user expectations about what is happening.
- Avoid adding imagery or additional UI elements that may distract from the upload state.

<br />

***

## Ready for Verification

Shown once both document sides have been successfully uploaded and validated with a green checkmark per side. The Continue button becomes active, allowing the user to proceed to the verification step.


<Image src="https://developer.incode.com/assets/15f54aaf36e05ea610bd0349f9e96f0d.png" align="center" />


<br />

### Customizable Elements

| Area                       | What can be customized                             | Notes                                                               |
| -------------------------- | -------------------------------------------------- | ------------------------------------------------------------------- |
| **Text**                   | Title, subtitle, tab labels, row labels, hint text | Fully localizable.                                                  |
| **Success indicator icon** | Green checkmark per row                            | Can replace with custom success icon; must remain clearly positive. |
| **Button — Continue**      | Label, color, radius                               | Must follow platform guidelines.                                    |
| **Background Color**       | Screen background                                  | Must maintain contrast with content.                                |
| **Brand Colors**           | Header text, tab indicator, accent color           | Uses brand tokens.                                                  |
| **Footer**                 | "Verified by Incode" line                          | Optional but recommended.                                           |

<br />

<br />

### Fixed Elements

| Element                          | Why it is fixed                                                  |
| -------------------------------- | ---------------------------------------------------------------- |
| **Success logic per row**        | Must reflect actual validation result per document side.         |
| **Status color mapping**         | Green = positive; required for consistent semantics.             |
| **Continue button active state** | Only activates when all sides are validated; cannot be bypassed. |
| **Button placement**             | Standardized across modules.                                     |
| **WCAG contrast requirements**   | Mandatory for accessibility and regulatory compliance.           |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/da0f37bb1dfd27cfcbb5a68e855db32c.png" align="center" />


| UI Element                     | Token                                                                       | Value   |
| ------------------------------ | --------------------------------------------------------------------------- | ------- |
| **Background**                 | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                 | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Tab label (active)**         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Tab label (inactive)**       | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Row background**             | Surface/Neutral/50 → Color/Gray/50                                          | #FCFCFD |
| **Row icon**                   | Icon/Neutral/500 → Color/Gray/500                                           | #60667C |
| **Row label text**             | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Close icon**                 | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Success icon**               | Icon/Status/Positive → Color/Positive/500                                   | #189F60 |
| **Hint area background**       | Surface/Brand/50 → Color/Brand/50                                           | #E5F0FF |
| **Hint text**                  | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Continue button background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Continue button text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Footer text**                | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |

<br />

### Design Notes

- The green checkmark per row gives users clear, per-side confirmation without requiring them to re-read the full screen.&#x20;
- Ensure the Continue button uses the brand 500 color to provide a clear and prominent next step.
- Maintain visual consistency between the upload and validated states of each row.

<br />

***

## Error Screen

Error screens appear inline within the upload flow when a document side is rejected or an incorrect file is submitted. The user is notified with a clear message directly below the affected upload row and prompted to upload the correct document. The Continue button remains disabled until the issue is resolved.


<Image src="https://developer.incode.com/assets/84801870ccd97dcbd17363c612cd8340.png" align="center" />


<br />

### Customizable Elements

| Area                   | What can be customized                                      | Notes                                                        |
| ---------------------- | ----------------------------------------------------------- | ------------------------------------------------------------ |
| **Title text**         | Screen title                                                | Fully localizable.                                           |
| **Tab labels**         | Document type tab labels                                    | Fully localizable.                                           |
| **Error message text** | Inline error message ("Please upload the correct document") | Fully localizable; tone should be neutral and non-blaming.   |
| **Error icon**         | Inline error indicator                                      | Can be replaced; must remain clearly negative.               |
| **Button — Upload**    | Label, color, radius                                        | Action should guide the user to retry with the correct file. |
| **Background color**   | Screen background                                           | Must support strong contrast.                                |
| **Brand Colors**       | Header text, tab indicator                                  | Uses brand tokens.                                           |
| **Footer**             | "Verified by Incode" line                                   | Optional but recommended.                                    |

<br />

### Fixed Elements

| Element                            | Why it is fixed                                                   |
| ---------------------------------- | ----------------------------------------------------------------- |
| **Error logic**                    | Must accurately reflect the document validation result.           |
| **Status color mapping**           | Red = negative; required for clarity and consistency.             |
| **Continue button disabled state** | Cannot advance until the error is resolved.                       |
| **Inline error placement**         | Positioned directly below the affected row for clear attribution. |
| **Button placement**               | Consistent across modules.                                        |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/f50455ccb13a6821c74bd0e88a6d7f21.png" align="center" />


| UI Element                                | Token                                                                     | Value   |
| ----------------------------------------- | ------------------------------------------------------------------------- | ------- |
| **Background**                            | Surface/Neutral/0 → Color/Gray/0                                          | #FFFFFF |
| **Title text**                            | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| **Tab label (active)**                    | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| **Tab label (inactive)**                  | Text/Body/500 (Secondary) → Color/Gray/500                                | #60667C |
| **Row background**                        | Surface/Neutral/50 → Color/Gray/50                                        | #FCFCFD |
| **Row icon**                              | Icon/Neutral/500 → Color/Gray/500                                         | #60667C |
| **Row label text**                        | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| **Success icon (validated row)**          | Icon/Status/Positive → Color/Positive/500                                 | #189F60 |
| **Error icon**                            | Icon/negative → Color/Negative/600                                        | #E71111 |
| **Inline error text**                     | Input/Text/Helper/Negative → Text/Status/Negative → Color/Negative/500    | #E71111 |
| **Hint area background**                  | Surface/Brand/50 → Color/Brand/50                                         | #E5F0FF |
| **Hint text**                             | Text/Body/800 (Primary) → Color/Gray/800                                  | #262831 |
| **Continue button background (disabled)** | Button/Primary/Surface/Disabled → Surface/Neutral/100 → Color/Gray/100    | #EBECEF |
| **Continue button text (disabled)**       | Button/Primary/Text/Disabled → Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| **Footer text**                           | Text/Body/500 (Secondary) → Color/Gray/500                                | #60667C |

<br />

### Design Notes

- Error messaging should be clear, direct, and action-oriented.&#x20;
- Inline placement of the error message directly below the affected row ensures users understand exactly which side needs to be corrected.
- Maintain consistent spacing and visual hierarchy for readability.
- Avoid technical language; users should understand the issue at a glance.

<br />

***

##

<br />

---

- Path: `design-and-ux/manual-upload-id-design`
- URL: https://developer.incode.com/design-and-ux/manual-upload-id-design/
- Markdown: https://developer.incode.com/design-and-ux/manual-upload-id-design.md

# Manual Upload ID

**Manual Upload ID** allows users to submit photos of their physical identity document directly from their device's photo library or files as part of the verification flow. It supports multiple document types — such as ID and Passport — and requires the user to upload both the front and back sides, enabling verification without requiring a live camera capture.

**Manual Upload ID** typically occurs at the beginning of the document verification step, as an alternative to camera-based ID capture.

![](https://developer.incode.com/assets/e1f38780f873132dc179022932ac4e94.gif)

<br />

***

## Where it fits in the flow

**Manual Upload ID** usually appears at the beginning of the document verification step, as an alternative to real-time camera capture.

Once the user successfully uploads both sides of their document and the files are validated, the flow continues to identity verification and any downstream verification logic required by the application.

***

## User Flow

The **Manual Upload ID** experience moves through several clear stages that guide the user from document selection to successful submission. The user selects a document type — such as ID or Passport — and is prompted to upload the front and back sides of their document from their device's photo library or files.

Once both sides are uploaded and confirmed, the module processes the files and validates the document. The user then receives a success state or an inline error message with the option to correct and retry before continuing to the next step.

<br />


<Image src="https://developer.incode.com/assets/9fb3081d14072cb8d6ca89d577e31219.png" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in **Manual Upload ID**, from document type selection and file upload, through the uploading and verification states, to the final success or error feedback.


<Image src="https://developer.incode.com/assets/d426e2a2df5b027bc850203805b44480.png" align="center" />


<br />

**Open Full Flow Map in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=1-283">Figma</Anchor>

***

## Happy Path (Light & Dark)

The ideal user journey when both document sides are uploaded and verified successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user selects the correct document type, uploads both sides from their library, the files are validated without errors, and the system successfully processes the document without requiring retries or corrections. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/94bb15eb80fe79263f973d75a50022ae.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/ef361702ca5edfa3a6707aac2341d8b9.png" align="center" caption="Dark mode" />


<br />

**Open Happy Path in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2288-10492">Figma</Anchor>

***

## Best Practices

Recommended guidelines for designing and implementing the Manual Upload ID experience.

**✅ Do**

- Keep instructions clear about what document sides are required and the expected image quality.
- Show upload status per document side so users always know what has been completed.
- Provide clear inline error messages with actionable next steps when a file is rejected.
- Always allow users to re-upload a side if it was rejected, without restarting the entire flow.
- Include image quality hints (e.g. "Ensure text on ID is readable", "Photo must be sharp and glare-free") to reduce submission errors.

**❌ Don’t**

- Don't allow the Continue button to be active until all required document sides have been uploaded and validated.
- Don't skip or reduce essential error states.
- Don't rely solely on color to communicate upload status or validation feedback.
- Don't remove the image quality hints, as they help users submit files that can be processed successfully.

<br />

---

- Path: `design-and-ux/manual-upload-id-screens-states`
- URL: https://developer.incode.com/design-and-ux/manual-upload-id-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/manual-upload-id-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the **Manual Upload ID** experience. Each state includes a brief description and a direct link to its source in Figma.

**Open Full Screen and Specs in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2005-20593">Figma</Anchor><br />Source of truth for layout, visual specs, interactions, and platform variations.

***

## Upload Your Documents

The main upload screen where the user selects their document type — such as ID or Passport — and uploads the front and back sides of their document from their device's photo library or files. The Continue button remains disabled until both sides have been successfully uploaded and validated. Image quality hints are shown to help users submit files that can be processed correctly.


<Image src="https://developer.incode.com/assets/644715a4bad9e305215e92e3e174c7b4.png" align="center" />


<br />

## Library

The native file picker presented when the user taps an Upload button. The user can browse their photo library or files to select the appropriate document side. This screen is controlled by the operating system and opens directly within the upload flow.


<Image src="https://developer.incode.com/assets/949d3f39e3bdb3547bf08242cfa8e67c.png" align="center" />


<br />

## Uploading

Shown while a selected file is being uploaded to the system. A loading spinner and a status message keep the user informed while the operation completes in the background.


<Image src="https://developer.incode.com/assets/05ff46e6a46342b9e7a8bf89543bf86a.png" align="center" />


<br />

## Ready for Verification

Shown once both document sides have been successfully uploaded and confirmed with a green checkmark indicator per side. The Continue button becomes active, allowing the user to proceed to the verification step.


<Image src="https://developer.incode.com/assets/14312209e4be14e4c7a192e7554eff6d.png" align="center" />


<br />

## Verifying

Shown while the system processes the uploaded document files and verifies the identity. A loading spinner and a status message keep the user informed while the operation completes in the background.


<Image src="https://developer.incode.com/assets/f1bd9902f544fbe7e1fbd76f9a8abb8f.png" align="center" />


<br />

## Success

Shown when the identity has been successfully verified. The user receives a clear visual confirmation before the flow continues to the next step.


<Image src="https://developer.incode.com/assets/1b44ab9c50846a9530e63effe8571850.png" align="center" />


<br />

## Errors

Shown inline on the upload screen when a document side is rejected or an incorrect file is uploaded. The user is notified with a clear error message directly below the affected upload row and prompted to upload the correct document. The Continue button remains disabled until the issue is resolved.


<Image src="https://developer.incode.com/assets/df0279cdb496352b8cd30b408aa5982f.png" align="center" />


<br />

---

- Path: `design-and-ux/manual-upload-id-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/manual-upload-id-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/manual-upload-id-specs-guidelines.md

# Specs & Guidelines

The **Manual Upload ID** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/b1d5bf9bfdebd26a8b2edb6631d81ec7.png" align="center" />


<br />

**Open Screens Specs in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2005-20593">Figma</Anchor>

<br />

***

## Responsiveness & Viewport Adaptation

The **Manual Upload ID** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/11ef0f91e6f037d37801b0d5862ecc72.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                         | Behavior                                                                                    |
| ---------------------------------- | ------------------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; upload rows and hint area scale down to maintain visibility. |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent.                                 |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and upload rows remain pinned to the top.          |
| **Foldables (e.g., Pixel Fold)**   | Larger upload area and more balanced white space; content remains centered.                 |
| **Tablets**                        | Increased layout margins; upload rows and buttons scale proportionally.                     |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding.                    |

<br />

### What is responsive (and customizable)

| Element                 | Responsive Behavior                                  | Customizable                   |
| ----------------------- | ---------------------------------------------------- | ------------------------------ |
| **Upload rows**         | Scale proportionally by viewport width               | Limited (colors and labels)    |
| **Title text**          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| **Tab selector**        | Width adjusts to container                           | Color & text                   |
| **Buttons**             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| **Hint area**           | Expands to container width; text wraps gracefully    | Color & text                   |
| **Footer / watermark**  | Pinned to bottom safe area                           | Optional                       |
| **Background surfaces** | Expand to full viewport                              | Yes                            |
| **Header area**         | Scales padding according to device safe insets       | Limited (color only)           |
| **Icons**               | Remain centered and maintain distance to the title   | Color & style                  |

<br />

### What remains fixed across breakpoints

| Element                            | Reason                                                   |
| ---------------------------------- | -------------------------------------------------------- |
| **Upload validation logic**        | Must remain consistent for accurate document collection. |
| **Continue button disabled state** | Cannot be bypassed regardless of screen size.            |
| **Minimum text size**              | Required for readability & WCAG compliance.              |
| **Minimum tap target sizes**       | Ensures accessibility on mobile.                         |
| **Overall hierarchy**              | Prevents cognitive load at different sizes.              |

<br />

### Design Notes

- Upload rows always remain the dominant UI elements, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI above or below the module — it may break alignment.
- Multiline text is handled gracefully, but avoid extremely long localized strings in tab labels or button labels.

<br />

**Open Screens Responsiveness in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2005-20593">Figma</Anchor>

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/dbe6a73eb15502a836363abf239d30c5.png" align="center" />


<br />

**Open Desktop & Tablet Guidelines in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2511-2153">Figma</Anchor>

<br />

***

## Prototype & Transitions

**Manual Upload ID** includes predefined transition rules and micro-interactions that ensure a smooth user experience from document type selection and file upload, through the uploading state, to the ready for verification and error outcomes. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/979f0122765b392f79631bd0c6436251.gif" align="center" />


<br />

**Open Prototype & Transitions in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2526-16259">Figma</Anchor>

<br />

***

## Localization

The **Manual Upload ID** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/7274e47091406386caaa4ce446a5ce6a.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable, including tab labels, upload row labels, hint text, button labels, and error messages.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Buttons and CTAs automatically expand to fit translated labels.
- Tab labels should remain short to avoid overflow; use abbreviations where appropriate for longer language variants.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
- Incode supports a variety of languages.

<br />

**Open Screens Localization in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2005-20593">Figma</Anchor>

---

- Path: `design-and-ux/manual-upload-id-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/manual-upload-id-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/manual-upload-id-v1-vs-v2-comparison.md

# Manual Upload ID V1 vs V2 Comparison

<br />

In V1, Manual Upload ID offers a basic experience for submitting identity document photos from a device. The flow covers the essential steps but provides limited guidance, and UI elements are not tokenized, which makes customization difficult and limits the ability to align the experience with your brand.

In V2, Manual Upload ID focuses on clarity and confidence. The flow guides users through document type selection and per-side upload with inline validation feedback, image quality hints, and a disabled Continue button that activates only once all required sides are validated — resulting in a simpler, more direct experience.

<br />


<Image src="https://developer.incode.com/assets/733ae938d13b77778bccc0cb757ea03d.png" align="center" caption="V1 is a basic upload experience with limited guidance and no tokenized customization." />


<br />


<Image src="https://developer.incode.com/assets/dcaff83be094b0cf813beb5696e80c4d.png" align="center" caption="V2 is a refined upload experience with clear per-side validation, inline error feedback, image quality hints, and full token-based customization." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities                   | V1 | V2 | Notes                                                                                                                                           |
| ------------------------------ | -- | -- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Document upload                | ✅  | ✅  | Both versions allow the user to upload identity documents from their device.                                                                    |
| Document type selection        | ✅  | ✅  | Both versions support selecting between document types such as ID and Passport.                                                                 |
| Per-side upload tracking       | ✅  | ✅  | Both versions require the front and back sides to be uploaded separately.                                                                       |
| Image quality hints            | ✅  | ✅  | Both versions display guidance to help users submit files that can be processed correctly.                                                      |
| Inline validation feedback     | ❌  | ✅  | V2 displays immediate inline error messages when an incorrect document is uploaded, allowing the user to correct it without leaving the screen. |
| Continue button disabled state | ✅  | ✅  | Both versions prevent advancing until all required sides are validated.                                                                         |
| Error States                   | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                               |
| Customization options          | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior.                |
| Documentation completeness     | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                                      |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior                 | V1                                                     | V2                                                                                                                        | Notes                                                                                        |
| ------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| Upload interface         | Basic file picker with no additional guidance per side | Structured upload interface with document type tabs, per-side upload prompts, and image quality hints                     | V2 gives users clear context for each required document side, reducing submission errors.    |
| Validation feedback      | Basic error states with no inline guidance             | Immediate inline error message directly below the affected upload row when an incorrect file is detected                  | V2 actively communicates upload issues so users can correct them without leaving the screen. |
| Continue button behavior | Disabled until all sides are uploaded                  | Disabled until all sides are uploaded and validated, with clear visual differentiation between disabled and active states | V2 makes the button state more predictable and visually consistent with the UXv2 system.     |
| State transitions        | Default transitions                                    | Specifically designed screen-by-screen transitions for smoothness                                                         | V2 includes transition guidelines as part of the module documentation package.               |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/6123707a433241829f32ae4c8a14c162.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify. This includes button styles, tab indicator colors, upload row appearance, inline error styling, and the overall visual theme — making it straightforward to align the module with your brand without affecting core upload and validation logic.

**For full details, visit the&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/WCx6d4zXG5nu946mu0KZNO/ID-Manual-Upload---Latest-Design?node-id=2462-18987">Customization</Anchor>**&#x20;tab of this module.**

<br />

<br />

---

- Path: `design-and-ux/modal`
- URL: https://developer.incode.com/design-and-ux/modal/
- Markdown: https://developer.incode.com/design-and-ux/modal.md

# Modal

Modals interrupt the current flow to deliver critical information or request a decision. Prizma modals always include a title, a supporting message, and a primary action. They are centered on screen and overlay a dimmed background.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-modal"><strong>Verification failed</strong><p>We couldn’t verify your identity. Please try again with better lighting.</p><button class="dh-pz-btn dh-pz-btn-primary" type="button">Try again</button></span></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#189f6008"><div class="dh-var-stage"><span class="dh-pz-modal" style="width:220px"><strong>Identity verified</strong><p>You can continue with your process.</p><button class="dh-pz-btn dh-pz-btn-primary" type="button">Continue</button></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#189f6014;color:#189f60">Confirmation</span><code>.modal--confirm</code><p>A single positive action to move forward.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-modal" style="width:220px"><strong>Verification failed</strong><p>We couldn’t verify your identity.</p><button class="dh-pz-btn dh-pz-btn-secondary" type="button">Try again</button></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#e7111114;color:#e71111">Recovery</span><code>.modal--error</code><p>Explains what went wrong and offers a retry path.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-modal" style="width:220px"><strong>Camera access needed</strong><p>Allow access to continue with face verification.</p><button class="dh-pz-btn dh-pz-btn-primary" type="button">Allow access</button></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Permission</span><code>.modal--permission</code><p>Requests a decision before the flow can continue.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--modal-surface | Modal card background | Component
--modal-border | Modal card border | Component
--modal-title | Title text color | Component
--modal-sub | Supporting text color | Component
--modal-overlay | Background overlay color | Component
--modal-close-icon | Close icon color | Component
--radius-modal | Modal corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/module-customization`
- URL: https://developer.incode.com/design-and-ux/module-customization/
- Markdown: https://developer.incode.com/design-and-ux/module-customization.md

# Module Customization

This section documents the end user experience and customization options for each Incode module. It's the reference for frontend engineers integrating Incode SDKs who need to know what users will see, what can be branded or restyled, and what design constraints apply.

## Modules documented in this section

Biometric capture: [ID Capture](/design-and-ux/id-capture-design/), [Face Capture](/design-and-ux/face-capture-design/), [Face Match](/design-and-ux/face-match-design/)

Document handling: [Document Capture](/design-and-ux/document-capture-design/), [Upload Digital ID](/design-and-ux/upload-digital-id-design/), [NFC](/design-and-ux/nfc-design/), [Manual Upload ID](/design-and-ux/manual-upload-id-design/), [OCR Review](/design-and-ux/ocr-review-design/), [Fiscal QR OCR](/design-and-ux/fiscal-qr-ocr-design/)

Data collection and consent: [Data Sharing Consent](/design-and-ux/data-sharing-consent-design/), [Geolocation](/design-and-ux/geolocation-design/), [Phone Number Input](/design-and-ux/phone-number-input-design/), [Email Input](/design-and-ux/email-input-design/), [Forms and Data Entry](/design-and-ux/forms-and-data-entry-design/)

Identity verification: [Government Record Verification](/design-and-ux/government-record-verification-design/), [CURP](/design-and-ux/curp-design/), [eKYC](/design-and-ux/ekyc-design/), [eKYB](/design-and-ux/ekyb-design/)

Signatures: [Electronic Signature](/design-and-ux/electronic-signature-design/), [Advanced Signature](/design-and-ux/advanced-signature-design/), [Qualified Signature](/design-and-ux/qualified-signature-design/), [Certificate Issuance](/design-and-ux/certificate-issuance-design/)

Watchlists: [Watchlist and Custom Watchlist](/design-and-ux/watchlist-design/), [Watchlist for Business](/design-and-ux/watchlist-business-design/)

## What each module's pages cover

Each module above is documented across four pages:

**Screens & States.** Every screen the end user encounters during the module flow, including loading states, success states, error states, and permission prompts. Use this to understand what UI your integration will surface and when.

**Customization.** What can be changed and how. Covers configurable colors, typography, copy, button styles, logos, and any module-specific customization hooks exposed through the SDK or Dashboard.

**Specs & Guidelines.** Design specifications and constraints: minimum tap targets, safe areas, contrast requirements, accessibility considerations, and Prizma design system alignment. Use this to validate that your customizations stay within supported limits.

**V1 vs V2 Comparison.** Visual and behavioral differences between the V1 and V2 experiences for modules that support both. Use this when planning a migration or deciding which version to integrate.

---

- Path: `design-and-ux/navigation-bar`
- URL: https://developer.incode.com/design-and-ux/navigation-bar/
- Markdown: https://developer.incode.com/design-and-ux/navigation-bar.md

# Navigation Bar

The Navigation Bar is the persistent header present on every step of a Prizma verification flow. It provides orientation (title), backward navigation (back button), and flow exit (close icon) — always in the same position.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-navbar"><i>‹</i><strong>Verify identity</strong><i>✕</i></span></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-navbar" style="max-width:260px"><i>‹</i><strong>Get started</strong><i>✕</i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Back + close</span><code>.navbar</code><p>The default: back on the left, step title centered, close on the right.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-navbar" style="max-width:260px"><span></span><strong>ID Capture</strong><i>✕</i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Close only</span><code>.navbar--no-back</code><p>First step of a flow — there is nowhere to go back to.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--nav-bar-surface | Bar background | Component
--nav-bar-border | Bottom border color | Component
--nav-bar-title | Title text color | Component
--nav-bar-back-text | Back label color | Component
--nav-bar-icon | Icon color (back, close) | Component
--nav-bar-height | Bar height | Component
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/nfc-customization`
- URL: https://developer.incode.com/design-and-ux/nfc-customization/
- Markdown: https://developer.incode.com/design-and-ux/nfc-customization.md

# Customization

This section outlines the elements you can customize within the NFC Scan module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text and brand colors, and which elements remain fixed to ensure consistency, accessibility, and reliable chip reading across platforms.

<br />

## NFC chip presence

The optional entry screen that asks the user whether the NFC chip symbol is visible on their passport cover. Two actions are presented: "No" routes the user out of the NFC flow, and "Yes" proceeds to the scan tutorial.


<Image src="https://developer.incode.com/assets/b316cc2a6e6eedca0e2bbf688ab1993f.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized      | Notes                                                       |
| -------------------- | --------------------------- | ----------------------------------------------------------- |
| **Text**             | Title, question text        | Fully localizable; tone can be adapted to your brand voice. |
| **Button — No**      | Label, border color, radius | Must remain visually distinct from the primary action.      |
| **Button — Yes**     | Label, color, radius        | Uses primary brand color.                                   |
| **Background Color** | Screen background           | Must maintain strong contrast with text and elements.       |
| **Brand Colors**     | Header text, button accent  | Uses brand tokens.                                          |
| **Footer**           | "Verified by Incode" line   | Optional but recommended for trust and product consistency. |

<br />

### Fixed Elements

| Element                            | Why it is fixed                                                                    |
| ---------------------------------- | ---------------------------------------------------------------------------------- |
| **Yes / No binary choice**         | Required to correctly gate the NFC flow; cannot be collapsed into a single action. |
| **NFC symbol illustration**        | Must remain recognizable to help users identify the chip on their document.        |
| **Component spacing & safe areas** | Required for device compatibility and visual stability.                            |
| **WCAG contrast requirements**     | Mandatory for accessibility and regulatory compliance.                             |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/a7c871deca463a312ea729c8e9e40367.png" align="center" />


| UI Element                  | Token                                                                       | Value   |
| --------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**              | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**              | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**           | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Button — No text**        | Button/Secondary/Text/Default → Text/Accent/Brand → Color/Brand/500         | #006AFF |
| **Button — Yes background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button — Yes text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Brand icon**              | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer icon**             | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer text**             | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Footer background**       | Icon/Neutral/0 Static → Color/Gray/0                                        | #FFFFFF |

<br />

### Design Notes

- The question must be phrased clearly so users without technical knowledge can identify the NFC symbol on their document.
- "Yes" should always be the primary (filled) button to guide the happy path.
- The NFC symbol illustration is a functional reference — do not replace it with a decorative asset.

<br />

***

## Tutorial

The screen that prepares the user before the scan begins. The user is instructed to hold their phone close to the front cover of their passport and taps "Start scanning" to initiate the session.


<Image src="https://developer.incode.com/assets/2d1b838554b71f173b34e84a847eef7e.png" align="center" />


<br />

### Customizable Elements

| Area                        | What can be customized     | Notes                                                       |
| --------------------------- | -------------------------- | ----------------------------------------------------------- |
| **Text**                    | Title, subtitle            | Fully localizable; should remain instructional and concise. |
| **Button — Start scanning** | Label, color, radius       | Uses primary brand color.                                   |
| **Background Color**        | Screen background          | Must maintain contrast with content.                        |
| **Brand Colors**            | Header text, button accent | Uses brand tokens.                                          |
| **Footer**                  | "Verified by Incode" line  | Optional but recommended.                                   |

<br />

### Fixed Elements

| Element                            | Why it is fixed                                                           |
| ---------------------------------- | ------------------------------------------------------------------------- |
| **Passport illustration**          | Must show the correct document positioning to guide the user accurately.  |
| **Single primary CTA**             | The scan can only be initiated by the user; no auto-advance is permitted. |
| **Component spacing & safe areas** | Required for device compatibility and visual stability.                   |
| **WCAG contrast requirements**     | Mandatory for accessibility and regulatory compliance.                    |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/26ff3d2914d2ab42856becdae760fbab.png" align="center" />


| UI Element                             | Token                                                                       | Value   |
| -------------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**                         | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                         | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**                      | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Button — Start scanning background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button — Start scanning text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Brand icon**                         | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer icon**                        | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer text**                        | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |

<br />

### Design Notes

- Keep the instruction brief — the user needs to understand one action: hold the phone against the passport cover.
- Do not add extra steps or supplementary CTAs that could delay the user from starting the scan.

<br />

***

## Scanning

Shown while the module is actively listening for and reading the NFC chip. A progress bar and "Hold still.." message keep the user informed. A bottom sheet displays real-time processing status and a Cancel option.


<Image src="https://developer.incode.com/assets/31bce2f2832b720fe13b1d347b438f80.png" align="center" />


<br />

### Customizable Elements

| Area                      | What can be customized              | Notes                                                        |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------ |
| **Title text**            | Scanning state title ("Scanning..") | Fully localizable.                                           |
| **Subtitle text**         | Supporting instruction              | Should reinforce the hold-still guidance.                    |
| **Progress bar color**    | Active fill color                   | Uses success/brand token; must remain clearly visible.       |
| **Hold still label**      | Bold status label                   | Fully localizable.                                           |
| **Bottom sheet title**    | "Ready to scan"                     | Fully localizable.                                           |
| **Bottom sheet subtitle** | "Processing, don't move your phone" | Fully localizable.                                           |
| **Background Color**      | Screen and bottom sheet background  | Must maintain contrast.                                      |
| **Button — Cancel**       | Label, color, radius                | Should be visually de-emphasized relative to the scan state. |

<br />

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                    |
| ------------------------------ | ------------------------------------------------------------------ |
| **Progress bar behavior**      | Tied to actual chip read progress; cannot be faked or accelerated. |
| **Bottom sheet pattern**       | Standardized scan UX across the SDK.                               |
| **Cancel availability**        | Must always be present to allow safe exit.                         |
| **Spacing & safe areas**       | Required for device consistency.                                   |
| **WCAG contrast requirements** | Mandatory for accessibility and compliance.                        |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/07f26f57f457d2e28c564236faae9b1d.png" align="center" />


| UI Element                  | Token                                      | Value   |
| --------------------------- | ------------------------------------------ | ------- |
| **Background (top area)**   | Surface/Neutral/100 → Color/Gray/100       | #EBECEF |
| **Title text**              | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Subtitle text**           | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |
| **Progress bar track**      | Surface/Neutral/100 → Color/Gray/100       | #EBECEF |
| **Progress bar fill**       | Icon/success → Color/Positive/600          | #189F60 |
| **Hold still label**        | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Bottom sheet background** | Surface/Neutral/0 → Color/Gray/0           | #FFFFFF |
| **Bottom sheet title**      | Text/Body/800 (Primary) → Color/Gray/800   | #262831 |
| **Bottom sheet subtitle**   | Text/Body/500 (Secondary) → Color/Gray/500 | #60667C |

<br />

### Design Notes

- The progress bar is the primary trust signal during the scan — ensure its fill color meets contrast requirements against the background.
- "Hold still.." copy is critical; do not replace with passive messaging that fails to reinforce the physical requirement.
- The Cancel button should be accessible but visually secondary to avoid accidental taps.

<br />

***

## Try again

Shown when a scan attempt fails. The user is given troubleshooting tips via a swipeable carousel and offered two actions: Help (opens Common Issues) and Try again (returns to the scan).


<Image src="https://developer.incode.com/assets/91054154aac2721eef5f3b65efb52876.png" align="center" />


<br />

### Customizable Elements

| Area                    | What can be customized                   | Notes                                              |
| ----------------------- | ---------------------------------------- | -------------------------------------------------- |
| **Title text**          | "Let's try again"                        | Fully localizable; tone should remain encouraging. |
| **Subtitle text**       | Troubleshooting instruction              | Fully localizable.                                 |
| **Carousel indicators** | Active and inactive dot colors           | Active uses brand token.                           |
| **Button — Help**       | Label, border color, radius              | Should be visually secondary.                      |
| **Button — Try again**  | Label, color, radius                     | Uses primary brand color.                          |
| **Background Color**    | Screen background                        | Must maintain contrast.                            |
| **Brand Colors**        | Header text, carousel dot, button accent | Uses brand tokens.                                 |
| **Footer**              | "Verified by Incode" line                | Optional but recommended.                          |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                          |
| ------------------------------ | ------------------------------------------------------------------------ |
| **Retry logic**                | Must route the user back to the active scan session.                     |
| **Help path**                  | Must lead to the Common Issues screen; cannot be removed.                |
| **Passport illustration**      | Must show the same document reference as the tutorial for consistency.   |
| **Carousel content**           | Troubleshooting tips are product-defined; layout must not suppress them. |
| **WCAG contrast requirements** | Mandatory for accessibility and compliance.                              |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/706b1d7b75825bda49927d29acbcc7fb.png" align="center" />


| UI Element                        | Token                                                                       | Value   |
| --------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**                    | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                    | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**                 | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Carousel dot (active)**         | Surface/Brand/500 Static → Color/Brand/500                                  | #006AFF |
| **Carousel dot (inactive)**       | Surface/Neutral/100 → Color/Gray/100                                        | #EBECEF |
| **Button — Help text**            | Button/Secondary/Text/Default → Text/Accent/Brand → Color/Brand/500         | #006AFF |
| **Button — Try again background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button — Try again text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Brand icon**                    | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer icon**                   | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Footer text**                   | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |

### Design Notes

- "Let's try again" framing keeps the tone supportive. Avoid error-heavy language that may cause the user to abandon the flow.
- The carousel is a key UX element — ensure dot indicators are sized and spaced for easy touch interaction.

<br />

***

## Common Issues

Shown when the user taps "Help" from the Try Again screen. A list of the most frequent reasons a scan fails is displayed, with a single "Ok, try again" CTA to return the user to the scan flow.


<Image src="https://developer.incode.com/assets/b44d0d86e1807cf0e7412459824d77d1.png" align="center" />


<br />

### Customizable Elements

| Area                       | What can be customized  | Notes                                                           |
| -------------------------- | ----------------------- | --------------------------------------------------------------- |
| **Title text**             | "Common issues"         | Fully localizable.                                              |
| **Issue list text**        | Individual issue labels | Fully localizable; keep each item short and scannable.          |
| **Issue icons**            | Per-row icons           | Can be replaced; must remain clearly associated with the issue. |
| **Button — Ok, try again** | Label, color, radius    | Uses primary brand color.                                       |
| **Background Color**       | Screen background       | Must maintain contrast.                                         |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                         |
| ------------------------------ | ----------------------------------------------------------------------- |
| **Issue list content**         | Product-defined based on the most common real-world failure causes.     |
| **Single CTA**                 | Must route back to the scan; no secondary exit should be provided here. |
| **List structure**             | Icon + label pattern required for scannability and accessibility.       |
| **WCAG contrast requirements** | Mandatory for accessibility and compliance.                             |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/8b6e1637f48f7f00d3f48b15b611b0f4.png" align="center" />


| UI Element                            | Token                                                                       | Value   |
| ------------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Background**                        | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Title text**                        | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Issue row background**              | Surface/Neutral/0 → Color/Gray/0                                            | #FFFFFF |
| **Issue row separator**               | Surface/Neutral/500 → Color/Gray/500                                        | #60667C |
| **Issue icon**                        | Surface/Neutral/500 → Color/Gray/500                                        | #60667C |
| **Issue label text**                  | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Button — Ok, try again background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button — Ok, try again text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |

<br />

### Design Notes

- Issue labels should be plain language, not technical error codes.
- Each row should be immediately scannable — users should be able to identify their problem within 2–3 seconds.
- Avoid adding a back button or secondary CTA that could increase drop-off.

<br />

<br />

***

## Verifying Identity

Shown after a successful chip read while the system processes and verifies the extracted data. A loading spinner and status message keep the user informed.


<Image src="https://developer.incode.com/assets/d155d28bdcc9dce58e91140b3a72f8a1.png" align="center" />


<br />

### Customizable Elements

| Area                         | What can be customized          | Notes                                                  |
| ---------------------------- | ------------------------------- | ------------------------------------------------------ |
| **Title text**               | "Hold on a sec.."               | Fully localizable; should remain short and reassuring. |
| **Subtitle text**            | "We're verifying your identity" | Fully localizable.                                     |
| **Spinner accent color**     | Primary spinner stroke          | Uses brand token; must remain visually clear.          |
| **Spinner background color** | Secondary spinner stroke        | Should maintain contrast with accent.                  |
| **Background Color**         | Screen background               | Must preserve readability and contrast.                |

<br />

### Fixed Elements

| Element                     | Why it is fixed                                                 |
| --------------------------- | --------------------------------------------------------------- |
| **Processing flow timing**  | Linked to backend verification; cannot be shortened or skipped. |
| **Spinner animation style** | Standardized across SDK for performance and recognizability.    |
| **Spacing & safe areas**    | Required for device consistency.                                |
| **Minimum contrast**        | Required for accessibility and compliance.                      |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/c1a02e911cef17587cf983efde8f9e9a.png" align="center" />


| UI Element             | Token                                                                | Value   |
| ---------------------- | -------------------------------------------------------------------- | ------- |
| **Background**         | Surface/Neutral/0 → Color/Gray/0                                     | #FFFFFF |
| **Spinner background** | Spinner/Surface/Secondary → Surface/Brand/50 → Color/Brand/50        | #E5F0FF |
| **Spinner accent**     | Spinner/Surface/Primary → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Title text**         | Spinner/Text/Title → Text/Body/800 (Primary) → Color/Gray/800        | #262831 |
| **Subtitle text**      | Spinner/Text/Subtitle → Text/Body/500 (Secondary) → Color/Gray/500   | #60667C |

<br />

### Design Notes

- Keep copy short to minimize cognitive load during the wait.
- Use the subtitle to set clear expectations about what is happening in the background.
- Avoid adding buttons or interactive elements during this state.

<br />

<br />

<br />

<br />

***

## Identity Verified

Shown when the identity has been successfully verified following the NFC scan. The user receives a clear visual confirmation with a green checkmark before the flow advances to the next step.


<Image src="https://developer.incode.com/assets/b44d0d86e1807cf0e7412459824d77d1.png" align="center" />


<br />

### Customizable Elements

| Area                   | What can be customized           | Notes                                                      |
| ---------------------- | -------------------------------- | ---------------------------------------------------------- |
| **Confirmation text**  | "Identity successfully verified" | Fully localizable; tone should be positive and conclusive. |
| **Success icon color** | Green checkmark background       | Uses positive/success token.                               |
| **Background Color**   | Screen background                | Must maintain contrast with content.                       |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                                 |
| ------------------------------ | --------------------------------------------------------------- |
| **Auto-advance behavior**      | Screen advances automatically; no CTA is required or permitted. |
| **Success icon shape**         | Standardized across the SDK for visual consistency.             |
| **Status color mapping**       | Green = positive; required for consistent semantics.            |
| **WCAG contrast requirements** | Mandatory for accessibility and compliance.                     |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/8b6e1637f48f7f00d3f48b15b611b0f4.png" align="center" />


| UI Element                  | Token                                     | Value   |
| --------------------------- | ----------------------------------------- | ------- |
| **Background**              | Surface/Neutral/0 → Color/Gray/0          | #FFFFFF |
| **Success icon background** | Icon/Status/Positive → Color/Positive/500 | #189F60 |
| **Success icon checkmark**  | Icon/Neutral/0 Static → Color/Gray/0      | #FFFFFF |
| **Confirmation text**       | Text/Body/800 (Primary) → Color/Gray/800  | #262831 |

### Design Notes

- This screen is intentionally minimal — the confirmation message and icon are the only elements needed.
- Do not add additional copy, CTAs, or decorative elements that could distract from the success state.
- The green icon must remain high-contrast against the white background.

<br />

---

- Path: `design-and-ux/nfc-design`
- URL: https://developer.incode.com/design-and-ux/nfc-design/
- Markdown: https://developer.incode.com/design-and-ux/nfc-design.md

# NFC

NFC Scan allows users to verify their identity by reading the embedded chip in their NFC-enabled passport or identity document. It extracts cryptographically secured identity data directly from the document chip, providing a higher assurance level than optical capture alone.

NFC Scan typically occurs after the document has been captured via OCR and before the final verification result is returned.

![](https://developer.incode.com/assets/52aee9692f1eab621e42d14b8038e3ec.gif)

<br />

***

## Where it fits in the flow

NFC Scan appears after the initial document capture step, once the system has confirmed the document is NFC-capable. It reads the chip data to cross-validate the information extracted during OCR and strengthen the overall verification result.

Once the user successfully completes the NFC scan, the flow continues to identity confirmation and any downstream verification logic required by the application.

***

## User Flow

The NFC Scan experience moves through several clear stages that guide the user from chip detection to successful read. An optional NFC chip presence screen first confirms whether the user's document supports NFC. The user is then introduced to the process through a tutorial screen explaining how to position their phone. Once the scan begins, the module reads the chip and provides real-time feedback. The user receives a success state or an error message with options to retry before continuing to the next step.

<br />


<Image src="https://developer.incode.com/assets/bd33c264a8485b4785e9ab67f4b8eaa2.png" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in NFC Scan, from the optional chip presence check and tutorial, to the active scan, success confirmation, and error handling paths including retry logic.


<Image src="https://developer.incode.com/assets/4fb6949e38ae8310dd21257f8ae52cb0.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the NFC chip is detected and read successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user confirms their document supports NFC, positions their phone as instructed, and the system successfully reads the chip data without requiring retries or corrections. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/2373dd4acf639a5b530966a58bfeb8d7.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/a66791895b88bd8da28291e55db67996.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Upload Digital ID** experience.

**✅ Do**

- Clearly instruct users to hold their phone steady against the front cover of the document throughout the scan
- Show real-time progress feedback so users know the scan is actively running.
- Provide clear error messages with actionable next steps when the chip read fails.
- Always offer a retry option so users can reattempt without restarting the full flow.

**❌ Don’t**

- Don't proceed with the NFC step if the document has not been confirmed as NFC-capable.
- Don't proceed with the NFC step if the document has not been confirmed as NFC-capable.
- Don't skip or reduce essential error states, including timeout and authentication failure screens.
- Don't remove the "hold still" guidance during active scanning, as movement is the most common cause of scan failure.

<br />

<br />

<br />

---

- Path: `design-and-ux/nfc-screens-states`
- URL: https://developer.incode.com/design-and-ux/nfc-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/nfc-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the **NFC Scan** experience. Each state includes a brief description and a direct link to its source in Figma.

***

## NFC Chip presence

The optional entry screen shown before the NFC scan begins. The user is asked whether the NFC chip symbol is visible on their passport cover. Selecting "Yes" moves them to the tutorial and scan flow. Selecting "No" routes them out of the NFC flow.


<Image src="https://developer.incode.com/assets/7484e702d7023aba931925e8970f4c95.png" align="center" />


<br />

## Tutorial

The introduction screen that prepares the user to begin the NFC scan. The user is instructed to hold their phone close to the front cover of their passport. Tapping "Start scanning" initiates the scan session.


<Image src="https://developer.incode.com/assets/4ec947bbf92ad99c84b3741da612fb52.png" align="center" />


<br />

## Ready to scan

Shown once the scan session has started and the module is listening for the NFC chip. A bottom sheet appears with positioning guidance, prompting the user to hold the phone steady. A Cancel button is available if the user needs to exit the scan.


<Image src="https://developer.incode.com/assets/fa3ef3cf19e5b0c0fef658f2b1ff94b9.png" align="center" />


<br />

## Scanning

Shown while the module is actively reading the chip. A progress bar and "Hold still.." message keep the user informed. The bottom sheet updates to indicate that processing is in progress and the phone must not be moved.


<Image src="https://developer.incode.com/assets/5630c4b50fdacabeeb3a6a753c75dcc0.png" align="center" />


<br />

## Successfully scanned

Shown when the chip has been read and the data is being finalized. The progress bar completes and the bottom sheet updates to confirm the scan was successful. The user is prompted to continue holding still until reading is finished.


<Image src="https://developer.incode.com/assets/f5e6b2f15a27473226ba571906ce47f9.png" align="center" />


<br />

## Identity verified

Shown when the identity has been successfully verified following the NFC scan. The user receives a clear visual confirmation with a green checkmark before the flow advances to the next step.


<Image src="https://developer.incode.com/assets/f1857ead8a13cebb75e370e998bf116a.png" align="center" />


<br />

## Try again

Shown when the first scan attempt fails. The user is prompted to remove their passport from any folder or cover, then hold the phone close to the front cover again. A swipeable tip carousel provides additional guidance. Two actions are available: Help and Try again.


<Image src="https://developer.incode.com/assets/55bb81be04afaabce1ecc0101dfbb02b.png" align="center" />


<br />

## Common issues

Shown when the user taps "Help" from the Try Again screen. A list of the most frequent reasons a scan fails is displayed, including the passport being in a cover, the phone being too far from the document, the chip being on a different page, movement during scanning, and interference from a phone case. A single "Ok, try again" button returns the user to the scan flow.


<Image src="https://developer.incode.com/assets/ea0adbe6702a842c67b1d7320c0cc677.png" align="center" />


<br />

## Unable to authenticate

Shown when the chip cannot be authenticated after all retry attempts are exhausted. The user is informed that the document chip could not be verified and is presented with a Continue button to proceed with the flow despite the failed NFC read.


<Image src="https://developer.incode.com/assets/48ca80cc6cab86c5810f26645fd56776.png" align="center" />


<br />

---

- Path: `design-and-ux/nfc-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/nfc-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/nfc-specs-guidelines.md

# Specs & Guidelines

The **NFC Scan** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/fbbc49c23f3896335e558da87834dea6.png" align="center" />


<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **NFC Scan** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/51de8e3115fe6040d96cde1ca58f6186.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                         | Behavior                                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; passport illustration scales down to maintain visibility. |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent.                              |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and illustration remain pinned to the top.      |
| **Foldables (e.g., Pixel Fold)**   | Larger illustration and more balanced white space; content remains centered.             |
| **Tablets**                        | Increased layout margins; illustration and bottom sheet scale proportionally.            |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding applied.         |

<br />

### What is responsive (and customizable)

| Element               | Responsive Behavior                                  | Customizable                   |
| --------------------- | ---------------------------------------------------- | ------------------------------ |
| Passport illustration | Scales proportionally by viewport height             | No                             |
| Title text            | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Progress bar          | Width adjusts to container width                     | Color                          |
| Bottom sheet          | Height adapts to content; anchored to bottom         | Limited (background color)     |
| Buttons               | Width adjusts to container; vertical spacing adapts  | Color & text                   |
| Footer / watermark    | Pinned to bottom safe area                           | Optional                       |
| Background surfaces   | Expand to full viewport                              | Yes                            |
| Header area           | Scales padding according to device safe insets       | Limited (color only)           |
| Icons                 | Remain centered and maintain distance to the title   | Color & style                  |

<br />

### What remains fixed across breakpoints

| Element                    | Reason                                               |
| -------------------------- | ---------------------------------------------------- |
| NFC chip reading logic     | Must remain consistent for reliable chip detection.  |
| Progress bar behavior      | Tied to actual scan progress; cannot be visual only. |
| Cancel button availability | Must always be reachable regardless of screen size.  |
| Minimum text size          | Required for readability & WCAG compliance.          |
| Minimum tap target sizes   | Ensures accessibility on mobile.                     |
| Overall hierarchy          | Prevents cognitive load at different sizes.          |

<br />

### Design Notes

- The passport illustration always remains the dominant visual element, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- The bottom sheet anchors to the bottom of the viewport — avoid adding custom UI that may overlap with it.
- Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Prototype & Transitions

**NFC Scan** includes predefined transition rules and micro-interactions that ensure a smooth user experience across all states — from the chip presence check and tutorial, through the active scan and progress feedback, to success and error outcomes. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/3f6a64b7bf5330f331c5c2e55e0d76ea.gif" align="center" />


<br />

<br />

***

## Localization

The **NFC** Scan module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/560c6a53a0e84f8b06f59ca7e62d6890.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable, including scan instructions, status messages, error labels, and button labels.
- UI adjusts to prevent truncation and maintain readability across all screen states.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Buttons and CTAs automatically expand to fit translated labels.
- The bottom sheet title and subtitle are independently localizable to allow precise control over tone per region.Ensure localized strings for scan instructions preserve clarity — ambiguous phrasing can cause users to move the phone and fail the scan.
- Incode supports a variety of languages.

<br />

---

- Path: `design-and-ux/nfc-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/nfc-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/nfc-v1-vs-v2-comparison.md

# NFC V1 vs V2 Comparison

In V1, NFC Scan offers a basic chip reading experience with minimal user guidance, no dedicated intro screen with the Incode header, limited scan state feedback, and restricted customization options. The scanning flow runs with a simple bottom sheet and generic status labels.

In V2, NFC Scan delivers a significantly improved experience with a dedicated tutorial screen, an NFC chip presence check, a cleaner bottom sheet design with bolder typography, real-time progress feedback through a green progress bar, structured error handling with a retry carousel, and full alignment with the token-based design system — resulting in a clearer, more guided, and more brandable flow.


<Image src="https://developer.incode.com/assets/080d5df1c47e3333ab5cdc929ec85f66.png" align="center" caption="V1 is a basic NFC scanning experience with a simple bottom sheet, limited guidance, and no tokenized customization." />


<br />


<Image src="https://developer.incode.com/assets/2491e12649ca41a762f5632dd9daf944.png" align="center" caption="V2 delivers a refined scanning experience with a dedicated tutorial, real-time progress feedback, structured error states, and full token-based customization." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                     |
| -------------------------- | -- | -- | --------------------------------------------------------------------------------------------------------- |
| NFC chip scanning          | ✅  | ✅  | Both versions read and extract data from NFC-enabled passport chips.                                      |
| NFC chip presence check    | ❌  | ✅  | V2 includes an optional screen to confirm the document supports NFC before initiating the scan.           |
| Retry flow                 | ✅  | ✅  | Both versions allow the user to retry after a failed scan attempt.                                        |
| Common issues screen       | ❌  | ✅  | V2 includes a dedicated help screen listing the most frequent causes of scan failure.                     |
| Error states               | ✅  | ✅  | Both versions handle general error cases the user may encounter.                                          |
| Dark mode support          | ✅  | ✅  | Both versions support dark and light display modes.                                                       |
| Customization options      | ❌  | ✅  | V1 provides limited customization, while V2 allows full control over text, colors, buttons, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior             | V1                                                                                                  | V2                                                                                                                        | Notes                                                                                                                 |
| -------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Tutorial behavior    | Basic intro screen with a tilted passport illustration and back/close navigation                    | Dedicated intro screen with an upright passport illustration, Incode header, and a single "Start scanning" CTA            | V2 is more focused and directs the user's attention toward the scanning instructions with a cleaner visual hierarchy. |
| Scan state feedback  | Simple bottom sheet with "Ready to scan" and "Hold still.." labels and a dot-row progress indicator | Bottom sheet with bold "Ready to scan" heading, descriptive subtitle, and a green linear progress bar at the top          | V2 actively communicates scanning progress so users understand what the module is doing at each moment.               |
| Success confirmation | "Document chip scan success" with a green checkmark                                                 | "Identity successfully verified" with a green checkmark badge                                                             | V2 language reflects the full verification outcome rather than just the chip read result.                             |
| Error handling       | Generic error screen                                                                                | Structured "Let's try again" screen with a swipeable tip carousel, Help CTA linking to Common Issues, and a Try again CTA | V2 gives users specific, actionable guidance on what went wrong and how to fix it.                                    |
| Navigation controls  | Back arrow and X close button in the header                                                         | No navigation chrome; Incode header only                                                                                  | V2 removes distracting navigation elements to keep the user focused on completing the scan.                           |
| State transitions    | Default transitions                                                                                 | Specifically designed screen-by-screen transitions for smoothness                                                         | V2 includes transition guidelines as part of the module documentation package.                                        |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/15cd8b89fd3df25e1f8afd453456021f.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across all NFC Scan screens
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 centralizes all customization options under a single structure, so developers always know where to look and what they can modify. This includes button styles, progress bar color, bottom sheet typography, instructional text, error message styling, and the "Verified by Incode" footer — making it straightforward to align the module with your brand without affecting core chip reading and verification logic.

<br />

<br />

---

- Path: `design-and-ux/ocr-review-design`
- URL: https://developer.incode.com/design-and-ux/ocr-review-design/
- Markdown: https://developer.incode.com/design-and-ux/ocr-review-design.md

# OCR Review

The **OCR** **Review** module presents the information automatically extracted from the identity document using OCR. Relevant fields detected on the document—such as full name, date of birth, gender, document number, and expiration date—are pre-filled for the user to review and confirm. This step helps ensure the extracted data is accurate before continuing the verification or onboarding process.


<Image src="https://developer.incode.com/assets/d415c41fbf39563c01bc2673b6de9be8.gif" align="center" />


***

## Where it fits in the flow

The \*\*OCR Review\*\* module is typically performed immediately after the ID Capture step and before identity verification is finalized. During this stage, the information extracted from the identity document using Optical Character Recognition (OCR) is presented to the user for review and confirmation. This helps ensure the captured data is accurate and complete before continuing the onboarding or verification process.

<br />

***

## User Flow

The **OCR Review** experience follows a four-step flow that begins immediately after the ID Capture step. First, the user captures their identity document. The system then processes the document and extracts the relevant information using Optical Character Recognition (OCR). Next, the extracted data is presented to the user for review and confirmation. Finally, once the information is verified, the user can continue the onboarding or identity verification process.


<Image src="https://developer.incode.com/assets/ff3e584f503ee6517da0202e01077a18.png" align="center" />


<br />

***

## Full Flow Map


<Image src="https://developer.incode.com/assets/51e315a7198453ba8ace609f0e60a8f0.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the information from the identity document is successfully extracted and displayed without errors or interruptions.

The happy path represents the smoothest version of the OCR Review experience: the user captures their identity document, the system automatically extracts relevant information using Optical Character Recognition (OCR), and the extracted fields are presented for review and confirmation before continuing the verification process.

The experience follows a simple three-step flow: the ID capture step, the OCR processing and extraction state, and the review and confirmation of the extracted information.


<Image src="https://developer.incode.com/assets/b67294a3c7de656dbd138a0c9ca39c41.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/0919a8a132cb0aa471ef2769c2455ee0.png" align="center" caption="Dark mode" />


<br />

<br />

## Best Practices

Recommended guidelines for designing and implementing the **OCR Review** experience.

✅ Do

- Clearly display the extracted information so users can quickly review and confirm the data captured from the identity document.&#x20;
- Highlight editable fields and allow users to correct any inaccurate or incomplete information before continuing.&#x20;
- Provide clear progress indicators between the ID Capture, OCR processing, and review steps to maintain transparency during the verification flow.

❌ Don't

- Don’t continue the verification process without giving users the opportunity to review the extracted information.
- Don’t present incomplete, poorly formatted, or low-confidence OCR results without prompting the user to retry or recapture the document.

<br />

---

- Path: `design-and-ux/phone-input-customization`
- URL: https://developer.incode.com/design-and-ux/phone-input-customization/
- Markdown: https://developer.incode.com/design-and-ux/phone-input-customization.md

# Customization

This section outlines the elements you can customize within the **Phone Number Input** module to match your brand while preserving Incode’s core UX. It clarifies which areas are flexible, such as text, and brand colors and which elements remain fixed to ensure consistency, accessibility, and optimal capture performance across platforms.

<br />

## Empty Form Screen

This screen represents the initial state of the Phone Number Input flow. The user is prompted to enter their phone number and country code. At this stage, no input is provided, and the Continue button is disabled.

<Image align="center" src="https://developer.incode.com/assets/107060513f67a2c1bcc57b0358f61c2e.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**             | **Notes**                                         |
| :--------------- | :------------------------------------- | :------------------------------------------------ |
| **Text**         | Title, subtitle, button label          | Fully localizable; tone can be adapted            |
| **Input Field**  | Border, background, placeholder color  | Must follow contrast and accessibility guidelines |
| **Brand Colors** | Header, buttons, and accent elements   | Uses Incode token structure for consistency       |
| **Buttons**      | Label, color states (enabled/disabled) | Must meet WCAG contrast ratio                     |

<br />

### Fixed Elements

| **Element**                       | **Why it is fixed**                              |
| :-------------------------------- | :----------------------------------------------- |
| Layout structure                  | Ensures alignment across onboarding modules      |
| Input field shape and proportions | Must remain consistent with other form modules   |
| Spacing & safe areas              | Optimized for readability and touch ergonomics   |
| Font hierarchy                    | Maintains visual clarity across all device sizes |
| Close icon position               | Standardized for user familiarity                |
| WCAG minimum contrast             | Mandatory for accessibility compliance           |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/2f64d540bb88164b81dd99bd41f36b08.png" />

| **UI Element**               | **Token**                         | **Raw Value** |
| :--------------------------- | :-------------------------------- | :------------ |
| Title text                   | `text-body-primary`               | `#262831`     |
| Subtitle text                | `text-body-secondary`             | `#60667C`     |
| Input placeholder            | `input-text-field-placeholder`    | `#A3A8B8`     |
| Input border                 | `input-border-default`            | `#EBECEF`     |
| Input surface                | `input-surface-default`           | `#FCFCFD`     |
| Dropdown text                | `dropdown-text-input-default`     | `#262831`     |
| Dropdown border              | `dropdown-border-default`         | `#EBECEF`     |
| Button background (disabled) | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)       | `button-primary-text-disabled`    | `#A3A8B8`     |

<br />

### Design Notes

* If customizing text, ensure clarity and brevity (e.g., “Enter your number” instead of “Please provide your mobile phone”).
* When adjusting button color, maintain strong contrast for accessibility.

<br />

***

## Form Filling Screen (Focused State)

This screen represents the focused input state of the Phone Number Input module.

When the user begins typing, the input field becomes highlighted with the focused border color, and the Continue button activates once the phone number is valid. This state communicates interaction and readiness to proceed.

<Image align="center" src="https://developer.incode.com/assets/7fb142f81520b9aa168e53a63449a7bd.png" />

<br />

### Customizable Elements

| **Area**                    | **What can be customized**              | **Notes**                                         |
| :-------------------------- | :-------------------------------------- | :------------------------------------------------ |
| **Text**                    | Title, subtitle, button label           | Fully localizable; tone can be adapted            |
| **Input Field (Focused)**   | Border color, surface, placeholder text | Must meet accessibility and contrast requirements |
| **Dropdown (Country Code)** | Icon, border, and surface colors        | Uses shared input styles and tokens               |
| **Brand Colors**            | Button and active states                | Derived from brand token system                   |
| **Buttons**                 | Label, enabled/disabled colors          | Must align with WCAG standards                    |

<br />

### Fixed Elements

| **Element**                  | **Why it is fixed**                                |
| :--------------------------- | :------------------------------------------------- |
| Layout structure             | Maintains alignment and consistency across modules |
| Input shape and field height | Standardized for usability and accessibility       |
| Spacing & padding            | Optimized for touch and visual rhythm              |
| Typography hierarchy         | Ensures consistent information hierarchy           |
| Button dimensions            | Fixed to meet platform accessibility requirements  |
| WCAG minimum contrast        | Required for certification and compliance          |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/409906fb2a1efda3ed503e67fe2b56fe.png" />

| **UI Element**              | **Token**                        | **Raw Value** |
| :-------------------------- | :------------------------------- | :------------ |
| Title text                  | `text-body-primary`              | `#262831`     |
| Subtitle text               | `text-body-secondary`            | `#60667C`     |
| Input border (focused)      | `input-border-focused`           | `#006AFF`     |
| Input text                  | `input-text-field-default`       | `#262831`     |
| Input surface (focused)     | `input-surface-focused`          | `#FCFCFD`     |
| Dropdown text               | `dropdown-text-input-default`    | `#262831`     |
| Dropdown border             | `dropdown-border-default`        | `#EBECEF`     |
| Button background (enabled) | `button-primary-surface-default` | `#006AFF`     |
| Button text (enabled)       | `button-primary-text-default`    | `#FFFFFF`     |
| Background surface          | `surface-neutral-0`              | `#FFFFFF`     |

<br />

### Design Notes

* You can adjust the focus color to match your brand, but ensure it remains visually distinct from error states.
* If modifying typography, preserve visual differences between title, subtitle, and input to maintain clarity.
* Always test your custom color scheme in light and dark modes for accessibility consistency.

<br />

***

## OTP Entry Screen (Focused State)

This screen appears after the user enters their phone number and the system sends a one-time passcode (OTP) via SMS.

The user is prompted to enter the code in a series of clearly separated fields. As the input fields gain focus, the borders and surfaces adapt to indicate active interaction. A countdown below the button communicates when the user can resend the code.

<Image align="center" src="https://developer.incode.com/assets/9266f28ac863bff5b229b0c39872a0a1.png" />

<br />

### Customizable Elements

| **Area**             | **What can be customized**             | **Notes**                                                      |
| :------------------- | :------------------------------------- | :------------------------------------------------------------- |
| **Text**             | Title, helper text, countdown label    | Fully localizable; supports dynamic values (e.g., countdown)   |
| **OTP Fields**       | Border and text color in focused state | Must maintain accessibility contrast and clarity               |
| **Buttons**          | Label, color states (disabled/enabled) | Must meet WCAG 2.1 contrast requirements                       |
| **Resend Code Text** | Color, hover/press state               | Uses tertiary text token, consistent with interaction patterns |
| **Brand Colors**     | Primary accent and focus color         | Derived from `brand-500` and related tokens                    |

<br />

### Fixed Elements

| **Element**           | **Why it is fixed**                                   |
| :-------------------- | :---------------------------------------------------- |
| Input field layout    | Ensures consistency across all OTP verification steps |
| Field spacing         | Optimized for readability and tap accuracy            |
| Countdown behavior    | Fixed duration to standardize retry experience        |
| Button placement      | Standard alignment for visual rhythm and reachability |
| Typography hierarchy  | Maintains cross-platform readability                  |
| WCAG minimum contrast | Required for accessibility certification              |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/762c16a960cbcf242b172d4b951f7570.png" />

| **UI Element**               | **Token**                         | **Raw Value** |
| :--------------------------- | :-------------------------------- | :------------ |
| Title text                   | `text-body-primary`               | `#262831`     |
| OTP input border (focused)   | `input-border-focused`            | `#006AFF`     |
| OTP input text               | `input-text-field-default`        | `#262831`     |
| OTP input surface (focused)  | `input-surface-focused`           | `#FCFCFD`     |
| Button background (disabled) | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)       | `button-primary-text-disabled`    | `#A3A8B8`     |
| Resend code text             | `button-tertiary-text-disabled`   | `#60667C`     |
| Countdown timer text         | `text-body-secondary`             | `#60667C`     |
| Background surface           | `surface-neutral-0`               | `#FFFFFF`     |

<br />

### Design Notes

* You can adjust the focus color to match your brand, but ensure it remains visually distinct from error states.
* If modifying typography, preserve visual differences between title, subtitle, and input to maintain clarity.
* Always test your custom color scheme in light and dark modes for accessibility consistency.

<br />

***

## OTP Checking (Verification Loading) Screen

This screen represents the verification state of the Phone Number Input module. After the user submits the one-time passcode (OTP), the system verifies the input. The interface locks input field and transitions the button to a loading spinner, indicating that validation is in progress.
During this state, interaction is temporarily disabled until the verification completes.

<Image align="center" src="https://developer.incode.com/assets/7f6044f25357a565dbf49423ece0666a.png" />

<br />

### Customizable Elements

| **Area**                        | **What can be customized**          | **Notes**                                           |
| :------------------------------ | :---------------------------------- | :-------------------------------------------------- |
| **Text**                        | Title and helper text               | Fully localizable; tone can be adapted              |
| **OTP Fields (Disabled)**       | Border, background, and text color  | Should visually indicate a non-editable state       |
| **Buttons**                     | Spinner color, background, and text | Spinner inherits brand color for visual consistency |
| **Resend / Change Number Text** | Color and link state                | Uses tertiary text token                            |
| **Brand Colors**                | Button and header accents           | Derived from `brand-500` and `brand-400` tokens     |

<br />

### Fixed Elements

| **Element**              | **Why it is fixed**                                        |
| :----------------------- | :--------------------------------------------------------- |
| Layout structure         | Ensures consistency across all verification states         |
| Button position          | Aligned for accessibility and predictable interaction flow |
| Input layout and spacing | Maintains readability during transition states             |
| Loading spinner size     | Standardized for cross-platform consistency                |
| Typography hierarchy     | Maintains readability and balance                          |
| WCAG minimum contrast    | Ensures accessible visual design                           |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/c972fd1ba19d1a76ef0f8e6ac9224c98.png" />

| **UI Element**                      | **Token**                        | **Raw Value** |
| :---------------------------------- | :------------------------------- | :------------ |
| Title text                          | `text-body-primary`              | `#262831`     |
| OTP input text (disabled)           | `input-text-field-disabled`      | `#A3A8B8`     |
| OTP input border (disabled)         | `input-border-disabled`          | `#EBECEF`     |
| OTP input surface (disabled)        | `input-surface-disabled`         | `#EBECEF`     |
| Button background (default/loading) | `button-primary-surface-default` | `#006AFF`     |
| Button text (default/loading)       | `button-primary-text-default`    | `#FFFFFF`     |
| Spinner accent                      | `surface-brand-400-static`       | `#3388FF`     |
| Resend/change number text           | `button-tertiary-text-disabled`  | `#60667C`     |

<br />

### Design Notes

* Avoid introducing additional text or loaders elsewhere on the screen.
* If modifying color schemes, ensure that disabled input states remain visibly distinct.

<br />

***

## Success Screen

This screen appears after the user’s phone number has been successfully verified.
It provides a clear confirmation of success before the flow transitions to the next module or completion step.
The layout is intentionally minimal to maintain focus on the success feedback.

<Image align="center" src="https://developer.incode.com/assets/322cabd7f0f7d1c8a700a425670a0f0a.png" />

<br />

### Customizable Elements

| **Area**         | **What can be customized**  | **Notes**                               |
| :--------------- | :-------------------------- | :-------------------------------------- |
| **Text**         | Confirmation message        | Fully localizable; tone can be adapted  |
| **Success Icon** | Color and animation         | Must use approved positive color tokens |
| **Brand Colors** | Header and accent           | Based on `brand-500` values             |
| **Background**   | Color and safe area padding | Must preserve contrast and clarity      |

<br />

### Fixed Elements

| **Element**            | **Why it is fixed**                                     |
| :--------------------- | :------------------------------------------------------ |
| Layout structure       | Ensures consistent feedback presentation across modules |
| Icon size and position | Optimized for recognition and accessibility             |
| Text alignment         | Central alignment for visual balance                    |
| Typography hierarchy   | Maintains brand consistency and readability             |
| WCAG minimum contrast  | Required for accessibility compliance                   |

<br />

### Token Reference

<Image align="center" src="https://developer.incode.com/assets/444aadf700d931ed5fd51ec673333602.png" />

| **UI Element**     | **Token**              | **Raw Value** |
| :----------------- | :--------------------- | :------------ |
| Title text         | `text-body-primary`    | `#262831`     |
| Success icon       | `icon-status-positive` | `#189F60`     |
| Background surface | `surface-neutral-0`    | `#FFFFFF`     |

<br />

### Design Notes

* Keep the confirmation text short and positive; don’t include instructions or next steps here.
* If using customized colors, ensure they don’t reduce the contrast of the success message or icon.

<br />

***

## OTP Error Screen

This screen appears when the user enters an incorrect or expired code.
It provides immediate visual feedback through red highlight states and an error message.
The interface allows the user to resend the code or change their phone number before attempting verification again.

<Image align="center" src="https://developer.incode.com/assets/c721a196b0566e57594329c9cfc6df78.png" />



### Customizable Elements

| **Area**                          | **What can be customized**     | **Notes**                                             |
| :-------------------------------- | :----------------------------- | :---------------------------------------------------- |
| **Text**                          | Error message and helper text  | Fully localizable; keep concise and polite tone       |
| **Input Fields (Error)**          | Border, background, text color | Must maintain strong color contrast for accessibility |
| **Error Icon**                    | Color                          | Uses negative (error) status color token              |
| **Buttons**                       | Label, color state             | Maintain clear disabled and active visual distinction |
| **Links (Resend / Change Email)** | Color and hover states         | Use brand accent color for recognition                |
| **Brand Colors**                  | Header and accents             | Should align with existing brand color tokens         |



### Fixed Elements

| **Element**                   | **Why it is fixed**                           |
| :---------------------------- | :-------------------------------------------- |
| Layout structure              | Maintains consistency across OTP states       |
| Input field shape and spacing | Optimized for error visibility                |
| Button placement              | Standardized for user familiarity             |
| Typography hierarchy          | Preserves consistent hierarchy and legibility |
| Error message position        | Fixed to align directly below input fields    |
| WCAG minimum contrast         | Required for accessibility compliance         |



### Token Reference

<Image align="center" src="https://developer.incode.com/assets/a85d859785ab9bfc597b83c8cf15056b.png" />

| **UI Element**                | **Token**                         | **Raw Value** |
| :---------------------------- | :-------------------------------- | :------------ |
| Title text                    | `text-body-primary`               | `#262831`     |
| Error border                  | `input-border-negative`           | `#E71111`     |
| Error surface                 | `input-surface-negative`          | `#EBECEF`     |
| Error text                    | `input-text-helper-negative`      | `#E71111`     |
| Error icon                    | `input-icon-negative`             | `#E71111`     |
| Input text (default)          | `input-text-field-default`        | `#262831`     |
| Button background (disabled)  | `button-primary-surface-disabled` | `#EBECEF`     |
| Button text (disabled)        | `button-primary-text-disabled`    | `#A3A8B8`     |
| Links (Resend / Change Email) | `button-tertiary-text-default`    | `#006AFF`     |
| Background surface            | `surface-neutral-0`               | `#FFFFFF`     |



### Design Notes

* Error messaging should remain concise — don’t overload users with explanations.
* Avoid replacing the red border with icons alone; border color communicates immediacy effectively.

---

- Path: `design-and-ux/phone-input-screens-states`
- URL: https://developer.incode.com/design-and-ux/phone-input-screens-states/
- Markdown: https://developer.incode.com/design-and-ux/phone-input-screens-states.md

# Screens & States

A complete view of all screens the user may encounter during the **Phone Number Input** experience. Each state includes a brief description.

***

## Enter Phone Number

This screen prompts the user to input their phone number for verification. It’s the initial state of the Phone Number Input step, featuring a country code selector, number input field, and a disabled Continue button until a valid format is detected.

Country Code selection appears when the user interacts with the country code dropdown. It allows selection from a list of international codes, ensuring compatibility with global users.

<Image align="center" src="https://developer.incode.com/assets/938a5b0ce45945832dc09fbf546dc385.png" />

<br />

<br />

## Enter Code (OTP Input)

Displayed after the user submits a valid phone number. The system sends an SMS with a one-time code, and this screen prompts the user to enter it. A countdown timer indicates when the “Resend code” option becomes available.

<Image align="center" src="https://developer.incode.com/assets/0a3c35ba4e6e56399936a7521c2fc75b.png" />

<br />

<br />

## Success

After entering or auto-filling the correct code, the system verifies it and transitions to a success screen confirming “Phone verified!” before proceeding to the next module.

<Image align="center" src="https://developer.incode.com/assets/7a85815c298e4337fbda26dbe01f97dc.png" />

<br />

<br />

## Error States

Displayed when the user enters an incorrect or expired code. The UI highlights the input fields in red and provides feedback such as:

* “Incorrect code, please try again.”
* “Code expired, please request a new one.”

Retry and resend options remain accessible, ensuring a smooth recovery path.

<Image align="center" src="https://developer.incode.com/assets/aa7bd160ae6a6d6e5200dbad6cc30ae5.png" />

---

- Path: `design-and-ux/phone-input-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/phone-input-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/phone-input-specs-guidelines.md

# Specs & Guidelines

The **Phone Number Input** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/f8df50753480551351e116551970ec9d.png" align="center" />


***

## Responsiveness & Viewport Adaptation

The **Phone Number Input** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

This ensures that key interactive areas, such as the input area, country selector, and primary CTA always remain visible and reachable without requiring scrolling or zooming.


<Image src="https://developer.incode.com/assets/a7f59bea41d61fb0060e1d583e4473cf.png" align="center" />


<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| :--------------------------------- | :--------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | Components stack vertically; country selector and input field scale slightly |
| **Standard phones (iPhone 12–16)** | Full layout displayed with consistent spacing and button hierarchy           |
| **Tall/narrow Android devices**    | Vertical spacing adjusts dynamically to maintain visual balance              |
| **Foldables (e.g., Pixel Fold)**   | Input group stays centered; margins expand symmetrically                     |
| **Tablets**                        | Wider margins with proportional input scaling; buttons stay centered         |
| **Desktop web**                    | Content is centered with fixed max-width and extended safe padding           |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**            |
| :------------------ | :--------------------------------------------------- | :-------------------------- |
| Input field & label | Scale and align based on viewport width              | Border, color, placeholder  |
| Country selector    | Expands in width proportionally to maintain spacing  | Icon, surface, border color |
| Buttons             | Width adjusts; spacing below inputs adapts           | Color & text                |
| Countdown text      | Reflows beneath inputs; stays visible on all devices | Yes, fully localizable      |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                    |
| Background surfaces | Fill full viewport; safe padding adjusts per device  | Yes                         |
| Header area         | Padding and alignment scale with safe insets         | Limited (color only)        |

<br />

### What remains fixed across breakpoints

| **Element**              | **Reason**                                    |
| :----------------------- | :-------------------------------------------- |
| OTP verification logic   | Core function, must stay consistent           |
| Input field proportions  | Ensures usability and recognition consistency |
| Minimum text size        | Maintains WCAG readability standards          |
| Minimum tap target sizes | Accessibility requirement across devices      |
| Layout hierarchy         | Preserves visual predictability and rhythm    |

<br />

### Design Notes

- Input grouping (country code + phone field) should always be treated as a single logical component.
- Button placement remains consistent across states (focused, disabled, success) to maintain predictability.
- The module is built for fast entry; avoid introducing animations or long transitions between states.
- Keep vertical spacing consistent with other verification steps (e.g., OTP entry) to support modular flow design.
- Typography tokens ensure clear contrast and legibility even in dark mode; test brand overrides for sufficient color ratios.

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/2c96b731e7751b3905e482fefa71629c.png" align="center" />


<br />

***

## Prototype & Transitions

Phone Number Input includes predefined transition rules and micro-interactions that ensure a smooth user experience. Animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/360b932f39ba58dfb201f83146474695.gif" align="center" />


<br />

***

## Localization

The **Phone Number Input** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/c0e11127da8a3998769918bbeb1ddd89.png" align="center" />


<br />

### Key considerations

- All user-facing text (titles, labels, placeholders, buttons, countdowns) is fully localizable.
- Text element's width and padding flex to accommodate longer translations (e.g., German, Portuguese).
- Spacing tokens adjust dynamically to preserve vertical rhythm in longer translations.

<br />

---

- Path: `design-and-ux/phone-input-v1-vs-v2-comparison`
- URL: https://developer.incode.com/design-and-ux/phone-input-v1-vs-v2-comparison/
- Markdown: https://developer.incode.com/design-and-ux/phone-input-v1-vs-v2-comparison.md

# Phone Number V1 vs V2 Comparison

V1 provides a basic phone number input and verification experience.
While it supports the necessary validation logic, the flow offers less flexibility in adapting the experience to different product needs, markets, or branding requirements.

V2 rethinks the flow to be clearer, and easier to customize, introducing better error handling, and alignment with the token-based system. The V2 experience is designed to reduce user confusion, lower drop-off during verification, and ensure consistent look across platforms and markets.

<br />

<Image align="center" caption="V1 provides a basic phone number input and verification experience, focused primarily on data submission with limited guidance and flexibility." src="https://developer.incode.com/assets/97a27a2b1bc758db6641a417fdefb3ed.png" />

<br />

<Image align="center" caption="V2 provides a more guided and consistent input experience. Improved UX writing and standardized components help users complete the flow with less friction." src="https://developer.incode.com/assets/2ba7ece65a4e52603c5ba994c8615363.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1      | V2       | Notes                                                              |
| -------------------------- | ------- | -------- | ------------------------------------------------------------------ |
| Phone number verification  | ✅       | ✅        | Core functionality present in both versions                        |
| Inline validation          | ✅       | ✅        | Validation logic during entry supported in both versions           |
| Error states coverage      | ✅       | ✅        | Both handle errors, V2 structures them better and improves clarity |
| Customization options      | Limited | Advanced | V2 supports token-based customization                              |
| Documentation completeness | Basic   | Enhanced | V2 provides enhanced, standardized documentation coverage          |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior              | V1                                     | V2                                                        | Notes                                                                       |
| --------------------- | -------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- |
| Error handling        | Separate error states, less contextual | Clear, actionable error messages with improved UX writing | V2 reduces cognitive load                                                   |
| State transitions     | Default transitions                    | Defined transitions between states                        | V2 includes transition smoothness and consistency as part of the experience |
| Flow and UI structure | Functional but less standardized       | Structured and consistent                                 | Aligned with the tokenized design system                                    |

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/79e0a63bc02f88f4cb4b49d6dde3aa52.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

---

- Path: `design-and-ux/phone-number-input-design`
- URL: https://developer.incode.com/design-and-ux/phone-number-input-design/
- Markdown: https://developer.incode.com/design-and-ux/phone-number-input-design.md

# Phone Number Input 

The [Phone Number Input](/features-and-modules/phone-number-input/) module verifies a user's mobile number using either Silent Network Authentication (SNA) or an SMS-based one-time password (OTP). It ensures that the user has access to a valid phone number, which can be used for identity verification, account recovery, or two-factor authentication workflows.


<Image src="https://developer.incode.com/assets/146725771b29ebedff6e0f2835eded24.gif" align="center" caption="OTP Verification" />


When available, Silent Network Authentication validates the phone number directly through the user's mobile network operator, without requiring the user to enter a code. If SNA is unavailable or unsuccessful, the system automatically falls back to SMS OTP verification.


<Image src="https://developer.incode.com/assets/4d3c3cbc170b6d75dbc5ebf4b80b100f.gif" align="center" caption="SNA Verification" />


This ensures both a frictionless experience and maximum verification coverage.

***

## Where it fits in the flow

Phone Number Input typically appears early in the onboarding or verification flow, often before ID and Selfie Capture modules.

Once the phone number is successfully verified (via Silent Network Authentication or SMS OTP), the user proceeds to the next step. This may include biometric verification, document capture, or additional compliance checks depending on configuration.

***

## User Flow

The sections below walk through each verification path: Silent Network Authentication first, then SMS OTP.

### Silent Network Authentication

When SNA is enabled, verification begins automatically after the user enters their phone number. If the user's carrier and device support SNA, the number is verified silently in the background. If not, the flow falls back to SMS OTP.

1. The user enters their phone number and confirms.
2. The system initiates verification.


<Image src="https://developer.incode.com/assets/da2e0a452864cd7a85c561f1fee81f34.png" align="center" />


If supported by the user's carrier and device:

- A background network validation is triggered.
- No SMS is sent.
- The user does not need to enter a code.

If validation succeeds, verification completes automatically. If SNA is unavailable or unsuccessful, the flow falls back to SMS OTP.

### OTP Verification

The Phone Number Input experience guides the user from entering their phone number to completing verification via OTP.

1. The user enters their phone number and confirms.
2. The system sends a verification code via SMS.
3. The user inputs the received code to complete verification.

If the code is incorrect or expired, the flow provides clear retry options, including resending the code or editing the phone number. Once the number is successfully verified, the user advances automatically to the next module.


<Image src="https://developer.incode.com/assets/eebe5e7c0e4c160d6e16d619e11d671d.png" align="center" />


***

## Full Flow Map SNA

This diagram presents the full sequence of screens involved in the **Phone Number Input module**, including:

- Phone number input and country code selection
- Silent Network Authentication attempt
- SMS OTP entry (if required)
- Successful verification
- Error handling and retry paths

It visually represents both the ideal path and alternative fallback scenarios, helping teams understand all possible user interactions and system states within the module.


<Image src="https://developer.incode.com/assets/015aa2c70daa32d2c4665b5ad7da0e20.png" align="center" />


## Full Flow Map OTP

This diagram presents the full sequence of screens involved in the **Phone Number Input** module, from initial input, country code selection, and OTP entry, to successful verification or error handling.

It visually represents both the ideal path and alternative error or retry paths, helping teams understand all possible user interactions and system states within the module.


<Image src="https://developer.incode.com/assets/c01079d240162afd985121d5f0f4390f.png" align="center" />


***

## Happy Path (Light & Dark) SNA

When Silent Network Authentication is available, the happy path is fully automatic. The user enters their phone number and advances without entering a code.


<Image src="https://developer.incode.com/assets/73064ee3a80e13fedbf7230e27e5392e.png" alt="Phone Number Input module - Happy Path in Light mode" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/5b42c3f29557e42fe0865672f622a679.png" alt="Phone Number Input module - Happy Path in Dark mode" align="center" caption="Dark mode" />


## Happy Path (Light & Dark) OTP

The ideal user journey when the phone number is entered and verified successfully with no interruptions.

The happy path represents the smoothest experience: the user inputs a valid phone number, receives the SMS code instantly, enters it correctly, and proceeds without retries.

Both light and dark mode previews are included so design, product, and engineering teams can validate visual consistency and accessibility across themes.


<Image src="https://developer.incode.com/assets/a1d557fe66e9a646522ce2c7e1fa63b1.png" alt="Phone Number Input module - Happy Path in Light mode" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/5946d45d738d9334a265840cf047f5de.png" alt="Phone Number Input module - Happy Path in Dark mode" align="center" caption="Dark mode" />


***

## Best Practices

Recommended guidelines for designing and implementing the **Phone Number Input** experience.

**✅ Do**

- Keep validation instant and informative.
- Provide clear feedback after OTP code submission (success or error).
- Provide a resend option and allow time buffer for delivery.
- Clearly communicate progress during background verification for SNA.

**❌ Don't**

- Avoid long delays or silent failures.
- Create long loading states without user feedback.

<br />

---

- Path: `design-and-ux/prizma-design-foundations`
- URL: https://developer.incode.com/design-and-ux/prizma-design-foundations/
- Markdown: https://developer.incode.com/design-and-ux/prizma-design-foundations.md

<div class="dh-px-hero"><div class="dh-px-dots"></div><p class="dh-px-badge"><i></i>Design System</p><h1 class="dh-px-title">Prizma.</h1>

Prizma is Incode’s single source of truth for our design language. It provides the tokens, components, and guidelines that help teams build fast, consistent, accessible experiences without sacrificing flexibility.

</div>

<div class="dh-px-cards"><div class="dh-px-grid2"><a class="dh-px-card dh-px-core" href="/design-and-ux/components/"><div class="dh-px-text"><div><p class="dh-px-eyebrow">Foundations · Tokens · Components</p><p class="dh-px-card-title">Prizma Core</p><p class="dh-px-card-body">The shared design language for Incode’s product suite. Tokens, primitives, typography, spacing, and color — everything that keeps every SDK and interface consistent.</p></div><span class="dh-px-cta">Explore Core<svg width="13" height="13" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><line x1="5" y1="12" x2="19" y2="12"/><polyline points="12 5 19 12 12 19"/></svg></span></div><img src="/assets/design-and-ux/prizma-design-foundations/selfie-capture.png" alt="" /></a><a class="dh-px-card dh-px-card--purple" href="/design-and-ux/components/"><div><i class="dh-px-tile"><svg width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><rect x="3" y="3" width="7" height="7" rx="1"/><rect x="14" y="3" width="7" height="7" rx="1"/><rect x="3" y="14" width="7" height="7" rx="1"/><rect x="14" y="14" width="7" height="7" rx="1"/></svg></i><p class="dh-px-eyebrow dh-px-eyebrow--purple">Web UI · Admin · Operator tools</p><p class="dh-px-card-title">Prizma Dashboard</p><p class="dh-px-card-body">Design language for the Incode Dashboard — the web interface used by operators and administrators. Adapted from Core for desktop-first, data-dense workflows.</p></div><span class="dh-px-cta dh-px-cta--purple">Explore Dashboard<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><line x1="5" y1="12" x2="19" y2="12"/><polyline points="12 5 19 12 12 19"/></svg></span></a></div><a class="dh-px-card dh-px-tokens" href="/design-and-ux/color/"><div><p class="dh-px-eyebrow">Foundations · Architecture · Theming</p><p class="dh-px-card-title">Design Tokens</p><p class="dh-px-card-body">The 3-layer token model — Primitive, Semantic, and Component — that powers consistent theming, white-labeling, and the shared contract between design and code.</p></div><span class="dh-px-chain"><span style="color:#60667c">#006aff</span><svg width="10" height="10" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M5 12h14M12 5l7 7-7 7"/></svg><span style="color:#006aff">Color.Brand.500</span><svg width="10" height="10" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M5 12h14M12 5l7 7-7 7"/></svg><span style="color:#3388ff">Surface.Brand</span><svg width="10" height="10" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M5 12h14M12 5l7 7-7 7"/></svg><span style="color:#189f60">Btn.Primary</span><svg width="13" height="13" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" style="color:#006aff;margin-left:8px"><line x1="5" y1="12" x2="19" y2="12"/><polyline points="12 5 19 12 12 19"/></svg></span></a></div>

<div class="dh-px-band"><p class="dh-px-band-label">Vision</p><p class="dh-px-band-lead">Prizma Design System is a scalable product UI infrastructure.</p><p>It defines the contract between design and development that enables consistent delivery, faster iteration, and reliable customization across platforms. Prizma is Incode’s single source of truth for our design language — tokens, components, and guidelines that help teams build fast, consistent, accessible experiences without sacrificing flexibility.</p></div>

<div class="dh-px-grid2" style="margin-bottom:56px"><div class="dh-px-panel"><p class="dh-px-eyebrow">Prizma is</p><ul class="dh-px-list"><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M2 6l3 3 5-5" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>A product UI foundation that keeps experiences consistent as products scale.</li><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M2 6l3 3 5-5" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>A shared contract between design and engineering, so what’s designed can be implemented predictably.</li><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M2 6l3 3 5-5" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>A system of tokens, components, patterns, and guidelines that supports reliable customization.</li></ul></div><div class="dh-px-panel"><p class="dh-px-eyebrow dh-px-eyebrow--muted">Prizma is not</p><ul class="dh-px-list dh-px-list--muted"><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M3 3l6 6M9 3l-6 6" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>Just a component library or a style guide.</li><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M3 3l6 6M9 3l-6 6" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>A static “Lego instruction manual.” Prizma is built to evolve with products and platforms.</li><li><i><svg width="8" height="8" viewBox="0 0 12 12" fill="none"><path d="M3 3l6 6M9 3l-6 6" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"/></svg></i>A constraint. It balances consistency with the adaptability teams need to ship.</li></ul></div></div>

<div class="dh-rule"><span>Principles</span><i></i></div>

<div class="dh-px-principles"><div class="dh-px-principle"><i><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><circle cx="12" cy="12" r="10"/><polyline points="12 6 12 12 16 14"/></svg></i><strong>Single source of truth</strong><p>One place where design decisions live, versioned and accessible to every team.</p></div><div class="dh-px-principle"><i><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><polyline points="16 18 22 12 16 6"/><polyline points="8 6 2 12 8 18"/></svg></i><strong>Design–dev contract</strong><p>Tokens connect Figma to code, so what’s designed is what gets built.</p></div><div class="dh-px-principle"><i><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><circle cx="12" cy="12" r="3"/><path d="M19.07 4.93a10 10 0 0 1 0 14.14M4.93 4.93a10 10 0 0 0 0 14.14"/></svg></i><strong>Reliable customization</strong><p>Built to be extended without breaking. Override at the token layer, not the component.</p></div><div class="dh-px-principle"><i><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><polyline points="22 12 18 12 15 21 9 3 6 12 2 12"/></svg></i><strong>Scales with products</strong><p>Prizma is infrastructure, not a style guide. It grows as the product suite grows.</p></div></div>

<div class="dh-px-band"><p class="dh-px-band-label">The name</p><p class="dh-px-band-lead">Prizma draws inspiration from the optical properties of a prism.</p><p>A prism bends and reflects light into a vibrant spectrum. In the same way, Prizma transforms a single foundation into many expressions — adapting to different products, platforms, and needs while maintaining a cohesive visual language. The name comes from the Serbian word for “prism” — призма.</p></div>

---

- Path: `design-and-ux/qualified-signature-design`
- URL: https://developer.incode.com/design-and-ux/qualified-signature-design/
- Markdown: https://developer.incode.com/design-and-ux/qualified-signature-design.md

# Qualified Signature 

**Qualified Signature** is a key step in onboarding and agreement workflows. It presents users with a document to review and a set of legally required consent statements to confirm before completing the signing process.


<Image src="https://developer.incode.com/assets/f4bf6e3103a8c602eb2478cb8d23cf4c.gif" align="center" />


***

## Where it fits in the flow

**Qualified Signature** is typically positioned after face capture, ID capture and OTP verification, after identity and document checks have been completed, depending on the configured workflow.

***

## User Flow

The **Qualified Signature experience** guides users through Terms and conditions, review and sign, and creating the signature.


<Image src="https://developer.incode.com/assets/d50863cf10ef91e8bc6270ddcfb901df.jpg" align="center" />


<br />

***

## Full Flow Map


<Image src="https://developer.incode.com/assets/5eeb9fbdb8de811d2e0085dd0de7ea96.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the user accepts the terms and conditions, reviews the document, accepts the terms and conditions again, creates the signature, and reaches the success screen without interruptions.<br />**The happy path** represents the smoothest version of the experience: the user accepts the terms and conditions, opens and reviews the contract, accepts the terms and conditions, creates the signature, and the system processes and confirms it. The user reaches the success screen on the first attempt without encountering any errors.<br />**Light and dark mode** previews are included to allow teams to validate visual consistency, accessibility, and contrast across themes and platforms.


<Image src="https://developer.incode.com/assets/d52e1c4fdb8065ec3484ba5b9e18c3f3.png" align="center" caption="Light mode" />



<Image src="https://developer.incode.com/assets/7cd97d8b5512a447c83c147690d22eb1.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

**Best Practices for Designing and Implementing the Qualified Signature Experience**

✅ Do

- Display the full contract or document with a clear link to open and read it before signing.
- Require each consent checkbox to be checked individually before the "Finish signing" button becomes active.
- Keep consent statements concise, specific, and easy to understand.
- Provide clear visual feedback during processing to prevent duplicate submissions.

❌ Don't

- Don't allow the "Finish signing" button to be tapped unless all checkboxes are checked.
- Don't allow duplicate submissions by leaving the button active while the signature is being processed.

<br />

---

- Path: `design-and-ux/radio`
- URL: https://developer.incode.com/design-and-ux/radio/
- Markdown: https://developer.incode.com/design-and-ux/radio.md

# Radio Button

Radio buttons allow users to select exactly one option from a set. Unlike checkboxes, selecting one automatically deselects others. Prizma radios are always used in groups of two or more.

## Try it live

Pick one — real radio inputs styled with the radio tokens.

<div class="dh-demo"><p class="dh-demo-label">Interactive — select one</p><label class="dh-pz-radio"><input type="radio" name="pz-demo-radio" checked /> <span>Use my camera</span></label><label class="dh-pz-radio"><input type="radio" name="pz-demo-radio" /> <span>Upload a file</span></label></div>

<div class="dh-rule"><span>States</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><label class="dh-pz-radio"><input type="radio" checked /> <span>Selected</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Selected</span><code>.radio.is-selected</code><p>The chosen option. The knob fills with brand color.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><label class="dh-pz-radio"><input type="radio" /> <span>Unselected</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Unselected</span><code>.radio</code><p>Available but not chosen. Selecting it automatically deselects the others in the group.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><label class="dh-pz-radio" style="opacity:0.4"><input type="radio" /> <span>Disabled</span></label></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Disabled</span><code>opacity: 0.4</code><p>Unavailable option, shown muted and non-interactive.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--radio-surface-default | Unselected background | Component
--radio-surface-selected | Selected background | Component
--radio-surface-disabled | Disabled background | Component
--radio-border-default | Unselected border | Component
--radio-border-selected | Selected border | Component
--radio-border-disabled | Disabled border | Component
--radio-dot-color | Inner dot color | Component
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/screen-states-ekyb`
- URL: https://developer.incode.com/design-and-ux/screen-states-ekyb/
- Markdown: https://developer.incode.com/design-and-ux/screen-states-ekyb.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the eKYB Verification experience.

***

## Entry Form

Entry point of the eKYB module. This screen collects the business and beneficial ownership information required for electronic Know Your Business (eKYB) verification.
The set of displayed fields depends on the selected verification source (e.g., Driver's License, Credit Bureau, Government Registry). In this example, the flow uses Driver's License verification.

<Image align="center" src="https://developer.incode.com/assets/97084381424925d77e1e295e51222b02.png" />

<br />

## Form filling

This state appears while the user is actively entering business and beneficial ownership information in the eKYB form.
Focused fields are visually highlighted, and system components such as the keyboard are displayed. Real-time validation may occur as the user types, guiding accurate data entry before submission.

<Image align="center" src="https://developer.incode.com/assets/d67b8c2d62058b6624068d086875a8ac.png" />

<br />

<br />

## Form Processing (Inline Submission State)

Displayed once all required fields are completed with valid values.

All form fields appear in a disabled, read-only state while the submission is in progress, preventing edits during the loading phase. A loading spinner replaces the Continue button label to indicate that the system is processing the request.

<Image align="center" src="https://developer.incode.com/assets/621a25524686687809842e2c3cf88462.png" />

<br />

## Form Processing

The form is replaced by a dedicated processing screen displaying a loading spinner and a "Processing..." label. This full-screen state indicates that the business data is being transmitted and validated against official registries

<Image align="center" src="https://developer.incode.com/assets/6a68d9bd6e18b220cea58958a8e6fa52.png" />

<br />

## Form Error

Displayed when one or more fields contain invalid or mismatched data (e.g., incorrect UBO surname).

Invalid fields are highlighted with a red border and inline error messaging beneath the affected field.

<Image align="center" src="https://developer.incode.com/assets/ad144935847d27a58c5c5a8426bc2bd4.png" />

<br />

## Processing Screen

Indicates that eKYB verification is in progress after successful submission.

A full-screen loading state with spinner and “Processing…” message communicates that backend services are validating the provided data. No user interaction is available during this step.

<Image align="center" src="https://developer.incode.com/assets/a8e27af8cb17af286f56fdedeac6a48b.png" />

<br />

## Failure Screen

Shown when eKYB verification fails due to backend validation, service errors, or data mismatches.

A clear error message and icon communicate the outcome. The Try again CTA allows the user to restart the verification attempt. Depending on configuration, retry limits or escalation logic may apply.

<Image align="center" src="https://developer.incode.com/assets/8d5a4382fed452b121543a144d06e9b1.png" />

<br />

## Success Screen

Displayed when eKYB verification is successfully completed.

A confirmation icon and message (“eKYB verified!”) indicate completion of the module. The system may automatically advance to the next step or wait for user confirmation, depending on configuration. This marks the successful end of the eKYB verification stage.

<Image align="center" src="https://developer.incode.com/assets/6306ae6b0c7f835530f905fb37011d33.png" />

---

- Path: `design-and-ux/screen-states-ocr`
- URL: https://developer.incode.com/design-and-ux/screen-states-ocr/
- Markdown: https://developer.incode.com/design-and-ux/screen-states-ocr.md

# Screen & States

This section provides a complete overview of all possible user-facing states within the **OCR Review module**

***

## Review data editable

This screen displays the information extracted from the identity document in an editable format, allowing users to review and correct any inaccurate or incomplete data before continuing the verification process. Common fields include full name, date of birth, gender, document number, and expiration date.


<Image src="https://developer.incode.com/assets/8dfba9eb142379ebeb07e215cd59d75a.png" align="center" />


## Review data non-editable

This screen displays the information extracted from the identity document in a non-editable format, allowing users to review the captured data before continuing the verification process. Common fields include full name, date of birth, gender, document number, and expiration date.


<Image src="https://developer.incode.com/assets/9b3adbc92ea50b5086d4ff86fd1aea3a.png" align="center" />


<br />

---

- Path: `design-and-ux/screen-states-watchlist-business`
- URL: https://developer.incode.com/design-and-ux/screen-states-watchlist-business/
- Markdown: https://developer.incode.com/design-and-ux/screen-states-watchlist-business.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Watchlist for business**

***

## Watchlist Empty

The initial state displays a simple business information form where users provide the business name and country before starting the watchlist screening process.

<Image align="center" src="https://developer.incode.com/assets/dd50d9f5fa0378df9cdb3501cda9e82a.png" />

<br />

## Watchlist Filled

The filled state displays the completed business information form after the user has entered the business name and selected the country, preparing the screening request for submission.

<Image align="center" src="https://developer.incode.com/assets/c139db30fa8745a7ce4a7ca510d70b4a.png" />

<br />

## Watchlist Processing

A loading indicator and processing message communicate that the screening is actively in progress while temporarily preventing duplicate submissions or interruptions.

<Image align="center" src="https://developer.incode.com/assets/f86d7d5fe10dc5deae9d4e383e962f0d.png" />

<br />

## Watchlist Success

The screen displays a success indicator and confirmation message, communicating that the user’s information has been successfully screened.

<Image align="center" src="https://developer.incode.com/assets/96ab1fe036ab5bc1c2b02af21adbb866.png" />

---

- Path: `design-and-ux/screens-states-adsign`
- URL: https://developer.incode.com/design-and-ux/screens-states-adsign/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-adsign.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Advanced Signature experience.**

***

## Signature empty

Entry point of the Advanced Signature module. This screen presents the user with a consent form titled "Accept and sign," accompanied by a brief instruction to accept the terms before completing the signature. It displays a linked document with a "View" option, followed by three unchecked checkboxes listing the required consent statements. A "Finish signing" button appears at the bottom but remains disabled until all checkboxes are selected.

<Image align="center" src="https://developer.incode.com/assets/838528b2fe33ccfdf369be521cf3108c.png" />

<br />

## Signature filled

This screen reflects the state after the user has checked all three consent checkboxes. Each checkbox is now marked and highlighted in blue, confirming the user's agreement to the terms. The "Finish signing" button becomes active and is highlighted in blue, indicating the user can proceed to the signature step.

<Image align="center" src="https://developer.incode.com/assets/2bc4cba19e3d43165b0f38c7220c340c.png" />

<br />

## Signature Loading

Transitional state shown after the user taps "Finish signing." The screen retains the consent form layout while a loading spinner appears on the "Finish signing" button, providing visual feedback that the system is processing the request.

<Image align="center" src="https://developer.incode.com/assets/d92458766e606bcab8e4585cf4372565.png" />

<br />

## Signature Processing

Intermediate screen displayed while the system processes the signature submission. The screen shows a spinning progress indicator alongside the text "Processing…", communicating to the user that their action is being handled and they should wait.

<Image align="center" src="https://developer.incode.com/assets/b797cc01d4e5967ad90f8e5acb5977ad.png" />

## Signature Success

Final confirmation screen of the Advanced Signature module. After processing completes, the screen displays a green checkmark icon along with the message "Signed successfully!" confirming that the signature has been captured and the process is complete. No further user action is required.

<Image align="center" src="https://developer.incode.com/assets/7eee1bb64ca75443f25bd2c0fc9edb6e.png" />

---

- Path: `design-and-ux/screens-states-certificate-issuance`
- URL: https://developer.incode.com/design-and-ux/screens-states-certificate-issuance/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-certificate-issuance.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Certificate Issuance**

***

## Create a password - Empty

The initial state displays the password creation screen where users create and confirm their password before continuing with the Certificate Issuance process. Password requirements and validation guidance are provided to help users create a secure password and successfully proceed to the next step.


<Image src="https://developer.incode.com/assets/2a26213f3eb985bbc0ec4ef3a12fbcb7.png" align="center" />


<br />

## Create a password - Filled

The filled state displays the completed password creation form after the user has entered and confirmed their password. All required fields have been completed successfully, enabling the user to proceed to the Certificate Issuance process.


<Image src="https://developer.incode.com/assets/a38601112f13b2988b3c690edd431dd5.png" align="center" />


<br />

## Create a password - Loading

A loading indicator and processing message communicate that the certificate issuance request is actively being processed. During this step, duplicate submissions and user interruptions are temporarily prevented to ensure a secure and successful certificate issuance experience.


<Image src="https://developer.incode.com/assets/d5060fdd33bc6e6de874bd1e24cb59ec.png" align="center" />


<br />

## Create a password - Processing

The screen displays a success indicator and confirmation message, communicating that the certificate has been successfully issued. This state confirms that the issuance process is complete and the user can proceed to the next step.


<Image src="https://developer.incode.com/assets/72a9d644784711b595fa333cea98ff0a.png" align="center" />


<br />

## Create a password - Download certificate&#x20;

The final state confirms that the certificate has been successfully generated and is ready for download. Users can review the confirmation message and download their certificate directly from this screen, completing the Certificate Issuance process.


<Image src="https://developer.incode.com/assets/515d672ddd385c4e5fe57ba7bcf7f6f3.png" align="center" />


## Create a password - Done&#x20;

The final state confirms that the certificate has been successfully downloaded and the Certificate Issuance process is complete. Users receive a clear confirmation that their certificate has been issued and saved, providing a successful end to the workflow.


<Image src="https://developer.incode.com/assets/ec8c64a9ca15ed9192c575244882689f.png" align="center" />


<br />

---

- Path: `design-and-ux/screens-states-ekyc`
- URL: https://developer.incode.com/design-and-ux/screens-states-ekyc/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-ekyc.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the eKYC Verification experience.

***

## Enter your details

The image below shows the Enter your details form in its empty state. **_First name_**, **_Last name_**, and **_Date of Birth_** are required fields marked with an asterisk. **_Middle name_** is optional. **Continue** submits the step.

<Image align="center" src="https://developer.incode.com/assets/edf8bad0-f962-48f8-83b7-cb946754aeb7.png" />

## Enter your details - Filled

The image below shows the Enter your details form with **_First name_**, **_Last name_**, and **_Date of Birth_** filled in. **Continue** advances to Driver’s License details.

<Image align="center" src="https://developer.incode.com/assets/726b976a-4758-4852-86a2-c16ced4dd3a6.png" />

## Driver’s License details

The image below shows the Driver’s License details form in its empty state. **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** are all required. **Continue** submits the step.

<Image align="center" src="https://developer.incode.com/assets/a3cc5881-9002-4c4e-831a-3dd285c56583.png" />

## Driver’s License details - Filled

The image below shows the Driver's License details form with **_Driver's License number_**, **_Driver's License state_**, and **_Driver's License expiration date_** filled in. **Continue** submits the step.

<Image align="center" src="https://developer.incode.com/assets/803a1ee6-f4f8-48ad-a096-719a2186bc04.png" />

## Processing

A full-screen processing state shown right after submission. The screen reads “Processing…” while the request is in flight.

<Image align="center" src="https://developer.incode.com/assets/894a0c81-1da2-45df-b6c4-1044ecde593b.png" />

## Success

The success state that closes the flow. Shows an “Information submitted!” message confirming the eKYC verification was successful.



<Image align="center" src="https://developer.incode.com/assets/22ca8de3-c7b7-4533-a9f6-5c4ef8af2945.png" />

## Error

Shown when eKYC verification fails due to backend validation or service errors. Shows a “Something went wrong” message and a **Try again** button to let the user restart the attempt.



<Image align="center" src="https://developer.incode.com/assets/995424a2-4ca9-4185-af1a-b1373ac35c84.png" />

---

- Path: `design-and-ux/screens-states-esign`
- URL: https://developer.incode.com/design-and-ux/screens-states-esign/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-esign.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Electronic Signature experience.**

***

## Signature Canva

Entry point of the Electronic Signature module. 

This screen presents the user with a blank drawing area where they can capture their signature using a finger or mouse. The canvas includes a "Sign here" placeholder to guide the user, a "Clear canvas" option to reset any input, and a "Done" button that remains disabled until a signature stroke is detected. 

<Image align="center" src="https://developer.incode.com/assets/6409ea908a533ce23c31fb2d1a134cb9.png" />

<br />

## Signature filled

This screen reflects the state after the user has drawn their signature on the canvas. The "Clear canvas" link becomes active, allowing the user to erase and start over if needed. The "Done" button is now enabled and highlighted in blue, indicating the user can proceed to submit their signature.

<Image align="center" src="https://developer.incode.com/assets/b0bc347038ed531cf0e841757cb1f25e.png" />

<br />

## Success

Final confirmation screen of the Electronic Signature module. After the user taps "Done," the system processes the signature and displays a green checkmark icon along with a "Signed successfully!" message. This screen confirms that the signature has been captured and the process is complete. No further user action is required.

<Image align="center" src="https://developer.incode.com/assets/2d380fdfd2c8090a87f103ccb1efcea5.png" />

<br />

---

- Path: `design-and-ux/screens-states-forms`
- URL: https://developer.incode.com/design-and-ux/screens-states-forms/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-forms.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Forms and Data Entry**

***

## Forms empty

Entry point of the data entry module. This screen presents the user with a form containing four customizable required fields: ID number, Email, Country of residence, and Date of Birth . All fields are empty and the "Continue" button is disabled until the user provides valid input.

<Image align="center" src="https://developer.incode.com/assets/b9554c84df4786d53e2bee218aecf467.png" />

<br />

## Forms Filled

This state confirms that the user has completed all required fields in the form. All four customizable fields — ID number, Email, Country of residence, and Date of Birth — contain valid input, and the "Continue" button is now enabled, allowing the user to proceed to the next step.

<Image align="center" src="https://developer.incode.com/assets/c6212909b6b28071a48ec403e9c09878.png" />

<br />

## Forms Loading

This state is triggered after the user taps "Continue" with all required fields completed. The form remains visible with the filled data, while the primary button transitions to a loading state, displaying a spinner as the submission is being processed..

<Image align="center" src="https://developer.incode.com/assets/63acd680deba0873526640af1a047928.png" />

<br />

## Form Success

This state confirms that the user's information has been successfully submitted. The screen displays a green checkmark icon accompanied by the message "Success!," indicating the process has been completed and the user can proceed to the next step in the flow.

<Image align="center" src="https://developer.incode.com/assets/d6378d221e6b86e5a80b1637fd0368c3.png" />

---

- Path: `design-and-ux/screens-states-qsign`
- URL: https://developer.incode.com/design-and-ux/screens-states-qsign/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-qsign.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Qualified Signature experience.**

***

## T\&C

Entry point of the Qualified Signature module. This screen presents the Terms & Conditions document for review, allowing the user to read the agreement before proceeding. The consent section is displayed below the document with five unchecked checkboxes containing the required consent statements, while the "Continue" button remains disabled until all required consents are accepted.


<Image src="https://developer.incode.com/assets/8e237fbfd791f6680bdc6c263cd7a13c.png" align="center" />


<br />

## T\&C Selected

Entry point of the Qualified Signature module. This screen displays the selected Terms & Conditions document in full, allowing the user to review its contents before continuing. The consent section remains available below the document, with five unchecked checkboxes containing the required consent statements. The "Continue" button remains disabled until all required consents are accepted.


<Image src="https://developer.incode.com/assets/6363296e3b5ad9483e4ad92fceb03900.png" align="center" />


<br />

## Signature&#x20;

Entry point of the Qualified Signature signing flow. This screen presents the user with a "Review and sign" form, including a brief instruction explaining that a qualified certificate will be issued to create the signature. It displays a linked document with a "View" option, followed by three unchecked consent checkboxes containing the required consent statements. The "Sign" button remains disabled until all required consents are accepted.


<Image src="https://developer.incode.com/assets/0e22996753336ef1196b267200cb078f.png" align="center" />


<br />

## Signature filled&#x20;

This screen reflects the state after the user has checked all three consent checkboxes. Each checkbox is now selected and highlighted in blue, confirming the user's agreement to the required consent statements. The "Sign" button becomes active and highlighted in blue, indicating that the user can proceed with the qualified signature process.


<Image src="https://developer.incode.com/assets/9f9736adc6ac71f8caff44af6993cb21.png" align="center" />


<br />

## Signature Loading

Transitional state displayed after the user taps the "Sign" button. The screen retains the "Review and sign" form layout while a loading spinner appears on the "Sign" button, providing visual feedback that the signature request is being submitted and processed.


<Image src="https://developer.incode.com/assets/36668cc78ef6c7b690b7e802023cb1be.png" align="center" />


<br />

## Signature Processing

Intermediate screen displayed while the system processes the signature submission. The screen shows a spinning progress indicator alongside the text "Creating your signature…", communicating to the user that their action is being handled and they should wait.


<Image src="https://developer.incode.com/assets/cf23f44d2525a0a86ab6f7833da3ca45.png" align="center" />


## Signature Success

Final confirmation screen of the Qualified Signature module. After the signature has been successfully created, the screen displays a green checkmark icon with the message "Signed successfully!" confirming that the signing process is complete. The screen also displays the signed user's name and a "Done" button, allowing the user to exit the flow.


<Image src="https://developer.incode.com/assets/acc197a865bcb772e79b04b74921b6b3.png" align="center" />


<br />

---

- Path: `design-and-ux/screens-states-watchlist`
- URL: https://developer.incode.com/design-and-ux/screens-states-watchlist/
- Markdown: https://developer.incode.com/design-and-ux/screens-states-watchlist.md

# Screens & States

This section provides a complete overview of all possible user-facing states within the **Watchlist**

***

## Watchlist Processing

A loading indicator and processing message communicate that the screening is actively in progress while temporarily preventing duplicate submissions or interruptions..

<Image align="center" src="https://developer.incode.com/assets/f86d7d5fe10dc5deae9d4e383e962f0d.png" />

<br />

## Watchlist Success

The screen displays a success indicator and confirmation message, communicating that the user’s information has been successfully screened.

<Image align="center" src="https://developer.incode.com/assets/96ab1fe036ab5bc1c2b02af21adbb866.png" />

---

- Path: `design-and-ux/separator`
- URL: https://developer.incode.com/design-and-ux/separator/
- Markdown: https://developer.incode.com/design-and-ux/separator.md

# Separator

Separators create visual breaks between content sections. Prizma offers a plain horizontal rule and a labeled variant — commonly used to separate primary and alternative authentication methods.

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-separator"><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Plain rule</span><code>.separator</code><p>A horizontal rule between content sections.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-separator"><i></i>Or<i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Labeled</span><code>.separator--label</code><p>Splits alternatives — an Or between two auth methods.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-separator is-dashed"><i></i></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#9ca3af14;color:#9ca3af">Dashed</span><code>.separator--dashed</code><p>Lighter division inside a single section.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--separator-line-color | Horizontal rule color | Component
--separator-text-color | Label text color | Component
--separator-gap | Gap between line and label | Component
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/shape`
- URL: https://developer.incode.com/design-and-ux/shape/
- Markdown: https://developer.incode.com/design-and-ux/shape.md

# Shape

Corner radius defines the personality of UI surfaces — from sharp precision to fully rounded pills. Always use semantic names like `small` or `medium`, not raw pixel values.

<Tabs>
<Tab title="Overview">

## Progression

```dh-strip
kind: radius
desc: The scale moves from no rounding (none) through functional steps (x-small → large) to decorative (xx-large) and full pill (full). Each step has a designated role — mixing steps within a component breaks visual logic.
none | 0
x-small | 4
small | 8
medium | 16
large | 24
x-large | 40
xx-large | 64
full | 9999
```

```dh-principles
#006aff | Token names, not pixels | Never write border-radius: 12px in component code. Reference the semantic token — it survives theming and global radius updates.
#189f60 | Nested radius rule | An inner element's radius should be: outer-radius − padding. A card with medium (16px) and 8px padding → inner radius ≈ small (8px).
#820ad1 | Full is intentional | Use full (9999px) only where circular form carries semantic meaning — avatars, icon buttons, pill badges, toggle tracks.
```

## Step context

```dh-principles
#006aff | Controls | Interactive elements — inputs, buttons, selects, list items. Steps: none, x-small, small.
#189f60 | Containers | Surfaces that wrap content — cards, panels, modals, sheets. Steps: medium, large, x-large.
#820ad1 | Decorative | Art-directed surfaces and circular elements. Steps: xx-large, full.
```

</Tab>
<Tab title="Scale">

```dh-scale
kind: radius
none | Border.Radius.none | 0 | --border-radius-none
x-small | Border.Radius.x-small | 4 | --border-radius-x-small
small | Border.Radius.small | 8 | --border-radius-small
medium | Border.Radius.medium | 16 | --border-radius-medium
large | Border.Radius.large | 24 | --border-radius-large
x-large | Border.Radius.x-large | 40 | --border-radius-x-large
xx-large | Border.Radius.xx-large | 64 | --border-radius-xx-large
full | Border.Radius.full | 9999 | --border-radius-full
```

</Tab>
<Tab title="Usage">

```dh-usage
kind: radius
none | 0px | Reserved for structural elements that span full width — dividers, progress fills, full-bleed images. No rounding. | Dividers, Progress bars, Full-bleed images
x-small | 4px | Keeps elements sharp and precise. Best for dense inline elements where rounding would consume too much visual space. | Chips, Tags, Badges
small | 8px | The default for interactive controls. Inputs, buttons, and selects all use this step. | Inputs, Dropdowns, Buttons, List items
medium | 16px | The default for containers — cards, sheets, and informational panels. | Cards, Panels, Dialogs, Drawers
large | 24px | For emphasis. Modal dialogs, bottom sheets, and featured content areas. | Modals, Bottom sheets, Featured cards
x-large | 40px | Rare. Used for hero-level surfaces that need strong visual distinction. | Hero cards, Large overlays
xx-large | 64px | Decorative only. Avoid for functional UI. | Decorative surfaces
full | 9999px | A fully rounded pill. Avatars, icon buttons, toggle tracks, and pill-style badges. | Avatars, Icon buttons, Pill badges, Toggles
```

</Tab>
</Tabs>

---

- Path: `design-and-ux/signature`
- URL: https://developer.incode.com/design-and-ux/signature/
- Markdown: https://developer.incode.com/design-and-ux/signature.md

# Signature Pad

The Signature Pad captures a freehand signature from the user. It supports an empty waiting state and a signed state that confirms capture. Used in consent, contracts, and identity affirmation flows.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-signature"><svg width="180" height="60" viewBox="0 0 180 60" fill="none" stroke="#262831" stroke-width="2" stroke-linecap="round"><path d="M10 45 C 30 10, 45 55, 65 30 S 100 10, 115 35 S 150 50, 170 20" /></svg></span></div>

<div class="dh-rule"><span>States</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-signature" style="width:200px;height:100px"></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#60667c14;color:#60667c">Empty</span><code>.signature-pad</code><p>The dashed canvas invites the user to sign with finger or stylus.</p></div></div><div class="dh-var" style="background:#006aff08"><div class="dh-var-stage"><span class="dh-pz-signature" style="width:200px;height:100px"><svg width="140" height="50" viewBox="0 0 180 60" fill="none" stroke="#262831" stroke-width="2" stroke-linecap="round"><path d="M10 45 C 30 10, 45 55, 65 30 S 100 10, 115 35 S 150 50, 170 20" /></svg></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#006aff14;color:#006aff">Signed</span><code>.signature-pad.has-ink</code><p>Once ink exists, Clear and Confirm actions become available.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--sig-surface | Pad background | Component
--sig-border | Pad border color | Component
--sig-baseline | Signature baseline color | Component
--sig-ink | Drawn stroke color | Component
--sig-signed-bg | Signed state background | Component
--radius-sig | Pad corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/snackbar`
- URL: https://developer.incode.com/design-and-ux/snackbar/
- Markdown: https://developer.incode.com/design-and-ux/snackbar.md

# Snackbar

Snackbars deliver brief, contextual feedback after a user action or system event. They appear at the bottom of the screen, auto-dismiss after a few seconds, and come in four semantic variants: positive, negative, warning, and neutral.

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-stage" style="flex-direction:column;align-items:stretch;max-width:360px;margin-inline:auto"><span class="dh-pz-snack is-neutral">Your session will expire in 2 minutes</span><span class="dh-pz-snack is-positive">Document captured successfully</span><span class="dh-pz-snack is-warning">Low light detected — find a brighter spot</span><span class="dh-pz-snack is-negative">We couldn’t read your document</span></div>

Four tones map to the snackbar tokens: neutral (brand), positive, warning, and negative — surface and border per tone, text always primary.

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--snackbar-positive-bg | Positive background | Component
--snackbar-negative-bg | Negative background | Component
--snackbar-warning-bg | Warning background | Component
--snackbar-neutral-bg | Neutral background | Component
--snackbar-text | Message text color | Component
--snackbar-icon-positive | Positive indicator color | Component
--radius-snackbar | Corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/spacing`
- URL: https://developer.incode.com/design-and-ux/spacing/
- Markdown: https://developer.incode.com/design-and-ux/spacing.md

# Spacing

An 8-point base grid keeps rhythm consistent across every component and layout. All values are multiples of 4px. Reference tokens as `Scale.*` — never hardcode pixel values.

<Tabs>
<Tab title="Overview">

## Grid rhythm

```dh-strip
kind: spacing
desc: Dense range (4–16px) grows in 4px steps for precise component internals. Above 16px the scale shifts to 8px steps to govern layout-level spacing.
4 | 4
8 | 8
12 | 12
16 | 16
24 | 24
32 | 32
48 | 48
64 | 64
```

```dh-principles
#006aff | 8-point base grid | The core rhythm is 8px. Every layout spacing value is a multiple of 8. This keeps vertical rhythm consistent across components and pages.
#189f60 | 4px for precision | The 4px subdivisions handle tight internal spacing — icon gaps, input padding, inline label offsets — without breaking the larger rhythm.
#ff9900 | Context governs density | Compact UI elements (4–12px), comfortable containers (16–24px), page-level layout (32px+). Density is intentional, not arbitrary.
```

## Density in practice

```dh-principles
#006aff | Compact | Badges, chips, tags, inline icons — 8px padding, 4px gaps.
#189f60 | Comfortable | Buttons, cards, inputs, modals — 16px padding, 8px gaps.
#820ad1 | Spacious | Page sections, hero areas — 32px padding, 16px gaps.
```

</Tab>
<Tab title="Scale">

```dh-scale
kind: spacing
none | Scale.0 | 0 | --scale-0
2 | Scale.2 | 2 | --scale-2
4 | Scale.4 | 4 | --scale-4
8 | Scale.8 | 8 | --scale-8
12 | Scale.12 | 12 | --scale-12
16 | Scale.16 | 16 | --scale-16
20 | Scale.20 | 20 | --scale-20
24 | Scale.24 | 24 | --scale-24
32 | Scale.32 | 32 | --scale-32
40 | Scale.40 | 40 | --scale-40
48 | Scale.48 | 48 | --scale-48
56 | Scale.56 | 56 | --scale-56
64 | Scale.64 | 64 | --scale-64
72 | Scale.72 | 72 | --scale-72
80 | Scale.80 | 80 | --scale-80
88 | Scale.88 | 88 | --scale-88
96 | Scale.96 | 96 | --scale-96
104 | Scale.104 | 104 | --scale-104
120 | Scale.120 | 120 | --scale-120
128 | Scale.128 | 128 | --scale-128
200 | Scale.200 | 200 | --scale-200
```

</Tab>
<Tab title="Usage">

```dh-usage
group: Compact — 4–12px | #006aff
Icon-to-label gap | Scale.4–8 | Gap between an icon and its adjacent label text. | Scale.4, Scale.8
Inline element padding | Scale.8–12 | Horizontal padding inside badges, chips, and tag elements. | Scale.8, Scale.12
Input helper text offset | Scale.4 | Margin between an input and its helper or error text. | Scale.4
group: Comfortable — 16–24px | #189f60
Button padding | Scale.16 | Horizontal padding inside primary, secondary, and tertiary buttons. | Scale.16
Card internal padding | Scale.16–24 | Padding inside card and panel components. | Scale.16, Scale.24
Form field gap | Scale.16 | Vertical gap between stacked form fields. | Scale.16
Modal padding | Scale.24 | Internal padding for dialog and bottom-sheet containers. | Scale.24
group: Layout — 32–64px | #820ad1
Section vertical margin | Scale.32–40 | Vertical space between major page sections. | Scale.32, Scale.40
Page horizontal gutter | Scale.24–40 | Left/right padding on the main content container. | Scale.24, Scale.40
```

</Tab>
</Tabs>

---

- Path: `design-and-ux/specs-guidelines-adsign`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-adsign/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-adsign.md

# Specs & Guidelines

The **Advanced Signature** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/89db0166b0029b6211615c8fb1e4316e.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Advanced Signature** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/552bbe279e7f63a500ce7a92d5e1bd6f.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/106037dd01ccb44f8b470d20b12a822c.png" />

<br />

<br />

***

## Prototype & Transitions

**Advanced Signature** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/1a6d53fb6b1d33ed9cb14dfb24ddcf8a.gif" />

<br />

***

## Localization

The **Advanced Signature** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/3b10f659bd48611dcffc6ef8ce4bbcb7.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-certificate-issuance`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-certificate-issuance/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-certificate-issuance.md

# Specs & Guidelines

The **Certificate Issuance** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/5532d2121dbcc55508d91c56e221f262.jpg" align="center" />


<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Certificate Issuance&#x20;**&#x6D;odule is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/3adc123421376b932c211d88e86ba0c7.jpg" align="center" />


<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

- The images always remain the dominant elements, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI above or below the module, it may break alignment.
- Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/7ba9dbc3769f8c1be21ebab7275b9aea.jpg" align="center" />


<br />

<br />

***

## Prototype & Transitions

**Certificate Issuance** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/d252a8cdcfff68b6d7e59d62027a0e26.gif" align="center" />


<br />

***

## Localization

The **Certificate Issuance&#x20;**&#x6D;odule supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/8ba7ea08fc250c4a86ac6d6376a76415.jpg" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
- Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-ekyc`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-ekyc/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-ekyc.md

# Specs & Guidelines

The [eKYC module](/features-and-modules/ekyc/) includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/c9352563-6e01-484b-a0a6-76a15cc942e3.png" />

<br />

***

## Responsiveness & Viewport Adaptation

The [eKYC module](/features-and-modules/ekyc/) is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/d3f90aff-a698-4109-838d-8ba0ac284abe.png" />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |
| Icons               | Remain centered and maintain distance to the title   | Color & style                  |

### What remains fixed across breakpoints

| **Element**                | **Reason**                                        |
| -------------------------- | ------------------------------------------------- |
| Matching logic & detection | Must remain consistent for accuracy               |
| Images displayed           | Automatic depending on users ID and selfie images |
| Minimum text size          | Required for readability & WCAG compliance        |
| Minimum tap target sizes   | Ensures accessibility on mobile                   |
| Overall hierarchy          | Prevents cognitive load at different sizes        |

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

***

## Desktop & Tablet Guidelines

The [eKYC module](/features-and-modules/ekyc/) is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/60654d3a-5205-4cbc-a6ae-6384760ffa11.png" />

<br />

***

## Prototype & Transitions

The [eKYC module](/features-and-modules/ekyc/) includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

***

## Localization

The [eKYC module](/features-and-modules/ekyc/) supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/aaa474ad-1f3e-4119-84c0-cc75b67a1a3a.png" />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

---

- Path: `design-and-ux/specs-guidelines-esign`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-esign/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-esign.md

# Specs & Guidelines

The **Electronic Signature** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/ce33a2f72000b7375c6118068b5c012a.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Electronic Signature** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/8b866581033f438d56be3f9e148196c1.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/21bf703a6dd645a7c95301abd680cc25.png" />

<br />

<br />

***

## Prototype & Transitions

**Electronic Signature** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/7ac4fdff395b10f784c752ed7d9101c1.gif" />

<br />

<br />

<br />

***

## Localization

The **Electronic Signature** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/b2ebd428db8be4f9e47bd3fc6c0f07da.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-forms`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-forms/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-forms.md

# Specs & Guidelines

The **Forms and data entry** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/4630fc72d7e577af37e8aea3ea290657.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Forms and data entry** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/a6dcc55ceed73087ab36b5b592b84945.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/f5cf7feb02637a66b41bfa0975cfb95a.png" />

<br />

***

## Prototype & Transitions

**Forms and data entry** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/2362d8cb78c280c9f8995aa238185d61.gif" />

<br />

***

## Localization

The **Forms and data entry** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/e6f19e7e592e4e94362dab4d981391cf.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-ocr`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-ocr/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-ocr.md

# Specs & Guidelines

The **OCR Review** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/29ed4d08fdc9c8d7e358cb1217e763f9.png" align="center" />


## Responsiveness & Viewport Adaptation

The **OCR Review&#x20;**&#x6D;odule is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/b7a02a0141b5f0866d57ef9027dfaee1.png" align="center" />


***

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

- The images always remain the dominant elements, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI above or below the module, it may break alignment.
- Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

***

## Prototype & Transitions

**OCR Review&#x20;**&#x69;ncludes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/89c2a61f0cfe97228851928c4071ddd7.gif" align="center" />


<br />

---

- Path: `design-and-ux/specs-guidelines-qsign`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-qsign/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-qsign.md

# Specs & Guidelines

The **Qualified Signature** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/f5b2e144e16ba2c56d4f74a58964cbfb.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Qualified Signature** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/47cb871b740ff540acb6cffa57718e85.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/0851bd5326c894817d52f1e3c6cf8a3b.png" />

<br />

<br />

***

## Prototype & Transitions

**Qualified Signature** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/7962b166383fb163b9066865b53e928d.gif" />

<br />

***

## Localization

The **Qualified Signature** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/1520a7a4a8250caadc10e74a401cddb3.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Buttons and CTAs automatically expand to fit translated labels.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-watchlist`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-watchlist/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-watchlist.md

# Specs & Guidelines

The **Watchlist** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/a4d8f4f758709fca64363c7ff298869c.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Watchlist** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/139e9f2fedc69ce94873edd9269acb8c.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/f79e7644b2597249734360c0d2298ca5.png" />

<br />

<br />

***

## Prototype & Transitions

**Watchlist** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/a70ce007424232aac37194968182dcc9.gif" />

<br />

***

## Localization

The **Watchlist** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/a00e6024f94c06f5dfbfe9056b60a3c1.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/specs-guidelines-watchlist-business`
- URL: https://developer.incode.com/design-and-ux/specs-guidelines-watchlist-business/
- Markdown: https://developer.incode.com/design-and-ux/specs-guidelines-watchlist-business.md

# Specs & Guidelines

The **Watchlist for business** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.

<Image align="center" src="https://developer.incode.com/assets/6b0ba7c972cbc2fb7fe6446d7413a1ac.png" />

<br />

<br />

***

## Responsiveness & Viewport Adaptation

The **Watchlist for business** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.

<Image align="center" src="https://developer.incode.com/assets/6bb60bb1fcfa4143aed61ab07bc7d688.png" />

<br />

### How the layout adapts across devices

| **Breakpoint**                     | **Behavior**                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; images scale down to maintain visibility      |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent                   |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and images remain pinned to the top |
| **Foldables (e.g., Pixel Fold)**   | Larger images and more balanced white space; content remains centered        |
| **Tablets**                        | Increased layout margins; silhouette scales proportionally                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding      |

<br />

### What is responsive (and customizable)

| **Element**         | **Responsive Behavior**                              | **Customizable**               |
| ------------------- | ---------------------------------------------------- | ------------------------------ |
| Images size         | Scale proportionally by viewport height              | No                             |
| Title text          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| Buttons             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| Footer / watermark  | Pinned to bottom safe area                           | Optional                       |
| Background surfaces | Expand to full viewport                              | Yes                            |
| Header area         | Scales padding according to device safe insets       | Limited (color only)           |

<br />

### What remains fixed across breakpoints

| **Element**                | **Reason**                                 |
| -------------------------- | ------------------------------------------ |
| Matching logic & detection | Must remain consistent for accuracy        |
| Minimum text size          | Required for readability & WCAG compliance |
| Minimum tap target sizes   | Ensures accessibility on mobile            |
| Overall hierarchy          | Prevents cognitive load at different sizes |

<br />

### Design Notes

* The images always remain the dominant elements, regardless of screen size.
* Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
* Avoid adding custom UI above or below the module, it may break alignment.
* Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.

<Image align="center" src="https://developer.incode.com/assets/461624f39f77320412dbe977858dbf04.png" />

<br />

<br />

***

## Prototype & Transitions

**Watchlist for business** includes predefined transition rules and micro-interactions that ensure a smooth user experience from the image comparison, to the successful and error states. Timing, easing, and animation guidelines are documented directly in Figma prototypes.

<Image align="center" src="https://developer.incode.com/assets/d50bd812119bc5069b0d11899c8f2238.gif" />

<br />

***

## Localization

The **Watchlist for business** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.

<Image align="center" src="https://developer.incode.com/assets/6a815012376135f7f076da07182a0a32.png" />

<br />

**Key considerations:**

* All user-facing text is fully localizable.
* UI adjusts to prevent truncation and maintain readability.
* Spacing and vertical rhythm adapt to accommodate longer languages.
* Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
* Incode supports a variety of languages

<br />

---

- Path: `design-and-ux/states`
- URL: https://developer.incode.com/design-and-ux/states/
- Markdown: https://developer.incode.com/design-and-ux/states.md

# States Block

The States Block is a full-screen layout used to communicate a process state: loading, success, or error. It centers a status icon, a title, and supporting text — replacing the standard screen layout while the system processes or delivers a result.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-states"><figure style="background:#e4fbf0"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#189f60" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="20 6 9 17 4 12"/></svg></figure><strong>Identity verified</strong><p>You’re all set. You can now continue with your application.</p><button class="dh-pz-btn dh-pz-btn-primary" type="button">Continue</button></span></div>

<div class="dh-rule"><span>Variants</span><i></i></div>

<div class="dh-var-grid"><div class="dh-var" style="background:#189f6008"><div class="dh-var-stage"><span class="dh-pz-states" style="width:210px;padding:24px 16px"><figure style="background:#e4fbf0;width:44px;height:44px"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="#189f60" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="20 6 9 17 4 12"/></svg></figure><strong style="font-size:15px">Success</strong><p style="margin:0">Verification complete.</p></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#189f6014;color:#189f60">Success</span><code>.states--success</code><p>Positive outcome with a single continue action.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-states" style="width:210px;padding:24px 16px"><figure style="background:#fff0f0;width:44px;height:44px"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="#e71111" stroke-width="2.5" stroke-linecap="round"><line x1="6" y1="6" x2="18" y2="18"/><line x1="18" y1="6" x2="6" y2="18"/></svg></figure><strong style="font-size:15px">Failed</strong><p style="margin:0">We couldn’t verify you.</p></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#e7111114;color:#e71111">Error</span><code>.states--error</code><p>Explains the failure and offers a retry.</p></div></div><div class="dh-var" style="background:transparent"><div class="dh-var-stage"><span class="dh-pz-states" style="width:210px;padding:24px 16px"><figure style="background:#fff7eb;width:44px;height:44px"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="#ff9900" stroke-width="2.5" stroke-linecap="round"><path d="M12 9v4"/><path d="M12 17h.01"/></svg></figure><strong style="font-size:15px">Attention</strong><p style="margin:0">Something needs review.</p></span></div><div class="dh-var-meta"><span class="dh-var-pill" style="background:#ff990014;color:#ff9900">Warning</span><code>.states--warning</code><p>A recoverable issue that needs user attention.</p></div></div></div>

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--states-icon-success | Success icon background | Component
--states-icon-error | Error icon background | Component
--states-icon-loading | Spinner arc color | Component
--states-title | Title text color | Component
--states-sub | Supporting text color | Component
--states-gap | Vertical gap between items | Component
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/stepper`
- URL: https://developer.incode.com/design-and-ux/stepper/
- Markdown: https://developer.incode.com/design-and-ux/stepper.md

# Stepper

Steppers show users where they are in a multi-step verification flow. Each segment is in one of three states: done, active, or pending. Prizma steppers support 3 to 5 steps.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-stepper"><i class="is-active"></i><i class="is-active"></i><i></i><i></i></span></div>

Track segments fill with brand blue as steps complete; inactive segments stay light gray. Both colors are static tokens — they don’t change with the theme.

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--stepper-bar-done | Completed segment color | Component
--stepper-bar-active | Current segment color | Component
--stepper-bar-pending | Upcoming segment color | Component
--stepper-bar-height | Track bar height | Component
--stepper-gap | Gap between bars | Component
--radius-stepper | Bar corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/timer`
- URL: https://developer.incode.com/design-and-ux/timer/
- Markdown: https://developer.incode.com/design-and-ux/timer.md

# Timer

The Timer component displays a visible countdown before a biometric capture event. It prepares users for the moment of capture, reducing failed attempts caused by user unreadiness.

<div class="dh-rule"><span>Anatomy</span><i></i></div>

<div class="dh-stage"><span class="dh-pz-timer"><b>0:45</b></span></div>

The countdown ring drains as time passes. The component always renders dark-on-dark regardless of page mode — its surface, border, and text are static tokens.

<div class="dh-rule"><span>Tokens</span><i></i></div>

```dh-comp-tokens
--timer-surface | Cell background | Component
--timer-border | Cell border color | Component
--timer-text | Digit text color | Component
--timer-font-size | Digit font size | Component
--radius-timer | Cell corner radius | Semantic
```

> 📘 Component tokens
>
> The color tokens for this component live in [Color → Tokens](/design-and-ux/color/), and its spacing, radius, and type map to the shared foundation scales.

---

- Path: `design-and-ux/typography`
- URL: https://developer.incode.com/design-and-ux/typography/
- Markdown: https://developer.incode.com/design-and-ux/typography.md

# Typography

Two typefaces, one cohesive system. **Rethink Sans** for display and impactful headings. **DM Sans** for all UI text: body, labels, buttons, inputs. Every style maps to a token used identically in Figma and CSS.

<Tabs>
<Tab title="Overview">

<div class="dh-families"><div class="dh-family"><em>Display / Headings</em><div class="dh-family-sample" style="font-family:'Rethink Sans',ui-sans-serif,sans-serif;font-weight:800">Ag</div><strong>Rethink Sans</strong><span class="dh-family-weights">400 · 500 · 600 · 700 · 800</span><p>Used exclusively for Display and Headline categories. Brings personality and visual impact to large-scale text without sacrificing legibility at high weights.</p></div><div class="dh-family"><em>Body / UI</em><div class="dh-family-sample" style="font-family:'DM Sans',ui-sans-serif,sans-serif;font-weight:400">Ag</div><strong>DM Sans</strong><span class="dh-family-weights">400 · 500 · 600 · 700 · 800</span><p>The workhorse of the UI. Used for Body, Button, Label, Input, and Tooltip. Optimised for small sizes and high-density layouts — reads cleanly at 11px.</p></div></div>

```dh-principles
#006aff | Tokens, not raw values | Every type style is a named token. Font size, weight, and line-height are bundled — never set individually. Use the token, not the number.
#189f60 | Two families, strict roles | Rethink Sans is for impact. DM Sans is for function. Mixing them outside their designated categories breaks visual hierarchy.
#820ad1 | Weight is semantic | Weight within a type style is fixed by the token. Bold is reserved for headings and emphasis — don't apply it to body or label styles arbitrarily.
```

## Category roles

```dh-usage
Display | Rethink Sans | Hero headlines, onboarding titles, verification outcomes at large scale. | 
Headline | Rethink Sans | Section headers, modal titles, step titles within a flow. | 
Feedback | DM Sans | Real-time capture guidance shown over the camera. | 
Body | DM Sans | Paragraphs, descriptions, and supporting copy. | 
Button | DM Sans | Labels inside primary, secondary, and tertiary buttons. | 
Label / Link / Tooltip | DM Sans | Form labels, inline links, and tooltip copy. | 
```

</Tab>
<Tab title="Scale">

## Display

```dh-type-ramp
desc: Rethink Sans. Hero moments and top-level screen titles.
D1 | Rethink Sans | 80/84 | 800 | -1.5 | Verify identity
D2 | Rethink Sans | 48/50.4 | 800 | -0.5 | Verify identity
```

## Headline

```dh-type-ramp
desc: DM Sans. Section and card titles inside product surfaces.
H1 | DM Sans | 32/36.8 | 700 | -1.5 | Keep a neutral expression
H2 | DM Sans | 24/27.6 | 700 | -1 | Keep a neutral expression
H3 | DM Sans | 20/23 | 700 | -0.5 | Keep a neutral expression
H4 | DM Sans | 18/20.7 | 500 | -0.5 | Keep a neutral expression
H5 | DM Sans | 16/18.4 | 500 | -0.5 | Keep a neutral expression
```

## Feedback

```dh-type-ramp
desc: DM Sans. Real-time capture guidance shown over the camera.
L | DM Sans | 24/28.8 | 700 | -0.5 | Ensure good lighting
S | DM Sans | 18/21.6 | 500 | -0.5 | Ensure good lighting
```

## Body

```dh-type-ramp
desc: DM Sans. Paragraphs, descriptions, and supporting copy.
M Bold | DM Sans | 14/18.2 | 700 | 0
M Regular | DM Sans | 14/16.8 | 400 | 0
S Bold | DM Sans | 12/15.6 | 700 | 0
S Regular | DM Sans | 12/15.6 | 400 | 0
```

## Button

```dh-type-ramp
desc: DM Sans. Labels inside primary, secondary, and tertiary buttons.
M | DM Sans | 18/18 | 500 | 0 | Continue
M Underlined | DM Sans | 18/18 | 500 | 0 | Continue
S | DM Sans | 14/14 | 500 | -0.5 | Continue
```

## Label, Link and Tooltip

```dh-type-ramp
desc: DM Sans. Form labels, inline links, and tooltip copy.
Label M | DM Sans | 14/14 | 700 | 0 | Date of birth
Link M Bold | DM Sans | 14/17.5 | 700 | 0 | Learn more
Link M ExtraBold | DM Sans | 14/17.5 | 800 | 0 | Learn more
Link S Bold | DM Sans | 12/15.6 | 700 | -0.5 | Learn more
Link S Medium | DM Sans | 12/15.6 | 500 | 0 | Learn more
Tooltip M | DM Sans | 16/18.4 | 500 | -0.5 | Position your face in the frame
```

</Tab>
<Tab title="Usage">

```dh-usage
Display | D1–D2 | Reserved for hero surfaces and top-level screen titles; inside product UI, start hierarchies at Headline. | Onboarding hero, Success screens
Headline | H1–H5 | Section and card titles. Pick the level by hierarchy, not by the size you want — sizes follow the scale. | Screen titles, Card titles, Section headers
Feedback | L, S | Real-time guidance over the camera; L for the primary instruction, S for secondary hints. | Capture overlay, Liveness hints
Body | M, S | Paragraphs and supporting copy; Bold variants only for inline emphasis, never for headings. | Descriptions, Help text, Legal copy
Button | M, S | Button labels; M for standalone CTAs, S for compact and inline buttons. | Primary CTA, Secondary actions
Label / Link / Tooltip | M, S | Form labels, inline links, and tooltip copy — never re-purpose these for body text. | Form fields, Inline links, Tooltips
```

</Tab>
</Tabs>

---

- Path: `design-and-ux/upload-digital-id-customization`
- URL: https://developer.incode.com/design-and-ux/upload-digital-id-customization/
- Markdown: https://developer.incode.com/design-and-ux/upload-digital-id-customization.md

# Customization

This section outlines the elements you can customize within the Upload Digital ID module to match your brand while preserving Incode's core UX. It clarifies which areas are flexible, such as text, illustrations, and brand colors, and which elements remain fixed to ensure consistency, accessibility, and reliable document processing across platforms.

<br />

## Tutorial Screen

The Intro Screen prepares the user for the Upload Digital ID step, explains what type of document is required, and sets clear expectations before the user selects a file.


<Image src="https://developer.incode.com/assets/ec0d7d951948912f88c37ca1eb040f74.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized            | Notes                                                       |
| -------------------- | --------------------------------- | ----------------------------------------------------------- |
| **Text**             | Title, subtitle, descriptive line | Fully localizable; tone can be adapted to your brand voice. |
| **Illustration**     | Digital ID illustration           | Can be replaced or recolored using brand tokens.            |
| **Button**           | Label, color, radius              | Must follow platform guidelines.                            |
| **Background Color** | Screen background                 | Must maintain strong contrast with text and elements.       |
| **Brand Colors**     | Header text, accent color         | Uses brand tokens.                                          |
| **Footer**           | "Verified by Incode" line         | Optional but recommended for trust and product consistency. |

<br />

<br />

### Fixed Elements

| Element                            | Why it is fixed                                            |
| ---------------------------------- | ---------------------------------------------------------- |
| **File type requirement (PDF)**    | Required to ensure consistent document processing.         |
| **Component spacing & safe areas** | Required for device compatibility and visual stability.    |
| **Text hierarchy**                 | Optimized to communicate requirements clearly.             |
| **Close icon position**            | Standardized across all modules for consistent navigation. |
| **WCAG contrast requirements**     | Mandatory for accessibility and regulatory compliance.     |

<br />

<br />

### Token Refearence


<Image src="https://developer.incode.com/assets/d9dfdb2c0735cdaac1b4c2d48c4beda2.png" align="center" />


| UI Element            | Token                                                                       | Value   |
| --------------------- | --------------------------------------------------------------------------- | ------- |
| **Brand name**        | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Title text**        | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**     | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Button background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Footer text**       | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Footer icon**       | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Close icon**        | Icon/Neutral/0 Static → Color/Gray/0                                        | #FFFFFF |
| **Background**        | Surface/Neutral/0                                                           | #FFFFFF |

### Design Notes

- Keep instructions clear and specific about the required file type and format.
- The illustration should reinforce what document the user needs to locate before proceeding.
- Ensure tap targets meet accessibility guidelines.ns.

<br />

***

## Review Document Screen

The Review Document Screen allows the user to confirm they have selected the correct file before proceeding. It displays a preview of the uploaded PDF and the filename, with options to continue or replace the file.


<Image src="https://developer.incode.com/assets/2279f13e22519f03453ed7e42405025b.png" align="center" />


<br />

### Customizable Elements

| Area                      | What can be customized               | Notes                                                  |
| ------------------------- | ------------------------------------ | ------------------------------------------------------ |
| **Text**                  | Title, subtitle, confirmation prompt | Fully localizable.                                     |
| **Button — Continue**     | Label, color, radius                 | Must follow platform guidelines.                       |
| **Button — Replace file** | Label, color, radius                 | Must remain visually distinct from the primary action. |
| **Background Color**      | Screen background                    | Must maintain contrast with preview and text.          |
| **Brand Colors**          | Header text, accent color            | Uses brand tokens.                                     |
| **Footer**                | "Verified by Incode" line            | Optional but recommended.                              |

<br />

### Fixed Elements

| Element                        | Why it is fixed                                              |
| ------------------------------ | ------------------------------------------------------------ |
| **Document preview**           | Required so users can confirm the correct file was selected. |
| **Filename display**           | Provides essential reference for the user before submission. |
| **Button placement**           | Standardized across modules.                                 |
| **Close icon position**        | Standardized across all modules for consistent navigation.   |
| **WCAG contrast requirements** | Mandatory for accessibility and regulatory compliance.       |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/ade622cae1f9bfb216e6e7a28f6a67c5.png" align="center" />


| UI Element                       | Token                                                                       | Value   |
| -------------------------------- | --------------------------------------------------------------------------- | ------- |
| **Brand name**                   | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Title text**                   | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**                | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Filename text**                | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Button background (Continue)** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button text (Continue)**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Button text (Replace file)**   | Button/Secondary/Text/Default → Text/Accent/Brand → Color/Brand/500         | #006AFF |
| **Footer text**                  | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Footer icon**                  | Icon/Brand/500 Static → Color/Brand/500                                     | #006AFF |
| **Close icon**                   | Icon/Neutral/0 Static → Color/Gray/0                                        | #FFFFFF |
| **Background**                   | Surface/Neutral/0                                                           | #FFFFFF |

<br />

### Design Notes

- Keep messaging focused on helping the user confirm their selection.
- The Replace file button must remain clearly available so users can correct mistakes without friction.
- Maintain clear visual separation between the primary and secondary actions.

<br />

***

## Analyzing Screen

The Analyzing Screen is shown while the module processes the uploaded PDF and extracts identity data and QR code information. It keeps users informed during the operation with a progress indicator and a document preview.


<Image src="https://developer.incode.com/assets/d074235e184dcf5e0f15f9cbabe7a1bb.png" align="center" />


<br />

### Customizable Elements

| Area                         | What can be customized             | Notes                                          |
| ---------------------------- | ---------------------------------- | ---------------------------------------------- |
| **Title text**               | Processing message ("Analyzing..") | Fully localizable; should remain concise.      |
| **Progress indicator color** | Accent and background stroke       | Uses brand tokens; must remain visually clear. |
| **Document border color**    | Preview frame accent               | Uses status positive token.                    |
| **Background Color**         | Screen background                  | Must preserve readability and contrast.        |

<br />

<br />

### Fixed Elements

| Element                      | Why it is fixed                                               |
| ---------------------------- | ------------------------------------------------------------- |
| **Document preview**         | Provides visual continuity from the review step.              |
| **Processing flow timing**   | Linked to backend processing; cannot be shortened or skipped. |
| **Progress indicator style** | Standardized across SDK for performance and recognizability.  |
| **Spacing & safe areas**     | Required for device consistency.                              |
| **Minimum contrast**         | Required for accessibility and compliance.                    |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/b44e734a4ff028afe60470f3b745c68c.png" align="center" />


| UI Element                  | Token                                     | Value   |
| --------------------------- | ----------------------------------------- | ------- |
| **Progress bar accent**     | Icon/Status/Positive → Color/Positive/500 | #189F60 |
| **Progress bar background** | Surface/Neutral/100 → Color/Gray/100      | #EBECEF |
| **Title text**              | Text/Body/800 (Primary) → Color/Gray/800  | #262831 |
| **Document border**         | Icon/Status/Positive → Color/Positive/500 | #189F60 |
| **Background**              | Surface/Neutral/0                         | #FFFFFF |

<br />

### Design Notes

- Keep copy short to minimize cognitive load during the wait.
- Avoid adding imagery or additional UI elements that may distract from the processing state.
- The green border on the document preview reinforces that the file was accepted and is being processed.

<br />

***

## Success Screen

If the document is successfully processed and identity data extracted, the user moves into the Success state. This screen provides clear confirmation before they continue to the next step in the flow.


<Image src="https://developer.incode.com/assets/5e7cedf5febfc1c1240a3eed45c0de16.png" align="center" />


<br />

### Customizable Elements

| Area                      | What can be customized                      | Notes                                                    |
| ------------------------- | ------------------------------------------- | -------------------------------------------------------- |
| **Title text**            | Success message ("Successfully processed!") | Fully localizable.                                       |
| **Subtitle text**         | Supporting message ("Let's continue")       | Tone can match your brand voice.                         |
| **Status icon**           | Green checkmark                             | Can replace with custom success icon; must remain clear. |
| **Document border color** | Preview frame accent                        | Uses status positive token.                              |
| **Button**                | Label, color, radius                        | Must follow platform guidelines.                         |
| **Background color**      | Full-screen background                      | Keep high contrast with icon and text.                   |

<br />

### Fixed Elements

| Element                  | Why it is fixed                                           |
| ------------------------ | --------------------------------------------------------- |
| **Success logic**        | Must reflect actual backend validation; not customizable. |
| **Status color mapping** | Green = positive; required for consistent semantics.      |
| **Icon placement**       | Ensures clarity and recognition.                          |
| **Button placement**     | Standardized across modules.                              |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/a07df30b7cfe53f44c8273c694672a87.png" align="center" />


| UI Element            | Token                                                                       | Value   |
| --------------------- | --------------------------------------------------------------------------- | ------- |
| **Document border**   | Border/Status/Positive/Static → Color/Positive/500                          | #189F60 |
| **Title text**        | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**     | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Button background** | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button text**       | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Background**        | Surface/Neutral/0                                                           | #FFFFFF |

<br />

### Design Notes

- Keep messaging short and reassuring; users should feel confident before proceeding.
- The green border and checkmark icon reinforce the positive outcome consistently.
- Ensure the button uses the brand 500 color to provide a clear next step with strong visual prominence.

<br />

***

## Error Screen

Error screens appear when the system cannot process the uploaded document. This screen informs the user that the file they uploaded is not a supported digital ID type and prompts them to try a different document. While text and styling can be branded, the error itself is fixed, as it reflects the outcome of the document validation and cannot be altered or removed.


<Image src="https://developer.incode.com/assets/a673ccf1cd431c02827882ca7eb06962.png" align="center" />


<br />

### Customizable Elements

| Area                 | What can be customized                    | Notes                                                            |
| -------------------- | ----------------------------------------- | ---------------------------------------------------------------- |
| **Title text**       | Error message ("ID type is not accepted") | Fully localizable; tone should be neutral and non-blaming.       |
| **Subtitle text**    | Supporting message                        | Fully localizable.                                               |
| **Status icon**      | Error indicator                           | Can be replaced; must remain clearly negative.                   |
| **Button**           | Label, color, radius                      | Action should guide the user to retry with the correct document. |
| **Background color** | Full screen                               | Must support strong contrast.                                    |

<br />

### Fixed Elements

| Element                  | Why it is fixed                                         |
| ------------------------ | ------------------------------------------------------- |
| **Error logic**          | Must accurately reflect the document validation result. |
| **Status color mapping** | Red = negative; required for clarity and consistency.   |
| **Title hierarchy**      | Emphasizes the issue clearly.                           |
| **Button placement**     | Consistent across modules.                              |

<br />

### Token Reference


<Image src="https://developer.incode.com/assets/1634459d9583ff9fdb162f18c36874d0.png" align="center" />


| UI Element                 | Token                                                                       | Value   |
| -------------------------- | --------------------------------------------------------------------------- | ------- |
| **Status icon background** | Icon/Status/Negative → Color/Negative/500                                   | #E71111 |
| **Icon (X mark)**          | Icon/Neutral/0 → Color/Gray/0                                               | #FFFFFF |
| **Title text**             | Text/Body/800 (Primary) → Color/Gray/800                                    | #262831 |
| **Subtitle text**          | Text/Body/500 (Secondary) → Color/Gray/500                                  | #60667C |
| **Button background**      | Button/Primary/Surface/Default → Surface/Brand/500 Static → Color/Brand/500 | #006AFF |
| **Button text**            | Button/Primary/Text/Default → Text/Body/0 Static → Color/Gray/0             | #FFFFFF |
| **Background**             | Surface/Neutral/0                                                           | #FFFFFF |

<br />

### Design Notes

- Error messaging should be clear, direct, and action-oriented.
- Avoid technical language; users should understand the issue at a glance.
- Maintain consistent spacing and visual hierarchy for readability.

<br />

---

- Path: `design-and-ux/upload-digital-id-customization-overview`
- URL: https://developer.incode.com/design-and-ux/upload-digital-id-customization-overview/
- Markdown: https://developer.incode.com/design-and-ux/upload-digital-id-customization-overview.md

# Upload Digital ID Customization Overview

<br />

## **Customization Overview**

Customization is significantly simple and consistent across module.


<Image src="https://developer.incode.com/assets/27cf991d7ba34ddc8533beeda063c92d.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

The customization system makes it easy to tailor the experience to your brand while maintaining consistency across the entire module.

Benefits include:

- Consistent branding across all screens and user flows
- Simplified customization with fewer settings to manage
- Faster implementation and reduced engineering effort
- Predictable visual and behavioral outcomes when making changes
- Clear separation between appearance and functional configuration
- Lower risk of introducing unintended UI or flow inconsistencies
- Centralized customization options that are easy to discover and maintain
- Flexible control over themes, colors, component styling, error states, and interaction patterns without impacting core functionality

This approach enables teams to create a branded, cohesive experience while keeping customization straightforward, scalable, and maintainable.

<br />

<br />

<br />

---

- Path: `design-and-ux/upload-digital-id-design`
- URL: https://developer.incode.com/design-and-ux/upload-digital-id-design/
- Markdown: https://developer.incode.com/design-and-ux/upload-digital-id-design.md

# Upload Digital ID

Upload Digital ID allows users to submit a government-issued digital identity document in PDF format as part of the verification flow. It extracts identity data and QR code information from the uploaded file, enabling verification without requiring a physical document capture.

Upload Digital ID typically occurs after the onboarding session is initiated and before the final verification result.

![](https://developer.incode.com/assets/abb40b60a91059b550707b125db8d1d3.gif)

<br />

***

## Where it fits in the flow

Upload Digital ID usually appears at the beginning of the document verification step, as an alternative to camera-based ID capture.

Once the user successfully uploads and confirms their digital ID, the flow continues to data extraction and any downstream verification logic required by the application.

***

## User Flow

The Upload Digital ID experience moves through several clear stages that guide the user from document selection to successful submission. The user is introduced to the process through an intro screen explaining what type of file is required. After selecting a PDF from their device, a review screen allows them to confirm the file before proceeding.

Once confirmed, the module processes the document and extracts the identity data and QR code. The user then receives a success state or an error message with options to retry before continuing to the next step.

<br />


<Image src="https://developer.incode.com/assets/8212ace9176a2e10bd42c391190d1402.png" align="center" />


<br />

***

## Full Flow Map

This diagram presents the full sequence of screens involved in Upload Digital ID, from the intro and file selection, to document review, processing, and final feedback.


<Image src="https://developer.incode.com/assets/ec672de13f2d4b882d5ab2bc0c8e6ae3.png" align="center" />


<br />

***

## Happy Path (Light & Dark)

The ideal user journey when the document is uploaded and processed successfully with no interruptions.

The happy path represents the smoothest version of the experience, where the user selects the correct PDF file, confirms the document on the review screen, and the system successfully extracts the identity data without requiring retries or corrections. Both light and dark mode previews are included so teams can validate visual consistency across themes.


<Image src="https://developer.incode.com/assets/fde5b804f0951fe17f8c987598b6a4bd.png" align="center" caption="Light mode" />


<br />


<Image src="https://developer.incode.com/assets/d87c4685b673a8e48c2062cfaaf46b44.png" align="center" caption="Dark mode" />


<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Upload Digital ID** experience.

**✅ Do**

- Keep instructions clear about the specific file type and format required.
- Display a document preview so users can confirm they selected the correct file.
- Provide clear error messages with actionable next steps when a file is rejected.
- Always offer a replace option so users can correct mistakes without restarting the flow.

**❌ Don’t**

- Don't accept file formats other than the supported PDF structure.
- Don't skip or reduce essential error states.
- Don't remove the file size limit feedback, as it helps users understand why a submission failed.

<br />

---

- Path: `design-and-ux/upload-digital-id-screens-and-states`
- URL: https://developer.incode.com/design-and-ux/upload-digital-id-screens-and-states/
- Markdown: https://developer.incode.com/design-and-ux/upload-digital-id-screens-and-states.md

# Screens & States

A complete view of all screens the user may encounter during the **Upload Digital ID** experience. Each state includes a brief description and a direct link to its source in Figma.

***

## Tutorial Screen

Introductory screen that prepares the user for the **Upload Digital ID** step. It displays an illustration of a government-issued digital ID and explains what type of file is required before the user proceeds to upload.


<Image src="https://developer.incode.com/assets/026e0bfb65a252f48e99066ed9358fbd.png" align="center" />


<br />

## Review Document

Shown after the user selects a PDF file from their device. Displays a preview of the uploaded document and its filename so the user can confirm it is the correct file before continuing. The user can either proceed or replace the file.


<Image src="https://developer.incode.com/assets/fafdce1f7aab2fab0f541ef517b08045.png" align="center" />


<br />

## Analyzing

Shown immediately after the user confirms their document. A progress indicator and a preview of the file are displayed while the module processes the PDF and extracts the identity data and QR code information.


<Image src="https://developer.incode.com/assets/013b57611eaa12b8ffafe865347d90c8.png" align="center" />


<br />

## Success

Shown when the document has been successfully processed and the identity data extracted. The user receives a clear visual confirmation and can proceed to the next step in the verification flow.


<Image src="https://developer.incode.com/assets/e8d8fd43935955c07295de86967704fb.png" align="center" />


<br />

## Error

Shown when the uploaded file does not correspond to a supported digital ID type. The user is informed and prompted to try uploading a different document.


<Image src="https://developer.incode.com/assets/cee4b600d471d1c7ea5e2700fb404149.png" align="center" />


<br />

---

- Path: `design-and-ux/upload-digital-id-specs-guidelines`
- URL: https://developer.incode.com/design-and-ux/upload-digital-id-specs-guidelines/
- Markdown: https://developer.incode.com/design-and-ux/upload-digital-id-specs-guidelines.md

# Specs & Guidelines

The **Upload Digital ID** module includes complete Figma specifications documenting spacing, layout rules, typography tokens, and language variants. These specs ensure consistency across platforms and allow localized versions of the UI to scale without breaking the layout.


<Image src="https://developer.incode.com/assets/97edfc50b6732c40fa958d4e299708be.png" align="center" />


<br />

**Open Screens Specs in&#x20;**<Anchor target="_blank" href="https://www.figma.com/design/wxFsHRvllern4VnjRqM4JO/Upload-Digital-ID---Latest-Design?node-id=16285-41282">Figma</Anchor>

<br />

***

## Responsiveness & Viewport Adaptation

The **Upload Digital ID** module is fully responsive and adapts seamlessly to a wide range of device sizes and aspect ratios. The layout is designed to remain consistent and predictable whether the user is on a small phone, large phone, foldable device, or tablet.


<Image src="https://developer.incode.com/assets/59ae00d60a93b99a73f67d513424a9b4.png" align="center" />


<br />

### How the layout adapts across devices

| Breakpoint                         | Behavior                                                                            |
| ---------------------------------- | ----------------------------------------------------------------------------------- |
| **Small phones (e.g., iPhone SE)** | UI elements adjust vertically; document preview scales down to maintain visibility. |
| **Standard phones (iPhone 12–16)** | Full layout shown; spacing and hierarchy remain consistent.                         |
| **Tall/narrow Android devices**    | Vertical spacing is redistributed; title and preview remain pinned to the top.      |
| **Foldables (e.g., Pixel Fold)**   | Larger preview and more balanced white space; content remains centered.             |
| **Tablets**                        | Increased layout margins; document preview scales proportionally.                   |
| **Desktop web**                    | Centered layout with controlled max-width; additional safe area padding.            |

<br />

### What is responsive (and customizable)

| Element                 | Responsive Behavior                                  | Customizable                   |
| ----------------------- | ---------------------------------------------------- | ------------------------------ |
| **Document preview**    | Scales proportionally by viewport height             | No                             |
| **Title text**          | Remains centered in the layout and pinned at the top | Yes, text is fully localizable |
| **Buttons**             | Width adjusts to container, vertical spacing adapts  | Color & text                   |
| **Footer / watermark**  | Pinned to bottom safe area                           | Optional                       |
| **Background surfaces** | Expand to full viewport                              | Yes                            |
| **Header area**         | Scales padding according to device safe insets       | Limited (color only)           |
| **Icons**               | Remain centered and maintain distance to the title   | Color & style                  |

<br />

### What remains fixed across breakpoints

| Element                      | Reason                                                 |
| ---------------------------- | ------------------------------------------------------ |
| **File processing logic**    | Must remain consistent for accurate data extraction.   |
| **Document preview content** | Automatically generated from the user's uploaded file. |
| **Minimum text size**        | Required for readability & WCAG compliance.            |
| **Minimum tap target sizes** | Ensures accessibility on mobile.                       |
| **Overall hierarchy**        | Prevents cognitive load at different sizes.            |

<br />

### Design Notes

- The document preview always remains a dominant visual element, regardless of screen size.
- Horizontal spacing is fluid; vertical spacing uses fixed-safe thresholds.
- Avoid adding custom UI above or below the module — it may break alignment.
- Multiline text is handled gracefully, but avoid extremely long localized strings.

<br />

<br />

***

## Desktop & Tablet Guidelines

The module is fully responsive and adapts gracefully to larger viewports. The Figma file includes guidelines for layout adjustments, safe areas, proportion scaling, and interaction differences between touch and pointer-based devices.


<Image src="https://developer.incode.com/assets/5b91948021fd6abf04828cbeaa0d3927.png" align="center" />


<br />

<br />

***

## Prototype & Transitions

**Upload Digital ID** includes predefined transition rules and micro-interactions that ensure a smooth user experience from document selection and review, through the analyzing state, to the success and error outcomes. Timing, easing, and animation guidelines are documented directly in Figma prototypes.


<Image src="https://developer.incode.com/assets/3f6a64b7bf5330f331c5c2e55e0d76ea.gif" align="center" />


<br />

<br />

***

## Localization

The **Upload Digital ID** module supports full localization and is designed to adapt to languages with different lengths, line breaks, and reading patterns. The Figma file includes examples for long, short, and multi-line translations to ensure layouts remain stable across regions.


<Image src="https://developer.incode.com/assets/209f486fa63071db8c44f44e33360fd4.png" align="center" />


<br />

**Key considerations:**

- All user-facing text is fully localizable.
- UI adjusts to prevent truncation and maintain readability.
- Spacing and vertical rhythm adapt to accommodate longer languages.
- Buttons and CTAs automatically expand to fit translated labels.
- Ensure localized strings preserve clarity and follow regulatory requirements when applicable.
- Incode supports a variety of languages.

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-adsign`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-adsign/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-adsign.md

# Advanced Signature V1 vs V2 Comparison

V1 delivers a basic Advanced Electronic Signature flow with limited guidance. The experience focuses on completing required steps—reviewing a document, selecting checkboxes, and continuing—without clearly explaining the significance of those actions.

V2 transforms the flow into a guided and trust-centered Advanced Electronic Signature experience. The interface introduces clearer structure and hierarchy, helping users understand what they are agreeing to and why it matters.

<Image align="center" caption="V1 is a basic Advanced signature experience with limited guidance." src="https://developer.incode.com/assets/3987dcfdc5e336dc96527dc6ce4ffe25.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded Advanced signature experience." src="https://developer.incode.com/assets/62c27b9d09a2020fef9818d73741ee55.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Signature experience       | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/7d49731e8bd4429703409bc67d348d83.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-certificate-issuance`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-certificate-issuance/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-certificate-issuance.md

# Certificate Issuance V1 vs V2 Comparison

V1 provides a basic Certificate Issuance experience with limited visibility into processing states and minimal customization options.

V2 enhances the Certificate Issuance experience with clearer progress and confirmation states, improved visual guidance, and full alignment with the token-based design system for a more consistent and branded workflow.


<Image src="https://developer.incode.com/assets/9e8efb88e964320b1f15ba25dcaa5f1a.jpg" align="center" caption="V1 is a basic watchlist experience with limited guidance." />


<br />


<Image src="https://developer.incode.com/assets/54c97025e5b3ecdf9b241e868d19b162.png" align="center" caption="V2 delivers a more structured, guided, and branded Watchlist for business experience." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities                       | V1 | V2 | Notes                                                                                                                            |
| ---------------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Certificate Issuance Functionality | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization Options              | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation Completeness         | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/b5773f66c3493b8259c6969883a2789f.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-ekyb`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ekyb/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ekyb.md

# eKYB V1 vs V2 Comparison

In V1, eKYB Verification presents a functional but generic credentials form experience. The screen focuses on collecting user information user information with standard input fields and minimal contextual structure. Processing and success state are simple and isolated, with little continuity between steps. The experience feels transactional, with basic feedback once the form is submitted.

In V2, eKYB Verification introduces a more structured, branded and guided experience. The interface is organized into clear sections, improving readability and reducing cognitive load. Processing and success states feel more cohesive with smoother visual transitions and clearer confirmation messaging making the flow feel complete and intentional.

<br />

<Image align="center" caption="V1 is a basic eKYB experience with limited guidance." src="https://developer.incode.com/assets/6b51571e3daf7e41fb65820c86425e46.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded eKYB experience." src="https://developer.incode.com/assets/579c0febb7e70283cb5ffc8841093b5f.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

<br />

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| eKYB data collection       | ✅  | ✅  | Core eKYB data capture supported in both versions.                                                                               |
| Inline validation          | ✅  | ✅  | Field-level validation during input available in both versions.                                                                  |
| Error States               | ✅  | ✅  | Both versions cover general error cases that users can encounter.                                                                |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior              | V1                            | V2                                                                | Notes                                                                          |
| --------------------- | ----------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| Feedback presentation | Brief contextual instructions | Clear, actionable feedback for a successful capture               | V2 has updated feedback instructions for users to correct their action faster. |
| State transitions     | Default transitions           | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior   | Static processing screen      | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/8643ac31e1e43d3e32a6b2e6178fbb22.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-ekyc`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ekyc/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ekyc.md

# eKYC V1 vs V2 Comparison

In V1, **eKYC** Verification presents a functional but generic credentials form experience. The screen focuses on collecting user information with standard input fields and minimal contextual structure. Processing and success states are simple and isolated, with little continuity between steps. The experience feels transactional, with basic feedback once the form is submitted.

In V2, **eKYC** Verification introduces a more structured, branded and guided experience. The interface is organized into clear sections, improving readability and reducing cognitive load. Processing and success states feel more cohesive with smoother visual transitions and clearer confirmation messaging, making the flow feel complete and intentional.

<Image align="center" caption="V1 is a basic eKYC experience with limited guidance." src="https://developer.incode.com/assets/160804e14fb3b3be1b09c85d4a136ab8.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded eKYC" src="https://developer.incode.com/assets/ef40220820bfed14342f82c20a80d825.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| eKYC exprience             | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/4ec9fee77ad1846c87f15613fa46aba9.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-esign`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-esign/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-esign.md

# Electronic Signature V1 vs V2 Comparison

In V1, the **Electronic Signature** experience presents a functional but generic capture flow. The screen focuses on collecting the user's signature with a basic canvas, minimal instruction text, and a simple "Continue" button. Processing and success states are simple and isolated, with little continuity between steps. The experience feels transactional, with basic feedback once the signature is submitted.

In V2, the **Electronic Signature** experience introduces a more structured, branded, and guided flow. The interface includes clearer instructional hierarchy, a "Verified by Incode" trust badge, and distinct visual states for the canvas, "Clear canvas" action, and "Done" button. Processing and success states feel more cohesive with smoother visual transitions and clearer confirmation messaging, making the flow feel complete and intentional.

<br />

<Image align="center" caption="V1 is a basic Electronic signature experience with limited guidance." src="https://developer.incode.com/assets/4b6b35a0cab11d08dd25f980252e0377.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded Electronic signature experience." src="https://developer.incode.com/assets/bb71586c6db1afd2132d1b54e1174ad1.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Signature experience       | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/cffd112cfe2ec21fc4ae9148af7e4957.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-forms`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-forms/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-forms.md

# Forms and Data Entry V1 vs V2 Comparison

V1 provides a basic custom fields capture experience, focused primarily on collecting additional user data — such as name, date of birth, or city — through simple form inputs with limited customization and visual feedback.

V2 redesigns the data entry flow for greater clarity, consistency, and customization — introducing improved field states, enhanced validation feedback, and full alignment with the token-based design system.

<Image align="center" caption="V1 is a basic Forms and data entry experience with limited guidance." src="https://developer.incode.com/assets/a38143714e73a23b1a3ed56b74640cc9.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded Advanced signature experience." src="https://developer.incode.com/assets/cc88b833b7d461315cb11e420f5361e1.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Forms experience           | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/df56626250d14ac8e2d7bb0e42b7c66a.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-ocr`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ocr/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-ocr.md

# OCR V1 vs V2 Comparison

V1 provides a basic OCR Review experience with limited review states, minimal guidance during data confirmation, and limited customization options.

V2 enhances the OCR Review experience with clearer review and processing states, improved editable and non-editable data handling, stronger visual guidance, and full alignment with the token-based design system for a more consistent and branded verification workflow.


<Image src="https://developer.incode.com/assets/73be1bcb408c0d83cd32ebcfab9445b0.png" align="center" caption="V1 is a basic OCR Review experience with limited guidance." />


<br />


<Image src="https://developer.incode.com/assets/210b5610abfd1938976744164c6239a1.png" align="center" caption="V2 delivers a more structured, guided, and branded OCR Review experience." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| OCR review Functionality   | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/42ed3679b54ad44e3979ea131405bc87.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-qsign`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-qsign/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-qsign.md

# Qualified Signature V1 vs V2 Comparison

<br />

V1 delivers a basic Qualified Electronic Signature flow with limited guidance. The experience focuses on completing required steps—reviewing a document, selecting checkboxes, and continuing—without clearly explaining the significance of those actions.

V2 transforms the flow into a guided and trust-centered Qualified Electronic Signature experience. The interface introduces clearer structure and hierarchy, helping users understand what they are agreeing to and why it matters.

<Image align="center" caption="V1 is a basic Qualified signature experience with limited guidance." src="https://developer.incode.com/assets/3987dcfdc5e336dc96527dc6ce4ffe25.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded Advanced signature experience." src="https://developer.incode.com/assets/62c27b9d09a2020fef9818d73741ee55.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Signature experience       | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/7d49731e8bd4429703409bc67d348d83.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-watchlist`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-watchlist/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-watchlist.md

# Watchlist V1 vs V2 Comparison

V1 provides a basic watchlist screening experience with minimal status feedback and limited customization.

V2 improves the watchlist screening experience with clearer processing and success states, better visual feedback, and alignment with the token-based design system.

<Image align="center" caption="V1 is a basic watchlist experience with limited guidance." src="https://developer.incode.com/assets/3c60905728ae73f75b55e12cebb85fcd.png" />

<br />

<Image align="center" caption="V2 delivers a more structured, guided, and branded Advanced signature experience." src="https://developer.incode.com/assets/b2375c9e2fdcb5003848974aa2682792.png" />

<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Watchlist Functionality    | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

<br />

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.

<Image align="center" caption="Customizing the experience to match your brand is simpler in V2" src="https://developer.incode.com/assets/f6e9653a4dca7b674eb0b2ab97dbad59.gif" />

<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

* Less engineering work to override UI elements
* Consistent branding across modules
* Predictable behavior when changing settings
* Reduced risk of breaking flows
* Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/v1-vs-v2-comparison-watchlist-business`
- URL: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-watchlist-business/
- Markdown: https://developer.incode.com/design-and-ux/v1-vs-v2-comparison-watchlist-business.md

# Watchlist for Business V1 vs V2 Comparison

V1 provides a basic Watchlist for Business screening experience with limited visibility into processing states and minimal customization options.

V2 enhances the Watchlist for Business experience with clearer verification and review states, improved visual guidance, and full alignment with the token-based design system for a more consistent and branded workflow.


<Image src="https://developer.incode.com/assets/fc300b1e2a6935252d5dd65d74bf8b22.png" align="center" caption="V1 is a basic watchlist experience with limited guidance." />


<br />


<Image src="https://developer.incode.com/assets/83b8c54b72e8a73b73b2700466f86ca6.png" align="center" caption="V2 delivers a more structured, guided, and branded Watchlist for business experience." />


<br />

***

<br />

## Feature Comparison

Functional capabilities of the module (objective features only; no UX or performance differences).

| Capabilities               | V1 | V2 | Notes                                                                                                                            |
| -------------------------- | -- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| Watchlist Functionality    | ✅  | ✅  | Core functionality present in both versions.                                                                                     |
| Customization options      | ❌  | ✅  | V1 provides limited customization options, while V2 allows full control over text, colors, buttons, illustrations, and behavior. |
| Documentation completeness | ❌  | ✅  | V2 provides complete, standardized documentation coverage.                                                                       |

<br />

***

<br />

## Behavior Differences

How the module behaves during runtime.

<br />

| Behavior            | V1                       | V2                                                                | Notes                                                                          |
| ------------------- | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| State transitions   | Default transitions      | Specifically designed screen-by-screen transitions for smoothness | V2 includes transition guidelines as part of the module documentation package. |
| Processing behavior | Static processing screen | Branded processing state with consistent loading behavior         | V2 aligns loading behavior with the overall system patterns                    |

<br />

***

## **Customization Overview**

Customization in V2 is significantly simpler and more consistent across modules.


<Image src="https://developer.incode.com/assets/a2ee582aaef5089bdc1174c52f6c7230.gif" align="center" caption="Customizing the experience to match your brand is simpler in V2" />


<br />

Instead of having isolated configuration options per screen or component, V2 uses a unified token-based system that allows developers to control visuals, behaviors, and experience patterns with fewer parameters and predictable outcomes.

This means:

- Less engineering work to override UI elements
- Consistent branding across modules
- Predictable behavior when changing settings
- Reduced risk of breaking flows
- Clear separation between visual tokens and experience configuration

V2 also centralizes all customization options under a single structure, so developers always know where to look and what they can modify.

<br />

<br />

---

- Path: `design-and-ux/watchlist-business-design`
- URL: https://developer.incode.com/design-and-ux/watchlist-business-design/
- Markdown: https://developer.incode.com/design-and-ux/watchlist-business-design.md

# Watchlist for Business

The **Watchlist for Business** module screens business entities against global sanctions lists, Politically Exposed Persons (PEPs), adverse media sources, and other compliance watchlists during onboarding and verification. It helps organizations identify potential compliance risks before account approval or activation.

<Image align="center" src="https://developer.incode.com/assets/9a31dd008a75ba267bd3bd9ec1312efe.gif" />

***

## Where it fits in the flow

The **Watchlist for Business** module is typically performed after the business information form has been completed and before onboarding is finalized. The screening process validates the submitted business data against global compliance databases to support AML and KYC requirements..

***

## User Flow

The **Watchlist for Business** experience follows a three-step flow.

<Image align="center" src="https://developer.incode.com/assets/27ebac1cd89b000ce13fc44ad013ea71.png" />

<br />

***

## Full Flow Map

<Image align="center" src="https://developer.incode.com/assets/9949cd3090ca6271ebb60861976c7cd3.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the business screening process completes successfully without interruptions, delays, or potential watchlist matches requiring additional review.

The **happy path** represents the smoothest version of the experience: the user submits the business name and country, the system performs automated screening against sanctions lists, Politically Exposed Persons (PEPs), adverse media sources, and compliance watchlists, and the verification completes successfully.

The experience follows a simple three-step flow: the business information form, the processing and screening state, and the successful verification result.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/ad1edcf68b7570ee4a6fffc6eb889ffa.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/991a5d3f2108da532ac4b5f493b69694.png" />

<br />

<br />

## Best Practices

Recommended guidelines for designing and implementing the **Watchlist for Business** experience.

✅ Do

* Clearly communicate that screening is in progress by displaying loading states and processing indicators during verification.
* Provide immediate visual feedback during watchlist screening to reassure users that the verification process is active.
* Display a clear success state once screening is completed successfully so users understand they can continue onboarding.

❌ Don't

* Don’t allow users to interrupt or resubmit the screening process while verification is still in progress.

---

- Path: `design-and-ux/watchlist-design`
- URL: https://developer.incode.com/design-and-ux/watchlist-design/
- Markdown: https://developer.incode.com/design-and-ux/watchlist-design.md

# Watchlist and Custom Watchlist

The **Watchlist** module checks customer identities against global sanctions lists, Politically Exposed Persons (PEPs), and other compliance watchlists during the onboarding and identity verification process.

<Image align="center" src="https://developer.incode.com/assets/5f22d7283f4e7cbde23d2931bdf3204f.gif" />

***

## Where it fits in the flow

The **Watchlist** module is typically performed after customer information has been collected and identity data is available for screening. It is positioned before onboarding completion or account approval to ensure the user is checked against sanctions lists, Politically Exposed Persons (PEPs), and other compliance watchlists as part of the risk evaluation process..

***

## User Flow

The **Watchlist** experience guides users through an automated compliance screening process that checks customer identities against sanctions lists, Politically Exposed Persons (PEPs), and other global watchlists before returning a final verification result..

<Image align="center" src="https://developer.incode.com/assets/775f661bfd4c54f701dae67c97e699e5.png" />

<br />

***

## Full Flow Map

<Image align="center" src="https://developer.incode.com/assets/dc302da8f78c6de36d2f8f2bb6358b51.png" />

<br />

***

## Happy Path (Light & Dark)

The ideal user journey occurs when the customer screening process completes successfully without interruptions, delays, or potential watchlist matches requiring additional review.

The **happy path** represents the smoothest version of the experience: the user submits their information, the system performs automated screening against sanctions lists, Politically Exposed Persons (PEPs), and compliance watchlists, and the verification completes successfully.

The user proceeds to the next step without encountering validation issues, manual review requirements, or blocking compliance matches. Light and dark mode previews are included to help teams validate visual consistency, accessibility, and contrast across themes and platforms.

<Image align="center" caption="Light mode" src="https://developer.incode.com/assets/ba2e196d7db3cf398205ca5d8e45e497.png" />

<Image align="center" caption="Dark mode" src="https://developer.incode.com/assets/b544c83a37bd23c7c06644c2b238370f.png" />

<br />

***

## Best Practices

Recommended guidelines for designing and implementing the **Watchlist**

✅ Do

* Clearly communicate that screening is in progress by displaying loading states and processing indicators during verification.
* Provide immediate visual feedback during watchlist screening to reassure users that the verification process is active.
* Use concise and user-friendly messaging to explain screening outcomes without exposing sensitive compliance logic.

❌ Don't

* Don’t allow users to interrupt or resubmit the screening process while verification is still in progress.
* Don’t expose internal compliance logic, risk rules, or watchlist matching criteria to end users.

---

- Path: `ecosystem-workforce/account-resets-recovery-with-okta-idv`
- URL: https://developer.incode.com/ecosystem-workforce/account-resets-recovery-with-okta-idv/
- Markdown: https://developer.incode.com/ecosystem-workforce/account-resets-recovery-with-okta-idv.md

# Account Resets & Recovery with Okta IDV Standard

You can use Incode identity verification (IDV) as the authentication method in Okta's Account Management Policy, enabling employees to recover access to their accounts through biometric and document verification instead of or in addition to traditional recovery factors.

This page covers configuring Okta to trigger an Incode IDV session during password reset and MFA recovery flows.

***

## Prerequisites

Ensure you have the following before you begin:

- [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/) setup page complete
- An Okta Identity Engine (OIE) instance
- An Okta administrator account with permissions to manage Authentication Policies and the Account Management Policy

***

## Understand IDV for Account Recovery

Okta's Account Management Policy controls what authentication factors a user must satisfy before completing a self-service recovery action such as a password or MFA reset. By adding Incode IDV as an allowed factor in this policy, Okta routes users through an Incode identity verification session before granting recovery access. When triggered:

1. The user initiates a password reset or MFA recovery from the Okta login page.
2. Okta evaluates the Account Management Policy and determines that Incode IDV is required.
3. Okta redirects the user to an Incode verification session.
4. The user completes the configured verification session on their mobile device. The Workflow you selected when configuring the [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/) integration determines the requirements of this session.
5. Incode returns a verification result to Okta.
6. On success, Okta allows the user to complete the recovery action.

***

## Set Up IDV for Account Recovery

### Confirm Incode IDV Is Configured in Okta

In your Okta instance, navigate to **Security** > **Identity Providers** and verify that the Incode IDV Standard integration appears in the list. If it is not yet configured, complete the [Incode IDV Integration with Okta](/ecosystem-workforce/okta-idv-standard/) setup page.

### Configure the Account Management Policy

1. Log in to your Okta Admin Console.
2. Navigate to **Security** > **Authentication Policies**.
3. Select **Account Management Policy**.
4. Add or edit a rule for the users or groups you want to require identity verification for recovery.
5. Under **Then**, set the authentication requirement to include **Incode IDV** as an allowed or required factor.
6. Click **Save**.

### Test the Recovery Flow

1. Go to your Okta organization's sign-in page.
2. Select **Forgot Password** or trigger an MFA recovery for a test user.
3. Confirm that Okta routes the user to an Incode verification session.
4. Complete the verification and confirm that Okta allows the recovery action to proceed.

<br />

---

- Path: `ecosystem-workforce/alloy`
- URL: https://developer.incode.com/ecosystem-workforce/alloy/
- Markdown: https://developer.incode.com/ecosystem-workforce/alloy.md

# Alloy

Alloy is a KYC- and fraud-decisioning middleware platform used by banks and fintechs to orchestrate identity checks at account opening and throughout the customer lifecycle.

In the Incode and Alloy integration, Incode is the document and biometric verification node inside an Alloy decision graph. When an applicant opens an account, Alloy routes them to Incode for ID capture and face match. Incode returns the verified result to Alloy, which combines it with additional data signals, such as bureau checks and watchlist screening, to make an automated decision: approve, decline, or review.

This integration is designed for US fintechs and digital banks using Alloy for identity orchestration. It adds biometric verification without replacing your existing decisioning infrastructure.

***

## Availability

This integration is available through the Incode OEM and MSP partner program. Alloy maintains a formal partner marketplace where Incode is listed as a verified identity verification connector.

To get started, contact your Incode Representative.

---

- Path: `ecosystem-workforce/ashby`
- URL: https://developer.incode.com/ecosystem-workforce/ashby/
- Markdown: https://developer.incode.com/ecosystem-workforce/ashby.md

# Ashby

This page covers integrating Incode identity verification into Ashby ATS. You can verify candidates at key stages to reduce fraud and meet compliance requirements.

***

## Candidate Journey

### Key Stages

1. **Application submission**: Candidate applies through Ashby.
2. **eKYC check**: Incode runs the candidate's phone number and email through its electronic Know Your Customer (eKYC) risk engine.
3. **Risk scoring and routing**: Candidates are routed based on their risk score:
   - **High risk**: Immediate identity verification through document and selfie capture.
   - **Medium risk**: Verification before recruiter and hiring manager interviews.
   - **Low risk**: Direct progression to interviews.
4. **Final verification**: Candidate completes a final identity check before the offer.
5. **Results sync**: Identity verification results—including status, risk score, and timestamp—are written back into Ashby, stored on the candidate's profile.

***

## Understand eKYC

eKYC (electronic Know Your Customer) is a digital identity verification process. It was developed for banking and compliance, but it applies equally to hiring.

For Ashby, eKYC:

- Uses candidate data— including email, phone, and IP/device signals—to detect risk.
- Checks for fraud history, synthetic identity patterns, and data mismatches.
- Returns a risk score—low, medium, or high—to guide the level of additional verification needed.

***

## Integration with Ashby Using Tines

This integration uses Tines, a powerful automation platform, to orchestrate the verification flow between Ashby and Incode.

> 📘 Note
>
> A prebuilt Tines story for this integration is coming soon.

### Example Flow

1. **Trigger**: A candidate submits an application in Ashby.
2. **Action**: Tines retrieves candidate data—name, email, and phone—through the Ashby API.
3. **Verification**: Tines sends the candidate an Incode verification link.
4. **Callback**: Incode returns verification results to Tines.
5. **Update**: Tines pushes the results back into Ashby.

***

## Step Up the Ashby Integration

### Prerequisites

- An Ashby ATS account with API access
- An Incode developer account
- A Tines workspace for automation orchestration

### Configure Ashby Webhooks

Set up a webhook in Ashby to trigger when a candidate is created or changes stage. Go to **Admin** > **Integrations** > **Webhooks** and configure the following:

- **Event**: `Application Submitted` and `Candidate Application Changed Stage`.

![](https://developer.incode.com/assets/ef28726d55ad22c0b159e934164c29f2.png)

<br />

- **Payload**: Candidate details, including name, email, and phone.
- **Destination**: Your Tines webhook URL.

### Configure Custom Candidate Fields

In Ashby, go to **Admin** > **Organization Setup** > **Custom Fields**. Under **Candidate**, create custom fields for the following Incode results:

- Phone Risk Score \[Incode]
- Email Risk Score \[Incode]
- First Name \[Incode]
- Last Name \[Incode]
- Verification Result \[Incode]
- Selfie Image \[Incode]

![](https://developer.incode.com/assets/f08c757cc022052cdc5909ead08be7f2.png)

<br />

### Built Tines Story

Import the Tines example story and do the following:

- Update credentials for your Ashby and Incode APIs.
- Add routing logic based on eKYC risk scoring.

### Connect to the Incode API

Use the Incode API to initiate and track identity verification. The following endpoints are available:

- `POST /ekyc/check`: Starts risk screening
- `POST /identity/verify`: Sends a document and selfie verification link
- `GET /identity/status/{id}`: Retrieves real-time verification results.

### Sync Results to Ashby

Use the Ashby API to push results, including custom fields such as `Verification Status` and `Risk Score`, back into candidate profiles. You can also configure Ashby automation rules to advance or hold candidates based on verification results.

***

## Example Use Cases

- **High-volume recruiting**: Automatically filter out fraudulent applications at scale.
- **Sensitive roles**: Enforce mandatory verification before final interviews.
- **Global compliance**: Meet KYC/AML requirements in hiring.

***

## What's Next

- Map your Ashby hiring stages to the verification checkpoints above.
- Import and adapt the Tines story (or other SOAR tool of choice) to Ashby.
- Test with sample candidates before rolling out to recruiters.

<br />

---

- Path: `ecosystem-workforce/auth0-post-login-action`
- URL: https://developer.incode.com/ecosystem-workforce/auth0-post-login-action/
- Markdown: https://developer.incode.com/ecosystem-workforce/auth0-post-login-action.md

# Auth0 Post-Login Action

You can integrate Incode identity verification (IDV) into your Auth0 tenant using a post-login Action. When a user logs in, they are redirected to Incode to complete identity verification. The results are stored in their Auth0 profile and included in the ID token.

This integration uses the Incode OIDC solution and Auth0 Actions. It supports on-the-fly identity creation, reverification periods, and face authentication for returning users.

***

## Prerequisites

Ensure you have the following before you begin:

- An Auth0 tenant with Actions enabled.
- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- An Incode OIDC Client ID and Client Secret—see [Find Integration Details](/dashboard-platform-administration/manage-integrations/#find-integration-details)​.
- Your Incode auth server URL (`https://auth.demo.incode.com` for demo, `https://auth.incode.com` for production).

***

## Integration Flow by Persona

- **First login (new user)**: The user is redirected to Incode for full identity verification—ID document capture, liveness detection, and face match. Results are stored in `app_metadata` and included in the ID token.
- **Returning user within the reverification window**: IDV is skipped. Existing verification claims are re-stamped onto the ID token.
- **Returning user requiring reverification**: The user is sent back to Incode. Their stored `incode_identity_id` is passed as the `login_hint`, enabling face authentication instead of full IDV.

***

## Set Up the Auth0 Integration

### Register the Auth0 Redirect URI in Dashboard

Before creating the Auth0 action, add Auth0's callback URL as an allowed redirect URI in your Incode OIDC integration.

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. From the Custom tab, open your **OIDC** integration.
4. Add the following as an allowed **Redirect URI**: `https://YOUR_AUTH0_DOMAIN/continue`.
5. Replace `YOUR_AUTH0_DOMAIN` with your Auth0 tenant domain: for example, `your-tenant.us.auth0.com`.

### Create the Post-Login Action in Auth0

1. In your Auth0 Dashboard, go to **Actions** > **Library**.
2. Click **Build Custom Action**.
3. Enter a name: for example, `Incode IDV`.
4. Select **Login/Post Login** as the trigger.
5. Click **Create**.
6. Paste the action code below into the editor, then click **Save Draft**.
   ```javascript
   /**
    * Auth0 Post-Login Action — Incode Identity Verification (OIDC)
    * Trigger: post-login
    */

   const DEFAULT_AUTH_SERVER = "https://auth.demo.incode.com";

   function needsVerification(event, reverificationHours) {
     const meta = event.user.app_metadata || {};
     if (!meta.incode_idv_completed) return true;
     const lastVerified = meta.incode_idv_completed_at;
     if (!lastVerified) return true;
     if (reverificationHours === 0) return false;
     const hoursSince = (Date.now() - new Date(lastVerified).getTime()) / 36e5;
     return hoursSince >= reverificationHours;
   }

   async function exchangeCodeForTokens(code, redirectUri, tokenEndpoint, event) {
     const body = new URLSearchParams({
       grant_type:    "authorization_code",
       code,
       redirect_uri:  redirectUri,
       client_id:     event.secrets.INCODE_CLIENT_ID,
       client_secret: event.secrets.INCODE_CLIENT_SECRET,
     });
     const resp = await fetch(tokenEndpoint, {
       method:  "POST",
       headers: { "Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json" },
       body: body.toString(),
     });
     if (!resp.ok) {
       const err = await resp.text();
       throw new Error(`Incode token exchange failed (${resp.status}): ${err}`);
     }
     return resp.json();
   }

   async function fetchUserInfo(accessToken, userInfoEndpoint) {
     const resp = await fetch(userInfoEndpoint, {
       headers: { Authorization: `Bearer ${accessToken}` },
     });
     if (!resp.ok) {
       const err = await resp.text();
       throw new Error(`Incode userinfo fetch failed (${resp.status}): ${err}`);
     }
     return resp.json();
   }

   exports.onExecutePostLogin = async (event, api) => {
     const authServer          = event.secrets.INCODE_SERVER_URL || DEFAULT_AUTH_SERVER;
     const authEndpoint        = `${authServer}/oauth2/authorize`;
     const reverificationHours = parseFloat(event.secrets.REVERIFICATION_HOURS || "720");
     const scopes              = event.secrets.SCOPES || "openid";
     const auth0Domain         = event.secrets.AUTH0_DOMAIN;
     const blockOnFailure      = (event.secrets.BLOCK_ON_FAILURE || "false").toLowerCase() === "true";

     if (!needsVerification(event, reverificationHours)) {
       const meta = event.user.app_metadata || {};
       if (meta.incode_idv) {
         api.idToken.setCustomClaim("https://incode.com/idv", meta.incode_idv);
       }
       return;
     }

     const redirectUri      = `https://${auth0Domain}/continue`;
     const storedIdentityId = (event.user.app_metadata || {}).incode_identity_id || null;
     const loginHint        = storedIdentityId || event.user.email || null;

     let sessionToken;
     try {
       sessionToken = api.redirect.encodeToken({
         secret:           event.secrets.REDIRECT_SECRET,
         expiresInSeconds: 3600,
         payload: { userId: event.user.user_id },
       });
     } catch (err) {
       console.error("[Incode IDV] encodeToken failed:", err.message);
       if (blockOnFailure) api.access.deny("identity_verification_failed");
       return;
     }

     const authParams = new URLSearchParams({
       response_type: "code",
       client_id:     event.secrets.INCODE_CLIENT_ID,
       redirect_uri:  redirectUri,
       scope:         scopes,
       state:         sessionToken,
       ...(loginHint ? { login_hint: loginHint } : {}),
     });

     api.redirect.sendUserTo(`${authEndpoint}?${authParams.toString()}`);
   };

   exports.onContinuePostLogin = async (event, api) => {
     const authServer       = event.secrets.INCODE_SERVER_URL || DEFAULT_AUTH_SERVER;
     const tokenEndpoint    = `${authServer}/oauth2/token`;
     const userInfoEndpoint = `${authServer}/userinfo`;
     const blockOnFailure   = (event.secrets.BLOCK_ON_FAILURE || "false").toLowerCase() === "true";
     const auth0Domain      = event.secrets.AUTH0_DOMAIN;
     const redirectUri      = `https://${auth0Domain}/continue`;

     const rawCode             = event.request?.query?.code;
     const rawError            = event.request?.query?.error;
     const rawErrorDescription = event.request?.query?.error_description;

     if (!rawCode) {
       console.error("[Incode IDV] No code returned. Error:", rawError, rawErrorDescription);
       api.user.setAppMetadata("incode_idv_completed", false);
       api.user.setAppMetadata("incode_idv_error", rawError
         ? `${rawError}: ${rawErrorDescription}`
         : "no_code_returned"
       );
       if (blockOnFailure) api.access.deny("identity_verification_failed");
       return;
     }

     let tokenResponse;
     try {
       tokenResponse = await exchangeCodeForTokens(rawCode, redirectUri, tokenEndpoint, event);
     } catch (err) {
       console.error("[Incode IDV] Token exchange error:", err.message);
       api.user.setAppMetadata("incode_idv_completed", false);
       api.user.setAppMetadata("incode_idv_error", err.message);
       if (blockOnFailure) api.access.deny("identity_verification_failed");
       return;
     }

     let userInfo = {};
     try {
       userInfo = await fetchUserInfo(tokenResponse.access_token, userInfoEndpoint);
     } catch (err) {
       console.warn("[Incode IDV] UserInfo fetch failed (non-fatal):", err.message);
     }

     let idTokenClaims = {};
     try {
       const idTokenPayload = tokenResponse.id_token.split(".")[1];
       idTokenClaims = JSON.parse(Buffer.from(idTokenPayload, "base64url").toString("utf8"));
     } catch (err) {
       console.warn("[Incode IDV] ID token parse failed (non-fatal):", err.message);
     }

     const now         = new Date().toISOString();
     const interviewId = idTokenClaims.interview_id || userInfo.interview_id || null;
     const identityId  = idTokenClaims.identity_id  || userInfo.identity_id  || userInfo.sub || null;

     const pii = {
       ...(userInfo.name         ? { name:         userInfo.name }         : {}),
       ...(userInfo.given_name   ? { given_name:   userInfo.given_name }   : {}),
       ...(userInfo.family_name  ? { family_name:  userInfo.family_name }  : {}),
       ...(userInfo.birthdate    ? { birthdate:    userInfo.birthdate }    : {}),
       ...(userInfo.email        ? { email:        userInfo.email }        : {}),
       ...(userInfo.phone_number ? { phone_number: userInfo.phone_number } : {}),
       ...(userInfo.address      ? { address:      userInfo.address }      : {}),
     };

     api.user.setAppMetadata("incode_idv", {
       id_token:            tokenResponse.id_token     || null,
       access_token:        tokenResponse.access_token || null,
       token_type:          tokenResponse.token_type   || null,
       expires_in:          tokenResponse.expires_in   || null,
       interview_id:        interviewId,
       identity_id:         identityId,
       auth_overall_score:  idTokenClaims.auth_overall_score  || null,
       auth_overall_status: idTokenClaims.auth_overall_status || null,
       pii,
       userinfo:            userInfo,
     });

     api.user.setAppMetadata("incode_idv_completed",    true);
     api.user.setAppMetadata("incode_idv_completed_at", now);
     api.user.setAppMetadata("incode_idv_error",        null);

     if (interviewId) api.user.setAppMetadata("incode_interview_id", interviewId);
     if (identityId)  api.user.setAppMetadata("incode_identity_id",  identityId);

     api.idToken.setCustomClaim("https://incode.com/idv", {
       completed:           true,
       completed_at:        now,
       interview_id:        interviewId,
       identity_id:         identityId,
       auth_overall_score:  idTokenClaims.auth_overall_score  || null,
       auth_overall_status: idTokenClaims.auth_overall_status || null,
       pii,
     });
   };
   ```

### Configure Action Secrets

In the Action editor, click the key icon in the left sidebar to open the Secrets panel. Add the following secrets:

<Table>
  <thead>
    <tr>
      <th>
        Secret key
      </th>

      <th>
        Description
      </th>

      <th>
        Example value
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `INCODE_CLIENT_ID`
      </td>

      <td>
        Your Incode OIDC Client ID
      </td>

      <td>
        `4cacb025...`
      </td>
    </tr>

    <tr>
      <td>
        `INCODE_CLIENT_SECRET`
      </td>

      <td>
        Your Incode OIDC Client Secret
      </td>

      <td>
        `your-secret`
      </td>
    </tr>

    <tr>
      <td>
        `INCODE_SERVER_URL`
      </td>

      <td>
        Incode auth server base URL
      </td>

      <td>
        Use `https://auth.demo.incode.com` for demo and `https://auth.incode.com` for production.
      </td>
    </tr>

    <tr>
      <td>
        `REDIRECT_SECRET`
      </td>

      <td>
        Random 32+ character string for signing session tokens
      </td>

      <td>
        Run the following in your browser console to generate a secure random value:

        ```javascript
        crypto.getRandomValues(new Uint8Array(32)).reduce((a,b) => a + b.toString(16).padStart(2,'0'), '')
        ```
      </td>
    </tr>

    <tr>
      <td>
        `AUTH0_DOMAIN`
      </td>

      <td>
        Your Auth0 tenant domain
      </td>

      <td>
        `your-tenant.us.auth0.com`
      </td>
    </tr>

    <tr>
      <td>
        `REVERIFICATION_HOURS`
      </td>

      <td>
        Hours between re-verifications (`0` = never re-verify)
      </td>

      <td>
        `720`
      </td>
    </tr>

    <tr>
      <td>
        `SCOPES`
      </td>

      <td>
        Space-separated OIDC scopes
      </td>

      <td>
        `openid`
      </td>
    </tr>

    <tr>
      <td>
        `BLOCK_ON_FAILURE`
      </td>

      <td>
        Set to `true` to deny login if IDV fails
      </td>

      <td>
        `true` or `false`
      </td>
    </tr>
  </tbody>
</Table>

### Deploy the Action

After adding all secrets, click **Deploy** in the top right corner of the Action editor. Saving the draft alone is not sufficient; the Action must be deployed before it will run.

### Attach the Action to the Login Flow

1. In the Auth0 Dashboard, go to **Actions** > **Triggers**.
2. Click **post-login**.
3. In the right sidebar under **Custom**, find your `Incode IDV` action.
4. Drag it into the pipeline between **Start** and **Complete**.
5. Click **Apply** to save the flow.

***

## Stored Data

After a successful verification, the following is written to the user's `app_metadata` in Auth0:

```json
{
  "incode_idv_completed": true,
  "incode_idv_completed_at": "2026-04-07T17:28:25.150Z",
  "incode_interview_id": "69d53e7a...",
  "incode_identity_id": "69d52eca...",
  "incode_idv": {
    "interview_id": "69d53e7a...",
    "identity_id": "69d52eca...",
    "auth_overall_score": "100.0",
    "auth_overall_status": "OK",
    "pii": {},
    "userinfo": { "sub": "69d53e7a..." }
  }
}
```

The following custom claim is also added to the Auth0 ID token under the `https://incode.com/idv` namespace:

```json
{
  "completed": true,
  "completed_at": "2026-04-07T17:28:25.150Z",
  "interview_id": "69d53e7a...",
  "identity_id": "69d52eca...",
  "auth_overall_score": "100.0",
  "auth_overall_status": "OK"
}
```

***

## Reverification Period

The `REVERIFICATION_HOURS` secret controls how often users must re-verify.

| Value  | Behavior                                      |
| ------ | --------------------------------------------- |
| `0`    | Never re-verify after completing once         |
| `24`   | Re-verify every 24 hours                      |
| `720`  | Re-verify every 30 days (recommended default) |
| `8760` | Re-verify once per year                       |

***

## PII Claims

By default, the `openid` scope returns only basic identity identifiers. To receive personally identifiable information (PII) such as name, date of birth, email, and address, contact your Incode Representative to enable additional scopes on your OIDC client, then update the `SCOPES` secret accordingly.

| Scope                | Data returned                           |
| -------------------- | --------------------------------------- |
| `profile`            | Name, date of birth                     |
| `email`              | Email address                           |
| `phone`              | Phone number                            |
| `address`            | Physical address                        |
| `id_attestation`     | ID document data                        |
| `identity_assurance` | Assurance level and verification status |

Example `SCOPES` value with additional scopes enabled:

```
openid profile email id_attestation
```

***

## Troubleshooting

### **IDV Is Skipped for a User I Expect to be Re-Verified**

The user has completed IDV and is within the reverification window. To force re-verification for testing, set `REVERIFICATION_HOURS` to a small value like `1`, or clear `incode_idv_completed` and `incode_idv_completed_at` from the user's `app_metadata` in **Auth0 Dashboard > User Management > Users**.

### **Error:&#x20;**`invalid_scope`

The scope you are requesting is not enabled on your Incode OIDC client. Revert `SCOPES` to `openid` and contact your Incode Representative to enable additional scopes.

### **Error:&#x20;**`invalid_client`

The `INCODE_CLIENT_ID` or `INCODE_CLIENT_SECRET` does not match what is registered in Incode, or `INCODE_SERVER_URL` is pointing to the wrong environment. Verify your credentials in Dashboard and confirm you are using the correct server URL.

### **Error:&#x20;**`identity_verification_failed`

Incode returned an error during the authorization or token exchange step. Check the Auth0 action logs under **Monitoring > Logs** for the specific error. Common causes are an expired authorization code (codes are single-use and expire in approximately 60 seconds) or a redirect URI mismatch.

### **Error:&#x20;**`no_code_returned`

Incode did not return an authorization code. The IDV session may have failed or the user abandoned the flow. If `BLOCK_ON_FAILURE` is `true`, the user is denied login. Check the `incode_idv_error` field in `app_metadata` for the specific error.

***

## OIDC Endpoints Reference

| Endpoint      | Demo                                                            | Production                                                 |
| ------------- | --------------------------------------------------------------- | ---------------------------------------------------------- |
| Authorization | `https://auth.demo.incode.com/oauth2/authorize`                 | `https://auth.incode.com/oauth2/authorize`                 |
| Token         | `https://auth.demo.incode.com/oauth2/token`                     | `https://auth.incode.com/oauth2/token`                     |
| UserInfo      | `https://auth.demo.incode.com/userinfo`                         | `https://auth.incode.com/userinfo`                         |
| JWKS          | `https://auth.demo.incode.com/oauth2/jwks`                      | `https://auth.incode.com/oauth2/jwks`                      |
| Discovery     | `https://auth.demo.incode.com/.well-known/openid-configuration` | `https://auth.incode.com/.well-known/openid-configuration` |

<br />

---

- Path: `ecosystem-workforce/authentication-strengths-conditional-access-with-entra-eam`
- URL: https://developer.incode.com/ecosystem-workforce/authentication-strengths-conditional-access-with-entra-eam/
- Markdown: https://developer.incode.com/ecosystem-workforce/authentication-strengths-conditional-access-with-entra-eam.md

# Authentication Strengths & Conditional Access with Entra EAM

This page covers using Microsoft Entra ID's Authentication Strengths and Conditional Access policies together with Incode EAM. Authentication Strengths define the assurance level required for a given access scenario. Conditional Access policies enforce those requirements based on conditions like user, app, location, or risk. When Incode EAM is configured as a Federated Multifactor method, it can satisfy Authentication Strength requirements directly.

***

## Prerequisites

Ensure you have the following before you begin:

- [Microsoft Entra EAM](/ecosystem-workforce/microsoft-entra-eam/) setup complete
- A Microsoft Entra administrator account with permissions to manage Authentication Methods and Conditional Access policies
- A Microsoft Entra ID P1 or P2 subscription

***

## Understand How It Works

Microsoft Entra Authentication Strengths define a set of allowed authentication method combinations at a given assurance level. By creating a custom Authentication Strength that includes Federated Multifactor, which covers external authentication methods like Incode EAM, you can then reference that strength in a Conditional Access policy. When a user triggers that policy, Entra requires them to satisfy the Authentication Strength, routing them to Incode for verification.

***

## Set Up Authentication Strengths and Conditional Access

### Create an Authentication Strength

1. Log in to your Microsoft Entra Admin Center as an administrator.
2. Go to **Authentication Methods** > **Authentication Strengths**.
3. Click **New Authentication Strength**.
4. Enter a unique name.
5. Under **Multifactor Authentication**, select **Federated Multifactor**.
6. Click **Next**, then **Create**.

### Create a Conditional Access Policy

1. Go to **Conditional Access** > **Policies**.
2. Click **New Policy** and enter a unique name.
3. Configure the policy:
   - **Users:** Select the users or groups this policy applies to.
   - **Conditions:** Define when the policy triggers—by app, location, risk level, etc. See [Microsoft's Conditional Access conditions documentation](https://learn.microsoft.com/en-us/entra/identity/conditional-access/concept-conditional-access-conditions) for details.
   - **Grant:** Select **Grant access** and then **Require Authentication Strength**.
   - Select the Authentication Strength created in the previous steps.
4. Click **Select**, then **Create**.

***

## Test the Integration

1. Go to a Microsoft application that meets your configured conditions.
2. Sign in with an Entra account in the target group.
3. After entering your password, confirm you are redirected to Incode to complete identity verification.
4. Complete verification and confirm access is granted.

<br />

---

- Path: `ecosystem-workforce/banking-and-fintech-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/banking-and-fintech-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/banking-and-fintech-integrations.md

# Banking and Fintech Integrations

Banking and fintech integrations embed Incode identity verification directly into core banking platforms, digital account opening workflows, and lending origination systems. They are designed for financial institutions that need to satisfy Know Your Customer (KYC), Customer Identification Program (CIP), and Anti-Money Laundering (AML) requirements as part of a fully digital onboarding experience without requiring applicants to complete verification outside the banking platform.

When a new applicant submits an account opening request or a loan application, the banking platform triggers an Incode verification session. The applicant scans their government-issued ID and completes a liveness check on their mobile device. The result is returned to the banking platform to gate credit decisioning, account activation, or
compliance recordkeeping.

> 📘 **Note**
>
> Banking and fintech platform integrations are on the Incode roadmap. If you are a financial institution or fintech looking to integrate Incode with your core banking platform, contact your Incode Representative to<br />discuss your use case and timeline.

***

## Platforms on the Roadmap

The following platforms are planned for integration:

| Platform            | Use case                                                                                                            |
| ------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Mambu               | KYC verification at loan origination and account opening for fintech lenders and embedded finance providers         |
| Apiture             | CIP-compliant identity verification for community banks and credit unions during digital account opening            |
| FIS / Worldpay      | Automated IDV as part of digital account opening and KYC refresh cycles for tier-one banks                          |
| Temenos             | Mobile-first KYC for digital challenger banks and neobanks built on Temenos Transact or Infinity                    |
| nCino               | Identity verification of business owners and signatories as part of KYB and AML workflows for commercial banks      |
| Sopra Banking Suite | Payment Services Directive 2 (PSD2) strong customer authentication and AML onboarding compliance for European banks |

<br />

---

- Path: `ecosystem-workforce/ciam-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/ciam-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/ciam-integrations.md

# CIAM Integrations

Customer Identity and Access Management (CIAM) integrations add Incode identity verification as a step within your customer-facing authentication flows. They are designed for use cases where verifying the identity of a customer, not an employee, is required as part of sign-up, login, or a sensitive transaction.

You can embed Incode IDV directly into the authentication platform your application already uses. The verified result is returned to the CIAM platform and can be used to gate access, populate user profile attributes, or trigger downstream compliance workflows.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available CIAM Integrations

<CIAMIntegrations />

<Component slug="ciam-integrations-table" />

---

- Path: `ecosystem-workforce/configure-claims-matching-with-okta-idv-standard`
- URL: https://developer.incode.com/ecosystem-workforce/configure-claims-matching-with-okta-idv-standard/
- Markdown: https://developer.incode.com/ecosystem-workforce/configure-claims-matching-with-okta-idv-standard.md

# Configure Claims Matching with Okta IDV Standard

When using Incode IDV with Okta, claims matching verifies that the person completing an identity verification session is the same person on record in your Okta directory. Okta sends the claims it wants Incode to validate as part of the authentication request, and Incode matches those claims against the verified data from the user's ID.

This page covers how claims matching works with the [Okta IDV Standard integration](/ecosystem-workforce/okta-idv-standard/) and how to configure it.

***

## Prerequisites

Ensure you have the following before you begin:

- [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/) setup page complete.
- Claims Matching module enabled in Dashboard for your organization. Contact your Incode Representative if you do not see this module in Workflows.

***

## Understand Claims Matching with Okta IDV

When a user is routed through an Incode verification session via the Okta IDV Standard integration, Okta sends a Pushed Authorization Request (PAR) to Incode. This request includes the claims Okta wants validated and the matching logic for each claim.

Incode receives these claims and evaluates them against the identity data captured during the verification session: OCR data from the user's government-issued ID, selfie liveness result, and any other modules included in the linked Workflow.

### **Matching Strictness**

Okta controls the matching strictness for each claim via the PAR request:

- **Exact matching**: The attribute value from the verified ID must match the directory record precisely. Recommended for fields such as date of birth and document number.
- **Fuzzy matching**: Allows for minor variations such as name abbreviations, hyphenation differences, or OCR normalization. Recommended for name fields where formatting may vary across documents.

***

## Set Up Claims Matching with Okta IDV

### Add Claims Matching Module to Workflow

1. In the left menu, click **Workflows**.
2. Open the Workflow linked to your Okta IDV Standard integration.
3. From the **Processes** menu, add **Claims Matching** to the Workflow.
4. Click the three dots > **Edit** to open the module configuration.
5. Ensure **External Policy** is selected. This setting instructs Incode to use the claims and matching logic sent by Okta in the PAR request, rather than a locally defined policy.
6. Click **Save Configurations** on the Claims Matching module, then **Save & Publish** for the Workflow.

> ⚠️ **Note**
>
> Do not select **Module Defined Policy** for Okta IDV Standard integrations. That setting is used for non-Okta flows where Incode defines the claims policy locally. For Okta, the claims are always controlled by Okta via the PAR request.

### Configure Claims in Okta

Claims sent to Incode are configured on the Okta side as part of your Okta IDV Standard integration settings. Refer to Okta's documentation on Identity Verification claims for details on which attributes can be sent and how to configure matching strictness per claim.

***

## Review Claims Manually

If a session's claims cannot be automatically matched, the session is routed to manual review. This may occur when data does not match within the strictness level configured in Okta: for example, a name on the ID differs significantly from the directory record. To review flagged sessions:

1. In the left menu, click **Sessions**.
2. Filter by **Pending review**.
3. Open the session and review the claims match result alongside the captured ID and selfie.
4. Click **Approve** or **Reject** and add a note for audit purposes.

***

## What's Next

- Account resets & recovery
- Passwordless sign-in with Okta IDV
- [Incode IDP integration with Okta](/ecosystem-workforce/okta-idp/)

<br />

---

- Path: `ecosystem-workforce/configure-entra-self-service-to-redirect-to-incode-verification`
- URL: https://developer.incode.com/ecosystem-workforce/configure-entra-self-service-to-redirect-to-incode-verification/
- Markdown: https://developer.incode.com/ecosystem-workforce/configure-entra-self-service-to-redirect-to-incode-verification.md

# Configure Entra Self-Service to Redirect to Incode Verification

By default, Microsoft Entra's **Forgot Password** link on the sign-in page initiates Entra's native Self-Service Password Reset (SSPR) flow. This page covers how to redirect that link to the Incode Self-Service Portal instead, routing employees through biometric identity verification before they can reset their password or MFA credentials.

This is useful when you want Incode to be the gating mechanism for all password and MFA resets, rather than relying solely on Entra's native recovery options.

***

## Prerequisites

Ensure you have the following before you begin:

- A Microsoft Entra administrator account with permissions to manage company branding and SSPR settings
- The Incode **Self-Serve Portal** integration configured and the portal URL available. See [Self-Serve Portal](/ecosystem-workforce/self-serve-portal/).
- The **Microsoft Entra Directory Sync** integration active so Incode can look up users by email. See [Microsoft Entra Directory](/ecosystem-workforce/microsoft-entra-directory/).

***

## Set Up Redirect Forgot Password to Incode

### Retrieve Your Self-Serve Portal URL

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click the Custom tab and open your **Self-Serve Portal** integration.
4. Copy the portal URL.

### Configure a Custom SSPR Link in Microsoft Entra

1. Log in to your Microsoft Entra Admin Center as an administrator.
2. Go to **User Settings** or **Company Branding**, depending on your Entra configuration.
3. Locate the **Self-Service Password Reset** or **Custom Helpdesk Link** setting.
4. Paste your Incode Self-Serve Portal URL as the custom link.
5. Click **Save**.

Once configured, users who click **Forgot password** on the Entra sign-in page will be redirected to the Incode Self-Serve Portal, where they complete biometric verification before resetting their credentials.

---

- Path: `ecosystem-workforce/configure-incode-as-sso-provider-with-okta-idp`
- URL: https://developer.incode.com/ecosystem-workforce/configure-incode-as-sso-provider-with-okta-idp/
- Markdown: https://developer.incode.com/ecosystem-workforce/configure-incode-as-sso-provider-with-okta-idp.md

# Configure Incode as SSO Provider with Okta IDP

You can configure Incode as a Single Sign-On (SSO) provider for your Okta-connected applications, enabling users to authenticate with Incode biometric verification as their primary login method across your app portfolio.

This configuration builds on the [Okta IDP Integration](/ecosystem-workforce/okta-idp/) and assumes the OIDC identity provider and authenticator are already set up.

***

## Prerequisites

Ensure you have the following before you begin:

- [Okta Authenticator (Preview/OIE)](/ecosystem-workforce/okta-authenticator-previewoie/) or [Okta Authenticator (Classic)](/ecosystem-workforce/okta-authenticator-classic/) steps complete
- The Incode OIDC Identity Provider active in your Okta instance
- An Okta administrator account with permissions to manage Applications and Authentication Policies

***

## Understand SSO with Okta IDP

When configured as an SSO provider, Incode acts as the IDP for application sign-on. Users who attempt to access an Okta-connected application are routed to an Incode verification session instead of or in addition to the standard Okta login page. On successful verification, Incode issues a signed token that Okta uses to authenticate the user into the application.

This is typically used in combination with a passwordless authentication policy, where the Incode biometric factor replaces the password entirely.

***

## Set Up Incode as an SSO Provider

### Assign the Incode IDP to Applications

1. Log in to your Okta Admin Console.
2. Go to **Applications** and open the application you want to protect with Incode SSO.
3. Click the **Sign On** tab.
4. In the **Identity Provider** settings, select the Incode OIDC IDP you configured during the authenticator setup.
5. Click **Save**.

### Configure the Authentication Policy

1. Go to **Security** > **Authentication Policies**.
2. Select the policy assigned to the application or create a new one.
3. Add or edit a rule:
   - Assign the user group you want to use Incode SSO.
   - Set **User must authenticate with** to the Incode authenticator as the required factor.
   - You can set Password to **Optional** to enable a fully passwordless experience.
4. Click **Save**, then assign the policy to the application.

***

## Test the SSO Flow

Test the SSO flow for the application with a user in the configured group. Confirm that the login flow routes through Incode verification and that the user is successfully authenticated into the application.

---

- Path: `ecosystem-workforce/crm-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/crm-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/crm-integrations.md

# CRM Integrations

Customer Relationship Management (CRM) integrations connect Incode identity verification to the platforms your sales and operations teams use to manage customer relationships. They are designed for use cases where verifying a customer's identity is a required step before activating an account, completing a regulated transaction, or progressing through an onboarding workflow.

Verification is triggered directly from within the customer record and results are written back automatically.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available CRM Integrations

<CRMIntegrations />

<Component slug="crm-integrations-table" />

---

- Path: `ecosystem-workforce/custom-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/custom-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/custom-integrations.md

# Custom Integrations

Custom integrations connect Incode to any system that does not have a dedicated pre-built connector. They are designed for organizations that want to integrate identity verification into internal tools, custom-built applications, ticketing systems, automation pipelines, or any workflow that can be reached through API or standard authentication protocols.

All custom integration types follow the same data model and are managed from the Integrations page in Dashboard.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Integration Mechanisms

You must choose one of these mechanisms to build a custom integration:

- **OIDC**: Use the OIDC mechanism to connect any system that supports the OpenID Connect protocol. Incode acts as the identity provider, issuing a signed ID token after a successful verification session. This is the right choice for applications that already use OIDC for authentication.

> 📘 Note
>
> The OIDC integration type is also used under the hood by the Okta IDP Authenticator and similar IAM configurations. See [Incode IDP Integration with Okta](/ecosystem-workforce/okta-idp/) for details.

- **API**: Use the API mechanism to trigger identity verification sessions from any system using the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/). This is the most flexible option and works with anything that can make an HTTP request: ticketing systems, automation tools, custom applications, and more.




### Set Up an OIDC Integration

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the **Custom&#x20;**&#x74;ab, click **OIDC**, then click **Continue**.
5. Enter a **Name** for this integration. This name appears in analytics and identifies verifications completed through this integration.
6. Configure the **Redirect URI**. This is the endpoint in your system that Incode will redirect to after verification is complete.
7. **Select a Workflow for this Integration&#x20;**&#x66;rom the drop-down.
8. Click **Save**. A client ID and client secret are generated for your integration.

### Set Up an API Integration

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. From the **Custom** tab, click **API**, then click **Continue**.
4. Enter a **Name** for this integration. This name appears in analytics and identifies verifications completed through this integration.
5. Optionally, enter a **Redirect URL** to send users to after verification is complete.
6. **Select a Workflow for this Integration&#x20;**&#x66;rom the drop-down.
7. Click **Save**. An integration ID is generated for use in API requests.

**Use an API Integration**

1. Call the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/) with your Integration ID to generate a unique verification link for a user. The API returns a URL you can deliver via email, SMS, or embed in your system.
2. Share the verification URL with the user. The user clicks the link to begin the verification process.
3. Listen for webhook notifications at the endpoint configured in **Dashboard** > **Configuration** > **Webhooks**. The relevant events are `SESSION_STARTED`, `SESSION_SUCCEEDED`, `SESSION_FAILED`, and `SESSION_PENDING_REVIEW`. See [Session Webhooks](/general-reference/session-webhooks/) for full payload documentation.

### Client Credentials

A Client Credentials integration is created automatically for organizations with Integrations Ecosystem enabled. It appears under **Integrations** > **Custom** > **OIDC Client Credentials** and is used to authenticate API requests to Incode using OAuth 2.0. On first use, generate a client secret. It is shown only once, so store it securely. See [Find Integration Details](/dashboard-platform-administration/manage-integrations/#find-integration-details) for instructions.

***

## Available Purpose-Built Integrations

The following integrations are pre-configured use cases built on top of the OIDC or API mechanisms above. Each has its own setup page.

<CustomIntegrations />

<Component slug="custom-integrations-table" />

---

- Path: `ecosystem-workforce/cyberark`
- URL: https://developer.incode.com/ecosystem-workforce/cyberark/
- Markdown: https://developer.incode.com/ecosystem-workforce/cyberark.md

# CyberArk

> 📘 **Coming Soon**
>
> This integration is in development. Contact your Incode Representative for early access and timeline details.

CyberArk is a privileged access management and identity security platform used by enterprises to protect high-value accounts and detect identity-based threats.

The Incode and CyberArk integration will add biometric identity verification as a step-up authentication trigger within CyberArk's privileged access and identity threat detection workflows. When anomalous behavior is detected or a user requests access to a privileged account, CyberArk will trigger an Incode verification session to confirm the user's identity before access is granted.

<br />

---

- Path: `ecosystem-workforce/descope`
- URL: https://developer.incode.com/ecosystem-workforce/descope/
- Markdown: https://developer.incode.com/ecosystem-workforce/descope.md

# Descope

Descope is a drag-and-drop CIAM platform that lets developers build authentication and identity flows visually, without code. The Descope Incode Connector adds biometric identity verification as a native step inside any Descope flow, useful for sign-up, step-up authentication on high-risk events, or identity verification during account recovery.

The connector is published and maintained by Descope. It is available in the Descope console connector library.

***

## Use Cases

The integration supports the following use cases:

- Identity verification at customer sign-up
- Step-up verification for high-risk transactions or session events
- Identity confirmation during account recovery or password reset
- Compliance-driven IDV as part of a broader Descope authentication flow

***

## Integration Flow

1. When a user reaches an **Incode/Verify** step in a Descope flow, Descope redirects the user to Incode to complete the verification experience configured in your Incode Flow.&#x20;
2. After the user finishes, Incode redirects them back to the Descope flow and the connector response populates fields that Descope's flow builder can evaluate, including overall status and score.
3. You use a **condition step** immediately after the connector to branch the flow based on the verification result. For example:
   - Continue to sign-up completion if verification succeeded.
   - Route the user to manual review or reject if verification failed.

The following output fields are available to downstream flow steps:

- `connectors.incode_verify.status`
- `connectors.incode_verify.data.status`
- `connectors.incode_verify.data.score.overall.status`

***

## Prerequisites

Ensure you have the following before you begin:

- An active Descope account with access to the Descope console
- An Incode account with API access
- An Incode API key
- An Incode flow ID configured for your verification use case

***

## Set Up the Descope Integration

The full setup is documented in <Anchor target="_blank" href="https://docs.descope.com/connectors/connector-configuration-guides/kyc/incode">Descope's documentation</Anchor>​. The steps below provide a summary.

### Configure the Incode Connector in Descope

1. In the Descope console, open the **Connectors** page.
2. Select **Incode** from the list of available connectors.
3. Enter the following values:
   | Field                 | Value                                                               |
   | --------------------- | ------------------------------------------------------------------- |
   | Connector name        | A display name for this connector: for example, `Incode IDV Signup` |
   | Connector description | Optional description of the connector's purpose                     |
   | API Key               | Your Incode production API key                                      |
   | API URL               | The base URL of the Incode API                                      |
   | Flow ID               | The Incode flow ID to run when this connector is invoked            |

4) Click **Test** to validate the configuration.
5) Click **Create** to save.

### Add the Incode Connector to a Descope Flow

1. In the Descope console, open the **Flows** page.
2. Select an existing flow or create a new one.
3. Click the blue plus (+) icon inside the flow builder and select **Connector**.
4. Choose your configured Incode connector.

### Add a Condition Step to Handle the Result

Immediately after the Incode connector, add a **Condition** step. Use one of the connector output keys—for example<br />`connectors.incode_verify.data.score.overall.status`—to branch the flow based on whether verification succeeded, failed, or requires review.

***

## Descope Documentation

For detailed screenshots, flow examples, and troubleshooting, see <Anchor target="_blank" href="https://docs.descope.com/connectors/connector-configuration-guides/kyc/incode">Descope's connector configuration guide</Anchor>.

---

- Path: `ecosystem-workforce/directory-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/directory-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/directory-integrations.md

# Directory Integrations

Directory integrations connect Incode to your organization's user directory, syncing employee records so that Incode can look up users and perform claims matching during verification sessions.

When a directory integration is configured, Incode can locate a user by their `loginHint`—typically a corporate email address or employee ID—and match verified identity attributes from their government-issued ID against the data in your directory. This ensures that the person completing a verification is the same person on record.

Directory integrations do not require a linked Workflow and do not trigger verification sessions on their own. They supply the user data that other integration types—such as IAM, ITSM, and Custom—rely on when performing directory-backed lookups.

Directory integrations also populate the **Directory Information** page in Dashboard, which lists all synced users and their enrollment status.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Understand Directory Sync

After a directory integration is configured and connected:

1. **Incode pulls your user records** from the connected directory, Okta or Microsoft Entra, and stores the relevant identity attributes: name, email, employee ID, and any mapped claims fields.
2. **Records stay in sync**. User additions, updates, and deactivations in your directory are reflected in Incode automatically.
3. **A verification session starts**. Incode uses the `loginHint` to look up the user's directory record and supply their attributes to the claims matching module.
4. **Claims matching runs**. Verified attributes from the government-issued ID (name, date of birth, address, email, phone) are compared against the directory record. Mismatches can be configured to trigger a hard stop or a soft flag for manual review.

> 📘 Note
>
> Directory sync is a prerequisite for claims matching in IAM, ITSM, and Custom integration flows. Configure your directory integration before setting up dependent integration types.

***

## Available Directory Integrations

<Component slug="directory-integrations-table" />

<DirectoryIntegrations />

***

## Directory vs. IAM Integrations

Directory and IAM integrations both involve Okta and Microsoft Entra, but they serve different purposes:

- **Directory integrations** handle user data sync. They tell Incode who your users are and what attributes they have.
- **IAM integrations** handle authentication flows. They trigger verification sessions when a user signs in, resets credentials, or requires a higher-assurance check.

A directory integration is typically a prerequisite for IAM and other integration types that rely on claims matching. The<br />[IAM integrations](/ecosystem-workforce/iam-integrations/) page lists authentication-layer counterparts.

---

- Path: `ecosystem-workforce/e-commerce-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/e-commerce-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/e-commerce-integrations.md

# E-commerce Integrations

E-commerce integrations let you embed identity verification into your online store or marketplace. They are designed for use cases where confirming a buyer's age or identity is a required step before a purchase can be completed, such as regulated goods, age-restricted products, or high-value transactions.

These integrations embed the verification step directly into the checkout flow, keeping the experience on your storefront.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available E-commerce Integrations

<ECommerceIntegrations />

<Component slug="e-commerce-integrations-table" />

---

- Path: `ecosystem-workforce/equifax`
- URL: https://developer.incode.com/ecosystem-workforce/equifax/
- Markdown: https://developer.incode.com/ecosystem-workforce/equifax.md

# Equifax

Equifax provides identity and fraud products, including KOUNT and core credit bureau data, used by financial institutions and fintechs to assess identity risk during account opening and transaction monitoring.

In the Incode and Equifax integration, Incode is the biometric and document verification front end, with Equifax supplying back-end data verification covering:

- SSN validation
- Address history
- Fraud alerts
- Synthetic identity signals

The combined result gives lenders and banks a higher-confidence identity decision that satisfies both biometric and<br />data-based KYC requirements, addressing scenarios where a fraudster presents a real stolen identity with their own face.

***

## Availability

This integration is available through the Equifax developer portal and technology partner program. It is also available through the Incode OEM and MSP partner program. Contact your Incode Representative to get started.

---

- Path: `ecosystem-workforce/experian`
- URL: https://developer.incode.com/ecosystem-workforce/experian/
- Markdown: https://developer.incode.com/ecosystem-workforce/experian.md

# Experian

Experian CrossCore is an identity and fraud orchestration platform used by banks and fintechs during customer onboarding.

In the Incode and Experian integration, Incode is the biometric document capture and liveness detection layer within a CrossCore workflow. Experian supplies data-based identity corroboration, including name, address, and date of birth matching against credit bureau records, fraud watchlists, and device signals. Together, the two signals satisfy CIP<br />requirements more completely than either vendor alone, defending against both presentation attacks and synthetic identity fraud where real stolen personally identifiable information (PII) is paired with a fraudster's face.

***

## Availability

This integration is available through the Experian developer marketplace, where Incode is listed as a verified connector within CrossCore workflows. It is also available through the Incode OEM and MSP partner program. Contact your Incode Representative to get started.

---

- Path: `ecosystem-workforce/greenhouse`
- URL: https://developer.incode.com/ecosystem-workforce/greenhouse/
- Markdown: https://developer.incode.com/ecosystem-workforce/greenhouse.md

# Greenhouse

This page covers integrating Incode identity verification into the Greenhouse Applicant Tracking System (ATS). You can add verification steps directly to your hiring workflow to confirm candidate identity and reduce fraud.

***

## Candidate Journey

The diagram below shows where identity verification fits into the recruiting workflow:

![](https://developer.incode.com/assets/88a8e3bf23c09ab41f013e906fe7abe8.png)

<br />

### Key Stages

1. **Application submission**: Candidate applies through the job board.
2. **eKYC check**: Candidate's phone number and email trigger an Incode identity check. This is optional.
3. **Risk scoring**: Candidates are routed based on their eKYC risk score:
   - **High risk**: Immediate identity verification through document and selfie capture.
   - **Medium risk**: Verification before recruiter and hiring manager interviews.
   - **Low risk**: Direct progression to interviews.
4. **Final verification**: Candidate completes a final identity check before the offer or final interview.
5. **Results sync**: Results are written back into Greenhouse, updating the candidate profile.

***

## Understand eKYC

eKYC (electronic Know Your Customer) is a digital identity verification process. It was developed for banking and compliance, but it applies equally to hiring.

For Greenhouse, eKYC:

- Uses candidate data, such as their email address and phone number, to perform fraud checks.
- Checks for history of fraud, synthetic activity, mismatched identity data, lack of history, and so on.
- Returns a risk score—low, medium, or high—to guide the level of additional verification needed.

***

## Integration with Greenhouse Using Tines

This integration uses Tines, a powerful automation platform, to orchestrate the verification flow between Greenhouse and Incode. A prebuilt Tines story is available: [Verify Candidate Identity with Greenhouse and Incode](https://www.tines.com/library/stories/1325972/?name=verify-candidate-identity-with-greenhouse-and-incode)​.

### Example Flow

1. **Trigger**: A candidate submits an application in Greenhouse.
2. **Action**: Tines retrieves candidate data—name, email, and phone—through the Greenhouse API.
3. **Verification**: Tines sends the candidate an Incode verification link.
4. **Callback**: Incode returns verification results to Tines.
5. **Update**: Tines pushes the results back into Greenhouse, updating the candidate record.

Recruiters and hiring managers can see real-time verification status without leaving Greenhouse.

***

## Set Up the Greenhouse Integration

### Prerequisites

- A Greenhouse ATS account with API access
- An Incode developer account
- A Tines workspace for automation (or another automation platform)

### Configure Greenhouse Webhooks and Custom Fields

Set up a webhook in Greenhouse to trigger when a candidate is created or changes stage. Go to your <Anchor target="_blank" href="https://app4.greenhouse.io/configure/dev_center/web_hooks">Greenhouse webhook settings</Anchor> and configure the following:

- **Event**: Candidate has been created or has changed stage.
- **Payload**: Candidate details, including name, email, and phone.
- **Destination**: Your Tines webhook URL.

Add custom fields in Greenhouse for the results you want to map, such as `Verification Status` and `Risk Score`. See
[Greenhouse: Add or edit a custom candidate field](https://support.greenhouse.io/hc/en-us/articles/202609675-Add-or-edit-a-custom-candidate-field).

### Build Tines Story

Import the [Tines story](https://www.tines.com/library/stories/1325972/?name=verify-candidate-identity-with-greenhouse-and-incode) and do the following:

- Update credentials for your Greenhouse and Incode APIs.
- Define routing rules based on eKYC risk scoring.
- Run the Lookup Customer Fields action to retrieve the results.

### Connect to the Incode API

Use the Incode API to initiate and complete identity verification. The following endpoints are available:

- `POST /omni/externalVerification/ekyc`: Starts a risk check using email and phone.
- `POST /v1/workforce/verification/candidate/generate-verification-link`: Creates a URL for document and selfie verification.

### Sync Results to Greenhouse

Tines calls the Greenhouse API to update candidate profiles with verification results.

***

## Example Use Cases

- **High-volume hiring**: Automatically filter out fraudulent applications at scale.
- **Sensitive roles**: Enforce mandatory verification before final interviews.
- **Global workforce compliance**: Meet KYC/AML requirements in hiring.

***

## What's Next

- Work with your Incode Solutions Engineer to get your Incode API credentials.
- Import the [Tines story](https://www.tines.com/library/stories/1325972/?name=verify-candidate-identity-with-greenhouse-and-incode)​.
- Map your hiring journey to the verification checkpoints in the diagram.
- Deploy the automation in Tines and test with sample candidates.


[<Image src="https://img.youtube.com/vi/zBxfTJ2jWio/0.jpg" alt="Watch the demo" align="left" />](https://youtu.be/zBxfTJ2jWio?si=H_WfcEyNedR6ZNfb)


<br />

---

- Path: `ecosystem-workforce/helpdesk-verifications`
- URL: https://developer.incode.com/ecosystem-workforce/helpdesk-verifications/
- Markdown: https://developer.incode.com/ecosystem-workforce/helpdesk-verifications.md

# Helpdesk Verifications

The Helpdesk integration enables IT and support agents to initiate an identity verification session for an employee on demand before handling high-risk requests such as MFA resets, account unlocks, or access changes.

Instead of relying on knowledge-based authentication such as security questions, the agent sends the employee a verification link. The employee completes a biometric check, and the agent views the result directly in Dashboard before proceeding.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.

***

## Helpdesk Flow

### Agent-Initiated Flow

1. A support agent receives a high-risk request from an employee: for example, an MFA reset or account unlock.
2. The agent uses Dashboard or the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/) to send the employee a verification link.
3. The employee receives the link by email or SMS and completes identity verification on their device.
4. The agent views the verification result in Dashboard and proceeds accordingly.

### Trigger Verifications Through the API

To request a verification programmatically, use the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/) with the helpdesk integration's `integrationReference` value and the employee's `loginHint`.

```
POST {base-api-url}/omni/b2b/onboarding/request-new
```

Set `notification.type` to `EMAIL` or `SMS` to deliver the verification link directly to the employee.

***

## Set Up Helpdesk Verifications

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Locate the **Helpdesk** integration and open its configuration.
4. **Select a Workflow for this Integration&#x20;**&#x66;rom the drop-down.
5. Click **Save**. An integration reference ID is generated for triggering verification sessions through the API.

***

## View Verification Results

Completed verification sessions are found in Dashboard under the employee's Identity. Session outcomes are also available via [session webhooks](/general-reference/session-webhooks/).

---

- Path: `ecosystem-workforce/hr-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/hr-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/hr-integrations.md

# HR Integrations

HR integrations let you initiate identity verification from your human resources platform as part of hiring and onboarding. Use them for pre-employment and new-hire use cases where verifying a candidate's or new employee's legal identity is a required step before they can access company systems or complete onboarding.

These integrations trigger identity verification directly from the tools your HR and recruiting teams already use, instead of running it as a separate process.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available HR Integrations

<Component slug="hr-integrations-table" />

<HRIntegrations />

***

## Candidate Verification

For candidate-based use cases that don't require a direct ATS integration, you can use the [Custom API integration](/ecosystem-workforce/custom-integrations/) to trigger verification sessions programmatically via the [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/). This approach works with any system and doesn't require a pre-built connector.

<br />

---

- Path: `ecosystem-workforce/iam-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/iam-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/iam-integrations.md

# IAM Integrations

Identity and access management (IAM) integrations add Incode identity verification as a high-assurance step within your organization's identity and access management flows. They are used to trigger verification sessions during sign-in, account recovery, MFA reset, or any access event where confirming a user's identity is required.

Unlike [directory integrations](/ecosystem-workforce/directory-integrations/), which handle user data sync, IAM integrations are tied to a specific Workflow and are triggered by an authentication event in your identity provider.

Both Okta and Microsoft Entra appear in the IAM category, but their IAM integrations are separate from their directory integrations. A directory integration syncs user data; an IAM integration routes users through an Incode verification session during an auth flow. You can use both together.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***



## Available IAM Integrations

<Component slug="iam-integrations-table" />

<IAMIntegrations />

***

## Understand IAM Integrations

Each IAM integration links to a Workflow. When your identity provider triggers an identity verification event, Incode runs the associated Workflow and returns the result to the identity provider. Depending on the integration type, the result either allows or blocks the user from completing their IAM flow.

Claims matching is commonly used alongside IAM integrations to verify that the person completing the session matches the directory record associated with their account.

:::note
If your IAM integration will use claims matching, configure your [Okta Directory](/ecosystem-workforce/okta-directory/) or [Microsoft Entra Directory](/ecosystem-workforce/microsoft-entra-directory/)<br />integration first. Claims matching requires an active directory sync to function.
:::

---

- Path: `ecosystem-workforce/iga-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/iga-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/iga-integrations.md

# Identity Governance and Administration Integrations

Identity Governance and Administration (IGA) integrations connect Incode identity verification to your IGA platform, enabling identity proofing as part of provisioning, access certification, and lifecycle management workflows.

These integrations let your IGA platform confirm that the person requesting or being granted access is who they claim to be, using biometric verification against a government-issued ID.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available IGA Integrations

<IGAIntegrations />

<Component slug="identity-governance-and-administration-integrations-table" />

---

- Path: `ecosystem-workforce/integrations-ecosystem-overview`
- URL: https://developer.incode.com/ecosystem-workforce/
- Markdown: https://developer.incode.com/ecosystem-workforce.md

# Ecosystem (Workforce)

The Incode Platform connects with the tools your organization already uses, such as identity providers, directories, HR systems, ticketing platforms, and productivity apps. You can set up and configure these connections through a unified Integrations experience in Dashboard.

Each integration links an external system to an Incode Workflow and defines:

- **Which external system** is connecting, such as Okta, Microsoft Entra, or Slack.
- **Which Workflow** runs when that system triggers an identity verification session.
- **How the session is initiated**: automatically via directory sync, via API, or by a user action in a connected app.

Incode supports integrations across:

- Identity and access management (IAM)
- IT service management (ITSM)
- Human resources
- Recruitment
- Messaging
- Customer identity (CIAM)
- Identity governance (IGA)
- Identity threat detection (ITDR)
- E-commerce
- Custom API connections.

All integration types follow the same configuration model and are managed from the Integrations page in Dashboard.

***

## The Integrations Page

All integrations are created and managed from the Integrations page in Dashboard. To access it, click **Integrations** from the left menu.

:::note
The Integrations page is only visible when the Integrations Ecosystem feature is enabled for your organization. Contact your Incode Representative if you do not see it.
:::

From the Integrations page, you can:

- Browse all active integrations organized by category.
- Create new integrations.
- View and edit integration configuration.
- Access the **Integration Reference** ID used for API-triggered sessions.
- View a directory of all enrolled users associated with directory integrations.

Instructions for these tasks are described in [Manage Integrations](/dashboard-platform-administration/manage-integrations/). Create, update, and delete actions are recorded in the Audit Log.

***

## Verification Session Flow

Regardless of the integration type, every session follows the same end-to-end path:

1. **Trigger**: An event in the connected system—such as a service request, a sign-in attempt, a new hire record, or an API call—initiates a verification session through the integration.
2. **Session delivery**: Incode generates a one-time verification link and delivers it to the end user via SMS, email, or inline redirect, depending on the integration type.
3. **Verification**: The end user completes the configured Workflow on their device: document capture, liveness check, and any additional modules, such as claims matching or eKYC.
4. **Result**: Incode posts the outcome—pass, fail, or pending review—back to the originating system via webhook or API response. The result includes risk score, verification status, and matched identity attributes.
5. **Action**: The connected system acts on the result, granting access, resolving a ticket, approving a hire, or routing to manual review.

:::info
Most integrations can be configured and tested in under an hour. Directory-based integrations, such as Okta and Microsoft Entra, require a one-time directory sync setup. Custom API integrations are live as soon as a Client Credentials token is generated.
:::

***

## Integration Categories

Integrations are organized into categories based on the type of external system they connect to.

### Directory

[Directory integrations](/ecosystem-workforce/directory-integrations/) sync your organization's user directory with Incode, enabling employee lookups and claims matching during verification sessions.

<Component slug="directory-integrations-table" />

<DirectoryIntegrations />

### IAM

IAM integrations add Incode identity verification as a step in your organization's access management flows. They can be used as an external authentication method or an identity verification step during sign-in.

<Component slug="iam-integrations-table" />



<IAMIntegrations />

### Productivity

Productivity integrations bring identity verification into the collaboration tools your teams use every day.

<Component slug="productivity-integrations-table" />

<ProductivityIntegrations />

### IT Service Management (ITSM)

ITSM integrations connect Incode to your IT service management platform, enabling agents to trigger identity verification directly from support workflows.

<Component slug="it-service-management-integrations-table" />

<ITSMIntegrations />

### HR

HR integrations allow you to initiate identity verification from your human resources platform as part of hiring and onboarding workflows.

<Component slug="hr-integrations-table" />

<HRIntegrations />

### Recruitment

Recruitment integrations connect Incode to your applicant tracking system (ATS), enabling identity verification as part of the hiring process.

<Component slug="recruitment-integrations-table" />

<RecruitmentIntegrations />

### E-commerce

E-commerce integrations allow you to embed identity verification directly into your online store or marketplace.

<Component slug="e-commerce-integrations-table" />

<ECommerceIntegrations />

### Identity Threat Detection and Response (ITDR)

ITDR integrations connect Incode to your threat detection platform, enabling your security team to trigger identity verification as part of an active incident response workflow.

<Component slug="itdr-integrations-table" />

<ITDRIntegrations />

### Customer Identity and Access Management (CIAM)

CIAM integrations add Incode identity verification as a step within your customer-facing authentication flows. Use them for sign-up, login, or sensitive transaction flows that require identity verification.

<Component slug="ciam-integrations-table" />

<CIAMIntegrations />

### Customer Relationship Management (CRM)

CRM integrations connect Incode identity verification to the platforms your sales and operations teams use to manage customer relationships.

<Component slug="crm-integrations-table" />

<CRMIntegrations />

### Identity Governance and Administration (IGA)

IGA integrations connect Incode to your identity governance platform, enabling identity proofing as part of provisioning, access certification, and lifecycle management workflows.

<Component slug="identity-governance-and-administration-integrations-table" />

<IGAIntegrations />

### OEM and MSP Partner

OEM and MSP partner integrations combine Incode's biometric and document verification with third-party identity data signals to produce a more complete and reliable identity decision.

<Component slug="oem-and-msp-partner-integrations-table" />

<OEMMSPPartnerIntegrations />

### Custom

Custom integrations connect Incode to any system, including internal tools, ticketing systems, and automation pipelines. These connections use standard protocols or the Incode API directly.

<Component slug="custom-integrations-table" />

<CustomIntegrations />

### Coming Soon

| Integration Category                                                                                    | Description                                                                                                                                                                                 |
| :------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Banking and Fintech](/ecosystem-workforce/banking-and-fintech-integrations/)               | Embed Incode identity verification directly into core banking platforms, digital account opening workflows, and lending origination systems.                                                |
| [Student Information System](/ecosystem-workforce/student-information-system-integrations/) | Embed Incode identity verification into the platforms used by higher education institutions and K-12 organizations to manage student records, enrollment, and access to academic resources. |
| [Video Conferencing](/ecosystem-workforce/video-conferencing-integrations/)                 | Add identity verification as a step before participants can join a meeting, webinar, or video call.                                                                                         |

***

## Key Concepts

The following concepts are referenced throughout the Integrations documentation:

- **Login Hint:&#x20;**&#x41; `loginHint` is a user identifier—typically a corporate email address, username, or employee ID—passed to Incode at the start of a verification session. It is used to look up the user in a connected directory and associate the session with an existing identity record.
- **Integration ID:&#x20;**&#x45;ach integration has a unique Integration ID. This ID is required when triggering verification sessions via the [Request New Onboarding API.](/features-and-modules/b2b-request-new-onboarding-api/) It routes the session through the correct Workflow and integration configuration.
- **Claims Matching:&#x20;**&#x4D;any integration use cases require comparing attributes from the user's government-issued ID against connected directory data, such as name, date of birth, or email. Claims matching is configured as a Workflow module and can be customized.
- **Client Credentials:&#x20;**&#x41; Client Credentials integration is created automatically for organizations with Integrations Ecosystem enabled. It appears under **Integrations** > **Custom** > **OIDC Client Credentials** and is used to authenticate API requests to Incode using OAuth 2.0.
- **Security and Data Handling:&#x20;**&#x41;ll data exchanged between Incode and connected systems is encrypted in transit using TLS 1.2 or higher. Integration credentials, such as client secrets and API keys, are hashed at rest and never returned in plaintext after initial creation. Verification results written back to third-party systems contain only the outcome, risk score, and matched attributes. Raw biometric data and document images are never forwarded to the connected system. Retention of session data is configurable at the attribute level in **Dashboard** > **Configuration** > **Data**.

---

- Path: `ecosystem-workforce/it-service-management-itsm-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/it-service-management-itsm-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/it-service-management-itsm-integrations.md

# IT Service Management 

IT Service Management (ITSM) integrations connect Incode to your ITSM platform, enabling support agents to trigger identity verification sessions directly within their existing ticketing and workflow tools. This eliminates the need for out-of-band verification steps. When an employee submits a high-risk IT request, the agent can initiate a verification session from within the ITSM platform and proceed only after the employee's identity is confirmed.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available ITSM Integrations

<ITSMIntegrations />

<Component slug="it-service-management-integrations-table" />

---

- Path: `ecosystem-workforce/itdr-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/itdr-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/itdr-integrations.md

# ITDR Integrations

ITDR (Identity Threat Detection and Response) integrations connect Incode to your threat detection platform, enabling your security team to trigger identity verification as part of an active incident response workflow.

When a suspicious activity alert—such as anomalous login behavior, lateral movement, or credential misuse—is raised, your security team can send the flagged user a biometric verification link directly from within the ITDR platform. The result is returned automatically, giving your team the confirmation they need to determine whether the alert is a<br />genuine threat or a false positive.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available ITDR Integrations

<ITDRIntegrations />

<Component slug="itdr-integrations-table" />

---

- Path: `ecosystem-workforce/jira-service-management`
- URL: https://developer.incode.com/ecosystem-workforce/jira-service-management/
- Markdown: https://developer.incode.com/ecosystem-workforce/jira-service-management.md

# Jira Service Management

This page covers configuring the Incode Identity Verification app for Jira Service Management (JSM). The integration allows help desk agents to verify employee identities directly from a JSM service request using Incode's biometric verification platform.

When a service request is created, agents can send a verification link to the employee through SMS or email. The employee completes a liveness check and face match on their device, and the result is automatically posted back to the ticket.

***

## Prerequisites

Ensure you have the following before you begin:

- An active Incode Workforce account
- A Jira Service Management Cloud instance
- Admin access to both your JSM instance and Incode Dashboard
- The Integration Ecosystem feature enabled in your Incode Dashboard—required for Client Credentials

***

## Set Up the JSM Integration

### Install the App

1. Go to the [Atlassian Marketplace](https://marketplace.atlassian.com) and search for **Incode Identity Verification**.
2. Click **Get it now** and select your JSM site.
3. Follow the installation prompts and grant the requested permissions.
4. After installing, go to **Jira Settings > Apps > Incode Verification Settings**.

### Gather your Incode Credentials

You need the following from Dashboard:

| Field                     | Where to find it                                                             |
| ------------------------- | ---------------------------------------------------------------------------- |
| **API Key**               | Ask your Incode Representative                                               |
| **Client ID**             | Dashboard > Integrations > Default client credentials integration            |
| **Client Secret**         | Dashboard > Integrations > Default client credentials integration > Generate |
| **Integration Reference** | Dashboard > Integrations > your B2B integration                              |

> ⚠️ **Warning**
>
> The Client Secret is only shown once when generated. Store it securely before closing the dialog.

### Configure the App

Go to **Jira Settings > Apps > Incode Verification Settings** and fill in the following sections:

**Incode API Credentials**

- **Environment**: Select **Demo** for testing or **Production** for live use.
  - Demo API: `demo-api.incodesmile.com`
  - Production API: `saas-api.incodesmile.com`
- **API Key**: Enter your Incode API key.
- **Client ID**: Enter your OAuth 2.0 Client ID.
- **Client Secret**: Enter your OAuth 2.0 Client Secret.
- **Integration Reference**: Enter your B2B integration reference ID.

Click **Test credentials** to verify the connection. You should see a **✓ Connected** badge if the credentials are valid.

**Verification Settings**

- **Link expiry (minutes)**: How long the verification link remains valid (5–60 minutes, default 10).
- **Default delivery method**: Whether to default to **SMS** or **Email** delivery when the agent opens the panel.

**Jira Status Transitions (Optional)**

Map Incode verification outcomes to your existing JSM ticket statuses. Leave blank to manage ticket status manually.

| Outcome                | Recommended status  |
| ---------------------- | ------------------- |
| Verification passes    | In Progress         |
| Verification fails     | Escalate            |
| Manual review required | Escalate or Pending |

**Comment Messages (Optional)**

Customize the comments posted to Jira tickets when verification completes. The following template variables are available:

| Variable         | Description                |
| ---------------- | -------------------------- |
| `{{name}}`       | Employee's display name    |
| `{{email}}`      | Employee's corporate email |
| `{{identityId}}` | Incode identity ID         |
| `{{sessionId}}`  | Incode session ID          |

Click **Save configuration** when done.

### Configure Webhooks in Incode Dashboard

To receive real-time verification results in your JSM tickets, register your webhook URL in the Incode Dashboard.

1. In Dashboard, go to **Configuration > Webhooks**.
2. Add a new webhook with the following settings:
   - **URL**: Your Forge webhook URL (provided during app setup)
   - **Events**: `SESSION_STARTED`, `SESSION_SUCCEEDED`, `SESSION_FAILED`, `SESSION_PENDING_REVIEW`
3. Click **Save**.

> 📘 **Note**
>
> Your webhook URL is unique to your JSM installation. Contact [support.incode.com](https://support.incode.com) if you need help
> locating it.

### Set Up Your Employee Directory

The B2B API matches employees against your Incode directory using the corporate email address as the `loginHint`. Ensure your employees are enrolled in Incode before using the integration.

***

## Understand the Agent Workflow

After setup, the agent workflow is as follows:

1. An employee calls the help desk and a service request is open in JSM.
2. The agent opens the ticket and scrolls to the **Incode Identity Verification** panel.
3. The agent enters the employee's corporate email address.
4. The agent selects the delivery method:
   - **SMS**: Recommended for lockout scenarios where the employee cannot access corporate email
   - **Email**: Sends to corporate email or an alternate address
5. The agent clicks **Send verification link**.
6. The employee receives the link and completes biometric verification on their device, typically in under 30 seconds.
7. The panel automatically updates with the result, no refresh needed.
8. The JSM ticket is updated with:
   - An activity comment showing the verification result, identity ID, and session ID
   - An automatic status transition, if configured

***

## Verification Outcomes

| Outcome        | Panel display          | Default comment                         |
| -------------- | ---------------------- | --------------------------------------- |
| Passed         | Verification passed    | Identity confirmed—you may proceed      |
| Failed         | Verification failed    | Do not proceed—escalate for review      |
| Pending review | Manual review required | Do not proceed until review is complete |

***

## Troubleshooting

**"Setup Required" Message in the Panel**

The app has not been configured yet. Go to **Jira Settings > Apps > Incode Verification Settings** and enter your Incode credentials.

**"Error Sending Verification"**

Confirm the following:

- Your Incode credentials are correct; use the **Test credentials** button to verify.
- The employee's corporate email exists in your Incode directory.
- Your integration reference is correct.
- The Incode environment (Demo/Production) matches your account.

**Ticket Status Not Updating Automatically**

Confirm the following:

- You have selected status transitions in the admin settings.
- The transition name must exactly match an available transition from the ticket's current state.
- Check that your JSM project workflow includes the configured transitions.

**Webhook Results Not Appearing**

Confirm the following:

- Verify the webhook URL is registered in your Incode Dashboard.
- Confirm all four session event types are enabled.
- Check that your Incode account has the Integration Ecosystem feature enabled.

<br />

---

- Path: `ecosystem-workforce/lever`
- URL: https://developer.incode.com/ecosystem-workforce/lever/
- Markdown: https://developer.incode.com/ecosystem-workforce/lever.md

# Lever

This page covers integrating Incode identity verification into the Lever Applicant Tracking System (ATS). This integration uses Tines, a powerful automation platform, to orchestrate the verification flow between Lever and Incode. When a candidate reaches a designated hiring stage, Tines sends them a personalized verification link, captures the result, and writes it back to their Lever opportunity automatically.

This integration handles the full candidate verification lifecycle. It:

- Validates incoming Lever webhook signatures using HMAC-SHA256.
- Triggers only when a candidate reaches your designated verification stage.
- Fetches candidate details from Lever, generates an Incode verification link, and emails it to the candidate.
- Stores a trace record in Tines to map verification results back to the correct Lever opportunity.
- Listens for Incode verification status updates and writes results, including notes and tags, back to Lever automatically.

> 📘 **Note**
>
> You will need an active Tines workspace, a Lever account with API access, and an Incode account with API credentials to proceed.

***

## Prerequisites

Ensure you have the following before you begin:

| Requirement   | Details                                                                                                                  |
| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Tines         | An active workspace with permission to create stories, credentials, and records. The Records feature must be enabled.    |
| Lever ATS     | An account with Admin or Super Admin access to create API keys and configure webhooks.                                   |
| Incode        | An active integration with integration ID, secret, and x-api-key available.                                              |
| Email sending | Tines email delivery is used to send verification links. Ensure your workspace domain is allowlisted for outbound email. |

***

## Understand Flows

The automation runs as two independent flows that communicate through a shared Tines Records table.

### Flow 1: Trigger and Send Verification

Fires when a candidate moves to the verification stage in Lever.

```
[Stage change webhook] → [Validate signature] → [Check stage ID]
        ↓
[GET /candidates/{id}] → [Extract name & email] → [3 min delay]
        ↓
[GET Incode auth token] → [Generate verification link]
        ↓
[Capture Tines record] → [Send email to candidate]
```

### Flow 2: Receive Result and Update Lever

Fires when Incode posts a verification status event to your Tines webhook.

```
[Status update webhook] → [Check event_type == succeeded]
        ↓
[Match trace ID → OpportunityID]
        ↓
[Add tag: biometric-verified] → [Post verification note]
```

> ⚠️ **Warning**
>
> Flow 2 triggers only on `verification.succeeded` events. Failed or expired verifications are written as notes to Lever but do not trigger the tag update. You can extend the story to handle additional event types such as `verification.failed`.

***

## Set Up the Lever Integration

### Configure Credentials

This Tines story requires five credentials stored in your Tines workspace. Go to **Credentials** in the Tines sidebar and create each one as a Text credential.

| Credential name                      | Source                                            | Description                                                                                                  |
| ------------------------------------ | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `lever_api_key`                      | Lever > Settings > Integrations > API Credentials | Your Lever API key. Used as a Bearer token to fetch candidate data, post notes, and add tags.                |
| `incode_x_api_key`                   | Dashboard > API Keys                              | The `x-api-key` header value for Incode's authorization endpoint.                                            |
| `incode_workforce_integrationid`     | Dashboard > Integrations                          | The unique identifier for your Incode integration.                                                           |
| `incode_workforce_secret`            | Dashboard > Integrations                          | The secret for your integration, used for server-side token generation.                                      |
| `tines_api_key_lever_incode_records` | Tines > Your Profile > API Keys                   | A Tines API key used by the story to query its own Records table when matching a trace ID to an opportunity. |

> ⚠️ **Warning**
>
> Credential names must match exactly as shown. The story references them using `<<CREDENTIAL.name>>` syntax. A typo will cause silent authentication failures.

### Set Up the Lever Webhook

Lever must send a webhook event whenever a candidate's pipeline stage changes.

1. **Copy the Tines webhook URL**:**&#x20;**&#x41;fter importing the story, open the `lever_webhook` agent and copy the generated webhook URL:
   ```
   https://<your-tenant>.tines.com/webhook/<story-guid>/871aa415a5da64cdfa3fba63527c374b
   ```
2. **Create the webhook in Lever**: In Lever, go to **Settings&#x20;**>**&#x20;Integrations** >**&#x20;Webhooks** and add a new webhook:
   | Field         | Value                                           |
   | ------------- | ----------------------------------------------- |
   | URL           | Your Tines webhook URL from above               |
   | Events        | `candidateStageChange`                          |
   | Signing token | Copy this value—you'll need it in the next step |
3. **Update the HMAC signature secret in the story**: Open the `validate_webhook_signature` agent in Tines and replace the placeholder signing token with your Lever webhook signing token:
   ```json
   {
     "calculated_signature_raw": "<<HMAC_SHA256(LOCAL.concatened, \"YOUR_LEVER_SIGNING_TOKEN_HERE\")>>"
   }
   ```

> 🚧 **Warning**
>
> The story ships with a placeholder signing token. Replace it with your Lever signing token or the signature check will reject all incoming webhooks.

### Set Up the Incode Webhook

Incode must POST verification status events to a second Tines webhook endpoint. This drives Flow 2.

1. **Copy the verification status webhook URL**: After importing the story, open the `Get_verification_status_updates` agent and copy its webhook URL:
   ```
   https://<your-tenant>.tines.com/webhook/<story-guid>/59ab814228451619d85618e952e62c34
   ```
2. **Register the webhook in Incode**: In Dashboard, go to **Configuration > Webhooks** and configure a webhook pointing to the URL above. The story expects the following fields in the webhook payload:
   ```json
   {
     "event_type": "verification.succeeded",
     "data": {
       "verification_trace_id": "<trace-id>",
       "failure_reason": "<status message>",
       "ip": "<candidate IP>",
       "user_name": "<candidate name>",
       "latitude": 0.0,
       "longitude": 0.0
     }
   }
   ```

### Configure Your Lever Stage ID

The story triggers only when a candidate advances to a specific Lever pipeline stage. You must update the stage ID to match a stage in your own Lever environment.

1. **Find the stage ID in Lever**: Use the Lever API to list your pipeline stages:
   ```bash
   curl -X GET https://api.lever.co/v1/stages \
     -H "Authorization: Bearer <your-lever-api-key>"
   ```
   Each stage has an `id` field. Copy the ID for your target stage: for example, Background Check or Offer.
2. **Update the&#x20;**`validate_stage`**&#x20;agent**: Open the `validate_stage` agent in Tines and replace the stage ID in the trigger rule:
   ```json
   {
     "type": "field==value",
     "value": "YOUR-STAGE-UUID-HERE",
     "path": "<<extract_data.to_stage_id>>"
   }
   ```

> 📘 **Note**
>
> The story ships with a sample stage ID (`73f73269-c81e-465f-bdf4-25c76929d60a`) that does not match your environment. If you don't update it, the story receives all stage change events but never proceeds past the `validate_stage` trigger.

### Import the Tines Story

1. **Download the story file**: Download `lever-incode-candidate-biometric-identity-verification.json` from your Incode account manager.
2. **Import into Tines**: In your Tines workspace, click **New Story > Import** and upload the JSON file. Tines then creates all agents, connections, and the Tines Records table automatically.
3. **Complete configuration**: Before enabling the story, confirm the following:
   - All five credentials are created in Tines.
   - Lever webhook is configured to POST to `lever_webhook`.
   - Lever HMAC signing token is updated in `validate_webhook_signature`.
   - Stage ID is updated in `validate_stage`.
   - Incode webhook is configured to POST to `Get_verification_status_updates`.
   - Email sender name and reply-to address is updated in the Send Email Action.
   - Redirect URL in `incode_verification` is updated to your domain.
4. **Enable and test**: Enable the story in Tines. Move a test candidate to your verification stage in Lever and confirm the story fires, the email is sent, and a record appears in the Tines Records table.

***

## Automation Agents Reference

The story contains 16 agents across both flows.

### Flow 1: Send Verification

| Agent                                         | Type                             | Description                                                                                                                   |
| --------------------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `lever_webhook`                               | WebhookAgent                     | Receives all `candidateStageChange` POST events from Lever. Responds with HTTP 200 immediately.                               |
| `validate_webhook_signature`                  | EventTransformationAgent         | Computes HMAC-SHA256 of token and triggeredAt using your Lever signing secret and compares it to the received signature.      |
| `check_signature`                             | TriggerAgent                     | Gate: passes only events where the computed signature matches the received signature. Rejects forged or replayed webhooks.    |
| `extract_data`                                | EventTransformationAgent         | Extracts `candidateId`, `opportunityId`, `fromStageId`, `toStageId`, and `stageName` from the webhook payload.                |
| `validate_stage`                              | TriggerAgent                     | Gate: passes only events where `toStageId` equals your configured verification stage ID.                                      |
| `get_candidate_details`                       | HTTPRequestAgent                 | Calls `GET /v1/candidates/{id}` on the Lever API to retrieve the candidate's profile.                                         |
| `extract_candidate_details`                   | EventTransformationAgent         | Parses name, email, and phone from the Lever response. Splits full name into `first_name` and `last_name` for Incode.         |
| `Delay sending identity verification message` | EventTransformationAgent (delay) | Waits 3 minutes before continuing. Allows stage transitions to settle in Lever before sending the email.                      |
| `get_incode_token`                            | HTTPRequestAgent                 | Calls the Incode server-side authorization endpoint to obtain a short-lived session token using your integration credentials. |
| `incode_verification`                         | HTTPRequestAgent                 | Generates a personalized, time-limited verification link for the candidate. The link is valid for 72 hours.                   |
| `Capture Record`                              | RecordAgent                      | Creates a record in the `Lever_Incode_Information` table storing the opportunity ID, candidate ID, and Incode trace ID.       |
| `Send Email Action`                           | EmailAgent                       | Sends an HTML-formatted email to the candidate with the verification link and instructions.                                   |

### Flow 2: Receive Result

| Agent                             | Type             | Description                                                                                                                                            |
| --------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Get_verification_status_updates` | WebhookAgent     | Receives POST callbacks from Incode containing verification results. Second entry point of the story.                                                  |
| `Trigger Action`                  | TriggerAgent     | Gate: passes only events where `event_type == "verification.succeeded"`.                                                                               |
| `Match_record_trace_opportunity`  | HTTPRequestAgent | Queries the Tines Records API to find the opportunity ID matching the `verification_trace_id` from the Incode callback.                                |
| `update_lever_tag`                | HTTPRequestAgent | Calls `POST /v1/opportunities/{id}/addTags` to add the `biometric-verified` tag to the candidate's Lever opportunity.                                  |
| `update_lever_note`               | HTTPRequestAgent | Posts a structured note to the Lever opportunity with the event type, status, trace ID, IP, name, and geolocation from the Incode verification result. |

***

## API Reference

### Incode APIs

**Get Auth Token**

```
POST https://demo-api-incode-id.incodesmile.com/v1/integration/authorize/server
x-api-key: <<CREDENTIAL.incode_x_api_key>>
```

Request body:

```json
{
  "integrationId": "<<CREDENTIAL.incode_workforce_integrationid>>",
  "secret": "<<CREDENTIAL.incode_workforce_secret>>"
}
```

Response:

```json
{ "token": "<session-token>" }
```

The `token` value is passed as the `x-auth-token` header in all subsequent Incode API calls.

**Generate Verification Link**

```
POST https://demo-api-incodesmile.com/v1/workforce/verification/candidate/generate-verification-link
x-auth-token: <<get_incode_token.body.token>>
```

Request body:

```json
{
  "integrationID": "<<CREDENTIAL.incode_workforce_integrationid>>",
  "secret": "<<CREDENTIAL.incode_workforce_secret>>",
  "loginHint": "candidate@email.com",
  "loginHintType": "EMAIL",
  "validityMinutes": 4320,
  "redirectUrl": "https://your-domain.com",
  "givenNames": "First",
  "lastName": "Last"
}
```

Key response fields:

```json
{
  "verificationLink": "https://...",
  "verificationTraceId": "..."
}
```

### Lever APIs

**Get Candidate Details**

```
GET https://api.lever.co/v1/candidates/{candidateId}
Authorization: Bearer <<CREDENTIAL.lever_api_key>>
```

Key response fields used:

```
data.name        // full name — split into first/last
data.emails[0]   // primary email address
data.phones[0]   // primary phone number
```

**Add Tag to Opportunity**

```
POST https://api.lever.co/v1/opportunities/{opportunityId}/addTags
Authorization: Bearer <<CREDENTIAL.lever_api_key>>
```

```json
{ "tags": ["biometric-verified"] }
```

**Post Verification Note**

```
POST https://api.lever.co/v1/opportunities/{opportunityId}/notes
Authorization: Bearer <<CREDENTIAL.lever_api_key>>
```

```json
{
  "secret": false,
  "value": "Biometric Verification Update\n\nEvent: <event_type>\n\nVerification Details:\n- Status: ...\n- Trace ID: ...\n- IP: ...\n- Name: ...\n- Location: lat, lon\n\nProcessed: <timestamp>"
}
```

***

## Email Template

The Send Email Action agent sends an HTML email to the candidate with a personalized greeting, a verification button, and step-by-step instructions.

To customize the template, open the Send Email Action agent in Tines and update the following:

| Field                                  | Default                       | Description                                    |
| -------------------------------------- | ----------------------------- | ---------------------------------------------- |
| `sender_name`                          | GoodLeap Talent Team          | Your company's talent team name                |
| `reply_to`                             | t3\@goodleap.com              | Your recruitment team's reply-to email address |
| `subject`                              | Identity Verification Request | Add your company name if needed                |
| CTA button color                       | #00AEEF                       | Your brand's primary color                     |
| Contact email in body                  | T3\@goodleap.com              | Your recruitment team's email address          |
| `redirectUrl` in `incode_verification` | https\://goodleap.com         | Your company website or careers page URL       |

***

## Tines Records Schema

The story creates and queries a Records table called `Lever_Incode_Information`. This table connects Flow 1 (send verification) and Flow 2 (receive result).

| Field         | Type      | Description                                                                                                           |
| ------------- | --------- | --------------------------------------------------------------------------------------------------------------------- |
| Story name    | TEXT      | Name of the Tines story that created the record. For debugging.                                                       |
| Timestamp     | TIMESTAMP | Date and time the record was created.                                                                                 |
| OpportunityID | TEXT      | The Lever opportunity ID. Used when writing back notes and tags in Flow 2.                                            |
| CandidateID   | TEXT      | The Lever candidate ID. Stored for reference and audit.                                                               |
| TraceID       | TEXT      | The Incode `verificationTraceId`. Used as the lookup key in Flow 2 to match the callback to the original opportunity. |
| Updated at    | TIMESTAMP | Auto-populated timestamp for when the record was last modified.                                                       |

> 📘 **Note**
>
> The `Match_record_trace_opportunity` agent queries this table using the Tines Records API at `https://<your-tenant>.tines.com/api/v1/records`, filtering by TraceID to find the corresponding Lever OpportunityID. Ensure `tines_api_key_lever_incode_records` has permission to read this table.

***

## Troubleshooting

### **Story Fires but No Email Is Sent**

Check the following in order:

- `check_signature` **trigger not passing**: Verify your HMAC signing token in `validate_webhook_signature` matches the signing token shown in Lever's webhook settings exactly.
- `validate_stage`**&#x20;trigger not passing**: Verify the stage ID in the trigger rule matches the UUID of your target pipeline stage in Lever.
- `get_incode_token` **returning non-200**: Check your `incode_x_api_key`, `incode_workforce_integrationid`, and `incode_workforce_secret` credentials in Tines.

### **Lever Note or Tag Not Written After Verification**

Confirm the following:

- The Incode webhook is correctly configured to POST to the `Get_verification_status_updates` URL.
- The `event_type` from Incode is exactly `verification.succeeded`: the Trigger Action performs a strict string match.
- A Tines record exists for the `verification_trace_id`. Check the Records table to confirm Flow 1 ran successfully for that candidate.
- `tines_api_key_lever_incode_records` is valid and has read access to the `Lever_Incode_Information` records table.

### **Signature Validation Fails for All Events**

The HMAC signing token in `validate_webhook_signature` must match your Lever webhook's signing token exactly.&#x20;

1. Go to **Lever > Settings > Integrations > Webhooks**.
2. Click your webhook.
3. Copy the signing token.
4. Paste the signing token into the `HMAC_SHA256` expression in the Tines agent, replacing any placeholder value.

### **Incode API Returns 401**

Your `incode_x_api_key`, `incode_workforce_integrationid`, or `incode_workforce_secret` credentials are incorrect or expired. Verify them in the Incode Dashboard and re-create the Tines credentials.

> 📘 **Tip**
>
> Use Tines' built-in event log for each agent to inspect the exact payload received and response. This is the fastest way to identify where an issue occurs.

<br />

---

- Path: `ecosystem-workforce/microsoft-defender-for-identity`
- URL: https://developer.incode.com/ecosystem-workforce/microsoft-defender-for-identity/
- Markdown: https://developer.incode.com/ecosystem-workforce/microsoft-defender-for-identity.md

# Microsoft Defender for Identity

You can connect Incode identity verification to Microsoft Sentinel so that when Defender for Identity raises a suspicious activity incident, your security team can send the flagged user a biometric verification link. The result is posted back to Sentinel automatically, giving your team the identity confirmation they need to resolve or escalate the incident.

This integration works well for Identity Threat Detection and Response (ITDR) workflows where you need to distinguish real security incidents from false positives. False positives can be caused by legitimate employees travelling, working from new devices, or logging in at unusual hours.

***

## Prerequisites

Ensure you have the following before you begin:

- An active Azure subscription with permissions to create Logic Apps and assign roles within a resource group
- A Microsoft Sentinel workspace
- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- Users as directory records in the Incode integration. This is needed for verification requests to succeed.

***

## Integration Flow

The integration runs on two Azure Logic Apps deployed in your Azure environment:

1. The first is a **Sentinel automation playbook**. When Sentinel creates an incident, the playbook calls the Incode API to generate a unique verification link for the flagged user and delivers it to your security team. Your security team then sends it to the user.
2. The second is a **webhook receiver**. When the user completes their biometric check, Incode sends the result to this receiver. The receiver reads the result and updates the Sentinel incident, closing it as a false positive if verification succeeded, or escalating it to high severity if verification failed.

Both Logic Apps use a managed identity to authenticate against:

- Azure Key Vault for Incode credentials.
- Microsoft Sentinel to update incidents.

No credentials are hardcoded.

***

## Set Up the Sentinel Integration

### Create an Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the Custom tab, click **API**, then click **Continue**.
5. Enter a **Name** for the integration: for example, `Microsoft Defender`.
6. Click **Save**.
7. Open the integration card and note the **Integration ID**. You'll need this in a later step.

### Collect Your Incode Credentials

Store the following values in Azure Key Vault. See [Find Integration Details](/dashboard-platform-administration/manage-integrations/) for where to locate each one in Dashboard.

- **Client ID**: Your OAuth client identifier.
- **Client secret**: Generate a new one if you don't already have one.
- **API key**: Obtain from your Incode account team if you don't have one.
- **Integration ID**: The value from the previous set of steps.
- **Auth server URL**: `https://auth.demo.incode.com` (demo) or `https://auth.incode.com` (production).
- **API base URL**: `https://demo-api.incodesmile.com` (demo) or `https://saas-api.incodesmile.com` (production).

### Deploy the Azure Resources

Incode provides both Logic Apps as ready-to-deploy ARM templates. Click **Deploy to Azure** in the [Incode GitHub repository](https://github.com/incode) to deploy both Logic Apps and an Azure Key Vault into your Azure subscription.

> 📘 Note
>
> If you don't have access to the ARM templates yet, contact your Incode account team.

After deploying, store the following secrets in Key Vault using the exact secret names shown:

| Secret name                    | Value                                           |
| ------------------------------ | ----------------------------------------------- |
| `incode-client-id`             | Your Incode OAuth client ID                     |
| `incode-client-secret`         | Your Incode OAuth client secret                 |
| `incode-api-key`               | Your Incode API key                             |
| `incode-integration-reference` | Your integration ID from the first set of steps |
| `incode-auth-url`              | Auth server URL from the previous set of steps  |
| `incode-api-base-url`          | API base URL from the previous set of steps     |

> 📘 Note
>
> To store secrets with special characters, use the Azure Cloud Shell Python approach to avoid bash misreading them:
>
> ```python
> python3 -c "
>
> import subprocess
>
> [subprocess.run](http://subprocess.run)(['az', 'keyvault', 'secret', 'set',
>
> '--vault-name', 'YOUR_KEYVAULT_NAME',
>
> '--name', 'incode-client-secret',
>
> '--value', 'YOUR_SECRET_VALUE_HERE'])
>
> "
>
> `
> ```

After storing all secrets, grant the Logic App managed identity **Get** and **List** permissions on Key Vault secrets.

### Assign the Sentinel Responder Role

Grant the managed identity the **Microsoft Sentinel Responder** role from Azure Cloud Shell:

```bash
az role assignment create \
  --assignee YOUR_MANAGED_IDENTITY_PRINCIPAL_ID \
  --role "Microsoft Sentinel Responder" \
  --scope /subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP
```

> 📘 Note
>
> Role assignments can take up to 10 minutes to propagate. Wait before testing.

### Configure Webhooks in Dashboard

The webhook receiver Logic App needs to receive session results from Incode when a user completes verification.

1. In Dashboard, click **Configuration** in the left menu.
2. Click the **Webhooks** tab.
3. Find the Flow or Workflow associated with your integration.
4. Add the webhook receiver Logic App URL as the endpoint for the `SESSION_SUCCEEDED` and `SESSION_FAILED` events.

To find the receiver Logic App URL, open the Logic App in the Azure portal, go to **Overview**, and copy the **Workflow URL**.

> 📘 Note
>
> Incode requires a webhook authentication secret to be configured before session webhooks are delivered. Contact your Incode Representative to confirm the required format for your environment.

### Connect Sentinel to the Playbook

1. In Microsoft Sentinel, create a new automation rule.
2. Set the trigger to **When an Incident is Created**.
3. Configure conditions to match the incidents you want to trigger verification for: for example, by severity or incident type.
4. Set the action to **Run Playbook** and select the playbook Logic App.
5. Click **Save**.

***

## Test the Integration

Test the end-to-end flow from Azure Cloud Shell:

```bash
curl -s -X POST \
  "YOUR_PLAYBOOK_TRIGGER_URL" \
  -H "Content-Type: application/json" \
  -d '{"incidentId":"TEST-001","severity":"Medium","userEmail":"user@yourdomain.com"}' \
  | python3 -m json.tool
```

A successful response includes a `verificationUrl` field and a `status` of `verification_initiated`. Open the URL to complete a test biometric check, then confirm the Sentinel incident was updated as expected.

***

## Technical Notes

- **The&#x20;**`api-version: 1.0`**&#x20;header is required.** Every call to the Incode B2B onboarding endpoint (`POST /omni/b2b/onboarding/request-new`) must include the header `api-version: 1.0`. Without it, the API returns HTTP 406 with no explanation.
- `externalCustomerId`**&#x20;is required for incident correlation.** Pass the Sentinel incident ID as `externalCustomerId` in every B2B onboarding request. Incode echoes this value back in the session webhook payload. Without it, the webhook receiver cannot identify which incident to update.
- **Users must exist in the Incode directory before verification.** If the `loginHint` (user email) does not match any record in the integration directory, the API returns error `5504: Employee by login factor cannot be found`. Add the user to the integration directory in Dashboard before retrying.

***

## Troubleshooting

### **Playbook Fails at OAuth Token Step with HTTP 401**

The client ID or client secret in Key Vault is wrong or has been rotated. Confirm credentials manually from Cloud Shell:

```bash
curl -s -X POST "{auth_url}/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&scope=openid&client_id={client_id}&client_secret={client_secret}"
```

### **Playbook Fails at B2B Onboarding Step with HTTP 406**

The `api-version: 1.0` header is missing from the HTTP action in the Logic App.

### **Playbook Fails with Error 5504**

The user email passed as `loginHint` does not exist in the Incode integration directory. Add the user in Dashboard and retry.

### **Webhook Receiver Never Fires After Verification Completes**

There are three possible causes:

- Session webhooks are not configured in Dashboard for the correct Flow or Workflow.
- The webhook auth secret is missing or incorrectly configured.
- The webhook is configured at the wrong level (session webhooks are scoped to individual Flows or Workflows, not globally).

### **Webhook Receiver Fires but Sentinel Update Fails with HTTP 403**

The managed identity does not have the Microsoft Sentinel Responder role, or the role assignment has not yet propagated. Wait up to 10 minutes and retry.

### **Sentinel Incident is Not Updated After Verification Completes**

The `externalCustomerId` in the webhook payload does not match a valid Sentinel incident ID. Confirm that the incident ID is being correctly passed in the original B2B onboarding request.

***

## Supported Environments

| Environment | Auth server URL                | API base URL                       |
| ----------- | ------------------------------ | ---------------------------------- |
| Demo        | `https://auth.demo.incode.com` | `https://demo-api.incodesmile.com` |
| Production  | `https://auth.incode.com`      | `https://saas-api.incodesmile.com` |

<br />

---

- Path: `ecosystem-workforce/microsoft-entra-directory`
- URL: https://developer.incode.com/ecosystem-workforce/microsoft-entra-directory/
- Markdown: https://developer.incode.com/ecosystem-workforce/microsoft-entra-directory.md

# Microsoft Entra Directory

The Microsoft Entra directory integration syncs your Entra user directory with Incode, enabling employee lookups and claims matching during identity verification sessions. This integration is required for any flow that requires verifying a user against their Entra directory record, including [Self-Serve Portal](/ecosystem-workforce/self-serve-portal/) password and MFA resets, ITSM verifications, and claims matching in Entra IAM flows.

This is a directory-only integration. It does not trigger verification sessions. Use [Microsoft Entra External Authentication Method (EAM)](/ecosystem-workforce/microsoft-entra-eam/) integration for authentication-layer integration with Microsoft Entra.

:::info
If your Microsoft Entra environment uses federated access through Okta as the identity provider, follow the<br />[Okta Directory](/ecosystem-workforce/okta-directory/) guide instead.
:::

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- A Microsoft Entra account with the following roles:
  - **User Administrator**, **Groups Administrator**, **Application Administrator**, and **App Developer** for App<br />Registration, group, and user setup
  - **Global Administrator** to grant the required app permissions

## Synced Data

Incode reads user profile data from Microsoft Entra to perform claims matching. Depending on your claims matching policy, some of the following fields may be required for verification to succeed. Ensure these attributes are populated for all users in the groups you intend to sync:

| Attribute                                         | Used for                                    |
| ------------------------------------------------- | ------------------------------------------- |
| First name (given name)                           | Name claim matching                         |
| Last name (surname)                               | Name claim matching                         |
| User principal name (UPN)                         | Primary user lookup (`loginHint`)           |
| Email                                             | Notification delivery, email claim matching |
| Mobile phone                                      | Phone claim matching                        |
| Date of birth                                     | Date of birth claim matching                |
| Street address, city, state, postal code, country | Address claim matching                      |

:::info
Missing attributes will cause claims matching failures for affected users. Ensure the relevant fields are populated in Entra before triggering a directory sync.
:::

## Set Up Entra Directory Integration

### Configure the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the **Directory** tab, select **Microsoft Entra Directory**, then
   click **Continue**.
5. Enter a **Directory Name**.
6. Enter the **User Group ID** (Object ID) of the Entra group containing the employees you want to sync. To find this, go to your Microsoft Entra portal > **Groups** > **All groups**, and copy the Object ID for the relevant group.
7. Select the permission level for the integration:
   - **Read-only**: Allows directory sync only
   - **Read and write**: Allows directory sync and Self-Serve password and MFA resets
8. Click **Save**.

### Grant Directory Permissions in Microsoft Entra

After saving, Dashboard redirects you to the Microsoft Entra admin consent page to approve the required permissions. A **Global Administrator** must complete this step.

:::info
If permissions are rejected, or the approving user does not have sufficient permissions, the integration will remain in an incomplete state and you must restart setup.
:::

### Sync the Directory

After permissions are granted, trigger an initial sync to import your users into Incode.

1. In the left menu, click **Integrations**.
2. From the **Directory** tab, locate the integration you just created.
3. On the integration card, click **Sync Directory**.

Depending on the size of your directory, the initial sync may take several minutes.

## View Synced Users

Click **Directory Information** in the left menu to view all synced users and their enrollment status. Users shown as **not enrolled** have been synced from Entra but have not yet completed an Incode verification session. To initiate verification for these users, trigger a session through your configured IAM or ITSM integration.

---

- Path: `ecosystem-workforce/microsoft-entra-eam`
- URL: https://developer.incode.com/ecosystem-workforce/microsoft-entra-eam/
- Markdown: https://developer.incode.com/ecosystem-workforce/microsoft-entra-eam.md

# Microsoft Entra EAM

An External Authentication Method (EAM) lets users satisfy Microsoft Entra ID's MFA requirements through an external provider. This page covers configuring Incode as an EAM in your Entra environment and describes the use cases this enables.

***

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- A [Workflow](/dashboard-platform-administration/workflows-20/) created for the integration.
- An active **Microsoft Entra ID P1 or P2** subscription.
- A Microsoft Entra administrator account with appropriate privileges.

***

## Understand What This Enables

After Incode is registered as an EAM, it can be used in the following scenarios:

- **SSPR & MFA recovery**: Redirect users who forgot a password or who cannot satisfy MFA to Incode for biometric and document verification before completing the reset.
- **External authentication**: Add Incode as a high-assurance check before granting access to apps or workflows through Entra Conditional Access.
- **New-hire onboarding**: Verify legal identity before activating Entra credentials for new employees.

***

## Understand How It Works

When a user is required to authenticate with Incode, Entra redirects them to an Incode verification session. The session requirements are determined by the Workflow linked to the integration. After the session completes, Incode returns a result to Entra to confirm the user's identity.

For use cases that include claims matching, Incode reads the user's profile from the Entra directory and matches verified attributes from their government-issued ID against that record. A successful match is required before the Entra action is allowed to proceed. If claims do not match, the session is routed to manual review.

The [Microsoft Entra Directory Sync](/ecosystem-workforce/microsoft-entra-directory/) page describes directory sync configuration, including which Entra user attributes Incode uses.

***

## Set Up Entra EAM Integration

### Create the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the IAM tab, click **Microsoft Entra EAM**, then click **Continue**.
5. Enter a **Name** for this integration.
6. **Select a Workflow for this Integration&#x20;**&#x66;rom the drop-down.
7. Copy the following values from the integration to use in the next set of steps:
   - **Client ID**
   - **Discovery Endpoint**
   - **Authorize URL**
8. Click **Save**.

### Register an Application in Microsoft Entra

1. Log in to your Microsoft Entra Admin Center as an administrator.
2. Go to **App Registrations** > **New Registration**.
3. Configure the registration:
   - **Name:** Enter a name for the application.
   - **Supported account types:** Select **Single tenant**.
   - **Redirect URI:** Select the **Web** platform and paste the **Authorize URL** from the previous set of steps.
4. Click **Register** and copy the generated **App ID**.

### Add Incode as an External Authentication Method

1. Go to **Protection** > **Authentication Methods** > **Policies**.
2. Click **+ Add External Method (Preview)**.
3. Configure the external method:
   - **Name:** Enter a display name—for example, **Incode**. This is the name users see when selecting an authentication method at login.
   - Paste the **Client ID**, **Discovery Endpoint**, and **Authorize URL** from the previous sets of steps into the respective fields.
4. Click **Request permission** to grant admin consent for the Incode authenticator. Check **Consent on behalf of your organization** and click **Accept**.
5. Toggle **Enable** to **On**.
6. Click **+ Add Target** to select the users or groups that should use Incode as an EAM. By default, the policy applies to all users.
7. Click **Save**.

***

## Test the Integration

1. Sign in to a Microsoft application with an account in your configured target group.
2. After entering your password, confirm you are prompted to verify your identity with Incode.
3. Complete the verification session and confirm that sign-in proceeds successfully.

> ⚠️ Warning
>
> Entra EAM through Conditional Access policies currently allows users to select **Sign in another way** and authenticate with a different enrolled factor, bypassing Incode. See [Authentication Strengths & Conditional Access with Incode EAM](/ecosystem-workforce/authentication-strengths-conditional-access-with-entra-eam/) for guidance on restricting this.

<br />

---

- Path: `ecosystem-workforce/oem-msp-partner-itegrations`
- URL: https://developer.incode.com/ecosystem-workforce/oem-msp-partner-itegrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/oem-msp-partner-itegrations.md

# Data Enrichment

Incode's OEM and MSP partner integrations combine Incode's biometric and document verification with third-party identity data signals to produce a more complete and reliable identity decision.

While Incode confirms that a person is physically present and matches their government-issued ID, OEM and MSP partners contribute additional signals—such as credit bureau records, fraud watchlists, device intelligence, and<br />phone and email risk scores—that validate whether the identity itself is genuine and not synthetic or stolen.

Together, these two layers give financial institutions, fintechs, and other regulated businesses a higher-confidence identity decision that satisfies both the biometric and data-based components of KYC and CIP requirements.

Access to these integrations is available through Incode's OEM and MSP partner program. Contact your Incode Representative for access and configuration details.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available OEM and MSP Partner Integrations

<OEMMSPPartnerIntegrations />

<Component slug="oem-and-msp-partner-integrations-table" />

---

- Path: `ecosystem-workforce/okta-authenticator-classic`
- URL: https://developer.incode.com/ecosystem-workforce/okta-authenticator-classic/
- Markdown: https://developer.incode.com/ecosystem-workforce/okta-authenticator-classic.md

# Okta Authenticator (Classic)

This page covers setting up Incode as an OIDC-based authenticator in an Okta Classic environment. If your organization uses Okta Identity Engine (OIE), follow the [Okta Authenticator (Preview/OIE)](/ecosystem-workforce/okta-authenticator-previewoie/) steps instead.

***

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode representative if you do not see it.
- [Okta IDP integration](/ecosystem-workforce/okta-idp/) prerequisites complete.
- An Okta Classic instance.
- An Okta administrator account with permissions to manage Identity Providers and Policies.

***

## Set Up Okta IDP Integration for Classic

### Create an OIDC Identity Provider in Okta

1. Log in to your Okta Admin Console.
2. Go to **Security** > **Identity Providers** > **Add Identity Provider**.
3. Select **OpenID Connect**.
4. Enter a name for the IDP and set the mode to **Factor Only**.
5. Ensure the following scopes are included: `email`, `openid`, and `profile`.

**Do not save yet.** You will need values from Dashboard in the next set of steps to complete this configuration.

### Create the Integration in Dashboard

> 📘 **Tip**
>
> This requires copying values between Dashboard and your Okta Admin Console. Keep both tabs open.

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the **IAM** tab, select **Okta IDP**, then click **Continue**.
5. Enter a **Name** for this integration. This name appears in analytics and identifies verifications completed through this integration.
6. **Select a Workflow** for this integration from the drop-down.
7. Copy the following values from Dashboard into the corresponding fields in your Okta OIDC IDP configuration:

| Dashboard field | Okta field             |
| --------------- | ---------------------- |
| Client ID       | Client ID              |
| Client Secret   | Client Secret          |
| Issuer URL      | Issuer                 |
| Authorize URL   | Authorization endpoint |
| Token URL       | Token endpoint         |
| JWKS URL        | JWKS endpoint          |
| Userinfo URL    | Userinfo endpoint      |

8. In Okta, set the **Authentication type** to **Client secret**.
9. Click **Save&#x20;**&#x69;n Okta.
10. Copy the **Redirect URI** generated by Okta after saving.
11. In Dashboard, paste the **Redirect URI** into the **Redirect URLs** field in the integration configuration.
12. Click **Save**.

### Configure Policies in Okta Classic

Okta Classic uses a different policy structure than OIE. Rather than separate enrollment and authentication policies, Classic uses per-application sign-on policies to enforce MFA requirements.

1. In the Okta Admin Console, go to **Applications** and open the application you want to protect with Incode verification.
2. Open the **Sign On** tab.
3. Under **Sign On Policy**, click **Add Rule**.
4. Configure the rule:
   - Set the conditions to match the user group you want to require Incode verification for.
   - Under **Access**, set **Multifactor Authentication** to **Required**.
   - Ensure the Incode IDP factor is listed as an allowed factor.
5. Click **Save**.
6. Repeat for any additional applications you want to protect.

> 📘 **Note**
>
> In Okta Classic, sign-on policies are configured per application, not globally. You must add an Incode rule to each application you want to protect. If you manage many applications, consider using Okta Identity Engine (OIE) for centralized policy management.

***

## Test the Integration

Sign in to one of the configured applications using a test user account in the enrolled group. The login flow should prompt for password followed by the Incode biometric verification step.

Confirm the following before rolling out to all users:

- The Incode authenticator appears as an MFA option after password entry.
- The user is redirected to an Incode verification session and can complete<br />it on their mobile device.
- After successful verification, the user is granted access to the<br />application.
- Failed verification blocks access and does not allow the user to proceed.

> ⚠️ **Warning**
>
> If the Incode factor does not appear, verify that the sign-on policy rule is applied to the correct user group<br />and that the Incode IDP is listed as an allowed factor in the rule. Changes to Okta Classic policies take effect immediately but may require a fresh browser session to reflect for active users.

***

## What's Next

- [Okta Authenticator (Preview/OIE)](/ecosystem-workforce/okta-authenticator-previewoie/)
- Configure Incode as an SSO provider
- [Okta Directory Sync](/ecosystem-workforce/okta-directory/)

<br />

---

- Path: `ecosystem-workforce/okta-authenticator-previewoie`
- URL: https://developer.incode.com/ecosystem-workforce/okta-authenticator-previewoie/
- Markdown: https://developer.incode.com/ecosystem-workforce/okta-authenticator-previewoie.md

# Okta Authenticator (Preview/OIE)

This page describes how to set up Incode as an OIDC-based Authenticator within an Okta Identity Engine (OIE) environment. The result is an Incode biometric factor that can be required in Okta Enrollment and Authentication Policies, functioning as MFA for any applications you choose to protect.

If your organization uses Okta Classic, use the separate steps for [Okta Authenticator (Classic)](/ecosystem-workforce/okta-authenticator-classic/) instead.

***

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- [Okta IDP Integration](/ecosystem-workforce/okta-idp/) prerequisites complete.
- An Okta Identity Engine (OIE) instance.
- An Okta administrator account with permissions to manage Identity Providers, Authenticators, and Authentication Policies.
- Access to the **Incode Omni Dashboard** with the **Integrations Ecosystem** feature enabled.

***

## Set Up Okta IDP Integration for Preview/OIE

### Create an OIDC Identity Provider in Okta

1. Log in to your Okta Admin Console.
2. Go to **Security** > **Identity Providers** > **Add Identity Provider**.
3. Select **OpenID Connect IDP**.
4. Add a name for the IDP and set the mode to **Factor Only**.
5. Ensure the following scopes are included: `email`, `openid`, and `profile`.

### Create the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the IAM tab, click **Okta IDP**, then click **Continue**.
5. Enter a **Name** for this integration. This name appears in analytics and identifies verifications completed through this integration.
6. **Select a Workflow for this Integration&#x20;**&#x66;rom the drop-down.
7. Copy the following values to the corresponding fields in your Okta OIDC IDP configuration:
   - Client ID
   - Client Secret
   - Issuer URL
   - Authorize URL
   - Token URL
   - JWKS URL
   - Userinfo URL
8. In another tab or window, open Okta. Set the **Authentication type** to **Client secret**.
9. Click **Save&#x20;**&#x69;n Okta.
10. Copy the **Redirect URI** generated by Okta after saving.
11. Back in Dashboard, paste the **Redirect URI** from Okta into the **Redirect URLS** field in the integration configuration.
12. Review your settings and click **Save**.

### Create an Okta Authenticator

1. In the Okta Admin Console, go to **Security** > **Authenticators** > **Add Authenticator**.
2. Select **IDP Authenticator** from the list of available authenticator types.
3. Select the Incode IDP you created in the first set of steps.
4. Set the authenticator name to **Incode** and upload the [Incode logo](https://incode-assets.s3.amazonaws.com/incode-logo.svg).
5. Click **Save**. The authenticator is now available for use in enrollment and authentication policies.

> 📘 Note
>
> Okta automatically adds new IDP authenticators as optional to the default policy. If this is not desired for your organization, disable this in the default policy after saving.

### Create an Enrollment Policy

Enrollment policies control which users are required to enroll with the Incode authenticator. Okta checks enrollment policy compliance at account creation and every login.

1. In the **Authenticators** menu, go to the **Enrollment** tab and select **Add a Policy**.
2. Enter a name and description.
3. Assign the Okta user group you want to require Incode verification for.
4. Set both **Password** and **Incode** as **Required**, along with any other MFA methods your organization uses.
5. Click **Save**.

### Create an Authentication Policy

Authentication policies determine when the Incode authenticator is required during login.

1. Go to **Security** > **Authentication Policies** > **Add a Policy**.
2. Enter a name and description.
3. Add a rule and configure it:
   - Assign the user group you created for Incode verification.
   - Set the authentication requirement to **Password / IDP + Another Factor**.
   - Select **Allow specific authentication methods** and add **Incode** and **Password**.
4. Click **Save**.
5. Go to **Applications** and assign the applications this policy should apply to.

***

## Test the Integration

Incode recommends testing the login process for the selected applications to confirm the authentication policy works as expected before rolling it out to all users.

---

- Path: `ecosystem-workforce/okta-directory`
- URL: https://developer.incode.com/ecosystem-workforce/okta-directory/
- Markdown: https://developer.incode.com/ecosystem-workforce/okta-directory.md

# Okta Directory

The Okta directory integration syncs your Okta user directory with Incode, enabling employee lookups and claims matching during identity verification sessions. This integration is required for any flow that requires verifying a user against their Okta directory record, including ITSM verifications, [Self-Serve Portal](https://developer.incode.com/ecosystem-workforce/self-serve-portal/) resets, and claims matching in IAM flows.

This is a directory-only integration. It does not trigger verification sessions. Use [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/)​ integration for authentication-layer integration with Okta.

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- An Okta administrator account with permissions to create and manage integrations.

## Synced Data

When the Okta directory integration is active, Incode syncs user and group data from your Okta instance. Synced attributes are used to look up users by `loginHint` and to supply claims for matching against verified identity data.

The following Okta user profile attributes are used by Incode, depending on your claims matching policy configuration:

| Attribute             | Used for                          |
| --------------------- | --------------------------------- |
| Email/login           | Primary user lookup (`loginHint`) |
| First name, last name | Name claim matching               |
| Date of birth         | Date of birth claim matching      |
| Address fields        | Address claim matching            |
| Phone number          | Phone claim matching              |
| Group membership      | Policy routing and scoping        |

Make sure the relevant attributes are populated for all users in the groups you intend to sync. Missing attributes will cause claims matching failures for those users.

## Set Up Okta Directory Integration

### Create the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the Directory tab, click **Okta Directory**, then click **Continue**.
5. Enter a **Directory Name**.
6. Enter your Okta Instance **URL** in this format: `https://your.company.name.okta.com`.  
:::warning
     If you leave a trailing / at the end of this URL, the directory sync will silently fail. Ensure your URL format matches exactly what is above.
:::
7. Enter a **Client ID** for the Okta service application.
8. You can enter a **User Group ID** to assign to Workforce.
9. Click **Save**.

### Authorize Directory Access in Okta

After saving the integration, Incode initiates an authorization flow to request read access to your Okta directory. Follow the prompts in your Okta Admin Console to approve the required permissions.

:::info
You must have Okta administrator permissions to approve directory access. If you lack sufficient permissions, the integration remains in an incomplete state and you must restart setup.
:::

### Sync the Directory

After authorizing access, trigger a directory sync to import your users into Incode.

1. In the left menu, click **Integrations**.
2. In the Directory tab, locate the directory you want to sync.
3. On the integration card, click **Sync directory**.

Depending on the size of your directory, the initial sync may take some time.

## View Synced Users

You can see synced users and their enrollment status by clicking **Directory Information** in the left menu.

<br />

---

- Path: `ecosystem-workforce/okta-idp`
- URL: https://developer.incode.com/ecosystem-workforce/okta-idp/
- Markdown: https://developer.incode.com/ecosystem-workforce/okta-idp.md

# Okta IDP

The Okta IDP integration configures Incode as the authenticator and Identity Provider (IdP) for your Okta organization. This is distinct from the [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/) integration, which uses Okta's built-in IDV Standard. The IDP path gives you broader control over how Incode is wired into Okta: as an OIDC-based authenticator, as a full SSO provider, or both.

This integration is commonly used when you want Incode biometric verification to function as an MFA factor within Okta authentication and enrollment policies, rather than as a separate identity verification step triggered by Okta's IDV Standard.

***

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- An Okta Identity Engine (OIE) instance.
- An Okta administrator account with permissions to add and modify Identity Providers, Authenticators, and Authentication Policies.

***

## Understand Okta IDP

The IDP integration uses an OIDC Identity Provider configured in Okta, backed by Incode. When a user is required to authenticate with the Incode factor, Okta redirects them to an Incode verification session through the OIDC flow. After the session completes, Incode returns a signed token to Okta to confirm the result.

After the OIDC IDP is set up, you create an Okta Authenticator that wraps it, then reference that authenticator in your Enrollment and Authentication Policies to control when and for which users Incode verification is required.

***

## Okta Environment Compatibility

Okta offers two environments with slightly different configuration paths. Use the page for your environment:

- [Okta Authenticator (Preview/OIE)](/ecosystem-workforce/okta-authenticator-previewoie/)
- [Okta Authenticator (Classic)](/ecosystem-workforce/okta-authenticator-classic/)

If you are unsure which environment your organization uses, check your Okta Admin Console. OIE instances show “Identity Engine” in the footer.

***

## What's Next

After completing authenticator setup, you can also:

- [**Configure Incode as an SSO Provider**](/ecosystem-workforce/configure-incode-as-sso-provider-with-okta-idp/): Set up Incode to act as the SSO provider for Okta-connected applications, enabling biometric login across your app portfolio.
- [**Sync your Okta Directory**](/ecosystem-workforce/okta-directory/): Sync your Okta user directory with Incode to enable employee lookups and claims matching.

<br />

---

- Path: `ecosystem-workforce/okta-idv-standard`
- URL: https://developer.incode.com/ecosystem-workforce/okta-idv-standard/
- Markdown: https://developer.incode.com/ecosystem-workforce/okta-idv-standard.md

# Okta IDV Standard

The Okta IDV Standard integration adds Incode biometric identity verification as a native step within Okta authentication policies. Using the Okta Identity Verification Standard, Incode is registered as a third-party identity verification provider directly in Okta, no custom redirects or middleware required.

After you configure the integration, Okta can invoke an Incode verification session at any point in an authentication policy: during account recovery, MFA reset, step-up authentication, or high-assurance sign-in flows. The verified result is returned to Okta and used to allow or block the user from completing the flow.

This integration is listed on the [Okta Integration Network (OIN)](https://www.okta.com/integrations/).

:::info
**Okta IDV Standard vs. Okta IDP**. The Okta IDV Standard integration uses Okta's native Identity Verification Standard protocol to invoke Incode from within an Okta authentication policy. The [Okta IDP integration](/ecosystem-workforce/okta-idp/) configures Incode as a full identity provider and authenticator for your Okta organization. Both can be used independently or together depending on your use case.
:::

## Prerequisites

Ensure you have the following before you begin:

- Access to the Integrations page in Dashboard. Contact your Incode representative if you do not see it.
- A [Workflow](/dashboard-platform-administration/workflows-20/) created for this integration.
- An Okta Identity Engine (OIE) instance.
- An Okta administrator account with permissions to add and modify Identity Providers and Authentication Policies.
- The **Identity verification with third-party identity verification vendors** Early Access feature enabled on your Okta instance.

> 📘 **Tip**
>
> To enable this feature, go to your Okta Admin Console > **Settings** > **Features** and search for "Identity verification with third-party identity verification vendors". Enable it. If the feature is not visible, contact Okta support to request access.

## What This Integration Enables

After it's configured, you can use the Okta IDV Standard integration to add Incode verification to the following flows:

- **Account resets and recovery**: Verify a user's identity before allowing a password reset or account unlock. See [Account resets & recovery](/ecosystem-workforce/account-resets-recovery-with-okta-idv/).
- **Passwordless sign-in**: Gate high-assurance sign-in steps with biometric verification. See [Passwordless sign-in](/ecosystem-workforce/passwordless-sign-in-with-okta-idv-standard/).
- **Custom claims matching**: Configure which identity attributes are matched against your Okta directory during verification. See [Configure claims matching](/ecosystem-workforce/configure-claims-matching-with-okta-idv-standard/).

## Set Up Okta IDV Standard Integration

### Create the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the **IAM** tab, select **Okta IDV Standard**, then click **Continue**.
5. Enter a **Name** for this integration.
6. **Select a Workflow** from the drop-down for this integration.
7. Enter your **Okta instance URL** in this format: `https://yourcompanyname.okta.com`.
8. Copy the generated **Client ID** and **Client Secret**. These are required for the next steps.
9. Click **Save**.

:::warning
The Client Secret is shown only once. Store it securely before navigating away from this screen.
:::

![](https://developer.incode.com/assets/95aab07307b5e344a2e5f6af39d40f19.png)

### Configure Incode IDV in Okta

1. Log in to your Okta Admin Console.
2. Navigate to **Security** > **Identity Providers**.
3. Click **Add Identity Provider** and select **Incode IDV**.
4. Enter a name for your integration.

   ![](https://developer.incode.com/assets/ef06c5c24002b150e0ee936f9a7ee8b1.png)
5. Paste the **Client ID** and **Client Secret** copied from the previous steps.
6. Click **Finish**.

   ![](https://developer.incode.com/assets/b84b0ca1d60dd4cf676923bbb84c5060.png)

For **Custom IDV** for Sandbox, use the following endpoints:

- Issuer: https://auth.demo.incode.com
- PAR request URL: https://auth.demo.incode.com/oauth2/par
- Authorize URL: https://auth.demo.incode.com/oauth2/authorize
- Token URL: https://auth.demo.incode.com/oauth2/token
- JWKS URL: https://auth.demo.incode.com/oauth2/jwks

[Watch the demo →](https://youtu.be/tpWFCe7ucpw?si=uxXn1xoW31iSIMRy)

---

- Path: `ecosystem-workforce/passwordless-sign-in-with-okta-idv-standard`
- URL: https://developer.incode.com/ecosystem-workforce/passwordless-sign-in-with-okta-idv-standard/
- Markdown: https://developer.incode.com/ecosystem-workforce/passwordless-sign-in-with-okta-idv-standard.md

# Passwordless Sign-In with Okta IDV Standard

You can configure a passwordless sign-in experience using Incode IDV and Okta Fastpass. In this flow, users authenticate with Okta Verify with Fastpass instead of a password. Incode IDV is used during the initial enrollment step to verify the user's identity before Fastpass is provisioned to their device.

***

## Prerequisites

Ensure you have the following before you begin:

- [Okta IDV Standard](/ecosystem-workforce/okta-idv-standard/) setup page complete
- Okta Verify installed on users' devices
- Okta Device Trust configured for your organization
- Familiarity with Okta Fastpass and Okta passwordless sign-in configuration

***

## Understand Passwordless Sign-In with IDV

This flow uses Incode IDV as a one-time identity proofing step during Fastpass enrollment. It does not invoke Incode on every sign-in, only during the initial setup of Okta Verify on a user's device. The enrollment sequence works as follows:

1. The user's password is removed from their Okta profile and their authenticators are reset.
2. The user opens the Okta Verify app and begins enrollment using your organization's domain.
3. Okta's enrollment policy requires identity verification. Incode IDV is invoked and the user completes a document and biometric check on their device.
4. On successful verification, Okta provisions Fastpass to the device.
5. From that point forward, the user signs in using Okta Verify with Fastpass, no password required.

***

## Set Up Passwordless Sign-In

### Configure Authenticators

1. Log in to your Okta Admin Console.
2. Go to **Security** > **Authenticators**.
3. Edit **Email** and enable it for both **Authentication and Recovery**.

### Set Up an Enrollment Policy

1. Under **Authenticators**, select **Enrollment**.
2. Edit an existing enrollment policy or add a new one tied to the group of users you want to enroll in passwordless sign-in: for example, a group named **Incode Identity Verification**.
3. Set **Email** and **Okta Verify** as required authenticators in the policy.

> 📘 **Tip**
>
> Okta recommends keeping admin users in a separate group with password access maintained to avoid locking out administrators.

### Create a Passwordless Authentication Policy

1. Go to **Security** > **Authentication Policies**.
2. Create a new policy: for example, **Passwordless Policy**.
3. Set the **Catch-all Rule** to **Deny**.
4. Add a new rule with the following configuration:
   - **Rule name**: For example, _Incode Passwordless_
   - **IF—User's group membership includes**: Your passwordless users group
   - **THEN—User must authenticate with**: Possession factor
   - In the **Allowed Authenticators** list, ensure only **Okta Verify—Fastpass** is shown. Use **Allow specific authentication methods** if additional control is needed.
5. Assign the **Okta Dashboard** app to this policy.

### Update the Global Session Policy

1. Go to **Security** > **Global Session Policy**.
2. Edit your Global Session Policy rule.
3. Set **Establish the user session with** to **Any factor used to meet the Authentication Policy requirements**.
4. Save the rule.

### Enroll and Test

1. Reset a test user's authenticators and remove their password from the user's Okta profile.
2. Have the test user sign in to the Okta Verify app directly using your organization's domain.
3. Confirm the user is prompted to verify their identity via Incode IDV before Fastpass is provisioned to their device.
4. After successful verification, confirm the user can sign in using Okta Fastpass without a password.

> ⚠️ **Warning**
>
> If the user is not prompted for Incode IDV during enrollment, confirm that the enrollment policy is applied to the correct group and that Okta Verify is set as a required authenticator. If the user is prompted for a<br />password, verify that the catch-all rule in the passwordless authentication policy is set to **Deny** and that the policy is assigned to the Okta Dashboard app.

***

## What's Next

- [Configure claims matching](/ecosystem-workforce/configure-claims-matching-with-okta-idv-standard/)
- Account resets & recovery

<br />

---

- Path: `ecosystem-workforce/ping-davinci`
- URL: https://developer.incode.com/ecosystem-workforce/ping-davinci/
- Markdown: https://developer.incode.com/ecosystem-workforce/ping-davinci.md

# Ping DaVinci

You can integrate Incode identity verification (IDV) into your PingOne DaVinci flows using the Incode DaVinci Connector. The connector connects verified real-world identities to Ping Identity user profiles through OpenID Connect (OIDC), enabling identity verification and face authentication as drag-and-drop nodes in DaVinci orchestration flows.

The Incode DaVinci connector is published in the [Ping Identity Marketplace](https://marketplace.pingone.com/item/incode-davinci-connector) and supports both customer identity (CIAM) and workforce identity (IAM) use cases.

***

## Prerequisites

Ensure you have the following before you begin:

- A PingOne DaVinci environment with permission to add connectors.
- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- An Incode Standard Workflow configured for your verification use case.

***

## Integration Flow

1. A user reaches the Incode Connector node in your DaVinci flow.
2. DaVinci redirects the user to Incode using OIDC.
3. The user completes identity verification on their device: ID document capture, liveness detection, and face match.
4. Incode redirects the user back to DaVinci with an authorization code and ID token containing verification claims.
5. After Incode has verified a user's real-world identity, face authentication can be enabled to confirm their identity in subsequent flows.

***

## Supported Use Cases

- **User registration**: Verify real-world identity as part of new user registration and create the Ping Identity user profile with verified claims.
- **Account recovery**: Verify identity before granting account access during recovery flows.
- **Password resets**: Gate password resets behind biometric verification.
- **Conditional step-up**: Trigger identity verification as an additional authentication factor when risk signals are detected.

***

## Set Up the DaVinci Integration

### Create the OIDC integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the **Custom** tab, select **OIDC**, then click **Continue**.
5. Enter a **Name** for this integration: for example, `Ping DaVinci`.
6. Configure the **Redirect URI**: this must match the Redirect URI in your Ping DaVinci connector configuration.
7. **Select a Workflow** for this integration from the drop-down.
8. Click **Save**. A client ID and client secret are generated.

> 📘 **Note**
>
> The client secret is shown only once. Store it securely before navigating away from this screen.

### Add the Incode Connector in DaVinci

In DaVinci, add an Incode connection. For help, see the Ping documentation on [Adding a connection](https://docs.pingidentity.com/davinci/connectors/davinci_connections.html).

Configure the connector with the following values:

| Field         | Value                                                                                                      |
| ------------- | ---------------------------------------------------------------------------------------------------------- |
| App ID        | The client ID from the Incode OIDC client configuration                                                    |
| Client Secret | The client secret from the Incode OIDC client configuration                                                |
| Issuer URL    | The Issuer URL for Incode's authorization server, provided by Incode                                       |
| Scope         | List of space-separated scopes—must match exactly those configured in the Incode OIDC client configuration |

### Add the Connector Node to Your Flow

Place the Incode Connector node at the point in your DaVinci flow where identity verification should occur. This is typically during new user registration, so the Ping Identity user profile is created with verified claims.

### Enable Face Authentication

After a user has been onboarded with Incode, you can use the connector's face authentication capability in subsequent flows to verify the user's real-world identity without another document capture.

***

## Troubleshooting

### **Redirect URI Mismatch**

Confirm that the Redirect URI in the Incode OIDC client configuration exactly matches the Redirect URI within the Incode Ping DaVinci connector configuration.

### **Environment Mismatch**

Confirm with your Incode Representative that your account is provisioned in the correct environment for the Issuer URL in your connector configuration.

![](https://developer.incode.com/assets/0972c71dfa292cda4488ffeec5fe9752.png)

***

## Additional Resources

- [Incode DaVinci Connector on Ping Identity Marketplace](https://marketplace.pingone.com/item/incode-davinci-connector)
- [Incode DaVinci Connector documentation](https://pingone-davinci.github.io/documentation/inocde/)
- [PingOne DaVinci Connector Library](https://marketplace.pingone.com/browse?products=davinci\&contentType=davinciConnectors)

<br />

---

- Path: `ecosystem-workforce/productivity-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/productivity-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/productivity-integrations.md

# Productivity Integrations

Productivity integrations bring identity verification into the collaboration tools your teams use every day. Instead of requiring employees to visit a separate portal or app, they can send and complete verification requests within familiar tools like Slack.

These integrations are well-suited for IT and security use cases where agents need to confirm someone's identity quickly without interrupting the normal flow of work.

When a verification is triggered from a productivity tool, Incode delivers a verification link to the employee through the same channel. The employee completes the session on their mobile device and the result is returned to the agent or system that initiated the request.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available Productivity Integrations

<ProductivityIntegrations />

<Component slug="productivity-integrations-table" />

---

- Path: `ecosystem-workforce/recruitment-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/recruitment-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/recruitment-integrations.md

# Recruitment Integrations

Recruitment integrations let you initiate identity verification from your applicant tracking system (ATS) as part of the hiring process. They are designed for candidate verification use cases, where confirming a candidate's legal identity is a required step before an offer is extended, a background check is initiated, or onboarding begins.

These integrations trigger identity verification directly from the tools your recruiting teams already use, instead of running it as a separate process.

When a verification is triggered from a recruitment platform, Incode delivers a one-time verification link to the candidate through email. The candidate completes the session on their mobile device and the result is returned to the originating platform automatically.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.



<IntegrationsEnablement />

***

## Available Recruitment Integrations

<RecruitmentIntegrations />

<Component slug="recruitment-integrations-table" />

---

- Path: `ecosystem-workforce/sailpoint-identity-security-cloud`
- URL: https://developer.incode.com/ecosystem-workforce/sailpoint-identity-security-cloud/
- Markdown: https://developer.incode.com/ecosystem-workforce/sailpoint-identity-security-cloud.md

# SailPoint Identity Security Cloud

SailPoint Identity Security Cloud is an enterprise identity governance platform used by large organizations to manage access certification, provisioning, and lifecycle management across their application portfolio.

The Incode and SailPoint integration adds biometric identity verification as a step within SailPoint identity governance workflows. When a user requires elevated identity assurance—such as during access certification, privileged account provisioning, or a high-risk lifecycle event—SailPoint triggers an Incode verification session. The verified result is returned to SailPoint and used to approve, deny, or escalate the governance action.

This integration is delivered through IdRamp, Incode's identity orchestration partner, which manages the connection between SailPoint Identity Security Cloud and the Incode verification platform.

***

## Integration Flow

The integration uses IdRamp as middleware between SailPoint and Incode. IdRamp handles the OIDC connection, session orchestration, and result routing so that no custom development is required on the SailPoint side. When a governance event triggers verification:

1. SailPoint routes the user to IdRamp through the configured integration step.
2. IdRamp calls the Incode API to create a verification session and delivers the link to the user.
3. The user completes biometric verification on their device.
4. Incode returns the result to IdRamp.
5. IdRamp posts the outcome back to SailPoint to complete the governance action.

***

## Prerequisites

Ensure you have the following before you begin:

- An active SailPoint Identity Security Cloud tenant.
- An Incode account with the Integrations Ecosystem feature enabled.
- An IdRamp account. Contact your Incode Representative to be connected with IdRamp as part of this integration.

***

## Set Up the SailPoint Integration

Detailed setup documentation for this integration is managed by IdRamp. To get started:

1. Contact your Incode Representative to request access to the SailPoint integration.
2. Your account manager connects you with the IdRamp team, who provides configuration instructions specific to your SailPoint tenant.
3. After IdRamp is configured, Incode verification sessions can be triggered from within your SailPoint governance workflows.

> 📘 **Note**
>
> This integration requires coordination between your Incode account team and IdRamp. Setup timelines depend on IdRamp availability. Contact [support.incode.com](https://support.incode.com) to initiate the process.

***

## Support

- Incode support: [support.incode.com](https://support.incode.com)
- Developer documentation: [developer.incode.com](https://developer.incode.com)

<br />

---

- Path: `ecosystem-workforce/salesforce`
- URL: https://developer.incode.com/ecosystem-workforce/salesforce/
- Markdown: https://developer.incode.com/ecosystem-workforce/salesforce.md

# Salesforce

This guide walks you through everything you need to do after installing the **Incode Identity Verification for Salesforce** package. By the end, your team will be able to trigger identity and/or business verification directly from any Contact, Lead, or Account record and see results update in real time.

You do not need to be a developer to complete this guide. Each step is numbered and takes about 20–30 minutes total.

***

## What is Incode Verification for Salesforce?

**Incode Verification for Salesforce** is a managed package that brings Incode's identity verification (IDV) and business verification (KYB) directly into the Salesforce records your teams already work in: Contact, Lead, and Account. Sales, RevOps, and Compliance users can request a verification, watch its status update in real time, and review the result without ever leaving the CRM.

One click sends the customer a secure verification link by email. As Incode processes the session, webhook callbacks push the outcome back into Salesforce through a Platform Event, so the requesting user sees the status flip from **Pending,** **Approved**, or **Declined** inline, with no page refresh required.

The package ships with:

- A **Lightning record-page component** for Contact, Lead, and Account, configurable per layout as either an IDV or KYB card via Lightning App Builder.
- **IDV flows** for individuals, government ID capture, selfie, liveness, and face match, and any other module you might need from our solution.
- **KYB flows** for businesses, allowing the verification of business name and TIN lookup, registration status, entity type, address, and UBO/Director matching.
- **Branded verification emails** containing links the customer can follow to complete verification on their own device.
- **Real-time push-based status updates** via Platform Events.
- **Verification history** on every record, with a drill-down Session Details modal you can drill into:&#x20;
  - **IDV**: sub-scores (ID Verification, Face Recognition, Liveness, GovMatch, Video Selfie) and the captured selfie, front-ID, and back-ID images
  - **KYB**: the full eKYB response (business name, TIN, address, registration status, entity type) and UBO/Director matches
- **Optional storage of score JSON and captured ID images** in Salesforce Files for compliance review.

## Why does this integration matter?

Most teams that need identity or business verification today live in two systems: their CRM, where the customer relationship is tracked, and their verification dashboard, where the actual check happens. That split has a real cost:

- **Slower onboarding.** Reps copy data between tools, chase customers through email threads, and lose context as deals move forward.
- **Weaker audit posture.** Verification outcomes live in one system and the commercial record in another, making it hard to prove _who_ was verified, _when_, and against _what flow_.
- **Inconsistent fraud protection.** Without verification embedded in the workflow, it often gets skipped on lower-priority accounts until a problem surfaces.

This integration closes that gap. Verification becomes a one-click step inside the same record where the deal, the contact, and the case history already live. For legitimate customers, onboarding gets faster. For compliance and AML teams, the audit trail gets tighter. For the business, fraud protection extends to every account, not just the high-value ones.

## Who is it for?

- **B2C and financial services teams** running KYC at Contact or Lead creation
- **B2B sales and onboarding teams** running KYB before opening a new business account
- **Compliance, AML, and Risk teams** that need a defensible audit trail tying each verification to a Salesforce record
- **Teams handling regulated or high-value transactions** that benefit from step-up verification at contract or payment milestones

## 📦 Latest Package Installation Link

Use the link below to install or upgrade to the latest version of the package:

Latest version: **v0.10.0-1**:

- Production: [https://login.salesforce.com/packaging/installPackage.apexp?p0=04tJx0000005PsDIAU](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tJx0000005PsDIAU)
- Sandbox: [https://test.salesforce.com/packaging/installPackage.apexp?p0=04tJx0000005PsDIAU](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tJx0000005PsDIAU)

> 📘 **Note**
>
> The links above always point to the current latest version. This page is updated with every new release, and previous versions are documented in [Version History](#version-history) below.

> 📌 **Tip — install/upgrade into a specific org**
>
> The link above defaults to `login.salesforce.com`, which routes you through the standard Salesforce login picker. To go straight to the install/upgrade wizard inside a specific target org (e.g. a sandbox you're already logged into), swap the host with the target org's My Domain URL.
>
> For example, if the target org is `https://acme--sandbox.sandbox.lightning.force.com/lightning/page/home`, change the path so the URL becomes:
>
> `https://acme--sandbox.sandbox.lightning.force.com/packaging/installPackage.apexp?p0=04tJx0000005PsDIAU`
>
> Opening that URL while logged into `acme--sandbox` takes you directly to the install/upgrade wizard for that org. The same pattern works for any sandbox, scratch org, or production org — keep the `/packaging/installPackage.apexp?p0=…` suffix and only swap the host.

### Version History

| Version   | Released   | Highlights                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| v0.10.0-1 | 2026-05-31 | Combined IDV + KYB managed package · Real-time updates via Platform Events · Manual Review status writable · Webhook Secret + X-Incode-Secret header · Use Production API toggle · Store Score And Images toggle · Branded verification emails (auto-routed IDV vs KYB) · Session Details modal · Three permission sets (Admin / User / Webhook Guest) · Salesforce Site + Apex REST endpoint · Post-install setup script + idempotent Run Setup button |

***

## Installation

The installation links above take you to the following screens:

1. Select **Install for All Users**.

> 📘 **Note**
>
> Remember to set proper settings regarding user access.

2. Click **Install**.

![](https://developer.incode.com/assets/17eb2f84e1f4ae738290c40e040e5fdb.png)

3. In the pop-up requesting third-party access, check **Yes, grant access to these third-party web sites**. You must accept it because the managed package needs to communicate with the Incode solution through APIs. Click **Continue**.

![](https://developer.incode.com/assets/ba54097f69c93651100b87a5abd2dc0e.png)

4. A successful installation shows the following page with the "Installation Complete!" message. Click **Done**.

![](https://developer.incode.com/assets/d976f22efe140d19b5366bb95eec8ade.png)

## What the package automates for you

When you install or upgrade the package, a post-install script runs automatically and handles the following:

- **Creates the default Incode Config record**. You only need to fill in your API Key and Configuration ID (Flow ID).
- **Verifies both Named Credentials are present** and warns you if either is missing.
- **Auto-creates two email templates** into the `Incode Templates` folder with automatic routing by verification type:
  - **Incode Verification Request** (IDV)
  - **Incode KYB Verification Request** (KYB)
    You create the folder once (Step 3), then `Run Setup` in Step 4 to create both templates inside it.
- **Assigns the&#x20;**`Incode_Webhook_Guest`**&#x20;permission set to the Site Guest User** once the Salesforce Site exists. You create the Site (Step 2), then `Run Setup` in Step 4 to pick it up and assign the permset automatically.

After install, you can re-run automated setup any time from the **App Launcher → Incode Setup → Run Setup** button. It is idempotent and safe to click after every package upgrade or whenever you make a manual config change. Anyone running this needs the **Incode Admin** permission set assigned (and the **Customize Application** permission, which System Administrators have by default).

***

## Before You Begin

### What you will need from Incode

Before starting, make sure you have received the following from your Incode account team:

| Item                         | Where to find it                                                                                                                                           |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **API Key**                  | Incode Dashboard → Configuration → API Keys                                                                                                                |
| **Demo or Prod environment** | You would need access to a sandbox or production environment of Dashboard to properly perform this integration.                                            |
| **Onboarding Flow**          | You must have an active onboarding flow configured in Dashboard. If you do not have one yet, create one under **Flow Builder** before proceeding.          |
| **Configuration ID**         | The ID of your onboarding flow. Incode Dashboard → Flow Builder → Flows → copy the **Flow URL**.                                                           |
| **Webhook URL slot**         | Incode Dashboard → Configuration Webhooks (you will paste a URL here in Step 2)                                                                            |
| **Environment**              | Confirm whether you are connecting to the **Demo** environment (`demo-api.incodesmile.com`) or the **Production** environment (`saas-api.incodesmile.com`) |

> 📘 **Tip**
>
> If you do not yet have an Incode account or API credentials, contact your Incode representative before proceeding. Nothing in this guide will work without a valid API Key, an onboarding flow, and its Flow ID.

### Salesforce prerequisites

- You must be a **Salesforce System Administrator** (or have the "Customize Application" and "Modify All Data" permissions).
- The package must already be installed. If you have not installed it yet, use the link at the top of this page before continuing.
- Your org must have **My Domain** enabled (Setup → My Domain). Lightning Experience components require My Domain to be active.
- Your org must have the **sending email domain verified** and **email deliverability** set to "All Email". See Step 0 below.

***

## Step 0 — Verify Email Domain and Deliverability

Salesforce requires that your organization's **email domain** is verified before any emails can be sent — even if your individual user email address shows as verified. Without this, the package will fail with: _"We can't send your email because your email address domain isn't verified."_

### Option A — Verify your email domain (recommended for Production)

This is the recommended approach for production orgs. It verifies your domain via DNS so all users with that email domain can send emails.

1. In Setup, type `Email Domain Verification` in Quick Find and click the result (under **Email**).
2. If your domain (e.g., `yourcompany.com`) is not listed, click **Add Domain**.
3. Enter your email domain — this is the part after the `@` in your Salesforce user email addresses.
4. Salesforce will generate **DNS TXT records** that must be added to your domain's DNS configuration.
5. Work with your IT/DNS administrator to add the provided TXT records to your domain's DNS.
6. Return to the page and click **Verify**. DNS propagation can take up to 72 hours.

> 📘 **Note**
>
> This is a one-time org-level setup. Once the domain is verified, all users in the org whose email address uses that domain can send emails.

### Option B — Use a substitute email address (quick fix for Sandbox / Scratch Orgs)

If you are working in a sandbox, scratch org, or developer edition and do not have access to DNS settings, you can enable a substitute sender address instead of verifying the domain.

1. In Setup, type `Deliverability` in Quick Find and click **Deliverability**.
2. Under **Email Security Compliance**, check **Use a substitute email address for unverified domains**.
3. Click **Save**.

   ![](https://developer.incode.com/assets/79bb6f7ca7d5410954c3bb1025326009.png)

Salesforce will replace the unverified "From" address with a generic Salesforce no-reply address. The recipient still receives the email, but the sender name will not show your domain.

> ⚠️ **Important**
>
> This is a workaround for testing and development. For production orgs, use Option A so emails are sent from your real domain and are less likely to be flagged as spam.

> ⚠️ **Substitute address is not a complete bypass.**&#x20;
>
> Even with this enabled, Salesforce still requires the **sending user's email address itself** to be verified (see "Verify the sending user's email" below). Substitute-address handles the _domain_ check, not the _user_ check. If you skip the next step, verification requests will appear to succeed in Salesforce (a "Pending" row shows up) but no email will ever reach the recipient.

### Verify the sending user's email (required for Sandbox / Scratch Orgs)

Salesforce will refuse to send any outbound email if the user triggering the send has an unverified email address on their User record. This is separate from domain verification (Option A) and is **not** bypassed by substitute address (Option B).

In production orgs, this is rarely an issue, as admins log in with their already-verified work email. In **scratch orgs and freshly cloned sandboxes**, the auto-generated user often has a synthetic email address (e.g., `user.abc123@example.com`) that you can't actually receive mail at, which means the verification link Salesforce sends is unreachable. You need to point the user at a real inbox you control before requesting verifications.

1. In Setup, type `Users` in Quick Find and click **Users**.
2. Click your user's name (the one you're logged in as).
3. Click **Edit**.
4. Change the **Email** field to a real address you can receive mail at. For testing, a personal Gmail address works fine (e.g., `yourname+sfdev@gmail.com`).
5. Click **Save**.
6. Salesforce sends a verification email to that address. Open your inbox, find the message from Salesforce, and click the verification link.
7. Return to Salesforce — the email is now verified for use as the From address.

![](https://developer.incode.com/assets/c9b501c02926c50a4cd5e53c0d15f8ab.png)

> 📘 **Why this matters**
>
> Scratch org users default to a synthetic @example.com email that no one can read. Without changing it to a real address and verifying it, every outbound email from that user, verification requests included, will silently fail.

### Confirm email deliverability

1. In Setup, type `Deliverability` in Quick Find and click **Deliverability**.
2. Ensure **Access to Send Email** is set to **_All Email_**. New sandbox and scratch orgs default to "System Email Only", which blocks all outbound emails except password resets.
3. Click **Save**.

### Test the email setup before continuing

Before moving on to Step 1, confirm Salesforce can actually send mail from this org:

1. In Setup, type `Test Deliverability` in Quick Find and click **Test Deliverability**.
2. Enter your own email address and click **Send**.
3. Salesforce sends test emails. They should arrive within 1–2 minutes (check spam if they don't).

**If you see _"The FROM address has not been verified"_:** the sending user's email is unverified. Go back to _"Verify the sending user's email"_ above.

**If the test succeeds but no emails arrive:** check spam, then check Setup → **Email Log Files** to see what Salesforce reports for each attempt.

**If the test succeeds and emails arrive:** email setup is complete. Proceed to Step 1.

***

## Step 1 — Configure Custom Settings

The default Incode Config record is auto-created at install time. You only need to populate the values.

1. In Setup, type `Custom Settings` in Quick Find and click the result.
2. Find **Incode Config** in the list and click **Manage** next to it.
3. Click **Edit** on the org-default row (auto-created).
4. Fill in the fields:

| Field                      | What to enter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **API Key**                | Your Incode API Key (e.g. `eyJhbG...`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **Configuration ID**       | Your onboarding Flow ID for the IDV flow from Dashboard (e.g. `6421abc123def456`)                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **KYB Configuration ID**   | Your onboarding Flow ID for the business verification flow from Dashboard (e.g. `6421abc123def487`)                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **Webhook Secret**         | Optional. Leave blank for now — add it later if Incode provides one.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Use Production API**     | Leave **unchecked** for Demo. Check this box **only** when you are ready to go live after testing end-to-end and confirming verifications are working.                                                                                                                                                                                                                                                                                                                                                                                |
| **Store Score And Images** | Optional checkbox, off by default. When enabled, completed IDV sessions store the full score result plus the selfie, front-ID, and back-ID images into Salesforce Files attached to the verification record, and enable the per-row details modal (see Step 7). <br />Enabling Store Score And Images persists copies of government-ID images in Salesforce Files. <br />Confirm this is consistent with your org's data-retention and privacy policies before turning it on. KYB/IDV status, score, and history all work without it. |

![](https://developer.incode.com/assets/bc34aa660d596984040f28e36d6243ee.png)

<br />

![](https://developer.incode.com/assets/1de8885423d3fcd39a7a4457990b62d6.png)

5. Click **Save**.

***

## Step 2 — Create the Webhook Endpoint (Salesforce Site + Incode Dashboard)

The Incode platform needs a public HTTPS URL to send verification results back to Salesforce. This is a two-part step: first you create a public Salesforce **Site** that exposes the webhook endpoint, then you register that endpoint URL with Incode Dashboard so it knows where to `POST` results.

> 📘 **Why manual?**
>
> Salesforce does not allow Sites (CustomSite metadata) to be included in second-generation managed packages. This is a one-time setup step.

### Part A — Create and Activate the Salesforce Site

The package includes the Visualforce pages the Site needs, you just need to wire them up.

1. In Setup, type `Sites` in Quick Find and click **Sites**.
2. If this is your first Site, Salesforce will ask you to **register a Sites domain**. Accept the suggested domain (e.g. `yourcompany.my.salesforce-sites.com`) and click **Register My Salesforce Site Domain**. Wait for registration to complete.
3. Click **New** to create a new Site.
4. Fill in the Site details:

| Field                     | Value                                                                                                                                                                                                                                                                                                                               |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Site Label**            | Any label works. We suggest a name containing the word `Incode` (e.g. `IncodeWebhook`, `IncodeIdentity`). `Run Setup` in Step 4 finds the Site's Guest User by matching "Incode" in the auto-generated profile name. If you choose a label without "Incode", you'll need to assign the Webhook Guest permset manually (see Step 5). |
| **Site Name**             | Auto-populates from the label                                                                                                                                                                                                                                                                                                       |
| **Active**                | Checked                                                                                                                                                                                                                                                                                                                             |
| **Active Site Home Page** | Select `incode__Incode_Webhook_Home` (provided by the package)                                                                                                                                                                                                                                                                      |

![](https://developer.incode.com/assets/ea92ab37e97d7c6d10290686aff6b960.png)

5. Click **Save**.

6. Once saved, copy the **Site URL** shown on the Site detail page. Salesforce computes this for you — by default it is just your registered Sites domain with no path component, e.g.:

   ```
   https://yourcompany.my.salesforce-sites.com
   ```

   If your org's Site has a custom **Default Web Address** set on the Site record, the URL will include that path segment. Always use whatever Salesforce displays as the Site URL, not the Site Name.

7. Your full webhook endpoint URL is the Site URL + `/services/apexrest/incode/webhook`. For the typical case above:

   ```
   https://yourcompany.my.salesforce-sites.com/services/apexrest/incode/webhook
   ```

Keep this URL handy — you'll paste it into the Incode Dashboard in Part B.

> 📘 **Tip**
>
> `incode` in the URL path (before `/webhook`) is the managed package namespace, automatically prepended by Salesforce. `webhook` is the REST endpoint mapping. Neither depends on the Site label you chose.

### Part B — Register the Webhook URL in the Incode Dashboard

You are registering an **Onboarding status webhook url,** this is the hook Incode fires when a verification session ends (whether the user finished, failed, or was sent to manual review). Without it, the status in Salesforce will stay **Pending** indefinitely.

1. Log in to the **Incode Dashboard** (your Incode account manager can provide the URL).
2. In the left menu, click **Configuration**.
3. Switch to the **Webhooks** tab.
4. Scroll down and click **Generate new**.
5. Use the **Type** drop-down to select **_Onboarding status webhook url_**. The package listens for the `ONBOARDING_FINISHED` event, which is delivered exclusively through this webhook.
6. In the **URL** field, enter the full webhook URL from Part A (e.g. `https://yourcompany.my.salesforce-sites.com/services/apexrest/incode/webhook`). Use whatever Salesforce shows as the Site URL, do **not** insert the Site Name as a path segment unless your Site has a custom Default Web Address
7. Click **Save**.

![](https://developer.incode.com/assets/a13ec20c5c66bfb52ccfe083c9bfbfb5.png)

<br />

If you entered a Webhook Secret in Step 1:

1. Scroll up to the General section of the Configuration > Webhooks.&#x20;
2. Click the **+** under Webhook custom headers.
3. For **Custom Header Key**, enter **_X-Incode-Secret_**&#x20;
4. For **Custom Header Value**, enter the exact string you entered in the **Webhook Secret** field in Step 1.
5. Click **Update settings**.

Incode will include this header in every POST it sends to Salesforce. The package checks the `X-Incode-Secret` request header on every inbound webhook call and rejects any request where it is missing or does not match — returning HTTP 401 so Incode knows to alert on the failure.&#x20;

***

## Step 3 — (Optional) Create the Email Template Folder

The package includes a built-in fallback email (plain HTML, no template required), so verification emails will be delivered even if you skip this step. Creating a named template lets you customize the branding and wording.

> 📘 **Why is this manual?**
>
> The 2GP managed-package builder cannot bundle `EmailFolder` metadata — a known Salesforce platform limitation. The post-install script auto-creates the email template **only if** the folder exists, which means the folder must be created manually first. Step 4 (`Run Setup`) auto-creates the template into it.

### Quickest path

1. In Setup, type `Email Template Folders` in Quick Find and create a new folder:
   - **Folder Label**: `Incode Templates`
   - **Folder Unique Name**: `Incode_Templates` (must match exactly)
   - **Folder Access**: Read/Write

Step 4 will detect the folder and auto-create both templates inside it: **Incode Verification Request** (IDV) and **Incode KYB Verification Request** (KYB). The package automatically routes the email by verification type.

### To customize the template (after Step 4 has created it)

1. In Setup, type `Classic Email Templates` in Quick Find.
2. In the folder dropdown, select **Incode Templates** → click the template you want to customize (**Incode Verification Request** for IDV or **Incode KYB Verification Request** for KYB) → **Edit HTML Version**.
3. Edit the HTML. **Keep these two placeholder strings intact** — the package replaces them at send time:
   - `{{VERIFICATION_URL}}` — the unique verification link
   - `{{FIRST_NAME}}` — the contact/lead's first name (falls back to "there" if blank)
4. Click **Save**.

> 📘 **Note**
>
> These are plain string placeholders, **not** Salesforce merge fields like `{!Contact.FirstName}`. The package only replaces the `{{...}}` tokens.

***

## Step 4 — Run Incode Setup

Open the **App Launcher** (top-left). Search for **Incode Setup**. You should see the Setup Assistant page. Click **Run Setup**.

> 📘 **Don't see the Incode Setup tab?**
>
> You need the **Incode Admin** permission set assigned to your user. Setup → Permission Sets → **Incode Admin** → Manage Assignments → add yourself, then return here. The tab is hidden by default to avoid cluttering end-users' App Launcher.

![](https://developer.incode.com/assets/f2a820a05d8ebd53e7d8d5f903b09d8d.png)

What the **Run Setup** button does (all idempotent):

- Confirms the default **Incode Config** custom-setting record exists.
- Creates (if missing) two email templates inside the **Incode Templates** folder: **Incode Verification Request** (IDV) and **Incode KYB Verification Request** (KYB). The package automatically routes the email by verification type. Skipped with a warning if you did not create the folder in Step 3; the built-in fallback email is used in this case.
- Assigns the **Incode\_Webhook\_Guest** permission set to the Site Guest User. Requires the Site from Step 2 to exist.
- Verifies that Named Credentials `IncodeAPI` and `IncodeAPI_Production` are present (warns if either is missing).

You should see a list of **Created** or **Already in place** entries confirming each task. The post-install script ran the same tasks at install time, so on a fresh install some items will already be in place — that's expected.

### KYB admin credentials (optional)

If you plan to process KYB verifications through Salesforce, the Setup Assistant will prompt you for an Incode admin email and password (the credentials of an admin user on your Incode dashboard). These are required only if you want the per-row Session Details modal to drill into business name, TIN, address, and UBO/Director matches.

**How it works**: The package uses these credentials to call Incode's /executive/log-in endpoint to obtain an access token, which is required to call /omni/single-session for the full KYB result. IDV flows don't require this because the package can call /omni/get/score directly with the onboarding session token.&#x20;

**Storage**: Credentials are stored in a Protected Custom Metadata row inside your Salesforce org, invisible to subscriber-org code outside this package's namespace. They never leave your instance.

**Skipping this step**: Leave the fields blank if you don't need the modal — KYB status, score, and history still work end-to-end without it.

***

## Step 5 — Assign Permission Sets

Two permission sets need to be assigned to internal users. The third (`Incode_Webhook_Guest`) was assigned to the Site Guest User automatically by Step 4.

### Incode\_User (for Salesforce users who will request verifications)

1. In Setup, type `Permission Sets` in Quick Find and click the result.
2. Click **Incode User** from the list.
3. Click **Manage Assignments** → **Add Assignments**.
4. Select all users who should be able to request identity verifications (e.g. your sales team, ops team).
5. If no users appear in your list view, click **Select a List View** and choose **Recently Viewed**.
6. Click **Next**.
   1. Note: Remember to set an assignment expiration if required.

> 📌 **Tip**
>
> You can also assign permission sets from a user's record. Go to the user record → Permission Set Assignments → Edit Assignments.

![](https://developer.incode.com/assets/7bbe563c553b1717327e1d1f3642f3f9.png)

<br />

<br />

![](https://developer.incode.com/assets/a7f86b5161fd45916ee6c58610c6246b.png)

<br />

![](https://developer.incode.com/assets/30a505ae3580094ec5a5884a4523393b.png)

<br />

### Incode\_Admin (for Salesforce admins who will run setup tasks)

Assign this to anyone who should see the **Incode Setup** tab. System Administrators have the underlying `Customize Application` permission they need to actually run the setup, but the tab itself is hidden by default until this permission set is assigned.

1. Setup → Permission Sets → **Incode Admin** → Manage Assignments → **Add Assignments** → pick yourself (and any co-admins) → **Assign**.

### Manual fallback for Incode\_Webhook\_Guest

Step 4 normally assigns this automatically. You only need this fallback if your Site's auto-generated profile name does not contain "Incode" (uncommon — usually means the Site label you chose in Step 2 did not contain "Incode"):

1. Setup → **Sites** → click your Site → **Public Access Settings** → scroll to bottom → **View Users**.
2. Click the Site Guest User → scroll to **Permission Set Assignments** → **Edit Assignments**.
3. Move **Incode Webhook Guest** from Available to Enabled → **Save**.

> 📘 **Note**
>
> You do not need to grant object or field permissions on the guest user profile. The webhook handler runs in system mode for data access and only updates package-owned records.

***

## Step 6 — Add the Component to Record Pages

The "Incode Identity Verification" sidebar card needs to be added to your Contact, Lead, and/or Account record pages using the Lightning App Builder.

Repeat these steps for each record type you want to enable (Contact, Lead, Account).

### For Contact pages:

1. Open any Contact/Lead/Account record.
2. Click the **gear icon** in the top-right of the record page → **Edit Page**.

   ![](https://developer.incode.com/assets/447d21610177a92b9863c6a1fbdb1808.png)
3. In the left panel, scroll down to **Custom** - **Managed** components. You should see **Incode Verification**.

   ![](https://developer.incode.com/assets/9b543f03a96f6e2d5427fd193e28e6ef.png)
4. Drag **Incode Verification** onto the right-hand sidebar of the page layout.

   ![](https://developer.incode.com/assets/a83b18ae85f5236fd71591c30cc65a86.png)
5. Select the verification type:
   1. **IDV:** For regular onboarding flows for individuals verification, ID, selfie, face match, etc.
   2. **KYB:** For business verification flows.
6. Click **Save** → **Activate** → choose **Activate for all users**.
7. Click **Back** (Left arrow) to return to the record.

> 📘 **Note**
>
> If the component shows an error message about missing configuration, go back and check Step 1.

Repeat for the remaining pages as needed.

***

## Step 7 — Test End-to-End

Before rolling out to your team, do a test run.

1. Open a Contact record.
2. In the **Incode Identity Verification** sidebar card, confirm the email address (or type in a test address you have access to).
3. Click **Request Verification**.
4. The history table should update within seconds to show a **Pending** row.
5. Check the inbox — you should receive an email with a verification link.
6. Click the link, complete the verification (ID photo + selfie).
7. Return to the Salesforce record. Within \~10 seconds the status should update to **Approved** (green) or **Declined** (red). If Incode routes the session to manual review, the status will show **Manual Review** (orange) until a reviewer approves or rejects it in the Incode Dashboard, after which it flips to **Approved** or **Declined**.&#x20;

   If **Store Score And Images** is enabled, click any IDV history row to open the Session Details modal (Session Info / ID Verification / Capture Attempts). Images are saved to Salesforce Files the first time an internal user (with the `Incode_User` permission set) opens the modal.

![](https://developer.incode.com/assets/c6e14cac5662b59e58a722ecdee19763.png)

***

## Step 8 — Troubleshooting Common Issues

**"Request Verification" button shows an error immediately**<br />Check Custom Settings (Step 1). API Key or Configuration ID is likely wrong or has extra spaces. Confirm the Demo/Production checkbox matches your environment.

**"We can't send your email because your email address domain isn't verified"**<br />Your sending email domain is not verified at the org level. Go back to Step 0 and complete the Email Domain Verification. This is different from your individual user email being verified — Salesforce requires the _domain itself_ (e.g., `yourcompany.com`) to be verified via DNS TXT records before any emails can be sent from that domain.

**Email is not received by the contact**<br />Check Setup → Email → Deliverability — Access Level must be set to **All Email** (see Step 0). Also check spam.

**"Pending" row appears in Verification History but no email arrives**<br />Salesforce believes it sent the email but it never reached the recipient. The most common cause in sandbox/scratch orgs is an unverified sender email on the User record. Go to Setup → Test Deliverability → send a test email to yourself. If it fails with _"The FROM address has not been verified"_, you need to verify the sending user's email (Step 0, _"Verify the sending user's email"_). Also check the recipient's spam folder and Setup → Email Log Files for delivery details.

**Verification status is not updating after the contact completes the flow**<br />Confirm the Site is Active (Step 2, Part A). Confirm the **ONBOARDING\_FINISHED** event webhook is registered in the Incode Dashboard for the correct configuration (Step 2, Part B). Confirm `Incode_Webhook_Guest` is assigned to the Site Guest User — the easiest way is to click **App Launcher → Incode Setup → Run Setup**; it'll either confirm the assignment is in place or create it. Check Setup → Sites → click your Site → **Site History** for 4xx/5xx errors. If you see HTTP 401 errors in Site History, the `X-Incode-Secret` custom header in the Incode Dashboard is missing or does not match the **Webhook Secret** you entered in Custom Settings (Step 1). If the verification card itself shows the event suffixed with `score-skipped: ...`, see the next entry.

**Verification card shows&#x20;**`Event: ONBOARDING_FINISHED | score-skipped: …`<br />The webhook arrived, but the package could not enqueue the async score reconciliation that decides Approved vs. Declined. The reason is shown after `score-skipped:`:

- `no config` — the Site Guest User cannot read the Incode Config custom setting. Re-install or upgrade the package so the latest `Incode_Webhook_Guest` permset (which grants this access) is applied to the Site Guest User.
- `API key blank` — the API Key in Custom Settings (Step 1) is empty. Fill it in and re-test with a fresh verification.

**Verification card shows&#x20;**`Event: ONBOARDING_FINISHED | score-fetch-unknown`<br />The webhook arrived and the package called Incode's `/omni/get/score` endpoint, but it returned no usable outcome (HTTP error, malformed response, or missing `overall.status`). Common causes:

- The **Use Production API** toggle in Custom Settings (Step 1) does not match the Incode environment that issued the webhook — e.g., the API Key is for Demo but the toggle is checked. Re-check Step 1.
- The Incode flow occasionally takes a few extra seconds to compute the score after firing the webhook. Re-try the verification — if every attempt shows this suffix, it is a configuration mismatch, not a timing issue.

**Verification row is stuck at "Pending" for a session that Incode sent to manual review**<br />This means the installed package predates v0.10.0, which made the Manual Review status writable on existing orgs. Upgrade to the latest package using the link at the top of this page — after the upgrade, existing Pending rows for manual-review sessions will update correctly when the reviewer approves or rejects in the Incode Dashboard.

**The "Incode Setup" tab is not visible in the App Launcher**<br />Assign the **Incode Admin** permission set to your user. Setup → Permission Sets → Incode Admin → Manage Assignments → Add Assignments. The tab is hidden by default to avoid cluttering end-users' App Launcher.

**Incode Setup → Run Setup says "Site Guest User" warning even after I created the Site**<br />The setup task looks up the Guest User via the Site's auto-generated profile name (which contains "Incode"). If your Site has a different profile name, fall back to the manual permset assignment instructions in Step 5.

**Component shows a configuration error on the record page**<br />Verify Custom Settings were saved (Step 1) and the logged-in user has the `Incode_User` permission set (Step 5).

**Component is not visible on the record page**<br />Must be added via Lightning App Builder. Go back to Step 6 and confirm you saved and activated the page.

***

## Quick Reference Checklist

- [ ] Obtained API Key and Configuration ID from Incode
- [ ] Email domain verified in Setup → Email Domain Verification (Step 0)
- [ ] Email deliverability set to "All Email" (Step 0)
  - [ ] Sending user's email verified (Step 0)
  - [ ] Test Deliverability succeeded (Step 0)
- [ ] Custom Setting **Incode Config**: API Key, Configuration ID, and Production toggle filled in (Step 1)
- [ ] Salesforce Site created and activated (Step 2, Part A)
- [ ] Webhook URL registered in Incode Dashboard, **ONBOARDING\_FINISHED** event selected, for the correct configuration (Step 2, Part B)
- [ ] `X-Incode-Secret` custom header configured in Incode Dashboard (if Webhook Secret was set in Step 1)
- [ ] (Optional) Email folder `Incode_Templates` created (Step 3) — or rely on the built-in fallback email
- [ ] **Incode Admin** permission set assigned to yourself so you can see the Incode Setup tab
- [ ] **Incode Setup → Run Setup** clicked once — auto-creates the email template (if folder exists), assigns the Webhook Guest permset, verifies Named Credentials (Step 4)
- [ ] **Incode\_User** permission set assigned to all relevant Salesforce users (Step 5)
- [ ] **Incode Verification** component added to Contact, Lead, and/or Account record pages (Step 6)
- [ ] End-to-end test completed successfully (Step 7)
- [ ] If any row is stuck at Pending for a session routed to manual review, upgrade to v0.10.0 or later (link at top) — pre-v0.10.0 installs cannot write the Manual Review status to existing orgs

***

_For additional support, contact your Incode account team or raise a support request through the Incode customer portal._

---

- Path: `ecosystem-workforce/self-serve-portal`
- URL: https://developer.incode.com/ecosystem-workforce/self-serve-portal/
- Markdown: https://developer.incode.com/ecosystem-workforce/self-serve-portal.md

# Self-Serve Portal

The Self-Serve Portal lets employees reset their passwords and MFA credentials on their own. The portal uses Incode biometric verification to confirm the employee's identity before allowing any credential changes.

> 📘 Note
>
> The Integrations Ecosystem feature must be enabled for your organization before you can access the Integrations page. Contact your Incode Representative to enable this feature.

***

## Self-Serve Flow

1. **Log in:&#x20;**&#x54;he employee navigates to the Self-Serve Portal and enters their work email. Incode checks that the email exists in the connected directory.
2. **Complete verification:&#x20;**&#x54;he employee scans a QR code or requests an SMS link to complete identity verification on their mobile device. Verification includes a selfie liveness check.
3. **Reset credentials:&#x20;**&#x41;fter successful verification, the browser redirects the employee to the portal where they can reset their password or MFA credentials.

***

## Key Features

- **IAM integration**: The portal displays available reset options based on your organization's connected IAM providers, such as Okta, Microsoft Entra, or Ping Identity.
- **Self-serve reset options**: Employees can reset their MFA authenticator or password directly from the portal.

After selecting a reset option, the employee receives an email from their IAM provider with instructions to complete the process.

> 📘 Note
>
> **Note**: Okta super admins cannot reset their password or MFA using the Self-Serve Portal.

***

## Set Up the Self-Serve Portal

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Locate the **Self-Serve Portal** integration and open its configuration.
4. Configure the portal settings, including any linked IAM integrations such as Okta or Microsoft Entra.
5. Click **Save**. The portal URL is generated and goes live immediately.
6. Share the portal URL with your employees.

---

- Path: `ecosystem-workforce/servicenow`
- URL: https://developer.incode.com/ecosystem-workforce/servicenow/
- Markdown: https://developer.incode.com/ecosystem-workforce/servicenow.md

# ServiceNow

The Incode integration for ServiceNow enables IT helpdesk agents to trigger identity verification sessions directly from supported record forms without leaving ServiceNow. When an agent clicks **Request Identity Verification** on a record, the relevant person receives a secure verification link by email. As they complete the Incode session, the **IDV Status** field on the record updates automatically in real time through webhook.

The integration is available as a scoped application installable from the [ServiceNow Store](https://store.servicenow.com).

***

## Prerequisites

Ensure you have the following before you begin:

- A ServiceNow instance running **Tokyo or later**.
- An `admin` role on the target ServiceNow instance.
- Access to the Integrations page in Dashboard. Contact your Incode representative if you do not see it.
- The following credentials from your Incode Dashboard—see [Find integration details](/dashboard-platform-administration/manage-integrations/#find-integration-details) for where to locate each one:
  | Credential       | Where to find it in Dashboard                   |
  | ---------------- | ----------------------------------------------- |
  | API Key          | Configuration > API Keys                        |
  | Configuration ID | Workflows                                       |
  | Integration ID   | Integrations > open integration > Copy ID       |
  | Client ID        | Integrations > Custom > OIDC Client Credentials |
  | Client Secret    | Integrations > Custom > OIDC Client Credentials |

* Outbound SMTP email configured on your ServiceNow instance

***

## Understand How It Works

1. An agent opens a supported ServiceNow record, such as an Incident or Service Request, and clicks **Request Identity Verification**. A confirmation dialog appears before the request is sent.
2. A verification session is created and a link is emailed to the relevant person on the record: the Caller, Requested For, or equivalent.
3. The person completes the Incode verification session on their device.
4. Incode sends webhook events back to the ServiceNow instance as the session progresses.
5. The **IDV Status** field on the record updates automatically with the result and timestamp.

***

## Supported Record Types

| Record type     | Table             | Person verified |
| --------------- | ----------------- | --------------- |
| Incident        | `incident`        | Caller          |
| Service Request | `sc_request`      | Requested For   |
| Requested Item  | `sc_req_item`     | Requested For   |
| Change Request  | `change_request`  | Requested By    |
| HR Case         | `sn_hr_core_case` | Opened For      |

> 📘 **Note**
>
> HR Case support requires the **HR Service Management Core** plugin (`com.sn_hr_core`) to be installed on your ServiceNow instance before the IDV Status field can be added to the HR Case form layout.

***

## IDV Status Field Values

The **IDV Status** field (`x_1946359_incode_0_idv_status`) on each supported record updates automatically as webhook events are received from Incode. Each status value includes a timestamp of the last update.

| Status                                 | Meaning                                                     |
| -------------------------------------- | ----------------------------------------------------------- |
| `In Progress - YYYY-MM-DD HH:MM:SS`    | Person has opened the verification link                     |
| `Pending Review - YYYY-MM-DD HH:MM:SS` | Verification submitted, awaiting manual review in Dashboard |
| `Success - YYYY-MM-DD HH:MM:SS`        | Identity confirmed, safe to proceed with resolution         |
| `Failed - YYYY-MM-DD HH:MM:SS`         | Verification failed, do not proceed                         |
| `Failure - YYYY-MM-DD HH:MM:SS`        | Session completed with unsuccessful onboarding status       |

***

## Set Up the ServiceNow Integration

### Install the Application

**Option A: ServiceNow Store**

1. Go to [store.servicenow.com](https://store.servicenow.com).
2. Search for **Incode Identity Verification**.
3. Click **Get**, then **Install** on your instance. The app installs automatically as a scoped application.

**Option B: Update Set XML (for PoC or pilot)**

1. In ServiceNow, go to **System Update Sets** > **Retrieved Update Sets**.
2. Click **Import Update Set from XML**.
3. Upload the provided `incode_idv_update_set.xml` file.
4. Click **Preview Update Set**, resolve any conflicts, then click **Commit Update Set**.

### Open the Getting Started Checklist

After installation, go to **Filter Navigator** > **Incode Identity Verification** > **Getting Started**. This guided checklist walks through the remaining setup steps in sequence. Follow it in order: the checklist covers the steps below.

### Configure the application

Navigate to **Incode Identity Verification** > **Configuration** and fill in all sections:

**API Settings**

| Field            | Value                                                               |
| ---------------- | ------------------------------------------------------------------- |
| Base URL         | `https://demo-api.incodesmile.com` (sandbox) or your production URL |
| API Key          | From Dashboard—Configuration > API Keys                             |
| Configuration ID | From Dashboard—Workflows                                            |
| Integration ID   | From Dashboard—Integrations > open integration > Copy ID            |

**OAuth2 Authentication**

| Field           | Value                                                                              |
| --------------- | ---------------------------------------------------------------------------------- |
| Auth Server URL | `https://auth.incode.com` (production) or `https://auth.demo.incode.com` (sandbox) |
| Token URL Path  | `/oauth2/token`                                                                    |
| Grant Type      | `client_credentials`                                                               |
| Client ID       | From Dashboard—Integrations > Custom > OIDC Client Credentials                     |
| Client Secret   | From Dashboard—Integrations > Custom > OIDC Client Credentials                     |
| Scope           | `openid`                                                                           |

**Email Settings**

| Field               | Value                                        |
| ------------------- | -------------------------------------------- |
| SMTP Host           | Your SMTP server (e.g. `smtp.office365.com`) |
| SMTP Port           | `587` (STARTTLS)                             |
| SMTP Username       | Your sending email address                   |
| SMTP Password       | Your SMTP password                           |
| Connection Security | `STARTTLS`                                   |
| From Address        | Must match SMTP username for Office 365      |
| From Name           | e.g. `IT Helpdesk`                           |

> 📘 **Note**
>
> The SMTP fields configure the From address on outbound emails. Actual email delivery uses the ServiceNow platform mailer configured under **System Properties > Email > Outbound** (`glide.smtp.*`). If you need
> a dedicated SMTP relay, ask your ServiceNow administrator to configure it there.

After filling in all fields:

1. Click **Save Configuration**.
2. Click **Test OAuth2** and confirm the connection shows as successful.
3. Click **Send Test Email** and confirm delivery.
4. Click **Clear Cache**.

### Register the webhook

1. Copy the webhook URL from the Configuration page: `https://YOUR-INSTANCE.service-now.com/api/x_1946359_incode_0/incode_idv_webhook`.
2. In Dashboard, go to **Configuration** > **Webhooks** and add a new endpoint. See [Configuration: Webhooks tab](/dashboard-platform-administration/configuration-webhooks-tab/) for more information.
3. Paste the webhook URL and enable the following events:

| Event                                       | IDV Status result                             |
| ------------------------------------------- | --------------------------------------------- |
| `SESSION_STARTED`                           | In Progress                                   |
| `SESSION_SUCCEEDED`                         | Success                                       |
| `SESSION_FAILED`                            | Failed                                        |
| `SESSION_PENDING_REVIEW`                    | Pending Review                                |
| `SESSION_COMPLETED` / `ONBOARDING_FINISHED` | Success or Failure based on onboarding result |

4. Copy the **Signing Secret** from the Incode webhook configuration and paste it into the **Webhook Secret** field on the ServiceNow Configuration page.
5. Click **Save**.

### Assign Roles

Assign roles to your team through **User Administration** > **Users**:

| Role                       | Assign to                                          |
| -------------------------- | -------------------------------------------------- |
| `x_1946359_incode_0.agent` | All helpdesk agents who will trigger verifications |
| `x_1946359_incode_0.admin` | IT administrators who manage app configuration     |

### Add IDV Status Field to Form Layouts

The **IDV Status** field is included in the app but must be added to each record type's form layout manually.

For each record type you want to enable:

1. Open any record of that type: for example, an Incident.
2. Right-click the form header and select **Configure** > **Form Layout**.
3. Find **IDV Status** in the Available fields list on the left.
4. Drag it to your preferred position on the form.
5. Click **Save**.

Repeat for each record type: Incident, Service Request, Requested Item, Change Request, and HR Case (if the HR plugin is installed).

> 📘 **Tip**
>
> Placing the IDV Status field near the top of the form or next to the caller/requestor field makes the verification result easy for agents to see at a glance.

***

## Test the Integration

Once setup is complete, test the full end-to-end flow:

1. Open an Incident record with a test user assigned as the Caller.
2. Click **Request Identity Verification** and confirm the confirmation dialog appears before sending.
3. Confirm the test user receives the verification link by email.
4. Complete the verification session on a mobile device.
5. Return to the Incident record and confirm the **IDV Status** field updates to `Success` with a timestamp.

> ⚠️ **Warning**
>
> If the IDV Status field does not update, confirm the webhook is registered correctly in Dashboard and that all six events are enabled. Verify the Signing Secret in ServiceNow matches the one in Dashboard. Check the ServiceNow **System Log** for any incoming webhook errors.

> ⚠️ **Warning**
>
> If the verification email is not received, click **Send Test Email** on the Configuration page to verify SMTP delivery is working. Check your spam folder and confirm the From Address is authorized to send from your SMTP server.

***

<br />

---

- Path: `ecosystem-workforce/shopify`
- URL: https://developer.incode.com/ecosystem-workforce/shopify/
- Markdown: https://developer.incode.com/ecosystem-workforce/shopify.md

# Shopify

The Incode Age Verification for Shopify integration adds identity-based age verification to your Shopify checkout. When a customer attempts to purchase an age-restricted product, they are redirected to complete an Incode identity verification flow before their order can be placed.

> 📘 **Note**
>
> This integration requires **Shopify Plus**. Checkout UI extensions are a Shopify Plus feature.

***

## Integration Flow

1. The merchant tags age-restricted products with `age-restricted` in Shopify Admin.
2. When a customer adds one of these products to their cart, the app detects it.
3. At checkout, a banner appears: **Identity Verification Required**.
4. The customer clicks **Verify with Incode** and completes the identity flow on their device.
5. On success, they are returned to checkout and can complete their purchase.
6. On failure, they see an error and cannot proceed.
7. All verification results—session ID, pass/fail, timestamp—are stored as order attributes for merchant audit.

***

## Prerequisites

- Shopify Plus store
- Incode account with API access
- Your **Incode API Key** from Incode Dashboard > Settings > API Keys
- Your **Incode Flow ID**, the onboarding flow configured for age verification
- The Incode Age Verify app installed on your store

***

## Set Up the Shopify Integration

### Install the App

Your Incode account manager provides an installation link. Click it and follow the Shopify OAuth prompts to install **Incode Age Verify** on your store.

### Configure Your Incode Credentials

1. In your Shopify Admin, go to **Apps > Incode Age Verify**.
2. On the settings page, enter:
   - **API Key**: Your Incode API key
   - **Flow ID**: The Incode onboarding flow ID for age verification
   - **Backend URL**: Provided by your Incode account manager (leave blank if unsure)
3. Click **Save Settings**.
4. The **Connection Status** badge should turn green: ✓ Connected.

### Enable the Theme Script

This script detects age-restricted products and sets up cart attributes before checkout.

1. Go to **Online Store > Themes > Customize**.
2. In the left panel, click **App Embeds**.
3. Enable **Incode Age Verify**.
4. In the **Backend URL** field, enter the same backend URL from the previous set of steps.
5. Click **Save.**

### Tag Your Age-Restricted Products

1. Go to **Products** in your Shopify Admin.
2. Open each age-restricted product.
3. In the **Tags** field, add the tag: `age-restricted`.
4. Click **Save**.

> ⚠️ **Warning**
>
> The tag must be exactly `age-restricted` (lowercase, hyphenated). Any product with this tag will trigger the verification flow at checkout.

### Confirm the Checkout Extension is Active

1. Go to **Settings > Checkout > Customize**.
2. Click the **Apps** section.
3. Confirm **Incode Age Verify** is listed and active.

***

## Test the Integration

1. Add an `age-restricted` tagged product to your cart.
2. Proceed to checkout.
3. Confirm the **Identity Verification Required** banner appears above the payment section.
4. Click **Verify with Incode**. Confirm you are redirected to the Incode verification flow.
5. Complete the verification on your mobile device.
6. Confirm you are returned to checkout with the **Identity verified with Incode—you're all set!** confirmation.
7. Complete the purchase.

***

## View verification records

Every order placed through the verification flow includes the following in the **Additional details** section of the order in Shopify Admin:

| Attribute                   | Description                                                |
| --------------------------- | ---------------------------------------------------------- |
| `age_verification_required` | If verification was required (`true`/`false`)              |
| `age_verified`              | If the customer passed verification (`true`/`false`)       |
| `age_verified_status`       | `pass` or `fail`                                           |
| `age_verified_session`      | Incode session reference ID (first 16 characters of token) |
| `age_verified_at`           | ISO timestamp when verification occurred                   |
| `age_verified_by`           | Always `incode`                                            |

***

## Troubleshooting

### **Verification Banner Doesn't Appear at Checkout**

Confirm the following:

- The product has the `age-restricted` tag with exact spelling.
- The theme app extension is enabled.
- The app is installed: go to **Apps&#x20;**> **Incode Age Verify** to confirm.

If the banner still doesn't appear, clear your cart and re-add the product. The cart attribute sync occurs on page load.

### **Verify with Incode Button Does Nothing**

The backend URL in the theme editor may be incorrect or the backend may be unreachable. Contact your Incode Representative to confirm the backend URL.

### **Verification Completes but Checkout Still Shows the Banner**

Clear your browser cache and reload the checkout page. Confirm you are returning to the correct store URL after verification.

### **Identity Verification Failed Message**

The customer did not pass the identity check. They can click **Try Again** to retry. If they choose not to verify, age-restricted items must be removed from the cart.

***

## Support

For setup help or issues, contact your Incode Representative or email [integrations@incode.com](mailto:integrations@incode.com).

---

- Path: `ecosystem-workforce/slack`
- URL: https://developer.incode.com/ecosystem-workforce/slack/
- Markdown: https://developer.incode.com/ecosystem-workforce/slack.md

# Slack

You can add identity verification to Slack using the Incode app for Slack. After installing, employees and IT teams can request on-demand identity verification directly from Slack before sharing sensitive information, handling high-risk requests, or granting access to protected meetings.

***

## Prerequisites

Ensure you have the following before you begin:

- A Slack workspace where you have admin permissions to install apps.
- Access to the Integrations page in Dashboard. Contact your Incode Representative if you do not see it.
- Your Slack **Team ID.**

***

## Understand What the Incode Slack App Does

The Incode app adds two slash commands to your Slack workspace:

- `/incode`: Send an identity verification request to another Slack user. Both the sender and recipient can view verification results in real time.
- `/incode-meeting`: Protect a Zoom meeting invite with identity verification. The recipient only receives the meeting link after passing verification. Requires a Zoom subscription.

### **Common Use Cases**

- IT administrators verifying an employee's identity before handling an MFA reset or account lockout through Slack.
- Finance and sales teams protecting wire transfer requests, contracts, or invoices before sending to recipients.

***

## Set Up Slack Integration

### Find Your Slack Team ID

1. Open your Slack workspace in a web browser using your workspace URL. After the page loads, the URL will be formatted as: `https://app.slack.com/client/TXXXXXXX/CXXXXXXX`.
2. Find your Team ID is the string beginning with `T`. For Enterprise Grid organizations, use the string beginning with `E`.

### Create the Integration in Dashboard

1. Log in to Dashboard.
2. In the left menu, click **Integrations**.
3. Click **New Integration**.
4. From the Productivity tab, click **Slack**, then click **Continue**.
5. Enter an **Integration Name**.
6. Enter your **Team ID** and click **Save**.
7. Click **Install Workforce App in Slack** to proceed to the Slack authorization flow.

### Install the App in Your Slack Workspace

Follow the prompts to grant the Incode app access to your Slack workspace.

![](https://developer.incode.com/assets/1ab4dde535aef75f6e7d3221a9f8e13c.png)

***

## Test the Integration

Use the `/incode` and `/incode-meeting` commands in a Slack direct message to confirm the integration is working.


<Image src="https://developer.incode.com/assets/f87d00ad3f23de281546b123fd74beed.png" align="center" caption="Type command /incode in direct message to a person whose identity you want to verify" />


<br />


<Image src="https://developer.incode.com/assets/f4f7a852d136ff982d2e17aad8cb21b9.png" align="center" caption="Start verification" />


<br />


<Image src="https://developer.incode.com/assets/548e12b8dab490377c76a35de4250da8.png" align="center" caption="Type command /incode-meeting and paste link to zoom meeting to request identity verification for a meeting participant" />


<br />

---

- Path: `ecosystem-workforce/student-information-system-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/student-information-system-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/student-information-system-integrations.md

# Student Information System Integrations

Student Information System (SIS) integrations embed Incode identity verification into the platforms used by higher education institutions and K-12 organizations to manage student records, enrollment, and access to academic resources. They are designed for use cases where confirming a student's or applicant's identity is required, such as remote exam<br />proctoring, financial aid verification, transcript requests, or new student enrollment.

When a student or applicant triggers a verification-required action, the SIS platform initiates an Incode verification session. The student scans their government-issued ID and completes a liveness check on their device. The result is returned to the SIS platform to gate access or progress the workflow.

> 📘 **Note**
>
> Student information system integrations are on the Incode roadmap. If you are a higher education institution or EdTech provider looking to integrate Incode with your SIS platform, contact your Incode Representative to discuss your use case and timeline.

***

## Platforms on the Roadmap

The following platforms are planned for integration:

| Platform                    | Use case                                                                                                                   |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Ellucian Banner / Colleague | Identity verification for student enrollment, financial aid, and transcript access across US higher education institutions |
| Instructure Canvas          | Exam access gating through Learning Tools Interoperability (LTI) integration for online and hybrid learning environments   |
| Oracle Student Cloud        | Identity proofing for student lifecycle events across large university systems                                             |
| PowerSchool                 | Parent and guardian identity verification for K-12 institutions                                                            |

<br />

---

- Path: `ecosystem-workforce/tines`
- URL: https://developer.incode.com/ecosystem-workforce/tines/
- Markdown: https://developer.incode.com/ecosystem-workforce/tines.md

# Tines Automation

<Anchor target="_blank" href="https://tines.com">Tines</Anchor> is a security and workflow automation platform that uses a straightforward graphical design process to automate tasks.

Incode is an AI-powered identity verification platform that uses government-issued photo IDs and biometric matching to verify a person's identity over the Internet. It is built for workforce, financial, and enterprise use cases.

Tines' ability to work with APIs, combined with the Incode Workforce API, is the simplest way to add automated biometric identity verification to your security workflows, HR pipelines, or customer onboarding processes.

This article assumes you have some familiarity with Tines and no familiarity with Incode. For an introduction to Tines, see [Tines University](https://www.tines.com/university).

***

## Collect Your Incode Credentials

You need three things from Incode to configure Tines:

- An API key (`*API_KEY*`)
- An integration ID (`*INTEGRATION_ID*`)
- An integration secret (`*INTEGRATION_SECRET*`)

To retrieve these values:

1. Open [Dashboard](https://dashboard.incode.com) and log in.
2. Go to **Settings > API Keys** in the left menu.
3. Select **Create new API key**.&#x20;
4. Enter a descriptive name such as `tines-integration`.
5. Copy the generated key. This is your `*API_KEY*`.
6. Go to **Integrations** in the left menu.
7. Select the integration you want to use or create a new one.
8. From the integration detail page, copy the **Integration ID** and **Integration Secret**. These are your `*INTEGRATION_ID*` and `*INTEGRATION_SECRET*`.

> 📘 **Note**
>
> If you are using Incode's sandbox environment, your API base URL will be `https://demo-api-incode-id.incodesmile.com`. For production, use the base URL provided by your Incode Representative.

***

## Add Credentials to Tines

1. Go to Tines and click **Credentials** in the left menu.
2. Add `*API_KEY*` as a **Text Credential** named `incode_x_api_key`. Add `incodesmile.com` in the **Domains** field.
3. Add `*INTEGRATION_ID*` as a **Text Credential** named `incode_workforce_integrationid`. Leave **Domains** blank.
4. Add `*INTEGRATION_SECRET*` as a **Text Credential** named `incode_workforce_secret`. Leave **Domains** blank.

All three credentials are entered as **Text** credentials and will look like this in the Tines Credentials panel:

| Name                             | Type | Domains           |
| -------------------------------- | ---- | ----------------- |
| `incode_x_api_key`               | Text | `incodesmile.com` |
| `incode_workforce_integrationid` | Text | —                 |
| `incode_workforce_secret`        | Text | —                 |

***

## Set Up Tines Actions

The steps below configure Tines to:

1. Authenticate with the Incode API to get a session token.
2. Generate a personalized verification link for the customer.
3. Deliver that link to the customer.
4. Wait for a webhook from Incode when the user completes verification.
5. Validate the webhook and use the result.

### Authenticate with Incode

Before you can generate a verification link, the Incode API requires a short-lived session token obtained through a server-side authentication call. This token is used as the `x-auth-token` header in subsequent requests.

1. Drag the **HTTP Request** action into your story from the sidebar and configure it as follows:
   - **Name**: `GetIncodeToken`
   - **URL**: `https://demo-api-incode-id.incodesmile.com/v1/integration/authorize/server`
   - **Content type**: JSON
   - **Method**: `POST`
   - **Headers**: &#x20;
     ```text
     x-api-key: {user.CREDENTIAL.incode_x_api_key}
     ```
   - **Payload:**
     ```text
     {
       "integrationId": "<<CREDENTIAL.incode_workforce_integrationid>>",
       "secret": "<<CREDENTIAL.incode_workforce_secret>>"
     }
     ```
   In the **Editor** view on the right side of the Tines workspace, this looks like:
   ```json
   {
     "url": "https://demo-api-incode-id.incodesmile.com/v1/integration/authorize/server",
     "content_type": "application_json",
     "method": "post",
     "headers": {
       "x-api-key": "<<CREDENTIAL.incode_x_api_key>>"
     },
     "payload": {
       "integrationId": "<<CREDENTIAL.incode_workforce_integrationid>>",
       "secret": "<<CREDENTIAL.incode_workforce_secret>>"
     }
   }
   ```
2. Select **Play** on this action. The events window should show a successful response from Incode:
   ```json
   {
     "token": "eyJhbGci....",
     "expiresAt": 1714512000
   }
   ```

The `token` field is the session token. It is short-lived, so this action should run at the beginning of each story run. Don't store it for reuse across separate executions.

### Generate a Verification Link

Now that you have a session token, you can generate a personalized, time-limited verification link for the end-user.

1. Drag another **HTTP Request** action into your story and configure it as follows:
   - **Name**: `GenerateVerificationLink`
   - **URL**: `https://demo-api-incode-id.incodesmile.com/v1/workforce/verification/candidate/generate-verification-link`
   - **Content type**: JSON
   - **Method**: `POST`&#x20;
   - **Headers:**
     ```text
     x-auth-token: <<GetIncodeToken.body.token>>
     ```
   - **Payload**:
     ```json
     {
       "integrationID": "<<CREDENTIAL.incode_workforce_integrationid>>",
       "secret": "<<CREDENTIAL.incode_workforce_secret>>",
       "loginHint": "<<user_email>>",
       "loginHintType": "EMAIL",
       "validityMinutes": 4320,
       "redirectUrl": "https://your-company.com",
       "givenNames": "<<user_first_name>>",
       "lastName": "<<user_last_name>>"
     }
     ```
2. Replace `<<user_email>>`, `<<user_first_name>>`, and `<<user_last_name>>` with the Tines variables from wherever you collect the user's information earlier in your story: for example, from a web form, a webhook payload, or a previous API call.
3. The `validityMinutes` field controls how long the verification link stays active. `4320` equals 72 hours, which is a sensible default for most workflows. Adjust this to suit your use case.

   In the **Editor** view, this looks like:

   ```json
   {
     "url": "https://demo-api-incode-id.incodesmile.com/v1/workforce/verification/candidate/generate-verification-link",
     "content_type": "application_json",
     "method": "post",
     "headers": {
       "x-auth-token": "<<GetIncodeToken.body.token>>"
     },
     "payload": {
       "integrationID": "<<CREDENTIAL.incode_workforce_integrationid>>",
       "secret": "<<CREDENTIAL.incode_workforce_secret>>",
       "loginHint": "<<user_email>>",
       "loginHintType": "EMAIL",
       "validityMinutes": 4320,
       "redirectUrl": "https://your-company.com",
       "givenNames": "<<user_first_name>>",
       "lastName": "<<user_last_name>>"
     }
   }
   ```
4. Select **Play** on this action. The response from Incode looks like:
   ```json
   {
     "verificationLink": "https://verify.incode.com/x/acme/abcd1234xyz",
     "verificationTraceId": "f78ee334-79a8-4a5e-be4a-d728e226df64"
   }
   ```

The two key fields are:

- `verificationLink`: The URL you will send to the customer so they can complete biometric verification.
- `verificationTraceId`: A unique identifier for this verification session. **Store this value.** You will use it later to match the Incode webhook callback to this specific verification request

### Deliver the Verification Link

Tines offers many methods to deliver data to end-users. Any of them will work for delivering this link: email, Slack, SMS, or a redirect from a Tines page.

To demonstrate the flow, we use email delivery. If your story has already collected the user's email address from a form or upstream system, skip the form step.

**Collect the User's Email**

1. If you need to collect the user's details first, select **+ / Tools** on the left of your Tines workspace.
2. Drag a **Page** object onto your workspace.
3. Name the page `Request Identity Verification`.
4. Add input fields for the user's email address, first name, and last name.

**Send the Email**

1. Drag the **Send Email** action from the sidebar onto your workspace and configure it as follows:
   - **Recipients**: `<<user_email>>` (or `<<request_identity_verification.body.email>>` if using a Tines form)
   - **Reply to**: Your team's support email address
   - **Sender name**: Your company or team name
   - **Subject**: `Your identity verification request from *COMPANY*`
   - **Body**: Write a message explaining the purpose of the verification. Include the link using the Tines variable
     `<<GenerateVerificationLink.body.verificationLink>>`. For example:
     ```
     Hi <<user_first_name>>,

     Please complete your identity verification by clicking the link below.
     The process takes less than 5 minutes and requires a government-issued
     photo ID and a quick facial scan.

     Verify your identity: <<GenerateVerificationLink.body.verificationLink>>

     This link expires in 72 hours. If you have any questions, reply to
     this email and our team will be happy to help.
     ```

2) Connect the actions in your story so they run in this order: `GetIncodeToken` → `GenerateVerificationLink` → `Send Email`.
3) To test the flow, run the story and confirm the email arrives with a working verification link.

### Set Up the Incode Webhook

Incode can POST a signed message to a pre-defined HTTP endpoint when an end-user completes or fails verification. This is how you receive the result back into your Tines story.

**Create the Webhook Action in Tines**

1. Go to your Tines story and drag a **Webhook Action** into your workspace.&#x20;
2. Select it to edit.&#x20;
3. Set **Allowed verbs** to `POST` only.&#x20;
4. Select **Copy** next to the **Webhook URL** to copy it. This is the `*DELIVERY_URL*` you will register in Incode.

**Register the Webhook in Incode**

1. Open [Dashboard](https://dashboard.incode.com)​.
2. Go to **Configuration** > **Webhooks**.&#x20;
3. Select your integration and open the **Webhooks** tab.
4. Select **Add Webhook** and configure it as follows:
   | Field        | Value                                            |
   | ------------ | ------------------------------------------------ |
   | Delivery URL | Paste the `*DELIVERY_URL*` you copied from Tines |
   | Events       | `verification.succeeded`, `verification.failed`  |
   | Enabled      | Toggle on                                        |
5. Save the webhook. Incode will now POST an event to your Tines story each time a user completes or fails a verification session on this integration.

**Name the Webhook Action**

Back in Tines, rename the Webhook Action to `IncodeStatusWebhook` to make it easy to reference in downstream actions.

### Validate the Webhook in Tines

When Incode posts a verification result to your Tines story, the webhook body looks like this:

```json
{
  "event_type": "verification.succeeded",
  "data": {
    "verification_trace_id": "f78ee334-79a8-4a5e-be4a-d728e226df64",
    "failure_reason": null,
    "ip": "203.0.113.42",
    "user_name": "Jane Smith",
    "latitude": 37.7749,
    "longitude": -122.4194
  }
}
```

The `verification_trace_id` in the callback matches the `verificationTraceId` you received when you generated the link. This is how you confirm that this callback belongs to the verification session you initiated.

**Create a Trigger Action**

1. Drag a **Trigger Action** into your story.&#x20;
2. Configure a rule that checks the incoming `event_type` and passes only events for successfully completed verifications:
   ```json
   {
     "rules": [
       {
         "type": "field==value",
         "value": "verification.succeeded",
         "path": "<<IncodeStatusWebhook.body.event_type>>"
       }
     ]
   }
   ```

This ensures that the rest of your story only runs when verification succeeds. To handle failures separately, add a second Trigger Action with `"value": "verification.failed"` and connect it to a different branch.

**Confirm the Trace ID**

If your story initiated the verification session and stored the `verificationTraceId`, you can add a second Trigger Action to confirm the callback matches the session you expect:

```json
{
  "rules": [
    {
      "type": "field==value",
      "value": "<<GenerateVerificationLink.body.verificationTraceId>>",
      "path": "<<IncodeStatusWebhook.body.data.verification_trace_id>>"
    }
  ]
}
```

> 📘 **Note**
>
> In asynchronous workflows where the verification link is sent and the result arrives in a separate story run, use Tines Records to store the `verificationTraceId` alongside any relevant identifiers—such as a user ID or opportunity ID—when the link is generated. Then look up that record using the incoming `verification_trace_id` when the callback arrives. See [Tines Records documentation](https://www.tines.com/docs/records) for details.

### Use the Verification Result

The `data` object in the webhook payload contains the following fields:

| Field                    | Description                                                           |
| ------------------------ | --------------------------------------------------------------------- |
| `verification_trace_id`  | Unique ID for this verification session                               |
| `failure_reason`         | Reason for failure if verification did not succeed; `null` on success |
| `ip`                     | IP address of the device used for verification                        |
| `user_name`              | Name of the person as verified by Incode                              |
| `latitude` / `longitude` | Approximate geolocation of the device at verification time            |

Here are some examples of how you can use this data in Tines:

- **ATS integration**: Use an HTTP Request action to add a `biometric-verified` tag and post a note to the candidate's profile in your applicant tracking system: for example, Lever, Greenhouse, or Workday.
- **IT provisioning**: Trigger an account creation or password reset workflow after identity is confirmed, combining the verified name with a lookup in your corporate directory.
- **Access control**: Update a record in your IAM or HRIS system to reflect that this person has completed biometric verification.
- **Helpdesk escalation**: Send the verified identity details to a Slack channel or a support ticket so an agent can take over with confidence.
- **Audit log**: Write the `verification_trace_id`, verified name, IP, and timestamp to a Tines Record or external data store for compliance.

To display the result for testing:

1. Drag a **Page** object onto your workspace.
2. Set the **Page behavior** to **Show success message**.
3. Set the success message to:
   ```
   Identity verification complete.

   Verified name: <<IncodeStatusWebhook.body.data.user_name>>
   Trace ID: <<IncodeStatusWebhook.body.data.verification_trace_id>>
   Processed: <<DATE("now")>>
   ```

***

## Summary

At the end of these steps, your Tines story will consist of two connected flows:

### **Flow 1: Send Verification**

```
[Collect user details] → [GetIncodeToken] → [GenerateVerificationLink] → [Send Email]
```

### **Flow 2: Receive Result**

```
[IncodeStatusWebhook] → [Check event_type] → [Use verified data]
```

This story shows how to use the Incode Workforce API in Tines to verify any user's identity and feed the result back into any downstream system Tines can reach.

---

- Path: `ecosystem-workforce/transunion`
- URL: https://developer.incode.com/ecosystem-workforce/transunion/
- Markdown: https://developer.incode.com/ecosystem-workforce/transunion.md

# TransUnion

TransUnion IDVision and TLOxp provide device intelligence, phone and email risk signals, and identity graph data used by financial institutions and insurance companies during onboarding and fraud investigations.

The Incode x TransUnion integration pairs Incode biometric and document verification with TransUnion data-based identity signals to produce a composite IDV score. This is particularly relevant for lenders who need to verify that:

- The person is who they claim to be.
- The identity itself is not synthetic or fraudulent.&#x20;

TransUnion's coverage across insurance and healthcare also expands the use case beyond banking, making this integration applicable across a broader range of regulated industries.

***

## Availability

This integration is available through the TransUnion developer API program and technology alliance track. It is also available through the Incode OEM and MSP partner program. Contact your Incode Representative to get started.

---

- Path: `ecosystem-workforce/video-conferencing-integrations`
- URL: https://developer.incode.com/ecosystem-workforce/video-conferencing-integrations/
- Markdown: https://developer.incode.com/ecosystem-workforce/video-conferencing-integrations.md

# Video Conferencing Integrations

Video conferencing integrations add identity verification as a gating step before participants can join a meeting or video call. They are designed for use cases where confirming a participant's identity before granting access is required, such as regulated meetings, high-stakes interviews, and remote notarization.

Incode supports any video conferencing platform that exposes a joinable meeting URL, including Zoom, Microsoft Teams, Cisco Webex, and Google Meet.

***

## Video Conferencing Flow

1. The organizer creates the meeting in their video conferencing platform and copies the meeting URL.
2. In Dashboard, the organizer opens the Candidate Verification screen, selects **Protect meeting with Incode**, and pastes the meeting URL.

   ![](https://developer.incode.com/assets/4f9e86911f72d40e5b39e00cc269c556.png)


3. Incode generates a verification link that can be shared with the participant via any channel: email, SMS, or copy-paste.
4. When the participant clicks the link, they are directed to Incode to complete identity verification.
5. If verification succeeds, Incode forwards the participant to the original meeting URL.
6. If verification fails, the participant cannot access the meeting.

***

## Protect a Meeting with Incode

1. Log in to Dashboard.
2. Go to **Candidate Verification**.
3. Select the candidate from the dropdown or add a new candidate.
4. Under **Verification method**, select **Protect meeting with Incode**.
5. Paste the meeting URL: for example, `https://your-org.zoom.us/j/...` or `https://teams.microsoft.com/l/meetup-join/...`.
6. Set the link validity period.
7. Click **Generate Verification & Copy Link**.
8. Share the generated verification link with the participant.

***

## Supported Platforms

The Protect Meeting with Incode feature works with any video conferencing platform that accepts a joinable meeting URL, including:

- Zoom
- Microsoft Teams
- Cisco Webex
- Google Meet
- GoTo Meeting
- BlueJeans

> 📘 **Note**
>
> Native platform integrations—such as Zoom App Marketplace listings, Microsoft Teams app store listings, and Webex App Hub listings—are on the Incode roadmap. Contact your Incode Representative for timeline<br />details.

<br />

---

- Path: `ecosystem-workforce/workday`
- URL: https://developer.incode.com/ecosystem-workforce/workday/
- Markdown: https://developer.incode.com/ecosystem-workforce/workday.md

# Workday

This page covers everything a developer needs to deploy the Incode x Workday Identity Verification (IDV) middleware integration (v1 Lite).

When a new hire is created in Workday, this integration automatically sends them an Incode identity verification link. When they complete the scan, the result is written back to Workday as a Government ID record.

***

## **Integration Flow**

1. Workday Hire business process fires an HTTP callout → `POST /trigger`.
2. Middleware authenticates with Incode, creates an IDV session, and returns the verification URL.
3. Workday delivers the URL to the employee.
4. The employee completes ID scan in Incode.
5. Incode fires a webhook → `POST /webhook`.
6. Middleware exchanges refresh token for a Workday OAuth token, then writes the IDV result via SOAP `Change_Government_IDs`.

***

## **Tech Stack**

- Node.js/Express (3 endpoints: `POST /trigger`, `POST /webhook`,
  `GET /health`)
- Incode OAuth2 `client_credentials` flow
- Workday OAuth2 `refresh_token` grant (ISU machine-to-machine)
- Workday SOAP API v43.0: Human\_Resources web service

***

## Prerequisites

### Incode

| Item                     | Notes                                                 |
| ------------------------ | ----------------------------------------------------- |
| B2B onboarding enabled   | Required on your Incode tenant                        |
| OAuth2 API Client        | `client_credentials` grant: save Client ID and Secret |
| API Key                  | From Dashboard                                        |
| Integration Reference ID | From Dashboard: identifies the workflow               |
| Auth URL                 | `https://auth.demo.incode.com/oauth2/token` (demo)    |
| API URL                  | `https://demo-api.incodesmile.com` (demo)             |

> ⚠️ Warning
>
> All session creation calls require the header `api-version: 1.0`. Without it, the API returns `406 Not Acceptable`.

### Workday

**Create an Integration System User (ISU)**

1. Search Workday for **Create Integration System User**.
2. Enter a **Name**: for example, `Incode_IDV_ISU`.
3. Check **Do Not Allow UI Sessions**.
4. Save.

**Create a Security Group and Assign Domain Permissions**

1. Search Workday for **Create Security Group** and select the type Integration System Security Group.
2. Enter a **Name**: for example, `Incode IDV Integration`.
3. Add `Incode_IDV_ISU` as a member.
4. Search Workday for **Maintain Permissions for Security Group** and select `Incode IDV Integration`.
5. Under **Domain Security Policy Permissions**, add:

| Domain                       | Access      |
| ---------------------------- | ----------- |
| `National ID Identification` | Get and Put |

6. Under **Business Process Security Policy Permissions**, add:

| Business Process        | Permission Type   |
| ----------------------- | ----------------- |
| `Change Government IDs` | Initiating Action |

7. Save.
8. Search Workday for **Activate Pending Security Policy Changes**.
9. Submit.

**Register an API Client for Integrations**

1. Search Workday for **Register API Client for Integrations**.
2. Enter a **Client Name**: for example, `Incode IDV Client`.
3. Set **Non-Expiring Refresh Tokens** to **Yes**.
4. Save.
5. Copy the **Client ID** and **Client Secret**.

**Generate a Refresh Token**

1. Search Workday for **Manage Refresh Tokens for Integrations**.
2. Select the ISU, then click **Generate New Refresh Token**.
3. Copy the token value.

**Configure the Hire Business Process HTTP Callout**

In the Hire business process, add an Integration step that POSTs to `/trigger` with this body:

```json
{
  "workerID": "{{Employee_ID}}",
  "fullName": "{{Legal_Name}}",
  "personalEmail": "{{Personal_Email}}",
  "tenantURL": "https://impl.wd12.myworkday.com/ccx/service/your_tenant",
  "workdayClientId": "{{Client_ID}}",
  "workdayClientSecret": "{{Client_Secret}}",
  "workdayRefreshToken": "{{Refresh_Token}}",
  "integrationReference": "{{Integration_Reference_ID}}",
  "linkValidityMinutes": 1440
}
```

***

## Environment Variables

```bash
# Incode
INCODE_CLIENT_ID=
INCODE_CLIENT_SECRET=
INCODE_AUTH_URL=https://auth.demo.incode.com/oauth2/token
INCODE_API_URL=https://demo-api.incodesmile.com
INCODE_API_KEY=
INCODE_INTEGRATION_REFERENCE=
LINK_VALIDITY_MINUTES=1440

# Workday
WORKDAY_TENANT=your_tenant_name
WORKDAY_CLIENT_ID=
WORKDAY_CLIENT_SECRET=
WORKDAY_REFRESH_TOKEN=
WORKDAY_ISU_USERNAME=Incode_IDV_ISU
AUTO_COMPLETE=true

# Middleware
PORT=3000
WEBHOOK_SECRET=       # optional — for HMAC signature validation
```

***

## API Endpoints

### `POST /trigger`

Receives the Workday callout. Creates an Incode IDV session and returns the verification URL.

**Request Body**

```json
{
  "workerID": "12345",
  "fullName": "Jane Doe",
  "personalEmail": "jane@example.com",
  "tenantURL": "https://impl.wd12.myworkday.com/ccx/service/mytenant",
  "workdayClientId": "...",
  "workdayClientSecret": "...",
  "workdayRefreshToken": "...",
  "integrationReference": "...",
  "linkValidityMinutes": 1440
}
```

**Response**

```json
{ "url": "https://incode.me/verify/..." }
```

### `POST /webhook`

Receives Incode `SESSION_SUCCEEDED` events. If `WEBHOOK_SECRET` is set, validates the HMAC-SHA256 signature (header: `x-incode-signature`). Looks up the session context by `externalCustomerId`, fetches a fresh Workday OAuth token, then writes `Change_Government_IDs` via SOAP.

### `GET /health`

Returns `{ "status": "ok" }`. Use for load balancer health checks.

***

## Deployment

### **Local Testing with Ngrok**

```bash
npm install
cp .env.example .env    # fill in all values
node src/index.js

# In a second terminal:
ngrok http 3000
# Use the ngrok HTTPS URL as your Incode webhook endpoint
```

### Production

```bash
npm install --production
NODE_ENV=production node src/index.js
```

Deploy behind a reverse proxy (nginx / AWS ALB) with TLS termination. The service is stateless except for the in-memory session store. For production, replace `sessionStore` with Redis.

***

## National ID Type Code Mapping

Workday `National_ID_Type_Code` values are country-specific, formatted as `{ISO3166Alpha3}-{Suffix}`. The middleware auto-derives codes from the issuing country and document type returned by Incode OCR. Common mappings are as follows:

| Incode document type | Issuing country | Workday code |
| -------------------- | --------------- | ------------ |
| `passport`           | IN (India)      | `IND-PAS`    |
| `passport`           | JP (Japan)      | `JPN-PAS`    |
| `passport`           | BY (Belarus)    | `BLR-PAS`    |
| `national_id`        | US              | `USA-SSN`    |
| `national_id`        | MX              | `MEX-CURP`   |
| `passport`           | US              | `USA-SSN`    |

For country-specific exceptions, add entries to `COUNTRY_DOC_OVERRIDES` in `src/utils/documentTypeMap.js`.

***

## Workday SOAP: Critical Notes

| Topic                  | Detail                                                                                          |
| ---------------------- | ----------------------------------------------------------------------------------------------- |
| OAuth token placement  | Bearer token in HTTP `Authorization` header, **not** in WS-Security SOAP header                 |
| Services host          | Sandbox: `impl-services1.wd12.myworkday.com` (different from UI host `impl.wd12.myworkday.com`) |
| SOAP endpoint          | `https://{services-host}/ccx/service/{tenant}/Human_Resources/v43.0`                            |
| Person reference       | Use `Person_Reference` (not `Worker_Reference`) inside `Change_Government_IDs_Data`             |
| Verification date      | `xsd:date` format, `YYYY-MM-DD` only, no time component                                         |
| Country reference type | `ISO_3166-1_Alpha-2_Code`                                                                       |
| ID type reference      | `National_ID_Type_Code`                                                                         |
| Replace\_All           | Set to `false` to preserve existing IDs                                                         |

***

## Troubleshooting

| Error                                                | Cause                               | Fix                                                            |
| ---------------------------------------------------- | ----------------------------------- | -------------------------------------------------------------- |
| Incode `invalid_client`                              | Wrong client secret                 | Re-paste `INCODE_CLIENT_SECRET` directly, do not retype        |
| Incode `406 Not Acceptable`                          | Missing `api-version` header        | Add `api-version: 1.0` to session creation request             |
| Incode `Employee by login factor cannot be found`    | Email not in Incode                 | Use an email that exists in the Incode tenant                  |
| Workday 404 on token endpoint                        | Wrong host                          | Use services host, not UI host                                 |
| Workday `invalid_client` (OAuth)                     | Misread client ID/secret            | Paste directly from Workday, don't retype                      |
| Workday `invalid username or password`               | Tenant has disabled SOAP Basic Auth | Switch to OAuth `refresh_token` grant                          |
| SOAP `The task submitted is not authorized`          | Missing BP security policy          | Add ISU group to `Change Government IDs` BP Initiating Actions |
| SOAP `Invalid Subelement Worker_Reference`           | Wrong SOAP schema                   | Use `Person_Reference` inside `Change_Government_IDs_Data`     |
| SOAP `PASSPORT is not a valid National_ID_Type_Code` | Generic codes don't exist           | Use country-specific code e.g. `IND-PAS`                       |
| SOAP `Invalid ID type Country_ID`                    | Wrong type attribute                | Use `ISO_3166-1_Alpha-2_Code`                                  |

***

## Go-Live Checklist

### **Incode**

- [ ] OAuth client created, credentials saved
- [ ] API key configured
- [ ] Integration Reference ID confirmed
- [ ] Webhook URL registered pointing to `/webhook`
- [ ] `WEBHOOK_SECRET` set and matches Incode dashboard

### **Workday**

- [ ] ISU created with "Do Not Allow UI Sessions"
- [ ] Security group created, ISU assigned
- [ ] Domain permission: `National ID Identification`—Get and Put
- [ ] BP policy: `Change Government IDs`—Initiating Action
- [ ] Security policy changes activated
- [ ] API Client registered, Client ID and Secret saved
- [ ] Refresh token generated and saved
- [ ] Hire BP HTTP callout configured with correct field mapping

**Middleware**

- [ ] All env vars populated
- [ ] `/health` returns `{ status: 'ok' }`
- [ ] `/trigger` tested manually—returns IDV URL
- [ ] `/webhook` tested with sample payload—writes to Workday
- [ ] TLS enabled on public endpoint
- [ ] Session store replaced with Redis for production

<br />

---

- Path: `ecosystem-workforce/workday-recruiting`
- URL: https://developer.incode.com/ecosystem-workforce/workday-recruiting/
- Markdown: https://developer.incode.com/ecosystem-workforce/workday-recruiting.md

# Workday Recruiting

This page covers Incode's identity verification integration with Workday. The integration uses facial biometrics, document authentication, and fraud detection to verify candidates during the hiring process.

***

## Workday Studio Integration

Incode provides a prebuilt Workday Studio integration package. It includes three independent Studio integrations, each covering a specific part of the onboarding and verification lifecycle:

- **eKYC Integration (INT00N\_eKYC\_Candidates\_Incode)**:**&#x20;**&#x53;ecurely sends candidate data from Workday to Incode for<br />electronic Know Your Customer (eKYC) checks and writes results back.
- **IDV Integration (INT00N\_IDV\_Candidates\_Incode)**: Retrieves biometric and document verification results from Incode and writes them into Workday.
- **Email Delivery Integration (INT00N\_Onboarding\_Email\_Incode)**: Sends personalized onboarding URLs and verification links to candidates using Workday's notification framework.

Each integration is delivered as a Workday Studio project file ready for deployment. They are modular; you don't need to use both eKYC and IDV together.

***

## eKYC Integration

The `INT00N_eKYC_Candidates_Incode` integration sends candidate profile data from Workday to Incode for eKYC checks. Results are returned to Workday and stored on the candidate's **Incode Details** tab. You can place this integration at any of the following hiring stages: Assessment, Background Check, Offer, or Pre-Hire.

This integration:

- Extracts candidate demographic data from Workday.
- Sends the data securely to the Incode verification API.
- Retrieves risk scores, verification statuses, and supporting metadata.
- Updates the candidate's **Incode Details** tab in Workday.


<Image src="https://developer.incode.com/assets/4e32afa823f3e58c6e1a7d13a72ddf4a.png" align="center" caption="Figure 1.1: Configure the Business Process Step" />



<Image src="https://developer.incode.com/assets/e4fc3822ffa0426af10fe38974290a42.png" align="center" caption="Figure 1.2: Receive the eKYC score response from Incode into Workday" />


<br />

***

## Email Delivery Integration

The `INT00N_Onboarding_Email_Incode` integration sends onboarding URLs and verification links to candidates using Workday's notification framework. You can place it at the Assessment, Background Check, Offer, or Hire stage.

This integration supports:

- Automated delivery of individualized onboarding URLs to candidates.
- Customizable email templates using Workday's notification framework.
- Flexible placement within hiring business processes.


<Image src="https://developer.incode.com/assets/38a977b7024bbae937fef1e007405307.png" align="center" caption="Figure 2.1: Configure the Business Process Step" />



<Image src="https://developer.incode.com/assets/d65a5f1d430d45e0f0f2b1cb908f9109.png" align="center" caption="Figure 2.2: Define the Business Process Condition" />


<br />

### **Onboarding Notification Template**

The notification template lets HR and Talent Acquisition teams send candidates clear, personalized instructions. Using this template, you can:

- Personalize message content.
- Include dynamic fields.
- Embed the onboarding URL.
- Align with organizational branding.

> 📘 **Note**
>
> You can use a custom BP Notification Template to align notifications with your company's communication standards.


<Image src="https://developer.incode.com/assets/686b53dde7f4fd67859bc4a0e100a06a.png" align="center" caption="Figure 2.3: Email delivery of the Onboarding URL for Identity Verification" />


***

## IDV Integration

The `INT00N_IDV_Candidates_Incode` integration retrieves biometric and document verification results from Incode and writes them into Workday. It retrieves IDV results on a scheduled basis: hourly, daily, or as configured.

This integration:

- Opens candidate sessions with document and biometric submissions.
- Extracts verification attributes such as:
  - Document authenticity validations
  - Biometric (facial match) scores
  - Fraud indicators
  - Session timestamps and metadata


<Image src="https://developer.incode.com/assets/98138a100b6696f06b7e85e154374c5a.png" align="center" caption="Figure 3.1: Custom Report for the IDV Integration" />



<Image src="https://developer.incode.com/assets/27f667878492fadf33f79ce48dcef1ac.png" align="center" caption="Figure 3.2: Identity verification details viewable in the Workday Candidate Profile" />


<br />

***

## eKYC Custom Object

The eKYC custom object stores identity verification data returned from Incode. It holds:

- Verification outcomes
- Risk categorization details
- Identity validation notes
- Incode session references

This object supports downstream consumption in reports, dashboards, audits, and compliance checks.


<Image src="https://developer.incode.com/assets/29df939ab7e7b0d00ee22b8ce60d2a51.png" align="center" caption="Figure 4.1: Custom Object for the eKYC details" />



<Image src="https://developer.incode.com/assets/9b8b6ebdcda9e0550874a81c349b9dc1.png" align="center" caption="Figure 4.2: Custom Object Fields for eKYC Details" />


<br />

***

## IDV Custom Object

The IDV custom object stores document verification and biometric results from Incode. It holds:

- Document inspection results (authenticity, tampering indicators)
- Biometric comparison metrics (face match scores, liveness checks)
- Risk indicators derived from Incode's scoring engine
- Reference keys for reconciliation and traceability

![](https://developer.incode.com/assets/7487f389b6ce567c330191b5bb9b5507.png)

Figure 5.1: Custom Object for the IDV Details


<Image src="https://developer.incode.com/assets/e5461cc9042b0cb34a4148133291f9d2.png" align="center" caption="Figure 5.2: Custom Object Fields for the IDV Details" />


<br />

***

## Integration Architecture

Data flows through the following pattern:

```
Workday → Workday Studio → Incode REST APIs → Workday Studio → Workday Custom Objects
```

The integration uses the following security measures:

- All data exchanged between Workday and Incode is encrypted over HTTPS.
- Authentication uses API keys stored securely in Workday's Integration System Credentials.
- Logging, retries, and exception tracing are built into the Studio integrations.

<br />

---

- Path: `features-and-modules/advanced-electronic-signature`
- URL: https://developer.incode.com/features-and-modules/advanced-electronic-signature/
- Markdown: https://developer.incode.com/features-and-modules/advanced-electronic-signature.md

# Advanced Electronic Signature

The Advanced Electronic Signature module shows the user documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When the Advanced Electronic Signature module runs, the end user is presented with the documents requiring their signature. The module walks the user through a structured consent flow before the signature is finalized.

By default, the module:

- Displays the documents to be signed, with an option to view each document before proceeding.
- Presents a legal consent screen with required checkboxes, collecting explicit informed consent from the user.
- Finalizes the signature using a digital certificate, ensuring cryptographic integrity and non-repudiation.
- Confirms successful signing with a success state at the end of the flow.

An Advanced Electronic Signature (AES) differs from a basic electronic signature in that it is backed by a digital certificate and requires verified identity before signing. This gives the signed document stronger legal weight and makes it suitable for compliance-driven use cases.

The module can also be configured to:

- Allow the user to upload the document they want signed.
- Allow the user to download or save the signed document after completion.
- Skip specific verification requirements, such as identity score validation, ID verification, face recognition, or one-time password (OTP).

## Use Advanced Electronic Signature

For instructions on implementing and configuring Advanced Electronic Signature on each supported platform, use the following pages:

- [Advanced Electronic Signature (Dashboard)](dashboard-platform-administration/advanced-electronic-signature-dashboard-1/)
- [AES (iOS)](/sdk-reference/module-aes/)
- [AES (Android)](/sdk-reference/android-aes-advanced-electronic-signature)
- [Electronic Signature Module (Web SDK)—includes Advanced Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/)
- [AES (React Native)](/sdk-reference/react-native-modules/#aes)
- [AES (Flutter)](/sdk-reference/flutter-modules/#aes-advanced-electronic-signature)

---

- Path: `features-and-modules/antifraud-check`
- URL: https://developer.incode.com/features-and-modules/antifraud-check/
- Markdown: https://developer.incode.com/features-and-modules/antifraud-check.md

# Antifraud Check

This module compares the current Session with existing Sessions and customers to detect anomalies that could be signs of fraud.

## Integrations

❌ Web | ✅ iOS | ❌ Android


## How It Works

The Antifraud Check module detects potential identity fraud during Onboarding by comparing a new user's session against prior sessions and known identities. It spots suspicious patterns such as:

- The same person trying to enroll under different details.
- Different people reusing the same identity information.&#x20;

It combines biometric similarity and document similarity to produce an overall outcome. Based on what it finds and your risk tolerance settings, it then passes the user through, flags the session for manual review, or treats it as likely fraud.

## Use Antifraud Check

For instructions on implementing and configuring Antifraud Check on each supported platform, use the following pages:

- [Antifraud Check (Dashboard)](/dashboard-platform-administration/antifraud-check-dashboard/)
- [Antifraud (iOS)](/sdk-reference/module-antifraud/)
- [Antifraud (Android)](/sdk-reference/android-antifraud/)
- [Antifraud Module (Web SDK)](/sdk-reference/web-sdk-2-module-antifraud/)
- [Antifraud (React Native)](/sdk-reference/react-native-modules/#antifraud)
- [Antifraud (Flutter)](/sdk-reference/flutter-modules/#antifraud)
- [Antifraud (Cordova)](/sdk-reference/cordova-modules/#addantifraud)

---

- Path: `features-and-modules/b2b-request-new-onboarding-api`
- URL: https://developer.incode.com/features-and-modules/b2b-request-new-onboarding-api/
- Markdown: https://developer.incode.com/features-and-modules/b2b-request-new-onboarding-api.md

# B2B – Request New Onboarding API

This API allows a B2B client to start a new onboarding session for a specific user under a specific integration. The API returns a generated onboarding link that can be delivered to the end user. The API is authenticated using an **OAuth 2.0 Client Credentials** access token.



## Security Model

The B2B Request New Onboarding API uses the **OAuth 2.0 Client Credentials** grant type — a server-to-server authentication pattern intended for trusted backend systems. Unlike the Authorization Code flow, this grant does not involve a user-facing login step. Instead, your server authenticates directly using a `client_id` and `client_secret` to obtain an access token, which is then used to authorize API requests.

A **Client Credentials integration** is created automatically for organizations that have **Integration Ecosystem** enabled.

## Find the Client ID & Client Secret

To view the integration details in Dashboard:

1. In the left navigation, go to **Integrations**.
2. On the Custom tab, click **Default client credentials integration**.

![](https://developer.incode.com/assets/85bb51f40ccec55990ff23024c4390b5.png)

3. Copy the Client ID to use in the access token request.
4. Click **Generate** to create the Client Secret. Copy it to use in the access token request. The secret is shown and copyable **only once**. Store it securely in a secrets manager or vault. If lost, you must generate a new one.

## Step 1: Obtain an Access Token

Before calling the B2B onboarding endpoint, your backend must obtain a Bearer token from the Incode authorization server using the Client Credentials grant.

**Endpoint**: `POST {auth-server-url}/oauth2/token`

**Environment URLs**

| Environment       | Auth Server URL                |
| ----------------- | ------------------------------ |
| Demo              | `https://auth.demo.incode.com` |
| SaaS / Production | `https://auth.incode.com`      |

**Request Parameters**

| Parameter       | Value                | Notes                                                                                                                            |
| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `grant_type`    | `client_credentials` |                                                                                                                                  |
| `client_id`     | `{client_id}`        | [Find the Client ID](/features-and-modules/b2b-request-new-onboarding-api#find-the-client-id-client-secret)         |
| `client_secret` | `{client_secret}`    | [Generate the Client Secret](/features-and-modules/b2b-request-new-onboarding-api#find-the-client-id-client-secret) |
| `scope`         | `openid`             |                                                                                                                                  |

**Example Request**

```bash
curl -X POST {auth-server-url}/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id={client_id}" \
  -d "client_secret={client_secret}" \
  -d "scope=openid"
```

A successful response returns an `access_token` to be used as a Bearer token in Step 2.

## Step 2: Call the B2B Request New Onboarding Endpoint

Use the access token obtained in Step 1 to call the onboarding endpoint.

**Endpoint**: `POST {base-api-url}/omni/b2b/onboarding/request-new`

**Environment URLs**

| Environment       | Base API URL                       |
| ----------------- | ---------------------------------- |
| Demo              | `https://demo-api.incodesmile.com` |
| SaaS / Production | `https://saas-api.incodesmile.com` |

### Headers

* `Authorization: Bearer <access_token>`
* `Content-Type: application/json`
* `x-api-key: {api_key}`

### Request Body

| Field | Required | Description | Example |
|-------|----------|-------------|---------|
| `integrationReference` | ✅ Yes | Unique identifier of the integration, as configured in Incode Dashboard. | `"int_b2b_prod_001"` |
| `loginHint` | ✅ Yes | User identifier (email, username, phone, etc.).<br><br>Employee-based integrations:<br>• An existing employee record with the provided `loginHint` must already exist.<br>• If no matching employee is found, the request will fail.<br><br>Candidate-based integrations:<br>• If no existing candidate is found with the provided `loginHint`, a new candidate will be created automatically. | `"john.doe@clientcompany.com"` |
| `notification` | ✅ Yes | Notification configuration object. | See below |
| `notification.type` | ✅ Yes | Must be `SMS`, `EMAIL`, or `URL`. | |
| `notification.email` | Conditional | Required if `type` is `EMAIL`. | `"john.doe@clientcompany.com"` |
| `notification.phone` | Conditional | Required if `type` is `SMS`. | `"+14155552671"` |
| `applicantId` | Optional | This should only be provided when requesting onboarding to an existing candidate. | `"app_987654321"` |
| `name` | Conditional | Applicant full name. New candidates must have a name. | `"John Doe"` |
| `meetingLink` | Optional | Custom meeting or session URL. | `"https://meet.company.com/abc"` |
| `linkValidityInMinutes` | Optional | How long the onboarding link remains valid.<br><br>If omitted, system default validity of 15 minutes applies. You can configure a different value in Dashboard at **Configuration** > **General** > **Onboarding link duration**. | `60` |

See [Migrating from Workforce](/features-and-modules/b2b-request-new-onboarding-api/#migrating-from-workforce) for a table that maps field names used in Workforce to field names used here.

**Example Request Body**

```json
{
  "integrationReference": "int_b2b_prod_001",
  "loginHint": "john.doe@clientcompany.com",
  "meetingLink": "https://meet.clientcompany.com/session/abc123",
  "notification": {
    "type": "URL"
  }
}
```

## Step 3: Handle the Response

### Success Response

**HTTP Status:** `200 OK`

Returned when a new onboarding session is successfully created and the onboarding link is generated.

**Response Body Schema**

```json
{
  "url": "string"
}
```

**Example Response**

```json
{
  "url": "https://url/workflow/69a8a52d8cc9700f429f9565?uuid=e22199bf-246e-4761-99e1-873cef74fc52&url_uuid=a5fe50d9-5f8e-4cd1-bcd2-189fe08c845e"
}
```

Deliver this URL to the end user via your preferred channel (email, SMS, in-app redirect, etc.).

### Error Responses

**HTTP Status:** `400 Bad Request`

Returned when a required field is missing or has an invalid value.

**Response Body Schema**

```json
{
  "timestamp": {timestamp},
  "status": {status},
  "error": {error},
  "message": {message},
  "path": "/omni/b2b/onboarding/request-new"
}
```

**Example Error Responses**

Missing or invalid `loginHint`:

```json
{
  "timestamp": 1773781956561,
  "status": 400,
  "error": "Bad Request",
  "message": "Login hint be a non-empty string",
  "path": "/omni/b2b/onboarding/request-new"
}
```

Missing phone number when `notification.type` is `SMS`:

```json
{
  "timestamp": 1773781994221,
  "status": 400,
  "error": "Bad Request",
  "message": "Phone must be provided when notification type is SMS",
  "path": "/omni/b2b/onboarding/request-new"
}
```

New candidate missing a name:

```json
{
  "timestamp": 1773782210449,
  "status": 400,
  "error": "Bad Request",
  "message": "BadRequestException: New candidate must have name.",
  "path": "/omni/b2b/onboarding/request-new"
}
```

## Migrating from Workforce

The table below maps deprecated Workforce request parameters to their Omni equivalents.

| Workforce field           | Omni equivalent         | Notes                                                                                  |
| ------------------------- | ----------------------- | -------------------------------------------------------------------------------------- |
| `integrationId`           | `integrationReference`  | Value format has changed — retrieve the new reference from the Omni Dashboard          |
| `secret`                  | _(removed)_             | Authentication is now handled via OAuth 2.0 Bearer token; no per-request secret needed |
| `loginHint`               | `loginHint`             | Unchanged                                                                              |
| `loginHintType`           | _(removed)_             | No longer required; type is inferred automatically                                     |
| `correlationId`           | `externalCustomerId`    | Surfaced in webhook payloads as `externalCustomerId`                                   |
| `redirectUrl`             | _(removed)_             | Configure redirect behavior at the workflow level in the Omni Dashboard                |
| `validityMinutes`         | `linkValidityInMinutes` | Renamed; same semantics                                                                |
| `givenNames` + `lastName` | `name`                  | Combined into a single full name field                                                 |

---

- Path: `features-and-modules/business-watchlist`
- URL: https://developer.incode.com/features-and-modules/business-watchlist/
- Markdown: https://developer.incode.com/features-and-modules/business-watchlist.md

# Watchlist Business

The Watchlist Business module screens business entities against global sanctions lists, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. It helps you conduct due diligence on vendors, suppliers, and partners. This reduces the risk of legal and financial exposure from associations with financial crimes or sanctions violations.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Watchlist Business is a processing node. It must be placed in a Workflow or Flow after user data has been collected. It uses the collected business name and country information to run a search against configured watchlist sources.

When the module runs, it submits the business name and country to the configured watchlist provider and returns a match status, total hits, and total matches. Results are available in [single Session view](/dashboard-platform-administration/single-session-view/#business) under the **Business** tab. Watchlist Business results are commonly used in Workflow conditions, such as in [this use case](/concepts-and-architecture/condition-use-cases/#watchlist-business).

Watchlist Business can be used with the [KYB](/features-and-modules/ekyb/) module or independently.

## Use Watchlist Business

For instructions on implementing and configuring Watchlist Business on each supported platform, use the following pages:

- [Watchlist Business (Dashboard)](/dashboard-platform-administration/watchlist-business-dashboard/)
- [Watchlist for Business Module (Web SDK)](/sdk-reference/web-sdk-2-module-watchlist-for-business/)

To view the end user experience screens and customization options for this module, see [Watchlist for Business: Design and UX](/design-and-ux/watchlist-business-design/).


<br />

---

- Path: `features-and-modules/certificate-issuance`
- URL: https://developer.incode.com/features-and-modules/certificate-issuance/
- Markdown: https://developer.incode.com/features-and-modules/certificate-issuance.md

# Certificate Issuance

This module issues a digital certificate tied to a verified identity, supporting legally binding and compliant document signing with enhanced security and authentication measures. It is available to organizations operating under applicable regulatory frameworks, such as Incode's Trust Service Provider (PSC) standing in Mexico.

## Integrations

✅ Web | ✅ iOS | ✅ Android

## How It Works

Certificate Issuance runs at the end of an Onboarding journey, after the user has completed all required identity verification (IDV) steps. The module only proceeds if the user passes IDV scoring; if verification fails, no certificate is issued.

When issuance is triggered, the user is prompted to create a password and can then download their certificate (`.cer`). Each identity can hold only one certificate. If a certificate already exists for that identity, the module skips issuance and presents a link to download the existing certificate instead.

You can configure certificate validity as one-time, short-term, and long-term/permanent. Long-term certificates are blocked when the user's identity document expires within 12 months.

## Use Certificate Issuance

For instructions on implementing and configuring Certificate Issuance on each supported platform, use the following pages:

- [Certificate Issuance (Dashboard)](/dashboard-platform-administration/certificate-issuance-dashboard/)
- [Certificate Issuance Module (Web SDK)](/sdk-reference/web-sdk-2-module-certificate-issuance/)

---

- Path: `features-and-modules/claims-matching`
- URL: https://developer.incode.com/features-and-modules/claims-matching/
- Markdown: https://developer.incode.com/features-and-modules/claims-matching.md

# Claims Matching


This module verifies an employee's identity by comparing attributes extracted from their verification Session—such as name, date of birth, and location—against trusted reference data from one or more connected directories (Okta, Entra ID, LDAP, CSV, or a no-directory candidate record flow). It is designed to reduce false approvals caused by name collisions or look-alike records by requiring agreement across multiple identity attributes before a Session is approved.

## Integrations

❌ Web | ✅ iOS | ✅ Android


## How It Works

Claims Matching runs after identity verification has produced a set of claims—attributes like name, date of birth, country, city, and region extracted from the captured ID. It then retrieves reference attributes from one or more configured directory sources and evaluates whether those attributes agree, claim by claim, according to the matching policy defined in the project settings.

Each claim in the policy is evaluated independently with two configurable dimensions:

- **Match type** controls how strictly the values are compared. Exact matching requires the values to be identical. Fuzzy matching applies a looser comparison algorithm, which varies by claim type: for example, name matching behaves differently from date-of-birth matching.
- **Presence rule** controls what happens when a claim is absent. If a claim is marked Required and is missing on either side—not present in the verification Session output or not present in the directory record—the claim fails. If a claim is marked Optional and is absent, it is skipped.

All required claims must pass for the Session to be auto-approved. If any required claim fails or is missing, the Session is routed to **Claims Match Review** as a single consolidated review item. Reviewers approve or reject the full set of claims together; review is not done field by field.

When multiple directories are connected, the system attempts matching against each one. If any directory satisfies the policy, the result is treated as a pass.

## Use Claims Matching

For instructions on configuring Claims Matching in Dashboard, see:

- [Claims Matching (Dashboard)](/dashboard-platform-administration/claims-matching-dashboard/)

---

- Path: `features-and-modules/combined-consent`
- URL: https://developer.incode.com/features-and-modules/combined-consent/
- Markdown: https://developer.incode.com/features-and-modules/combined-consent.md

# Data Sharing Consent

The Data Sharing Consent module shows the user one or more preconfigured [consents](/dashboard-platform-administration/configuration-consents-tab/) to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey. Incode includes default consent language that covers common regulatory requirements. You can use only the default consent, create your own to match your requirements, or use a combination of both.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android | :warning: React Native coming soon

## How It Works

This module asks permission from the user to collect the information and photos required for verification. The module adapts to your organization's needs. You can:

- Localize the consent screen into any language your users speak
- Write custom titles, descriptions, and terms using markdown for rich formatting
- Mark each checkbox as mandatory or optional

<Accordion title="View an example consent">
  This example consent displays to the user:

  - A clear title.
  - Detailed consent information.
  - Mandatory and optional consent checkboxes.
  - A "Continue" button that is enabled only after all mandatory consents are checked.


  <Image src="https://developer.incode.com/assets/8dea255a08561625c9df6f4ec152c6d1.png" alt="The consent is displayed, with checkboxes and a Continue option at the bottom." align="center" />



  <Image src="https://developer.incode.com/assets/27e283c3fce90575a96a7a15712d3452.png" align="center" />

</Accordion>

​You [create and manage consents](/dashboard-platform-administration/configuration-consents-tab/) in Dashboard. You can view Data Sharing Consent module results on the [Other tab in single Session view](/dashboard-platform-administration/single-session-view/#other).

## Use Data Sharing Consent

For instructions on implementing and configuring Data Sharing Consent on each supported platform, use the following pages:

- [Data Sharing Consent (Dashboard)](/dashboard-platform-administration/data-sharing-consent-dashboard/)
- [Combined Consent (iOS)](/sdk-reference/module-combined-consent/)
- [Combined Consent (Android)](/sdk-reference/android-combined-consent/)
- [Consent Module (Web SDK)](/sdk-reference/web-sdk-2-module-consent/)
- [Combined Consent (React Native)](/sdk-reference/react-native-modules/#combinedconsent)
- [Combined Consent (Flutter)](/sdk-reference/flutter-modules/#combinedconsent)

To view the end user experience screens and customization options for this module, see [Data Sharing Consent: Design and UX](/design-and-ux/data-sharing-consent-design/).

---

- Path: `features-and-modules/cross-check`
- URL: https://developer.incode.com/features-and-modules/cross-check/
- Markdown: https://developer.incode.com/features-and-modules/cross-check.md

# Cross Check

The Cross Check module compares a data field from one source against the same field from a second source and identifies whether the values match. For example, it can confirm that the name on a user's ID matches the name on their proof of address document.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

In Workflows, Cross Check is a process module. It operates on data collected by earlier modules in the Workflow, such as ID Capture, Proof of Address, and Custom Fields. It doesn't ask the user for data directly. In Flows, Cross Check is a configurable setting. It also relies on modules that collect data.

You configure one or more comparisons. Each comparison specifies two document sources, the field to compare across those sources, and a severity level that controls how strictly the values must match. You can give each comparison a name to make it easier to identify when [viewing results](#fetch-and-read-results) later.

Cross Check executes each configured comparison and produces a match or mismatch result. You can use these results in later conditional logic to route the session. For example, you can continue the flow on a match or mark the Session for review on a mismatch.

### Fetch and Read Results

You can fetch results using the Fetching Crosscheck Results API. When reading results, iterate through the dictionary and use a "contains" comparison with the comparison name. Do not read the comparison name as a direct key on the JSON response. Incode's system automatically appends metadata to the end of each name, so a direct key lookup will not work.

For example, if you name a comparison `FirstNameComparison` in Dashboard, the API may return it as `FirstNameComparison #i1class`. The appended metadata varies and should be ignored. To retrieve the result, loop through the top-level keys of the JSON response and find the key that contains `FirstNameComparison`.

Name comparisons so there is no overlap in "contains" matching. For example, do not name one comparison `FirstNameComp` and another `FirstNameComparison`. This can cause your code to read from the wrong field.

## Use Cross Check

For instructions on implementing and configuring Cross Check on each supported platform, use the following pages:

- [Cross Check (Dashboard)](/dashboard-platform-administration/cross-check-dashboard/)
- [Cross-Document Data Match Module (Web SDK)](/sdk-reference/web-sdk-2-module-cross-doc-match/)

---

- Path: `features-and-modules/curp-validation`
- URL: https://developer.incode.com/features-and-modules/curp-validation/
- Markdown: https://developer.incode.com/features-and-modules/curp-validation.md

# CURP Validation

The CURP Validation module validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When CURP Validation runs, it queries RENAPO through Incode's configured third-party providers (typically FIMPE and/or CECOBAN). If the CURP is present in the OCR output from a prior ID Capture step, the module uses that value automatically and can validate without additional input from the user. If no CURP is available from OCR, the user is prompted to enter it manually. If the user does not know their CURP, the module can generate one from name, birthdate, sex, and birth state data provided by the user.

Your Incode Representative can configure providers for you. A primary provider and an optional fallback provider can be specified; the fallback is triggered if the primary times out or returns an error. Your Incode Representative can also configure per-provider timeout and daily request rate limits.

## Use CURP Validation

For instructions on implementing and configuring CURP Validation on each supported platform, use the following pages:

- [CURP Validation (Dashboard)](/dashboard-platform-administration/curp-validation-dashboard/)
- [CURP Validation (iOS)](/sdk-reference/module-curp-validation/)
- [CURP Validation (Android)](/sdk-reference/android-curp-validation/)
- [CURP Validation Module (Web SDK)](/sdk-reference/web-sdk-2-module-curp-validation/)
- [CURP (React Native)](/sdk-reference/react-native-modules/#curp)
- [CURP (Flutter)](/sdk-reference/flutter-modules/#curp)
- [CURP Validation (Cordova)](/sdk-reference/cordova-modules/#curpvalidation)

To view the end user experience screens and customization options for this module, see [CURP: Design and UX](/design-and-ux/curp-design/).

---

- Path: `features-and-modules/custom-fields`
- URL: https://developer.incode.com/features-and-modules/custom-fields/
- Markdown: https://developer.incode.com/features-and-modules/custom-fields.md

# Custom Fields

The Custom Fields module captures additional user-provided data and saves it to the Session, making it available for reporting, server-side decisions, or cross-checking later in the journey. The data can either be collected from the user in the UI or supplied through the back end via API.

:::warning
This module is deprecated. Existing implementations may continue use, but it is not available in new implementations.
:::





## Integrations

&#x20;:white_check_mark: Web | :x: iOS | :x: Android


## How It Works

Custom fields are first [defined in Dashboard](/dashboard-platform-administration/configuration-general-tab/#manage-custom-fields), where each field is given a name and a type (number, string, Boolean, or date). Once defined, they can be populated in two ways:

- **Collected in the UI**: When the Custom Fields module is added to a Flow, it presents a form to the user during verification. On submit, the values are saved to the Session.
- **Sent via the backend**: When the module is not added, the values are expected through the backend via API and saved to the Session.

Either way, the data lands in the Session's custom fields payload, where it can be referenced by other modules or retrieved server-side after the Session completes.

## Use Custom Fields

For instructions on adding and configuring the Custom Fields module on each supported platform, use the following pages:

- [Custom Fields (Dashboard)](/dashboard-platform-administration/custom-fields-dashboard/)
- [Custom Fields (iOS)](/sdk-reference/module-custom-fields)
- [Custom Fields Module (Web SDK)](/sdk-reference/web-sdk-2-module-custom-fields/)

---

- Path: `features-and-modules/custom-module`
- URL: https://developer.incode.com/features-and-modules/custom-module/
- Markdown: https://developer.incode.com/features-and-modules/custom-module.md

# Custom Module

The Custom Module pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues. Use it to integrate Workflows with external systems, partner APIs, or proprietary business rules while keeping the end user in a single, seamless journey.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android


:::warning
The Custom Module requires an SDK integration to function. Dashboard configuration alone is not enough. The callback that resumes the Workflow is implemented in your SDK code.
:::

## How It Works

The Workflow configuration in Dashboard defines which Custom Module runs and where it sits in the Workflow. The SDK callback (`onCustomModuleStarted`) defines what happens when the module runs. Both pieces are required.

### Responsibilities

**Incode** runs the Workflow and manages the pause and resume around the Custom Module.

**Your integration** implements the `onCustomModuleStarted` callback in the SDK, runs whatever logic the use case requires (such as a partner API call, a risk-engine evaluation, a custom UI screen, or a business rule check), and returns a result.

### Execution Flow

1. The Workflow runs until it reaches the Custom Module, then pauses.
2. The SDK invokes your `onCustomModuleStarted` callback.
3. Your callback runs its logic and returns one of three [results](#results).
4. The Workflow resumes and branches based on the returned result.

### Results

Your callback must return exactly one of the following:

| Result      | Path                |
| ----------- | ------------------- |
| `onSuccess` | Approved/pass       |
| `onFail`    | Rejected/fail       |
| `onUnknown` | No decision/step-up |

**Important:** If your callback does not return a result, the Workflow stays paused indefinitely. This is the most common integration issue. Make sure every code path in your callback, including error handlers, returns a result.

### When to Use the Custom Module

The Custom Module is the right choice when:

- A decision needs to happen outside of Incode
- Your business logic shouldn't live in Incode's platform
- The Workflow's next step depends on an external system, partner API, or proprietary rule
- You need to insert a custom screen or step-up prompt mid-Workflow

The Custom Module is **not** intended for:

- Long-running or delayed decisions; the Workflow stays paused while the callback runs, so the operation should complete in a reasonable time
- Logic that Incode already provides as a standard module
- Workflows where no customer-side integration is available to handle the callback

## Use Custom Module

The Custom Module requires **both** Dashboard configuration and an SDK integration. See the following pages:

- [Custom Module (Dashboard)](/dashboard-platform-administration/custom-module-dashboard/)
- [Custom Module (iOS)](/sdk-reference/module-custom-module/)
- [Custom Module (Android)](/sdk-reference/android-custom-module/)

---

- Path: `features-and-modules/custom-watchlist`
- URL: https://developer.incode.com/features-and-modules/custom-watchlist/
- Markdown: https://developer.incode.com/features-and-modules/custom-watchlist.md

# Custom Watchlist

The Custom Watchlist module screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It runs as a background process and isn't visible to the end user.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Custom Watchlist operates as a background process. It runs after user data has been collected earlier in the Session and does not present any visible step to the end user.

Each watchlist entry is associated with one of the following list types:

- **Blocklist**: Identifies users your organization wants to review or deny.
- **Allowlist**: Identifies users your organization wants to explicitly trust or grant special access.

When the module runs, it performs layered matching between the current session's collected data and your organization's watchlist entries. Matching can include:

- Data matching against fields such as name, date of birth, ID number, personal ID number, email, phone, and device fingerprint.
- [1:N](/get-started-with-incode/glossary/#1n-face-authentication) biometric face search against face data in the watchlist.
- An optional fallback search.

Matches are scored, with Blocklist matches reducing the Session score and Allowlist matches increasing it. The final result is made available as a condition that your Workflow or Flow can branch on, enabling you to block the user, route them for additional review, or apply special privileges. You can view watchlist matches on the [Risk tab in single Session view](/dashboard-platform-administration/single-session-view/#risk).

Watchlist entries can be added in several ways: [manually through the Dashboard](/dashboard-platform-administration/manage-custom-watchlists/), [from a completed session](/dashboard-platform-administration/single-session-view/#risk), via CSV bulk import, or automatically. Each entry stores a snapshot of the user's data at the time of creation; entries are not automatically updated if the underlying identity record changes later.

## Use Custom Watchlist

- [Custom Watchlist (Dashboard)](/dashboard-platform-administration/custom-watchlist-dashboard/)
- [Custom Watchlist (iOS)](/sdk-reference/module-custom-watchlist/)
- [Custom Watchlist (Android)](/sdk-reference/android-custom-watchlist/)
- [Custom Watchlist Module (Web SDK)](/sdk-reference/web-sdk-2-module-custom-watchlist/)
- [Custom Watchlist (React Native)](/sdk-reference/react-native-modules/#customwatchlist)
- [Custom Watchlist (Flutter)](/sdk-reference/flutter-modules/#customwatchlist)

To view the end user experience screens and customization options for this module, see [Watchlist and Custom Watchlist: Design and UX](/design-and-ux/watchlist-design/).

<br />

---

- Path: `features-and-modules/deepsight`
- URL: https://developer.incode.com/features-and-modules/deepsight/
- Markdown: https://developer.incode.com/features-and-modules/deepsight.md

# Deepsight Overview and Implementation

Incode Deepsight is the AI-powered fraud prevention suite that protects every step of identity verification experiences from deepfakes and identity spoofing injections. This guide will help you enable Deepsight in your integration.

![Diagram showing how Deepsight detects deepfake injection attacks across the verification flow.](https://developer.incode.com/assets/867c9a15872278983107584bb2873673.png)

The diagram illustrates four trust layers Deepsight applies across the onboarding flow, from left to right:

- **User → Behavior Trust:** Flags anomalies in device motion and user behavior that signal bots or scripted fraud.
- **Device → Device Trust:** Detects tampered, emulated, or rooted devices that allow spoofing or injection.
- **Selfie Capture → Camera Trust:** Blocks virtual cameras and prevents video injection using camera source validation.
- **User Verified → Multi-Modal Intelligence:** Advanced multi-frame liveness, depth, and motion modalities deployed to detect deepfakes and physical spoofs in the captured selfie.

A red arrow labeled "Injection bypasses device camera" shows the attack vector a deepfake attempts — entering directly at the Selfie Capture stage, bypassing the device layer. Deepsight's Camera Trust and Multi-Modal Intelligence layers are positioned to intercept this attack.

## Prerequisites

Deepsight requires additional licensing. After you have purchased Deepsight, contact your Incode Admin to enable the Deepsight feature flag for the requested organization.

Before using Deepsight, you should be familiar with concepts such as multimodal, spoof, evasion, stream frames, jailbroken phones, and deepfakes.

If you have any questions, contact your Incode Admin for assistance.

## API Changes With Deepsight

When Deepsight is enabled, the response structure of the `GET /omni/get/score` API changes.

With Deepsight OFF, the response includes these sections: 

- `liveness`
- `deviceRisk`
- `behavioralRisk` sections.

With Deepsight ON, the response includes a `deepsight` section containing new and enhanced fields that build on the original fields:

- `liveness`  → `multimodalIntelligence` + new fields.
- `deviceRisk`  → `deviceTrust`
- `behavioralRisk`  → `behavioralTrust`
- `cameraTrust` (new field)

#### Multi-modal Intelligence

Multi-modal intelligence includes attack detection checks for face domain and attack vectors for document domain.

**Face domain:**

- **Physical Spoof Detection**: Catches 2D masks, 3D masks, paper replays, and screen replays. Depth Feed Analysis: Confirms 3D structures.
- **Digital Spoof Detection**: Catches deepfakes, digitally generated or manipulated images or videos.
- **Evasion**: Catches extreme expressions, extreme makeup, and paraphernalia.

**Document domain:**

- **AI Generated Document**: Catches digitally-generated or manipulated document images.

## Implementation

This section contains instructions for implementing Deepsight based on the platform you are using.

### Web SDK
1. Update Web SDK to version 1.80.0 or higher.
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
   6. Call `renderCaptureFace` or `renderCaptureId` SDK methods. Example of `renderCaptureFace` usage below:

```javascript
// When rendering the camera for selfie capture
const container = document.getElementById("face-capture-container");
IncodeSDK.renderCaptureFace(container, {
  session={session}
  onSuccess: async (response) => {
    // Unlike renderCamera, renderCaptureFace will not call processFace automatically
    const processFaceResponse = await IncodeSDK.processFace({ token: session.token });
    // go to next step
  },
  onError: (error) = {
    // handle error
  },
});

// When rendering the camera for ID capture
const container = document.getElementById("id-capture-container");
IncodeSDK.renderCaptureId(container, {
  session: session,
  onSuccess: (response) => {
    // ID capture completed successfully
  },
  onError: (error) => {
    // handle error
  },
});
```

### iOS SDK

#### Standard Mode

1. Update SDK to version 5.35.0 or higher.
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
4. Copy the ID for the Workflow or Flow you added Deepsight to. Provide this ID as a `configurationId` to the methods in the next step. More info here.
5. Use `startFlow()` , `startWorkflow()` , `startOnboarding()` or `startOnboardingSection()` APIs to access the feature

**Important Considerations**

* In Standard mode, Video Liveness recording is only available with `startFlow()` or `startWorkflow()` APIs

#### Capture-Only Mode

To enable Deepsight within the Selfie module, specify the `videoLivenessRecording` param:

```javascript
let flowConfig = IncdOnboardingFlowConfiguration()
flowConfig.addSelfieScan(videoLivenessRecording: true)
```

No additional configuration is needed for the ID module in capture-only.

:::info
When Deepsight is enabled, it overrides stream frames and session recording settings.
:::

**Important Considerations**

* In Capture-Only mode, the video file path is returned in `SelfieScanResult.videoFileURL`
* In Capture-Only mode, to get the results from Deepsight, you’ll need to call into Incode’s backend with the `metadata` string received in the `IdScanResult` or `SelfieScanResult` objects.

### Android SDK

#### Standard Mode

1. Update SDK version 5.38.0 or later.
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
4. Copy the ID for the Workflow or Flow you added Deepsight to. Provide this ID as a `configurationId`to the methods in next step
5. Use `startFlow()` , `startWorkflow()` , `startOnboarding()` or `startOnboardingSection()` APIs to access the feature

#### Capture-Only Mode

To enable Deepsight within the Selfie module, call the  `setVideoLivenessRecordingEnabled` method when adding the `SelfieScan` module:

```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addSelfieScan(new SelfieScan.Builder()
        .setVideoLivenessRecordingEnabled(true)
        .build()
    )
    .build();
```

No additional configuration is needed for the ID module in capture-only.

:::info
When Video Liveness is enabled through Deepsight, it overrides `SelfieScan.streamFramesEnabled` and `FlowConfig.isRecordSession` settings.
:::

**Important Considerations**

* In Capture-Only mode, the video file path is returned in `SelfieScanResult.videoFilePath`
* In Capture-Only mode, to get the results from Deepsight, you’ll need to call into Incode’s backend with the `metadata` string received int the `IdScanResult` or `SelfieScanResult` objects.

### React Native SDK

:::info
React Native currently only supports Standard Mode for Deepsight.
:::

#### Standard Mode

1. Update SDK version to 9.4.0 or later
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
4. Copy the ID for the Workflow or Flow you added Deepsight to. Provide this ID as a `configurationId`to the methods in next step
5. Use `startFlow()` , `startWorkflow()` , `startOnboarding()` or `startOnboardingSection()` APIs to access the feature.


### Flutter SDK

:::info
Flutter currently only supports Standard Mode for Deepsight.
:::

#### Standard Mode

1. Simply update to SDK version 4.8.0 or later.
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
4. Copy the ID for the Workflow or Flow you added Deepsight to. Provide this ID as a `configurationId`to the methods in next step.
5. Use `startFlow()` , `startWorkflow()` , `startOnboarding()` or `startOnboardingSection()` APIs to access the feature.


### Cordova SDK

:::info
Cordova currently only supports Standard Mode for Deepsight.
:::

#### Standard Mode

1. Simply update to SDK version 2.8.0 or later.
2. Contact your Incode representative to request Deepsight for your organization.
3. Enable Deepsight in Workflow or Flow settings:
   1. In the Dashboard left navigation, click **Workflows** or **Flows**, depending on your configuration.
   2. Locate the Workflow or Flow you want to enable Deepsight for.
      1. For Workflows, click to open it, then click **Edit**.
      2. For Flows, click **Edit**.
   3. Click to switch to the Settings tab.
   4. At the top of the settings page, click to toggle Deepsight ON. If you don’t see Deepsight here, contact your Incode representative to ensure your organization is configured to use Deepsight.
   5. Click **Save Changes**.
4. Copy the ID for the Workflow or Flow you added Deepsight to. Provide this ID as a `configurationId` to the methods in next step.
5. Use `startOnboardingSection` method:

```javascript
cordova.exec(function(winParam) {
  console.log("Section completed successfully: " + winParam);
}, function(err) {
  console.log("Error: " + err);
  // handle the error by showing some UI or alert.
}, "Cplugin", "startOnboardingSection", ["addId", "addSelfieScan"]);
```


<br />

---

- Path: `features-and-modules/digital-id-verification`
- URL: https://developer.incode.com/features-and-modules/digital-id-verification/
- Markdown: https://developer.incode.com/features-and-modules/digital-id-verification.md

# Digital ID Verification

A digital ID is a government-issued, cryptographically signed credential that lives in a user's phone wallet. Instead of photographing a physical card, the user presents the credential straight from the wallet, and Incode verifies on the server-side that it is genuine, unaltered, and issued by the official authority.

Digital ID Verification is not a separate product to integrate. It is an acceptance method you [enable in the ID Capture module](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) alongside physical document capture.




## What is mDL?
Mobile Drivers Licence (mDL) is a signed data package that lives on the user's phone and holds the same fields as the physical license: name, date of birth, document number, issue and expiry dates, license class, portrait, and address. The issuing authority signs it once at provisioning, so the proof travels with the credential from then on.

When a user presents an mDL, Incode runs cryptographic checks server-side:

| Check | Confirms | Stops |
|---|---|---|
| Issuer data authentication	| A real DMV signed this exact data | Forged / synthetic credentials |
| Data-element integrity	| No field was altered after issuance | Tampering |



### Capabilities on top of verification:

- **Selective disclosure**: request only the fields you need. Age thresholds are pre-computed as signed flags (age_over_18, age_over_21), so a wallet can attest "over 21" without transmitting the date of birth.
- **Portrait + face match**: request the portrait and match it against a live selfie to bind the credential to the person present.
- **Authoritative data**: issuer-signed fields with standardized names

### Supported wallets
Incode normalizes every wallet behind one integration so you do not re-integrate per wallet or per release. The mDL data is the same standardized format in each wallet — what differs is how the wallet exposes it to a verifier.

| Wallet	| Region |
|---|---|
| Apple Wallet | US |
| Google Wallet | US |
| Samsung Wallet - Coming soon | US |
| CA DMV Wallet |	US - California |

Incode is a registered Google Wallet Verifier Registrar and its own Certificate Authority, so you accept Google Wallet mDLs through Incode without registering with Google directly. Incode supports customers during approval process with Apple.



### Coverage
As of mid-2026, 21 US states + Puerto Rico issue mDL. Wallet support overlaps by state; most issuing states offer more than one wallet.

For the current wallet-by-state matrix, see [Supported Digital IDs.](/general-reference/supported-digital-ids/)



### Choose your integration
Enable Digital ID acceptance once per flow in Dashboard ([ID Capture → Manage Digital IDs](/dashboard-platform-administration/id-capture-dashboard/#configuration-options)), then integrate through the surface you already use:

| Platform | When to use | Guide |
|---|---|---|
| Web |	Incode Hosted (no-code) or WebSDK | [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/) |
| iOS SDK | Native iOS apps | [Apple Wallet ](/sdk-reference/ios-apple-wallet-id/)|
| Android SDK | Native Android apps | [Google Wallet](/sdk-reference/android-google-wallet-id/) |

---

- Path: `features-and-modules/document-capture`
- URL: https://developer.incode.com/features-and-modules/document-capture/
- Markdown: https://developer.incode.com/features-and-modules/document-capture.md

# Document Capture

The Document Capture module captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When a user reaches the Document Capture module, they choose to either take a photo with their camera or upload an existing file from their device. After capturing or selecting a file, the user previews it and confirms before continuing to the next step in verification.

Submitted documents appear in [single Session view](/dashboard-platform-administration/single-session-view/) in the **Other** tab > **Other Documents**.

## Use Document Capture

For instructions on implementing and configuring Document Capture on each supported platform, use the following pages:

- [Document Capture (Dashboard)](/dashboard-platform-administration/document-capture-dashboard/)
- [Document Capture (iOS)](/sdk-reference/module-document-scan/)
- [Document Scan (Android)](/sdk-reference/android-document-scan/)
- [Document Capture Module (Web SDK)](/sdk-reference/web-sdk-2-module-document-capture/)
- [Document Scan (React Native)](/sdk-reference/react-native-modules/#documentscan)
- [Document Scan (Flutter)](/sdk-reference/flutter-modules/#documentscan)
- [Document Scan (Cordova)](/sdk-reference/cordova-modules/#adddocumentscan)

To view the end user experience screens and customization options for this module, see [Document Capture: Design and UX](/design-and-ux/document-capture-design/).

---

- Path: `features-and-modules/ekyb`
- URL: https://developer.incode.com/features-and-modules/ekyb/
- Markdown: https://developer.incode.com/features-and-modules/ekyb.md

# eKYB (Electronic Know Your Business)

eKYB (electronic Know Your Business) verifies the identity and legitimacy of a business by matching business details (such as business name, tax ID, address, and associated individuals) against records in recognized government and commercial data sources. It enables business onboarding while supporting regulatory compliance across jurisdictions.

Incode eKYB offers two solutions:

- **Verification**: The end user submits business details, and the system verifies them against a source of truth. Verification returns match results for each submitted field along with enrichment details such as registration status and entity type.
- **Prefill**: An enrichment solution that lowers end-user friction by pre-filling verified business data from official registries. The end user submits only a tax ID and business name; the system returns additional details such as registered address and entity type. Prefill is currently available for Mexico only, in Flows only.

Both solutions are configured on the [eKYB Dashboard configuration](/dashboard-platform-administration/ekyb-dashboard/) page.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android | :white_check_mark: React Native | :white_check_mark: Flutter

## How it Works

### Verification

When the eKYB module runs in Verification mode, the end user is presented with a set of input fields collecting the business information required for verification. The fields shown depend on the module configuration and the country the end user selects for the check. Once the user submits their information, the module sends it to the eKYB source for the selected country and returns a set of match and status results that downstream Workflow or Flow steps can act on.

By default, the module performs the following:

- Collects business information from the end user through an input form.
- Prompts the end user to select the country the check should verify against.
- Submits the collected data to the eKYB source for the selected country.
- Returns match results for individual fields (such as business name, tax ID, address, and associated individuals) and an overall registration status for the business.

The module can also be configured to:

- Select which fields are collected from the end user (business name, address, tax ID, UBO, and directors).
- Branch the session on eKYB results using Workflow Conditions, including business name, tax ID verification, address verification, UBO name match, and address deliverability.

### Prefill

When the eKYB module runs in Prefill mode, the end user submits only a tax ID and business name. The system looks up the business in official registries and returns matching business details (such as registered address and entity type) for pre-fill in the flow. Prefill does not verify submitted values; it retrieves and returns authoritative data.

## Use eKYB

For instructions on implementing and configuring eKYB on each supported platform, use the following pages:

- [eKYB (Dashboard)](/dashboard-platform-administration/ekyb-dashboard/)
- [eKYB (iOS)](/sdk-reference/module-ekyb/)
- [eKYB (Android)](/sdk-reference/android-ekyb/)
- [eKYB Module (Web SDK)](/sdk-reference/web-sdk-2-module-ekyb)
- [eKYB (React Native)](/sdk-reference/react-native-modules/#ekyb)
- [eKYB (Flutter)](/sdk-reference/flutter-modules/#ekyb)

To view the end user experience screens and customization options for this module, see [eKYB: Design and UX](/design-and-ux/ekyb-design/).

---

- Path: `features-and-modules/ekyc`
- URL: https://developer.incode.com/features-and-modules/ekyc/
- Markdown: https://developer.incode.com/features-and-modules/ekyc.md

# eKYC (Electronic Know Your Customer)

eKYC (electronic Know Your Customer) verifies an end user's identity by matching the personal information they provide (such as name, date of birth, address, tax ID, phone, and email) against records in recognized data sources. It enables online onboarding while supporting regulatory compliance across jurisdictions.

## Integrations

✅ Web | ✅ iOS | ✅ Android

## How it Works

When the eKYC module runs, the end user is presented with a set of input fields collecting the personal information required for verification. The fields shown depend on the module configuration and on the country and data sources selected for the check. Once the user submits their information, the module sends it to the configured eKYC sources and returns a set of match and risk results that downstream Workflow or Flow steps can act on.

By default, the module performs the following:

- Collects personal information from the end user through a configurable input form.
- Submits the collected data to one or more eKYC sources for verification.
- Returns match results for individual fields (such as tax ID, name, address, and date of birth) and overall risk levels for the user, tax ID, phone, and other attributes.

The module can also be configured to:

- Select which fields are collected from the end user, based on the country and data sources in use.
- Route to country-specific sources of truth. For example, United States checks can draw on telco data, credit bureau data, and state driver's license records.
- Branch the session on eKYC results using Workflow Conditions, including overall eKYC level, tax ID status, tax ID level, and phone level.

## Use eKYC

For instructions on implementing and configuring eKYC on each supported platform, use the following pages:

- [eKYC (Dashboard)](/dashboard-platform-administration/ekyc-dashboard/)
- [eKYC (iOS)](/sdk-reference/module-ekyc/)
- [eKYC (Android)](/sdk-reference/android-ekyc/)
- [eKYC Module (Web SDK)](/sdk-reference/web-sdk-2-module-ekyc/)
- [eKYC (React Native)](/sdk-reference/react-native-modules#ekyc)
- [eKYC (Flutter)](/sdk-reference/flutter-modules/#ekyc)
- [eKYC (Cordova)](/sdk-reference/cordova-modules/#addekyc)

To view the end user experience screens and customization options for this module, see [eKYC: Design and UX](/design-and-ux/ekyc-design/).

---

- Path: `features-and-modules/ekyc-prefill`
- URL: https://developer.incode.com/features-and-modules/ekyc-prefill/
- Markdown: https://developer.incode.com/features-and-modules/ekyc-prefill.md

# eKYC Pre-fill
eKYC Pre-fill looks up an end user in recognized identity data sources from one or two identifiers, such as a phone number or a tax ID, and returns the personal data the source holds: name, date of birth, addresses, emails, phone details, and risk signals. It lowers onboarding friction by filling in data the end user would otherwise have to type, and gives downstream steps an authoritative record to work with.

:::info
This is different than [eKYC](/features-and-modules/ekyc/).
:::



## Integrations

✅ API | ✅ Web | Coming Soon: iOS, Android, React Native, Flutter

## How it Works

When this module runs, Incode looks up the end user in the data source configured for the session's country and source, using the identifiers that configuration requires. The module returns the person's data as the source holds it, together with a check status that downstream Workflow or Flow steps can act on.

By default, the module performs the following:
- Looks up the end user in the data source for the session's configured country and source.
- Returns the person's data the source holds: name, date of birth, addresses, emails, phone details, and risk signals.
- Stores the result and a check status with the session.

This module can also be configured to:
- Select which identifiers are sent to find the person, from the ones the chosen source accepts.
- Return driver's license data the source holds, when enabled.

## Use eKYC Pre-fill

For instructions on implementing and configuring this module, see:
- [eKYC Pre-fill](/dashboard-platform-administration/ekyc-prefill-dashboard/) (Dashboard)

---

- Path: `features-and-modules/electronic-signature-module`
- URL: https://developer.incode.com/features-and-modules/electronic-signature-module/
- Markdown: https://developer.incode.com/features-and-modules/electronic-signature-module.md

# Electronic Signature

The Electronic Signature module captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent.

For a certificate-backed signature with stronger legal weight, use the [Advanced Electronic Signature](/features-and-modules/advanced-electronic-signature/) module.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android | :white_check_mark: Flutter | :white_check_mark: React Native | :white_check_mark: Cordova | :white_check_mark: Xamarin

## How It Works

When the Electronic Signature module runs, the user is guided through a short signing sequence at the end of the verification process.

By default, the module:

- Prompts the user to draw their initials on a canvas. **Continue** becomes active after input is detected.
- Prompts the user to draw their full signature on a canvas. **Done** becomes active after input is detected.
- Displays a confirmation screen where the user can review their signature and clear and redraw it if needed.
- Processes the submission and displays a success confirmation when the signature is accepted.

The module can also be configured to display a custom title and subtitle, allowing you to add instructions or communicate the purpose of the signature to the user.

After the session is complete and approved, the captured signature can be visually added to the session record or digitally attached to one or more PDF documents.

> Capturing initials and attaching a signature to a PDF are not available for the Incode Webflow app. They are only available for SDK integrations.

## Use Electronic Signature

For instructions on implementing and configuring Electronic Signature on each supported platform, use the following pages:

- [Electronic Signature (Dashboard)](/dashboard-platform-administration/electronic-signature-dashboard/)
- [Signature (iOS)](/sdk-reference/module-signature/)
- [Signature (Android)](/sdk-reference/android-signature/)
- [Electronic Signature Module (Web SDK)](/sdk-reference/web-sdk-2-module-electronic-signature/)
- [Signature (React Native)](/sdk-reference/react-native-modules/#signature)
- [Signature (Flutter)](/sdk-reference/flutter-modules/#signature)
- [Signature (Cordova)](/sdk-reference/cordova-modules/#addsignature)

To view the end user experience screens and customization options for this module, see [Electronic Signature: Design and UX](/design-and-ux/electronic-signature-design/).

---

- Path: `features-and-modules/email-input`
- URL: https://developer.incode.com/features-and-modules/email-input/
- Markdown: https://developer.incode.com/features-and-modules/email-input.md

# Email Input

The Email Input module collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

The Email Input module prompts the user to enter their email address. If one-time password (OTP) verification is enabled, the system sends a code that email address. The user enters the code, the system validates it, and the user proceeds. If the code is incorrect or expired, the user sees an error and can request a new code. If OTP verification is not enabled, the user continues without that step.

The module can be positioned at any point in an onboarding journey where an email address is required.

## Use Email Input

For instructions on implementing and configuring Email Input on each supported platform, use the following pages:

- [Email Input (Dashboard)](/dashboard-platform-administration/email-input-dashboard/)
- [Email (iOS)](/sdk-reference/module-email/)
- [Email (Android)](/sdk-reference/android-email/)
- [Email Module (Web SDK)](/sdk-reference/web-sdk-2-module-email/)
- [Email (React Native)](/sdk-reference/react-native-modules/#email)
- [Email (Flutter)](/sdk-reference/flutter-modules/#email)
- [Email (Cordova)](/sdk-reference/cordova-modules/#email)

To view the end user experience screens and customization options for this module, see [Email Input: Design and UX](/design-and-ux/email-input-design/).

---

- Path: `features-and-modules/external-decision`
- URL: https://developer.incode.com/features-and-modules/external-decision/
- Markdown: https://developer.incode.com/features-and-modules/external-decision.md

# External Decision

The External Decision module calls a configured external endpoint and exposes the returned decision value for routing [Conditions](/dashboard-platform-administration/configure-workflow-conditions/). Use this module to incorporate signals you own, such as account status, risk, or eligibility, into identity verification. This is commonly used in cases where identity alone is not enough to determine what happens next.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

This module is not exposed as a standalone SDK module and has no end-user-facing UI.

## How It Works

External Decision is a **process node**: when the Workflow engine reaches it, the Incode backend calls the configured endpoint synchronously, receives a single decision string in response, and routes the Workflow based on that value using standard business rules. Nothing is shown to the end user.

On each execution, Incode sends a fixed payload with the session context (`sessionId`, `identityId`, `flowId`, and `timestamp`). The client endpoint returns a single string representing its decision; the value is client-defined, and Incode does not interpret or constrain it. An optional `reason` field is supported for observability and does not affect routing.

The node can be placed anywhere in the Workflow. Place it after an authentication module only when the decision depends on `identityId`; otherwise it runs using `sessionId`, `flowId`, and `timestamp` alone.

### Failure handling

The Incode backend waits up to 30 seconds for a response from the client endpoint. If the endpoint does not respond within that window, is unavailable, returns an error, returns an invalid format, or returns a string that matches no configured condition, the decision value is set to the reserved value `INCODE_UNRESOLVED`. This value is available in Conditions like any other, so you decide how to handle it (terminate the session, proceed, or trigger a step-up).

The 30-second timeout is fixed and cannot be adjusted. Endpoints that may take longer than 30 seconds to respond are not compatible with the External Decision module.

### Authentication

Incode authenticates to the client endpoint using OAuth 2.0 (client credentials). The client stands up a standard OAuth token endpoint and issues Incode a Client ID and Secret. On each execution, Incode requests an access token from the client's authorization URL using the client-credentials grant, then calls the client endpoint with that token.

## Use External Decision

For instructions on configuring the External Decision module in Dashboard, see:

- [External Decision (Dashboard)](/dashboard-platform-administration/external-decision-dashboard/)

<br />

---

- Path: `features-and-modules/face-authentication`
- URL: https://developer.incode.com/features-and-modules/face-authentication/
- Markdown: https://developer.incode.com/features-and-modules/face-authentication.md

# Face Authentication

The Face Authentication module captures a returning user's face with the device camera and matches it against the face already enrolled for that user. It then returns a pass or fail result. Face Authentication detects liveness, physical and digital attacks, and image quality. It can also check for lenses, hats, closed eyes, or face masks.

Face Authentication provides an added level of security for organizations, applications, and higher-level permissions. For example, you can use Face Authentication to grant access to specific functionality within your application. This ensures the person requesting access has a valid, registered Incode Identity.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Face Authentication captures a selfie image of a user, creates a biometric template from the captured image, and compares it against biometric identities to confirm a match. There are two identification strategies to confirm an [identity](/get-started-with-incode/glossary/#incode-identity):

- 1:1 searches for a specific identity
- 1:N searches for an identity among all your Incode identities

After the authentication process is complete, you can review the results and decide what happens next in your application.

## Use Face Authentication

For instructions on implementing and configuring Face Authentication on each supported platform, use the following pages:

- [Face Authentication (Dashboard)](/dashboard-platform-administration/face-authentication-dashboard/)
- [Face Authentication (iOS)](/sdk-reference/module-face-authentication/)
- [Face Authentication (Android)](/sdk-reference/android-face-authentication/)
- [Auth Face (Web SDK 1.x)](/sdk-reference/web-sdk-reference/#renderauthface)
- [Authentication (Web SDK 2.x)](/sdk-reference/web-sdk-2-module-authentication/)
- [Face Authentication (React Native)](/sdk-reference/react-native-modules/#faceauthentication)
- [Face Authentication (Flutter)](/sdk-reference/flutter-modules/#faceauthentication)
- [addFaceAuthentication (Cordova)](/sdk-reference/cordova-modules/#addfaceauthentication)

<br />

---

- Path: `features-and-modules/face-capture`
- URL: https://developer.incode.com/features-and-modules/face-capture/
- Markdown: https://developer.incode.com/features-and-modules/face-capture.md

# Face Capture

The Face Capture module captures a user’s face with their device’s camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using [1:1](/get-started-with-incode/glossary/#11-face-authentication) or [1:N](/get-started-with-incode/glossary/#1n-face-authentication) face authentication.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When Face Capture runs, the user is guided through a selfie capture step with on-screen feedback to center their face. The module attempts automatic capture for a configurable window, falling back to additional attempts if the image cannot be captured cleanly.

Once an image is captured, the module can run any combination of the following checks, depending on configuration:

- **Liveness checks** that detect physical presentation attacks (e.g., printed photos, masks), digital presentation attacks (e.g., a face shown on a screen), and evasion attempts (e.g., obscuring or distorting the face). Each check has a configurable threshold.
- **Image quality validation** at a configurable severity level.
- **Occlusion and obstruction checks** for glasses or contact lenses, masks, hats, closed eyes, and image brightness.
- **Reliable age estimation** against a configurable minimum age.

Sessions that fail capture can optionally be routed for manual review rather than rejected outright. Processing can run server-side or on the user's device.

## Use Face Capture

For instructions on implementing and configuring Face Capture on each supported platform, use the following pages:

- [Face Capture (Dashboard)](/dashboard-platform-administration/face-capture-dashboard/)
- [Selfie (iOS)](/sdk-reference/module-selfie/)
- [Selfie Scan (Android)](/sdk-reference/android-selfie-scan/)
- [Selfie Module (Web SDK)](/sdk-reference/web-sdk-2-module-selfie-1/)
- [Selfie Scan (React Native)](/sdk-reference/react-native-modules/#selfiescan)
- [Selfie Scan (Flutter)](/sdk-reference/flutter-modules/#selfiescan)
- [Selfie Scan (Cordova)](/sdk-reference/cordova-modules/#addselfiescan)

To view the end user experience screens and customization options for this module, see [Face Capture: Design and UX](/design-and-ux/face-capture-design/).

---

- Path: `features-and-modules/face-match`
- URL: https://developer.incode.com/features-and-modules/face-match/
- Markdown: https://developer.incode.com/features-and-modules/face-match.md

# Face Match

The Face Match module compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a confidence score.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Face Match runs after [Face Capture](/features-and-modules/face-capture/) and [ID Capture](/features-and-modules/id-capture/) have collected their images. The module compares a configurable pair of images—the captured selfie against the photo from the ID, the photo read from the document's NFC chip, or both—and returns a match result based on a configurable severity threshold.

For sessions that capture more than one identity document, Face Match can be scoped to a specific ID (First ID or Second ID) so it compares against the intended document.

Face Match can also optionally inspect the EXIF metadata of the captured face image to detect signs of software modification or to reject images captured well before the session began.

## Use Face Match

For instructions on implementing and configuring Face Match on each supported platform, use the following pages:

- [Face Match (Dashboard)](/dashboard-platform-administration/face-match-dashboard/)
- [Face Match (iOS)](/sdk-reference/module-face-match/)
- [Face Match (Android)](/sdk-reference/android-face-match/)
- [Face Match Module (Web SDK)](/sdk-reference/web-sdk-2-module-face-match)
- [Face Match (React Native)](/sdk-reference/react-native-modules/#facematch)
- [Face Match (Flutter)](/sdk-reference/flutter-modules/#facematch)
- [Face Match (Cordova)](/sdk-reference/cordova-modules/#addfacematch)

To view the end user experience screens and customization options for this module, see [Face Match: Design and UX](/design-and-ux/face-match-design/).

---

- Path: `features-and-modules/face-onboarding`
- URL: https://developer.incode.com/features-and-modules/face-onboarding/
- Markdown: https://developer.incode.com/features-and-modules/face-onboarding.md

# Face Onboarding

The Face Onboarding module allows a user to begin or resume Onboarding using face recognition, reusing their data from a previous Session with their consent. This reduces friction for returning users. If no previous Session is found, the verification continues along a standard Onboarding or KYC path.

## Integrations

:white_check_mark: Web | :x: iOS | :x: Android

## How It Works

When a user reaches the Face Onboarding module, they are prompted to proceed with face recognition. If the user has completed a prior Onboarding, they are asked to consent to reusing that data. The system then attempts to match the user's face against existing records.

- **If a match is found**, prior Onboarding data is available for reuse, streamlining the remainder of the flow.
- **If no match is found**, the verification continues with a full Onboarding or KYC path.

This approach helps prevent duplicate accounts and supports fraud mitigation by identifying whether a user record already exists before collecting new information.

## Use Face Onboarding

For instructions on implementing and configuring Face Onboarding on each supported platform, use the following pages:

- [Face Onboarding (Dashboard)](/dashboard-platform-administration/face-onboarding-dashboard/)

---

- Path: `features-and-modules/feature-deep-dive`
- URL: https://developer.incode.com/features-and-modules/feature-deep-dive/
- Markdown: https://developer.incode.com/features-and-modules/feature-deep-dive.md

# Feature Deep Dive

This section contains more detailed information about products, features, or settings that are part of other pages or processes.

- [Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/)
- [Deepsight Overview and Implementation](/features-and-modules/deepsight/)
- [INE Fingerprint Validation](/features-and-modules/ine-fingerprint-validation/)
- [Risk AI Agent Overview](/features-and-modules/risk-ai-agent/)
- [Silent Network Authentication](/features-and-modules/silent-network-authentication-sna/)
- [Digital ID Wallet Verification](/features-and-modules/digital-id-verification)
- [TrustGraph](/features-and-modules/trust-graph-overview/)

<br />

---

- Path: `features-and-modules/features-and-modules`
- URL: https://developer.incode.com/features-and-modules/
- Markdown: https://developer.incode.com/features-and-modules.md

# Features and Modules

This section covers modules, the building blocks you use to construct a Workflow or Flow, and the advanced features that extend or harden a verification session beyond core identity checks.

***

## Modules

- **[Modules Overview](/features-and-modules/modules-overview-and-availability/)**: The full catalog of modules available for Workflows and Flows, organized by category: collecting identity data, verifying and authenticating users, capturing signatures and consent, adding human-assisted verification, and configuring the user experience.

## Advanced Fraud & Risk Features

- **[Deepsight](/features-and-modules/deepsight/)**: Incode's AI-powered fraud prevention suite. Adds device, camera, and behavioral trust layers on top of standard liveness to detect deepfakes, virtual cameras, and injection attacks. Requires additional licensing.
- **[Risk AI Agent](/features-and-modules/risk-ai-agent/)**: An adaptive, machine-learning-based fraud decisioning system that replaces the legacy TotalScore model. It weighs signals from across a session in context (document validation, biometrics, device and behavioral risk) to produce a single pass/fail decision, rather than applying fixed rule thresholds. Currently available for Mexico, the United States, and Colombia.

## Specialized Verification Features

- **[Digital ID Wallet Verification](/features-and-modules/digital-id-verification/)**: Lets users verify with a mobile driver's license (mDL) or other supported digital ID from Apple Wallet, Google Wallet, Samsung Wallet, or a national identity scheme, instead of photographing a physical ID. Available in the Hosted onboarding app or via the Web SDK `renderWallet` API. Configured within the ID Capture module; see [Supported Digital IDs](/general-reference/supported-digital-ids/) for the full list of wallets, schemes, and attributes by region.

* **[INE Fingerprint Validation](/features-and-modules/ine-fingerprint-validation/)**: Verifies a user's identity against Mexico's INE using fingerprint biometrics captured at a branch or kiosk, returning a per-finger confidence score alongside the standard government validation result. Configured within the Government Record Verification module.
* **[Silent Network Authentication (SNA)](/features-and-modules/silent-network-authentication-sna/)**: A carrier-based phone verification method, available within the Phone Number Input module, that confirms possession of a mobile number directly through the mobile network — no SMS or OTP entry required. Falls back to SMS OTP automatically when SNA isn't available. Currently supported in Flows only.

## Server-to-Server Integration

- **[B2B Request New Onboarding API](/features-and-modules/b2b-request-new-onboarding-api/)**: Lets a B2B client trigger a new onboarding session for a specific user from its own backend, authenticated via OAuth 2.0 Client Credentials, and returns a link to deliver to the end user. Replaces the legacy Workforce integration pattern.

***

**Note:** Deepsight, Risk AI Agent, INE Fingerprint Validation, SNA, and Digital IDs all require your Incode representative to enable them for your organization before they can be configured.

---

- Path: `features-and-modules/field-comparison-1`
- URL: https://developer.incode.com/features-and-modules/field-comparison-1/
- Markdown: https://developer.incode.com/features-and-modules/field-comparison-1.md

# Field Comparison

The Field Comparison module compares fields from different sources, such as OCR data extracted from an ID and information entered by the user, to verify they match. It supports branching, so you can route users down separate paths depending on whether the comparison passes or fails.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android


## How It Works

Field Comparison performs a crosscheck between fields from two different sources and produces a named result that downstream logic can act on. You configure the module by choosing the sources and specific fields to include in the comparison. Common sources include:

- OCR data extracted from a captured ID
- Input fields entered directly by the user
- Other data collected earlier in the Session (such as custom fields or additional captured sources)

The comparison output is saved under a Comparison Name you define. Once configured, that name becomes available in the rules list of any Condition node that follows; the result is reusable, not just a one-time pass/fail gate.

## Use Field Comparison

For instructions on implementing and configuring Field Comparison on each supported platform, use the following pages:

- [Field Comparison (Dashboard)](/dashboard-platform-administration/field-comparison-dashboard/)
- [Field Comparison Module (Web SDK)](/sdk-reference/web-sdk-2-module-field-comparison/)

---

- Path: `features-and-modules/fiscal-qr-ocr`
- URL: https://developer.incode.com/features-and-modules/fiscal-qr-ocr/
- Markdown: https://developer.incode.com/features-and-modules/fiscal-qr-ocr.md

# Fiscal QR OCR

The Fiscal QR OCR module scans the QR code on a Constancia de Situación Fiscal, the SAT tax document issued in Mexico, and extracts the associated fiscal data. The parsed result is available via API as a Fiscal QR Response tied to the Session.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android | :white_check_mark: Flutter | :white_check_mark: React Native

## How It Works

The Fiscal QR OCR module prompts the user to scan the QR code on their Constancia de Situación Fiscal. Incode extracts the URL embedded in the QR code and attaches it to the Session. Incode then scrapes the fiscal data returned by that URL, including information tied to the user's RFC (tax identification record), and makes it available as a structured Fiscal QR Response.

You can retrieve the parsed data using the following API endpoint:

`GET /omni/fiscal-qr-url-response/{interviewId}`

This endpoint returns the information obtained from the fiscal QR URL added to the session. It is available for Mexico only.

## Use Fiscal QR OCR

For instructions on implementing Fiscal QR OCR on each supported platform, use the following pages:

- [Fiscal QR OCR (Dashboard)](/dashboard-platform-administration/fiscal-qr-ocr-dashboard/)

To view the end user experience screens and customization options for this module, see [Fiscal QR OCR: Design and UX](/design-and-ux/fiscal-qr-ocr-design/).

---

- Path: `features-and-modules/forms-and-data-entry`
- URL: https://developer.incode.com/features-and-modules/forms-and-data-entry/
- Markdown: https://developer.incode.com/features-and-modules/forms-and-data-entry.md

# Forms and Data Entry

The Forms and Data Entry module presents one or more custom form screens to collect information from a user. Responses are stored in the Session and can be retrieved via API.

Use this module when identity documents alone don't capture everything you need. Common use cases include collecting information not present on the user's ID (such as a residential address or a Brazilian CPF number), routing users to different verification paths based on citizenship or residency status, and gathering more information for enhanced due diligence.

### Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

### How It Works

When the Forms and Data Entry module runs, the user is presented with one or more pages of questions you configure. The module displays a title, if configured. It shows one question at a time or a set of questions per page, depending on how you set up the form.

By default, the module:

- Displays questions in the order they were configured, across one or multiple pages.
- Enforces required fields before allowing the user to proceed. **Continue** is disabled until all required inputs on the current page contain valid responses.
- Validates input in real time, showing inline errors for invalid entries: for example, an invalid email address or an out-of-range date.
- Stores all responses in the Session, where they can be reviewed on the [Other tab in single Session view](/dashboard-platform-administration/single-session-view/#other) and retrieved via the [Fetch Form Answers](/reference/fetchformanswers/) API.

The module can also be configured to:

- Display a custom title at the top of the form or hide the title entirely.
- Spread questions across multiple pages, with **Continue** advancing the user between pages and **Done** completing the form on the final page.
- Mix pre-defined questions, which come with question text and input type already set, with custom questions, where you write the question text and select the input type.
- Mark individual questions as required or optional.

In Workflows, form responses can be used as [conditions](/dashboard-platform-administration/configure-workflow-conditions/). This allows you to route users to different verification paths based on their answers. For example, you can request additional documents from non-citizens or collect more information from users flagged for enhanced due diligence.

### Use Forms and Data Entry

For instructions on implementing and configuring Forms and Data Entry on each supported platform, use the following pages:

- [Forms and Data Entry (Dashboard)](/dashboard-platform-administration/forms-and-data-entry-dashboard/)
- [Dynamic Forms (iOS)](/sdk-reference/module-dynamic-forms/)
- [Dynamic Forms (Android)](/sdk-reference/android-dynamic-forms/)
- [Dynamic Forms Module (Web SDK)](/sdk-reference/web-sdk-2-module-dynamic-forms/)

To view the end user experience screens and customization options for this module, see [Forms and Data Entry: Design and UX](/design-and-ux/forms-and-data-entry-design/).




<br />

---

- Path: `features-and-modules/geolocation-2`
- URL: https://developer.incode.com/features-and-modules/geolocation-2/
- Markdown: https://developer.incode.com/features-and-modules/geolocation-2.md

# Geolocation

The Geolocation module requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city. Use this module to:

- Identify Sessions where the device location differs significantly from the location implied by the user's IP address or identity document
- Detect potential VPN or proxy use

:::info
IP-based location is captured automatically for every session as part of device info, even if the Geolocation module isn't in your Flow or Workflow. If you only need country- or region-level location information, you may not need this module.
:::

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When the Geolocation module runs, it asks the user to allow location access on their device. If the user allows it, the module records the device's GPS coordinates and location fields such as country, region, city, and postal code. If the user denies or skips the step, no GPS location is captured. IP-based location is still available through device info. Precise location data can drive Workflow [conditions](/dashboard-platform-administration/configure-workflow-conditions/) to route users, block access, or send sessions to manual review.

Location data is stored in the Session. You can review it on the [Other tab in single Session view](/dashboard-platform-administration/single-session-view/#other) and retrieve it via the [Fetch Device Info](/api-reference/get-device-info/) API.

<Accordion title="View location data and confidence levels">
  Geolocation extracts the following data. Each confidence level indicates how reliable that data is for driving Workflow conditions and compliance decisions. For routing and access decisions, use conditions based on data with high confidence levels.

  | Data                                            | Description                                                        | Confidence Level |
  | ----------------------------------------------- | ------------------------------------------------------------------ | ---------------- |
  | Latitude                                        | North-south coordinate                                             | High             |
  | Longitude                                       | East-west coordinate                                               | High             |
  | Admin Area                                      | Primary administrative division: for example, state or province    | High             |
  | Sub Admin Area                                  | Secondary administrative division: for example, county             | High             |
  | Locality                                        | City or town                                                       | High             |
  | Country Code                                    | ISO 3166-1 alpha-3 country code                                    | High             |
  | Country Name                                    | Full name of the country                                           | High             |
  | Device Location                                 | Address or place where the device is located                       | Medium           |
  | Device Location vs IP Address Location Distance | Distance between the device's GPS location and IP address location | Medium           |
  | Sub Locality                                    | Smaller area within the locality: for example, neighborhood        | Medium           |
  | Thoroughfare                                    | Street or road name                                                | Medium           |
  | Postal Code                                     | Postal or ZIP code                                                 | Medium           |
  | Sub Thoroughfare                                | Specific address number or additional street information           | Low              |
</Accordion>

## Use Geolocation

For instructions on implementing and configuring Geolocation on each supported platform, use the following pages:

- [Geolocation (Dashboard)](/dashboard-platform-administration/geolocation-dashboard/)
- [Geolocation (iOS)](/sdk-reference/module-geolocation/)
- [Geolocation (Android)](/sdk-reference/android-geolocation/)
- [Geolocation Module (Web SDK)](/sdk-reference/web-sdk-2-module-geolocation/)
- [Geolocation (React Native)](/sdk-reference/react-native-modules/#geolocation)
- [Geolocation (Flutter)](/sdk-reference/flutter-modules/#geolocation)
- [Geolocation (Cordova)](/sdk-reference/cordova-modules/#addgeolocation)

To view the end user experience screens and customization options for this module, see [Geolocation: Design and UX](/design-and-ux/geolocation-design/).

---

- Path: `features-and-modules/government-record-verification`
- URL: https://developer.incode.com/features-and-modules/government-record-verification/
- Markdown: https://developer.incode.com/features-and-modules/government-record-verification.md

# Government Record Verification

The Government Record Verification module validates identity data extracted from a user's ID document and/or biometrics extracted from a user’s selfie against an authoritative government registry. The process runs in the background and isn't visible to the user. After relevant identity attributes and selfie image are captured via OCR or barcode scan alongside selfie capture, the module submits them to the corresponding government provider for that country. The provider returns a field-by-field match result and an overall status that can be used in downstream decisioning.

## Integrations

:white_check_mark: iOS | :white_check_mark: Android | :white_check_mark: Web

## How It Works

Government Record Verification receives identity data and/or selfie images already collected in the session, typically from the [ID Capture](/features-and-modules/id-capture/) and [Face Capture](/features-and-modules/face-capture/) modules. It sends that data to a country-specific provider to verify identity against authoritative government databases through either direct or indirect connections.

For country-specific guides, refer to the [Government Verification](/general-reference/government-verification-sources/) section.

A fallback mode is available for situations where the primary provider is unavailable. Contact your Incode representative to configure providers.

The provider checks the submitted data fields and selfie image against its system of record and returns match results for each submitted input along with an overall verification status. The module supports two verification types, depending on the country and the terms of a client’s contract:





- **Data validation**: Compares biographic fields—such as document number, name, and date of birth—against the government record.
- **Facial validation**: Where supported, compares a biometric captured during the session against a government-held portrait or biometric source.

These can be used together or independently. Verification results are displayed in Dashboard on the [GovMatch tab in single Session view](/dashboard-platform-administration/single-session-view/#govmatch).

You may use the Process Government Validation API to directly interact with the module, bypassing the default configuration and using Session-specific details for verification.



## Use Government Record Verification

- [Government Record Verification (Dashboard)](/dashboard-platform-administration/government-record-verification-dashboard/)
- [Government Validation (iOS)](/sdk-reference/module-government-validation/)
- [Government Validation (Android)](/sdk-reference/android-government-validation/)
- [Government Validation Module (Web SDK)](/sdk-reference/web-sdk-2-module-gov-validation-1/)
- [Government Validation (React Native)](/sdk-reference/react-native-modules/#governmentvalidation)
- [Government Validation (Flutter)](/sdk-reference/flutter-modules/#governmentvalidation)
- [Government Validation (Cordova)](/sdk-reference/cordova-modules/#addgovernmentvalidation)

To view the end user experience screens and customization options for this module, see [Government Record Verification: Design and UX](/design-and-ux/government-record-verification-design/).

---

- Path: `features-and-modules/id-capture`
- URL: https://developer.incode.com/features-and-modules/id-capture/
- Markdown: https://developer.incode.com/features-and-modules/id-capture.md

# ID Capture

The ID Capture module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When the ID Capture module runs, the end user is prompted to present an identity document to their device camera. The module displays visual guidelines to help the user center the document in the frame and provides real-time feedback on framing, focus, and lighting.

By default, the module performs the following:

- Detects the document in the camera frame and applies alignment classification to confirm the ID is properly positioned before accepting the image.
- Automatically captures the front of the ID when image quality criteria are met (autocapture), with configurable timeouts and a configurable maximum number of attempts.
- Prompts the user to capture the back of the ID and, when applicable, reads the barcode on the back.

The module can also be configured to:

- Restrict accepted documents to a specific country or to a defined set of document types (for example, passports only).
- Allow the user to upload an existing image of their ID instead of capturing live, or to submit a digital ID from a device wallet.
- Capture only the front of the ID, only the back, or require both regardless of document type.
- Redact sensitive fields (such as document numbers or personal identifiers) from the captured images on a per-country, per-document-type basis.

## Digital ID Wallet Verification

ID Capture supports Digital ID verification alongside physical document capture. Users can verify with a mobile driver's license (mDL) or other supported digital ID from Apple Wallet, Google Wallet, or Samsung Wallet, instead of photographing a physical ID.

Digital IDs are enabled per flow in the Dashboard. Once enabled, the wallet option appears automatically in the Hosted onboarding app's ID chooser, or can be launched from a custom UI using the Web SDK `renderWallet` API.

For the integration model, end-user experience, and recommended patterns, see [Digital ID Wallet Verification](/features-and-modules/digital-id-verification/).

For the full list of supported wallets, schemes, and attributes by region, see [Supported Digital IDs](/general-reference/supported-digital-ids/).

## Use ID Capture

For instructions on implementing and configuring ID Capture on each supported platform, use the following pages:

- [ID Capture (Dashboard)](/dashboard-platform-administration/id-capture-dashboard/)
- [ID Capture (iOS)](/sdk-reference/module-id-scan/)
- [ID Scan (Android)](/sdk-reference/android-id-scan/)
- [ID Capture Module (Web SDK)](/sdk-reference/web-sdk-2-module-id-capture/)
- [ID Scan (React Native)](/sdk-reference/react-native-modules/#idscan)
- [ID Scan (Flutter)](/sdk-reference/flutter-modules/#idscan)
- [Add ID (Cordova)](/sdk-reference/cordova-modules/#addid)

To view the end user experience screens and customization options for this module, see [ID Capture: Design and UX](/design-and-ux/id-capture-design/).

<br />

---

- Path: `features-and-modules/id-validation-module`
- URL: https://developer.incode.com/features-and-modules/id-validation-module/
- Markdown: https://developer.incode.com/features-and-modules/id-validation-module.md

# ID Validation

The ID Validation module determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Capture](/features-and-modules/id-capture/) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

The Capture ID module collects images of the front and, where applicable, back of the user's ID. When the ID Validation module runs, the Incode Platform performs OCR data extraction and a series of authenticity checks on the captured ID images. These checks assess factors such as document liveness, tamper detection, barcode content, font consistency, and more. These depend on which checks are enabled in your configuration.

The module produces a validation score at the module level. That score contributes to an overall Session outcome (approved, rejected, or manual review) based on your configured thresholds and workflow logic.

## Use ID Validation

For instructions on implementing and configuring ID Validation on each supported platform, use the following pages:

- [ID Validation (Dashboard)](/dashboard-platform-administration/id-validation-dashboard/)
- [Process ID (iOS)](/sdk-reference/module-process-id/)
- [Process ID (Android)](/sdk-reference/android-process-id/)
- [Process ID (React Native)](/sdk-reference/react-native-modules/#processid)
- [Process ID (Flutter)](/sdk-reference/flutter-modules/#processid)
- [Add ID (Cordova)—includes Process ID](/sdk-reference/cordova-modules/#addid)

---

- Path: `features-and-modules/ine-fingerprint-validation`
- URL: https://developer.incode.com/features-and-modules/ine-fingerprint-validation/
- Markdown: https://developer.incode.com/features-and-modules/ine-fingerprint-validation.md

# INE Fingerprint Validation

Incode's INE Fingerprint Validation lets you verify a user's identity against Mexico's Instituto Nacional Electoral (INE) using fingerprint biometrics captured at a branch or kiosk. You supply fingerprint scans from your existing hardware; Incode forwards them to INE for matching and returns a per-finger confidence score alongside the standard government validation result.

This feature must be enabled for your organization before use. Contact your Incode representative if you are interested in this feature. When enabled, this feature is configurable in the [Government Record Verification](/dashboard-platform-administration/government-record-verification-dashboard/) module.&#x20;

***

## How It Works

Fingerprint validation is a two-step flow:

1. **Collection** — your app uploads fingerprints to the active session using `/omni/add/fingerprints`.
2. **Validation** — your app calls `/omni/process/government-validation`. Incode selects the best available fingerprints, sends them to INE alongside face and ID data, and returns a combined result.

Fingerprints can also be passed inline in the validation request instead of pre-uploading them. See [Sample Request](#sample-request) below.

***

## Supported Fingerprint Formats

| Value | Format |
| ----- | ------ |
| `1`   | ANSI   |
| `2`   | WSQ    |
| `3`   | RAW    |

All formats submitted in a single session must use the same type. If you upload fingerprints with a different `type` than what is already stored in the session, all previously stored fingerprints are deleted before the new ones are saved.

The most common format in production is **WSQ (**`type: 2`**)**.

***

## Finger Index Mapping

Use the `index` field to identify which finger was scanned.

| Index | Finger | Hand  |
| ----- | ------ | ----- |
| 1     | Thumb  | Right |
| 2     | Index  | Right |
| 3     | Middle | Right |
| 4     | Ring   | Right |
| 5     | Pinky  | Right |
| 6     | Thumb  | Left  |
| 7     | Index  | Left  |
| 8     | Middle | Left  |
| 9     | Ring   | Left  |
| 10    | Pinky  | Left  |

The most common submission in production is the **right index finger (**`index: 2`**)** in WSQ format.

If a user cannot provide a specific finger, submit whichever finger is available. A single fingerprint is sufficient — there is no minimum beyond one.

***

## API Reference

### POST `/omni/add/fingerprints`

Upload one or more fingerprints to the active session.

**Request body:**

```json
{
  "type": 2,
  "fingerprints": [
    {
      "index": 2,
      "base64Fingerprint": "<base64-encoded image>",
      "fingerprintMetadata": {
        "device": "scanner_device",
        "resolution": "500x500",
        "qualityScore": "95"
      }
    }
  ]
}
```

**Fields:**

| Field                                             | Type           | Required | Description                                          |
| ------------------------------------------------- | -------------- | -------- | ---------------------------------------------------- |
| `type`                                            | integer        | Yes      | Fingerprint format: `1` = ANSI, `2` = WSQ, `3` = RAW |
| `fingerprints`                                    | array          | Yes      | Array of fingerprint objects                         |
| `fingerprints[].index`                            | integer (1–10) | Yes      | Which finger was scanned                             |
| `fingerprints[].base64Fingerprint`                | string         | Yes      | Base64-encoded fingerprint image                     |
| `fingerprints[].fingerprintMetadata.device`       | string         | No       | Scanner device identifier                            |
| `fingerprints[].fingerprintMetadata.resolution`   | string         | No       | Image resolution                                     |
| `fingerprints[].fingerprintMetadata.qualityScore` | string         | No       | Quality score reported by the scanner                |

**Response:**

```json
{ "success": true }
```

**Behavior notes:**

- The session must be active. Fingerprints cannot be added to a completed or expired session.
- Submitting a fingerprint with the same `index` as one already stored in the session overwrites the previous one. Use this to replace a low-quality scan.
- You may upload up to 10 fingerprints per session (one per index).

***

### GET `/omni/get/fingerprints?interviewId={id}`

Retrieve the fingerprints stored for a session. Returns the same structure as the add request, with `base64Fingerprint` populated from storage.

***

### POST `/omni/process/government-validation`

Trigger INE identity validation. Incode selects the best available fingerprints from the session and sends them to INE alongside face and ID data.

Fingerprints can be passed inline in this request using the `fingerprintsData` field, or omitted entirely if they were already uploaded via `/omni/add/fingerprints` — the service retrieves them from storage automatically. Inline fingerprints take precedence over stored ones.

See the [Sample Request](#sample-request) section for a full example.

***

## Finger Selection Logic

INE accepts a maximum of 2 fingerprints per validation request. Incode automatically selects the best available fingerprints from the session before forwarding to INE.

**Selection priority:**

1. A matched pair (same finger position, both hands) is preferred over a single finger.
2. Pairs are evaluated in this order: Index (2/7) → Thumb (1/6) → Middle (3/8) → Ring (4/9) → Pinky (5/10).
3. If no matched pair is available, the highest-priority single finger is sent.
4. If no fingerprints are available, the request proceeds without fingerprint data.

**Example:** If the session contains fingers 2, 5, and 7 — the selector sends fingers 2 and 7 (right index + left index, highest-priority pair).

***

## Sample Request

Full example calling `/omni/process/government-validation` with fingerprints passed inline:

```bash
curl -X POST "https://<host>/omni/process/government-validation?interviewId=<interviewId>" \
  -H "Content-Type: application/json" \
  -H "X-Incode-Hardware-Id: <apiKey>" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "cic": "1234567890",
    "claveElector": "ABCDEF123456789012",
    "nombre": "JUAN",
    "apellidoPaterno": "GARCIA",
    "apellidoMaterno": "LOPEZ",
    "curp": "GALJ800101HDFRCN09",
    "anioRegistro": "2010",
    "anioEmision": "2020",
    "numeroEmisionCredencial": "01",
    "base64Image": "<base64-encoded face template>",
    "fingerprintsData": {
      "type": 2,
      "fingerprints": [
        {
          "index": 2,
          "base64Fingerprint": "<base64-encoded fingerprint image>",
          "fingerprintMetadata": {
            "device": "Suprema BioMini",
            "resolution": "500x500",
            "qualityScore": "92"
          }
        },
        {
          "index": 7,
          "base64Fingerprint": "<base64-encoded fingerprint image>",
          "fingerprintMetadata": {
            "device": "Suprema BioMini",
            "resolution": "500x500",
            "qualityScore": "88"
          }
        }
      ]
    }
  }'
```

### Sample Success Response

```json
{
  "governmentValidationStatus": "OK",
  "governmentRecognitionConfidence": 97.3,
  "governmentRecognitionConfidence2": 95.1,
  "governmentFingerprintConfidence": {
    "finger1": null,
    "finger2": 98.5,
    "finger3": null,
    "finger4": null,
    "finger5": null,
    "finger6": null,
    "finger7": 96.2,
    "finger8": null,
    "finger9": null,
    "finger10": null
  },
  "comparisonResults": {
    "nombre": true,
    "apellidoPaterno": true,
    "apellidoMaterno": true,
    "claveElector": true,
    "curp": true,
    "ocr": true,
    "anioRegistro": true,
    "anioEmision": true,
    "numeroEmisionCredencial": true
  },
  "registralSituation": {
    "tipoSituacionRegistral": "VIGENTE",
    "tipoReporteRoboExtravio": null
  }
}
```

`null` values for fingers not submitted are expected. INE only scores the fingers it received.

***

## Response Fields

### Fingerprint Confidence

`governmentFingerprintConfidence` contains per-finger similarity scores returned by INE. Scores range from 0–100. Only fingers included in the request will have non-null values.

Incode applies a pass/fail threshold to each finger's score internally before returning the result.

### Face Confidence

| Field                              | Description                |
| ---------------------------------- | -------------------------- |
| `governmentRecognitionConfidence`  | Primary face match score   |
| `governmentRecognitionConfidence2` | Secondary face match score |

### Comparison Results

INE validates whether the data on the ID card matches its records. Each field returns `true` or `false`.

| Field                     | What is validated          |
| ------------------------- | -------------------------- |
| `nombre`                  | First name                 |
| `apellidoPaterno`         | Paternal last name         |
| `apellidoMaterno`         | Maternal last name         |
| `claveElector`            | Voter key                  |
| `curp`                    | CURP                       |
| `ocr`                     | OCR data                   |
| `anioRegistro`            | Registration year          |
| `anioEmision`             | Issuance year              |
| `numeroEmisionCredencial` | Credential emission number |

### Registral Situation

INE returns the current status of the credential.

`tipoSituacionRegistral`**:**

| Value                  | Meaning                 |
| ---------------------- | ----------------------- |
| `VIGENTE`              | ID is current and valid |
| `NO_VIGENTE`           | ID is no longer valid   |
| `DATOS_NO_ENCONTRADOS` | No data found           |

`tipoReporteRoboExtravio`**:**

| Value                 | Meaning            |
| --------------------- | ------------------ |
| `null`                | No report on file  |
| `REPORTE_DE_EXTRAVIO` | ID reported lost   |
| `REPORTE_DE_ROBO`     | ID reported stolen |

***

## Status Codes

| Status Code  | Internal Status             | Meaning                          |
| ------------ | --------------------------- | -------------------------------- |
| `0`          | `OK`                        | Identity verified successfully   |
| `-1`         | `PROCESSING_INE`            | Result pending (async)           |
| `112`, `113` | `INE_SIGNATURE_ERROR`       | Signature validation error       |
| `204`        | `INE_CONNECTION_ERROR`      | Connection error to INE          |
| `205`        | `NOT_ENOUGH_DATA`           | Insufficient data provided       |
| `1403`       | `USER_NOT_FOUND_IN_INE_DB`  | Person not found in INE database |
| `1404`       | `INE_NOT_CURRENT`           | ID card is not current           |
| `1405`       | `INE_REPORTED_LOST`         | ID reported lost                 |
| `1406`       | `INE_REPORTED_STOLEN`       | ID reported stolen               |
| `1505`       | `INE_NOT_VALID`             | ID is not valid                  |
| `1506`       | `PROVIDER_UNAVAILABLE`      | INE provider is unavailable      |
| `1507`       | `MODULE_NOT_SUPPORTED`      | Module not supported             |
| `2336`       | `TRANSACTION_LIMIT_REACHED` | Rate limit exceeded              |

***

## Dashboard

When fingerprint validation is enabled, the Gov Verification section in the single session view displays:

- Fingerprint images for each finger submitted
- Which finger was captured (index 1–10)
- Individual confidence score per finger
- Pass/fail status per finger
- Overall verification result
- Device metadata
- Timestamp and INE response details

Only fingers that were actually submitted appear in the dashboard — all 10 slots are not shown by default.

***

## Flow / Workflow Configuration

Fingerprint validation behavior is configured per Flow or Workflow within the Government Record Verification module. The following fingerprint-specific options are available when Mexico is selected as a validation country:

- **Fingerprint Validation**: Enables fingerprint capture and biometric matching as part of the government identity verification flow.
- **Minimum Passing Fingerprints**: Sets the minimum number of fingerprints that must return a passing match score for the verification to succeed.
- **Fingerprint Match Override Score**: When enabled, a successful fingerprint match overrides a failed face or data comparison, and the verification is approved based on the fingerprint result alone.

***

## Key Constraints

| Constraint              | Detail                                                                                |
| ----------------------- | ------------------------------------------------------------------------------------- |
| Max fingers per session | 10 (one per index)                                                                    |
| Max fingers sent to INE | 2                                                                                     |
| Supported formats       | ANSI, WSQ, RAW — cannot mix formats in the same session                               |
| Session requirement     | Session must be active to add fingerprints                                            |
| Re-upload behavior      | Re-uploading the same `index` replaces the existing fingerprint                       |
| INE preference          | Matched pair (same finger, both hands) preferred over single                          |
| Inline vs. pre-stored   | Fingerprints passed inline in the validation request take precedence over stored ones |

<br />

---

- Path: `features-and-modules/instant-bav`
- URL: https://developer.incode.com/features-and-modules/instant-bav/
- Markdown: https://developer.incode.com/features-and-modules/instant-bav.md

# Instant BAV

The Instant BAV (Bank Account Verification) module validates a user's bank account information by checking key details such as name, address, account ID, and balance.

## Integrations

:white_check_mark: Web | :x: iOS | :x: Android


## How It Works

When Instant BAV is included in a Flow, the user is prompted to connect their bank account for verification. The module guides the user through an integrated bank account verification flow, typically provided by a third-party vendor, and retrieves key account details from the bank.

Once the bank account information is returned, the module validates it against expected identity and account attributes, such as name, address, account ID, and balance. The module then returns a verification result along with the underlying account attributes used in the check, depending on the integration and your organization's configuration.

## Use Instant BAV

For instructions on implementing and configuring Instant BAV on each supported platform, use the following pages:

- [Instant BAV (Dashboard)](/dashboard-platform-administration/instant-bav-dashboard/)

---

- Path: `features-and-modules/kyb-modules`
- URL: https://developer.incode.com/features-and-modules/kyb-modules/
- Markdown: https://developer.incode.com/features-and-modules/kyb-modules.md

# KYB
The Know Your Business (KYB) module verifies the identity and legitimacy of a business by matching the business details submitted for a session against government and commercial data sources.

:::note
This module is different than [eKYB](/features-and-modules/ekyb/).
:::

Rather than running one fixed verification, it offers the flexibility to select from the following checks and run only what a given use case needs:

- Identity
- Address
- Registration status
- Associated people
- Web presence
- Industry
- Financial risk
- Group structure

Incode routes the request to the data source that covers the selected country. This supports flexible, risk-based business verification, running and billing only the checks a decision actually requires.

## Integrations

✅ API | ✅ Web | Coming Soon: iOS, Android, React Native, Flutter

## How it works

The business details and the list of checks to run are submitted for the session.

**By default, this module:**

- Validates the submitted details against the requirements of the selected country and checks requested.
- Runs the requested checks the source supports, skipping any the source doesn’t.
- Returns the result of every check that finished, along with a `referenceId`. See the [KYB API Reference](/general-reference/kyb-api-reference).
- Sends one [`KYB_RESULTS` webhook](/general-reference/kyb-results-webhook/) once every check has finished.

**This module can also:**

- Select which checks to run per session, rather than always running a fixed set.
- Retrieve in-progress results later, by webhook or by polling with the `referenceId`.

Available checks may vary by country. See [KYB Coverage](/general-reference/kyb-coverage) for details.

## Use KYB

For instructions on implementing and configuring KYB Modules on each supported platform, use the following pages:

- [KYB (Dashboard)](/dashboard-platform-administration/kyb-modules-dashboard)

---

- Path: `features-and-modules/modules-overview-and-availability`
- URL: https://developer.incode.com/features-and-modules/modules-overview-and-availability/
- Markdown: https://developer.incode.com/features-and-modules/modules-overview-and-availability.md

# Modules Overview

Modules are the primary building blocks of Workflows and Flows. They allow you to collect selfies, documents, consent, or information from users. Each module is a part of the identity verification (IDV) process. In Workflows, some modules are considered Processes. Processes are prebuilt steps for validating data, identity checks, and fraud signals. Some modules have prerequisites that must be configured before they can be used. Refer to each module's documentation page for specific requirements.

You can configure modules as a part of Workflows or Flows directly in Dashboard or in the code of your SDK. We recommend using Dashboard for configuration, then calling to the Workflow/Flow ID from the SDK.

Depending on your organization's configuration, you may not see all possible modules. Contact your Incode representative if you have questions about the modules available in your organization.

The following tables can help you choose which modules to use. They are divided by category.

## Collect Identity Data

These modules gather raw inputs from users. No pass/fail determination is made; these modules receive and record.

| Module                                                                                               | Description                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Custom Fields](/features-and-modules/custom-fields/)                       | Allows you to capture additional user-provided data.                                                                                                                                           |
| [Document Capture](/features-and-modules/document-capture/)                 | Allows users to submit document images or files.                                                                                                                                               |
| [Email Input](/features-and-modules/email-input/)                           | Collects the user's email address.                                                                                                                                                             |
| [Face Capture](/features-and-modules/face-capture/)                         | Captures a photo of the user's face.                                                                                                                                                           |
| [Face Onboarding](/features-and-modules/face-onboarding/)                   | Onboards a user's face to establish a biometric record for future authentication.                                                                                                              |
| [Fiscal QR OCR](/features-and-modules/fiscal-qr-ocr/)                       | Scans and extracts data from the QR code printed on a Constancia de Situación Fiscal, the SAT tax document issued in Mexico.                                                                   |
| [Forms and Data Entry](/features-and-modules/forms-and-data-entry/)         | Presents a customizable form to collect data from the user.                                                                                                                                    |
| [Geolocation](/features-and-modules/geolocation-2/)                         | Captures the user's exact geographic location.                                                                                                                                                 |
| [ID Capture](/features-and-modules/id-capture/)                             | Captures an image of the user's government-issued ID.                                                                                                                                          |
| [NFC Scan](/features-and-modules/nfc/)                                      | Reads data from the [NFC](/get-started-with-incode/glossary#nfc-scan) chip embedded in compatible IDs.                                                                  |
| [Phone Number Input](/features-and-modules/phone-number-input/)             | Collects the user's phone number.                                                                                                                                                              |
| [Proof of Address Capture](/features-and-modules/proof-of-address-capture/) | Captures a document that verifies the user's residential address.                                                                                                                              |
| [Review OCR Data](/features-and-modules/review-ocr-data/)                   | Extracts text from a captured document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr) and presents it to the user for confirmation. |
| [Video Selfie](/features-and-modules/video-selfie/)                         | Captures a short video of the user capturing their ID and face.                                                                                                                                |

## Verify and Authenticate

These modules run checks against collected data to produce a pass/fail or match/no-match determination.

| Module                                                                                                           | Description                                                                                                                                                                                         |
| ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Antifraud Check](/features-and-modules/antifraud-check/)                               | Runs automated checks to detect fraudulent activity.                                                                                                                                                |
| [Claims Matching](/features-and-modules/claims-matching/)                               | Verifies an employee's identity by comparing data from their IDV session with trusted reference data from one or more connected directories.                                                        |
| [Cross Check](/features-and-modules/cross-check/)                                       | Compares a data field from one source against the same field from a second source and identifies whether the values match.                                                                          |
| [CURP Validation](/features-and-modules/curp-validation/)                               | Validates a Mexican CURP (Clave Única de Registro de Población) identifier.                                                                                                                         |
| [Custom Watchlist](/features-and-modules/custom-watchlist/)                             | Screens the user against a watchlist you define.                                                                                                                                                    |
| [eKYB (electronic Know Your Business)](/features-and-modules/ekyb/)                     | Electronically verifies a business's identity and legitimacy.                                                                                                                                       |
| [eKYC (electronic Know Your Customer)](/features-and-modules/ekyc/)                     | Electronically verifies a user's identity against authoritative data sources.                                                                                                                       |
| [Face Authentication](/features-and-modules/face-authentication/)                       | Authenticates a returning user by matching their face against a previously onboarded biometric record.                                                                                              |
| [Face Login](/features-and-modules/user_guide_face_login/)                              | Performs face authentication to allow users to log in without a password or token.                                                                                                                  |
| [Face Match](/features-and-modules/face-match/)                                         | Compares faces captured during the Face Capture and ID Capture modules to confirm they belong to the same person.                                                                                   |
| [Field Comparison](/features-and-modules/field-comparison-1/)                           | Matches information from two or more sources to validate consistency.                                                                                                                               |
| [Government Record Verification](/features-and-modules/government-record-verification/) | Verifies the user's identity against official government records.                                                                                                                                   |
| [ID Validation](/features-and-modules/id-validation-module/)                            | Determines whether a submitted ID is authentic.                                                                                                                                                     |
| [Instant BAV](/features-and-modules/instant-bav/)                                       | Verifies a user's bank account information and validates key details such as name, address, and account ID.                                                                                         |
| [Watchlist](/features-and-modules/watchlist/)                                           | Screens the user against standard watchlists.                                                                                                                                                       |
| [Watchlist Business](/features-and-modules/business-watchlist/)                         | Screens a business against standard watchlists.                                                                                                                                                     |
| [TrustGraph](/features-and-modules/trust-graph)                                   | Connects to a cross-organization fraud intelligence network that links isolated sessions into a connected graph to detect fraud patterns without sharing Personally Identifiable Information (PII). |



## Capture Signatures and Consent

These modules capture legally binding signatures and record user consent.

| Module                                                                                                           | Description                                                                                                            |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| [Advanced Electronic Signature](/features-and-modules/advanced-electronic-signature/)   | Captures a certificate-backed electronic signature that meets higher legal standards.                                  |
| [Certificate Issuance](/features-and-modules/certificate-issuance)                     | Issues a certificate upon successful completion of the verification process to support legal and compliance standards. |
| [Data Sharing Consent](/features-and-modules/combined-consent)                         | Collects the user's consent to collect and process their data.                                                         |
| [Electronic Signature](/features-and-modules/electronic-signature-module)              | Captures a standard electronic signature from the user.                                                                |
| [Qualified Electronic Signature](/features-and-modules/qualified-electronic-signature) | Captures an electronic signature that meets the highest legal standards, specifically under the EU eIDAS Regulation.   |

## Add Human-Assisted Verification

These modules introduce a live agent into the IDV process.

| Module                                                                               | Description                                                                                        |
| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
| [Video Conference](/features-and-modules/video-conference) | Connects the user with a live agent who conducts an identity verification interview through video. |

## Configure the User Experience

These modules shape the user experience of a Workflow or Flow, including routing decisions. They do not collect or verify data.

| Module                                                                                 | Description                                                                                                                                                                                  |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Custom Module](/features-and-modules/custom-module)         | Allows you to point the IDV session to your application to run custom logic and return a result.                                                                                             |
| [External Decision](/features-and-modules/external-decision) | Calls a configured external endpoint and exposes the returned decision value for routing [conditions](/dashboard-platform-administration/configure-workflow-conditions/). |

---

- Path: `features-and-modules/nfc`
- URL: https://developer.incode.com/features-and-modules/nfc/
- Markdown: https://developer.incode.com/features-and-modules/nfc.md

# NFC Scan

The NFC Scan module reads the secure [NFC](/get-started-with-incode/glossary/#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image. It reads the chip directly using the device's NFC hardware, providing a high-assurance data source that complements optical capture and OCR.

## Integrations

:x: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

NFC Scan works in conjunction with [Document Capture](/features-and-modules/document-capture/) and [OCR](/get-started-with-incode/glossary/#ocr). The user is prompted to hold the document near their device to begin an NFC session. The module uses details extracted from the document during OCR to establish a secure connection with the chip before reading its contents. Once authenticated, NFC Scan reads the chip's data groups and validates the document's authenticity using the embedded digital signature. The extracted chip data is returned for use in later verification steps, where it can be matched against other identity signals captured during the session.

## Use NFC Scan

For instructions on implementing and configuring NFC Scan on each supported platform, use the following pages:

- [NFC Scan (Dashboard)](/dashboard-platform-administration/nfc-scan-dashboard/)
- [NFC (iOS)](/sdk-reference/module-nfc-scan/)
- [NFC Scan (Android)](/sdk-reference/android-nfc-scan-2/)
- [NFC Scan (React Native)](/sdk-reference/react-native-modules/#nfcscan)
- [NFC Scan (Flutter)](/sdk-reference/flutter-modules/#nfcscan)
- [Add NFC (Cordova)](/sdk-reference/cordova-modules/#addnfc)

To view the end user experience screens and customization options for this module, see [NFC: Design and UX](/design-and-ux/nfc-design/).

---

- Path: `features-and-modules/phone-number-input`
- URL: https://developer.incode.com/features-and-modules/phone-number-input/
- Markdown: https://developer.incode.com/features-and-modules/phone-number-input.md

# Phone Number Input

The Phone Number Input module collects a user's phone number and can confirm phone ownership using either Silent Network Authentication (SNA) or an SMS one-time password (OTP). When SNA is enabled, it runs as the primary verification method, with SMS OTP as an automatic fallback when SNA is unavailable.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

The user is shown a phone number input field, optionally pre-populated with a default country prefix. The user enters their phone number and continues.

If SNA is enabled and supported for the user's carrier and device, verification happens silently in the background with no code entry required. If SNA is not enabled, or if it is unavailable for the user's carrier or device, the system sends an SMS code to the provided number and the user enters the code to confirm ownership.

On success, the module completes and returns the captured phone number (for example, +11234567890).

For a deeper explanation of how SNA works, its benefits, and its limitations, see Silent Network Authentication.

## Use Phone Number Input

For instructions on implementing and configuring Phone Number Input on each supported platform, use the following pages:

- [Phone Number Input (Dashboard)](/dashboard-platform-administration/phone-number-input-dashboard/)
- [Phone (iOS)](/sdk-reference/module-phone/)
- [Phone (Android)](/sdk-reference/android-phone/)
- [Phone Module (Web SDK)](/sdk-reference/web-sdk-2-module-phone/)
- [Phone (React Native)](/sdk-reference/react-native-modules/#phone)
- [Phone (Flutter)](/sdk-reference/flutter-modules/#phone)
- [Phone (Cordova)](/sdk-reference/cordova-modules/#phone)

To view the end user experience screens and customization options for this module, see [Phone Number Input: Design and UX](/design-and-ux/phone-number-input-design/).

---

- Path: `features-and-modules/proof-of-address-capture`
- URL: https://developer.incode.com/features-and-modules/proof-of-address-capture/
- Markdown: https://developer.incode.com/features-and-modules/proof-of-address-capture.md

# Proof of Address Capture

The Proof of Address Capture module captures a proof-of-address document, such as a utility bill, bank statement, or telecom agreement, as an image or PDF. It then extracts the address data through [OCR](/get-started-with-incode/glossary/#ocr) to validate the user's residential address. This module is optional by default but can be made mandatory through configuration.

## Integrations

:white_check_mark: iOS | :white_check_mark: Android | :white_check_mark: Web | :white_check_mark: Flutter | :white_check_mark: React Native | :white_check_mark: Cordova | :white_check_mark: Xamarin

## How It Works

The user is prompted to take or upload an image or PDF of a proof-of-address document. The document is then processed using OCR and machine learning to extract:

- Document type
- Full name
- Address (as a raw string and, where available, structured address components)
- Dates on the document

The extracted data is returned in the Session's OCR response. Incode extracts and structures the address data.  You can define pass/fail business logic, such as requiring a document dated within the last three months.

## Use Proof of Address Capture

For instructions on implementing and configuring Proof of Address Capture on each supported platform, use the following pages:

- [Proof of Address Capture (Dashboard)](/dashboard-platform-administration/proof-of-address-capture-dashboard/)

---

- Path: `features-and-modules/qualified-electronic-signature`
- URL: https://developer.incode.com/features-and-modules/qualified-electronic-signature/
- Markdown: https://developer.incode.com/features-and-modules/qualified-electronic-signature.md

# Qualified Electronic Signature

The Qualified Electronic Signature module shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

When the Qualified Electronic Signature module runs, the user is presented with the document or documents to be signed and guided through a consent and signing process. Qualified Electronic Signature is based on qualified certificates issued by a Qualified Trust Service Provider (QTSP) and uses PKI cryptography to cryptographically link the signature to the document, ensuring it cannot be altered without invalidation.

By default, this module:

- Displays the documents to be signed, each with a **View** link so the user can review them before proceeding.
- Presents required consent checkboxes covering the Trust Center terms and conditions, electronic signing authorization, and the legal binding nature of the signature.
- Keeps the **Finish signing** button disabled until all required consents are accepted.
- Issues a qualified certificate and applies the cryptographic signature upon submission.
- Displays a processing state during signature issuance, followed by a success confirmation when signing is complete.

The module can also be configured to:

- Restrict signing to a specific region. Country-specific Qualified Electronic Signature configurations are available. For more information, contact your Incode representative.
- Allow the user to upload a PDF document to sign.
- Allow the user to download the signed document after signing is complete.
- Use a one-time, short-term, or long-term certificate for the signature.
- Display the user's email address as part of the issued certificate.

## Use Qualified Electronic Signature

For instructions on implementing and configuring Qualified Electronic Signature on each supported platform, use the following pages:

- [Qualified Electronic Signature (Dashboard)](/dashboard-platform-administration/qualified-electronic-signature-dashboard-1/)
- [QES (iOS)](/sdk-reference/module-qes/)
- [QES (Android)](/sdk-reference/android-qes/)
- [Electronic Signature Module (Web SDK)—includes Qualified Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/)

To view the end user experience screens and customization options for this module, see [Qualified Signature: Design and UX](/design-and-ux/qualified-signature-design/).

---

- Path: `features-and-modules/review-ocr-data`
- URL: https://developer.incode.com/features-and-modules/review-ocr-data/
- Markdown: https://developer.incode.com/features-and-modules/review-ocr-data.md

# Review OCR Data

The Review OCR Data module extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr)​. It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields. It runs after [ID Capture](/features-and-modules/id-capture/).

## Integrations

:x: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

After the user completes ID Capture, Incode runs OCR on the captured document to extract its text fields. The Review OCR Data module then displays those fields to the user on a review screen.

By default, the module:

- Displays OCR-extracted fields from the identity document, including Full Name, Date of Birth, Gender, Document Number, Expiry Date, and Address.
- Allows the user to confirm the extracted data is correct before the session proceeds.

The module can also allow the user to edit and correct OCR-extracted values. This is useful when a field is missing or was misread. For example, when an address is not detected on the document, the user can enter it manually. Enabling this feature may require back-end enablement. Contact your Incode Representative for more information.

## Use Review OCR Data

For instructions on implementing and configuring Review OCR Data on each supported platform, use the following pages:

- [Review OCR Data (Dashboard)](/dashboard-platform-administration/review-ocr-data-dashboard/)
- [ID OCR (iOS)](/sdk-reference/module-id-info/)
- [ID Info (Android)](/sdk-reference/android-id-info/)
- [OCR Edit (React Native)](/sdk-reference/react-native-modules/#ocredit)
- [OCR Edit (Flutter)](/sdk-reference/flutter-modules/#ocredit)

---

- Path: `features-and-modules/risk-ai-agent`
- URL: https://developer.incode.com/features-and-modules/risk-ai-agent/
- Markdown: https://developer.incode.com/features-and-modules/risk-ai-agent.md

# Risk AI Agent Overview

Risk AI Agent is Incode's adaptive, machine-learning-based fraud decisioning system. Instead of applying fixed rules and weights to individual checks, it evaluates all available signals from a verification session in context. After weighing how each signal affects the others, it produces a single, more accurate pass/fail decision. It reduces the need for regular threshold tuning or custom rules.

Risk AI Agent replaces the legacy TotalScore model.

Risk AI Agent must be enabled for your organization. Contact your Incode representative to enable it.


***

## Session Decisioning

Risk AI Agent evaluates signals from across the verification session, including document validation, biometric checks, cross-field consistency, session timing, device risk, and more. It produces a fraud probability score between 0 and 1. Sessions scoring above the threshold fail; sessions scoring below pass.

![Diagram showing how Risk AI Agent processes multiple signal types to produce a context-aware session decision.](https://developer.incode.com/assets/7724e431f58763a33ed647e0d1bbb39a.png)

<br />

<Accordion title="View a text description of the diagram">
  The diagram shows Risk AI Agent's decision architecture. Input signals flow from right to left into a central Autopilot AI Agent. This agent undergoes continuous retraining and outputs a context-aware session decision.

The agent draws on two primary input categories:

- **OCR & data cross-check**: Optical character recognition and data validation signals
- **Biometric matching**: Comparison of biometric data across the session

These branch into more granular signals, including:

- **Liveness**: Sub-signals for **Client ID**, **Face features**, and **Behavior and device signals**
- **Document features**: Document-level signals feeding into the same decision pipeline

Additional signal inputs are indicated but not individually labeled.
</Accordion>

### Decisioning Logic

Risk AI Agent does not operate in isolation. A session fails if any of the following are true, regardless of the Risk AI Agent score:

- Trust Graph fails
- Deepsight scores below 0.5
- Government Validation scores below 0.81

If Risk AI Agent does not run, the session falls back to TotalScore. When Risk AI Agent is active, the `total_score` field in the score API response returns a pass/fail value instead of a numeric score.

***

## Signal Inputs

The model ingests confidence scores, not pass/fail statuses, from most checks, including:

- ID validation
- Tamper and alteration detection
- Fake document detection
- Paper and screen liveness
- Face recognition
- OCR

It also incorporates session timing signals, device risk indicators, the client ID, and the document type.

Because Risk AI Agent uses underlying confidence scores rather than check statuses, severity settings on most checks have little effect on its output. The exceptions are liveness (physical, digital, and evasion) and face recognition. For these, Risk AI Agent uses both status and confidence thresholds, so severity settings on those checks can influence outcomes.

\*\*Required dependency: [ID Validation](/features-and-modules/id-validation-module/) (`processID`) must be included in the Flow or Workflow for Risk AI Agent to function. Liveness and face recognition are not required but improve accuracy.

***

## Explainability

Risk AI Agent is a gradient-boosting decision tree model and cannot produce a rule-based explanation of its output. Instead:

- For sessions that fail, it surfaces the top 3 contributing signals that drove the decision: for example, document alteration and face recognition.
- For sessions that pass, it surfaces signals that support legitimacy.

A narrative risk assessment summary is also available in the `responseText` field of the API response.

***

## Rules Engine Compatibility

Rules that override the final session decision (for example, forcing a fail when a specific check fails) continue to work alongside Risk AI Agent. Rules that send sessions to Manual Review also continue to work.

Rules that modify module weights or scores do not affect Risk AI Agent, because the model uses the original confidence scores as inputs.

***

## Supported Regions

Risk AI Agent is available for Mexico, the United States, and Colombia. Sessions from other countries fall back to TotalScore.

---

- Path: `features-and-modules/silent-network-authentication-sna`
- URL: https://developer.incode.com/features-and-modules/silent-network-authentication-sna/
- Markdown: https://developer.incode.com/features-and-modules/silent-network-authentication-sna.md

# Silent Network Authentication

Silent Network Authentication (SNA) is a carrier-based phone verification method that confirms a user's possession of a mobile number directly through the mobile network, without sending an SMS or requiring the user to enter a code.

SNA is available as a verification method within the [Phone Number Input](/features-and-modules/phone-number-input/) module. It is currently only available for Flows. When enabled, SNA runs as the primary verification method, with SMS OTP as an automatic fallback when SNA is unavailable.

This feature must be enabled for your organization before use. Contact your Incode representative if you are interested in this feature.&#x20;

## How It Works

SNA verifies that the device associated with the provided phone number is active and connected to the mobile network. This validation happens through secure interactions with mobile network operators, establishing a proof of possession tied to the SIM.

The following sequence diagram shows how SNA runs within a verification flow, including coverage checks, carrier validation, and fallback to SMS OTP when required.

![SNA Sequence Diagram](https://developer.incode.com/assets/64e6ff45d42c82b880d2a3dda6aff7b8.png)

## Benefits

SNA improves the phone verification experience across three dimensions:

- Low-friction user experience: Users only need to enter their phone number. Verification happens in the background without OTP retrieval or manual input, which reduces user effort and improves completion rates.
- Reliable verification: Removing the dependency on SMS delivery avoids common issues such as message delays, delivery failures, and repeated OTP requests.
- Improved security: Carrier-level validation reduces exposure to SMS-based threats such as phishing, OTP interception, and SIM swap attacks.

## Considerations

- Requires mobile network connectivity: SNA relies on communication with the mobile carrier network and will not work if the device has no mobile data connectivity.
- Fallback is required for full coverage: When SNA is not supported due to device, carrier, or connectivity constraints, the flow automatically falls back to SMS OTP to complete verification.

## SNA and Identity Verification

SNA provides a real-time signal that a user controls the phone number they are claiming, by validating the association between the device and SIM through the mobile network. On its own, SNA answers foundational questions about phone ownership and device linkage. Combined with other Incode signals such as biometrics, document verification, and device intelligence, it contributes to a more complete view of the user.

This supports stronger identity decisions by helping answer questions such as:

- Does the user control this phone number?
- Is this number actively linked to the device being used?
- Has this phone or device been reused across multiple accounts?
- Is this identity linked to known or previously detected fraud?
- Is this identity part of a suspicious network of users or devices?

These insights are powered by Incode's ability to connect signals across sessions and workflows, supporting detection of repeat fraud, account sharing, and coordinated activity.

For deeper network-level insights and relationship-based risk analysis, SNA can be combined with Trust Graph. Contact your Incode representative for more information.

## Implementation

SNA implementation is platform-specific. See the SDK reference for your platform:

- [Phone Number Input (Dashboard)](/dashboard-platform-administration/phone-number-input-dashboard/)
- [Phone Number Input (iOS)](/sdk-reference/module-phone/)
- [Phone Number Input (Android)](/sdk-reference/android-phone/)

<br />

---

- Path: `features-and-modules/trust-graph`
- URL: https://developer.incode.com/features-and-modules/trust-graph/
- Markdown: https://developer.incode.com/features-and-modules/trust-graph.md

# TrustGraph

[TrustGraph](/features-and-modules/trust-graph-overview) is Incode's privacy-preserving trust network. It runs alongside your identity verification stack and returns real-time signals when a session's attributes have shown up before in ways worth flagging, in your own history or across the network.

## Integrations

TrustGraph runs server-side on every session in a flow that has it enabled. There is no SDK integration on the client. [Add the module](/dashboard-platform-administration/trust-graph-module-configuration) in the Flow or Workflow Builder.

## How It Works

TrustGraph runs five categories in parallel on each session, independently and per your flow configuration:

- **Suspected Repeat Fraudster**: matches against identities, devices, and documents previously labelled fraudulent
- **First-Party Fraud**: catches abuse reported by an institution about users who are who they claim to be but act in bad faith
- **Unusual Activity**: surfaces inconsistencies across sessions, like one document appearing with several faces
- **Velocity**: flags the same attribute onboarding abnormally often within a configured time window
- **Fraud Rings**: evaluates the session against discovered fraud clusters in real time

Each enabled category returns its own status and [reason codes](/general-reference/trust-graph-reason-codes). The overall TrustGraph status is `OK` or `FAIL`; it is `FAIL` if at least one enabled category is `AT_RISK`. In the [single Session view](/dashboard-platform-administration/single-session-view#trust-graph), this surfaces as PASS or RISK. TrustGraph returns signals, not decisions: you decide whether a signal fails a session, routes it to manual review, or follows another path.

## Use TrustGraph

For instructions on configuring and using TrustGraph, use the following pages:

- [TrustGraph module configuration](/dashboard-platform-administration/trust-graph-module-configuration)
- [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer)
- [Single Session View, TrustGraph tab](/dashboard-platform-administration/single-session-view#trust-graph)

---

- Path: `features-and-modules/trust-graph-overview`
- URL: https://developer.incode.com/features-and-modules/trust-graph-overview/
- Markdown: https://developer.incode.com/features-and-modules/trust-graph-overview.md

# TrustGraph

TrustGraph is Incode's privacy-preserving trust network for helping institutions detect repeat fraud and giving them real-time signals to boost conversion. It is a layered set of categories, each analyzing a different fraud vector, and it runs in real time during session execution.

TrustGraph sits on top of your per-session identity stack to add context that a single session can never see on its own. Document authenticity, liveness, face match, and government validation checks answer whether a single session looks genuine; TrustGraph answers a different question: have these data attributes shown up before, in your own history or across the network, in a way you should worry about?

## How it works

Steps 1 through 3 happen automatically and in real time whenever TrustGraph is enabled on a flow. Step 4 is the investigation and feedback loop that compounds the product's value over time.

**Step 1: Verify.** A user completes an identity verification in your Incode-powered flow: onboarding, authentication, or any other journey.

**Step 2: Query the network.** Incode normalizes and de-identifies the relevant identifiers (for example face, face on ID, device hash, document number, personal number, voter number) and checks them against TrustGraph, for the categories you enabled on that flow and with the thresholds you configured.

**Step 3: Return signals.** TrustGraph returns a per-category signal, an overall status, and an explainable list of reason codes describing what matched and why, delivered inside the standard score response. You can add rules for decisioning as needed.

**Step 4: Review, investigate, and contribute.** Your team reviews sessions and investigates connected sessions in [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer). When you confirm a fraud outcome, you can report it back. That signal protects every other TrustGraph participant and sharpens the signals you receive in return.

:::note
A defining property of the network: no participant ever learns which institution contributed a signal, or even whether its own data matched a given query. You receive a status and an explainable breakdown, never another institution's records.
:::

## Categories

Each category has its own signals, fraud vectors, and reason codes. For every category, you use the [TrustGraph module configuration](/dashboard-platform-administration/trust-graph-module-configuration) to determine which checks are run and the thresholds to use. Your Incode team will work with you to help optimize the configurations. Refer to [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer) to learn how these configurations show in the ring exploration and investigation workflow.

<Component slug="trustgraph-detection-categories" />

For the full list of reason codes emitted by each category, see [TrustGraph reason codes](/general-reference/trust-graph-reason-codes).

## Result structure

TrustGraph returns signals, not decisions or numbers to threshold. Each enabled category returns `OK`, `AT_RISK`, or `NOT_EXECUTED`, along with an explainable list of matches and reason codes. The overall TrustGraph status is `OK` or `FAIL`; `FAIL` if at least one enabled category is `AT_RISK`.

Incode does not decision on your behalf: you decide whether a signal fails a session, routes it to manual review, or follows another path. Branch on the matches and reason codes rather than the status alone, and treat both statuses and reason codes as an open set that can grow over time.


## Reading TrustGraph in your integration

TrustGraph fires automatically on every session in a flow that has it enabled. No SDK or client code changes are required to start receiving signals.

Two reads cover almost every integration:

- For the summary signals, read `trustGraph.riskResults.overall.status` and the per-category statuses in `reasonCategoryScores` from the score response.
- For the detailed explanation, call the TrustGraph result endpoint and read the `matches` on each category. Every match carries a `reason` (why it fired) and a `checkType` (the attribute that matched). Those two fields are what you route queues on and what you show an analyst.

The same results are visible without writing any code in the Dashboard single Session view. Open the session and go to the [TrustGraph tab](/dashboard-platform-administration/single-session-view/#trust-graph) to see these details.

To verify TrustGraph is active on a flow, run one session and inspect the response:

```bash
curl --silent --location \
  --url 'https://demo-api.incodesmile.com/omni/get/score?id=INTERVIEW_ID' \
  --header 'api-version: 1.0' \
  --header 'api-key: API_KEY' \
  --header 'Content-Type: application/json' \
  --header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
  | jq '.trustGraph.riskResults.reasonCategoryScores'
```

An enabled category returns `OK` or `AT_RISK`. A disabled category returns `NOT_EXECUTED`. On a clean test session, a healthy integration returns `OK` for the categories you enabled and `NOT_EXECUTED` for the rest. If every category comes back `NOT_EXECUTED`, TrustGraph is not active on the flow: confirm both that the tenant is provisioned and in scope, and that the TrustGraph module is attached to the flow the session ran through.

:::warning
Handle unknown values gracefully. Treat statuses and reason codes as an open set: new values are added over time. Branch on the values you know and default anything unrecognized to review rather than assuming a fixed enum.
:::

## Decisioning with rules

:::note
The rule patterns below describe the Rules Engine, which applies to Flows. If you're using Workflows, [configure a Condition](/dashboard-platform-administration/trust-graph-module-configuration/#add-conditions) after the TrustGraph module in your Workflow to act on signals instead. The patterns and the fields you branch on are the same; only the surface differs.
:::

By default, TrustGraph signals do not affect the session decision. They are surfaced as an independent set of signals so you can watch them before they affect outcomes. You make them impact decisions by adding rules, which can act on the overall TrustGraph signal, on any individual category, or on both.

The three patterns below are illustrative shapes, not a literal rule syntax. Express them in your own rules configuration.

**Single-field.** The simplest possible adoption: one condition on the overall status.

```
IF trustGraph.riskResults.overall.status = FAIL
THEN route the session to manual review
```

**Per-category routing.** Different categories mean different things, so send them to different places.

```
IF SUSPECTED_REPEAT_FRAUDSTER = AT_RISK  THEN hard block
IF FIRST_PARTY_FRAUD          = AT_RISK  THEN route to the investigations queue
IF UNUSUAL_ACTIVITY           = AT_RISK  THEN route to manual review
IF VELOCITY_CHECKS            = AT_RISK  THEN route to the velocity review queue
```

**Composite decisioning.** Combine the TrustGraph signal with what the per-session checks already told you.

```
IF SUSPECTED_REPEAT_FRAUDSTER = AT_RISK
   AND a per-session check (liveness, document authenticity, government
       validation) already failed
THEN fail the session

IF SUSPECTED_REPEAT_FRAUDSTER = AT_RISK
   AND every per-session check passed
THEN route to manual review with the TrustGraph matches attached
```

In all three, the final decision stays on the session's top-level status. TrustGraph complements the per-session checks; it never replaces them and it never decides on your behalf.

:::tip
TrustGraph returns a signal status, not a numeric score, so there are no thresholds to hard-code in your backend. Thresholds live in the configuration your Incode team applies, and your rules branch on the resulting statuses.
:::

## Deployment scopes

TrustGraph runs in one of two deployment scopes, set per tenant. The scope determines two things at once: what your institution contributes, and what your checks can search against. Both scopes include the same categories, but in the Local scope TrustGraph can only tell you about fraud you have already seen, while in the Global scope it draws on the whole network. Global is recommended by default to leverage the full product value; region-specific exclusions may apply, as advised by your Incode team.

**Reciprocity.** The network is strongest when participation is mutual. The more accurate fraud you contribute to the Global scope, the more precise the signals you get back.

| Scope | What you contribute | What your checks search |
| --- | --- | --- |
| **Local** | Everything you store stays scoped to your own organization family. | Only data belonging to your own organization family. |
| **Global** | Your data contributes to the network through the privacy-preserving query layer, with zero knowledge sharing. | Network-contributed signals **plus** your own organization family's data. |

## Privacy

Fraud operations do not stop at one company's boundary, but privacy and regulatory constraints have historically blocked institutions from comparing notes: pooling customer data is never an option. TrustGraph's privacy architecture is what removes that blocker.

TrustGraph lets institutions jointly validate identity signals without sharing any private data with each other or with Incode. The Global layer is a privacy-preserving query layer, implemented with proprietary Secure Multi-Party Computation (SMPC). It is explicitly not a centralized data store and does not pool records.

**How a query executes:**

- **Normalize locally.** The local node standardizes identifiers (capitalization, whitespace, phone and postal formats) so they are comparable across institutions.
- **De-identify.** Hashing and truncation strip PII before any value leaves the local node.
- **Build fresh cryptographic material per request.** The same identifier produces a different on-the-wire query every time, so no observer, including Incode, can correlate queries. Routing across participating nodes also mitigates scraping and brute force.
- **Compute jointly on shares.** Each node runs SMPC against its own data, operating only on cryptographic shares. No participant sees another's inputs in plaintext, hashed, or encrypted form, and nodes return contributions without learning the outcome of their own participation.
- **Return an aggregate signal.** The aggregation layer combines contributions and applies scoring without ever seeing raw or hashed user data. You get a status and an explainable breakdown: no records, no per-source detail. Transient query data is destroyed when the session ends and the cryptographic material is not reusable.

## Data handling

TrustGraph is a component of the Incode platform and follows the same platform machinery and the retention policy you configure. Whatever policy you set applies to TrustGraph too: there is no separate or divergent retention schedule. Deletion requests submitted on platform propagate across data stores, including those used by TrustGraph.

## Control layers

Every layer of control is yours. Some layers you set yourself in Dashboard, while tenant-level layers are set by your Incode team based on what you decide.

| Layer | You decide | Governs |
| --- | --- | --- |
| **Tenant enablement and scope** | Whether TrustGraph runs at all, and whether your tenant is **Local** or **Global**. Your Incode team applies it. | Whether any category can run, which insights your checks reach, which sub-features are available. |
| **Named configuration** | Which categories your team can toggle in Flow Builder, which granular checks run inside each category, and the thresholds and time windows they use. | Your definition of risk: for example, how many times one device may appear across identities before it counts as a signal. |
| **Flow Builder** | Which categories run in which user journey, and which named configuration applies. | Per-flow behavior. |
| **Decisioning rules** | Whether a TrustGraph signal affects the session outcome at all, and how. | Fail, manual review, queue routing, or observe-only, per category or on the overall status. |

## Get started

1. **Incode provisions your tenant and scope.** TrustGraph is opt-in at the tenant level and no category runs until it is provisioned. Your Incode team applies it and can help calibrate velocity windows and thresholds in your configuration.
2. **Add the TrustGraph module to a flow.** In the [Flow](/dashboard-platform-administration/flows-1) or [Workflow](/dashboard-platform-administration/workflows-20/) Builder, [add the TrustGraph module](/dashboard-platform-administration/trust-graph-module-configuration) and toggle categories per flow. TrustGraph then fires automatically on every session in that flow: no change to your code or user-journey integration is required to start receiving signals.
3. **Run and observe.** By default, TrustGraph does not alter session decisioning: statuses appear on every session with zero decision impact. Run a representative period and evaluate decisioning strategy.
4. **Enforce with rules and close the loop.** Add rules on the overall TrustGraph status and/or per category, route queues on the returned reason codes, and turn on **Report Fraud**.

## Related pages

- [TrustGraph module overview](/features-and-modules/trust-graph): Module summary with platform availability and links to per-SDK configuration.
- [TrustGraph module configuration](/dashboard-platform-administration/trust-graph-module-configuration): How to add TrustGraph to a Flow or Workflow, and the settings available in the module configuration panel.
- [TrustGraph reason codes](/general-reference/trust-graph-reason-codes): Full list of reason codes emitted by each category, with meanings.
- [Fraud Ring Explorer](/dashboard-platform-administration/trust-graph-fraud-ring-explorer): The Dashboard investigation surface for fraud rings discovered in your history.
- [Single Session View, TrustGraph tab](/dashboard-platform-administration/single-session-view/#trust-graph): Reading TrustGraph results for an individual session in Dashboard.

---

- Path: `features-and-modules/user_guide_face_login`
- URL: https://developer.incode.com/features-and-modules/user_guide_face_login/
- Markdown: https://developer.incode.com/features-and-modules/user_guide_face_login.md

# Face Login (iOS)

The Face Login module performs face authentication to allow users to log in without a password or token.

## Supported Platforms

- iOS

## How It Works

Face Login uses biometric face scanning to authenticate users without passwords or tokens. When a user initiates a login, the SDK captures a selfie and runs liveness detection to confirm the person is physically present and not a spoofed image or recording.

There are two authentication modes:

- **1:N (Identify)**: The captured face is compared against your entire database of approved users. The system finds the closest match and returns that user's identity. If multiple similar faces are detected, the system performs step-up authentication, prompting the user to confirm their identity with an additional code. Use this mode when you do not know in advance who is trying to log in.
- **1:1 (Verify)**: The captured face is compared against a single, pre-specified user identified by their [customer UUID](/get-started-with-incode/glossary/#customer-uuid). The system returns a pass or fail for that specific person only. Use this mode when the user has already been identified by another means and you only need to confirm they are physically present.

In both modes, if liveness detection fails, the result is flagged as a spoof attempt rather than a failed face match, allowing your application to handle the two cases differently.

## Prerequisites

- The user must have completed a full Incode onboarding flow and be an approved customer.

## Integrate Face Login Module

### Initialize the IncdOnboarding SDK

Add the following line of code to your `AppDelegate` class:

```
IncdOnboardingManager.shared.initIncdOnboarding(url: url, apiKey: apiKey)
```

Incode provides `url` and `apiKey`. If you are running the app on a simulator, set the `testMode` parameter to `true`.

### Execute 1:N Face Login: Identify a User

Call `startFaceLogin` without a `customerUUID` to match against your full user database:

```swift
IncdOnboardingManager.shared.presentingViewController = self
IncdOnboardingManager.shared.startFaceLogin() { result in
          guard let loginResult = result.faceLoginResult else {
            // An error occurred
            print(result.error)
            return
          }
          
          if loginResult.success == true {
            // Face authentication successful
            let customerUUID = loginResult.customerUUID
            let token = loginResult.token
            let interviewId = loginResult.interviewId
          } else {
            if result.spoofAttempt == true {
              // Liveness check  failed
            } else {
              // No matching face found in database
            }
          }
        }
```

### Execute 1:1 Face Login: Verify a Specific User

Call `startFaceLogin` with the `customerUUID` of the user you want to verify:

```swift
IncdOnboardingManager.shared.presentingViewController = self
IncdOnboardingManager.shared.startFaceLogin(customerUUID: "YOUR_CUSTOMER_ID") { result in
          guard let loginResult = result.faceLoginResult else {
            // An error occurred
            print(result.error)
            return
          }
          
          if loginResult.success == true {
            // Face authentication successful
            let customerUUID = loginResult.customerUUID
            let token = loginResult.token
            let interviewId = loginResult.interviewId
          } else {
            if result.spoofAttempt == true {
              // Liveness check failed
            } else {
              // User's face did not match
            }
          }
        }
```

### View Face Login Result

The callback returns a `SelfieScanResult` object with the following fields:

- `faceLoginResult`: A `FaceLoginResult` object that contains:
  - `success`: `true` if face login was successful; `false` if it was not.
  - `customerUUID`: The customer UUID of the matched user; `nil` if no match was found.
  - `token`: The customer token of the matched user; `nil` if no match was found.
  - `interviewId`: The session [interviewId](/get-started-with-incode/glossary/#interviewid) from the user's original approval flow.
  - `interviewToken`: The session [interviewToken](/get-started-with-incode/glossary/#session-token) used during user approval.
  - `transactionId`: The transaction ID of the face login attempt.
- `spoofAttempt`: `true` if the attempt was flagged as a spoof; `false` if it was not.
- `image`: The selfie image captured during the scan.
- `error`: A `SelfieScanError` describing any error that occurred.

### Specify Login Parameters

By default, Face Login performs liveness detection and face matching on the server. For faster authentication and reduced network dependency, switch to on-device processing using the `faceAuthMode` parameter:

- To use on-device liveness detection with server-side face matching, specify `FaceAuthMode.hybrid` via the `faceAuthMode` param of the `startFaceLogin` method:
  ```swift
  IncdOnboardingManager.shared.presentingViewController = self
  IncdOnboardingManager.shared.startFaceLogin(faceAuthMode: .hybrid) { result in
            ...
          }
  ```
- To use on-device liveness detection and on-device face matching, specify `FaceAuthMode.local` via the `faceAuthMode` param of the `startFaceLogin` method:
  ```swift
  IncdOnboardingManager.shared.presentingViewController = self
  IncdOnboardingManager.shared.startFaceLogin(faceAuthMode: .local) { result in
            ...
          }
  ```

<Callout icon="📘" theme="info">
  ### Note

  `FaceAuthMode.hybrid` and `FaceAuthMode.local` require specific Onboarding SDK frameworks with FaceAuth models included. If using CocoaPods, specify the `l` variant: for example, `5.51.0-d-l`.
</Callout>

The following additional parameters are available on `startFaceLogin`:

| Parameter                  | Type    | Default | Description                                                                                                                                                       |
| -------------------------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `showTutorials`            | Boolean | `true`  | Shows a tutorial screen before the selfie scan.                                                                                                                   |
| `faceAuthModeFallback`     | Boolean |         | When `true`, falls back to `FaceAuthMode.server` if `FaceAuthMode.local` cannot run due to a missing face template on the device. Applies to 1:1 Face Login only. |
| `lensesCheck`              | Boolean | `true`  | Detects whether the user is wearing lenses during the selfie scan. Set to `false` to disable.                                                                     |
| `faceMaskCheck`            | Boolean | `false` | Detects whether the user is wearing a face mask during capture. Set to `true` to enable.                                                                          |
| `logAuthenticationEnabled` | Boolean | `true`  | Sends liveness statistics after each login attempt. Set to `false` to disable.                                                                                    |
| `customLogo`               | Image   |         | A custom logo to display during face capture. Uses the default Incode logo if not specified.                                                                      |

### Manage Locally Stored Identities

To authenticate multiple users using 1:N mode with `FaceAuhtMode.local`, you must populate a local database of user identities on the device. You can use the following methods to manage that database.

**Add a Face**

To add a single identity to the local database, use the `addFace` method and provide a `FaceInfo` object that contains the following fields:

| Field          | Type   | Description                                                                                    |
| -------------- | ------ | ---------------------------------------------------------------------------------------------- |
| `faceTemplate` | String | The biometric representation of the user's face.                                               |
| `customerUUID` | String | The user's unique customer identifier in Incode's database.                                    |
| `templateId`   | String | The unique identifier of the biometric representation of the user's face in Incode's database. |

```swift
let face = FaceInfo(faceTemplate: template,
                    customerUUID: uuid,
                    templateId: templateId)
IncdOnboardingManager.shared.addFace(face)
```

**Remove a Face**

To remove a single identity from the local database, use the `removeFace` method and provide a `customerUUID`:

```swift
IncdOnboardingManager.shared.removeFace(customerUUID: customerUUID)
```

**Get Faces**

To fetch all identities currently stored in the local database, use the `getFaces` method:

```swift
  var identities: [FaceInfo] = IncdOnboardingManager.shared.getFaces()
```

**Set Multiple Faces**

To replace the entire local database with a new list of identities, use the `setFaces` method and provide a list of `FaceInfo` objects:

```swift
IncdOnboardingManager.shared.setFaces(faceInfoList)
```

<Callout icon="⚠️" theme="warn">
  ### Warning

  This method deletes all existing entries before the new list is written.
</Callout>

**Clear the Face Database**

To remove all identities from the local database, use the `setFaces` method and provide an empty list of `FaceInfo `objects:

```
IncdOnboardingManager.shared.setFaces([])
```

<br />

---

- Path: `features-and-modules/video-conference`
- URL: https://developer.incode.com/features-and-modules/video-conference/
- Markdown: https://developer.incode.com/features-and-modules/video-conference.md

# Video Conference

The Video Conference module connects the user with a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements. The agent may be an Incode representative or an agent in your organization.

Video Conference is designed for regulated markets and high-assurance scenarios where automated verification alone is insufficient. Incode's video conference design complies with the regulatory requirements issued by the Comisión Nacional Bancaria y de Valores (CNBV).

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Video Conference is triggered after the end user completes prior modules in the session, typically ID Capture and Face Capture. When the module runs, the user is placed in a waiting queue until an available agent accepts the call.

When the Video Conference module runs, the user is prompted to connect to a live call at the Conference step. A representative logs into the conference portal and answers the incoming call. Once the call is established, the representative interviews the user and conducts any verifications required by the Session configuration. The session result is recorded and tied to the user's onboarding session.

The module can also be configured to require a One-Time Password (OTP) before the user connects to the call. When Conference OTP is enabled, the user must enter a code to confirm their identity before the live session begins.

Video Conference uses OpenTok (Vonage) as its underlying video streaming technology.

### Agent Setup

Before your agents can use Video Conference with end users, the following setup is required:

- A Flow or Workflow with the Video Conference module enabled
- An executive user (agent) account added to the conference portal
- The conference portal URL provisioned and shared with the relevant team alongside the standard Dashboard URL

## Use Video Conference

For instructions on implementing and configuring Video Conference on each supported platform, use the following pages:

- [Video Conference (Dashboard)](/dashboard-platform-administration/video-conference-dashboard/)
- [Video Conference (iOS)](/sdk-reference/module-conference/)
- [Conference (Assisted Video) (Android)](/sdk-reference/android-conference-assisted-video/)
- [Conference (React Native)](/sdk-reference/react-native-modules/#conference)

---

- Path: `features-and-modules/video-selfie`
- URL: https://developer.incode.com/features-and-modules/video-selfie/
- Markdown: https://developer.incode.com/features-and-modules/video-selfie.md

# Video Selfie

The Video Selfie module records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent. It is commonly used by financial institutions to meet regulatory requirements for remote identity verification. The module digitally replicates what a branch manager would do in person.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Video Selfie is a multi-check verification step, not simply a video recording. It depends on the ID Capture and Face Capture modules being completed earlier in the session. Those modules provide the reference data for all the comparisons Video Selfie performs.

During Video Selfie, the user records a short video in which they are guided to show their face. Depending on configuration, they may also be guided to show their identity document and provide spoken consent. The recording is then processed against the following checks:

**Checks that contribute to the Video Selfie score:**

| Check              | What it does                                                                                                                                                                      |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Speech Recognition | Transcribes the user's spoken consent and validates it against the expected statement. Only runs when **_Voice Consent_** is enabled.                                             |
| Face Recognition   | Compares the selfie captured during Video Selfie against the selfie from the prior Face Capture module step. You can configure sensitivity using **_Face Recognition Severity_**. |
| Liveness           | Confirms the user is physically present, not a photo or spoof, in real time during recording.                                                                                     |

**Informational checks (do not affect score by default):**

| Check                          | What it does                                                                                                                                                      |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Face Match                     | Compares the ID photo from ID Capture against the ID shown during Video Selfie.                                                                                   |
| Type of ID Match               | Confirms the same document type is used throughout the session.                                                                                                   |
| OCR Match                      | Compares the full name extracted from the ID shown in Video Selfie against the original [OCR](/get-started-with-incode/glossary/#ocr) data. |
| Back ID Type Match             | Performs the same document-type check for the back of the ID.                                                                                                     |
| Back ID OCR Match              | Compares back-of-ID data against original OCR data.                                                                                                               |
| Voice Consent Face Recognition | Validates that the person giving voice consent matches the prior selfie. Only runs when the Voice Consent setting is enabled.                                     |
| Hat Check                      | Detects whether the person is wearing a hat or other head covering during the selfie.                                                                             |
| Lenses Check                   | Detects whether the person is wearing glasses or sunglasses during the selfie.                                                                                    |
| Mask Check                     | Detects whether the person’s face is covered by a mask during the selfie                                                                                          |
| Closed Eyes Check              | Detects whether the person’s eyes are closed during the selfie.                                                                                                   |

The Video Selfie score is the average of the three scoring checks above. Custom decisions based on any check can be configured to affect either the Video Selfie score or the total session score.

Captured video is uploaded asynchronously after recording. The Incode Platform checks for the file every 20 seconds, up to a configurable maximum window. The default window is 4 minutes. You can configure a webhook to notify your system when processing is complete.

## Use Video Selfie

For instructions on configuring your Flow or Workflow to use Video Selfie and then implementing it in your supported integration, use the following pages:

- [Video Selfie (Dashboard)](/dashboard-platform-administration/video-selfie-dashboard/)
- [Video Selfie (iOS)](/sdk-reference/module-video-selfie/)
- [Video Selfie (Android)](/sdk-reference/android-video-selfie/)
- [Video Selfie Module (Web SDK)](/sdk-reference/web-sdk-2-module-video-selfie/)
- [Video Selfie (React Native)](/sdk-reference/react-native-modules/#videoselfie)
- [Video Selfie (Flutter)](/sdk-reference/flutter-modules/#videoselfie)
- [Video Selfie (Cordova)](/sdk-reference/cordova-modules/#addvideoselfie)

---

- Path: `features-and-modules/watchlist`
- URL: https://developer.incode.com/features-and-modules/watchlist/
- Markdown: https://developer.incode.com/features-and-modules/watchlist.md

# Watchlist

The Watchlist module screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources.

## Integrations

:white_check_mark: Web | :white_check_mark: iOS | :white_check_mark: Android

## How It Works

Watchlist is a processing module, so it runs after user data has been collected earlier in the session. It needs a name and date of birth to perform a search, and it can source these from either the [Forms and Data Entry](/features-and-modules/forms-and-data-entry/) module (using the predefined questions "What is your name?" and "What is your date of birth?") or from an [ID Capture](/features-and-modules/id-capture/) module followed by [ID Validation](/features-and-modules/id-validation-module/). If both sources are present, data collected through Forms takes priority over data extracted from the ID.

When the module runs, it submits the collected name and date of birth to the configured watchlist sources and returns the results. Watchlist matches on first name and last name only; middle names are not processed. The search can be scoped in several ways:

- Narrowed by the customer's birth year, to reduce false positives on common names.
- Filtered by one or more countries of operation, so results are limited to entities tied to those countries by nationality or residence. Country filtering does not apply to entities on sanction lists, entities with adverse media mentions only, or entities with no country assigned. These always appear regardless of the country filter.
- Restricted to specific watchlist categories (such as sanctions, PEP classes, fitness-probity, or FATF-aligned adverse media categories), or to a defined search profile. Watchlist categories and search profile are mutually exclusive; only configure one or the other.
- Tuned for match strictness using a fuzziness value, where lower values require closer matches to the supplied name and higher values allow looser matching.

The module can also subscribe to ongoing updates for a search. When subscribed, Incode sends a notification to a configured webhook whenever the underlying watchlist data for that search changes, so downstream systems can retrieve the updated result. For setup instructions, see [Global Watchlist Webhook](/general-reference/global-watchlists-webhook/).

## Use Watchlist

For instructions on implementing and configuring ID Capture on each supported platform, use the following pages:

- [Watchlist (Dashboard)](/dashboard-platform-administration/watchlist-dashboard/)
- [Global Watchlist (iOS)](/sdk-reference/module-global-watchlist/)
- [Global Watchlist (Android)](/sdk-reference/android-global-watchlist/)
- [Watchlist Module (Web SDK)](/sdk-reference/web-sdk-2-module-watchlist/)
- [Global Watchlist (React Native)](/sdk-reference/react-native-modules/#globalwatchlist)
- [Global Watchlist (Flutter)](/sdk-reference/flutter-modules/#globalwatchlist)

To view the end user experience screens and customization options for this module, see [Watchlist and Custom Watchlist: Design and UX](/design-and-ux/watchlist-design/).

---

- Path: `general-reference/accessibility`
- URL: https://developer.incode.com/general-reference/accessibility/
- Markdown: https://developer.incode.com/general-reference/accessibility.md

# Accessibility Manifest

Incode is committed to delivering products that adhere to recognized accessibility standards and practices, including [WCAG](https://www.w3.org/TR/WCAG22/) (globally), [ADA](https://www.access-board.gov/ada/) in the US, and [EEA](https://sorry.ec.europa.eu/) in Europe.

## WCAG Criteria

The Web Content Accessibility Guidelines (WCAG) outline criteria for designers and developers to enhance accessibility for individuals with general disability, like hearing, listening, or visual (from minor to severe levels).

It groups compliance into three levels: Level A, Level AA, and Level AAA.

Level A stands for the most fundamental level of accessibility, and Level AAA stands for the highest level of accessibility possible. It is strongly recommended that businesses adhere to the standards set out by at least the AA rating.

## Our Accessibility Audits

We are continually improving our product with newest accessibility standards.

### Latest Audit

Incode conducts WCAG accessibility audits at least once per year.

- January 2026: Incode products are partially compliant with **WCAG 2.2**
  - Covered Native (Android & iOS), as well as Web
  - Covered Dashboard
- January 2025: Incode products are partially compliant with **WCAG 2.2**
  - Covered Native (Android & iOS), as well as Web
  - Covered Dashboard
- December 2024: Incode products are partially compliant with **WCAG 2.2**
  - Covered Web

The table below indicates the WCAG 2.2 Level AA compliance for each Incode offering.

| Incode Offering  | Partial compliance | Full compliance |
| :--------------- | :----------------- | :-------------- |
| Web SDK          | X                  |                 |
| Android SDK      | X                  |                 |
| iOS SDK          | X                  |                 |
| React Native SDK | X                  |                 |
| Dashboard        | X                  |                 |

Partial compliance indicates that certain aspects of the content may not fully meet accessibility standards. Efforts are underway to ensure that all our products achieve full compliance with WCAG 2.2 level AA standards.

### Methodology

For our evaluation, we used the WCAG Evaluation Method (WCAG-EM), a common procedure for auditing website accessibility. It uses the following steps:

1. Define the scope of the evaluation, including the WCAG conformance level (A, AA or AAA), technologies used, and baseline required
2. Explore the target product
3. Select a representative sample
4. Evaluate the sample
5. Report findings
   1. We have evaluated all 50 Level A and Level AA success criteria from version 2.2 of the Web Content\Accessibility Guidelines.

### Accessibility support

The audited website should work in at least the following browsers and assistive technologies:

- Microsoft Edge (last 3 versions)
- Mozilla Firefox (last 3 versions)
- Google Chrome (last 3 versions)
- Apple Safari (last 3 versions)
- Apple Safari on iOS
- Common assistive technologies

### Technologies used

The audited web page relies on the following technologies:

- HTML
- CSS
- JavaScript
- WAI-ARIA
- SVG
- NonVisual Desktop Access (NVDA)
- JAWS
- ANDI / WAVE / WebAIM / IBM Scanner

### Commonly Asked Questions from Customers

How often does Incode conduct a full audit for WCAG compliance?

- Annually, at a minimum.

Who performs the WCAG audits?

- Our annual audits are performed by external certified accessibility specialists, or CPWAs.

Do you have a VPAT?

- Yes. A VPAT can be provided upon request.

Is your WCAG testing automated or manual?

- Automated tools can only detect about 30-40% of WCAG issues. We perform both automated and manual testing to identify the full spectrum of results.

If an accessibility issue is identified, what is the process and typical turn-around time for remediation?

- Incode works to proactively implement WCAG improvements into our platform through many channels - design, QA, and development. If an accessibility issue is identified after a release, we strive to remediate any critical and moderate findings within 90 days.

<br />

---

- Path: `general-reference/api-error-codes`
- URL: https://developer.incode.com/general-reference/api-error-codes/
- Markdown: https://developer.incode.com/general-reference/api-error-codes.md

# API Error Codes






The Incode Omni API uses standard HTTP status codes to indicate whether a request succeeded or failed. For certain errors, the response body also contains an Incode-specific status code that provides more precise information about what went wrong.

This page covers API error codes. [SDK error handling](/general-reference/sdk-error-handling/) and Dashboard error messages are documented separately.

:::note
SDK error handling documentation is coming soon. In the meantime, refer to the error handling section in each platform's integration guide.
:::

***

## Error Response Format

All error responses from the Omni API return a JSON object with the following structure:

```json
{
  "timestamp": 1722948860110,
  "status": 4004,
  "error": "Bad Request",
  "message": "Could not find user",
  "path": "/omni/add/front-id/v2"
}
```

| Field       | Type    | Description                                                          |
| ----------- | ------- | -------------------------------------------------------------------- |
| `timestamp` | integer | UTC timestamp of the error, in milliseconds                          |
| `status`    | integer | HTTP status code, or an Incode custom error code for `400` responses |
| `error`     | string  | HTTP status text (e.g., `"Bad Request"`, `"Forbidden"`)              |
| `message`   | string  | Human-readable description of the error                              |
| `path`      | string  | The endpoint path that returned the error                            |
| `details`   | object  | Additional error context, when present                               |

:::info
When an Incode custom error code is returned, the `status` field in the response body will contain the custom code (e.g., `4004`) rather than the HTTP status code. The HTTP status of the response itself will still be `400`.
:::

***

## HTTP Status Codes

The following standard HTTP status codes are used across the Omni API.


| Code  | Name                  | Description                                                                                                                                                         |
| ----- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `200` | OK                    | The request succeeded.                                                                                                                                              |
| `400` | Bad Request           | The request was invalid. This may be due to missing or malformed parameters, or an Incode-specific condition described by a custom error code in the response body. |
| `403` | Forbidden             | The request is not permitted. This can occur when a feature is disabled for your organization (for example, score retrieval).                                       |
| `429` | Too Many Requests     | The request was rate-limited. A cooldown period must complete before retrying. This applies to OTP send operations.                                                 |
| `500` | Internal Server Error | An unexpected error occurred on Incode's servers.                                                                                                                   |
| `504` | Gateway Timeout       | The request exceeded the allowed time limit. This can occur during external validation operations such as CURP validation.                                          |

***

## Incode Custom Error Codes

When a request fails with a `400` response, the `status` field in the response body may contain an Incode-specific error code. These codes provide more precise information than the HTTP status alone.

Custom error codes are grouped below by functional area.

### Session Initialization

These errors are returned by `POST /omni/start` when a session cannot be created due to configuration or parameter issues.

| Code   | Message                                           | Description                                                                                         |
| ------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `4026` | Invalid uuid parameter                            | The `uuid` parameter provided is not valid.                                                         |
| `4027` | Invalid configurationId                           | The `configurationId` does not correspond to a valid configuration.                                 |
| `4028` | Flow is not activated                             | The specified Flow or Workflow has not been activated. Activate it in the Dashboard before use.     |
| `4081` | Invalid parameters for validation                 | One or more parameters failed validation on session start.                                          |
| `4082` | Start endpoint version forbidden in flow/workflow | The version of the `/omni/start` endpoint used is not permitted by the configured Flow or Workflow. |

### User and Identity

These errors indicate that a required user record could not be found or that a conflict exists with existing user data.

| Code   | Message                              | Returned by                                                                               |
| ------ | ------------------------------------ | ----------------------------------------------------------------------------------------- |
| `4004` | Could not find user                  | `POST /omni/external/send-sms`, `POST /omni/add/front-id/v2`, `POST /omni/add/back-id/v2` |
| `4006` | User with given phone already exists | `POST /omni/process/approve`                                                              |

### Face and Selfie Processing

These errors are returned when a face or selfie image cannot be processed successfully. They are most commonly returned by ID upload and face capture endpoints.

| Code   | Message                                      | Description                                                                                                   |
| ------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `1003` | Face cropping failure                        | A face was detected in the image but could not be cropped successfully.                                       |
| `4010` | More than one face detected                  | The image contains multiple faces. Only a single face is expected.                                            |
| `4019` | Face not found                               | No face was detected in the submitted image.                                                                  |
| `4077` | Selfie image has low quality                 | The selfie image does not meet minimum quality requirements.                                                  |
| `4078` | Selfie face is occluded or partially covered | The face in the selfie is obscured. Prompt the user to remove obstructions (glasses, masks, hands) and retry. |

**Affected endpoints:** `POST /omni/add/front-id/v2`, `POST /omni/add/front-second-id/v2`, `POST /omni/add/face/third-party`

### Image Quality


These errors indicate that a submitted image does not meet technical requirements.

| Code   | Message                | Description                                            |
| ------ | ---------------------- | ------------------------------------------------------ |
| `5003` | Unsatisfied image size | The image does not meet the minimum size requirements. |

**Affected endpoints:** `POST /omni/add/back-id/v2`

### B2B Integration

These errors are specific to B2B onboarding flows (`POST /omni/b2b/onboarding/request-new`).

| Code   | Message                                  | Description                                                                 |
| ------ | ---------------------------------------- | --------------------------------------------------------------------------- |
| `4300` | Integration not found by id              | The integration ID provided does not match a known integration.             |
| `4301` | Employee by login factor cannot be found | An employee record matching the provided login factor could not be located. |

### OTP and Contact Verification


These errors are returned by `GET /omni/send/otp`.

| HTTP Code | Message                       | Description                                                                                                   |
| --------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `400`     | Contact Already Verified      | The phone number or email address is already verified for this session.                                       |
| `429`     | Cooldown period not completed | An OTP was recently sent to this contact. Wait for the cooldown period to expire before requesting a new one. |

### Government Validation (Mexico)

These errors apply to Mexican tax ID and identity validation endpoints.

| HTTP Code | Endpoint                  | Description                                                  |
| --------- | ------------------------- | ------------------------------------------------------------ |
| `400`     | `POST /api/validate/rfc`  | Invalid RFC format.                                          |
| `400`     | `POST /api/calculate/rfc` | Invalid input data provided for RFC calculation.             |
| `500`     | `POST /api/validate/rfc`  | Internal server error during RFC validation.                 |
| `500`     | `POST /api/calculate/rfc` | Internal server error during RFC calculation.                |
| `500`     | CURP validation endpoints | Internal error during CURP validation.                       |
| `504`     | CURP validation endpoints | The CURP validation request exceeded the allowed time limit. |

### Score Retrieval

| HTTP Code | Endpoint              | Description                                                                                                                   |
| --------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `403`     | `GET /omni/get/score` | Score retrieval is disabled for this organization for session users. Contact your Incode account team to enable this feature. |

***

## Known Gaps

The API specification documents custom error codes for a subset of endpoints. Many endpoints that return `400 Bad Request` do not currently have custom error codes defined in the API spec. If you encounter a `400` response without a custom code from an endpoint not listed above, the `message` field in the response body is the best available source of information about the specific failure.

:::note
This reference will be updated as custom error codes are confirmed for additional endpoints. If you encounter an undocumented error code, contact Incode Support or your customer success manager.
:::

***

## Handling Errors

A few general practices for handling Omni API errors:

- **For&#x20;**`400`**&#x20;errors:** Check the `status` field in the response body first. If it contains a value from the custom error code tables above, use that to determine the specific failure. If `status` is `400`, fall back to the `message` field.
- **For&#x20;**`429`**&#x20;errors:** Implement a retry with a backoff delay. Do not retry immediately — the response indicates a cooldown period is required.
- **For&#x20;**`500`**&#x20;and&#x20;**`504`**&#x20;errors:** These indicate a server-side or timeout condition. Retry with exponential backoff. If errors persist, check the [Incode Status Page](/dashboard-platform-administration/check-system-status/) for any ongoing incidents.
- **For&#x20;**`403`**&#x20;errors:** These are typically configuration issues, not transient failures. Retrying will not resolve them — contact your Incode account team.

---

- Path: `general-reference/aus-kyb-prefill`
- URL: https://developer.incode.com/general-reference/aus-kyb-prefill/
- Markdown: https://developer.incode.com/general-reference/aus-kyb-prefill.md

# Australia

eKYB Prefill in Australia leverages Australia's source of truth to automatically retrieve and populate business information based on a company's registration number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Australia | `AU_KYB_PREFILL` | Returns matching Australian business details from Australia's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `AU_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `AU`. |
| `taxId` | Mandatory | String. ACN or ABN. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered or trading business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

Australia uses two business identifier formats. Input must be numeric only — no other lengths or formats are accepted. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| ACN (Australian Company Number) | 9 numeric digits (e.g. `000014675`) |
| ABN (Australian Business Number) | 11 numeric digits (e.g. `88000014675`) |

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "AU_KYB_PREFILL",
    "country": "AU",
    "taxId": "51 824 753 556",
    "businessName": "ACME GROUP LIMITED",
    "address": "123 Example Street, Sydney NSW 2000, Australia"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted.

```json
{
    "kyb-prefill": [
        {
            "tin": "51824753556",
            "vatNo": "51824753556",
            "name": "ACME GROUP LIMITED",
            "nameMatch": "Verified",
            "address": "123 Example Street, Sydney NSW 2000, Australia",
            "addressMatch": "Verified",
            "city": "Sydney",
            "postalCode": "2000",
            "entityType": "Australian Public Company",
            "registrationStatus": "Active",
            "registrationDate": "1998-03-15",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industry": "Retail Trade",
            "industryDesc": "Supermarket, grocery, and general retail trade operations",
            "turnover": { "currency": "AUD", "value": 69346000000 },
            "otherAddresses": [
                {
                    "type": "Principal Place of Business",
                    "otherAddress": "456 Sample Avenue, Melbourne VIC 3000, Australia"
                }
            ],
            "directors": [
                { "name": "John Sample Smith", "positionName": "Director" },
                { "name": "Jane Example Doe", "positionName": "Director" }
            ],
            "otherNames": [
                { "name": "ACME Retail", "businessNameType": "Main Trading Name" },
                { "name": "ACME Supermarkets", "businessNameType": "Main Trading Name" }
            ],
            "activityDesc": "Supermarket and Grocery Stores"
        }
    ]
}
```

:::info
Some fields — `shareholders`, `employeeCount`, `ultimateParent`, and `immediateParent` — are not always present in the response. They are only returned when the source of truth has the underlying data (for example, `ultimateParent`/`immediateParent` are omitted when the entity is not itself a subsidiary of another company, and `shareholders`/`employeeCount` may be unavailable depending on the entity's filing history). This is expected and does not indicate an error.
:::

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | Registration number | The tax ID submitted in the request (ACN), as returned and confirmed by the source of truth. |
| `vatNo` | Registration number | The ABN associated with the business, as returned by the source of truth. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address. |
| `postalCode` | Postal code | The postal code associated with the registered business address. |
| `entityType` | Entity type | The legal entity type of the business (e.g. Australian Public Company). |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. See [Registration status values](#registration-status-values). |
| `registrationDate` | Date | The date the business was registered. |
| `creditRating` | Rating value (e.g. A, C) | The business's credit rating, as returned from the source of truth. |
| `creditRatingDescription` | Description (e.g. Very Low Risk, Moderate Risk) | Human-readable description of the credit rating. |
| `industry` | Industry sector | The primary industry sector associated with the business. |
| `industryDesc` | Industry description | Description of the business's main activity. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be present for all companies (e.g. smaller/private entities with no filed financials). |
| `otherAddresses` | Array of `{type, otherAddress}` | Addresses associated with the business other than the main registered address, if any. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information, if available. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. |
| `otherNames` | Array of `{name, businessNameType}` | Other registered or trading names associated with the business, if available. |
| `activityDesc` | Activity description | Description of the business's classified activity. |
| `employeeCount` | Number | Latest reported number of employees, if available. |
| `ultimateParent` | `{name, country, registrationNumber}` | The business's ultimate parent company, if the business is a subsidiary. |
| `immediateParent` | `{name, country, registrationNumber}` | The business's immediate parent company, if the business is a subsidiary. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The business is currently registered and active. |
| Expired | The business registration has lapsed. |
| Unknown | The registration status could not be determined. |
| Not Found | The business is inactive or could not be found in the source of truth. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Australia Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or not 9 or 11 numeric digits:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid ACN (9 digits) or ABN (11 digits), numeric only",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```







## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/austria`
- URL: https://developer.incode.com/general-reference/austria/
- Markdown: https://developer.incode.com/general-reference/austria.md

# Austria

eKYB Prefill in Austria leverages Austria's source of truth to automatically retrieve and populate business information based on a company's FN number or VAT number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Austria | `AT_KYB_PREFILL` | Returns matching Austrian business details from Austria's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `AT_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `AT`. |
| `taxId` | Mandatory | String. FN number or VAT number. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

Austria supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| FN (Firmenbuchnummer) | `FN` + a space + digits + a check letter (e.g. `FN 109608P`) |
| VAT number | `AT` + `U` + 8 digits (e.g. `ATU25486907`) |



### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "AT_KYB_PREFILL",
    "country": "AT",
    "taxId": "FN 109608P",
    "businessName": "",
    "address": ""
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted. Field availability varies significantly by company — see the notes under each example below.

**Example 1 — large, established company (with parent)**

```json
{
    "kyb-prefill": [
        {
            "tin": "FN 109608p",
            "vatNo": "ATU25486907",
            "name": "Sample Shoes Austria GmbH",
            "nameMatch": "Verified",
            "address": "Sample Straße 2, 9560 Sampletown",
            "city": "Sampletown",
            "postalCode": "9560",
            "entityType": "limited liability company",
            "registrationStatus": "Active",
            "registrationDate": "1969-08-13T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Wholesale of footwear",
            "activityDesc": "WHOLESALE AND RETAIL TRADE",
            "turnover": { "currency": "EUR", "value": 56160000 },
            "employeeCount": "81",
            "leiNumber": "5299000000000000AB12",
            "websites": ["https://www.sampleshoes.example"],
            "shareholders": [
                { "name": "Sample Shoes GmbH", "percentSharesHeld": 100 }
            ],
            "ultimateParent": { "name": "SAMPLE SHOES HOLDING", "country": "DE" },
            "immediateParent": { "name": "SAMPLE SHOES HOLDING", "country": "DE" },
            "otherNames": [
                { "name": "Sample Shoes GmbH", "businessNameType": "Previous Name" },
                { "name": "Sample-Schuhfabriken Gesellschaft m.b.H.", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```

**Example 2 — small, single-owner company**

```json
{
    "kyb-prefill": [
        {
            "tin": "FN 292309t",
            "vatNo": "ATU63372512",
            "name": "Sample Planning GmbH",
            "nameMatch": "Verified",
            "address": "Sample Weg B8, 7093 Sample Village",
            "city": "Sample Village",
            "postalCode": "7093",
            "entityType": "limited liability company",
            "registrationStatus": "Active",
            "registrationDate": "2007-04-28T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Other renting and operating of own or leased real estate",
            "activityDesc": "REAL ESTATE ACTIVITIES",
            "employeeCount": "1",
            "shareholders": [
                { "name": "Sample Owner Name", "percentSharesHeld": 100 }
            ],
            "otherNames": [
                { "name": "Sample Architect Studio GmbH", "businessNameType": "Previous Name" },
                { "name": "Sample Planning GmbH (old)", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```



**Example 3 — large holding-type entity (cross-border parent)**

```json
{
    "kyb-prefill": [
        {
            "tin": "FN 364103x",
            "name": "Sample Glass Trading GmbH",
            "nameMatch": "Verified",
            "address": "Sample Platz 7, 1010 Sample City",
            "city": "Sample City",
            "postalCode": "1010",
            "entityType": "limited liability company",
            "registrationStatus": "Active",
            "registrationDate": "2011-06-17T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Wholesale of china and glassware and cleaning materials",
            "activityDesc": "WHOLESALE AND RETAIL TRADE",
            "employeeCount": "0",
            "leiNumber": "5299000000000000CD34",
            "shareholders": [
                { "name": "Sample Green Energy GmbH", "percentSharesHeld": 100 }
            ],
            "ultimateParent": { "name": "SAMPLE GLASS HOLDING GMBH", "country": "LI" },
            "immediateParent": { "name": "SAMPLE GLASS HOLDING GMBH", "country": "LI" },
            "otherNames": [
                { "name": "Sample-East Glass Trading GmbH", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```



:::info
Field availability differs significantly by company, regardless of size. `vatNo`, `turnover`, `leiNumber`, `ultimateParent`/`immediateParent`, and `websites` may all be absent even for large, established companies — this is expected and does not indicate an error.
:::

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | FN number | Firmenbuchnummer, as returned from the source of truth. |
| `vatNo` | VAT number | May not be present, even for large companies. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. |
| `postalCode` | Postal code | The postal code associated with the registered business address, when available. |
| `entityType` | Entity type | The legal entity type of the business (e.g. limited liability company). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. |
| `creditRating` | Rating value (e.g. A, C) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Very Low Risk) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | A specific description of the business's main activity (e.g. "Wholesale of footwear"). |
| `activityDesc` | Activity description | A broader category describing the business's principal activity (e.g. "WHOLESALE AND RETAIL TRADE"). Genuinely distinct from `industryDesc` for Austria. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be present. |
| `employeeCount` | Number (as string) | Latest reported number of employees. May not be present, or may be `"0"` for pure holding entities. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information. May be an individual person or a corporate entity. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. May not be present. |
| `ultimateParent` | `{name, country}` | The business's ultimate parent company, if the business is a subsidiary. May not be present. |
| `immediateParent` | `{name, country}` | The business's immediate parent company, if the business is a subsidiary. May not be present. |
| `leiNumber` | LEI | Legal Entity Identifier, if available. May not be present for smaller companies. |
| `otherNames` | Array of `{name, businessNameType}` | Former legal names of the business, with `businessNameType` set to `"Previous Name"`. |
| `websites` | Array of strings | Websites associated with the business, if available. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Austria Prefill returns the following country-specific 400 errors.

`taxId` is not a valid FN number (`FN` + digits + check letter) or VAT number (`AT` + `U` + 8 digits):

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Austrian FN number or VAT number",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/authorizing-webhooks-requests`
- URL: https://developer.incode.com/general-reference/authorizing-webhooks-requests/
- Markdown: https://developer.incode.com/general-reference/authorizing-webhooks-requests.md

# Authorizing Webhook Requests with OAuth 2.0

If your system uses OAuth 2.0 for authentication and authorization, you can ensure that every webhook request to your Incode system is authenticated. You can define these three authentication parameters:

* `authentication URL`
* `client_id`
* `client_secret`

To define these parameters, go to`Dashboard > Configuration > General`.

# Request Authentication Flow

When you configure authentication for webhook requests, Incode exchanges the `client_id` and `client_secret` for an access token. This token is then used to send future notifications.

This image shows a sample request issued to the authentication URL you configure in the Incode Dashboard.

```curl cURL
curl --location '<configured authentication url>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <base64(client_id:client_secret)>' \
--data 'grant_type=client_credentials'
```

The following image shows an expected response example, which is a JSON body with two fields: `access token`, and `expires_in`:

```json json
{
  "access_token": "", //String, mandatory. Access token to be usend when sending notifications.
  "expires_in": 0000000000 //Number, mandatory. Access token expiration time in seconds.
}
```

---

- Path: `general-reference/belgium`
- URL: https://developer.incode.com/general-reference/belgium/
- Markdown: https://developer.incode.com/general-reference/belgium.md

# Belgium

eKYB Prefill in Belgium leverages Belgium's source of truth to automatically retrieve and populate business information based on a company's BCE/KBO number or VAT number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Belgium | `BE_KYB_PREFILL` | Returns matching Belgian business details from Belgium's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `BE_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `BE`. |
| `taxId` | Mandatory | String. BCE/KBO number or VAT number. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

Belgium supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| BCE/KBO number | 9 numeric digits, no prefix (e.g. `656908546`) |
| VAT number | `BE0` + the same 9-digit BCE number (e.g. `BE0656908546`) |



### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "BE_KYB_PREFILL",
    "country": "BE",
    "taxId": "656908546",
    "businessName": "",
    "address": ""
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted. Field availability varies significantly by company — see the notes under each example below.

**Example 1 — purchasing cooperative (large turnover, small headcount)**

```json
{
    "kyb-prefill": [
        {
            "tin": "123456789",
            "vatNo": "BE0123456789",
            "name": "SAMPLE TRADING CV",
            "nameMatch": "Verified",
            "address": "Sample Straat 10, 1040 Sample City",
            "city": "Sample City",
            "postalCode": "1040",
            "entityType": "Cooperative company",
            "registrationStatus": "ACTIVE",
            "registrationDate": "2016-06-22T00:00:00Z",
            "creditRating": "B",
            "creditRatingDescription": "Low Risk",
            "industryDesc": "Activities of business and employers membership organisations",
            "turnover": { "currency": "EUR", "value": 13390642077 },
            "employeeCount": "39",
            "shareholders": [
                { "name": "SAMPLE HOLDING SA", "percentSharesHeld": 32.67 }
            ],
            "directors": [
                { "name": "SAMPLE DIRECTOR NAME", "positionName": "Director" }
            ],
            "otherAddresses": [
                { "otherAddress": "Sample Straat 10 1040 Sample City" }
            ],
            "otherNames": [
                { "name": "SAMPLE TRADING", "businessNameType": "Trading Name" }
            ]
        }
    ]
}
```

**Example 2 — multinational subsidiary (cross-border parent)**

```json
{
    "kyb-prefill": [
        {
            "tin": "987654321",
            "vatNo": "BE0987654321",
            "name": "SAMPLE CHOCOLATE BELGIUM SA",
            "nameMatch": "Verified",
            "address": "Sample Dreve 13, 7700 Sample Town",
            "city": "Sample Town",
            "postalCode": "7700",
            "entityType": "Public limited company",
            "registrationStatus": "ACTIVE",
            "registrationDate": "1997-09-24T00:00:00Z",
            "industryDesc": "Wholesale of sugar, chocolate and sugar confectionery",
            "turnover": { "currency": "EUR", "value": 48835433 },
            "employeeCount": "270",
            "websites": ["http://www.samplechocolate.example"],
            "shareholders": [
                { "name": "SAMPLE HOLDING FRANCE SAS", "percentSharesHeld": 100 }
            ],
            "ultimateParent": { "name": "SAMPLE NETHERLANDS HOLDING B.V.", "country": "NL" },
            "immediateParent": { "name": "SAMPLE NETHERLANDS HOLDING B.V.", "country": "NL" },
            "otherAddresses": [
                { "otherAddress": "Sample Dreve(L) 13 7700 Sample Town" },
                { "otherAddress": "Sample Lei 37 2018 Sample City" }
            ],
            "otherNames": [
                { "name": "SAMPLE CHOCOLATE BELGIUM NV", "businessNameType": "Trading Name" }
            ]
        }
    ]
}
```

**Example 3 — small boutique with a distinct trading name**

```json
{
    "kyb-prefill": [
        {
            "tin": "456789123",
            "vatNo": "BE0456789123",
            "name": "SAMPLE BOUTIQUE BVBA",
            "nameMatch": "Verified",
            "address": "Sample Walletje 20 C, 8300 Sample Coast",
            "city": "Sample Coast",
            "postalCode": "8300",
            "entityType": "Private limited liability company",
            "registrationStatus": "ACTIVE",
            "registrationDate": "2010-07-30T00:00:00Z",
            "industryDesc": "Tour operator activities",
            "otherNames": [
                { "name": "SAMPLE LUXURY BRAND BOUTIQUE", "businessNameType": "Trading Name" }
            ]
        }
    ]
}
```



:::info
Field availability differs significantly by company. `turnover`, `employeeCount`, `shareholders`, `directors`, `websites`, `otherAddresses`, and `creditRating` may all be absent for a given company — this is expected and does not indicate an error. `ultimateParent`/`immediateParent` are absent for companies that sit at the top of their own group.
:::

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | BCE/KBO number | 9-digit registration number, as returned from the source of truth. |
| `vatNo` | VAT number | `BE0` + the 9-digit BCE number. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. |
| `postalCode` | Postal code | The postal code associated with the registered business address, when available. |
| `entityType` | Entity type | The legal entity type of the business (e.g. Cooperative company, Public limited company). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. |
| `creditRating` | Rating value (e.g. A, B) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Low Risk) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | Description of the business's main activity. May not reflect the company's actual current business activity in all cases. |
| `activityDesc` | Activity description | Description of the business's principal activity. Same data-quirk caveat as `industryDesc`. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be present. |
| `employeeCount` | Number (as string) | Latest reported number of employees, if available. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information. May not be present, or may only reflect a partial capitalization table for large companies. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. |
| `ultimateParent` | `{name, country}` | The business's ultimate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |
| `immediateParent` | `{name, country}` | The business's immediate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |
| `otherNames` | Array of `{name, businessNameType}` | The business's trading name, with `businessNameType` set to `"Trading Name"`. Usually identical to `name`, but can genuinely differ. |
| `otherAddresses` | Array of `{otherAddress}` | Addresses associated with the business other than the main registered address, if any. May not be present for smaller companies. |
| `websites` | Array of strings | Websites associated with the business, if available. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Belgium Prefill returns the following country-specific 400 errors.

`taxId` is not a valid BCE/KBO number (bare 9 digits) or VAT number (`BE0` + 9 digits):

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Belgian BCE/KBO number or VAT number",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/colombia`
- URL: https://developer.incode.com/general-reference/colombia/
- Markdown: https://developer.incode.com/general-reference/colombia.md

# Colombia
Colombia eKYC verification matches submitted individual data against Colombia's civil register as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                    | API source string     | Description                                                     |
| --------------------------- | ------------------------ | ---------------------------------------------------------------- |
| Colombia Civil Register 1  | `CO_CIVIL_REGISTER_1`    | Verifies submitted data against Colombia's civil register.        |

## Colombia Civil Register 1

### Request parameters

| Parameter     | Required  | Description                                                                                          |
| ------------- | --------- | ---------------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `CO_CIVIL_REGISTER_1`.                                                                         |
| `country`     | Mandatory | Must be `CO`.                                                                                          |
| `idNum`       | Mandatory | Colombian Cédula de Ciudadanía. 8 to 10 numeric digits.                                                |
| `firstName`   | Mandatory | First name of the individual.                                                                          |
| `middleName`  | Optional  | Middle name of the individual.                                                                         |
| `surName`     | Mandatory | Last name of the individual.                                                                           |
| `issueDate`   | Mandatory | Format: `yyyy-mm-dd`. Date the Cédula de Ciudadanía was issued.                                        |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                                                  |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                                                         |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "CO_CIVIL_REGISTER_1", //required field
    "firstName": "Lukas", //required field
    "middleName": "Johannes",
    "surName": "Müller", //required field
    "idNum": "1234567890", //required field
    "dateOfBirth": "1991-08-02",
    "issueDate": "1991-08-02", //required field
    "gender": "m",
    "country": "CO" //required field
}
```

### Response fields

Colombia Civil Register 1 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field              | Statuses                              | Description                                                                       |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.            |
| `middleNameMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.           |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.             |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.             |
| `idNumMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches Cédula de Ciudadanía submitted against the value in the source of truth.  |
| `issueDateMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches ID issue date submitted against the value in the source of truth.         |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.         |
| `genderMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                |
| `overallLevel`     | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                              |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and Cédula de Ciudadanía:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` or `idNumMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "issueDateMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/colombia-payload-guide`
- URL: https://developer.incode.com/general-reference/colombia-payload-guide/
- Markdown: https://developer.incode.com/general-reference/colombia-payload-guide.md

# Payload Guide: Colombia

This guide covers the correct request fields for GovMatch in [Colombia](/general-reference/system-of-record-colombia/) (`countryCode=CO`), including two cases that are easy to get wrong: [names with more than one given name](#names-with-more-than-one-given-name) and citizens who don't have a [maternal surname](#no-maternal-surname). It applies to accounts set up for field-by-field name validation in Colombia; contact your Incode representative if you aren't sure how your account is set up, or if you have a use case not covered on this page.

## Endpoint

`POST /omni/process/government-validation?countryCode=CO`

## Required fields

| Field | Description | Required |
| --- | --- | --- |
| `idNumber` | Cédula number, digits only (no dots, spaces, or dashes) | Yes |
| `firstName` | Person's first given name (single word) | Yes |
| `middleName` | Second given name, if the person has one | No |
| `paternalLastName` | First (paternal) surname | Yes |
| `maternalLastName` | Second (maternal) surname | Yes, send `""` if not applicable |
| `fechaEmision` | ID issue date, format `dd/MM/yyyy` or `yyyy-MM-dd` | Yes |

**Send every field in the table, even when a value is empty.** If you leave a name field or `fechaEmision` out of the request, we fall back to the value read from the ID image, which can contain OCR errors. This is why `maternalLastName` must be sent as an empty string when it does not apply: omitting it causes the surname read from the ID to be used instead. Values sent directly in the request always take precedence over any previously submitted data for the same person.

**Don't use `nombre`, `apellidoPaterno`, or `apellidoMaterno`.** These are not used for Colombia validation. Use `firstName` / `middleName` / `paternalLastName` / `maternalLastName` instead.

## Use cases

### Names with more than one given name

If a person has more than one given name (e.g. "Juan Carlos"), split it across `firstName` and `middleName` rather than sending both words in `firstName`. Sending a combined value in one field can cause a valid identity to fail.

```json
{
  "idNumber": "1234567890",
  "firstName": "JUAN",
  "middleName": "CARLOS",
  "paternalLastName": "PEREZ",
  "maternalLastName": "GOMEZ",
  "fechaEmision": "31/10/2025"
}
```

### No maternal surname

Some Colombian citizens don't have a maternal surname. Send `maternalLastName` as an explicit empty string:

```json
{
  "idNumber": "1234567890",
  "firstName": "JUAN",
  "paternalLastName": "PEREZ",
  "maternalLastName": "",
  "fechaEmision": "31/10/2025"
}
```

</br>

---

- Path: `general-reference/coverage-hub`
- URL: https://developer.incode.com/general-reference/coverage-hub/
- Markdown: https://developer.incode.com/general-reference/coverage-hub.md

# Incode Coverage Hub

Four sections of the documentation define what Incode supports in a given country. Use this hub to find country-specific policies, accepted document types, and verification sources.

***

## Supported IDs

**What this covers:** The full catalog of government-issued identity documents that Incode can classify, read, and extract data from using OCR. Organized by region: Africa, Asia, Caribbean, Europe, North and Central America, Oceania, and South America.

**Question this answers:** Can Incode's camera capture and OCR read this physical document?

**When it applies:** Use this when you need to confirm that a specific document type from a specific country is recognized by the platform.

[View supported IDs →](/general-reference/supported-ids/)

***

## Government Verification Sources (System of Records)

**What this covers:** After a user submits an ID document and biometric, Incode cross-checks the extracted data against official government registries to confirm the document is authentic and currently valid. Country-specific pages detail which registries are used and what data fields are validated.

**Question this answers:** Can Incode validate this identity against a government registry?

**When it applies:** Use this when your compliance requirements demand that identity data be validated at the source, not just scanned and extracted.

[View verification sources →](/general-reference/government-verification-sources/)

***

## eKYC Coverage

**What this covers:** Verifying a customer's identity without physical documents. Incode checks submitted data directly against authoritative country sources such as voter registers, credit bureaus, civil registries, and telecom records. Sub-pages provide country-specific data source details and supported fields.

**Question this answers:** Can Incode verify this person's data against a private or government data source?

**When it applies:** Use this when your flow needs data-only KYC without a document scan.

[View eKYC coverage →](/general-reference/ekyc-coverage/)

***

## KYB Coverage

**What this covers:** Instant access to verified company information from official registries worldwide, including registration status, legal entity type, tax ID, address, and UBO/director details. Sub-pages provide country-specific source details and supported fields.

**Question this answers:** Can Incode verify this business against a country's business registry?

**When it applies:** Use this when onboarding a business rather than an individual, or when you need to confirm a company's legitimacy before extending services.

View KYB coverage →

> 📘 Note
>
> Not all countries and data sources are live in production. Contact the sales team to learn more about our expanding network.

<br />

---

- Path: `general-reference/curp-validation-error-codes-reference`
- URL: https://developer.incode.com/general-reference/curp-validation-error-codes-reference/
- Markdown: https://developer.incode.com/general-reference/curp-validation-error-codes-reference.md

# CURP Validation Error Codes

Incode uses a third party provider to access the official RENAPO records.

Errors while requesting the CURP validation might come from different sources: Provider and RENAPO.

The details of the error will be included within the `error` field in the response.

* The errors from the Provider suggest a connectivity error. These are provided via a pair of fields: `codigoRespuesta` and `descripcionRespuesta`.
* RENAPO errors are of a different nature, as they indicate errors with the CURP data itself or RENAPO internal errors. These errors are provided with a pair of fields: `tipoError` and `codigoError`

## Provider Error Codes

Errors originated directly from the Provider do not reach to query the information at the RENAPO services.

When an error happens at the Provider level, you should get a response similar to these:

```json
{
    "success": false,
    "error": {   
        "descripcionRespuesta": "LOS DATOS SON INCORRECTOS",
        "codigoRespuesta": "03",  
        "codigoError": "06",
        "tipoError": "01",
    },
    "result": "error"
}
```

```json
{
    "success": false,
    "error": {
        "codigoRespuesta": "01",
        "descripcionRespuesta": "SIN RESPUESTA DE RENAPO",
        "referencia": "",
        "respuestaRENAPO": null
    },
    "result": ""
}
```


Here are the possible values of the `codigoRespuesta` and `descripcionRespuesta` fields:

| codigoRespuesta | descripcionRespuesta | descripcionRespuesta |
|---|---|---|
| 01 | SIN RESPUESTA DE RENAPO | No response from RENAPO |
| 02 | SERVIDOR SVBI NO RESPONDE<br>SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR MES<br>SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR MINUTO<br>SE HA ALCANZADO EL LÍMITE DE TRANSACCIONES PERMITIDAS POR DIA | * SVBI server is not responding<br>* The limit of transactions allowed per month has been reached<br>* The limit of transactions allowed per minute has been reached<br>* The limit of transactions allowed per day has been reached |
| 03 | LOS DATOS SON INCORRECTOS | Data is incorrect |
| 05 | ERROR INESPERADO | Unexpected error |


## Renapo Error Codes

When a CURP validation request is successful (meaning, RENAPO responded), you will get a response that looks like the following:

```json
{
    "success": false,
    "error": {
        "codigoError": "06",
        "tipoError": "01",
        "message": "",
    },
    "result": "",
    "renapo_valid": false
}
```

Errors are divided in 3 groups. You can identify them by the `tipoError` and `codigoError` fields.

* Group 1: Errors most likely to be found. Might be due to incorrect CURP input in the session.
* Group 2: Connectivity errors (within RENAPO). Most of these should be transient and might require you to retry.
* Group 3: Internal errors. These should not be found. Please reach out to Incode technical support if you find any of these.

**Group 1**

| tipoError | codigoError | message                                                | Description                                        |
| --------- | ----------- | ------------------------------------------------------ | :------------------------------------------------- |
| 01        | 04          | CURP previamente dada de baja                          | The CURP was previously deactivated.               |
| 01        | 06          | La CURP no se encuentra en la base de datos.           | The CURP is not found in the database.             |
| 01        | 09          | La llave de la CURP no está bien formada.              | The CURP key is not correctly formatted.           |
| 01        | 20          | Más de una CURP para estos datos                       | More than one CURP exists for this data.           |
| 01        | 90          | Curp status is not acceptable                          | Curp status is not acceptable                      |
| 03        | 01          | \[Nombre campo]: No cumple con el formato especificado | \[Field name]: Does not meet the specified format. |

<br />

For **Group 2**  and **Group 3** , you can handle the same meaning for all combinations:

| tipoError | codigoError | Meaning              | Group   |
| --------- | ----------- | -------------------- | ------- |
| 01        | 13          | **Connection Error** | Group 2 |
| 01        | 14          | **Connection Error** | Group 2 |
| 01        | 18          | **Connection Error** | Group 2 |
| 02        | 01          | **Connection Error** | Group 2 |
| 02        | 02          | **Connection Error** | Group 2 |
| 02        | 03          | **Connection Error** | Group 2 |
| 04        | 01          | **Connection Error** | Group 2 |
| 99        | 01          | **Connection Error** | Group 2 |
| 99        | 02          | **Connection Error** | Group 2 |
| 01        | 01          | **Internal Error**   | Group 3 |
| 01        | 02          | **Internal Error**   | Group 3 |
| 01        | 03          | **Internal Error**   | Group 3 |
| 01        | 05          | **Internal Error**   | Group 3 |
| 01        | 07          | **Internal Error**   | Group 3 |
| 01        | 08          | **Internal Error**   | Group 3 |
| 01        | 10          | **Internal Error**   | Group 3 |
| 01        | 11          | **Internal Error**   | Group 3 |
| 01        | 12          | **Internal Error**   | Group 3 |
| 01        | 15          | **Internal Error**   | Group 3 |
| 01        | 16          | **Internal Error**   | Group 3 |
| 01        | 17          | **Internal Error**   | Group 3 |
| 01        | 19          | **Internal Error**   | Group 3 |
| 03        | 02          | **Internal Error**   | Group 3 |
| 05        | 01          | **Internal Error**   | Group 3 |

<br />

In case there is a communication error and it was not possible to establish a connection with the provider, you will see the following message: "The CURP validation service is not available":

```json
{
    "success": false,
    "error": {
        "codigoError": "01",
        "tipoError": "99",
        "message": "The CURP validation service is not available"
    },
    "result": "The CURP validation service is not available",
    "renapo_valid": false
}
```

---

- Path: `general-reference/denmark`
- URL: https://developer.incode.com/general-reference/denmark/
- Markdown: https://developer.incode.com/general-reference/denmark.md

# Denmark


Denmark eKYC verification matches submitted individual data against Denmark's official civil register, credit, and telco records. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description |
|---|---|---|
| Denmark Civil Register + Credit + Telco | `DK_CIVIL_REG_CREDIT_TELCO` | Verifies submitted data against Denmark's official civil register, consumer credit, and telco records. |

## Denmark Civil Register + Credit + Telco

### Request parameters

| Parameter | Required | Description |
|---|---|---|
| `source` | Mandatory | Must be `DK_CIVIL_REG_CREDIT_TELCO`. |
| `country` | Mandatory | Must be `DK`. |
| `firstName` | Mandatory | First name of the individual. Must not contain digits. |
| `surName` | Mandatory | Last name of the individual. Must not contain digits. |
| `phone` | Mandatory | Denmark phone number. See format note below. |
| `street` | Optional | Full street including house number. |
| `city` | Optional | City of the individual's address (for example, Copenhagen). |
| `state` | Optional | Accepted in the request but not currently used for matching by this source. |
| `postalCode` | Optional | Denmark postal code (postnummer). See format note below. |
| `dateOfBirth` | Optional | Format: yyyy-mm-dd. |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "DK_CIVIL_REG_CREDIT_TELCO", //required field
    "firstName": "Anna", //required field
    "surName": "Nielsen", //required field
    "street": "Norrebrogade 12",
    "city": "Copenhagen",
    "state": "Capital Region",
    "postalCode": "2200",
    "country": "DK", //required field
    "dateOfBirth": "1991-08-02",
    "phone": "12345678" //required field
}
```

### Response fields

Denmark Civil Register + Credit + Telco anchors verification on individual name, phone number, date of birth, and address. See the eKYC API Reference for common match field definitions and status values.

| Field | Statuses | Description |
|---|---|---|
| `firstNameMatch` | exact, fuzzy, nomatch | Matches first name submitted against the value in the source of truth. |
| `lastNameMatch` | exact, fuzzy, nomatch | Matches last name submitted against the value in the source of truth. |
| `fullNameMatch` | exact, fuzzy, nomatch | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise `fuzzy`. |
| `phoneMatch` | exact, fuzzy, nomatch | Matches phone submitted against the value in the source of truth. |
| `dobMatch` | exact, fuzzy, nomatch, nodata | Matches date of birth submitted against the value in the source of truth. |
| `streetMatch` | exact, fuzzy, nomatch, nodata | Matches street submitted against the value in the source of truth. |
| `cityMatch` | exact, fuzzy, nomatch, nodata | Matches city submitted against the value in the source of truth. |
| `stateMatch` | exact, fuzzy, nomatch, nodata | Matches state submitted against the value in the source of truth. |
| `postalCodeMatch` | exact, fuzzy, nomatch, nodata | Matches postal code submitted against the value in the source of truth. |
| `fullAddressMatch` | exact, fuzzy, nomatch, nodata | Composite of `streetMatch`, `cityMatch`, `stateMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `overallLevel` | low, medium, high | Overall risk level. See below for calculation logic. |

#### `fullAddressMatch` calculation

- `exact` when `streetMatch` is exact, and `cityMatch` is exact or nodata, and `stateMatch` is exact or nodata, and `postalCodeMatch` is exact or nodata.
- `nomatch` when `streetMatch` is nomatch.
- `nodata` when `streetMatch`, `cityMatch`, `stateMatch`, and `postalCodeMatch` are all nodata.
- `fuzzy` for any other combination.

#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name, phone number, and date of birth:

- `low` when `fullNameMatch` is exact, and `phoneMatch` or `dobMatch` is exact.
- `high` when `fullNameMatch` is nomatch, and both `phoneMatch` and `dobMatch` are nomatch.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/dmv-data-match-technical-details`
- URL: https://developer.incode.com/general-reference/dmv-data-match-technical-details/
- Markdown: https://developer.incode.com/general-reference/dmv-data-match-technical-details.md

# DMV Data Match Technical Details


GovDataMatch is Incode's data verification service through AAMVA or through validation of Verifiable Credentials. During verification, the supported document data fields are validated against the data on the record held by the issuing state's DMV.

GovDataMatch is part of the overall [US GovMatch](/general-reference/united-states-govmatch/) offering.

GovDataMatch now runs on AAMVA's DLDV 3.0 service. This update improves the quality of the match and the detail in the response. The endpoint, the request body, the scoring model, and the provider value are unchanged.

## Decisioning

The document number is the anchor for the whole check. When the issuing agency confirms the document number, the remaining submitted fields are evaluated individually and returned in `ocrValidation`. When it does not, no field-level results are returned and the module resolves to one of the statuses in the [error table](#error-codes) below.

Each field is returned with its own result in `ocrValidation`:

| Key | Evaluated |
|---|---|
| `documentNumber` | Always. The anchor for the check. If it does not match, no other field is scored |
| `firstName` | Always |
| `paternalLastName` | Always |
| `birthDate` | Always |
| `issueDate` | Always, except in jurisdictions that cannot verify an issue date for the document class presented |
| `expirationDate` | Always. Replaced by an indefinite-expiration check where the credential carries no expiry |
| `address` | When address validation is enabled on the flow. Street line 1 |
| `addressLine2` | When address validation is enabled on the flow |
| `city` | When address validation is enabled on the flow |
| `state` | When address validation is enabled on the flow |
| `zipCode` | When address validation is enabled on the flow |

Not every jurisdiction supports every field. Talk to your account team to confirm coverage for the jurisdictions relevant to you.

### Elements the agency cannot answer

An element resolves three ways:

- It matches the agency record
- It does not match the agency record
- The issuing agency holds no record for it

Only the first two are scored. Where the agency holds no record for an element or cannot answer it, that element is **omitted from `ocrValidation`** rather than returned as a failure, and it applies no score deduction. This behavior leads to fewer deductions overall and a shorter `ocrValidation` array on sessions where the agency holds a partial record.

:::info
**Action for integrators.** If your decision logic counts entries in `ocrValidation`, or assumes a fixed set of keys, review it. The array varies in length by jurisdiction and by record completeness.
:::

Decisioning should be based on the `status` value in the `overall` object. The `status` value can be:

* **OK**: Data Match is successful

* **FAIL**: Data Match is unsuccessful

<Accordion title="Scoring">
  The module score starts at 100. Each field returned as `FAIL` deducts points according to the severity configured for that check: 15 points at the default MEDIUM severity, less for the address fields, which are LOW. Elements the issuing agency could not answer are not counted as failures and apply no deduction.

  * **OK**: score above 55
  * **FAIL**: score of 55 or below, or every returned field failed

  Where the document number itself did not match, `ocrValidationOverall` and `overall` are both returned as `0.0` / `FAIL`.
</Accordion>

<Accordion title="NY Verifiable Credential" >
  GovDataMatch supports NY through the validation of the Verifiable Credential within the document. A successful Data Match confirms the document was issued by the New York Department of Motor Vehicles and the identity data in the barcode has not been altered or tampered with. Results are returned as OK (100.0) or FAIL (0.0).

Note: supports New York driver’s licenses and ID cards issued after 2005 
</Accordion>

## How data fields are matched

Name and address fields aren't compared character by character. The issuing agency runs several comparisons on each field and reports each one separately. Incode returns the field as a match if any comparison matched.



Comparisons include the exact value, phonetic variants, values within a small edit distance, and any alternative or former name the agency holds on record. This covers common spelling variants (`STEPHEN` and `STEVEN` match; `JONHSON` and `JOHNSON` match) as well as the many valid ways to write the same address (`APT 4B`, `#4B`, and `UNIT 4B` are treated as the same value; `ST` and `STREET` match).

This doesn't lower the standard. Genuinely different values still return `FAIL`. What it prevents is a mismatch caused only by spelling, punctuation, or formatting. Matching behavior isn't configurable.



Two things to know:

* **Nicknames only match when the agency has them on record.** `ROBERT` doesn't automatically match `BOB`, since the two are neither phonetically similar nor within a small edit distance.
* **First and last name are stricter than other fields.** Anything short of a match returns `FAIL` rather than being treated as unevaluated. That said, two failed name fields alone still leave the module above the pass threshold.

## Standalone API

`POST` `/omni/process/government-validation?countryCode=USA`

### Request Body

```json
{
    "documentNumber": "D12345678",
    "firstName": "JOHNTEST",
    "paternalLastName": "DOETEST",
    "birthDate": "1990-03-16",
    "issuedAt": "2020-01-15",
    "expireAt": "2028-01-15",
    "issuerState": "TX",
    "driverLicenseNonCommercialStatusCode": "LIC"
}
```

### Response Body

```json
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "firstName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "paternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "birthDate"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "issueDate"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "expirationDate"
            }
        ],
        "credentialStatus": [
            {
                "status": "OK",
                "key": "nonCommercialDriverLicenseStatus"
            },
            {
                "status": "OK",
                "key": "indefiniteExpiration"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "100.0",
            "status": "OK"
        },
        "provider": "GOVDATAMATCH"
    }
}
```

### Response Details

The response for GovDataMatch is contained within the `governmentValidation` object.

This object contains the following fields:

| Field | Type | Description |
|---|---|---|
| `validationStatus` | StatusValue | Provider status code for error handling. Contains a `value`, `status`, and `key`. See [below](#statusvalue-keyvalue-pairs) for more information. |
| `ocrValidation`<br />_Optional_ | Array[StatusValue] | Individual data field match results. Each data field result contains a `value`, `status`, and `key`. See [below](#statusvalue-keyvalue-pairs) for more information. |
| `credentialStatus`<br />_Optional_ | Array[StatusValue] | Issuing agency verdicts on credential attributes that were submitted. Does not affect `overall`. See [Credential status](#credential-status). |
| `ocrValidationOverall`<br />_Optional_ | StatusValue | Percentage of OCR fields that matched. Supplementary data for analysis. Contains a `value` and `status`. See [below](#statusvalue-keyvalue-pairs) for more information. |
| `overall` | StatusValue | Primary verification result. Use this field to determine pass/fail. Contains a `value` and `status`. See [below](#statusvalue-keyvalue-pairs) for more information. |
| `provider`<br />_Optional_ | String | Indicates whether the request was sent to GovFaceMatch (`GOVFACEMATCH`) or GovDataMatch (`GOVDATAMATCH`). Only present for US verification. |

#### StatusValue key/value pairs

This object contains the following fields:

| Field | Type | Description |
|---|---|---|
| `value`<br />_Optional_ | String | The numeric or boolean value. |
| `status` | String | The status code. Possible statuses are:<br /><br />- `OK`: User passed verification.<br />- `FAIL`: Data did not match during validation.<br />- `UNKNOWN`: GovDataMatch was run, but the submitted document or region isn't supported or something went wrong when trying to perform validation. |
| `key`<br />_Optional_ | String | The key for which the status is being reported. For example, `firstName`, `birthDate`, or `documentNumber`. |

### Credential status

The issuing agency reports verdicts on certain credential attributes. There is a `credentialStatus` array on the `governmentValidation` object if the session collected one of the attributes:

- **`nonCommercialDriverLicenseStatus`.** Whether the holder has a current, valid base driving privilege for standard passenger vehicles such as cars, vans, pickups, and SUVs. This attribute says nothing about commercial driver licenses; no CDL information is carried at any point, and a holder may also hold a CDL. Not every jurisdiction participates; where one doesn't, the status is `UNKNOWN`, not `FAIL`. Participation is expanding over time. The jurisdictions returning this field are Alabama, Arizona, Arkansas, Colorado, Delaware, District of Columbia, Georgia, Hawaii, Illinois, Indiana, Kansas, Kentucky, Massachusetts, Michigan, Mississippi, Missouri, Montana, Nebraska, New Jersey, New Mexico, North Dakota, Ohio, Rhode Island, South Dakota, Tennessee, Texas, Vermont, West Virginia, and Wyoming.

- **`indefiniteExpiration`.** Whether the credential is one of those issued with no expiration date. A small number of jurisdictions do this, in some cases only above a given age. When a credential is submitted as indefinite, the agency confirms that against its record and the verdict is returned both here and as the `expirationDate` row in `ocrValidation`. An expiration date and an indefinite indicator are mutually exclusive, so a credential carries one or the other, never both.

Each entry has a `key` and a `status` of `OK`, `FAIL`, or `UNKNOWN`. Verdicts are reported separately from `ocrValidation` because they describe the credential rather than verify a submitted value, so they don't affect `ocrValidationOverall` or `overall`.

### Error Codes

If these errors appear for a legitimate user, or if the errors persist, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation.

| Reason Code                         | Description                                                                                                                                          | Status    | Next Steps                                                                                                                                                                                                  |
| :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `providerNotConfigured`             | **Provider Not Configured**<br />Provider is not configured or is incorrectly configured for this flow.                                                   | `UNKNOWN` | Submit a support ticket through [http://support.incode.com/](http://support.incode.com/) to troubleshoot issues with your configuration.                                                                    |
| `missingDocumentId`                 | **Missing Document Number**<br />Document number missing or has an invalid pattern.                                                                       | `UNKNOWN` | Check ID capture quality for barcode/OCR readability issues.                                                                                                                                                |
| `invalidExpirationDate`             | **Invalid Expiration Date**<br />Expiration date is not valid per document standards.                                                                     | `UNKNOWN` | Check ID capture quality for barcode/OCR readability issues. If user is legitimate, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation.     |
| `notEnoughData` | **Missing Required Data**<br />One or more required fields are missing or invalid, or the issuing agency could not evaluate the document number. | `UNKNOWN` | Ensure all required fields are provided by user into session. |
| `documentTypeNotSupported`          | **Document Type Not Supported**<br />Invalid document type for validation by the configured provider.                                                     | `UNKNOWN` | Ensure the user is providing a supported document type.                                                                                                                                                     |
| `geographicRegionNotSupported`      | **Country Not Supported**<br />Document country not supported by the configured provider.                                                                 | `UNKNOWN` | Verify the user is providing supported document and countries are provisioned correctly.                                                                                                                    |
| `geographicStateRegionNotSupported` | **State Not Supported**<br />Document state not supported by the configured provider.                                                                     | `UNKNOWN` | Verify the user is providing supported document and states are provisioned correctly.                                                                                                                       |
| `connectionError`                   | **Provider Connection Error**<br />Error occurred during processing within provider environment.                                                     | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/).                                                                               |
| `infrastructureError`               | **Incode Processing Error**<br />Error occurred during processing within Incode environment.                                                         | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/).                                                                               |
| `transactionLimitReached` | **Transaction Limit Reached**<br />The provider rejected the request because a rate or volume limit was exceeded. | `UNKNOWN` | Retry after a short delay. If the error persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) so the limit can be reviewed. |
| `null`                              | If government validation status is not present, then it means the module was not run.                                                                | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/).                                                                               |
| `userNotFound` | **User Not Found**<br />The document number did not match, and no other submitted identity field matched the agency record. | `FAIL` | Check data extraction quality. If user is legitimate, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation. |
| `documentNumberMismatch` | **Document Number Mismatch**<br />The document number did not match, but other submitted identity fields did, so a record for this person exists under a different credential number. Commonly a renewed or replaced credential. | `FAIL` | Check data extraction quality. If user is legitimate, ask that a newer identity document is used for verification or submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation. |

---

- Path: `general-reference/dmv-face-match-technical-details`
- URL: https://developer.incode.com/general-reference/dmv-face-match-technical-details/
- Markdown: https://developer.incode.com/general-reference/dmv-face-match-technical-details.md

# GovFaceMatch Technical Details

GovFaceMatch is Incode’s direct connection to state DMV systems for biometric face comparison. During verification, the supported document data fields are sent to the DMV. If the document data fields match to a record within the DMV database, the uploaded selfie is compared against the official portrait stored in the state’s DMV database. A successful Face Match guarantees that the Data Match also passed, and provides the highest level of assurance that the person presenting the document is the legitimate holder.

GovFaceMatch is part of the overall [US GovMatch](/general-reference/united-states-govmatch/) offering.

***

## Decisioning

State requirements mandate that certain data fields must match before Incode can access the DMV selfie. Face matching only occurs after this data match succeeds. Therefore, a successful Face Match guarantees that the Data Match also passed.

Decisioning should be based on the `status` value in the `overall` object. The `status` value can be:

* **OK**: Face Match is successful

* **FAIL**: Face Match is unsuccessful
  * Did not meet Must-Match requirements of the state

    OR
  * Met Must-Match requirements of the state, but uploaded face image did not match official photograph stored in the state's DMV database

<Accordion title="Scoring">
  Most states return a face match confidence score with a passing threshold of 77. Due to variability of image quality by state, face match confidence thresholds vary, and not every state may provide that level of granularity. Numeric match confidence is provided where applicable and acceptance thresholds are subject to change. When numeric match confidence is not returned, a simple pass (100.0) / fail (0.0) is used when determining a match.
</Accordion>

<Accordion title="Must-Match Data fields for CA">
  For California, the following data must meet the listed match requirements:

  * Document Number: Exact match
  * First 3 letters of Last Name: Partial match
  * Date of Birth: Exact match
</Accordion>

<Accordion title="Must-Match Data fields for GA, MS, VA">
  For Georgia, Mississippi, and Virginia, the following data must meet the listed match requirements:

  * Document Number: Exact match
  * First Name: Exact match
  * Last Name: Exact match
  * Date of Birth: Exact match
</Accordion>

***

## Standalone API

`POST` `/omni/process/government-validation?countryCode=USA`

To retrieve the results of GovMatch, use the [Fetch Scores endpoint](/reference/getscores/). When government record verification is enabled for your organization, a `governmentValidation` field is present in the endpoint results.

### Request Body

```json
{
    "idNumber": "T123456789",
    "firstName": "EMILYTEST",
    "paternalLastName": "DAVISTEST",
    "birthDate": "1987-04-18",
    "base64Image": "{{selfie}}",
    "issuerState": "VA"
}
```

### Response Body

```json
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "recognitionConfidence": {
            "value": "100.0",
            "status": "OK"
        },
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "firstName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "paternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "birthDate"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "100.0",
            "status": "OK"
        },
        "provider": "GOVFACEMATCH"
    }
}
```


### Response Details

The response for GovFaceMatch is contained within the `governmentValidation` object. This object contains the following fields:

| **Field**                               | Type                | **Description**                                                                                                                                                                                               |
| --------------------------------------- | ------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `validationStatus`                      | StatusValue         | Provider status code for error handling. Contains a `value`, `status`, and `key`. See [below](#statusvalue-keyvalue-pairs) for more information.                                                              |
| `ocrValidation`<br />_Optional_         | Array\[StatusValue] | Individual data field match results. Each data field result contains a `value`, `status`, and `key`. See [below](#statusvalue-keyvalue-pairs) for more information.                                           |
| `recognitionConfidence`<br />_Optional_ | StatusValue         | Face Match confidence score. Only present for GovFaceMatch; indicates biometric verification was performed. Contains a `value` and `status`. See [below](#statusvalue-keyvalue-pairs) for more information. |
| `ocrValidationOverall`<br />_Optional_  | StatusValue         | Percentage of OCR fields that matched. Supplementary data for analysis. Contains a `value` and `status`. See [below](#statusvalue-keyvalue-pairs) for more information.                                       |
| `overall`                               | StatusValue         | Primary verification result. Use this field to determine pass/fail. Contains a `value` and `status`. See [below](#statusvalue-keyvalue-pairs) for more information.                                           |
| `provider`<br />_Optional_              | String              | Indicates whether the request was sent to GovFaceMatch (`GOVFACEMATCH`) or GovDataMatch (`GOVDATAMATCH`). Only present for US verification.                                                         |

#### StatusValue key/value pairs

Any field listed as StatusValue in the table above contains a `value` and a `status`. Some also contain a `key`.

| Field | Type | Description |
|---|---|---|
| `value`<br />_Optional_ | String | The numeric or boolean value. |
| `status` | String | The status code. Possible statuses are:<br /><br />- `OK`: User passed verification.<br />- `FAIL`: Either data or face did not match during validation.<br />- `UNKNOWN`: GovFaceMatch was run, but the submitted document or region isn’t supported or something went wrong when trying to perform validation. |
| `key`<br />_Optional_ | String | The key for which the status is being reported. For example, `firstName`, `birthDate`, or `documentNumber`. |

#### Error Codes



If these errors appear for a legitimate user, or if the errors persist, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation.

| Reason Code | Description | Status | Next Steps |
|---|---|---|---|
| `providerNotConfigured` | **Provider Not Configured**<br />Provider is not configured or is incorrectly configured for this flow. | `UNKNOWN` | Submit a support ticket through [http://support.incode.com/](http://support.incode.com/) to troubleshoot issues with your configuration. |
| `missingDocumentId` | **Missing Document Number**<br />Document number missing or has an invalid pattern. | `UNKNOWN` | Check ID capture quality for barcode/OCR readability issues. |
| `invalidExpirationDate` | **Invalid Expiration Date**<br />Expiration date is not valid per document standards. | `UNKNOWN` | Check ID capture quality for barcode/OCR readability issues. If user is legitimate, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation. |
| `notEnoughData` | **Missing Required Data**<br />One or more required fields are missing or invalid. | `UNKNOWN` | Ensure all required fields are provided by the user in the session. |
| `missingSelfie` | **Missing Selfie**<br />Provider requires selfie for processing but not provided in session. | `UNKNOWN` | Ensure the user provides a selfie in the session. |
| `selfieChecksFailed` | **Selfie Image Quality Check Failed**<br />Higher-quality selfie needed for processing by provider. | `UNKNOWN` | Ensure the user retakes a higher-quality selfie (e.g. check brightness, blurriness, face mask, occlusion). |
| `documentTypeNotSupported` | **Document Type Not Supported**<br />Invalid document type for validation by the configured provider. | `UNKNOWN` | Ensure the user is providing a supported document type. |
| `geographicRegionNotSupported` | **Country Not Supported**<br />Document country not supported by the configured provider. | `UNKNOWN` | Verify the user is providing a supported document and countries are provisioned correctly. |
| `geographicStateRegionNotSupported` | **State Not Supported**<br />Document state not supported by the configured provider. | `UNKNOWN` | Verify the user is providing a supported document and states are provisioned correctly. |
| `connectionError` | **Provider Connection Error**<br />Error occurred during processing within provider environment. | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/). |
| `infrastructureError` | **Incode Processing Error**<br />Error occurred during processing within Incode environment. | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/). |
| `null` | If government validation status is not present, then it means the module was not run. | `UNKNOWN` | Try again later; if issue persists, submit a support ticket through [http://support.incode.com/](http://support.incode.com/). |
| `userNotFound` | **User Not Found**<br />ID not found in government database. | `FAIL` | Check data extraction quality. If user is legitimate, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation. |
| `faceComparisonFailed` | **Face Match Failed**<br />Selfie does not match government database portrait. | `FAIL` | Check selfie capture quality. If user is legitimate, submit a support ticket through [http://support.incode.com/](http://support.incode.com/) for further investigation. |

<br />

---

- Path: `general-reference/ekyb-greece`
- URL: https://developer.incode.com/general-reference/ekyb-greece/
- Markdown: https://developer.incode.com/general-reference/ekyb-greece.md

eKYB Verification in Greece leverages GR's source of truth to validate the legitimacy of businesses, including their tax ID, business name, business address, along with UBOs and directors.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Greece | `GR` | Validates Greek businesses against Greece's official source of truth. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a KYB search. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb"]`. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `GR`. |
| taxId | Mandatory | String. Greek AFM number or VAT number. See [Tax ID formats](tax-id-formats) below for details. |
| businessName | Optional | String. Registered name of the business. |
| street | Optional | String. Street name of the business address. |
| houseNo | Optional | String. Building or house number. |
| addressLine2 | Optional | String. Additional address information. |
| city | Optional | String. City of the business address. |
| state | Optional | String. State or region of the business address. |
| postalCode | Optional | String. Greek postal code. Format: exactly 5 digits (for example, `10560`). |
| uboNames | Optional | Array of strings. Full legal name(s) of Ultimate Beneficial Owners to check against business records. |
| directors | Optional | Array of strings. Full legal name(s) of directors to check against business records. |

### Tax ID formats

The `taxId` field accepts two Greek business identifier types. Routing between them is determined automatically by the format and length of the submitted value.

| ID Type | Description | Format | Routing logic | Example |
| --- | --- | --- | --- | --- |
| **AFM** (Arithmos Forologikou Mitroou) | Greek Tax Registration Number assigned by AADE | Exactly 9 numeric digits | Routes to `vatNo` in source of truth lookup | `123456789` |
| **VAT number** | Greek intra-community VAT identifier | `EL` + 9 numeric digits — note the prefix is `EL`, not `GR` | `EL` prefix is stripped before lookup; 9-digit value is used as AFM | `EL123456789` |

Inputs that do not match either format return a 400 error. The AFM is a separate identifier from the GEMI number (Genikó Emporikó Mitró / General Commercial Registry number), which is 12 digits and also accepted as `taxId` — in that case it routes to `regNo` in the source of truth lookup.

### Sample request

```json
{
    "plugins": ["ekyb"],
    "country": "GR",
    "taxId": "123456789",
    "businessName": "EXAMPLE COMPANY E.E.",
    "street": "Example Street",
    "houseNo": "10",
    "addressLine2": "",
    "city": "Athens",
    "state": "",
    "postalCode": "10560",
    "uboNames": ["John Doe"],
    "directors": ["Jane Smith"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name",                 "sub_label": "Verified" },
    { "key": "tin",                  "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch",            "sub_label": "Verified" },
    { "key": "postalCodeMatch",      "sub_label": "Verified" },
    { "key": "registrationStatus",   "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": {
        "entityType": "Limited Partnership"
      }
    },
    {
      "key": "directors_name_match",
      "sub_label": "Verified",
      "directorsName_input": "Jane Smith"
    },
    {
      "key": "directors_name_match",
      "sub_label": "Unverified",
      "directorsName_input": "John Johnson"
    },
    {
      "key": "ubo_name_match",
      "sub_label": "Verified",
      "uboName_input": "John Doe"
    },
    {
      "key": "ubo_name_match",
      "sub_label": "Unverified",
      "uboName_input": "Sarah Smith"
    }
  ]
}
```

### Response fields

| Incode API Key | Status | Definition |
| --- | --- | --- |
| name | Verified, Approximate Match, Unverified | Submitted business name is verified, approximate match, or unverified against the registered legal name associated with the business tax ID in the source of truth. Note: matching is performed against the registered legal name only — trading names are not checked. |
| tin | Verified, Unverified | Submitted AFM (tax ID) is found or not found in the source of truth. |
| address\_verification | Verified, Approximate Match, Unverified | Submitted address is verified, approximate match, or unverified against the registered address associated with the business tax ID in the source of truth. Fuzzy matching is applied to the full address string. |
| cityMatch | Verified, Approximate Match, Unverified | Submitted city is verified, approximate match, or unverified against the city associated with the business tax ID in the source of truth. |
| postalCodeMatch | Verified, Unverified | Submitted postal code is verified or unverified against the postal code associated with the business tax ID in the source of truth. Format: exactly 5 digits (for example, `10560`). |
| registrationStatus | Active, Not active | Current registration status of the business as returned from the source of truth. `Active` = the business is currently active. `Not active` = the business is no longer active. |
| entityType | Legal entity type of the business | The legal form of the business as returned from the source of truth (for example, `Limited Partnership`, `Société Anonyme`). Passed through as-is — not fuzzy matched against anything in the request. |
| ubo\_name\_match | Verified, Approximate Match, Unverified | Submitted UBO name is matched against shareholders associated with the business tax ID in the source of truth. One entry is returned per submitted UBO name, distinguishable via `uboName_input`. |
| directors\_name\_match | Verified, Approximate Match, Unverified | Submitted director name is matched against current directors associated with the business tax ID in the source of truth. One entry is returned per submitted director name, distinguishable via `directorsName_input`. |


## Error responses

See the [eKYB API Reference](/general-reference/ekyb-api-reference/) for standard error responses.



## Single Session Dashboard results

Results for Greece eKYB are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/#business).

---

- Path: `general-reference/ekyb-portugal`
- URL: https://developer.incode.com/general-reference/ekyb-portugal/
- Markdown: https://developer.incode.com/general-reference/ekyb-portugal.md

# Portugal
Portugal eKYB validates the legitimacy of Portuguese businesses by checking their tax ID, business name, address, UBOs, and directors against Portuguese government-backed business registry data.

## Source

| Country  | Source                          | Description                                                                |
| -------- | -------------------------------- | ---------------------------------------------------------------------------- |
| Portugal | Portuguese business registry sources | Verifies submitted business details against records maintained in the Portuguese business registry. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).









### Request parameters

| Parameter      | Required  | Description                                                                                     |
| --------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `plugins`       | Mandatory | Array. Must be `["ekyb"]`.                                                                            |
| `businessName`  | Mandatory | String. Name of the business.                                                                        |
| `country`       | Mandatory | String. Two-letter Alpha-2 country code. Must be `PT`.                                                |
| `taxId`         | Mandatory | String. NIF (Número de Identificação Fiscal). Exactly 9 numeric digits (for example, `500123456`). Serves as both the company registration number and VAT number.       |
| `street`        | Optional  | String. Street name of the business.                                                                  |
| `houseNo`       | Optional  | String. Building or house number.                                                                     |
| `addressLine2`  | Optional  | String. Second line of the business address.                                                          |
| `city`          | Optional  | String. City in the business address.                                                                 |
| `state`         | Optional  | String. State in the business address.                                                                |
| `postalCode`    | Optional  | String. Postal code of the business address.                                                          |
| `uboNames`      | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. Shareholders on file are often other companies or holding entities rather than individuals, so this may not resolve to a real individual UBO name. |
| `directors`     | Optional  | Array. Full legal names of directors to check against records associated with the business.           |




### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Atlantica Energia SA",
  "houseNo": "45",
  "street": "Av. da Liberdade",
  "addressLine2": "",
  "city": "LISBOA",
  "state": "LISBOA",
  "postalCode": "1250-096",
  "country": "PT",
  "taxId": "500123456",
  "directors": ["Mariana Costa Ferreira"],
  "uboNames": [""]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Joint Stock Company" }
    },
    {
      "key": "directors_name_match",
      "sub_label": "Verified",
      "directorsName_input": "Mariana Costa Ferreira"
    }
  ]
}
```

### Response fields

| Key                     | Status                                    | Description                                                                                       |
| ------------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `name`                  | Verified, Approximate Match, Unverified      | Submitted business name against the single registered company name on file.                        |
| `tin`                   | Verified, Unverified                          | Submitted NIF against the registry.                                                                  |
| `address_verification`  | Verified, Approximate Match, Unverified      | Submitted address against the registered address on file. Matched as a fuzzy match on the full address. |
| `cityMatch`             | Verified, Approximate Match, Unverified      | Submitted city against the city on the registered address.                                          |
| `postalCodeMatch`       | Verified, Unverified                          | Submitted postal code against the postal code on the registered address.                            |
| `registrationStatus`    | Active, Inactive, Unknown                     | Registration status of the business. Values other than Active/Inactive returned by the source are mapped to Unknown. |
| `entityType`            | Legal entity type of the business             | The legal entity type of the business, if available. If not available, displays Unknown.             |
| `ubo_name_match`        | Verified, Approximate Match, Unverified      | Submitted UBO against shareholders associated with the business. Distinguished by the `uboName_input` field on each entry. Omitted entirely if the registry profile has no shareholder data. |
| `directors_name_match`  | Verified, Approximate Match, Unverified      | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. Omitted entirely if the registry profile has no director data. |

## Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

---

- Path: `general-reference/ekyb-prefill-api-reference`
- URL: https://developer.incode.com/general-reference/ekyb-prefill-api-reference/
- Markdown: https://developer.incode.com/general-reference/ekyb-prefill-api-reference.md

# eKYB Prefill API Reference

eKYB Prefill is a data enrichment solution that retrieves and returns business information from official sources of truth using a minimum set of inputs, typically a tax ID. Unlike Verification, which compares submitted data against official records, Prefill is a pure data-fetching solution: it returns available business data as-is, without performing fuzzy matching, transformations, or assessments.

Prefill is designed for use cases where you want to populate business information automatically before presenting it to the user or passing it downstream into your own business logic.

<Callout icon="📘" theme="info">
  ### How it differs from Verification

  [eKYB Verification](/general-reference/ekyb-verification-api-reference/) takes multiple inputs (business name, address, tax ID, UBOs, directors) and returns a `Verified` / `Approximate Match` / `Unverified` result for each field.

  eKYB Prefill takes a minimum input (tax ID + country) and returns raw business data retrieved from the source of truth (business name, entity type, registration status, incorporation date, and contact details) without performing any assessment on that data.
</Callout>

This page documents the request and response semantics shared across all eKYB Prefill sources. For source-specific request formats, response fields, and status values, see the country page for the country you are querying. The full list of country pages is on the [eKYB Prefill Coverage](/general-reference/ekyb-prefill-coverage/) page.

<Callout icon="📘" theme="info">
  ### API authentication

  All endpoints require authentication headers. See the [Incode API Documentation](/reference/introduction/) for details.
</Callout>

## Endpoint

`POST /omni/externalVerification/ekyb-prefill`

The endpoint retrieves business data from the source of truth for the specified tax ID and country.

See the OpenAPI reference for the endpoint schema.

## Request parameters

All four parameters are mandatory for every Prefill request.

| Field     | Data type    | Description                                                                                                                            |
| --------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins` | String array | Must be `["ekyb-prefill"]`. This value is static.                                                                                      |
| `source`  | String       | Identifies the Prefill data source to route the request. Value is country- and configuration-specific (for example, `MX_KYB_PREFILL`). |
| `country` | String       | Two-letter Alpha-2 country code (for example, `MX`).                                                                                   |
| `taxId`   | String       | Tax identifier for the business. Format requirements vary by country.                                                                  |

The `country` and `source` parameters are used together to route the request to the correct data source. Both are required for every Prefill request.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "MX_KYB_PREFILL",
    "country": "MX",
    "taxId": "ABC12345"
}
```

## Response

The response returns business data as retrieved from the source of truth. Fields are passed through without modification, matching, or scoring. The response structure uses the `kyb-prefill` key.

### Sample response

```json
{
  "kyb-prefill": [
    {
      "tin": "ABC12345",
      "name": "COMPANY NAME ABC",
      "entityType": "Company/Legal Entity",
      "registrationStatus": "Active",
      "taxIdEffectiveDate": "2025-07-17",
      "incorporationDate": "2025-05-29",
      "email": "example@domain.com"
    }
  ]
}
```

<Callout icon="📘" theme="info">
  ### Available fields vary by country

  The fields returned in the `kyb-prefill` response depend on what information is available from the source of truth for the requested country. Not all fields are available in all countries. See the country page for the exact response structure for that source.
</Callout>

## Error responses

For standard HTTP response codes, see the [API Error Response](/reference/introduction/#api-responses) page.

`taxId`**&#x20;is missing, empty, or in an invalid format for the requested country:**

```
message: BadRequestException: Invalid taxId.
```

`country`**&#x20;or&#x20;**`source`**&#x20;is missing or empty:**

```
message: BadRequestException: Missing required field.
```

Country-specific error responses may also apply. See the country page for the country-specific error responses returned by that source.


## Behavior and design considerations

### What Prefill returns

Prefill is scoped to fetching and returning data from the source of truth. It does not:

- Perform fuzzy matching or name comparison.
- Return `Verified` / `Approximate Match` / `Unverified` statuses.
- Accept or process address, UBO, or director inputs for matching.

Any editing, updating, or additional data collection from the user, and any subsequent business logic applied to the returned data, should be handled outside the Prefill service, within your own platform.

### Invalid or unavailable tax IDs

Two error scenarios are handled separately:

- **Tax ID is invalid**: The API returns a 400 error with an `Invalid taxId` message. The request is not forwarded to the source of truth.
- **Tax ID is valid but no data is returned**: The API returns an empty or partial response. Your platform should handle this case by allowing the user to fill in data manually, if applicable.

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-prefill-coverage`
- URL: https://developer.incode.com/general-reference/ekyb-prefill-coverage/
- Markdown: https://developer.incode.com/general-reference/ekyb-prefill-coverage.md

# eKYB Prefill Coverage

Incode eKYB Prefill returns verified business data from official registries and authoritative sources based on a submitted tax ID and business name. Prefill lowers end-user friction by pre-filling business details in the flow rather than requiring the end user to submit them.



## Country coverage

The following countries are currently supported for prefill. See each country's page for details on the source, request parameters, response fields, and more.

- [Australia](/general-reference/aus-kyb-prefill/) 
- [Austria](/general-reference/austria/)  
- [Belgium](/general-reference/belgium/)
- [France](/general-reference/france/) 
- [Germany](/general-reference/germany)
- [Greece](/general-reference/greece/)
- [India](/general-reference/india/)     
- [Ireland](/general-reference/ireland)  
- [Italy](/general-reference/italy)  
- [Mexico](/general-reference/ekyb-prefill-reference-mexico/)
- [Netherlands](/general-reference/netherlands)    
- [Portugal](/general-reference/portugal)
- [Saudi Arabia](/general-reference/saudi-arabia) 
- [Spain](/general-reference/spain)    
- [United Kingdom](/general-reference/united-kingdom) 
- [United States](/general-reference/us-prefill)

Don't see the country you need? [Get in touch with our sales team](https://incode.com/contact/) to discuss expanded coverage.

---

- Path: `general-reference/ekyb-prefill-reference-mexico`
- URL: https://developer.incode.com/general-reference/ekyb-prefill-reference-mexico/
- Markdown: https://developer.incode.com/general-reference/ekyb-prefill-reference-mexico.md

# Mexico

eKYB Prefill in Mexico leverages Mexico's source of truth to automatically retrieve and populate business information based on a company's RFC, including the business name, entity type, registration status, incorporation date, and contact details, without requiring manual input from the user.

## Source

| Country | Source           | Description                                                                           |
| ------- | ---------------- | ------------------------------------------------------------------------------------- |
| Mexico  | `MX_KYB_PREFILL` | Returns matching Mexican business details from Mexico's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required  | Description                                                                                          |
| --------- | --------- | ---------------------------------------------------------------------------------------------------- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow.                                |
| `source`  | Mandatory | String. Must be `MX_KYB_PREFILL`. Identifies the Prefill source.                                     |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `MX`.                                               |
| `taxId`   | Mandatory | String. RFC (Registro Federal de Contribuyentes). See [Tax ID formats](#tax-id-formats) for details. |

### Tax ID formats

RFC (Registro Federal de Contribuyentes) is the Mexican federal tax identifier. Input must be 12 or 13 alphanumeric characters. Requests with an invalid format return a 400 error.

| Entity Type  | Format                                                                                                                                                                                                                                                        |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Individual   | 12 characters: 4 letters + 6 digits + 3 alphanumeric characters (for example: `AIGB850818QJ9`)   |
| Legal entity | 13 characters: 3 letters + 6 digits + 3 alphanumeric characters (for example: `CSE250529PSA`)  |

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "MX_KYB_PREFILL",
    "country": "MX",
    "taxId": "ABCD123456789"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source, without fuzzy matching or verification scoring.

```json
{
  "kyb-prefill": [
    {
      "tin": "ABCD123456789",
      "name": "Company Name ABC",
      "entityType": "Company/Legal Entity",
      "registrationStatus": "Active",
      "taxIdEffectiveDate": "2025-07-17",
      "incorporationDate": "2025-05-29",
      "email": "sampleemail@gmail.com"
    }
  ]
}
```

<Callout icon="📘" theme="info">
  When an RFC is not found, the response returns a 200 status code with a message indicating the RFC could not be located. Not all keys are returned in this case. iness name, entity type, registration status, incorporation date, and contact details, without requiring manual input from the user.




</Callout>

### Response fields

| Key                  | Value                                       | Description                                                                                                             |
| -------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `tin`                | RFC number                                  | The tax ID submitted in the request, as returned and confirmed by the source of truth.                                  |
| `name`               | Business name                               | The registered legal name of the business as returned from the source of truth.                                         |
| `entityType`         | Entity type                                 | The legal entity type of the business (for example, `Company/Legal Entity`, `Individual/Sole Proprietorship`).          |
| `registrationStatus` | `Active`, `Expired`, `Unknown`, `Not Found` | Current registration status of the business. See [Registration status values](#registration-status-values) for details. |
| `taxIdEffectiveDate` | Date                                        | The date from which the RFC became effective.                                                                           |
| `incorporationDate`  | Date                                        | The date the business was incorporated.                                                                                 |
| `email`              | Email address                               | The business contact email address registered with the source of truth, if available.                                   |

### Registration status values

| Status    | Description                                                       |
| --------- | ----------------------------------------------------------------- |
| Active    | The RFC is currently registered and active (Vigente).             |
| Expired   | The RFC registration has lapsed (Expirado).                       |
| Unknown   | The registration status could not be determined.                  |
| Not Found | The RFC is inactive or could not be found in the source of truth. |

### Error responses

For standard HTTP response codes, see the API Error Response  page. Mexico Prefill returns the following country-specific 400 errors.

`taxId`**&#x20;is missing, empty, or not 12 to 13 alphanumeric characters:**

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "taxId must be a valid Mexican RFC: 12 or 13 alphanumeric characters (3-4 letters, 6 digits, 3 alphanumeric)",
    "message": "taxId must be a valid Mexican RFC: 12 or 13 alphanumeric characters (3-4 letters, 6 digits, 3 alphanumeric)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

**Any mandatory field (**`plugins`**,&#x20;**`source`**,&#x20;**`country`**, or&#x20;**`taxId`**) is missing:**

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

**Wrong country code is provided (any value other than&#x20;**`MX`**):**

```json
{
    "timestamp": 1782851583695,
    "status": 400,
    "error": "Bad Request",
    "message": "IllegalArgumentException: No enum constant com.incodesmile.onboarding.integration.external.government.ekyb.domain.entity.model.EkybCountry.CO",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-reference`
- URL: https://developer.incode.com/general-reference/ekyb-reference/
- Markdown: https://developer.incode.com/general-reference/ekyb-reference.md

# eKYB Reference

This section provides technical reference for the eKYB module: the countries supported, the request and response schemas, and the semantics of each response field for both Verification and Prefill solutions.

The [eKYB](/features-and-modules/ekyb/) module page covers what the module does at a conceptual level. This section covers the integration and API details for building against it.

## eKYB solutions

eKYB offers two solutions, each documented in its own sub-section:

- **eKYB Verification**: The end user submits business details, and the system verifies them against a source of truth. Returns match results for each submitted field along with enrichment details such as registration status and entity type.
- **eKYB Prefill**: An enrichment solution that lowers end-user friction. The end user submits only a tax ID and business name; the system looks up the business and returns matching business details for pre-fill.

Both solutions are configured on the same [eKYB Dashboard configuration](/dashboard-platform-administration/ekyb-dashboard/) page, on separate tabs.

## In this section

### eKYB Verification

- [eKYB Verification Coverage](/general-reference/ekyb-verification-coverage/): The full list of supported countries with the data attributes verifiable per country. Country pages linked from Coverage document the source of truth, request parameters, response fields, and status values specific to each country.
- [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/): Shared response field definitions, status value normalization, and error responses that apply across all eKYB Verification sources.

### eKYB Prefill

- [eKYB Prefill Coverage](/general-reference/ekyb-prefill-coverage/): The full list of supported countries for Prefill. Country pages linked from Coverage document the request parameters, response fields, and error responses specific to each country.
- [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/): Shared endpoint, request and response semantics, and error responses that apply across all eKYB Prefill sources.

<br />

---

- Path: `general-reference/ekyb-verification-api-reference`
- URL: https://developer.incode.com/general-reference/ekyb-verification-api-reference/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-api-reference.md

# eKYB Verification API Reference

This page documents the request and response semantics shared across all eKYB sources. For source-specific request parameters, response fields, and status values, see the country page for the country you are verifying. The full list of country pages is on the eKYB Coverage page.

<Callout icon="📘" theme="info">
  ### API authentication

  All endpoints require authentication headers. See the [Incode API Documentation](/reference/introduction/) for details.
</Callout>

## Endpoint

`POST /omni/externalVerification/ekyb`

The endpoint performs an eKYB check for the business specified. It can be called with an empty body `{}`, in which case information is pulled from the module configuration and session details. When called with a populated body, the submitted values override any pre-existing configuration and session data.

See the [OpenAPI reference](/reference/externalverificationekyb/) for the endpoint schema.

## Common request parameters

Most eKYB sources accept a common set of request parameters. Country-specific documentation lists which parameters are required, optional, or unsupported for a given country.

| Parameter      | Description                                                                                                  |
| -------------- | ------------------------------------------------------------------------------------------------------------ |
| `plugins`      | Array. Must be `["ekyb"]`.                                                                                   |
| `businessName` | Name of the business.                                                                                        |
| `country`      | Two-letter Alpha-2 country code identifying the country to verify against.                                   |
| `taxId`        | Tax identifier for the business. Naming, format, and validation rules vary by country.                       |
| `street`       | Street name of the business.                                                                                 |
| `houseNo`      | Building or house number.                                                                                    |
| `addressLine2` | Second line of the business address.                                                                         |
| `city`         | City in the business address.                                                                                |
| `state`        | State in the business address.                                                                               |
| `postalCode`   | Postal code, formatted per country conventions.                                                              |
| `uboNames`     | Array of full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Array of full legal names of directors to check against records associated with the business.                |

The `country` parameter limits business validation to the specified country. Only businesses established in the selected country are validated.

## Common response fields

Most eKYB sources return a common set of response fields. Which fields appear depends on the country and, in some cases, the verification variant (for example, US Advanced vs US Advanced+). The country page for each country lists the specific fields returned and their status values.

| Key                    | Description                                                                                                                                               |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | Match status for the submitted business name against the government source of truth.                                                                      |
| `tin`                  | Match status for the submitted tax ID against the government source of truth. May include `reasonCodes` indicating which tax ID type was verified.        |
| `address_verification` | Match status for the submitted address against the government source of truth.                                                                            |
| `cityMatch`            | Match status for the submitted city.                                                                                                                      |
| `postalCodeMatch`      | Match status for the submitted postal code.                                                                                                               |
| `registrationStatus`   | Registration status of the business in the government source of truth. Values vary by country; see country page for details.                              |
| `entityType`           | Legal entity type of the business, if available.                                                                                                          |
| `ubo_name_match`       | Match status for each submitted UBO name. When multiple UBOs are submitted, one entry appears per name, distinguished by `uboName_input`.                 |
| `directors_name_match` | Match status for each submitted director name. When multiple directors are submitted, one entry appears per name, distinguished by `directorsName_input`. |

Some sources return additional country-specific fields. For example:

- US Advanced+ returns `address_deliverability`, `address_property_type`, and `people`.
- Brazil returns a `kybSource.uboNames` array with the full list of UBOs stored in the CNPJ database, correlated to `ubo_name_match` entries via `nameId_match`.

Refer to the country page for the specific set of fields returned.

## Status value conventions

Match status values follow a general pattern across sources, but the exact set of values varies by country and field. Common patterns include:

| Value               | Meaning                                                                                      |
| ------------------- | -------------------------------------------------------------------------------------------- |
| `Verified`          | The submitted value matches the value in the source of truth.                                |
| `Approximate Match` | The submitted value is a close match under Incode's fuzzy matching algorithm, but not exact. |
| `Unverified`        | The submitted value does not match, or the source of truth has no data for this field.       |

The tax ID (`tin`) field may use `Found` / `Not Found` status values on some sources rather than the match values above. See the country page for the exact status values returned per source.

### Approximate Match

`Approximate Match` is generated through Incode's proprietary fuzzy matching algorithm. When returned, the algorithm has identified a close but not exact match between the submitted value and the value in the source of truth for a particular field. This value is returned when exact matches are not possible due to misspellings, typographical errors, or minor variations in input data.

## Error responses

For standard HTTP response codes for API request success or failure, see the [API Error Response](/reference/introduction/#api-responses) page.

Custom 400 error messages are returned when required fields are empty or null. The specific message varies by country and by which field is missing. Common patterns include:

- `businessName, taxId, and country are minimum required fields` (most countries)
- `taxId and country are minimum required fields` (some countries, including China)
- `BadRequestException: Invalid taxId` (India)
- `Country field is either not correct or available.` (India)

Refer to the country page for country-specific error message language.

---

- Path: `general-reference/ekyb-verification-coverage`
- URL: https://developer.incode.com/general-reference/ekyb-verification-coverage/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-coverage.md

# eKYB Verification Coverage

Incode eKYB Verification provides instant access to verified company information from official sources around the world. Coverage draws on company registries, ministries, SEC filings, government databases, and UBO records in 150+ countries.

:::info
Not all countries and data sources are currently live in production. Additional coverage can be enabled based on customer need and use case.
:::

<Accordion title="Global Coverage Table">

| Country | Business Name | Reg. Status | Legal Entity | Tax ID | Address | UBOs / Directors |
|---|---|---|---|---|---|---|
| 🇦🇫 Afghanistan (AF) | Yes | No | No | No | Yes | Yes |
| 🇦🇱 Albania (AL) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇩🇿 Algeria (DZ) | Yes | Yes | No | No | Yes | Yes |
| 🇦🇴 Angola (AO) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇮 Anguilla (AI) | Yes | Yes | Yes | No | Yes | Yes |
| 🇦🇬 Antigua and Barbuda (AG) | Yes | No | No | No | Yes | No |
| 🇦🇷 Argentina (AR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇲 Armenia (AM) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇼 Aruba (AW) | Yes | Yes | No | No | Yes | No |
| 🇦🇺 Australia (AU) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇹 Austria (AT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇿 Azerbaijan (AZ) | Yes | No | No | Yes | Yes | Yes |
| 🇧🇸 Bahamas (BS) | Yes | No | No | No | Yes | Yes |
| 🇧🇭 Bahrain (BH) | Yes | Yes | Yes | No | Yes | Yes |
| 🇧🇩 Bangladesh (BD) | Yes | No | Yes | No | Yes | Yes |
| 🇧🇧 Barbados (BB) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇾 Belarus (BY) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇪 Belgium (BE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇿 Belize (BZ) | Yes | Yes | Yes | No | No | No |
| 🇧🇯 Benin (BJ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇲 Bermuda (BM) | Yes | No | Yes | No | No | No |
| 🇧🇹 Bhutan (BT) | Yes | Yes | No | No | Yes | Yes |
| 🇧🇴 Bolivia (BO) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇶 Bonaire (BQ) | Yes | Yes | Yes | No | No | No |
| 🇧🇦 Bosnia and Herzegovina (BA) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇼 Botswana (BW) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇷 Brazil (BR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇻🇬 British Virgin Islands (VG) | Yes | Yes | Yes | No | Yes | No |
| 🇧🇳 Brunei (BN) | Yes | Yes | Yes | No | Yes | Yes |
| 🇧🇬 Bulgaria (BG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇫 Burkina Faso (BF) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇮 Burundi (BI) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇭 Cambodia (KH) | Yes | Yes | No | Yes | Yes | Yes |
| 🇨🇲 Cameroon (CM) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇦 Canada (CA) | Yes | Yes | Yes | Yes | Yes | No |
| 🇨🇻 Cape Verde (CV) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇾 Cayman Islands (KY) | Yes | Yes | Yes | No | Yes | Yes |
| 🇨🇫 Central African Republic (CF) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇹🇩 Chad (TD) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇱 Chile (CL) | Yes | No | No | Yes | Yes | Yes |
| 🇨🇳 China (CN) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇴 Colombia (CO) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇲 Comoros (KM) | Yes | Yes | No | No | No | No |
| 🇨🇬 Congo (CG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇰 Cook Islands (CK) | Yes | Yes | Yes | No | No | Yes |
| 🇨🇷 Costa Rica (CR) | Yes | No | No | Yes | Yes | Yes |
| 🇭🇷 Croatia (HR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇺 Cuba (CU) | Yes | No | Yes | No | No | Yes |
| 🇨🇼 Curacao (CW) | Yes | No | No | No | Yes | Yes |
| 🇨🇾 Cyprus (CY) | Yes | Yes | Yes | No | Yes | Yes |
| 🇨🇿 Czechia (CZ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇩🇰 Denmark (DK) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇩🇯 Djibouti (DJ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇩🇲 Dominica (DM) | Yes | No | Yes | No | Yes | Yes |
| 🇩🇴 Dominican Republic (DO) | Yes | No | No | No | No | Yes |
| 🇹🇱 East Timor (TL) | Yes | No | No | Yes | No | Yes |
| 🇪🇨 Ecuador (EC) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇬 Egypt (EG) | Yes | No | No | No | Yes | Yes |
| 🇸🇻 El Salvador (SV) | Yes | No | No | No | Yes | Yes |
| 🇬🇶 Equatorial Guinea (GQ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇷 Eritrea (ER) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇪 Estonia (EE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇹 Ethiopia (ET) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇫🇰 Falkland Islands (FK) | Yes | No | No | No | No | No |
| 🇫🇯 Fiji Islands (FJ) | Yes | Yes | Yes | No | Yes | Yes |
| 🇫🇮 Finland (FI) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇫🇷 France (FR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇵 France Guadeloupe, French Guiana (GP) | Yes | Yes | No | Yes | Yes | Yes |
| 🇬🇦 Gabon (GA) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇲 Gambia (GM) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇪 Georgia (GE) | Yes | Yes | Yes | No | Yes | Yes |
| 🇩🇪 Germany (DE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇭 Ghana (GH) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇷 Greece (GR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇩 Grenada (GD) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇹 Guatemala (GT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇳 Guinea (GN) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇼 Guinea-Bissau (GW) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇬🇾 Guyana (GY) | Yes | No | No | No | Yes | Yes |
| 🇭🇹 Haiti (HT) | Yes | No | No | No | Yes | No |
| 🇭🇳 Honduras (HN) | Yes | No | Yes | No | Yes | Yes |
| 🇭🇰 Hong Kong (HK) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇭🇺 Hungary (HU) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇮🇸 Iceland (IS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇮🇳 India (IN) | Yes | Yes | Yes | Yes | Yes | No |
| 🇮🇩 Indonesia (ID) | Yes | Yes | Yes | No | Yes | No |
| 🇮🇷 Iran (IR) | Yes | No | No | No | Yes | No |
| 🇮🇶 Iraq (IQ) | Yes | Yes | No | No | Yes | Yes |
| 🇮🇪 Ireland (IE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇮🇱 Israel (IL) | Yes | Yes | Yes | No | Yes | Yes |
| 🇮🇹 Italy (IT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇮 Ivory Coast (CI) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇯🇲 Jamaica (JM) | Yes | Yes | Yes | No | No | Yes |
| 🇯🇵 Japan (JP) | Yes | Yes | Yes | Yes | Yes | No |
| 🇯🇴 Jordan (YO) | Yes | Yes | Yes | No | Yes | Yes |
| 🇰🇿 Kazakhstan (KZ) | Yes | No | Yes | Yes | Yes | Yes |
| 🇰🇪 Kenya (KE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇮 Kiribati (KI) | Yes | No | Yes | No | Yes | Yes |
| 🇽🇰 Kosovo (XK) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇼 Kuwait (KW) | Yes | No | No | No | Yes | Yes |
| 🇰🇬 Kyrgyzstan (KG) | Yes | Yes | Yes | No | Yes | Yes |
| 🇱🇦 Laos (LA) | Yes | Yes | No | Yes | Yes | Yes |
| 🇱🇻 Latvia (LV) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇧 Lebanon (LB) | Yes | No | No | No | Yes | Yes |
| 🇱🇸 Lesotho (LS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇷 Liberia (LR) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇾 Libya (LY) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇮 Liechtenstein (LI) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇹 Lithuania (LT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇺 Luxembourg (LU) | Yes | Yes | Yes | Yes | Yes | No |
| 🇲🇴 Macau S.A.R (MO) | Yes | Yes | No | No | Yes | Yes |
| 🇲🇰 Macedonia (MK) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇬 Madagascar (MG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇼 Malawi (MW) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇾 Malaysia (MY) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇱 Mali (ML) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇹 Malta (MT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇭 Marshall Islands (MH) | Yes | Yes | Yes | No | Yes | Yes |
| 🇲🇺 Mauritius (MU) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇾🇹 Mayotte (YT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇽 Mexico (MX) | Yes | No | No | No | P | No |
| 🇫🇲 Micronesia (FM) | Yes | No | No | No | Yes | Yes |
| 🇲🇩 Moldova (MD) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇳 Mongolia (MN) | Yes | Yes | Yes | No | Yes | Yes |
| 🇲🇪 Montenegro (ME) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇸 Montserrat (MS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇦 Morocco (MA) | Yes | Yes | No | No | No | Yes |
| 🇲🇿 Mozambique (MZ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇲 Myanmar (MM) | Yes | Yes | Yes | No | No | Yes |
| 🇳🇦 Namibia (NA) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇳🇵 Nepal (NP) | Yes | Yes | Yes | No | Yes | Yes |
| 🇳🇨 New Caledonia (NC) | Yes | Yes | Yes | No | No | No |
| 🇳🇿 New Zealand (NZ) | Yes | Yes | Yes | No | Yes | Yes |
| 🇳🇮 Nicaragua (NI) | Yes | Yes | No | No | No | No |
| 🇳🇪 Niger (NE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇳🇬 Nigeria (NG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇳🇴 Norway (NO) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇴🇲 Oman (OM) | Yes | Yes | Yes | No | Yes | Yes |
| 🇵🇰 Pakistan (PK) | Yes | Yes | No | No | No | Yes |
| 🇵🇼 Palau (PW) | Yes | Yes | Yes | No | Yes | Yes |
| 🇵🇸 Palestine (PS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇦 Panama (PA) | Yes | No | No | No | No | Yes |
| 🇵🇬 Papua New Guinea (PG) | Yes | Yes | Yes | No | Yes | Yes |
| 🇵🇾 Paraguay (PY) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇪 Peru (PE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇭 Philippines (PH) | Yes | Yes | Yes | Yes | Yes | No |
| 🇵🇱 Poland (PL) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇹 Portugal (PT) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇷 Puerto Rico (PR) | Yes | Yes | Yes | No | Yes | Yes |
| 🇶🇦 Qatar (QA) | Yes | Yes | No | No | Yes | Yes |
| 🇷🇪 Reunion (RE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇷🇴 Romania (RO) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇷🇺 Russia (RU) | Yes | Yes | No | Yes | Yes | Yes |
| 🇷🇼 Rwanda (RW) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇧🇱 Saint Barthelemy (BL) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇭 Saint Helena (SH) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇳 Saint Kitts & Nevis (KN) | Yes | No | No | No | Yes | Yes |
| 🇱🇨 Saint Lucia (LC) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇲🇫 Saint Martin (MF) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇵🇲 Saint Pierre & Miquelon (PM) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇻🇨 Saint Vincent & the Grenadines (VC) | Yes | Yes | Yes | No | Yes | No |
| 🇼🇸 Samoa (WS) | Yes | Yes | Yes | No | Yes | Yes |
| 🇸🇹 Sao Tome and Principe (ST) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇦 Saudi Arabia (SA) | Yes | Yes | Yes | No | Yes | Yes |
| 🇸🇳 Senegal (SN) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇷🇸 Serbia (RS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇨 Seychelles (SC) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇱 Sierra Leone (SL) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇬 Singapore (SG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇽 Sint Maarten (SX) | Yes | No | No | No | Yes | Yes |
| 🇸🇰 Slovakia (SK) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇮 Slovenia (SI) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇧 Solomon Islands (SB) | Yes | No | No | No | No | Yes |
| 🇸🇴 Somalia (SO) | Yes | No | No | No | No | No |
| 🇿🇦 South Africa (ZA) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇰🇷 South Korea (KR) | Yes | No | No | Yes | Yes | Yes |
| 🇸🇸 South Sudan (SS) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇸 Spain (ES) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇱🇰 Sri Lanka (LK) | Yes | No | No | No | Yes | Yes |
| 🇸🇩 Sudan (SD) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇷 Suriname (SR) | Yes | No | No | No | Yes | No |
| 🇸🇿 Swaziland (SZ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇪 Sweden (SE) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇨🇭 Switzerland (CH) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇸🇾 Syria (SY) | Yes | No | No | No | Yes | Yes |
| 🇹🇼 Taiwan (TW) | Yes | Yes | Yes | No | Yes | Yes |
| 🇹🇯 Tajikistan (TJ) | Yes | Yes | Yes | No | Yes | Yes |
| 🇹🇿 Tanzania (TZ) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇹🇭 Thailand (TH) | Yes | Yes | Yes | Yes | Yes | No |
| 🇹🇬 Togo (TG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇹🇴 Tonga (TO) | Yes | Yes | No | No | Yes | Yes |
| 🇹🇹 Trinidad & Tobago (TT) | Yes | Yes | Yes | No | No | No |
| 🇹🇳 Tunisia (TN) | Yes | Yes | No | No | Yes | Yes |
| 🇹🇷 Turkey (TR) | Yes | No | No | Yes | Yes | Yes |
| 🇹🇲 Turkmenistan (TM) | Yes | No | No | No | Yes | No |
| 🇹🇨 Turks and Caicos Islands (TC) | Yes | No | No | No | No | No |
| 🇺🇬 Uganda (UG) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇺🇦 Ukraine (UA) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇦🇪 United Arab Emirates (AE) | Yes | Yes | Yes | No | Yes | Yes |
| 🇬🇧 United Kingdom (GB) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇺🇸 United States of America (US) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇺🇾 Uruguay (UY) | Yes | No | No | No | No | Yes |
| 🇻🇮 US Virgin Islands (VI) | Yes | Yes | Yes | No | Yes | Yes |
| 🇺🇿 Uzbekistan (UZ) | Yes | No | No | No | Yes | Yes |
| 🇻🇺 Vanuatu (VU) | Yes | Yes | Yes | No | Yes | Yes |
| 🇻🇪 Venezuela (VE) | Yes | No | No | Yes | No | No |
| 🇻🇳 Vietnam (VN) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇪🇭 Western Sahara (EH) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇾🇪 Yemen (YE) | Yes | No | Yes | No | No | No |
| 🇿🇲 Zambia (ZM) | Yes | Yes | Yes | Yes | Yes | Yes |
| 🇿🇼 Zimbabwe (ZW) | Yes | Yes | Yes | Yes | Yes | Yes |

</Accordion>

## Country-specific guidelines

The following countries have dedicated documentation with source-specific integration and API details:

- [Brazil](/general-reference/ekyb-verification-reference-brazil/)
- [Bulgaria](/general-reference/ekyb-verification-reference-bulgaria/)
- [Cameroon](/general-reference/ekyb-verification-reference-cameroon/)
- [China](/general-reference/ekyb-verification-reference-china/)
- [Denmark](/general-reference/ekyb-verification-reference-denmark/)
- [France](/general-reference/ekyb-verification-reference-france/)
- [Germany](/general-reference/ekyb-verification-reference-germany/)
- [Greece](/general-reference/ekyb-greece/)
- [Hong Kong](/general-reference/ekyb-verification-reference-hong-kong/)
- [India](/general-reference/ekyb-verification-reference-india/)
- [Ireland](/general-reference/ireland-ekyb/)
- [Israel](/general-reference/ekyb-verification-reference-israel/)
- [Italy](/general-reference/ekyb-verification-reference-italy/)
- [Kenya](/general-reference/ekyb-verification-reference-kenya/)
- [Malta](/general-reference/ekyb-verification-reference-malta/)
- [Mexico](/general-reference/ekyb-verification-reference-mexico/)
- [Netherlands](/general-reference/ekyb-verification-reference-netherlands/)
- [Nigeria](/general-reference/ekyb-verification-reference-nigeria/)
- [Portugal](/general-reference/ekyb-portugal/)
- [Spain](/general-reference/ekyb-verification-reference-spain/)
- [United Kingdom](/general-reference/ekyb-verification-reference-united-kingdom/)
- [United States](/general-reference/ekyb-verification-reference-united-states/)

---

- Path: `general-reference/ekyb-verification-reference-brazil`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-brazil/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-brazil.md

# Brazil

Brazil eKYB validates the legitimacy of Brazilian businesses by checking their tax ID, business name, address, and UBOs against the Brazilian government CNPJ database.

Directors are not currently supported for Brazil. 

## Source

| Country | Source                             | Description                                                                          |
| ------- | ---------------------------------- | ------------------------------------------------------------------------------------ |
| Brazil  | Brazilian government CNPJ database | Verifies submitted business details against records maintained in the CNPJ registry. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                            |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------ |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                             |
| `businessName` | Mandatory | String. Name of the business.                                                                          |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `BR`.                                                 |
| `taxId`        | Mandatory | String. CNPJ (14 digits, usually written as `12.345.678/9012-34`).                                     |
| `street`       | Optional  | String. Street name of the business.                                                                   |
| `houseNo`      | Optional  | String. Building or house number.                                                                      |
| `addressLine2` | Optional  | String. Second line of the business address.                                                           |
| `city`         | Optional  | String. City in the business address.                                                                  |
| `state`        | Optional  | String. State in the business address.                                                                 |
| `postalCode`   | Optional  | String. 8-digit Brazilian postal code.                                                                 |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the CNPJ. |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "RENATA DISTR. DE SUPLEMENTOS LTDA",
  "street": "Rua Curupaiti",
  "houseNo": "225",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "postalCode": "20735320",
  "country": "BR",
  "taxId": "41111051548164",
  "uboNames": ["MICHEL RODRIGUES", "ERIC SANTOS", "MICHELLE MUNHOZ"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Sociedade Empresária Limitada" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "MICHEL RODRIGUES", "nameId_match": "2" },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "ERIC SANTOS", "nameId_match": "1" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "MICHELLE MUNHOZ", "nameId_match": "-1" }
  ],
  "kybSource": {
    "uboNames": [
      { "id": "1", "uboName": "ERIC SANTOS" },
      { "id": "2", "uboName": "MICHEL RODRIGUES" }
    ]
  }
}
```

The `nameId_match` value on each `ubo_name_match` entry correlates to the `id` in the `kybSource.uboNames` array. A `nameId_match` of `-1` indicates no match to any UBO in the source of truth.

### Response fields

| Key                    | Status                                                           | Description                                                                                                                               |
| ---------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified`                    | Submitted business name against the business name associated with the CNPJ.                                                               |
| `tin`                  | `Verified`, `Unverified`                                         | Submitted CNPJ against the government CNPJ database.                                                                                      |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified`                    | Submitted address against the address associated with the CNPJ.                                                                           |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified`                    | Submitted city against the city associated with the CNPJ.                                                                                 |
| `postalCodeMatch`      | `Verified`, `Unverified`                                         | Submitted postal code against the postal code associated with the CNPJ.                                                                   |
| `registrationStatus`   | `Active`, `Suspended`, `Null`, `Unfit`, `Written off`, `Unknown` | Registration status of the business in the CNPJ database. See [Registration status values](#registration-status-values) for definitions.  |
| `entityType`           | Legal entity type of the business                                | The legal entity type of the company, if available. If not available, displays `Unknown`.                                                 |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified`                    | Submitted UBO against UBOs associated with the CNPJ. Distinguished by the `uboName_input` field on each entry.                            |
| `kybSource.uboNames`   | Array of UBO records                                             | Full list of UBOs stored in the CNPJ database for the business.                                                                           |

### Registration status values

| Status      | Description                                                                                                                                                                                                                                                            |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Active      | The CNPJ is active.                                                                                                                                                                                                                                                    |
| Suspended   | The company did not comply with tax obligations, presented data issues to the Federal Revenue Service, or is under investigation for possible fraud.                                                                                                                   |
| Null        | The CNPJ is invalid, typically due to registration problems in other instances such as a duplicate State Registration.                                                                                                                                                 |
| Unfit       | Tax irregularity or omission of company tax information caused the Federal Revenue Service to reclassify the CNPJ as Unfit until regularization is made.                                                                                                               |
| Written off | The Federal Revenue Service considers the company written off or cancelled. This can occur due to closure of the company's activities, serious tax irregularities, failure to submit mandatory declarations, or voluntary request for dismissal by the company itself. |
| Unknown     | Registration status is not available.                                                                                                                                                                                                                                  |

### Address `unabletoverify` note

Address-based fields on Brazil eKYB may return `unabletoverify` for `taxIdStateMatch`, `taxIdAddressMatch`, `taxIdCityMatch`, and `taxIdPostalCodeMatch`. This is because addresses are validated through the driver's license (CNH) Brazilian government source of truth. If the individual associated with the business does not have a CNH on file, address components cannot be validated.&#x20;

### Reason codes

The following reason codes may appear on Brazil eKYB responses:

| Reason Code | Description                                                                                                                                       |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| ASDL        | Unable to verify address because CPF consulted does not have a CNH in the official government database.                                           |
| TSRF        | Tax ID Status (situação CPF) is not regular. It is suspended or canceled due to pending regularization, being null, or the holder being deceased. |
| TSR         | Tax ID Status (situação CPF) is regular.                                                                                                          |
| TSRP        | Tax ID Status is pending regularization.                                                                                                          |
| TNPIN       | Tax ID check was not performed due to invalid nationality.                                                                                        |
| TLGPD       | Tax ID check was not performed due to LGPD: minor's data.                                                                                         |
| ASCV        | State and country validated.                                                                                                                      |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).&#x20;

---

- Path: `general-reference/ekyb-verification-reference-bulgaria`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-bulgaria/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-bulgaria.md

# Bulgaria

Bulgaria eKYB validates the legitimacy of Bulgarian businesses by checking their tax ID (UIC/EIK number), business name, address, UBOs, and directors against Bulgaria's government database.

## Source

| Country  | Source                        | Description                                                                                |
| -------- | ----------------------------- | ------------------------------------------------------------------------------------------ |
| Bulgaria | Bulgarian government database | Verifies submitted business details against records maintained in the government database. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                                                        |
| -------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                                                         |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `BG`.                                                                                                                                             |
| `taxId`        | Mandatory | String. Bulgarian UIC/EIK number. Accepted formats: 9 digits (e.g. `123456789`), or `BG` + 9 digits (VAT format, e.g. `BG123456789`). The `BG` prefix is stripped automatically before processing. |
| `businessName` | Optional  | String. Registered name of the business.                                                                                                                                                           |
| `street`       | Optional  | String. Street name of the business.                                                                                                                                                               |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                                                                  |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                                                                       |
| `city`         | Optional  | String. City in the business address.                                                                                                                                                              |
| `state`        | Optional  | String. State or region in the business address.                                                                                                                                                   |
| `postalCode`   | Optional  | String. 4-digit Bulgarian postal code (e.g. `1000`).                                                                                                                                               |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the UIC/EIK.                                                                                          |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the UIC/EIK.                                                                                                         |

The `country` parameter limits business validation to the specified region. Only businesses established in the country specified in the eKYB request are validated.

### Sample request

```json
{
  "plugins": ["ekyb"],
  "country": "BG",
  "taxId": "123456789",
  "businessName": "EXAMPLE BULGARIA OOD",
  "street": "VITOSHA BLVD",
  "houseNo": "10",
  "city": "SOFIA",
  "postalCode": "1000",
  "uboNames": ["MARIA GEORGIEVA"],
  "directors": ["IVAN PETROV IVANOV"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Approximate Match" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited with Share Capital" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "Maria Georgieva" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Ivan Petrov Ivanov" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                                                                                              |
| ---------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the UIC/EIK.                                                                                                           |
| `tin`                  | `Verified`, `Unverified`                      | Submitted UIC/EIK number against the government database.                                                                                                                                |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the UIC/EIK.                                                                                                                       |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the UIC/EIK.                                                                                                                             |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the UIC/EIK. Always 4 digits for Bulgaria.                                                                                 |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business in the government database. See [Registration status values](#registration-status-values) for definitions.                                           |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available (e.g. Private limited with Share Capital, Limited liability company with one shareholder only). If not available, displays `Unknown`. |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the UIC/EIK. Distinguished by the `uboName_input` field on each entry.                                                                        |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the UIC/EIK. Distinguished by the `directorsName_input` field on each entry.                                                        |

### Registration status values

| Status   | Description                                                                         |
| -------- | ----------------------------------------------------------------------------------- |
| Active   | The business registration is active.                                                |
| Inactive | The business registration is suspended, inactive, or the business no longer exists. |
| Unknown  | Registration status is not available.                                               |

### Approximate Match

`Approximate Match` is generated through Incode's proprietary fuzzy matching algorithm. It is returned when the submitted string is similar to, but not an exact match for, the value stored in the government database. This accounts for misspellings, typographical errors, and slight variations in input data.

### Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-cameroon`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-cameroon/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-cameroon.md

# Cameroon

Cameroon eKYB validates the legitimacy of Cameroonian businesses by checking their tax ID, business name, and address against Cameroonian government sources of truth.

<Callout icon="⚠️" theme="warn">
  Cameroon eKYB is currently available only in the Incode demo environment, not in production. Contact Incode support for availability.
</Callout>

UBOs and directors are not currently supported for Cameroon.&#x20;

## Source

| Country  | Source                                  | Description                                                                                |
| -------- | --------------------------------------- | ------------------------------------------------------------------------------------------ |
| Cameroon | Cameroonian government sources of truth | Verifies submitted business details against records maintained in Cameroonian registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                            |
| -------------- | --------- | ---------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                             |
| `businessName` | Mandatory | String. Name of the business.                                          |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `CM`.                 |
| `taxId`        | Mandatory | String. NIF (Numéro d'Identification Fiscale). Typically alphanumeric. |
| `street`       | Optional  | String. Street name of the business.                                   |
| `houseNo`      | Optional  | String. Building or house number.                                      |
| `addressLine2` | Optional  | String. Second line of the business address.                           |
| `city`         | Optional  | String. City in the business address.                                  |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Equatorial Beverages Ltd.",
  "street": "Rue de la République, Bonanjo",
  "city": "Douala",
  "country": "CM",
  "taxId": "CM0000087219"
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    { "key": "entityType", "sub_label": "Société à Responsabilité Limitée (SARL)" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                     |
| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                   |
| `tin`                  | `Found`, `Not Found`                          | Submitted tax ID against the government database.                                                               |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                               |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                     |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                       |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-china`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-china/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-china.md

# China

China eKYB validates the legitimacy of Chinese businesses by checking their tax ID, business name, address, and UBOs against Chinese government sources of truth.

China eKYB supports input in Chinese, English, and Pinyin.

Directors are not currently supported for China.&#x20;

## Source

| Country | Source                              | Description                                                                            |
| ------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| China   | Chinese government sources of truth | Verifies submitted business details against records maintained in Chinese registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `CN`.                                                     |
| `taxId`        | Mandatory | String. Unified Social Credit Code, 18 characters.                                                         |
| `addressLine2` | Optional  | String. Full business address including house number, street, city, state, and postal code.                |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "SHANGHAI JINLONG TECHNOLOGY CO., LTD.",
  "addressLine2": "Pudong New Area, Zhangyang Road 88, Shanghai 200120",
  "country": "CN",
  "taxId": "91310000MA1K123456",
  "uboNames": ["Li Wei", "Zhang Mei"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Limited Liability Company (Sole Proprietorship by a Natural Person)" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "Li Wei" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Zhang Mei" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                        |
| ---------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                      |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                  |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                  |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.    |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                          |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-denmark`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-denmark/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-denmark.md

# Denmark

Denmark eKYB validates the legitimacy of Danish businesses by checking their tax ID (CVR number), business name, address, UBOs, and directors against Denmark's government database.

## Source

| Country | Source                     | Description                                                                                |
| ------- | -------------------------- | ------------------------------------------------------------------------------------------ |
| Denmark | Danish government database | Verifies submitted business details against records maintained in the government database. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                                               |
| -------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                                                |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `DK`.                                                                                                                                    |
| `taxId`        | Mandatory | String. Danish CVR number. Accepted formats: 8 digits (e.g. `12345678`), or `DK` + 8 digits (VAT format, e.g. `DK12345678`). The `DK` prefix is stripped automatically before processing. |
| `businessName` | Optional  | String. Registered name of the business.                                                                                                                                                  |
| `street`       | Optional  | String. Street name of the business.                                                                                                                                                      |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                                                         |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                                                              |
| `city`         | Optional  | String. City in the business address.                                                                                                                                                     |
| `state`        | Optional  | String. State or region in the business address.                                                                                                                                          |
| `postalCode`   | Optional  | String. 4-digit Danish postal code (e.g. `1050`).                                                                                                                                         |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the CVR number.                                                                              |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the CVR number.                                                                                             |

The `country` parameter limits business validation to the specified region. Only businesses established in the country specified in the eKYB request are validated.

### Sample request

```json
{
  "plugins": ["ekyb"],
  "country": "DK",
  "taxId": "12345678",
  "businessName": "EXAMPLE DENMARK A/S",
  "street": "STRØGET",
  "houseNo": "10",
  "city": "COPENHAGEN",
  "postalCode": "1050",
  "uboNames": ["JOHN DOE", "SARAH SMITH"],
  "directors": ["LARS NIELSEN"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Approximate Match" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Public Limited Company (A/S)" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "John Doe" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                                                    |
| ---------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the CVR number.                                                              |
| `tin`                  | `Verified`, `Unverified`                      | Submitted CVR number against the government database.                                                                                          |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the CVR number.                                                                          |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the CVR number.                                                                                |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the CVR number. Always 4 digits for Denmark.                                     |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business in the government database. See [Registration status values](#registration-status-values) for definitions. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available (e.g. Public Limited Company (A/S), Limited company). If not available, displays `Unknown`. |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the CVR number. Distinguished by the `uboName_input` field on each entry.                           |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the CVR number. Distinguished by the `directorsName_input` field on each entry.           |

### Registration status values

| Status   | Description                                                                         |
| -------- | ----------------------------------------------------------------------------------- |
| Active   | The business registration is active.                                                |
| Inactive | The business registration is suspended, inactive, or the business no longer exists. |
| Unknown  | Registration status is not available.                                               |

### Approximate Match

`Approximate Match` is generated through Incode's proprietary fuzzy matching algorithm. It is returned when the submitted string is similar to, but not an exact match for, the value stored in the government database. This accounts for misspellings, typographical errors, and slight variations in input data.

### Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

Custom 400 responses include `BadRequestException: Invalid taxId.` when `taxId` is missing or malformed.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-france`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-france/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-france.md

# France

France eKYB validates the legitimacy of French businesses by checking their tax ID, business name, address, UBOs, and directors against French government sources of truth.

## Source

| Country | Source                             | Description                                                                           |
| ------- | ---------------------------------- | ------------------------------------------------------------------------------------- |
| France  | French government sources of truth | Verifies submitted business details against records maintained in French registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `FR`.                                                     |
| `taxId`        | Mandatory | String. Accepts SIREN, SIRET, RCS, RC (local numbers), or VAT Number. Format varies by type.               |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. French postal code.                                                                                |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "AUCHAN RETAIL INTERNATIONAL",
  "street": "RUE MAL DE LATTRE DE TASSIGNY",
  "city": "CROIX",
  "postalCode": "59170",
  "country": "FR",
  "taxId": "XXXXXXXXX",
  "uboNames": ["LLO", "Sarah Smith"],
  "directors": ["Andrew Martin", "Sarah Schrader"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Limited Liability Granting Company" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "LLO" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-germany`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-germany/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-germany.md

# Germany

Germany eKYB validates the legitimacy of German businesses by checking their tax ID, business name, address, UBOs, and directors against German government sources of truth.

## Source

| Country | Source                             | Description                                                                           |
| ------- | ---------------------------------- | ------------------------------------------------------------------------------------- |
| Germany | German government sources of truth | Verifies submitted business details against records maintained in German registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                 |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                  |
| `businessName` | Mandatory | String. Name of the business.                                                                                                               |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `DE`.                                                                                      |
| `taxId`        | Mandatory | String. Accepts VAT (`DE + 9 digits`), SafeNo (`DE + 8 digits`), or Reg No (HRB or HRA). See [Tax ID formats](#tax-id-formats) for details. |
| `street`       | Optional  | String. Street name of the business.                                                                                                        |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                           |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                |
| `city`         | Optional  | String. City in the business address.                                                                                                       |
| `state`        | Optional  | String. State in the business address.                                                                                                      |
| `postalCode`   | Optional  | String. 5-digit German postal code.                                                                                                         |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business.                                  |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                                                 |

### Tax ID formats

| Tax ID Type         | Format                                                                                                           |
| ------------------- | ---------------------------------------------------------------------------------------------------------------- |
| VAT                 | `DE` + 9 digits                                                                                                  |
| SafeNo              | `DE` + 8 digits                                                                                                  |
| Reg No (HRB or HRA) | `HRB` + 3-6 digits, `HRB` + 6 digits + letter, `HRA` + 4-6 digits, or 4-6 digits (handled as `HRB` + 4-6 digits) |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "BERLIN TECH SOLUTIONS GMBH",
  "street": "Kurfürstendamm",
  "houseNo": "182",
  "addressLine2": "Charlottenburg-Wilmersdorf",
  "city": "Berlin",
  "state": "Berlin",
  "postalCode": "10707",
  "country": "DE",
  "taxId": "123456789",
  "uboNames": ["John Schmidt", "Emily Bauer"],
  "directors": ["David Meyer", "Anna Weber"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "General Partnership" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "John Schmidt" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Emily Bauer" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "David Meyer" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Anna Weber" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-hong-kong`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-hong-kong/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-hong-kong.md

# Hong Kong

Hong Kong eKYB validates the legitimacy of Hong Kong businesses by checking their tax ID (CR number), business name, address, UBOs, and directors against Hong Kong's government database.

Incode supports input in Chinese, English, and Pinyin.

## Source

| Country   | Source                        | Description                                                                                |
| --------- | ----------------------------- | ------------------------------------------------------------------------------------------ |
| Hong Kong | Hong Kong government database | Verifies submitted business details against records maintained in the government database. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                                                              |
| -------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                                                               |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `HK`.                                                                                                                                                   |
| `taxId`        | Mandatory | String. Hong Kong CR number (8 digits, e.g. `12345678`). Extended formats such as `12345678-000-09-20-3`, `12345678-000-11-23-A`, and `1234567800007210` are accepted; only the first 8 digits are used. |
| `businessName` | Mandatory | String. Name of the business.                                                                                                                                                                            |
| `addressLine2` | Optional  | String. Full business address, including house number, street, city, state, and postal code.                                                                                                             |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the CR number.                                                                                              |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the CR number.                                                                                                             |

The `country` parameter limits business validation to the specified region. Only businesses established in the country specified in the eKYB request are validated.

### Sample request

```json
{
  "plugins": ["ekyb"],
  "country": "HK",
  "taxId": "12345678",
  "businessName": "Dummy Company Limited",
  "addressLine2": "105-111 MAIN ROAD, WAN CHAI, Hong Kong, 999077",
  "uboNames": ["Lin Xi Wein"],
  "directors": ["Andrew Chang"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private company limited by shares" }
    },
    {
      "key": "ubo_name_match",
      "sub_label": "Verified",
      "uboName_input": "Li Xi Wein",
      "ubo_ownership": "100.00%"
    },
    {
      "key": "directors_name_match",
      "sub_label": "Unverified",
      "directorsName_input": "Andrei Blang"
    }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                                                    |
| ---------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the CR number.                                                               |
| `tin`                  | `Verified`, `Unverified`                      | Submitted CR number against the government database.                                                                                           |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the CR number.                                                                           |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business in the government database. See [Registration status values](#registration-status-values) for definitions. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available (e.g. Private company limited by shares). If not available, displays `Unknown`.             |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the CR number. Distinguished by the `uboName_input` field on each entry.                            |
| `ubo_ownership`        | Percentage                                    | Ownership percentage of the matched UBO, as recorded in the government database. Returned on `ubo_name_match` entries where a match is found.  |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the CR number. Distinguished by the `directorsName_input` field on each entry.            |

### Registration status values

| Status   | Description                                                                         |
| -------- | ----------------------------------------------------------------------------------- |
| Active   | The business registration is active.                                                |
| Inactive | The business registration is suspended, inactive, or the business no longer exists. |
| Unknown  | Registration status is not available.                                               |

### Approximate Match

`Approximate Match` is generated through Incode's proprietary fuzzy matching algorithm. It is returned when the submitted string is similar to, but not an exact match for, the value stored in the government database. This accounts for misspellings, typographical errors, and slight variations in input data.

### Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

Custom 400 responses include `taxId and country are minimum required fields.` when `taxId`, `country`, or `businessName` is missing or empty.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-india`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-india/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-india.md

# India

India eKYB validates the legitimacy of Indian businesses by checking their tax ID, business name, address, and directors against Indian government databases.

UBOs are not currently supported for India. Only director verification is supported.

## Source

| Country | Source                      | Description                                                                |
| ------- | --------------------------- | -------------------------------------------------------------------------- |
| India   | Indian government databases | Verifies submitted business details against Indian government registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                                           |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                                            |
| `businessName` | Mandatory | String. Name of the business.                                                                                                                                                         |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `IN`.                                                                                                                                |
| `taxId`        | Mandatory | String. Accepts CIN, LLPIN, or UDYAM. Input is not case-sensitive; the system automatically converts it to caps before processing. See [Tax ID formats](#tax-id-formats) for details. |
| `street`       | Optional  | String. Street name of the business.                                                                                                                                                  |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                                                     |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                                                          |
| `city`         | Optional  | String. City in the business address.                                                                                                                                                 |
| `state`        | Optional  | String. State in the business address.                                                                                                                                                |
| `postalCode`   | Optional  | String. 6-digit Indian postal code.                                                                                                                                                   |
| `directors`    | Optional  | Array. Full legal names of business directors to check against records associated with the business.                                                                                  |

### Tax ID formats

| Tax ID Type                                                     | Format                                                               | Applicable To                                                                                                   |
| --------------------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| **CIN** (Corporate Identification Number)                       | 1 letter + 5 digits + 2 letters + 4 digits + 3 letters + 6 digits    | Private Limited Companies, Public Limited Companies, One Person Companies (OPCs), Section 8 Companies           |
| **LLPIN** (Limited Liability Partnership Identification Number) | 3 letters + hyphen + 4 digits                                        | Limited Liability Partnerships (LLPs)                                                                           |
| **UDYAM** (MSME Registration Number)                            | `UDYAM` + hyphen + 2 letters + hyphen + 2 digits + hyphen + 7 digits | MSMEs (Micro, Small, and Medium Enterprises), including sole proprietorships, partnerships, LLPs, and companies |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "country": "IN",
  "taxId": "U72900KA2024PTC123456",
  "businessName": "AARAV TECHNOLOGIES PRIVATE LIMITED",
  "street": "MG Road",
  "houseNo": "42",
  "city": "BENGALURU",
  "state": "KARNATAKA",
  "postalCode": "560001",
  "directors": ["RAJESH KUMAR"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "PRIVATE COMPANY LIMITED BY SHARES NON-GOVERNMENT COMPANY" }
    },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "RAJESH KUMAR" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "ROHAN GUPTA" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `registrationStatus`   | `Active`, `Inactive`                          | Registration status of the business.                                                                                 |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses. India returns the following country-specific 400 errors:

| Error Condition            | Message                                             |
| -------------------------- | --------------------------------------------------- |
| `taxId` missing or invalid | `BadRequestException: Invalid taxId.`               |
| `country` missing or empty | `Country field is either not correct or available.` |

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-israel`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-israel/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-israel.md

# Israel

Israel eKYB validates the legitimacy of Israeli businesses by checking their tax ID, business name, and address against Israeli government sources of truth.

UBOs and directors are not currently supported for Israel.&#x20;

## Source

| Country | Source                              | Description                                                                            |
| ------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| Israel  | Israeli government sources of truth | Verifies submitted business details against records maintained in Israeli registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                           |
| -------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                            |
| `businessName` | Mandatory | String. Name of the business.                                                                                                                                         |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `IL`.                                                                                                                |
| `taxId`        | Mandatory | String. Mispar Osek (מספר עסק), the 9-digit Israeli VAT registration number. The first digit indicates the entity type; the remaining digits are a unique identifier. |
| `street`       | Optional  | String. Street name of the business.                                                                                                                                  |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                                     |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                                          |
| `city`         | Optional  | String. City in the business address.                                                                                                                                 |
| `state`        | Optional  | String. State in the business address.                                                                                                                                |
| `postalCode`   | Optional  | String. Israeli postal code.                                                                                                                                          |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "אי. אם. טי הפצה ולוגיסטיקה בי אנד בי בע״מ",
  "street": "חומה ומגדל",
  "houseNo": "22",
  "city": "תל אביב - יפו",
  "state": "ישראל",
  "country": "IL",
  "taxId": "XXXXXXXXX"
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Israeli Private Company" }
    }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                               |
| ---------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.             |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                         |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                         |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                               |
| `registrationStatus`   | `Active`, `Inactive`                          | Registration status of the business.                                                      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-italy`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-italy/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-italy.md

# Italy

Italy eKYB validates the legitimacy of Italian businesses by checking their tax ID, business name, address, UBOs, and directors against Italian government sources of truth.

## Source

| Country | Source                              | Description                                                                            |
| ------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| Italy   | Italian government sources of truth | Verifies submitted business details against records maintained in Italian registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                           |
| -------------- | --------- | --------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                            |
| `businessName` | Mandatory | String. Name of the business.                                                                                         |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `IT`.                                                                |
| `taxId`        | Mandatory | String. Accepts CCIAA/NREA, CS_COMPANY_ID, or Tax Code/VAT Number. See [Tax ID formats](#tax-id-formats) for details. |
| `street`       | Optional  | String. Street name of the business.                                                                                  |
| `houseNo`      | Optional  | String. Building or house number.                                                                                     |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                          |
| `city`         | Optional  | String. City in the business address.                                                                                 |
| `state`        | Optional  | String. State in the business address.                                                                                |
| `postalCode`   | Optional  | String. 5-digit Italian postal code.                                                                                  |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business.            |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                           |

### Tax ID formats

| Tax ID Type      | Format                                                                        |
| ---------------- | ----------------------------------------------------------------------------- |
| CCIAA/NREA       | 2 letters + 6 or 7 digits (for example: `AA123456`, `AA-123456`, `AA1234567`) |
| CS_COMPANY_ID    | `IT` + 8 digits                                                               |
| Tax Code/VAT No. | 11 digits                                                                     |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "LUXOTTICA GROUP SPA",
  "street": "PLE LUIGI CADORNA",
  "houseNo": "3",
  "city": "MILAN",
  "postalCode": "20123",
  "country": "IT",
  "taxId": "XXXXXXXXX",
  "uboNames": ["Stella Smith", "Sarah Smith"],
  "directors": ["Andrew Martin", "Mike Martin"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["VATNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "LIMITED LIABILITY COMPANY" }
    },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Stella Smith" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Mike Martin" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-kenya`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-kenya/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-kenya.md

# Kenya

Kenya eKYB validates the legitimacy of Kenyan businesses by checking their tax ID, business name, and address against Kenyan government sources of truth.

<Callout icon="⚠️" theme="warn">
  Kenya eKYB is currently available only in the Incode demo environment, not in production. Contact Incode support for availability.
</Callout>

UBOs and directors are not currently supported for Kenya.&#x20;

## Source

| Country | Source                             | Description                                                                           |
| ------- | ---------------------------------- | ------------------------------------------------------------------------------------- |
| Kenya   | Kenyan government sources of truth | Verifies submitted business details against records maintained in Kenyan registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                            |
| -------------- | --------- | ------------------------------------------------------ |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                             |
| `businessName` | Mandatory | String. Name of the business.                          |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `KE`. |
| `taxId`        | Mandatory | String. Kenyan business tax ID.                        |
| `street`       | Optional  | String. Street name of the business.                   |
| `houseNo`      | Optional  | String. Building or house number.                      |
| `addressLine2` | Optional  | String. Second line of the business address.           |
| `city`         | Optional  | String. City in the business address.                  |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "SOUTHAMPTON SPORTS CLUB KENYA LIMITED",
  "street": "Kemp House, Stadium Lane",
  "addressLine2": "Off Moi Avenue",
  "city": "Nairobi",
  "country": "KE",
  "taxId": "P051234567T"
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    { "key": "entityType", "sub_label": "Private Limited Company (Ltd)" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                     |
| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                   |
| `tin`                  | `Found`, `Not Found`                          | Submitted tax ID against the government database.                                                               |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                               |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                     |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                       |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-malta`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-malta/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-malta.md

# Malta

Malta eKYB validates the legitimacy of Maltese businesses by checking their registration number (MBR number), business name, address, UBOs, and directors against Malta's government database.

## Source

| Country | Source                    | Description                                                                                |
| ------- | ------------------------- | ------------------------------------------------------------------------------------------ |
| Malta   | Malta government database | Verifies submitted business details against records maintained in the government database. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                                                                                                                         |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                                                                                          |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `MT`.                                                                                                                                                              |
| `taxId`        | Mandatory | String. Maltese MBR registration number. Accepted formats: `C` followed by digits (e.g. `C12345`), or `MT` + 8 digits (VAT format, e.g. `MT12345678`). The `MT` prefix is stripped automatically before processing. |
| `businessName` | Optional  | String. Registered name of the business.                                                                                                                                                                            |
| `street`       | Optional  | String. Street name of the business.                                                                                                                                                                                |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                                                                                   |
| `addressLine2` | Optional  | String. Second line of the business address.                                                                                                                                                                        |
| `city`         | Optional  | String. City in the business address.                                                                                                                                                                               |
| `state`        | Optional  | String. State or region in the business address.                                                                                                                                                                    |
| `postalCode`   | Optional  | String. Maltese postal code: 3 letters + 4 digits (e.g. `VLT1234`).                                                                                                                                                 |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the MBR number.                                                                                                        |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the MBR number.                                                                                                                       |

The `country` parameter limits business validation to the specified region. Only businesses established in the country specified in the eKYB request are validated.

### Sample request

```json
{
  "plugins": ["ekyb"],
  "country": "MT",
  "taxId": "C12345",
  "businessName": "EXAMPLE MALTA LIMITED",
  "street": "TRIQ IL-MERKANTI",
  "houseNo": "5",
  "city": "VALLETTA",
  "postalCode": "VLT1234",
  "uboNames": ["JOHN DOE", "SARAH SMITH"],
  "directors": ["JOHN BORG"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Approximate Match" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private Limited Liability Company" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "John Doe" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "John Borg" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                                                    |
| ---------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the MBR number.                                                              |
| `tin`                  | `Verified`, `Unverified`                      | Submitted MBR registration number against the government database.                                                                             |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the MBR number.                                                                          |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the MBR number.                                                                                |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the MBR number. Format: 3 letters + 4 digits (e.g. `VLT1234`).                   |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business in the government database. See [Registration status values](#registration-status-values) for definitions. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available (e.g. Private Limited Liability Company). If not available, displays `Unknown`.             |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the MBR number. Distinguished by the `uboName_input` field on each entry.                           |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the MBR number. Distinguished by the `directorsName_input` field on each entry.           |

### Registration status values

| Status   | Description                                                                         |
| -------- | ----------------------------------------------------------------------------------- |
| Active   | The business registration is active.                                                |
| Inactive | The business registration is suspended, inactive, or the business no longer exists. |
| Unknown  | Registration status is not available.                                               |

### Approximate Match

`Approximate Match` is generated through Incode's proprietary fuzzy matching algorithm. It is returned when the submitted string is similar to, but not an exact match for, the value stored in the government database. This accounts for misspellings, typographical errors, and slight variations in input data.

### Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-mexico`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-mexico/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-mexico.md

# Mexico

Mexico eKYB Verification validates the legitimacy of Mexican businesses by checking their tax ID, business name, and address against Mexican government sources of truth.

Mexico eKYB Verification is available in two modes:

- **Standard**: Full verification of business name, address, and tax ID.
- **Lite**: Reduced verification limited to business name, tax ID, and postal code.

UBOs and directors are not currently supported for Mexico Verification in any mode.&#x20;

:::info
For enrichment via lookup rather than field-by-field verification, see [Mexico Prefill](/general-reference/ekyb-prefill-reference-mexico/).
:::

## Source

| Country | Source                              | Description                                                                            |
| ------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| Mexico  | Mexican government sources of truth | Verifies submitted business details against records maintained in Mexican registries.  |

## Standard mode

### Request parameters

| Parameter      | Required  | Description                                                                                          |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                           |
| `businessName` | Mandatory | String. Name of the business.                                                                        |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `MX`.                                               |
| `taxId`        | Mandatory | String. RFC (Registro Federal de Contribuyentes). See [Tax ID formats](#tax-id-formats) for details. |
| `street`       | Optional  | String. Street name of the business.                                                                 |
| `houseNo`      | Optional  | String. Building or house number.                                                                    |
| `addressLine2` | Optional  | String. Second line of the business address.                                                         |
| `city`         | Optional  | String. City in the business address.                                                                |
| `state`        | Optional  | String. State in the business address.                                                               |
| `postalCode`   | Optional  | String. 5-digit Mexican postal code.                                                                 |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Aerolíneas del Sureste S.A. de C.V.",
  "street": "Avenida Patriotismo",
  "addressLine2": "Piso 5, Torre Ejecutiva",
  "city": "Ciudad de México",
  "state": "Ciudad de México",
  "postalCode": "03800",
  "country": "MX",
  "taxId": "ASU1003149Z1"
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Approximate Match" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Sole Proprietorship (Persona Física)" }
    }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                     |
| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                   |
| `tin`                  | `Found`, `Not Found`                          | Submitted tax ID against the government database.                                                               |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                               |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                     |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                       |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation. |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                       |

## Lite mode

Lite mode performs only postal code verification, in addition to business name and tax ID checks.

### Request parameters

| Parameter      | Required  | Description                                                     |
| -------------- | --------- | --------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                      |
| `businessName` | Mandatory | String. Name of the business.                                   |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `MX`.          |
| `taxId`        | Mandatory | String. RFC. See [Tax ID formats](#tax-id-formats) for details. |
| `postalCode`   | Mandatory | String. 5-digit Mexican postal code.                            |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Aerolíneas del Sureste S.A. de C.V.",
  "postalCode": "03800",
  "country": "MX",
  "taxId": "ASU1003149Z1"
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "S.A. de C.V." }
    }
  ]
}
```

### Response fields

| Key                  | Status                            | Description                                                                               |
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------- |
| `name`               | `Verified`, `Unverified`          | Submitted business name against the business name associated with the tax ID.             |
| `tin`                | `Verified`, `Unverified`          | Submitted tax ID against the government database.                                         |
| `postalCodeMatch`    | `Verified`, `Unverified`          | Submitted postal code against the postal code associated with the tax ID.                 |
| `registrationStatus` | `Active`, `Inactive`, `Unknown`   | Registration status of the business.                                                      |
| `entityType`         | Legal entity type of the business | The legal entity type of the company, if available. If not available, displays `Unknown`. |


## Tax ID formats

RFC (Registro Federal de Contribuyentes) is the Mexican federal tax identifier.

| Entity Type | Format                                                           |
| ----------- | ---------------------------------------------------------------- |
| Individual  | 13 characters: 4 letters + 6 numbers + 3 alphanumeric characters |
| Business    | 12 characters: 3 letters + 6 numbers + 3 alphanumeric characters |


### Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-netherlands`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-netherlands/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-netherlands.md

# Netherlands

Netherlands eKYB validates the legitimacy of Dutch businesses by checking their tax ID, business name, address, UBOs, and directors against Dutch government sources of truth.

## Source

| Country     | Source                            | Description                                                                          |
| ----------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| Netherlands | Dutch government sources of truth | Verifies submitted business details against records maintained in Dutch registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `NL`.                                                     |
| `taxId`        | Mandatory | String. Accepts VAT (`NL + 9 digits + B + 2 digits`) or KvK (8 digits).                                    |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. Dutch postal code (4 digits, space, and 2 letters).                                                |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Tulip Tech B.V.",
  "street": "Herengracht",
  "houseNo": "100",
  "city": "AMSTERDAM",
  "state": "NORD-HOLLAND",
  "postalCode": "1015BS",
  "country": "NL",
  "taxId": "12345678",
  "uboNames": ["Sanne de Vries"],
  "directors": ["Jeroen van Dijk"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited liability company" }
    },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Daan Visser" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Thijs Mulder" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Not Verified`                    | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-nigeria`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-nigeria/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-nigeria.md

# Nigeria

Nigeria eKYB validates the legitimacy of Nigerian businesses by checking their tax ID, business name, address, and UBOs against Nigerian government sources of truth.

<Callout icon="⚠️" theme="warn">
  Nigeria eKYB is currently available only in the Incode demo environment, not in production. Contact Incode support for availability.
</Callout>

Directors are not currently supported for Nigeria.&#x20;

## Source

| Country | Source                               | Description                                                                             |
| ------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| Nigeria | Nigerian government sources of truth | Verifies submitted business details against records maintained in Nigerian registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `NG`.                                                     |
| `taxId`        | Mandatory | String. TIN (Tax Identification Number).                                                                   |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. 6-digit Nigerian postal code.                                                                      |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "SkyBridge Aviation Services Ltd.",
  "street": "West Terminal Boulevard, Suite 310",
  "addressLine2": "3rd Floor Port Harcourt International Airport",
  "city": "Port Harcourt",
  "state": "Rivers",
  "postalCode": "500102",
  "country": "NG",
  "taxId": "NG-X-NG0000098712",
  "uboNames": ["Oluwaseun Okonkwo", "Marian Ekong"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "state", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    { "key": "entityType", "sub_label": "Private Company Limited by Shares (Ltd)" },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "Oluwaseun Okonkwo" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Marian Ekong" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                        |
| ---------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                      |
| `tin`                  | `Found`, `Not Found`                          | Submitted tax ID against the government database.                                                                  |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                  |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                        |
| `state`                | `Verified`, `Approximate Match`, `Unverified` | Submitted state against the state associated with the tax ID.                                                      |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                          |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.    |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                          |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-spain`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-spain/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-spain.md

# Spain

Spain eKYB validates the legitimacy of Spanish businesses by checking their tax ID, business name, address, UBOs, and directors against Spanish government sources of truth.

## Source

| Country | Source                              | Description                                                                            |
| ------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| Spain   | Spanish government sources of truth | Verifies submitted business details against records maintained in Spanish registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `ES`.                                                     |
| `taxId`        | Mandatory | String. Accepts VAT Number or Registration Number. See [Tax ID formats](#tax-id-formats) for details.      |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. 5-digit Spanish postal code.                                                                       |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                |

### Tax ID formats

| Entity Type         | Format                     |
| ------------------- | -------------------------- |
| Regular company     | Letter + 8 digits          |
| Foreign Sole Trader | Letter + 7 digits + Letter |
| Sole Trader         | 8 digits + Letter          |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "REAL MADRID CLUB DE FUTBOL",
  "street": "Avenida de Concha Espina",
  "houseNo": "1",
  "city": "MADRID",
  "postalCode": "28036",
  "country": "ES",
  "taxId": "XXXXXXXXX",
  "uboNames": ["Sarah Smith"],
  "directors": ["Florentino Perez"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Found", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited with Share Capital" }
    },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Florentino Perez" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Found`, `Not Found`                          | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-united-kingdom`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-united-kingdom/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-united-kingdom.md

# United Kingdom

United Kingdom eKYB validates the legitimacy of British businesses by checking their tax ID, business name, address, UBOs, and directors against UK government sources of truth.

## Source

| Country        | Source                         | Description                                                                       |
| -------------- | ------------------------------ | --------------------------------------------------------------------------------- |
| United Kingdom | UK government sources of truth | Verifies submitted business details against records maintained in UK registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `GB`.                                                     |
| `taxId`        | Mandatory | String. Accepts Registration Number or VAT Number. See [Tax ID formats](#tax-id-formats) for details.      |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. UK postal code (5-7 alphanumeric characters).                                                      |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                |

### Tax ID formats

| Tax ID Type         | Format                                                        |
| ------------------- | ------------------------------------------------------------- |
| Registration Number | 8 digits (or 7 digits, in which case a leading zero is added) |
| VAT Number          | `GB` + 9 digits                                               |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "SOUTHAMPTON FOOTBALL CLUB LIMITED",
  "street": "S STADIUM ST MARY Kemp House",
  "addressLine2": "BRITANNIA ROAD",
  "city": "SOUTHAMPTON",
  "postalCode": "SO14 0AA",
  "country": "GB",
  "taxId": "XXXXXXXXX",
  "uboNames": ["ST MARY'S FOOTBALL GROUP LTD", "Sarah Smith"],
  "directors": ["Andrew Martin", "Sarah Schrader"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited with Share Capital" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "ST MARY'S FOOTBALL GROUP LTD" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyb-verification-reference-united-states`
- URL: https://developer.incode.com/general-reference/ekyb-verification-reference-united-states/
- Markdown: https://developer.incode.com/general-reference/ekyb-verification-reference-united-states.md

# United States

United States eKYB validates the legitimacy of US businesses by checking their tax ID, business name, address, and UBOs against US government sources of truth.

US eKYB is offered in two variants:

- **Advanced**: Core verification including business name, tax ID, address, city, postal code, registration status, and UBO name match.
- **Advanced+**: Everything in Advanced, plus address deliverability, address property type, entity type, and the full list of individuals associated with the business.

Both variants use the same endpoint, request parameters, and match fields. Advanced+ returns additional response fields not present in Advanced.

## Sources

| Country       | Source    | Description                                                                                                         |
| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------- |
| United States | Advanced  | Verifies business details against IRS records and state Secretary of State filings.                                 |
| United States | Advanced+ | Same source as Advanced, plus additional verification including USPS address deliverability and full people lookup. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](/general-reference/ekyb-reference/).

### Request parameters

Request parameters are identical for Advanced and Advanced+.

| Parameter      | Required  | Description                                                                                                                                        |
| -------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                                                         |
| `businessName` | Mandatory | String. Name of the business.                                                                                                                      |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `US`.                                                                                             |
| `taxId`        | Mandatory | String. Accepts a 9-digit EIN issued by the IRS or a state-issued business registration number. See [Tax ID formats](#tax-id-formats) for details. |
| `street`       | Optional  | String. Street name of the business.                                                                                                               |
| `houseNo`      | Optional  | String. Building or house number.                                                                                                                  |
| `addressLine2` | Optional  | String. Second line of the business address (for example, apartment or unit number).                                                               |
| `city`         | Optional  | String. City in the business address.                                                                                                              |
| `state`        | Optional  | String. State in the business address.                                                                                                             |
| `postalCode`   | Optional  | String. 5-digit US postal code.                                                                                                                    |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business.                                         |

At least one field from `street`, `houseNo`, `addressLine2`, `city`, `state`, or `postalCode` must be provided.

### Tax ID formats

| Tax ID Type               | Format                               |
| ------------------------- | ------------------------------------ |
| EIN                       | 9 digits, issued by the IRS.         |
| State Registration Number | No standard format; varies by state. |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "Delta International Inc.",
  "street": "SW 72nd Ave",
  "houseNo": "4856",
  "city": "MIAMI",
  "state": "FL",
  "postalCode": "33155",
  "country": "US",
  "taxId": "XXXXXXXXX",
  "uboNames": ["Jose A Santos"]
}
```

### Sample response — Advanced

```json
{
  "kyb": [
    { "key": "name", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Business Name" },
    { "key": "tin", "status": "success", "sub_label": "Verified", "message": "The IRS has a record for the submitted TIN and Business Name combination" },
    { "key": "address_verification", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Office Address" },
    { "key": "registrationStatus", "sub_label": "Active" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "ubo_name_match", "status": "success", "sub_label": "Verified" }
  ]
}
```

### Sample response — Advanced+

```json
{
  "kyb": [
    { "key": "name", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Business Name" },
    { "key": "tin", "status": "success", "sub_label": "Verified", "message": "The IRS has a record for the submitted TIN and Business Name combination" },
    { "key": "address_verification", "status": "success", "sub_label": "Verified", "message": "Match identified to the submitted Office Address" },
    { "key": "address_deliverability", "status": "success", "sub_label": "Deliverable", "message": "The USPS is able to deliver mail to the submitted Office Address" },
    { "key": "address_property_type", "status": "success", "sub_label": "Commercial", "message": "Submitted Office Address is a Commercial property" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited with Share Capital" }
    },
    { "key": "ubo_name_match", "status": "success", "sub_label": "Verified" },
    {
      "key": "people",
      "people": [
        { "name": "PANDO, ADA B.", "titles": [{ "title": "DIRECTOR" }] },
        { "name": "PANDO, SARAH A.", "titles": [{ "title": "DIRECTOR" }] },
        {
          "name": "MARTIN, JOHN",
          "titles": [
            { "title": "DIRECTOR" },
            { "title": "REGISTERED AGENT" }
          ]
        },
        {
          "name": "SANTOS, JOSE A",
          "titles": [
            { "title": "CEO" },
            { "title": "PRESIDENT" },
            { "title": "REGISTERED AGENT" },
            { "title": "VICE PRESIDENT" }
          ]
        }
      ]
    }
  ]
}
```

### Response fields

The Available column indicates which variants return each field.

| Key                      | Available           | Status                                        | Description                                                                                                                                                                           |
| ------------------------ | ------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                   | Advanced, Advanced+ | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                                                                                         |
| `tin`                    | Advanced, Advanced+ | `Verified`, `Unverified`                      | Submitted tax ID against the government database. See [Tax ID verification messages](#tax-id-verification-messages) for the specific messages returned per Tax ID type and outcome.   |
| `address_verification`   | Advanced, Advanced+ | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                                                                                     |
| `address_deliverability` | Advanced+           | `Deliverable`, `Not Deliverable`              | USPS deliverability status of the submitted address.                                                                                                                                  |
| `address_property_type`  | Advanced+           | `Commercial`, `Residential`                   | Property type of the submitted address.                                                                                                                                               |
| `cityMatch`              | Advanced, Advanced+ | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                                                                                           |
| `postalCodeMatch`        | Advanced, Advanced+ | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                                                                                             |
| `registrationStatus`     | Advanced, Advanced+ | `Active`, `Inactive`, `Unknown`               | Registration status of the business across states with SOS filings. `Active` if active in some or all states; `Inactive` if suspended or inactive in all; `Unknown` if not available. |
| `entityType`             | Advanced+           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                                                                                             |
| `ubo_name_match`         | Advanced, Advanced+ | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.                                                                    |
| `people`                 | Advanced+           | Array of individuals and their titles         | Full list of individuals associated with the business entity, with associated titles (for example, DIRECTOR, REGISTERED AGENT, CEO, PRESIDENT, VICE PRESIDENT).                       |

The `sub_label` field is the primary indicator of match outcome. Response entries that also include `status` and `message` fields provide additional context useful for risk-based decisioning.

### Tax ID verification messages

The `tin` response field returns a `message` describing the specific verification outcome. Messages differ based on Tax ID type and match outcome.

| Tax ID Type         | Condition                                                                  | Message                                                                              |
| ------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| EIN                 | Tax ID is found in IRS and valid                                           | The IRS has a record for the submitted TIN and Business Name combination.            |
| EIN                 | Tax ID is found in IRS but not associated with the submitted Business Name | We believe the submitted TIN is associated with a different business name.           |
| EIN                 | Tax ID is not found in IRS                                                 | The IRS does not have a record for the submitted TIN and Business Name combination.  |
| State-issued Tax ID | Tax ID and Business Name are associated with each other                    | The Tax ID provided is associated with the Business Name.                            |
| State-issued Tax ID | Tax ID and Business Name are not associated with each other                | We could not determine a record for the submitted TIN and Business Name combination. |
| State-issued Tax ID | Neither Tax ID nor Business Name could be found                            | We could not find a business with the provided name or tax ID.                       |

### Error responses

See the [eKYB API Reference](/general-reference/ekyb-reference/) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ekyc-api-reference`
- URL: https://developer.incode.com/general-reference/ekyc-api-reference/
- Markdown: https://developer.incode.com/general-reference/ekyc-api-reference.md

# eKYC API Reference

The External Verification (eKYC) endpoint (`POST /omni/externalVerification/ekyc`) verifies an individual's identity against country-specific data sources and returns a set of match and risk-level fields describing the result. This page explains the response semantics for that endpoint: how to interpret match fields, status values, risk levels, metadata fields, reason codes, error responses, and Risk Add-ons.

For the request contract (headers, request body schema, sample requests), see the [External Verification (eKYC)](/reference/externalverificationekyc/) API reference. For per-source response schemas, mandatory fields, and overallLevel calculations, see the country pages in this section. For the Brazil-only Income Verification endpoint (`POST /omni/externalVerification/income`), see the [Brazil](/general-reference/ekyc-reference-brazil/) country page.

## Response field categories

Response fields returned by the eKYC endpoint fall into three categories:

- **Match fields** compare a submitted value (name, address, date of birth, and so on) against the value found in the source of truth. Match field names follow one of several patterns depending on how the source anchors verification (see the following section).
- **Risk level fields** return aggregate risk assessments for the submitted values (`overallLevel`, `phoneLevel`, `taxIdLevel`, `addressRiskLevel`, `emailLevel`).
- **Metadata fields** describe attributes of the source-of-truth data itself, rather than match statuses (for example, `phoneCarrier`, `phoneLineType`, `panStatus`, `deliverability`).

Not all fields appear in every response. The fields returned depend on the source used for the verification.

## Match field naming conventions

Different sources anchor verification differently, and the match field names reflect the anchor. Understanding the anchor makes response schemas easier to read.

| Anchor                   | Match field pattern                                                                                                                                                                                 | Examples of sources                                                                                             |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| Source of truth register | `firstNameMatch`, `dobMatch`, `idNumMatch`, `phoneMatch`, and so on. Each submitted field is matched against its counterpart in the register.                                                       | Argentina, Canada, Chile, Greece, Guatemala, Spain, Sweden, United Kingdom (Voter Register), US Credit Bureau 3 |
| Phone number             | `phoneNameMatch`, `phoneAddressMatch`, `phoneDobMatch`, `phoneCityMatch`, and so on. Each submitted field is matched against the record associated with the submitted phone number.                 | US Telco 1, US Telco 2, US Telco 4, US Telco 5                                                                  |
| Tax ID                   | `taxIdMatch`, `taxIdNameMatch`, `taxIdDobMatch`, `taxIdAddressMatch`, and so on. Each submitted field is matched against the record associated with the submitted tax ID.                           | US Credit Bureau 1, Brazil Government (BR GOVT 1)                                                               |
| Address                  | `nameMatch`, `streetMatch`, `cityMatch`, `stateMatch`, `zipcodeMatch`, `addressMatch`. Match fields focus on the address itself; the address also carries USPS deliverability and validity signals. | US Address 1                                                                                                    |
| Document                 | Document-specific patterns: `dlNumberMatch`, `dlNameMatch`, `dlDobMatch` (driver's license); `panNumberMatch`, `panNameMatch`, `panStatus` (PAN card).                                              | US Drivers License, India PAN                                                                                   |

See the country pages for the full response schema of each source.

## Status values

Match fields return a status indicating the quality of the match. Common status values:

| Status             | Meaning                                                                                                                                             |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `exact`            | The submitted value exactly matches the value in the source of truth.                                                                               |
| `fuzzy`            | The submitted value approximately matches the value in the source of truth (per a proprietary algorithm).                                           |
| `approximatematch` | Alternative label for a fuzzy match, used by some sources (Brazil Government, Guatemala).                                                           |
| `nomatch`          | The submitted value does not match the value in the source of truth.                                                                                |
| `nodata`           | No corresponding value was found in the source of truth to compare against.                                                                         |
| `unknown`          | The source of truth does not have this information available for comparison.                                                                        |
| `unabletoverify`   | The specific attribute could not be validated. Used by Brazil Government for address components when the individual has no driver's license record. |

See the country pages for source-specific status values and their meanings.

## Risk level fields

Risk level fields return aggregate risk assessments. The specific set of risk level fields returned varies by source.

| Field              | Statuses                             | Description                                                                                                                                |
| ------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `overallLevel`     | `low`, `medium`, `high`, `very_high` | The overall risk level for the verification. Calculation varies by source; see the country pages for source-specific calculation logic.    |
| `taxIdLevel`       | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted tax ID. Returned by tax-ID-anchored sources.                                                      |
| `phoneLevel`       | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted phone number. Returned by phone-anchored sources and by sources that include phone risk scoring.  |
| `addressRiskLevel` | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted address, independent of address matching. Based on USPS deliverability and address validity data. |
| `emailLevel`       | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted email address. Based on validity, deliverability, breach history, and behavioral signals.         |
| `emailDomainLevel` | `low`, `high`                        | Risk level associated with the submitted email's domain.                                                                                   |

`overallLevel` is customizable per customer requirements. The calculations documented on each country page reflect Incode's default thresholds; contact your Incode representative to adjust thresholds for your use case.

## Metadata fields

Some sources return metadata about the source-of-truth data itself, rather than match statuses. Common examples:

| Field            | Type    | Description                                                                                                              |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `phoneCarrier`   | String  | The phone carrier associated with the submitted phone number (for example, `T-Mobile USA`, `Verizon`).                   |
| `phoneLineType`  | String  | The type of phone line (for example, `Mobile`, `Landline`, `FixedVOIP`, `NonFixedVOIP`).                                 |
| `lastPorted`     | Date    | Date the phone number was last ported, in `yyyy-mm-dd` format. Only returned if the number has been ported.              |
| `activityScore`  | Integer | Activity score (0-1000) representing the quality of a phone number. Higher scores indicate better activity.              |
| `panStatus`      | String  | Status of the PAN card (`Active`, `Inactive`). India PAN only.                                                           |
| `panHolderType`  | String  | The type of entity associated with the PAN number (for example, `Individual`, `Business`). India PAN only.               |
| `deliverability` | String  | USPS deliverability status of an address. US Address 1 only.                                                             |
| `addressValid`   | Boolean | Whether the submitted address exists as a real location in postal, mapping, or delivery data sources. US Address 1 only. |

See the country pages for the full set of metadata fields returned by each source.

## Reason codes

Some sources return reason codes alongside match fields and risk level fields. Reason codes provide additional context for a match result or risk assessment (for example, indicating that an address matched but is a PO Box, or that a phone number is associated with a high-risk line type).

Reason codes are returned in a `reasonCodes` array on the relevant field. For the full list of reason codes and their meanings, see [eKYC Reason Codes](/general-reference/ekyc-reason-codes/).

## Error responses

The eKYC endpoint returns conventional HTTP response codes. Common error scenarios:

- **400 Bad Request:** Missing mandatory fields for the selected source. The response body identifies which field is missing. See each source's request parameters on the country pages for source-specific mandatory fields.
- **400 Bad Request:** Phone number not in international E.164 format (for example, `+14081234567`). Applies to any source that accepts `phone` as a parameter.
- **400 Bad Request:** Invalid `country` value for the selected source. The `country` parameter must match the expected country code for the source (for example, `US`, `BR`, `GB`, or `GL` for Risk Add-ons).

For the full list of HTTP response codes and general API error handling, see [API responses](/reference/introduction/#api-responses).

## Risk Add-ons

Risk Add-ons are supplementary checks that evaluate the trust and potential risk of a phone number or email address. They are invoked through the standard eKYC endpoint with `country: "GL"` and a source-specific identifier. Risk Add-ons can be run alongside a country-specific eKYC check or configured as standalone checks under the Global country with the _Risk Add-ons Only_ source (see the [eKYC Dashboard configuration page](/dashboard-platform-administration/ekyc-dashboard/) for details).

### Phone Check

**Source:** `PHONE_RISK_1`

Evaluates a phone number and returns validity, activity, carrier information, and a risk score based on signals such as line type, VOIP or prepaid status, breach exposure, and spam reports.

**Response fields:**

| Field             | Statuses / Type                      | Description                                                                                                   |
| ----------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| `phoneValid`      | `true`, `false`                      | Whether the phone number is properly formatted and valid for the country's carrier ranges.                    |
| `phoneActive`     | `true`, `false`, `unknown`           | Whether the phone number is a live, usable, currently active phone number.                                    |
| `phoneVOIP`       | `true`, `false`, `unknown`           | Whether the phone number is a Voice Over IP (VOIP) or digital phone number.                                   |
| `phonePrepaid`    | `true`, `false`, `unknown`           | Whether the phone number is associated with a prepaid service plan.                                           |
| `phoneRisky`      | `true`, `false`, `unknown`           | Whether the phone number is associated with fraudulent activity, scams, robocalls, fake accounts, or similar. |
| `phoneLineType`   | String                               | The type of line associated with the phone number.                                                            |
| `phoneCarrier`    | String                               | The carrier associated with the phone number.                                                                 |
| `phoneLeaked`     | `true`, `false`                      | Whether the phone number has recently been exposed in an online database breach.                              |
| `phoneSpammer`    | `true`, `false`                      | Whether the phone number has recently been reported for spam or harassing calls or texts.                     |
| `phoneFraudScore` | `low`, `medium`, `high`              | Fraud score based on a proprietary scale: less than 75 is low, 75-85 is medium, greater than 85 is high.      |
| `overallLevel`    | `low`, `medium`, `high`, `very_high` | Aggregate risk assessment. See below for calculation logic.                                                   |

**overallLevel calculation:**

- `very_high` if `phoneValid == false` OR `phoneActive == false` OR `phoneRisky == true` OR `phoneFraudScore == high`
- `high` if (`phoneValid == false` OR `phoneActive == false`) AND (`phoneRisky == true` OR `phoneFraudScore == high`)
- `medium` if `phoneValid == true` AND `phoneActive == true` AND (`phoneRisky == true` OR `phoneFraudScore == medium`)
- `low` otherwise

### Advanced Phone Check

**Source:** `PHONE_RISK_2`

Extends Phone Check with additional intelligence signals: porting history, first-seen date in the data partner's network, associated social media platforms, breach history including first and last breach dates, and a digital footprint score. Returns a confidence level alongside the overall risk level.

**Response fields:**

| Field                    | Statuses / Type                      | Description                                                                                           |
| ------------------------ | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `phoneValid`             | `true`, `false`                      | Whether the phone number is valid.                                                                    |
| `phoneActive`            | `true`, `false`                      | Whether the phone number is a live, usable phone number that is currently active.                     |
| `phonePorted`            | `true`, `false`                      | Whether the phone number has been ported.                                                             |
| `currentCarrier`         | String                               | Current carrier or service provider.                                                                  |
| `previousCarrier`        | String                               | Previous carrier or service provider.                                                                 |
| `lastPorted`             | Date                                 | Date the number was last ported in `yyyy-mm-dd` format. Only present if the number has been ported.   |
| `phoneLineType`          | String                               | Type of line (for example, mobile, landline).                                                         |
| `isDisposable`           | `true`, `false`                      | Whether the phone number is a disposable type.                                                        |
| `activityScore`          | Integer                              | Activity score (0-1000) representing the quality of the phone number.                                 |
| `activityDescription`    | String                               | Describes the amount of network activity available.                                                   |
| `totalBreaches`          | String                               | Number of breaches the phone number was found in.                                                     |
| `firstBreachDate`        | Date                                 | Date the number was first found in a data breach.                                                     |
| `lastBreachDate`         | Date                                 | Date the number was most recently found in a data breach.                                             |
| `multipleBreachExposure` | `true`, `false`                      | Whether the phone number was found in multiple breaches.                                              |
| `connectedPlatforms`     | String                               | Comma-separated list of social media platforms where an account is associated with this phone number. |
| `digitalPresenceScore`   | Integer                              | Digital footprint score (0-1000).                                                                     |
| `footprintScore`         | Integer                              | Digital footprint score (0-1000). Higher scores indicate better activity and confidence.              |
| `phoneName`              | String                               | Name of the person associated with this phone number.                                                 |
| `firstSeen`              | Date                                 | Date when this phone number was first seen in the data partner's network.                             |
| `checkStatus`            | String                               | Outcome of the check for the provided phone number.                                                   |
| `confidenceLevel`        | `low`, `medium`, `high`, `very_high` | Confidence level in the verification result.                                                          |
| `overallLevel`           | `low`, `medium`, `high`, `very_high` | Aggregate risk level for the phone number.                                                            |

### Email Check

**Source:** `EMAIL_RISK_1`

Evaluates an email address for validity, deliverability, and fraud risk. Includes signals for breach exposure, email address age, domain age, and legitimate user activity.

**Response fields:**

| Field                 | Statuses / Type                      | Description                                                                                                      |
| --------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `emailValid`          | `true`, `false`                      | Whether the email address appears valid.                                                                         |
| `emailDeliverability` | `low`, `medium`, `high`              | Likelihood that emails will be delivered to the recipient's mailbox.                                             |
| `emailLeaked`         | `true`, `false`                      | Whether the email address was associated with a recent third-party database leak.                                |
| `emailFirstSeen`      | String                               | Estimated email address age, based on when the address was first discovered.                                     |
| `domainFirstSeen`     | String                               | When the email domain was registered.                                                                            |
| `emailUserActivity`   | `high`, `medium`, `low`, `none`      | Frequency of legitimate purchases, account registrations, and other legitimate online behavior for this address. |
| `emailFraudScore`     | `low`, `medium`, `high`              | Fraud score: less than 75 is low, 75-85 is medium, greater than 85 is high.                                      |
| `overallLevel`        | `low`, `medium`, `high`, `very_high` | Aggregate risk assessment. See below for calculation logic.                                                      |

**overallLevel calculation:**

- `very_high` if `emailValid == false` OR `emailDeliverability == low` OR `emailFraudScore == high`
- `high` if `emailValid == false` AND (`emailDeliverability == low` OR `emailFraudScore == high`)
- `medium` if `emailValid == true` AND (`emailDeliverability == medium` OR `emailFraudScore == medium`)
- `low` otherwise

### Phone Profile
**Source:** `PHONE_PROFILE`

Given just a phone number, this check returns the associated person's name, date of birth, and address(es) on file when available, along with any additional candidate identities tied to that number.

**Mandatory field:** `phone`, in E.164 format (must include `+` and country calling code).

Response fields:

| Field | Statuses / Type | Description |
|---|---|---|
| checkStatus | found, notFound | Outcome of the check for the provided phone number. |
| confidenceLevel | low, medium, high | Confidence in the returned identity match. |
| phoneFirstName | String | First name of the person associated with this phone number. |
| phoneLastName | String | Last name of the person associated with this phone number. |
| phoneDob | Date (yyyy-mm-dd) | Date of birth of the person associated with this phone number. Availability varies by country. |
| phoneValid | true, false | Whether the phone number is valid. |
| phoneCountry | String | Country associated with the phone number. |
| phoneAddresses | Array of strings | Address(es) on file for the phone number. Each address is a single concatenated string, not split into street/city/state/postal. |
| additionalProfiles | Array of objects | Alternate candidate identities tied to the same phone number, each with a name, date of birth (if available), and address(es). |
| reasonCodes | Array of strings | Reason codes explaining the check outcome. |
| nameReturned | true, false | Computed field. True only if both phoneFirstName and phoneLastName are present and non-empty; false otherwise. |
| phonePersonAge | Integer | Computed field. Age calculated from phoneDob at the time of the check. Not present when phoneDob is unavailable. |
| isAdult | true, false | Computed field. True if phonePersonAge >= 18 or nameReturned = true; false otherwise. |

**Error handling:** if `checkStatus == "notFound"`, the response returns "No information was found for the provided phone number."

---

- Path: `general-reference/ekyc-belgium`
- URL: https://developer.incode.com/general-reference/ekyc-belgium/
- Markdown: https://developer.incode.com/general-reference/ekyc-belgium.md

# Belgium




Belgium eKYC verification matches submitted individual data against Belgium's consumer credit and telco records. See the eKYC API Reference for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description |
|---|---|---|
| Belgium Credit + Telco | `BE_CREDIT_TELCO` | Verifies submitted data against Belgium's consumer credit and telco records. |

## Belgium Credit + Telco

### Request parameters

| Parameter | Required | Description |
|---|---|---|
| `source` | Mandatory | Must be `BE_CREDIT_TELCO`. |
| `country` | Mandatory | Must be `BE`. |
| `firstName` | Mandatory | First name of the individual. Must not contain digits. |
| `surName` | Mandatory | Last name of the individual. Must not contain digits. |
| `phone` | Mandatory | Belgium mobile phone number. See format note below. |
| `street` | Optional | Full street including house number (address = `street` + house number in Belgium). |
| `city` | Optional | City of the individual's address (for example, Brussels). |
| `state` | Optional | Region of the individual's address. |
| `postalCode` | Optional | Belgium postal code. See format note below. |
| `dateOfBirth` | Optional | Format: yyyy-mm-dd. |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "BE_CREDIT_TELCO", //required field
    "firstName": "Jane", //required field
    "surName": "Doe", //required field
    "street": "Rue de la Loi 12",
    "city": "Brussels",
    "state": "Brussels-Capital Region",
    "postalCode": "1000",
    "country": "BE", //required field
    "dateOfBirth": "1991-08-02",
    "phone": "475123456" //required field
}
```

### Response fields

Belgium Credit + Telco anchors verification on individual name and phone number. See the eKYC API Reference for common match field definitions and status values.

| Field | Statuses | Description |
|---|---|---|
| `firstNameMatch` | exact, fuzzy, nomatch | Matches first name submitted against the value in the source of truth. |
| `lastNameMatch` | exact, fuzzy, nomatch | Matches last name submitted against the value in the source of truth. |
| `fullNameMatch` | exact, fuzzy, nomatch | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise `fuzzy`. |
| `phoneMatch` | exact, fuzzy, nomatch | Matches phone submitted against the value in the source of truth. |
| `dobMatch` | exact, fuzzy, nomatch, nodata | Matches date of birth submitted against the value in the source of truth. |
| `streetMatch` | exact, fuzzy, nomatch, nodata | Matches street submitted against the value in the source of truth. |
| `cityMatch` | exact, fuzzy, nomatch, nodata | Matches city submitted against the value in the source of truth. |
| `stateMatch` | exact, fuzzy, nomatch, nodata | Matches state submitted against the value in the source of truth. |
| `postalCodeMatch` | exact, fuzzy, nomatch, nodata | Matches postal code submitted against the value in the source of truth. |
| `fullAddressMatch` | exact, fuzzy, nomatch, nodata | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. `stateMatch` is not factored into this calculation. See below for calculation logic. |
| `overallLevel` | low, medium, high | Overall risk level. See below for calculation logic. |



`overallLevel` is calculated based on the risk associated with the submitted full name and phone number:

- `low` when `fullNameMatch` and `phoneMatch` are both exact.
- `high` when `fullNameMatch` or `phoneMatch` is nomatch.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/ekyc-coverage`
- URL: https://developer.incode.com/general-reference/ekyc-coverage/
- Markdown: https://developer.incode.com/general-reference/ekyc-coverage.md

# eKYC Coverage

Incode provides reliable eKYC verification worldwide, leveraging a wide range of trusted data sources to ensure secure and compliant identity checks. eKYC verifies a customer's identity without requiring physical documents by confirming that the identification data provided matches the relevant authoritative source of truth in the customer's country.

:::info
  Not all countries and data sources listed below are currently live in production. Additional coverage can be enabled based on customer demand and specific use case requirements. Contact your Incode representative for details.
:::

<Accordion title="Global Coverage Table">

| Country Code | Country              | Type of Data                                                    | Fields supported (Mandatory inputs in **bold**)                                                          |
| ------------ | -------------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| AF           | Afghanistan          | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| AL           | Albania              | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| AD           | Andorra              | Utility - Phone Register                                        | **Name,** Address, Date of Birth, Gender, Phone                                                          |
| AR           | Argentina            | National ID, Credit Bureau                                      | **Name**, Address, Date of Birth, National ID (DNI)                                                      |
| AR           | Argentina            | Citizens - AFIP (Administración Federal de Ingresos Públicos)   | **Name, Date of Birth, National ID (DNI)**                                                               |
| AR           | Argentina            | Credit Bureau                                                   | **Name, Address, Date of Birth, Gender, Phone, National ID**                                             |
| AR           | Argentina            | National ID                                                     | **Name, Address, Date of Birth, Gender, National ID**                                                    |
| AR           | Argentina            | Government                                                      | **Name**, **Address**, Date of Birth, Gender                                                             |
| AR           | Argentina            | Official Resident Register                                      | **Name**, **Address**, Date of Birth, Gender                                                             |
| AR           | Argentina            | Credit Bureau                                                   | **Name**, Address, Date of Birth, Phone, National ID (DNI)                                               |
| AR           | Argentina            | Official Civil Register                                         | **Name**, Address, Date of Birth, Gender, National ID (DNI)                                              |
| AM           | Armenia              | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, National ID (Voter ID)**                                         |
| AM           | Armenia              | Official Resident Register                                      | **Name, Address, Date of Birth**                                                                         |
| AU           | Australia            | Official National ID - Drivers License, Passport, Citizenship   | **Name, Date of Birth, National ID (Drivers license)**                                                   |
| AU           | Australia            | Credit Bureau                                                   | **Name, Address, Date of Birth**                                                                         |
| AU           | Australia            | Residential, Phone, Consumer, Payroll                           | **Name, Address, Date of Birth, Phone**                                                                  |
| AU           | Australia            | Death Check                                                     | **Name, Date of Birth**                                                                                  |
| AU           | Australia            | Electoral Roll                                                  | **Name, Address, Date of Birth**                                                                         |
| AU           | Australia            | Document Verification Service (DVS) Identity Documents          | **Name, Date of Birth, National ID (Document number)**                                                   |
| AU           | Australia            | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| AU           | Australia            | Official Voter Register                                         | **Name, Address, Gender, Phone**                                                                         |
| AU           | Australia            | Official Resident Register                                      | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| AU           | Australia            | Official National ID - VISA                                     | **Name, Date of Birth, Gender, National ID (Passport)**                                                  |
| AU           | Australia            | Official National Phone Register                                | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| AU           | Australia            | Consumer                                                        | **Name, Address, Date of Birth, Phone**                                                                  |
| AU           | Australia            | Telco & MNO                                                     | **Name, Address, Date of Birth, Phone**                                                                  |
| AU           | Australia            | VEVO - Department of Home Affairs Visa database                 | **Date of Birth, National ID (Document number)**                                                         |
| AT           | Austria              | Credit Bureau                                                   | **Name, Address, Date of Birth**                                                                         |
| AT           | Austria              | Official Civil Register + Consumer Credit + Telco               | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| AT           | Austria              | Consumer, Population Register & Telco                           | **Name, Address, Date of Birth, Phone**                                                                  |
| AT           | Austria              | Credit Bureau                                                   | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| BD           | Bangladesh           | Government                                                      | **Name**, Date of Birth, **National ID**                                                                 |
| BE           | Belgium              | Residential, Utility                                            | **Name, Address, Date of Birth, Phone, Email**                                                           |
| BE           | Belgium              | Official Citizenship Register                                   | **Name, Address, Gender, Phone**                                                                         |
| BE           | Belgium              | Telco & MNO                                                     | **Name, Address, Date of Birth, Phone**                                                                  |
| BE           | Belgium              | Official Civil Register + Consumer Credit + Telco               | **Name, Address, Date of Birth, Phone**                                                                  |
| BE           | Belgium              | Consumer, Population Register & Telco                           | **Name, Address, Date of Birth, Phone**                                                                  |
| BE           | Belgium              | Utility - Phone Register                                        | **Name, Address, Gender, Phone**                                                                         |
| BE           | Belgium              | Consumer                                                        | **Name**, Address, Date of Birth, Phone                                                                  |
| BE           | Belgium              | Population Register                                             | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| BJ           | Benin                | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| BM           | Bermuda              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| BO           | Bolivia              | Official Civil Register                                         | **Name, Date of Birth, National ID**                                                                     |
| BR           | Brazil               | National ID -  Receita Federal                                  | **Name, Address, Date of Birth, National ID (CPF)**                                                      |
| BR           | Brazil               | Telco                                                           | **Name, Address, Date of Birth, Phone**                                                                  |
| BR           | Brazil               | National ID                                                     | **Name, Address, Date of Birth, National ID (Tax ID)**                                                   |
| BR           | Brazil               | Official Tax Register and Mobile Phone Register                 | **Name**, **Address**, Date of Birth, Gender, Phone, National ID (CPF)                                   |
| BR           | Brazil               | Official CPF                                                    | **Name**, **National ID (CPF)**                                                                          |
| BR           | Brazil               | Official Tax Register                                           | **Name**, Address, Date of Birth, Gender, **National ID (CPF)**                                          |
| BR           | Brazil               | Telco & MNO                                                     | **Name**, Address, Date of Birth, **Phone**                                                              |
| BR           | Brazil               | Official Civil Register and Tax Register                        | **Name**, Address, Date of Birth, Gender, Phone, **National ID (CPF)**                                   |
| BG           | Bulgaria             | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| BI           | Burundi              | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| KH           | Cambodia             | Official National ID                                            | **Name**, Address, **Date of Birth**, Gender, **National ID (Voter ID)**                                 |
| KH           | Cambodia             | National ID                                                     | **Name, Date of Birth, National ID (Voter ID)**                                                          |
| CM           | Cameroon             | Official Voter Register                                         | **Name, Address, Date of Birth, National ID (Voter ID)**                                                 |
| CM           | Cameroon             | Official Voter Register                                         | **Name**, Address, Date of Birth, Gender, National ID                                                    |
| CA           | Canada               | Credit Bureau, Residential                                      | **Name, Address, Date of Birth, Phone**                                                                  |
| CA           | Canada               | Utility - Phone Register                                        | **Name**, Address, Phone, Gender                                                                         |
| CA           | Canada               | Official Resident Register                                      | **Name**, **Address**, Phone                                                                             |
| CA           | Canada               | Telco & MNO                                                     | Name, Address, Date Of Birth, **Phone**                                                                  |
| KY           | Cayman Islands       | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| CL           | Chile                | National ID                                                     | **Name, Date of Birth, National ID (RUN)**                                                               |
| CL           | Chile                | Utility - Phone Register                                        | **Name**, Address, Phone, Gender                                                                         |
| CL           | Chile                | Official Civil Register                                         | **Name, National ID (RUT)**                                                                              |
| CL           | Chile                | Official Civil Register                                         | **Name**, Date of Birth, National ID (RUT)                                                               |
| CL           | Chile                | Official Civil Register                                         | **Name**, Address, Date of Birth, Gender, **National ID**                                                |
| CN           | China                | Official Voter Register                                         | **Name**, **Address**, National ID, Phone                                                                |
| CN           | China                | Official Bank Card                                              | **Name, Date of Birth, National ID**                                                                     |
| CN           | China                | Official National Phone Register                                | **Name, Date of Birth, Phone, National ID**                                                              |
| CN           | China                | Official National ID                                            | **Name, Date of Birth, National ID**                                                                     |
| CN           | China                | Official Data Service (Bank card, National ID, Phone, Passport) | **Name, Date of Birth, Phone, National ID (Passport)**                                                   |
| CO           | Colombia             | National ID Register (Registraduria)                            | **Name, Date of Birth, National ID (NUIP)**                                                              |
| CO           | Colombia             | Official National ID                                            | **Name, Date of Birth, National ID (Cédula de Ciudadanía, Cédula de Extranjería, NIT, Passport)**        |
| CO           | Colombia             | Official Civil Register                                         | **Name, Address, Date of Birth, National ID (Cédula de Ciudadanía / PPT + Issue Date)**                  |
| CO           | Colombia             | Official Civil Register                                         | **Name, National ID (Cédula de Ciudadanía / PPT)**                                                       |
| CO           | Colombia             | Official National ID                                            | **Name, National ID (Cédula de Ciudadanía, Cédula de Extranjería, Tarjeta de Identidad, NIT, Passport)** |
| CR           | Costa Rica           | Official Voter Register                                         | **Name, Address, Gender**                                                                                |
| CR           | Costa Rica           | Official Civil Register                                         | **Name, National ID (Cédula de Identidad)**                                                              |
| HR           | Croatia              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| CU           | Cuba                 | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| CZ           | Czech Republic       | Residential - Property ownership registers                      | **Name, Address, Date of Birth**                                                                         |
| CZ           | Czech Republic       | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| CZ           | Czech Republic       | Official Civil Register and Credit Bureau                       | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| DK           | Denmark              | Civil Registration, Consumer                                    | **Name, Address, Date of Birth, Phone, National ID (CPR)**                                               |
| DK           | Denmark              | Consumer & Population Register                                  | **Name**, Address, Date of Birth, Phone                                                                  |
| DK           | Denmark              | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| DK           | Denmark              | Official Civil Register + Consumer Credit + Telco               | **Name**, Address, Date of Birth, **Phone**                                                              |
| DK           | Denmark              | Official Tax Register                                           | **Name**, Address, Date of Birth, Gender, National ID                                                    |
| DK           | Denmark              | Official Civil Register                                         | **Name**, Address, Phone                                                                                 |
| DO           | Dominican Republic   | Official Civil Register                                         | **Name, National ID (CIE Number)**                                                                       |
| DO           | Dominican Republic   | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Phone, National ID                                                     |
| EC           | Ecuador              | Official Civil Register                                         | **Name, National ID**                                                                                    |
| EC           | Ecuador              | Official Civil Register                                         | **Name, National ID (Cédula de Ciudadanía)**                                                             |
| EC           | Ecuador              | Official Civil Register                                         | **Name, National ID (Cédula de identidad)**                                                              |
| EE           | Estonia              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| EE           | Estonia              | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| FO           | Faroe Islands        | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| FI           | Finland              | National ID, Consumer                                           | **Name, Address, Date of Birth, National ID (PIN)**                                                      |
| FI           | Finland              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| FI           | Finland              | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Phone                                                                  |
| FI           | Finland              | Official Civil Register                                         | **Name**, Address, Phone                                                                                 |
| FR           | France               | Residential, Phone                                              | **Name, Address, Date of Birth, Phone**                                                                  |
| FR           | France               | Residential, Utility, Consumer                                  | **Name, Address, Date of Birth, Phone**                                                                  |
| FR           | France               | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| FR           | France               | Official Civil Register and Consumer Credit                     | **Name**, Address, Date of Birth, Phone, Gender                                                          |
| FR           | France               | Population Register                                             | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| FR           | France               | Consumer Data - Phone Register                                  | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| FR           | France               | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| FR           | France               | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| FR           | France               | Telco & MNO                                                     | **Name**, Address, Date of Birth, **Phone**                                                              |
| GE           | Georgia              | Official Resident Register                                      | **Name, Address, Gender**                                                                                |
| GE           | Georgia              | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| GE           | Georgia              | Official Department of Motor Vehicle                            | **Name, Address, Gender, National ID (Drivers license)**                                                 |
| DE           | Germany              | Credit Bureau, Residential                                      | **Name, Address, Date of Birth**                                                                         |
| DE           | Germany              | Credit Bureau, Residential, Phone, Utility                      | **Name, Address, Date of Birth, Phone**                                                                  |
| DE           | Germany              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| DE           | Germany              | Consumer, Population Register & Telco                           | **Name**, Address, Gender, Phone, Date of Birth                                                          |
| DE           | Germany              | Official Civil Register and Consumer Credit                     | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| DE           | Germany              | Utility - Phone Register and Mobile Phone Register              | **Name**, Address, Gender, Phone                                                                         |
| DE           | Germany              | Official Civil Register and Consumer Credit                     | **Name**, Address, Date of Birth                                                                         |
| DE           | Germany              | Credit Bureau                                                   | **Name**, **Address**, Date of Birth, Gender                                                             |
| GI           | Gibraltar            | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| GR           | Greece               | Official Voter Register and Consumer Credit                     | **Name, Address, Date of Birth, Gender, Phone, National ID**                                             |
| GR           | Greece               | Credit Bureau, Consumer                                         | **Name, Address, Date of Birth, Phone, National ID (AFM)**                                               |
| GR           | Greece               | Official Voter Register                                         | **Name**, Address, Date of Birth                                                                         |
| GR           | Greece               | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| GP           | Guadeloupe           | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| GT           | Guatemala            | Gov validation                                                  | **Name, Address, Gender, Phone**                                                                         |
| HK           | Hong Kong            | Official Resident Register                                      | **Name, Address, Gender**                                                                                |
| HK           | Hong Kong            | Gov agency - property ownership data                            | **Name, Address**                                                                                        |
| HK           | Hong Kong            | Land Register                                                   | **Name**, **Address**, Gender                                                                            |
| HU           | Hungary              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| IS           | Iceland              | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| IN           | India                | PAN, Aadhaar                                                    | **Name, Date of Birth, National ID (PAN or Aadhar)**                                                     |
| IN           | India                | Voter Register (EPIC)                                           | **Name, Date of Birth, Voter ID (EPIC)**                                                                 |
| IN           | India                | Passport Seva Kendra                                            | **Name, Date of Birth, National ID (Passport)**                                                          |
| IN           | India                | DMV (RoadTransport Offices of the States of India)              | **Name, Date of Birth, Address, National ID (Drivers license)**                                          |
| IN           | India                | Official Voter Register                                         | **Name**, **Address**, National ID (Identity card)                                                       |
| IN           | India                | Official National ID - Aadhar                                   | Address, Gender, **National ID (Aadhar card)**                                                           |
| IN           | India                | Official Department of Motor Vehicle                            | **Name**, Address, **Date of Birth**, **Gender**, **National ID (Drivers license)**                      |
| IN           | India                | Official National ID - Pan Card                                 | **Name**, Gender, **National ID (PAN card)**                                                             |
| IN           | India                | Telco & MNO                                                     | **Name**, Address, Date of Birth, Gender, **Phone**, National ID                                         |
| ID           | Indonesia            | Resident Identity Card                                          | **Name, Address, Date of Birth, Phone, National ID (NIK)**                                               |
| ID           | Indonesia            | Telco                                                           | **Name, Date of Birth, Phone**                                                                           |
| ID           | Indonesia            | Official National ID                                            | **Name**, Date Of Birth, Gender, **National ID**                                                         |
| ID           | Indonesia            | Consumer & Official Census                                      | **Name**, Address, Date of Birth, Gender                                                                 |
| ID           | Indonesia            | Official National ID                                            | **Name**, Address, Date of Birth, **National ID**                                                        |
| ID           | Indonesia            | Telco & MNO                                                     | **Name,** Address, Date of Birth, Gender, **Phone**                                                      |
| IR           | Iran                 | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| IE           | Ireland              | Credit Bureau                                                   | **Name, Address, Date of Birth**                                                                         |
| IE           | Ireland              | Residential, Voter Register                                     | **Name, Address, Date of Birth, National ID (PPSN)**                                                     |
| IE           | Ireland              | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| IE           | Ireland              | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| IE           | Ireland              | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| IE           | Ireland              | Official Resident Register                                      | **Name**, Address, Date of Birth, Gender                                                                 |
| IE           | Ireland              | Credit Bureau                                                   | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| IE           | Ireland              | Public Register, Consumer List, Telco                           | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| IL           | Israel               | Official Resident Register                                      | **Name, Address, Gender, Phone, National ID (Voter ID)**                                                 |
| IL           | Israel               | Official Resident Register                                      | **Name**, Address, **Phone**, National ID (Voter ID)                                                     |
| IT           | Italy                | Official Civil Register + Consumer Credit + Telco               | **Name, Address, Date of Birth, Phone**                                                                  |
| IT           | Italy                | Credit Bureau                                                   | **Name, Address, Date of Birth, National ID (Codice fiscale)**                                           |
| IT           | Italy                | Credit Bureau, Residential                                      | **Name, Address, Date of Birth, Phone**                                                                  |
| IT           | Italy                | Official Civil Register and Utility - Phone Register            | **Name**, Address, Date of Birth, **Phone**                                                              |
| IT           | Italy                | Population Register                                             | **Name**, Address, Date of Birth, Phone                                                                  |
| IT           | Italy                | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| IT           | Italy                | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| IT           | Italy                | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| IT           | Italy                | Official Resident Register & Utility Register                   | **Name**, Address, Date of Birth, Gender                                                                 |
| IT           | Italy                | Credit Bureau                                                   | **Name**, **Address**, Gender, Phone, **National ID (Tax ID)**                                           |
| IT           | Italy                | Telco & MNO                                                     | **Name**, Address, Date of Birth, Gender, **Phone**                                                      |
| JE           | Jersey Islands       | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| KE           | Kenya                | National ID                                                     | **Name, Date of Birth, National ID (NIN)**                                                               |
| KE           | Kenya                | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| KE           | Kenya                | Official National ID                                            | **Name**, **Date of Birth**, Gender, **National ID**                                                     |
| KG           | Kyrgyzstan           | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| KG           | Kyrgyzstan           | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| LV           | Latvia               | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| LY           | Libya                | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| LI           | Liechtenstein        | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| LT           | Lithuania            | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| LT           | Lithuania            | Official Voter Register                                         | **Name**, Address, Phone, National ID (Voter ID)                                                         |
| LU           | Luxembourg           | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| LU           | Luxembourg           | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| MY           | Malaysia             | National ID                                                     | **Name, Address, Date of Birth, Phone, National ID (NRIC)**                                              |
| MY           | Malaysia             | Credit Bureau                                                   | **Name, Address, Date of Birth, National ID (NRIC)**                                                     |
| MY           | Malaysia             | Credit Bureau                                                   | **Name**, Address, **Date of Birth**, Gender, **National ID**                                            |
| MY           | Malaysia             | Official Resident Register                                      | **Name**, Address, **Date of Birth**, Gender, **National ID**                                            |
| MY           | Malaysia             | Mobile Phone Register                                           | **Name**, Address, Date of Birth, Gender, Phone, National ID (Identity card)                             |
| MY           | Malaysia             | Official Voter Register                                         | **Name**, **Address**, Date of Birth, Gender, National ID (Identity card)                                |
| MY           | Malaysia             | Credit Bureau                                                   | **Name**, Date of Birth, Gender, **National ID**                                                         |
| MT           | Malta                | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| MT           | Malta                | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| MT           | Malta                | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| MQ           | Martinique           | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| MX           | Mexico               | Official Civil Register                                         | **Name, Date of Birth, National ID (CURP)**                                                              |
| MX           | Mexico               | Official Civil Register                                         | **Name, Date of Birth, National ID (RFC)**                                                               |
| MX           | Mexico               | RENAPO                                                          | **Name, Date of Birth, National ID (CURP)**                                                              |
| MX           | Mexico               | INE (Instituto Nacional Electoral)                              | **Name, Date of Birth, National ID (CURP)**                                                              |
| MX           | Mexico               | Telco                                                           | **Name, Address, Phone**                                                                                 |
| MX           | Mexico               | National Population Registry                                    | **Name**, **Address**, **Date of Birth**, Gender, **National ID (CURP / Voter ID)**                      |
| MD           | Moldova              | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| MA           | Morocco              | Telco                                                           | **Name, Address, Phone**                                                                                 |
| MA           | Morocco              | Mobile Phone Register                                           | **Name**, **Address**, Date of Birth, Phone                                                              |
| NA           | Namibia              | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, National ID (Voter ID / Tax ID)**                                |
| NP           | Nepal                | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| NP           | Nepal                | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| NL           | Netherlands          | Official Civil Register + Consumer Credit + Telco               | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| NL           | Netherlands          | Residential                                                     | **Name, Address, Date of Birth, Phone, Email**                                                           |
| NL           | Netherlands          | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| NL           | Netherlands          | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| NL           | Netherlands          | Population Register                                             | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| NL           | Netherlands          | Telco & MNO                                                     | **Name**, Address, Date of Birth, Gender, **Phone**                                                      |
| NZ           | New Zealand          | Credit Bureau                                                   | **Name, Address, Date of Birth, Gender**                                                                 |
| NZ           | New Zealand          | Consumer, Population Register & Telco                           | **Name, Address, Date of Birth, Phone**                                                                  |
| NZ           | New Zealand          | Residential, Consumer, Companies Office                         | **Name, Address, Date of Birth**                                                                         |
| NZ           | New Zealand          | Credit Bureau                                                   | **Name, Address, Date of Birth**                                                                         |
| NZ           | New Zealand          | DIA Birth Certificate                                           | **Name, Date of Birth**                                                                                  |
| NZ           | New Zealand          | DIA Passport                                                    | **Name, Date of Birth, National ID (Passport)**                                                          |
| NZ           | New Zealand          | NZTA verification service                                       | **Name, Date of Birth, National ID (Drivers license)**                                                   |
| NZ           | New Zealand          | New Zealand Birth, Deaths, Marriages Register                   | **Name, Address**                                                                                        |
| NZ           | New Zealand          | Official Resident Register                                      | **Name**, Address, Phone                                                                                 |
| NZ           | New Zealand          | Official Resident Register                                      | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| NZ           | New Zealand          | Official DIA Citizenship Register                               | **Name, Date of Birth**                                                                                  |
| NZ           | New Zealand          | Official National ID - DIA Passport                             | **Name, Date of Birth, National ID (Passport)**                                                          |
| NZ           | New Zealand          | Official NZTA Drivers License                                   | **Name, Date of Birth, National ID (Drivers license)**                                                   |
| NZ           | New Zealand          | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| NZ           | New Zealand          | NZTA and DIA                                                    | **Name**, Address, **Date of Birth**, **National ID (Drivers license / Passport)**                       |
| NG           | Nigeria              | National ID                                                     | **Name, Date of Birth, National ID (NIN)**                                                               |
| NG           | Nigeria              | Nigerian Banking Industry database                              | **Name, Date of Birth, National ID (BVN)**                                                               |
| NG           | Nigeria              | National ID Register                                            | **Name, Address, Date of Birth, Phone, National ID**                                                     |
| NG           | Nigeria              | Driver's License Register                                       | **Name, Date of Birth, National ID (Drivers license)**                                                   |
| NO           | Norway               | Residential, Consumer                                           | **Name, Address, Date of Birth, National ID (NIN)**                                                      |
| NO           | Norway               | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| NO           | Norway               | Mobile Phone Register                                           | **Name**, **Address**, Gender, Phone                                                                     |
| NO           | Norway               | Consumer & Population Register                                  | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| NO           | Norway               | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| NO           | Norway               | Official Postal Register & Utility - Phone Register             | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| PS           | Palestine            | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| PA           | Panama               | Official Civil Register                                         | **Name**, Date of Birth, **National ID (Cédula de Ciudadanía)**                                          |
| PE           | Peru                 | Tax Registration (SUNAT), National ID                           | **Name, Date of Birth, National ID (DNI)**                                                               |
| PE           | Peru                 | Residential                                                     | **Name, Address, Phone**                                                                                 |
| PE           | Peru                 | Official Voter Register                                         | **Name**, **Address**, Date of Birth, National ID (DNI)                                                  |
| PE           | Peru                 | Official Civil Register                                         | **Name**, Address, Date of Birth, **National ID (DNI)**                                                  |
| PE           | Peru                 | Official Civil Register                                         | **Name**, Date of Birth, Gender, National ID (DNI)                                                       |
| PE           | Peru                 | Official Tax Register                                           | **Name**, Gender, **National ID (Tax ID)**                                                               |
| PH           | Philippines          | Official Voter Register                                         | **Name**, Address, **Date of Birth**, Gender                                                             |
| PH           | Philippines          | Credit Bureau and Official National ID                          | **Name**, Address, **Date of Birth**, Gender, National ID                                                |
| PH           | Philippines          | Official Resident Register                                      | **Name**, Address, **Date of Birth**                                                                     |
| PH           | Philippines          | Residential, Credit Bureau                                      | **Name, Address, Date of Birth, National ID (SSN, TIN or GSIS)**                                         |
| PL           | Poland               | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| PL           | Poland               | Credit Bureau, Consumer                                         | **Name, Address, Date of Birth, Phone, Email**                                                           |
| PL           | Poland               | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| PL           | Poland               | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| PL           | Poland               | Credit Bureau                                                   | **Name**, **Address**, Date of Birth, Phone                                                              |
| PL           | Poland               | Credit Bureau                                                   | **Name**, **Address**, Date of Birth, Gender                                                             |
| PT           | Portugal             | Residential                                                     | **Name, Address, Date of Birth**                                                                         |
| PT           | Portugal             | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| PT           | Portugal             | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| PT           | Portugal             | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| PT           | Portugal             | Official Civil Register + Consumer Credit + Telco               | **Name**, Address, Date of Birth, Gender, **Phone**                                                      |
| PT           | Portugal             | Consumer                                                        | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| PR           | Puerto Rico          | Population Register                                             | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| RE           | Réunion              | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| RO           | Romania              | Official National ID                                            | **Name**, **Address**, Date of Birth, Gender, Phone                                                      |
| RU           | Russia               | Official Resident Register                                      | **Name, Address, Date of Birth, Gender, Phone, National ID (Tax ID)**                                    |
| RU           | Russia               | Official Department of Motor Vehicle                            | **Name, Address, Date of Birth, National ID (Drivers license)**                                          |
| RU           | Russia               | Consumer                                                        | **Name**, **Address**, Date of Birth, Phone                                                              |
| WS           | Samoa                | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| SG           | Singapore            | Utility, Credit Bureau                                          | **Name, Address, Date of Birth, Phone, National ID (NRIC)**                                              |
| SG           | Singapore            | Utility - Phone Register                                        | **Name**, **Address**, Date of Birth, Phone                                                              |
| SG           | Singapore            | Official Resident Register                                      | **Name**, **Address**, Date of Birth, Gender                                                             |
| SG           | Singapore            | Credit Bureau                                                   | **Name, Address, Date of Birth, National ID**                                                            |
| SG           | Singapore            | Credit Bureau                                                   | **Name**, Address, **Date of Birth**, Gender, **National ID**                                            |
| SK           | Slovakia             | Residential                                                     | **Name, Address, Date of Birth**                                                                         |
| SK           | Slovakia             | Official Resident Register                                      | **Name, Address**                                                                                        |
| SK           | Slovakia             | Official Civil Register and Credit Bureau                       | **Name**, **Address**, Date of Birth, Phone                                                              |
| SI           | Slovenia             | Utility - Phone Register                                        | **Name**, Address, Phone                                                                                 |
| SO           | Somalia              | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| ZA           | South Africa         | National ID                                                     | **Name, Date of Birth, National ID (ID number)**                                                         |
| KR           | South Korea          | National ID                                                     | **Name, Date of Birth, National ID (ID number)**                                                         |
| ES           | Spain                | Residential, Utility                                            | **Name, Address, Date of Birth, Phone**                                                                  |
| ES           | Spain                | National ID                                                     | **Name, Address, Date of Birth**                                                                         |
| ES           | Spain                | Official Census and Utility Services - Telephone Register       | **Name, Address, Date of Birth, Phone, National ID**                                                     |
| ES           | Spain                | Utility - Phone Register                                        | Name, Address, Gender, Phone                                                                             |
| ES           | Spain                | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| ES           | Spain                | Official Civil Register + Consumer Credit + Telco               | **Name**, Address, Date of Birth, **Gender**, **Phone**                                                  |
| ES           | Spain                | Consumer, Population Register & Telco                           | **Name,** Address, Date of Birth, Gender, Phone                                                          |
| ES           | Spain                | Telco & MNO                                                     | **Name**, Address, Date of Birth, **Gender**, **Phone**                                                  |
| SD           | Sudan                | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| SD           | Sudan                | Official Voter Register                                         | **Name**, Address, Gender, **National ID (Voter ID)**                                                    |
| SE           | Sweden               | National ID, Phone                                              | **Name, Address, Date of Birth, Phone, National ID (PIN)**                                               |
| SE           | Sweden               | Official Civil Register                                         | **Name, Address, Date of Birth, Gender, Phone, National ID**                                             |
| SE           | Sweden               | Utility - Phone Register                                        | **Name**, Address, Gender, Phone                                                                         |
| SE           | Sweden               | Consumer & Population Register                                  | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| SE           | Sweden               | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| SE           | Sweden               | Official Tax Register                                           | **Name**, **Address**, Date of Birth, Gender                                                             |
| CH           | Switzerland          | Credit Bureau, Consumer                                         | **Name, Address, Date of Birth, Phone, Email**                                                           |
| CH           | Switzerland          | Utility - Phone Register                                        | **Name, Address**                                                                                        |
| CH           | Switzerland          | Credit and Official Postal Register                             | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| CH           | Switzerland          | Credit Bureau                                                   | **Name**, Address, **Date of Birth**, Gender, Phone                                                      |
| CH           | Switzerland          | Telco & MNO                                                     | **Name**, Address, Gender, **Phone**                                                                     |
| SY           | Syria                | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| TW           | Taiwan               | Ministry of Interior                                            | **Name, Government ID (ID + Issue Date)**                                                                |
| TJ           | Tajikistan           | Official Voter Register                                         | **Name, Address, National ID (Voter ID)**                                                                |
| TJ           | Tajikistan           | Official Voter Register                                         | **Name**, Address, Gender, National ID (Voter ID)                                                        |
| TH           | Thailand             | National ID                                                     | **Name, Address, Date of Birth, National ID**                                                            |
| TH           | Thailand             | Consumer                                                        | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| TH           | Thailand             | Official Civil Register                                         | **Name**, Address, **Date of Birth**, Gender, **National ID**                                            |
| TT           | Trinidad and Tobago  | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| TR           | Turkey               | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, Phone, National ID (Voter ID)**                                  |
| TR           | Turkey               | Official Voter Register                                         | **Name**, Address, Date of Birth, Gender, National ID (Voter ID)                                         |
| TR           | Turkey               | Official Resident Register                                      | **Name**, Address, Date of Birth, Gender, National ID (Voter ID)                                         |
| TR           | Turkey               | Official Voter Register                                         | **Name**, **Address**, Date of Birth, Gender, Phone, National ID (Voter ID)                              |
| TR           | Turkey               | Consumer & Electoral Register                                   | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| TR           | Turkey               | Official Voter Register and Consumer Credit                     | **Name**, Address, Date of Birth, Gender, National ID                                                    |
| UG           | Uganda               | Official Voter Register                                         | **Name, Address, Gender, National ID (Voter ID)**                                                        |
| UA           | Ukraine              | Official Voter Register                                         | **Name, Address, Date of Birth**                                                                         |
| UA           | Ukraine              | Official Resident Register                                      | **Name, Address, Date of Birth, Gender, Phone, National ID (Tax ID)**                                    |
| UA           | Ukraine              | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| AE           | United Arab Emirates | Utility - Phone Register                                        | **Name**, Address, **Date of Birth**, Phone                                                              |
| GB           | United Kingdom       | Official Civil and Voter Register and Credit                    | **Name, Address, Date of Birth**                                                                         |
| GB           | United Kingdom       | Official Voter Register                                         | **Name**, Address, Gender                                                                                |
| GB           | United Kingdom       | Utility - Phone Register                                        | **Name, Address, Phone**                                                                                 |
| GB           | United Kingdom       | Official Voter Register                                         | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| GB           | United Kingdom       | Consumer, Population Register & Telco                           | **Name**, Address, Date of Birth, Gender, Phone                                                          |
| GB           | United Kingdom       | Official Census                                                 | Name, Address, Date of Birth, Gender                                                                     |
| GB           | United Kingdom       | Residential, Citizens, Credit Bureau                            | **Name, Address, Date of Birth, Phone**                                                                  |
| GB           | United Kingdom       | Official Resident Register                                      | **Name, Address, Gender, Phone**                                                                         |
| GB           | United Kingdom       | Telco & MNO                                                     | **Name, Address, Date of Birth, Gender, Phone**                                                          |
| GB           | United Kingdom       | Credit Bureau                                                   | **Name, Address, Date of Birth, Gender**                                                                 |
| US           | United States        | Telco                                                           | **Name**, Address, **Phone**, Date of Birth                                                              |
| US           | United States        | Telco                                                           | **Name**, Address, **Phone**, Date of Birth, National ID (Last 4 SSN, DL State, DL Number), Email        |
| US           | United States        | Credit Bureau                                                   | **Name**, **Address**, Date of Birth, Phone, **National ID (Full SSN)**, Email                           |
| US           | United States        | Credit + US Identity Graph                                      | **Name**, Address, Date of Birth, Gender, Phone, National ID                                             |
| US           | United States        | Official Civil Register and Consumer Credit                     | **Name**, **Address**, Date of Birth, Phone                                                              |
| US           | United States        | Official Social Security                                        | **Name**, **Address**, Date of Birth, Phone, National ID (SSN)                                           |
| UY           | Uruguay              | Official Civil Register                                         | **Name, Address, Date of Birth, National ID (Cédula de identidad)**                                      |
| UZ           | Uzbekistan           | Official Department of Motor Vehicle                            | **Name, Gender, National ID (Drivers License)**                                                          |
| VE           | Venezuela            | Official Voter Register                                         | **Name, Date of Birth, National ID**                                                                     |
| VE           | Venezuela            | Official Civil Register                                         | **Name, Gender, National ID**                                                                            |
| VE           | Venezuela            | Official Census                                                 | **Name, Address, Date of Birth, Gender, National ID**                                                    |
| VN           | Vietnam              | Official Resident Register                                      | **Name, Address, Date of Birth, Gender**                                                                 |
| VN           | Vietnam              | Official Resident Register                                      | **Name, Address, Date of Birth, Gender**                                                                 |
| YE           | Yemen                | Mobile Phone Register                                           | **Name, Address, Gender, Phone**                                                                         |
| ZW           | Zimbabwe             | Official Voter Register                                         | **Name, Address, Date of Birth, National ID (Voter ID)**                                                 |

</Accordion>

If you don't see the country or data source you need, or want more details about our coverage, contact your Incode representative to learn more about our expanding network.

## Country-specific guidelines

The following countries have dedicated documentation with source-specific integration and API details:

- [Argentina](/general-reference/ekyc-reference-argentina/)
- [Belgium](/general-reference/ekyc-belgium/)
- [Brazil](/general-reference/ekyc-reference-brazil/)
- [Canada](/general-reference/ekyc-reference-canada/)
- [Chile](/general-reference/ekyc-reference-chile/)
- [Colombia](/general-reference/colombia)
- [Costa Rica](/general-reference/ekyc-reference-costa-rica/)
- [Denmark](/general-reference/denmark/)
- [Finland](/general-reference/finland/)
- [Germany](/general-reference/ekyc-germany)
- [Greece](/general-reference/ekyc-reference-greece/)
- [Guatemala](/general-reference/ekyc-reference-guatemala/)
- [India](/general-reference/ekyc-reference-india/)
- [Italy](/general-reference/ekycitaly/)
- [Kyrgyzstan](/general-reference/kyrgyzstan/)
- [Mexico](/general-reference/ekyc-reference-mexico/)
- [Netherlands](/general-reference/ekyc-reference-netherlands/)
- [Nigeria](/general-reference/ekyc-reference-nigeria/)
- [Peru](/general-reference/peru/)
- [Philippines](/general-reference/ekyc-reference-philippines/)
- [Spain](/general-reference/ekyc-reference-spain/)
- [Sweden](/general-reference/ekyc-reference-sweden/)
- [Turkey](/general-reference/turkey/)
- [United Kingdom](/general-reference/ekyc-reference-united-kingdom/)
- [United States](/general-reference/ekyc-reference-united-states/)
- [Venezuela](/general-reference/venezuela/)

---

- Path: `general-reference/ekyc-germany`
- URL: https://developer.incode.com/general-reference/ekyc-germany/
- Markdown: https://developer.incode.com/general-reference/ekyc-germany.md

# Germany




Germany eKYC verification matches submitted individual data against Germany's utility phone register and mobile phone register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description |
|---|---|---|
| Germany Phone and Mobile Register | `DE_PHONE_MOBILE_REGISTER` | Verifies submitted data against Germany's utility phone register and mobile phone register. |

## Germany Phone and Mobile Register

### Request parameters

| Parameter | Required | Description |
|---|---|---|
| `source` | Mandatory | Must be `DE_PHONE_MOBILE_REGISTER`. |
| `country` | Mandatory | Must be `DE`. |
| `firstName` | Mandatory | First name of the individual. Must not contain digits. |
| `middleName` | Optional | Additional given name(s) (Vornamen). Must not contain digits. Germany does not use "middle name" the same way as countries like the US or UK — people can have multiple given names instead. |
| `surName` | Mandatory | Last name of the individual. Must not contain digits. |
| `phone` | Mandatory | Germany phone number. See format note below. |
| `street` | Optional | Full street including house number. |
| `city` | Optional | City of the individual's address (for example, Berlin). |
| `postalCode` | Optional | Germany postal code. See format note below. |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "DE_PHONE_MOBILE_REGISTER", //required field
    "firstName": "Lukas", //required field
    "middleName": "Johannes",
    "surName": "Müller", //required field
    "street": "Hauptstraße 25",
    "city": "Berlin",
    "postalCode": "10115",
    "country": "DE", //required field
    "phone": "493012345678" //required field
}
```

### Response fields

Germany Phone and Mobile Register anchors verification on individual name, address, and phone number. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field | Statuses | Description |
|---|---|---|
| `firstNameMatch` | exact, fuzzy, nomatch | Matches first name submitted against the value in the source of truth. |
| `middleNameMatch` | exact, fuzzy, nomatch, nodata | Matches additional given name(s) submitted against the value in the source of truth. |
| `lastNameMatch` | exact, fuzzy, nomatch | Matches last name submitted against the value in the source of truth. |
| `fullNameMatch` | exact, fuzzy, nomatch | Composite of `firstNameMatch`, `lastNameMatch`, and `middleNameMatch`. See below for calculation logic. |
| `streetMatch` | exact, fuzzy, nomatch, nodata | Matches street submitted against the value in the source of truth. |
| `cityMatch` | exact, fuzzy, nomatch, nodata | Matches city submitted against the value in the source of truth. |
| `postalCodeMatch` | exact, fuzzy, nomatch, nodata | Matches postal code submitted against the value in the source of truth. |
| `fullAddressMatch` | exact, fuzzy, nomatch, nodata | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `phoneMatch` | exact, fuzzy, nomatch, nodata | Matches phone submitted against the value in the source of truth. |
| `overallLevel` | low, medium, high | Overall risk level. See below for calculation logic. |

#### `fullNameMatch` calculation

- `exact` when `firstNameMatch` is exact and `lastNameMatch` is exact, and `middleNameMatch` is exact, fuzzy, or nodata.
- `nomatch` when `firstNameMatch` and `lastNameMatch` are both nomatch.
- `fuzzy` for any other combination.

#### `fullAddressMatch` calculation

- `exact` when `streetMatch` is exact, and `cityMatch` is exact or nodata, and `postalCodeMatch` is exact or nodata.
- `nomatch` when `streetMatch`, `cityMatch`, and `postalCodeMatch` are all nomatch.
- `nodata` when `streetMatch`, `cityMatch`, and `postalCodeMatch` are all nodata.
- `fuzzy` for any other combination.

#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name:

- `low` when `fullNameMatch` is exact.
- `high` when `fullNameMatch` is nomatch.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/ekyc-prefill-api-reference`
- URL: https://developer.incode.com/general-reference/ekyc-prefill-api-reference/
- Markdown: https://developer.incode.com/general-reference/ekyc-prefill-api-reference.md

# eKYC Prefill API Reference

The eKYC Prefill endpoint (`POST /omni/externalVerification/ekyc-prefill`) looks up the end user of the session in the configured source and returns the data the source holds. This page explains the request parameters, response schema, lookup limits, and error responses for that endpoint. For the sources available per country and the data each source returns, see [eKYC Prefill Coverage](/general-reference/ekyc-prefill-coverage/). For instructions on how to configure the module in Dashboard, see [eKYC Prefill (Dashboard)](/dashboard-platform-administration/ekyc-prefill-dashboard/).

The endpoint accepts an onboarding session token (`X-Incode-Hardware-Id`) and `x-api-key`, uses `application/json`, and responds synchronously. The Flow or Workflow used for the Session must contain the [eKYC Prefill module](/features-and-modules/ekyc-prefill/).

:::info
This is different than [eKYC API Reference](/general-reference/ekyc-api-reference/).
:::



## Request

| Field | Type | Required | Description |
|---|---|---|---|
| `source` | string | Yes | `US_PREFILL`, `US_PREFILL_EXPRESS`, or `BR_PREFILL`. Must match the source set in the session's module |
| `countryCode` | string | Yes | ISO 3166-1 alpha-2 country code. Must match the module's country: `US` for the US sources, `BR` for `BR_PREFILL` |
| `phone` | string | `US_PREFILL`, `US_PREFILL_EXPRESS` | Phone number in `E.164` format, for example `+12025550123`. Only `+1` numbers are accepted |
| `dateOfBirth` | string | `US_PREFILL` (one of three) | `yyyy-MM-dd`, not in the future and not more than 130 years ago |
| `ssn` | string | `US_PREFILL` (one of three) | 9 digits, as `123456789` or `123-45-6789` |
| `surName` | string | `US_PREFILL` (one of three) | Last name, at most 100 characters |
| `taxIdNumber` | string | `BR_PREFILL` | Brazilian CPF, as 11 digits or `XXX.XXX.XXX-XX` |

Take `source` and `countryCode` from the module in the session's flow configuration rather than hardcoding them. An organization can switch the module's source, and a request with the old source then returns `400`.

### Inputs per source

- `US_PREFILL`: `phone`, plus at least one of `dateOfBirth`, `ssn`, or `surName`. Only the identifiers enabled in the module configuration are accepted; sending one that is disabled returns `400`.
- `US_PREFILL_EXPRESS`: `phone` only.
- `BR_PREFILL`: `taxIdNumber` only. The CPF check digits are verified before the lookup, so an invalid CPF returns `400` without using up a lookup.

Each source ignores the fields it does not use, and never sends them to the data source. No field may be longer than 255 characters. Unknown fields are ignored. `firstName` and `includeDriverLicenseData` have no effect: driver's license data is returned only when the module's **Include driver's license data** option is on.

### Legacy fields

`plugins` (string array) is a legacy field. Do not include it in new integrations. When sent, it must be `["kyc-prefill"]`; any other value returns `400`.

### Example requests

```json Node
{
  "source": "US_PREFILL",
  "countryCode": "US",
  "phone": "+12025550123",
  "dateOfBirth": "1985-11-22"
}
```

```json Node
{ 
  "source": "US_PREFILL_EXPRESS", 
  "countryCode": "US", 
  "phone": "+12025550143" 
}
```

```json Node
{ 
  "source": "BR_PREFILL", 
  "countryCode": "BR", 
  "taxIdNumber": "123.456.789-00" 
}
```

:::info
The CPF in this example fails check-digit validation on purpose, so no real CPF appears in Incode's documentation. Send a valid CPF in production requests.
:::

## Response

`200 OK.` The result is under `kyc-prefill`. Null fields are omitted, and not every source returns every field; see [Returned data per source](/general-reference/ekyc-prefill-coverage/#returned-data-per-source) in eKYC Prefill Coverage.

### Response field categories

Response fields fall into six categories:

- **Status and reasons** describe the outcome of the lookup: `checkStatus`, `message`, `reasonCodes`, `reasons`.
- **Person data** returns the identity the source holds on the looked-up person: `returnedFirstName`, `returnedLastName`, `returnedFullName`, `returnedDob`, `returnedSsn`, `returnedIsItin`, `returnedTaxIdNumber`.
- **Contact information** returns the person's emails, addresses, and phone details: `returnedEmails`, `returnedAddresses`, `returnedPhoneDetails`, `returnedPhoneStatus`, `phoneValid`, `returnedAssociatedPhoneNumbers`.
- **Signals** flag characteristics of the person or their contact details: `returnedPersonSignals`, `returnedCreditSignals`, plus contact signals nested inside addresses and phone details.
- **Driver's license data** is returned only when the module's **Include driver's license data** option is on: `returnedDriverLicenses`.
- **Alternate identities** (`US_PREFILL_EXPRESS` only) list other people the source links to the same phone number: `additionalProfiles`.

### Response fields

| Field | Type | Description |
|---|---|---|
| `checkStatus` | string | `pass`, `partialPass`, `fail`, or `inconclusive`. See [Check statuses](/general-reference/ekyc-prefill-reference/#check-statuses) in eKYC Prefill Reference |
| `message` | string | Present only when no person data was returned. Human-readable and different per source: branch on `checkStatus`, not on this text |
| `returnedFirstName` | string | First name. Not returned by `BR_PREFILL` |
| `returnedLastName` | string | Last name. Not returned by `BR_PREFILL` |
| `returnedFullName` | string | Full name |
| `returnedDob` | string | Date of birth as the source holds it. Usually `yyyy-MM-dd`, but parse it defensively |
| `returnedSsn` | string | SSN as the source holds it. Some sources return it masked |
| `returnedIsItin` | boolean | Whether `returnedSsn` is an Individual Taxpayer Identification Number |
| `returnedTaxIdNumber` | string | `BR_PREFILL` only. The CPF the source holds for the person found, as 11 digits |
| `returnedPersonSignals` | object | Person signals, see below |
| `returnedPhoneDetails` | object | Phone details of the looked-up number, see below |
| `returnedPhoneStatus` | string | `US_PREFILL_EXPRESS` only. Phone status as the source reports it, for example `inactive`. Not a closed list |
| `phoneValid` | boolean | `US_PREFILL_EXPRESS` only. Whether the source considers the looked-up number valid |
| `returnedEmails` | string[] | Email addresses linked to the person |
| `returnedAddresses` | object[] | Addresses linked to the person, see below |
| `returnedCreditSignals` | object | Credit signals, see below |
| `returnedDriverLicenses` | object[] | Driver's licenses. Only when the module requests them |
| `returnedAssociatedPhoneNumbers` | object[] | Other phone numbers linked to the person. The looked-up number is left out |
| `additionalProfiles` | object[] | `US_PREFILL_EXPRESS` only. See [Additional profiles](#additional-profiles) below |
| `reasonCodes` | string[] | Reason codes behind the answer. Not a closed list |
| `reasons` | object[] | Each reason with its code and message |

For the list fields, absent and `[]` both mean none.

### Person signals

| Field | Type | Description |
|---|---|---|
| `isDeceased` | boolean | The person is reported deceased |
| `hasSanction` | boolean | The person appears on a sanctions list |
| `activeMilitary` | boolean | The person is on active military duty |
| `fraudCriminalBackground` | boolean | The person has a fraud or criminal record |

### Phone details

| Field | Type | Description |
|---|---|---|
| `activityScore` | integer | Phone activity score from the source |
| `type` | string | Line type, for example `Mobile` |
| `carrier` | string | Carrier name |
| `lastPorted` | string | Date the number was last ported. Not every source returns it |
| `activityDescription` | string | Free text from the source. Do not branch on it. Not every source returns it |
| `codeRangeAllocated` | boolean | Passed through from the source. Not every source returns it |
| `signals` | object | Contact signals, see below |

### Address

| Field | Type | Description |
|---|---|---|
| `street` | string | Street address |
| `street2` | string | Second address line, when the record has one |
| `city` | string | City |
| `state` | string | State |
| `postalCode` | string | Postal code |
| `signals` | object | Contact signals, see below. Not returned by `BR_PREFILL` |

### Contact signals

| Field | Type | Description |
|---|---|---|
| `highFrequency` | boolean | The phone or address is used by an unusually high number of identities |
| `possibleFraudRisk` | boolean | The phone or address is linked to possible fraud |

### Credit signals

| Field | Type | Description |
|---|---|---|
| `consumerVictimStatement` | boolean | A consumer victim statement is on file |
| `extendedConsumerVictimStatement` | boolean | An extended consumer victim statement is on file |

### Driver's license

| Field | Type | Description |
|---|---|---|
| `licenseNumber` | string | License number |
| `issuingState` | string | Issuing state |
| `firstReportedDate` | string | First date the license was reported |
| `lastReportedDate` | string | Last date the license was reported |

### Associated phone number

| Field | Type | Description |
|---|---|---|
| `phoneNumber` | string | Phone number |
| `firstReportedDate` | string | First date the number was reported for the person |
| `lastReportedDate` | string | Last date the number was reported for the person |

### Additional profiles

`US_PREFILL_EXPRESS` only. Other identities the source links to the same phone number. They are less reliable than the main result and can be different people. Each profile has the main result's person and contact fields (`returnedFirstName`, `returnedLastName`, `returnedFullName`, `returnedDob`, `returnedPersonSignals`, `returnedEmails`, `returnedAddresses`, `returnedCreditSignals`, `returnedDriverLicenses`, `returnedAssociatedPhoneNumbers`), and never an `SSN`, phone details, a `checkStatus`, or `reasons`.

At most 4 profiles are returned. The field is absent when there are none, which does not mean that nobody else is linked to the number.

### Example response

`US_PREFILL`, fictional data:

```json Node
{
  "kyc-prefill": {
    "checkStatus": "pass",
    "returnedFirstName": "Sarah",
    "returnedLastName": "Johnson",
    "returnedFullName": "Sarah Johnson",
    "returnedDob": "1985-11-22",
    "returnedSsn": "987-65-4321",
    "returnedPersonSignals": { "isDeceased": false, "hasSanction": false, "activeMilitary": false, "fraudCriminalBackground": false },
    "returnedPhoneDetails": {
      "activityScore": 1000,
      "type": "Mobile",
      "carrier": "Example Wireless",
      "signals": { "highFrequency": false, "possibleFraudRisk": false }
    },
    "returnedEmails": ["sarah.johnson@example.com"],
    "returnedAddresses": [
      {
        "street": "100 Maple Dr",
        "city": "Bethesda",
        "state": "MD",
        "postalCode": "20814",
        "signals": { "highFrequency": false, "possibleFraudRisk": false }
      }
    ],
    "returnedCreditSignals": { "consumerVictimStatement": false, "extendedConsumerVictimStatement": false },
    "returnedAssociatedPhoneNumbers": [
      { "phoneNumber": "+12025550147", "firstReportedDate": "2025-08-15", "lastReportedDate": "2025-11-06" }
    ],
    "reasonCodes": ["MC1006", "MC1000"],
    "reasons": [
      { "code": "MC1006", "message": "Phone number intelligence check met" },
      { "code": "MC1000", "message": "Phone Number and date of birth match" }
    ]
  }
}
```

`BR_PREFILL`, fictional data:

```json Node
{
  "kyc-prefill": {
    "checkStatus": "pass",
    "returnedFullName": "Ana Paula Costa Ferreira",
    "returnedDob": "1970-03-12",
    "returnedTaxIdNumber": "12345678900",
    "returnedEmails": ["ana.ferreira@example.com"],
    "returnedAddresses": [
      { "street": "R Exemplo 307", "city": "Fortaleza", "state": "CE", "postalCode": "60710160" },
      { "street": "AV Modelo 696", "street2": "AP 3", "city": "Fortaleza", "state": "CE", "postalCode": "60415540" }
    ],
    "reasonCodes": ["MC1008"],
    "reasons": [{ "code": "MC1008", "message": "Id number match" }]
  }
}
```

### No data found

When the source holds no data for the identifier, the response is still `200`, with `checkStatus` `fail` (or `inconclusive` for `BR_PREFILL`), a message, and the source's reason codes. `US_PREFILL_EXPRESS` also returns the phone fields for the looked-up number when the source checked it.

```json Node
{
  "kyc-prefill": {
    "checkStatus": "fail",
    "message": "No person data was returned for the provided phone number.",
    "returnedPhoneStatus": "inactive",
    "phoneValid": false,
    "reasonCodes": ["RC2001", "RC1006"],
    "reasons": [ ... ]
  }
}
```

A `fail` means nobody is on file. A failure of the data source is never reported as `fail`; it returns `503`, see [Errors](#errors) below.

### Minimum age

A source can set a minimum age for the people it returns. `BR_PREFILL` sets it at 18; the US sources set none. When the person found is under that age, or their age cannot be established from the date of birth, the answer is withheld:

```json Node
{
  "kyc-prefill": {
    "checkStatus": "pass",
    "returnedEmails": [],
    "returnedAddresses": [],
    "reasonCodes": ["Minor"],
    "reasons": [{ "code": "Minor", "message": "..." }]
  }
}
```

- `checkStatus` stays `pass`, because the source did match, and no person field is returned.
- `Minor` and `AgeUnknown` are the two reason codes. They come from Incode, not from the source.
- No person data from the source is stored for the lookup, and neither is the identifier that was sent.
- The lookup counts against the session limit, and a repeat of it is not matched to the stored answer. With `BR_PREFILL`'s limit of one lookup per session, treat a withheld answer as final.

### Lookups per session

Lookups are limited per session and the limit does not reset. See [Lookup limits](/general-reference/ekyc-prefill-coverage/#lookup-limits) in eKYC Prefill Coverage.

- Any answer (`pass`, `partialPass`, `fail`, or `inconclusive`) uses up one lookup. A `400` or a `503` does not.
- A repeated call with the same input in the same session returns the stored result. It does not make a new lookup and does not use up the limit.
- Once the limit is reached, a call with new input returns `429`.

## Errors

The eKYC Prefill endpoint returns conventional HTTP response codes. Validation errors return `400` with a specific message; authentication and authorization errors return `401` or `403`; lookup limits return `429`; data source failures return `503`. The error body has this shape:

```json Node
{
  "timestamp": 1760600000000,
  "status": 400,
  "error": "Send at least one of: dateOfBirth, ssn, surName.",
  "message": "Send at least one of: dateOfBirth, ssn, surName.",
  "path": "/omni/externalVerification/ekyc-prefill"
}
```

The `error` and `message` fields are always identical. Parse either one.

| HTTP | Body status | Cause |
|---|---|---|
| 400 | 400 | A field is missing, too long, or has the wrong format; `source` or `countryCode` does not match the module; or an identifier is not enabled in the module. See the messages below |
| 400 | 4210 | Phone number country is not supported. The phone is not a `+1` number, or the source rejects it for the country |
| 401 | (no body) | Missing, invalid, or expired session token, or a token from a different organization than the `x-api-key` |
| 403 | 4091 | The token is not an onboarding session token with the required access level |
| 403 | 403 | The session or the organization cannot use this module. See the messages below |
| 406 | 406 | The body is empty or not JSON, or a field has the wrong JSON type |
| 409 | 409 | Another call for the same session is still running |
| 415 | 415 | `Content-Type` is missing or is not `application/json` |
| 429 | 429 | The eKYC Prefill lookup limit for this session has been reached |
| 429 | (plain text) | The organization rate limit was reached. Only this one sends `Retry-After` |
| 503 | 8001 | The data source could not be reached or did not give a usable answer. Retrying later can succeed |

### 400 messages

| Message | Cause |
|---|---|
| source is required. Supported sources: ... | `source` is missing |
| source is not supported. Supported sources: ... | `source` is not one of the listed values |
| source XX is not the source configured for this session. | `source` does not match the module |
| countryCode must be XX for source YY. | `countryCode` does not match the source |
| phone is required. / taxIdNumber is required. | The source's lookup identifier (`phone` or `taxIdNumber`) is missing |
| Send at least one of: dateOfBirth, ssn, surName. | `US_PREFILL` was called with the `phone` only |
| XX is not enabled in this session's eKYC Prefill configuration. | An identifier was sent that the module does not enable |
| phone must be in E.164 format..., phone is not a valid phone number. | `phone` is not a valid `E.164` number |
| dateOfBirth must use the yyyy-MM-dd format., etc. | `dateOfBirth` is invalid |
| ssn must have 9 digits, as 123456789 or 123-45-6789. | `ssn` is invalid |
| surName cannot be blank. | `surName` is blank |
| taxIdNumber must be a CPF, as 11 digits or XXX.XXX.XXX-XX. | `taxIdNumber` does not have a CPF format |
| taxIdNumber is not a valid CPF. | The CPF check digits do not match |
| XX cannot be longer than N characters. | A field is too long |
| plugins must be ["kyc-prefill"] when it is sent. | `plugins` has another value |

### 403 messages

| Message | Cause |
|---|---|
| The onboarding session is closed or does not belong to this organization. | The session is closed, deleted, or belongs to another organization |
| eKYC Prefill is not part of this session's flow or workflow. | The session's Flow or Workflow does not contain the module |
| The eKYC Prefill module is configured with a country its source does not serve. | The module's country is not the source's country |
| eKYC Prefill is not available for this source. | The source is not enabled |
| eKYC Prefill is not provisioned for this organization and country. | The organization is not enabled for the source in that country |

---

- Path: `general-reference/ekyc-prefill-coverage`
- URL: https://developer.incode.com/general-reference/ekyc-prefill-coverage/
- Markdown: https://developer.incode.com/general-reference/ekyc-prefill-coverage.md

# eKYC Prefill Coverage

The [eKYC Prefill module](/features-and-modules/ekyc-prefill/) is available in the countries and sources below. The module's country and source are set in the module configuration, and every request must match them.

Each source must also be enabled for the organization. Contact your Incode representative to enable a source.

:::info
This is different than [eKYC Coverage](/general-reference/ekyc-coverage/).
:::

## Sources

| Country | Code | Source | Dashboard label | Looks up by | Also needs | Minimum age |
|---|---|---|---|---|---|---|
| United States | `US` | `US_PREFILL` | US Pre-fill | `phone` | one of `dateOfBirth`, `ssn`, `surName` | none |
| United States | `US` | `US_PREFILL_EXPRESS` | US Pre-fill Express | `phone` | nothing | none |
| Brazil | `BR` | `BR_PREFILL` | BR Pre-fill | `taxIdNumber` (CPF) | nothing | 18 |

## Input formats

| Field | Format |
|---|---|
| `phone` | `E.164`, with the country code. Only `+1` numbers are accepted; the data source makes the final call on numbers from other `+1` regions, such as Canada |
| `dateOfBirth` | `yyyy-MM-dd`, not in the future and not more than 130 years ago |
| `ssn` | 9 digits, as `123456789` or `123-45-6789` |
| `surName` | Last name, at most 100 characters |
| `taxIdNumber` | Brazilian CPF, as 11 digits or `XXX.XXX.XXX-XX`. The check digits are verified before the lookup |

## Returned data per source

A Yes in the table below means the source can return the field; it is returned only when the source holds the data.

| Field | `US_PREFILL` | `US_PREFILL_EXPRESS` | `BR_PREFILL` |
|---|---|---|---|
| `returnedFirstName`, `returnedLastName` | Yes | Yes | No |
| `returnedFullName` | Yes | Yes | Yes |
| `returnedDob` | Yes | Yes | Yes |
| `returnedSsn`, `returnedIsItin` | Yes | Yes | No |
| `returnedTaxIdNumber` | No | No | Yes |
| `returnedPersonSignals` | Yes | Yes | No |
| `returnedPhoneDetails` | Yes | Yes | No |
| `returnedPhoneStatus`, `phoneValid` | No | Yes | No |
| `returnedEmails` | Yes | Yes (up to 4) | Yes (up to 4) |
| `returnedAddresses` | Yes | Yes (up to 4) | Yes (up to 4, no signals) |
| `returnedCreditSignals` | Yes | Yes | No |
| `returnedDriverLicenses` | Yes (when enabled) | Yes (when enabled, up to 4) | No |
| `returnedAssociatedPhoneNumbers` | Yes | Yes (up to 4) | No |
| `additionalProfiles` | No | Yes (up to 4) | No |
| `checkStatus: inconclusive` | No | No | Yes |

Driver's licenses are returned only when the module's **Include driver's license data** option is on. When it is on and the person has no license on file, `US_PREFILL` returns `returnedDriverLicenses: []` and `US_PREFILL_EXPRESS` leaves the field out. Treat both the same.

On `fail`, `US_PREFILL_EXPRESS` still returns `returnedPhoneDetails`, `returnedPhoneStatus`, and `phoneValid` for the looked-up number when the source checked it.

## Lookup limits

| Source | Lookups per session |
|---|---|
| `US_PREFILL` | 3 |
| `US_PREFILL_EXPRESS` | 3 |
| `BR_PREFILL` | 1 |

Each answer (`pass`, `partialPass`, `fail`, or `inconclusive`) uses up one lookup, and the limit does not reset. A repeated call with the same input in the same session returns the stored result without using up a lookup. Requests rejected with `400` and source failures (`503`) do not count. See [Lookups per session](/general-reference/ekyc-prefill-api-reference/#lookups-per-session) in the eKYC Prefill API Reference.

---

- Path: `general-reference/ekyc-prefill-reference`
- URL: https://developer.incode.com/general-reference/ekyc-prefill-reference/
- Markdown: https://developer.incode.com/general-reference/ekyc-prefill-reference.md

# eKYC Prefill Reference

This section provides API-level reference material for eKYC Prefill. Use these pages to understand how a lookup works, request and response semantics, the sources and identifiers available per country, and the data each source returns.

:::info
This is different than [eKYC Reference](/general-reference/ekyc-reference/).
:::



For an overview of how to configure eKYC Prefill in your Dashboard, see [eKYC Prefill Dashboard configuration](/dashboard-platform-administration/ekyc-prefill-dashboard/).

## How a lookup works

The end user provides the identifiers the configured source needs. Then Incode:

1. Checks that the Session contains this module and that the organization is enabled for its source.
2. Validates the identifiers against the source's requirements, before any lookup is made.
3. Looks up the person in the source for the module's country.
4. Returns the person's data together with a `checkStatus` and stores the result with the Session.

## Check statuses

| Value | Meaning |
|---|---|
| pass | The person was found and their data is returned. |
| partialPass | The person was found, but one of the source's checks was not met. Data is returned. |
| fail | No person data was returned. A message says why. Also covers answers where the source found more than one possible person. |
| inconclusive | BR_PREFILL source only. The source could not decide. No person data is returned. |

A `pass` with no person data and a `Minor` or `AgeUnknown` reason code means the answer was withheld, because the person found is under the source's minimum age or their age could not be established. See [Minimum age](/general-reference/ekyc-prefill-api-reference/#minimum-age) in the eKYC Pre-fill API Reference.

Treat an unrecognized status as `fail`.

## What's in this section

- [eKYC Prefill API Reference](/ekyc-prefill-api-reference/) explains the request, response, and error schemas for `POST /omni/externalVerification/ekyc-prefill`, including the minimum age rule and lookups per session.
- [eKYC Prefill Coverage](/ekyc-prefill-coverage/) lists the countries and sources Incode supports, the identifiers each source needs, the data each source returns, and the lookup limit per source.

---

- Path: `general-reference/ekyc-reason-codes`
- URL: https://developer.incode.com/general-reference/ekyc-reason-codes/
- Markdown: https://developer.incode.com/general-reference/ekyc-reason-codes.md

# eKYC Reason Codes

Electronic Know Your Customer (eKYC) reason codes provide additional context for match results and risk assessments returned by the eKYC API. Reason codes indicate why a specific risk level was returned, or add nuance to a match result. For example, a reason code may indicate that an address matched but is a PO Box, or that a phone number is associated with a high-risk carrier.

Reason codes are returned in the `reasonCodes` array on the relevant response field (`overallLevel`, `taxIdLevel`, `phoneLevel`, `addressRiskLevel`, `emailLevel`, `emailDomainLevel`). For examples of how reason codes appear in API responses, see the sample responses on the country pages under [eKYC Coverage](/general-reference/ekyc-coverage/). For the response field concepts, see [eKYC API Reference](/general-reference/ekyc-api-reference/).

The tables below list all reason codes by category (Phone, Email, Tax ID, Address), including their status. **Live** codes are actively returned by the API. **Deprecated** codes are no longer returned but may still appear in historical data. **New** codes were added in the most recent update (December 2025).

## Phone Reason Codes

| Reason Code | Description                                                                                                                                                                                                                                                                  | Status                   |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| P2OSOV      | Two identities have OS or OV reason codes.                                                                                                                                                                                                                                   | New: Added December 2025 |
| P3OSOV      | Three identities have OS or OV reason codes.                                                                                                                                                                                                                                 | New: Added December 2025 |
| P4OSOV      | Four identities have OS or OV reason codes.                                                                                                                                                                                                                                  | New: Added December 2025 |
| P5OSOV      | Five or more identities have OS or OV reason codes.                                                                                                                                                                                                                          | New: Added December 2025 |
| PA15        | There was activity on this number in the last 15 days.                                                                                                                                                                                                                       | Deprecated               |
| PA24        | There was activity on this number in the last 24 hours.                                                                                                                                                                                                                      | Deprecated               |
| PA2M        | There was activity on this number in the last two months.                                                                                                                                                                                                                    | Deprecated               |
| PA3M        | There was activity on this number in the last three months.                                                                                                                                                                                                                  | Deprecated               |
| PABA        | The address provided in the request is a business address.                                                                                                                                                                                                                   | Live                     |
| PABM        | The address provided resulted in a better match than the normalized address.                                                                                                                                                                                                 | Live                     |
| PACF        | The address provided in the request matches the address of a U.S. correctional facility.                                                                                                                                                                                     | Live                     |
| PADU        | The address provided in the request is a dual address: for example, 123 Main St PO Box 99.                                                                                                                                                                                   | Live                     |
| PAE         | Some empty address fields were completed through address normalization for the address match check.                                                                                                                                                                          | Live                     |
| PAHR        | The address provided in the request is for a building that contains sub-units, such as apartments.                                                                                                                                                                           | Live                     |
| PAIN        | The address provided in the request is inactive. For example, new developments may have addresses but are inactive until someone moves in; or, after a natural disaster, addresses in the affected area are marked as inactive for a time.                                   | Live                     |
| PALT        | The address provided is in low tenure.                                                                                                                                                                                                                                       | Live                     |
| PAM         | There was activity on this number in the last month.                                                                                                                                                                                                                         | Deprecated               |
| PAMA        | The address provided in the request is tied to multiple active addresses. The address may be missing a suite or apartment number.                                                                                                                                            | Live                     |
| PAML        | The address provided in the request is a military address.                                                                                                                                                                                                                   | Live                     |
| PANN        | There is no name and address information associated with the phone number provided.                                                                                                                                                                                          | Live                     |
| PANV        | The address provided could not be verified.                                                                                                                                                                                                                                  | Live                     |
| PAPM        | The address provided is associated with a Private Mailbox operator: for example, a UPS store.                                                                                                                                                                                | Live                     |
| PAPO        | The address provided is a PO Box.                                                                                                                                                                                                                                            | Live                     |
| PAUD        | The address provided in the request is an undeliverable address.                                                                                                                                                                                                             | Live                     |
| PAV         | The address provided is vacant—unoccupied in the past 90 days.                                                                                                                                                                                                               | Live                     |
| PAVN        | The address provided in the request is valid and has been normalized prior to calculating the match score.                                                                                                                                                                   | Live                     |
| PAW         | There was activity on this number in the last seven days.                                                                                                                                                                                                                    | Deprecated               |
| PBL         | The number is associated with a business line.                                                                                                                                                                                                                               | New: Added December 2025 |
| PBOT        | The behavior pattern that suggests this number is being used by a bot.                                                                                                                                                                                                       | Deprecated               |
| PCA         | There are common addresses appearing across multiple seemingly unrelated identities associated with the phone number. This can indicate a higher risk of fraudulent activity.                                                                                                | New: Added December 2025 |
| PCC         | The behavior pattern that suggests this number is being used by a call center.                                                                                                                                                                                               | Deprecated               |
| PCSV90      | Continuous successful regular volume of verification traffic on this number over the past 90 days.                                                                                                                                                                           | New: Added December 2025 |
| PCU         | The carrier call was unsuccessful.                                                                                                                                                                                                                                           | New: Added December 2025 |
| PCV90       | Continuous successful regular volume of verification traffic from a range this number belongs to over the past 90 days.                                                                                                                                                      | New: Added December 2025 |
| PD1         | The phone number was found to be a web-scraped number showing as active.                                                                                                                                                                                                     | New: Added December 2025 |
| PD2         | The phone number was recently deactivated.                                                                                                                                                                                                                                   | New: Added December 2025 |
| PDI         | The phone record data has a death indicator; the person associated with this record has been identified as deceased.                                                                                                                                                         | Live                     |
| PDL         | No driver's license data is available to match to the submitted driver's license parameters.                                                                                                                                                                                 | Live                     |
| PDLA        | No driver's license data is available to match to the submitted driver's license parameters.                                                                                                                                                                                 | Deprecated               |
| PDR         | The device date returned was not obtained in real-time; there may be a more recent device change.                                                                                                                                                                            | New: Added December 2025 |
| PDS         | T-Mobile customers only: the mobile number has been identified as Do Not Sell by the carrier, and live data was not used for the Trust Score.                                                                                                                                | New: Added December 2025 |
| PDV         | High device change velocity is associated with the phone.                                                                                                                                                                                                                    | New: Added December 2025 |
| PE24        | Expected activity for this number over the last 24 hours.                                                                                                                                                                                                                    | Live                     |
| PE90        | Expected activity for this number over the past 90 days.                                                                                                                                                                                                                     | Live                     |
| PECD        | Expected call duration for this number over the past 90 days.                                                                                                                                                                                                                | Deprecated               |
| PELT        | Expected activity on this number over a tenure greater than or equal to 90 days (long-term).                                                                                                                                                                                 | Deprecated               |
| PES         | Expected success for this number over the past 90 days.                                                                                                                                                                                                                      | Deprecated               |
| PES90       | Extremely significant activity for a risky range that this number belongs to over the past 90 days.                                                                                                                                                                          | Deprecated               |
| PFF         | Call forwarding was not enabled on the phone.                                                                                                                                                                                                                                | New: Added December 2025 |
| PFIS        | Few incoming calls were successful for this number.                                                                                                                                                                                                                          | Deprecated               |
| PFN         | A family name was found and used in the name matching calculation.                                                                                                                                                                                                           | Live                     |
| PFO         | Call forwarding was enabled on the phone.                                                                                                                                                                                                                                    | New: Added December 2025 |
| PFOI        | Few outgoing calls were successful and very few incoming calls were successful for this number.                                                                                                                                                                              | Deprecated               |
| PFOS        | Few outgoing calls were successful for this number.                                                                                                                                                                                                                          | Deprecated               |
| PFRD        | This number has been flagged as a source of fraud. The score always recommends blocking this number.                                                                                                                                                                         | Live                     |
| PFXL        | This is a fixed line number.                                                                                                                                                                                                                                                 | New: Added December 2025 |
| PH90        | Higher than expected activity on this number within one or more 24-hour periods within the last 90 days. Spikes within one hour are also considered.                                                                                                                         | Deprecated               |
| PHAI        | Activity towards this number is coming from a higher-than-expected quantity of unique phone numbers.                                                                                                                                                                         | Deprecated               |
| PHAO        | Activity from this number is going to a higher-than-expected quantity of unique phone numbers.                                                                                                                                                                               | Deprecated               |
| PHLT        | Higher than expected activity on this number over a tenure greater than or equal to 90 days (long-term).                                                                                                                                                                     | Deprecated               |
| PHRL        | The provided phone number is associated with a high-risk line type (Non-Fixed VoIP or Prepaid MVNO)—available for most carriers with consent.                                                                                                                                | Live                     |
| PHSLT       | Higher than expected activity on this number within one or more 24-hour periods within the tenure (either short or long-term). Spikes within one hour are also considered.                                                                                                   | Deprecated               |
| PHV         | High velocity of change events associated with the phone.                                                                                                                                                                                                                    | New: Added December 2025 |
| PILE        | The number of identities associated with the phone number has exceeded the phone data provider's suggested limit. This can indicate a higher risk of fraudulent activity.                                                                                                    | Live                     |
| PINV        | The number is invalid.                                                                                                                                                                                                                                                       | Live                     |
| PKA         | Ownership tenure is between eight and 14 days.                                                                                                                                                                                                                               | New: Added December 2025 |
| PKB         | Ownership tenure is between 15 and 21 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PKC         | Ownership tenure is between 22 and 30 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PKD         | Ownership tenure is between 31 and 45 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PKE         | Ownership tenure is between 46 and 60 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PKF         | Ownership tenure is between 61 and 90 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PKG         | Ownership tenure is between 91 and 120 days.                                                                                                                                                                                                                                 | New: Added December 2025 |
| PKH         | Ownership tenure is between 121 and 150 days.                                                                                                                                                                                                                                | New: Added December 2025 |
| PKI         | Ownership tenure is between 151 and 180 days.                                                                                                                                                                                                                                | New: Added December 2025 |
| PKJ         | Ownership tenure is between 181 and 365 days.                                                                                                                                                                                                                                | New: Added December 2025 |
| PKK         | Ownership tenure is between 366 and 730 days.                                                                                                                                                                                                                                | New: Added December 2025 |
| PKL         | Ownership tenure is between 731 and 1095 days.                                                                                                                                                                                                                               | New: Added December 2025 |
| PKM         | Ownership tenure is between 1096 and 1460 days.                                                                                                                                                                                                                              | New: Added December 2025 |
| PKN         | Ownership tenure is between 1461 and 1825 days.                                                                                                                                                                                                                              | New: Added December 2025 |
| PKO         | Ownership tenure is greater than 1826 days.                                                                                                                                                                                                                                  | New: Added December 2025 |
| PLEA        | Much less than expected activity or none at all for this number over the past 90 days. Cannot classify.                                                                                                                                                                      | Live                     |
| PLLT        | Lower than expected activity on this number over a tenure greater than or equal to one week (long-term).                                                                                                                                                                     | Deprecated               |
| PLP         | Device Change \< 90 days OR SIM Change \< 90 days OR Mobile Number Change \< 90 days                                                                                                                                                                                         | New: Added December 2025 |
| PLS         | Device Change \< 90 days OR SIM Change \< 90 days                                                                                                                                                                                                                            | Live                     |
| PLST        | Lower than expected activity on this number over a tenure less than one week (short-term). Cannot classify.                                                                                                                                                                  | Deprecated               |
| PLT         | Device Change \< 90 days old                                                                                                                                                                                                                                                 | New: Added December 2025 |
| PMA24       | More than expected activity for this number over the last 24 hours.                                                                                                                                                                                                          | Live                     |
| PMA90       | More than expected activity for this number over the past 90 days.                                                                                                                                                                                                           | Live                     |
| PMAE        | More activity than expected is going from this number towards unassigned phone numbers. Both the volume of activity and the quantity of unique unassigned numbers are considered.                                                                                            | Deprecated               |
| PMAIC       | More activity than expected is coming to this number from numbers of risky countries. Both the risk level of the country and the amount of traffic between the number and that country are considered.                                                                       | Deprecated               |
| PMAOC       | More activity than expected is going from this number towards numbers of risky countries. Both the risk level of the country and the amount of traffic between the number and that country are considered.                                                                   | Deprecated               |
| PMAOP       | More activity than expected is going from this number towards premium numbers. Both the quantity of premium numbers and the amount of traffic to those numbers are considered.                                                                                               | Deprecated               |
| PMAOT       | More activity than expected is coming from this number towards toll-free numbers. Both the quantity of toll-free numbers and the amount of traffic from those numbers are considered.                                                                                        | Deprecated               |
| PML         | The phone number provided has been matched with the identity information—such as name and address—for more than 90 days (long tenure).                                                                                                                                       | Live                     |
| PMNA        | The provided mobile phone number is not active. This is available for most carriers with consent.                                                                                                                                                                            | Live                     |
| PMO         | The phone number provided has been matched with the identity information—such as name and address—and the ownership or association to this phone number was not recent; however, there is no known, newer ownership or association found. The ownership is considered older. | Live                     |
| PMS         | More success than expected for this number over the past 90 days. Impact depends on activity level. For higher-than-expected activity, this is a risk signal. For expected or lower-than-expected activity this is a trust signal.                                           | Deprecated               |
| PMST        | The phone number provided has been matched with the identity information—such as name and address—for between eight and 90 days (short tenure).                                                                                                                              | Live                     |
| PMU         | The phone number provided has been matched with the identity information—such as name and address—for an unknown amount of time (unknown tenure).                                                                                                                            | Live                     |
| PMVS        | The phone number provided has been matched with the identity information—such as name and address—for less than seven days (very short tenure).                                                                                                                              | Live                     |
| PN3M        | No activity on this number in the last three months.                                                                                                                                                                                                                         | Deprecated               |
| PNC         | The first and last name provided in the request are combined in one field.                                                                                                                                                                                                   | Live                     |
| PNMB        | The phone number provided is not a mobile line type.                                                                                                                                                                                                                         | Live                     |
| PNN         | A nickname was found and used in the name matching calculation: for example, Bill matches with William.                                                                                                                                                                      | Live                     |
| PNNS        | There is no network status information associated with the phone number provided.                                                                                                                                                                                            | Live                     |
| PNO         | The phone number provided has been matched with the identity information—such as name and address—and a newer ownership or association has recently been connected to the phone number.                                                                                      | Live                     |
| PNPB        | The phone number provided is a non-personal business line.                                                                                                                                                                                                                   | Live                     |
| PNRR        | This number was recently reported as removed from distribution. Finding activity from it is unexpected for a legitimate user. The service takes into account the number of reports of removal before making this determination.                                              | Deprecated               |
| PNS         | The first and last name provided were swapped compared to the phone number records.                                                                                                                                                                                          | Live                     |
| PNU         | The phone number provided has been updated.                                                                                                                                                                                                                                  | Live                     |
| POD         | The ownership match for the provided phone number was found prior to a disconnect date.                                                                                                                                                                                      | Live                     |
| PPC3        | The postal code provided matches the first three digits of the address on record for this phone number.                                                                                                                                                                      | Live                     |
| PPC5        | The postal code provided matches the first five digits of the address on record for this phone number.                                                                                                                                                                       | Live                     |
| PPC6        | The postal code provided matches the first six digits of the address on record for this phone number. This applies to Canadian phone numbers only.                                                                                                                           | Live                     |
| PPC9        | The postal code provided matches the first nine digits of the address on record for this phone number.                                                                                                                                                                       | Live                     |
| PPER        | Phone type is personal.                                                                                                                                                                                                                                                      | New: Added December 2025 |
| PPGR        | This number is associated with a pager.                                                                                                                                                                                                                                      | Live                     |
| PPN         | This is a premium number.                                                                                                                                                                                                                                                    | Live                     |
| PPPH        | This number is associated with a payphone.                                                                                                                                                                                                                                   | Live                     |
| PPRE        | This is a prepaid number.                                                                                                                                                                                                                                                    | New: Added December 2025 |
| PPRT        | The provided phone number is currently in a ported state.                                                                                                                                                                                                                    | Live                     |
| PPV         | A successful person search verification was run for the provided phone number.                                                                                                                                                                                               | Live                     |
| PRC         | This number is associated with a risky carrier.                                                                                                                                                                                                                              | Live                     |
| PRCO        | The country code of this number is for a risky country: a country that originates a disproportionate share of fraud attacks.                                                                                                                                                 | Live                     |
| PRM         | The provided phone number identity matching was only based on raw user data.                                                                                                                                                                                                 | Live                     |
| PRN         | The phone number is at lower risk for fraud because it is listed as a mobile line on the Override Services Registry (OSR).                                                                                                                                                   | New: Added December 2025 |
| PROM        | Telecom companies use this number for special technical purposes, such as roaming.                                                                                                                                                                                           | Live                     |
| PRP         | This number has a risky prefix.                                                                                                                                                                                                                                              | Live                     |
| PRR         | The phone number is at higher risk for fraud because it is listed as a non-mobile line on the Override Services Registry (OSR).                                                                                                                                              | New: Added December 2025 |
| PRSA        | This number has risky static attributes, such as VoIP phone type or being on a blocklist.                                                                                                                                                                                    | Live                     |
| PRSK        | This number has another phone type that is risky and not covered by any of the other number\_type reason codes.                                                                                                                                                              | Live                     |
| PRSV        | TeleSign or BICS reserved this number for their apps' customers to use: for example, to send verification messages; however, it appears that it is being used for a different purpose.                                                                                       | Live                     |
| PSA         | The phone number is classified as a sub-account line.                                                                                                                                                                                                                        | New: Added December 2025 |
| PSCD        | Call duration for this number has been shorter or longer than expected over the past 90 days.                                                                                                                                                                                | Deprecated               |
| PSDBM       | The matched identity has an SSN issued prior to either the submitted date of birth or the selected identity's date of birth (if no date of birth was submitted). This can indicate a higher risk of counterfeit identity.                                                    | Live                     |
| PSFE        | You have flagged this number as safe. The score always recommends allowing this number.                                                                                                                                                                                      | Live                     |
| PSG24       | Significant activity for a risky range that this number belongs to over the last 24 hours.                                                                                                                                                                                   | Live                     |
| PSG90       | Significant activity for a risky range that this number belongs to over the past 90 days.                                                                                                                                                                                    | Live                     |
| PSM90       | Some activity for a risky range that this number belongs to over the past 90 days.                                                                                                                                                                                           | Live                     |
| PSMDB       | The matched identity has multiple date of birth records. This can indicate a higher risk of counterfeit identity.                                                                                                                                                            | Live                     |
| PSMRN       | The matched identity has a high number of relatives with the same or similar name. This can indicate a higher risk of counterfeit identity.                                                                                                                                  | Live                     |
| PSMSN       | The matched identity has multiple unique SSNs. This can indicate a higher risk of counterfeit identity.                                                                                                                                                                      | Live                     |
| PSR         | The SIM date returned was not obtained in real time; there may be a more recent SIM change.                                                                                                                                                                                  | New: Added December 2025 |
| PSTF        | Significant activity on this number to or from risky services over the past 90 days.                                                                                                                                                                                         | Live                     |
| PTFN        | This is a toll-free number.                                                                                                                                                                                                                                                  | Live                     |
| PTL         | This number is invalid because it is too long, even after the application of cleansing rules.                                                                                                                                                                                | Live                     |
| PTO         | The phone record data retrieval timed out.                                                                                                                                                                                                                                   | Live                     |
| PUC         | There was insufficient data to calculate the risk score.                                                                                                                                                                                                                     | New: Added December 2025 |
| PUSV90      | Significant volume of unsuccessfully verified traffic from a range this number belongs to over the past 90 days.                                                                                                                                                             | New: Added December 2025 |
| PUV90       | Significant volume of unsuccessfully verified traffic from this number over the past 90 days.                                                                                                                                                                                | New: Added December 2025 |
| PVLA        | Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.                                                                                                     | Live                     |
| PVLS        | Much less success than expected or no success at all for this number over the past 90 days.                                                                                                                                                                                  | Deprecated               |
| PVMN        | This is a voicemail number.                                                                                                                                                                                                                                                  | Live                     |
| PVOIP       | This is a VoIP number.                                                                                                                                                                                                                                                       | Live                     |
| PVRC        | This number is associated with a very risky carrier.                                                                                                                                                                                                                         | Live                     |
| PVS24       | Very significant activity for a risky range that this number belongs to over the last 24 hours.                                                                                                                                                                              | Live                     |
| PVS90       | Very significant activity for a risky range that this number belongs to over the past 90 days.                                                                                                                                                                               | Live                     |
| PVST        | Very little activity, or none at all, was ever observed on this number. Very short tenure. Cannot classify.                                                                                                                                                                  | Deprecated               |
| PVSTF       | Very significant activity on this number to or from risky services over the past 90 days.                                                                                                                                                                                    | Live                     |
| TNSA        | This number was seen in phone risk scoring traffic in the last month.                                                                                                                                                                                                        | Live                     |
| TPSMT       | This phone was seen multiple times in last 90 days with different last names.                                                                                                                                                                                                | Live                     |
| TSBF        | Sparse regular volume of phone risk scoring traffic on this number over the past 90 days.                                                                                                                                                                                    | Live                     |
| TSBG        | Continuous, regular volume of verification traffic on this number over the past 90 days.                                                                                                                                                                                     | New: Added December 2025 |
| TSBH        | Very high volume of phone risk scoring traffic on this number over the past 90 days.                                                                                                                                                                                         | Live                     |
| TSBI        | Very high volume of phone risk scoring traffic on this number over the past 24 hours.                                                                                                                                                                                        | Live                     |
| TSBJ        | Very low volume of verification traffic, or none at all, was ever observed on this number.                                                                                                                                                                                   | New: Added December 2025 |
| TSBK        | Low volume of verification traffic on this phone number over the past 90 days.                                                                                                                                                                                               | New: Added December 2025 |
| TSBN        | Low volume of phone risk scoring traffic on this phone number over the past 24 hours. Very low volume of phone risk scoring traffic, or none at all, over the past 90 days.                                                                                                  | Live                     |
| TSBO        | Less than expected activity for this number.                                                                                                                                                                                                                                 | Live                     |
| TSCG        | Extremely significant activity for a risky range that this number belongs to over the past 90 days.                                                                                                                                                                          | Live                     |
| TSCH        | Extremely significant activity for a risky range that this number belongs to over the last 24 hours.                                                                                                                                                                         | Live                     |
| TSDC        | The behavior pattern that suggests this number is being used by a bot.                                                                                                                                                                                                       | Live                     |
| TSDD        | Verification traffic on risky services on this number over the past 90 days.                                                                                                                                                                                                 | New: Added December 2025 |
| TSDE        | Phone risk scoring traffic on risky services on this number over the past 24 hours.                                                                                                                                                                                          | Live                     |
| TSDF        | High volume of phone risk scoring traffic on risky services on this number over the past 90 days.                                                                                                                                                                            | Live                     |
| TSDG        | High volume of verification traffic on risky services on this number over the past 24 hours.                                                                                                                                                                                 | New: Added December 2025 |
| TSDH        | Verification traffic on risky services on the range this number belongs to over the past 90 days.                                                                                                                                                                            | New: Added December 2025 |
| TSDI        | Verification traffic on risky services on the range this number belongs to over the past 24 hours.                                                                                                                                                                           | New: Added December 2025 |
| TSDJ        | High volume of verification traffic on risky services on the range this number belongs to over the past 90 days.                                                                                                                                                             | New: Added December 2025 |
| TSDK        | High volume of phone risk scoring traffic on risky services on the range this number belongs to over the past 24 hours.                                                                                                                                                      | Live                     |
| TSDL        | Very high volume of phone risk scoring traffic on risky services on this number over the past 90 days.                                                                                                                                                                       | Live                     |
| TSDM        | Very high volume of phone risk scoring traffic on risky services on this number over the past 24 hours.                                                                                                                                                                      | Live                     |
| TSDN        | Very high volume of phone risk scoring traffic on risky services on the range this number belongs to over the past 90 days.                                                                                                                                                  | Live                     |
| TSDO        | Very high volume of phone risk scoring traffic on risky services on the range this number belongs to over the past 24 hours.                                                                                                                                                 | Live                     |
| TSDP        | Extremely high volume of phone risk scoring traffic in a very short period (less than one hour) on the range this number belongs to.                                                                                                                                         | Live                     |
| TSKU        | This number is too short to be a valid phone number.                                                                                                                                                                                                                         | Live                     |
| TSMA        | This number was seen in phone risk scoring traffic in the last day.                                                                                                                                                                                                          | Live                     |
| TSMB        | This number was seen in phone risk scoring traffic in the last seven days.                                                                                                                                                                                                   | Live                     |
| TSMC        | This number was seen in phone risk scoring traffic in the last 15 days.                                                                                                                                                                                                      | Live                     |
| TSNB        | This number was seen in phone risk scoring traffic in the last two months.                                                                                                                                                                                                   | Live                     |
| TSNC        | This number was seen in phone risk scoring traffic in the last three months.                                                                                                                                                                                                 | Live                     |
| TSOA        | This number was not seen in phone risk scoring traffic in the last three months.                                                                                                                                                                                             | Live                     |
| TXHR        | This number is in a high-risk category based on past behavior.                                                                                                                                                                                                               | Live                     |
| TXMTW       | This number is in the most trustworthy category based on past behavior.                                                                                                                                                                                                      | Live                     |
| TXNA        | There is not enough activity or attributes to classify the transaction as either risky or trustworthy.                                                                                                                                                                       | Live                     |
| TXR         | This number is in a risky category based on past behavior.                                                                                                                                                                                                                   | Live                     |
| TXTW        | This number is in a trustworthy category based on past behavior.                                                                                                                                                                                                             | Live                     |
| TXVHR       | This number is in the highest-risk category based on past behavior.                                                                                                                                                                                                          | Live                     |

## Email Reason Codes

| Reason Code | Description                                                                                                                                                                                                                                                 | Status                   |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| EA1Y        | The email address was first seen at least a year ago.                                                                                                                                                                                                       | Live                     |
| EA2Y        | The email address was created within the last two years.                                                                                                                                                                                                    | Live                     |
| EA4M        | The email address was created within the last four months.                                                                                                                                                                                                  | Live                     |
| EA4Y        | The email address was created more than four years ago.                                                                                                                                                                                                     | Live                     |
| EA6M        | The email address was created within the last six months.                                                                                                                                                                                                   | Live                     |
| EAC1F       | The email address was confirmed as suspected fraud once across the email data provider's customer network.                                                                                                                                                  | Live                     |
| EACMF       | The email address was confirmed as suspected fraud multiple times across the email data provider's customer network.                                                                                                                                        | Live                     |
| EADP        | Disposable email domain.                                                                                                                                                                                                                                    | Live                     |
| EAF1        | The email address was confirmed as fraudulent to the email data provider by one of their customers.                                                                                                                                                         | Live                     |
| EAF2        | The email address was confirmed as fraudulent to the email data provider by two of their customers.                                                                                                                                                         | Live                     |
| EAF3        | The email address was confirmed as fraudulent to the email data provider by three or more of their customers.                                                                                                                                               | Live                     |
| EAF4Y       | The email address was first seen at least four years ago.                                                                                                                                                                                                   | Live                     |
| EAFC        | The email address was confirmed as fraudulent by you or by the email data provider.                                                                                                                                                                         | Live                     |
| EAG1        | The email address was confirmed as good to the email data provider by one of their customers.                                                                                                                                                               | Live                     |
| EAG2        | The email address was confirmed as good to the email data provider by two of their customers.                                                                                                                                                               | Live                     |
| EAG3        | The email address was confirmed as good to the email data provider by three of their customers.                                                                                                                                                             | Live                     |
| EAG4        | The email address was confirmed as good to the email data provider by four of their customers.                                                                                                                                                              | Live                     |
| EAG5        | The email address was confirmed as good to the email data provider by five of their customers.                                                                                                                                                              | Live                     |
| EAG6        | The email address was confirmed as good to the email data provider by six or more of their customers.                                                                                                                                                       | Live                     |
| EAHF        | The email address has high probability of being associated to fraud due to multiple risk factors based on the email data provider's proprietary algorithm: for example, validity, age, and fraud history.                                                   | Live                     |
| EALLI       | The email address is linked to a low-risk LinkedIn account, based on the account's number of connections and posting activity.                                                                                                                              | Live                     |
| EALSM       | The email address is linked to a low-risk social media account (for example, Facebook, Yahoo, or Pandora), based on the account's number of connections and posting activity.                                                                               | Live                     |
| EALTW       | The email address is linked to a low-risk Twitter account, based on the account's number of connections and posting activity.                                                                                                                               | Live                     |
| EAM         | The email address was created within the last month.                                                                                                                                                                                                        | Live                     |
| EAMC        | Multiple email addresses with similar handle patterns were recently queried at the email data provider for the company the email owner is tied to.                                                                                                          | Live                     |
| EAMF        | The email address mailbox is full: the owner has exceeded the allowed capacity of email service.                                                                                                                                                            | Live                     |
| EAMI        | Multiple email addresses with similar handle patterns were recently queried at the email data provider for the transaction industry it has been previously tied to: for example, banking/finance or gaming.                                                 | Live                     |
| EAMP        | The email address mailbox existed in the past and is no longer available.                                                                                                                                                                                   | Live                     |
| EANA        | The email address mailbox is no longer active.                                                                                                                                                                                                              | Live                     |
| EANE        | The email address does not exist.                                                                                                                                                                                                                           | Live                     |
| EANI        | Not enough information was found for the provided email address to determine a risk assessment.                                                                                                                                                             | Deprecated               |
| EANP        | No email address was provided for risk assessment.                                                                                                                                                                                                          | Live                     |
| EAPF        | The email address syntax follows patterns that have been associated with fraud.                                                                                                                                                                             | Live                     |
| EAQ3        | The email address has been queried in a short amount of time to the email data provider by three of their customers.                                                                                                                                        | Live                     |
| EAQ4        | The email address has been queried in a short amount of time to the email data provider by four of their customers.                                                                                                                                         | Live                     |
| EAQM        | The email address has been queried in a short amount of time to the email data provider by more than four of their customers.                                                                                                                               | Live                     |
| EASI        | The email address syntax is not valid.                                                                                                                                                                                                                      | Live                     |
| EAVQ        | Different variations of the email address that point to the same inbox were recently queried.                                                                                                                                                               | Live                     |
| EAW         | The email address was created within the last week.                                                                                                                                                                                                         | Live                     |
| EAY         | The email address was created within the last year.                                                                                                                                                                                                         | Live                     |
| ED4M        | The email domain was created within the last four months.                                                                                                                                                                                                   | Live                     |
| EDCH        | The email domain is tied to a category type—such as banking and webmail—with high fraud rates.                                                                                                                                                              | Live                     |
| EDCO        | The email domain country is considered to be risky.                                                                                                                                                                                                         | Live                     |
| EDDN        | The email domain does not exist in the email data provider's registry. This domain might still have valid DNS record.                                                                                                                                       | Live                     |
| EDHA        | The email domain is considered to be high risk based on the email data provider's proprietary algorithm—for example, validity, age, or fraud history—for the company the email owner is tied to.                                                            | Live                     |
| EDHC        | The email domain is considered to be high risk based on the email data provider's proprietary algorithm—for example, validity, age, or fraud history—for the category type of the company the email is tied to.                                             | Live                     |
| EDHI        | The email domain is considered to be high risk based on the email data provider's proprietary algorithm—for example, validity, age, or fraud history—for the transaction industry it has been previously tied to, such as banking, finance, or gaming.      | Live                     |
| EDHN        | The email domain is considered to be high risk across the data provider's network based on their proprietary algorithm: for example, validity, age, or fraud history.                                                                                       | Live                     |
| EDI         | The email domain is invalid.                                                                                                                                                                                                                                | Live                     |
| EDL         | The email domain is considered to be low risk based on the email data provider's proprietary algorithm: for example, validity, age, or fraud history.                                                                                                       | Live                     |
| EDLC        | The email domain is considered to be low risk based on the email data provider's proprietary algorithm for the category type of the company the email is tied to.                                                                                           | Live                     |
| EDM         | The email domain is considered to be medium risk based on the email data provider's proprietary algorithm: for example, validity, age, or fraud history.                                                                                                    | Live                     |
| EDNP        | The email address handle contains numeric patterns.                                                                                                                                                                                                         | Live                     |
| EDPR        | The email domain is considered to be risky based on the email data provider's proprietary algorithm: for example, validity, age, or fraud history.                                                                                                          | Live                     |
| EDVH        | The email domain is considered to be very high risk based on the email data provider's proprietary algorithm: for example, validity, age, or fraud history.                                                                                                 | Live                     |
| EDVHC       | The email domain is considered to be very high risk based on the email data provider's proprietary algorithm—for example, validity, age, or fraud history—for the company the email owner is tied to.                                                       | Live                     |
| EDVHI       | The email domain is considered to be very high risk based on the email data provider's proprietary algorithm—for example, validity, age, or fraud history—for the transaction industry it has been previously tied to, such as banking, finance, or gaming. | Live                     |
| EE24        | Expected level of activity for this email address over the last 24-hours.                                                                                                                                                                                   | Live                     |
| EE90        | Expected level of activity for this email address over the past 90 days.                                                                                                                                                                                    | Live                     |
| EELH        | The email address may have been created recently. Limited historical data was found.                                                                                                                                                                        | New: Added December 2025 |
| EEPEII      | Error from email enrichment provider. This includes error due to invalid input. Some risk assessment features might be limited due to error.                                                                                                                | Live                     |
| EFRD        | The email has been flagged as a source of fraud.                                                                                                                                                                                                            | New: Added December 2025 |
| EMA24       | More than expected activity for this email address over the last 24-hours.                                                                                                                                                                                  | Live                     |
| EMA90       | More than expected activity for this email address over the past 90 days.                                                                                                                                                                                   | Live                     |
| ESFE        | The email has been flagged as safe.                                                                                                                                                                                                                         | New: Added December 2025 |
| ESG24       | Significant activity for this email address to or from risky services over the last 24 hours.                                                                                                                                                               | Live                     |
| ESG90       | Significant activity on this email address to or from risky services over the last 90 days.                                                                                                                                                                 | Live                     |
| EVS24       | Very significant activity for this email address to or from risky services over the last 24 hours.                                                                                                                                                          | Live                     |
| EVS90       | Very significant activity on this email address to or from risky services over the last 90 days.                                                                                                                                                            | Live                     |
| EVV24       | Very high volume of verification traffic on this email address over the past 24 hours.                                                                                                                                                                      | New: Added December 2025 |
| EVV90       | Very high volume of verification traffic on this email address over the past 90 days.                                                                                                                                                                       | New: Added December 2025 |
| TSLI        | Very high volume of phone risk scoring traffic on this email address over the past 24 hours.                                                                                                                                                                | Deprecated               |
| TSLJ        | Very high volume of phone risk scoring traffic on this email address over the past 90 days.                                                                                                                                                                 | Deprecated               |
| TSLK        | The behavior pattern suggests this email address is being used by a software program.                                                                                                                                                                       | Live                     |
| TSLN        | This email address is invalid and could not have been used by a legitimate user.                                                                                                                                                                            | Live                     |
| TSLO        | This email address may have originated from a service providing temporary email addresses. These temporary addresses can be used to conceal the identity of the user.                                                                                       | Live                     |

## Tax ID Reason Codes

| Reason Code | Description                                                                                                                                                               | Status                   |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| ASPI        | Some parts of the address (such as the street and ZIP code) are valid.                                                                                                    | New: Added December 2025 |
| TANM        | The SSN used is more closely associated with another consumer.                                                                                                            | New: Added December 2025 |
| TANO        | Current address not on file.                                                                                                                                              | Live                     |
| TARF        | Address reported with past fraud.                                                                                                                                         | New: Added December 2025 |
| TDDA        | Different date of birth (age) than past application linked to the current applicant.                                                                                      | Live                     |
| TFAD1       | FACTA active duty alert. Active for one year.                                                                                                                             | Deprecated               |
| TFADF       | FACTA active duty alert with fraud victim. Active for one year.                                                                                                           | Deprecated               |
| TFADI       | FACTA active duty alert with fraud victim: initial alert. Active for 90 days.                                                                                             | Deprecated               |
| TFEM        | The age of the consumer is younger than the issue date of the SSN.                                                                                                        | New: Added December 2025 |
| TFMCI       | Five or more credit inquiries in the last 14 days.                                                                                                                        | New: Added December 2025 |
| TFVE        | FACTA fraud victim extended alert. Active for seven years.                                                                                                                | Deprecated               |
| TFVI        | FACTA fraud victim initial alert. Active for 90 days.                                                                                                                     | Deprecated               |
| TH3AA       | High-risk Third Party Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                    | Deprecated               |
| TH3AH       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's address history.                     | Deprecated               |
| TH3AI       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN might belong to another person not yet credit active.           | Deprecated               |
| TH3AO       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer appears to have a better SSN.                                       | Deprecated               |
| TH3AS       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to addresses linked to counterfeit fraud.                   | Deprecated               |
| TH3BO       | High-risk Third Party Score based on the TaxID data provider's categorization of whether there is a better owner for the SSN.                                             | Deprecated               |
| TH3CH       | High-risk Third Party Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                               | Deprecated               |
| TH3DB       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's date of birth.                       | Deprecated               |
| TH3DI       | High-risk Third Party Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.            | Deprecated               |
| TH3ED       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                      | Deprecated               |
| TH3FG       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                   | Deprecated               |
| TH3FR       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                      | Deprecated               |
| TH3IT       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to an ITIN.                                                 | Deprecated               |
| TH3MR       | High-risk Third Party Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                              | Deprecated               |
| TH3NN       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                            | Deprecated               |
| TH3OM       | High-risk Third Party Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                | Deprecated               |
| TH3PB       | High-risk Third Party Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                          | Deprecated               |
| TH3PH       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the phone aligns with the consumer's history.                                    | Deprecated               |
| TH3PR       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.           | Deprecated               |
| TH3RI       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN is a randomly issued SSN.                                       | Deprecated               |
| TH3SA       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                            | Deprecated               |
| TH3SF       | High-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                        | Deprecated               |
| TH3SM       | High-risk Third Party Score based on the TaxID data provider's categorization of how well the start time of the consumer's history aligns with the expected start time.   | Deprecated               |
| THAAA       | High-risk Abuse Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                          | Deprecated               |
| THAAH       | High-risk Abuse Score based on the TaxID data provider's validation of the consumer's address history.                                                                    | Deprecated               |
| THAAI       | High-risk Abuse Score based on the TaxID data provider's categorization of the provided SSN belonging to another person not yet credit active.                            | Deprecated               |
| THAAO       | High-risk Abuse Score based on the TaxID data provider's categorization of the consumer appearing to have a better SSN.                                                   | Deprecated               |
| THAAS       | High-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to addresses linked to counterfeit fraud.                              | Deprecated               |
| THABO       | High-risk Abuse Score based on the TaxID data provider's categorization of there being a better owner for the SSN.                                                        | Deprecated               |
| THACH       | High-risk Abuse Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                                     | Deprecated               |
| THADB       | High-risk Abuse Score based on the TaxID data provider's validation of the consumer's date of birth.                                                                      | Deprecated               |
| THADI       | High-risk Abuse Score based on the TaxID data provider's categorization of the supplied information corresponding to a deceased individual.                               | Deprecated               |
| THAED       | High-risk Abuse Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                            | Deprecated               |
| THAFG       | High-risk Abuse Score based on the TaxID data provider's categorization of the SSN being tied to a clump of SSNs empirically used for fraud.                              | Deprecated               |
| THAFR       | High-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to fraud code records.                                                 | Deprecated               |
| THAIT       | High-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to an ITIN.                                                            | Deprecated               |
| THAMR       | High-risk Abuse Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                                    | Deprecated               |
| THANN       | The SSN provided is not a valid number as reported by the SSA.                                                                                                            | Live                     |
| THAOM       | High-risk Abuse Score based on the TaxID data provider's categorization of whether other applications match aspects of this application's information.                    | Deprecated               |
| THAPB       | High-risk Abuse Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                                | Deprecated               |
| THAPH       | High-risk Abuse Score based on the TaxID data provider's validation of the consumer's phone history.                                                                      | Deprecated               |
| THAPR       | High-risk Abuse Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.                 | Deprecated               |
| THARI       | High-risk Abuse Score based on the TaxID data provider's categorization of the provided SSN being a randomly issued SSN.                                                  | Deprecated               |
| THASA       | High-risk Abuse Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                                  | Deprecated               |
| THASF       | High-risk Abuse Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                              | Deprecated               |
| THASM       | High-risk Abuse Score based on the TaxID data provider's categorization of the consumer's history start time aligning with the expected record start time.                | Deprecated               |
| THPAA       | High-risk First Party Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                    | Deprecated               |
| THPAH       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's address history.                     | Deprecated               |
| THPAI       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN might belong to another person not yet credit active.           | Deprecated               |
| THPAO       | High-risk First Party Score based on the TaxID data provider's categorization of whether the consumer appears to have a better SSN.                                       | Deprecated               |
| THPAS       | High-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to addresses linked to counterfeit fraud.                   | Deprecated               |
| THPBO       | High-risk First Party Score based on the TaxID data provider's categorization of whether there is a better owner for the SSN.                                             | Deprecated               |
| THPCH       | High-risk First Party Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                               | Deprecated               |
| THPDB       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied TaxID aligns with the consumer's date of birth.                     | Deprecated               |
| THPDI       | High-risk First Party Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.            | Deprecated               |
| THPED       | High-risk First Party Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                      | Deprecated               |
| THPFG       | High-risk First Party Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                   | Deprecated               |
| THPFR       | High-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                      | Deprecated               |
| THPIT       | High-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to an ITIN.                                                 | Deprecated               |
| THPMR       | High-risk First Party Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                              | Deprecated               |
| THPNN       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                            | Deprecated               |
| THPOM       | High-risk First Party Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                | Deprecated               |
| THPPB       | High-risk First Party Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                          | Deprecated               |
| THPPH       | High-risk First Party Score based on the TaxID data provider's categorization of whether the phone aligns with the consumer's history.                                    | Deprecated               |
| THPPR       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.           | Deprecated               |
| THPRI       | High-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN is a randomly issued SSN.                                       | Deprecated               |
| THPSA       | High-risk First Party Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                            | Deprecated               |
| THPSF       | High-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                        | Deprecated               |
| THPSM       | High-risk First Party Score based on the TaxID data provider's categorization of how well the start time of the consumer's history aligns with the expected start time.   | Deprecated               |
| THTAH       | High-risk ID Theft Score based on the TaxID data provider's categorization of how consistent the address is with the consumer's history.                                  | Deprecated               |
| THTAV       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the address has a high velocity of applications.                                    | Deprecated               |
| THTBE       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant appears to be the best owner of the email.                            | Deprecated               |
| THTBP       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant appears to be the best owner of the phone.                            | Deprecated               |
| THTDI       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.               | Deprecated               |
| THTED       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                         | Deprecated               |
| THTES       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the email has had suspicious application activity.                                  | Deprecated               |
| THTFG       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                      | Deprecated               |
| THTFR       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                         | Deprecated               |
| THTGP       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether there is unusual geographic activity associated with the phone number.              | Deprecated               |
| THTHE       | High-risk ID Theft Score based on the TaxID data provider's categorization of the length of history of the email.                                                         | Deprecated               |
| THTIA       | High-risk ID Theft Score based on whether application information is tied to an associate.                                                                                | Deprecated               |
| THTIH       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the IP address aligns with the applicant's physical address history.                | Deprecated               |
| THTIP       | High-risk ID Theft Score based on whether the IP address has had suspicious application activity.                                                                         | Deprecated               |
| THTMX       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the application information contains a mix of information from different consumers. | Deprecated               |
| THTNN       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                               | Deprecated               |
| THTOM       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                   | Deprecated               |
| THTPR       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.              | Deprecated               |
| THTRP       | High-risk ID Theft Score based on the TaxID data provider's categorization of the number of recent applications associated with the phone.                                | Deprecated               |
| THTSG       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant has a suspicious gap in history.                                      | Deprecated               |
| THTVP       | High-risk ID Theft Score based on the TaxID data provider's categorization of whether the application's IP address is from a risky VPN.                                   | Deprecated               |
| TIAWB       | Address reported as associated with a business.                                                                                                                           | Live                     |
| TIAWF       | Address reported as associated with a business with higher potential fraud activity.                                                                                      | Live                     |
| TIENK       | No search keys generated for IEN.                                                                                                                                         | New: Added December 2025 |
| TIENM       | No match to any IEN repository records.                                                                                                                                   | New: Added December 2025 |
| TINO        | Input SSN does not match on-file SSN.                                                                                                                                     | Live                     |
| TITIN       | TaxID is an ITIN.                                                                                                                                                         | New: Added December 2025 |
| TL3AA       | Low-risk Third Party Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                     | Deprecated               |
| TL3AH       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's address history.                      | Deprecated               |
| TL3AI       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN might belong to another person not yet credit active.            | Deprecated               |
| TL3AO       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer appears to have a better SSN.                                        | Deprecated               |
| TL3AS       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to addresses linked to counterfeit fraud.                    | Deprecated               |
| TL3BO       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether there is a better owner for the SSN.                                              | Deprecated               |
| TL3CH       | Low-risk Third Party Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                                | Deprecated               |
| TL3DB       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's date of birth.                        | Deprecated               |
| TL3DI       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.             | Deprecated               |
| TL3ED       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                       | Deprecated               |
| TL3FG       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                    | Deprecated               |
| TL3FR       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                       | Deprecated               |
| TL3IT       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to an ITIN.                                                  | Deprecated               |
| TL3MR       | Low-risk Third Party Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                               | Deprecated               |
| TL3NN       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                             | Deprecated               |
| TL3OM       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                 | Deprecated               |
| TL3PB       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                           | Deprecated               |
| TL3PH       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the phone aligns with the consumer's history.                                     | Deprecated               |
| TL3PR       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.            | Deprecated               |
| TL3RI       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the supplied SSN is a randomly issued SSN.                                        | Deprecated               |
| TL3SA       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                             | Deprecated               |
| TL3SF       | Low-risk Third Party Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                         | Deprecated               |
| TL3SM       | Low-risk Third Party Score based on the TaxID data provider's categorization of how well the start time of the consumer's history aligns with the expected start time.    | Deprecated               |
| TLAAA       | Low-risk Abuse Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                           | Deprecated               |
| TLAAH       | Low-risk Abuse Score based on the TaxID data provider's validation of the consumer's address history.                                                                     | Deprecated               |
| TLAAI       | Low-risk Abuse Score based on the TaxID data provider's categorization of the provided SSN belonging to another person not yet credit active.                             | Deprecated               |
| TLAAO       | Low-risk Abuse Score based on the TaxID data provider's categorization of the consumer appearing to have a better SSN.                                                    | Deprecated               |
| TLAAS       | Low-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to addresses linked to counterfeit fraud.                               | Deprecated               |
| TLABO       | Low-risk Abuse Score based on the TaxID data provider's categorization of there being a better owner for the SSN.                                                         | Deprecated               |
| TLACH       | Low-risk Abuse Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                                      | Deprecated               |
| TLADB       | Low-risk Abuse Score based on the TaxID data provider's validation of the consumer's date of birth.                                                                       | Deprecated               |
| TLADI       | Low-risk Abuse Score based on the TaxID data provider's categorization of the supplied information corresponding to a deceased individual.                                | Deprecated               |
| TLAED       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                             | Deprecated               |
| TLAFG       | Low-risk Abuse Score based on the TaxID data provider's categorization of the SSN being tied to a clump of SSNs empirically used for fraud.                               | Deprecated               |
| TLAFR       | Low-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to fraud code records.                                                  | Deprecated               |
| TLAIT       | Low-risk Abuse Score based on the TaxID data provider's categorization of the consumer being tied to an ITIN.                                                             | Deprecated               |
| TLAMR       | Low-risk Abuse Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                                     | Deprecated               |
| TLANN       | Low-risk Abuse Score based on the TaxID data provider's categorization of the provided name or SSN as nonsense.                                                           | Deprecated               |
| TLAOM       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether other applications match aspects of this application's information.                     | Deprecated               |
| TLAPB       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                                 | Deprecated               |
| TLAPH       | Low-risk Abuse Score based on the TaxID data provider's validation of the consumer's phone history.                                                                       | Deprecated               |
| TLAPR       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.                  | Deprecated               |
| TLARI       | Low-risk Abuse Score based on the TaxID data provider's categorization of the provided SSN being a randomly issued SSN.                                                   | Deprecated               |
| TLASA       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                                   | Deprecated               |
| TLASF       | Low-risk Abuse Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                               | Deprecated               |
| TLASM       | Low-risk Abuse Score based on the TaxID data provider's categorization of the consumer's history start time aligning with the expected record start time.                 | Deprecated               |
| TLGPD       | Tax ID check was not performed due to LGPD: minor's data.                                                                                                                 | Live                     |
| TLPAA       | Low-risk First Party Score based on the TaxID data provider's categorization of attributes of addresses that the consumer is tied to.                                     | Deprecated               |
| TLPAH       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN aligns with the consumer's address history.                      | Deprecated               |
| TLPAI       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN might belong to another person not yet credit active.            | Deprecated               |
| TLPAO       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the consumer appears to have a better SSN.                                        | Deprecated               |
| TLPAS       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to addresses linked to counterfeit fraud.                    | Deprecated               |
| TLPBO       | Low-risk First Party Score based on the TaxID data provider's categorization of whether there is a better owner for the SSN.                                              | Deprecated               |
| TLPCH       | Low-risk First Party Score based on the TaxID data provider's categorization of the depth of the consumer's history with this information.                                | Deprecated               |
| TLPDB       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied TaxID aligns with the consumer's date of birth.                      | Deprecated               |
| TLPDI       | Low-risk First Party Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.             | Deprecated               |
| TLPED       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                       | Deprecated               |
| TLPFG       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                    | Deprecated               |
| TLPFR       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                       | Deprecated               |
| TLPIT       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to an ITIN.                                                  | Deprecated               |
| TLPMR       | Low-risk First Party Score based on the TaxID data provider's categorization of how well the supplied information matches Manifest records.                               | Deprecated               |
| TLPNN       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                             | Deprecated               |
| TLPOM       | Low-risk First Party Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                 | Deprecated               |
| TLPPB       | Low-risk First Party Score based on the TaxID data provider's categorization of whether aspects of the supplied PII correspond to bankruptcies.                           | Deprecated               |
| TLPPH       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the phone aligns with the consumer's history.                                     | Deprecated               |
| TLPPR       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.            | Deprecated               |
| TLPRI       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the supplied SSN is a randomly issued SSN.                                        | Deprecated               |
| TLPSA       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the SSN might belong to an associate.                                             | Deprecated               |
| TLPSF       | Low-risk First Party Score based on the TaxID data provider's categorization of whether the consumer is tied to security freezes.                                         | Deprecated               |
| TLPSM       | Low-risk First Party Score based on the TaxID data provider's categorization of how well the start time of the consumer's history aligns with the expected start time.    | Deprecated               |
| TLTAH       | Low-risk ID Theft Score based on the TaxID data provider's categorization of how consistent the address is with the consumer's history.                                   | Deprecated               |
| TLTAV       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the address has a high velocity of applications.                                     | Deprecated               |
| TLTBE       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant appears to be the best owner of the email.                             | Deprecated               |
| TLTBP       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant appears to be the best owner of the phone.                             | Deprecated               |
| TLTDI       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether any of the supplied information corresponds to a deceased individual.                | Deprecated               |
| TLTED       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the email domain or structure of the handle are suspicious.                          | Deprecated               |
| TLTES       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the email has had suspicious application activity.                                   | Deprecated               |
| TLTFG       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the SSN is tied to a clump of SSNs empirically used for fraud.                       | Deprecated               |
| TLTFR       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the consumer is tied to fraud code records.                                          | Deprecated               |
| TLTGP       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether there is unusual geographic activity associated with the phone number.               | Deprecated               |
| TLTHE       | Low-risk ID Theft Score based on the TaxID data provider's categorization of the length of history of the email.                                                          | Deprecated               |
| TLTIA       | Low-risk ID Theft Score based on whether application information is tied to an associate.                                                                                 | Deprecated               |
| TLTIH       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the IP address aligns with the applicant's physical address history.                 | Deprecated               |
| TLTIP       | Low-risk ID Theft Score based on whether the IP address has had suspicious application activity.                                                                          | Deprecated               |
| TLTMX       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the application information contains a mix of information from different consumers.  | Deprecated               |
| TLTNN       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the supplied name or SSN is nonsense.                                                | Deprecated               |
| TLTOM       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether other applicants match aspects of this application's information.                    | Deprecated               |
| TLTPR       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the supplied phone number corresponds to a risky carrier or line type.               | Deprecated               |
| TLTSG       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the applicant has a suspicious gap in history.                                       | Deprecated               |
| TLTVP       | Low-risk ID Theft Score based on the TaxID data provider's categorization of whether the application's IP address is from a risky VPN.                                    | Deprecated               |
| TMAI        | Multiple address inconsistencies in the last seven days and SSN seen with different phones in the last 90 days.                                                           | Live                     |
| TMFSI       | Multiple Fraud Shield indicators triggered or unverifiable SSN.                                                                                                           | Live                     |
| TNAPD       | Greater than 50% of tradelines in the last 90 days have the same name and address but a different phone, and occurred in the last seven days.                             | Live                     |
| TNASM       | Name and address seen multiple times in the last 90 days with a different SSN.                                                                                            | Live                     |
| TNPID       | Tax ID check was not performed due to invalid date of birth.                                                                                                              | Deprecated               |
| TNPIE       | Tax ID check was not performed due to invalid email.                                                                                                                      | Deprecated               |
| TNPIP       | Tax ID check was not performed due to invalid phone.                                                                                                                      | Deprecated               |
| TNPIR       | Tax ID check was not performed due to invalid request.                                                                                                                    | Deprecated               |
| TNPIS       | Tax ID check was not performed due to invalid SSN.                                                                                                                        | Deprecated               |
| TNPIZ       | Tax ID check was not performed due to invalid ZIP code.                                                                                                                   | Deprecated               |
| TNPMS       | Tax ID check was not performed due to missing SSN.                                                                                                                        | Deprecated               |
| TNSA        | This number was seen in phone risk scoring traffic in the last month.                                                                                                     | Deprecated               |
| TOAB        | On-file address reported as associated with a business.                                                                                                                   | Live                     |
| TOAF        | On-file address reported as associated with a business with higher potential fraud activity.                                                                              | Live                     |
| TOARF       | On-file address reported with past fraud.                                                                                                                                 | New: Added December 2025 |
| TPAI        | All trades are bankcard trades with phone-address inconsistencies in non-credit data verification.                                                                        | Live                     |
| TPDNV       | One or more PII data elements not verified.                                                                                                                               | Live                     |
| TPFUT       | More than four unique tradelines with the same phone number in the last 90 days.                                                                                          | New: Added December 2025 |
| TSAC        | Current address conflict.                                                                                                                                                 | Live                     |
| TSAF        | Address first reported.                                                                                                                                                   | Live                     |
| TSDV        | SSN issue date cannot be verified.                                                                                                                                        | Live                     |
| TSNA        | Input SSN exact match to at least one other, but input name and address not connected.                                                                                    | Live                     |
| TSNV        | New credit profile with unverifiable SSN, or address matches to a different name in non-credit data.                                                                      | Live                     |
| TSOD        | Best on-file SSN issue date cannot be verified.                                                                                                                           | Live                     |
| TSOP        | Best on-file SSN recorded as deceased.                                                                                                                                    | Live                     |
| TSPNA       | Same SSN, phone, or name and address seen more than three times in the last seven days.                                                                                   | Live                     |
| TSPNM       | SSN seen with a different phone more than 15 times in the last 90 days, or input phone does not match on-file phone at least twice in the last 90 days.                   | Live                     |
| TSPR        | The Tax ID provided is pending regularization.                                                                                                                            | Live                     |
| TSR         | Tax ID status is regular.                                                                                                                                                 | Live                     |
| TSRD        | Subject reported deceased.                                                                                                                                                | Live                     |
| TSRF        | Tax ID status is not regular. It is suspended or canceled.                                                                                                                | Live                     |
| TSRP        | Tax ID status is pending regularization.                                                                                                                                  | Live                     |
| TSSF        | Subject has placed a security freeze on their SSN file.                                                                                                                   | Live                     |
| TSTUT       | More than three unique trades with the same SSN in the last 28 days.                                                                                                      | Live                     |
| TTIQ        | More than two inquiries with the same name and address in the last 28 days.                                                                                               | Live                     |
| TTMIQ       | Too many inquiries in the last 90 days where name and address don't match the best on-file, and no change of address.                                                     | New: Added December 2025 |

## Address Reason Codes

| Reason Code | Description                                                                                                                                                                    | Status                   |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
| A4070SS     | Tracking data indicates that between 40% and 70% of mailpieces sent to this address were delivered successfully.                                                               | Live                     |
| A40SS       | Tracking data indicates that fewer than 40% of mailpieces sent to this address were delivered successfully, and recent mailings weren't successful.                            | Live                     |
| A70SS       | Tracking data indicates that over 70% of mailpieces sent to this address were delivered successfully, and recent mailings were also successful.                                | Live                     |
| AASE        | Verified. The input data is acceptable, but errors were introduced in an attempt to standardize user input.                                                                    | Live                     |
| ACMRA       | The address matched to a CMRA and private mailbox information is not present.                                                                                                  | New: Added December 2025 |
| ACP         | The address matched to a CMRA and private mailbox information is present.                                                                                                      | New: Added December 2025 |
| ACV         | Country validated.                                                                                                                                                             | Live                     |
| AD          | The address is deliverable.                                                                                                                                                    | New: Added December 2025 |
| ADC         | Verified. The input data is correct.                                                                                                                                           | Live                     |
| ADCMS       | Verified. The input data is correct. All input data was able to match in databases after some or all elements were standardized.                                               | Live                     |
| ADCUD       | Verified. The input data is correct, although some input data is unverifiable due to incomplete data.                                                                          | Live                     |
| ADGD        | The address is a deliverable General Delivery address. General Delivery is a USPS service that allows individuals without permanent addresses to receive mail.                 | New: Added December 2025 |
| ADU         | The address is a deliverable unique address. A unique ZIP code is assigned to a single organization—such as a government agency—that receives a large volume of mail.          | New: Added December 2025 |
| AFAEI       | Fixed. The input data is acceptable, but errors were introduced in an attempt to standardize user input.                                                                       | Live                     |
| AFM         | Fixed. The input data is matched and fixed: for example, "Brighon - UK" is corrected to "Brighton - UK".                                                                       | Live                     |
| AFMNCC      | Fixed. The input data is matched and fixed, but some elements such as sub-building number and house number cannot be checked.                                                  | Live                     |
| AFMSCC      | Fixed. The input data is matched, but some elements such as street cannot be checked.                                                                                          | Live                     |
| AHNI        | Invalid house or building number.                                                                                                                                              | Live                     |
| AHR         | Historical resident matched.                                                                                                                                                   | Live                     |
| AIA         | Invalid address.                                                                                                                                                               | Live                     |
| AIAU        | The address is an Informed Address. The recipient and the street address are replaced with a special code provided by the USPS.                                                | New: Added December 2025 |
| AII         | Invalid input.                                                                                                                                                                 | Live                     |
| AIN         | PO Box, Rural Route, or Highway Contract box number is invalid.                                                                                                                | New: Added December 2025 |
| AIR         | The address is deliverable to the building's default address, but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. | Live                     |
| AMA         | The address is a deliverable military address.                                                                                                                                 | New: Added December 2025 |
| AMCC        | Missing country code.                                                                                                                                                          | Live                     |
| AMI         | Missing input.                                                                                                                                                                 | Live                     |
| AMICC       | Missing info. The input data cannot be corrected completely.                                                                                                                   | Live                     |
| AMICCMM     | Missing info. The input data cannot be corrected completely, and multiple matches were found in databases.                                                                     | Live                     |
| AMICCSE     | Missing info. The input data cannot be corrected completely, and only some elements were found.                                                                                | Live                     |
| AMN         | PO Box, Rural Route, or Highway Contract box number is missing.                                                                                                                | New: Added December 2025 |
| ANA         | No tracking data exists for this address, or deliverability was unable to find a corresponding level of mail success.                                                          | Live                     |
| AND         | The address is not deliverable according to the USPS.                                                                                                                          | Live                     |
| ANF         | Not found.                                                                                                                                                                     | Live                     |
| APA         | Partial address.                                                                                                                                                               | Live                     |
| APAI        | Both parsed and postal address parameters provided; postal address parameters ignored.                                                                                         | Live                     |
| APCC        | Input postal code was corrected.                                                                                                                                               | Live                     |
| APCR        | The address matched to a Phantom Carrier Route (carrier route of R777), which corresponds to physical addresses that are not eligible for delivery.                            | New: Added December 2025 |
| API         | The primary number is invalid.                                                                                                                                                 | New: Added December 2025 |
| APM         | The primary number is missing.                                                                                                                                                 | New: Added December 2025 |
| APNV        | Street, postcode, city, and country validated. Premise not validated.                                                                                                          | Live                     |
| APO         | The address is identified as a PO Box street address.                                                                                                                          | New: Added December 2025 |
| ARNF        | Resident not found at address.                                                                                                                                                 | Live                     |
| ASC         | Input state corrected.                                                                                                                                                         | Live                     |
| ASCV        | State and country validated.                                                                                                                                                   | Live                     |
| ASDL        | Unable to verify address because the CPF consulted does not have a CNH in the official government database.                                                                    | Live                     |
| ASU         | The address is deliverable, but the secondary unit information is unnecessary.                                                                                                 | Live                     |
| ASUD        | The primary number was confirmed, but the secondary number is unconfirmed and required to be deliverable.                                                                      | New: Added December 2025 |
| ATA         | The address is deliverable by dropping a trailing alphabet from the primary number.                                                                                            | New: Added December 2025 |
| AUICCM      | Unverified. The input data cannot be corrected or matched.                                                                                                                     | Live                     |
| AWS         | The address is deliverable to the building's default address, but is missing secondary unit information. There is a chance the mail will not reach the intended recipient.     | Live                     |

<br />

---

- Path: `general-reference/ekyc-reference`
- URL: https://developer.incode.com/general-reference/ekyc-reference/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference.md

# eKYC Reference

This section provides API-level reference material for Incode's eKYC (electronic Know Your Customer) product. Use these pages to understand response semantics, look up per-country source details, interpret reason codes, and retrieve eKYC data for a completed onboarding session.

For an overview of how to configure eKYC in your Dashboard, see [eKYC Dashboard configuration](/dashboard-platform-administration/ekyc-dashboard/) and [eKYC field requirements by source](/dashboard-platform-administration/ekyc-field-requirements-by-source/).&#x20;

## What's in this section

- [**eKYC API Reference**](/general-reference/ekyc-api-reference/) explains the response semantics for the External Verification (eKYC) endpoint: how to interpret match fields, status values, risk levels, metadata fields, reason codes, and Risk Add-ons. Start here if you are new to integrating with the eKYC API.
  - [**Fetch eKYC Data**](/general-reference/fetch-ekyc-input/) documents the endpoint for retrieving the original form input and risk data for a completed onboarding session.
- [**eKYC Reason Codes**](/general-reference/ekyc-reason-codes/) provides the full list of reason codes returned by the eKYC API, organized by category (Phone, Email, Tax ID, Address).
- [**eKYC Coverage**](/general-reference/ekyc-coverage/) lists all countries and data sources Incode supports for eKYC verification, including field requirements for each source. Individual country pages nested under Coverage provide API-level detail for the sources currently available in the Dashboard, including request parameters, response schemas, and `overallLevel` calculations.

## How the pieces fit together

A typical eKYC integration flow uses these pages together:

1. Choose a country and source from **eKYC Coverage** based on your customer base and use case.
2. Review the country page for that source to understand its request parameters, response schema, and risk-level calculations.
3. Refer to **eKYC API Reference** for shared response concepts (match field patterns, status values, risk levels) that apply across sources.
4. Retrieve original form input and risk data for any session using **Fetch eKYC Data**.
5. Interpret returned reason codes using **eKYC Reason Codes**.

<br />

---

- Path: `general-reference/ekyc-reference-argentina`
- URL: https://developer.incode.com/general-reference/ekyc-reference-argentina/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-argentina.md

# Argentina

Argentina eKYC verification matches submitted individual data against Argentine sources of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                              | API source string                   | Description                                                          |
| ----------------------------------- | ----------------------------------- | -------------------------------------------------------------------- |
| Argentina - Official Civil Register | `AR_1`                              | Verifies submitted data against Argentina's Official Civil Register. |
| Argentina - Credit Bureau 1         | `AR_CREDIT_BUR_1` | Verifies submitted data against Argentine credit bureau records.     |

## Argentina - Official Civil Register

### Request parameters

| Parameter     | Required  | Description                                                     |
| ------------- | --------- | --------------------------------------------------------------- |
| `source`      | Mandatory | Must be `AR_1`.                                                 |
| `country`     | Mandatory | Must be `AR`.                                                   |
| `idNumber`    | Mandatory | Argentine national ID number. Eight digits.                     |
| `idNumber1`   | Optional | Argentine tax ID number (DNI). Eleven digits, numeric only.     |
| `firstName`   | Mandatory | First name of the individual.                                   |
| `middleName`  | Optional  | Middle name of the individual.                                  |
| `surName`     | Mandatory | Last name of the individual.                                    |
| `street`      | Optional  | Street name and house number.                                   |
| `floor`       | Optional  | Floor number in the building.                                   |
| `apartment`   | Optional  | Apartment number.                                               |
| `city`        | Optional  | City of the individual's address (for example, `Buenos Aires`). |
| `state`       | Optional  | State or province.                                              |
| `postalCode`  | Optional  | Postal code.                                                    |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                           |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                 |


### Response fields

Argentina - Official Civil Register anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                               |
| -------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches first name submitted against the value in the source of truth.                    |
| `middleNameMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.                   |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches last name submitted against the value in the source of truth.                     |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.                     |
| `dobMatch`           | `exact`, `nomatch`, `nodata`          | Matches date of birth submitted against the value in the source of truth.                 |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street name and street number submitted against the value in the source of truth. |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches floor and apartment submitted against the value in the source of truth.           |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street and house number submitted against the value in the source of truth.       |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                          |
| `stateMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                         |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                   |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address submitted against the value in the source of truth.                  |
| `idNumMatch`         | `exact`, `nomatch`, `nodata`          | Matches national ID number submitted against the value in the source of truth.            |
| `idNum1Match`        | `exact`, `nomatch`, `nodata`          | Matches tax ID number (DNI) submitted against the value in the source of truth.           |
| `genderMatch`        | `exact`, `nomatch`, `nodata`          | Matches gender submitted against the value in the source of truth.                        |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                      |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and ID numbers:

- `low` when `fullNameMatch` is `exact` AND (`idNumMatch` OR `idNum1Match`) is `exact`.
- `high` when `fullNameMatch` is `nomatch` AND (`idNumMatch` OR `idNum1Match`) is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "idNum1Match", "status": "exact" },
        { "key": "genderMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

## Argentina - Credit Bureau 1

### Request parameters

| Parameter     | Required  | Description                                                     |
| ------------- | --------- | --------------------------------------------------------------- |
| `source`      | Mandatory | Must be `AR_CREDIT_BUR_1`.                                      |
| `country`     | Mandatory | Must be `AR`.                                                   |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.          |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.           |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                           |
| `middleName`  | Optional  | Middle name of the individual. Must not contain digits.         |
| `street`      | Optional  | Street name and house number combined into a single field.      |
| `city`        | Optional  | City of the individual's address.                               |
| `state`       | Optional  | State or province.                                              |
| `postalCode`  | Optional  | Argentine postal code. Accepted formats: 8-character CPA (1 letter + 4 digits + 3 letters, e.g. `C1425ABC`) or legacy 4-digit (e.g. `1425`). |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                 |
| `phone`       | Optional  | Phone number. Digits only.                                      |
| `idNumber`    | Optional  | DNI (Documento Nacional de Identidad). Exactly 8 digits.        |
| `idNumber1`   | Optional  | CUIT (Clave Única de Identificación Tributaria) or CUIL (Código Único de Identificación Laboral). Exactly 11 digits. |

### Response fields

Argentina - Credit Bureau 1 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field              | Statuses                              | Description                                                                                |
| ------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------ |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                     |
| `middleNameMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.                    |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                      |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.                      |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.                  |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street address submitted against the value in the source of truth. Street and house number are combined into a single field. |
| `cityMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                           |
| `stateMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state or province submitted against the value in the source of truth.              |
| `postalCodeMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                    |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address submitted against the value in the source of truth.                   |
| `genderMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                         |
| `phoneMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                          |
| `idNumMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches DNI number submitted against the value in the source of truth.                     |
| `idNum1Match`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches CUIT or CUIL submitted against the value in the source of truth.                   |
| `overallLevel`     | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                       |

### overallLevel calculation

`overallLevel` is calculated based on `fullNameMatch` and `dobMatch`:

- `low` when `fullNameMatch` is `exact` AND `dobMatch` is `exact`.
- `high` when `fullNameMatch` is `nomatch` OR `dobMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
  "kyc": [
    { "key": "firstNameMatch", "status": "exact" },
    { "key": "middleNameMatch", "status": "exact" },
    { "key": "lastNameMatch", "status": "exact" },
    { "key": "fullNameMatch", "status": "exact" },
    { "key": "dobMatch", "status": "exact" },
    { "key": "streetMatch", "status": "exact" },
    { "key": "cityMatch", "status": "exact" },
    { "key": "stateMatch", "status": "exact" },
    { "key": "postalCodeMatch", "status": "exact" },
    { "key": "fullAddressMatch", "status": "exact" },
    { "key": "genderMatch", "status": "exact" },
    { "key": "phoneMatch", "status": "exact" },
    { "key": "idNumMatch", "status": "exact" },
    { "key": "idNum1Match", "status": "exact" },
    { "key": "overallLevel", "status": "low" }
  ]
}
```

---

- Path: `general-reference/ekyc-reference-brazil`
- URL: https://developer.incode.com/general-reference/ekyc-reference-brazil/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-brazil.md

# Brazil

Brazil eKYC verification matches submitted individual data against Brazilian government sources of truth. Brazil also supports a separate income verification endpoint that returns employment and income data for a valid CPF. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all identity-matching sources.

## Available sources

| Source    | Description                                                                                             |
| --------- | ------------------------------------------------------------------------------------------------------- |
| BR GOVT 1 | Verifies submitted data against Brazilian government records associated with the provided tax ID (CPF). |
| BR Income Verification | Retrieves employment and estimated income data for a valid CPF. |
| BR_TAX_PHONE_REGISTER | Verifies submitted data against Brazil's official tax register (CPF) and mobile phone register. |

## BR GOVT 1

### Request parameters

| Parameter     | Required  | Description                                                                                  |
| ------------- | --------- | -------------------------------------------------------------------------------------------- |
| `country`     | Mandatory | Must be `BR`.                                                                                |
| `taxId`       | Mandatory | Brazilian CPF. Eleven digits.                                                                |
| `firstName`   | Mandatory | First name of the individual.                                                                |
| `surName`     | Mandatory | Last name of the individual. If the individual has a middle name, include it here.           |
| `houseNo`     | Optional  | House number.                                                                                |
| `street`      | Optional  | Full street including apartment number.                                                      |
| `city`        | Optional  | City of the individual's address (for example, `Rio de Janeiro`).                            |
| `state`       | Optional  | Two-letter state code (for example, `RJ`).                                                   |
| `postalCode`  | Optional  | Postal code.                                                                                 |
| `dateOfBirth` | Mandatory  | Format: `yyyy-mm-dd`.                                                                        |
| `nationality` | Optional  | Accepted values: `BRAZILIAN`, `NATURALIZED_BRAZILIAN`, `FOREIGNER`, `BRAZILIAN_BORN_ABROAD`. |



### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "firstName": "Renata", // required field
    "surName": "De Maria Santos", //required field 
    "houseNo" : "121",
    "street" : "Rua Luiz Ferreira Dorta",
    "postalCode": "76535000",
    "country": "BR", //required field
    "state" : "RJ",
    "city" : "Rio de Janerio",
    "dateOfBirth": "1980-06-01", //required field
    "nationality" : "1",
    "taxId" : "23490843490" //required field
}
```

### Response fields

BR GOVT 1 anchors verification on the tax ID (CPF). See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values. BR GOVT 1 uses `approximatematch` as an alternative to `fuzzy` for some fields, and `unabletoverify` for address components when the individual has no driver's license record.

| Field                   | Statuses                                                 | Description                                                                                                                                                                             |
| ----------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `taxIdMatch`            | `exact`, `nomatch`                                       | Matches submitted CPF against the CPF in the government source of truth.                                                                                                                |
| `taxIdNameMatch`        | `exact`, `approximatematch`, `nomatch`                   | Matches submitted name against the name associated with the CPF in the government source of truth.                                                                                      |
| `taxIdDobMatch`         | `exact`, `nomatch`                                       | Matches submitted date of birth against the date of birth associated with the CPF.                                                                                                      |
| `taxIdStateMatch`       | `exact`, `nomatch`, `unabletoverify`                     | Matches submitted state against the government source of truth.                                                                                                                         |
| `taxIdAddressMatch`     | `exact`, `approximatematch`, `nomatch`, `unabletoverify` | Matches submitted address against the government source of truth. Approximate match is returned when at least two address elements (street, postal code, city, or state) match exactly. |
| `taxIdCityMatch`        | `exact`, `nomatch`, `unabletoverify`                     | Matches submitted city against the government source of truth.                                                                                                                          |
| `taxIdPostalCodeMatch`  | `exact`, `nomatch`, `unabletoverify`                     | Matches submitted postal code against the government source of truth.                                                                                                                   |
| `taxIdNationalityMatch` | `exact`, `nomatch`                                       | Matches submitted nationality against the CPF in the government source of truth.                                                                                                        |
| `taxIdLevel`            | `low`, `high`                                            | Risk level associated with the CPF. See below.                                                                                                                                          |
| `overallLevel`          | `low`, `medium`, `high`                                  | Overall risk level of the submitted attributes associated with the CPF.                                                                                                                 |

:::info
`unabletoverify` is returned for address-based fields (`taxIdStateMatch`, `taxIdAddressMatch`, `taxIdCityMatch`, `taxIdPostalCodeMatch`) when the individual does not have a driver's license record. Addresses are validated through the Brazilian government's driver's license source of truth.
:::

### taxIdLevel

`taxIdLevel` reflects the status of the submitted CPF:

- `low`: The CPF status is regular (verified).
- `high`: The CPF status is suspended, associated with a deceased holder, pending regularization, canceled due to multiplicity, or canceled by authority.

### Reason codes

BR GOVT 1 returns reason codes alongside match and risk-level fields. Selected Brazil-specific reason codes:

| Reason code | Description                                                                                                                            |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `ASDL`      | Unable to verify address because the CPF does not have a CNH (driver's license) in the official government database.                   |
| `TSR`       | Tax ID status (situação CPF) is regular.                                                                                               |
| `TSRF`      | Tax ID status is not regular. It may be suspended, canceled due to pending regularization, null, or associated with a deceased holder. |
| `TSRP`      | Tax ID status is pending regularization.                                                                                               |
| `TNPIN`     | Tax ID check was not performed due to invalid nationality.                                                                             |
| `TLGPD`     | Tax ID check was not performed due to LGPD (minor's data).                                                                             |
| `ASCV`      | State and country validated.                                                                                                           |

For the full list of reason codes, see [eKYC Reason Codes](/general-reference/ekyc-reason-codes/).

### Sample response

```json
{
    "kyc": [
        { "key": "taxIdNationalityMatch", "status": "exact" },
        { "key": "taxIdDobMatch", "status": "exact" },
        { "key": "taxIdMatch", "status": "exact" },
        { "key": "taxIdAddressMatch", "status": "approximatematch", "reasonCodes": ["ASCV"] },
        { "key": "taxIdNameMatch", "status": "exact" },
        { "key": "taxIdStateMatch", "status": "exact" },
        { "key": "taxIdCityMatch", "status": "exact" },
        { "key": "taxIdPostalCodeMatch", "status": "nomatch" },
        { "key": "taxIdLevel", "status": "low", "reasonCodes": ["TSR"] },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

## BR Income verification

Brazil supports a separate endpoint for retrieving employment and estimated income data for a valid CPF. This endpoint is distinct from the standard eKYC endpoint and returns employment type, employment sector, and an estimated income range in Brazilian Real.

### Endpoint

`POST /omni/externalVerification/income`

For the request contract, see the [eKYC Income Verification](/reference/externalverificationincome/) API reference.

### Response fields

| Field               | Statuses             | Description                                                                                                     |
| ------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------- |
| `employment_type`   | `success`, `failure` | Employment type for the individual (for example, `ENTREPRENEUR / BUSINESS OWNER`, `SELF-EMPLOYED`, `EMPLOYEE`). |
| `employment_sector` | `success`, `failure` | Employment sector, including the CNAE code and description.                                                     |
| `income_range`      | `success`, `failure` | Estimated monthly income range in Brazilian Real (R$), based on a statistical prediction model.                 |

Each field returns a `status` (indicating whether data was available), a `sub_label` (a display label for the field), and a `message` (the actual value or `Unavailable`).

### Estimated income range

The income range is calculated as a multiple of the Brazilian minimum wage and returned as a range in Brazilian Real (R$):

- No information
- 0 - 1412
- 1412 - 2824
- 2824 - 4236
- 4236 - 7060
- 7060 - 9884
- 9884 - 14120
- 14120 - 21180
- 21180 - 28240
- Above 28240


### Employment type

Employment type describes the individual's current employment status. Example values:

- `ENTREPRENEUR / BUSINESS OWNER`
- `SELF-EMPLOYED`
- `EMPLOYEE`

### Employment sector

Employment sector describes the industry the individual works in, including a CNAE code and Portuguese-language description. The CNAE (Classificação Nacional de Atividades Econômicas) is Brazil's national classification of economic activities, maintained by the Instituto Brasileiro de Geografia e Estatística (IBGE).

Example values:

- `PRIVATE - 4789001 - COMERCIO VAREJISTA DE SUVENIRES, BIJUTERIAS E ARTESANATOS`
- `PRIVATE - 7319002 - PROMOCAO DE VENDAS`
- `PUBLIC - 8412400 - REGULACAO DAS ATIVIDADES DE SAUDE, EDUCACAO, SERVICOS CULTURAIS E OUTROS SERVICOS SOCIAIS`

For the full CNAE classification, see the [IBGE CNAE reference](https://concla.ibge.gov.br/busca-online-cnae.html).

### Sample response

```json
{
    "income": [
        {
            "key": "employment_type",
            "status": "success",
            "sub_label": "Type",
            "message": "ENTREPRENEUR | BUSINESS OWNER"
        },
        {
            "key": "employment_sector",
            "status": "success",
            "sub_label": "Sector",
            "message": "PRIVATE - 4639701 - COMERCIO ATACADISTA DE PRODUTOS ALIMENTICIOS EM GERAL"
        },
        {
            "key": "income_range",
            "status": "success",
            "sub_label": "Estimated Income Range",
            "message": "9240-13200"
        }
    ]
}
```

### Availability

Income data may not always be available even for a valid, verified CPF. If a CPF passes the standard BR GOVT 1 check but no income data is available, the income verification endpoint returns `failure` statuses for the affected fields.







## Brazil Tax + Phone Register

### Request parameters

| Parameter | Required | Description |
|---|---|---|
| `source` | Mandatory | Must be `BR_TAX_PHONE_REGISTER`. |
| `country` | Mandatory | Must be `BR`. |
| `firstName` | Mandatory | First name of the individual. Must not contain digits. |
| `middleName` | Optional | Middle name of the individual. Must not contain digits. |
| `surName` | Mandatory | Last name of the individual. Must not contain digits. |
| `city` | Mandatory | City of the individual's address (for example, São Paulo). |
| `street` | Optional | Street name (address = `street` + `houseNo` in Brazil). |
| `houseNo` | Optional | House/building number, combined with `street` to form the full address. |
| `state` | Optional | Brazilian state. Enter the state name, optionally with its two-letter abbreviation (for example, São Paulo – SP). |
| `postalCode` | Optional | Brazil postal code (CEP). See format note below. |
| `dateOfBirth` | Optional | Format: yyyy-mm-dd. |
| `gender` | Optional | Must be `m` or `f`. |
| `email` | Optional | Email address of the individual. |
| `phone` | Optional | Brazil mobile phone number. See format note below. |
| `idNum` | Optional | Brazilian CPF (Cadastro de Pessoas Físicas). See format note below. |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "BR_TAX_PHONE_REGISTER", //required field
    "firstName": "João", //required field
    "middleName": "Carlos",
    "surName": "da Silva Oliveira", //required field
    "street": "Rua Augusta",
    "houseNo": "1500",
    "city": "São Paulo", //required field
    "state": "SP",
    "postalCode": "01304-001",
    "country": "BR", //required field
    "dateOfBirth": "1991-08-02",
    "gender": "m",
    "email": "example.example@gmail.com",
    "phone": "+55 11 91234-5678",
    "idNum": "12345678909"
}
```

### Response fields

Brazil Tax + Phone Register anchors verification on individual name, address, and phone number. See the eKYC API Reference for common match field definitions and status values.

| Field | Statuses | Description |
|---|---|---|
| `firstNameMatch` | exact, fuzzy, nomatch | Matches first name submitted against the value in the source of truth. |
| `middleNameMatch` | exact, fuzzy, nomatch, nodata | Matches middle name submitted against the value in the source of truth. |
| `lastNameMatch` | exact, fuzzy, nomatch | Matches last name submitted against the value in the source of truth. |
| `fullNameMatch` | exact, fuzzy, nomatch | Composite of `firstNameMatch`, `lastNameMatch`, and `middleNameMatch`. See below for calculation logic. |
| `dobMatch` | exact, fuzzy, nomatch, nodata | Matches date of birth submitted against the value in the source of truth. |
| `streetMatch` | exact, fuzzy, nomatch, nodata | Matches street/address submitted against the value in the source of truth. |
| `cityMatch` | exact, fuzzy, nomatch, nodata | Matches city submitted against the value in the source of truth. |
| `stateMatch` | exact, fuzzy, nomatch, nodata | Matches state submitted against the value in the source of truth. |
| `postalCodeMatch` | exact, fuzzy, nomatch, nodata | Matches postal code submitted against the value in the source of truth. |
| `fullAddressMatch` | exact, fuzzy, nomatch, nodata | Composite of `streetMatch`, `cityMatch`, `stateMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `idNumMatch` | exact, fuzzy, nomatch, nodata | Matches CPF (`idNum`) submitted against the value in the source of truth. |
| `genderMatch` | exact, fuzzy, nomatch, nodata | Matches gender submitted against the value in the source of truth. |
| `phoneMatch` | exact, fuzzy, nomatch, nodata | Matches phone submitted against the value in the source of truth. |
| `emailMatch` | exact, fuzzy, nomatch, nodata | Matches email submitted against the value in the source of truth. |
| `overallLevel` | low, medium, high | Overall risk level. See below for calculation logic. |

#### `fullNameMatch` calculation

- `exact` when `firstNameMatch` is exact and `lastNameMatch` is exact, and `middleNameMatch` is exact or nodata.
- `nomatch` when `firstNameMatch` is nomatch or `lastNameMatch` is nomatch.
- `fuzzy` for any other combination.

#### `fullAddressMatch` calculation

- `exact` when `cityMatch` is exact, and at least one of `streetMatch`, `stateMatch`, or `postalCodeMatch` is exact or nodata.
- `nomatch` when `cityMatch` is nomatch.
- `nodata` when `cityMatch`, `streetMatch`, `stateMatch`, and `postalCodeMatch` are all nodata.
- `fuzzy` for any other combination.

#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and city:

- `low` when `fullNameMatch` and `cityMatch` are both exact.
- `high` when `fullNameMatch` or `cityMatch` is nomatch.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "emailMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/ekyc-reference-canada`
- URL: https://developer.incode.com/general-reference/ekyc-reference-canada/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-canada.md

Canada eKYC verification matches submitted individual data against Canadian sources of truth. See the [eKYC API Reference](https://developer.incode.com/v1.1_shipweek/docs/ekyc-api-reference) for common response semantics that apply across all sources.

## Available sources

| Source                   | API source string                   | Description                                                                                      |
| ------------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------ |
| CA RES CREDIT            | `CA_RES_CREDIT`                     | Verifies submitted data against Canadian residential and credit records.                         |
| CA Credit Bureau FINTRAC | `CA_CREDIT_FINTRAC` | Verifies submitted data against Canadian credit bureau records for FINTRAC compliance workflows. |


## CA RES CREDIT

### Request parameters

| Parameter     | Required  | Description                                                |
| ------------- | --------- | ---------------------------------------------------------- |
| `source`      | Mandatory | Must be `CA_RES_CREDIT`.                                   |
| `country`     | Mandatory | Must be `CA`.                                              |
| `firstName`   | Mandatory | First name of the individual.                              |
| `middleName`  | Optional  | Middle name of the individual.                             |
| `surName`     | Mandatory | Last name of the individual.                               |
| `street`      | Mandatory | Street name and house number.                              |
| `city`        | Mandatory | City of the individual's address (for example, `Toronto`). |
| `state`       | Mandatory | Province.                                                  |
| `postalCode`  | Mandatory | Postal code.                                               |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                      |
| `phone`       | Optional  | Phone number.                                              |

### Response fields

CA RES CREDIT anchors verification on the source-of-truth register. See the [eKYC API Reference](https://developer.incode.com/v1.1_shipweek/docs/ekyc-api-reference) for common match field definitions and status values.

| Field              | Statuses                    | Description                                                                                                 |
| ------------------ | --------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `nomatch`          | Matches first name submitted against the value in the source of truth.                                      |
| `middleNameMatch`  | `exact`, `nomatch`          | Matches middle name submitted against the value in the source of truth.                                     |
| `lastNameMatch`    | `exact`, `nomatch`          | Matches last name submitted against the value in the source of truth.                                       |
| `fullNameMatch`    | `exact`, `nomatch`          | Matches full name submitted against the value in the source of truth.                                       |
| `dobMatch`         | `exact`, `nomatch`          | Matches date of birth submitted against the value in the source of truth.                                   |
| `streetMatch`      | `exact`, `nomatch`          | Matches street submitted against the value in the source of truth.                                          |
| `cityMatch`        | `exact`, `nomatch`          | Matches city submitted against the value in the source of truth.                                            |
| `stateMatch`       | `exact`, `nomatch`          | Matches province submitted against the value in the source of truth.                                        |
| `postalCodeMatch`  | `exact`, `nomatch`          | Matches postal code submitted against the value in the source of truth.                                     |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch` | Matches full address (street, city, state, postal code) submitted against the value in the source of truth. |
| `phoneMatch`       | `exact`, `nomatch`          | Matches phone submitted against the value in the source of truth.                                           |
| `overallLevel`     | `low`, `medium`, `high`     | Overall risk level. See below for calculation logic.                                                        |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name, postal code, and date of birth:

- `low` when `fullNameMatch`, `postalCodeMatch`, and `dobMatch` are all `exact`.
- `high` when `fullNameMatch`, `postalCodeMatch`, and `dobMatch` are all `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "nomatch" },
        { "key": "fullNameMatch", "status": "nomatch" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "medium" }
    ]
}
```

## CA Credit Bureau FINTRAC

Canada eKYC non-doc verification leverages Canada's source of truth to validate individuals. It is essential in eKYC processes for ensuring identity authenticity, regulatory compliance, and enhanced security. It helps prevent fraud, boosts user trust, and streamlines operations through automated and efficient verification methods.

eKYC module configuration gives various options to specify different search criteria with various sources of truth for each country (eg. US has multiple via Telco, Credit Bureau, and Driver's License). User data can be collected via a user input flow by using pre-selected fields where users can type in their name or date of birth, etc. See an example below:


<Image src="https://developer.incode.com/assets/0128510078b609b76d75cabfd8a2b7c0.png" align="center" caption="eKYC  user input flow example" />


### Module Configuration

The [module configuration](/dashboard-platform-administration/ekyc-dashboard) can be leveraged to select the applicable fields for the input data you would like to collect from the end user. 


<Image src="https://developer.incode.com/assets/a145630a9f20440beed64fa9faa66f73.png" align="center" caption="eKYC Module configuration" />


### Direct API Approach

All module configurations and user data can be forwarded directly in the request for performing an eKYC search. This will override existing configuration and data collected about the user.

  All endpoints require authentication headers to be specified as stated in [Incode API Documentation](https://developer.incode.com/reference/introduction)


### [**eKYC request**](https://developer.incode.com/reference/externalverificationekyb)

**POST /omni/externalVerification/ekyc**

This endpoint performs an eKYC check for the individual specified. Note: Endpoint can have empty body {} and in that case information will be pulled from module configuration and session details.

- **country**:  (mandatory) String. Two letter Alpha-2 country code. Must be CA.
- **source**: (mandatory) String. Must be CA_RES_CREDIT or CA_CREDIT_FINTRAC.
- **firstName:**: (mandatory) String. First name of the individual.
- **surName**: (mandatory) String. Last name of the individual.
- **middleName:**: (optional) String.
- **street**: (mandatory) String. (Address = street + houseNo in CA)
- **city**: (mandatory) String. City of the individual's address. (eg. Toronto).
- **state**: (mandatory) String.
- **postalCode**: (mandatory) String. postalCode formatted based on per-country postalCode basis.
- **dateOfBirth**: (mandatory) String. Format: YYYY-MM-DD (eg. 1980-06-21)
- **phone**: (mandatory) String.

Example Incode requests:

```json
{
    "plugins": ["kyc"],
	  "source": "CA_RES_CREDIT", //mandatory
    "firstName": "Daniel", //mandatory
    "middleName": "", //optional
    "surName": "Whitmore ", //mandatory
    "street": "2799 Maplewood Crescent", //mandatory - houseNo + street
    "city" : "Ottawa", //mandatory
    "state": "ON", // mandatory
    "postalCode": "K1R7X5", //mandatory
    "country": "CA", //mandatory
    "dateOfBirth" : "1991-08-02", //mandatory
    "phone": "+12048900252", //mandatory
}
```

```json
{
    "plugins": ["kyc"],
	  "source": "CA_CREDIT_FINTRAC", 
    "firstName": "John",
    "middleName": "", 
    "surName": "Doe",
    "street": "97 Main St",
    "city" : "Ottawa",
    "state": "ON",
    "postalCode": "K1M1N8",
    "country": "CA", 
    "dateOfBirth" : "1990-12-12", 
}
```

### Direct API Response

  All endpoints require authentication headers to be specified as stated in [Incode API Documentation](https://developer.incode.com/reference/introduction)


:::note
Endpoint can have empty body {} and in that case information will be pulled from module configuration and session details.
:::

Example Incode responses:

```json
{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "Exact"; 
        },
        {
            "key": "middleNameMatch",
            "status": "Exact"
        },
        {
            "key": "lastNameMatch",
            "status": "Approximate Match"
        },
        {
            "key": "fullNameMatch",
            "status": "Fuzzy"
        },
        {
            "key": "dobMatch",
            "status": "Exact"
        },
        {
            "key": "streetMatch",
            "status": "Exact"
        },
        {
            "key": "cityMatch",
            "status": "Exact"
        },
        {
            "key": "stateMatch",
            "status": "Exact"
        },
        {
            "key": "postalCodeMatch",
            "status": "Exact"
        },
        {
            "key": "fullAddressMatch",
            "status": "Fuzzy"
        },
        {
            "key": "phoneMatch",
            "status": "Match"
        },
        {
            "key": "overallLevel",
            "status": "Low"
        }
    ]
}
```

```json
{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "Exact"; 
        },
        {
            "key": "middleNameMatch",
            "status": "No Match"
        },
        {
            "key": "lastNameMatch",
            "status": "Exact"
        },
        {
            "key": "fullNameMatch",
            "status": "Exact"
        },
        {
            "key": "dobMatch",
            "status": "Exact"
        },
        {
            "key": "streetMatch",
            "status": "Exact"
        },
        {
            "key": "cityMatch",
            "status": "Exact"
        },
        {
            "key": "stateMatch",
            "status": "Exact"
        },
        {
            "key": "postalCodeMatch",
            "status": "Exact"
        },
        {
            "key": "fullAddressMatch",
            "status": "Exact"
        },
        {
            "key": "overallLevel",
            "status": "Low"
        },
        {
		        "key": "creditFileNumber", 
		        "status": "123456789"
		        
        },
        {
		        "key": "creditFileCreationDate", 
          "status": "01-14-2000"
        }
    ]
}
```

### **eKYC error responses**

Please refer to [error response](https://developer.incode.com/reference/introduction#api-responses) to see conventional HTTP response codes to indicate the success or failure of an API request.
For Canada, custom 400 error messages if taxId, or country is “ “ or null:

| Incode API Key | Status | Definition |
|---|---|---|
| firstNameMatch | exact, nomatch | Matches first name submitted against the name associated to the value in the source of truth. |
| middleNameMatch | exact, nomatch | Matches middle name submitted against the name associated to the value in the source of truth. |
| lastNameMatch | exact, nomatch | Matches last name submitted against the name associated to the value in the source of truth. |
| fullNameMatch (first_name, last_name, middle_name) | exact, nomatch | Matches full name (first_name, last_name, middle_name) submitted against the full name associated to the value in the source of truth. |
| dobMatch | exact, nomatch | Matches date of birth submitted against the date of birth associated to the value in the source of truth |
| streetMatch | exact, nomatch | Matches street submitted against the street associated to the value in the source of truth (address1) |
| cityMatch | exact, nomatch | Matches city submitted against the city associated to the value in the source of truth |
| stateMatch | exact, nomatch | Matches state submitted against the state associated to the value in the source of truth |
| postalCodeMatch | exact, nomatch | Matches postal code submitted against the postal code associated to the value in the source of truth |
| fullAddressMatch (StreetMatch, cityMatch, stateMatch, postalCodeMatch) | exact, fuzzy, nomatch | Matches full address (street, city, state, zip) submitted against the full address associated to the value in the source of truth |
| phoneMatch | exact, nomatch | Matches phone submitted against the phone associated to the value in the source of truth |
| creditFileNumber | Integer | The credit file number of the individual.<br />Note: This is only available if the credit file was created at least 3 years ago. For cases where the credit file was created 3 years ago or later, the response will be "_File created less than 3 years ago_". |
| creditFileCreationDate | Date | Date when credit file was created.<br />Note: This is only available if the credit file was created at least 3 years ago. For cases where the credit file was created 3 years ago or later, the response will be "_File created less than 3 years ago_". |

<br />

### overallLevel

Overall Level is the API response key for the submitted name. The fields low, medium, and high are mapped to a proprietary fuzzy matching algorithm that is mapped to a score from 0 to 100.

As a default, overallLevel will return:

**low**: when fullNameMatch & postalCodeMatch & dobMatch are exact;

**high**: when fullNameMatch & postalCodeMatch & dobMatch are nomatch;

**medium**: for all otherwise combination.

### Single Session Dashboard Result


<Image src="https://developer.incode.com/assets/e8725a0fef9d6ff743fc9e9bc178c143.png" align="center" caption="Single Session Dashboard Result" />

---

- Path: `general-reference/ekyc-reference-chile`
- URL: https://developer.incode.com/general-reference/ekyc-reference-chile/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-chile.md

# Chile

Chile eKYC verification matches submitted individual data against Chile's Official Census as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                  | API source string | Description                                              |
| ----------------------- | ----------------- | -------------------------------------------------------- |
| Chile - Official Census | `CL_1`            | Verifies submitted data against Chile's Official Census. |

## Chile - Official Census

### Request parameters

| Parameter     | Required  | Description                                                                                 |
| ------------- | --------- | ------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `CL_1`.                                                                             |
| `country`     | Mandatory | Must be `CL`.                                                                               |
| `idNum`       | Mandatory | Chilean RUT (Rol Único Tributario). Eight digits plus a verification digit or the letter K. |
| `firstName`   | Mandatory | First name of the individual.                                                               |
| `middleName`  | Optional  | Middle name of the individual.                                                              |
| `surName`     | Mandatory | Last name of the individual.                                                                |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                                       |

### Response fields

Chile - Official Census anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field             | Statuses                              | Description                                                               |
| ----------------- | ------------------------------------- | ------------------------------------------------------------------------- |
| `firstNameMatch`  | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.    |
| `middleNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.   |
| `lastNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.     |
| `fullNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.     |
| `dobMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth. |
| `idNumMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches RUT submitted against the value in the source of truth.           |
| `overallLevel`    | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                      |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and RUT:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/ekyc-reference-costa-rica`
- URL: https://developer.incode.com/general-reference/ekyc-reference-costa-rica/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-costa-rica.md

# Costa Rica

Costa Rica eKYC verification matches submitted individual data against Costa Rican sources of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string                   | Description                                          |
| ------ | ----------------------------------- | ---------------------------------------------------- |
| CR 1   |  | Verifies submitted data against Costa Rican records. |


## CR 1


Documentation for this source is forthcoming. Contact your Incode representative for details in the meantime.

---

- Path: `general-reference/ekyc-reference-greece`
- URL: https://developer.incode.com/general-reference/ekyc-reference-greece/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-greece.md

# Greece 

Greece eKYC verification matches submitted individual data against Greece's source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description                                               |
| ------ | ----------------- | --------------------------------------------------------- |
| GR 1   | `GR_1`            | Verifies submitted data against Greece's source of truth. |


## GR 1

### Request parameters

| Parameter     | Required  | Description                                               |
| ------------- | --------- | --------------------------------------------------------- |
| `source`      | Mandatory | Must be `GR_1`.                                           |
| `country`     | Mandatory | Must be `GR`.                                             |
| `idNum`       | Mandatory | Greek national ID. Nine digits, numeric only.             |
| `firstName`   | Mandatory | First name of the individual.                             |
| `middleName`  | Optional  | Middle name of the individual.                            |
| `surName`     | Mandatory | Last name of the individual.                              |
| `houseNo`     | Optional  | House number.                                             |
| `street`      | Optional  | Street name.                                              |
| `city`        | Mandatory | City of the individual's address (for example, `Athens`). |
| `state`       | Optional  | State or region.                                          |
| `postalCode`  | Optional  | Postal code.                                              |
| `gender`      | Optional  | Accepted values are `m` or `f`.                           |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                     |
| `phone`       | Optional  | Phone number.                                             |

### Response fields

GR 1 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field              | Statuses                              | Description                                                                         |
| ------------------ | ------------------------------------- | ----------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.              |
| `middleNameMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.             |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.               |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.               |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.           |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street and house number submitted against the value in the source of truth. |
| `cityMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                    |
| `stateMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                   |
| `postalCodeMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.             |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address submitted against the value in the source of truth.            |
| `idNumMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches national ID submitted against the value in the source of truth.             |
| `phoneMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                   |
| `genderMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                  |
| `overallLevel`     | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and national ID:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/ekyc-reference-guatemala`
- URL: https://developer.incode.com/general-reference/ekyc-reference-guatemala/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-guatemala.md

# Guatemala

Guatemala eKYC verification matches submitted individual data against Guatemala's source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description                                                                          |
| ------ | ----------------- | ------------------------------------------------------------------------------------ |
| GT 1   | `GT_1`            | Verifies submitted data against Guatemalan records associated with the provided DPI. |


## GT 1

### Request parameters

| Parameter     | Required  | Description                                                                                                     |
| ------------- | --------- | --------------------------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `GT_1`.                                                                                                 |
| `country`     | Mandatory | Must be `GT`.                                                                                                   |
| `idNum`       | Mandatory | Guatemalan DPI (Documento Personal de Identificación). Thirteen digits, typically written as `XXXX XXXXX XXXX`. |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                                                                           |
| `firstName`   | Optional  | First name (and often Segundo nombre) of the individual.                                                        |
| `surName`     | Optional  | Last name (and often Segundo apellido) of the individual.                                                       |

### Response fields

GT 1 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values. GT 1 uses `approximatematch` as an alternative to `fuzzy` for name fields.

| Field            | Statuses                               | Description                                                               |
| ---------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `firstNameMatch` | `exact`, `approximatematch`, `nomatch` | Matches first name submitted against the value in the source of truth.    |
| `lastNameMatch`  | `exact`, `approximatematch`, `nomatch` | Matches last name submitted against the value in the source of truth.     |
| `fullNameMatch`  | `exact`, `approximatematch`, `nomatch` | Matches full name submitted against the value in the source of truth.     |
| `dobMatch`       | `exact`, `fuzzy`, `nomatch`            | Matches date of birth submitted against the value in the source of truth. |
| `idNumMatch`     | `exact`, `fuzzy`, `nomatch`            | Matches DPI submitted against the value in the source of truth.           |
| `overallLevel`   | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                      |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and DPI:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "approximatematch" },
        { "key": "fullNameMatch", "status": "approximatematch" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/ekyc-reference-india`
- URL: https://developer.incode.com/general-reference/ekyc-reference-india/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-india.md

# India

India eKYC verification matches submitted individual data against an Indian government source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source         | API source string  | Description                                                                                    |
| -------------- | ------------------- | ------------------------------------------------------------------------------------------------ |
| India DMV      | `IN_DMV`            | Verifies submitted driver's license details.                                                    |
| India PAN      | `INDIA_PAN_1`       | Verifies submitted name, date of birth, and PAN (Permanent Account Number) against a government-partnered source. |
| India Passport | `INDIA_PASSPORT_1`  | Verifies submitted name, date of birth, passport number, file number (PRFN) and issue date against a government-partnered source. |

## India DMV

### Request parameters

| Parameter     | Required  | Description                                                                                       |
| ------------- | --------- | ------------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `IN_DMV`.                                                                                 |
| `country`     | Mandatory | Must be `IN`. `countryCode` takes priority over `country` if both are provided.                   |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.                                            |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                                             |
| `middleName`  | Optional  | Middle name of the individual. Must not contain digits.                                           |
| `dateOfBirth` | Mandatory | Date of birth. Format: `YYYY-MM-DD` (for example, `1991-08-02`).                                  |
| `idNumber`    | Mandatory | Driving license number (for example, `SS-RRRR-YYYY-NNNNNNN`).                                     |
| `street`      | Optional  | House number and street name of the individual's address.                                         |
| `city`        | Optional  | City of the individual's address (for example, `Bengaluru`).                                      |
| `state`       | Optional  | State of the individual's address (for example, `Karnataka`).                                     |
| `postalCode`  | Optional  | PIN code. Must be exactly 6 digits (for example, `560001`).                                       |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                                                   |

The endpoint can accept an empty body (`{}`), in which case information is pulled from module configuration and session details.

### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "IN_DMV",
    "country": "IN",
    "firstName": "Arjun",
    "middleName": "Vikram",
    "surName": "Mehta",
    "dateOfBirth": "1990-03-14",
    "idNumber": "KA0120150009999",
    "street": "12 Street Sample",
    "city": "Bengaluru",
    "state": "Karnataka",
    "postalCode": "560002",
    "gender": "m"
}
```

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

### Response fields

| Field              | Statuses                          | Description                                                                                                                       |
| ------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`       | Matches first name submitted against the value in the source of truth.                                                            |
| `middleNameMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.                                                       |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`       | Matches last name submitted against the value in the source of truth.                                                             |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`       | Matches full name (first, middle, last) submitted against the full name in the source of truth.                                   |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.                                                     |
| `idNumMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches driving license number submitted against the value in the source of truth.                                            |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street submitted against the value in the source of truth.                                                            |
| `cityMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                                                              |
| `stateMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                                                             |
| `postalCodeMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                                                       |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address (street, city, state, postal code) submitted against the full address in the source of truth.            |
| `genderMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                                                            |
| `overallLevel`     | `low`, `medium`, `high`           | Overall risk level based on submitted full name, date of birth, and driving license number. See below for calculation logic.      |

### overallLevel calculation

`overallLevel` is calculated based on the submitted full name, date of birth, and driving license number:

- `low` when `fullNameMatch`, `dobMatch`, and `idNumMatch` are all `exact`.
- `high` when `fullNameMatch`, `dobMatch`, OR `idNumMatch` are `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Error responses

See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for standard HTTP response codes and error handling conventions.

## India PAN

India PAN verifies submitted name, date of birth, and PAN (Permanent Account Number) against a government-partnered source of truth. The name is verified as a single concatenated string rather than first/last name separately.

### Request parameters

| Parameter     | Required  | Description                                                                                       |
| ------------- | --------- | ------------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `INDIA_PAN_1`.                                                                            |
| `country`     | Mandatory | Must be `IN`.                                                                                     |
| `firstName`   | Mandatory | First name of the individual.|
| `surName`     | Mandatory | Last name of the individual.|
| `dateOfBirth` | Mandatory | Date of birth. Format: `YYYY-MM-DD` (for example, `1987-08-17`).                                  |
| `idNumber`    | Mandatory | PAN (Permanent Account Number). Exactly 10 characters: 5 letters, 4 digits, 1 letter (for example, `BVZPS1846R`). |

### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "INDIA_PAN_1",
    "country": "IN",
    "firstName": "Priya",
    "surName": "Nair",
    "dateOfBirth": "1992-11-05",
    "idNumber": "ABCDE1234F"
}
```

### Sample response

```json
{
    "kyc": [
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumberMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ],
    "income": []
}
```

### Response fields

| Field            | Statuses                | Description                                                                                       |
| ---------------- | ------------------------ | --------------------------------------------------------------------------------------------------- |
| `fullNameMatch`   | `exact`, `fuzzy`, `nomatch` | Matches the submitted full name (firstName + surName, concatenated) against the name on record for the PAN. Name is verified as one string — `firstNameMatch`/`lastNameMatch` are not returned for this source. |
| `dobMatch`        | `exact`, `nomatch`         | Matches date of birth submitted against the value on record for the PAN.                           |
| `idNumberMatch`   | `exact`, `nomatch`         | Matches the submitted PAN number against the government-partnered source.                          |
| `overallLevel`    | `low`, `medium`, `high`    | Overall risk level based on submitted full name, date of birth, and PAN number. See below for calculation logic. |

### overallLevel calculation

`overallLevel` is calculated based on the submitted full name, date of birth, and PAN number:

- `low` when (`fullNameMatch` is `exact` OR `fullNameMatch` is `fuzzy`) AND `idNumberMatch` is `exact` AND `dobMatch` is `exact`.
- `high` when `fullNameMatch` is `nomatch` AND `idNumberMatch` is `nomatch` AND `dobMatch` is `nomatch`.
- `medium` for all other combinations.



### Error responses

See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for standard HTTP response codes and error handling conventions.



## India Passport

India Passport verifies submitted name, date of birth, passport number, passport file number (PRFN) and — optionally — passport issue date against a government-partnered source of truth. The name is verified as a single concatenated string rather than first/last name separately.

### Request parameters

| Parameter     | Required  | Description                                                                                       |
| ------------- | --------- | ------------------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `INDIA_PASSPORT_1`.                                                                       |
| `country`     | Mandatory | Must be `IN`.                                                                                     |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.|
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.|
| `dateOfBirth` | Mandatory | Date of birth, in the past. Format: `YYYY-MM-DD` (for example, `1987-08-17`).                      |
| `idNumber`    | Mandatory | Passport number. Exactly 8 characters, uppercase: 1 letter followed by 7 digits (for example, `S3733862`). Values are uppercased before matching, so lowercase input is accepted. |
| `fileNumber`  | Mandatory | Passport file number (PRFN). Exactly 15 characters, uppercase: 2 letters followed by 13 digits (for example, `BO3072344560818`). Values are uppercased before matching, so lowercase input is accepted. |
| `dateOfIssue` | Optional  | Passport issue date. Format: `YYYY-MM-DD` (for example, `2018-05-14`).                             |

### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "INDIA_PASSPORT_1",
    "country": "IN",
    "firstName": "Vikram",
    "surName": "Reddy",
    "dateOfBirth": "1988-06-23",
    "idNumber": "J4567890",
    "fileNumber": "DL1234567890123",
    "dateOfIssue": "2020-02-10"
}
```

### Sample response

```json
{
    "kyc": [
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumberMatch", "status": "exact" },
        { "key": "fileNumberMatch", "status": "exact" },
        { "key": "dateOfIssueMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ],
    "income": []
}
```

### Response fields

| Field              | Statuses                | Description                                                                                       |
| ------------------- | ------------------------ | ----------------------------------------------------------------------------------------------- |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch` | Matches the submitted full name (firstName + surName, concatenated) against the name on record for the passport. Name is verified as one string — `firstNameMatch`/`lastNameMatch` are not returned for this source. |
| `dobMatch`           | `exact`, `nomatch`         | Matches date of birth submitted against the value on record for the passport.                     |
| `idNumberMatch`      | `exact`, `nomatch`         | Matches the submitted passport number against the government-partnered source.                    |
| `fileNumberMatch`    | `exact`, `nomatch`         | Matches the submitted passport file number (PRFN) against the government-partnered source.        |
| `dateOfIssueMatch`   | `exact`, `nomatch`         | Matches the submitted passport issue date against the value on record. Returned only when `dateOfIssue` was included in the request. |
| `overallLevel`       | `low`, `medium`, `high`    | Overall risk level based on submitted full name, date of birth, and passport number. `fileNumberMatch` and `dateOfIssueMatch` do not factor into this calculation. See below for calculation logic. |

### overallLevel calculation

`overallLevel` is calculated based on the submitted full name, date of birth, and passport number only — `fileNumberMatch` and `dateOfIssueMatch` are not used in this calculation:

- `low` when (`fullNameMatch` is `exact` OR `fullNameMatch` is `fuzzy`) AND `dobMatch` is `exact` AND `idNumberMatch` is `exact`.
- `high` when `fullNameMatch` is `nomatch` AND `dobMatch` is `nomatch` AND `idNumberMatch` is `nomatch`.
- `medium` for all other combinations.



### Error responses

See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for standard HTTP response codes and error handling conventions.

---

- Path: `general-reference/ekyc-reference-mexico`
- URL: https://developer.incode.com/general-reference/ekyc-reference-mexico/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-mexico.md

# Mexico

Mexico eKYC verification uses phone and email risk-scoring rather than source-of-truth identity matching. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics.

## Available sources

| Source        | API source string | Description                                                                                             |
| ------------- | ----------------- | ------------------------------------------------------------------------------------------------------- |
| MX CONSUMER 1 | `MX_Consumer_1`   | Returns risk scores for phone and email based on third-party data, and an aggregate overall risk level. |
| Mexico Civil Register 2 | `MX_CIVIL_REGISTER_2` | Returns risk scores for CURP, Name and DOB based on government database. |

## MX CONSUMER 1

MX CONSUMER 1 combines phone and email risk-scoring from third-party providers:

- **Phone** returns a risk score based on account history, prepaid status, account duration, and monthly bill amount.
- **Email** returns a predictive risk score based on historical transaction data and behavior patterns.

The request works with only phone or only email supplied. If both are provided, the response includes both individual scores and an aggregate overall risk level.

### Request parameters

| Parameter         | Required    | Description                                                               |
| ----------------- | ----------- | ------------------------------------------------------------------------- |
| `source`          | Mandatory   | Must be `MX_Consumer_1`.                                                  |
| `country`         | Mandatory   | Must be `MX`.                                                             |
| `phone`           | Conditional | Phone number in E.164 format. Either `phone` or `email` must be provided. |
| `email`           | Conditional | Email address. Either `phone` or `email` must be provided.                |
| `firstName`       | Optional    | First name of the individual, including middle name if applicable.        |
| `surName`         | Optional    | Last name of the individual.                                              |
| `maternalSurname` | Optional    | Maternal surname.                                                         |

### Response fields

| Field          | Statuses                             | Description                                                |
| -------------- | ------------------------------------ | ---------------------------------------------------------- |
| `phoneLevel`   | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted phone number.     |
| `phoneCarrier` | String                               | Phone carrier associated with the submitted phone number.  |
| `emailLevel`   | `low`, `medium`, `high`, `very_high` | Risk level associated with the submitted email address.    |
| `overallLevel` | `low`, `medium`, `high`, `very_high` | Aggregate risk level combining the phone and email scores. |

### Sample response

```json
{
    "kyc": [
        { "key": "phoneLevel", "status": "low" },
        { "key": "phoneCarrier", "status": "Verizon" },
        { "key": "emailLevel", "status": "low" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

## Mexico Civil Register 2

Mexico eKYC non-doc verification leverages Mexico's source of truth to validate individuals. It is essential in eKYC processes for ensuring identity authenticity, regulatory compliance, and enhanced security. It helps prevent fraud, boosts user trust, and streamlines operations through automated and efficient verification methods.







### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["kyc"]`. |
| source | Mandatory | String. Must be `MX_CIVIL_REGISTER_2`. |
| firstName | Mandatory | String. First name (Nombre) of the individual. Must not contain digits. |
| surName | Mandatory | String. Father's last name (Apellido Paterno) of the individual. Must not contain digits. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `MX`. |
| idNum | Mandatory | String. Mexican CURP (Clave Única de Registro de Población). Format: exactly 18 alphanumeric characters (for example, `GODE561231HDFRRN09`). |
| middleName | Optional | String. Mother's last name (Apellido Materno) of the individual. Must not contain digits. |
| dateOfBirth | Optional | String. Date of birth in `yyyy-mm-dd` format (for example, `1991-08-02`). |
| gender | Optional | String. Gender of the individual. Accepted values: `m` (male) or `f` (female). |



### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "MX_CIVIL_REGISTER_2",
    "firstName": "Jose",
    "middleName": "Example",
    "surName": "Alberto",
    "country": "MX",
    "idNum": "ABCD000101HDFRRN09",
    "dateOfBirth": "2000-01-01",
    "gender": "m"
}
```

### Sample response

```json
{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "exact"
        },
        {
            "key": "middleNameMatch",
            "status": "exact"
        },
        {
            "key": "lastNameMatch",
            "status": "exact"
        },
        {
            "key": "fullNameMatch",
            "status": "exact"
        },
        {
            "key": "dobMatch",
            "status": "exact"
        },
        {
            "key": "idNumMatch",
            "status": "exact"
        },
        {
            "key": "genderMatch",
            "status": "exact"
        },
        {
            "key": "overallLevel",
            "status": "low"
        }
    ]
}
```

### Response fields

| Incode API Key | Status | Definition |
| --- | --- | --- |
| firstNameMatch | exact, fuzzy, nomatch | Matches first name (Nombre) submitted against the first name in the source of truth. |
| middleNameMatch | exact, fuzzy, nomatch, nodata | Matches mother's last name (Apellido Materno) submitted against the source of truth. `nodata` is returned when the middle name is not available in the source of truth. |
| lastNameMatch | exact, fuzzy, nomatch | Matches father's last name (Apellido Paterno) submitted against the source of truth. |
| fullNameMatch | exact, fuzzy, nomatch | Composite match derived from `firstNameMatch`, `lastNameMatch`, and `middleNameMatch`. See overallLevel section below for composite logic. |
| dobMatch | exact, fuzzy, nomatch, nodata | Matches date of birth submitted against the source of truth. |
| idNumMatch | exact, fuzzy, nomatch, nodata | Matches the CURP submitted against the source of truth. |
| genderMatch | exact, fuzzy, nomatch, nodata | Matches gender submitted against the source of truth. |
| overallLevel | low, medium, high | Overall Risk Level derived from `fullNameMatch` and `idNumMatch`. See below for how low, medium, and high are calculated. |

### overallLevel

Overall Level is the API response key for the submitted identity check. The fields low, medium, and high are mapped to the result of the identity verification check.

As a default, overallLevel will return:

**low**: when `fullNameMatch` = exact **AND** `idNumMatch` = exact;

**high**: when `fullNameMatch` = nomatch **OR** `idNumMatch` = nomatch;

**medium**: for all other combinations.

---

- Path: `general-reference/ekyc-reference-netherlands`
- URL: https://developer.incode.com/general-reference/ekyc-reference-netherlands/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-netherlands.md

# Netherlands



Netherlands eKYC verification matches submitted individual data against Netherlands sources of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                                    | API source string            | Description                                                                                          |
| ----------------------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------ |
| Netherlands Consumer + Pop Register + Telco | `NL_CONSUMER_POP_REG_TELCO` | Verifies submitted data against Netherlands consumer records, the population register, and telco records. |

## Netherlands Consumer + Pop Register + Telco

Netherlands Consumer + Pop Register + Telco verifies a submitted individual against Netherlands consumer records, the population register, and telco records in a single request. Verification is anchored on name and phone number.

### Request parameters

| Parameter     | Required  | Description                                                                 |
| ------------- | --------- | ---------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `NL_CONSUMER_POP_REG_TELCO`.                                         |
| `country`     | Mandatory | Must be `NL`.                                                                |
| `firstName`   | Mandatory | First name of the individual. Letters, spaces, hyphens, and apostrophes only. |
| `surName`     | Mandatory | Last name of the individual. Letters, spaces, hyphens, and apostrophes only.  |
| `phone`       | Mandatory | Netherlands phone number. Must be either 10 digits in national format (for example, `0612345678`) or `+31` followed by 9 digits in international format (for example, `+31612345678`).                            |
| `street`      | Optional  | Street name.                                                                 |
| `houseNo`     | Optional  | House or building number.                                                    |
| `city`        | Optional  | City of the individual's address (for example, `Amsterdam`).                |
| `postalCode`  | Optional  | Netherlands postal code. Must be four digits followed by two uppercase letters (for example, `1016DV`).                             |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                        |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                              |
| `email`       | Optional  | Email address of the individual.                                             |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "NL_CONSUMER_POP_REG_TELCO", //required field
    "firstName": "Jeroen", //required field
    "surName": "van Dijk", //required field
    "phone": "+31612345678", //required field
    "country": "NL", //required field
    "street": "Keizersgracht", //optional field
    "houseNo": "215", //optional field
    "city": "Amsterdam", //optional field
    "postalCode": "1016DV", //optional field
    "dateOfBirth": "1991-08-02", //optional field
    "gender": "m", //optional field
    "email": "jeroen.vandijk@example.com" //optional field
}
```

### Response fields

Netherlands Consumer + Pop Register + Telco anchors verification on individual name and phone number. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                                                    |
| -------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches submitted first name against the source of truth.                                                      |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches submitted last name against the source of truth.                                                        |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise, `fuzzy`. |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted date of birth against the source of truth.                                                    |
| `genderMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted gender against the source of truth.                                                           |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted street against the source of truth.                                                           |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted house number against the source of truth. Not used in the `fullAddressMatch` calculation.     |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch` and `houseNoMatch`. `exact` if both match; `nomatch` if either does not match; `nodata` if both have no data; otherwise, `fuzzy`. |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted city against the source of truth.                                                             |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted postal code against the source of truth.                                                      |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. `exact` if `streetMatch` is `exact` and `cityMatch` and `postalCodeMatch` are each `exact` or `nodata`; `nomatch` if all three are `nomatch`; `nodata` if all three are `nodata`; otherwise, `fuzzy`. |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted phone number against the source of truth.                                                     |
| `emailMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted email address against the source of truth.                                                    |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level of the submitted attributes. See below for calculation logic.                                |

#### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and phone number:

- `low` when `fullNameMatch` is `exact` AND `phoneMatch` is `exact`.
- `high` when `fullNameMatch` is `nomatch` OR `phoneMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "genderMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "houseNoMatch", "status": "exact" },
        { "key": "streetAddressMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "emailMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/ekyc-reference-nigeria`
- URL: https://developer.incode.com/general-reference/ekyc-reference-nigeria/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-nigeria.md

# Nigeria

Nigeria eKYC verification matches submitted individual data against Nigerian sources of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source      | API source string                   | Description                                                                            |
| ----------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| NG MONO BVN |  | Verifies submitted data against Nigerian BVN (Bank Verification Number) records.       |
| NG MONO NIN |  | Verifies submitted data against Nigerian NIN (National Identification Number) records. |



## NG MONO BVN

Documentation for this source is forthcoming. Contact your Incode representative for details in the meantime.

## NG MONO NIN

Documentation for this source is forthcoming. Contact your Incode representative for details in the meantime.

---

- Path: `general-reference/ekyc-reference-philippines`
- URL: https://developer.incode.com/general-reference/ekyc-reference-philippines/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-philippines.md

Philippines eKYC non-doc verification leverages the Philippines' sources of truth to validate individuals. It is essential in eKYC processes for ensuring identity authenticity, regulatory compliance, and enhanced security. It helps prevent fraud, boosts user trust, and streamlines operations through automated and efficient verification methods.

## Integration

### User input flow

eKYC module configuration gives various options to specify different search criteria with various sources of truth for each country (e.g. Philippines has a sequenced/waterfall source that looks for matches through 2 data sources: Philippines Residential and Philippines Credit Bureau). User data can be collected via a user input flow by using pre-selected fields where users can type in their name, date of birth, etc. See an example below:


<Image src="https://developer.incode.com/assets/9174af288cd2ffd3c4efd330483670df.png" align="center" width="250px" caption="_eKYC User Input Flow_" />


<br />

### Module configuration

The module configuration can be leveraged to select the applicable fields for the input data you would like to collect from the end user.


<Image src="https://developer.incode.com/assets/9f6fcd48c401c0327c798cd71931af54.png" align="center" width="600px" caption="_eKYC Module configuration_" />


<br />

<br />_eKYC Module configuration_

### Direct API Approach

All module configurations and user data can be forwarded directly in the request for performing an eKYC search. This will override existing configuration and data collected about the user.

<Callout icon="📘" theme="info">
  #### **API Authentication**

  All endpoints require authentication headers to be specified as stated in [Incode API Documentation](https://developer.incode.com/reference/introduction)
</Callout>

#### eKYC request

**POST /omni/externalVerification/ekyc**

This endpoint performs an eKYC check for the individual specified. Note: Endpoint can have empty body `{}` and in that case information will be pulled from module configuration and session details.

- **country**: (mandatory) String. Two letter Alpha-2 country code. Must be `PH`. Note: `countryCode` takes priority over `country` if both are provided.
- **source**: (mandatory) String. Must be `PH_RES_CREDIT`.
- **firstName**: (mandatory) String. First name of the individual. Must not contain digits.
- **surName**: (mandatory) String. Last name of the individual. Must not contain digits.
- **middleName**: (optional) String. Must not contain digits.
- **dateOfBirth**: (mandatory) String. Format: `YYYY-MM-DD` (e.g. `1970-12-12`).
- **street**: (optional) String. House number and street name of the address.
- **district**: (optional) String. Barangay or district of the address.
- **city**: (optional) String. City of the individual's address (e.g. `Quezon City`).
- **state**: (optional) String. Province or region (e.g. `Metro Manila (NCR)`).
- **postalCode**: (optional) String. Must be exactly 4 digits (e.g. `1100`).
- **idNumber**: (optional) String. National ID number. Must be provided together with `idType`. Supported types below.
- **idType**: (optional) String. Must be one of `SSS`, `TIN`, or `GSIS`. Must be provided together with `idNumber`.

**Supported ID types:**

| ID Type | Description                                | Format                                                                                     |
| ------- | ------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `TIN`   | Tax Identification Number                  | 9 digits (`123456789` or `123-456-789`) or 12 digits (`123456789000` or `123-456-789-000`) |
| `SSS`   | Social Security System Number              | 10 digits with hyphens (`12-3456789-0`)                                                    |
| `GSIS`  | Government Service Insurance System Number | Exactly 12 digits (`123456789012`)                                                         |

Example Incode request:

```json
{
    "plugins": ["kyc"],
    "source": "PH_RES_CREDIT",
    "firstName": "Maria",
    "middleName": "Santos",
    "surName": "Cruz",
    "street": "123 Rizal Street",
    "district": "Tangil",
    "city": "Quezon City",
    "state": "Metro Manila (NCR)",
    "postalCode": "1100",
    "country": "PH",
    "dateOfBirth": "1970-12-12",
    "idNumber": "123456789012",
    "idType": "GSIS"
}
```

### Direct API Response

<Callout icon="📘" theme="info">
  #### **API Authentication**

  All endpoints require authentication headers to be specified as stated in [Incode API Documentation](https://developer.incode.com/reference/introduction)
</Callout>

Note: Endpoint can have empty body `{}` and in that case information will be pulled from module configuration and session details.

Example Incode response:

```json
{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "exact"
        },
        {
            "key": "middleNameMatch",
            "status": "nomatch"
        },
        {
            "key": "lastNameMatch",
            "status": "exact"
        },
        {
            "key": "fullNameMatch",
            "status": "exact"
        },
        {
            "key": "dobMatch",
            "status": "exact"
        },
        {
            "key": "streetMatch",
            "status": "exact"
        },
        {
            "key": "districtMatch",
            "status": "exact"
        },
        {
            "key": "cityMatch",
            "status": "exact"
        },
        {
            "key": "stateMatch",
            "status": "exact"
        },
        {
            "key": "postalCodeMatch",
            "status": "exact"
        },
        {
            "key": "fullAddressMatch",
            "status": "exact"
        },
        {
            "key": "idNumberMatch",
            "status": "nomatch"
        },
        {
            "key": "overallLevel",
            "status": "low"
        }
    ]
}
```

#### eKYC error responses

Please refer to [error response](https://developer.incode.com/reference/introduction#api-responses) to see conventional HTTP response codes to indicate the success or failure of an API request.
For Philippines, custom 400 error messages if required fields are missing or incorrectly formatted:

| Incode API Key                                                                        | Status                | Definition                                                                                                                                                                                 |
| ------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| firstNameMatch                                                                        | exact, nomatch        | Matches first name submitted against the name associated to the value in the source of truth.                                                                                              |
| middleNameMatch                                                                       | exact, nomatch        | Matches middle name submitted against the name associated to the value in the source of truth.                                                                                             |
| lastNameMatch                                                                         | exact, nomatch        | Matches last name submitted against the name associated to the value in the source of truth.                                                                                               |
| fullNameMatch (firstName, surName, middleName)                                        | exact, nomatch        | Matches full name (firstName, surName, middleName) submitted against the full name associated to the value in the source of truth.                                                         |
| dobMatch                                                                              | exact, nomatch        | Matches date of birth submitted against the date of birth associated to the value in the source of truth.                                                                                  |
| streetMatch                                                                           | exact, nomatch        | Matches street submitted against the street associated to the value in the source of truth.                                                                                                |
| districtMatch                                                                         | exact, nomatch        | Matches district/Barangay submitted against the district associated to the value in the source of truth. New field for Philippines.                                                        |
| cityMatch                                                                             | exact, nomatch        | Matches city submitted against the city associated to the value in the source of truth.                                                                                                    |
| stateMatch                                                                            | exact, nomatch        | Matches state/province submitted against the state associated to the value in the source of truth.                                                                                         |
| postalCodeMatch                                                                       | exact, nomatch        | Matches postal code submitted against the postal code associated to the value in the source of truth.                                                                                      |
| fullAddressMatch (streetMatch, districtMatch, cityMatch, stateMatch, postalCodeMatch) | exact, fuzzy, nomatch | Matches full address (street, district, city, state, postalCode) submitted against the full address associated to the value in the source of truth.                                        |
| idNumberMatch                                                                         | exact, nomatch        | Matches national ID number submitted against the ID number associated to the value in the source of truth.                                                                                 |
| overallLevel                                                                          | low, medium, high     | Overall Risk Level is focused on the risk associated to the submitted full name and date of birth. See context below for more information around how low, medium, and high are calculated. |

#### overallLevel

Overall Level is the API response key for the submitted name. The fields low, medium, and high are mapped to the result of the identity verification check.

As a default, overallLevel will return:

**low**: when fullNameMatch & dobMatch are exact;

**high**: when fullNameMatch OR dobMatch are nomatch;

**medium**: for all otherwise combinations.

### Single Session Dashboard Result<br />


<Image src="https://developer.incode.com/assets/ae1fd6be00f77c8edae65981cf20b9b3.png" align="center" caption="_Single Session Dashboard Result_" />

---

- Path: `general-reference/ekyc-reference-spain`
- URL: https://developer.incode.com/general-reference/ekyc-reference-spain/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-spain.md

# Spain

Spain eKYC verification matches submitted individual data against Spain's Utility - Phone Register as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                 | API source string | Description                                                       |
| ---------------------- | ----------------- | ----------------------------------------------------------------- |
| Spain Phone Register 2 | `ES_1`            | Verifies submitted data against Spain's Utility - Phone Register. |


## Spain Phone Register 2

### Request parameters

| Parameter     | Required  | Description                                                         |
| ------------- | --------- | ------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `ES_1`.                                                     |
| `country`     | Mandatory | Must be `ES`.                                                       |
| `taxID`       | Mandatory | Spanish DNI. Nine characters: eight digits followed by a letter.    |
| `firstName`   | Mandatory | First name of the individual.                                       |
| `surName`     | Mandatory | Last name (Apellido2, mother's last name).                          |
| `middleName`  | Optional  | Apellido1 (father's last name).                                     |
| `houseNo`     | Optional  | House or building number.                                           |
| `street`      | Optional  | Street name.                                                        |
| `city`        | Optional  | City of the individual's address (for example, `Madrid`).           |
| `state`       | Optional  | State or autonomous community (for example, `Comunidad de Madrid`). |
| `postalCode`  | Optional  | Postal code.                                                        |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                               |
| `phone`       | Optional  | Phone number.                                                       |


### Response fields

Spain Phone Register 2 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                         |
| -------------------- | ------------------------------------- | ----------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.              |
| `middleNameMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.             |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.               |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.               |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.           |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street submitted against the value in the source of truth.                  |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches house number submitted against the value in the source of truth.            |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street and house number submitted against the value in the source of truth. |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                    |
| `stateMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                   |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.             |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address submitted against the value in the source of truth.            |
| `idNumMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches DNI submitted against the value in the source of truth.                     |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                   |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and DNI:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/ekyc-reference-sweden`
- URL: https://developer.incode.com/general-reference/ekyc-reference-sweden/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-sweden.md

# Sweden

Sweden eKYC verification matches submitted individual data against Sweden's source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description                                               |
| ------ | ----------------- | --------------------------------------------------------- |
| SE 1   | `SE_1`            | Verifies submitted data against Sweden's source of truth. |


## SE 1

### Request parameters

| Parameter     | Required  | Description                                                           |
| ------------- | --------- | --------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `SE_1`.                                                       |
| `country`     | Mandatory | Must be `SE`.                                                         |
| `idNumber`    | Mandatory | Swedish personnummer. Ten characters in the most common short format. |
| `firstName`   | Mandatory | First name of the individual.                                         |
| `surName`     | Mandatory | Last name of the individual.                                          |
| `street`      | Mandatory | Street name and house number.                                         |
| `city`        | Mandatory | City of the individual's address (for example, `Stockholm`).          |
| `postalCode`  | Optional  | Postal code. Always five digits, typically written with a space.      |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                 |
| `phone`       | Optional  | Phone number.                                                         |

### Response fields

SE 1 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                                          |
| -------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                               |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                                |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches full name (first and last) submitted against the value in the source of truth.               |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.                            |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street and house number submitted against the value in the source of truth.                  |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                                     |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                              |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address (street, city, postal code) submitted against the value in the source of truth. |
| `idNumMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches personnummer submitted against the value in the source of truth.                             |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                                    |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                                 |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and personnummer:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetAddressMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/ekyc-reference-united-kingdom`
- URL: https://developer.incode.com/general-reference/ekyc-reference-united-kingdom/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-united-kingdom.md

# United Kingdom

United Kingdom eKYC verification matches submitted individual data against UK sources of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source             | API source string                   | Description                                                          |
| ------------------ | ----------------------------------- | -------------------------------------------------------------------- |
| UK VOTER REGISTER  | `UK_Voter_Register`                 | Verifies submitted data against the United Kingdom's Voter Register. |
|UK 2+2 VERIFICATION | `GB_2X2`   | Verifies submitted data against UK civil and voter register and credit records.

## UK VOTER REGISTER

### Request parameters

| Parameter     | Required  | Description                                                                            |
| ------------- | --------- | -------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `UK_Voter_Register`.                                                           |
| `country`     | Mandatory | Must be `GB`.                                                                          |
| `firstName`   | Mandatory | First name of the individual.                                                          |
| `middleName`  | Optional  | Middle name of the individual.                                                         |
| `surName`     | Mandatory | Last name of the individual.                                                           |
| `street`      | Optional  | Street name and house number.                                                          |
| `city`        | Optional  | City of the individual's address.                                                      |
| `postalCode`  | Optional  | Postal code. Five to seven characters, letters and digits only, no special characters. |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                                  |
| `phone`       | Optional  | Phone number. Ten or eleven digits, most commonly eleven.                              |
| `gender`      | Optional  | Accepted values are `M` or `F`.                                                        |


### Response fields

UK VOTER REGISTER anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field             | Statuses                               | Description                                                               |
| ----------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `firstNameMatch`  | `exact`, `fuzzy`, `nomatch`            | Matches first name submitted against the value in the source of truth.    |
| `middleNameMatch` | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches middle name submitted against the value in the source of truth.   |
| `lastNameMatch`   | `exact`, `fuzzy`, `nomatch`            | Matches last name submitted against the value in the source of truth.     |
| `fullNameMatch`   | `exact`, `fuzzy`, `nomatch`            | Matches full name submitted against the value in the source of truth.     |
| `dobMatch`        | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches date of birth submitted against the value in the source of truth. |
| `genderMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches gender submitted against the value in the source of truth.        |
| `streetMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches street submitted against the value in the source of truth.        |
| `cityMatch`       | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches city submitted against the value in the source of truth.          |
| `zipcodeMatch`    | `exact`, `nomatch`, `unknown`          | Matches postal code submitted against the value in the source of truth.   |
| `addressMatch`    | `exact`, `fuzzy`, `nomatch`            | Matches full address submitted against the value in the source of truth.  |
| `phoneMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches phone submitted against the value in the source of truth.         |
| `overallLevel`    | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                      |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and address:

- `low` when `fullNameMatch` is a match AND (`addressMatch` is a match OR `addressMatch` is `fuzzy`).
- `high` when `fullNameMatch` and `addressMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "genderMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "zipcodeMatch", "status": "exact" },
        { "key": "addressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

## GB 2x2



### Request parameters

| Parameter     | Required  | Description                                                                 |
| ------------- | --------- | ---------------------------------------------------------------------------- |
| `country`     | Mandatory | Must be `GB`.                                                                |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.                      |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                       |
| `street`      | Mandatory | Street name.                                                                 |
| `houseNo`     | Mandatory | House or building number.                                                    |
| `city`        | Mandatory | City of the individual's address (for example, `London`).                   |
| `state`       | Mandatory | County or region (for example, `Greater London`).                           |
| `postalCode`  | Mandatory  | UK postal code. See format note below.                                      |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                                        |

:::info
`postalCode` must be 5–7 alphanumeric characters, optionally with a single space separating the outward and inward parts (5–8 characters including the space). For example, `NW1 6XE` or `NW16XE`.
:::

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "firstName": "John", //required field
    "surName": "Smith", //required field
    "street": "Baker Street", //required field
    "houseNo": "221B", //required field
    "city": "London", //required field
    "state": "Greater London", //required field
    "postalCode": "NW1 6XE", //required field
    "country": "GB", //required field
    "dateOfBirth": "1991-08-02" //required field
}
```

### Response fields

GB_2X2 anchors verification on individual name, date of birth, and address elements. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                 | Statuses                          | Description                                                                                                    |
| --------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `firstNameMatch`      | `exact`, `fuzzy`, `nomatch`         | Matches submitted first name against the source of truth.                                                      |
| `lastNameMatch`       | `exact`, `fuzzy`, `nomatch`         | Matches submitted last name against the source of truth.                                                        |
| `fullNameMatch`       | `exact`, `fuzzy`, `nomatch`         | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise `fuzzy`. |
| `dobMatch`            | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted date of birth against the source of truth.                                                    |
| `streetMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted street against the source of truth.                                                           |
| `houseNoMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted house number against the source of truth.                                                     |
| `streetAddressMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch` and `houseNoMatch`. `exact` if both match; `nomatch` if either does not match; `nodata` if both have no data; otherwise `fuzzy`. |
| `cityMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted city against the source of truth.                                                             |
| `stateMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted state/county against the source of truth.                                                     |
| `postalCodeMatch`     | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted postal code against the source of truth.                                                      |
| `fullAddressMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetAddressMatch`, `cityMatch`, and `postalCodeMatch`. `exact` if all match (or have no data where applicable); `nomatch` if all three do not match; `nodata` if all three have no data; otherwise `fuzzy`. |
| `overallLevel`        | `low`, `medium`, `high`            | Overall risk level of the submitted attributes. `low` if `fullNameMatch` and `dobMatch` are exact and `fullAddressMatch` is exact or fuzzy; `high` if `fullNameMatch` or `dobMatch` does not match and `fullAddressMatch` does not match; otherwise `medium`. |

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "houseNoMatch", "status": "exact" },
        { "key": "streetAddressMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/ekyc-reference-united-states`
- URL: https://developer.incode.com/general-reference/ekyc-reference-united-states/
- Markdown: https://developer.incode.com/general-reference/ekyc-reference-united-states.md

# United States

United States eKYC verification supports multiple sources of truth, including telco databases, credit bureau records, USPS-verified address data, and state driver's license records. Because the response schema and calculation logic differ meaningfully between US sources, each source is documented separately below. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source               | API source string      | Description                                                                                      |
| -------------------- | ---------------------- | ------------------------------------------------------------------------------------------------ |
| US TELCO 1           | `US_TELCO_1`           | Verifies submitted data against telco records associated with the provided phone number.         |
| US TELCO 2           | `US_TELCO_2`           | Verifies submitted data against telco records associated with the provided phone number.         |
| US TELCO 4           | `US_TELCO_4`           | Verifies submitted data against telco records associated with the provided phone number.         |
| US TELCO 5           | `US_TELCO_5`           | Verifies submitted data against telco records associated with the provided phone number.         |
| US CREDIT BUREAU 1   | `US_CREDIT_BUREAU_1`   | Verifies submitted data against credit bureau records associated with the provided tax ID (SSN). |
| US CREDIT BUREAU 3   | `US_CREDIT_BUREAU_3`   | Verifies submitted data against credit bureau records.                                           |
| US CREDIT TELCO      | `US_CREDIT_TELCO`      | Verifies submitted data against combined credit bureau and telco records.                        |
| US ADDRESS 1         | `US_Address_1`         | Verifies submitted data against USPS-verified address records.                                   |
| US DRIVERS LICENSE 1 | `US_DRIVERS_LICENSE_1` | Verifies submitted driver's license details against state driver's license records.              |

## US TELCO 1

### Request parameters

| Parameter     | Required  | Description                                                 |
| ------------- | --------- | ----------------------------------------------------------- |
| `source`      | Mandatory | Must be `US_TELCO_1`.                                       |
| `country`     | Mandatory | Must be `US`.                                               |
| `phone`       | Mandatory | Phone number in E.164 format (for example, `+14081234567`). |
| `firstName`   | Mandatory | First name of the individual.                               |
| `surName`     | Mandatory | Last name of the individual.                                |
| `street`      | Optional  | Full street including house number and apartment number.    |
| `city`        | Optional  | City of the individual's address.                           |
| `state`       | Optional  | Two-letter state code.                                      |
| `postalCode`  | Optional  | Postal code.                                                |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                       |
| `email`       | Optional  | Email address.                                              |
| `dlNumber`    | Optional  | Driver's license number.                                    |
| `dlState`     | Optional  | Two-letter driver's license state.                          |
| `last4SSN`    | Optional  | Last four digits of SSN.                                    |

### Response fields

US TELCO 1 anchors verification on the phone number. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common status values.

| Field               | Statuses                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phoneNameMatch`    | `exact`, `fuzzy`, `nomatch` | Matches name submitted against the name associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `phoneAddressMatch` | `exact`, `fuzzy`, `nomatch` | Matches address submitted against the address associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `phoneCityMatch`    | `exact`, `nomatch`          | Matches city submitted against the city associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `phoneStateMatch`   | `exact`, `nomatch`          | Matches state submitted against the state associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `phoneZipcodeMatch` | `exact`, `nomatch`          | Matches zip code submitted against the zip code associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `phoneDobMatch`     | `exact`, `nomatch`          | Matches date of birth submitted against the date of birth associated with the phone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `phoneEmailMatch`   | `exact`, `nomatch`          | Matches email submitted against the email associated with the phone in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `dlNumberCheck`     | `exact`, `nomatch`          | Matches driver's license number submitted against the number associated with the phone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `dlStateCheck`      | `exact`, `nomatch`          | Matches driver's license state submitted against the state associated with the phone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `nameRiskLevel`     | `low`, `medium`, `high`     | Risk level associated with the submitted name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `addressRiskLevel`  | `low`, `medium`, `high`     | Risk level associated with the submitted address, independent of address matching.<br /> |
| `phoneLevel`        | `low`, `medium`, `high`     | Risk level associated with the submitted phone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `overallLevel`      | `low`, `medium`, `high`     | Overall risk level. See below for calculation logic.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### overallLevel calculation

`overallLevel` is calculated based on `phoneNameMatch` and `phoneAddressMatch`:

- `low` when `phoneNameMatch` and `phoneAddressMatch` are both `exact`.
- `medium` when any of the following apply:
  - `phoneNameMatch` is `exact` AND `phoneAddressMatch` is `fuzzy` or `nomatch`.
  - `phoneNameMatch` is `nomatch` AND `phoneAddressMatch` is `fuzzy`.
  - `phoneNameMatch` is `fuzzy` AND `phoneAddressMatch` is `fuzzy`.
- `high` when `phoneNameMatch` and `phoneAddressMatch` are both `nomatch`.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Risk level calculations

`nameRiskLevel` and `addressRiskLevel` are calculated from proprietary matching algorithms scored 0-100:

- `low`: score is 70-100.
- `medium`: score is 30-69.
- `high`: score is less than 30.

## US TELCO 2

### Request parameters

| Parameter     | Required  | Description                                                            |
| ------------- | --------- | ---------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `US_TELCO_2`.                                                  |
| `countryCode` | Mandatory | Must be `US`.                                                          |
| `phone`       | Mandatory | Phone number in E.164 format (for example, `+14081234567`).            |
| `firstName`   | Optional  | First name of the individual.                                          |
| `surName`     | Optional  | Last name of the individual. This source does not process middle name. |
| `street`      | Optional  | Full street including house number and apartment number.               |
| `city`        | Optional  | City of the individual's address.                                      |
| `state`       | Optional  | Two-letter state code.                                                 |
| `postalCode`  | Optional  | Postal code.                                                           |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                  |

### Response fields

US TELCO 2 anchors verification on the phone number.

| Field               | Statuses                               | Description                                                                                                                                           |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phoneMatch`        | `exact`, `nomatch`                     | Whether the phone number exists in the source of truth.                                                                                               |
| `phoneNameMatch`    | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches name submitted against the name associated with the phone. Does not account for middle name.                                                  |
| `phoneAddressMatch` | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches address submitted against the address associated with the phone.                                                                              |
| `phoneCityMatch`    | `exact`, `nomatch`, `unknown`          | Matches city submitted against the city associated with the phone.                                                                                    |
| `phoneStateMatch`   | `exact`, `nomatch`, `unknown`          | Matches state submitted against the state associated with the phone.                                                                                  |
| `phoneZipcodeMatch` | `exact`, `nomatch`, `unknown`          | Matches zip code submitted against the zip code associated with the phone.                                                                            |
| `phoneDobMatch`     | `exact`, `nomatch`                     | Matches date of birth submitted against the date of birth associated with the phone. `nomatch` includes cases where no DOB information was available. |
| `phoneCarrier`      | String                                 | Phone carrier associated with the submitted phone number.                                                                                             |
| `phoneLineType`     | String                                 | Type of phone line (for example, `Mobile`).                                                                                                           |
| `phoneLevel`        | `low`, `medium`, `high`, `very_high`   | Risk level associated with the submitted phone.                                                                                                       |
| `addressRiskLevel`  | `low`, `medium`, `high`, `very_high`   | Risk level associated with the submitted address, independent of address matching.                                                                    |
| `overallLevel`      | `low`, `medium`, `high`, `very_high`   | Overall risk level, customizable per customer requirements.                                                                                           |

### phoneNameMatch calculation

`phoneNameMatch` uses a proprietary matching algorithm scored from -1 to 100. Does not account for middle name.

- `unknown`: score is -1.
- `nomatch`: score is 0-29.
- `fuzzy`: score is 30-99.
- `exact`: score is 100.

### phoneAddressMatch calculation

`phoneAddressMatch` uses a proprietary matching algorithm scored from -1 to 100.

- `unknown`: score is -1.
- `nomatch`: score is 0-29.
- `fuzzy`: score is 30-69.
- `exact`: score is 70-100. The default exact threshold is 70 to account for slight variations in input such as apartment or house number.

### phoneLevel calculation

`phoneLevel` is calculated from a phone risk score (0-1000, with 1000 as highest risk):

- `low`: score is 500 or less.
- `medium`: score is 501-800.
- `high`: score is 801-900.
- `very_high`: score is 901 or greater.

### addressRiskLevel calculation

`addressRiskLevel` is a signal based on address validity, USPS deliverability, commercial vs. residential classification, and a Lob-based confidence score.

- `low`: The address is valid, over 70% of Lob mailpieces to this address were delivered successfully, recent mailings were successful, and the address is USPS-deliverable (or deliverable to the building's default address but missing secondary unit information).
- `medium`: The address is valid, but either no tracking data exists, or between 40% and 70% of Lob mailpieces were delivered successfully.
- `high`: The address is valid, but less than 40% of Lob mailpieces were delivered successfully and recent mailings were not successful.
- `very_high`: The address is not valid and not deliverable by USPS.

## US TELCO 4

### Request parameters

| Parameter      | Required  | Description                                                            |
| -------------- | --------- | ---------------------------------------------------------------------- |
| `source`       | Mandatory | Must be `US_TELCO_4`.                                                  |
| `countryCode`  | Mandatory | Must be `US`.                                                          |
| `phone`        | Mandatory | Phone number in E.164 format (for example, `+14081234567`).            |
| `firstName`    | Optional  | First name of the individual.                                          |
| `surName`      | Optional  | Last name of the individual. This source does not process middle name. |
| `street`       | Optional  | Full street including house number and apartment number.               |
| `city`         | Optional  | City of the individual's address.                                      |
| `state`        | Optional  | Two-letter state code.                                                 |
| `postalCode`   | Optional  | Postal code.                                                           |
| `dateOfBirth`  | Optional  | Format: `yyyy-mm-dd`.                                                  |
| `emailAddress` | Optional  | Email address.                                                         |

### Response fields

US TELCO 4 anchors verification on the phone number. It returns match fields at both the aggregate (`phoneNameMatch`, `phoneAddressMatch`) and component (`phoneFirstNameMatch`, `phoneLastNameMatch`, `phoneStreetMatch`) levels.

| Field                 | Statuses                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phoneMatch`          | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Whether the phone number exists in the source of truth.                                                                                                                                                                                                                                                                                                                                                                                |
| `phoneFirstNameMatch` | `match`, `fuzzy`, `nomatch`, `unknown`                   | Matches first name submitted against the value associated with the phone.                                                                                                                                                                                                                                                                                                                                                              |
| `phoneLastNameMatch`  | `match`, `fuzzy`, `nomatch`, `unknown`                   | Matches last name submitted against the value associated with the phone.                                                                                                                                                                                                                                                                                                                                                               |
| `phoneNameMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches full name against the name associated with the phone. Does not account for middle name.                                                                                                                                                                                                                                                                                                                                        |
| `phoneStreetMatch`    | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches street submitted against the street associated with the phone.                                                                                                                                                                                                                                                                                                                                                                 |
| `phoneCityMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches city submitted against the city associated with the phone.                                                                                                                                                                                                                                                                                                                                                                     |
| `phoneStateMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches state submitted against the state associated with the phone.                                                                                                                                                                                                                                                                                                                                                                   |
| `phoneZipcodeMatch`   | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches zip code submitted against the zip code associated with the phone.                                                                                                                                                                                                                                                                                                                                                             |
| `phoneAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches full address submitted against the address associated with the phone.                                                                                                                                                                                                                                                                                                                                                          |
| `phoneDobMatch`       | `exact`, `nomatch`, `unknown`                            | Matches date of birth submitted against the value associated with the phone.                                                                                                                                                                                                                                                                                                                                                           |
| `phoneEmailMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown`                   | Matches email submitted against the email associated with the phone.                                                                                                                                                                                                                                                                                                                                                                   |
| `phoneCarrier`        | String                                                   | Phone carrier associated with the submitted phone number.                                                                                                                                                                                                                                                                                                                                                                              |
| `phoneLineType`       | String                                                   | Type of phone line (for example, `Mobile`).                                                                                                                                                                                                                                                                                                                                                                                            |
| `phoneLevel`          | `low`, `medium`, `high`, `very_high`                     | Risk level associated with the submitted phone.                                                                                                                                                                                                                                                                                                                                                                                        |
| `phoneRiskLevel`      | `low`, `medium`, `high`, `very_high` (with reason codes) | Risk level associated with the submitted phone, with reason codes. Uses the same logic as `phoneLevel`.                                                                                                                                                                                                                                                                                                                                |
| `emailRiskLevel`      | `low`, `medium`, `high` (with reason codes)              | Risk level associated with the submitted email.<br /> |
| `overallLevel`        | `low`, `medium`, `high`                                  | Overall risk level, customizable per customer requirements.                                                                                                                                                                                                                                                                                                                                                                            |

### phoneNameMatch calculation

`phoneNameMatch` is derived from `phoneFirstNameMatch` and `phoneLastNameMatch`:

- `exact`: `phoneFirstNameMatch` and `phoneLastNameMatch` are both `exact` (or `match`).
- `nomatch`: `phoneFirstNameMatch` and `phoneLastNameMatch` are both `nomatch`.
- `unknown`: `phoneFirstNameMatch` and `phoneLastNameMatch` are both `unknown`.
- `fuzzy`: all other cases.

### phoneAddressMatch calculation

`phoneAddressMatch` is derived from the component address fields:

- `exact`: `phoneStreetMatch`, `phoneCityMatch`, `phoneStateMatch`, and `phoneZipcodeMatch` are all `exact`.
- `nomatch`: all four component fields are `nomatch`.
- `unknown`: all four component fields are `unknown`.
- `fuzzy`: all other cases.

### phoneLevel calculation

`phoneLevel` is calculated from a proprietary matching score (-1 to 100):

- `low`: score is 300 or less.
- `medium`: score is 300-600.
- `high`: score is 600-800.
- `very_high`: score is 800 or greater.

## US TELCO 5

### Request parameters

| Parameter      | Required  | Description                                                 |
| -------------- | --------- | ----------------------------------------------------------- |
| `source`       | Mandatory | Must be `US_TELCO_5`.                                       |
| `countryCode`  | Mandatory | Must be `US`.                                               |
| `phone`        | Mandatory | Phone number in E.164 format (for example, `+14081234567`). |
| `firstName`    | Optional  | First name of the individual.                               |
| `middleName`   | Optional  | Middle name of the individual.                              |
| `surName`      | Optional  | Last name of the individual.                                |
| `street`       | Optional  | Full street including house number and apartment number.    |
| `city`         | Optional  | City of the individual's address.                           |
| `state`        | Optional  | Two-letter state code.                                      |
| `postalCode`   | Optional  | Postal code.                                                |
| `dateOfBirth`  | Optional  | Format: `yyyy-mm-dd`.                                       |
| `emailAddress` | Optional  | Email address.                                              |
| `idNumber`     | Optional  | Individual's SSN.                                           |

### Response fields

US TELCO 5 anchors verification on the phone number. Compared to US TELCO 4, it adds middle name matching, tax ID matching, and additional metadata fields.

| Field                  | Statuses                               | Description                                                                           |
| ---------------------- | -------------------------------------- | ------------------------------------------------------------------------------------- |
| `checkStatus`          | String                                 | Outcome of the check.                                                                 |
| `phoneMatch`           | `exact`, `fuzzy`, `nomatch`, `unknown` | Whether the phone number exists in the source of truth.                               |
| `phoneFirstNameMatch`  | `exact`, `fuzzy`, `nomatch`            | Matches first name submitted against the value associated with the phone.             |
| `phoneMiddleNameMatch` | `exact`, `fuzzy`, `nomatch`            | Matches middle name submitted against the value associated with the phone.            |
| `phoneLastNameMatch`   | `exact`, `fuzzy`, `nomatch`            | Matches last name submitted against the value associated with the phone.              |
| `phoneNameMatch`       | `exact`, `fuzzy`, `nomatch`            | Matches full name against the name associated with the phone.                         |
| `phoneStreetMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches street submitted against the value associated with the phone.                 |
| `phoneCityMatch`       | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches city submitted against the value associated with the phone.                   |
| `phoneStateMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches state submitted against the value associated with the phone.                  |
| `phoneZipcodeMatch`    | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches zip code submitted against the value associated with the phone.               |
| `phoneAddressMatch`    | `exact`, `fuzzy`, `nomatch`            | Matches full address submitted against the value associated with the phone.           |
| `phoneDobMatch`        | `exact`, `nomatch`                     | Matches date of birth submitted against the value associated with the phone.          |
| `phoneEmailMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown` | Matches email submitted against the value associated with the phone.                  |
| `taxIdMatch`           | `exact`, `nomatch`                     | Matches submitted tax ID against the tax ID related to the closest matching identity. |
| `isItin`               | `true`, `false`                        | Whether the returned SSN is an ITIN.                                                  |
| `emailType`            | String                                 | Type of email (for example, `personal`, `business`).                                  |
| `phoneCarrier`         | String                                 | Phone carrier associated with the submitted phone number.                             |
| `phoneLineType`        | String                                 | Type of phone line (for example, `mobile`).                                           |
| `lastPorted`           | Date                                   | Date the number was last ported, in `yyyy-mm-dd` format.                              |
| `activityScore`        | Integer                                | Activity score (0-1000) representing the quality of the phone number.                 |
| `overallLevel`         | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                                  |

### overallLevel calculation

`overallLevel` is calculated based on `phoneNameMatch`, `phoneDobMatch`, and `taxIdMatch`:

- `low` when `phoneNameMatch` is `exact` AND (`phoneDobMatch` OR `taxIdMatch`) is `exact`.
- `high` when `phoneNameMatch` is `nomatch` AND (`phoneDobMatch` OR `taxIdMatch`) is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

## US CREDIT BUREAU 1

### Request parameters

| Parameter     | Required  | Description                                              |
| ------------- | --------- | -------------------------------------------------------- |
| `source`      | Mandatory | Must be `US_CREDIT_BUREAU_1`.                            |
| `countryCode` | Mandatory | Must be `US`.                                            |
| `ssn`         | Mandatory | Nine-digit US tax ID (SSN).                              |
| `firstName`   | Mandatory | First name of the individual.                            |
| `middleName`  | Optional  | Middle name of the individual.                           |
| `surName`     | Mandatory | Last name of the individual.                             |
| `street`      | Mandatory | Full street including house number and apartment number. |
| `city`        | Mandatory | City of the individual's address.                        |
| `state`       | Mandatory | Two-letter state code.                                   |
| `postalCode`  | Mandatory | Postal code.                                             |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                    |
| `email`       | Optional  | Email address.                                           |
| `phone`       | Optional  | Phone number in E.164 format.                            |

### Response fields

US CREDIT BUREAU 1 anchors verification on the tax ID (SSN) but does not perform a direct Social Security Administration lookup. Instead, the submitted attributes (name, DOB, address, email, phone, SSN) are used to find the closest matching identity from third-party data including credit header files, phone records, email records, bankruptcies, deceased data, IP information, and other public records. Match results are then returned against that closest match.

The risk levels returned by this source reflect an assessment of whether the submitted identity is likely to be synthetic. A first-party synthetic identity is one where the applicant provides a true name and DOB but a fictitious SSN (often to obscure other parts of their profile). A third-party synthetic identity is one where the name, DOB, and SSN together describe a fictitious person (commonly used in organized identity fraud). `low` risk levels indicate the submitted identity is unlikely to be synthetic; `high` and `very_high` levels indicate elevated risk of synthetic identity fraud or, for `taxIdLevel`, a name or DOB mismatch against the SSN.

| Field               | Statuses                                                   | Description                                                                              |
| ------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `taxIdMatch`        | `exact`, `fuzzy`, `nomatch`, `unknown`                     | Matches submitted tax ID against the closest matching identity.                          |
| `taxIdNameMatch`    | `exact`, `fuzzy`, `nomatch`, `unknown`                     | Matches submitted full name (first, middle, last) against the closest matching identity. |
| `taxIdDobMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown`                     | Matches submitted date of birth against the closest matching identity.                   |
| `taxIdStateMatch`   | `exact`, `fuzzy`, `nomatch`, `unknown`                     | Matches submitted state against the closest matching identity.                           |
| `taxIdAddressMatch` | `exact`, `nomatch`, `unknown`                              | Matches submitted address against the closest matching identity.                         |
| `taxIdLevel`        | `low`, `medium`, `high`, `very_high`                       | Risk level associated with the tax ID.                                                   |
| `phoneCarrier`      | String                                                     | Phone carrier associated with the submitted phone number, if phone data is available.    |
| `phoneLineType`     | `Mobile`, `Landline`, `FixedVOIP`, `NonFixedVOIP`, `Other` | Phone line type, if phone data is available.                                             |
| `phoneLevel`        | `low`, `medium`, `high`, `very_high`                       | Risk level associated with the submitted phone.                                          |
| `addressRiskLevel`  | `low`, `medium`, `high`, `very_high`                       | Risk level associated with the submitted address, independent of address matching.       |
| `emailLevel`        | `low`, `medium`, `high`, `very_high`                       | Risk level associated with the submitted email.                                          |
| `emailDomainLevel`  | `low`, `high`                                              | Risk level associated with the submitted email's domain.                                 |
| `overallLevel`      | `low`, `medium`, `high`, `very_high`                       | Overall risk level. Defaults to the value of `taxIdLevel`.                               |

### Fuzzy match definitions

US CREDIT BUREAU 1 uses specific fuzzy match rules for each field.

**Fuzzy taxIdNameMatch** is returned when at least one of the following applies:

- First names match exactly.
- Last names match exactly.
- First and last names are swapped and match when unswapped.
- The submitted first and last names appear inside the source-of-truth full name, and the submitted names are at least five characters each. For example, submitted `Joanna Smith` against source-of-truth `Joanna Lucinda Smith`.
- The restricted Damerau-Levenshtein distance between the two names is less than three, and both names are at least five characters.

**Fuzzy taxIdDobMatch** is returned when the DOBs are not an exact match and:

- Two of three components (year, month, day) match exactly (for example, `1987-01-05` vs. `1987-06-05`).
- Month and day are swapped (for example, `1987-12-06` vs. `1987-06-12`).

**Fuzzy taxIdMatch** is returned when the SSNs are not an exact match and their restricted Damerau-Levenshtein distance is three or less.

**Fuzzy taxIdAddressMatch** is returned when any of the following applies:

- Partial match to street data (misspelling of street name, missing street number) and all other address fields match.
- No match on state, but all other address fields match.
- No match on zip code, but all other address fields match.
- No match on city, but all other address fields match.

**Fuzzy taxIdStateMatch** does not exist. State fields return only `exact`, `nomatch`, or `unknown`.

### taxIdLevel calculation

`taxIdLevel` is derived from `taxIdMatch`, `taxIdNameMatch`, and `taxIdDobMatch`:

- `low`: `taxIdMatch`, `taxIdNameMatch`, and `taxIdDobMatch` all return `exact`.
- `medium`: at least one of `taxIdMatch`, `taxIdNameMatch`, or `taxIdDobMatch` returns `fuzzy`.
- `high`: at least one of `taxIdMatch`, `taxIdNameMatch`, or `taxIdDobMatch` returns `nomatch`.
- `very_high`: `taxIdMatch`, `taxIdNameMatch`, and `taxIdDobMatch` all return `nomatch`.

### phoneLevel calculation

`phoneLevel` is calculated from a phone risk score (0-1000, with 1000 as highest risk):

- `low`: score is 500 or less.
- `medium`: score is 501-800.
- `high`: score is 801-900.
- `very_high`: score is 901 or greater.

### addressRiskLevel calculation

`addressRiskLevel` is a signal based on address validity, USPS deliverability, commercial vs. residential classification, and a Lob-based confidence score. It is not based on address verification against the submitted name.

- `low`: The address is valid, over 70% of Lob mailpieces were delivered successfully, recent mailings were successful, and the address is USPS-deliverable (or deliverable to the building's default address but missing secondary unit information).
- `medium`: The address is valid, but either no tracking data exists, or between 40% and 70% of Lob mailpieces were delivered successfully.
- `high`: The address is valid, but less than 40% of Lob mailpieces were delivered successfully and recent mailings were not successful.
- `very_high`: The address is not valid and not deliverable by USPS.

### emailLevel calculation

`emailLevel` is based on a machine-learning model that leverages email age, velocity, network signals, and domain reputation. The risk score is a value from 0-100.

- `low`: score is 20 or less.
- `medium`: score is 21-84.
- `high`: score is 85-98.
- `very_high`: score is greater than 98.

### emailDomainLevel calculation

`emailDomainLevel` uses a machine-learning model to identify high-risk email domains, with a risk score of 0-100.

- `low`: default when a high-risk domain is not identified.
- `high`: score is 90 or greater.

Incode does not have default recommendations for `medium` or `very_high` at the domain level.

## US CREDIT BUREAU 3


### Request parameters

| Parameter     | Required    | Description                                                             |
| ------------- | ----------- | ----------------------------------------------------------------------- |
| `source`      | Mandatory   | Must be `US_CREDIT_BUREAU_3`.                                           |
| `country`     | Mandatory   | Must be `US`.                                                           |
| `firstName`   | Mandatory   | First name of the individual.                                           |
| `middleName`  | Optional    | Middle name of the individual.                                          |
| `surName`     | Mandatory   | Last name of the individual.                                            |
| `dateOfBirth` | Conditional | Format: `yyyy-mm-dd`. Either `dateOfBirth` or `phone` must be provided. |
| `phone`       | Conditional | Phone number. Either `dateOfBirth` or `phone` must be provided.         |
| `street`      | Optional    | Street name.                                                            |
| `houseNo`     | Optional    | House number.                                                           |
| `city`        | Optional    | City of the individual's address.                                       |
| `state`       | Optional    | State.                                                                  |
| `postalCode`  | Optional    | Postal code.                                                            |
| `email`       | Optional    | Email address.                                                          |
| `idNum`       | Optional    | SSN (Social Security Number).                                           |

### Response fields

US CREDIT BUREAU 3 anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                         |
| -------------------- | ------------------------------------- | ----------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.              |
| `middleNameMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.             |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.               |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.               |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.           |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street name submitted against the value in the source of truth.             |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches house number submitted against the value in the source of truth.            |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street and house number submitted against the value in the source of truth. |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                    |
| `stateMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                   |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.             |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address submitted against the value in the source of truth.            |
| `idNumMatch`         | `exact`, `nomatch`, `nodata`          | Matches SSN submitted against the value in the source of truth.                     |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                   |
| `emailMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches email submitted against the value in the source of truth.                   |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                |

### overallLevel calculation

`overallLevel` is calculated based on the submitted full name and at least one identity-anchoring field:

- `low` when `fullNameMatch` is `exact` AND (`dobMatch` OR `fullAddressMatch` OR `idNumMatch` OR `phoneMatch`) is `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

## US CREDIT TELCO

US CREDIT TELCO verifies submitted identity data against combined credit bureau and telco records. It is commonly used in eKYC processes for identity authentication and fraud prevention.

### Request parameters

| Parameter     | Required    | Description                                                             |
| ------------- | ----------- | ----------------------------------------------------------------------- |
| `source`      | Mandatory   | Must be `US_CREDIT_TELCO`.                                              |
| `country`     | Mandatory   | Must be `US`.                                                           |
| `firstName`   | Mandatory   | First name of the individual.                                           |
| `surName`     | Mandatory   | Last name of the individual.                                            |
| `dateOfBirth` | Conditional | Format: `yyyy-mm-dd`. Either `dateOfBirth` or `ssn` must be provided. |
| `phone`       | Optional | Phone number. |
| `street`      | Optional    | Street name.                                                            |
| `apartment`   | Optional    | Apartment, suite, or unit number.                                       |
| `city`        | Optional    | City of the individual's address.                                       |
| `state`       | Optional    | Two-letter state code.                                                  |
| `postalCode`  | Optional    | Postal code.                                                            |
| `ssn`       | Conditional    | SSN (Social Security Number). Either `dateOfBirth` or `ssn` must be provided.                                           |

### Sample request

```json
{
  "plugins": ["kyc"],
  "source": "US_CREDIT_TELCO",
  "country": "US",
  "firstName": "John",
  "surName": "Smith",
  "street": "Evergreen Terrace",
  "apartment": "742",
  "city": "Springfield",
  "state": "IL",
  "postalCode": "100011234",
  "dateOfBirth": "1991-08-02",
  "phone": "2125551234",
  "ssn": "123456789"
}
```

### Sample response

```json
{
  "kyc": [
    { "key": "firstNameMatch", "status": "Exact" },
    { "key": "lastNameMatch", "status": "Exact" },
    { "key": "fullNameMatch", "status": "Exact" },
    { "key": "dobMatch", "status": "Exact" },
    { "key": "streetMatch", "status": "Exact" },
    { "key": "apartmentMatch", "status": "Exact" },
    { "key": "cityMatch", "status": "Exact" },
    { "key": "stateMatch", "status": "Exact" },
    { "key": "postalCodeMatch", "status": "Exact" },
    { "key": "fullAddressMatch", "status": "Exact" },
    { "key": "taxIdMatch", "status": "Exact" },
    { "key": "phoneMatch", "status": "No Match" },
    { "key": "overallLevel", "status": "Low" }
  ]
}
```

### Response fields

See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common status values.

| Field              | Statuses                              | Description                                                                                                     |
| ------------------ | ------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                                          |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                                           |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches full name (first name, middle name, last name) submitted against the value in the source of truth.      |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.                                       |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street name submitted against the value in the source of truth.                                         |
| `apartmentMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches apartment, suite, or unit number submitted against the value in the source of truth.                    |
| `cityMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                                                |
| `stateMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches state submitted against the value in the source of truth.                                               |
| `postalCodeMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                                         |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches full address (street, apartment, city, postal code) submitted against the value in the source of truth. |
| `taxIdMatch`       | `exact`, `nomatch`, `nodata`          | Matches submitted SSN against the value in the source of truth.                                                 |
| `phoneMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                                               |
| `overallLevel`     | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                                            |

### overallLevel calculation

`overallLevel` is calculated based on the submitted full name and at least one identity-anchoring field:

- `low` when `fullNameMatch` is `exact` AND (`dobMatch` OR `idNumMatch`) is `exact`.
- `high` when `fullNameMatch` and `idNumMatch` are both `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.



## US ADDRESS 1

### Request parameters

US ADDRESS 1 requires all address fields as mandatory.

| Parameter     | Required  | Description                                                            |
| ------------- | --------- | ---------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `US_Address_1`.                                                |
| `countryCode` | Mandatory | Must be `US`.                                                          |
| `street`      | Mandatory | Full street including house number and apartment number.               |
| `city`        | Mandatory | City of the individual's address.                                      |
| `state`       | Mandatory | Two-letter state code.                                                 |
| `postalCode`  | Mandatory | Postal code.                                                           |
| `firstName`   | Optional  | First name of the individual.                                          |
| `surName`     | Optional  | Last name of the individual. This source does not process middle name. |

### Response fields

US ADDRESS 1 anchors verification on the address, using USPS-verified address data. Match results and additional address-quality signals are returned.

| Field              | Statuses                                                                                                                 | Description                                                                                            |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `nameMatch`        | `exact`, `fuzzy`, `nomatch`, `unknown`                                                                                   | Matches name submitted against the name associated with the address. Does not account for middle name. |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `unknown`                                                                                   | Matches street submitted against the value in the source of truth.                                     |
| `cityMatch`        | `exact`, `fuzzy`, `nomatch`, `unknown`                                                                                   | Matches city submitted against the value in the source of truth.                                       |
| `stateMatch`       | `exact`, `nomatch`, `unknown`                                                                                            | Matches state submitted against the value in the source of truth.                                      |
| `zipcodeMatch`     | `exact`, `nomatch`, `unknown`                                                                                            | Matches zip code submitted against the value in the source of truth.                                   |
| `addressMatch`     | `exact`, `fuzzy`, `nomatch`, `unknown`                                                                                   | Matches full address submitted against the value in the source of truth.                               |
| `deliverability`   | `deliverable`, `deliverable_unnecessary_unit`, `deliverable_incorrect_unit`, `deliverable_missing_unit`, `undeliverable` | Represents likelihood that the address is deliverable. See below.                                      |
| `addressValid`     | `true`, `false`                                                                                                          | Whether the address exists as a real location. See below.                                              |
| `addressRiskLevel` | `low`, `medium`, `high`, `very_high` (with reason codes)                                                                 | Represents likelihood that the address is deliverable, along with reason codes.                        |
| `overallLevel`     | `low`, `medium`, `high`, `very_high`                                                                                     | Overall risk level, customizable per customer requirements.                                            |

### deliverability values

- `deliverable`: The address is deliverable by USPS.
- `deliverable_unnecessary_unit`: The address is deliverable but the secondary unit information is unnecessary.
- `deliverable_incorrect_unit`: The address is deliverable to the building's default address, but the secondary unit provided may not exist. Mail may not reach the intended recipient.
- `deliverable_missing_unit`: The address is deliverable to the building's default address but is missing secondary unit information. Mail may not reach the intended recipient.
- `undeliverable`: The address is not deliverable by USPS.

### addressValid

`addressValid` indicates whether the address was found in a comprehensive dataset including USPS records, open-source mapping data, and proprietary mail delivery data. This is a broader test than `deliverability`: an address may be valid (exists as a real location) but not deliverable by USPS.

### addressMatch calculation

`addressMatch` is derived from the component address fields:

- `exact`: `streetMatch`, `cityMatch`, `stateMatch`, and `zipcodeMatch` are all `exact`.
- `nomatch`: `streetMatch` is `nomatch` AND (`cityMatch` is `nomatch` OR `zipcodeMatch` is `nomatch`).
- `unknown`: `streetMatch` is `unknown` AND (`cityMatch` is `unknown` OR `zipcodeMatch` is `unknown`).
- `fuzzy`: all other cases.

## US DRIVERS LICENSE 1

US DRIVERS LICENSE 1 verifies submitted driver's license details against state driver's license records. It is commonly used in scenarios that require age verification, such as couriers and delivery services confirming the individual is above the legal age.

US DRIVERS LICENSE 1 currently supports 42 of the 50 US states. The following states are not supported: Alaska, California, Louisiana, Minnesota, New Hampshire, New York, Oklahoma, Pennsylvania, and Utah.

### Request parameters


| Parameter     | Required  | Description                                             |
| ------------- | --------- | ------------------------------------------------------- |
| `source`      | Mandatory | Must be `US_DRIVERS_LICENSE_1`.                         |
| `countryCode` | Mandatory | Must be `US`.                                           |
| `state`       | Mandatory | Two-letter driver's license state (for example, `CA`).  |
| `dlNumber`    | Mandatory | Driver's license number. Format varies per state.       |
| `firstName`   | Optional  | First name of the individual.                           |
| `surName`     | Optional  | Last name of the individual.                            |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                   |
| `dlExpireAt`  | Optional  | Driver's license expiration date. Format: `yyyy-mm-dd`. |

### Response fields

US DRIVERS LICENSE 1 anchors verification on the driver's license record. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common status values.

| Field                   | Statuses                               | Description                                                                              |
| ----------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------- |
| `dlNumberMatch`         | `exact`, `nomatch`                     | Whether the submitted driver's license number matches the state driver's license record. |
| `dlDobMatch`            | `exact`, `nomatch`                     | Matches date of birth submitted against the driver's license record.                     |
| `dlNameMatch`           | `exact`, `approximatematch`, `nomatch` | Matches name submitted against the driver's license record.                              |
| `dlExpirationDateMatch` | `exact`, `nomatch`                     | Matches expiration date submitted against the driver's license record.                   |
| `dlStateCodeMatch`      | `exact`, `nomatch`                     | Matches state submitted against the driver's license record.                             |

---

- Path: `general-reference/ekycitaly`
- URL: https://developer.incode.com/general-reference/ekycitaly/
- Markdown: https://developer.incode.com/general-reference/ekycitaly.md

# Italy
Italy eKYC verification matches submitted individual data against Italy's official civil register, credit, and telco records. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                             | API source string             | Description                                                                          |
| ------------------------------------ | -------------------------------- | ------------------------------------------------------------------------------------------ |
| Italy Civil Register + Credit + Telco | `IT_CIVIL_REG_CREDIT_TELCO`      | Verifies submitted data against Italy's official civil register, consumer credit, and telco records. |

## Italy Civil Register + Credit + Telco

### Request parameters

| Parameter     | Required  | Description                                                                 |
| ------------- | --------- | ------------------------------------------------------------------------------ |
| `source`      | Mandatory | Must be `IT_CIVIL_REG_CREDIT_TELCO`.                                            |
| `country`     | Mandatory | Must be `IT`.                                                                   |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.                         |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                          |
| `phone`       | Mandatory | Italy phone number. See format note below.                                     |
| `street`      | Optional  | Full street including house number.                                            |
| `city`        | Optional  | City of the individual's address (for example, `Milano`).                      |
| `postalCode`  | Optional  | Italy postal code. See format note below.                                      |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                           |



### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "IT_CIVIL_REG_CREDIT_TELCO", //required field
    "firstName": "Marco", //required field
    "surName": "Rossi", //required field
    "street": "Via Giuseppe Garibaldi 25",
    "city": "Milano",
    "postalCode": "20121",
    "country": "IT", //required field
    "dateOfBirth": "1991-08-02",
    "phone": "+390212345678" //required field
}
```

### Response fields

Italy Civil Register + Credit + Telco anchors verification on individual name, address, and phone number. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                                |
| --------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                     |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                      |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise `fuzzy`. |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.                  |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street submitted against the value in the source of truth.                         |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                           |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                    |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                          |
| `overallLevel`       | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                                       |







#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and phone number:

- `low` when `fullNameMatch` and `phoneMatch` are both `exact`.
- `high` when `fullNameMatch` or `phoneMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/error-code-changes-for-colombia`
- URL: https://developer.incode.com/general-reference/error-code-changes-for-colombia/
- Markdown: https://developer.incode.com/general-reference/error-code-changes-for-colombia.md

# Error Code Changes for Colombia

Error code definitions and response statuses for the Government Verification module for Colombia changed in June 2026. These changes improve result explainability, reduce ambiguity, and make it easier to interpret session outcomes in Dashboard and via API responses.

<Callout icon="⚠️" theme="warn">
  ### Action Required

  If your implementation uses the impacted error codes for later decisioning logic or alerting, please review the status changes carefully and update your logic accordingly.
</Callout>

***

## **Status Changes for Select Error Codes**

Several error codes that previously returned `FAIL` status now return `UNKNOWN`. This is more accurate. These outcomes are not definitive verification failures; instead, they indicate the verification could not be completed due to missing inputs, configuration issues, or connectivity problems.

| Error Code         | Description                                                                           | Old Status | New Status |
| ------------------ | ------------------------------------------------------------------------------------- | ---------- | ---------- |
| `NOT_ENOUGH_DATA`  | One or more required fields are missing or invalid.                                   | `FAIL`     | `UNKNOWN`  |
| `CONNECTION_ERROR` | Error occurred while trying to connect to the provider or during provider processing. | `FAIL`     | `UNKNOWN`  |

If you prefer to continue failing sessions that now return `UNKNOWN`, such as `CONNECTION_ERROR` during a provider outage, you can configure this in **Business Rules** without any code changes on your end.

***

## **New Error Codes and Mapping**

The following error codes can now be returned. Previously, these scenarios were grouped under broader codes. They now map to more specific codes to provide more precision in result handling.

| New Code                  | Description                                                            | Status    |
| ------------------------- | ---------------------------------------------------------------------- | --------- |
| `PROVIDER_UNAVAILABLE`    | Provider has been intentionally disabled.                              | `UNKNOWN` |
| `PROVIDER_NOT_CONFIGURED` | Provider is not configured or is incorrectly configured for this flow. | `UNKNOWN` |
| `USER_NOT_FOUND`          | The document was not found in the government database.                 | `FAIL`    |

***

## **Updated Behavior for&#x20;**&#x56;ALIDATION_ERROR

`VALIDATION_ERROR` continues to return `FAIL`, but it is now applied more precisely to only include genuine verification failures, such as a document being found but in a canceled/not-valid state. Scenarios that are not true verification failures—such as connectivity, availability, and missing input data—are now mapped individually instead of being grouped under `VALIDATION_ERROR`.

***

## **Error Codes**

| Reason Code               | Description                                                                           | Status    |
| ------------------------- | ------------------------------------------------------------------------------------- | --------- |
| `PROVIDER_UNAVAILABLE`    | Provider has been intentionally disabled.                                             | `UNKNOWN` |
| `PROVIDER_NOT_CONFIGURED` | Provider is not configured or is incorrectly configured for this flow.                | `UNKNOWN` |
| `NOT_ENOUGH_DATA`         | One or more required fields are missing or invalid.                                   | `UNKNOWN` |
| `CONNECTION_ERROR`        | Error occurred while trying to connect to the provider or during provider processing. | `UNKNOWN` |
| `USER_NOT_FOUND`          | The document was not found in the government database.                                | `FAIL`    |
| `VALIDATION_ERROR`        | Document exists in the government database but is an invalid status.                  | `FAIL`    |

***

## Unchanged Behavior

- **The API interface is unchanged.** Error codes continue to be returned in the same fields and the same response structure. This update is fully backwards compatible; no integration changes are required.
- **Error codes remain available in Business Rules.** All error codes, including newly distinguished ones, continue to be exposed in Business Rules, so you can configure `FAIL` or `UNKNOWN` handling as needed.

<br />

---

- Path: `general-reference/error-code-changes-for-us-government-verification`
- URL: https://developer.incode.com/general-reference/error-code-changes-for-us-government-verification/
- Markdown: https://developer.incode.com/general-reference/error-code-changes-for-us-government-verification.md

# Error Code Changes for US Government Verification

Error code definitions and response statuses for the Government Verification module for the United States changed in April 2026. These changes improve result explainability, reduce ambiguity, and make it easier to interpret session outcomes in Dashboard and via API responses.

<Callout icon="⚠️" theme="warn">
  ### Action Required

  If your implementation uses the impacted error codes for later decisioning logic or alerting, please review the status changes carefully and update your logic accordingly.
</Callout>

***

## Status Changes for Select Error Codes

Several error codes that previously returned `FAIL` status now return `UNKNOWN`. This is more accurate. These outcomes are not definitive verification failures; instead, they indicate the verification could not be completed due to missing inputs, configuration issues, or connectivity problems.

| Error Code              | Description                                                         | Old Status | New Status |
| :---------------------- | :------------------------------------------------------------------ | :--------- | :--------- |
| `providerNotConfigured` | Provider is not configured or incorrectly configured for this flow  | `FAIL`     | `UNKNOWN`  |
| `missingDocumentId`     | Document number missing or has an invalid pattern                   | `FAIL`     | `UNKNOWN`  |
| `invalidExpirationDate` | Expiration date is not valid per document standards                 | `FAIL`     | `UNKNOWN`  |
| `notEnoughData`         | One or more required fields are missing or invalid                  | `FAIL`     | `UNKNOWN`  |
| `missingSelfie`         | Provider requires selfie for processing but not provided in session | `FAIL`     | `UNKNOWN`  |
| `connectionError`       | Error occurred during processing within provider environment        | `FAIL`     | `UNKNOWN`  |
| `infrastructureError`   | Error occurred during processing within Incode environment          | `FAIL`     | `UNKNOWN`  |

If you prefer to continue failing sessions that now return `UNKNOWN`, such as `connectionError` during a provider outage, you can configure this in **Business Rules** without any code changes on your end.

***

## Deprecated Error Codes and New Mapping

The following error codes are deprecated and no longer returned. Sessions that would have previously triggered these codes will now return one of the more specific replacement codes listed below.

| Deprecated Code       | Old Description                                                                                               | Now Mapped To                                                                          |
| --------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `validationError`     | Grouped validation failure covering: record not found, data mismatch, restricted record, or face match failed | `userNotFound`, `faceComparisonFailed` (more specific codes per actual failure reason) |
| `providerUnavailable` | DMV or AAMVA provider service unavailable or credentials invalid                                              | `connectionError`                                                                      |

***

## Updated Error Descriptions

Some error codes retain the same status but have updated descriptions for improved clarity. No behavioral changes were made.

| Error Code | Description |
|---|---|
| `providerNotConfigured` | **Provider Not Configured**<br />Provider is not configured or is incorrectly configured for this flow. |
| `missingDocumentId` | **Missing Document Number**<br />Document number missing or has an invalid pattern. |
| `invalidExpirationDate` | **Invalid Expiration Date**<br />Expiration date is not valid per document standards. |
| `notEnoughData` | **Missing Required Data**<br />One or more required fields are missing or invalid. |
| `missingSelfie` | **Missing Selfie**<br />Provider requires selfie for processing but not provided in session. |
| `documentTypeNotSupported` | **Document Type Not Supported**<br />Invalid document type for validation by the configured provider. |
| `geographicRegionNotSupported` | **Country Not Supported**<br />Document country not supported by the configured provider. |
| `geographicStateRegionNotSupported` | **State Not Supported**<br />Document state not supported by the configured provider. |
| `connectionError` | **Provider Connection Error**<br />Error occurred during processing within provider environment. |
| `infrastructureError` | **Incode Processing Error**<br />Error occurred during processing within Incode environment. |
| `userNotFound` | **User Not Found**<br />ID data doesn't match the government database. |
| `faceComparisonFailed` | **Face Match Failed**<br />Selfie does not match government database portrait. |

***

## Unchanged Behavior

- **The API interface is unchanged.** Error codes continue to be returned in the same fields and the same response structure. This update is fully backwards compatible; no integration changes are required.
- **Error codes remain available in Business Rules.** All error codes, including newly renamed and updated ones, continue to be exposed in Business Rules, so you can configure `FAIL` or `UNKNOWN` handling as needed.
- **Error codes remain unchanged for non-US connections.** The error codes for all non-US government verification connections remain unchanged.
- **Billing behavior is unchanged** for all affected codes.

---

- Path: `general-reference/face-authentication-webhook`
- URL: https://developer.incode.com/general-reference/face-authentication-webhook/
- Markdown: https://developer.incode.com/general-reference/face-authentication-webhook.md

# Face Authentication Webhook

This webhook is specifically designed for use with the [Face Authentication](/features-and-modules/face-authentication/) module. It also requires the webhooks to be defined in the **Configuration** > **Webhooks** tab in Dashboard.

## Success Notification

The following code block shows an example of a payload for a successful attempt when the Face Authentication module is used.

```json Successful attempt
{
    "interviewId": <string>,
    "customerId": <string>,
    "externalCustomerId": <string>,
    "overallStatus": <string> ("PASS" | "FAIL"),
    "hint": <string>,
    "attemptCounterState": {
        "max": <int>,
        "remaining": <int>
    },
    "error": {
        "name": <string> (check possible codes below),
        "message": <string>
    }
}
```

## Failure Notifications

Possible errors include:

- `"INACTIVE_SESSION"`
- `"HINT_NOT_PROVIDED"`
- `"NONEXISTENT_CUSTOMER"`
- `"MULTIPLE_FACES_DETECTED"`
- `"SPOOF_ATTEMPT_DETECTED"`
- `"FACE_TOO_DARK"`
- `"FACE_CROPPING_FAILED"`
- `"FACE_TOO_SMALL"`
- `"FACE_TOO_BLURRY"`
- `"BAD_PHOTO_QUALITY"`
- `"LENSES_DETECTED"`
- `"FACE_MASK_DETECTED"`
- `"HEAD_COVER_DETECTED"`
- `"CLOSED_EYES_DETECTED"`
- `"SELFIE_FACE_OCCLUDED"`
- `"SELFIE_IMAGE_LOW_QUALITY"`
- `"USER_IS_NOT_RECOGNIZED"`
- `"FACE_NOT_FOUND"`
- `"BAD_REQUEST"`
- `"PROCESSING_ERROR"`
- `"DEFAULT_ERROR"`

The following code block shows an example of a payload for a failed attempt when the Face Authentication module is used. This payload includes two fields with information about the error: its `name` and `message`.

```json Failed attempt
{
  "interviewId": "68e6492f71ccd116c458f59a",
  "customerId": "68e4e62e44106b8c9535436e",
  "overallStatus": "FAIL",
  "hint": "68e4e62e44106b8c9535436e",
  "error": {
      "name": "SPOOF_ATTEMPT_DETECTED",
      "message": "Spoof attempt detected"
   }
}
```

<br />

---

- Path: `general-reference/fetch-ekyc-input`
- URL: https://developer.incode.com/general-reference/fetch-ekyc-input/
- Markdown: https://developer.incode.com/general-reference/fetch-ekyc-input.md

# Fetch eKYC Data

## What is eKYC data?

Customers often integrate our eKYC input forms directly into their end-user experiences. As a result, customers want to have the opportunity to save and collect the original form input. The eKYC data for an onboarding contains all of the information that was submitted during the eKYC onboarding form. This includes all the textual information submitted (eg. Name, Address, etc.)

<Callout icon="⚠️" theme="warning">
  ###

  This endpoint requires an Admin session token. Session tokens issued for individual onboarding sessions cannot be used with this endpoint. For details on obtaining an Admin session token, see [Incode API Documentation](/reference/introduction/).
</Callout>

## How is eKYC data fetched?

To fetch eKYC data for a given onboarding session, you will need to pass the session's unique interview ID to the API endpoint.

## Direct API approach

<Callout icon="📘" theme="info">
  ### API Authentication

  All endpoints require authentication headers to be specified as stated in [Incode API Documentation](/reference/introduction/)
</Callout>

### [**eKYC fetch input**]()

**GET /omni/externalVerification/ekyc/session/\[interviewId]**

You can retrieve the session IDs by navigating to the sessions tab within your dashboard.

<br />

## Sample Response

```json JSON
{
    "userData": {
        "plugins": [],
        "source": "US_CREDIT_BUREAU_1",
        "firstName": "xxx",
        "surName": "xxx",
        "email": "xxx@xxx.com",
        "street": "XXX XX AVE",
        "houseNo": "XX",
        "postalCode": "XXXXX",
        "countryCode": "US",
        "phone": "+1408XXXXXXX",
        "state": "CA",
        "city": "SAN FRANCISCO",
        "ssn": "123456789",
        "dateOfBirth": "YYYY-MM-DD"
    },
    "riskData": {
        "level": "medium",
        "verifications": {
            "phoneCarrier": "Multiple OCN Listing",
            "phoneLevel": "very_high",
            "taxIdLevel": "medium",
            "taxIdStateMatch": "exact",
            "emailDomainLevel": "low",
            "phoneLineType": "Landline",
            "taxIdMatch": "exact",
            "taxIdDobMatch": "exact",
            "taxIdNameMatch": "fuzzy",
            "taxIdAddressMatch": "nomatch",
            "addressRiskLevel": "low",
            "emailLevel": "medium"
        },
        "reasonCodes": [
            {
                "key": "addressRiskLevel",
                "reasonCodes": [
                    {
                        "reasonCode": "A70SS",
                        "description": "Tracking data indicates that over 70% of mailpieces sent to this address were delivered successfully and recent mailings were also successful."
                    }
                ]
            },
            {
                "key": "taxIdLevel",
                "reasonCodes": [
                    {
                        "reasonCode": "TSAC",
                        "description": "Current Address Conflict"
                    },
                    {
                        "reasonCode": "TANO",
                        "description": "Current Address Not On-file"
                    },
                    {
                        "reasonCode": "TMAI",
                        "description": "Multiple address inconsistencies in last 7 days and SSN seen with different phones in last 90 days"
                    },
                    {
                        "reasonCode": "TPSMT",
                        "description": "Phone seen multiple times in last 90 days with different last names"
                    },
                    {
                        "reasonCode": "TPDNV",
                        "description": "One or more PII data elements not verified"
                    }
                ]
            },
            {
                "key": "customer",
                "reasonCodes": [
                    {
                        "reasonCode": "PRSA",
                        "description": "This number has risky static attributes (like VOIP phone type or being on a blocklist) -"
                    },
                    {
                        "reasonCode": "EANI",
                        "description": "Not enough information was found for the provided email address to determine a risk assessment"
                    },
                    {
                        "reasonCode": "TSAC",
                        "description": "Current Address Conflict"
                    },
                    {
                        "reasonCode": "TANO",
                        "description": "Current Address Not On-file"
                    },
                    {
                        "reasonCode": "TMAI",
                        "description": "Multiple address inconsistencies in last 7 days and SSN seen with different phones in last 90 days"
                    },
                    {
                        "reasonCode": "TPSMT",
                        "description": "Phone seen multiple times in last 90 days with different last names"
                    },
                    {
                        "reasonCode": "TPDNV",
                        "description": "One or more PII data elements not verified"
                    }
                ]
            }
        ]
    }
}
```

<br />

---

- Path: `general-reference/fetching-crosscheck-results`
- URL: https://developer.incode.com/general-reference/fetching-crosscheck-results/
- Markdown: https://developer.incode.com/general-reference/fetching-crosscheck-results.md

# Fetching Crosscheck Results

The [Cross Check module](/features-and-modules/cross-check/) compares two data points from a session against each other and returns a match result. Cross checks are [configured in Dashboard](/dashboard-platform-administration/cross-check-dashboard/) as part of a Workflow or Flow: you name each comparison, choose the two fields to compare (for example, first name from ID Capture against first name entered in a Form), and set the severity applied when the values don't match. During a session, each configured comparison runs automatically. This page documents how to fetch the results of those comparisons via API.

## Endpoint

`POST /omni/cross-doc-data-check/results`

## Response

The response returns a dictionary keyed by comparison name. Each value is an array of result objects containing the compared fields, match outcome, and severity.

### Sample response

```json
{
  "FirstNameComparison #i1class": [
    {
      "interviewId": "string",
      "comparisonName": "string",
      "comparisonId": "string",
      "result": "OK",
      "leftValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "rightValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "severity": "ultra_low"
    }
  ]
}
```

### Response fields

| Field               | Description                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `interviewId`       | ID of the interview the comparison was run against.                                                  |
| `comparisonName`    | Name of the comparison as configured in Dashboard.                                                   |
| `comparisonId`      | Internal ID of the comparison.                                                                       |
| `result`            | Match outcome for this comparison.                                                                   |
| `leftValueDetails`  | Object describing the first field in the comparison, including document type, field name, and value. |
| `rightValueDetails` | Object describing the second field in the comparison.                                                |
| `severity`          | Severity level of the comparison result (for example, `ultra_low`).                                  |

## Reading results

When reading the response, iterate through the dictionary and use a "contains" comparison with the comparison name. Do not read the comparison name as a direct key on the JSON response. Incode's system automatically appends metadata to the end of each name, so a direct key lookup will not work.

For example, if you name a comparison `FirstNameComparison` in Dashboard, the API may return it as `FirstNameComparison #i1class`. The appended metadata varies and should be ignored. To retrieve the result, loop through the top-level keys of the JSON response and find the key that contains `FirstNameComparison`.

Name comparisons so there is no overlap in "contains" matching. For example, do not name one comparison `FirstNameComp` and another `FirstNameComparison`. This can cause your code to read from the wrong field.

---

- Path: `general-reference/finland`
- URL: https://developer.incode.com/general-reference/finland/
- Markdown: https://developer.incode.com/general-reference/finland.md

# Finland

Finland eKYC verification matches submitted individual data against Finland's source of truth using a sequenced search across multiple underlying data sources. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source          | API source string  | Description                                                                                                    |
| ---------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------ |
| FI National ID   | `FI_NATIONAL_ID`     | Runs a search across Finland's national ID database. |
| Finland Consumer + Pop Register + Telco | `FI_CONSUMER_POP_REG_TELCO` | Verifies submitted data against Finland consumer records, the population register, and telco records.

## FI National ID

### Request parameters

| Parameter     | Required  | Description                                                       |
| ------------- | --------- | ---------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `FI_NATIONAL_ID`.                                             |
| `country`     | Mandatory | Must be `FI`.                                                         |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.                |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                 |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                                  |
| `idNumber`    | Mandatory | Finnish national identity number.                                      |
| `street`      | Optional  | Street name and house number.                                          |
| `city`        | Optional  | City of the individual's address (for example, `Lappeenranta`).        |
| `state`       | Optional  | State or region.                                                       |
| `postalCode`  | Optional  | Finland postal code. See format note below.                            |

:::info
`postalCode` must be exactly 5 digits, numeric only (no letters, spaces, or hyphens).
:::

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "FI_NATIONAL_ID", //required field
    "firstName": "Matti", //required field
    "surName": "Virtanen", //required field
    "street": "Koivukuja 12 A 4",
    "city": "Lappeenranta",
    "state": "South Karelia",
    "postalCode": "53100",
    "country": "FI", //required field
    "dateOfBirth": "1991-08-02", //required field
    "idNumber": "010203A123X" //required field
}
```

### Response fields

FI National ID anchors verification on the submitted national identity number, name, date of birth, and address elements. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values. Individual field matches for this source resolve to `exact` or `nomatch` only; `fullAddressMatch` additionally supports `fuzzy`.

| Field                | Statuses                    | Description                                                                                |
| --------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `nomatch`           | Matches first name submitted against the value in the source of truth.                     |
| `lastNameMatch`      | `exact`, `nomatch`           | Matches last name submitted against the value in the source of truth.                      |
| `fullNameMatch`      | `exact`, `nomatch`           | Matches full name submitted against the value in the source of truth.                      |
| `dobMatch`           | `exact`, `nomatch`           | Matches date of birth submitted against the value in the source of truth.                  |
| `idNumMatch`         | `exact`, `nomatch`           | Matches national identity number submitted against the value in the source of truth.       |
| `streetMatch`        | `exact`, `nomatch`           | Matches street submitted against the value in the source of truth.                         |
| `cityMatch`          | `exact`, `nomatch`           | Matches city submitted against the value in the source of truth.                           |
| `stateMatch`         | `exact`, `nomatch`           | Matches state submitted against the value in the source of truth.                          |
| `postalCodeMatch`    | `exact`, `nomatch`           | Matches postal code submitted against the value in the source of truth.                    |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`  | Composite of `streetMatch`, `cityMatch`, `stateMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `overallLevel`       | `low`, `medium`, `high`      | Overall risk level. See below for calculation logic.                                       |





#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name, national identity number, and date of birth:

- `low` when `fullNameMatch`, `idNumMatch`, and `dobMatch` are all `exact`.
- `high` when `fullNameMatch`, `idNumMatch`, and `dobMatch` are all `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

## Finland Consumer + Pop Register + Telco

### Request parameters

| Parameter     | Required  | Description                                                       |
| ------------- | --------- | ---------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `FI_CONSUMER_POP_REG_TELCO`.                                             |
| `country`     | Mandatory | Must be `FI`.                                                         |
| `firstName`   | Mandatory | First name of the individual. Letters, spaces, hyphens, and apostrophes only.    |
| `surName`     | Mandatory | Last name of the individual. Letters, spaces, hyphens, and apostrophes only.     |
| `phone`       | Mandatory | Finland phone number. Must be either 10 digits starting with a `0` in national format, or `+358` followed by 9 digits, without the leading 0, in international format. For example, `0401234567` or `+358401234567`.          |
| `street`      | Optional  | Street name.                                          |
| `houseNo`     | Optional  | House or building number.                             |
| `city`        | Optional  | City of the individual's address (for example, `Helsinki`).        |
| `postalCode`  | Optional  | Finland postal code. Five digits (for example, `00100`).               |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                  |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                        |
| `email`       | Optional  | Email address of the individual.         |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "FI_CONSUMER_POP_REG_TELCO", //required field
    "firstName": "Mikko", //required field
    "surName": "Virtanen", //required field
    "phone": "+358401234567", //required field
    "country": "FI", //required field
    "street": "Mannerheimintie", //optional field
    "houseNo": "45", //optional field
    "city": "Helsinki", //optional field
    "postalCode": "00100", //optional field
    "dateOfBirth": "1991-08-02", //optional field
    "gender": "m", //optional field
    "email": "mikko.virtanen@example.com" //optional field
}
```

### Response fields

Finland Consumer + Pop Register + Telco anchors verification on individual name and phone number. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                    | Description                                                                                |
| --------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------- |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches submitted first name against the source of truth.                     |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches submitted last name against the source of truth.                      |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise, `fuzzy`.                      |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata`           | Matches submitted date of birth against the source of truth.                  |
| `genderMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted gender against the source of truth.                                                           |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted street against the source of truth.                                                           |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted house number against the source of truth. Not used in the `fullAddressMatch` calculation.     |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch` and `houseNoMatch`. `exact` if both match; `nomatch` if either does not match; `nodata` if both have no data; otherwise, `fuzzy`. |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted city against the source of truth.                                                             |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted postal code against the source of truth.                                                      |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. `exact` if `streetMatch` is `exact` and `cityMatch` and `postalCodeMatch` are each `exact` or `nodata`; `nomatch` if all three are `nomatch`; `nodata` if all three are `nodata`; otherwise, `fuzzy`. |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted phone number against the source of truth.                                                     |
| `emailMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches submitted email address against the source of truth.                                                    |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level of the submitted attributes. See below for calculation logic.                                |

#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and phone number:

- `low` when `fullNameMatch` is `exact` AND `phoneMatch` is `exact`.
- `high` when `fullNameMatch` is `nomatch` OR `phoneMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "genderMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "houseNoMatch", "status": "exact" },
        { "key": "streetAddressMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "emailMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

---

- Path: `general-reference/france`
- URL: https://developer.incode.com/general-reference/france/
- Markdown: https://developer.incode.com/general-reference/france.md

# France

eKYB Prefill in France leverages France's source of truth to automatically retrieve and populate business information based on a company's SIREN, SIRET, RCS, RC, or VAT number, including the business name, registered address, entity type, registration status, directors, shareholders, and additional financial and corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| France | `FR_KYB_PREFILL` | Returns matching French business details from France's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `FR_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `FR`. |
| taxId | Mandatory | String. French business identifier. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts five French business identifier types. Routing between them is determined automatically by the format of the submitted value.

| **ID Type** | **Description** | **Format** | **Example** |
|---|---|---|---|
| **SIREN** | Company-level identifier issued by INSEE | 9 numeric digits | `775670417` |
| **SIRET** | Establishment-level identifier (SIREN + NIC suffix) | 14 numeric digits (9-digit SIREN + 5-digit NIC) | `12345678901234` |
| **RCS** | Registre du Commerce et des Sociétés number | `RCS` + registering court city + SIREN | `RCS Paris 775 670 417` |
| **RC** | Registre du Commerce number for artisans/crafts | `RC` + city + registration number | Paris 123 456 789 |
| **VAT number** | French intra-community VAT identifier | `FR` + 2-digit check code + 9-digit SIREN (13 characters total) | `FR81775670417` |

Inputs that do not match any of the above formats return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "FR_KYB_PREFILL",
    "country": "FR",
    "taxId": "12345678901234",
    "businessName": "Entreprise Exemple SAS",
    "address": "10 Rue de Rivoli, 75001 Paris, France"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request. `vatNo` and `leiNumber` are only present when available on file for the company.

**Example 1 — ABERMIDONE (small company)**

```json
{
  "kyb-prefill": [
    {
      "tin": "12345678901234",
      "vatNo": "FR12345678901",
      "name": "ABERMIDONE",
      "nameMatch": "Verified",
      "address": "10 Rue de Rivoli, 75001 Paris, France",
      "city": "Paris",
      "postalCode": "75001",
      "entityType": "Simplified joint stock company",
      "registrationStatus": "Active",
      "registrationDate": "2013-09-25T00:00:00Z",
      "creditRating": "B",
      "creditRatingDescription": "Low Risk",
      "industryDesc": "Retail sale via home-shopping by general catalogue",
      "activityDesc": "Retail sale via home-shopping by general catalogue",
      "employeeCount": "7 to 9 employees",
      "otherAddresses": [
        { "type": null, "otherAddress": "33185 LE HAILLAN" },
        { "type": null, "otherAddress": "75008 PARIS" }
      ],
      "shareholders": [
        { "name": "Groupe Exemple SA", "percentSharesHeld": 100 }
      ],
      "directors": [
        { "name": "Groupe Exemple SA", "positionName": "President" }
      ],
      "ultimateParent": { "name": "Groupe Exemple SA", "country": "FR" },
      "immediateParent": { "name": "Groupe Exemple SA", "country": "FR" }
    }
  ]
}
```

**Example 2 — LVMH MOET HENNESSY LOUIS VUITTON (large public company)**

```json
{
  "kyb-prefill": [
    {
      "tin": "12345678901234",
      "vatNo": "FR12345678901",
      "leiNumber": "549300ECLIPSELUXE199",
      "name": "Maison Éclipse Luxe SAS",
      "nameMatch": "Verified",
      "address": "108 AVENUE RIVIÈRE 75008 PARIS",
      "city": "PARIS",
      "postalCode": "75008",
      "entityType": "European Company",
      "registrationStatus": "Active",
      "registrationDate": "1989-01-13T00:00:00Z",
      "creditRating": "A",
      "creditRatingDescription": "Very Low Risk",
      "industryDesc": "Activities of head offices",
      "activityDesc": "Activities of head offices",
      "turnover": { "currency": "EUR", "value": 748000000 },
      "employeeCount": "20",
      "shareholders": [
        { "name": "FINANCIÈRE ÉCLAT", "percentSharesHeld": 6.73 },
        { "name": "FAMILLE BEAUMONT", "percentSharesHeld": 0.57 }
      ],
      "directors": [
        { "name": "M BERNARD BEAUMONT", "positionName": "Chairman of the Board" },
        { "name": "Mme LYDIA ANNA-NOËLLE DUNE", "positionName": "Administrator" }
      ]
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | SIREN or SIRET | The company registration number as confirmed by the source of truth. |
| vatNo | VAT number | The French VAT number (TVA intracommunautaire) as returned from the source of truth (for example, `FR81775670417`). Only present when available on file for the company. |
| leiNumber | LEI number | The Legal Entity Identifier as returned from the source of truth. Only present when available — not all French companies have one. |
| name | Business name | The registered legal name of the business as returned from the source of truth. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `Simplified joint stock company`, `European Company`). Defaults to `Unknown` when not available. |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). Defaults to `Unknown` when not available. |
| registrationDate | Date | The date the company was registered, as returned from the source of truth. May not be present for all companies. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `A`). Defaults to `Unknown` when not available. |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Very Low Risk`). |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Activities of head offices`). |
| activityDesc | Activity description | The principal activity description as returned from the source of truth. For France, this is typically identical to `industryDesc`. |
| turnover | `{currency, value}` object or string range | The latest turnover figure or range as returned from the source of truth. Passed through as-is — may be an exact `{currency, value}` object for larger companies or absent entirely for smaller companies. May not be present for all companies. |
| employeeCount | String | The latest employee count as returned from the source of truth. May be an exact number (for example, `"20"`) or a range (for example, `"6 to 9 employees"`) depending on the company. Always returned as a string. May not be present for all companies. |
| otherAddresses | Array of `{type, otherAddress}` | Additional addresses on file, other than the primary registered address. May not be present for all companies. |
| websites | Array of strings | Website URLs associated with the business as returned from the source of truth. May not be present for all companies. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. May not be present for all companies. |
| directors | Array of `{name, positionName}` | Current directors and officers as returned from the source of truth. `positionName` reflects the primary position title on file. May not be present for all companies. |
| ultimateParent | `{name, country, registrationNumber}` | Ultimate parent company, if available. Absent when the entity sits at the top of its own group structure. |
| immediateParent | `{name, country, registrationNumber}` | Immediate parent company, if available. Absent when the entity sits at the top of its own group structure. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. France Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match a supported French identifier format (SIREN, SIRET, RCS, RC, or VAT number):

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid French identifier: SIREN (9 digits), SIRET (14 digits), RCS (RCS + city + number), RC (RC + city + number), or VAT number (FR + 11 characters)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/germany`
- URL: https://developer.incode.com/general-reference/germany/
- Markdown: https://developer.incode.com/general-reference/germany.md

# Germany

eKYB Prefill in Germany leverages Germany's source of truth to automatically retrieve and populate business information based on a company's commercial register number or VAT number, including the business name, registered address, entity type, registration status, directors, shareholders, and additional financial and corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Germany | `DE_KYB_PREFILL` | Returns matching German business details from Germany's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `DE_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `DE`. |
| taxId | Mandatory | String. German commercial register number or VAT number. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts two German business identifier types. Routing between them is determined automatically by the format of the submitted value.

| ID Type | Format | Example |
| --- | --- | --- |
| **Handelsregisternummer** (Commercial register number) | `HRB` or `HRA` followed by digits | `HRB 209661` |
| **USt-IdNr** (VAT number) | `DE` + 9 numeric digits | `DE814194672` |

These formats do not overlap, so routing is unambiguous. Inputs that do not match either format return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "DE_KYB_PREFILL",
    "country": "DE",
    "taxId": "HRB 123456",
    "businessName": "SAGDO GmbH",
    "address": "Lindenstraße 24, 21465 Reinbek"
}
```
### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request. `vatNo` is only present when the VAT number is available on file for the company.

```json
{
  "kyb-prefill": [
    {
      "tin": "HRB 123456",
      "vatNo": "DE123456789",
      "name": "SAGDO GmbH",
      "nameMatch": "Verified",
      "address": "Lindenstraße 24, 21465 Reinbek",
      "city": "Reinbek",
      "postalCode": "21465",
      "entityType": "Private limited company",
      "registrationStatus": "Active",
      "registrationDate": "2005-12-16T00:00:00Z",
      "creditRating": "A",
      "creditRatingDescription": "Very Low Risk",
      "industryDesc": "Manufacture of sports goods",
      "activityDesc": "Manufacture of sports goods",
      "turnover": "2 million - 5 million",
      "employeeCount": "3-5",
      "websites": ["sagdo.de"],
      "shareholders": [
        { "name": ": "Nordlicht Capital Investment GmbH", "percentSharesHeld": 100 }
      ],
      "ultimateParent": { "name": "BERGMANN BETEILIGUNGSGESELLSCHAFT MBH", "country": "DE" },
      "immediateParent": { "name": "BERGMANN BETEILIGUNGSGESELLSCHAFT MBH", "country": "DE" }
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | Commercial register number | The Handelsregisternummer (HRB/HRA number) as confirmed by the source of truth. |
| vatNo | VAT number | The USt-IdNr as returned from the source of truth (for example, `DE123456789`). Only present when the VAT number is available on file — not every company will have this field even if a VAT number exists. |
| name | Business name | The registered legal name of the business as returned from the source of truth. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `Private limited company`). Defaults to `Unknown` when not available. |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). Defaults to `Unknown` when not available. |
| registrationDate | Date | The date the company was registered, as returned from the source of truth. May not be present for all companies. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `A`). Defaults to `Unknown` when not available. |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Very Low Risk`). |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Manufacture of sports goods`). |
| activityDesc | Activity description | The principal activity description as returned from the source of truth. For Germany, this is typically identical to `industryDesc`. |
| turnover | String | The turnover range as returned from the source of truth (for example, `"2 million - 5 million"`). Germany provides range values only — no exact figure is available. This field is always a string, not a numeric object. |
| employeeCount | String | The latest employee count as returned from the source of truth. May be an exact number (for example, `"5"`) or a range (for example, `"3-5"`) depending on the company. Always returned as a string. May not be present for all companies. |
| otherAddresses | Array of `{type, otherAddress}` | Additional addresses on file, other than the primary registered address. May not be present for all companies. |
| websites | Array of strings | Website URLs associated with the business as returned from the source of truth. May not be present for all companies. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. May not be present for all companies. |
| directors | Array of `{name, positionName}` | Current directors and officers as returned from the source of truth. `positionName` reflects the primary position title on file. May not be present for all companies. |
| ultimateParent | `{name, country, registrationNumber}` | Ultimate parent company, if available. Absent when the entity is not a subsidiary. |
| immediateParent | `{name, country, registrationNumber}` | Immediate parent company, if available. Absent when the entity is not a subsidiary. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Germany Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match the `HRB`/`HRA` + digits or `DE` + 9 digits format:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid German commercial register number (HRB/HRA followed by digits) or VAT number (DE followed by 9 digits)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/get-an-access-token`
- URL: https://developer.incode.com/general-reference/get-an-access-token/
- Markdown: https://developer.incode.com/general-reference/get-an-access-token.md

# Get an Access Token

Incode's platform includes two primary access control levels. The first level is the session token and it's scoped to an onboarding session. The second level is the executive token and this token provides access to any session, as well as privileged operations. Privileged operations include, but are not limited to operations such as, asynchronously fetching scores or other pieces of past session data, using our SMS endpoint, and fetching data after a webhook is received.

## Session Tokens

A session token is returned by the `omni/start` API endpoint and is used for the immediate activities related to the Incode session it was generated for. For example, once calling the `omni/start` endpoint, the same token should be used to call subsequent capture and process API calls. The token returned in the `omni/start` response is used for the **X-Incode-Hardware-Id** header. The TTL (time to live) value of these tokens defaults to 20 minutes.

## Executive Tokens

The executive token, also reffered to as an admin token,  is generated from a user's password and email. You can find this information in your Incode delivery document. Supply the credentials associated with the environment that you are attempting to access data in. For example, when trying to fetch session images in the Demo environment, use your dashboard login credentials for the Demo environment. The TTL value of these tokens defaults to 24 hours. 

The request body for the API [call](/api-reference/executive-log-in/) will look like the following JSON example:

```json
{
"email": "some@email.com",
"password": "somePassword"
}
```

#### Response:

The response will be a token that you will use for the **X-Incode-Hardware-Id** header.



```json
{  
"token": "[string]"  
}
```

## Request Header

This is the standard request header that will be used for all API calls

* **api-version**: This header is mandatory for each request. The value must be set to `1.0`
* **x-api-key**: This header is mandatory for each request. This is a client specific API key which should be issued by Incode. You can find this in your Incode delivery document
* **X-Incode-Hardware-Id**: The value for this header is should be set after calling the `omni/start` endpoint or after calling the ` /executive/log-in` endpoint

---

- Path: `general-reference/global-watchlists-webhook`
- URL: https://developer.incode.com/general-reference/global-watchlists-webhook/
- Markdown: https://developer.incode.com/general-reference/global-watchlists-webhook.md

# Watchlist update webhook

[Watchlists](/features-and-modules/watchlist/) supports continuous updates for a session if you subscribed to continuous updates through the API. When the search has updated security information, the Global Watchlists webhook asynchronously sends a notification to your callback URL.

The `ref` and `search_id` fields in the notification are identifiers assigned when the initial search was performed. You can use either field to retrieve the new search result with the [Get updated watchlist result](/reference/getupdatedwatchlistresult/) endpoint.

## Configure the webhook

To configure your callback URL:

1. In Dashboard, go to **Configuration** > **Webhooks**.
2. Scroll down and click **Generate New**.
3. Enter a **_Name_** for the webhook.
4. Use the **_Type_** drop-down to select _Watchlist update webhook url_.
5. Enter your **_URL_**.
6. You can choose to **Override Custom Headers and Authentication**.
7. Click **Save**.

For more information, see the [webhook overview](/general-reference/webhooks-overview/).

## Endpoint details

Incode sends a `POST` request to the endpoint you configured:

`POST https://{client-defined-url}`

### Request

The webhook sends the following payload when triggered.

```json Sample request payload
{
  "interviewId": "",
  "ref": "",
  "search_id": ""
}
```

| Field | Description |
| --- | --- |
| `interviewId` | Identifier of the session the search belongs to. |
| `ref` | Reference number received when the search was created. |
| `search_id` | Search ID received when the search was created. |

If you are [authenticating your webhook requests](/general-reference/authorizing-webhooks-requests/), the webhook includes the `Authorization` header with the OAuth 2.0 bearer token:

`Authorization: Bearer <ACCESS_TOKEN>`

Any additional custom headers you configured are included as well.

### Response

To prevent the [retry policy](/general-reference/webhooks-overview/#retry-policy) from resending the same notification, make sure your endpoint returns one of the following:

* Status code `204 No Content`
* Status code `200 OK` with a `Content-Type` of `application/json`, for example `{ "success": true }`

```json Sample response
{
  "success": true
}
```

---

- Path: `general-reference/government-verification-sources`
- URL: https://developer.incode.com/general-reference/government-verification-sources/
- Markdown: https://developer.incode.com/general-reference/government-verification-sources.md

# Government Verification

Incode verifies user-provided identity data against official government registries to confirm that IDs are legitimate, valid, and belong to the person presenting them. Registries are maintained by government agencies in each supported country; supported documents, verifiable data, and available verification tiers vary by country. GovMatch runs as part of an onboarding session after data capture and biometric checks are complete.

## Country Coverage

Each country page documents the registry Incode connects to, the verification tiers available (for example, Data, Face, or Data and Face), the supported document types, and the fields that can be verified. Where applicable, pages also note credential requirements for accessing the registry.

- [Argentina](/general-reference/system-of-record-argentina/)
- [Australia](/general-reference/system-of-record-australia/)
- [Brazil](/general-reference/system-of-record-brazil/)
- [Chile](/general-reference/system-of-record-chile/)
- [Colombia](/general-reference/system-of-record-colombia/)
- [Mexico](/general-reference/system-of-record-mexico/)
- [South Africa](/general-reference/system-of-record-south-africa/)
- [United States (GovMatch)](/general-reference/united-states-govmatch/)

## Direct API Approach

For the request and response reference, see [Process Government Validation](/api-reference/process-government-validation/) in the Incode Omni API Reference.

---

- Path: `general-reference/greece`
- URL: https://developer.incode.com/general-reference/greece/
- Markdown: https://developer.incode.com/general-reference/greece.md

# Greece

eKYB Prefill in Greece leverages Greece's source of truth to automatically retrieve and populate business information based on a company's AFM or GEMI number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Greece | `GR_KYB_PREFILL` | Returns matching Greek business details from Greece's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `GR_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `GR`. |
| `taxId` | Mandatory | String. AFM or GEMI number. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

Greece supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| AFM (Arithmos Forologikou Mitroou) | 9 numeric digits (e.g. `801725938`). Also accepted with the `EL` VAT prefix (e.g. `EL801725938`) — the prefix is stripped before lookup. |
| GEMI number (General Commercial Registry number) | 12 numeric digits |

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "GR_KYB_PREFILL",
    "country": "GR",
    "taxId": "801725938",
    "businessName": "",
    "address": ""
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted. Field availability varies by company — see the notes under each example below.

**Example 1 — small company with trading name and previous name**

```json
{
    "kyb-prefill": [
        {
            "tin": "123456789000",
            "vatNo": "801725938",
            "name": "SAMPLE BOAT I.K.E.",
            "nameMatch": "Verified",
            "address": "Sample Street 1 Kerkyra Kerkyra 49100",
            "city": "Kerkyra",
            "postalCode": "49100",
            "entityType": "Private Capital Company",
            "registrationStatus": "Active",
            "registrationDate": "2023-05-12T00:00:00Z",
            "creditRating": "E",
            "creditRatingDescription": "Not Rated",
            "activityDesc": "Yachting",
            "turnover": { "currency": "EUR", "value": 74882 },
            "websites": ["www.sampleboat.example"],
            "shareholders": [
                { "name": "Sample Owner Name", "percentSharesHeld": 100 }
            ],
            "directors": [
                { "name": "Sample Director Name", "positionName": "Administrator" }
            ],
            "otherNames": [
                { "name": "SAMPLE BOAT", "businessNameType": "Trading Name" },
                { "name": "SAMPLE BOAT SINGLE MEMBER P.C.", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```

**Example 2 — company with multiple shareholders (limited turnover/contact data)**

```json
{
    "kyb-prefill": [
        {
            "tin": "987654321000",
            "vatNo": "802498747",
            "name": "SAMPLE RENTAL E.E.",
            "nameMatch": "Verified",
            "address": "Sample Avenue 86 Kavala Kavala 65404",
            "city": "Kavala",
            "postalCode": "65404",
            "entityType": "Limited Partnership",
            "registrationStatus": "Active",
            "registrationDate": "2026-02-02T00:00:00Z",
            "creditRating": "E",
            "creditRatingDescription": "Not Rated",
            "shareholders": [
                { "name": "Sample Shareholder One", "percentSharesHeld": 35 },
                { "name": "Sample Shareholder Two", "percentSharesHeld": 35 },
                { "name": "Sample Shareholder Three", "percentSharesHeld": 30 }
            ],
            "directors": [
                { "name": "Sample Director One", "positionName": "Administrator" },
                { "name": "Sample Director Two", "positionName": "Administrator" }
            ],
            "otherNames": [
                { "name": "SAMPLE TRADING NAME", "businessNameType": "Trading Name" },
                { "name": "SAMPLE RENTAL O.E.", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```

*(`turnover`, `employeeCount`, `websites`, `otherAddresses` omitted — not present in this response.)*

**Example 3 — larger company (with otherAddresses/employeeCount)**

```json
{
    "kyb-prefill": [
        {
            "tin": "456789123000",
            "vatNo": "094232831",
            "name": "SAMPLE SHOES SA",
            "nameMatch": "Verified",
            "address": "Sample Road 7 Argyroupoli 16452 Attiki",
            "entityType": "Societe Anonyme",
            "registrationStatus": "Active",
            "creditRating": "C",
            "creditRatingDescription": "Moderate Risk",
            "industryDesc": "Wholesale of clothing and footwear",
            "turnover": { "currency": "EUR", "value": 4887918 },
            "employeeCount": "19",
            "websites": ["www.sampleshoes.example"],
            "otherAddresses": [
                { "otherAddress": "Sample Secondary Address, Glyfada, Attiki 16675" }
            ],
            "otherNames": [
                { "name": "SAMPLE SHOES S.A.", "businessNameType": "Trading Name" },
                { "name": "SAMPLE SHOES S.A.", "businessNameType": "Previous Name" }
            ]
        }
    ]
}
```

*(`otherNames` entries here are near-duplicates of `name`, differing only in punctuation — a real, if unremarkable, response.)*

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | GEMI number | 12-digit General Commercial Registry number, as returned from the source of truth. |
| `vatNo` | AFM | 9-digit tax registry number. |
| `name` | Business name | The registered **legal** name of the business, as returned from the source of truth — not the trading name. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. |
| `postalCode` | Postal code | The postal code associated with the registered business address, when available. Always 5 digits. |
| `entityType` | Entity type | The legal entity type of the business (e.g. Private Capital Company, Societe Anonyme). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. May not be available for all entities. |
| `creditRating` | Rating value (e.g. A, C, E) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Moderate Risk, Not Rated) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | Description of the business's main activity, when available. |
| `activityDesc` | Activity description | Description of the business's principal activity, when available. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be available for all entities. |
| `employeeCount` | Number (as string) | Latest reported number of employees, if available. |
| `websites` | Array of strings | Websites associated with the business, if available. |
| `otherAddresses` | Array of `{otherAddress}` | Addresses associated with the business other than the main registered address, if any. May not be present for smaller companies. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information, if available. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. May occasionally contain garbled or low-quality name data. |
| `otherNames` | Array of `{name, businessNameType}` | Trading name and any previous legal names for the business, combined into a single list. `businessNameType` is `"Trading Name"` or `"Previous Name"`. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Greece Prefill returns the following country-specific 400 errors.

`taxId` is not a valid 9-digit AFM or 12-digit GEMI number:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid AFM (9 digits) or GEMI number (12 digits)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted taxId:
```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}`
```









## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/incode-api-overview`
- URL: https://developer.incode.com/general-reference/incode-api-overview/
- Markdown: https://developer.incode.com/general-reference/incode-api-overview.md

# Incode API Overview

The Incode Omni API is organized around REST. In general our API uses standard secure HTTP requests with JSON arguments and JSON responses.

## Authentication

REST API calls must be authenticated using a custom HTTP header `X-Incode-Hardware-Id` — along with a JSON web token. Additionally, every API call has to contain `x-api-key` header with valid client API key.

:::info
  Please check [Get an Access Token](/general-reference/get-an-access-token/) for an explanation of how access tokens are generated and used.
:::

## API Responses

Incode Omni uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

- Codes in the `2XX` range indicate success.
- Codes in the `4xx` range indicate an error that failed given the information provided (e.g. missing required parameter). These usually mean you need to fix your request.
- Codes in the `5xx` range indicate server side errors (these are rare).

:information_source: Some `2XX` responses of the Omni API have a dynamic nature. For example, the [Fetch ocr data](/api-reference/get-ocr-data/) or [Fetch ocr data V2](/api-reference/get-ocr-data-v2/) endpoint  will might contain additional fields depending on the data which was extracted from provided ID Document in the session. If you are using typed languages such as Java or C#, consider these cases to avoid having serialization exception when reading the JSON responses.

:warning: `4XX` errors that can be handled programmatically on your end include status of an error and message that briefly explains the error reported.

Arguments:

- **timestamp**: Long, UTC timestamp in milliseconds
- **status**: Integer, custom error code or http status code
- **error**: String, Http status error
- **message**: String, custom error message
- **path**: String, endpoint path

Custom error codes are given for each endpoint.

```json Example response with custom error
 { 
   "timestamp": 1584639032757,
   "status": 405,
   "error": "Spoof attempt detected",
   "message": "BadRequestException: Spoof attempt detected.",
   "path": "/omni/add/face"
}
```

HTTP status code summary:

- `200` (OK): Everything worked as expected.
- `400` (Bad Request): The request was unacceptable, often due to missing a required parameter.
- `401` (Unauthorized): Invalid or missing access token.
- `403` (Forbidden): Invalid or missing api key.
- `404` (Not Found): The requested resource doesn't exist.
- `405` (Method Not Allowed): Unacceptable HTTP method for requested resource.
- `406` (Not Acceptable): Unacceptable request.
- `429` (Too Many Requests): See [rate limits](#rate-limits) below.
- `500, 502, 503, 504` (Server Errors): Something went wrong on server side. (These are rare.)

## API Limitations

### Maximum Request Size

**There is a limitation of 10Mb** as the maximum possible request / response size in all our API endpoints, for this reason; it's is not possible to upload or fetch images/files larger than 10 Mb.

### Timeout

**There is a hard limit of 30 seconds** for all of our endpoints. If any request takes longer than that, you will receive a `Request Timeout` error

### Rate limits

We rate limit our APIs via throttling based on the "tokens in a bucket" approach:

- Each endpoint call requires a token (each organization has a bucket of tokens per endpoint category)
- Bucket capacity (`burst`) defines how many tokens can be withdrawn at once
- Tokens are refilled until the bucket reaches maximum capacity based on the refill rate (`maxRps`)

There are three endpoint categories, each one with its own bucket:

1.  `SUPER_HEAVY`: ID endpoints triggered by the SDK normally (e.g. `add/front`, `add/back`, `process/id)`
2.  `HEAVY`: Face endpoints triggered by the SDK normally (e.g. `add/face`, `process/face`)
3.  `OTHER`: All other endpoints

| Category    | maxRps | burst |
| :---------- | :----- | :---- |
| SUPER HEAVY | 1      | 5     |
| HEAVY       | 1      | 5     |
| OTHER       | 100    | 50    |

See [API Rate Limits](/general-reference/rate-limits/) for more information. For **special cases (only)** where these limits are not enough, our Customer Success team can help you adjust as needed.

**Rate limit example:**

The endpoints `add/front` `add/back` and `process/id` are in the `SUPER_HEAVY` category. The maximum bucket capacity is `5`, meaning the max amount of requests that can be done in a second is 5. Every request will deplenish the bucket by 1. If all 5 requests are consumed **within the same second** the bucket is emptied, any additional requests within the same second will receive the response: `429 Too Many Requests` .

The `SUPER_HEAVY` bucket has a refill rate of 1 (`maxRps`) per second, so it will refill by 1 unit every second until it's filled (5).

---

- Path: `general-reference/india`
- URL: https://developer.incode.com/general-reference/india/
- Markdown: https://developer.incode.com/general-reference/india.md

# India

eKYB Prefill in India leverages India's source of truth to automatically retrieve and populate business information based on a company's tax identifier (CIN or GSTIN), including the business name, entity type, registration status, registration date, credit rating, PAN details, and GST registrations, without requiring manual input from the user.

### Source

| Country | Source | Description |
| --- | --- | --- |
| India | `IN_KYB_PREFILL` | Returns matching Indian business details from India's source of truth for pre-fill. |

### Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

#### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

#### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `IN_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `IN`. |
| `taxId` | Mandatory | String. CIN or GSTIN. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

#### Tax ID formats

India supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| CIN (Corporate Identification Number) | 21 alphanumeric characters — company-type entities only (e.g. `U12345MH2020PTC123456`) |
| GSTIN (Goods and Services Tax Identification Number) | 15 alphanumeric characters |

Routing logic: if `taxId` is exactly 21 characters, it is treated as a CIN. Otherwise, if it matches the 15-character GSTIN format, it is treated as a GSTIN. Any other length or format returns a 400 error.

:::note
PAN (Permanent Account Number) is a valid Indian tax identifier but is **not** usable as search input — it does not return results. PAN is still returned as a field within the response (`panNumber`/`panName`) when available.

India does not have a separate VAT distinct from GST — the GSTIN serves as both. Not every entity has a GSTIN, since registration is turnover-threshold dependent. Proprietorships (sole proprietors) have no CIN at all — only a GSTIN and PAN.
:::

#### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "IN_KYB_PREFILL",
    "country": "IN",
    "taxId": "U12345MH2020PTC123456",
    "businessName": "",
    "address": "123 Sample Road, Mumbai, MH 123 456"
}
```

#### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted. Field availability varies significantly by entity type — see the notes under each example below.

**Example 1 — public company (CIN-based)**

```json
{
    "kyb-prefill": [
        {
            "tin": "U12345MH2020PTC123456",
            "vatNo": "14AAAAA0000A1Z1",
            "allGSTINs": [
                { "gstin": "14AAAAA0000A1Z1", "status": "Active" },
                { "gstin": "32AAAAA0000A1Z2", "status": "Active" },
                { "gstin": "02AAAAA0000A1Z3", "status": "Cancelled" }
            ],
            "panNumber": "AAAAA0000A",
            "panName": "SAMPLE INDUSTRIES LIMITED",
            "leiNumber": "5493000000000000AB12",
            "name": "SAMPLE INDUSTRIES LIMITED",
            "nameMatch": "Verified",
            "address": "1ST FLOOR SAMPLE TOWER 100 EXAMPLE ROAD NA MUMBAI Maharashtra India 400001",
            "entityType": "Public",
            "registrationStatus": "Active",
            "registrationDate": "1990-01-15T00:00:00Z",
            "creditRating": "C",
            "creditRatingDescription": "Moderate Risk",
            "industryDesc": "Manufacture of fuels, oils, and related chemical products.",
            "activityDesc": "The company is engaged in the business of manufacturing, refining, and distribution of industrial products.",
            "turnover": { "currency": "INR", "value": 5000000000000 },
            "websites": ["www.sampleindustries.example"],
            "shareholders": [
                { "name": "Public", "percentSharesHeld": 49.52 },
                { "name": "Example Commercials LLP", "percentSharesHeld": 11.12 }
            ],
            "directors": [
                { "name": "ANANYA SAMPLE RAO", "positionName": "Whole-time director" },
                { "name": "ROHAN SAMPLE MEHTA", "positionName": "Director" }
            ]
        }
    ]
}
```

*(`ultimateParent`/`immediateParent` omitted — this entity sits at the top of its own group.)*

**Example 2 — sole proprietorship (GSTIN/PAN-based, no CIN)**

```json
{
    "kyb-prefill": [
        {
            "vatNo": "27BBBBB1111B1Z1",
            "allGSTINs": [
                { "gstin": "27BBBBB1111B1Z1", "status": "Active" }
            ],
            "panNumber": "BBBBB1111B",
            "panName": "SAMPLE PROPRIETOR NAME",
            "name": "Sample Engineering Works",
            "nameMatch": "Verified",
            "address": "Plot 12, Sample Industrial Estate, Sample Road, Pune - 411000, Maharashtra, India",
            "entityType": "Proprietorship",
            "registrationStatus": "Active",
            "creditRating": "C",
            "creditRatingDescription": "Moderate Risk",
            "industryDesc": "Manufacture of fabricated metal products.",
            "activityDesc": "The entity is engaged in the business of manufacturing metal components and providing related services.",
            "otherAddresses": [
                { "type": "PAN Address", "otherAddress": "Flat 5, Sample Apartments, Sample Nagar, Pune - 411001, Maharashtra, INDIA" }
            ]
        }
    ]
}
```



:::info
Field availability differs across entity types and is not consistent even within the same type. `tin` (CIN), `leiNumber`, `registrationDate`, `turnover`, `shareholders`, `directors`, `ultimateParent`, and `immediateParent` are generally not available for proprietorships, since these entities have no company registration or share structure. `city` and `postalCode` are not consistently present for any entity type and should be treated as optional.
:::

#### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | CIN | Corporate Identification Number. May not be available for all entities (e.g. proprietorships have no CIN). |
| `vatNo` | GSTIN | The active GSTIN. India has no separate VAT — this field holds the GSTIN. If the input `taxId` was a GSTIN, that value is echoed back; otherwise the first active GSTIN on record is returned. |
| `allGSTINs` | Array of `{gstin, state, status}` | All GSTINs on record for the business. May not be available for all entities. Some entities hold multiple GSTINs (one per state of operation). |
| `panNumber` | PAN | The business's (or, for proprietorships, the owner's) Permanent Account Number. |
| `panName` | Name | The legal name associated with the PAN. May reflect the individual owner's name for proprietorships. |
| `leiNumber` | LEI | Legal Entity Identifier, if available. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. |
| `postalCode` | Postal code | The postal code associated with the registered business address, when available. |
| `entityType` | Entity type | The legal entity type of the business (e.g. Public, Proprietorship). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. May not be available for all entities. |
| `creditRating` | Rating value (e.g. A, C) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Moderate Risk) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | Description of the business's main activity. Defaults to "Unknown" when not available. |
| `activityDesc` | Activity description | Description of the business's principal activity. Defaults to "Unknown" when not available. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be available for all entities. |
| `websites` | Array of strings | Websites associated with the business, if available. |
| `otherAddresses` | Array of `{type, otherAddress}` | Addresses associated with the business other than the main registered address, if any. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information, if available. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. |
| `ultimateParent` | `{name, country, registrationNumber}` | The business's ultimate parent company, if the business is a subsidiary. |
| `immediateParent` | `{name, country, registrationNumber}` | The business's immediate parent company, if the business is a subsidiary. |

### Error responses

For standard HTTP response codes, see the API Error Response page. India Prefill returns the following country-specific 400 errors.

`taxId` is not a valid 21-character CIN or a valid 15-character GSTIN:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid CIN (21 characters) or GSTIN (15 characters)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```









### Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ine-scraping-webhook`
- URL: https://developer.incode.com/general-reference/ine-scraping-webhook/
- Markdown: https://developer.incode.com/general-reference/ine-scraping-webhook.md

# INE Scraping

The purpose of this webhook is to notify customers when the results of an INE scraping verification are available. INE scraping functionality is based on the execution of an asynchronous process, this process runs in background and once the results from the “INE Listas Nominales” are retrieved, these results are updated as part of the Onboarding Scores. To know when this asynchronous process has finished, it is highly recommended to implement the INE Scraping Webhook. This webhook is a simple HTTP request notification that will be triggered when the INE scraping process has finished.  To configure your callback URL, navigate to the Dashboard and select `Configuration -> Webhooks`, and then enter your URL under `INE SCRAPING WEBHOOK URL (OPTIONAL)`.  For more information see the webhook introduction page.

## INE Scraping Process

![](https://developer.incode.com/assets/76d053a8da25c05cf4c32ffd7e72e848.png)

<br />

## INE Scraping Webhook Details

When INE Scraping is enabled and configured, the following two HTTP requests are sent:

1. INE Scraping In Progress
   1. This request will be received when an INE scraping process is triggered and is in progress.
2. INE Scraping Finished.
   1. This request will be received when an INE scraping process has finished.
   2. Once the `FINISHED` status is received, the /omni/get/score API can be called to retrieve the results about the “INE Listas Nominales” verification.

### In Progress Request

**POST`https://{client-defined-url}`**

#### Request Payload

**POST Body:**

* **InterviewId:** String, mandatory. Session ID.
* **externalId:** String, optional. External ID - only if it was sent in start.
* **ScrapingStatus:`IN_PROGRESS`** String, mandatory.

### Response

Response body must be `{"success": "true"}`

* **success:** Boolean. Flag indicating client received notification successfully.

### Finished Request

#### Request

**Body:**

* **InterviewId:** String, mandatory. Session ID.
* **externalId:** String, optional. External ID - only if it was sent in start.
* **ScrapingStatus:`FINISHED`** String, mandatory.

### Response

Response body must be `{"success": "true"}`

* **success:** Boolean. Flag indicating client received notification successfully.

---

- Path: `general-reference/ireland`
- URL: https://developer.incode.com/general-reference/ireland/
- Markdown: https://developer.incode.com/general-reference/ireland.md

# Ireland

eKYB Prefill in Ireland leverages Ireland's source of truth to automatically retrieve and populate business information based on a company's CRO number or VAT number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Ireland | `IE_KYB_PREFILL` | Returns matching Irish business details from Ireland's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `IE_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `IE`. |
| `taxId` | Mandatory | String. CRO number or VAT number. See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

Ireland supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| CRO number (Company Registration Number) | Purely numeric, typically 5–9 digits (e.g. `301274`). May or may not appear with an `IE` prefix in the response — do not assume either way. |
| VAT number | `IE` + 7 digits + 1–2 check letters (e.g. `IE6321274H`) |

Disambiguation logic: if `taxId` is purely numeric, it is treated as a CRO number. If it contains letters, it is treated as a VAT number.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "IE_KYB_PREFILL",
    "country": "IE",
    "taxId": "301274",
    "businessName": "",
    "address": ""
}
```

### Sample response





```json
{
    "kyb-prefill": [
        {
            "tin": "IE301274",
            "vatNo": "IE6321274H",
            "name": "SAMPLE CHEMICAL & DAIRY ENGINEERING LIMITED",
            "nameMatch": "Verified",
            "address": "SAMPLE ROAD, EXAMPLETOWN CORK Ireland",
            "entityType": "LTD - PRIVATE COMPANY LIMITED BY SHARES",
            "registrationStatus": "Active",
            "registrationDate": "1999-02-15T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Manufacture of metal structures and parts of structures",
            "activityDesc": "The manufacture of process systems and stainless steel products including the design, procurement and manufacture of modular process skid units.",
            "turnover": { "currency": "EUR", "value": 53090461 },
            "employeeCount": "211",
            "shareholders": [
                { "name": "SAMPLE CHEMICAL & DAIRY ENGINEERING (HOLDINGS) LIMITED", "percentSharesHeld": 100 }
            ],
            "directors": [
                { "name": "SAMPLE DIRECTOR NAME", "positionName": "Director" },
                { "name": "SAMPLE DIRECTOR NAME", "positionName": "Company Secretary" },
                { "name": "ANOTHER SAMPLE NAME", "positionName": "Director" },
                { "name": "THIRD SAMPLE NAME", "positionName": "Director" }
            ],
            "ultimateParent": { "name": "SAMPLE HOLDING GROUP", "country": "FR" },
            "immediateParent": { "name": "SAMPLE HOLDING GROUP", "country": "FR" }
        }
    ]
}
```

**Example 2 — sole trader (NonLtd)**

```json
{
    "kyb-prefill": [
        {
            "tin": "240907",
            "name": "SAMPLE SALON",
            "nameMatch": "Verified",
            "address": "2 SAMPLE COURT, SAMPLE ROAD, EXAMPLE AREA, DUBLIN 18, D18TW10",
            "city": "DUBLIN",
            "postalCode": "D18TW10",
            "entityType": "INDIVIDUAL",
            "registrationStatus": "Active",
            "registrationDate": "2003-09-10T00:00:00Z",
            "activityDesc": "Website",
            "directors": [
                { "name": "SAMPLE OWNER NAME", "positionName": "Registered Business Owner" }
            ]
        }
    ]
}
```









:::info
Field availability differs significantly by entity type. `vatNo`, `creditRating`, `turnover`, `employeeCount`, and `shareholders` may all be absent for sole traders. `ultimateParent`/`immediateParent` are absent for entities that sit at the top of their own group. `city`, `postalCode`, and `websites` are not consistently present across entities.
:::

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | CRO number | Company Registration Number. May or may not include an `IE` prefix, depending on the entity — do not assume either way. |
| `vatNo` | VAT number | Includes the `IE` prefix as stored in the source of truth (not stripped). Absent for sole traders and pure holding companies with no VAT registration. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. May not be present even when available at the initial search step. |
| `postalCode` | Postal code | Eircode format (3+4 characters), when available. |
| `entityType` | Entity type | The legal entity type of the business (e.g. LTD - PRIVATE COMPANY LIMITED BY SHARES, INDIVIDUAL). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. May not be available for all entities. |
| `creditRating` | Rating value (e.g. A, C) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Very Low Risk) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | Description of the business's main activity. |
| `activityDesc` | Activity description | Description of the business's principal activity. May be a short label or a long free-text description depending on the company — this varies within Ireland itself. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. May not be present (e.g. for sole traders). |
| `employeeCount` | Number (as string) | Latest reported number of employees, if available. |
| `websites` | Array of strings | Websites associated with the business, if available. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information. Entirely absent for sole traders and other non-limited entities — not just empty. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business. The same person may appear multiple times with different `positionName` values — all entries are listed, without deduplication. For sole traders, the owner appears here with `positionName: "Registered Business Owner"`. |
| `ultimateParent` | `{name, country}` | The business's ultimate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |
| `immediateParent` | `{name, country}` | The business's immediate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Ireland Prefill returns the following country-specific 400 errors.

`taxId` is not a valid CRO number (numeric) or VAT number (`IE` + 7 digits + 1–2 letters):

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid CRO number or Irish VAT number",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/ireland-ekyb`
- URL: https://developer.incode.com/general-reference/ireland-ekyb/
- Markdown: https://developer.incode.com/general-reference/ireland-ekyb.md

# Ireland

Ireland eKYB validates the legitimacy of Irish businesses by checking their tax ID, business name, address, UBOs, and directors against Irish government-backed business registries.

## Source

| Country | Source                          | Description                                                                |
| -------- | --------------------------------- | ----------------------------------------------------------------------------- |
| Ireland  | Irish business registry sources   | Verifies submitted business details against records maintained in Irish registries, covering both limited companies and sole trader / business name registrations. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Verification Reference](/general-reference/ekyb-verification-api-reference/).

### Request parameters

| Parameter      | Required  | Description                                                                                     |
| --------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `plugins`       | Mandatory | Array. Must be `["ekyb"]`.                                                                            |
| `businessName`  | Mandatory | String. Name of the business.                                                                        |
| `country`       | Mandatory | String. Two-letter Alpha-2 country code. Must be `IE`.                                                |
| `taxId`         | Mandatory | String. Accepts a CRO number or a VAT number. See [Tax ID formats](#tax-id-formats) for details.      |
| `street`        | Optional  | String. Street name of the business.                                                                  |
| `houseNo`       | Optional  | String. Building or house number.                                                                     |
| `addressLine2`  | Optional  | String. Second line of the business address.                                                          |
| `city`          | Optional  | String. City in the business address.                                                                 |
| `state`         | Optional  | String. State in the business address.                                                                |
| `postalCode`    | Optional  | String. Irish Eircode. See format note below.                                                          |
| `uboNames`      | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`     | Optional  | Array. Full legal names of directors to check against records associated with the business.           |



#### Tax ID formats

| Tax ID Type  | Format                                                                     |
| ------------- | ----------------------------------------------------------------------------- |
| CRO number    | 5–9 numeric digits (for example, `123456`). Issued by the Companies Registration Office. |
| VAT number    | `IE` + 7 digits + 1–2 check letters (for example, `IE1234567X`). The `IE` prefix is stripped before matching. |





### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "ACME TRADING LIMITED",
  "street": "Harbour Road",
  "houseNo": "12",
  "city": "Cork",
  "postalCode": "T12A1B2",
  "country": "IE",
  "taxId": "123456",
  "uboNames": ["Jane Doe", "John Doe"],
  "directors": ["Jane Doe"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "LTD - PRIVATE COMPANY LIMITED BY SHARES" }
    },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Jane Doe" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "John Doe" }
  ]
}
```

### Response fields

| Key                     | Status                                    | Description                                                                                       |
| ------------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `name`                  | Verified, Approximate Match, Unverified      | Submitted business name against the registered legal name.                                         |
| `tin`                   | Verified, Unverified                          | Submitted tax ID (CRO or VAT number) against the registry.                                          |
| `address_verification`  | Verified, Approximate Match, Unverified      | Submitted address against the registered address on file. Matched as a fuzzy match on the full address; the postal code is an Eircode, not a fixed-digit numeric format. |
| `cityMatch`             | Verified, Approximate Match, Unverified      | Submitted city against the city on the registered address.                                          |
| `postalCodeMatch`       | Verified, Unverified                          | Submitted Eircode against the Eircode on the registered address.                                    |
| `registrationStatus`    | Active, Inactive, Unknown                     | Registration status of the business. Inactive includes suspended businesses and those no longer in operation. |
| `entityType`            | Legal entity type of the business             | The legal entity type of the business, if available (for example, a limited company form, or an individual/sole trader designation). If not available, displays Unknown. |
| `ubo_name_match`        | Verified, Approximate Match, Unverified      | Submitted UBO against shareholders/UBOs associated with the business. Distinguished by the `uboName_input` field on each entry. May return `Unverified` for sole trader businesses that have no shareholder structure. |
| `directors_name_match`  | Verified, Approximate Match, Unverified      | Submitted director against directors (or, for sole traders, the registered business owner) associated with the business. Distinguished by the `directorsName_input` field. A single person may appear more than once under different position titles; all entries are checked. |

## Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

---

- Path: `general-reference/italy`
- URL: https://developer.incode.com/general-reference/italy/
- Markdown: https://developer.incode.com/general-reference/italy.md

# Italy

eKYB Prefill in Italy leverages Italy's source of truth to automatically retrieve and populate business information based on a company's CCIAA/NREA number, VAT/Tax Code, or Codice Fiscale, including the business name, registered address, entity type, registration status, directors, shareholders, and additional financial and corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Italy | `IT_KYB_PREFILL` | Returns matching Italian business details from Italy's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `IT_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `IT`. |
| taxId | Mandatory | String. Italian business identifier. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts three Italian business identifier types. Routing between them is determined automatically by the format of the submitted value.

| ID Type | Description | Format | Example |
| --- | --- | --- | --- |
| **CCIAA/NREA** | Chamber of Commerce registration number | 2 letters + 6 or 7 digits | `BR123456`, `VA187262` |
| **Partita IVA** (VAT/Tax Code) | Italian VAT identifier | 11 numeric digits. A leading `IT` prefix is stripped automatically before processing. | `02324830740`, `IT08719600960` |
| **Codice Fiscale** | Personal tax code for sole traders | 16-character alphanumeric | `CGNMHL70D16A225B` |

Inputs that do not match any of the above formats return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "IT_KYB_PREFILL",
    "country": "IT",
    "taxId": "BR123456",
    "businessName": "ITALIA VENEZIA ENTERPRISE",
    "address": "STRADA MILANO STRADA 17, 72014 CISTERNINO BR"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request. Fields such as `turnover`, `employeeCount`, `shareholders`, `directors`, `creditRating`, and `companySize` may be absent for sole traders and smaller companies — this is expected, not an error.

**Example 1 — ITALIA VENEZIA ENTERPRISE (Limited Liability Company)**

```json
{
  "kyb-prefill": [
    {
      "tin": "BR123456",
      "vatNo": "12345678901",
      "name": "ITALIA VENEZIA ENTERPRISE - SOCIETA' A RESPONSABILITA' LIMITATA",
      "nameMatch": "Verified",
      "address": "STRADA MILANO STRADA 17, 72014 CISTERNINO BR",
      "city": "CISTERNINO",
      "postalCode": "72014",
      "entityType": "LIMITED LIABILITY COMPANY",
      "registrationStatus": "Active",
      "creditRating": "C",
      "creditRatingDescription": "Moderate Risk",
      "industryDesc": "Non-specialised retail sale",
      "turnover": { "currency": "EUR", "value": 2298098 },
      "employeeCount": "4",
      "shareholders": [
        { "name": "Alessandro Moretti", "percentSharesHeld": 60 }
      ],
      "directors": [
        { "name": "Giulia Romano", "positionName": "SOLE DIRECTOR" }
      ]
    }
  ]
}
```





**Example 2 — RUOTA LIBERA DI CAGNAZZI MICHELE (Sole trader)**

```json
{
  "kyb-prefill": [
    {
      "tin": "BA123456",
      "vatNo": "12345678901",
      "name": "RUOTA VENEZIA DI CAGNAZZI MICHELE",
      "nameMatch": "Verified",
      "address": "HOUSE 123, STREET ABC, 72014 CISTERNINO BR",
      "city": "CISTERNINO",
      "postalCode": "72014",
      "entityType": "SOLE PROPRIETOR",
      "registrationStatus": "Active",
      "registrationDate": "2008-09-22T00:00:00Z",
      "industryDesc": "Other retail sale of new goods in specialised stores"
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | CCIAA/NREA number | The Italian Chamber of Commerce registration number as confirmed by the source of truth. |
| vatNo | Partita IVA | The 11-digit Italian VAT number as returned from `alternateSummary.vatRegistrationNumber` in the source of truth. This field is reliable for all entity types, including sole traders, regardless of how the search was performed. |
| name | Business name | The registered legal name of the business as returned from the source of truth. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `LIMITED LIABILITY COMPANY`, `SOLE PROPRIETOR`). Defaults to `Unknown` when not available. |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). Defaults to `Unknown` when not available. |
| registrationDate | Date | The date the company was incorporated (`incorporationDate`), as returned from the source of truth. May not be present for all companies. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `A`). Defaults to `Unknown` when not available. May not be present for sole traders. |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Very Low Risk`). May not be present for sole traders. |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Non-specialised retail sale`). |
| activityDesc | Activity description | The principal activity description as returned from the source of truth. For Italy, this is typically identical to `industryDesc`. May not be present for all companies. |
| turnover | `{currency, value}` object | The latest turnover figure as returned from the source of truth. May not be present for sole traders and smaller companies. |
| employeeCount | String | The latest employee count as returned from the source of truth. Always returned as a string. May not be present for sole traders and smaller companies. |
| companySize | String | The company size classification as returned from the source of truth (for example, `Small Company`). May not be present for all companies. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. `percentSharesHeld` is sourced from `quotaPercentage` under `shareCapitalStructureExtra`. May not be present for sole traders. |
| directors | Array of `{name, positionName}` | Current directors and officers as returned from the source of truth. `positionName` reflects the primary position title on file. May not be present for sole traders. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Italy Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match a supported Italian identifier format:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Italian identifier: CCIAA/NREA (2 letters + 6-7 digits), Partita IVA (11 digits), or Codice Fiscale (16 alphanumeric characters)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [Single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/kyb-api-reference`
- URL: https://developer.incode.com/general-reference/kyb-api-reference/
- Markdown: https://developer.incode.com/general-reference/kyb-api-reference.md

# KYB API Reference
Runs the requested checks for one business, returning a single response with one result for each check requested.

:::note
This is not the same as eKYB [Verification](/general-reference/ekyb-verification-api-reference/) or [Prefill](/general-reference/ekyb-prefill-api-reference/) API Reference.
:::



All endpoints require authentication headers. See the Incode API Documentation for details.









## Endpoint

`POST /omni/kyb`




| | |
|---|---|
| Authentication | Session Token (X-Incode-Hardware-Id) and x-api-key |
| Content type | application/json |
| Result delivery | Synchronous response, plus one KYB_RESULTS webhook per run |
| Related | KYB Results Webhook, KYB Coverage |

## Request

| Field | Type | Required | Description |
|---|---|---|---|
| country | string | Yes | ISO 3166-1 alpha-2 country code, for example US, GB, DE |
| modules | string[] | Yes | Modules to run. See Modules below |
| taxId | string | Per country and module | Tax ID, company registration number or VAT number. Outside the US this is how the business is found. See Tax ID formats |
| businessName | string | Per country and module | Registered legal name of the business |
| street | string | No | Street address |
| city | string | Per country and module | City |
| state | string | Per country and module | State or province. For the US, the two-letter state code |
| postalCode | string | No | Postal code or ZIP |
| personNames | string[] | No | Full names of people to check against the business's officers and directors (personAssociation). One result is returned per name |
| website | string | No | Business website URL |
| alternativeNames | string[] | No | Trade names or other names the business uses |
| phoneNumber | string | No | Business phone number |
| email | string | No | Business email address |

## Modules

`identity`, `address`, `statusEntityType`, `personAssociation`, `webPresence`, `websiteAnalysis`, `industryInfo`, `financialIntelligence`, `groupStructure`.

A module the country’s source does not support is skipped and is absent from the response. An unknown module name rejects the request.

## Validation

**United States**

| Rule | Error message |
|---|---|
| identity requires taxId and businessName | Missing mandatory fields: taxId, businessName |
| address, webPresence, websiteAnalysis and industryInfo require businessName, city and state | Missing mandatory fields: businessName, city, state |
| statusEntityType, personAssociation and financialIntelligence must be requested together with address | Missing required module address for modules: statusEntityType |
| taxId, when sent, is 1 to 20 letters, numbers, spaces or hyphens | Invalid taxId: must be 1 to 20 characters of letters, numbers, spaces or hyphens |

The error message lists every missing field at once. A `website` does not replace `businessName`, `city` and `state`: `websiteAnalysis` always starts from the business’s discovered web presence, and the submitted `website` is used when one is sent.

**Other countries**

The business is found by `taxId`. Without a taxId, or when no business matches it, every requested module carries an `error` with status `notFound` (see Errors inside a module below). `address` is compared only when at least one of `street`, `city` or `postalCode` is sent; otherwise the address module is left out of the response.

**Example request**





















```json Node
{
  "country": "US",
  "modules": ["identity", "address", "statusEntityType", "personAssociation", "webPresence"],
  "taxId": "12-3456789",
  "businessName": "Acme Corp",
  "street": "123 Main Street",
  "city": "Austin",
  "state": "TX",
  "postalCode": "78701",
  "personNames": ["John Smith"],
  "website": "https://acmecorp.com"
}
```

**Response**

`200 OK`. Only the checks that were requested and are supported for the country are present. Read each check by name and treat an absent check as “not checked”. `null` fields are omitted.

| Field | Type | Description |
|---|---|---|
| identity | object | Identity |
| address | object | Address |
| statusEntityType | object | Status and entity type |
| personAssociation | object | Person association |
| webPresence | object | Web presence |
| websiteAnalysis | object | Website analysis |
| industryInfo | object | Industry info |
| financialIntelligence | object | Financial intelligence |
| groupStructure | object | Group structure |
| scores | object[] | KYB or risk scores, when the source returns them: type, score, rating |
| pendingModules | string[] | Modules still running. Their results arrive with the webhook |
| referenceId | string | Identifies this run in the webhook and the polling endpoint |

Match statuses are `Verified`, `Approximate Match`, `Unverified` and `Not Found`.

**Identity**

| Field | Type | Description |
|---|---|---|
| taxId | match status | Match result for the submitted tax ID |
| name | match status | Match result for the submitted business name against the registered names |
| registryName | string | Registered name of the business |
| registryNames | string[] | All registered names the submitted name was compared against |
| tinMatchType | string | US only. EIN or state registration number |
| tinMatchMessage | string | US only. IRS name + TIN result: Tax ID and business name combination found or Tax ID and business name combination not found |
| error | object | See Errors inside a module |

**Address**

| Field | Type | Description |
|---|---|---|
| addressVerification | match status | Match result for the submitted address |
| registryAddress | string | Registered address of the business |
| registryAddresses | string[] | All addresses on file the submitted address was compared against |
| officeType | string | Type of the registered office, for example headOffice |
| otherAddresses | object[] | Other addresses on file: address, type |
| error | object | See Errors inside a module |

**Status and entity type**

| Field | Type | Description |
|---|---|---|
| registrationStatus | string | Active, Inactive or Unknown |
| entityType | string | Legal entity type, as reported by the registry |
| incorporationDate | string | Date of incorporation |
| companySize | string | Company size band |
| otherInfo | object | vatNo, leiNumber, otherNames[] (name, businessNameType). India only: panNumber, panName, allGSTINs[] (gstin, state, status) |
| error | object | See Errors inside a module |

**Person association**

| Field | Type | Description |
|---|---|---|
| personMatches | object[] | One entry per name in personNames: checkedName, status (match status), matchedName, matchedPerson |
| people | object[] | Every officer, director or shareholder on record: name, titles[], percentSharesHeld |
| error | object | See Errors inside a module |

**Web presence**

| Field | Type | Description |
|---|---|---|
| socialProfiles | object[] | platform (for example facebook, x, linked_in:company), username, url, confidence (high, medium, low), followers, bio, businessWebsite, verified |
| websites | string[] | Websites associated with the business |
| phoneNumbers | string[] | Phone numbers associated with the business |
| emailAddresses | string[] | Email addresses associated with the business |
| error | object | See Errors inside a module |

**Website analysis**

| Field | Type | Description |
|---|---|---|
| url | string | Website that was analyzed |
| domainAgeMonths | integer | Age of the domain in months |
| domainCreatedAt / domainExpiresAt | string | ISO-8601 dates |
| registrar | string | Domain registrar |
| parked | boolean | true when the domain is parked or a placeholder |
| buildStatus | string | For example active |
| ssl | object | isValid, issuer, certificateType (DV, OV, EV), tlsVersion, expiryDate, daysUntilExpiry, isWildcard, isSelfSigned, isRevoked |
| structureMetrics | object | depth, breadth |
| error | object | See Errors inside a module |

**Industry info**

| Field | Type | Description |
|---|---|---|
| naicsCode / title | string | NAICS code and title (US) |
| accuracy | number | Confidence of the NAICS prediction, 0.0 to 1.0 (US) |
| riskLevel | string | low, medium or high (US) |
| industryCode / classification | string | Local industry code and its classification system, for example SIC07, WZ2008 |
| industryDesc / activityDesc | string | Industry and activity descriptions |
| error | object | See Errors inside a module |

**Financial intelligence**

| Field | Type | Description |
|---|---|---|
| liens | object[] | US. filingNumber, filingType, filingDate, status, lienAmount, matchLevel |
| litigation | object[] | US. docketNumber, court, state, title, caseType, dateFiled, matchLevel, riskLevel |
| bankruptcy | object[] | US. bankruptcyType, docketNumber, court, title, dateFiled, riskLevel, matchLevel |
| creditRating / creditRatingDescription | string | Credit rating A to E and its description |
| creditLimit | object | currency, value |
| probabilityOfDefault | number | Probability of default |
| turnover | object | currency, value, or only a range band where the registry reports no figure (Germany) |
| employeeCount | string | A figure or a band, for example 3-5 |
| negativeInformation | object | Negative information as reported by the source |
| error | object | See Errors inside a module |

For `liens`, `litigation` and `bankruptcy`, an empty list means the search ran and found nothing; an absent list means that search did not complete.

**Group structure**

| Field | Type | Description |
|---|---|---|
| ultimateParent / immediateParent | object | name, country, status, registrationNumber |
| subsidiaryCompanies / affiliatedCompanies | object[] | Same shape as a parent |
| relatedEntities | object[] | Italy only. A flat list where each entry also carries a level |
| error | object | See Errors inside a module |

**Example response**

```json Node
{
  "identity": {
    "taxId": "Verified",
    "name": "Verified",
    "registryName": "ACME CORP",
    "tinMatchType": "EIN",
    "tinMatchMessage": "Tax ID and business name combination found"
  },
  "address": {
    "addressVerification": "Verified",
    "registryAddress": "123 Main Street, Austin, TX 78701"
  },
  "statusEntityType": {
    "registrationStatus": "Active",
    "entityType": "Corporation"
  },
  "personAssociation": {
    "personMatches": [
      {
        "checkedName": "John Smith",
        "status": "Verified",
        "matchedName": "JOHN SMITH",
        "matchedPerson": { "name": "JOHN SMITH", "titles": ["CEO"] }
      }
    ],
    "people": [
      { "name": "JOHN SMITH", "titles": ["CEO"] },
      { "name": "MARY JONES", "titles": ["Director"] }
    ]
  },
  "pendingModules": ["webPresence"],
  "referenceId": "6650f2c1a9b8e45d2c3f1a77"
}
```

## Errors

**Errors inside a module**

A module that ran but could not produce a result carries an `error` object, and the rest of the response is unaffected. The request still answers `200`.

| Field | Description |
|---|---|
| status | notFound when the business or the data was not found, unverified when the source failed or could not complete the check |
| message | The reason |

| Message | Meaning |
|---|---|
| Business Not Found | No business matched the request (US) |
| Incorrect Tax ID/Registration Number | No business matched the submitted taxId |
| Tax ID and business name combination not found | The IRS did not confirm the name + TIN pair (US) |
| No information available | The business was found, but the source holds no data for this module |
| Verification could not be completed: the provider request failed or the provider is unavailable | The source failed. The request can be retried |
| Web presence unavailable, Website analysis unavailable, Industry info unavailable, Liens unavailable, Litigation and bankruptcy unavailable | That background check did not complete |

```json Node
{
  "identity": {
    "error": { "status": "notFound", "message": "Incorrect Tax ID/Registration Number" }
  },
  "statusEntityType": {
    "error": { "status": "notFound", "message": "Incorrect Tax ID/Registration Number" }
  },
  "referenceId": "6650f2c1a9b8e45d2c3f1a78"
}
```

**Request errors**

`400 Bad Request`. The request was rejected before any source was called, or the source could not be reached at all. Nothing is billed for a request rejected by validation.

| Message | Cause |
|---|---|
| Missing mandatory fields: … | A field the requested modules need is missing or blank |
| Missing required module address for modules: … | A module that depends on address was requested without it |
| Invalid taxId: … | taxId does not have a valid format |
| No provider configured for country XX | This module is not enabled for this country for the organization |
| Company report unavailable for XX | The business was found but its report could not be retrieved |

```json Node
{
  "timestamp": 1760600000000,
  "status": 400,
  "error": "Missing mandatory fields: taxId, businessName",
  "message": "Missing mandatory fields: taxId, businessName",
  "path": "/omni/kyb"
}
```

</br>

---

- Path: `general-reference/kyb-coverage`
- URL: https://developer.incode.com/general-reference/kyb-coverage/
- Markdown: https://developer.incode.com/general-reference/kyb-coverage.md

# KYB Coverage
Available checks and accepted tax ID formats depend on the country. A check that is not available for the requested country is skipped and left out of the response, and the rest of the request runs normally.

Each country must also be enabled for the organization. Contact your Incode representative to enable a country.

:::note
This is different than eKYB [Verification](/general-reference/ekyb-verification-coverage/) and [Prefill](/general-reference/ekyb-prefill-coverage/) coverage.
:::

## Checks by region

| Check | United States | Other supported countries* |
|---|---|---|
| identity | ✅ | ✅ |
| address | ✅ | ✅ |
| statusEntityType | ✅ | ✅ |
| personAssociation | ✅ | ✅ |
| webPresence | ✅ | ✅ |
| websiteAnalysis | ✅ | ❌ |
| industryInfo | ✅ | ✅ |
| financialIntelligence | ✅ | ✅ |
| groupStructure | ❌ | ✅ |

*_Availability may vary by country, depending on what the official registry or data source provides._

In the United States, `webPresence`, `websiteAnalysis`, `industryInfo`, and `financialIntelligence` can finish after the initial response and arrive with the [KYB Results Webhook](/general-reference/kyb-results-webhook).

## What each check returns, by region

| Check | United States | Other supported countries* |
|---|---|---|
| identity | Name and tax ID match, plus whether the IRS confirms the name and tax ID combination | Name and tax ID match |
| address | Match against every address on file | Match against the registered address, the type of office, and any other addresses on file |
| statusEntityType | Registration status and entity type | Adds incorporation date, company size, and other identifiers such as VAT number or LEI |
| personAssociation | Officers and directors | Directors and shareholders, including ownership percentage |
| webPresence | Social profiles discovered online | Websites, phone numbers, and email addresses on file |
| industryInfo | Predicted industry classification with a confidence score and risk level | Registered industry code and classification system |
| financialIntelligence | Liens, litigation, and bankruptcy filings | Credit rating, credit limit, probability of default, turnover, employee count, and other negative information |

*_Availability may vary by country, depending on what the official registry or data source provides._

## Supported countries and tax ID formats

How a business is found and the tax ID format accepted varies by country. The list below is not exhaustive of our coverage. Contact our sales team to discuss a country not listed here.

### United States

The business is found by name and location (`businessName`, `city`, `state`). `taxId` is required only for identity, and is sent to the IRS name + TIN check together with `businessName`.

**Accepted format:** EIN or state (Secretary of State) issued registration number, 1 to 20 letters, numbers, spaces, or hyphens.

### Other countries

Outside the US, `taxId` is mandatory. Some registries require it to locate the business at all, and requiring it also reduces the chance of impersonation: a business' name and address are easy to find publicly, but its tax ID is something only someone with real access to the business is likely to have. Where a country accepts both a registration number and a VAT number, the format of the value decides which one is searched: a country-code prefix (for example `GB`, `DE`, `FR`) means a VAT number, and a bare number means a registration number.

| Country | Code | taxId accepted |
|---|---|---|
| Argentina | AR | CUIT (VAT number) |
| Australia | AU | 11-digit ABN or 9-digit ACN |
| Austria | AT | ATU-prefixed VAT number, or commercial register number (FN) |
| Belgium | BE | Enterprise number (BCE/KBO); dots, spaces, and a BE prefix are accepted |
| Bulgaria | BG | Registration number, or BG-prefixed VAT number |
| Cameroon | CM | Registration number |
| Denmark | DK | CVR number, or DK-prefixed VAT number |
| France | FR | SIREN, or FR-prefixed VAT number |
| Germany | DE | Commercial register number, or DE-prefixed VAT number |
| Greece | GR | 11 to 12 digit GEMI number, or 9-digit AFM (optionally EL-prefixed) |
| India | IN | 21-character CIN or 15-character GSTIN |
| Ireland | IE | Company number, or IE-prefixed VAT number |
| Italy | IT | CCIAA/REA number (letter prefix), 11-digit Partita IVA, or 16-character Codice Fiscale |
| Japan | JP | Corporate Number |
| Kenya | KE | Registration number |
| Lithuania | LT | Registration number, or LT-prefixed VAT number |
| Malta | MT | Registration number, or MT-prefixed VAT number |
| Mexico | MX | Registration number |
| Netherlands | NL | 8-digit KvK number, or RSIN / NL…B… VAT number |
| Nigeria | NG | Registration number |
| Norway | NO | 9-digit organization number, or with the MVA suffix for the VAT number |
| Portugal | PT | NIF, optionally PT-prefixed |
| Romania | RO | Registration number, or RO-prefixed VAT number |
| Spain | ES | Registration number, or ES-prefixed VAT number |
| Sweden | SE | Organization number, or SE-prefixed VAT number |
| United Kingdom | GB | Companies House number, or GB-prefixed VAT number |
| Vietnam | VN | Registration number |

---

- Path: `general-reference/kyb-modules-reference`
- URL: https://developer.incode.com/general-reference/kyb-modules-reference/
- Markdown: https://developer.incode.com/general-reference/kyb-modules-reference.md

# KYB Reference
This section provides technical reference: the countries supported, the request and response schemas, and the format details for each supported country.

:::note
This is different than [eKYB Reference](/general-reference/ekyb-reference/).
:::

The [module overview page](features-and-modules/kyb-modules) covers what it does at a conceptual level, and the [Dashboard configuration page](dashboard-platform-administration/kyb-modules) explains how to add the module to your Flows and Workflows. This section covers the integration and API details for building against it.

## In this section

- [KYB Coverage](/general-reference/kyb-coverage): supported countries and which checks are available per country.
- [KYB Tax ID Formats](/general-reference/kyb-tax-id-formats): the tax ID format accepted for each supported country.
- [KYB API Reference](/general-reference/kyb-api-reference): request, response, and error schemas for `POST /omni/kyb`.

## See also

- [KYB Results Webhook](/general-reference/kyb-results-webhook): `referenceId`, pending checks, the `KYB_RESULTS` webhook, and polling.

---

- Path: `general-reference/kyb-results-webhook`
- URL: https://developer.incode.com/general-reference/kyb-results-webhook/
- Markdown: https://developer.incode.com/general-reference/kyb-results-webhook.md

# KYB Results Webhook
Every run returns a `referenceId` and ends with exactly one `KYB_RESULTS` webhook. Use the webhook, or poll with the `referenceId`, to read the final result of a run, including checks that were still running when `POST /omni/kyb` answered.





## How results are delivered

Most checks answer within the request. Four checks query sources that can take longer:

- `webPresence`
- `websiteAnalysis`
- `industryInfo`
- `financialIntelligence`

These run in parallel and the request waits for them up to a fixed budget (20 seconds by default). Then:

| Situation | POST /omni/kyb response | Webhook |
|---|---|---|
| Every requested check finished in time | Full result, no pendingModules | Sent right away with the same result |
| Some checks are still running | Result of the checks that finished, plus pendingModules listing the rest | Sent once every pending check finishes, with the full result |

Only the United States runs checks in the background. For other countries, every check answers within the request.

A background check that never finishes is closed after a timeout and reported with an `error` (for example `Web presence unavailable`), so a run always ends with a webhook.

```json Node
{
  "identity": { "taxId": "verified", "name": "verified", "registryName": "ACME CORP" },
  "address": { "addressVerification": "verified" },
  "pendingModules": ["webPresence", "industryInfo"],
  "referenceId": "6650f2c1a9b8e45d2c3f1a77"
}
```

## Configure webhook

[Configure this webhook](/dashboard-platform-administration/configuration-webhooks-tab/) URL for the `KYB_RESULTS` event in Dashboard at Configuration > Webhooks.

| Field | Type | Description |
|---|---|---|
| referenceId | string | The referenceId returned by POST /omni/kyb |
| result | object | The final result, with the same shape as the POST /omni/kyb response. pendingModules and referenceId are not set inside result |

```json Node
{
  "referenceId": "6650f2c1a9b8e45d2c3f1a77",
  "result": {
    "identity": { "taxId": "verified", "name": "verified", "registryName": "ACME CORP" },
    "address": { "addressVerification": "verified" },
    "webPresence": {
      "socialProfiles": [
        { "platform": "linked_in:company", "url": "https://www.linkedin.com/company/acmecorp", "confidence": "high" }
      ],
      "websites": ["https://acmecorp.com"]
    },
    "industryInfo": {
      "naicsCode": "541511",
      "title": "Custom Computer Programming Services",
      "accuracy": 0.92,
      "riskLevel": "low"
    }
  }
}
```

The webhook is sent once per run. Use `referenceId` to match it with the request.

## Poll the result

`GET /omni/verification/async/{referenceId}`

Authentication is the same as for `POST /omni/kyb`. Use polling as a fallback when the webhook is not configured or did not arrive.

| Field | Type | Description |
|---|---|---|
| referenceId | string | The requested referenceId |
| status | string | PENDING while checks are still running, COMPLETED when the result is final, FAILED when the run could not be finalized |
| type | string | KYB_RESULTS |
| result | object | The final result once COMPLETED, otherwise null |

```json Node
{
  "referenceId": "6650f2c1a9b8e45d2c3f1a77",
  "status": "COMPLETED",
  "type": "KYB_RESULTS",
  "result": {
    "identity": { "taxId": "verified", "name": "verified" },
    "webPresence": { "websites": ["https://acmecorp.com"] }
  }
}
```

Returns `404` when the `referenceId` is unknown or belongs to another organization.

---

- Path: `general-reference/kyrgyzstan`
- URL: https://developer.incode.com/general-reference/kyrgyzstan/
- Markdown: https://developer.incode.com/general-reference/kyrgyzstan.md

# Kyrgyzstan

Kyrgyzstan eKYC verification matches submitted individual data against Kyrgyzstan's official voter register as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description |
| --- | --- | --- |
| Kyrgyzstan Voter Register | `KG_VOTER_REGISTER` | Verifies submitted data against Kyrgyzstan's official voter register. |

## Kyrgyzstan Voter Register

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| source | Mandatory | Must be `KG_VOTER_REGISTER`. |
| country | Mandatory | Must be `KG`. |
| firstName | Mandatory | First name of the individual. Can be submitted in Latin or Cyrillic — both match. |
| surName | Mandatory | Last name of the individual. Kyrgyz patronymic surname forms (uulu, kyzy) are supported. Can be submitted in Latin or Cyrillic. |
| city | Mandatory | Plain city name (for example, `Бишкек`, `Bishkek`, `Ош`, `Osh`). Provide the city, not the region. City prefixes such as `г.`, `g.`, `город`, and `gorod` are stripped automatically before the request is sent. A wrong city, a region name, or a prefixed city causes the entire check to fail, including name matching. |
| middleName | Optional | Patronymic of the individual. Not included in `fullNameMatch`. |
| gender | Optional | Accepted values are `M` or `F`. |
| street | Optional | Street name and house number in one field (for example, `ul. Kiyevskaya, d. 45`). Can be submitted in Latin or Cyrillic. Address matching is at street level — a wrong house number may still return a match. |
| idNum | Optional | Kyrgyz PIN (Personal Identification Number) printed on the biometric ID card (eID). Format: exactly 14 numeric digits (`PDDMMYYYYRNNNK` — where `P` is gender digit, `DDMMYYYY` is date of birth, `RNNN` is authority code and sequence number, `K` is check digit). For example, `21505199012345`. |

### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "KG_VOTER_REGISTER",
    "firstName": "John",
    "middleName": "Example",
    "surName": "Doe",
    "country": "KG",
    "city": "Бишкек",
    "street": "ul. Example, d. 1",
    "gender": "M",
    "idNum": "21505199012345"
}
```

### Response fields

Kyrgyzstan Voter Register anchors verification on full name and address. See the eKYC API Reference for common match field definitions and status values.

| Field | Statuses | Description |
| --- | --- | --- |
| `firstNameMatch` | `exact`, `fuzzy`, `nomatch` | Matches first name submitted against the value in the source of truth. |
| `lastNameMatch` | `exact`, `fuzzy`, `nomatch` | Matches last name submitted against the value in the source of truth. |
| `middleNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches patronymic submitted against the value in the source of truth. Shown as a standalone field, not included in `fullNameMatch`. |
| `fullNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite match derived from `firstNameMatch` and `lastNameMatch` only. |
| `genderMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth. |
| `streetMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street address submitted against the value in the source of truth. Address matching is at street level. |
| `cityMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth. |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite match derived from `cityMatch` and `streetMatch`. |
| `idNumMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches the personal identification number (PIN) submitted against the value in the source of truth. |
| `overallLevel` | `low`, `medium`, `high` | Overall risk level. See below for calculation logic. |

:::info
The source of truth only returns results for the fields that were sent in the request. If a field was not submitted, its corresponding response key is not returned — this counts as `nodata` in all composite logic.
:::

### overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name and address:

- **low** when `fullNameMatch` is `exact` AND (`fullAddressMatch` is `exact` OR (`fullAddressMatch` is `fuzzy` AND `idNumMatch` is `exact`)).
- **high** when `fullNameMatch` is `nomatch` OR `fullAddressMatch` is `nomatch` or `nodata`.
- **medium** for all other combinations.

Contact your Incode representative to customize the overallLevel calculation for your use case.





### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch",   "status": "exact" },
        { "key": "lastNameMatch",    "status": "exact" },
        { "key": "middleNameMatch",  "status": "exact" },
        { "key": "fullNameMatch",    "status": "exact" },
        { "key": "genderMatch",      "status": "exact" },
        { "key": "streetMatch",      "status": "exact" },
        { "key": "cityMatch",        "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "idNumMatch",       "status": "exact" },
        { "key": "overallLevel",     "status": "low" }
    ]
}
```

---

- Path: `general-reference/migrations-and-deprecations`
- URL: https://developer.incode.com/general-reference/migrations-and-deprecations/
- Markdown: https://developer.incode.com/general-reference/migrations-and-deprecations.md

# Migrations and Deprecations
This section documents changes to existing Incode behavior that require action from your integration: features being retired, endpoints being replaced, and defaults being changed. Each page states what is changing, who is affected, the enforcement date, and the replacement path.

Review this section whenever you plan integration work. Changes listed here have fixed enforcement dates, and most have no grace period.

## Active Migrations

| Change | Enforcement date | Who's affected |
| --- | --- | --- |
| [Moving off session restarts](/general-reference/moving-off-session-restarts/) | TBD | Any integration that calls `omni/start` with an `interviewId` or `externalId` that already exists |
| [Step-up and additional checks](/general-reference/step-up-and-additional-checks/) | Depends on scenario | Any integration that restarts a completed session to add a signature, document, module, or acceptance after the original onboarding |

## Pages

- [Moving off session restarts](/general-reference/moving-off-session-restarts/): Retires the ability to restart an existing session with `omni/start`, and covers the replacement paths: admin-token reads, new sessions linked by `identityId`, and new sessions per attempt.
- [Step-up and additional checks](/general-reference/step-up-and-additional-checks/): Covers the replacement paths for running an extra check or collecting another document for a person who is already verified: document signatures, expired document updates, non-scoring additions, and Government Record Verification and Video Selfie. Also explains why retroactive module runs are not supported.

## How to Use These Pages

- **Check whether you're affected.** Each page opens with an *At a glance* summary naming the affected call sites and how to find them in your own code.
- **Identify your scenario.** A single integration may hit the same deprecation for several different reasons, each with its own replacement. Work through the scenarios in order.
- **Migrate before the enforcement date.** Replacement paths are generally available well ahead of enforcement, so you can switch incrementally rather than in one cutover.
- **Remove the old path.** Migration is not complete until the deprecated call site is gone.

---

- Path: `general-reference/moving-off-session-restarts`
- URL: https://developer.incode.com/general-reference/moving-off-session-restarts/
- Markdown: https://developer.incode.com/general-reference/moving-off-session-restarts.md

# Migration Guide: Moving Off Session Restarts

The ability to call `omni/start` again on a session that already exists, referred to as a **restart**, is being retired. If your integration does this, you need to migrate to one of the replacement paths below before the enforcement date.

## At a glance

| | |
|---|---|
| **Enforcement date** | Dependent on scenario |
| **What's changing** | Restarting a session by calling `omni/start` API or SDK again with an existing `interviewId` or `externalId` |
| **Who's affected** | Any integration that calls `omni/start` with an `interviewId` or `externalId` that already exists |
| **How to check** | Search your integration for call sites where `omni/start` is passed an existing `interviewId` or `externalId`. For each one, work through [Find Your scenario](#find-your-scenario) to identify why. |
| **Grace period** | None. See [Enforcement](#enforcement). |

## What is changing

| | What it is | Status |
|---|---|---|
| **Restart** | Calling `omni/start` API or SDK again with the `interviewId` or `externalId` of an existing session. Begins the flow from the top. | Being retired |
| **Continue** | Calling `/omni/b2b/v1/sessions/continue` to pick the same session back up where it left off. | The supported path going forward |

The 48-hour rule governs **session resume** only. A session can be resumed via [`/omni/b2b/v1/sessions/continue`](/api-reference/b2b-v1-sessions-continue/) within 48 hours of the `omni/start` call that created it, up to twice. Resuming does not extend the window, and once it closes a new session is required. The same 48-hour window limits how long any new session stays open, including a step-up session. The 48 hours do not apply when a session is only being read using an admin token; there is no limit on session age in that case.

### Enforcement

The enforcement date differs based on the scenario; contact your Incode representative for more information. There will be no reset at that date and no grace period: the 48 hours are measured from each session's own `omni/start` call, so a session created more than 48 hours before enforcement cannot be resumed once enforcement begins.

After the enforcement date, a restart on a session outside its 48-hour window returns HTTP 400:

| Code | Message | Meaning |
|---|---|---|
| 400 | `maximum session lifetime exceeded` | The session is too old to restart. |
| 400 | `maximum session inactivity exceeded` | The session has not been updated recently enough to restart. |



The [`/omni/b2b/v1/sessions/continue`](/api-reference/b2b-v1-sessions-continue/) endpoint returns a distinct response for each rejection case.

## Find your scenario

Work through these in order. The first match is your scenario. An integration may fall into more than one, in which case handle each separately.

| # | Applies when | Replacement |
|---|---|---|
| [1](#scenario-1-reading-session-data) | A session is restarted only to obtain a token in order to read its data (scores, OCR, images) | Use an **admin token** with the `interviewId` as a query parameter. No session opened. |
| [2](#scenario-2-resuming-an-interrupted-session) | A real user drops off and returns within a couple of days to finish | Call `/omni/b2b/v1/sessions/continue` to pick up the same session |
| [3](#scenario-3-step-up-and-additional-checks) | An old session is reopened to run an extra check or collect another document (a signature, a proof of address, a tier upgrade) | See [Migration Guide: Step-Up and Additional Checks](/general-reference/step-up-and-additional-checks). Most cases use a new session linked to the person's identity. |
| [4](#scenario-4-repeating-a-completed-onboarding) | The user completed onboarding, and the finished session is restarted later to run it again | Create a **new session** for each attempt |
| — | None of the above | Contact your Incode CS representative or reach out using the customer portal. |

## Scenario 1: Reading session data

**Applies when:** the integration calls `omni/start` again purely to mint a token, then uses that token to read data. The restart is a side effect of needing a token, not something the flow requires.

**What to do instead:** authenticate with an **admin token** and pass the session's `interviewId` explicitly. No session is opened.

**Prerequisites**:
- Provision an admin user: A dashboard user with the **Admin** role is required on the specific instance being called. The admin token is issued in exchange for that user's email and password. If the account is removed or its password changes, the integration stops working.



- Obtain and refresh the admin token.

### The endpoints you'll call

The admin token goes in the **`X-Incode-Hardware-Id`** header, not `Authorization: Bearer`. The session is identified by `interviewId` as a **query parameter**, which is what allows an existing session to be read without opening it.

```bash
curl -X GET 'https://<api-base>/omni/get/ocr-data?id=<interviewId>' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-incode-hardware-id: <ADMIN_TOKEN>' \
  --header 'api-version: 1.0'
```

| Data required | Call |
|---|---|
| OCR data | [`GET /omni/get/ocr-data?id=<interviewId>`](/api-reference/get-ocr-data/) |
| Scores | [`GET /omni/get/score?id=<interviewId>`](/api-reference/get-score/)|
| Device info | [`GET /omni/get/device-info?id=<interviewId>`](/api-reference/get-device-info/)|
| Images | [`POST /omni/get/images/v2?id=<interviewId>`](/api-reference/get-images-v2/) |
| Session events | [`GET /omni/interview-events?interviewId=<interviewId>`](/api-reference/getevents/)|
| Video selfie download URL | [`GET /omni/generateVideoSelfieDownloadUrl?interviewId=<interviewId>`](/api-reference/generatevideoselfiedownloadurl/)|
| Authentication attempts | [`POST /omni/authentications/external/search`](/api-reference/authentications-external-search/)|
| Custom fields | [`GET /omni/get/custom-fields`](/api-reference/get-custom-fields/)|

**Images.** Use `POST /omni/get/images/v2`, documented at [`get-images-v2`](/api-reference/get-images-v2/) as "Fetch image links". It returns pre-signed download URLs valid for one hour. The v1 path `POST /omni/get/images` returns base64 instead, and responses over 10MB fail at the API gateway. New integrations should use v2.

**Session age.** There is no age restriction on reads made with an admin token. A session from any point in the past can be read, provided its `interviewId` is known. Images and other data removed under your data retention policy cannot be retrieved, regardless of session age.

Log in to obtain a token:

```bash
curl -X POST 'https://<api-base>/executive/log-in' \
  --header 'api-version: 1.0' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "<admin user email>", "password": "<password>" }'
```

The response contains `token` (the admin token, a JWT), plus `refreshToken` and `incodeRefreshToken`. Reference: [`executive/log-in`](/api-reference/executive-log-in/).

One admin token works across all sessions. Store it and reuse it rather than calling `/executive/log-in` for each request. The token expires after **24 hours** by default. Store the expiry alongside the token and request a new one before it lapses, rather than waiting for a call to fail. Refresh via `POST /executive/refresh`, passing the refresh token in the `X-Incode-Hardware-Id` header. The `incodeRefreshToken` is single-use and is invalidated on logout.



:::warning
An admin token together with the API key can read any session in the organization, including personal data. Store the token, the API key, and the admin user's credentials according to your own security policy.
:::

### After migration: remove the old path

Remove any code path that calls `omni/start` with an existing `interviewId` or `externalId` in order to obtain a token for reading.

Storing a session token is not an alternative. The session token TTL defaults to 20 minutes.

## Scenario 2: Resuming an interrupted session

**Applies when:** a real user abandons a flow partway and the session is restarted so they can pick up where they left off.

**What to do instead:** call `/omni/b2b/v1/sessions/continue` to obtain a fresh token for the same session. Available within 48 hours of the `omni/start` call that created the session, up to two times.

### What the change looks like

1. **Call [`/omni/b2b/v1/sessions/continue`](/api-reference/b2b-v1-sessions-continue/) to obtain a new session token**. The session token is scoped to that single session and is passed in the `X-Incode-Hardware-Id` header, the same as the token returned by `omni/start`.
2. **Resume the user at the right step**. If you want the user to pick up exactly where they left off, you need your own record of how far they progressed.
3. **Handle rejection**. A `continue` call fails when either the 48 hours have elapsed or the session has already been continued twice. On rejection, start a new session.

`/omni/start` continues to accept its current behavior during the migration period, so the switch does not have to be made in a single step. For the request and response contract, see the [API reference](/api-reference/start/).

## Scenario 3: Step-up and additional checks

**Applies when:** an existing or completed session is reopened to run an extra verification step or collect another document: a signature, a proof of address, a tier upgrade, or a renewed terms acceptance.

**What to do instead:** start a new session and link it to the person's identity through face authentication. This covers most step-ups. Some cases need no new session, and running a module over old sessions is not supported.

See [Migration Guide: Step-Up and Additional Checks](/general-reference/step-up-and-additional-checks) for each scenario and its migration path.









## Scenario 4: Repeating a completed onboarding

**Applies when:** a user completed onboarding successfully, and days, weeks, or months later the finished session is restarted rather than a new one created. The session was not interrupted partway; it completed.

**What to do instead:** create a new session for each attempt.

---

- Path: `general-reference/netherlands`
- URL: https://developer.incode.com/general-reference/netherlands/
- Markdown: https://developer.incode.com/general-reference/netherlands.md

# Netherlands

eKYB Prefill in the Netherlands leverages the Netherlands' source of truth to automatically retrieve and populate business information based on a company's KvK number or RSIN, including the business name, registered address, entity type, registration status, directors, and additional corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Netherlands | `NL_KYB_PREFILL` | Returns matching Dutch business details from the Netherlands' source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `NL_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `NL`. |
| taxId | Mandatory | String. Dutch KvK number or RSIN. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts two Dutch business identifier types. Routing between them is determined automatically by the format of the submitted value.

| ID Type | Description | Format | Example |
| --- | --- | --- | --- |
| **KvK number** | Kamer van Koophandel registration number | 8 numeric digits | `12345678` |
| **RSIN** | Rechtspersonen en Samenwerkingsverbanden Informatienummer | 9 numeric digits | `123456789` |

Inputs that do not match either format return a 400 error. RSIN is not issued to sole traders — searching by RSIN will not return sole trader records.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "NL_KYB_PREFILL",
    "country": "NL",
    "taxId": "12345678",
    "businessName": "Noorderlicht Ventures B.V.",
    "address": "Lindengracht 42, 1015 KJ Amsterdam, Netherlands"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request. `vatNo` is absent for sole traders. Director position names and authority levels are returned in Dutch and are not translated. `shareholders` is typically absent for Dutch BV companies, as shareholder registers commonly show only an aggregate share capital figure.

**Example 1 — Noorderlicht Ventures B.V. (sole trader)**

```json
{
  "kyb-prefill": [
    {
      "tin": "12345678",
      "name": "Noorderlicht Ventures B.V.",
      "nameMatch": "Verified",
      "address": "Lindengracht 42, 1015 KJ Amsterdam, Netherlands",
      "city": "Amsterdam",
      "postalCode": "1234RV",
      "entityType": "Sole trader with one owner",
      "registrationStatus": "Active",
      "registrationDate": "2012-12-11T00:00:00Z",
      "creditRating": "C",
      "creditRatingDescription": "Moderate Risk",
      "industryDesc": "Activities of Noorderlicht",
      "activityDesc": "Activities of Noorderlicht",
      "employeeCount": "1",
      "websites": ["www.daanvandijk.nl"],
      "directors": [
        { "name": "Daan van Dijk", "positionName": "Eigenaar" }
      ],
      "otherNames": [
        { "name": "Noorderlicht", "businessNameType": "Trading Name" }
      ]
    }
  ]
}
```

**Example 2 — Noorderlicht Trader B.V. (private limited company)**

```json
{
  "kyb-prefill": [
    {
      "tin": "12345678",
      "vatNo": "123456789",
      "name": "Noorderlicht Trader B.V.",
      "nameMatch": "Verified",
      "address": ": "Tulpenlaan 27, 3511 AB Utrecht, Netherlands",
      "entityType": "Private limited liability company (BV) with ordinary structure",
      "registrationStatus": "Active",
      "registrationDate": "2019-12-17T00:00:00Z",
      "creditRating": "E",
      "creditRatingDescription": "Not Rated",
      "industryDesc": "Retail sale of motor vehicles",
      "activityDesc": "Retail sale of motor vehicles",
      "employeeCount": "2",
      "directors": [
        { "name": "Daan van Dijk", "positionName": "Algemeen Directeur", "authority": "Alleen/zelfstandig bevoegd" },
        { "name": "Daan van Dijk", "positionName": "Algemeen Directeur", "authority": "Alleen/zelfstandig bevoegd" }
      ],
      "otherNames": [
        { "name": "Noorderlicht Trader B.V.", "businessNameType": "Trading Name" }
      ]
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | KvK number | The 8-digit Kamer van Koophandel registration number as confirmed by the source of truth. |
| vatNo | RSIN | The 9-digit Rechtspersonen en Samenwerkingsverbanden Informatienummer as returned from the source of truth. Only present for legal entities — not issued to sole traders. |
| name | Business name | The registered legal name of the business as returned from the source of truth. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. May not be present for all companies. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. May not be present for all companies. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `Sole trader with one owner`, `Private limited liability company (BV) with ordinary structure`). Defaults to `Unknown` when not available. |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). Defaults to `Unknown` when not available. |
| registrationDate | Date | The date the company was registered, as returned from the source of truth. May not be present for all companies. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `C`, `E`). Defaults to `Unknown` when not available. |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Moderate Risk`, `Not Rated`). |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Retail sale of motor vehicles`). |
| activityDesc | Activity description | The principal activity description as returned from the source of truth. For the Netherlands, this is typically identical to `industryDesc`. |
| turnover | `{currency, value}` object | The latest turnover figure as returned from the source of truth. May not be present for all companies. |
| employeeCount | String | The latest employee count as returned from the source of truth. Sourced from `additionalInformation.misc.employeeNumber`. Always returned as a string. May not be present for all companies. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. Typically absent for Dutch BV companies — Dutch shareholder registers commonly surface only an aggregate share capital figure, not named shareholders. |
| directors | Array of `{name, positionName, authority}` | Current directors and officers as returned from the source of truth. `positionName` and `authority` are returned in Dutch and are not translated (for example, `Algemeen Directeur`, `Alleen/zelfstandig bevoegd`). May not be present for all companies. |
| otherNames | Array of `{name, businessNameType}` | Trading names associated with the business. `businessNameType` is always `"Trading Name"`. May not be present for all companies. |
| otherAddresses | Array of `{type, otherAddress}` | Additional addresses on file, other than the primary registered address. May not be present for all companies. |
| websites | Array of strings | Website URLs associated with the business as returned from the source of truth. May not be present for all companies. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Netherlands Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match a supported Dutch identifier format:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Dutch identifier: KvK number (8 digits) or RSIN (9 digits)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [Single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/norway`
- URL: https://developer.incode.com/general-reference/norway/
- Markdown: https://developer.incode.com/general-reference/norway.md

# Norway
# Norway

Norway eKYC verification matches submitted individual data against Norway's source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                        | API source string   | Description                                                                     |
| ------------------------------ | -------------------- | -------------------------------------------------------------------------------- |
| Norway Consumer + Pop Register | `NO_CONS_POP_REG`    | Verifies submitted data against Norway's consumer and population register.       |

## Norway Consumer + Pop Register

### Request parameters

| Parameter     | Required  | Description                                                       |
| ------------- | --------- | -------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `NO_CONS_POP_REG`.                                            |
| `country`     | Mandatory | Must be `NO`.                                                         |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.               |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                |
| `dateOfBirth` | Mandatory | Format: `yyyy-mm-dd`.                                                 |
| `street`      | Optional  | Street name.                                                          |
| `houseNo`     | Optional  | House or building number.                                             |
| `city`        | Optional  | City of the individual's address (for example, `Oslo`).               |
| `postalCode`  | Optional  | Norway postal code. See format note below.                            |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                       |
| `phone`       | Optional  | Norway phone number. See format note below.                           |
| `email`       | Optional  | Email address of the individual.                                      |

:::info
`postalCode` must be exactly 4 digits, numeric only (no letters, spaces, or hyphens).

`phone` must be a Norway phone number consisting of 8 digits excluding the country code, submitted as `+47 XXX XX XXX` or `+47XXXXXXXX`.
:::

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "NO_CONS_POP_REG", //required field
    "firstName": "Lars", //required field
    "surName": "Johansen", //required field
    "street": "Bjørkeveien",
    "houseNo": "18",
    "city": "Oslo",
    "postalCode": "0484",
    "country": "NO", //required field
    "dateOfBirth": "1991-08-02", //required field
    "gender": "m",
    "phone": "+4741234567",
    "email": "lars.johansen@example.com"
}
```

### Response fields

Norway Consumer + Pop Register anchors verification on individual name, date of birth, address, phone, and email. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field                | Statuses                              | Description                                                                            |
| --------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------ |
| `firstNameMatch`     | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                 |
| `lastNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                  |
| `fullNameMatch`      | `exact`, `fuzzy`, `nomatch`           | Composite of `firstNameMatch` and `lastNameMatch`. `exact` if both match; `nomatch` if either does not match; otherwise `fuzzy`. |
| `dobMatch`           | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.              |
| `genderMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                     |
| `streetMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street submitted against the value in the source of truth.                     |
| `houseNoMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches house number submitted against the value in the source of truth.               |
| `streetAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch` and `houseNoMatch`. `exact` if both match; `nomatch` if either does not match; `nodata` if both have no data; otherwise `fuzzy`. |
| `cityMatch`          | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches city submitted against the value in the source of truth.                       |
| `postalCodeMatch`    | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches postal code submitted against the value in the source of truth.                |
| `fullAddressMatch`   | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite of `streetMatch`, `cityMatch`, and `postalCodeMatch`. See below for calculation logic. |
| `phoneMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches phone submitted against the value in the source of truth.                      |
| `emailMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches email submitted against the value in the source of truth.                      |
| `overallLevel`       | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                                   |





#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name, date of birth, and phone number:

- `low` when `fullNameMatch` is `exact` and either `dobMatch` or `phoneMatch` is also `exact`.
- `high` when `fullNameMatch`, `dobMatch`, and `phoneMatch` are all `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "houseNoMatch", "status": "exact" },
        { "key": "streetAddressMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/oauth2-secured-sessions`
- URL: https://developer.incode.com/general-reference/oauth2-secured-sessions/
- Markdown: https://developer.incode.com/general-reference/oauth2-secured-sessions.md

# OAuth2 Secured Sessions

OAuth2 Secured Sessions is a configurable setting in [Workflows](/dashboard-platform-administration/workflows-20/) and [Flows](/dashboard-platform-administration/flows-1/) that mitigates security risks associated with redirect-based webflows.

When enabled, the Workflow or Flow runs as part of an OAuth 2.0 / OpenID Connect (OIDC) authorization flow. The onboarding process itself serves as the authentication step. After the user completes onboarding successfully, the authorization server issues an authorization code.

When the **OAuth2 Secured** setting is enabled on a Workflow or Flow:

- A dedicated OIDC client is automatically generated. This OAuth client ID is visible in the Workflow or Flow settings after saving. The client is configured with:
  - Authorization Code grant
  - Proof Key for Code Exchange (PKCE) S256
- The Workflow or Flow execution is part of an OIDC authentication process
- A redirect URL becomes mandatory.
  - If you change this URL later, you must update it in the Workflow or Flow configuration and in all client authorize and token requests. Mismatches cause authorization failures.
- Disabling and re-enabling the setting regenerates the OAuth client and invalidates the previous one.

When a Workflow or Flow uses OAuth security, the legacy incodesmile.com URL scheme no longer works for that Flow ID. You must use the new URL scheme and authorization pattern described below. This prevents security gaps caused by manual URL tampering.

## Security Model

The generated OAuth client uses Proof Key for Code Exchange (PKCE) ([RFC 7636](https://www.rfc-editor.org/rfc/rfc7636.txt)) and does not require a client secret. This makes the secured session flow suitable for Single Page Applications (SPAs), mobile applications, or any client unable to securely store secrets.

PKCE protects the authorization code from interception by binding it to a cryptographically random verifier known only to the client.

## OpenID Connect (OIDC) Authorization Flow

The following diagram shows the sequence of a successful onboarding using OIDC:

![Sequence diagram showing a successful OIDC onboarding flow between client, authorization server, and Omni API](https://developer.incode.com/assets/cd744109a99270c1f5b6c23f89b6399f.png)

The following diagram shows the sequence of a failed onboarding using OIDC:

![Sequence diagram showing a failed OIDC onboarding flow with error response](https://developer.incode.com/assets/bb882966324df926bca1f58389f5138b.png)

### Step 1: Authorization Request (`/oauth2/authorize`)

Before initiating the authorization request, the client must:

1. Generate a cryptographically random `code_verifier` and store it

2. Compute the `code_challenge` by hashing the `code_verifier` with SHA-256

3. Generate a `state` parameter that is used for CSRF protection. The value should be:

   - Cryptographically random
   - High entropy (unguessable)
   - Unique per authorization request

   Store `state` in memory for SPAs, or in a secure session cookie or session-keyed in-memory cache for a Backend for Frontend (BFF) layer. For more detail, see [RFC 6749 §10.12](https://datatracker.ietf.org/doc/html/rfc6749#section-10.12).

4. Generate a `nonce` parameter to prevent ID token replay attacks. The value should be:&#x20;
   - High-entropy
   - Unique per authentication request
   - Same quality as state

     Store `nonce` the same way you store `state`. For more detail, see the [OIDC nonce notes](https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes).

The well-known endpoint for automatic discovery of configuration, endpoints, and key sets is at [https://auth.incode.com/.well-known/openid-configuration](https://auth.incode.com/.well-known/openid-configuration).

#### Authorization Request Parameters

| Parameter                              | Description                                                                             |
| :------------------------------------- | :-------------------------------------------------------------------------------------- |
| `client_id`                            | OAuth Client ID generated and stored in the Workflow/Flow settings.                     |
| `redirect_uri`                         | Redirect URI configured in the Workflow/Flow settings.                                  |
| `response_type`                        | `code`                                                                                  |
| `scope`                                | `openid`                                                                                |
| `state`                                | Opaque value used to maintain request/response integrity                                |
| `nonce`                                | Value used to associate the ID Token with the client session and prevent replay attacks |
| `code_challenge_method`                | `S256`                                                                                  |
| `code_challenge`                       | Generated PKCE challenge                                                                |
| `response_mode`                        | `form_post`                                                                             |
| `external_customer_id`<br />_Optional_ | ID that identifies user in clients external system                                      |

Example Authorization Request

```text Request
https://auth.incode.com/oauth2/authorize
?client_id={client_id}
&redirect_uri={redirect_uri}
&scope=openid
&response_type=code
&response_mode=form_post
&state={state}
&nonce={nonce}
&code_challenge_method=S256
&code_challenge={codeChallenge}
&external_customer_id={external_customer_id}
```

Here's what this request does:

- The user is redirected to the Incode authorization server.
- The associated Workflow or Flow runs as part of the `/authorize` endpoint.
- If onboarding succeeds:
  - The user is redirected back to `redirect_uri`.
  - An authorization code and `state` are returned in the URL.
  - The client must verify the `state` parameter on callback by comparing the returned value to the stored one. If it's missing or doesn't match, abort the process.
- If onboarding fails:
  - The user is redirected back to `redirect_uri`.
  - Error and error description parameters are included in the URL (see the [OIDC error spec](https://openid.net/specs/openid-connect-core-1_0.html#AuthError)).

### Step 2: Token Exchange (`/oauth2/token`)

The client exchanges the authorization code for tokens. Client authenticates using the `code_verifier` generated in [Step 1](/general-reference/oauth2-secured-sessions/#step-1-authorization-request-oauth2authorize).

#### Token Request Parameters

| Parameter       | Description                                                                                                                              |
| :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| `grant_type`    | `authorization_code`                                                                                                                     |
| `code`          | Authorization code from [Step 1](/general-reference/oauth2-secured-sessions/#step-1-authorization-request-oauth2authorize) |
| `client_id`     | Client ID used in the authorize request                                                                                                  |
| `redirect_uri`  | Redirect URI used in the authorize request                                                                                               |
| `code_verifier` | Original PKCE code verifier                                                                                                              |

#### Example Token Response Body

```json Response
{
  "access_token": "eyJraWQiOiI2MzM2NjAy....zAZ4-FboQg",
  "scope": "openid profile",
  "id_token": "eyJraWQiOiI2MzM2NjAyYy05....O3dDfO13Yyg",
  "token_type": "Bearer",
  "expires_in": 86399
}
```

After a successful response, client must validate ID token. Validation must confirm that:

- The issuer identifier exactly matches the `iss` claim.
- The `aud` claim contains the client's `client_id` value.
- The JWS signature is valid, using the algorithm in the JWT header and the public key from the issuer's well-known JWKS endpoint.
- The current time is before the `exp` claim.
- The `nonce` claim exactly matches the `nonce` value the client sent in the authentication request.

Access token validation is the responsibility of the Omni server, and happens in [Step 3](/general-reference/oauth2-secured-sessions/#step-3-api-access).

### Step 3: API Access

Use the `access_token` from [Step 2](/general-reference/oauth2-secured-sessions/#step-2-token-exchange-oauth2token) as a Bearer token in the `Authorization` header instead of the `x-incode-hardware-id` header. The token:

- Is required to access Omni APIs
- Is bound to a single session
- Follows standard OAuth 2.0 token validation rules

#### Example curl request with OAuth Secured Workflows/Flows

```curl curl request
curl --location 'https://saas-api.incodesmile.com/omni/get/score' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: 13cf313e0db1507e77bf8d0631f3ca736173ccde' \
--header 'Authorization: Bearer eyJraWQiOiI2MzM2Nj.....Lf_N7hww'
```

You can use this token with the following endpoints:

- `omni/get/score`
- `omni/get/custom-fields`
- `omni/get/onboarding/status`
- `omni/get/ocr-data`

<br />

---

- Path: `general-reference/onboarding-status-webhook`
- URL: https://developer.incode.com/general-reference/onboarding-status-webhook/
- Markdown: https://developer.incode.com/general-reference/onboarding-status-webhook.md

# Onboarding status  webhook

The Onboarding Status Webhook sends notifications to your specified server URL in real time when a module completes and thus the onboarding status changes. These notifications indicate the current state of the onboarding interview.

Depending on the number of modules in the session Flow or Workflow, this could be more notifications than you need or want. If you only want notification for a specific event, [session webhooks](/general-reference/session-webhooks/) may be a better fit for your needs. You can configure a session webhook for each of these statuses: `Session_Started`, `Session_Failed`, `Session_Succeeded`, and `Session_Pending_Review`. Each webhook triggers for only the single session event noted.

## Onboarding Statuses

Onboarding statuses occur sequentially and describe the processing state of the interview. See below for a description of each status and the order in which it occurs.

1. `UNKNOWN`:
   1. A session has a status of unknown when it has not been started by the user. For example, this could happen when an onboarding URL is shared with a customer, but the customer has not yet clicked the link to begin the session. **You will not receive a webhook notification for unknown status. This status can be determined by calling the endpoint [get session status](/api-reference/session-status-get)** .
2. `ID_VALIDATION_FINISHED`
   1. For Webflows and Workflows that perform ID validation, the `ID_VALIDATION_FINISHED` webhook indicates that the processes for the ID validation modules are complete. Although the overall session data is not complete at this point, it is possible to fetch some elements, such as the OCR data and ID validation score.
3. `ID_VALIDATION_FINISHED_SECOND_ID`
   1. For Webflows and Workflows that perform ID validation, the `ID_VALIDATION_FINISHED_SECOND_ID` webhook indicates that the processes for the second ID validation modules are complete (If applicable). Although the overall session data is not complete at this point, it is possible to fetch some elements, such as the OCR data and ID validation score.
4. `GOVERNMENT_VALIDATION_FINISHED`
   1. Government validation occurs after ID validation and indicates that the tests associated with government validation are complete. Similarly to `ID_VALIDATION_FINISHED`, once the `GOVERNMENT_VALIDATION_FINISHED `notification is received, preliminary results can be fetched via the API. While this is possible, we recommend waiting until the `ONBOARDING_FINISHED` notification is received to ensure that all results are finalized.
5. `FACE_VALIDATION_FINISHED`
   1. Face validation requires two images for comparison. The first comparison image is taken from the ID portrait photo during the ID validation process and the second comparison photo is acquired from the selfie capture process. As a result, face validation occurs after ID validation and the selfie capture process. If government validation is part of the flow, the `FACE_VALIDATION_FINISHED` notification will generally occur subsequently to `GOVERNMENT_VALIDATION_FINISHED`.
6. `POST_PROCESSING_FINISHED`
   1. Post processing indicates that all collected raw interview data is done processing.
7. `POST_PROCESSING_FINISHED_SECOND_ID`
   1. Post processing indicates that all collected raw interview data is done processing for the second ID (if applicable).
8. `ONBOARDING_FINISHED`
   1. The `ONBOARDING_FINISHED` notification indicates that all data has been collected and processed, any custom business rules have been applied, the session status has been updated to its final determination, and the user has exited the flow. We recommend waiting for this status before fetching session data.
9. `MANUAL_REVIEW_APPROVED`
   1. This notification occurs after `ONBOARDING_FINISHED` once a session with a `MANUAL` status is reviewed and manually approved through the Incode dashboard. This will occur subsequent to an `ONBOARDING_FINISHED` notification.
10. `MANUAL_REVIEW_REJECTED`
    1. This notification occurs after `ONBOARDING_FINISHED` once a session with a `MANUAL` status is reviewed and manually rejected through the Incode dashboard. This will occur subsequent to an `ONBOARDING_FINISHED` notification.
11. `EXPIRED`
    1. This notification occurs when an expired time limit is set on a flow configuration and the user surpasses the expiration time limit by abandoning the session. When the user returns to an expired session, it will display a session expiration screen.
12. `DELETED`
    1. This notification occurs when a session's data has been deleted. Take into account that sessions might not be deleted instantly, since data deletion is placed in a queue. This webhook will contain a field `interviewIds` instead of `interviewId`. The field is a string array with 1 or more interview IDs which have just been deleted.

## Endpoint Details

`POST https://{your-defined-url}`

### Request

Below is an example of the payload that you will get when the webhook triggers

```json Sample request payload
{
  "clientId": "MyClientId001",
  "flowId": "66969519eb1d789a96347ca7",
  "interviewId": "664283755e0f8e1b87fcc2ce",
  "externalCustomerId": "MyCustomerID#0001", // only if an externalCustomerId was specified on the omni/start endpoint
  "onboardingStatus": "ONBOARDING_FINISHED" // see above for possible values
}
```

If you are [authenticating your webhook requests](/general-reference/authorizing-webhooks-requests/) , the webhook will contain the `Authorization` header along with the OAuth2.0 bearer token:

`Authorization: Bearer <ACCESS_TOKEN>`

If you configured additional custom headers, they will be included as well.

### Response

To avoid our [retry policy](/general-reference/webhooks-overview/#retry-policy) to keep sending the same notification over and over, make sure your endpoint returns one of the following:

* Status code `204 No content`
* Status code `200 OK` with a response type `application/json`, for example `{ "success" : true }`

```json Sample response
{
	"success" : true 
}
```

---

- Path: `general-reference/payment-proof-webhook`
- URL: https://developer.incode.com/general-reference/payment-proof-webhook/
- Markdown: https://developer.incode.com/general-reference/payment-proof-webhook.md

# Proof of payment webhook

For customers in Mexico that need to verify documents such as utility bills, the payment proof webhook provides the payment proof data as soon as all asynchronous processes are complete and the data is available. This webhook is the recommended method for receiving payment proof data.

## Triggering the Payment Proof Webhook

In order to trigger the payment proof webhook, the following API endpoints must be called in order:

1. First create a flow and call the [Start onboarding](https://developer.incode.com/api-reference/start/) endpoint.
2. Call the `omni/add/qr-code-text` endpoint. You can find additional documentation API docs [here](https://developer.incode.com/api-reference/add-qr-code-text/). This will add the QR code text as a custom field to the session started in step #1. Below is an example cURL request.
3. Lastly, call the `omni/process/payment-proof` [endpoint](https://developer.incode.com/api-reference/process-payment-proof/). Once processing is complete a webhook containing the payment proof data will be sent the URL specified in the configuration tab of the dashboard. If you haven't configured your callback URL yet, see the our webhook introduction [page](/general-reference/webhooks-overview/). Below is an example cURL request.
   ```
   curl --location --request POST 'https://demo-api.incodesmile.com/omni/process/payment-proof' \
   --header 'Accept: application/json' \
   --header 'Content-Type: application/json' \
   --header 'api-version: 1.0' \
   --header 'x-api-key: YOUR API KEY' \
   --header 'X-Incode-Hardware-Id: YOUR SESSION TOKEN' \
   --data ''
   ```

## Endpoint Details

`POST https://{your-defined-url}`

### Request

Below is an example of the payload that you will get when the webhook triggers

```json Sample request payload
{
  "requestId": "cba1e997-sbaf-1234-abc5-n456bb2343c3",
  "rfcIssuer": "SLI1234567",
  "issuerName": "SOME ISSUER NAME",
  "rfcReceiver": "MP1231231",
  "receiverName": "SOME CLIENT NAME",
  "fiscalInvoice": "SOME FISCAL INVOICE ID",
  "issueDate": "2025-06-19T12:33:20",
  "certificationDate": "2025-06-19T12:33:20",
  "rfcPac": "MBS42143234",
  "totalCfdi": "$1,962.36",
  "voucherEffect": "Nómina",
  "cancellationStatus": "Cancelable sin aceptación",
  "validationCode": "fc413452345.34563",
  "status": "OK"
}
```

If you are [authenticating your webhook requests](/general-reference/authorizing-webhooks-requests/), the webhook will contain the `Authorization` header along with the OAuth2.0 bearer token:

`Authorization: Bearer <ACCESS_TOKEN>`

If you configured additional custom headers, they will be included as well.

### Response

To avoid our [retry policy](/general-reference/webhooks-overview/#retry-policy) to keep sending the same notification over and over, make sure your endpoint returns one of the following:

* Status code `204 No content`
* Status code `200 OK` with a response type `application/json`, for example `{ "success" : true }`

```json Sample response
{
   "success" : true 
}
```

---

- Path: `general-reference/peru`
- URL: https://developer.incode.com/general-reference/peru/
- Markdown: https://developer.incode.com/general-reference/peru.md

# Peru
Peru eKYC verification matches submitted individual data against Peru's official civil register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                | API source string      | Description                                                              |
| ---------------------- | ------------------------ | --------------------------------------------------------------------------- |
| Peru Civil Register 2  | `PE_CIVIL_REGISTER_2`    | Verifies submitted data against Peru's official civil register.             |

## Peru Civil Register 2

### Request parameters

| Parameter     | Required  | Description                                                                    |
| ------------- | --------- | ------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `PE_CIVIL_REGISTER_2`.                                                   |
| `country`     | Mandatory | Must be `PE`.                                                                    |
| `idNumber`    | Mandatory | Peru DNI (Documento Nacional de Identidad). See format note below.              |
| `firstName`   | Mandatory | First name of the individual. Must not contain digits.                          |
| `surName`     | Mandatory | Last name of the individual. Must not contain digits.                           |
| `middleName`  | Optional  | Middle name of the individual. Must not contain digits.                         |
| `street`      | Optional  | Full street including house number.                                             |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                           |
| `gender`      | Optional  | Accepted values are `m` or `f`.                                                 |



### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "PE_CIVIL_REGISTER_2", //required field
    "firstName": "Carlos", //required field
    "middleName": "Eduardo",
    "surName": "García", //required field
    "street": "Av. Arequipa 1234",
    "idNumber": "76543218", //required field
    "country": "PE", //required field
    "dateOfBirth": "1991-08-02",
    "gender": "m"
}
```

### Response fields

Peru Civil Register 2 anchors verification on the submitted national identity number and full name. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field              | Statuses                              | Description                                                                             |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------- |
| `firstNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.                  |
| `middleNameMatch`  | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth.                 |
| `lastNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.                   |
| `fullNameMatch`    | `exact`, `fuzzy`, `nomatch`           | Composite of `firstNameMatch`, `lastNameMatch`, and `middleNameMatch`. See below for calculation logic. |
| `dobMatch`         | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth.               |
| `streetMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street submitted against the value in the source of truth.                      |
| `genderMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth.                      |
| `idNumMatch`       | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches national identity number submitted against the value in the source of truth.    |
| `overallLevel`     | `low`, `medium`, `high`                | Overall risk level. See below for calculation logic.                                    |



#### `overallLevel` calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and national identity number:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` or `idNumMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/portugal`
- URL: https://developer.incode.com/general-reference/portugal/
- Markdown: https://developer.incode.com/general-reference/portugal.md

# Portugal

eKYB Prefill in Portugal leverages Portugal's source of truth to automatically retrieve and populate business information based on a company's NIF, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Portugal | `PT_KYB_PREFILL` | Returns matching Portuguese business details from Portugal's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `PT_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `PT`. |
| `taxId` | Mandatory | String. NIF (Número de Identificação Fiscal). See [Tax ID formats](#tax-id-formats) for details. |
| `businessName` | Optional | String. Registered business name, used to verify the match against the source of truth. |
| `address` | Optional | String. Business address, used to verify the match against the source of truth. |

### Tax ID formats

The NIF (Número de Identificação Fiscal) is the Portuguese tax identifier. It serves as both the company registration number and the VAT number — no separate VAT identifier exists for Portugal. Requests with an invalid format return a 400 error.

| Entity Type | Format |
| --- | --- |
| NIF | 9 numeric digits (e.g. `123456789`) |

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "PT_KYB_PREFILL",
    "country": "PT",
    "taxId": "123456789",
    "businessName": "",
    "address": ""
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (`nameMatch`, `addressMatch`) are only returned when the corresponding input (`businessName`, `address`) was submitted. Field availability varies by entity type and size — see the notes under each example below.

**Example 1 — large public company (no group structure)**

```json
{
    "kyb-prefill": [
        {
            "tin": "123456789",
            "vatNo": "123456789",
            "name": "SAMPLE ENERGY SA",
            "nameMatch": "Verified",
            "address": "Av. Sample, nº 12, 1000-000, LISBOA, LISBOA",
            "city": "LISBOA",
            "postalCode": "1000-000",
            "entityType": "Joint Stock Company",
            "registrationStatus": "Active",
            "registrationDate": "1991-01-22T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Activities of corporate headquarters",
            "activityDesc": "Activities of corporate headquarters",
            "turnover": { "currency": "EUR", "value": 326830000 },
            "employeeCount": "617",
            "websites": ["http://www.sampleenergy.example"],
            "shareholders": [
                { "name": "EXAMPLE CAPITAL INC", "percentSharesHeld": 8.35 },
                { "name": "SAMPLE HOLDINGS GROUP", "percentSharesHeld": 22.2 }
            ],
            "directors": [
                { "name": "MARIA SAMPLE SILVA", "positionName": "Board of Director's President" }
            ]
        }
    ]
}
```

*(`ultimateParent`/`immediateParent` omitted — this entity sits at the top of its own group.)*

**Example 2 — small company with a parent (no directors)**

```json
{
    "kyb-prefill": [
        {
            "tin": "987654321",
            "vatNo": "987654321",
            "name": "SAMPLE DREAM FACTORY LDA",
            "nameMatch": "Verified",
            "address": "Rua Sample, nº 41, 4000-000, VALONGO, PORTO",
            "city": "VALONGO",
            "postalCode": "4000-000",
            "entityType": "Private Limited Company",
            "registrationStatus": "Active",
            "registrationDate": "2009-07-16T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Web search portal activities",
            "activityDesc": "Web search portal activities",
            "turnover": { "currency": "EUR", "value": 227214 },
            "employeeCount": "2",
            "websites": ["http://www.sampledreamfactory.example"],
            "shareholders": [
                { "name": "EXAMPLE EVENTOS LDA", "percentSharesHeld": 5 },
                { "name": "SAMPLE NETWORK LDA", "percentSharesHeld": 71 },
                { "name": "EXAMPLE HOLDING LDA", "percentSharesHeld": 24 }
            ],
            "ultimateParent": { "name": "SAMPLE NETWORK LDA", "country": "PT" },
            "immediateParent": { "name": "SAMPLE NETWORK LDA", "country": "PT" },
            "otherAddresses": [
                { "otherAddress": "Rua Sample, nº 41 4000-000" },
                { "otherAddress": "RUA EXAMPLE JUNQUEIRO, 495, 1º, SALA E 4100-000" }
            ]
        }
    ]
}
```



**Example 3 — small, single-owner company**

```json
{
    "kyb-prefill": [
        {
            "tin": "456789123",
            "vatNo": "456789123",
            "name": "SAMPLE INOVACAO AMBIENTAL LDA",
            "nameMatch": "Verified",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Other physical and natural science research and development",
            "activityDesc": "Other physical and natural science research and development",
            "turnover": { "currency": "EUR", "value": 449780 },
            "employeeCount": "5",
            "websites": ["http://www.sampleinovamb.example"],
            "shareholders": [
                { "name": "SAMPLE INVESTIMENTOS SGPS SA", "percentSharesHeld": 100 }
            ],
            "directors": [
                { "name": "JOAO SAMPLE ROQUE", "positionName": "Manager" }
            ]
        }
    ]
}
```

> **Info**
> Field availability differs across companies, regardless of entity type or size. `directors`, `shareholders`, `ultimateParent`, `immediateParent`, `city`, `postalCode`, `otherAddresses`, and `websites` may all be absent for a given company — this is expected and does not indicate an error.

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `tin` | NIF | Company registration number, as returned from the source of truth. |
| `vatNo` | NIF | The VAT registration number. Identical to `tin` for Portugal, since the NIF serves both purposes. |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name. Only returned when `businessName` is submitted. |
| `address` | Address | The registered business address as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address. Only returned when `address` is submitted. |
| `city` | City | The city associated with the registered business address, when available. |
| `postalCode` | Postal code | The postal code associated with the registered business address, when available. |
| `entityType` | Entity type | The legal entity type of the business (e.g. Joint Stock Company, Private Limited Company). Defaults to "Unknown" when not available. |
| `registrationStatus` | Active, Expired, Unknown, Not Found | Current registration status of the business. Defaults to "Unknown" when not available. |
| `registrationDate` | Date | The date the business was registered. May not be available for all entities. |
| `creditRating` | Rating value (e.g. A, C) | The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available. |
| `creditRatingDescription` | Description (e.g. Very Low Risk) | Human-readable description of the credit rating. Defaults to "Unknown" when not available. |
| `industryDesc` | Industry description | Description of the business's main activity. |
| `activityDesc` | Activity description | Description of the business's principal activity. Identical to `industryDesc` for Portugal. |
| `turnover` | `{currency, value}` object | The business's latest reported turnover figure. |
| `employeeCount` | Number (as string) | Latest reported number of employees, if available. |
| `websites` | Array of strings | Websites associated with the business, if available. |
| `otherAddresses` | Array of `{otherAddress}` | Addresses associated with the business other than the main registered address, if any. No `type` label is provided in the source data for Portugal. |
| `shareholders` | Array of `{name, percentSharesHeld}` | Shareholder information, if available. |
| `directors` | Array of `{name, positionName}` | Directors associated with the business, if available. |
| `ultimateParent` | `{name, country}` | The business's ultimate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |
| `immediateParent` | `{name, country}` | The business's immediate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Portugal Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or not a 9-digit NIF:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Portuguese NIF: 9 numeric digits",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```
No business match is found for the submitted taxId:
```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}`
```








## Single Session Dashboard results

Prefill results are available on the **Business** tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/rate-limits`
- URL: https://developer.incode.com/general-reference/rate-limits/
- Markdown: https://developer.incode.com/general-reference/rate-limits.md

# API Rate Limits

The Incode Omni API uses a token bucket algorithm to enforce rate limits. It's important to understand how limits work and how to handle them gracefully. This will help you build integrations that stay within bounds under normal conditions. It will also help you recover cleanly when limits are reached.

## How Rate Limiting Works

Each API endpoint belongs to one of three categories. Each category has its own independent token bucket. When you make a request, one token is consumed from that category's bucket. If the bucket is empty, the request is rejected with a `429 Too Many Requests` response.

Buckets refill automatically at a fixed rate (`maxRps`) up to their maximum capacity (`burst`). The burst value defines the maximum number of requests you can make in a single second before the bucket empties.

## Endpoint Categories and Limits

| Category | Endpoints | maxRps | Burst |
| :--- | :--- | :--- | :--- |
| `SUPER_HEAVY` | ID capture and processing (`add/front`, `add/back`, `process/id`) | 1 req/sec | 5 |
| `HEAVY` | Face capture and processing (`add/face`, `process/face`) | 1 req/sec | 5 |
| `OTHER` | All other endpoints | 100 req/sec | 50 |

<Note title="Category assignment">
The category for a given endpoint is fixed. You cannot move endpoints between categories or configure per-endpoint limits. For special cases where the default limits are insufficient, contact your Incode Customer Success representative.
</Note>

## Reading a Rate Limit Example

The `SUPER_HEAVY` bucket has a burst capacity of 5. If you send 5 requests to `add/front` within the same second, the bucket empties and any additional requests within that second return `429 Too Many Requests`. The bucket then refills at 1 token per second until it reaches capacity again.

In practice, a typical onboarding session might call `add/front`, `add/back`, and `process/id` sequentially. Thus, a single session's document capture flow consumes 3 tokens. The burst capacity of 5 accommodates a small amount of concurrent sessions. High-volume production traffic will approach limits in the `SUPER_HEAVY` category more quickly than in `OTHER`.

## Handling 429 Responses

When your integration receives a `429` response, do not retry immediately. Implement an exponential backoff strategy:

1. On the first `429`, wait before retrying.
2. Double the wait time on each subsequent retry.
3. Add a small random jitter to prevent synchronized retries across concurrent requests.
4. Set a maximum retry count or total wait time to avoid indefinite loops.

```javascript
async function requestWithBackoff(fn, maxRetries = 4) {
  let delay = 1000; {/* start with 1 second */}
  for (let attempt = 0; attempt <= maxRetries; attempt++) {
    try {
      return await fn();
    } catch (err) {
      if (err.status !== 429 || attempt === maxRetries) throw err;
      const jitter = Math.random() * 500;
      await new Promise(res => setTimeout(res, delay + jitter));
      delay *= 2;
    }
  }
}
```


## Request and Response Size Limits

Two additional constraints apply regardless of rate category:

- **Maximum request/response size:** 10 MB. Images and files larger than 10 MB cannot be uploaded or retrieved.
- **Request timeout:** 30 seconds. Any request that exceeds this limit returns a timeout error.

---

- Path: `general-reference/reference-section`
- URL: https://developer.incode.com/general-reference/
- Markdown: https://developer.incode.com/general-reference.md

# General Reference

This section answers quick, standalone questions that come up across integrations: what Incode supports, what a code or status means, and how a session or session type behaves. It's built for both developers and business users, and it's meant to be searched rather than read start to finish. For deeper implementation detail, see the Helpful Links below.

## Coverage and Compatibility

These pages help you confirm whether Incode supports a country, ID type, language, or system before you build against it:

- [Incode Coverage Hub](/general-reference/coverage-hub/): A starting point for geographic coverage, linking out to the specific reference pages below.
- [Supported Languages](/general-reference/supported-languages/): The languages available across Incode's SDKs and dashboard experiences.
- [Supported IDs](/general-reference/supported-ids/): ID document types Incode can process, by country.
- [Supported Digital IDs](/general-reference/supported-digital-ids/): Digital ID formats and issuing authorities Incode supports, by region.
- [System of Records Verification](/general-reference/government-verification-sources/): Government and third-party systems of record available for identity verification, by country.

## Errors and Troubleshooting

Use this group when something failed and you need to know what a code or message means.

- [API Error Codes](/general-reference/api-error-codes/): Consolidated list of API error codes and their meanings.
- [SDK Error Handling](/general-reference/sdk-error-handling/): Common SDK-level errors and how to handle them in your integration.

## Sessions, Limits, and Security

Use this group to understand session behavior, request limits, and authentication requirements.

- [Incode Session Statuses](/general-reference/session-statuses/): The full list of session statuses and what each one means.
- [API Rate Limits](/general-reference/rate-limits/): Request limits by endpoint and plan.
- [OAuth2 Secured Sessions](/general-reference/oauth2-secured-sessions/): How OAuth2 authentication applies to session security.

## Webhooks

- [Incode Webhooks](/general-reference/webhooks-overview/): Catalog of webhook events for onboarding, session status changes, and authentication, with payload details for each.

## eKYB Reference

- [eKYB Reference](/general-reference/ekyb-verification-api-reference): Country coverage, response fields, and country-specific detail for eKYB verification.

## eKYC Reference

- [eKYC Reference](/general-reference/ekyc-reference/): Reason codes and explanations specific to eKYC customers.

## Module and Integration References

Specialized references for specific modules and integration patterns.

- [Fetching Crosscheck Results](/general-reference/fetching-crosscheck-results/): How to fetch and read Cross Check comparison results via API.
- [Accessibility Manifest](/general-reference/accessibility): Accessibility conformance information for Incode SDKs and dashboard experiences.

## Helpful Links

The following pages and sections contain more specialized reference information:

- API Reference section, linked at the top of each page
- [SDK Reference section](/sdk-reference/sdk-reference/), linked in the left navigation menu
- [Incode Glossary](/get-started-with-incode/glossary/)

---

- Path: `general-reference/saudi-arabia`
- URL: https://developer.incode.com/general-reference/saudi-arabia/
- Markdown: https://developer.incode.com/general-reference/saudi-arabia.md

eKYB Prefill in Saudi Arabia leverages official Saudi business registry data to automatically retrieve and populate business information based on a company's registration number, including the business name, registration status, entity type, registration date, incorporation date, and registered address, without requiring manual input from the user.



## Source

| Source | Description |
| --- | --- |
| `SA_KYB_PREFILL` | Returns matching Saudi Arabia business details from official business registry data for prefill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).



### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `SA_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `SA`. |
| taxId | Mandatory | String. Saudi Commercial Registration (CR) number. Must be a 10-digit numeric value. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, may improve match accuracy. |

### Tax ID formats

For businesses, the following identifier types are supported, all as 10-digit numeric values:

| Format | Example |
| --- | --- |
| Commercial Registration (CR) number | `1010223344` |
| License number | `2050112233` |
| Tax number | `3001998877` |

For individuals, the supported identifier is:

| Format | Example |
| --- | --- |
| National ID number | `1098765432` |

:::note 
The Saudi Commercial Registration (CR) number must be a 10-digit numeric value (regex: `^\d{10}$`). Requests with a `taxId` that does not match this format will be rejected. Business name and address data may be returned in Arabic script.
:::

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "SA_KYB_PREFILL",
    "country": "SA",
    "taxId": "1010223344",
    "businessName": "Al Noor Trading Company"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source.



```json
{
  "kyb-prefill": [
    {
      "tin": "1010223344",
      "name": "AL NOOR TRADING COMPANY",
      "registrationStatus": "Active",
      "entityType": "Unknown",
      "registrationDate": "2019-03-11",
      "incorporationDate": "2005-07-02",
      "address": "RIYADH, AL OLAYA DISTRICT, RIYADH, SA-01, SAUDI ARABIA, 12212",
      "email": null,
      "phoneNumber": null
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | Registration number | The Saudi CR/tax/license number as submitted in the request, confirmed by the source of truth. |
| name | Business name | The registered legal name of the business as returned from the source of truth. Names originally in Arabic are automatically translated to English. |
| registrationStatus | Active, Inactive, Unknown | Current registration status of the business. See Registration status values for details. |
| entityType | Entity type | The legal entity type of the business as returned from the source of truth. Returns `Unknown` when not available. |
| registrationDate | Date | The date the company was registered in the source registry, as returned from the source of truth. May not be present for all companies. |
| incorporationDate | Date | The date the company was incorporated, as returned from the source of truth. Falls back to an alternate source field when the primary field is not available. May not be present for all companies. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. Addresses originally in Arabic are automatically translated to English. May not be present for all companies. |
| email | Email address | The business contact email address registered with the source of truth, if available. |
| phoneNumber | Phone number | The business contact phone number registered with the source of truth, if available. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved or inactive. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Saudi Arabia Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match the required 10-digit format:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, or `country`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/sdk-error-handling`
- URL: https://developer.incode.com/general-reference/sdk-error-handling/
- Markdown: https://developer.incode.com/general-reference/sdk-error-handling.md

# SDK Error Handling


Incode SDKs surface errors differently from the Omni API. Rather than HTTP status codes, SDK errors appear as typed values delivered through callbacks, delegate methods, or state machine transitions — depending on the platform and integration path.

This page covers error handling for the Web SDK 2.0, iOS SDK, and Android SDK. For API error codes, see [API Error Codes](/general-reference/api-error-codes/).

***

## Error Handling Model by Platform

Before diving into platform specifics, it helps to understand the structural difference between how each SDK surfaces errors:

| Platform        | Fatal flow errors                                               | Module-level errors                                   | Configuration errors                               |
| --------------- | --------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------- |
| **Web SDK 2.0** | `error` state on manager; `onError` callback on `<incode-flow>` | `captureStatus === 'uploadError'` on capture managers | Thrown at runtime for unrecognized workflow steps  |
| **iOS**         | `onError(_ error: IncdFlowError)` delegate method               | Per-module result error enums (e.g. `NFCScanError`)   | Runtime. No dedicated configuration exception      |
| **Android**     | `onError(error: Throwable)` listener method                     | `resultCode` on module result objects                 | `ModuleConfigurationException` thrown at `build()` |

***

## Web SDK 2.0

The Web SDK 2.0 uses a state machine model. Every manager exposes an `error` terminal state, and the `<incode-flow>` component surfaces fatal errors via a callback.

### Fatal Errors

**Headless managers** (Phone, Email, Selfie, ID Capture, Workflow, Orchestrated Flow) all share the same `error` state shape:

```typescript
// Subscribe to state changes on any manager
manager.subscribe((state) => {
  if (state.status === 'error') {
    console.error('Fatal error:', state.error);
    // state.error is a string describing the failure
  }
});
```

`<incode-flow>`**&#x20;component** surfaces fatal errors via its `onError` callback:

```typescript
flow.onError = (error: string | undefined, errorCode?: number) => {
  console.error('Flow error:', error, errorCode);
};
```


| Property    | Type                  | Description                                                                              |
| ----------- | --------------------- | ---------------------------------------------------------------------------------------- |
| `error`     | `string \| undefined` | Human-readable description of the error                                                  |
| `errorCode` | `number` (optional)   | Numeric error code providing additional detail. See review note 1 for documentation gap. |

The **Workflow manager** error state also includes an optional `errorCode`:

```typescript
// WorkflowState when status === 'error'
{ status: 'error', error: string, errorCode?: number }
```

### Capture Errors

During active capture, errors surface as sub-state properties rather than as a separate `error` state. These are inline failures the user can retry, not fatal flow terminations.

**Selfie and ID Capture managers** — when `captureStatus === 'uploadError'`:

| Property                 | Type      | Description                               |
| ------------------------ | --------- | ----------------------------------------- |
| `uploadError`            | `string?` | Error code identifying the upload failure |
| `uploadErrorMessage`     | `string?` | Human-readable error message              |
| `uploadErrorDescription` | `string?` | Detailed error description                |

Retry is available when `canRetry === true`. Call `manager.retryCapture()` to retry.

### Camera Permission Errors

When `status === 'permissions'` and `permissionStatus === 'denied'`, the user has denied camera access. This is not a fatal error. Prompt the user to enable camera permissions in their browser settings, then call `manager.requestPermission()` again.

### Unrecognized Workflow Steps (Headless Mode Only)

In headless mode using `createOrchestratedFlowManager`, if the workflow returns a step whose module key is not registered, the manager throws:

```
"No registered module found for: <KEY>"
```

This does not apply to the `<incode-flow>` component, which renders a fallback "Module not available" screen and advances the flow automatically.

***

## iOS SDK

The iOS SDK uses a delegate pattern. Fatal flow errors are delivered to a single `onError` method on `IncdOnboardingDelegate`, while module-level errors are returned as typed enum values within each module's result struct.

### Fatal Flow Errors

All fatal errors during an onboarding flow are delivered via:

```swift
func onError(_ error: IncdFlowError) {
    // Handle fatal flow error
}
```

The documented `IncdFlowError` cases are:

| Case                     | Description                                                                                                                                               |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `.interrupted`           | The flow was interrupted programmatically via `forceInterrupt()` or `dismiss(forceInterrupt: true)`.                                                      |
| `.apiKeyRevoked(apiKey)` | The API key used to initialize the SDK was revoked mid-session. The associated value contains the revoked key. Use this case to trigger API key rotation. |


:::info
When `.apiKeyRevoked` is received, reinitialize the SDK with a new API key using `IncdOnboardingManager.shared.initIncdOnboarding(url:apiKey:)`, then restart or resume the session. See [API Key Rotation](/sdk-reference/ios-api-key-rotation) for full details.
:::

### Handling Programmatic Interruption

To force-stop the current flow:

```swift
// Attempt to mark session as finished, then trigger onError(.interrupted)
IncdOnboardingManager.shared.forceInterrupt(tryFinishingFlow: true) { success, error in
    // Cleanup complete
}

// Or dismiss without finishing:
IncdOnboardingManager.shared.dismiss(forceInterrupt: true)
```

### Module Result Errors

Each module callback returns a result struct that includes an error property. Errors here indicate a module-level failure, not necessarily a fatal flow error.

#### AES (Advanced Electronic Signature)

```swift
func onAesCompleted(_ result: AESResult) {
    if let error = result.error {
        // Handle AES error
    }
}
```

`AESError` values:

| Value           | Description                                                    |
| --------------- | -------------------------------------------------------------- |
| `.noDocuments`  | No documents are available for the current onboarding session. |
| `.failedToSign` | The AES signing operation failed.                              |

#### NFC Scan

```swift
func onNFCScanCompleted(_ result: NFCScanResult) {
    if let error = result.error {
        // Handle NFC error
    }
}
```

`NFCScanError` values:

| Value                      | Description                                                                                    |
| -------------------------- | ---------------------------------------------------------------------------------------------- |
| `.error(IncdError)`        | An underlying SDK error occurred. The associated `IncdError` value provides additional detail. |
| `.notAvailable`            | NFC scanning is not available on this device.                                                  |
| `.userDocumentHasNoChip`   | The user indicated their document does not have an NFC chip.                                   |
| `.noScanAttemptsRemaining` | The user exhausted all NFC scan attempts without success.                                      |


#### Face Login/Selfie Scan

Face login results include a `SelfieScanError` in the `error` property of `SelfieScanResult`. Spoof detection is surfaced separately via the `spoofAttempt` boolean:

```swift
IncdOnboardingManager.shared.startFaceLogin() { result in
    if let error = result.error {
        // A SelfieScanError occurred
    }
    if result.spoofAttempt == true {
        // Liveness check failed — spoof detected
    }
}
```


### On-Demand Resources Error

If you are using On-Demand Resources (ODR) and call an onboarding method before the resources have been downloaded, the method returns a `.resourcesNotFound` error. Always call `downloadOnDemandResources()` and wait for `onCompleted` before starting any onboarding modules.

### Simulator Behavior

On iOS Simulator, modules that require the camera (`ID Scan`, `Selfie Scan`, `Video Selfie`, and others) show a black screen for 2 seconds, then return `.simulatorDetected` and advance to the next module. Ensure `testMode: true` is set during initialization when running on Simulator.

***

## Android SDK

The Android SDK uses a listener pattern. Fatal errors are delivered as `Throwable` objects to `onError()` on `OnboardingListener`. Module results carry a `ResultCode` indicating the outcome.

### Fatal Flow Errors

```kotlin
override fun onError(error: Throwable) {
    // Fatal flow error — log error.message for details
    IncodeWelcome.getInstance().deleteUserLocalData()
}
```

```java
@Override
public void onError(@NonNull Throwable error) {
    // Fatal flow error — log error.getMessage() for details
    IncodeWelcome.getInstance().deleteUserLocalData();
}
```

:::warning
Always call `IncodeWelcome.getInstance().deleteUserLocalData()` in `onError()`, `onSuccess()`, and `onUserCancelled()` to ensure local session data is cleaned up regardless of how the flow exits.
:::

Unlike the iOS SDK, Android does not use a typed error enum for fatal flow errors. The `Throwable` message is the primary source of diagnostic information.

### Module Result Codes

Every module result object includes a `resultCode` property of type `ResultCode`. This indicates the high-level outcome of the module:

| Value               | Description                                                                                                                                                            |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SUCCESS`           | The module completed successfully.                                                                                                                                     |
| `ERROR`             | The module encountered an error. Check the result object for additional details.                                                                                       |
| `USER_CANCELLED`    | The user cancelled the module.                                                                                                                                         |
| `EMULATOR_DETECTED` | The module was running on an emulator. After a 2-second delay, the module returns this code automatically. Remove `setTestModeEnabled(true)` before production builds. |

For `ID Scan` specifically, emulator detection is returned as `IdResults.RESULT_EMULATOR_DETECTED` on the `frontIdResult` and `backIdResult` properties rather than via `ResultCode`.

### Configuration Errors

`FlowConfig.Builder.build()` throws `ModuleConfigurationException` synchronously if the flow configuration violates module rules; for example, if mandatory modules are omitted or ordering dependencies are violated. Catch this at build time:

```kotlin
try {
    val flowConfig = FlowConfig.Builder()
        .addID(IdScan.Builder().build())
        .addSelfieScan(SelfieScan.Builder().build())
        .addFaceMatch()
        .build()
} catch (e: ModuleConfigurationException) {
    // Invalid flow configuration — fix before running
    Log.e("Incode", "Flow config error: ${e.message}")
}
```

```java
try {
    FlowConfig flowConfig = new FlowConfig.Builder()
        .addID(new IdScan.Builder().build())
        .addSelfieScan(new SelfieScan.Builder().build())
        .addFaceMatch()
        .build();
} catch (ModuleConfigurationException e) {
    // Invalid flow configuration — fix before running
    Log.e("Incode", "Flow config error: " + e.getMessage());
}
```

This is an Android-specific error type with no direct equivalent in the iOS or Web SDKs.

### Delayed Onboarding Sync Errors

When syncing offline (delayed) onboardings, errors are delivered via a dedicated listener:

```kotlin
IncodeWelcome.getInstance().syncDelayedOnboardings(object : SyncDelayedOnboardingListener {
    override fun onError(error: DelayedOnboardingSyncError) {
        // Handle sync error
    }
})
```

### Emulator Behavior

On Android emulators, camera-dependent modules (`ID Scan`, `Selfie Scan`, `Face Match`, `Document Scan`, `Video Selfie`) show a black screen for 2 seconds then return `ResultCode.EMULATOR_DETECTED` automatically. Remove `setTestModeEnabled(true)` before building for production.

***

## Flutter, React Native, and Xamarin


The Flutter, React Native, and Xamarin SDKs wrap the native iOS and Android SDKs. Error handling in these platforms mirrors the underlying native platform:

- On **iOS devices**, errors follow the iOS SDK model described above: typed `IncdFlowError` cases delivered via delegate callbacks, with per-module result error enums.
- On **Android devices**, errors follow the Android SDK model: `Throwable` errors via listener callbacks, with `ResultCode` on module results.

Refer to each platform's integration guide for the platform-specific callback and listener signatures used to receive these errors.

:::note
Detailed error handling documentation for Flutter, React Native, and Xamarin is coming soon. Contact your Incode customer success manager or refer to the native platform sections above in the meantime.
:::

---

- Path: `general-reference/session-statuses`
- URL: https://developer.incode.com/general-reference/session-statuses/
- Markdown: https://developer.incode.com/general-reference/session-statuses.md

# Incode Session Statuses

There are two categories of session status values:

- **Onboarding progress statuses** are set automatically by the Incode Platform as [a session moves](/get-started-with-incode/onboarding-session-lifecycle/) through its verification modules. You receive these via the [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/) or by polling the [`/omni/get/onboarding/status`](https://developer.incode.com/api-reference/get-onboarding-status/) endpoint.
- **Manual session states** are values you set by calling the [`/omni/session/status/set`](https://developer.incode.com/api-reference/session-status-set/) endpoint.

:::info
Some of the API and code references on this page refer to _onboarding sessions_. Some of the statuses can apply to either onboarding or authentication sessions. It's important to know [the difference between onboarding and authentication](/concepts-and-architecture/onboarding-vs-authentication/).
:::

***

## Onboarding Progress Statuses

A session moves through these statuses in order. Not every status occurs in every session. The modules configured in your Workflow or Flow determine which statuses occur.

### Sequential Processing Statuses

| Status                               | Description                                                                                                                                                                                                                                                                                                                                       |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `UNKNOWN`                            | Initial status. The session is created but the user has not yet started it. For example, an onboarding URL has been shared but the user has not clicked it. **No webhook notification is sent for this status.** Retrieve it by calling the [get session status](https://developer.incode.com/api-reference/session-status-get/) endpoint. |
| `ID_VALIDATION_FINISHED`             | ID document validation is complete. OCR data has been extracted and the `idValidation` score has been calculated. Preliminary OCR data and the ID validation score can be fetched at this point. Wait for `ONBOARDING_FINISHED` before fetching final results.                                                                                    |
| `ID_VALIDATION_FINISHED_SECOND_ID`   | ID document validation is complete for a second ID document, if applicable. Preliminary data for the second ID can be fetched at this point.                                                                                                                                                                                                      |
| `GOVERNMENT_VALIDATION_FINISHED`     | Validation against a government registry or third-party source of truth is complete. Preliminary government validation results can be fetched. Wait for `ONBOARDING_FINISHED` before fetching final results.                                                                                                                                      |
| `FACE_VALIDATION_FINISHED`           | Face Match is complete. The selfie has been compared against the ID document photo. The `faceRecognition` and `liveness` scores have been calculated. If government validation is part of the flow, this status generally occurs after `GOVERNMENT_VALIDATION_FINISHED`.                                                                          |
| `POST_PROCESSING_FINISHED`           | ID post-processing is complete. Used in specific implementations where additional server-side data review is required after ID capture.                                                                                                                                                                                                           |
| `POST_PROCESSING_FINISHED_SECOND_ID` | ID post-processing is complete for the second ID document, if applicable.                                                                                                                                                                                                                                                                         |
| `ONBOARDING_FINISHED`                | The session is complete. All data has been collected and processed, business rules have been applied, the final session score has been calculated, and the user has exited the flow. **Wait for this status for before fetching scores and session data.**                                                                                        |

### Post-Completion Statuses

These statuses occur after `ONBOARDING_FINISHED` and show the outcome of manual review or session lifecycle events.

| Status                   | Description                                                                                                                                                                                                                                                                                                                      |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `MANUAL_REVIEW_APPROVED` | A session that was in a Needs Review state has been manually approved by a reviewer in Dashboard.                                                                                                                                                                                                                                |
| `MANUAL_REVIEW_REJECTED` | A session that was in a Needs Review state has been manually rejected by a reviewer in Dashboard.                                                                                                                                                                                                                                |
| `EXPIRED`                | A time limit is configured on the Flow or Workflow and the user abandons the session after that limit. If the user returns, they see a session expired screen.                                                                                                                                                                   |
| `DELETED`                | The session's data has been deleted. Deletion is not immediate. Finished sessions are placed in a queue. The webhook payload for this status uses `interviewIds`, a string array, instead of the usual `interviewId` field. Multiple sessions may be deleted in a single event. See [Deleted sessions](#deleted-sessions) below. |

***

## Manual Session States

You can manually set a session's state by calling the [`POST /omni/session/status/set`](https://developer.incode.com/api-reference/session-status-set/) endpoint with one of the following `action` values:

| State     | Description                                                                                                                           |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `Alive`   | The session is active. All `/add/...` data capture calls are permitted. This is the default state for a session in progress.          |
| `Closed`  | The session is closed. All `/add/...` calls are disabled. No further data can be added to the session. The session data is preserved. |
| `Deleted` | The important data stored in the session is deleted. See [Deleted sessions](#deleted-sessions) below.                                 |

***

## Deleted Sessions

`Deleted` appears in both categories because a session can reach a deleted state in two ways:

1. **Manually**, by calling `POST /omni/session/status/set` with `action: Deleted`.
2. **Automatically**, as a platform-level data deletion event. For example, when data retention policies cause session data to be purged.

In both cases, if you have configured the [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/), a `DELETED` webhook notification is sent when the deletion is processed. The payload for this notification differs from all other onboarding status webhooks; it contains an `interviewIds` array of one or more session IDs, rather than a single `interviewId` field.

***

## Webhook Coverage

Not all onboarding progress statuses trigger a webhook notification. The table below shows which statuses send a webhook when the [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/) is configured.

| Status                               | Webhook sent?                            |
| ------------------------------------ | ---------------------------------------- |
| `UNKNOWN`                            | ❌ No, poll the API instead               |
| `ID_VALIDATION_FINISHED`             | ✅ Yes                                    |
| `ID_VALIDATION_FINISHED_SECOND_ID`   | ✅ Yes, if applicable                     |
| `GOVERNMENT_VALIDATION_FINISHED`     | ✅ Yes                                    |
| `FACE_VALIDATION_FINISHED`           | ✅ Yes                                    |
| `POST_PROCESSING_FINISHED`           | ✅ Yes                                    |
| `POST_PROCESSING_FINISHED_SECOND_ID` | ✅ Yes, if applicable                     |
| `ONBOARDING_FINISHED`                | ✅ Yes                                    |
| `MANUAL_REVIEW_APPROVED`             | ✅ Yes                                    |
| `MANUAL_REVIEW_REJECTED`             | ✅ Yes                                    |
| `EXPIRED`                            | ✅ Yes                                    |
| `DELETED`                            | ✅ Yes, payload uses `interviewIds` array |

***

## Related Pages

- [Onboarding Session Lifecycle](/get-started-with-incode/onboarding-session-lifecycle/): How statuses change during a session
- [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/): Webhook payload details, authentication, and retry policy
- [Session Webhooks](/general-reference/session-webhooks/): Targeted webhooks for specific session events (`Session_Started`, `Session_Failed`, `Session_Succeeded`, `Session_Pending_Review`)
- [Get Session Status](https://developer.incode.com/api-reference/session-status-get/): API endpoint for polling session status
- [Set Session Status](https://developer.incode.com/api-reference/session-status-set/): API endpoint for setting session state

<br />

---

- Path: `general-reference/session-webhooks`
- URL: https://developer.incode.com/general-reference/session-webhooks/
- Markdown: https://developer.incode.com/general-reference/session-webhooks.md

# Session Webhooks

Session webhooks let you set up notifications for events that happen during any session triggered by a Flow or Workflow. You can [configure them](/dashboard-platform-administration/configuration-webhooks-tab/), along with other types of webhooks, in Dashboard.

## Learn more about webhooks

Webhooks are event notifications. They let your organization's application know when a specific event happens on the Incode platform or when a process initiated by a user is completed (also known as a callback). Your application can then take action based on the notification.

Webhooks are asynchronous (that is, the communication is only from the Incode platform to your application). You must configure them if you want to use them.

Each session webhook notifies you about a specific session event. This is different from the [Onboarding Status webhook,](/general-reference/onboarding-status-webhook/) which sends notifications at the completion of every module during a single session. Depending on the number of modules in the session Flow or Workflow, this could be more notifications than you need or want.

Session webhooks provide additional flexibility and let you tailor your notifications for specific needs.

There are six session webhooks available:

- **Session Started:** Triggered when any session triggered by a Flow or Workflow starts.
- **Session Progress:** Triggered on any `/start` endpoint call after the initial session creation. For example, when an end user resumes a session on their phone.
- **Session Failed:** Triggered when any session triggered by a Flow or Workflow fails. Sessions can fail at various points and for various reasons during a Flow or Workflow. You can view more information about failed sessions in Dashboard. Go to **Dashboard** > **Sessions** and click any session in the table to open it.
- **Session Succeeded:** Triggered when any session triggered by a Flow or Workflow succeeds.
- **Session Pending Review:** Triggered when any session triggered by a Flow or Workflow requires manual review.
- **Identity Enrolled:** Triggered the first time an Identity is created. Updates to an existing Identity do not emit this event.

***

## Key facts about session webhooks

- Each session webhook notification contains a number of common fields. These provide context and allow you to track what's happening more easily.
- Notifications come as `POST` requests to the endpoint you configured in Dashboard.
- Notification headers are passed as key/value pairs.
- Notification payloads are sent in JSON format. You must configure any internal settings to include `Accept Application/json`.
- Data is included in the first notification for which it is available.

***

## Notification payload fields

### Common fields

The fields in the following table are common to all session webhook notifications (`SESSION_STARTED`, `SESSION_PROGRESS`, `SESSION_FAILED`, `SESSION_SUCCEEDED`, and `SESSION_PENDING_REVIEW`). They are the only fields included in `SESSION_STARTED` and `SESSION_PROGRESS`.

| Field                | Type     | Description                                                                                                                                                    |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `event_type`         | `string` | Name of the webhook providing the notification: `SESSION_STARTED`, `SESSION_PROGRESS`, `SESSION_FAILED`, `SESSION_SUCCEEDED`, or `SESSION_PENDING_REVIEW`      |
| `timestamp`          | `string` | UTC timestamp of the triggering event in ISO 8601 format                                                                                                       |
| `interviewId`        | `string` | Unique identifier for the session                                                                                                                              |
| `externalCustomerId` | `string` | Unique identifier from your system that is used for data matching                                                                                              |
| `clientId`           | `string` | Unique identifier assigned to your organization                                                                                                                |
| `configurationId`    | `string` | Unique identifier assigned to the Flow or Workflow for this session                                                                                            |
| `integrationId`      | `string` | Unique identifier assigned by Incode to the integration associated with this session. If there was no integration for the session, this field does not appear. |
| `integrationType`    | `string` | Type of integration associated with this session. If there was no integration for the session, this field does not appear.                                     |
| `loginHint`          | `string` | Displays a value entered by the end user as a login hint for this session. If no login hint was used, this field does not appear.                              |
| `devices`            | `array`  | Not included in `SESSION_STARTED` or `SESSION_PROGRESS` notifications. See [Devices array](#devices-array) for details.                                        |

### Fields available after a session starts

The next table explains fields that are only available after a session starts. These fields are included in `SESSION_FAILED`, `SESSION_SUCCEEDED`, or `SESSION_PENDING_REVIEW` notifications.

| Field              | Type     | Description                                                                                                                                                                  |
| ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `onboardingStatus` | `string` | Status of the session; the value is always `ONBOARDING_FINISHED`. The term "onboarding" here applies to any session.                                                         |
| `ip`               | `string` | IP address for the end user device (legacy field, preserved for backward compatibility). Not available for fully API-integrated sessions.                                    |
| `latitude`         | `string` | Latitude at which the end user device was located during the session (legacy field, preserved for backward compatibility). Not available for fully API-integrated sessions.  |
| `longitude`        | `string` | Longitude at which the end user device was located during the session (legacy field, preserved for backward compatibility). Not available for fully API-integrated sessions. |
| `devices`          | `array`  | Structured array of device objects containing enriched device fingerprint data. Empty array (`[]`) when no device data is available. See [Devices array](#devices-array).    |

### Fields available for specific event types

The following table explains fields that appear only in specific event type notifications.

| Field            | Event type(s)                         | Type     | Description                                                                                                                                                                              |
| ---------------- | ------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `identityId`     | `SESSION_SUCCEEDED`, `SESSION_FAILED` | `string` | Unique identifier for the Identity that was matched or created for this session. Included in `SESSION_FAILED` when the failed session is tied to an existing Identity.                   |
| `failureReasons` | `SESSION_FAILED`                      | `array`  | Sorted, deduplicated array of upper-snake-case string identifiers indicating why the session failed. Replaces the legacy `failureReason` field. See [Failure reasons](#failure-reasons). |

### Devices array

The `devices` field is a structured array of device objects included in `SESSION_FAILED`, `SESSION_SUCCEEDED`, and `SESSION_PENDING_REVIEW` notifications. It replaces the flat `ip`, `latitude`, and `longitude` fields previously included. However, these fields are preserved for backward compatibility. Devices are sorted by timestamp, with the oldest first.

Each device object contains the following fields:

| Field         | Type     | Description                               |
| ------------- | -------- | ----------------------------------------- |
| `ip`          | `string` | IP address of the end user device         |
| `latitude`    | `number` | Latitude of the end user device location  |
| `longitude`   | `number` | Longitude of the end user device location |
| `browser`     | `string` | Browser used during the session           |
| `deviceModel` | `string` | Model of the end user device              |
| `deviceType`  | `string` | Type of device (for example, `mobile`)    |
| `osVersion`   | `string` | Operating system and version              |
| `hash`        | `string` | Device fingerprint hash                   |

Example:

```json
{
  "ip": "203.0.113.10",
  "latitude": 37.7749,
  "longitude": -122.4194,
  "browser": "Chrome",
  "deviceModel": "iPhone 15",
  "deviceType": "mobile",
  "osVersion": "iOS 17.5",
  "hash": "fingerprint-hash"
}
```

### Failure reasons

<Callout icon="⚠️" theme="warn">
  ### **Breaking change:** The legacy `failureReason` (singular string) field has been removed from `SESSION_FAILED` notifications and replaced by the `failureReasons` array.
</Callout>

The `failureReasons` field is included only in `SESSION_FAILED` notifications. It contains a stable, sorted, deduplicated array of identifiers indicating why the session failed.

Example:

```json
{
  "event_type": "SESSION_FAILED",
  "failureReasons": ["ID_VALIDATION", "LIVENESS"]
}
```

The following table lists all possible identifiers:

| Identifier                      | Source                                                                                                                                              |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AUTHENTICATION`                | `authentication` score field                                                                                                                        |
| `ID_VALIDATION`                 | `idValidation` score field                                                                                                                          |
| `SECOND_ID_VALIDATION`          | `secondIdValidation` score field                                                                                                                    |
| `ANTIFRAUD`                     | `antifraud` score field                                                                                                                             |
| `LIVENESS`                      | `liveness` score field                                                                                                                              |
| `DEEPSIGHT`                     | `deepsight` score field                                                                                                                             |
| `FACE_CAPTURE_ASSESSMENT`       | `faceCaptureAssessment` score field                                                                                                                 |
| `FACE_RECOGNITION`              | `faceRecognition` score field                                                                                                                       |
| `FACE_RECOGNITION_SECOND_ID`    | `faceRecognitionSecondId` score field                                                                                                               |
| `GOVERNMENT_VALIDATION`         | `governmentValidation` score field                                                                                                                  |
| `VIDEO_SELFIE`                  | `videoConference` score field                                                                                                                       |
| `PREMIUM_EXTERNAL_VERIFICATION` | `premiumExternalVerification` score field                                                                                                           |
| `CURP_VERIFICATION`             | `curpVerification` score field                                                                                                                      |
| `ID_OCR_CONFIDENCE`             | `idOcrConfidence` score field                                                                                                                       |
| `ID_OCR_CONFIDENCE_SECOND_ID`   | `idOcrConfidenceSecondId` score field                                                                                                               |
| `INCODE_WATCHLIST`              | `incodeWatchlistScore` score field                                                                                                                  |
| `DEVICE_RISK`                   | `deviceRisk` score field                                                                                                                            |
| `BEHAVIORAL_RISK`               | `behavioralRisk` score field                                                                                                                        |
| `TRUST_GRAPH`                   | `trustGraph` score field                                                                                                                            |
| `AUTOPILOT`                     | `autopilot` score field                                                                                                                             |
| `INVOICE_VALIDATION`            | `invoiceValidation` score field                                                                                                                     |
| `LINK_EXPIRED`                  | Session link expiry failure path                                                                                                                    |
| `MANUAL_REJECTED`               | Triggered when a session enters Review state and a Dashboard admin rejects the session.                                                             |
| `OTHER`                         | Fallback used when no specific failure reason can be determined. For example, when it's unclear whether a module or a condition caused the failure. |

***

## Identity Enrolled webhook

The `IDENTITY_ENROLLED` webhook fires the first time an Identity is created. It does not fire for updates to an existing Identity.

The payload for `IDENTITY_ENROLLED` uses the following shape:

| Field                  | Type     | Description                                                                                                                         |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `eventType`            | `string` | Always `IDENTITY_ENROLLED`                                                                                                          |
| `timestamp`            | `string` | UTC timestamp of the triggering event in ISO 8601 format                                                                            |
| `identityId`           | `string` | Unique identifier for the newly created Identity (required)                                                                         |
| `interviewId`          | `string` | Unique identifier for the session associated with the Identity creation                                                             |
| `externalId`           | `string` | External identifier from the integration, if available. If not available, this field does not appear.                               |
| `externalCustomerId`   | `string` | Unique identifier from your system used for data matching. If not available, this field does not appear.                            |
| `clientId`             | `string` | Unique identifier assigned to your organization                                                                                     |
| `configurationId`      | `string` | Unique identifier assigned to the Flow or Workflow for this session                                                                 |
| `integrationReference` | `string` | Reference to the integration associated with this session. If there was no integration for the session, this field does not appear. |
| `loginHint`            | `string` | Displays a value entered by the end user as a login hint for this session. If no login hint was used, this field does not appear.   |

Example payload:

```json
{
  "eventType": "IDENTITY_ENROLLED",
  "timestamp": "2026-05-20T14:00:00Z",
  "identityId": "65f8...",
  "interviewId": "65f7...",
  "externalId": "ext-abc-123",
  "externalCustomerId": "cust-456",
  "clientId": "client-xyz",
  "configurationId": "flow-prod-onboarding",
  "integrationReference": "ref-789"
}
```

***

## Session Failed on link expiration

When a Workforce verification link expires, the platform sends a `SESSION_FAILED` webhook with `failureReasons` containing `["LINK_EXPIRED"]`. This feature is configuration-dependent. Contact your Incode representative to enable it.

***

## Error handling and retry policy

Webhooks make up to 5 attempts to deliver a notification in case of endpoint failures. You should ensure your endpoint is ready to handle retries and process duplicate notifications gracefully.

Retries will be triggered by either of these scenarios:

- A timeout is received when your endpoint is called
- A status code is returned from your service and is not either:
  - `200 OK` along with the `application/json` header, or
  - `204 No content`

The retry policy for webhooks is exponential, with an initial interval of 30 seconds and a multiplier of 2.5. The maximum number of attempts is 5. This means the maximum time a webhook can take to reach its destination is approximately 32 minutes, as illustrated in the following table.

| Retry attempt | Delay (seconds) | Delay (minutes) | Total (minutes) |
| :-----------: | --------------: | --------------: | --------------: |
|       1       |              30 |             0.5 |             0.5 |
|       2       |              75 |            1.25 |            1.75 |
|       3       |           187.5 |            3.13 |            4.88 |
|       4       |          468.75 |            7.81 |           12.69 |
|       5       |        1,171.88 |           19.53 |           32.22 |

***

## Webhook IP address list

If your organization restricts inbound traffic for your network, make sure the following IP addresses are added to your allow list.

### United States

Allow the IP addresses shown in this table for the SAAS (Production) environment.

| IP Address    | Active                 |
| ------------- | ---------------------- |
| 54.86.34.156  | Currently Active       |
| 3.142.125.52  | Currently Active       |
| 54.85.117.182 | As of February 2, 2026 |
| 3.233.40.153  | As of February 2, 2026 |

Allow this IP address for the Demo environment.

| IP Address     | Active                                                |
| -------------- | ----------------------------------------------------- |
| 34.198.171.165 | Active since October 2024 (previously 18.210.119.234) |

### Europe

Allow this IP address for both the Production and Demo environments.

| IP Address    | Active |
| ------------- | ------ |
| 18.158.116.18 | Active |

<br />

---

- Path: `general-reference/spain`
- URL: https://developer.incode.com/general-reference/spain/
- Markdown: https://developer.incode.com/general-reference/spain.md

# Spain

eKYB Prefill in Spain leverages Spain's source of truth to automatically retrieve and populate business information based on a company's CIF or VAT number, including the business name, registered address, entity type, registration status, directors, shareholders, and additional financial and corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| Spain | `ES_KYB_PREFILL` | Returns matching Spanish business details from Spain's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `ES_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `ES`. |
| taxId | Mandatory | String. Spanish CIF or VAT number. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts three CIF formats and a VAT number format. Routing between them is determined automatically by the format of the submitted value.

| ID Type | Format | Example |
| --- | --- | --- |
| **CIF — Regular company** | 1 letter + 8 digits | `B12345678` |
| **CIF — Sole Trader** | 8 digits + 1 letter | `12345678A` |
| **CIF — Foreign Sole Trader** | 1 letter + 7 digits + 1 letter | `X1234567A` |
| **VAT number** | `ES` + CIF | `ESB12345678` |

Inputs that do not match any of the above formats return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "ES_KYB_PREFILL",
    "country": "ES",
    "taxId": "B12345678",
    "businessName": "SECONDOLAB SL",
    "address": "CALLE ANNA 6 PTA 2, 08620 SANT VICENÇ DELS HORTS"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request. `otherNames`, `turnover`, `employeeCount`, `companySize`, `shareholders`, and `directors` are only present when available for the company.

**Example 1 — SECONDOLAB (Limited Liability Company)**

```json
{
  "kyb-prefill": [
    {
      "tin": "B12345678",
      "vatNo": "ES12345678",
      "name": "SECONDOLAB SL",
      "otherNames": [
        { "name": "SECONDOLAB", "businessNameType": "Trade Name" }
      ],
      "nameMatch": "Verified",
      "address": "CALLE ANNA 6 PTA 2, 08620 SANT VICENÇ DELS HORTS",
      "city": "SANT VICENÇ DELS HORTS",
      "postalCode": "12345",
      "entityType": "Limited Liability Company",
      "registrationStatus": "Active",
      "registrationDate": "2011-09-15T00:00:00Z",
      "creditRating": "B",
      "creditRatingDescription": "Low Risk",
      "industryDesc": "Retail sale via mail order houses or via Internet",
      "activityDesc": "Retail sale via mail order houses or via Internet",
      "turnover": { "currency": "EUR", "value": 120000 },
      "employeeCount": "1",
      "companySize": "Micro-company",
      "shareholders": [
        { "name": "ANA MARIA JIMENEZ", "percentSharesHeld": 100 }
      ],
      "directors": [
        { "name": "ANA MARIA JIMENEZ", "positionName": "Sole Administrator" }
      ]
    }
  ]
}
```
**Example 2 — MARIA MAESTRE ANNA CB (Joint Ownership / Comunidad de Bienes)**

```json
{
  "kyb-prefill": [
    {
      "tin": "E12345678",
      "vatNo": "ES12345678",
      "name": "MARIA MAESTRE ANNA CB",
      "otherNames": [
        { "name": "Champús", "businessNameType": "Trade Name" }
      ],
      "nameMatch": "Verified",
      "address": "CALLE Champús PROPI LA OCA 90 LOCAL POSTERIOR, 28041 MADRID",
      "city": "MADRID",
      "postalCode": "28041",
      "entityType": "Joint Ownership",
      "registrationStatus": "Active",
      "creditRating": "C",
      "creditRatingDescription": "Moderate Risk",
      "industryDesc": "Retail sale of footwear and leather goods in specialised stores",
      "activityDesc": "Retail sale of footwear and leather goods in specialised stores",
      "employeeCount": "12",
      "companySize": "Small company"
    }
  ]
}
```





### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | CIF number | The Spanish CIF as confirmed by the source of truth. |
| vatNo | VAT identifier | The Creditsafe internal company number (`companyNumber`) mapped as the VAT identifier (for example, `ES09166632`). Present for all companies. |
| name | Business name | The registered legal name of the business (`registeredCompanyName`) as returned from the source of truth. |
| otherNames | Array of `{name, businessNameType}` | Trade names or other business names associated with the company. `businessNameType` is always `"Trade Name"`. Only present when a trade name differs from the registered legal name. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the registered name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `Limited Liability Company`, `Joint Ownership`). Defaults to `Unknown` when not available. |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). Defaults to `Unknown` when not available. |
| registrationDate | Date | The date the company was registered, as returned from the source of truth. May not be present for all companies. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `B`). Defaults to `Unknown` when not available. May not be present for all companies. |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Low Risk`). May not be present for all companies. |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Retail sale via mail order houses or via Internet`). |
| activityDesc | Activity description | The principal activity description as returned from the source of truth. For Spain, this is typically identical to `industryDesc`. |
| turnover | `{currency, value}` object | The latest turnover figure as returned from the source of truth. May not be present for all companies. |
| employeeCount | String | The latest employee count as returned from the source of truth. Always returned as a string. May not be present for all companies. |
| companySize | String | The company size classification as returned from the source of truth (for example, `Micro-company`, `Small company`). May not be present for all companies. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. Absent for Joint Ownership (`Comunidad de Bienes`) entities — this is expected, not an error. May not be present for all other company types. |
| directors | Array of `{name, positionName}` | Current directors and officers as returned from the source of truth. `positionName` reflects the primary position title on file. Absent for Joint Ownership (`Comunidad de Bienes`) entities — this is expected, not an error. May not be present for all other company types. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. Spain Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or does not match a supported Spanish identifier format:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid Spanish CIF (letter + 8 digits, 8 digits + letter, or letter + 7 digits + letter) or VAT number (ES + CIF)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [Single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/step-up-and-additional-checks`
- URL: https://developer.incode.com/general-reference/step-up-and-additional-checks/
- Markdown: https://developer.incode.com/general-reference/step-up-and-additional-checks.md

# Step-Up and Additional Checks

A **step-up** runs an additional check, or collects another document, for a person who has already been verified. Examples include a signature, a proof of address document, and a tier upgrade. Integrations have usually done this by restarting the original session, because that is where the earlier data lives. Restarts are being retired, as described in [Migration Guide: Moving Off Session Restarts](/general-reference/moving-off-session-restarts/). This page covers the replacement paths for step-ups.

## At a glance

|                      |                                                                                                                                                                                                                  |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enforcement date** | Depends on the scenario.                                                                                                                                                                                                |
| **What's changing**  | Reopening a completed session by calling the `omni/start` API or SDK again, in order to run an extra check or collect another document.                                                                               |
| **Who's affected**   | Any integration that restarts an existing session to add a signature, document, module, or acceptance after the original onboarding.                                                                              |
| **How to check**     | Search your integration for call sites where `omni/start` is passed an existing `interviewId` or `externalId` and is followed by a module, upload, or signature call. For each one, work through [Find your scenario](#find-your-scenario). |
| **Grace period**     | None. See [Enforcement](/general-reference/moving-off-session-restarts/#enforcement). The 30 September 2026 date in that guide applies to reading session data and repeating a completed onboarding. It does not apply to step-ups. |

## What is changing

|                                         | What it is                                                                                                              | Status                           |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| **Reopen the original session**         | Restarting a completed session to run a step-up there, because that is where the earlier data lives.                    | Being retired                    |
| **New session, linked to the identity** | Starting a new session, proving it is the same person, and supplying any data the check needs. Incode writes the result back to the identity. | The supported path going forward |

None of the replacement paths reopen the original session. Most follow the same shape, with two exceptions: [Scenario 2](#scenario-2-expired-document-update) needs no step-up session, and [Scenario 5](#scenario-5-retroactive-module-runs) is not supported.

### Key concepts

- **Identity**: The record Incode keeps for a person across sessions. It is created when an onboarding session is approved, and it is what allows a later session to be recognized as the same person. Results such as a signature or a proof of address are written to it. Raw images are never stored on the identity.
- **Proving it is the same person**: Where a scenario requires it, run Incode face authentication at the start of the new session. This links the new session to the existing identity. There is no backend-to-backend alternative today.
- **Supplying raw data**: There is no mechanism to move data from one session into another. Where a check needs the ID images and the selfie, upload them into the new session. You can get them in two ways: keep your own copy from the original onboarding, or retrieve them from the original session with an admin token. See [Scenario 4](#scenario-4-modules-that-need-earlier-data).
- **The 48-hour window**: A session lasts 48 hours from the `omni/start` call that created it. This applies to every scenario below that creates a new session. Everything you intend to do in that session must happen inside the window.

## Find your scenario

Identify every scenario that describes what your integration does. Most integrations have more than one. Handle each separately.

| #                                                            | Applies when                                                                                     | Replacement                                                                                                       |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| [1](#scenario-1-document-signature)                              | A document is signed using the signature captured during an earlier onboarding.                   | New session linked to the identity by face authentication. The signature is read from the identity.               |
| [2](#scenario-2-expired-document-update)                         | An ID, selfie, or proof of address has expired and needs replacing.                                | Read the expiry with an **admin token**, then run a new onboarding when it lapses.                                 |
| [3](#scenario-3-non-scoring-additions)                           | Something is collected that needs nothing from the earlier session: terms acceptance, an additional proof of address, or a tier upgrade. | New session linked to the identity by face authentication. Collect the item there.                    |
| [4](#scenario-4-modules-that-need-earlier-data)          | A module is run that needs images or data captured in an earlier session, such as Government Record Verification, Video Selfie, or AES or QES signing without face authentication. | Get the original images and any other input the module needs, upload them into a **new session**, and run the module there. |
| [5](#scenario-5-retroactive-module-runs)                         | A module bought after the original onboarding is run over old sessions.                           | Not supported.                                                                                                     |
| —                                                            | Session data is read to make a decision or for an audit, and nothing is run.                      | Not a step-up. See [Moving Off Session Restarts, Scenario 1: Reading session data](/general-reference/moving-off-session-restarts/#scenario-1-reading-session-data). |
| —                                                            | A module failed and needs re-running.                                                             | Not a step-up. See [Moving Off Session Restarts, Scenario 2: Remediation after a failure](/general-reference/moving-off-session-restarts/#scenario-2-remediation-after-a-failure). |
| —                                                            | None of the above.                                                                                | Contact your Incode representative or use the customer portal.                                     |

## Scenario 1: Document signature

**Applies when:** a document is signed using a signature that was captured during an earlier onboarding.

**What to do instead:** start a new session linked to the person's identity through face authentication. The signature endpoints read the default signature from the identity.

**Prerequisites:**

- An identity for the person. It is created when the onboarding session that captured the default signature is approved.
- Face authentication, to link the new session to that identity.
- For batch signing only: an admin token. See [the admin token prerequisites in Moving Off Session Restarts](/general-reference/moving-off-session-restarts/#scenario-1-reading-session-data).
- For QES only: a phone number or email address verified with a one-time code in the new session. See [Advanced and qualified electronic signatures](#advanced-and-qualified-electronic-signatures).

### Flow A: One document at a time

1. During onboarding, upload the default signature and approve the session. Approval creates the identity and copies the signature to it.
2. Run face authentication. This creates a new session linked to the identity.
3. Upload the contract and any additional signatures to the new session.
4. Call Attach Signature on Annotation. It takes the contract and additional signatures from the session, and the default signature from the identity.

### Flow B: Batch signing

1. The user authenticates with face authentication. This creates a session linked to their identity. Create one session per authentication event per day.
2. Upload documents to that session throughout the day, using an admin token.
3. Apply the signatures in your nightly job. Call the endpoint with the admin token, passing `interviewId` and each contract ID in turn.

A single day of documents fits inside the 48-hour session window. Start a new session the next day.

:::warning
Do not create a session per document. This would repeat the pattern being retired, which is one restart per document. Attach all of a day's documents to a single session.
:::

### The endpoints you'll call

| What                          | Call                                                                                                                                    |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Upload the default signature  | [`POST /omni/add/document/v2?type=signature`](/api-reference/add-document-v2/)                              |
| Upload a contract             | [`POST /omni/add/document/v2?type=contract&title=<name>`](/api-reference/add-document-v2/)                  |
| Apply the signature           | [`POST /omni/attach-signature-on-annotation`](/api-reference/attach-signature-on-annotation/)               |
| Apply to several PDFs at once | [`POST /omni/attach-signature-to-pdf/v2`](/api-reference/attach-signature-to-pdf-v2/)                       |

The file goes in the request body as either `base64Image` or `imageUrl`. All calls take the `x-api-key`, `x-incode-hardware-id`, and `api-version: 1.0` headers.

### Where the signature comes from

When you call [Attach Signature on Annotation](/api-reference/attach-signature-on-annotation/) or [Attach Signature to Multiple PDF Documents](/api-reference/attach-signature-to-pdf-v2/), Incode checks whether the session references a customer ID, which links it to an identity. It then looks for the default signature in this order:

- **The identity**: Used if the session is linked to an identity that has a signature. The identity takes priority over the session.
- **The session**: Used if there is no identity link, or the identity has no signature. This is how the endpoints work today, so existing integrations keep working.

Only the default signature is stored on the identity. That is the one the user draws during onboarding. It is written once, when the onboarding session is approved. Approving a later session does not overwrite it.

Additional signatures stay on the session. These are any others you collect live, such as from a surgeon, patient, or witness.

### Existing users

The signature is copied to the identity when a session is approved, so the flows above work for people onboarded after this change. For people onboarded before it, Incode runs a one-time backfill per account that copies the signature across. No action is required on your side.

Until the backfill has run for your account, use these flows for newly onboarded users and keep your current integration for everyone else. Contact your Incode representative to confirm the backfill status for your account.

### Advanced and qualified electronic signatures

Advanced electronic signatures (AES) and qualified electronic signatures (QES) are available on this path. Both use face authentication to link the new session to the identity, and the signing certificate uses the person's details from the identity.

**Prerequisites:**

- Face authentication in the new session.
- For AES: no phone step is required. If the phone step in your Flow or Workflow has code verification turned on, the person must complete it first.
- For QES: a phone number or email address verified with a one-time code in the new session, or your own verification evidence.

:::warning
Identities created before this change may not hold all the details that signing needs. Contact your Incode representative before you use this path for users onboarded before the change.
:::

#### What the change looks like

1. Run face authentication. This creates a new session linked to the identity.
2. For QES, verify the phone number or email address with a one-time code in that session. This step is optional for AES.
3. Upload the contract to the session.
4. Sign with AES or QES.

#### The endpoints you'll call

| What                                | Call                                                              |
| ----------------------------------- | ----------------------------------------------------------------- |
| Get an upload link for the contract | `POST /omni/es/generateDocumentUploadUrl`                         |
| Sign with AES                       | `POST /omni/es/process/sign`                                      |
| Accept the QES terms                | `POST /omni/es/qes/terms`                                         |
| Sign with QES                       | `POST /omni/es/process/signQes`. Call it after `POST /omni/es/qes/terms`. |
| Get the signed documents            | `GET /omni/es/documents/signed/v2`                                |

#### What is checked

- Face authentication replaces the earlier checks. If face authentication matches the identity, signing does not require an approved session, an ID score, or a face match score.
- One-time codes are checked on the new session. A code verified during the original onboarding is not reused.
- The identity must hold the person's details. If it does not, signing falls back to the full checks and returns an error.

#### Without face authentication

Supply the ID images, selfie, and phone number in the new session yourself, as described in [Scenario 4](#scenario-4-modules-that-need-earlier-data), then sign. The full checks apply.

### After migration: Remove the old path

Remove any code path that calls `omni/start` with an existing `interviewId` or `externalId` in order to sign a document.

## Scenario 2: Expired document update

**Applies when:** an ID, selfie, or proof of address has expired and needs replacing.

**What to do instead:** read the document's expiry from the original session with an admin token. When it lapses, run a new onboarding for that person. No step-up session, identity, or face authentication is required.

**Prerequisites:**

- An admin token. See [See the admin token prerequisites in Moving Off Session Restarts](/general-reference/moving-off-session-restarts/#scenario-1-reading-session-data).

### What the change looks like

1. Read the expiry date from the original session with [`GET /omni/get/ocr-data?id=<interviewId>`](/api-reference/get-ocr-data/).
2. When the document lapses, run a new onboarding for that person.

```bash
curl -X GET 'https://<api-base>/omni/get/ocr-data?id=<interviewId>' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-incode-hardware-id: <ADMIN_TOKEN>' \
  --header 'api-version: 1.0'
```

If identity is enabled for your account, you can query the identity for a validity flag instead of reading raw OCR data. The replacement document is captured in the new session and Incode writes it back to the identity, so the record stays linked. Identity makes this scenario simpler but is not required to migrate.

### After migration: Remove the old path

Remove any code path that restarts the original session to capture a replacement document.

## Scenario 3: Non-scoring additions

**Applies when:** something is collected that needs nothing from the earlier session: a terms acceptance, an additional proof of address, or a tier upgrade.

**What to do instead:** start a new session, authenticate the user against the existing identity, and collect the new item in that session.

**Prerequisites:**

- An identity for the person.
- Face authentication, to link the new session to that identity.

### What the change looks like

1. Create a new session.
2. Authenticate the user against the existing identity with face authentication.
3. Collect the new item in that session. For a proof of address, call [`POST /omni/add/document/v2?type=document&format=pdf`](/api-reference/add-document-v2/).
4. Incode attaches the result to the identity where it qualifies as a credential.

Terms and conditions acceptance and watchlist results stay on the session and are not written to the identity.

Without face authentication, you can still collect the item in a new session, but it is not attached to the person's identity. There is no way to link a session to an existing identity without face authentication today.

### After migration: Remove the old path

Remove any code path that restarts a completed session to collect an additional document or acceptance.

## Scenario 4: Modules that need earlier data

**Applies when:** a module is run that needs images or data captured in an earlier session. Examples include [Government Record Verification](/features-and-modules/government-record-verification/), [Video Selfie](/features-and-modules/video-selfie/), and [AES](/features-and-modules/advanced-electronic-signature/) or [QES](/features-and-modules/qualified-electronic-signature/) signing without face authentication.

**What to do instead:** get the input the module needs from the original onboarding, upload it into a new session, and run the module there. Incode does not move data between sessions, so you must supply it.

**Prerequisites:**

- The input the module needs. For most modules, this is the ID images and selfie from the original onboarding. Some modules need more, such as a phone number. Check the module's page, listed in [Modules Overview and Availability](/features-and-modules/modules-overview-and-availability/) for its required inputs.
- You can get the ID images and selfie in two ways:
  - **Keep your own copy**: Store the ID images and selfie when you capture them at onboarding.
  - **Retrieve them from the original session**: Use an admin token and the original `interviewId`. The original session is not reopened, and no new session is required to read them. Use this option for users onboarded before you started keeping copies. See [the prerequisites in Moving Off Session Restarts](/general-reference/moving-off-session-restarts/#scenario-1-reading-session-data) for the admin token.

:::warning
Retrieval depends on your data retention settings. Images already removed under your retention policy cannot be retrieved, and only your own copy will work. Check how far back your retention reaches before you rely on this option for older sessions.
:::

### What the change looks like

1. Get the ID images and selfie from your own storage or from the original session.
2. Create a new session.
3. Upload the images, and any other input the module needs, into the new session.
4. Run the module in the new session.

### The endpoints you'll call

Get the images from the original session. Pass the original session's `interviewId` as `id`. Without it, the endpoint reads the session from the token, which is not the session you want.

| Data required                                | Call                                                                                             |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Images, as download links valid for one hour | [`POST /omni/get/images/v2?id=<interviewId>`](/api-reference/get-images-v2/)                     |
| Second ID images                             | [`POST /omni/get/images-second-id/v2?id=<interviewId>`](/api-reference/get-images-second-id-v2/) |

These endpoints return links instead of base64 in the response body, which matters when retrieving in volume.

**Upload the images into the new session.**

| What                     | Call                                                                      |
| ------------------------ | ------------------------------------------------------------------------- |
| Front of the ID          | [`POST /omni/add/front-id/v2`](/api-reference/add-front-id-v2/)           |
| Back of the ID           | [`POST /omni/add/back-id/v2`](/api-reference/add-back-id-v2/)             |
| Process the ID           | [`POST /omni/process-id`](/api-reference/process-id/)                     |
| Selfie                   | [`POST /omni/add/face/third-party`](/api-reference/add-face-third-party/) |
| Compare selfie to the ID | [`POST /omni/process-face`](/api-reference/process-face/)                 |

Images go in the request body as either `base64Image` or `imageUrl`. Keep to this order:

- Upload the front of the ID before the back.
- Run `process-id` before `process-face`.
- After `process-id` has finished, the ID upload calls cannot be repeated on that session.

For selfies supplied by `imageUrl`, the domain must be allowlisted.

The Video Selfie module uses the previously captured selfie and ID as inputs, but it performs a new face capture, which is where liveness is checked. It does not replay the old capture.

### After migration: Remove the old path

Remove any code path that restarts the original session to run an additional module.

## Scenario 5: Retroactive module runs

**Applies when:** a module such as [CURP Validation](/features-and-modules/curp-validation/), [Antifraud Check](/features-and-modules/antifraud-check/), or [Custom Watchlist](/features-and-modules/custom-watchlist/) is contracted after onboarding and needs to run over existing sessions.

**Not supported.** A module runs only on sessions created after it is contracted. This is by design, and there is no migration path.

**What to do instead:** run the module on new sessions going forward. Where an existing user needs it, create a new session and supply the data you already hold, as in [Scenario 4](#scenario-4-modules-that-need-earlier-data).

---

- Path: `general-reference/supported-digital-ids`
- URL: https://developer.incode.com/general-reference/supported-digital-ids/
- Markdown: https://developer.incode.com/general-reference/supported-digital-ids.md

# Supported Digital IDs

Incode's Digital IDs capability lets you accept and verify government-issued digital identity credentials in any Incode flow. Digital IDs include mobile driver's licenses (mDLs), national eIDs, and government ID apps.

Digital IDs do not replace the rest of Incode's identity stack. They feed into it. Each digital ID session can still run liveness, deepfake detection, TrustGraph signal lookup, and risk scoring on top.

## Supported regions

- [**United States**](/general-reference/supported-digital-ids-united-states/): Mobile driver's licenses (mDLs) from Apple Wallet, Google Wallet, and Samsung Wallet.



- [**Europe**](/general-reference/supported-digital-ids-europe/): More than 20 national identity schemes, including MitID, BankID, itsme, SPID, and Smart-ID.



- [**Asia**](/general-reference/supported-digital-ids-asia/): Singpass, DigiLocker, and UAE Pass.



## Integration paths

Digital IDs can be integrated through three surfaces. All three require your Incode Representative to enable the Digital IDs feature for your organization first.

| Path                                | Where it lives        | Configuration                                                          |
| ----------------------------------- | --------------------- | ---------------------------------------------------------------------- |
| Dashboard (Web Flows and Workflows) | Hosted onboarding app | ID Capture module in each Workflow; no code changes                    |
| SDK (mobile, web)                   | Your app              | `verificationOptions.methods` in the SDK, plus Dashboard configuration |
| Server API                          | Your backend          | Direct API endpoints for session creation and credential exchange      |

For Dashboard configuration steps, see [ID Capture module configuration](/dashboard-platform-administration/id-capture-dashboard).

For the Web SDK headless integration, see [Digital ID Wallet Verification](/features-and-modules/digital-id-wallet-verification/).

## Selective disclosure

Unlike physical document capture, digital ID presentation is attribute-by-attribute. The wallet or scheme only releases the fields you explicitly request. Anything not requested never leaves the user's device.

Requested attributes are configured per flow in the Dashboard. Customers do not pass requested fields directly from the browser or SDK at runtime. This keeps every request aligned with the approved flow configuration.

When no custom attribute set is configured, Incode applies the default set for the enabled method.

## Observability

Every digital ID session logs:

- The method presented
- The verification outcome, including success or fail reason
- Whether a fallback was triggered, for example when a credential is missing and the user falls back to physical document capture
- The flow ID, session ID, and device metadata

These fields are available in session results and downstream analytics. See the per-region pages for method-specific attribute sets.

## Common integration notes

- **Device capability detection.** The iOS SDK checks entitlements and wallet contents before offering a method, so users do not reach a dead end on unsupported devices.
- **Chrome on iOS.** Digital IDs are not supported because of an Apple restriction. The SDK hides the option.
- **Desktop.** Not all credential types are available on desktop. See the per-region pages for details.
- **Selective disclosure.** Incode requests only the attributes required by your flow configuration. You control the minimum data set.

## Provider registration

Certain credential types require you to register as a relying party with the scheme operator. Incode Support guides you through this process and, where applicable, completes the registration on your behalf. Contact your Incode Representative to get started.

## Retrieving results

All digital ID methods return attributes via `GET /omni/get/ocr-data/v2` under the `ocrData` object. Two fields identify the credential source on every digital ID session:

- `documentSubmissionMethod` is always `IMPORTED_CREDENTIAL`
- `credentialsProvider` identifies the specific method (for example, `apple_wallet`, `mitid`, `singpass`)

Portrait photos, where available, are retrieved via `/omni/get/images`.

---

- Path: `general-reference/supported-digital-ids-asia`
- URL: https://developer.incode.com/general-reference/supported-digital-ids-asia/
- Markdown: https://developer.incode.com/general-reference/supported-digital-ids-asia.md

# Asia

Incode supports several digital identity schemes across Asia. To enable methods for a flow, go to **ID Capture Module** > **Digital IDs** in the Dashboard.

Contact your Incode Representative to enable support for specific countries.

## Available methods

| Method     | SDK ID       | Country                   |
| ---------- | ------------ | ------------------------- |
| Singpass   | `singpass`   | Singapore (SG)            |
| DigiLocker | `digilocker` | India (IN)                |
| UAE Pass   | `uae_pass`   | United Arab Emirates (AE) |

## Available attributes by method

All attributes are returned via `GET /omni/get/ocr-data/v2` under the `ocrData` object. Two fields identify the credential:

- `documentSubmissionMethod` is always `IMPORTED_CREDENTIAL` for digital ID sessions
- `credentialsProvider` identifies the specific scheme (for example, `singpass`, `digilocker`, `uae_pass`)

### Singpass: Singapore

| Attribute       | `ocrData` field            |
| --------------- | -------------------------- |
| Family name     | `name.paternalLastName`    |
| Full name       | `name.fullName`            |
| Date of birth   | `birthDate`                |
| Nationality     | `nationality`              |
| Gender          | `gender`                   |
| Phone number    | `phone`                    |
| Street          | `addressFields.street`     |
| Postal code     | `addressFields.postalCode` |
| Country         | `issuingCountry`           |
| Document type   | `typeOfId`                 |
| Document number | `documentNumber`           |
| Expiry date     | `expireAt`                 |

### DigiLocker: India

| Attribute               | `ocrData` field         |
| ----------------------- | ----------------------- |
| Given name              | `name.givenName`        |
| Family name             | `name.paternalLastName` |
| Date of birth           | `birthDate`             |
| Gender                  | `gender`                |
| Full address            | `address`               |
| Aadhaar number (masked) | `documentNumber`        |
| Portrait photo          | via `/omni/get/images`  |

### UAE Pass: United Arab Emirates

| Attribute          | `ocrData` field         |
| ------------------ | ----------------------- |
| Given name         | `name.givenName`        |
| Family name        | `name.paternalLastName` |
| Date of birth      | `birthDate`             |
| Emirates ID number | `documentNumber`        |
| Expiry date        | `expireAt`              |
| Portrait photo     | via `/omni/get/images`  |

---

- Path: `general-reference/supported-digital-ids-europe`
- URL: https://developer.incode.com/general-reference/supported-digital-ids-europe/
- Markdown: https://developer.incode.com/general-reference/supported-digital-ids-europe.md

# Europe

Incode supports more than 20 identity schemes across Europe. To enable methods for a flow, go to **ID Capture Module** > **Digital IDs** > **Europe** in the Dashboard. Methods are grouped by country. When multiple methods are enabled, users see the highest-adoption method for their detected location first.

Contact your Incode Representative to enable support for specific countries.

## Available methods

| Method                | SDK ID          | Country                                                           |
| --------------------- | --------------- | ----------------------------------------------------------------- |
| MitID                 | `mitid`         | Denmark (DK)                                                      |
| BankID Norway         | `bankid_norway` | Norway (NO)                                                       |
| BankID Sweden         | `bankid_sweden` | Sweden (SE)                                                       |
| Finnish Trust Network | `ftn`           | Finland (FI)                                                      |
| SPID                  | `spid`          | Italy (IT)                                                        |
| Audkenni              | `audkenni`      | Iceland (IS)                                                      |
| OneID                 | `oneid`         | United Kingdom (GB)                                               |
| Ukrainian DIIA        | `ukraine_diia`  | Ukraine (UA)                                                      |
| iDIN                  | `idin`          | Netherlands (NL)                                                  |
| itsme                 | `itsme`         | Belgium, Luxembourg, Netherlands (BE, LU, NL)                     |
| SwissID               | `swissid`       | Switzerland (CH)                                                  |
| Smart-ID              | `smart_id`      | Belgium, Estonia, Finland, Latvia, Lithuania (BE, EE, FI, LV, LT) |
| Mobile ID             | `mobile_id`     | Estonia, Lithuania (EE, LT)                                       |
| Evrotrust             | `evrotrust`     | Bulgaria (BG)                                                     |
| MojeID Poland         | `mojeid_poland` | Poland (PL)                                                       |
| eDO app               | `edo_app`       | Poland (PL)                                                       |
| Czech Bank iD         | `czech_bank_id` | Czech Republic (CZ)                                               |
| MojeID Czech          | `mojeid_czech`  | Czech Republic (CZ)                                               |
| eParaksts Mobile      | `eparaksts`     | Latvia (LV)                                                       |
| Digidentity           | `digidentity`   | Netherlands, United Kingdom (NL, GB)                              |
| Verimi                | `verimi`        | Germany (DE)                                                      |
| Freja eID             | `freja_eid`     | Sweden (SE)                                                       |

## Available attributes by method

All attributes are returned via `GET /omni/get/ocr-data/v2` under the `ocrData` object. Two fields identify the credential:

- `documentSubmissionMethod` is always `IMPORTED_CREDENTIAL` for digital ID sessions
- `credentialsProvider` identifies the specific scheme (for example, `mitid`, `bankid_sweden`, `itsme`)

### MitID: Denmark

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### BankID Norway: Norway

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Full name     | `name.fullName`         |
| Date of birth | `birthDate`             |

### BankID Sweden: Sweden

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Full name     | `name.fullName`         |
| Date of birth | `birthDate`             |
| Gender        | `gender`                |

### Finnish Trust Network: Finland

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### SPID: Italy

| Attribute      | `ocrData` field         |
| -------------- | ----------------------- |
| Given name     | `name.givenName`        |
| Family name    | `name.paternalLastName` |
| Date of birth  | `birthDate`             |
| Gender         | `gender`                |
| Phone          | `phone`                 |
| ID card number | `documentNumber`        |

### Audkenni: Iceland

| Attribute          | `ocrData` field         |
| ------------------ | ----------------------- |
| Given name         | `name.givenName`        |
| Family name        | `name.paternalLastName` |
| Date of birth      | `birthDate`             |
| National ID number | `documentNumber`        |

### OneID: United Kingdom

| Attribute      | `ocrData` field         |
| -------------- | ----------------------- |
| Given name     | `name.givenName`        |
| Family name    | `name.paternalLastName` |
| Date of birth  | `birthDate`             |
| Street address | `addressFields.street`  |

### Ukrainian DIIA: Ukraine

| Attribute       | `ocrData` field         |
| --------------- | ----------------------- |
| Given name      | `name.givenName`        |
| Family name     | `name.paternalLastName` |
| Date of birth   | `birthDate`             |
| Document number | `documentNumber`        |
| Portrait photo  | via `/omni/get/images`  |

### iDIN: Netherlands

| Attribute     | `ocrData` field            |
| ------------- | -------------------------- |
| Family name   | `name.paternalLastName`    |
| Date of birth | `birthDate`                |
| Gender        | `gender`                   |
| Street        | `addressFields.street`     |
| City          | `addressFields.city`       |
| Postal code   | `addressFields.postalCode` |
| Country       | `issuingCountry`           |
| Phone number  | `phone`                    |

### itsme: Belgium, Luxembourg, Netherlands

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### SwissID: Switzerland

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### Smart-ID: Belgium, Estonia, Finland, Latvia, Lithuania

| Attribute          | `ocrData` field         |
| ------------------ | ----------------------- |
| Given name         | `name.givenName`        |
| Family name        | `name.paternalLastName` |
| Date of birth      | `birthDate`             |
| National ID number | `documentNumber`        |

### Mobile ID: Estonia, Lithuania

| Attribute          | `ocrData` field         |
| ------------------ | ----------------------- |
| Given name         | `name.givenName`        |
| Family name        | `name.paternalLastName` |
| Date of birth      | `birthDate`             |
| National ID number | `documentNumber`        |

### Evrotrust: Bulgaria

| Attribute       | `ocrData` field         |
| --------------- | ----------------------- |
| Given name      | `name.givenName`        |
| Family name     | `name.paternalLastName` |
| Date of birth   | `birthDate`             |
| Document number | `documentNumber`        |

### MojeID Poland: Poland

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### eDO app: Poland

| Attribute       | `ocrData` field         |
| --------------- | ----------------------- |
| Given name      | `name.givenName`        |
| Family name     | `name.paternalLastName` |
| Date of birth   | `birthDate`             |
| Document number | `documentNumber`        |

### Czech Bank iD: Czech Republic

| Attribute      | `ocrData` field         |
| -------------- | ----------------------- |
| Given name     | `name.givenName`        |
| Family name    | `name.paternalLastName` |
| Date of birth  | `birthDate`             |
| Street address | `addressFields.street`  |

### MojeID Czech: Czech Republic

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### eParaksts Mobile: Latvia

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### Digidentity: Netherlands, United Kingdom

| Attribute     | `ocrData` field            |
| ------------- | -------------------------- |
| Given name    | `name.givenName`           |
| Family name   | `name.paternalLastName`    |
| Middle name   | `name.middleName`          |
| Date of birth | `birthDate`                |
| Phone number  | `phone`                    |
| Street        | `addressFields.street`     |
| Postal code   | `addressFields.postalCode` |
| Country       | `issuingCountry`           |
| Gender        | `gender`                   |

### Verimi: Germany

| Attribute     | `ocrData` field         |
| ------------- | ----------------------- |
| Given name    | `name.givenName`        |
| Family name   | `name.paternalLastName` |
| Date of birth | `birthDate`             |

### Freja eID: Sweden

| Attribute       | `ocrData` field         |
| --------------- | ----------------------- |
| Given name      | `name.givenName`        |
| Family name     | `name.paternalLastName` |
| Date of birth   | `birthDate`             |
| Personal number | `documentNumber`        |

---

- Path: `general-reference/supported-digital-ids-united-states`
- URL: https://developer.incode.com/general-reference/supported-digital-ids-united-states/
- Markdown: https://developer.incode.com/general-reference/supported-digital-ids-united-states.md

# United States

**Credential type:** Mobile Driver's License (mDL)
**Standard:** ISO 18013-5 (proximity) / ISO 18013-7 (online/remote)

US mDLs are state-issued driving licenses provisioned into a device wallet and cryptographically signed by the issuing state DMV. Incode supports three wallets. All three expose the same attribute set with selective disclosure.

In Dashboard, configure which fields to request per flow from the ID Capture module under **Digital IDs** > **United States**.

## Available methods

| Method         | SDK ID           |
| -------------- | ---------------- |
| Apple Wallet   | `apple_wallet`   |
| Google Wallet  | `google_wallet`  |
| Samsung Wallet | `samsung_wallet` |

## Available attributes

All attributes are selectable. Configure which attributes to request for each flow in the Dashboard.

| Attribute                            | `ocrData` field            |
| ------------------------------------ | -------------------------- |
| Given name                           | `name.givenName`           |
| Family name                          | `name.paternalLastName`    |
| Date of birth                        | `birthDate`                |
| Gender                               | `gender`                   |
| Height                               | `height`                   |
| Nationality                          | `nationality`              |
| Age 18+ confirmation (no DOB shared) | `ageOver18`                |
| Age 21+ confirmation (no DOB shared) | `ageOver21`                |
| License number                       | `documentNumber`           |
| Issue date                           | `issuedAt`                 |
| Expiry date                          | `expireAt`                 |
| Issuing country                      | `issuingCountry`           |
| Issuing authority                    | `issuingAuthority`         |
| Driving privileges                   | `drivingPrivileges`        |
| Full address                         | `address`                  |
| City                                 | `addressFields.city`       |
| State / Province                     | `addressFields.state`      |
| Postal code                          | `addressFields.postalCode` |
| Portrait photo                       | via `/omni/get/images`     |

Attributes are returned via `GET /omni/get/ocr-data/v2` under the `ocrData` object. Two fields identify the credential:

- `documentSubmissionMethod` is always `IMPORTED_CREDENTIAL` for digital ID sessions
- `credentialsProvider` identifies the specific wallet: `apple_wallet`, `google_wallet`, or `samsung_wallet`

## Selective disclosure and data minimization

Unlike physical document capture, mDL presentation is attribute-by-attribute. The wallet only releases the fields you explicitly request. Anything not requested never leaves the device.

The Dashboard pre-selects all available attributes when you first enable a wallet method. Configure each flow to request only what you actually need.

### Recommended attribute sets by use case

| Use case              | Request                                                                     |
| --------------------- | --------------------------------------------------------------------------- |
| Age gate              | `ageOver18` or `ageOver21` only, no DOB shared                              |
| Identity verification | `name.givenName`, `name.paternalLastName`, `birthDate`, portrait            |
| KYC / account opening | Add `documentNumber`, `issuedAt`, `expireAt`, `issuingAuthority`            |
| Address verification  | Add `addressFields.city`, `addressFields.state`, `addressFields.postalCode` |
| Driving eligibility   | Add `drivingPrivileges`                                                     |

`height`, `nationality`, `gender`, and `drivingPrivileges` should only be requested when directly relevant. Several US states with mDL programs restrict what relying parties may request. Request the minimum your use case requires.

## Provider registration

Apple Wallet web support requires the relying-party domain to be approved for wallet presentation. Coordinate with your Incode representative before going live with Apple Wallet.

Incode is an approved Google Verifier registrar and handles Google Wallet registration on your behalf. You provide basic verifier details (company name, logo, terms of service), and your Incode representative takes care of the rest. The user must still be on Android Chrome with a compatible digital ID in Google Wallet.

Contact your Incode Support representative to get started.

---

- Path: `general-reference/supported-ids`
- URL: https://developer.incode.com/general-reference/supported-ids/
- Markdown: https://developer.incode.com/general-reference/supported-ids.md

# Supported IDs

Supported IDs are identification documents that Incode can classify and extract information from. This includes passports, national ID cards, driver's licenses, and residence permits, with the specific document types varying by country.

Use this section to confirm whether a document from a given country is supported before you configure ID Capture in a Workflow or Flow. If your country isn't listed under a region, that document type isn't currently supported.

## Browse by Region

Countries are grouped by geographic area of origin. A few examples are called out under each region to help you find what you're looking for; open a region page for the full country list and supported document types.

- [Africa](/general-reference/supported-ids-africa/): Including Nigeria, South Africa, Kenya, and more.
- [Asia](/general-reference/supported-ids-asia/): Including India, Japan, Singapore, Hong Kong, and more.
- [Caribbean](/general-reference/supported-ids-caribbean/): Including Jamaica, Dominican Republic, Trinidad and Tobago, and more.
- [Central America](/general-reference/supported-ids-central-america/): Including Costa Rica, Panama, Guatemala, and more.
- [Europe](/general-reference/supported-ids-europe/): Including the United Kingdom, Germany, France, Spain, and more.
- [North America](/general-reference/supported-ids-north-central-america/): Including the United States, Canada, Mexico, and more.
- [Oceania](/general-reference/supported-ids-oceania/): Including Australia, New Zealand, and more.
- [South America](/general-reference/supported-ids-south-america/): Including Brazil, Argentina, Colombia, Chile, and more.

## Related Coverage References

Depending on what you're building, you may also need:

- [Supported Digital IDs](/general-reference/supported-digital-ids/): Incode support for mobile driver's licenses (mDLs), national eIDs, and government ID apps.
- [System of Records](/general-reference/government-verification-sources/): The government sources Incode queries to verify identity data.
- [eKYC country pages](/general-reference/ekyc-coverage/): Country-by-country eKYC support and data attributes.
- eKYB [Verification Coverage](/general-reference/ekyb-verification-coverage/) and [Prefill Coverage](/general-reference/ekyb-prefill-coverage/): Country-by-country eKYB support for business verification.

---

- Path: `general-reference/supported-ids-africa`
- URL: https://developer.incode.com/general-reference/supported-ids-africa/
- Markdown: https://developer.incode.com/general-reference/supported-ids-africa.md

# Africa

The following table lists supported identification documents for Africa, organized by country.

## Algeria (DZA)

| State | Type of ID         | Subtype of ID        | Version | Description          |
| :---- | :----------------- | :------------------- | :------ | :------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE      | 2018    | Driving License      |
| ALL   | DriversLicense     | DRIVERS_LICENSE      | 2020    | Driving License      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD  | 2016    | Identification Card  |
| ALL   | MedicalCard        | SOCIAL_SECURITY_CARD | 2024    | Social Security Card |
| ALL   | Passport           | NATIONAL_PASSPORT    | 2012    | Passport             |

## Angola (AGO)

| State | Type of ID         | Subtype of ID       | Version | Description                                                                   |
| :---- | :----------------- | :------------------ | :------ | :---------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2011    | Carta de Condução (Driving License)                                           |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Bilhete de Identidade de Cidadão Nacional (Identity Card of National Citizen) |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2025    | Refugee Identification Card                                                   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2000    | Passaporte / Passport                                                         |
| ALL   | Visa               | VISA                | 2024    | Visa                                                                          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2022    | Consular Card                                                                 |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2023    | Consular Card                                                                 |

## Benin (BEN)

| State | Type of ID         | Subtype of ID       | Version | Description                                                                   |
| :---- | :----------------- | :------------------ | :------ | :---------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Permis de Conduire (Driving License)                                          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Carte Nationale D'Identite (National I.D. Card)                               |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Carte D'Identité Cedeao / ECOWAS Identity Card                                |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Certificat D'Identification Personnelle (Personal Identification Certificate) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passeport (Passport)                                                          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passeport (Passport)                                                          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2024    | Passeport (Passport)                                                          |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2023    | Carte de Resident (Residence Permit)                                          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2019    | Carte D'Identite Consulaire (Consular Card)                                   |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Carte D'Identite Consulaire (Consular Card)                                   |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2021    | Carte D'Identite Consulaire (Consular Card)                                   |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2022    | Carte Consulaire / Consular Card                                              |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2023    | Carte D'Identite Consulaire (Consular Card)                                   |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2024    | Carte D'Identite Consulaire / Consular Card                                   |

## Botswana (BWA)

| State | Type of ID         | Subtype of ID       | Version | Description              |
| :---- | :----------------- | :------------------ | :------ | :----------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2020    | Driving License          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | National Identity Card   |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2023    | Permanent Residence Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | National Passport        |
| ALL   | Visa               | VISA                | 2022    | Visa                     |

## Burkina Faso (BFA)

| State | Type of ID         | Subtype of ID       | Version | Description                                                   |
| :---- | :----------------- | :------------------ | :------ | :------------------------------------------------------------ |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Permis de Conduire (Driving License)                          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2012    | Carte Nationale D'Identite Burkinabe (National Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2026    | Identification Card                                           |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passeport (Passport)                                          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passeport (Passport)                                          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2024    | Passport                                                      |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Carte Consulaire (Consular Card)                              |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2022    | Consular Card                                                 |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2025    | Consular Card                                                 |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2026    | Consular Card                                                 |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020    | Voter Identification Card                                     |

## Burundi (BDI)

| State | Type of ID         | Subtype of ID               | Version | Description                                                 |
| :---- | :----------------- | :-------------------------- | :------ | :---------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE             | 2016    | Permis de Conduire (Driving License)                        |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2020    | Carte d'Identité Pour Réfugié (Refugee Identification Card) |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2014    | Passeport (Passport)                                        |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2018    | Passeport (Passport)                                        |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2022    | Passeport (Passport)                                        |

## Cameroon (CMR)

| State | Type of ID          | Subtype of ID               | Version | Description                                         |
| :---- | :------------------ | :-------------------------- | :------ | :-------------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE             | 2009    | Permis de Conduire (Driving License)                |
| ALL   | DriversLicense      | DRIVERS_LICENSE             | 2020    | Permis de Conduire (Driving License)                |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD         | 2008    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD         | 2016    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD         | 2025    | Carte Nationale D'Identite (Identity Card)          |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD | 2022    | Refugee Identification Card                         |
| ALL   | TravelDocument      | CONSULAR_CARD               | 2021    | Consular Card                                       |
| ALL   | TravelDocument      | CONSULAR_CARD               | 2022    | Consulate Identity Card                             |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2013    | Passeport (Passport)                                |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2021    | Passeport (Passport)                                |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2023    | Passeport (Passport)                                |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD   | 2020    | Carte D'Electeur (Voter's Card)                     |
| ALL   | TravelDocument      | CONSULAR_CARD               | 2023    | Carte D'identite Consulaire (Consular Card)         |
| ALL   | TravelDocument      | CONSULAR_CARD               | 2024    | Consular Identity Card                              |
| ALL   | TravelDocument      | CONSULAR_CARD               | 2025    | Consular Card                                       |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT            | 2023    | Residence Permit                                    |
| ALL   | ResidenceDocument      | RESIDENCE_PERMIT            | 2026    | Carte de Sejour (Residence Permit) |
| ALL   | Visa                | VISA                        | 2022    | Visa                                                |

## Cape Verde (CPV)

| State | Type of ID         | Subtype of ID       | Version | Description                                                                   |
| :---- | :----------------- | :------------------ | :------ | :---------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2013    | Permis de Conduire (Driving License)                                          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2012    | Bilhete de Identidade de Cidadão Nacional (Identity Card of National Citizen) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | Cartão Nacional de Identificação (National Identity Card)                     |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2005    | Passaporte / Passport                                                         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passaporte / Passport                                                         |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Cartão de Identificação (Consular Card)                                       |

## Central African Republic (CAF)

| State | Type of ID     | Subtype of ID     | Version | Description                                          |
| :---- | :------------- | :---------------- | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense | DRIVERS_LICENSE   | 2010    | Permis de Conduire (Driving License)                 |
| ALL   | DriversLicense | DRIVERS_LICENSE   | 2020    | Permis de Conduire (Driver's License)                |
| ALL   | Passport       | NATIONAL_PASSPORT | 2018    | Passeport (Passport)                                 |
| ALL   | ResidenceDocument | RESIDENCE_PERMIT  | 2026    | Residence Permit                                     |
| ALL   | TravelDocument | CONSULAR_CARD     | 2024    | Carte D'Identite Consulaire / Consular Identity Card |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020 | Voter Identification Card |

## Comoros (COM)

| State | Type of ID         | Subtype of ID       | Version | Description                                         |
| :---- | :----------------- | :------------------ | :------ | :-------------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Passeport (Passport)                                |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2021    | Carte Consulaire / Consular Card                    |
| ALL   | Visa               | VISA                | 2023    | Visa                                                |

## Congo (COG)

| State | Type of ID          | Subtype of ID             | Version | Description                                         |
| :---- | :------------------ | :------------------------ | :------ | :-------------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2016    | Permis de Conduire (Driving License)                |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2023    | Permis de Conduire / Driving License                |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2019    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2024    | Identity Card                                       |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2024    | Carte D'Electeur (Voter Identification Card)        |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2013    | Passeport Ordinaire / Ordinary Passport             |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2019    | Passeport (Passport)                                |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT          | 2020    | Carte de Resident / Residence Permit                                    |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2024    | Carte Consulaire / Consular Card                    |

## Democratic Republic of the Congo (COD)

| State | Type of ID          | Subtype of ID              | Version | Description                                          |
| :---- | :------------------ | :------------------------- | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2017    | Permis de Conduire National (Driving License)        |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2018    | Driving License                                      |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2020    | Permis de Conduire / Driving License                 |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2021    | Permis de Conduire (Driving Licence)                 |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2022    | Driving License                                      |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2023    | Driving License                                      |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2024    | Driving License                                      |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT           | 2022    | Carte de Residence Pour Etrangers (Residence Permit) |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD | 2019    | Police Identification Card                           |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD | 2021    | Refugee Identification Card                          |
| ALL   | Military            | MILITARY_CARD              | 2020    | Carte d'Identite Militaire (Military Card)           |
| ALL   | Permit              | WORK_PERMIT                | 2023    | Carte de Travail Pour Etranger (Work Permit)         |
| ALL   | Passport            | NATIONAL_PASSPORT          | 2009    | Passeport (Passport)                                 |
| ALL   | Passport            | NATIONAL_PASSPORT          | 2015    | Passeport (Passport)                                 |
| ALL   | Passport            | NATIONAL_PASSPORT          | 2025    | Passeport / Passport                                 |
| ALL   | TravelDocument      | CONSULAR_IDENTITY_CARD     | 2020    | Consular Identity Card                               |
| ALL   | TravelDocument      | CONSULAR_IDENTITY_CARD     | 2022    | Carte Consulaire / Consular Identity Card            |
| ALL   | TravelDocument      | CONSULAR_IDENTITY_CARD     | 2023    | Carte Consulaire / Consular Card                     |
| ALL   | TravelDocument      | CONSULAR_IDENTITY_CARD     | 2024    | Carte Consulaire / Consular Card                     |
| ALL   | TravelDocument      | CONSULAR_IDENTITY_CARD     | 2025    | Carte Consulaire / Consular Card                     |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD  | 2010    | Carte D'Electeur (Voter's Card)                      |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD  | 2022    | Carte D'Electeur (Voter's Card)                      |

## Djibouti (DJI)

| State | Type of ID | Subtype of ID     | Version | Description          |
| :---- | :--------- | :---------------- | :------ | :------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2024    | Identification Card  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identification Card  |
| ALL   | Passport   | NATIONAL_PASSPORT | 2017    | Passeport (Passport) |

## Egypt (EGY)

| State | Type of ID         | Subtype of ID                | Version | Description                   |
| :---- | :----------------- | :--------------------------- | :------ | :---------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2012    | Driving License               |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2022    | Driving License               |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2023    | Driving License               |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT | 2021    | International Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2000    | Identity Card                 |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2021    | Foreign Residence Card        |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2008    | Passport                      |
| ALL   | Visa               | VISA                         | 2017    | Visa                          |

## Equatorial Guinea (GNQ)

| State | Type of ID         | Subtype of ID       | Version | Description                                     |
| :---- | :----------------- | :------------------ | :------ | :---------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Documento de Identidad Personal (Identity Card) |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Permiso de Conducción / Driving License         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Pasaporte (Passport)                            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2020    | Pasaporte (Passport)                            |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2024    | Permiso de Residencia (Residence Permit)        |

## Eritrea (ERI)

| State | Type of ID         | Subtype of ID       | Version | Description   |
| :---- | :----------------- | :------------------ | :------ | :------------ |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passport      |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2023    | Passport      |

## Eswatini (SWZ)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2007    | Driver's License       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2011    | National Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport               |

## Ethiopia (ETH)

| State       | Type of ID         | Subtype of ID               | Version | Description                       |
| :---------- | :----------------- | :-------------------------- | :------ | :-------------------------------- |
| ADDIS_ABABA | IdentificationCard | IDENTIFICATION_CARD         | 2020    | Addis Ababa City Resident ID Card |
| ADDIS_ABABA | ResidenceDocument  | RESIDENCE_DOCUMENT          | 2026    | Residence Document                |
| ALL         | DriversLicense     | DRIVERS_LICENSE             | 2004    | Driving License                   |
| ALL         | DriversLicense     | DRIVERS_LICENSE             | 2010    | Driving License                   |
| ALL         | DriversLicense     | DRIVERS_LICENSE             | 2011    | Driving License                   |
| ALL         | IdentificationCard | DIGITAL_IDENTIFICATION_CARD | 2023    | Ethiopian Digital ID Card         |
| ALL         | IdentificationCard | DIGITAL_IDENTIFICATION_CARD | 2024    | Ethiopian Digital ID Card         |
| ALL         | IdentificationCard | DIGITAL_IDENTIFICATION_CARD | 2025    | Ethiopian Digital ID Card         |
| ALL         | Other              | REFUGEE_IDENTIFICATION_CARD | 2022    | Refugee Identification Card       |
| ALL         | Passport           | NATIONAL_PASSPORT           | 2016    | Passport                          |
| ALL         | Passport           | NATIONAL_PASSPORT           | 2025    | Passport                          |
| ALL         | TravelDocument     | CONSULAR_CARD               | 2020    | Consular Card                     |
| ALL         | Visa               | VISA                        | 2024    | Visa                              |
| OROMIA      | IdentificationCard | IDENTIFICATION_CARD         | 2023    | Oromia Identification Card        |

## Gabon (GAB)

| State | Type of ID         | Subtype of ID       | Version | Description                                          |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2011    | Carte Nationale D'Identite (National Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Carte nationale d'identité (identity Card)           |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Carte D'Identite Consulaire (Consular Identity Card) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2020    | Residence Permit                                     |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2024    | Carte D'Identite Consulaire / Consular Identity Card |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2026    | Consular Card                                        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | Passeport / Passport                                 |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passeport / Passport                                 |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2022    | Passeport / Passport                                 |
| ALL   | Visa               | VISA                | 2014    | Visa                                                 |

## Ghana (GHA)

| State | Type of ID          | Subtype of ID                  | Version | Description                                       |
| :---- | :------------------ | :----------------------------- | :------ | :------------------------------------------------ |
| ALL   | DriversLicense      | DRIVERS_LICENSE                | 2008    | Driver License                                    |
| ALL   | DriversLicense      | DRIVERS_LICENSE                | 2018    | Driver License                                    |
| ALL   | DriversLicense      | LEARNERS_PERMIT                | 2018    | Learner's Driving License                         |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2010    | National Identity Card                            |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2024    | Identification Card                               |
| ALL   | IdentificationCard  | ECOWAS                         | 2019    | ECOWAS Identity Card                              |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD    | 2024    | Refugee ID Card                                   |
| ALL   | IdentificationCard  | DIPLOMATIC_IDENTIFICATION_CARD | 2024    | Diplomatic Identification Card                    |
| ALL   | MedicalCard         | MEDICAL_CARD                   | 2015    | Medical Card                                      |
| ALL   | MedicalCard         | MEDICAL_CARD                   | 2020    | Medical Card                                      |
| ALL   | MedicalCard         | VOTER_MEDICAL_CARD             | 2016    | NHIS Membership Identification Card               |
| ALL   | MedicalCard         | SSNIT_CARD                     | 2020    | Social Security and National Insurance Trust Card |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2007    | Passeport / Passport                              |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2010    | Passeport / Passport                              |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2023    | Passport                                          |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2025    | Passeport / Passport                              |
| ALL   | Visa                | VISA                           | 2024    | Visa                                              |
| ALL   | TravelDocument      | CONSULAR_CARD                  | 2022    | Carte Consulaire (Consular Card)                  |
| ALL   | TravelDocument      | CONSULAR_CARD                  | 2023    | Carte Consulaire (Consular Card)                  |
| ALL   | TravelDocument      | CONSULAR_CARD                  | 2024    | Carte D'Identite Consulaire (Consular Card)       |
| ALL   | TravelDocument      | CONSULAR_CARD                  | 2025    | Carte Consulaire / Consular Card                  |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2010    | Voter Card                                        |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2020    | Voter Card                                        |

## Guinea (GIN)

| State | Type of ID         | Subtype of ID       | Version | Description                                          |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2023    | Driving License                                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | Carte Nationale d'Identite (National Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | ECOWAS Identity Card                                 |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2007    | Passport                                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2014    | Passport                                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passport                                             |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2022    | Carte D'identite Consulaire (Consular Identity Card) |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2023    | Carte D'Identite Consulaire (Consular Card)          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2024    | Carte D'Identite Consulaire (Consular Card)          |
| ALL   | Visa               | VISA                | 2021    | Visa                                                 |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2017    | Voter Identification Card                            |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020    | Voter Identification Card                            |

## Guinea-Bissau (GNB)

| State | Type of ID          | Subtype of ID             | Version | Description                                   |
| :---- | :------------------ | :------------------------ | :------ | :-------------------------------------------- |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2021    | Ecowas Identity Card                          |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2021    | Passport                                      |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020    | Cartão de Eleitor (Voter Identification Card) |

## Ivory Coast (CIV)

| State | Type of ID         | Subtype of ID       | Version | Description                                          |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2000    | Permis de Conduire (Driving License)                 |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2014    | Permis de Conduire (Driving License)                 |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2009    | Carte Nationale D'Identite (National Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Carte Nationale D'Identite (National Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Attestation D'Identite (Identity Card)               |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2018    | Carte D'Identite Consulaire (Consular Identity Card) |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Carte Consulaire / Consular Card                     |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2021    | Carte D'Identite Consulaire (Consular Card)          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2022    | Carte D'Identite Consulaire / Consular Card          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2023    | Carte D'Identite Consulaire (Consular Card)          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2024    | Carte D'Identite Consulaire / Consular Card          |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2025    | Carte Consulaire / Consular Card                     |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2018    | Residence Permit                                     |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2024    | Resident Permit                                      |
| ALL   | MedicalCard        | MEDICAL_CARD        | 2023    | Carte D'Assure (Medical Card)                        |
| ALL   | MedicalCard        | MEDICAL_CARD        | 2024    | Medical Card                                         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passeport / Passport                                 |
| ALL   | Permit             | WORK_PERMIT         | 2025    | Work Permit                                          |
| ALL   | Visa             | VISA        | 2022    | Visa                                         |

## Kenya (KEN)

| State | Type of ID          | Subtype of ID                  | Version | Description                       |
| :---- | :------------------ | :----------------------------- | :------ | :-------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE                | 2019    | Driving License                   |
| ALL   | DriversLicense      | DRIVERS_LICENSE                | 2020    | Driving License                   |
| ALL   | DriversLicense      | DRIVERS_LICENSE                | 2024    | Driving License                   |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2011    | Identity Card                     |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2020    | National Identity Card            |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD    | 2016    | Refugee ID Card                   |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2023    | National Identity Card            |
| ALL   | IdentificationCard  | DIPLOMATIC_IDENTIFICATION_CARD | 2023    | Diplomatic Identity Card          |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD     | 2018    | Police Identification Card        |
| ALL   | IdentificationCard  | DISABILITY_IDENTIFICATION_CARD | 2023    | Disability Identification Card    |
| ALL   | MedicalCard         | MEDICAL_CARD                   | 2018    | Medical Card                      |
| ALL   | Passport            | NATIONAL_PASSPORT              | 1997    | Passeport / Passport              |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2007    | Passeport / Passport              |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2008    | Passeport / Passport              |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2015    | Passeport / Passport              |
| ALL   | Passport            | TRAVEL_DOCUMENT                | 2024    | Titre de Voyage / Travel Document |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT               | 2021    | Foreigner Certificate             |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2010    | Electors Card                     |
| ALL   | Military            | MILITARY_CARD                  | 2023    | Defence Forces Identity Card      |
| ALL   | Military            | MILITARY_CARD                  | 2024    | National Youth Service ID Card    |
| ALL   | Military            | MILITARY_CARD                  | 2025    | Veteran Identity Card             |

## Lesotho (LSO)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2012    | Driving License        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | National Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passeport / Passport   |

## Liberia (LBR)

| State | Type of ID         | Subtype of ID       | Version | Description                      |
| :---- | :----------------- | :------------------ | :------ | :------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | National Identification Card     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driver’s License                 |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport                         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2020    | Passeport / Passport             |
| ALL   | Permit             | WORK_PERMIT         | 2024    | Work Permit                      |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2023    | Carte Consulaire / Consular Card |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020    | Voter Identification Card        |

## Libya (LBY)

| State | Type of ID | Subtype of ID       | Version | Description         |
| :---- | :--------- | :------------------ | :------ | :------------------ |
| ALL   | DriversLicense | DRIVERS_LICENSE     | 2026    | Driving License     |
| ALL   | Passport   | NATIONAL_PASSPORT   | 2014    | Passport            |
| ALL   | Passport   | DIPLOMATIC_PASSPORT | 2020    | Diplomatic Passport
|
| ALL   | Passport   | DIPLOMATIC_PASSPORT | 2023    | Diplomatic Passport |
| ALL   | Passport   | SPECIAL_PASSPORT    | 2018    | Special Passport    |

## Madagascar (MDG)

| State | Type of ID         | Subtype of ID       | Version | Description                                      |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Permis de Conduire (Driving License)             |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2021    | Permis de Conduire (Driving License)             |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Kara Panondrom Pirenena (National Identity Card) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Pasipaoro (Passport)                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Pasipaoro (Passport)                             |

## Malawi (MWI)

| State | Type of ID         | Subtype of ID       | Version | Description                 |
| :---- | :----------------- | :------------------ | :------ | :-------------------------- |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Passeport / Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passeport / Passport        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2015    | Driving License             |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Traffic Register Card       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Citizen Identification Card |

## Mali (MLI)

| State | Type of ID         | Subtype of ID       | Version | Description                                    |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2023    | Carte D'Identite Cedeao (ECOWAS Identity Card) |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2025    | Refugee Identification Card                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passeport / Passport                           |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2025    | Passport                                       |

## Mauritania (MRT)

| State | Type of ID         | Subtype of ID       | Version | Description                            |
| :---- | :----------------- | :------------------ | :------ | :------------------------------------- |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passeport / Passport                   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passeport / Passport                   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Carte D'Identification (Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Carte D'Identification (Identity Card) |
| ALL   | ResidenceDocument  | RESIDENCE_CARD      | 2023    | Residence Card                         |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2025    | Consular Card                          |
| ALL   | Visa               | VISA                | 2016    | Visa                                   |

## Mauritius (MUS)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2013    | National Identity Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | National Identity Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS | 2022    | Identification Card for Foreigners |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passeport / Passport   |

## Morocco (MAR)

| State | Type of ID         | Subtype of ID       | Version | Description                                         |
| :---- | :----------------- | :------------------ | :------ | :-------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2000    | Permis de Conduire (Driving License)                |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2001    | Permis de Conduire (Driving License)                |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2020    | Permis de Conduire (Driving License)                |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2008    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | Passeport / Passport                                |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2026    | Passport                                            |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2023    | Residence Permit                                    |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Consular Card                                       |

## Mozambique (MOZ)

| State | Type of ID          | Subtype of ID             | Version | Description                           |
| :---- | :------------------ | :------------------------ | :------ | :------------------------------------ |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2015    | Carta de Condução (Driving License)   |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2021    | Carta de Condução (Driving License)   |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2015    | Bilhete de Identidade (Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2019    | Bilhete de Identidade (Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2020    | Bilhete de Identidade (Identity Card) |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2016    | Passaporte / Passport                 |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2020    | Passaporte / Passport                 |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2022    | Passport                              |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2010    | Cartão de Eleitor (Voter Card)        |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2023    | Cartão de Eleitor (Voter Card)        |
| ALL   | ResidenceDocument   | ASYLUM_SEEKER_CARD        | 2021    | Asylum Seeker Card                    |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2025    | Consular Card                         |
| ALL   | Visa                | VISA                      | 2010    | Visto / Visa                          |

## Namibia (NAM)

| State | Type of ID          | Subtype of ID             | Version | Description                          |
| :---- | :------------------ | :------------------------ | :------ | :----------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2017    | Carta de Condução (Driving License)  |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2022    | Permis de Conduire (Driving License) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2006    | National Identity Card               |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2014    | Ordinary Passport                    |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2018    | Ordinary Passport                    |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2014    | Voter Card                           |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2020    | Voter Card                           |

## Niger (NER)

| State | Type of ID     | Subtype of ID     | Version | Description                          |
| :---- | :------------- | :---------------- | :------ | :----------------------------------- |
| ALL   | Passport       | NATIONAL_PASSPORT | 2017    | Passeport / Passport                 |
| ALL   | DriversLicense | DRIVER_LICENSE    | 2020    | Permis de Conduire (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2026    | Identification Card                  |
| ALL   | Military       | MILITARY_CARD     | 2020    | Military Card                        |
| ALL   | TravelDocument | CONSULAR_CARD     | 2020    | Consular Card                        |
| ALL   | TravelDocument | CONSULAR_CARD     | 2024    | Carte Consulaire / Consular Card     |

## Nigeria (NGA)

| State | Type of ID          | Subtype of ID                 | Version | Description                                          |
| :---- | :------------------ | :---------------------------- | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense      | DRIVER_LICENSE                | 2019    | National Driver's License                            |
| ALL   | DriversLicense      | INTERNATIONAL_DRIVERS_LICENSE | 2022    | International Driving Permit                         |
| ALL   | DriversLicense      | INTERNATIONAL_DRIVERS_LICENSE | 2024    | International Driver's License                       |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 1995    | National Identification Number Slip (NINS)           |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 1996    | National Identification Number (NIN)                 |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2003    | National Identity Card                               |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2005    | National Identification Number Slip                  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2008    | Identification Card                                  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2010    | National Identification Number Slip (NINS)           |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2011    | National Identification Card                         |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2012    | Identification Card                                  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2013    | National Identification Card                         |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2015    | National Identity Card                               |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2016    | National Identification Number (NIN)                 |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2019    | National Identification Number Slip                  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2022    | National Identification Number (NIN)                 |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD           | 2023    | National Identification Number Slip                  |
| ALL   | IdentificationCard  | DIGITAL_IDENTIFICATION_CARD_PDF           | 2026    | Digital Identification Card                 |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD   | 2019    | Refugee Identity Card                                |
| ALL   | Military            | MILITARY_IDENTIFICATION_CARD  | 2023    | Military Identification Card                         |
| ALL   | Passport            | NATIONAL_PASSPORT             | 2019    | Passeport / Passport                                 |
| ALL   | Passport            | NATIONAL_PASSPORT             | 2020    | Passeport / Passport                                 |
| ALL   | TaxIdentification   | TAX_IDENTIFICATION            | 2015    | Tax Identification                                   |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION          | 2014    | Voter's Card                                         |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION          | 2018    | Voter's Card                                         |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION          | 2020    | Cartão de Eleitor (Voter Identification Card)        |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION          | 2024    | Nigerian Voter's Card                                |
| LAGOS | ResidenceDocument   | RESIDENCE_CARD                | 2015    | Lagos State Resident Card                            |
| LAGOS | ResidenceDocument   | RESIDENCE_CARD                | 2020    | Lagos Residence Card                                 |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2017    | Carte D'Identite Consulaire / Consular Identity Card |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2018    | Consular Card                                        |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2019    | Consular Identity Card                               |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2020    | Consular Card                                        |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2021    | Consular Identity Card                               |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2023    | Consular Card                                        |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2024    | Carte Consulaire Du Nigeria Au Mali / Consular Card  |
| ALL   | TravelDocument      | CONSULAR_CARD                 | 2025    | Consular Identity Card                               |
| ALL   | Visa                | VISA                          | 2024    | Visa                                                 |

## Republic of Chad (TCD)

| State | Type of ID          | Subtype of ID             | Version | Description                                  |
| :---- | :------------------ | :------------------------ | :------ | :------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2017    | Permis de Conduire (Driving License)         |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2019    | Carte Nationale D'Identite (Identity Card)   |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2024    | Carte d'Electeur / Voter Identification Card |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2018    | Passeport / Passport                         |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2020    | Passeport / Passport                         |

## Rwanda (RWA)

| State | Type of ID         | Subtype of ID               | Version | Description                                          |
| :---- | :----------------- | :-------------------------- | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE             | 2008    | Uruhushya Rwo Gutwara Ibinyabiziga (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2019    | Indangamuntu (National Identity Card)                |
| ALL   | ResidenceDocument  | RESIDENCE_CARD              | 2024    | Resident Identity Card                               |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2019    | Pasiporo (Passport)                                  |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2020    | Passeport / Passport                                 |
| ALL   | TravelDocument     | LAISSEZ_PASSER              | 2023    | Laissez - Passer                                     |
| ALL   | TravelDocument     | REFUGEE_TRAVEL_DOCUMENT     | 2024    | Refugee Travel Document                              |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2022    | Refugee Identity Card                                |
| ALL   | Visa               | VISA                        | 2024    | Visa                                                 |

## Sao Tome and Principe (STP)

| State | Type of ID | Subtype of ID     | Version | Description                       |
| :---- | :--------- | :---------------- | :------ | :-------------------------------- |
| ALL   | Passport   | NATIONAL_PASSPORT | 2016    | Passeport / Passport / Passaporte |
| ALL   | Passport   | NATIONAL_PASSPORT | 2018    | Passeport / Passport              |

## Senegal (SEN)

| State | Type of ID          | Subtype of ID             | Version | Description                                         |
| :---- | :------------------ | :------------------------ | :------ | :-------------------------------------------------- |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2010    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2017    | Carte D'Identite Cedeao (ECOWAS Identity Card)      |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2018    | Permis de Conduire (Driving License)                |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2024    | Carte d'Electeur / Voter Identification Card        |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2024    | Carte D'Identite Consulaire / Consular Card         |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2014    | Passeport / Passport                                |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2025    | Passeport / Passport                                |

## Seychelles (SYC)

| State | Type of ID         | Subtype of ID                | Version | Description            |
| :---- | :----------------- | :--------------------------- | :------ | :--------------------- |
| ALL   | IdentificationCard | NATIONAL_IDENTIFICATION_CARD | 2010    | National Identity Card |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2016    | Driving Licence        |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2017    | Passeport / Passport   |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2023    | Passeport / Passport   |

## Sierra Leone (SLE)

| State | Type of ID          | Subtype of ID        | Version | Description             |
| :---- | :------------------ | :------------------- | :------ | :---------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE      | 2018    | Motor Driver's License  |
| ALL   | DriversLicense      | DRIVERS_LICENSE      | 2023    | Motor Driver's License  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD  | 2020    | National Identity Card  |
| ALL   | MedicalCard         | SOCIAL_SECURITY_CARD | 2022    | Social Security Card    |
| ALL   | Passport            | NATIONAL_PASSPORT    | 2017    | Passeport / Passport    |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION | 2010    | Voter ID Card           |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION | 2020    | Voter Registration Card |

## Somalia (SOM)

| State      | Type of ID         | Subtype of ID                 | Version | Description                       |
| :--------- | :----------------- | :---------------------------- | :------ | :-------------------------------- |
| ALL        | DriversLicense     | DRIVERS_LICENSE               | 2015    | Driver License                    |
| ALL        | DriversLicense     | DRIVERS_LICENSE               | 2019    | Driver License                    |
| ALL        | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2023    | International Driver's License    |
| ALL        | IdentificationCard | IDENTIFICATION_CARD           | 2016    | Identity Card                     |
| ALL        | IdentificationCard | IDENTIFICATION_CARD           | 2023    | Identity Card                     |
| ALL        | Passport           | NATIONAL_PASSPORT             | 2007    | Passport                          |
| ALL        | Passport           | NATIONAL_PASSPORT             | 2010    | Passport                          |
| ALL        | Passport           | NATIONAL_PASSPORT             | 2018    | Passport                          |
| ALL        | VoterIdentification | VOTER_IDENTIFICATION_CARD     | 2023    | Voter Identification Card         |
| ALL        | VoterIdentification | VOTER_IDENTIFICATION_CARD     | 2025    | Voter Identification Card         |
| SOMALILAND | DriversLicense     | DRIVERS_LICENSE               | 2024    | Somaliland Driving License        |
| SOMALILAND | IdentificationCard | IDENTIFICATION_CARD           | 2024    | Somaliland National Identity Card |
| SOMALILAND | IdentificationCard | IDENTIFICATION_CARD           | 2026    | Identification Card               |
| SOMALILAND | Military           | MILITARY_CARD                 | 2025    | Military Card                     |
| SOMALILAND | VoterIdentification | VOTER_IDENTIFICATION_CARD     | 2021    | Voter Identification Card         |
| SOMALILAND | Passport | NATIONAL_PASSPORT     | 2018    | Passport        |

## South Africa (ZAF)

| State | Type of ID         | Subtype of ID                | Version | Description                         |
| :---- | :----------------- | :--------------------------- | :------ | :---------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2005    | Carta de Conducao (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 1996    | National Identity Card              |
| ALL   | IdentificationCard | NATIONAL_IDENTIFICATION_CARD | 2015    | National Identity Card              |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2007    | Passeport / Passport                |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2009    | Passeport / Passport                |
| ALL   | Passport           | TRAVEL_DOCUMENT              | 2018    | Travel Document                     |
| ALL   | Visa               | WORK_VISA                    | 2010    | Zimbabwean Exemption Permit (ZEP)   |

## South Sudan (SSD)

| State | Type of ID         | Subtype of ID       | Version | Description             |
| :---- | :----------------- | :------------------ | :------ | :---------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2023    | Driving Licence         |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2024    | Driving License         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2014    | Nationality Certificate |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2024    | National ID Card        |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2023    | Refugee Identification Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Passport                |
| ALL   | Visa               | VISA                | 2013    | Visa                    |

## Sudan (SDN)

| State | Type of ID         | Subtype of ID       | Version | Description         |
| :---- | :----------------- | :------------------ | :------ | :------------------ |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Driving License     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driving License     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identification Card |
| ALL   | Military           | MILITARY_CARD       | 2021    | Military Card       |
| ALL   | Military           | MILITARY_CARD       | 2026    | Military Card       |
| ALL   | Passport           | DIPLOMATIC_PASSPORT | 2020    | Diplomatic Passport |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passport            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2025    | Passport            |

## Tanzania (TZA)

| State    | Type of ID          | Subtype of ID                  | Version | Description                                               |
| :------- | :------------------ | :----------------------------- | :------ | :-------------------------------------------------------- |
| ALL      | DriversLicense      | DRIVERS_LICENSE                | 2017    | Driving License                                           |
| ALL      | IdentificationCard  | IDENTIFICATION_CARD            | 2014    | Citizen Identity Card                                     |
| ALL      | IdentificationCard  | IDENTIFICATION_CARD            | 2015    | Citizen Identity Card                                     |
| ALL      | IdentificationCard  | IDENTIFICATION_CARD            | 2020    | Citizen Identity Card                                     |
| ALL      | IdentificationCard  | POLICE_IDENTIFICATION_CARD     | 2024    | Police Identity Card                                      |
| ALL      | IdentificationCard  | DIPLOMATIC_IDENTIFICATION_CARD | 2024    | Diplomatic Identity Card                                  |
| ALL      | Passport            | NATIONAL_PASSPORT              | 2005    | Pasipoti (Passport)                                       |
| ALL      | Passport            | NATIONAL_PASSPORT              | 2018    | Pasipoti (Passport)                                       |
| ALL      | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2015    | Kadi Ya Mpiga Kura (Voter's Card)                         |
| ALL      | MedicalCard         | MEDICAL_CARD                   | 2011    | Medical Card                                              |
| ALL      | MedicalCard         | MEDICAL_CARD                   | 2013    | Membership Identity Card (National Health Insurance Fund) |
| ALL      | MedicalCard         | MEDICAL_CARD                   | 2019    | Medical Card                                              |
| ALL      | Other               | CABIN_CREW_CERTIFICATE         | 2024    | Cabin Crew Certificate                                    |
| ZANZIBAR | DriversLicense      | DRIVERS_LICENSE                | 2021    | Zanzibar Driver's License                                 |
| ZANZIBAR | IdentificationCard  | IDENTIFICATION_CARD            | 2013    | Identification Card                                       |

## The Gambia (GMB)

| State | Type of ID          | Subtype of ID        | Version | Description                                    |
| :---- | :------------------ | :------------------- | :------ | :--------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE      | 2022    | Driver License                                 |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD  | 2015    | Identification Card                            |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD  | 2019    | Carte D'Identite Cedeao (ECOWAS Identity Card) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD  | 2024    | Identification Card                            |
| ALL   | MedicalCard         | HEALTH_CARD          | 2023    | Health Card                                    |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION | 2020    | Voter ID Card                                  |
| ALL   | Passport            | NATIONAL_PASSPORT    | 2002    | Passeport / Passport                           |
| ALL   | Passport            | NATIONAL_PASSPORT    | 2012    | Passeport / Passport                           |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT     | 2023    | Resident Permit - ''B'' Ecowas                 |

## Togo (TGO)

| State | Type of ID          | Subtype of ID             | Version | Description                                         |
| :---- | :------------------ | :------------------------ | :------ | :-------------------------------------------------- |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2020    | Identity Card                                       |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2021    | Carte Nationale D'Identite (National Identity Card) |
| ALL   | DriversLicense      | DRIVERS_LICENSE           | 2020    | Permis de Conduire (Driving License)                |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2024    | Carte d'Electeur / Voter Identification Card        |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT          | 2023    | Residence Permit                                    |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2021    | Carte D'Identite Consulaire / Consular Card         |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2022    | Carte D'Identite Consulaire (Consular Card)         |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2023    | Carte D'Identite Consulaire (Consular Card)         |
| ALL   | TravelDocument      | CONSULAR_CARD             | 2025    | Carte Consulaire (Consular Card)                    |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2017    | Passeport / Passport                                |
| ALL   | Visa            | VISA         | 2023    | Visa                               |

## Tunisia (TUN)

| State | Type of ID         | Subtype of ID       | Version | Description                          |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2002    | Permis de Conduire (Driving License) |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2012    | Permis de Conduire (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2008    | Identity Card                        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2003    | Passport                             |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2026    | Residence Permit                     |

## Uganda (UGA)

| State | Type of ID          | Subtype of ID               | Version | Description                          |
| :---- | :------------------ | :-------------------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE             | 2015    | Permis de Conduire / Driving Permit  |
| ALL   | DriversLicense      | DRIVERS_LICENSE             | 2018    | Permis de Conduire / Driving Permit  |
| ALL   | DriversLicense      | DRIVERS_LICENSE             | 2021    | Permis de Conduire / Driving License |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD         | 2014    | National ID Card                     |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD         | 2025    | National ID Card                     |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD   | 2020    | Voter Identification Card            |
| ALL   | ResidenceDocument   | RESIDENCE_PERMIT            | 2024    | Residential Card                     |
| ALL   | Military            | MILITARY_CARD               | 2022    | Uganda People's Defence Forces Card  |
| ALL   | Other               | REFUGEE_IDENTIFICATION_CARD | 2018    | Refugee Identity Card                |
| ALL   | Other               | REFUGEE_IDENTIFICATION_CARD | 2022    | Refugee Identity Card                |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2003    | Passeport / Passport                 |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2018    | Passeport / Passport                 |
| ALL   | Passport            | NATIONAL_PASSPORT           | 2023    | Passeport / Passport                 |
| ALL   | Visa                | VISA                        | 2024    | Visa                                 |

## Zambia (ZMB)

| State | Type of ID          | Subtype of ID                   | Version | Description                                   |
| :---- | :------------------ | :------------------------------ | :------ | :-------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE                 | 2020    | Driving License                               |
| ALL   | DriversLicense      | DRIVERS_LICENSE                 | 2024    | Driving License                               |
| ALL   | IdentificationCard  | COMMON_WEALTH_REGISTRATION_CARD | 2019    | Commonwealth Registration Card                |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD             | 2019    | National Registration Card                    |
| ALL   | IdentificationCard  | REFUGEE_IDENTIFICATION_CARD     | 2024    | Refugee Identity Card                         |
| ALL   | MedicalCard         | MEDICAL_CARD                    | 2023    | The National Health Insurance Membership Card |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD       | 2020    | Voter's Card                                  |
| ALL   | TravelDocument      | CONSULAR_CARD                   | 2024    | Diplomatic Permit                             |
| ALL   | Passport            | NATIONAL_PASSPORT               | 2008    | Passeport / Passport                          |

## Zimbabwe (ZWE)

| State | Type of ID         | Subtype of ID                 | Version | Description                    |
| :---- | :----------------- | :---------------------------- | :------ | :----------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2000    | Driver's License               |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2024    | Driving License                |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2022    | International Driver's License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2010    | National Registration Card     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2011    | National Registration Card     |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2011    | Passport                       |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2022    | Passport                       |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT              | 2025    | Residence Permit               |

---

- Path: `general-reference/supported-ids-asia`
- URL: https://developer.incode.com/general-reference/supported-ids-asia/
- Markdown: https://developer.incode.com/general-reference/supported-ids-asia.md

# Asia

The following tables list supported identification documents for Asia, organized by country. The tables for India and the Philippines are further divided by ID type or state.

## Afghanistan (AFG)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | National Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Diplomatic Passport    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport               |

## Armenia (ARM)

| State | Type of ID         | Subtype of ID            | Version | Description                          |
| :---- | :----------------- | :----------------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE          | 2013    | Permis de Conduire (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD      | 2014    | ID Card                              |
| ALL   | Passport           | NATIONAL_PASSPORT        | 2012    | Passport                             |
| ALL   | Passport           | NATIONAL_PASSPORT        | 2015    | Passport                             |
| ALL   | Passport           | NATIONAL_PASSPORT        | 2021    | Travel Document / Passport           |
| ALL   | ResidenceDocument  | RESIDENCE_CARD           | 2010    | Residence Card                       |
| ALL   | ResidenceDocument  | RESIDENCE_CARD           | 2023    | Residence Card                       |
| ALL   | ResidenceDocument  | TEMPORARY_RESIDENCE_CARD | 2024    | Temporary Residence Card             |

## Azerbaijan (AZE)

| State | Type of ID         | Subtype of ID       | Version | Description                          |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2013    | Permis de Conduire (Driving License) |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2021    | Driving License                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2005    | Identity Card                        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2019    | Identity Card                        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identity Card                        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 1998    | Passport                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passport                             |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2023    | Permit for Temporary Residence       |

## Bahrain (BHR)

| State | Type of ID         | Subtype of ID       | Version | Description      |
| :---- | :----------------- | :------------------ | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Driving License  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Identity Card    |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2019    | Identity Card    |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identity Card    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2010    | Passport         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2024    | Passport         |
| ALL   | Passport           | RESIDENCE_DOCUMENT  | 2010    | Residence Permit |
| ALL   | Passport           | RESIDENCE_DOCUMENT  | 2021    | Residence Permit |

## Bangladesh (BGD)

| State | Type of ID         | Subtype of ID               | Version | Description                        |
| :---- | :----------------- | :-------------------------- | :------ | :--------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE             | 2012    | Motor Driving License              |
| ALL   | DriversLicense     | DRIVERS_LICENSE             | 2017    | Professional Motor Driving License |
| ALL   | DriversLicense     | PROVISIONAL_DRIVERS_LICENSE | 2024    | Non Professional E-Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2006    | National ID Card                   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2016    | National ID Card                   |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2017    | Passport                           |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2019    | Official Passport                  |
| ALL   | Visa               | VISA                        | 2017    | Visa                               |

## Bhutan (BTN)

| State | Type of ID         | Subtype of ID       | Version | Description      |
| :---- | :----------------- | :------------------ | :------ | :--------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Citizenship Card |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driving License  |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2006    | Passport         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2020    | Residence Permit |

## Brunei (BRN)

| State | Type of ID         | Subtype of ID       | Version | Description                     |
| :---- | :----------------- | :------------------ | :------ | :------------------------------ |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2015    | Lesen Memandu / Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Lesen Memandu / Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Identity Card                   |
| ALL   | Military           | MILITARY_CARD       | 2020    | Armed Forces Identity Card      |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2008    | Passport                        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2019    | Certificate of Identity         |

## Cambodia (KHM)

| State | Type of ID         | Subtype of ID       | Version | Description      |
| :---- | :----------------- | :------------------ | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2010    | Driving License  |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2019    | Driver's License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driver's License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Identity Card    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passport         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passport         |
| ALL   | Passport           | TRAVEL_DOCUMENT     | 2023    | Travel Document  |
| ALL   | ResidenceDocument  | PERMANENT_RESIDENCE_CARD | 2025    | Permanent Residence Card |

## China (CHN)

| State | Type of ID         | Subtype of ID               | Version | Description                                                                                     |
| :---- | :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE             | 2001    | Driving License of the People's Republic of China                                               |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2004    | Domestic Identity Card                                                                          |
| ALL   | Other              | HUKOU_CARD                  | 2010    | Hukou Card                                                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2007    | Passport                                                                                        |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2012    | Passport                                                                                        |
| ALL   | Passport           | DIPLOMATIC_PASSPORT         | 2023    | Diplomatic Passport                                                                             |
| ALL   | Passport           | SERVICE_PASSPORT            | 2022    | Service Passport                                                                                |
| ALL   | Passport           | SERVICE_PASSPORT            | 2024    | Passport for Public Affairs                                                                     |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT            | 2017    | Residence Permit                                                                                |
| ALL   | TravelDocument     | EXIT_ENTRY_PERMIT           | 2014    | Exit-Entry Permit                                                                               |
| ALL   | TravelDocument     | HOME_RETURN_PERMIT          | 2012    | Mainland Travel Permit                                                                          |
| ALL   | Visa               | VISA                        | 2002    | Visa                                                                                            |
| ALL   | Visa               | VISA                        | 2024    | Visa                                                                                            |
| MACAU | DriversLicense     | DRIVER_LICENSE              | 2000    | Carta de condução de Macau (Driving License)                                                    |
| MACAU | Passport           | NATIONAL_PASSPORT           | 2009    | Macau Passport                                                                                  |
| MACAU | Passport           | NATIONAL_PASSPORT           | 2019    | Macau Passport                                                                                  |
| MACAU | ResidenceDocument  | PERMANENT_RESIDENT_IDENTITY | 2002    | Bilhete de Identidade de Residente Permanente de Macau (Macau Permanent Resident Identity Card) |
| MACAU | ResidenceDocument  | PERMANENT_RESIDENT_IDENTITY | 2013    | Bilhete de Identidade de Residente Permanente de Macau (Macau Permanent Resident Identity Card) |

## East Timor (TLS)

| State | Type of ID         | Subtype of ID       | Version | Description                          |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | Bilhete de Identidade (Citizen Card) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passaporte / Passport                |
| ALL   | VoterIdentification          | VOTER_IDENTIFICATION_CARD   | 2025    | Voter Identification Card               |

## Hong Kong (HKG)

| State | Type of ID        | Subtype of ID               | Version | Description             |
| :---- | :---------------- | :-------------------------- | :------ | :---------------------- |
| ALL   | DriversLicense    | DRIVERS_LICENSE             | 2000    | Driving License         |
| ALL   | Passport          | NATIONAL_PASSPORT           | 2007    | Passport                |
| ALL   | Passport          | NATIONAL_PASSPORT           | 2019    | Passport                |
| ALL   | ResidenceDocument | PERMANENT_RESIDENT_IDENTITY | 2003    | Permanent Identity Card |
| ALL   | ResidenceDocument | PERMANENT_RESIDENT_IDENTITY | 2018    | Permanent Identity Card |

## India (IND)

### National IDs

| State | Type of ID          | Subtype of ID                  | Version | Description                                |
| :---- | :------------------ | :----------------------------- | :------ | :----------------------------------------- |
| ALL   | DriversLicense      | DRIVER_LICENSE                 | 2003    | Union of India Driving License             |
| ALL   | DriversLicense      | DRIVER_LICENSE                 | 2007    | Indian Driving License                     |
| ALL   | DriversLicense      | DRIVER_LICENSE                 | 2011    | Indian Union Driving License               |
| ALL   | DriversLicense      | DRIVER_LICENSE                 | 2024    | Driving License                            |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2005    | Aadhaar Card (Identity Card)               |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2010    | Aadhaar Card (Identity Card)               |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD            | 2015    | Identification Card                        |
| ALL   | IdentificationCard  | DIPLOMATIC_IDENTIFICATION_CARD | 2023    | Diplomatic Identity Card                   |
| ALL   | IdentificationCard  | PENSIONERS_IDENTITY_CARD       | 2024    | Pensioner's Identity Card                  |
| ALL   | IdentificationCard  | AIRFORCE_IDENTIFICATION_CARD   | 2023    | Retired Officers Identity Card             |
| ALL   | IdentificationCard  | AIRFORCE_IDENTIFICATION_CARD   | 2024    | Air force Identification Card              |
| ALL   | IdentificationCard  | MASKED_IDENTIFICATION_CARD     | 2005    | Masked Identification Card                 |
| ALL   | IdentificationCard  | MASKED_IDENTIFICATION_CARD     | 2015    | Masked Identification Card                 |
| ALL   | MedicalCard         | MEDICAL_CARD                   | 2020    | Medical Card                               |
| ALL   | MedicalCard         | MEDICAL_CARD                   | 2024    | Medical Card                               |
| ALL   | Military            | MILITARY_CARD                  | 2020    | Retired Officer's Identity Card            |
| ALL   | Military            | MILITARY_CARD                  | 2021    | Indian Armed Forces Identity Card          |
| ALL   | Military            | PENSIONERS_IDENTITY_CARD       | 2020    | Pensioner's Identity Card                  |
| ALL   | Military            | PENSIONERS_IDENTITY_CARD       | 2021    | Military Pensioner's Identity Card         |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2005    | Passport                                   |
| ALL   | Passport            | NATIONAL_PASSPORT              | 2019    | Passport                                   |
| ALL   | TaxIdentification   | TAX_DEPARTMENT                 | 2000    | Tax Identification Card                    |
| ALL   | TaxIdentification   | TAX_DEPARTMENT                 | 2010    | Tax Identification Card                    |
| ALL   | TaxIdentification   | TAX_DEPARTMENT                 | 2015    | Tax Identification Card                    |
| ALL   | TaxIdentification   | TAX_DEPARTMENT                 | 2019    | Tax Identification Card                    |
| ALL   | TaxIdentification   | TAX_DEPARTMENT                 | 2020    | Tax Identification Card                    |
| ALL   | Visa                | VISA                           | 2000    | Visa                                       |
| ALL   | Visa                | VISA                           | 2001    | Visa                                       |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2000    | Elector Photo Identity Card                |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2009    | Voter Identification Card                  |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2010    | Election Commission of India Identity Card |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2015    | Voter Identification Card                  |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2022    | Voter Identification Card                  |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD      | 2023    | Voter Identification Card                  |
| ALL   | TravelDocument | CERTIFICATE_OF_REGISTRATION_OCI     | 2018    | Certificate of Registration OCI                 |

### Andaman and Nicobar

| State               | Type of ID     | Subtype of ID   | Version | Description                         |
| :------------------ | :------------- | :-------------- | :------ | :---------------------------------- |
| ANDAMAN_AND_NICOBAR | DriversLicense | DRIVERS_LICENSE | 2024    | Andaman and Nicobar Driving License |

### Andhra Pradesh

| State          | Type of ID     | Subtype of ID   | Version | Description                                   |
| :------------- | :------------- | :-------------- | :------ | :-------------------------------------------- |
| ANDHRA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2010    | Andhra Pradesh - Indian Union Driving License |
| ANDHRA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2011    | Andhra Pradesh - Indian Union Driving License |
| ANDHRA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2020    | Andhra Pradesh - Indian Union Driving License |
| ANDHRA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2021    | Andhra Pradesh - Indian Union Driving License |
| ANDHRA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2024    | Andhra Pradesh Driving License                |

### Arunachal Pradesh

| State             | Type of ID     | Subtype of ID   | Version | Description                       |
| :---------------- | :------------- | :-------------- | :------ | :-------------------------------- |
| ARUNACHAL_PRADESH | DriversLicense | DRIVERS_LICENSE | 2020    | Arunachal Pradesh Driving License |
| ARUNACHAL_PRADESH | DriversLicense | DRIVERS_LICENSE | 2023    | Arunachal Pradesh Driving License |

### Assam

| State | Type of ID     | Subtype of ID   | Version | Description                                        |
| :---- | :------------- | :-------------- | :------ | :------------------------------------------------- |
| ASSAM | DriversLicense | DRIVERS_LICENSE | 2010    | Government of Assam - Indian Union Driving License |
| ASSAM | DriversLicense | DRIVERS_LICENSE | 2021    | Assam Driving License                              |
| ASSAM | DriversLicense | DRIVERS_LICENSE | 2022    | Assam Driving License                              |

### Bihar

| State | Type of ID     | Subtype of ID   | Version | Description                                        |
| :---- | :------------- | :-------------- | :------ | :------------------------------------------------- |
| BIHAR | DriversLicense | DRIVERS_LICENSE | 2016    | Government of Bihar - Indian Driving License       |
| BIHAR | DriversLicense | DRIVERS_LICENSE | 2022    | Indian Union Driving License - Government of Bihar |
| BIHAR | DriversLicense | DRIVERS_LICENSE | 2024    | Bihar Driving License                              |

### Chandigarh

| State      | Type of ID     | Subtype of ID   | Version | Description                        |
| :--------- | :------------- | :-------------- | :------ | :--------------------------------- |
| CHANDIGARH | DriversLicense | DRIVERS_LICENSE | 2008    | Driving License - Chandigarh State |

### Chhattisgarh

| State        | Type of ID     | Subtype of ID   | Version | Description                                               |
| :----------- | :------------- | :-------------- | :------ | :-------------------------------------------------------- |
| CHHATTISGARH | DriversLicense | DRIVERS_LICENSE | 2008    | Indian Union Driving License - Chhattisgarh State         |
| CHHATTISGARH | DriversLicense | DRIVERS_LICENSE | 2009    | Indian Union Driving License - Government of Chhattisgarh |
| CHHATTISGARH | DriversLicense | DRIVERS_LICENSE | 2023    | Chhattisgarh Driving License                              |

### Dadra and Nagar Haveli

| State                  | Type of ID     | Subtype of ID   | Version | Description                            |
| :--------------------- | :------------- | :-------------- | :------ | :------------------------------------- |
| DADRA_AND_NAGAR_HAVELI | DriversLicense | DRIVERS_LICENSE | 2016    | Dadra and Nagar Haveli Driving License |

### Delhi

| State | Type of ID     | Subtype of ID   | Version | Description                                                       |
| :---- | :------------- | :-------------- | :------ | :---------------------------------------------------------------- |
| DELHI | DriversLicense | DRIVERS_LICENSE | 2002    | Delhi Driving License                                             |
| DELHI | DriversLicense | DRIVERS_LICENSE | 2003    | Indian Union Driving License - Transport Department GNCT of Delhi |
| DELHI | DriversLicense | DRIVERS_LICENSE | 2009    | Driving License - Transport Department Government of NCT of Delhi |
| DELHI | DriversLicense | DRIVERS_LICENSE | 2019    | Driving License - Transport Department Government of NCT of Delhi |
| DELHI | DriversLicense | DRIVERS_LICENSE | 2021    | Indian Union Driving License - Transport Department GNCT of Delhi |

### Goa

| State | Type of ID     | Subtype of ID   | Version | Description                              |
| :---- | :------------- | :-------------- | :------ | :--------------------------------------- |
| GOA   | DriversLicense | DRIVERS_LICENSE | 2017    | Indian Union Driving License - Goa State |

### Gujarat

| State   | Type of ID     | Subtype of ID   | Version | Description                                          |
| :------ | :------------- | :-------------- | :------ | :--------------------------------------------------- |
| GUJARAT | DriversLicense | DRIVERS_LICENSE | 2005    | Union of India Driving License - Gujarat State       |
| GUJARAT | DriversLicense | DRIVERS_LICENSE | 2008    | Gujarat Driving License                              |
| GUJARAT | DriversLicense | DRIVERS_LICENSE | 2014    | Gujarat State Driving License                        |
| GUJARAT | DriversLicense | DRIVERS_LICENSE | 2020    | Indian Union Driving License - Government of Gujarat |

### Gurgaon

| State   | Type of ID     | Subtype of ID   | Version | Description             |
| :------ | :------------- | :-------------- | :------ | :---------------------- |
| GURGAON | DriversLicense | DRIVERS_LICENSE | 2017    | Gurgaon Driving License |

### Haryana

| State   | Type of ID     | Subtype of ID   | Version | Description                                    |
| :------ | :------------- | :-------------- | :------ | :--------------------------------------------- |
| HARYANA | DriversLicense | DRIVERS_LICENSE | 2006    | Indian Driving License - Government of Haryana |
| HARYANA | DriversLicense | DRIVERS_LICENSE | 2016    | Haryana Driving License                        |

### Himachal Pradesh

| State            | Type of ID     | Subtype of ID   | Version | Description                                                   |
| :--------------- | :------------- | :-------------- | :------ | :------------------------------------------------------------ |
| HIMACHAL_PRADESH | DriversLicense | DRIVERS_LICENSE | 2013    | Indian Union Driving License - Government of Himachal Pradesh |
| HIMACHAL_PRADESH | DriversLicense | DRIVERS_LICENSE | 2024    | Himachal Pradesh Driving License                              |

### Jammu and Kashmir

| State             | Type of ID     | Subtype of ID   | Version | Description                                                  |
| :---------------- | :------------- | :-------------- | :------ | :----------------------------------------------------------- |
| JAMMU_AND_KASHMIR | DriversLicense | DRIVERS_LICENSE | 2010    | Indian Union Driving License - Government of Jammu & Kashmir |
| JAMMU_AND_KASHMIR | DriversLicense | DRIVERS_LICENSE | 2014    | Indian Union Driving License - Government of Jammu & Kashmir |
| JAMMU_AND_KASHMIR | DriversLicense | DRIVERS_LICENSE | 2024    | Jammu and Kashmir Driving License                            |

### Jharkhand

| State     | Type of ID     | Subtype of ID   | Version | Description                                    |
| :-------- | :------------- | :-------------- | :------ | :--------------------------------------------- |
| JHARKHAND | DriversLicense | DRIVERS_LICENSE | 2014    | Indian Union Driving License - Jharkhand State |
| JHARKHAND | DriversLicense | DRIVERS_LICENSE | 2017    | Indian Union Driving License - Jharkhand State |

### Karnataka

| State     | Type of ID     | Subtype of ID   | Version | Description                                          |
| :-------- | :------------- | :-------------- | :------ | :--------------------------------------------------- |
| KARNATAKA | DriversLicense | DRIVERS_LICENSE | 2005    | Indian Union Motor Driving License - Karnataka State |
| KARNATAKA | DriversLicense | DRIVERS_LICENSE | 2010    | Driving License - Karnataka State                    |

### Kerala

| State  | Type of ID     | Subtype of ID   | Version | Description                                 |
| :----- | :------------- | :-------------- | :------ | :------------------------------------------ |
| KERALA | DriversLicense | DRIVERS_LICENSE | 2016    | Indian Union Driving License - Kerala State |
| KERALA | DriversLicense | DRIVERS_LICENSE | 2018    | Kerala Driving License                      |
| KERALA | DriversLicense | DRIVERS_LICENSE | 2019    | Indian Union Driving License - Kerala State |

### Madhya Pradesh

| State          | Type of ID     | Subtype of ID   | Version | Description                    |
| :------------- | :------------- | :-------------- | :------ | :----------------------------- |
| MADHYA_PRADESH | DriversLicense | DRIVERS_LICENSE | 2020    | Madhya Pradesh Driving License |

### Maharashtra

| State       | Type of ID         | Subtype of ID            | Version | Description                                                  |
| :---------- | :----------------- | :----------------------- | :------ | :----------------------------------------------------------- |
| MAHARASHTRA | DriversLicense     | DRIVER_LICENSE           | 2000    | Maharashtra State Motor Driving License - The Union of India |
| MAHARASHTRA | DriversLicense     | DRIVER_LICENSE           | 2005    | Maharashtra Driving License                                  |
| MAHARASHTRA | DriversLicense     | DRIVER_LICENSE           | 2023    | Maharashtra Driving License                                  |
| MAHARASHTRA | IdentificationCard | PENSIONERS_IDENTITY_CARD | 2024    | Maharashtra Pensioner's Identity Card                        |

### Manipur

| State   | Type of ID     | Subtype of ID   | Version | Description                                          |
| :------ | :------------- | :-------------- | :------ | :--------------------------------------------------- |
| MANIPUR | DriversLicense | DRIVERS_LICENSE | 2019    | Indian Union Driving License - Government of Manipur |

### Mizoram

| State   | Type of ID     | Subtype of ID   | Version | Description             |
| :------ | :------------- | :-------------- | :------ | :---------------------- |
| MIZORAM | DriversLicense | DRIVERS_LICENSE | 2022    | Mizoram Driving License |

### Nagaland

| State    | Type of ID     | Subtype of ID   | Version | Description              |
| :------- | :------------- | :-------------- | :------ | :----------------------- |
| NAGALAND | DriversLicense | DRIVERS_LICENSE | 2018    | Nagaland Driving License |
| NAGALAND | DriversLicense | DRIVERS_LICENSE | 2020    | Nagaland Driving License |

### Odisha

| State  | Type of ID     | Subtype of ID   | Version | Description                                 |
| :----- | :------------- | :-------------- | :------ | :------------------------------------------ |
| ODISHA | DriversLicense | DRIVERS_LICENSE | 2019    | Indian Union Driving License - Odisha State |
| ODISHA | DriversLicense | DRIVERS_LICENSE | 2020    | Indian Union Driving License - Odisha State |

### Punjab

| State  | Type of ID     | Subtype of ID   | Version | Description                                 |
| :----- | :------------- | :-------------- | :------ | :------------------------------------------ |
| PUNJAB | DriversLicense | DRIVERS_LICENSE | 2000    | Indian Union Driving License - Punjab State |
| PUNJAB | DriversLicense | DRIVERS_LICENSE | 2021    | Indian Union Driving License - Punjab State |
| PUNJAB | DriversLicense | DRIVERS_LICENSE | 2023    | Punjab Driving License                      |
| PUNJAB | DriversLicense | DRIVERS_LICENSE | 2024    | Punjab Driving License                      |

### Rajasthan

| State     | Type of ID     | Subtype of ID   | Version | Description                               |
| :-------- | :------------- | :-------------- | :------ | :---------------------------------------- |
| RAJASTHAN | DriversLicense | DRIVERS_LICENSE | 2012    | Driving License - Government of Rajasthan |
| RAJASTHAN | DriversLicense | DRIVERS_LICENSE | 2015    | Driving License - Government of Rajasthan |
| RAJASTHAN | DriversLicense | DRIVERS_LICENSE | 2024    | Rajasthan International Driving Permit    |

### Sikkim

| State  | Type of ID     | Subtype of ID   | Version | Description            |
| :----- | :------------- | :-------------- | :------ | :--------------------- |
| SIKKIM | DriversLicense | DRIVERS_LICENSE | 2020    | Sikkim Driving License |
| SIKKIM | DriversLicense | DRIVERS_LICENSE | 2021    | Sikkim Driving License |

### Tamil Nadu

| State      | Type of ID     | Subtype of ID   | Version | Description                                             |
| :--------- | :------------- | :-------------- | :------ | :------------------------------------------------------ |
| TAMIL_NADU | DriversLicense | DRIVERS_LICENSE | 2000    | India Driving License - Tamil Nadu                      |
| TAMIL_NADU | DriversLicense | DRIVERS_LICENSE | 2003    | Union of India Driving License - Tamil Nadu             |
| TAMIL_NADU | DriversLicense | DRIVERS_LICENSE | 2005    | India Driving License - Tamil Nadu                      |
| TAMIL_NADU | DriversLicense | DRIVERS_LICENSE | 2020    | Indian Driving License - Tamil Nadu                     |
| TAMIL_NADU | DriversLicense | DRIVERS_LICENSE | 2023    | Indian Union Driving License - Government of Tamil Nadu |

### Telangana

| State     | Type of ID         | Subtype of ID                 | Version | Description                                                        |
| :-------- | :----------------- | :---------------------------- | :------ | :----------------------------------------------------------------- |
| TELANGANA | DriversLicense     | CERTIFICATE_OF_TRANSPORTATION | 2005    | Certificate of Registration - Telangana State Transport Department |
| TELANGANA | DriversLicense     | DRIVERS_LICENSE               | 2014    | Indian Union Driving License - Telangana State                     |
| TELANGANA | DriversLicense     | DRIVERS_LICENSE               | 2021    | Indian Union Driving License - Telangana State                     |
| TELANGANA | DriversLicense     | DRIVERS_LICENSE               | 2022    | Telangana Driving License                                          |
| TELANGANA | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT  | 2020    | Telangana International Driving Permit                             |
| TELANGANA | IdentificationCard | POLICE_IDENTFICATION_CARD      | 2020    | Telangana Police Identification Card                               |

### Tripura

| State   | Type of ID     | Subtype of ID   | Version | Description             |
| :------ | :------------- | :-------------- | :------ | :---------------------- |
| TRIPURA | DriversLicense | DRIVERS_LICENSE | 2020    | Tripura Driving License |
| TRIPURA | DriversLicense | DRIVERS_LICENSE | 2024    | Tripura Driving License |

### Uttarakhand

| State       | Type of ID     | Subtype of ID   | Version | Description                                                |
| :---------- | :------------- | :-------------- | :------ | :--------------------------------------------------------- |
| UTTARAKHAND | DriversLicense | DRIVERS_LICENSE | 2013    | Indian Union Driving License - Government of Uttarakhand   |
| UTTARAKHAND | DriversLicense | DRIVERS_LICENSE | 2016    | Union of India Driving License - Government of Uttarakhand |

### Uttar Pradesh

| State         | Type of ID     | Subtype of ID   | Version | Description                                  |
| :------------ | :------------- | :-------------- | :------ | :------------------------------------------- |
| UTTAR_PRADESH | DriversLicense | DRIVERS_LICENSE | 2019    | Indian Union Driving License - Uttar Pradesh |
| UTTAR_PRADESH | DriversLicense | DRIVERS_LICENSE | 2020    | Uttar Pradesh Driving License                |

### West Bengal

| State       | Type of ID     | Subtype of ID   | Version | Description                                                    |
| :---------- | :------------- | :-------------- | :------ | :------------------------------------------------------------- |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2000    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2002    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2003    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2006    | Indian Union Driving License - West Bengal State               |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2007    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2008    | Indian Union Driving License - Government of West Bengal State |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2012    | Indian Union Driving License - West Bengal State               |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2013    | Indian Union Driving License - Government of West Bengal State |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2014    | Indian Union Driving License - Government of West Bengal State |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2015    | Indian Union Driving License - West Bengal State               |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2018    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2019    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2020    | Indian Union Driving License - Government of West Bengal State |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2023    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2024    | West Bengal Driving License                                    |
| WEST_BENGAL | DriversLicense | DRIVERS_LICENSE | 2026    | West Bengal Driving License                                    |

## Indonesia (IDN)

| State | Type of ID         | Subtype of ID       | Version | Description                          |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2000    | Driving License                      |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2019    | Driving License                      |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2023    | Driving License                      |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2024    | Driving License                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2000    | Kartu Tanda Penduduk (Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Kartu Identitas Anak (Identity Card) |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Paspor / Passport                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2015    | Paspor / Passport                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2022    | Paspor / Passport                    |
| ALL   | Passport           | DIPLOMATIC_PASSPORT | 2024    | Diplomatic Passport                  |

## Iran (IRN)

| State | Type of ID         | Subtype of ID       | Version | Description     |
| :---- | :----------------- | :------------------ | :------ | :-------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2010    | Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2012    | Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2024    | Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Identity Card   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2011    | Identity Card   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2007    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2011    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2014    | Passport        |
| ALL   | Visa               | VISA                | 2018    | Visa            |

## Iraq (IRQ)

| State | Type of ID         | Subtype of ID       | Version | Description         |
| :---- | :----------------- | :------------------ | :------ | :------------------ |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Identification Card |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2025    | Refugee Identification Card |
| ALL   | Military           | MILITARY_CARD       | 2025    | Military Card       |
| ALL   | Military           | MILITARY_CARD       | 2026    | Military Card       |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2011    | Passport            |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driving License     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2023    | Driving License     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2025    | Driving License     |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2023    | Passport            |
| ALL   | Permit             | WORK_PERMIT         | 2025    | Work Permit         |
| ALL   | ResidenceDocument  | IMMIGRATION_CARD    | 2023    | Immigration Card    |
| ALL   | ResidenceDocument           | RESIDENCE_CARD   | 2021    | Residence Card           |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2025    | Voter Identification Card |

## Israel (ISR)

| State | Type of ID         | Subtype of ID                     | Version | Description                       |
| :---- | :----------------- | :-------------------------------- | :------ | :-------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                    | 2009    | Driving License                   |
| ALL   | DriversLicense     | DRIVER_LICENSE                    | 2018    | Driving License                   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD               | 2000    | Domestic Identity Card            |
| ALL   | IdentificationCard | IDENTIFICATION_CARD               | 2013    | Domestic Identity Card            |
| ALL   | Military           | MILITARY_CARD                     | 2024    | Military Card                     |
| ALL   | Passport           | NATIONAL_PASSPORT                 | 2011    | Passport                          |
| ALL   | Passport           | NATIONAL_PASSPORT                 | 2013    | Passport                          |
| ALL   | TravelDocument     | CONSULAR_CARD                     | 2024    | Consular Card                     |
| ALL   | TravelDocument     | TEMPORARY_IMMIGRATION_CERTIFICATE | 2010    | Temporary Immigration Certificate |

## Japan (JPN)

| State | Type of ID         | Subtype of ID                          | Version | Description                            |
| :---- | :----------------- | :------------------------------------- | :------ | :------------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                         | 2000    | Driving License                        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                    | 2020    | Identity Card                          |
| ALL   | Passport           | NATIONAL_PASSPORT                      | 2006    | Passport                               |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                       | 2016    | Residence Card                         |
| ALL   | ResidenceDocument  | SPECIAL_PERMANENT_RESIDENT_CERTIFICATE | 2024    | Special Permanent Resident Certificate |
| ALL   | Visa               | VISA                                   | 2000    | Visa                                   |
| ALL   | Visa               | VISA                                   | 2001    | Visa                                   |
| ALL   | Visa               | VISA                                   | 2002    | Visa                                   |
| ALL   | Visa               | VISA                                   | 2024    | Visa                                   |

## Jordan (JOR)

| State | Type of ID         | Subtype of ID                | Version | Description                  |
| :---- | :----------------- | :--------------------------- | :------ | :--------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 1996    | Driving License              |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT | 2020    | International Driving Permit |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2012    | ID Card                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2025    | Identification Card          |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2008    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2016    | Passport                     |
| ALL   | Military           | MILITARY_CARD                | 2022    | Military Card                |
| ALL   | Military           | MILITARY_CARD                | 2023    | Military Card                |
| ALL   | Military           | MILITARY_CARD                | 2024    | Military Card                |
| ALL   | Other              | INVESTOR_CARD                | 2020    | Investor Card                |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2025    | Residence Permit             |

## Kazakhstan (KAZ)

| State | Type of ID         | Subtype of ID       | Version | Description         |
| :---- | :----------------- | :------------------ | :------ | :------------------ |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2005    | Driving License     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2016    | Driving License     |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2026    | Driving License     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2008    | Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2009    | Identity Card       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Identity Card       |
| ALL   | ResidenceDocument | RESIDENCE_PERMIT | 2014    | Residence Permit      |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | Passport            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passport            |

## Kuwait (KWT)

| State | Type of ID         | Subtype of ID       | Version | Description      |
| :---- | :----------------- | :------------------ | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2004    | Driving License  |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2014    | Driving License  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2011    | Civil ID Card    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passport         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2019    | Civil ID Card    |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2022    | Residence Permit |

## Kyrgyzstan (KGZ)

| State | Type of ID         | Subtype of ID       | Version | Description       |
| :---- | :----------------- | :------------------ | :------ | :---------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2019    | Driving License   |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2020    | Driving License   |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2021    | Driving License   |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2026    | Driving License   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2005    | Identity Card     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Identity Card     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identity Card     |
| ALL   | Passport           | DIPLOMATIC_PASSPORT | 2021    | Passport          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2011    | National Passport |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2021    | Passport          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2025    | Passport          |

## Laos (LAO)

| State | Type of ID | Subtype of ID     | Version | Description |
| :---- | :--------- | :---------------- | :------ | :---------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2023    | Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2024    | Identification Card |
| ALL   | Passport   | NATIONAL_PASSPORT | 2012    | Passport    |
| ALL   | Passport   | NATIONAL_PASSPORT | 2016    | Passport    |

## Lebanon (LBN)

| State | Type of ID         | Subtype of ID                 | Version | Description                                 |
| :---- | :----------------- | :---------------------------- | :------ | :------------------------------------------ |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2010    | Driving License                             |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2018    | Permis de Conduire (Driving License)        |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2020    | International Driving Permit                |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2015    | Identity Card                               |
| ALL   | IdentificationCard | REFUGEE_IDENTIFICATION_CARD   | 2025    | Refugee Identification Card                 |
| ALL   | Military           | MILITARY_DRIVERS_LICENSE      | 2017    | Military Driver License                     |
| ALL   | Military           | MILITARY_IDENTIFICATION_CARD  | 2025    | Military Identification Card                |
| ALL   | TravelDocument     | CONSULAR_CARD                 | 2021    | Carte D'Identite Consulaire / Consular Card |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2010    | Passeport / Passport                        |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2017    | Passeport / Passport                        |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT              | 2023    | Residence Permit                            |

## Malaysia (MYS)

| State | Type of ID         | Subtype of ID                    | Version | Description                                                          |
| :---- | :----------------- | :------------------------------- | :------ | :------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                   | 2000    | Driving License                                                      |
| ALL   | DriversLicense     | LEARNERS_PERMIT                  | 2000    | Lesen Belajar Memandu Malaysia (Malaysian Learner's Driving License) |
| ALL   | DriversLicense     | DRIVER_LICENSE                   | 2025    | Driving License                                                      |
| ALL   | DriversLicense     | DRIVER_LICENSE                   | 2026    | Driving License                                                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD              | 2012    | Identity Card                                                        |
| ALL   | IdentificationCard | DIPLOMATIC_IDENTIFICATION_CARD   | 2024    | Diplomatic Identification Card                                       |
| ALL   | Military           | MILITARY_CARD                    | 2020    | Military Card                                                        |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                 | 2020    | Residence Pass - Talent                                              |
| ALL   | IdentificationCard | POLICE_IDENTIFICATION_CARD       | 2020    | Police Identification Card                                           |
| ALL   | Passport           | NATIONAL_PASSPORT                | 2008    | Pasport / Passport                                                   |
| ALL   | Passport           | NATIONAL_PASSPORT                | 2013    | Pasport / Passport                                                   |
| ALL   | Passport           | NATIONAL_PASSPORT                | 2026    | Pasport / Passport                                                   |
| ALL   | Visa               | VISA                             | 2022    | Multiple Entry Visa                                                  |
| ALL   | Permit             | WORK_PERMIT                      | 2023    | Employment Pass                                                      |
| ALL   | ResidenceDocument  | STUDENT_PASS                     | 2020    | Student Pass                                                         |
| ALL   | Other              | PROFESSIONAL_IDENTIFICATION_CARD | 2020    | Malaysian Vocational License                                         |

## Maldives (MDV)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | National Identity Card |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Driving License        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2023    | Driving License        |
| ALL   | Permit             | WORK_PERMIT         | 2020    | Work Permit            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passport               |

## Mongolia (MNG)

| State | Type of ID         | Subtype of ID       | Version | Description                       |
| :---- | :----------------- | :------------------ | :------ | :-------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2014    | Mongolian Driver's License        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2022    | Driver's License                  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2013    | Citizen Identity Card of Mongolia |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Identity Card                     |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2007    | Passport                          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2023    | Passport                          |

## Myanmar (MMR)

| State | Type of ID     | Subtype of ID     | Version | Description     |
| :---- | :------------- | :---------------- | :------ | :-------------- |
| ALL   | DriversLicense | DRIVERS_LICENSE   | 2006    | Driving License |
| ALL   | Passport       | NATIONAL_PASSPORT | 2014    | Passport        |
| ALL   | Passport       | NATIONAL_PASSPORT | 2023    | Passport        |
| ALL   | Passport       | TRAVEL_DOCUMENT | 2025    | Travel Document      |
| ALL   | Visa           | VISA              | 2014    | Visa            |

## Nepal (NPL)

| State | Type of ID         | Subtype of ID                | Version | Description                  |
| :---- | :----------------- | :--------------------------- | :------ | :--------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2007    | Driving License              |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2015    | Driving License              |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2021    | Driving License              |
| ALL   | DriversLicense     | PROBATIONARY_DRIVERS_LICENSE | 2022    | Probationary Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2023    | Driving License              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2018    | National Identity Card       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2024    | National Identity Card       |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2010    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2022    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2026    | Passport                     |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2010    | Citizenship Certificate      |

## Oman (OMN)

| State | Type of ID         | Subtype of ID       | Version | Description             |
| :---- | :----------------- | :------------------ | :------ | :---------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2015    | Vehicle Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2006    | Identity Card           |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identity Card           |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2014    | Passport                |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2010    | Resident Card           |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2025    | Residence Permit        |

## Pakistan (PAK)

| State                  | Type of ID         | Subtype of ID                 | Version | Description                                |
| :--------------------- | :----------------- | :---------------------------- | :------ | :----------------------------------------- |
| ALL                    | IdentificationCard | IDENTIFICATION_CARD           | 2002    | Identity Card                              |
| ALL                    | IdentificationCard | IDENTIFICATION_CARD           | 2012    | National Identity Card                     |
| ALL                    | IdentificationCard | IDENTIFICATION_CARD           | 2025    | Identification Card                        |
| ALL                    | IdentificationCard | IDENTIFICATION_CARD           | 2026    | Identification Card                        |
| ALL                    | DriversLicense     | DRIVERS_LICENSE               | 2020    | Driving License                            |
| ALL                    | DriversLicense     | DRIVERS_LICENSE               | 2021    | National Driving Permit                    |
| ALL                    | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT  | 2022    | International Driving Permit               |
| ALL                    | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT  | 2023    | International Driving Permit               |
| ALL                    | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT  | 2024    | International Driving Permit               |
| ALL                    | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT  | 2025    | International Driving Permit               |
| ALL                    | Other              | REFUGEE_IDENTIFICATION_CARD   | 2024    | Refugee Identification Card                |
| ALL                    | Passport           | NATIONAL_PASSPORT             | 2017    | Passport                                   |
| ALL                    | Passport           | NATIONAL_PASSPORT             | 2023    | Passport                                   |
| ALL                    | TravelDocument     | TRAVEL_IDENTIFICATION_CARD    | 2014    | National Identity Card Overseas Pakistanis |
| AZAD_JAMMU_AND_KASHMIR | DriversLicense     | DRIVERS_LICENSE               | 2023    | Azad Jammu & Kashmir Driving License       |
| BALOCHISTAN            | DriversLicense     | DRIVERS_LICENSE               | 2024    | Balochistan Driver License                 |
| ISLAMABAD              | DriversLicense     | DRIVERS_LICENSE               | 2015    | Islamabad Driving License                  |
| ISLAMABAD              | DriversLicense     | DRIVERS_LICENSE               | 2020    | Islamabad Driving License / Permit         |
| KHYBER_PAKHTUNKHWA     | DriversLicense     | DRIVERS_LICENSE               | 2024    | Khyber Pakhtunkhwa Driver's License        |
| KHYBER_PAKHTUNKHWA     | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2021    | International Driving License              |
| KHYBER_PAKHTUNKHWA     | DriversLicense     | DRIVERS_LICENSE               | 2023    | Khyber Pakhtunkhwa Driver's License        |
| PUNJAB                 | DriversLicense     | DRIVERS_LICENSE               | 2007    | Punjab Driving License                     |
| SINDH                  | DriversLicense     | DRIVERS_LICENSE               | 2006    | Sindh Driving License                      |
| SINDH                  | DriversLicense     | DRIVERS_LICENSE               | 2016    | Sindh Driving License                      |
| SINDH                  | DriversLicense     | LEARNERS_PERMIT               | 2024    | Sindh Driving License                      |

## Palestine (PSE)

| State | Type of ID         | Subtype of ID       | Version | Description     |
| :---- | :----------------- | :------------------ | :------ | :-------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2010    | Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2011    | Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Identity Card   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2023    | Passport        |

## Philippines (PHL)

### National IDs

| State | Type of ID          | Subtype of ID                        | Version | Description                                          |
| :---- | :------------------ | :----------------------------------- | :------ | :--------------------------------------------------- |
| ALL   | DriversLicense      | DRIVER_LICENSE                       | 2000    | Non-Professional Driver's License                    |
| ALL   | DriversLicense      | DRIVER_LICENSE                       | 2017    | Non-Professional Driver's License                    |
| ALL   | DriversLicense      | DRIVER_LICENSE                       | 2023    | Driver's License                                     |
| ALL   | IdentificationCard  | CITIZENCARD                          | 2021    | Philippine Identification Card                       |
| ALL   | IdentificationCard  | DIPLOMATIC_IDENTIFICATION_CARD       | 2025    | Diplomatic Identification Card                       |
| ALL   | IdentificationCard  | EPHIL_CARD                           | 2023    | Philippine Identification                            |
| ALL   | IdentificationCard  | EPHIL_CARD_PDF                       | 2023    | Ephil Card                                           |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD                  | 2020    | Philippine Identification Card                       |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD                  | 2021    | Philippine Identification Card                       |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD                  | 2022    | Philippine Identification Card                       |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD                  | 2023    | Philippine National ID    |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2010    | Parañaque City Police Clearance Card                             |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2011    | Police Clearance ID Card                             |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2012    | Online Police Clearance Card                         |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2013    | Police Clearance Identification Card                 |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2014    | Police Clearance Card                                |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2017    | Caloocan City Police Clearance Identification Card   |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2019    | Police Clearance Data Card                           |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2020    | Police Identification Card                           |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2021    | Valenzuela City Police Clearance Identification Card |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2022    | Manila City Clearance Data Card                      |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2023    | Cebu City Police Clearance Identification Card       |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2024    | Police Clearance Identity Card                       |
| ALL   | IdentificationCard  | POLICE_CLEARANCE_IDENTIFICATION_CARD | 2025    | Police Clearance Identification Card                 |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD           | 2022    | Makati City Police Clearance Identification Card     |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD           | 2023    | Police Identity Card                                 |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD           | 2024    | Police Identification Card                           |
| ALL   | IdentificationCard  | PROFESSIONAL_IDENTIFICATION_CARD     | 2024    | Professional License ID                              |
| ALL   | IdentificationCard  | SSS_ID_CARD                          | 2025    | SSS ID Card                                          |
| ALL   | IdentificationCard  | UMID_CARD                            | 2000    | Unified Multi-Purpose ID                             |
| ALL   | IdentificationCard  | UMID_CARD                            | 2001    | Unified Multi-Purpose ID                             |
| ALL   | IdentificationCard  | UMID_CARD                            | 2002    | Unified Multi-Purpose ID                             |
| ALL   | MedicalCard         | MEDICAL_CARD                         | 2008    | Medical Card                                         |
| ALL   | MedicalCard         | MEDICAL_CARD                         | 2009    | PhilHealth Insurance Card                            |
| ALL   | MedicalCard         | MEDICAL_CARD                         | 2010    | PhilHealth Insurance Card                            |
| ALL   | MedicalCard         | MEDICAL_CARD                         | 2012    | PhilHealth Insurance Card                            |
| ALL   | MedicalCard         | MEDICAL_CARD                         | 2013    | Medical Card                                         |
| ALL   | Military            | MILITARY_CARD                        | 2019    | Military Card                                        |
| ALL   | Military            | MILITARY_CARD                        | 2022    | Military Card                                        |
| ALL   | Military            | MILITARY_CARD                        | 2023    | Military Card                                        |
| ALL   | Military            | MILITARY_CARD                        | 2024    | Military Card                                        |
| ALL   | Military            | MILITARY_CARD                        | 2025    | Military Card                                        |
| ALL   | Other               | COAST_GUARD                          | 2020    | Coast Guard Card                                      |
| ALL   | Other               | FIRE_PROTECTION_BUREAU_ID            | 2022    | Fire Protection Bureau ID                           |
| ALL   | Other               | GSIS_ECARD_PLUS                      | 2020    | GSIS eCard Plus                                      |
| ALL   | Other               | MARITIME_INDUSTRY_AUTHORITY          | 2020    | Maritime Industry Authority Card                     |
| ALL   | Other               | MARITIME_INDUSTRY_AUTHORITY          | 2021    | Maritime Industry Authority Card                     |
| ALL   | Other               | MARITIME_INDUSTRY_AUTHORITY          | 2022    | Maritime Industry Authority Card                     |
| ALL   | Other               | NBI_CLEARANCE                        | 2020    | National Bureau Investigation Clearance              |
| ALL   | Other               | PHILPOST                             | 2015    | Postal Identity Card - PHLPOST                       |
| ALL   | Other               | PHILPOST                             | 2018    | Postal Identity Card - PHLPOST                       |
| ALL   | Other               | PHILPOST                             | 2020    | Postal Identity Card - PHLPOST                       |
| ALL   | Other               | PROFESSIONAL_REGULATION_COMMISSION   | 2000    | Professional Identification Card                     |
| ALL   | Other               | PROFESSIONAL_REGULATION_COMMISSION   | 2010    | Professional Identification Card                     |
| ALL   | Other               | PROFESSIONAL_REGULATION_COMMISSION   | 2026    | Professional Identification Card                     |
| ALL   | Other               | SOCIAL_SECURITY_CARD                 | 2011    | Social Security System Number                        |
| ALL   | Other               | SOCIAL_SECURITY_CARD                 | 2024    | Social Security Card                                 |
| ALL   | Passport            | NATIONAL_PASSPORT                    | 2010    | Pasaporte / Passport                                 |
| ALL   | Passport            | NATIONAL_PASSPORT                    | 2012    | Pasaporte / Passport                                 |
| ALL   | Passport            | NATIONAL_PASSPORT                    | 2016    | Pasaporte / Passport                                 |
| ALL   | ResidenceDocument   | ALIEN_CERTIFICATE_OF_REGISTRATION    | 2020    | Alien Certificate of Registration                    |
| ALL   | ResidenceDocument   | SPECIAL_INVESTOR_RESIDENT_VISA       | 2020    | Special Investor's Resident Visa                     |
| ALL   | TaxIdentification   | TAX_IDENTIFICATION                   | 2017    | TIN (Taxpayer Identification Number) ID              |
| ALL   | TaxIdentification   | TAX_IDENTIFICATION                   | 2020    | TIN (Taxpayer Identification Number) ID              |
| ALL   | TaxIdentification   | TAX_IDENTIFICATION                   | 2021    | TIN (Taxpayer Identification Number) ID              |
| ALL   | TaxIdentification   | TAX_IDENTIFICATION                   | 2022    | TIN (Taxpayer Identification Number) ID              |
| ALL   | Visa                | VISA                                 | 2016    | Visa                                                 |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD            | 2010    | Voter's ID                                           |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD            | 2011    | Voter's ID                                           |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD            | 2022    | Voter Identification Card                            |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD            | 2024    | Voter's Certification                                |

### Local Disability Identification Cards

| State | Type of ID         | Subtype of ID                  | Version | Description                                                   |
| :---- | :----------------- | :----------------------------- | :------ | :------------------------------------------------------------ |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1938    | City of Lipa Disability Identification Card                   |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1939    | City of Caloocan Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1940    | City Government of Valenzuela Disability Identification Card  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1941    | City of Cauayan Disability Identification Card                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1943    | City of Santa Rosa Disability Identification Card             |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1944    | Municipality of Concepcion Disability Identification Card     |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1945    | City of Santa Rosa Disability Identification Card             |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1946    | San Antonio Disability Identification Card                    |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1947    | Naga City Disability Identification Card                      |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1948    | Municipality of Bulalacao Disability Identification Card      |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1949    | Municipality of Tanza Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1950    | Province of Capiz Disability Identification Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1951    | Tuguegarao City Disability Identification Card                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1952    | City of Liliw Disability Identification Card                  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1953    | Municipality of Dinalupihan Disability Identification Card    |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1954    | City of Bacoor Disability Identification Card                 |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1955    | City of Talisay Disability Identification Card                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1956    | Municipality of Rizal Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1957    | City of Santiago Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1958    | City of Pasay Disability Identification Card                  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1959    | City of Makati Disability Identification Card                 |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1960    | City Government of Tanauan Disability Identification Card     |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1961    | Municipality of Marilao Disability Identification Card        |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1962    | Municipality of Tapaz Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1963    | City of Himamaylan Disability Identification Card             |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1964    | Municipality of Los Baños Disability Identification Card      |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1965    | Municipality of Subic Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1966    | Municipality of Daraga Disability Identification Card         |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1967    | Municipality of Jaro Disability Identification Card           |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1968    | City Government of Pasig Disability Identification Card       |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1969    | Municipality of Santa Barbara Disability Identification Card  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1970    | Municipality of Pateros Disability Identification Card        |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1973    | City of Tagaytay Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1974    | City of Navotas Disability Identification Card                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1975    | Municipality of Cabatuan Disability Identification Card       |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1976    | Province of Batangas Disability Identification Card           |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1978    | Municipality of Kalibo Disability Identification Card         |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1979    | Iloilo City Disability Identification Card                    |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1980    | City of Caloocan Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1983    | City of Imus Disability Identification Card                   |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1984    | City of Davao Disability Identification Card                  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1985    | City of San Juan Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1987    | City of Parañaque Disability Identification Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1989    | Disability Identification Card                                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1993    | City of Bacoor Disability Identification Card                 |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1995    | City of Paranaque Disability Identification Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1997    | City of Cotabato Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1998    | Province of Rizal Disability Identification Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 1999    | City of General Trias Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2000    | City of Malolos Disability Identification Card                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2001    | City of Antipolo Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2002    | Victoria, Laguna Disability Identification Card               |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2003    | Province of Pampanga Disability Identification Card           |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2004    | City of Muntinlupa Disability Identification Card             |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2005    | Las Pinas City Disability Identification Card                 |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2006    | Cebu City Disability Identification Card                      |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2007    | Municipality of Balete Disability Identification Card         |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2008    | Municipality of GAMU Disability Identification Card           |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2009    | Bacolod City Disability Identification Card                   |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2010    | Disability Identification Card                                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2011    | Province of Bulacan Disability Identification Card            |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2012    | Municipality of Talavera Disability Identification Card       |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2013    | Municipality of Oton Disability Identification Card           |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2015    | City of Manila Disability Identification Card                 |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2016    | City of Binan Disability Identification Card                  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2017    | City Government of Calamba Disability Identification Card     |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2018    | Marikina City Disability Identification Card                  |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2019    | City Government of Pasig Disability Identification Card       |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2020    | City of San Pedro Disability Identification Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2021    | Disability Identification Card                                |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2022    | Municipality of La Paz, Tarlac Disability Identification Card |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2023    | Municipality of Liliw Disability Identification Card          |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2024    | Municipality of Cataingan Disability Identification Card      |

### Local Senior Identification Cards

| State | Type of ID         | Subtype of ID              | Version | Description                                                     |
| :---- | :----------------- | :------------------------- | :------ | :-------------------------------------------------------------- |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1928    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1929    | Bacolod City Senior Identification Card                         |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1930    | Municipality of Concepcion Senior Identification Card           |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1931    | City of Surigao Senior Identification Card                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1932    | Municipality of Tubod Senior Identification Card                |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1934    | City of Bacoor Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1935    | City of Valenzuela Senior Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1936    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1937    | City of Iloilo Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1938    | Municipality of Tangcal Senior Identification Card              |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1940    | Cebu City Senior Identification Card                            |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1941    | City of Santa Rosa Senior Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1942    | City Government of Digos Identification Card                    |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1943    | Municipality of Plaridel Senior Identification Card             |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1944    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1945    | Baguio City Senior Identification Card                          |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1946    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1947    | Province of Batangas Senior Identification Card                 |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1948    | City of Santa Rosa Senior Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1949    | Tacloban City Senior Identification Card                        |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1951    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1952    | Municipality of Silang Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1953    | Las Piñas City Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1954    | City of Mandaluyong Senior Identification Card                  |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1955    | Municipality of Irosin Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1956    | City of San Fernando Senior Identification Card                 |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1958    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1959    | City of San Juan Senior Identification Card                     |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1960    | Siquijor Senior Identification Card                             |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1961    | Municipality of Lucban Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1962    | City of Antipolo Senior Identification Card                     |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1965    | Cebu Senior Identification Card                                 |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1971    | Cagayan de Oro City Senior Identification Card                  |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1972    | San Juan, Batangas Senior Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1975    | BAC Senior Identification Card                                  |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1976    | City of Taguig Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1977    | Municipality of Taytay Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1979    | City of San Carlos Senior Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1980    | Pasig City Senior Identification Card                           |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1981    | Guihulngan City Senior Identification Card                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1985    | Bataan Senior Identification Card                               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1987    | Cavinti City Senior Identification Card                         |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1989    | Cagayan de Oro City Senior Citizens Identification Card         |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1990    | City of Manila Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1992    | City of Silay Senior Citizen's Card                             |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1993    | City of Caloocan Senior Identification Card                     |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1994    | Cainta Rizal Senior Citizens Identification Card                |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1995    | City Government of Makati Senior Citizen's Blu Card             |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1996    | City Government of Tacloban Senior Citizens Identification Card |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1997    | City of San Jose del Monte Senior Citizens Identification Card  |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1998    | City of Manila Senior Citizens Identification Card              |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 1999    | Province of Quezon Senior Citizens Identification Card          |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2001    | City Government of Mabalacat Senior Citizen's Card              |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2002    | Las Piñas Senior Citizens Identification Card                   |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2003    | Marikina City Senior Identification Card                        |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2004    | Municipality of Angono Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2005    | Las Pinas City Senior Identification Card                       |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2006    | Municipality of Taytay Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2007    | Municipality of Baliwag Senior Identification Card              |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2009    | City of Mandaluyong Senior Identification Card                  |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2010    | Senior Citizen / Identification Card                            |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2011    | City of Malolos Senior Identification Card                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2012    | Municipality of Carmen Senior Identification Card               |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2013    | Quezon Province Senior Citizen / Identification Card            |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2014    | Province of Zamboanga del Norte Senior Identification Card      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2015    | City of Surigao Senior Identification Card                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2016    | Quezon City Senior Identification Card                          |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2017    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2020    | Senior Identification Card                                      |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2021    | Legazpi City Senior Identification Card                         |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2022    | Dipolog City Senior Identification Card                         |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2023    | Municipality of Naic Senior Citizens Identification Card        |
| ALL   | IdentificationCard | SENIOR_IDENTIFICATION_CARD | 2024    | Cebu City Senior Identification Card                            |

### Local Residence Cards

| State | Type of ID        | Subtype of ID  | Version | Description                                        |
| :---- | :---------------- | :------------- | :------ | :------------------------------------------------- |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1800    | Municipality of Gandara Residence Card             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1801    | Municipality of Bulan Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1802    | Barangay San Antonio Residence Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1803    | Barangay Platero Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1804    | Barangay San Matias Residence Card                 |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1805    | City of Marikina Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1806    | Barangay Malanday Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1807    | City of Gapan Residence Card                       |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1808    | Barangay Lalakay Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1809    | City of Marikina Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1810    | Imus City Residence Card                           |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1811    | Barangay Talangan Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1812    | City of Manila Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1813    | Barangay San Isidro Residence Card                 |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1814    | Barangay Malusak Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1815    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1818    | Barangay Dela Paz Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1819    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1820    | Barangay Canlalay Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1821    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1822    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1823    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1824    | Province of Zambales Residence Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1825    | City of Manila Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1826    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1827    | Municipality of Binangonan Residence Card          |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1828    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1829    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1830    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1831    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1832    | Municipality of Abuyog Residence Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1833    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1834    | Municipality of Bulusan Residence Card             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1835    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1836    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1837    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1839    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1840    | Barangay San Rafael Residence Card                 |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1841    | City of Manila Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1849    | Barangay Malaban Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1850    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1851    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1852    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1853    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1854    | Barangay Yapak Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1855    | City of Passi Residence Card                       |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1856    | Barangay Muzon Proper Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1857    | Barangay Manggahan Residence Card                  |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1858    | Barangay Santo Cristo Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1859    | Barangay Sicsican Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1860    | Barangay Fort Bonifacio Residence Card             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1861    | Barangay Dila Residence Card                       |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1862    | Barangay Ibayo Tipas Residence Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1865    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1866    | City of Sorsogon Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1867    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1868    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1869    | Municipality of Gen. Mariano Alvarez Resident Card |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1886    | Barangay Resident Card                             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1890    | Barangay Resident Card                             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1894    | Barangay Bayan Luma 7 Resident Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1895    | Barangay San Jose Resident Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1897    | Barangay Baliwasan Resident Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1904    | Barangay Resident Card                             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1905    | City of Caloocan Resident Card                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1908    | Payatas Resident Card                              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1911    | Barangay Resident Card                             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1912    | Barangay Camino Nuevo Resident Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1918    | City of Sorsogon Resident Card                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1919    | Barangay Isio Resident Card                        |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1921    | Barangay Resident Card                             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1922    | City of Cabanatuan Resident Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1931    | Barangay Santo Niño Residence Card                 |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1932    | Barangay Upper Bicutan Residence Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1933    | Barangay Cupang Residence Card                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1934    | Barangay Marikina Heights Residence Card           |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1939    | Barangay Sampaloc Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1942    | Barangay San Dionisio Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1943    | Barangay Santo Cristo Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1947    | Barangay San Bartolome Residence Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1949    | Barangay Talaba 1 Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1950    | Barangay East Poblacion Residence Card             |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1954    | Barangay Sabutan Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1957    | Barangay Anabu Ii- c Residence Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1958    | Barangay Tungkong Mangga Residence Card            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1968    | City of Antipolo Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1970    | Barangay Malanday Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1977    | Barangay Mariblo Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1978    | Barangay Tandang Sora Residence Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1979    | Barangay Tambo Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1980    | Barangay Sauyo Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1981    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1982    | Barangay Santiago Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1983    | City of Quezon Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1984    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1985    | City of Parañaque Residence Card                   |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1986    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1987    | Barangay Culiat Residence Card                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1988    | Barangay San Isidro Residence Card                 |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1989    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1990    | City of Tagaytay Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1991    | Barangay Muzon South Residence Card                |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1992    | Barangay Muzon Residence Card                      |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1994    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1995    | Old Capitol Site Residence Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1996    | Barangay Residence Card                            |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1997    | Barangay Batasan Hills Residence Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1998    | Barangay Resident's Card                           |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 1999    | Barangay San Jose Resident Card                    |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2000    | Barangay Resident Identification Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2001    | Barangay Identification Card                       |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2002    | Barangay Identification Card                       |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2003    | Barangay Resident Identification Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2004    | Barangay Resident Identification Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2005    | Municipality of Magallanes Resident Card           |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2006    | Barangay Resident Identification Card              |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2007    | Barangay Timugan Identification Card               |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2008    | Residence Card                                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2009    | Residence Card                                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2010    | Residence Card                                     |
| ALL   | ResidenceDocument | RESIDENCE_CARD | 2023    | Alien Certificate of Registration                  |

## Qatar (QAT)

| State | Type of ID         | Subtype of ID       | Version | Description      |
| :---- | :----------------- | :------------------ | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2013    | Driving License  |
| ALL   | DriversLicense     | LEARNERS_PERMIT     | 2020    | Learner's Permit |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | ID Card          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2011    | ID Card          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2008    | Passport         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2010    | Residency Permit |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2020    | Residence Permit |

## Russia (RUS)

| State | Type of ID         | Subtype of ID                 | Version | Description                   |
| :---- | :----------------- | :---------------------------- | :------ | :---------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2011    | Driver's License              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2008    | Identity Card                 |
| ALL   | IdentificationCard | TEMPORARY_IDENTIFICATION_CARD | 2024    | Temporary Identification Card |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2000    | Passport                      |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2008    | Passport                      |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2010    | Passport                      |
| ALL   | Visa               | VISA                          | 2021    | Viza / Visa                   |

## Saudi Arabia (SAU)

| State | Type of ID         | Subtype of ID                | Version | Description                  |
| :---- | :----------------- | :--------------------------- | :------ | :--------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2012    | Driving License              |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2013    | Driving License              |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT | 2023    | International Driving Permit |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2010    | National ID Card             |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2013    | National ID Card             |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS | 2015    | Identification Card for Foreigners |
| ALL   | Military           | MILITARY_CARD                | 2020    | Military Card                |
| ALL   | Passport           | DIPLOMATIC_PASSPORT          | 2003    | Diplomatic Passport          |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2007    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2022    | Saudi Passport               |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2015    | Resident Identity Card       |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2020    | Residence Permit             |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2024    | Premium Resident Identity    |
| ALL   | TravelDocument     | CONSULAR_CARD                | 2020    | Consular Card                |
| ALL   | TravelDocument     | CONSULAR_CARD                | 2021    | Consular Identity Card       |

## Singapore (SGP)

| State | Type of ID         | Subtype of ID                | Version | Description                          |
| :---- | :----------------- | :--------------------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE               | 2002    | Driving License                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2001    | Identity Card                        |
| ALL   | Military           | MILITARY_IDENTIFICATION_CARD | 2010    | Singapore Armed Forces Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2005    | Passport                             |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2017    | Passport                             |
| ALL   | Permit             | WORK_PERMIT                  | 2000    | Work Permit                          |
| ALL   | Permit             | WORK_PERMIT                  | 2001    | Work Permit                          |
| ALL   | Permit             | WORK_PERMIT                  | 2019    | Work Permit                          |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2005    | Identity Card                        |
| ALL   | TravelDocument     | LONG_TERM_VISIT_PASS         | 2023    | Long-Term Visit Pass                 |

## South Korea (KOR)

| State | Type of ID         | Subtype of ID       | Version | Description             |
| :---- | :----------------- | :------------------ | :------ | :---------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2000    | Driver's License        |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2020    | Driver's License        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2000    | Identity Card           |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2008    | Passport                |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2022    | Passport                |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2018    | Alien Registration Card |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2023    | Residence Card          |
| ALL   | Visa  | VISA   | 2020    | Visa         |

## Sri Lanka (LKA)

| State | Type of ID         | Subtype of ID       | Version | Description            |
| :---- | :----------------- | :------------------ | :------ | :--------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2006    | Driving License        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2011    | Driving License        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2023    | Driving License        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Identity Card          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | National Identity Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2022    | Identification Card    |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Identification Card    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2015    | Passport               |

## Syrian Arab Republic (SYR)

| State | Type of ID         | Subtype of ID                 | Version | Description                  |
| :---- | :----------------- | :---------------------------- | :------ | :--------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2000    | Identity Card                |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2024    | Identification Card          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2025    | Identification Card          |
| ALL   | DriversLicense     | DRIVERS_LICENSE               | 2019    | Driving License              |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2019    | International Driving Permit |
| ALL   | Military           | MILITARY_CARD                 | 2014    | Military Card                |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2010    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2023    | Passport                     |
| ALL   | Passport           | TRAVEL_DOCUMENT               | 2025    | Travel Document              |

## Taiwan (TWN)

| State | Type of ID         | Subtype of ID                  | Version | Description                    |
| :---- | :----------------- | :----------------------------- | :------ | :----------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE                | 2015    | Driving License                |
| ALL   | DriversLicense     | DRIVERS_LICENSE                | 2019    | Driving License                |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT   | 2020    | International Driving Permit   |
| ALL   | IdentificationCard | MEDICAL_CARD                   | 2012    | National Health Insurance Card  |
| ALL   | IdentificationCard | NATIONAL_IDENTIFICATION_CARD   | 2005    | National Identity Card         |
| ALL   | IdentificationCard | DIPLOMATIC_IDENTIFICATION_CARD | 2024    | Diplomatic Identification Card |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2020    | Disability Identification Card |
| ALL   | Passport           | NATIONAL_PASSPORT              | 2008    | Passport                       |
| ALL   | Passport           | NATIONAL_PASSPORT              | 2017    | Passport                       |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT               | 2020    | Resident Certificate           |
| ALL   | TravelDocument     | HOME_RETURN_PERMIT             | 2024    | Home Return Permit             |
| ALL   | Visa               | VISA                           | 2023    | Visa                           |

## Tajikistan (TJK)

| State | Type of ID         | Subtype of ID       | Version | Description     |
| :---- | :----------------- | :------------------ | :------ | :-------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2014    | Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Identity Card   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passport        |
| ALL   | Visa               | VISA                 | 2025    | Visa             |

## Thailand (THA)

| State | Type of ID         | Subtype of ID                      | Version | Description                        |
| :---- | :----------------- | :--------------------------------- | :------ | :--------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE                    | 2010    | Driving License                    |
| ALL   | DriversLicense     | DRIVERS_LICENSE                    | 2013    | Private Car Driving License        |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                | 2001    | Thai National ID Card              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS | 2025    | Identification Card for Foreigners |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS | 2026    | Identification Card for Foreigners |
| ALL   | TravelDocument     | CONSULAR_CARD                      | 2020    | Consular Card                      |
| ALL   | Passport           | NATIONAL_PASSPORT                  | 2012    | Passport                           |
| ALL   | Passport           | NATIONAL_PASSPORT                  | 2020    | Passport                           |
| ALL   | Passport           | EMERGENCY_PASSPORT                 | 2023    | Emergency Passport                 |
| ALL   | Permit             | WORK_PERMIT                        | 2026    | Work Permit                        |

## Turkey (TUR)

| State | Type of ID         | Subtype of ID                          | Version | Description                                                           |
| :---- | :----------------- | :------------------------------------- | :------ | :-------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE                        | 2010    | Driving License                                                       |
| ALL   | DriversLicense     | DRIVERS_LICENSE                        | 2016    | Driving License                                                       |
| ALL   | DriversLicense     | DRIVERS_LICENSE                        | 2022    | Driving License                                                       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                    | 2006    | Türkiye Cumhuriyeti Kimlik Kartı (Turkish Identity Card)              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                    | 2007    | Identity Card                                                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                    | 2017    | Republic of Turkey Identity Card                                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD                    | 2024    | Identification Card (Blue Card)                                       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS     | 2023    | Identification Card for Foreigners                                    |
| ALL   | IdentificationCard | IDENTIFICATION_CARD_FOR_FOREIGNERS     | 2025    | Identification Card for Foreigners                                    |
| ALL   | Other              | FIREARMS_LICENSE                       | 2025    | Firearms License                                                      |
| ALL   | Other              | TEMPORARY_PROTECTION_IDENTITY_DOCUMENT | 2014    | Geçici Koruma Kimlik Belgesi (Temporary Protection Identity Document) |
| ALL   | Permit             | WORK_PERMIT                            | 2023    | Work Permit                                                           |
| ALL   | Permit             | WORK_PERMIT                            | 2024    | Fixed Term Work Permit                                                |
| ALL   | Permit             | WORK_PERMIT                            | 2025    | Work Permit                                                           |
| ALL   | Passport           | NATIONAL_PASSPORT                      | 2010    | Pasaport / Passport                                                   |
| ALL   | Passport           | NATIONAL_PASSPORT                      | 2018    | Pasaport / Passport                                                   |
| ALL   | Passport           | NATIONAL_PASSPORT                      | 2022    | Pasaport / Passport                                                   |
| ALL   | Passport           | TEMPORARY_PASSPORT                     | 2024    | Temporary Passport                                                    |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                       | 2010    | Residence Permit Document                                             |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                       | 2021    | Residence Permit Document                                             |

## Turkish Republic of Northern Cyprus (XCT)

| State | Type of ID         | Subtype of ID              | Version | Description          |
| :---- | :----------------- | :------------------------- | :------ | :------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE            | 2020    | Driving License      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD        | 2022    | Identity Card        |
| ALL   | IdentificationCard | POLICE_IDENTIFICATION_CARD | 2013    | Police Identity Card |
| ALL   | Passport           | NATIONAL_PASSPORT          | 2021    | Pasaport / Passport  |

## Turkmenistan (TKM)

| State | Type of ID     | Subtype of ID     | Version | Description                          |
| :---- | :------------- | :---------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense | DRIVERS_LICENSE   | 2003    | Permis de Conduire / Driving License |
| ALL   | Passport       | NATIONAL_PASSPORT | 1998    | Passport                             |
| ALL   | Passport       | NATIONAL_PASSPORT | 2015    | Passport                             |
| ALL   | Passport       | NATIONAL_PASSPORT | 2025    | Passport                             |

## United Arab Emirates (ARE)

| State | Type of ID         | Subtype of ID                 | Version | Description                  |
| :---- | :----------------- | :---------------------------- | :------ | :--------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                | 2001    | Driving License              |
| ALL   | DriversLicense     | DRIVER_LICENSE                | 2002    | Driving License              |
| ALL   | DriversLicense     | DRIVER_LICENSE                | 2003    | Driving License              |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVERS_LICENSE | 2020    | International Driving Permit |
| ALL   | IdentificationCard | IDENTIFICATION_CARD           | 2011    | Identity Card                |
| ALL   | MedicalCard        | MEDICAL_CARD                  | 2018    | Health Card                  |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2011    | Passport                     |
| ALL   | Passport           | NATIONAL_PASSPORT             | 2023    | Passport                     |
| ALL   | Passport           | DIPLOMATIC_PASSPORT           | 2022    | Diplomatic Passport          |
| ALL   | Visa               | VISA                          | 2020    | Residence Permit             |
| ALL   | ResidenceDocument  | GOLDEN_CARD                   | 2022    | Golden Card                  |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT              | 2000    | Resident Identity Card       |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT              | 2021    | Resident Identity Card       |

## Uzbekistan (UZB)

| State | Type of ID         | Subtype of ID       | Version | Description     |
| :---- | :----------------- | :------------------ | :------ | :-------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Identity Card   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2006    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2019    | Passport        |

## Vietnam (VNM)

| State | Type of ID         | Subtype of ID                  | Version | Description                    |
| :---- | :----------------- | :----------------------------- | :------ | :----------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                 | 2000    | Driver's License               |
| ALL   | DriversLicense     | DRIVER_LICENSE                 | 2003    | Driver's License               |
| ALL   | DriversLicense     | DRIVER_LICENSE                 | 2025    | Driving License                |
| ALL   | IdentificationCard | IDENTIFICATION_CARD            | 1999    | Identity Card                  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD            | 2000    | Identity Card                  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD            | 2020    | Identity Card                  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD            | 2021    | Identity Card                  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD            | 2024    | Identity Card                  |
| ALL   | IdentificationCard | DIPLOMATIC_IDENTIFICATION_CARD | 2025    | Diplomatic Identification Card |
| ALL   | IdentificationCard | POLICE_IDENTIFICATION_CARD     | 2023    | Police Identification Card     |
| ALL   | Passport           | NATIONAL_PASSPORT              | 2005    | Passport                       |
| ALL   | Passport           | NATIONAL_PASSPORT              | 2022    | Passport                       |
| ALL   | Passport           | NATIONAL_PASSPORT              | 2023    | Passport                       |
| ALL   | TravelDocument          | EXIT_ENTRY_PERMIT            | 2024    | Entry and Exit Permit                     |

## Yemen (YEM)

| State | Type of ID         | Subtype of ID       | Version | Description     |
| :---- | :----------------- | :------------------ | :------ | :-------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2019    | Driving License |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2024    | Driving License |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Identity Card   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Passport        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport        |

---

- Path: `general-reference/supported-ids-caribbean`
- URL: https://developer.incode.com/general-reference/supported-ids-caribbean/
- Markdown: https://developer.incode.com/general-reference/supported-ids-caribbean.md

# Caribbean

The following tables list supported identification documents for the Caribbean, organized by country.

## Antigua and Barbuda (ATG)

| State | Type of ID     | Subtype of ID           | Version | Description                |
| :---- | :------------- | :---------------------- | :------ | :------------------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE        | 2020    | Driver's License           |
| ALL   | DriversLicense | LEARNERS\_PERMIT        | 2025    | Learner's Permit           |
| ALL   | MedicalCard    | MEDICAL\_BENEFITS\_CARD | 2021    | Medical Benefits Card      |
| ALL   | MedicalCard    | SOCIAL\_SECURITY\_BOARD | 2022    | Social Security Board Card |
| ALL   | MedicalCard    | SOCIAL\_SECURITY\_BOARD | 2024    | Social Security Board Card |
| ALL   | Passport       | NATIONAL\_PASSPORT      | 2016    | Passport                   |
| ALL   | Passport       | NATIONAL\_PASSPORT      | 2017    | Passport                   |

## Anguilla (AIA)

| State | Type of ID     | Subtype of ID    | Version | Description    |
| :---- | :------------- | :--------------- | :------ | :------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE | 2021    | Driver License |

## Aruba (ABW)

| State | Type of ID         | Subtype of ID        | Version | Description                               |
| :---- | :----------------- | :------------------- | :------ | :---------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2019    | Cedula di Identidad (Identification Card) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2022    | Identity Card                             |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Rijbewijs (Driving License)               |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2020    | Rijbewijs (Driving License)               |
| ALL   | Visa               | VISA                 | 2023    | Visa                                       |

## Barbados (BRB)

| State | Type of ID         | Subtype of ID        | Version | Description         |
| :---- | :----------------- | :------------------- | :------ | :------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Driving License     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2009    | Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2023    | Identification Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2016    | Passport            |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2023    | Passport            |

## Bermuda (BMU)

| State | Type of ID         | Subtype of ID        | Version | Description                 |
| :---- | :----------------- | :------------------- | :------ | :-------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2014    | Driving License             |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2024    | Bermuda Identification Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2004    | Passport                    |

## Bonaire (BES)

| State | Type of ID     | Subtype of ID    | Version | Description                 |
| :---- | :------------- | :--------------- | :------ | :-------------------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE | 2018    | Rijbewijs (Driving License) |

## Cayman Islands (CYM)

| State | Type of ID         | Subtype of ID        | Version | Description      |
| :---- | :----------------- | :------------------- | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2018    | Driver's License |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2020    | Identity Card    |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2008    | Passport         |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Passport         |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2020    | Passport         |

## Cuba (CUB)

| State | Type of ID         | Subtype of ID        | Version | Description                          |
| :---- | :----------------- | :------------------- | :------ | :----------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2019    | Carné de Identidad (Identity Card)   |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2003    | Permis de Conduire (Driving License) |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2016    | Pasaporte (Passport)                 |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2013    | Pasaporte / Passport                 |

## Curaçao (CUW)

| State | Type of ID         | Subtype of ID        | Version | Description                      |
| :---- | :----------------- | :------------------- | :------ | :------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2017    | Rijbewijs (Driving License)      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2023    | Identiteitskaart (Identity Card) |

## Dominica (DMA)

| State | Type of ID | Subtype of ID      | Version | Description |
| :---- | :--------- | :----------------- | :------ | :---------- |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2016    | Passport    |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2022    | Passport    |

## Dominican Republic (DOM)

| State | Type of ID         | Subtype of ID                    | Version | Description                                                                  |
| :---- | :----------------- | :------------------------------- | :------ | :--------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2000    | Licencia de Conducir (Driving License)                                       |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2007    | Driving License                                      |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2022    | Licencia Motocicletas (Driving License)                                      |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2024    | Permiso de Aprendizaje (Driving License)                                     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2026    | Licencia de Conducir (Driving License)                                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2001    | Cédula de Identidad y Electoral (Identity and Electoral Card)                |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2026    | Cédula de Identidad y Electoral (Identity and Electoral Card)                |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2024    | Carnet de Identificación Diplomática / Diplomatic Identification Card        |
| ALL   | IdentificationCard | INTERNATIONAL\_IDENTITY\_CARD    | 2020    | International Identity Card                                                  |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD     | 2022    | Policia Carnet de Identidad / Police Identification Card                     |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD     | 2023    | Policia Nacional Dominicana Carnet de Identidad / Police Identification Card |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD     | 2024    | Policia Carnet de Identidad / Police Identification Card                     |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD     | 2025    | Police Identity Card                                                         |
| ALL   | MedicalCard        | SOCIAL\_SECURITY\_CARD           | 2024    | Social Security Card                                                         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2022    | Residencia Permanente / Residence Permit                                     |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2023    | Residencia Temporal / Residence Permit                                       |
| ALL   | Permit             | WORK\_PERMIT                     | 2022    | Permiso Temporal de Trabajo / Work Permit                                    |
| ALL   | Military           | MILITARY\_CARD                   | 2023    | Military Card                                                                |
| ALL   | Military           | MILITARY\_CARD                   | 2024    | Military Card                                                                |
| ALL   | Military           | MILITARY\_CARD                   | 2025    | Military Card                                                                |
| ALL   | Military           | MILITARY\_CARD                   | 2026    | Military Card                                                                |
| ALL   | TravelDocument     | CONSULAR\_CARD                   | 2021    | Consular Card                                                                |
| ALL   | TravelDocument     | CONSULAR\_CARD                   | 2022    | Consular Card                                                                |
| ALL   | TravelDocument     | CONSULAR\_CARD                   | 2024    | Consular Card                                                                |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2009    | Passport                                                                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2014    | Passport                                                                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2015    | Passport                                                                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2016    | Passport                                                                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2026    | Passport                                                                     |
| ALL   | Visa               | VISA                             | 2019    | Visa                                                                         |
| ALL   | Visa               | VISA                             | 2022    | Visa                                                                         |

## Grenada (GRD)

| State | Type of ID     | Subtype of ID      | Version | Description      |
| :---- | :------------- | :----------------- | :------ | :--------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2019    | Driver's License |
| ALL   | MedicalCard    | SOCIAL\_SECURITY\_CARD | 2025    | Social Security Card |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2001    | Passport         |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2019    | Passport         |

## Haiti (HTI)

| State | Type of ID         | Subtype of ID        | Version | Description                                               |
| :---- | :----------------- | :------------------- | :------ | :-------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Permis de Conduire (Driving License)                      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2005    | Carte D'Identification Nationale (National Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2019    | Carte D'Identification Nationale (National Identity Card) |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2013    | Passeport / Passport                                      |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2017    | Passeport / Passport                                      |

## Jamaica (JAM)

| State | Type of ID          | Subtype of ID               | Version | Description                              |
| :---- | :------------------ | :-------------------------- | :------ | :--------------------------------------- |
| ALL   | DriversLicense      | DRIVERS\_LICENSE            | 2017    | Driver's License                         |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2021    | Elector Registration Identification Card |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2026    | Identification Card                      |
| ALL   | Other                | FIREARMS\_LICENSE           | 2025    | Firearms License                         |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2010    | Passport                                 |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2013    | Passport                                 |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2023    | Passport                                 |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2010    | Elector Registration Identification Card |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2015    | Voter Identification Card                |

## Puerto Rico (PRI)

| State | Type of ID          | Subtype of ID               | Version | Description                                                         |
| :---- | :------------------ | :-------------------------- | :------ | :------------------------------------------------------------------ |
| ALL   | DriversLicense      | DRIVERS\_LICENSE            | 2008    | Licencia de Conducir (Driver's License)                             |
| ALL   | DriversLicense      | DRIVERS\_LICENSE            | 2015    | Driver's License                                                    |
| ALL   | DriversLicense      | DRIVERS\_LICENSE            | 2018    | Driver's License                                                    |
| ALL   | DriversLicense      | DRIVERS\_LICENSE            | 2019    | Licencia de Conducir (Driver's License)                             |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2018    | Tarjeta de identificación (Identification Card)                     |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2019    | Identification Card                                                 |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2015    | Tarjeta De Identificacion Electoral (Electoral Identification Card) |
| ALL   | Other               | FISHERMAN\_LICENSE          | 2020    | Fisherman License                                                   |
| ALL   | Other               | FIREARMS\_LICENSE           | 2020    | Firearm License                                                     |

## Saint Kitts and Nevis (KNA)

| State | Type of ID         | Subtype of ID        | Version | Description                  |
| :---- | :----------------- | :------------------- | :------ | :--------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2015    | National Identification Card |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2019    | Drivers' License             |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2010    | Passport                     |

## Saint Lucia (LCA)

| State | Type of ID         | Subtype of ID        | Version | Description       |
| :---- | :----------------- | :------------------- | :------ | :---------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2015    | National ID Card  |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Driver's License  |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2013    | Official Passport |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2023    | Passport          |

## Sint Maarten (Dutch part) (SXM)

| State | Type of ID     | Subtype of ID    | Version | Description      |
| :---- | :------------- | :--------------- | :------ | :--------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE | 2015    | Driver's License |

## Saint Vincent and the Grenadines (VCT)

| State | Type of ID         | Subtype of ID        | Version | Description            |
| :---- | :----------------- | :------------------- | :------ | :--------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2022    | National Identity Card |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2024    | Drivers License        |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2016    | Passport               |

## The Bahamas (BHS)

| State | Type of ID         | Subtype of ID        | Version | Description         |
| :---- | :----------------- | :------------------- | :------ | :------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2021    | Driver's License    |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2011    | Identification Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2010    | Passport            |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2017    | Passport            |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2026    | Voter Identification Card |

## Trinidad and Tobago (TTO)

| State | Type of ID         | Subtype of ID        | Version | Description                  |
| :---- | :----------------- | :------------------- | :------ | :--------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | National Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2011    | National Identification Card |
| ALL   | DriversLicense | DRIVERS_LICENSE | 1998    | Driver's License |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2006    | Driver's License             |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2007    | Passport                     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2016    | Passport                     |
| ALL   | Permit             | WORK\_PERMIT         | 2024    | Work Permit                  |

## Turks and Caicos Islands (TCA)

| State | Type of ID         | Subtype of ID                     | Version | Description                    |
| :---- | :----------------- | :-------------------------------- | :------ | :----------------------------- |
| ALL   | IdentificationCard | ENDORSEE\_IDENTIFICATION\_CARD    | 2025    | Endorsee Identification Card   |
| ALL   | IdentificationCard | NATIONAL\_STATUS\_CARD            | 2022    | National Status Card           |

## US Virgin Islands (VIR)

| Type of ID          | Subtype of ID               | Version | Description                                |
| :------------------ | :-------------------------- | :------ | :----------------------------------------- |
| DriversLicense      | DRIVERS\_LICENSE            | 2018    | Driver's License                           |
| DriversLicense      | DRIVER\_LICENSE\_UNDER21    | 2019    | Driver's License Under 21                  |
| DriversLicense      | DRIVERS\_LICENSE            | 2023    | Virgin Islands Driver License              |
| DriversLicense      | DRIVER\_LICENSE\_UNDER21    | 2025    | Virgin Islands Driver's License (Under 21) |
| DriversLicense      | DRIVERS\_LICENSE            | 2025    | Virgin Islands Driver's License            |
| IdentificationCard  | IDENTIFICATION\_CARD        | 2018    | Identification Card                        |
| IdentificationCard  | IDENTIFICATION\_CARD        | 2025    | Identification Card                        |
| VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2020    | Virgin Islands Voter Identification Card   |

---

- Path: `general-reference/supported-ids-central-america`
- URL: https://developer.incode.com/general-reference/supported-ids-central-america/
- Markdown: https://developer.incode.com/general-reference/supported-ids-central-america.md

# Central America

The following tables list supported identification documents for Central America, organized by country.

## Belize (BLZ)

| State | Type of ID     | Subtype of ID              | Version | Description                |
| :---- | :------------- | :------------------------- | :------ | :------------------------- |
| ALL   | DriversLicense | DRIVERS_LICENSE            | 2016    | Belize Driver's License    |
| ALL   | DriversLicense | DRIVERS_LICENSE            | 2021    | Belize Driver's License    |
| ALL   | DriversLicense | DRIVERS_LICENSE            | 2022    | Belize Driver's License    |
| ALL   | DriversLicense | DRIVERS_LICENSE            | 2023    | Belize Driver's License    |
| ALL   | Passport       | NATIONAL_PASSPORT          | 2012    | Passport                   |
| ALL   | Passport       | NATIONAL_PASSPORT          | 2023    | Passport                   |
| ALL   | MedicalCard    | SOCIAL_SECURITY_BOARD_CARD | 2020    | Social Security Board Card |
| ALL   | ResidenceDocument | PERMANENT_RESIDENCE_CARD   | 2025    | Permanent Residence Card   |

## Costa Rica (CRI)

| State | Type of ID         | Subtype of ID                   | Version | Description                                                                                               |
| :---- | :----------------- | :------------------------------ | :------ | :-------------------------------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE                  | 2000    | Licencia de Conducir (Driver License)                                                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD             | 1999    | Cedula de Identidad (Identity Card)                                                                       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD             | 2016    | Cedula de Identidad (Identity Card)                                                                       |
| ALL   | IdentificationCard | IDENTIFICATION_CARD             | 2025    | Cedula de Identidad (Identity Card)                                                                       |
| ALL   | IdentificationCard | TARJETA_DE_IDENTIDAD_DE_MENORES | 2010    | Tarjeta de Identidad de Menores de Edad / Identity Card for Minors                                        |
| ALL   | IdentificationCard | TARJETA_DE_IDENTIDAD_DE_MENORES | 2026    | Tarjeta de Identidad de Menores de Edad / Identity Card for Minors                                        |
| ALL   | Passport           | NATIONAL_PASSPORT               | 2015    | Pasaporte (Passport)                                                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT               | 2019    | Pasaporte (Passport)                                                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT               | 2022    | Pasaporte (Passport)                                                                                      |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                | 2005    | Documento de Identidad Migratorio para Extranjeros - DIMEX (Immigration Identity Document for Foreigners)         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT                | 2023    | Documento de Identidad Migratorio para Extranjeros - DIMEX (Immigration Identity Document for Foreigners)         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT_PDF            | 2023    | Documento de Identidad Migratorio para Extranjeros - DIMEX (Digital Immigration Identity Document for Foreigners) |
| ALL   | TravelDocument     | CONSULAR_CARD                   | 2024    | Consular Card                                                                                             |
| ALL   | Permit             | WORK_PERMIT                     | 2024    | Work Permit                                                                                               |
| ALL   | Visa               | VISA                            | 2024    | Visa                                                                                                      |

## El Salvador (SLV)

| State | Type of ID         | Subtype of ID       | Version | Description                                             |
| :---- | :----------------- | :------------------ | :------ | :------------------------------------------------------ |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2000    | Licencia de Conducir (Driver License)                   |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2017    | Licencia de Conducir / Driver License                   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2000    | Documento Unico de Identidad (Unique Identity Document) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2012    | Identification Card                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2013    | Identification Card                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2014    | Documento Unico de Identidad (Unique Identity Document) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Documento Unico de Identidad (Unique Identity Document) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Identification Card                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Documento Unico de Identidad (Unique Identity Document) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | Identification Card                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Documento de Identidad Personal / Identity Card         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2022    | Documento Unico de Identidad (Unique Identity Document) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2023    | Carnet de Identificación Personal / Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2026    | Carnet de Identificación Personal / Identification Card |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2010    | Carné de Residencia / Residence Permit                  |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2024    | Residencia Definitiva / Residence Permit                |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Pasaporte (Passport)                                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2024    | Pasaporte / Passport                                    |

## Guatemala (GTM)

| State | Type of ID         | Subtype of ID       | Version | Description                                                                        |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2011    | Licencia de Conducir (Driver License)                                              |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Licencia de Conducir (Driver License)                                              |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2019    | Licencia de Conducir (Driver License)                                              |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2020    | Licencia de Conducir (Driver License)                                              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2009    | Documento Personal de Identificacion (Personal Identification Document)            |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Documento Personal de Identificación / Identity Card                               |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2016    | Documento Personal de Identificacion (Personal Identification Document)            |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2016    | Pasaporte (Passport)                                                               |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2000    | Documento Personal de Identificacion - Extranjero Domiciliado (Residence Document) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2011    | Documento Personal de Identificacion - Extranjero Domiciliado (Residence Document) |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2017    | Identificacion Consular (Consular ID Card)                                         |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Cédula Diplomática / Consular Card                                                 |

## Honduras (HND)

| State | Type of ID         | Subtype of ID                | Version | Description                                                       |
| :---- | :----------------- | :--------------------------- | :------ | :---------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2019    | Licencia de Conducir (Driver License)                             |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2022    | Permiso de Conducir (Driver License)                              |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2023    | Permiso de Conducir (Driver License)                              |
| ALL   | DriversLicense     | DRIVERS_LICENSE              | 2024    | Permiso de Conducir / Driving License                             |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2009    | Tarjeta de Identidad (Identity Card)                              |
| ALL   | IdentificationCard | IDENTIFICATION_CARD          | 2020    | Documento Nacional de Identificacion (National Identity Document) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2015    | Carnet de Extranjero Residente / Residence Permit                 |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT             | 2020    | Residence Permit / Carnet de Extranjero Residente                 |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2015    | Pasaporte (Passport)                                              |
| ALL   | Passport           | NATIONAL_PASSPORT            | 2022    | Pasaporte (Passport)                                              |
| ALL   | TravelDocument     | CONSULAR_IDENTIFICATION_CARD | 2018    | Matricula Consular (Consular ID)                                  |
| ALL   | TravelDocument     | CONSULAR_IDENTIFICATION_CARD | 2025    | Matricula Consular / Consular ID Card                             |

## Nicaragua (NIC)

| State | Type of ID         | Subtype of ID       | Version | Description                             |
| :---- | :----------------- | :------------------ | :------ | :-------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2021    | Licencia de Conducir (Driver License)   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2009    | Cedula de Identidad (Identity Card)     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2010    | Cedula de Identidad (Identity Card)     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2018    | Cedula de Identidad (Identity Card)     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2026    | Cedula de Identidad (Identity Card)     |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2010    | Cedula de Residencia / Residence Permit |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2012    | Pasaporte (Passport)                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2019    | Pasaporte (Passport)                    |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2020    | Carnet Consular / Consular Card         |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2025    | Carnet de Servicio / Consular Card      |
| ALL   | TravelDocument     | CONSULAR_CARD       | 2026    | Consular Card                           |

## Panama (PAN)

| State | Type of ID         | Subtype of ID             | Version | Description                                                      |
| :---- | :----------------- | :------------------------ | :------ | :--------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER_LICENSE            | 2001    | Licencia de Conducir (Driving License)                           |
| ALL   | DriversLicense     | DRIVER_LICENSE            | 2025    | Licencia de Conducir / Driver's License                          |
| ALL   | IdentificationCard | IDENTIFICATION_CARD       | 2010    | Cedula de Identidad (Domestic Identity Card)                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD       | 2016    | Cedula de Identidad (Domestic Identity Card)                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD       | 2023    | Documento de Identidad (Identity Card)                           |
| ALL   | IdentificationCard | YOUTH_IDENTIFICATION_CARD | 2018    | Cedula Juvenil (Youth ID)                                        |
| ALL   | IdentificationCard | YOUTH_IDENTIFICATION_CARD | 2023    | Cedula Juvenil (Youth ID)                                        |
| ALL   | Passport           | NATIONAL_PASSPORT         | 2013    | Pasaporte / Passport                                             |
| ALL   | Passport           | NATIONAL_PASSPORT         | 2019    | Pasaporte / Passport                                             |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT          | 2000    | Permiso de Residencia Provisional (Provisional Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT          | 2015    | Carné de Residente Permanente (Permanent Resident Card)          |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT          | 2021    | Residence Permit                                                 |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT          | 2023    | Carné de Residente Permanente (Permanent Resident Card)          |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT          | 2024    | Residence Permit                                                 |
| ALL   | ResidenceDocument  | PERMANENT_RESIDENCE_CARD  | 2000    | Residente Permanente / Residence Permit                          |
| ALL   | ResidenceDocument  | PERMANENT_RESIDENCE_CARD  | 2015    | Carné de Residente Permanente (Permanent Resident Card)          |
| ALL   | TravelDocument     | CONSULAR_CARD             | 2020    | Consular Card                                                    |
| ALL   | Permit             | WORK_PERMIT               | 2019    | Permiso de Trabajo / Work Permit                                 |

---

- Path: `general-reference/supported-ids-europe`
- URL: https://developer.incode.com/general-reference/supported-ids-europe/
- Markdown: https://developer.incode.com/general-reference/supported-ids-europe.md

# Europe

The following tables list supported identification documents for Europe, organized by country. The table for the United Kingdom is further divided by state.

## Albania (ALB)

| State | Type of ID         | Subtype of ID                    | Version | Description                                        |
| :---- | :----------------- | :------------------------------- | :------ | :------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2005    | Leje Drejtimi (Driving License)                    |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2015    | Certifikatë Aftësimi Profesional (Driving License) |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2019    | Leje Drejtimi (Driving License)                    |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2013    | Letërnjoftim ID (Identity Card)                    |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2025    | Diplomatic Identification Card                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2010    | Pasaportë (Passport)                               |

## Andorra (AND)

| State | Type of ID        | Subtype of ID      | Version | Description                         |
| :---- | :---------------- | :----------------- | :------ | :---------------------------------- |
| ALL   | DriversLicense    | DRIVERS\_LICENSE   | 1990    | Permis de Conduir (Driving License) |
| ALL   | DriversLicense    | DRIVERS\_LICENSE   | 2025    | Driving License                     |
| ALL   | ResidenceDocument | RESIDENCE\_PERMIT  | 2024    | Residence Permit                    |
| ALL   | Passport          | NATIONAL\_PASSPORT | 2005    | Passaport (Passport)                |
| ALL   | Passport          | NATIONAL\_PASSPORT | 2007    | Passaport (Passport)                |
| ALL   | Passport          | NATIONAL\_PASSPORT | 2017    | Passaport (Passport)                |

## Austria (AUT)

| State | Type of ID         | Subtype of ID                    | Version | Description                                                                    |
| :---- | :----------------- | :------------------------------- | :------ | :----------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2010    | Führerschein Republik Österreich (Driving license for the Republic of Austria) |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2013    | Führerschein (Driving License)                                                 |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2014    | Identity Card of the Republic of Austria                                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2021    | Identity Card                                                                  |
| ALL   | IdentificationCard | DISABILITY\_IDENTIFICATION\_CARD | 2020    | Identity Card for Disabled Persons                                             |
| ALL   | MedicalCard        | MEDICAL\_CARD                    | 2020    | Medical Card                                                                   |
| ALL   | Other              | FIREARMS\_LICENSE                | 2021    | Firearms License                                                               |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2014    | Passport                                                                       |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2024    | Passport                                                                       |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT              | 2012    | Aufenthaltskarte (Residence Card)                                              |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT              | 2017    | Legitimation Card Republic of Austria - Residence Permit                       |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT              | 2021    | Aufenthaltsberechtigungskarte (Residence Permit Card)                          |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2011    | Aufenthaltstitel (Residence Permit)                                            |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Aufenthaltstitel (Residence Permit)                                            |
| ALL   | Visa               | VISA                             | 2020    | Visum / Visa                                                                   |

## Belarus (BLR)

| State | Type of ID         | Subtype of ID        | Version | Description      |
| :---- | :----------------- | :------------------- | :------ | :--------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2012    | Driving License  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | Identity Card    |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Residence Permit |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2022    | Residence Permit |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2010    | Passport         |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2021    | Passport         |

## Belgium (BEL)

| State | Type of ID         | Subtype of ID                 | Version | Description                                                 |
| :---- | :----------------- | :---------------------------- | :------ | :---------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE               | 2010    | Rijbewijs / Permis de Conduire (Driving License)            |
| ALL   | DriversLicense     | DRIVER\_LICENSE               | 2013    | Rijbewijs / Permis de Conduire (Driving License)            |
| ALL   | DriversLicense     | DRIVER\_CARD                  | 2020    | Driver Card                                                 |
| ALL   | DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE | 2013    | Provisional Driving License                                 |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD          | 2014    | Identiteitskaart / Carte D'Identite (Identity Card)         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD          | 2020    | Identiteitskaart / Carte D'Identite (Identity Card)         |
| ALL   | Passport           | NATIONAL\_PASSPORT            | 2014    | Passport                                                    |
| ALL   | Passport           | NATIONAL\_PASSPORT            | 2022    | Passport                                                    |
| ALL   | Passport           | TRAVEL\_DOCUMENT              | 2024    | Travel Document                                             |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT           | 2013    | Verblijfstitel (Residence Permit)                           |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT           | 2015    | E Kaart / E Card (Residence Document)                       |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT           | 2021    | Document de Sejour / Verblijfsdocument (Residence Document) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT             | 2021    | Aufenthaltstitel (Residence Permit)                         |
| ALL   | ResidenceDocument  | SPECIAL\_IDENTITY\_CARD       | 2013    | Special Identity Card                                       |
| ALL   | Visa               | VISA                          | 2019    | Visa                                                        |

## Bosnia and Herzegovina (BIH)

| State | Type of ID         | Subtype of ID        | Version | Description                       |
| :---- | :----------------- | :------------------- | :------ | :-------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Vozacka Dozvola (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2003    | Licna Karta (Identity Card)       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2013    | Licna Karta (Identity Card)       |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2014    | Pasos (Passport)                  |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Pasos (Passport)                  |

## Bulgaria (BGR)

| State | Type of ID         | Subtype of ID        | Version | Description                                     |
| :---- | :----------------- | :------------------- | :------ | :---------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Driving License                                 |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2014    | Driver Card                                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2010    | Licna Karta (Identity Card)                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2024    | Licna Karta (Identity Card)                     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2010    | Passport                                        |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2019    | Passport                                        |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT  | 2015    | Certificate for EU Citizen (Residence Document) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2019    | Residence Permit                                |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2024    | Residence Permit                                |
| ALL   | ResidenceDocument  | TEMPORARY\_PROTECTION\_IDENTITY\_DOCUMENT | 2020    | Temporary Protection Identity Document          |
| ALL   | Visa               | VISA                 | 2023    | Visa                                            |

## Croatia (HRV)

| State | Type of ID         | Subtype of ID       | Version | Description                        |
| :---- | :----------------- | :------------------ | :------ | :--------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 1994    | Vozacka Dozvola (Driving License)  |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2013    | Vozacka Dozvola (Driving License)  |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2024    | Vozacka Dozvola (Driving License)  |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2003    | Osobna Iskaznica (Identity Card)   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2015    | Osobna Iskaznica (Identity Card)   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2021    | Osobna Iskaznica (Identity Card)   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2009    | Putovnica (Passport)               |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2020    | Dozvola boravka (Residence Permit) |
| ALL   | ResidenceDocument  | SPECIAL_IDENTITY_CARD | 2026    | Special Identity Card              |
| ALL   | Visa               | VISA                | 2023    | Viza / Visa                        |

## Cyprus (CYP)

| State | Type of ID         | Subtype of ID                    | Version | Description              |
| :---- | :----------------- | :------------------------------- | :------ | :----------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2014    | Driving License          |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2014    | Identity Card            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2015    | Identity Card            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2020    | Identity Card            |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2025    | Diplomatic Identity Card |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2010    | Passport                 |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2014    | Residence Permit         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Residence Permit         |

## Czech Republic (CZE)

| State | Type of ID         | Subtype of ID        | Version | Description                                  |
| :---- | :----------------- | :------------------- | :------ | :------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2004    | Řidičský Průkaz (Driving License)            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2012    | Občanský Průkaz (National Identity Card)     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | Občanský Průkaz (National Identity Card)     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2009    | Cestovní Pas (Passport)                      |
| ALL   | Passport           | EMERGENCY\_PASSPORT  | 2024    | Emergency Passport                           |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2006    | Residence Permit                             |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2013    | Povolení k Pobytu (Residence Permit)         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2015    | Identity Card and Long Term Residence Permit |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2020    | Povolení k Pobytu (Residence Permit)         |
| ALL   | Visa               | VISA                 | 2022    | Visa                                         |

## Denmark (DNK)

| State          | Type of ID        | Subtype of ID       | Version | Description                          |
| :------------- | :---------------- | :------------------ | :------ | :----------------------------------- |
| ALL            | DriversLicense    | DRIVER\_LICENSE     | 1997    | Kørekort (Driving License)           |
| ALL            | DriversLicense    | DRIVER\_LICENSE     | 2013    | Kørekort (Driving License)           |
| ALL            | DriversLicense    | DRIVER\_LICENSE     | 2018    | Kørekort (Driving License)           |
| ALL            | DriversLicense    | DRIVER\_LICENSE     | 2025    | Driving License                      |
| ALL            | MedicalCard       | MEDICAL\_CARD       | 2014    | Sundhedskort (Health Card)           |
| ALL            | Passport          | NATIONAL\_PASSPORT  | 2012    | Passport                             |
| ALL            | Passport          | NATIONAL\_PASSPORT  | 2021    | Passport                             |
| ALL            | ResidenceDocument | RESIDENCE\_DOCUMENT | 2018    | Opholdskort (Residence Card)         |
| ALL            | ResidenceDocument | RESIDENCE\_PERMIT   | 1998    | Opholdstilladelse (Residence Permit) |
| ALL            | ResidenceDocument | RESIDENCE\_PERMIT   | 2010    | Opholdstilladelse (Residence Permit) |
| ALL            | ResidenceDocument | RESIDENCE\_PERMIT   | 2018    | Opholdstilladelse (Residence Permit) |
| FAROE\_ISLANDS | DriversLicense    | DRIVERS\_LICENSE    | 2020    | Faroe Islands Driving License        |
| FAROE\_ISLANDS | DriversLicense    | DRIVERS\_LICENSE    | 2025    | Faroe Islands Driving License        |
| GREENLAND      | DriversLicense    | DRIVERS\_LICENSE    | 2010    | Kalaallit Nunaat Driver License      |
| GREENLAND      | DriversLicense    | DRIVERS\_LICENSE    | 2024    | Greenland Driving License            |

## Estonia (EST)

| State | Type of ID         | Subtype of ID                    | Version | Description                                                                                      |
| :---- | :----------------- | :------------------------------- | :------ | :----------------------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2013    | Juhiluba (Driving License)                                                                       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2020    | Juhiluba (Driving License)                                                                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2011    | Isikutunnistus (Identity Card)                                                                   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2018    | Isikutunnistus (Identity Card)                                                                   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2025    | Isikutunnistus (Identity Card)                                                                   |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2022    | Diplomatic Identity Card                                                                         |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2010    | Passport                                                                                         |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2014    | Passport                                                                                         |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2021    | Passport                                                                                         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2016    | Rahvusvahelise Kaitse Taotleja Tunnistus (Certificate of Applicant for International Protection) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2018    | Elamisluba (Residence Permit)                                                                    |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Elamisluba (Residence Permit)                                                                    |

## Finland (FIN)

| State | Type of ID         | Subtype of ID               | Version | Description                                                                   |
| :---- | :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------------------- |
| ALAND | DriversLicense     | DRIVERS\_LICENSE            | 2015    | Aland Körkort (Driving License)                                               |
| ALAND | DriversLicense     | DRIVERS\_LICENSE            | 2020    | Aland Körkort (Driving License)                                               |
| ALL   | DriversLicense     | DRIVERS\_LICENSE            | 2000    | Ajokortti Körkort (Driving License)                                           |
| ALL   | DriversLicense     | DRIVERS\_LICENSE            | 2013    | Ajokortti Körkort (Driving License)                                           |
| ALL   | DriversLicense     | DRIVERS\_LICENSE            | 2019    | Ajokortti Körkort (Driving License)                                           |
| ALL   | DriversLicense     | DRIVERS\_LICENSE            | 2024    | Driving License / Permis de Conduire                                          |
| ALL   | DriversLicense     | DRIVER\_QUALIFICATION\_CARD | 2022    | Driver Qualification Card                                                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD        | 2011    | Identitetskort (Identity Card)                                                |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD        | 2017    | Identitetskort (Identity Card)                                                |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD        | 2021    | Identitetskort (Identity Card)                                                |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD        | 2023    | Identitetskort (Identity Card)                                                |
| ALL   | IdentificationCard | MINORS\_ID                  | 2024    | Minor's Identity Card                                                         |
| ALL   | MedicalCard        | MEDICAL\_CARD               | 2025    | Medical Card                                                                  |
| ALL   | Passport           | NATIONAL\_PASSPORT          | 2000    | Passport                                                                      |
| ALL   | Passport           | NATIONAL\_PASSPORT          | 2006    | Passi / Passport                                                              |
| ALL   | Passport           | NATIONAL\_PASSPORT          | 2012    | Passport                                                                      |
| ALL   | Passport           | NATIONAL\_PASSPORT          | 2017    | Passport                                                                      |
| ALL   | Passport           | NATIONAL\_PASSPORT          | 2025    | Passport                                                                      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT           | 2012    | Finnish Residence Permit                                                      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT           | 2017    | Identitetskort (Identity Card)                                                |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT           | 2020    | Identitetskort /Identity Card (this document authorizes residence in Finland) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT           | 2023    | Residence Permit                                                              |
| ALL   | Visa               | VISA                        | 2019    | Viisumi (Visa)                                                                |
| ALL   | Visa               | VISA                        | 2022    | Viisumi (Visa)                                                                |
| ALL   | MedicalCard        | MEDICAL\_CARD               | 2024    | Health Insurance Card                                                         |

## France (FRA)

| State          | Type of ID         | Subtype of ID                      | Version | Description                                        |
| :------------- | :----------------- | :--------------------------------- | :------ | :------------------------------------------------- |
| ALL            | DriversLicense     | DRIVER\_LICENSE                    | 1999    | Permis de Conduire (Driver's License)              |
| ALL            | DriversLicense     | DRIVER\_LICENSE                    | 2013    | Permis de Conduire (Driver's License)              |
| ALL            | DriversLicense     | DRIVER\_QUALIFICATION\_CARD        | 2020    | Driver Qualification Card                          |
| ALL            | IdentificationCard | IDENTIFICATION\_CARD               | 1994    | Carte Nationale D'Identite (Identity Card)         |
| ALL            | IdentificationCard | IDENTIFICATION\_CARD               | 2021    | Carte Nationale D'Identite (Identity Card)         |
| ALL            | IdentificationCard | PROFESSIONAL\_IDENTIFICATION\_CARD | 2024    | Professional Identification Card                   |
| ALL            | Military           | MILITARY\_ID                       | 2009    | Carte D'identité Militaire (Military Card)         |
| ALL            | Military           | MILITARY\_ID                       | 2020    | Carte D'Identite Militaire (Military ID Card)      |
| ALL            | Military           | MILITARY\_ID                       | 2023    | Military ID Card                                   |
| ALL            | Passport           | DIPLOMATIC\_PASSPORT               | 2008    | Passeport Diplomatique (Diplomatic Passport)       |
| ALL            | Passport           | NATIONAL\_PASSPORT                 | 2008    | Passeport (Passport)                               |
| ALL            | Passport           | EMERGENCY\_PASSPORT                | 2023    | Passeport D'urgence / Emergency Passport           |
| ALL            | Permit             | PRIVATE\_HIRE\_DRIVERS\_LICENSE    | 2024    | Private Hire Driver's License                      |
| ALL            | ResidenceDocument  | RESIDENCE\_PERMIT                  | 2001    | Residence Permit                                   |
| ALL            | ResidenceDocument  | RESIDENCE\_PERMIT                  | 2011    | Titre de Séjour (Residence Permit)                 |
| ALL            | ResidenceDocument  | RESIDENCE\_PERMIT                  | 2020    | Titre de Séjour (Residence Permit)                 |
| ALL            | Visa               | VISA                               | 2010    | Visa                                               |
| ALL            | Visa               | VISA                               | 2020    | Visa                                               |
| ALL            | MedicalCard        | MEDICAL\_CARD                      | 2023    | Medical Card                                       |
| ALL            | MedicalCard        | MEDICAL\_CARD                      | 2024    | Medical Card                                       |
| NEW\_CALEDONIA | DriversLicense     | DRIVERS\_LICENSE                   | 2024    | New Caledonia Permis de Conduire (Driving License) |

## Georgia (GEO)

| State | Type of ID         | Subtype of ID        | Version | Description              |
| :---- | :----------------- | :------------------- | :------ | :----------------------- |
| ABHAZIA | DriversLicense     | DRIVERS\_LICENSE     | 2025    | Abkhazia Driving License |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2006    | Driving License          |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Driving License          |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2012    | Identity Card            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2025    | Identity Card            |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Temporary Residence Card |
| ALL   | ResidenceDocument  | TEMPORARY\_RESIDENCE\_CARD | 2025    | Temporary Residence Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2010    | Passport                 |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2016    | Passport                 |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2025    | Passport                 |

## Germany (DEU)

| State | Type of ID         | Subtype of ID          | Version | Description                                           |
| :---- | :----------------- | :--------------------- | :------ | :---------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE        | 2011    | Führerschein (Driver's License)                       |
| ALL   | DriversLicense     | DRIVER\_LICENSE        | 2013    | Führerschein (Driver's License)                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD   | 2007    | Personalausweis (Identity Card)                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD   | 2010    | Personalausweis (Identity Card)                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD   | 2021    | Personalausweis (Identity Card)                       |
| ALL   | IdentificationCard | TEMP\_GERMAN\_IDCARD   | 2004    | Vorlaufiger Personalausweis (Temporary Identity Card) |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2025 | Diplomatic Identification Card                |
| ALL   | Passport           | NATIONAL\_PASSPORT     | 2007    | Reisepass (Passport)                                  |
| ALL   | Passport           | NATIONAL\_PASSPORT     | 2017    | Reisepass (Passport)                                  |
| ALL   | Passport           | TEMPORARY\_PASSPORT    | 2014    | Vorläufiger Reisepass (Temporary Passport)            |
| ALL   | ResidenceDocument  | FICTIONAL\_CERTIFICATE | 2020    | Fictional Certificate                                 |
| ALL   | ResidenceDocument  | FICTIONAL\_CERTIFICATE | 2024    | Fiktionsbescheinigung (Fictional Certificate)         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT      | 2011    | Aufenthaltstitel (Residence Permit)                   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT      | 2019    | Aufenthaltstitel (Residence Permit)                   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT      | 2021    | Residence Permit                                      |
| ALL   | Visa               | VISA                   | 2018    | Visum (Visa)                                          |
| ALL   | MedicalCard        | MEDICAL\_CARD          | 2024    | Medical Card                                          |

## Gibraltar (GIB)

| State | Type of ID         | Subtype of ID             | Version | Description                      |
| :---- | :----------------- | :------------------------ | :------ | :------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD      | 2020    | Identity Card / Carte D'Identite |
| ALL   | Other              | CIVIL\_REGISTRATION\_CARD | 2020    | Civilian Registration Card       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE          | 2023    | Driving License                  |

## Greece (GRC)

| State | Type of ID         | Subtype of ID                     | Version | Description                |
| :---- | :----------------- | :-------------------------------- | :------ | :------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                  | 2009    | Driver's License           |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                  | 2013    | Driver's License           |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                  | 2023    | Driver's License           |
| ALL   | IdentificationCard | DOMESTIC\_IDENTIFICATION\_CARD    | 2016    | Identity Card              |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD              | 2016    | Identity Card              |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD              | 2023    | Identity Card              |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD      | 2020    | Police Identification Card |
| ALL   | IdentificationCard | POLICE\_IDENTIFICATION\_CARD      | 2025    | Police Identification Card |
| ALL   | Military           | MILITARY\_ID                      | 2022    | Military ID Card           |
| ALL   | Passport           | DIPLOMATIC\_PASSPORT              | 2006    | Diplomatic Passport        |
| ALL   | Passport           | NATIONAL\_PASSPORT                | 2020    | Passport                   |
| ALL   | Passport           | NATIONAL\_PASSPORT                | 2024    | Passport                   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                 | 2013    | Residence Permit           |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                 | 2020    | Residence Permit           |
| ALL   | ResidenceDocument  | ASYLUM\_SEEKER\_CARD              | 2020    | Asylum Seeker Card         |
| ALL   | ResidenceDocument  | TEMPORARY\_PROTECTION\_IDENTITY\_DOCUMENT | 2026    | Temporary Protection Identity Document |
| ALL   | Other              | FIREFIGHTER\_IDENTIFICATION\_CARD | 2024    | Firefighter Identity Card  |
| ALL   | Visa         | VISA                | 2023    | Visa                  |

## Hungary (HUN)

| State | Type of ID         | Subtype of ID                         | Version | Description                                 |
| :---- | :----------------- | :------------------------------------ | :------ | :------------------------------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                      | 2013    | Vezetői Engedély (Driving License)          |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2012    | Személyazonosító Igazolvány (Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2016    | Személyazonosító Igazolvány (Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2022    | Temporary Identity Card                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD\_FOR\_FOREIGNERS | 2016    | ID Card for foreigners                      |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2012    | Útlevél (Passport)                          |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2023    | Útlevél (Passport)                          |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2018    | Tartózkodási Engedély (Residence Permit)    |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2019    | Permanent Residence Permit                  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2020    | Tartózkodási Engedély (Residence Permit)    |
| ALL   | Visa  | VISA                  | 2023    | Visa    |

## Iceland (ISL)

| State | Type of ID     | Subtype of ID      | Version | Description                    |
| :---- | :------------- | :----------------- | :------ | :----------------------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 1997    | Ökuskírteini (Driving License) |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2002    | Ökuskírteini (Driving License) |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2016    | Ökuskírteini (Driving License) |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2024    | Ökuskírteini (Driving License) |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2013    | Vegabréf (Passport)            |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2018    | Vegabréf (Passport)            |
| ALL   | ResidenceDocument | RESIDENCE\_PERMIT | 2020    | Residence Permit               |

## Interpol (XPO)

| State | Type of ID         | Subtype of ID        | Version | Description                                           |
| :---- | :----------------- | :------------------- | :------ | :---------------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2014    | Interpol Identification Card (Carte D'Identification) |
| ALL   | Passport           | PASSPORT             | 2013    | Interpol Passport / Passeport                         |

## Ireland (IRL)

| State | Type of ID          | Subtype of ID               | Version | Description                        |
| :---- | :------------------ | :-------------------------- | :------ | :--------------------------------- |
| ALL   | DriversLicense      | DRIVER\_LICENSE             | 2013    | Ceadúnas Tiomána (Driving License) |
| ALL   | DriversLicense      | LEARNER\_PERMIT             | 2013    | Cead Foghlamor (Learner's Permit)  |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2015    | Passport Card                      |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD        | 2025    | Identification Card                |
| ALL   | IdentificationCard  | AGE\_CARD                   | 2020    | Age Card                           |
| ALL   | Other               | PUBLIC\_SERVICES            | 2013    | Public Services Card               |
| ALL   | Other               | PUBLIC\_SERVICES            | 2014    | Public Services Card               |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2006    | Pas / Passport                     |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2013    | Pas / Passport                     |
| ALL   | Passport            | NATIONAL\_PASSPORT          | 2026    | Passport                           |
| ALL   | Passport            | PASSPORT\_CARD              | 2026    | Passport Card                      |
| ALL   | ResidenceDocument   | RESIDENCE\_PERMIT           | 2001    | Certificate of Registration        |
| ALL   | ResidenceDocument   | RESIDENCE\_PERMIT           | 2017    | Residence Permit                   |
| ALL   | ResidenceDocument   | RESIDENCE\_PERMIT           | 2020    | Residence Permit                   |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD | 2020    | Electoral Identity Card            |

## Italy (ITA)

| State | Type of ID         | Subtype of ID                    | Version | Description                               |
| :---- | :----------------- | :------------------------------- | :------ | :---------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2000    | Patente di Guida (Driver's License)       |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2013    | Patente di Guida (Driver's License)       |
| ALL   | IdentificationCard | DOMESTIC\_DOCUMENT\_OF\_IDENTITY | 2000    | Carta di Identità (Identity Card)         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2004    | Carta di Identità (Identity Card)         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2016    | Carta di Identità (Identity Card)         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2023    | Carta di Identità (Identity Card)         |
| ALL   | MedicalCard        | HEALTH\_CARD                     | 2022    | Tessera Sanitaria (Health Insurance Card) |
| ALL   | MedicalCard        | HEALTH\_CARD                     | 2025    | Health Card                               |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2005    | Passaporto (Passport)                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2010    | Passaporto (Passport)                     |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2011    | Permesso di Soggiorno (Residence Permit)  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2013    | Permesso di Soggiorno (Residence Permit)  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2021    | Permesso di Soggiorno (Residence Permit)  |
| ALL   | TravelDocument     | CONSULAR\_CARD                   | 2023    | Consular Card                             |
| ALL   | Visa               | VISA                             | 2005    | Visto (Visa)                              |
| ALL   | Visa               | VISA                             | 2019    | Visto (Visa)                              |

## Jersey (JEY)

| State | Type of ID     | Subtype of ID   | Version | Description     |
| :---- | :------------- | :-------------- | :------ | :-------------- |
| ALL   | DriversLicense | DRIVER\_LICENSE | 2014    | Driving License |

## Kosovo (RKS)

| State | Type of ID         | Subtype of ID        | Version | Description           |
| :---- | :----------------- | :------------------- | :------ | :-------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2008    | Driving License       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2021    | Driving License       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2024    | Driving License       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2008    | Identity Card         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2013    | Identity Card         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2024    | Identity Card         |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2011    | Passaporte / Passport |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2013    | Passaporte / Passport |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2024    | Passport              |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Residence Permit      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2025    | Residence Permit      |

## Latvia (LVA)

| State | Type of ID         | Subtype of ID        | Version | Description                          |
| :---- | :----------------- | :------------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2014    | Vadītāja Apliecība (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2012    | Personas Apliecība (Identity Card)   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2019    | Personas Apliecība (Identity Card)   |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2012    | Pase (Passport)                      |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Pase (Passport)                      |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2024    | Pase (Passport)                      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Permanent Residence Card             |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2024    | Residence Permit                     |

## Liechtenstein (LIE)

| State | Type of ID        | Subtype of ID      | Version | Description                          |
| :---- | :---------------- | :----------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense    | DRIVERS\_LICENSE   | 2018    | Permis de Conduire (Driving License) |
| ALL   | DriversLicense    | DRIVERS\_LICENSE   | 2022    | Driving License                       |
| ALL   | IdentificationCard    | IDENTIFICATION_CARD   | 2024    | Identity Card                       |
| ALL   | Passport          | NATIONAL\_PASSPORT | 2016    | Passport                             |
| ALL   | Passport          | NATIONAL\_PASSPORT | 2026    | Passport                             |
| ALL   | ResidenceDocument | RESIDENCE\_PERMIT  | 2020    | Aufenthaltskarte (Residence Card)    |

## Lithuania (LTU)

| State | Type of ID         | Subtype of ID              | Version | Description                              |
| :---- | :----------------- | :------------------------- | :------ | :--------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE           | 2000    | Permis de Conduire (Driving License)     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE           | 2010    | Vairuotojo Pazymejimas (Driving License) |
| ALL   | DriversLicense     | DRIVERS\_LICENSE           | 2011    | Vairuotojo Pazymejimas (Driving License) |
| ALL   | DriversLicense     | DRIVERS\_LICENSE           | 2013    | Vairuotojo Pazymejimas (Driving License) |
| ALL   | DriversLicense     | DRIVERS\_LICENSE           | 2017    | Vairuotojo Pazymejimas (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2010    | Personal Identity Card                   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2012    | Personal Identity Card                   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2021    | Identity Card                            |
| ALL   | IdentificationCard | PENSIONERS\_IDENTITY\_CARD | 2024    | Pensioner certificate                    |
| ALL   | Passport           | NATIONAL\_PASSPORT         | 2019    | Passport                                 |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT          | 2012    | Leidimas Gyventi (Residence Permit)      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT          | 2020    | Leidimas Gyventi (Residence Permit)      |
| ALL   | Visa               | VISA                       | 2020    | Viza / Visa                              |

## Luxembourg (LUX)

| State | Type of ID         | Subtype of ID        | Version | Description                          |
| :---- | :----------------- | :------------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Permis de Conduire (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2008    | Identity Card / Carte D'Identite     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2014    | Identity Card / Carte D'Identite     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | Identity Card / Carte D'Identite     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Pass / Passport                      |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2026    | Pass / Passport                      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2013    | Titre de Sejour (Residence Permit)   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2020    | Titre de Sejour (Residence Permit)   |
| ALL   | TravelDocument     | CONSULAR\_CARD       | 2024    | Consular Card                        |

## Malta (MLT)

| State | Type of ID         | Subtype of ID        | Version | Description                              |
| :---- | :----------------- | :------------------- | :------ | :--------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Driving License                          |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2020    | Driving License                          |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2014    | Identity Card                            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2020    | Identity Card                            |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2008    | Passaport (Passport)                     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2021    | Passaport (Passport)                     |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2020    | Permess Ta 'Residenza (Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2025    | Residence Permit                         |

## Moldova (MDA)

| State | Type of ID         | Subtype of ID                             | Version | Description                            |
| :---- | :----------------- | :---------------------------------------- | :------ | :------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                          | 2015    | Permis de Conducere (Driving License)  |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                          | 2023    | Driving License                        |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                          | 2026    | Driving License                        |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                      | 2007    | Buletin de Identitate (Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                      | 2014    | Buletin de Identitate (Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                      | 2015    | Buletin de Identitate (Identity Card)  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                      | 2025    | Buletin de Identitate (Identity Card)  |
| ALL   | Other              | TEMPORARY\_PROTECTION\_IDENTITY\_DOCUMENT | 2023    | Temporary Protection Identity Document |
| ALL   | Passport           | NATIONAL\_PASSPORT                        | 2014    | Passport                               |
| ALL   | Passport           | NATIONAL\_PASSPORT                        | 2023    | Passport                               |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                         | 2023    | Residence Permit                       |

## Monaco (MCO)

| State | Type of ID         | Subtype of ID        | Version | Description                       |
| :---- | :----------------- | :------------------- | :------ | :-------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2009    | Identity Card / Carte D'Identite  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2018    | Carte D'identité (Identity Card)  |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2005    | Passeport / Passport              |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2017    | Carte de Resident (Resident Card) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2023    | Residence Permit                  |

## Montenegro (MNE)

| State | Type of ID         | Subtype of ID        | Version | Description                                                               |
| :---- | :----------------- | :------------------- | :------ | :------------------------------------------------------------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2008    | Vozacka Dozvola (Driving License)                                         |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2020    | Vozacka Dozvola (Driving License)                                         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2008    | Licna Karta (Identity Card)                                               |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2020    | Licna Karta (Identity Card)                                               |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2022    | Permanent Residence Permit                                                |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2023    | Dozvola za privremeni boravak i rad (Temporary residence and work permit) |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2008    | Pasos (Passport)                                                          |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2020    | Pasos (Passport)                                                          |

## Netherlands (NLD)

| State | Type of ID         | Subtype of ID                    | Version | Description                    |
| :---- | :----------------- | :------------------------------- | :------ | :----------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2006    | Driving License                |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2013    | Driving License                |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2018    | Driving License                |
| ALL   | DriversLicense     | DRIVER\_LICENSE                  | 2025    | Driving License                |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2014    | Identity Card                  |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2016    | Diplomatic Identification Card |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2006    | Paspoort (Passport)            |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2014    | Paspoort (Passport)            |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2024    | Passport                       |
| ALL   | Permit             | PRIVATE\_HIRE\_DRIVERS\_LICENSE  | 2021    | Private Hire Driver's License  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2014    | Dutch Residence Permit         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Residence Permit               |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2022    | Residence Permit               |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2026    | Residence Permit               |
| ALL   | Visa               | VISA                             | 2023    | Visa                           |

## Norway (NOR)

| State | Type of ID         | Subtype of ID                | Version | Description          |
| :---- | :----------------- | :--------------------------- | :------ | :------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE              | 1989    | Driving License      |
| ALL   | DriversLicense     | DRIVER\_LICENSE              | 2007    | Driving License      |
| ALL   | DriversLicense     | DRIVER\_LICENSE              | 2013    | Driving License      |
| ALL   | DriversLicense     | DRIVER\_LICENSE              | 2018    | Driving License      |
| ALL   | DriversLicense     | DRIVER\_LICENSE              | 2023    | Driving License      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD         | 2015    | Handelsbanken BankID |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD         | 2020    | Identity Card        |
| ALL   | MilitaryCard       | MILITARY\_CARD               | 2024    | Military Card        |
| ALL   | Passport           | NATIONAL\_PASSPORT           | 2011    | Passport             |
| ALL   | Passport           | NATIONAL\_PASSPORT           | 2021    | Passport             |
| ALL   | Passport           | IMMIGRATION\_PASSPORT        | 2023    | Immigration Passport |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT            | 2020    | Residence Card       |
| ALL   | ResidenceDocument  | TEMPORARY\_RESIDENCE\_PERMIT | 2012    | Residence Permit     |
| ALL   | ResidenceDocument  | ASYLUM\_SEEKER\_CARD         | 2023    | Asylum Seeker Card   |
| ALL   | Visa  | VISA       | 2024    | Visa   |

## Poland (POL)

| State | Type of ID         | Subtype of ID                               | Version | Description                              |
| :---- | :----------------- | :------------------------------------------ | :------ | :--------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                            | 2000    | Prawo Jazdy (Driving License)            |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                            | 2001    | Permis de Conduire (Driving License)     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                            | 2002    | Prawo Jazdy (Driving License)            |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                            | 2013    | Prawo Jazdy (Driving License)            |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                        | 2013    | Dowód Osobisty (Identity Card)           |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                        | 2015    | Dowód Osobisty (Identity Card)           |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                        | 2019    | Dowód Osobisty (Identity Card)           |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                        | 2022    | Karta Polaka (Pole's Card)               |
| ALL   | Passport           | NATIONAL\_PASSPORT                          | 2011    | Paszport (Passport)                      |
| ALL   | Passport           | NATIONAL\_PASSPORT                          | 2018    | Paszport (Passport)                      |
| ALL   | Passport           | TEMPORARY\_PASSPORT                         | 2024    | Temporary Passport                       |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                           | 2018    | Karta Pobytu (Residence Permit)          |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                           | 2020    | Karta Pobytu (Residence Permit)          |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                           | 2024    | Residence Permit                         |
| ALL   | ResidenceDocument  | SPECIAL\_IDENTITY\_CARD                     | 2010    | Special Identity Card                    |
| ALL   | ResidenceDocument  | TEMPORARY\_FOREIGNER\_IDENTITY\_CERTIFICATE | 2024    | Temporary Foreigner Identity Certificate |
| ALL   | ResidenceDocument  | TEMPORARY\_FOREIGNER\_IDENTITY\_CERTIFICATE | 2025    | Temporary Foreigner Identity Certificate |
| ALL   | Military           | MILITARY\_IDENTIFICATION\_CARD               | 2025    | Military Identification Card             |
| ALL   | Visa         | VISA              | 2020    | Visa            |

## Portugal (PRT)

| State | Type of ID         | Subtype of ID                         | Version | Description                             |
| :---- | :----------------- | :------------------------------------ | :------ | :-------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                      | 1999    | Carta de Condução (Driving License)     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                      | 2013    | Carta de Condução (Driving License)     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                      | 2014    | Carta de Condução (Driving License)     |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                      | 2025    | Carta de Condução (Driving License)     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2015    | Cartão de Cidadão (Citizen Card)        |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2024    | Cartão de Cidadão (Identity Card)       |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD      | 2025    | Diplomatic Identification Card          |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD\_FOR\_FOREIGNERS | 2024    | Identification Card for Foreigners      |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2009    | Passport                                |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2018    | Passport                                |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2008    | Título de Residência (Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2020    | Título de Residência (Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2023    | Permanent Residence Certificate |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2024    | Residence Permit                        |
| ALL   | ResidenceDocument  | ASYLUM\_SEEKER\_CARD                  | 2020    | Asylum Seeker Card                      |
| ALL   | Visa               | VISA                                  | 2010    | Visto (Visa)                            |
| ALL   | Visa               | VISA                                  | 2019    | Visto (Visa)                            |

## Republic of North Macedonia (MKD)

| State | Type of ID         | Subtype of ID        | Version | Description                               |
| :---- | :----------------- | :------------------- | :------ | :---------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2007    | Vozacka Dozvola (Driving License)         |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2007    | Licna Karta (Identity Card)               |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2008    | Licna Karta (Identity Card)               |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Pasos (Passport)                          |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2017    | Pasos (Passport)                          |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2019    | Permanent Residence Permit for Foreigners |

## Romania (ROU)

| State | Type of ID         | Subtype of ID                    | Version | Description                           |
| :---- | :----------------- | :------------------------------- | :------ | :------------------------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2013    | Permis de Conducere (Driving License) |
| ALL   | DriversLicense     | DRIVER\_QUALIFICATION\_CARD      | 2022    | Driver Qualification Card             |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2015    | Carte de Identitate (Identity Card)   |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2022    | Carte de Identitate (Identity Card)   |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2025    | Diplomatic Identification Card        |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2008    | Pasaport/Passport                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2019    | Pasaport/Passport                     |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2024    | Pasaport/Passport                     |
| ALL   | Passport           | TEMPORARY\_PASSPORT              | 2020    | Pasaport/Passport                     |
| ALL   | Passport           | TEMPORARY\_PASSPORT              | 2023    | Pasaport/Passport                     |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2013    | Permis de ședere (Residence Permit)   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Permis de ședere (Residence Permit)   |
| ALL   | ResidenceDocument  | RESIDENCE\_CARD                  | 2020    | Residence Card                        |
| ALL   | Visa  | VISA                  | 2025    | Visa                       |

## Saint Martin (French part) (MAF)

| State | Type of ID     | Subtype of ID    | Version | Description                          |
| :---- | :------------- | :--------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE | 2019    | Permis de Conduire (Driving License) |

## San Marino (SMR)

| State | Type of ID         | Subtype of ID        | Version | Description                      |
| :---- | :----------------- | :------------------- | :------ | :------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2017    | Carta D'identità / Identity Card |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2024    | Carta D'identità / Identity Card |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2021    | Driving License                  |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Passaporto (Passport)            |

## Serbia (SRB)

| State | Type of ID         | Subtype of ID                         | Version | Description                                                     |
| :---- | :----------------- | :------------------------------------ | :------ | :-------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE                       | 2011    | Vozacka Dozvola (Driving License)                               |
| ALL   | DriversLicense     | DRIVER\_QUALIFICATION\_CARD           | 2025    | Driver Qualification Card                                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD                  | 2008    | Licna Karta (Identity Card)                                     |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD      | 2020    | Diplomatic Identification Card                                  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD\_FOR\_FOREIGNERS | 2022    | Licna karta za strance / Identification Card for Foreigners     |
| ALL   | Other              | FIREARMS\_LICENSE                     | 2021    | Firearms License                                                |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                     | 2011    | Dozvola za privremeni boravak i rad (Residence and work permit) |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2008    | Pasos (Passport)                                                |
| ALL   | Passport           | NATIONAL\_PASSPORT                    | 2026    | Pasos (Passport)                                                |

## Slovakia (SVK)

| State | Type of ID         | Subtype of ID        | Version | Description                                                                        |
| :---- | :----------------- | :------------------- | :------ | :--------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2008    | Vodičský Preukaz (Driving License)                                                 |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Vodičský Preukaz (Driving License)                                                 |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Vodičský Preukaz (Driving License)                                                 |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2013    | Občiansky Preukaz (Identity Card)                                                  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2022    | Občiansky Preukaz (Identity Card)                                                  |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2023    | Identity Card                                                                      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2025    | Občiansky Preukaz (Identity Card)                                                  |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2008    | Passport                                                                           |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2024    | Passport                                                                           |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2019    | Povolenie Na Pobyt (Residence Permit)                                              |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2020    | Pobyt rodinného príslušníka občana EÚ (Residence Card of EU Citizen Family Member) |

## Slovenia (SVN)

| State | Type of ID         | Subtype of ID        | Version | Description                           |
| :---- | :----------------- | :------------------- | :------ | :------------------------------------ |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Voznisko Dovoljenje (Driving License) |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2015    | Voznisko Dovoljenje (Driving License) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 1998    | Osebna Iskaznica (Identity Card)      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2022    | Osebna Iskaznica (Identity Card)      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2020    | Residence Permit                      |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Residence Permit                      |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2006    | Potni List (Passport)                 |

## Spain (ESP)

| State | Type of ID         | Subtype of ID              | Version | Description                                                                               |
| :---- | :----------------- | :------------------------- | :------ | :---------------------------------------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVER\_LICENSE            | 2004    | Permiso de Conduccion (Driver's License)                                                  |
| ALL   | DriversLicense     | DRIVER\_LICENSE            | 2013    | Permiso de Conduccion (Driver's License)                                                  |
| ALL   | DriversLicense     | DRIVER\_CARD               | 2020    | Tarjeta de Conductor / Driver Card                                                        |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2006    | Documento Nacional de Identidad (National Identity Document)                              |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2010    | Identification Card                                                                       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2015    | Documento Nacional de Identidad (National Identity Document)                              |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD       | 2021    | Documento Nacional de Identidad (National Identity Document)                              |
| ALL   | IdentificationCard | CITIZENCARD                | 2020    | Citizen Card                                                                              |
| ALL   | Military           | MILITARY\_CARD             | 2020    | Military Card                                                                             |
| ALL   | Military           | MILITARY\_DRIVERS\_LICENSE | 2025    | Military Driving License                                                                  |
| ALL   | Passport           | NATIONAL\_PASSPORT         | 2008    | Pasaporte (Passport)                                                                      |
| ALL   | Passport           | NATIONAL\_PASSPORT         | 2015    | Pasaporte (Passport)                                                                      |
| ALL   | ResidenceDocument  | RESIDENCE\_DOCUMENT        | 2017    | Certificado de Registro de Ciudadano de la Union (Union Citizen Registration Certificate) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT          | 2010    | Tarjeta de Identidad de Extranjero (Foreigner Identity Card)                              |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT          | 2011    | Permiso de Residencia (Residence Permit)                                                  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT          | 2020    | Permiso de Residencia (Residence Permit)                                                  |
| ALL   | ResidenceDocument  | ASYLUM\_SEEKER\_CARD       | 2021    | Asylum Seeker Card                                                                        |
| ALL   | TravelDocument     | CONSULAR\_CARD             | 2020    | Consular Card                                                                             |
| ALL   | TravelDocument     | CONSULAR\_CARD             | 2021    | Consular Card                                                                             |
| ALL   | TravelDocument     | CONSULAR\_CARD             | 2023    | Consular Card                                                                             |
| ALL   | Visa               | VISA                       | 2019    | Visado (Visa)                                                                             |
| ALL   | Visa               | VISA                       | 2021    | Visado (Visa)                                                                             |

## Sweden (SWE)

| State | Type of ID         | Subtype of ID        | Version | Description                                        |
| :---- | :----------------- | :------------------- | :------ | :------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2007    | Körkort Sverige (Driving License)                  |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2013    | Körkort Sverige (Driving License)                  |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2016    | Körkort Sverige (Driving License)                  |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2024    | Driving License                                    |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2025    | Driving License                                    |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2000    | Identity Card                                      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2007    | Identity Card                                      |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2012    | National Identity Card                             |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2013    | Identitetskort (Identity Card)                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2017    | Identitetskort (Identity Card)                     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | Nationellt Identitetskort (National Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2022    | Identitetskort (Identity Card)                     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2012    | Passport                                           |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2022    | Passport                                           |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2011    | Residence Permit                                   |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT    | 2021    | Residence Permit                                   |

## Switzerland (CHE)

| State | Type of ID         | Subtype of ID                    | Version | Description                         |
| :---- | :----------------- | :------------------------------- | :------ | :---------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2003    | Führerausweise (Driving License)    |
| ALL   | DriversLicense     | DRIVERS\_LICENSE                 | 2023    | Führerausweise (Driving License)    |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2003    | Identitatskarte (Identity Card)     |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD             | 2023    | Identitatskarte (Identity Card)     |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2024    | Diplomatic Identification Card      |
| ALL   | IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2025    | Diplomatic Identification Card      |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2010    | Passport                            |
| ALL   | Passport           | NATIONAL\_PASSPORT               | 2022    | Passport                            |
| ALL   | Passport           | TEMPORARY\_PASSPORT              | 2024    | Temporary Passport                  |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2016    | Aufenthaltstitel (Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2019    | Aufenthaltstitel (Residence Permit) |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT                | 2020    | Aufenthaltstitel (Residence Permit) |
| ALL   | Visa               | VISA                             | 2022    | Visa                                |
| ALL   | Visa               | VISA                             | 2023    | Visa / Visum                        |

## Ukraine (UKR)

| State | Type of ID         | Subtype of ID                | Version | Description                                        |
| :---- | :----------------- | :--------------------------- | :------ | :------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE             | 1996    | Permis de Conduire / Driving License               |
| ALL   | DriversLicense     | DRIVERS\_LICENSE             | 2005    | Driving License                                    |
| ALL   | DriversLicense     | DRIVERS\_LICENSE             | 2014    | Driving License                                    |
| ALL   | DriversLicense     | DRIVERS\_LICENSE             | 2021    | Driving License                                    |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD         | 2016    | Passport of the Citizen of Ukraine (Identity Card) |
| ALL   | IdentificationCard | PENSIONERS\_IDENTITY\_CARD   | 2024    | Pensioner's Identity Card                          |
| ALL   | Passport           | NATIONAL\_PASSPORT           | 2007    | Passport                                           |
| ALL   | Passport           | NATIONAL\_PASSPORT           | 2015    | Passport                                           |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT            | 2005    | Permanent Residence Permit                         |
| ALL   | ResidenceDocument  | RESIDENCE\_PERMIT            | 2018    | Permanent Residence Permit                         |
| ALL   | ResidenceDocument  | TEMPORARY\_RESIDENCE\_PERMIT | 2018    | Temporary Residence Permit                         |

## United Kingdom (GBR)

### All States

| Type of ID         | Subtype of ID                    | Version | Description                     |
| :----------------- | :------------------------------- | :------ | :------------------------------ |
| DriversLicense     | DRIVER\_LICENSE                  | 2006    | Driving License                 |
| DriversLicense     | DRIVER\_LICENSE                  | 2007    | Driving License                 |
| DriversLicense     | DRIVER\_LICENSE                  | 2013    | Driving License                 |
| DriversLicense     | DRIVER\_LICENSE                  | 2015    | Driving License                 |
| DriversLicense     | DRIVER\_LICENSE                  | 2019    | Driver Qualification Card       |
| DriversLicense     | DRIVER\_LICENSE                  | 2022    | Driving License                 |
| DriversLicense     | DRIVER\_CARD                     | 2018    | Driver Card                     |
| DriversLicense     | DRIVER\_QUALIFICATION\_CARD      | 2022    | Driver Qualification Card       |
| DriversLicense     | PROVISIONAL\_DRIVER\_LICENSE     | 2007    | Provisional Driving License     |
| DriversLicense     | PROVISIONAL\_DRIVER\_LICENSE     | 2013    | Provisional Driving License     |
| DriversLicense     | PROVISIONAL\_DRIVER\_LICENSE     | 2015    | Provisional Driving License     |
| DriversLicense     | PROVISIONAL\_DRIVER\_LICENSE     | 2021    | Provisional Driving License     |
| DriversLicense     | INTERNATIONAL\_DRIVERS\_LICENSE  | 2023    | International Drivers License   |
| DriversLicense     | INTERNATIONAL\_DRIVERS\_LICENSE  | 2024    | International Drivers License   |
| DriversLicense     | INTERNATIONAL\_DRIVERS\_LICENSE  | 2025    | International Drivers License   |
| IdentificationCard | CITIZENCARD                      | 2010    | CitizenCard - Proof of Age Card |
| IdentificationCard | CITIZENCARD                      | 2011    | CitizenCard - Proof of Age Card |
| IdentificationCard | CITIZENCARD                      | 2012    | CitizenCard - Proof of Age Card |
| IdentificationCard | CITIZENCARD                      | 2015    | CitizenCard - Proof of Age Card |
| IdentificationCard | CITIZENCARD                      | 2021    | CitizenCard - Proof of Age Card |
| IdentificationCard | CITIZENCARD                      | 2025    | CitizenCard - Proof of Age Card |
| IdentificationCard | IDENTIFICATION\_CARD             | 2009    | National Identity Card          |
| IdentificationCard | DIPLOMATIC\_IDENTIFICATION\_CARD | 2024    | Diplomatic Identity Card        |
| IdentificationCard | DISABILITY\_IDENTIFICATION\_CARD | 2020    | UK Disabled ID                  |
| IdentificationCard | DISABILITY\_IDENTIFICATION\_CARD | 2024    | National Disability Card        |
| Military           | MILITARY\_IDENTIFICATION\_CARD    | 2017    | British Army Identity Card      |
| Military           | MILITARY\_IDENTIFICATION\_CARD    | 2024    | Military Identity Card          |
| Military           | MILITARY\_IDENTIFICATION\_CARD    | 2025    | British Army Identity Card      |
| Passport           | NATIONAL\_PASSPORT               | 2006    | Passport                        |
| Passport           | NATIONAL\_PASSPORT               | 2010    | Passport / Passeport            |
| Passport           | NATIONAL\_PASSPORT               | 2015    | Passport / Passeport            |
| Passport           | NATIONAL\_PASSPORT               | 2020    | Passport / Passeport            |
| Passport           | NATIONAL\_PASSPORT               | 2023    | Passport                        |
| Passport           | NATIONAL\_PASSPORT               | 2025    | Passport                        |
| Passport           | TRAVEL\_DOCUMENT                 | 2020    | Travel Document                 |
| ResidenceDocument  | RESIDENCE\_PERMIT                | 2004    | Residence Permit                |
| ResidenceDocument  | RESIDENCE\_PERMIT                | 2008    | Residence Permit                |
| ResidenceDocument  | RESIDENCE\_PERMIT                | 2021    | Residence Permit                |
| Visa               | VISA                             | 2010    | Entry Clearance (Visa)          |
| Visa               | VISA                             | 2020    | Visa                            |
| Other              | DIGITAL_RIGHT_TO_WORK_PDF                           | 2026    | Digital Right to Work                          |

### Falkland Islands

| Type of ID     | Subtype of ID   | Version | Description                      |
| :------------- | :-------------- | :------ | :------------------------------- |
| DriversLicense | DRIVERS\_LICENSE | 2020    | Falkland Islands Driving License |

### Guernsey

| Type of ID     | Subtype of ID   | Version | Description              |
| :------------- | :-------------- | :------ | :----------------------- |
| DriversLicense | DRIVER\_LICENSE | 2013    | Guernsey Driving License |

### Isle of Man

| Type of ID     | Subtype of ID   | Version | Description                 |
| :------------- | :-------------- | :------ | :-------------------------- |
| DriversLicense | DRIVER\_LICENSE | 2006    | Isle of Man Driving License |
| DriversLicense | DRIVER\_LICENSE | 2022    | Isle of Man Driving License |

### Montserrat

| Type of ID     | Subtype of ID    | Version | Description                 |
| :------------- | :--------------- | :------ | :-------------------------- |
| DriversLicense | DRIVERS\_LICENSE | 2022    | Montserrat Driver's License |

### Scotland

| Type of ID         | Subtype of ID | Version | Description                                       |
| :----------------- | :------------ | :------ | :------------------------------------------------ |
| IdentificationCard | CITIZENCARD   | 2020    | Scotland National Entitlement Card (Saltire card) |

### Wales

| Type of ID     | Subtype of ID   | Version | Description           |
| :------------- | :-------------- | :------ | :-------------------- |
| DriversLicense | DRIVER\_LICENSE | 2007    | Wales Driving License |
| DriversLicense | DRIVER\_LICENSE | 2013    | Wales Driving Licence |

## Vatican City (VAT)

| State | Type of ID | Subtype of ID      | Version | Description           |
| :---- | :--------- | :----------------- | :------ | :-------------------- |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2010    | Passaporto / Passport |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2013    | Passaporte / Passport |

---

- Path: `general-reference/supported-ids-north-central-america`
- URL: https://developer.incode.com/general-reference/supported-ids-north-central-america/
- Markdown: https://developer.incode.com/general-reference/supported-ids-north-central-america.md

# North America

The following tables list supported identification documents for North America, organized by country, then state.

## Canada (CAN)

### All States

| Type of ID           | Subtype of ID                 | Version | Description                                            |
| :------------------- | :---------------------------- | :------ | :----------------------------------------------------- |
| IdentificationCard   | IDENTIFICATION_CARD           | 2013    | Identification Card                                    |
| IdentificationCard   | CANADIAN_CITIZENSHIP_CARD     | 2002    | Certificate of Canadian Citizenship                    |
| IdentificationCard   | CERTIFICATE_OF_INDIAN_STATUS  | 2010    | Certificate of Indian Status                           |
| IdentificationCard   | CERTIFICATE_OF_INDIAN_STATUS  | 2012    | Certificate of Indian Status                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD    | 2022    | Citizenship Card                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD    | 2023    | Métis Nation - Saskatchewan Tribal Identification Card |
| DriversLicense       | DRIVERS_LICENSE               | 2023    | Driver's License                                       |
| Military             | MILITARY_CARD                 | 2010    | Canadian Forces Identification Card                    |
| Military             | TEMPORARY_IDENTIFICATION_CARD | 2020    | Temporary Identification Card                          |
| Other                | FIREARMS_LICENSE              | 2010    | Firearms License                                       |
| Other                | FIREARMS_LICENSE              | 2020    | Firearms License                                       |
| Other                | INDIAN_STATUS_CERTIFICATE     | 2007    | Certificate of Indian Status                           |
| Other                | INDIAN_STATUS_CERTIFICATE     | 2008    | Certificate of Indian Status                           |
| Other                | INDIAN_STATUS_CERTIFICATE     | 2009    | Certificate of Indian Status                           |
| Passport             | NATIONAL_PASSPORT             | 2007    | Passport                                               |
| Passport             | NATIONAL_PASSPORT             | 2013    | Passport                                               |
| Passport             | NATIONAL_PASSPORT             | 2023    | Passport                                               |
| Passport             | TEMPORARY_PASSPORT            | 2023    | Temporary Passport / Passeport Provisoire              |
| ResidenceDocument    | RESIDENCE_PERMIT              | 2009    | Permanent Resident Card                                |
| ResidenceDocument    | RESIDENCE_PERMIT              | 2013    | Permanent Resident Card                                |
| ResidenceDocument    | RESIDENCE_PERMIT              | 2021    | Permanent Resident Card                                |
| Visa                 | VISA                          | 2019    | Visa                                                   |

### Alberta

| Type of ID         | Subtype of ID                | Version | Description                          |
| :----------------- | :--------------------------- | :------ | :----------------------------------- |
| DriversLicense     | DRIVER_LICENSE               | 2009    | Alberta Operator's Licence           |
| DriversLicense     | DRIVER_LICENSE               | 2018    | Alberta Driver's Licence             |
| DriversLicense     | DRIVER_LICENSE               | 2026    | Alberta Driver's Licence             |
| IdentificationCard | IDENTIFICATION_CARD          | 2015    | Alberta Identification Card          |
| IdentificationCard | IDENTIFICATION_CARD          | 2020    | Alberta Identification Card          |
| IdentificationCard | IDENTIFICATION_CARD          | 2026    | Alberta Identification Card          |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD | 2023    | Alberta Enhanced Identification Card |

### British Columbia

| Type of ID         | Subtype of ID              | Version | Description                                         |
| :----------------- | :------------------------- | :------ | :-------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE            | 2020    | British Columbia Driver's Licence                   |
| DriversLicense     | DRIVERS_LICENSE            | 2022    | British Columbia Driver's Licence and Services Card |
| DriversLicense     | DRIVERS_LICENSE            | 2025    | British Columbia Driver's Licence                   |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE   | 2009    | British Columbia Enhanced Driver's Licence          |
| DriversLicense     | LEARNERS_DRIVERS_LICENSE   | 2020    | British Columbia Learner Driver Licence             |
| DriversLicense     | LEARNERS_DRIVERS_LICENSE   | 2022    | British Columbia Learner Driver Licence             |
| IdentificationCard | IDENTIFICATION_CARD        | 2016    | British Columbia Identity Card                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2020    | British Columbia Services Card                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2021    | British Columbia Identity Card                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2025    | British Columbia Identity Card                      |
| MedicalCard        | MEDICAL_CARD               | 2010    | British Columbia Care Card                          |
| MedicalCard        | SERVICES_CARD              | 2022    | British Columbia Services Card                      |
| Other              | SERVICES_CARD              | 2010    | British Columbia Services Card                      |
| Other              | SERVICES_CARD              | 2022    | British Columbia Services Card                      |
| Other              | TRIBAL_IDENTIFICATION_CARD | 2015    | British Columbia Citizenship & ID Card              |

### Manitoba

| Type of ID         | Subtype of ID       | Version | Description                  |
| :----------------- | :------------------ | :------ | :--------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2009    | Manitoba Driver's Licence    |
| IdentificationCard | IDENTIFICATION_CARD | 2018    | Manitoba Identification Card |

### Newfoundland

| Type of ID         | Subtype of ID       | Version | Description                                   |
| :----------------- | :------------------ | :------ | :-------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2007    | Newfoundland and Labrador Driver Licence      |
| DriversLicense     | DRIVERS_LICENSE     | 2018    | Newfoundland and Labrador Driver Licence      |
| IdentificationCard | IDENTIFICATION_CARD | 2017    | Newfoundland and Labrador Identification Card |
| MedicalCard        | MEDICAL_CARD        | 2010    | Newfoundland and Labrador Medical Care Plan   |

### New Brunswick

| Type of ID         | Subtype of ID       | Version | Description                                |
| :----------------- | :------------------ | :------ | :----------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2009    | New Brunswick Driver Licence               |
| DriversLicense     | DRIVERS_LICENSE     | 2017    | New Brunswick Driver Licence               |
| IdentificationCard | IDENTIFICATION_CARD | 2021    | New Brunswick Identification Card          |
| MedicalCard        | MEDICAL_CARD        | 2010    | New Brunswick Medicare Assurance - maladie |

### Northwest Territories

| Type of ID         | Subtype of ID             | Version | Description                                      |
| :----------------- | :------------------------ | :------ | :----------------------------------------------- |
| DriversLicense     | DRIVER_LICENSE            | 2008    | Northwest Territories Driver's Licence           |
| DriversLicense     | DRIVER_LICENSE            | 2020    | Northwest Territories Driver's Licence           |
| DriversLicense     | TEMPORARY_DRIVERS_LICENSE | 2024    | Northwest Territories Temporary Driver's License |
| IdentificationCard | IDENTIFICATION_CARD       | 2010    | Northwest Territories Identification Card        |
| IdentificationCard | IDENTIFICATION_CARD       | 2020    | Northwest Territories Identification Card        |

### Nova Scotia

| Type of ID         | Subtype of ID           | Version | Description                           |
| :----------------- | :---------------------- | :------ | :------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE         | 2010    | Nova Scotia Driver Licence            |
| DriversLicense     | DRIVERS_LICENSE         | 2017    | Nova Scotia Driver Licence            |
| DriversLicense     | DRIVERS_LICENSE_UNDER21 | 2010    | Nova Scotia Driver License (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD     | 2017    | Nova Scotia Identification Card       |
| IdentificationCard | IDENTIFICATION_CARD     | 2018    | Nova Scotia Identification Card       |
| IdentificationCard | IDENTIFICATION_CARD     | 2025    | Nova Scotia Identification Card       |
| MedicalCard        | MEDICAL_CARD            | 2010    | Nova Scotia Health Card               |

### Nunavut

| Type of ID         | Subtype of ID       | Version | Description                 |
| :----------------- | :------------------ | :------ | :-------------------------- |
| DriversLicense     | DRIVER_LICENSE      | 2008    | Nunavut Driver's Licence    |
| IdentificationCard | IDENTIFICATION_CARD | 2010    | Nunavut Identification Card |
| MedicalCard        | MEDICAL_CARD        | 2010    | Nunavut Health Card         |

### Ontario

| Type of ID         | Subtype of ID            | Version | Description                       |
| :----------------- | :----------------------- | :------ | :-------------------------------- |
| DriversLicense     | DRIVERS_LICENSE          | 2011    | Ontario Driver's Licence          |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE | 2010    | Ontario Enhanced Driver's License |
| IdentificationCard | IDENTIFICATION_CARD      | 2011    | Ontario Photo Card                |
| MedicalCard        | MEDICAL_CARD             | 2020    | Ontario Health Card               |
| Other              | BIRTH_CERTIFICATE        | 2010    | Ontario Birth Certificate         |

### Prince Edward Island

| Type of ID         | Subtype of ID       | Version | Description                              |
| :----------------- | :------------------ | :------ | :--------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2007    | Prince Edward Island Driver Licence      |
| DriversLicense     | DRIVERS_LICENSE     | 2017    | Prince Edward Island Driver Licence      |
| IdentificationCard | IDENTIFICATION_CARD | 2010    | Prince Edward Island Identification Card |
| IdentificationCard | IDENTIFICATION_CARD | 2017    | Prince Edward Island Identification Card |
| MedicalCard        | MEDICAL_CARD        | 2010    | Prince Edward Island Health Card         |

### Quebec

| Type of ID     | Subtype of ID  | Version | Description                                       |
| :------------- | :------------- | :------ | :------------------------------------------------ |
| DriversLicense | DRIVER_LICENSE | 2009    | Quebec Permis de conduire (Driver Licence)        |
| DriversLicense | DRIVER_LICENSE | 2015    | Quebec Permis de conduire (Driver Licence)        |
| MedicalCard    | MEDICAL_CARD   | 2010    | Quebec Regie de L'assurance maladie (Health Card) |
| MedicalCard    | MEDICAL_CARD   | 2018    | Quebec Regie de L'assurance maladie (Health Card) |

### Saskatchewan

| Type of ID         | Subtype of ID       | Version | Description                      |
| :----------------- | :------------------ | :------ | :------------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2011    | Saskatchewan Driver's Licence    |
| DriversLicense     | DRIVERS_LICENSE     | 2016    | Saskatchewan Driver's Licence    |
| IdentificationCard | IDENTIFICATION_CARD | 2017    | Saskatchewan Identification Card |
| IdentificationCard | IDENTIFICATION_CARD | 2019    | Saskatchewan Identification Card |
| Military           | MILITARY_CARD       | 2024    | Saskatchewan Military Card       |

### Yukon

| Type of ID         | Subtype of ID       | Version | Description                             |
| :----------------- | :------------------ | :------ | :-------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE     | 2010    | Yukon Operator's Licence                |
| DriversLicense     | DRIVERS_LICENSE     | 2024    | Permis de Conduire (Operator's License) |
| IdentificationCard | IDENTIFICATION_CARD | 2016    | Yukon General Identification Card       |
| IdentificationCard | IDENTIFICATION_CARD | 2024    | Yukon General Identification Card       |

## Mexico (MEX)

### All States

| Type of ID          | Subtype of ID                               | Version | Description                                                                                                      |
| :------------------ | :------------------------------------------ | :------ | :--------------------------------------------------------------------------------------------------------------- |
| IdentificationCard  | IDENTIFICATION_CARD                         | 2000    | Cédula Profesional                                                                                               |
| IdentificationCard  | IDENTIFICATION_CARD                         | 2015    | Cédula Profesional                                                                                               |
| IdentificationCard  | DIGITAL_IDENTIFICATION_CARD                 | 2020    | Digital Cédula Profesional                                                                                       |
| IdentificationCard  | DIGITAL_INSURANCE_AGENTS_ID_PDF             | 2026    | Digital Insurance Agents ID                                                                                      |
| IdentificationCard  | AIRFORCE_IDENTIFICATION_CARD                | 2021    | Licencia Federal de Técnico Aeronáutico (Federal Aeronautical Technician License - Airforce Identification Card) |
| IdentificationCard  | AIRFORCE_IDENTIFICATION_CARD                | 2024    | Airforce Identification Card                                                                                     |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2009    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2010    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2011    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2013    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2014    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2015    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2020    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2023    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2024    | Tarjeta INAPAM                                                                                                   |
| IdentificationCard  | SENIOR_IDENTIFICATION_CARD                  | 2025    | Tarjeta INAPAM                                                                                                   |
| MedicalCard         | MEDICAL_CARD                                | 2010    | Tarjera IMSS                                                                                                     |
| Military            | MILITARY_CARD                               | 2010    | Military Card                                                                                                    |
| Military            | MILITARY_CARD                               | 2018    | Tarjeta de Identidad Militar / Military Card                                                                     |
| Military            | MILITARY_CARD                               | 2019    | Tarjeta de Identidad Militar (Military Card)                                                                     |
| Military            | MILITARY_CARD                               | 2021    | Credencial de Identidad Militar                                                                                  |
| Military            | MILITARY_CARD                               | 2022    | Credencial de Identidad Militar                                                                                  |
| Military            | MILITARY_CARD                               | 2023    | Military Card                                                                                                    |
| Military            | MILITARY_CARD                               | 2024    | Tarjeta de Identidad Militar / Military Card                                                                     |
| Military            | MILITARY_CARD                               | 2025    | Military Card                                                                                                    |
| Passport            | NATIONAL_PASSPORT                           | 2000    | Passport                                                                                                         |
| Passport            | NATIONAL_PASSPORT                           | 2002    | Passport                                                                                                         |
| Passport            | NATIONAL_PASSPORT                           | 2008    | Passport                                                                                                         |
| Passport            | NATIONAL_PASSPORT                           | 2012    | Passport                                                                                                         |
| Passport            | NATIONAL_PASSPORT                           | 2015    | Passport                                                                                                         |
| Passport            | NATIONAL_PASSPORT                           | 2022    | Passport                                                                                                         |
| ResidenceDocument   | PERMANENT_RESIDENCE_CARD                    | 2000    | Credencial de Residente Permanente                                                                               |
| ResidenceDocument   | PERMANENT_RESIDENCE_CARD                    | 2001    | Credencial de Residente Permanente                                                                               |
| ResidenceDocument   | PERMANENT_RESIDENCE_CARD                    | 2012    | Credencial de Residente Permanente                                                                               |
| ResidenceDocument   | PERMANENT_RESIDENCE_CARD                    | 2020    | Credencial de Residente Permanente                                                                               |
| ResidenceDocument   | PERMANENT_RESIDENCE_CARD                    | 2022    | Credencial de Residente Permanente                                                                               |
| ResidenceDocument   | RESIDENCE_PERMIT                            | 2010    | Credencial de Inmigrado                                                                                          |
| ResidenceDocument   | TEMPORARY_RESIDENCE_CARD                    | 2000    | Credencial de Residente Temporal                                                                                 |
| ResidenceDocument   | TEMPORARY_RESIDENCE_CARD                    | 2012    | Credencial de Residente Temporal                                                                                 |
| ResidenceDocument   | TEMPORARY_RESIDENCE_CARD                    | 2022    | Credencial de Residente Temporal                                                                                 |
| ResidenceDocument   | VISITORS_PERMIT                             | 2020    | Credencial de Visitante                                                                                          |
| ResidenceDocument   | VISITORS_PERMIT                             | 2022    | Credencial de Visitante                                                                                          |
| TravelDocument      | MATRICULA_CONSULAR                          | 2011    | Matricula Consular / Consular ID Card                                                                            |
| TravelDocument      | MATRICULA_CONSULAR                          | 2019    | Consular ID Card                                                                                                 |
| TravelDocument      | MATRICULA_CONSULAR                          | 2023    | Consular ID Card                                                                                                 |
| TravelDocument      | MATRICULA_CONSULAR                          | 2024    | Matricula Consular (Consular Card)                                                                               |
| Visa                | VISA                                        | 2021    | Visa                                                                                                             |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2002    | Credencial para Votar                                                                                            |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2008    | Credencial para Votar                                                                                            |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2013    | Credencial para Votar                                                                                            |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2014    | Credencial para Votar                                                                                            |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2019    | Credencial para Votar                                                                                            |
| VoterIdentification | VOTER_IDENTIFICATION_CARD                   | 2026    | Voter Identification Card                                                                                        |
| Other               | BIRTH_CERTIFICATE                           | 2020    | Acta de Nacimiento / Birth Certificate                                                                           |
| Other               | DIGITAL_CURP_CERTIFICATE_FOR_FOREIGNERS_PDF | 2026    | Digital CURP Cerificate for Foreigners                                                                           |
| Other               | DIGITAL_CURP_CERTIFICATE_FOR_MEX_CITIZENS_PDF | 2026    | Digital CURP Certificate for Mexican Citizens                                                                    |
| DriversLicense      | FEDERAL_DRIVERS_LICENSE                     | 2015    | Nationwide Drivers License                                                                                       |
| DriversLicense      | FEDERAL_DRIVERS_LICENSE                     | 2018    | Nationwide Drivers License                                                                                       |
| DriversLicense      | FEDERAL_DRIVERS_LICENSE                     | 2019    | Nationwide Drivers License                                                                                       |
| DriversLicense      | DIGITAL_FEDERAL_DRIVERS_LICENSE_PDF         | 2025    | Digital Federal Driver License                                                                                   |
| MedicalCard         | MEDICAL_CARD                                | 2022    | Credencial del Instituto de Seguridad Social de Estado de México y Municipios                                    |
| MedicalCard         | MEDICAL_CARD                                | 2026    | Medical Card                                                                                                     |

### Aguascalientes

| Type of ID     | Subtype of ID   | Version | Description                    |
| :------------- | :-------------- | :------ | :----------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2014    | Aguascalientes Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Aguascalientes Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Aguascalientes Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Aguascalientes Drivers License |

### Baja California

| Type of ID         | Subtype of ID                  | Version | Description                                    |
| :----------------- | :----------------------------- | :------ | :--------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                | 2014    | Baja California Drivers License                |
| DriversLicense     | DRIVERS_LICENSE                | 2016    | Baja California Drivers License                |
| DriversLicense     | DRIVERS_LICENSE                | 2018    | Baja California Drivers License                |
| DriversLicense     | DRIVERS_LICENSE                | 2019    | Baja California Drivers License                |
| DriversLicense     | DRIVERS_LICENSE                | 2020    | Baja California Drivers License                |
| DriversLicense     | DRIVERS_LICENSE                | 2021    | Baja California Drivers License                |
| IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2023    | Baja California Disability Identification Card |

### Baja California Sur

| Type of ID     | Subtype of ID   | Version | Description                         |
| :------------- | :-------------- | :------ | :---------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2016    | Baja California Sur Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Baja California Sur Drivers License |

### Campeche

| Type of ID     | Subtype of ID   | Version | Description              |
| :------------- | :-------------- | :------ | :----------------------- |
| DriversLicense | DRIVERS_LICENSE | 2019    | Campeche Drivers License |

### CDMX

| Type of ID     | Subtype of ID              | Version | Description                                   |
| :------------- | :------------------------- | :------ | :-------------------------------------------- |
| DriversLicense | DRIVER_LICENSE             | 1929    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2000    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2004    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2005    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2014    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2018    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2019    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2021    | Mexico City Drivers License                   |
| DriversLicense | DRIVER_LICENSE             | 2024    | CDMX Licencia para Conducir / Driving License |
| DriversLicense | DRIVER_LICENSE             | 2025    | CDMX Licencia para Conducir / Driving License |
| DriversLicense | DIGITAL_DRIVER_LICENSE_APP | 2023    | Mexico City Digital Drivers License           |
| DriversLicense | DIGITAL_DRIVER_LICENSE_APP | 2024    | Mexico City Digital Drivers License           |

### Chiapas

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2013    | Chiapas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2016    | Chiapas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Chiapas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Chiapas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Chiapas Drivers License |

### Chihuahua

| Type of ID     | Subtype of ID   | Version | Description               |
| :------------- | :-------------- | :------ | :------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2016    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Chihuahua Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Chihuahua Drivers License |

### Coahuila

| Type of ID     | Subtype of ID   | Version | Description              |
| :------------- | :-------------- | :------ | :----------------------- |
| DriversLicense | DRIVERS_LICENSE | 2016    | Coahuila Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Coahuila Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Coahuila Drivers License |

### Colima

| Type of ID     | Subtype of ID   | Version | Description            |
| :------------- | :-------------- | :------ | :--------------------- |
| DriversLicense | DRIVERS_LICENSE | 2016    | Colima Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Colima Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Colima Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Colima Drivers License |

### Durango

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2015    | Durango Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2016    | Durango Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2023    | Durango Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Durango Drivers License |

### Estado De Mexico

| Type of ID     | Subtype of ID   | Version | Description                  |
| :------------- | :-------------- | :------ | :--------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2006    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2011    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2014    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Mexico State Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Mexico State Drivers License |

### Guanajuato

| Type of ID     | Subtype of ID   | Version | Description                |
| :------------- | :-------------- | :------ | :------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2015    | Guanajuato Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Guanajuato Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Guanajuato Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2023    | Guanajuato Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Guanajuato Drivers License |

### Guerrero

| Type of ID     | Subtype of ID   | Version | Description                                                                 |
| :------------- | :-------------- | :------ | :-------------------------------------------------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 1895    | Guerrero Drivers License                                                    |
| DriversLicense | DRIVERS_LICENSE | 1985    | Guerrero Drivers License (Juan R. Escudero)                                 |
| DriversLicense | DRIVERS_LICENSE | 1896    | Guerrero Drivers License (Tecoanapa)                                        |
| DriversLicense | DRIVERS_LICENSE | 1897    | Guerrero Drivers License (Constitucional de Tixtla)                         |
| DriversLicense | DRIVERS_LICENSE | 1898    | Guerrero Drivers License (Acapulco)                                         |
| DriversLicense | DRIVERS_LICENSE | 1900    | Guerrero Driving License (Taxco)                                            |
| DriversLicense | DRIVERS_LICENSE | 1901    | Guerrero Driving License (Ixcateopan de Cuauhtemoc)                         |
| DriversLicense | DRIVERS_LICENSE | 1902    | Guerrero Drivers License (Chilpancingo)                                     |
| DriversLicense | DRIVERS_LICENSE | 1903    | Guerrero Drivers License (La Union de Isidoro Montes de Oca)                |
| DriversLicense | DRIVERS_LICENSE | 1904    | Guerrero Drivers License (Chilpancingo)                                     |
| DriversLicense | DRIVERS_LICENSE | 1905    | Guerrero Drivers License (Zihuatanejo de Azueta)                            |
| DriversLicense | DRIVERS_LICENSE | 1906    | Guerrero Drivers License (H. Ayuntamiento de Alcozauca)                     |
| DriversLicense | DRIVERS_LICENSE | 1908    | Guerrero Drivers License (H. Ayuntamiento Municipal de Cutzamala de Pinzon) |
| DriversLicense | DRIVERS_LICENSE | 1909    | Guerrero Drivers License (Tecpan de Galeana)                                |
| DriversLicense | DRIVERS_LICENSE | 1910    | Guerrero Drivers License (La Unión de Isidoro Montes de Oca)                |
| DriversLicense | DRIVERS_LICENSE | 1911    | Guerrero Drivers License (Huitzuco)                                         |
| DriversLicense | DRIVERS_LICENSE | 1912    | Guerrero Drivers License (H. Ayuntamiento de Apaxtla)                       |
| DriversLicense | DRIVERS_LICENSE | 1914    | Guerrero Drivers License (Pilcaya)                                          |
| DriversLicense | DRIVERS_LICENSE | 1915    | Guerrero Drivers License (Zitlala)                                          |
| DriversLicense | DRIVERS_LICENSE | 1916    | Guerrero Drivers License (Ayuntamiento de Zirándaro)                        |
| DriversLicense | DRIVERS_LICENSE | 1919    | Guerrero Drivers License (Hueycantenango)                                   |
| DriversLicense | DRIVERS_LICENSE | 1920    | Guerrero Drivers License (General Canuto A. Neri)                           |
| DriversLicense | DRIVERS_LICENSE | 1922    | Guerrero Drivers License (Malinaltepec)                                     |
| DriversLicense | DRIVERS_LICENSE | 1925    | Guerrero Drivers License (Chilpancingo de los Bravo)                        |
| DriversLicense | DRIVERS_LICENSE | 1926    | Guerrero Drivers License (Iguala de la Independencia)                       |
| DriversLicense | DRIVERS_LICENSE | 1927    | Guerrero Drivers License (General Heliodoro Castillo)                       |
| DriversLicense | DRIVERS_LICENSE | 1928    | Guerrero Driving License (Taxco)                                            |
| DriversLicense | DRIVERS_LICENSE | 1929    | Guerrero Drivers License (Buenavista de Cuéllar)                            |
| DriversLicense | DRIVERS_LICENSE | 1930    | Guerrero Driving License (Copalillo)                                        |
| DriversLicense | DRIVERS_LICENSE | 1931    | Guerrero Drivers License (Cocula)                                           |
| DriversLicense | DRIVERS_LICENSE | 1932    | Guerrero Driving License (Coyuca de Benitez)                                |
| DriversLicense | DRIVERS_LICENSE | 1934    | Guerrero Drivers License                                                    |
| DriversLicense | DRIVERS_LICENSE | 1936    | Guerrero Drivers License (Acapulco)                                         |
| DriversLicense | DRIVERS_LICENSE | 1943    | Guerrero Drivers License (General Canuto A. Neri)                           |
| DriversLicense | DRIVERS_LICENSE | 1944    | Guerrero Drivers License (H. Ayuntamiento de Alcozauca)                     |
| DriversLicense | DRIVERS_LICENSE | 1948    | Guerrero Drivers License (Malinaltepec)                                     |
| DriversLicense | DRIVERS_LICENSE | 1950    | Guerrero Drivers License (Teloloapan)                                       |
| DriversLicense | DRIVERS_LICENSE | 1951    | Guerrero Drivers License (Chilpancingo)                                     |
| DriversLicense | DRIVERS_LICENSE | 1952    | Guerrero Drivers License (Apaxtla de Castrejon)                             |
| DriversLicense | DRIVERS_LICENSE | 1953    | Guerrero Drivers License (Juan R. Escudero)                                 |
| DriversLicense | DRIVERS_LICENSE | 1954    | Guerrero Drivers License                                                    |
| DriversLicense | DRIVERS_LICENSE | 1955    | Guerrero Drivers License                                                    |
| DriversLicense | DRIVERS_LICENSE | 1957    | Guerrero Drivers License (Gral. Canuto A. Neri)                             |
| DriversLicense | DRIVERS_LICENSE | 1959    | Guerrero Drivers License (Municipal Constitucional de Juan R. Escudero)     |
| DriversLicense | DRIVERS_LICENSE | 1961    | Guerrero Drivers License (Buenavista de Cuellar)                            |
| DriversLicense | DRIVERS_LICENSE | 1962    | Guerrero Drivers License (H. Ayuntamiento de Cuautepec)                     |
| DriversLicense | DRIVERS_LICENSE | 1963    | Guerrero Drivers License (Chilpancingo de los Bravo)                        |
| DriversLicense | DRIVERS_LICENSE | 1967    | Guerrero Drivers License (La Union de Isidoro Montes de Oca)                |
| DriversLicense | DRIVERS_LICENSE | 1969    | Guerrero Drivers License (Acapulco de Juarez)                               |
| DriversLicense | DRIVERS_LICENSE | 1971    | Guerrero Drivers License (Hueycantenango)                                   |
| DriversLicense | DRIVERS_LICENSE | 1973    | Guerrero Drivers License (Malinaltepec)                                     |
| DriversLicense | DRIVERS_LICENSE | 1974    | Guerrero Drivers License (Acapulco de Juarez)                               |
| DriversLicense | DRIVERS_LICENSE | 1975    | Guerrero Drivers License (Zihuatanejo de Azueta)                            |
| DriversLicense | DRIVERS_LICENSE | 1976    | Guerrero Drivers License (Malinaltepec)                                     |
| DriversLicense | DRIVERS_LICENSE | 1979    | Guerrero Drivers License (Tetipac)                                          |
| DriversLicense | DRIVERS_LICENSE | 1980    | Guerrero Drivers License (Tetipac)                                          |
| DriversLicense | DRIVERS_LICENSE | 1982    | Guerrero Drivers License (Pilcaya)                                          |
| DriversLicense | DRIVERS_LICENSE | 1986    | Guerrero Drivers License (Pedro Ascencio Alquisiras)                        |
| DriversLicense | DRIVERS_LICENSE | 1987    | Guerrero Drivers License (Iliatenco)                                        |
| DriversLicense | DRIVERS_LICENSE | 1989    | Guerrero Drivers License (Iguala de la Independencia)                       |
| DriversLicense | DRIVERS_LICENSE | 1990    | Guerrero Drivers License (Iguala de la Independencia)                       |
| DriversLicense | DRIVERS_LICENSE | 1991    | Guerrero Drivers License (Copalillo)                                        |
| DriversLicense | DRIVERS_LICENSE | 1992    | Guerrero Drivers License (Copalillo)                                        |
| DriversLicense | DRIVERS_LICENSE | 1993    | Guerrero Drivers License (Cocula)                                           |
| DriversLicense | DRIVERS_LICENSE | 1994    | Guerrero Drivers License (Chilpancingo)                                     |
| DriversLicense | DRIVERS_LICENSE | 1996    | Guerrero Drivers License                                                    |
| DriversLicense | DRIVERS_LICENSE | 1997    | Guerrero Drivers License (Atlamaljancingo del Monte)                        |
| DriversLicense | DRIVERS_LICENSE | 1998    | Guerrero Drivers License (Atenango del Rio)                                 |
| DriversLicense | DRIVERS_LICENSE | 1999    | Guerrero Drivers License (Acapulco de Juarez)                               |
| DriversLicense | DRIVERS_LICENSE | 2000    | Guerrero Drivers License (Acapulco de Juarez)                               |
| DriversLicense | DRIVERS_LICENSE | 2001    | Guerrero Drivers License (Buenavista de Cuellar)                            |
| DriversLicense | DRIVERS_LICENSE | 2002    | Guerrero Drivers License (Pilcaya)                                          |
| DriversLicense | DRIVERS_LICENSE | 2003    | Guerrero Drivers License (Tlacoapa)                                         |
| DriversLicense | DRIVERS_LICENSE | 2004    | Guerrero Drivers License (Cuetzala del Progreso)                            |
| DriversLicense | DRIVERS_LICENSE | 2005    | Guerrero Drivers License (Buenavista de Cuellar)                            |
| DriversLicense | DRIVERS_LICENSE | 2006    | Guerrero Drivers License (Acapulco de Juarez)                               |
| DriversLicense | DRIVERS_LICENSE | 2007    | Guerrero Drivers License (Tepecoacuilco)                                    |
| DriversLicense | DRIVERS_LICENSE | 2008    | Guerrero Drivers License (Cocula)                                           |
| DriversLicense | DRIVERS_LICENSE | 2009    | Guerrero Drivers License (Pungarabato)                                      |
| DriversLicense | DRIVERS_LICENSE | 2010    | Guerrero Drivers License (Jose Joaquin de Herrera)                          |
| DriversLicense | DRIVERS_LICENSE | 2011    | Guerrero Drivers License (Tetipac)                                          |
| DriversLicense | DRIVERS_LICENSE | 2012    | Guerrero Drivers License (Copalillo)                                        |
| DriversLicense | DRIVERS_LICENSE | 2013    | Guerrero Drivers License (Gral. Canuto A. Neri)                             |
| DriversLicense | DRIVERS_LICENSE | 2016    | Guerrero Drivers License (Atlamaljancingo del Monte)                        |
| DriversLicense | DRIVERS_LICENSE | 2017    | Guerrero Drivers License (Juchitan)                                         |
| DriversLicense | DRIVERS_LICENSE | 2018    | Guerrero Drivers License (Pilcaya)                                          |
| DriversLicense | DRIVERS_LICENSE | 2019    | Guerrero Drivers License (Cocula)                                           |
| DriversLicense | DRIVERS_LICENSE | 2020    | Guerrero Drivers License (Juchitan)                                         |
| DriversLicense | DRIVERS_LICENSE | 2021    | Guerrero Drivers License (Juchitan)                                         |
| DriversLicense | DRIVERS_LICENSE | 2022    | Guerrero Drivers License (Juchitan)                                         |
| DriversLicense | DRIVERS_LICENSE | 2023    | Guerrero Drivers License (State Drivers License)                            |
| DriversLicense | DRIVERS_LICENSE | 2025    | Guerrero Driving License (Chilpancingo)                                     |
| DriversLicense | DRIVERS_LICENSE | 2026    | Guerrero Driving License (Tabasco)                                          |

### Hidalgo

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2014    | Hidalgo Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Hidalgo Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Hidalgo Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Hidalgo Drivers License |

### Jalisco

| Type of ID     | Subtype of ID  | Version | Description             |
| :------------- | :------------- | :------ | :---------------------- |
| DriversLicense | DRIVER_LICENSE | 2004    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2013    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2017    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2018    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2019    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2020    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2021    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2022    | Jalisco Drivers Licence |
| DriversLicense | DRIVER_LICENSE | 2024    | Jalisco Drivers License |

### Michoacan

| Type of ID     | Subtype of ID   | Version | Description               |
| :------------- | :-------------- | :------ | :------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2012    | Michoacan Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Michoacan Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Michoacan Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Michoacan Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Michoacan Drivers License |

### Morelos

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2015    | Morelos Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Morelos Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Morelos Driving License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Morelos Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Morelos Drivers License |

### Nayarit

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2016    | Nayarit Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Nayarit Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Nayarit Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | Nayarit Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2026    | Nayarit Drivers License |

### Nuevo Leon

| Type of ID     | Subtype of ID  | Version | Description                |
| :------------- | :------------- | :------ | :------------------------- |
| DriversLicense | DRIVER_LICENSE | 2016    | Nuevo Leon Drivers License |
| DriversLicense | DRIVER_LICENSE | 2017    | Nuevo Leon Drivers License |
| DriversLicense | DRIVER_LICENSE | 2018    | Nuevo Leon Drivers License |
| DriversLicense | DRIVER_LICENSE | 2020    | Nuevo Leon Drivers License |
| DriversLicense | DRIVER_LICENSE | 2021    | Nuevo Leon Drivers License |
| DriversLicense | DRIVER_LICENSE | 2022    | Nuevo Leon Drivers License |

### Oaxaca

| Type of ID     | Subtype of ID   | Version | Description            |
| :------------- | :-------------- | :------ | :--------------------- |
| DriversLicense | DRIVERS_LICENSE | 2018    | Oaxaca Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Oaxaca Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2023    | Oaxaca Drivers License |

### Puebla

| Type of ID     | Subtype of ID   | Version | Description            |
| :------------- | :-------------- | :------ | :--------------------- |
| DriversLicense | DRIVERS_LICENSE | 2014    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2015    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2016    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2023    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Puebla Driving License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Puebla Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2026    | Puebla Drivers License |

### Queretaro

| Type of ID     | Subtype of ID   | Version | Description               |
| :------------- | :-------------- | :------ | :------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2015    | Queretaro Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2016    | Queretaro Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Queretaro Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Queretaro Drivers License |

### Quintana Roo

| Type of ID     | Subtype of ID   | Version | Description                                           |
| :------------- | :-------------- | :------ | :---------------------------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 1997    | Quintana Roo Drivers License (Felipe Carrillo Puerto) |
| DriversLicense | DRIVERS_LICENSE | 1998    | Quintana Roo Drivers License                          |
| DriversLicense | DRIVERS_LICENSE | 1999    | Quintana Roo Drivers License (Felipe Carillo Puerto)  |
| DriversLicense | DRIVERS_LICENSE | 2000    | Quintana Roo Drivers License                          |
| DriversLicense | DRIVERS_LICENSE | 2001    | Quintana Roo Drivers License                          |
| DriversLicense | DRIVERS_LICENSE | 2002    | Quintana Roo Drivers License (Othon P. Blanco)        |
| DriversLicense | DRIVERS_LICENSE | 2004    | Quintana Roo Drivers License (Puerto Morelos)         |
| DriversLicense | DRIVERS_LICENSE | 2006    | Quintana Roo Drivers License (Felipe Carillo Puerto)  |
| DriversLicense | DRIVERS_LICENSE | 2007    | Quintana Roo Drivers License (Bacalar)                |
| DriversLicense | DRIVERS_LICENSE | 2009    | Quintana Roo Drivers License (Solidaridad)            |
| DriversLicense | DRIVERS_LICENSE | 2010    | Quintana Roo Drivers License (Benito Juarez)          |
| DriversLicense | DRIVERS_LICENSE | 2011    | Quintana Roo Drivers License (Lazaro Cardenas)        |
| DriversLicense | DRIVERS_LICENSE | 2012    | Quintana Roo Drivers License (Jose Maria Morelos)     |
| DriversLicense | DRIVERS_LICENSE | 2013    | Quintana Roo Driving License                          |
| DriversLicense | DRIVERS_LICENSE | 2014    | Quintana Roo Drivers License                          |
| DriversLicense | DRIVERS_LICENSE | 2015    | Quintana Roo Drivers License (Tulum)                  |
| DriversLicense | DRIVERS_LICENSE | 2016    | Quintana Roo Drivers License (Cozumel)                |
| DriversLicense | DRIVERS_LICENSE | 2017    | Quintana Roo Drivers License (Cozumel)                |
| DriversLicense | DRIVERS_LICENSE | 2018    | Quintana Roo Drivers License (Tulum)                  |
| DriversLicense | DRIVERS_LICENSE | 2019    | Quintana Roo Drivers License (Benito Juarez)          |
| DriversLicense | DRIVERS_LICENSE | 2020    | Quintana Roo Drivers License (Solidaridad)            |
| DriversLicense | DRIVERS_LICENSE | 2021    | Quintana Roo Drivers License                          |
| DriversLicense | DRIVERS_LICENSE | 2022    | Quintana Roo Drivers License (Solidaridad)            |
| DriversLicense | DRIVERS_LICENSE | 2023    | Quintana Roo Drivers License (Puerto Morelos)         |
| DriversLicense | DRIVERS_LICENSE | 2024    | Quintana Roo Drivers License (Solidaridad)            |

### San Luis Potosi

| Type of ID     | Subtype of ID   | Version | Description                     |
| :------------- | :-------------- | :------ | :------------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2017    | San Luis Potosi Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | San Luis Potosi Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | San Luis Potosi Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | San Luis Potosi Drivers License |

### Sinaloa

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2010    | Sinaloa Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2015    | Sinaloa Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Sinaloa Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Sinaloa Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2026    | Sinaloa Drivers License |

### Sonora

| Type of ID     | Subtype of ID  | Version | Description            |
| :------------- | :------------- | :------ | :--------------------- |
| DriversLicense | DRIVER_LICENSE | 2015    | Sonora Drivers License |
| DriversLicense | DRIVER_LICENSE | 2016    | Sonora Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Sonora Drivers License |
| DriversLicense | DRIVER_LICENSE | 2022    | Sonora Drivers License |

### Tabasco

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2013    | Tabasco Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Tabasco Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Tabasco Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | Tabasco Drivers License |

### Tamaulipas

| Type of ID     | Subtype of ID   | Version | Description                |
| :------------- | :-------------- | :------ | :------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2019    | Tamaulipas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Tamaulipas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2021    | Tamaulipas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Tamaulipas Drivers License |

### Tlaxcala

| Type of ID     | Subtype of ID   | Version | Description              |
| :------------- | :-------------- | :------ | :----------------------- |
| DriversLicense | DRIVERS_LICENSE | 2019    | Tlaxcala Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Tlaxcala Drivers License |

### Veracruz

| Type of ID     | Subtype of ID   | Version | Description              |
| :------------- | :-------------- | :------ | :----------------------- |
| DriversLicense | DRIVERS_LICENSE | 2016    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2019    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2022    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2024    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2025    | Veracruz Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2026    | Veracruz Drivers License |

### Yucatan

| Type of ID     | Subtype of ID   | Version | Description             |
| :------------- | :-------------- | :------ | :---------------------- |
| DriversLicense | DRIVERS_LICENSE | 2018    | Yucatan Drivers License |

### Zacatecas

| Type of ID     | Subtype of ID   | Version | Description               |
| :------------- | :-------------- | :------ | :------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2014    | Zacatecas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2015    | Zacatecas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2017    | Zacatecas Drivers License |
| DriversLicense | DRIVERS_LICENSE | 2018    | Zacatecas Drivers License |

## United Nations (UNO)

| State | Type of ID         | Subtype of ID                | Version | Description                  |
| :---- | :----------------- | :--------------------------- | :------ | :--------------------------- |
| ALL   | Military           | MILITARY_CARD                | 2020    | Military Card                |
| ALL   | IdentificationCard | UNHCR_CARD                   | 2022    | UNHCR Card                   |
| ALL   | IdentificationCard | UNHCR_CARD                   | 2023    | UNCHR Card                   |
| ALL   | IdentificationCard | UNHCR_CARD                   | 2024    | UNCHR Card                   |
| ALL   | DriversLicense     | DRIVING_PERMIT               | 2022    | Driving Permit               |
| ALL   | DriversLicense     | INTERNATIONAL_DRIVING_PERMIT | 2024    | International Driving Permit |
| ALL   | TravelDocument     | LAISSEZ_PASSER               | 2022    | Laissez Passer               |
| ALL   | TravelDocument     | LAISSEZ_PASSER               | 2023    | Laissez Passer               |
| ALL   | Passport           | PASSPORT                     | 2012    | Laisses-Passer (Passport)    |

## USA (USA)

### All States

| Type of ID           | Subtype of ID                       | Version | Description                                                                                    |
| :------------------- | :---------------------------------- | :------ | :--------------------------------------------------------------------------------------------- |
| DriversLicense       | DRIVERS_LICENSE_UNDER21             | 2025    | Driver's License (Under 21)                                                                    |
| DriversLicense       | FOREIGN_DRIVERS_LICENSE             | 2022    | Foreign Driver License                                                                         |
| MedicalCard          | SOCIAL_SECURITY_CARD                | 2015    | Social Security Card                                                                           |
| MedicalCard          | SOCIAL_SECURITY_CARD                | 2016    | Social Security Card                                                                           |
| Other                | BIRTH_CERTIFICATE                   | 2010    | Certificate of Live Birth                                                                      |
| Other                | BIRTH_CERTIFICATE                   | 2011    | Birth Certificate                                                                              |
| Other                | CHICAGO_IDENTIFICATION_CARD         | 2024    | Chicago Identification Card                                                                    |
| Passport             | NATIONAL_PASSPORT                   | 2006    | Passport                                                                                       |
| Passport             | NATIONAL_PASSPORT                   | 2020    | Passport                                                                                       |
| Passport             | NATIONAL_PASSPORT                   | 2021    | Passport                                                                                       |
| Passport             | NATIONAL_PASSPORT                   | 2022    | Passport                                                                                       |
| ResidenceDocument    | PERMANENT_RESIDENCE_CARD            | 2017    | Permanent Residence Card                                                                       |
| TravelDocument       | FASTEXPRES                          | 2008    | FAST/EXPRESS Card                                                                              |
| TravelDocument       | GLOBAL_ENTRY                        | 2008    | Global Entry Card                                                                              |
| TravelDocument       | NEXUS                               | 2008    | NEXUS Card                                                                                     |
| TravelDocument       | SENTRI                              | 2008    | SENTRI Card                                                                                    |
| TribalIdentification | ENHANCED_TRIBAL_IDENTIFICATION_CARD | 2025    | Enhanced Tribal Identification Card                                                            |
| TribalIdentification | ENHANCED_TRIBAL_IDENTIFICATION_CARD | 2026    | Enhanced Tribal Identification Card                                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1813    | Noatak Tribal Identification Card                                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1814    | Tetlin Tribal Identification Card                                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1815    | Kwinhagak Tribal Identification Card                                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1816    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1817    | Asa'carsarmiut Tribe of Mountain Village Tribal Identification Card                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1818    | Miccosukee Tribe of Indians of Florida Identification Card                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1819    | Akiachak Native Tribal Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1820    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1821    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1822    | Native Village of Barrow Tribal Identification Card                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1823    | Taos Pueblo Tribal Identification Card                                                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1824    | Wichita and Affiliated Tribes Identification Card                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1825    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1826    | Algaaciq Tribal Membership ID Card                                                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1827    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1828    | Iipay Nation of Santa Ysabel Tribal Identification Card                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1829    | Native Village of Kotlik Tribal Identification Card                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1830    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1831    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1832    | Narragansett Tribal Identification Card                                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1833    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1834    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1835    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1836    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1837    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1838    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1839    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1840    | Tribal Identification Card                                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1841    | Oneida Nation Identification Card                                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1842    | Turtle Mountain Band of Chippewa Indians Identification Card                                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1843    | Lumbee Tribe Identification Card                                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1844    | Sisseton-Wahpeton Oyate of the Lake Traverse Reservation Identification Card                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1845    | Northern Arapaho Tribe of Wyoming Identification Card                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1849    | Chemehuevi Indian Tribe                                                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1851    | Susanville Indian Rancheria                                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1852    | Association Of Village Council Presidents Tribal Identification Card                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1854    | Moak Tribe Of Western Shoshone Tribal Identification Card                                      |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1855    | Picayune Rancheria of the Chukchansi Indians Tribal Identification Card                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1857    | Kickapoo Traditional Tribe Of Texas Identification Card                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1859    | Apache Tribe Of Oklahoma Identification Card                                                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1862    | Eastern Shoshone Tribal Identification Card                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1867    | Ho-Chunk Nation Tribal Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1868    | Kalispel Tribe Identification Card                                                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1869    | Umatilla Indian Tribes Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1871    | Redding Rancheria Tribal Identification Card                                                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1872    | Seminole Tribe of Florida Identification Card                                                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1873    | Village Of Wainwright Tribal Identification Card                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1875    | Spokane Tribal Identification Card                                                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1877    | Spirit Lake Tribal Membership Card                                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1879    | The San Carlos Apache Tribe Identification Card                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1886    | Confederated Tribes Of The Warm Springs Reservation Identification Card                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1897-98 | Stillaguamish Tribe Identification Card                                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1898    | Yurok Tribe Identification Card                                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1899    | Mashantucket Pequot Tribal Nation Identification Card                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1900    | Central Council of the Tlingit and Haida Indian Tribes of Alaska Identification Card           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1901    | Pawnee Nation of Oklahoma Tribal Identification Card                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1903    | Ute Indian Tribe Identification Card                                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1904    | Nottawaseppi Huron Band of the Potawatomi Identification Card                                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1905    | Karuk Tribe Identification Card                                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1906    | Crow Creek Sioux Tribal Identification Card                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1908    | Native Village of Point Hope Tribal Identification Card                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1909    | Quartz Valley Indian Reservation Identification Card                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1914    | White Mountain Apache Tribe Identification Card                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1916    | Native Village of Ouzinkie Tribal ID                                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1918    | Nez Perce Tribe Identification Card                                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1919    | Fond Du Lac Band of Lake Superior Chippewa Identification Card                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1920    | Winnebago Tribe of Nebraska Identification Card                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1921    | Native Village of Kotzebue Identification Card                                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1922    | Bear River Band of Rohnerville Rancheria Identification Card                                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1923    | White Earth Reservation Identification Card                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1924    | Pueblo of Laguna Tribal Identification Card                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1925    | Quinault Indian Nation Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1926    | The Klamath Tribe Identification Card                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1927    | Traditional Village of Togiak Identification Card                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1928    | Shakopee Mdewakanton Sioux Community Identification Card                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1929    | Little Traverse Bay Bands of Odawa Indians Identification Card                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1930    | Eastern Band of Cherokee Indians Identification Card                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1932    | Cowlitz Indian Tribe Identification Card                                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1933    | Yavapai - Apache Nation Identification Card                                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1934    | Comanche Nation Identification Card                                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1937    | Grand Traverse Band of Ottawa and Chippewa Indians Tribal Identification Card                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1943    | Lummi Nation Tribal Identification Card                                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1946    | Winnebago Tribe Of Nebraska Identification Card                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1948    | Native Village of Eyak Tribal Identification Card                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1949    | Sitka Tribe of Alaska Identification Card                                                      |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1950    | Saint Regis Mohawk Tribe Identity Card                                                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1951    | Choctaw Nation of Oklahoma Tribal Identity Card                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1952    | Alabama - Coushatta Tribe Identification Card                                                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1958    | Fort Peck Sioux Tribal Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1960    | Ute Mountain Ute Tribe Identification Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1961    | Lummi Nation Tribal Identification Card                                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1964    | The Tulalip Tribe Identification Card                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1965    | Oneida Nation Tribal Identification Card                                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1966    | Seneca Nation of Indians Tribal Identification Card                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1967    | Quechan Tribe Tribal Identification Card                                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1968    | Association of Village Council Presidents Tribal Identification Card                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1969    | North Fork Rancheria of Mono Indians of California Tribal Identification Card                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1972    | Fort Belknap Indian Community Card                                                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1973    | The Shoshone - Bannock Tribes Identification Card                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1974    | Enhanced Tribal Identification Card (The Confederated Salish and Kootenai Tribes)              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1975    | Lac Courte Oreilles Tribal Membership Card                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1976    | Tribal Identification Card (Three Affiliated Tribes of the Fort Berthold Reservation)          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1977    | Tribal Membership Identification Card (Bishop Paiute Tribe)                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1978    | Tribal Identification Card (Muckleshoot Indian Tribe)                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1979    | Pascua Yaqui Tribe Membership Identification Card                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1980    | Tribal Identification Card (Northern Cheyenne Tribe)                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1981    | Tribal Identification Card (Muscogee - Creek Nation Citizenship ID)                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1984    | Tribal Identification Card (Northern Arapaho Tribe)                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1985    | Tribal Identification Card (Rosebud Sioux Tribe)                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1986    | Tribal Identification Card (Mescalero Apache Tribe)                                            |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1987    | Tribal Identification Card (Confederated Tribes and Bands of the Yakama Nation)                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1988    | Tribal Identification Card (Assiniboine and Sioux Tribes)                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1989    | Cheyenne and Arapaho Tribes Membership Identification                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1990    | Tribal Identification Card (Lac Vieux Desert Band of Lake Superior Chippewa)                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1992    | Lower Brule Sioux Tribal Member Card                                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1993    | Tribal Membership Identification Card (Tonkawa Tribe of Oklahoma)                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1994    | Lower Elwha Klallam Tribe Membership Identification Card                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1995    | Tribal Identification Card (Kiowa Tribe)                                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1996    | White Earth Reservation Tribal Identification Card                                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1997    | Santee Sioux Nation Tribal Identification Card                                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1998    | Tribal Identification Card (St. Croix Chippewa of Wisconsin Tribe)                             |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 1999    | Tribal Identification Card (Citizen Potawatomi Nation)                                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2000    | Tribal Identification Card (Sac and Fox Nation)                                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2001    | Official Membership ID Card (Oglala Sioux Tribe)                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2003    | Tribal Identification Card (Coeur D'Alene Tribe)                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2004    | Tribal Identification Card (Salt River Pima-Maricopa Indian Community)                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2005    | Tribal Identification Card (Citizen of the Cherokee Nation)                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2006    | Tribal Enrollment Identification Card (Chippewa Cree Tribe)                                    |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2007    | Tribal Identification Card (Turtle Mountain Band of Chippewa Indians)                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2008    | Official Tribal Identification Card of Leech Lake Band of Ojibwe                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2009    | Tribal Identification Card (Red Lake Band of Chippewa Indians)                                 |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2010    | Tribal Identification Card (Mississippi Band of Choctaw Indians)                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2016    | Tribal Identification Card (The Blackfeet Nation)                                              |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2017    | Muscogee (Creek) Nation Citizenship ID                                                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2018    | Bois Forte Band of Chippewa Membership Identification                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2019    | Tribal Identification Card (Sisseton-Wahpeton Oyate Tribe)                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2020    | Tribal Identification Card (Omaha Tribe of Nebraska)                                           |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2021    | Crow Tribal Membership Identification                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2022    | Tribal Identification Card (Mille Lacs Band of Ojibwe)                                        |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2023    | Tribal Identification Card (Standing Rock Sioux Tribe)                                         |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2024    | Menominee Tribe of Wisconsin Identification Card                                               |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD          | 2025    | Native Village of Savoonga Tribal Identification Card                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2003    | San Carlos Apache Tribe Minor Identification Card (Under 21)                                   |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2004    | Klamath Tribal Identification Card (Under 21)                                                  |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2005    | Association of Village Council Presidents Tribal Identification Card (Under 21)                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2006    | Tribal Identification Card (Under 21)                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2007    | Tribal Identification Card (Under 21)                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2009    | Reno Sparks Indian Colony Tribal Identification Card (Under 21)                                |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2010    | Three Affiliated Tribes of the Fort Berthold Reservation Tribal Identification Card (Under 21) |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2016    | Hoopa Valley Tribal Minor Identification Card (Under 21)                                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2017    | Ute Indian Tribe Minor Identification Card (Under 21)                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2020    | Tribal Identification Card (Under 21)                                                          |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2021    | Bear River Band of Rohnerville Rancheria Tribal Identity Card (Under 21)                       |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2024    | Crow Tribal Identification Card (Under 21)                                                     |
| TribalIdentification | TRIBAL_IDENTIFICATION_CARD_UNDER21  | 2025    | Cheyenne and Arapaho Tribes Tribal Identification Card (Under 21)                              |

### Alabama

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                                                                 |
| :----------------- | :-------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2005    | Alabama Driver License / Vessel License / FN Vessel License / FN Commercial Driver License / FN Driver License / FN Nonresident Vessel License / Nonresident Vessel License |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | Alabama Driver License / Commercial Driver License                                                                                                                          |
| DriversLicense     | LEARNERS_PERMIT             | 2010    | Alabama Learner's Permit                                                                                                                                                    |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2010    | Alabama Driver License (Under 21) / Graduated Driver License (Under 21)                                                                                                     |
| IdentificationCard | IDENTIFICATION_CARD         | 2005    | Alabama Nondriver Identification Card / FN Identification Card                                                                                                              |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | Alabama Nondriver Identification Card                                                                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | Alabama Nondriver Identification Card (Under 21)                                                                                                                            |
| Other              | FIREARMS_LICENSE            | 2010    | Alabama Firearms License                                                                                                                                                    |

### Alaska

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                      |
| :----------------- | :---------------------------------- | :------ | :--------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2014    | Alaska Driver License / Commercial License / Driver - Motorcycle License                                         |
| DriversLicense     | DRIVERS_LICENSE                     | 2019    | Alaska Driver License / Commercial Driver's License / CDL & Motorcycle License                                   |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2014    | Alaska Driver License (Under 21)                                                                                 |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2019    | Alaska Driver License (Under 21) / Commercial Driver's License (Under 21)  / CDL & Motorcycle License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE                     | 2025    | Alaska Driver License                                                                                            |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2025    | Alaska Driver License (Under 21)                                                                                 |
| DriversLicense     | LEARNERS_PERMIT                     | 2019    | Alaska Driver Permit / Commercial Learner's Permit                                                               |
| DriversLicense     | LEARNERS_PERMIT                     | 2025    | Alaska Driver Permit                                                                                             |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2019    | Alaska Driver Permit (Under 21) / Commercial Learner's Permit (Under 21)                                         |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2019    | Alaska Provisional Driver License (Under 21)                                                                     |
| IdentificationCard | IDENTIFICATION_CARD                 | 2014    | Alaska Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD                 | 2019    | Alaska Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2019    | Alaska Identification Card (Under 21)                                                                            |
| IdentificationCard | IDENTIFICATION_CARD                 | 2025    | Alaska Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2025    | Alaska Identification Card (Under 21)          
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2023    | Alaska City Identification Card                                                                  |                                                                        |
| Other              | FIREARMS_LICENSE                    | 2020    | Alaska Concealed Handgun Permit                                                                                  |

### Arizona

| Type of ID         | Subtype of ID               | Version | Description                                                                                                    |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2001    | Arizona Driver License / Commercial Driver License                                                             |
| DriversLicense     | DRIVERS_LICENSE             | 2014    | Arizona Driver License / Commercial Driver License                                                             |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | Arizona Driver License / Commercial Driver License                                                             |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2001    | Arizona Driver License (Under 21) / Graduated Driver License (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2014    | Arizona Driver License (Under 21) / Graduated Driver License (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2023    | Arizona Driver License (Under 21) / Graduated Driver License (Under 21)                                        |
| DriversLicense     | LEARNERS_PERMIT             | 2001    | Arizona Instruction Permit                                                                                     |
| DriversLicense     | LEARNERS_PERMIT             | 2014    | Arizona Instruction Permit                                                                                     |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | Arizona Instruction Permit / Limited - Term Instruction Permit                                                 |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2001    | Arizona Instruction Permit (Under 21) / Graduated Instruction Permit (Under 21)                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2014    | Arizona Instruction Permit (Under 21) / Graduated Instruction Permit (Under 21)                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | Arizona Instruction Permit (Under 21) / Graduated Instruction Permit (Under 21)                                |
| IdentificationCard | IDENTIFICATION_CARD         | 2001    | Arizona Identification Card                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD         | 2014    | Arizona Identification Card                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | Arizona Identification Card                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2001    | Arizona Identification Card (Under 21)                                                                         |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2014    | Arizona Identification Card (Under 21)                                                                         |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | Arizona Identification Card (Under 21)                                                                         |
| Other              | FIREARMS_LICENSE            | 2020    | Arizona Concealed Weapons Permit                                                                               |

### Arkansas

| Type of ID         | Subtype of ID               | Version | Description                                                                                                              |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | Arkansas Driver's License / Commercial Driver's License                                                                  |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | Arkansas Driver's License / Commercial Driver's License                                                                  |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | Arkansas Driver's License (Under 21) / Commercial Driver's License (Under 21) / Intermediate Driver's License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2018    | Arkansas Driver's License (Under 21) / Commercial Driver's License (Under 21) / Intermediate Driver's License (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD         | 2006    | Arkansas Non Driver Identification Card                                                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | Arkansas Non - Driver's Identification Card                                                                              |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Arkansas Identification Card                                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2015    | Arkansas Non - Driver's Identification Card (Under 21)                                                                   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Arkansas Identification Card (Under 21)                                                                                  |
| IdentificationCard | CITY_IDENTIFICATION_CARD    | 2025    | Arkansas City Identification Card                                                                                        |
| Other              | ENHANCED_FIREARMS_LICENSE   | 2020    | Arkansas Concealed Handgun Carry License                                                                                 |

### California

| Type of ID         | Subtype of ID                       | Version | Description                                                                 |
| :----------------- | :---------------------------------- | :------ | :-------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2000    | California Driver License                                                   |
| DriversLicense     | DRIVERS_LICENSE                     | 2010    | California Driver License / Commercial Driver License                       |
| DriversLicense     | DRIVERS_LICENSE                     | 2018    | California Driver License / Commercial Driver License                       |
| DriversLicense     | DRIVERS_LICENSE                     | 2025    | California Driver License                                                   |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2000    | California Driver License (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2010    | California Driver License (Under 21)                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2018    | California Driver License (Under 21)                                        |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2025    | California Driver License (Under 21)                                        |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2010    | California Provisional Driver License (Under 21)                            |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2018    | California Provisional Driver License (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD                 | 2000    | California Identification Card                                              |
| IdentificationCard | IDENTIFICATION_CARD                 | 2010    | California Identification Card / Senior Citizen Identification Card         |
| IdentificationCard | IDENTIFICATION_CARD                 | 2018    | California Identification Card                                              |
| IdentificationCard | IDENTIFICATION_CARD                 | 2025    | California Identification Card                                              |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2018    | California Identification Card (Under 21)                                   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2025    | California Identification Card (Under 21)        
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2018    | San Francisco City ID Card    
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2024    | San Francisco City ID Card                         |                                               |
| Other              | FIREARMS_LICENSE                    | 2009    | California License to Carry Concealed Pistol, Revolver or other Firearm     |
| Other              | FIREARMS_LICENSE                    | 2025    | California Firearms License                                                 |

### Colorado

| Type of ID         | Subtype of ID               | Version | Description                                                                                       |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE             | 1994    | Colorado Driver License                                                                           |
| DriversLicense     | DRIVERS_LICENSE             | 2014    | Colorado Driver License / Commercial Driver License / Restricted License / Probationary License / |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Colorado Driver License / Commercial Driver License / Restricted Driver License                   |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | Colorado Driver License / Commercial Driver License                                               |
| DriversLicense     | DRIVERS_LICENSE             | 2022    | Colorado Driver License / Commercial Driver License                                               |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 1994    | Colorado Driver License (Under 21)                                                                |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2016    | Colorado Driver License (Under 21) / Restricted Driver License (Under 21)                         |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2020    | Colorado Driver License (Under 21) / Commercial Driver License (Under 21)                         |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2022    | Colorado Driver License (Under 21)                                                                |
| DriversLicense     | LEARNERS_PERMIT             | 2014    | Colorado Instruction Permit / Restricted Permit                                                   |
| DriversLicense     | LEARNERS_PERMIT             | 2016    | Colorado Instruction Permit / Restricted Permit                                                   |
| DriversLicense     | LEARNERS_PERMIT             | 2020    | Colorado Instruction Permit / Commercial Learner Permit                                           |
| DriversLicense     | LEARNERS_PERMIT             | 2022    | Colorado Instruction Permit                                                                       |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2016    | Colorado Instruction Permit (Under 21)                                                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2020    | Colorado Instruction Permit (Under 21)                                                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2022    | Colorado Instruction Permit (Under 21)                                                            |
| IdentificationCard | IDENTIFICATION_CARD         | 2014    | Colorado Identification Card                                                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Colorado Identification Card                                                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2020    | Colorado Identification Card                                                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2022    | Colorado Identification Card                                                                      |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2014    | Colorado Identification Card (Under 21)                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2016    | Colorado Identification Card (Under 21)                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2019    | Colorado Identification Card (Under 21)                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2022    | Colorado Identification Card (Under 21)                                                           |
| Other              | FIREARMS_LICENSE            | 2010    | Colorado Concealed Handgun Permit                                                                 |
| Other              | FIREARMS_LICENSE            | 2020    | Colorado Concealed Handgun Permit                                                                 |
| Permit             | DRIVER_INSTRUCTION_PERMIT_ALLAGES | 1994    | Colorado Driver Instruction Permit                                                                |
| Permit             | DRIVER_INSTRUCTION_PERMIT_UNDER18 | 1994    | Colorado Driver Instruction Permit (Under 18)                                                     |
| Permit             | DRIVER_INSTRUCTION_PERMIT_UNDER21 | 1994    | Colorado Driver Instruction Permit (Under 21)                                                     |

### Connecticut

| Type of ID         | Subtype of ID               | Version | Description                                                                                                 |
| :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | Connecticut Driver License / Commercial Driver License / Commercial Driver Instruction Permit               |
| DriversLicense     | DRIVERS_LICENSE             | 2017    | Connecticut Driver License                                                                                  |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | Connecticut Driver License (Under 21) / Motorcycle Permit (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2017    | Connecticut Driver License (Under 21)                                                                       |
| DriversLicense     | LEARNERS_PERMIT             | 2011    | Connecticut Adult Learner Permit                                                                            |
| DriversLicense     | LEARNERS_PERMIT             | 2017    | Connecticut Adult Learner Permit                                                                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2011    | Connecticut Learner Permit (Under 21) / Adult Learner Permit (Under 21)                                     |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2017    | Connecticut Learner Permit (Under 21) / Adult Learner Permit (Under 21)                                     |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | Connecticut Identification Card                                                                             |
| IdentificationCard | IDENTIFICATION_CARD         | 2017    | Connecticut Identification Card                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2011    | Connecticut Identification Card (Under 21)                                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2017    | Connecticut Identification Card (Under 21)     
| IdentificationCard | CITY_IDENTIFICATION_CARD | 2020    | Connecticut Park City Resident Card                                                               |                                                                       |
| Other              | FIREARMS_LICENSE            | 2010    | Connecticut Permit to Carry Pistols and Revolvers                                                           |

### Delaware

| Type of ID         | Subtype of ID               | Version | Description                                           |
| :----------------- | :-------------------------- | :------ | :---------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | Delaware Driver License / Commercial Driver License   |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | Delaware Driver License / Commercial Driver's License |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2010    | Delaware Driver License (Under 21)                    |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2018    | Delaware Driver License (Under 21)                    |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | Delaware Non-Driver Identification Card               |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Delaware Identification Card                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | Delaware Non-Driver Identification Card (Under 21)    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Delaware Identification Card (Under 21)               |
| Other              | BIRTH_CERTIFICATE           | 2020    | Delaware Birth Certificate                            |

### District Of Columbia

| Type of ID         | Subtype of ID               | Version | Description                                                                                               |
| :----------------- | :-------------------------- | :------ | :-------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2002    | Washington, D.C. Driver's License / Commercial Driver's License / Learner's Permit / CDL Learner's Permit |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | Washington, DC Driver License                                                                             |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | Washington DC Learner Permit                                                                              |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE | 2023    | Washington DC Provisional Driver License                                                                  |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | Washington, DC Learner Permit                                                                             |
| DriversLicense     | DRIVERS_LICENSE             | 2017    | Washington, DC Driver License / Temporary Driver License / Commercial Driver License                      |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2017    | Washington, DC Driver License (Under 21) / Temporary Driver License (Under 21)                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2017    | Washington, DC Learner Permit (Under 21) / Temporary Learner Permit (Under 21)                            |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE | 2017    | Washington, DC Provisional Driver License (Under 21)                                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2013    | District of Columbia Identification Card                                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2017    | Washington, DC Identification Card / Temporary Identification Card                                        |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | Washington, DC Identification Card                                                                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2013    | District of Columbia Identification Card (Under 21)                                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2017    | Washington, DC Identification Card (Under 21)  / Temporary Identification Card (Under 21)                 |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | Washington, DC Identification Card (Under 21)                                                             |
| Other              | FIREARMS_LICENSE            | 2010    | District of Columbia Concealed Carry Pistol License                                                       |

### Florida

| Type of ID         | Subtype of ID                         | Version | Description                                                         |
| :----------------- | :------------------------------------ | :------ | :------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                       | 2004    | Florida Driver License / Learner License / CDL                      |
| DriversLicense     | DRIVERS_LICENSE                       | 2017    | Florida Driver License / CDL                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21                | 2004    | Florida Driver License (Under 21) / CDL (Under 21)                  |
| DriversLicense     | DRIVER_LICENSE_UNDER21                | 2017    | Florida Driver License (Under 21)                                   |
| DriversLicense     | LEARNERS_PERMIT                       | 2004    | Florida Learner License (Under 21)                                  |
| DriversLicense     | LEARNERS_PERMIT                       | 2017    | Florida Learner's License / Learner's Permit / CDL Learner's Permit |
| DriversLicense     | LEARNERS_PERMIT_UNDER21               | 2017    | Florida Learner's License (Under 21)                                |
| DriversLicense     | TEMPORARY_DRIVERS_LICENSE             | 2017    | Florida Temporary Driver License                                    |
| DriversLicense     | TEMPORARY_DRIVERS_LICENSE_UNDER21             | 2017    | Florida Temporary Driver License (Under 21)                                    |
| DriversLicense     | TEMPORARY_LEARNERS_PERMIT             | 2017    | Florida Temporary Learner's License                                 |
| IdentificationCard | IDENTIFICATION_CARD                   | 1999    | Florida Identification Card                                         |
| IdentificationCard | IDENTIFICATION_CARD                   | 2013    | Florida Identification Card                                         |
| IdentificationCard | IDENTIFICATION_CARD                   | 2017    | Florida Identification Card                                         |
| IdentificationCard | TEMPORARY_IDENTIFICATION_CARD         | 2017    | Florida Temporary Identification Card                               |
| IdentificationCard | TEMPORARY_IDENTIFICATION_CARD_UNDER21 | 2017    | Florida Temporary Identification Card (Under 21)                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21           | 2013    | Florida Identification Card (Under 21)                              |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21           | 2017    | Florida Identification Card (Under 21)                              |
| Other              | FIREARMS_LICENSE                      | 2020    | Florida Concealed Weapon or Firearm License                         |
| Other              | FIREARMS_LICENSE                      | 2025    | Statewide Firearm License                                           |

### Georgia

| Type of ID          | Subtype of ID                       | Version | Description                                                                                         |
| :------------------ | :---------------------------------- | :------ | :-------------------------------------------------------------------------------------------------- |
| DriversLicense      | DRIVERS_LICENSE                     | 2012    | Georgia Driver's License / Limited - Term Driver's License / Commercial Driver's License            |
| DriversLicense      | DRIVERS_LICENSE                     | 2019    | Georgia Driver's License / Limited - Term Driver's License / Commercial Driver's License            |
| DriversLicense      | DRIVER_LICENSE_UNDER21              | 2012    | Georgia Driver's License (Under 21)                                                                 |
| DriversLicense      | DRIVER_LICENSE_UNDER21              | 2019    | Georgia Driver's License (Under 21)                                                                 |
| DriversLicense      | LEARNERS_PERMIT                     | 2012    | Georgia DL Instructional Permit / Commercial Learner's Permit                                       |
| DriversLicense      | LEARNERS_PERMIT                     | 2019    | Georgia DL Instructional Permit / CDL Instructional Permit / Limited - Term DL Instructional Permit |
| DriversLicense      | LEARNERS_PERMIT_UNDER21             | 2012    | Georgia DL Instructional Permit (Under 21)                                                          |
| DriversLicense      | LEARNERS_PERMIT_UNDER21             | 2019    | Georgia DL Instructional Permit (Under 21)  /  Limited - Term DL Instructional Permit (Under 21)    |
| DriversLicense      | PROVISIONAL_DRIVERS_LICENSE         | 2012    | Georgia Provisional Driver's License                                                                |
| DriversLicense      | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2019    | Georgia Provisional Driver's License (Under 21)                                                     |
| IdentificationCard  | IDENTIFICATION_CARD                 | 2012    | Georgia Identification Card                                                                         |
| IdentificationCard  | IDENTIFICATION_CARD                 | 2019    | Georgia Identification Card / Limited - Term Identification Card                                    |
| IdentificationCard  | IDENTIFICATION_CARD_UNDER21         | 2012    | Georgia Identification Card (Under 21) / ID for Voting Purpose                                      |
| IdentificationCard  | IDENTIFICATION_CARD_UNDER21         | 2019    | Georgia Identification Card (Under 21)                                                              |
| Other               | FIREARMS_LICENSE                    | 2020    | Georgia Weapons Carry License                                                                       |
| VoterIdentification | VOTER_IDENTIFICATION_CARD           | 2022    | Georgia Voter Identification Card                                                                   |

### Guam

| Type of ID         | Subtype of ID               | Version | Description                                                        |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | Guam Driver's License                                              |
| DriversLicense     | DRIVERS_LICENSE             | 2017    | Guam Driver's License                                              |
| DriversLicense     | DRIVERS_LICENSE             | 2019    | Guam Driver's License                                              |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | Guam Driver's License                                              |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2019    | Guam Driver's License (Under 21)                                   |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2020    | Guam Driver's License (Under 21) / Intermediate License (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Guam Identification Card                                           |
| IdentificationCard | IDENTIFICATION_CARD         | 2020    | Guam Identification Card                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Guam Identification Card (Under 21)                                |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2019    | Guam Identification Card (Under 21)                                |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2021    | Guam Identification Card (Under 21)                                |
| Other              | FIREARMS_LICENSE            | 2010    | Guam Firearm Identification Card                                   |

### Hawaii

| Type of ID         | Subtype of ID                       | Version | Description                                    |
| :----------------- | :---------------------------------- | :------ | :--------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2015    | Hawaii Driver License                          |
| DriversLicense     | DRIVERS_LICENSE                     | 2021    | Hawaii Limited Purpose Driver License          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2009    | Hawaii Driver License (Under 21)               |
| DriversLicense     | LEARNERS_PERMIT                     | 2009    | Hawaii Driver License - PERMIT                 |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2009    | Hawaii Driver License - PERMIT (Under 21)      |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2009    | Hawaii Driver License - PROVISIONAL (Under 21) |
| DriversLicense     | DRIVERS_LICENSE                     | 2026    | Hawaii Driver License                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2026    | Hawaii Driver License (Under 21)                          |
| DriversLicense     | LEARNERS_PERMIT                     | 2026    | Hawaii Instruction Permit                          |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2026    | Hawaii Instruction Permit (Under 21)                         |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2026    | Hawaii Provisional Driver License (Under 21)                      |
| IdentificationCard | IDENTIFICATION_CARD                 | 2015    | Hawaii Identification Card                     |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2014    | Hawaii Identification Card (Under 21)          |
| IdentificationCard | IDENTIFICATION_CARD                 | 2026    | Hawaii Identification Card                     |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2026    | Hawaii Identification Card (Under 21)                    |

### Idaho

| Type of ID         | Subtype of ID               | Version | Description                                                                |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | Idaho Driver's License                                                     |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Idaho Driver's License                                                     |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | Idaho Driver's License                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | Idaho Driver's License (Under 21) / Commercial Driver's License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2016    | Idaho Driver's License (Under 21)                                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2023    | Idaho Driver's License (Under 21)                                          |
| DriversLicense     | LEARNERS_PERMIT             | 2016    | Idaho Instruction Permit                                                   |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | Idaho Instruction Permit                                                   |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2016    | Idaho Instruction Permit (Under 21)                                        |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | Idaho Instruction Permit (Under 21)                                        |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | Idaho Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Idaho Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | Idaho Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Idaho Identification Card (Under 21)                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | Idaho Identification Card (Under 21)                                       |
| Other              | FIREARMS_LICENSE            | 2013    | Idaho Concealed Weapons License                                            |
| Other              | FIREARMS_LICENSE            | 2016    | Idaho Concealed Weapons License                                            |
| Other              | ENHANCED_FIREARMS_LICENSE   | 2023    | Idaho Enhanced Concealed Weapons License                                   |

### Illinois

| Type of ID         | Subtype of ID               | Version | Description                                            |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2000    | Illinois Driver's License                              |
| DriversLicense     | DRIVERS_LICENSE             | 2007    | Illinois Driver's License / CDL                        |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Illinois Driver's License                              |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | Illinois Driver's License                              |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2016    | Illinois Driver's License (Under 21) / TVDL (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD         | 2007    | Illinois ID Card                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2007    | Illinois ID Card (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Illinois Identification Card                           |
| IdentificationCard | IDENTIFICATION_CARD         | 2020    | Illinois Identification Card                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2016    | Illinois Identification Card (Under 21)                |
| IdentificationCard | CITY_IDENTIFICATION_CARD | 2000    | City of Chicago Identification Card (Illinois)          |
| IdentificationCard | CITY_IDENTIFICATION_CARD | 2020    | City of Chicago Identification Card (Illinois) 
| Other              | FIREARMS_LICENSE            | 2010    | Illinois Concealed Carry License                       |
| Other              | FIREARMS_LICENSE            | 2024    | Illinois Firearm Owner's Identification Card           |

### Indiana

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                                                          |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | Indiana Operator License / Commercial Driver's License / DUP Operator Driver License / Motorcycle Only License / Amend Commercial Driver License / Chauffeur License |
| DriversLicense     | DRIVERS_LICENSE             | 2019    | Indiana Operator License / Commercial Driver's License / Driver's License                                                                                            |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2019    | Indiana Driver's License (Under 21) / Operator License (Under 21)                                                                                                    |
| DriversLicense     | LEARNERS_PERMIT             | 2019    | Indiana Learner Permit                                                                                                                                               |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2010    | Indiana Learner Permit (Under 21)                                                                                                                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2019    | Indiana Learner Permit (Under 21)                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | Indiana Identification Card                                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD         | 2019    | Indiana Identification Card                                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | Indiana Identification Card (Under 21)                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2019    | Indiana Identification Card (Under 21)                                                                                                                               |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2020    | City of Union / City Municipal Identification Card                                                                                                                   |
| Other              | FIREARMS_LICENSE            | 2020    | Indiana License to Carry Handgun                                                                                                                                     |

### Iowa

| Type of ID         | Subtype of ID               | Version | Description                                                                                                    |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2013    | Iowa Driver License / Commercial Driver License                                                                |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | Iowa Driver License / Limited - Term Driver License / Commercial Driver License                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2013    | Iowa Driver License (Under 21) / Commercial Driver License (Under 21) / Intermediate Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2018    | Iowa Driver License (Under 21) / Commercial Driver License (Under 21) / Intermediate Driver License (Under 21) |
| DriversLicense     | LEARNERS_PERMIT             | 2018    | Iowa Limited - Term Instruction Permit / Instruction Permit                                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2013    | Iowa Instruction Permit (Under 21)                                                                             |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2018    | Iowa Instruction Permit (Under 21)                                                                             |
| IdentificationCard | IDENTIFICATION_CARD         | 2005    | Iowa Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2013    | Iowa Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Iowa Identification Card / Limited - Term Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2013    | Iowa Identification Card (Under 21)                                                                            |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Iowa Identification Card (Under 21)                                                                            |
| Other              | FIREARMS_LICENSE            | 2013    | Iowa Non - Professional Permit to carry weapons                                                                |

### Kansas

| Type of ID         | Subtype of ID               | Version | Description                                                                                            |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2004    | Kansas Driver's License / CDL                                                                          |
| DriversLicense     | DRIVERS_LICENSE             | 2012    | Kansas Driver's License / Commercial Driver's License                                                  |
| DriversLicense     | DRIVERS_LICENSE             | 2017    | Kansas Driver's License / Commercial Driver's License / Learner's Permit / Commercial Learner's Permit |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2004    | Kansas Driver's License (Under 21)                                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2012    | Kansas Driver's License (Under 21)                                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2017    | Kansas Driver's License / Commercial Driver's License (Under 21)                                       |
| DriversLicense     | LEARNERS_PERMIT             | 2013    | Kansas Learner's Permit                                                                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2017    | Kansas Learner's Permit (Under 21) / Commercial Learner's Permit (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD         | 2012    | Kansas Identification Card                                                                             |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Kansas Identification Card                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2012    | Kansas Identification Card (Under 21)                                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2017    | Kansas Identification Card (Under 21)                                                                  |
| Other              | FIREARMS_LICENSE            | 2017    | Kansas Concealed Carry License                                                                         |

### Kentucky

| Type of ID         | Subtype of ID                           | Version | Description                                                                          |
| :----------------- | :-------------------------------------- | :------ | :----------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                         | 2004    | Kentucky Hardship Driver's License / Kentucky Commercial Driver's License            |
| DriversLicense     | DRIVERS_LICENSE                         | 2012    | Kentucky Driver's License / Kentucky Commercial Driver's License                     |
| DriversLicense     | DRIVERS_LICENSE                         | 2019    | Kentucky Driver's License / Kentucky Commercial Driver's License                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2012    | Kentucky Driver's License (Under 21)                                                 |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2019    | Kentucky Driver's License (Under 21) / Commercial Driver's License Limited - Term    |
| DriversLicense     | LEARNERS_PERMIT                         | 2011    | Kentucky Instruction Permit                                                          |
| DriversLicense     | LEARNERS_PERMIT                         | 2019    | Kentucky Instruction Permit / Commercial Learner's Permit                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                 | 2012    | Kentucky Instruction Permit (Under 21)                                               |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                 | 2019    | Kentucky Instruction Permit (Under 21)  / Commercial Driver's License Limited - Term |
| IdentificationCard | IDENTIFICATION_CARD                     | 2012    | Kentucky Identification Card                                                         |
| IdentificationCard | IDENTIFICATION_CARD                     | 2019    | Kentucky Identification Card                                                         |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21             | 2012    | Kentucky Identification Card (Under 21)                                              |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21             | 2019    | Kentucky Identification Card (Under 21)                                              |
| IdentificationCard | IDENTIFICATION_CARD_VALID_WITHOUT_PHOTO | 2019    | Kentucky Identification Card (valid without photo)                                   |
| Other              | FIREARMS_LICENSE                        | 2009    | Kentucky Concealed Deadly Weapons License                                            |

### Louisiana

| Type of ID         | Subtype of ID               | Version | Description                                                                    |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2001    | Louisiana Personal Driver's License                                            |
| DriversLicense     | DRIVERS_LICENSE             | 2013    | Louisiana Personal Driver's License / Chauffeur's License / Commercial License |
| DriversLicense     | DRIVERS_LICENSE             | 2015    | Louisiana Personal Driver's License / Chauffeur's License / Commercial License |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2015    | Louisiana Personal Driver's License (Under 21)                                 |
| DriversLicense     | LEARNERS_PERMIT             | 2015    | Louisiana Temporary Instructional Permit / Commercial Learner's Permit         |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2015    | Louisiana Temporary Instructional Permit (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD         | 2001    | Louisiana Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2013    | Louisiana Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2015    | Louisiana Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2015    | Louisiana Identification Card (Under 21)                                       |
| Other              | FIREARMS_LICENSE            | 2020    | Louisiana Concealed Handgun Permit                                             |
| Other              | FIREARMS_LICENSE            | 2025    | Louisiana Concealed Handgun Permit                                             |

### Maine

| Type of ID         | Subtype of ID               | Version | Description                                                                |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | Maine Driver's License / CDL Operator                                      |
| DriversLicense     | DRIVERS_LICENSE             | 2019    | Maine Driver's License / Commercial Driver's License                       |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | Maine Driver's License (Under 21)                                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2019    | Maine Driver's License (Under 21) / Commercial Driver's License (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | Maine Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2019    | Maine Identification Card                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2011    | Maine Identification Card (Under 21)                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2019    | Maine Identification Card (Under 21)                                       |
| Other              | FIREARMS_LICENSE            | 2010    | Maine Permit to Carry Concealed Firearms                                   |

### Mariana Islands

| Type of ID         | Subtype of ID           | Version | Description                                                             |
| :----------------- | :---------------------- | :------ | :---------------------------------------------------------------------- |
| IdentificationCard | IDENTIFICATION_CARD     | 2014    | Mariana Islands Identification Card  
| IdentificationCard | CITY_IDENTIFICATION_CARD     | 2025    | Municipality of Saipan Identification Card                              |                                   |
| IdentificationCard | CITY_IDENTIFICATION_CARD_UNDER21 | 2025    | Municipality of Saipan Identification Card (Under 21)                   |
| DriversLicense     | DRIVERS_LICENSE         | 2020    | Mariana Islands Driver License                                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21 | 2020    | Mariana Islands Driver License (Under 21) / Driver License Limited Term |
| Other              | DRIVERS_LICENSE         | 2023    | Mariana Islands Driver's License                                        |
| Other              | DRIVERS_LICENSE_UNDER21 | 2025    | Mariana Islands Driver's License (Under 21)                             |

### Maryland

| Type of ID         | Subtype of ID                       | Version | Description                                                       |
| :----------------- | :---------------------------------- | :------ | :---------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2002    | Maryland Driver's License / Commercial Driver's License           |
| DriversLicense     | DRIVERS_LICENSE                     | 2016    | Maryland Driver's License / Commercial Driver's License           |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2016    | Maryland Driver's License (Under 21)                              |
| DriversLicense     | LEARNERS_PERMIT                     | 2002    | Maryland Learner's Instructional Permit / Moped Operator's Permit |
| DriversLicense     | LEARNERS_PERMIT                     | 2017    | Maryland Learner's Instructional Permit                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2016    | Maryland Learner's Instructional Permit (Under 21)                |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE         | 2002    | Maryland Provisional Driver's License                             |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE         | 2017    | Maryland Provisional Driver's License                             |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2016    | Maryland Provisional Driver's License (Under 21)                  |
| IdentificationCard | IDENTIFICATION_CARD                 | 2002    | Maryland Identification Card                                      |
| IdentificationCard | IDENTIFICATION_CARD                 | 2016    | Maryland Identification Card / Limited Term Identification Card   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2002    | Maryland Identification Card (Under 21)                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2016    | Maryland Identification Card (Under 21)                           |
| Other              | FIREARMS_LICENSE                    | 2020    | Maryland Handgun Permit                                           |

### Massachusetts

| Type of ID         | Subtype of ID                    | Version | Description                                                  |
| :----------------- | :------------------------------- | :------ | :----------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                  | 2010    | Massachusetts Driver's License / Commercial Driver's License |
| DriversLicense     | DRIVERS_LICENSE                  | 2016    | Massachusetts Driver's License / Commercial Driver's License |
| DriversLicense     | DRIVER_LICENSE_UNDER21           | 2010    | Massachusetts Under 21 Driver's License                      |
| DriversLicense     | DRIVER_LICENSE_UNDER21           | 2016    | Massachusetts Under 21 Driver's License                      |
| DriversLicense     | JUNIOR_OPERATORS_LICENSE_UNDER21 | 2010    | Massachusetts Junior Operator's License (Under 21)           |
| DriversLicense     | JUNIOR_OPERATORS_LICENSE_UNDER21 | 2016    | Massachusetts Junior Operator's License (Under 21)           |
| IdentificationCard | IDENTIFICATION_CARD              | 2004    | Massachusetts Identification Card                            |
| IdentificationCard | IDENTIFICATION_CARD              | 2005    | Massachusetts Identification Card                            |
| IdentificationCard | IDENTIFICATION_CARD              | 2010    | Massachusetts Identification Card / Liquor ID Card           |
| IdentificationCard | IDENTIFICATION_CARD              | 2016    | Massachusetts Identification Card / Liquor ID Card           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21      | 2004    | Massachusetts Identification Card (Under 21)                 |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21      | 2016    | Massachusetts Identification Card (Under 21)                 |
| Other              | FIREARMS_LICENSE                 | 2009    | Massachusetts License to Carry Firearms                      |

### Michigan

| Type of ID         | Subtype of ID                        | Version | Description                                                                                                                         |
| :----------------- | :----------------------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                      | 2011    | Michigan Driver License / Commercial Driver License                                                                                 |
| DriversLicense     | DRIVERS_LICENSE                      | 2024    | Michigan Driver's License / Chauffeur's License                                                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21              | 2011    | Michigan Driver License (Under 21)  / Commercial Driver License (Under 21)                                                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21              | 2024    | Michigan Driver's License (Under 21)                                                                                                |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE             | 2011    | Michigan Enhanced Driver License / Enhanced Chauffeur License / Enhanced Commercial Driver License                                  |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE             | 2024    | Michigan Enhanced Driver's License / Enhanced Chauffeur's License                                                                   |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21     | 2011    | Michigan Enhanced Driver License (Under 21) / Enhanced Chauffeur License (Under 21) / Enhanced Commercial Driver License (Under 21) |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21     | 2024    | Michigan Enhanced Driver's License (Under 21)                                                                                       |
| DriversLicense     | ENHANCED_LEARNERS_PERMIT_UNDER21     | 2011    | Michigan Enhanced Graduated Driver License (Under 21)                                                                               |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD         | 2011    | Michigan Enhanced Identification Card                                                                                               |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD_UNDER21 | 2024    | Michigan Enhanced Identification Card (Under 21)                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD                  | 2011    | Michigan Identification Card                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD                  | 2024    | Michigan Identification Card                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2011    | Michigan Identification Card (Under 21)                                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2024    | Michigan Identification Card (Under 21)                                                                                             |
| IdentificationCard | CITY_IDENTIFICATION_CARD                  | 2025    | City of Detroit Municipal ID Card                                                                                                     |
| Other              | FIREARMS_LICENSE                     | 2024    | Michigan Concealed Pistol License                                                                                                   |

### Minnesota

| Type of ID         | Subtype of ID                                | Version | Description                                                                                                   |
| :----------------- | :------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                              | 2004    | Minnesota Driver's License / Driver's License Commercial / Motorized Bicycle                                  |
| DriversLicense     | DRIVERS_LICENSE                              | 2018    | Minnesota Driver's License                                                                                    |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                      | 2004    | Minnesota Driver's License (Under 21) / Driver's License Commercial (Under 21) / Motorized Bicycle (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                      | 2018    | Minnesota Driver's License (Under 21)                                                                         |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE                     | 2018    | Minnesota Enhanced Driver's License                                                                           |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21             | 2018    | Minnesota Enhanced Driver's License (Under 21)                                                                |
| DriversLicense     | ENHANCED_LEARNERS_PERMIT                     | 2018    | Minnesota Enhanced Instruction Permit                                                                         |
| DriversLicense     | ENHANCED_PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2018    | Minnesota Enhanced Provisional Driver's License (Under 21)                                                    |
| DriversLicense     | LEARNERS_PERMIT                              | 2018    | Minnesota Instruction Permit                                                                                  |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                      | 2004    | Minnesota Instruction Permit (Under 21)                                                                       |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                      | 2018    | Minnesota Instruction Permit (Under 21)                                                                       |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21          | 2018    | Minnesota Provisional Driver's License (Under 21)                                                             |
| IdentificationCard | IDENTIFICATION_CARD                          | 2004    | Minnesota Identification Card                                                                                 |
| IdentificationCard | IDENTIFICATION_CARD                          | 2018    | Minnesota Identification Card                                                                                 |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                  | 2004    | Minnesota Identification Card (Under 21)                                                                      |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                  | 2018    | Minnesota Identification Card (Under 21)                                                                      |
| Other              | FIREARMS_LICENSE                             | 2020    | Minnesota Permit to Carry a Pistol                                                                            |

### Mississippi

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2001    | Mississippi Driver License / Commercial License                                                                            |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Mississippi Driver License / Commercial Driver License / Light Commercial Driver License / Non-US Citizen Driver License   |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2024    | Mississippi Driver License (Under 21)                                                                                      |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2001    | Mississippi Driver License (Under 21) / Commercial License (Under 21) /  Non-US Citizen Driver License (Under 21)          |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2016    | Mississippi Driver License (Under 21) / Commercial Driver License (Under 21)  / Light Commercial Driver License (Under 21) |
| DriversLicense     | LEARNERS_PERMIT             | 2016    | Mississippi Learner's Permit / Commercial Learner's Permit / Non-US Citizen Commercial Learner's Permit                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2001    | Mississippi Learner's Permit (Under 21)                                                                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2016    | Mississippi Learner's Permit (Under 21) / Restricted Learner's Permit (Under 21) / Commercial Learner's Permit (Under 21)  |
| DriversLicense     | DRIVERS_LICENSE             | 2024    | Mississippi Driver License                                                                                                 |
| DriversLicense     | LEARNERS_PERMIT             | 2024    | Mississippi Learner's Permit                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD         | 2001    | Mississippi Identification Card / Non-US Citizen Identification Card                                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Mississippi Identification Card / Person with disabilities Identification Card                                             |
| IdentificationCard | IDENTIFICATION_CARD         | 2024    | Mississippi Identification Card                                                                                            |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2001    | Mississippi Identification Card (Under 21)                                                                                 |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2016    | Mississippi Identification Card (Under 21) / Person with disabilities Identification Card (Under 21)                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2024    | Mississippi Identification Card (Under 21)                                                                                 |
| Other              | FIREARMS_LICENSE            | 2010    | Mississippi Firearms Permit                                                                                                |
| Other              | FIREARMS_LICENSE            | 2020    | Mississippi Firearms Permit                                                                                                |
| Other              | FIREARMS_LICENSE            | 2024    | Mississippi Firearms Permit                                                                                                |

### Missouri

| Type of ID         | Subtype of ID                        | Version | Description                                                               |
| :----------------- | :----------------------------------- | :------ | :------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                      | 2003    | Missouri Driver License / Commercial Driver License                       |
| DriversLicense     | DRIVERS_LICENSE                      | 2012    | Missouri Driver License / Commercial Driver License                       |
| DriversLicense     | DRIVERS_LICENSE                      | 2020    | Missouri Driver License / Commercial Driver License / Non-Domiciled CDL   |
| DriversLicense     | DRIVER_LICENSE_UNDER21               | 2012    | Missouri Driver License (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21               | 2020    | Missouri Driver License (Under 21)                                        |
| DriversLicense     | INTERMEDIATE_DRIVERS_LICENSE_UNDER21 | 2012    | Missouri Intermediate Driver License (Under 21)                           |
| DriversLicense     | INTERMEDIATE_DRIVERS_LICENSE_UNDER21 | 2020    | Missouri Intermediate Driver License (Under 21)                           |
| DriversLicense     | LEARNERS_PERMIT                      | 2012    | Missouri Instruction Permit                                               |
| DriversLicense     | LEARNERS_PERMIT                      | 2020    | Missouri Instruction Permit                                               |
| DriversLicense     | LEARNERS_PERMIT_UNDER21              | 2012    | Missouri Instruction Permit (Under 21)                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21              | 2020    | Missouri Instruction Permit (Under 21)                                    |
| IdentificationCard | IDENTIFICATION_CARD                  | 2012    | Missouri Nondriver License                                                |
| IdentificationCard | IDENTIFICATION_CARD                  | 2020    | Missouri Nondriver Identification Card                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2012    | Missouri Nondriver License (Under 21)                                     |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2020    | Missouri Nondriver Identification Card (Under 21)                         |

### Montana

| Type of ID         | Subtype of ID               | Version | Description                                                       |
| :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2008    | Montana Driver License / Commercial Driver License                |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Montana Driver License / Commercial License                       |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2016    | Montana Driver License (Under 21) / Commercial License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2025    | Montana Driver License (Under 21)                                 |
| DriversLicense     | DRIVERS_LICENSE             | 2025    | Montana Driver License                                            |
| IdentificationCard | IDENTIFICATION_CARD         | 2008    | Montana Identification Card                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Montana Identification Card                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2025    | Montana Identification Card                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2008    | Montana Identification Card (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2016    | Montana Identification Card (Under 21)                            |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2025    | Montana Identification Card (Under 21)                            |

### Nebraska

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                                                                                         |
| :----------------- | :---------------------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2017    | Nebraska Driver License / Operators License / School Bus Permit / Medical Hardship Permit / Non - Domiciled CDL / Commercial Drivers License / Restricted CDL                       |
| DriversLicense     | DRIVERS_LICENSE                     | 2021    | Nebraska Driver's License / Commercial Driver's License                                                                                                                             |
| DriversLicense     | DRIVERS_LICENSE                     | 2026    | Nebraska Driver's License                                                                                                                                                           |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2003    | Nebraska School Learners Permit (Under 21) / Provisional Operators Permit (Under 21) / Operators License (Under 21) / Restricted CDL                                                |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2017    | Nebraska Driver License (Under 21) / Commercial Driver's License (Under 21) / Limited - Term Driver License (Under 21) / Restricted CDL (Under 21) / Non - Domiciled CDL (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2021    | Nebraska Driver's License (Under 21)                                                                                                                                                |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2026    | Nebraska Driver's License (Under 21)                                                                                                                                                |
| DriversLicense     | LEARNERS_PERMIT                     | 2017    | Nebraska Learners Permit /  Limited - Term Learners Permit / Commercial Learner's Permit / Non - Domiciled CLP                                                                      |
| DriversLicense     | LEARNERS_PERMIT                     | 2022    | Nebraska Learner's Permit / Commercial Learner's Permit                                                                                                                             |
| DriversLicense     | LEARNERS_PERMIT                     | 2026    | Nebraska Learner's Permit                                                                                                                                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2017    | Nebraska Commercial Learner's Permit (Under 21)  /  Learners Permit (Under 21)                                                                                                      |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2021    | Nebraska Learner's Permit (Under 21)                                                                                                                                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2026    | Nebraska Learner's Permit (Under 21)                                                                                                                                                |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2017    | Nebraska Provisional Operators Permit (Under 21)                                                                                                                                    |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2021    | Nebraska Provisional Operator's Permit (Under 21)                                                                                                                                   |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2026    | Nebraska Provisional Operator's Permit (Under 21)                                                                                                                                   |
| DriversLicense     | IGNITION_INTERLOCK_PERMIT | 2026    | Nebraska Ignition Interlock Permit                                                                                                                                  |
| IdentificationCard | IDENTIFICATION_CARD                 | 2009    | Nebraska Identification Card                                                                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD                 | 2021    | Nebraska Identification Card                                                                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD                 | 2026    | Nebraska Identification Card                                                                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2017    | Nebraska Identification Card (Under 21)                                                                                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2021    | Nebraska Identification Card (Under 21)                                                                                                                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2026    | Nebraska Identification Card (Under 21)                                                                                                                                             |
| Other              | FIREARMS_LICENSE                    | 2020    | Nebraska Concealed Handgun Permit                                                                                                                                                   |

### Nevada

| Type of ID         | Subtype of ID               | Version | Description                                                                                          |
| :----------------- | :-------------------------- | :------ | :--------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | Nevada Driver License / Commercial Driver License                                                    |
| DriversLicense     | DRIVERS_LICENSE             | 2021    | Nevada Driver License                                                                                |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2010    | Nevada Driver License (Under 21)                                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2021    | Nevada Driver License (Under 21)                                                                     |
| DriversLicense     | LEARNERS_PERMIT             | 2021    | Nevada Instruction Permit / Commercial Learner Permit / Instruction Permit Driver Authorization Card |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2010    | Nevada Instruction Permit (Under 21)                                                                 |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2021    | Nevada Instruction Permit (Under 21)                                                                 |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | Nevada Identification Card                                                                           |
| IdentificationCard | IDENTIFICATION_CARD         | 2021    | Nevada Identification Card                                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | Nevada Identification Card (Under 21)                                                                |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2021    | Nevada Identification Card (Under 21)                                                                |

### New Hampshire

| Type of ID         | Subtype of ID               | Version | Description                                              |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | New Hampshire Operator License                           |
| DriversLicense     | DRIVERS_LICENSE             | 2017    | New Hampshire Driver License / Commercial Driver License |
| DriversLicense     | DRIVERS_LICENSE             | 2025    | New Hampshire Driver License                             |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2017    | New Hampshire Driver License (Under 21)                  |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2025    | New Hampshire Driver License (Under 21)                  |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | New Hampshire Non Driver ID                              |
| IdentificationCard | IDENTIFICATION_CARD         | 2017    | New Hampshire Identification Card                        |
| IdentificationCard | IDENTIFICATION_CARD         | 2025    | New Hampshire Identification Card                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2008    | New Hampshire Non Driver ID (Under 21)                   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2017    | New Hampshire Identification Card (Under 21)             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2025    | New Hampshire Identification Card (Under 21)             |
| Other              | FIREARMS_LICENSE            | 2020    | New Hampshire Pistol / Revolver License                  |

### New Jersey

| Type of ID         | Subtype of ID               | Version | Description                                                |
| :----------------- | :-------------------------- | :------ | :--------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | New Jersey Auto Driver License / Commercial Driver License |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | New Jersey Auto Driver License (Under 21)                  |
| DriversLicense     | LEARNERS_PERMIT             | 2011    | New Jersey Probationary Auto License                       |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2011    | New Jersey Probationary Auto License (Under 21)            |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | New Jersey - FOR IDENTIFICATION ONLY                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | New Jersey - FOR IDENTIFICATION ONLY (Under 21)            |
| IdentificationCard | CITY_IDENTIFICATION_CARD    | 2018    | New Jersey City Identification Card                        |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2019    | New Jersey County of Essex Resident Card                   |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2020    | City of Plainfield Municipal Identification Card               |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2021    | Monmouth County Identification Card      |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2022    | City of New Ark Municipal Identification Card    |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2023    | City of Paterson New Jersey Municipal Identification Card    |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2024    | City of Elizabeth NJ Identification Card   |
| IdentificationCard | CITY_IDENTIFICATION_CARD         | 2025    | New Jersey Identification Card   |

### New Mexico

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                          |
| :----------------- | :---------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2007    | New Mexico Driver's License (Interlock License)  / Commercial Driver's License  / Restricted Driver's License        |
| DriversLicense     | DRIVERS_LICENSE                     | 2016    | New Mexico Driver's License / Commercial Driver's License / Driver's Interlock License / Commercial Learner's Permit |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2007    | New Mexico Driver's License (Under 21) / Interlock Driver's License (Under 21)                                       |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2007    | New Mexico Restricted Driver's License (Under 21)                                                                    |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2007    | New Mexico Provisional License (Under 21) / Provisional Interlock License (Under 21)                                 |
| IdentificationCard | IDENTIFICATION_CARD                 | 2016    | New Mexico Identification Card                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2007    | New Mexico Identification Card (Under 21)                                                                            |
| Other              | FIREARMS_LICENSE                    | 2010    | New Mexico Concealed Handgun License                                                                                 |

### New York

| Type of ID         | Subtype of ID                        | Version | Description                                                                                                                                                                                                                                                          |
| :----------------- | :----------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVER_LICENSE                       | 2005    | New York State Driver License / Enhanced Commercial Driver License / Enhanced Restricted Use Driver License / Restricted Use Driver License / Commercial Driver License / Enhanced Driver License / Enhanced Conditional Driver License / Conditional Driver License |
| DriversLicense     | DRIVER_LICENSE                       | 2010    | New York State Driver License                                                                                                                                                                                                                                        |
| DriversLicense     | DRIVER_LICENSE                       | 2017    | New York State Driver License                                                                                                                                                                                                                                        |
| DriversLicense     | DRIVER_LICENSE                       | 2022    | New York State Driver License                                                                                                                                                                                                                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21               | 2017    | New York State Driver License Under 21                                                                                                                                                                                                                               |
| DriversLicense     | DRIVER_LICENSE_UNDER21               | 2022    | New York State Driver License Under 21                                                                                                                                                                                                                               |
| DriversLicense     | ENHANCED_DRIVER_LICENSE              | 2017    | New York State Enhanced Commercial Driver License / Enhanced Driver License                                                                                                                                                                                          |
| DriversLicense     | LEARNERS_PERMIT                      | 2005    | New York State Learner Permit / Enhanced Learner Permit                                                                                                                                                                                                              |
| DriversLicense     | LEARNERS_PERMIT                      | 2017    | New York State Learner Permit                                                                                                                                                                                                                                        |
| DriversLicense     | LEARNERS_PERMIT                      | 2022    | New York State Learner Permit                                                                                                                                                                                                                                        |
| DriversLicense     | LEARNERS_PERMIT_UNDER21              | 2005    | New York State Learner Permit (Under 21)                                                                                                                                                                                                                             |
| DriversLicense     | LEARNERS_PERMIT_UNDER21              | 2017    | New York State Learner Permit (Under 21)                                                                                                                                                                                                                             |
| DriversLicense     | LEARNERS_PERMIT_UNDER21              | 2022    | New York State Learner Permit (Under 21)                                                                                                                                                                                                                             |
| IdentificationCard | CITY_IDENTIFICATION_CARD             | 2021    | New York City Identification Card                                                                                                                                                                                                                                    |
| IdentificationCard | CITY_IDENTIFICATION_CARD             | 2024    | City of Kingston Identification Card                                                                                                                                                                                                                                    |
| IdentificationCard | CITY_IDENTIFICATION_CARD_UNDER21     | 2023    | New York City Identification Card (Under 21)                                                                                                                                                                                                                         |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD         | 2017    | New York State Enhanced Identification Card                                                                                                                                                                                                                          |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD_UNDER21 | 2017    | New York State Enhanced Identification Card (Under 21)                                                                                                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD                  | 2005    | New York State Identification Card                                                                                                                                                                                                                                   |
| IdentificationCard | IDENTIFICATION_CARD                  | 2017    | New York State Identification Card                                                                                                                                                                                                                                   |
| IdentificationCard | IDENTIFICATION_CARD                  | 2018    | NYC Identification Card                                                                                                                                                                                                                                              |
| IdentificationCard | CITY_IDENTIFICATION_CARD                  | 2020    | Westchester County Clerk Identification Card                                                                                                                                                                                                                         |
| Other              | IDENTIFICATION_CARD                  | 2021    | NYC Identification Card                                                                                                                                                                                                                                              |
| IdentificationCard | IDENTIFICATION_CARD                  | 2022    | New York State Enhanced Identification Card                                                                                                                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2017    | New York State Identification Card (Under 21)                                                                                                                                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21          | 2022    | New York State Identification Card (Under 21)                                                                                                                                                                                                                        |
| MedicalCard        | MEDICAL_CARD                         | 2015    | New York State Medical Card                                                                                                                                                                                                                                          |
| Other              | FIREARMS_LICENSE                     | 2010    | New York Firearms License                                                                                                                                                                                                                                            |
| Other              | FIREARMS_LICENSE                     | 2015    | New York Firearms License                                                                                                                                                                                                                                            |

### North Carolina

| Type of ID         | Subtype of ID                       | Version | Description                                                                                 |
| :----------------- | :---------------------------------- | :------ | :------------------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                     | 2000    | North Carolina Driver License                                                               |
| DriversLicense     | DRIVERS_LICENSE                     | 2008    | North Carolina Driver License / Commercial Driver License                                   |
| DriversLicense     | DRIVERS_LICENSE                     | 2015    | North Carolina Driver License / Commercial Driver License                                   |
| DriversLicense     | DRIVERS_LICENSE                     | 2024    | North Carolina Driver License                                                               |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2004    | North Carolina Driver License (Under 21)                                                    |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2015    | North Carolina Driver License (Under 21)                                                    |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2016    | North Carolina Driver License (Under 21)                                                    |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2024    | North Carolina Driver License (Under 21)                                                    |
| DriversLicense     | LEARNERS_PERMIT                     | 2015    | North Carolina Learner Permit / Commercial Learner Permit                                   |
| DriversLicense     | LEARNERS_PERMIT                     | 2024    | North Carolina Learner Permit                                                               |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2024    | North Carolina Learner Permit (Under 21)                                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2015    | North Carolina Limited Learner Permit (Under 21) / Learner Permit (Under 21)                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2016    | North Carolina Limited Learner Permit (Under 21)                                            |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2015    | North Carolina Full Provisional License (Under 21) / Limited Provisional License (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD                 | 2008    | North Carolina Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD                 | 2015    | North Carolina Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD                 | 2024    | North Carolina Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2014    | North Carolina Identification Card (Under 21)                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2015    | North Carolina Identification Card (Under 21)                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2024    | North Carolina Identification Card (Under 21)                                               |
| Other              | FIREARMS_LICENSE                    | 2020    | North Carolina Concealed Handgun Permit                                                     |
| VoterIdentification | VOTER_IDENTIFICATION_CARD           | 2023    | North Carolina Voter Identification Card                                                    |

### North Dakota

| Type of ID         | Subtype of ID               | Version | Description                                                                                            |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2006    | North Dakota Driver License / Motorized Bicycle Permit / Commercial Driver License / Motorcycle Permit |
| DriversLicense     | DRIVERS_LICENSE             | 2014    | North Dakota Driver License / Permanent Driver License / Commercial Driver License                     |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | North Dakota Driver License / Commercial Driver License                                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2017    | North Dakota Driver License (Under 21)                                                                 |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2023    | North Dakota Driver License (Under 21)                                                                 |
| DriversLicense     | LEARNERS_PERMIT             | 2006    | North Dakota Instruction Permit                                                                        |
| DriversLicense     | LEARNERS_PERMIT             | 2014    | North Dakota Instruction Permit / Temporary Instruction Permit                                         |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2014    | North Dakota Instruction Permit (Under 21)                                                             |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | North Dakota Instruction Permit                                                                        |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | North Dakota Instruction Permit (Under 21)                                                             |
| DriversLicense     | TEMPORARY_DRIVERS_LICENSE   | 2023    | North Dakota Temporary Operator Permit / Temporary Driver License                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2006    | North Dakota Non - Driver Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD         | 2014    | North Dakota Non - Driver Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | North Dakota Non - Driver Identification Card                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2006    | North Dakota Non - Driver Identification Card (Under 21)                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2014    | North Dakota Non - Driver Identification Card (Under 21)                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | North Dakota Non - Driver Identification Card (Under 21)                                               |

### Ohio

| Type of ID         | Subtype of ID               | Version | Description                                                                      |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------- |
| DriversLicense     | DRIVER_LICENSE              | 2009    | Ohio Driver License / Commercial License                                         |
| DriversLicense     | DRIVER_LICENSE              | 2018    | Ohio Driver License / Commercial License                                         |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2009    | Ohio Driver License (Under 21)                                                   |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2018    | Ohio Driver License (Under 21) / Commercial License (Under 21)                   |
| DriversLicense     | LEARNERS_PERMIT             | 2018    | Ohio Temporary Permit                                                            |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2018    | Ohio Temporary Permit (Under 21)                                                 |
| IdentificationCard | IDENTIFICATION_CARD         | 2009    | Ohio Identification Card / Temporary Instruction Permit ID                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Ohio Identification Card                                                         |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2015    | Ohio Identification Card (Under 21) / Temporary Instruction Permit ID (Under 21) |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Ohio Identification Card (Under 21)                                              |
| Other              | FIREARMS_LICENSE            | 2020    | Ohio License to Carry Concealed Handgun                                          |

### Oklahoma

| Type of ID         | Subtype of ID               | Version | Description                                                                 |
| :----------------- | :-------------------------- | :------ | :-------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2012    | Oklahoma Driver License / Commercial Driver License                         |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | Oklahoma Driver License                                                     |
| DriversLicense     | DRIVERS_LICENSE             | 2026    | Oklahoma Driver License                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2012    | Oklahoma Driver License (Under 21) / Intermediate Driver License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2020    | Oklahoma Driver License (Under 21) / Intermediate Driver License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2026    | Oklahoma Driver License (Under 21)                                          |
| DriversLicense     | LEARNERS_PERMIT             | 2012    | Oklahoma Learner Permit                                                     |
| DriversLicense     | LEARNERS_PERMIT             | 2020    | Oklahoma Learner Permit                                                     |
| DriversLicense     | LEARNERS_PERMIT             | 2026    | Oklahoma Learner Permit                                                     |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2012    | Oklahoma Learner Permit (Under 21)                                          |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2020    | Oklahoma Learner Permit (Under 21)                                          |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2026    | Oklahoma Learner Permit (Under 21)                                          |
| IdentificationCard | IDENTIFICATION_CARD         | 2012    | Oklahoma Non - Driver Identification Card                                   |
| IdentificationCard | IDENTIFICATION_CARD         | 2020    | Oklahoma Non - Driver Identification Card                                   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2012    | Oklahoma Non - Driver Identification Card (Under 21)                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2020    | Oklahoma Non - Driver Identification Card (Under 21)                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2026    | Oklahoma Identification Card (Under 21)                                     |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | Oklahoma Non - Driver Identification Card                                   |
| IdentificationCard | IDENTIFICATION_CARD         | 2026    | Oklahoma Identification Card                                                |
| Other              | FIREARMS_LICENSE            | 2020    | Oklahoma Handgun License                                                    |

### Oregon

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                                                         |
| :----------------- | :---------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2004    | Oregon Driver License / Instruction Permit / CDL Instruction Permit / Commercial Driver License / Motorcycle Instruction Permit / Moped Restriction |
| DriversLicense     | DRIVERS_LICENSE                     | 2018    | Oregon Driver License / Commercial Driver License                                                                                                   |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2004    | Oregon Driver License (Under 21) / Commercial Drivers License (Under 21)                                                                            |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2018    | Oregon Driver License (Under 21) / Commercial Drivers License (Under 21)                                                                            |
| DriversLicense     | LEARNERS_PERMIT                     | 2018    | Oregon Instruction Permit                                                                                                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2004    | Oregon Provisional Instruction Permit (Under 21) / CDL Instruction Permit (Under 21)                                                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2018    | Oregon Provisional Instruction Permit (Under 21) / CDL Instruction Permit (Under 21)                                                                |
| DriversLicense     | DRIVERS_LICENSE_VALID_WITHOUT_PHOTO | 2018    | Oregon Driving License (valid without photo)                                                                                                        |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2004    | Oregon Provisional License (Under 21) / Provisional Student Permit (Under 21)                                                                       |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2018    | Oregon Provisional Driver License (Under 21)                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD                 | 2004    | Oregon Identification Card                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD                 | 2018    | Oregon Identification Card                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2004    | Oregon Identification Card (Under 21)                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2018    | Oregon Identification Card (Under 21)                                                                                                               |
| Other              | FIREARMS_LICENSE                    | 2022    | Oregon Concealed Handgun License                                                                                                                    |

### Pennsylvania

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                                                                    |
| :----------------- | :---------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2007    | Pennsylvania Driver's License (Under 21) / Temporary Driver's License (Under 21) / Limited Commercial Driver's License (Under 21) / Limited License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2017    | Pennsylvania Driver's License (Under 21)                                                                                                                       |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2022    | Pennsylvania Driver's License (Under 21)                                                                                                                       |
| DriversLicense     | DRIVER_LICENSE                      | 2007    | Pennsylvania Driver's License / Limited Commercial Driver's License / Commercial Driver's License / Limited License                                            |
| DriversLicense     | DRIVER_LICENSE                      | 2017    | Pennsylvania Driver's License / Commercial Driver's License                                                                                                    |
| DriversLicense     | DRIVER_LICENSE                      | 2022    | Pennsylvania Driver's License / Commercial Driver's License                                                                                                    |
| DriversLicense     | JUNIOR_DRIVERS_LICENSE              | 2007    | Pennsylvania Junior Driver's License                                                                                                                           |
| DriversLicense     | JUNIOR_DRIVERS_LICENSE              | 2017    | Pennsylvania Junior Driver's License (Under 21)                                                                                                                |
| DriversLicense     | JUNIOR_DRIVERS_LICENSE              | 2022    | Pennsylvania Junior Driver's License (Under 21)                                                                                                                |
| DriversLicense     | DRIVERS_LICENSE_VALID_WITHOUT_PHOTO | 2022    | Pennsylvania Driving License (valid without photo)                                                                                                             |
| IdentificationCard | IDENTIFICATION_CARD                 | 2007    | Pennsylvania Identification Card                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD                 | 2017    | Pennsylvania Identification Card                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD                 | 2022    | Pennsylvania Identification Card                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2007    | Pennsylvania Identification Card (Under 21) / Pennsylvania Temporary Identification Card (Under 21)                                                            |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2018    | Pennsylvania Identification Card (Under 21)                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2022    | Pennsylvania Identification Card (Under 21)                                                                                                                    |
| IdentificationCard | CITY_IDENTIFICATION_CARD                 | 2024    | City of Philadelphia Identification Card                                                                                                                       |
| Other              | BIRTH_CERTIFICATE                   | 2020    | Pennsylvania Birth Certificate                                                                                                                                 |
| Other              | FIREARMS_LICENSE                    | 2020    | Pennsylvania License to Carry Firearms                                                                                                                         |

### Rhode Island

| Type of ID         | Subtype of ID                       | Version | Description                                                                                                     |
| :----------------- | :---------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2007    | Rhode Island Driver License / Commercial Driver License                                                         |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2016    | Rhode Island Learner Permit (Under 21)                                                                          |
| DriversLicense     | DRIVERS_LICENSE                     | 2018    | Rhode Island Driver License / Commercial Driver License / Non - Domiciled CDL                                   |
| DriversLicense     | LEARNERS_PERMIT                     | 2018    | Rhode Island Learner Permit                                                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21             | 2016    | Rhode Island Driver License (Under 21)  / Commercial Driver License (Under 21) / Non - Domiciled CDL (Under 21) |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2016    | Rhode Island Provisional Driver License (Under 21)                                                              |
| IdentificationCard | IDENTIFICATION_CARD                 | 2007    | Rhode Island Identification Card                                                                                |
| IdentificationCard | IDENTIFICATION_CARD                 | 2016    | Rhode Island Identification Card                                                                                |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2016    | Rhode Island Identification Card                                                                                |
| IdentificationCard | CITY_IDENTIFICATION_CARD                 | 2025    | Rhode Island Identification Card                                                                                |
| Other              | FIREARMS_LICENSE                    | 2020    | Rhode Island Pistol Permit                                                                                      |

### South Carolina

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                                                                                                                      |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 1994    | South Carolina Driver's License                                                                                                                                                                                                  |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | South Carolina Driver's License                                                                                                                                                                                                  |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | South Carolina Driver's License / Commercial Driver's License / Provisional Driver's License / Moped Driver's License / Route Restricted Driver's License / Temporary Alcohol Driver's License / Limited - Term Driver's License |
| DriversLicense     | DRIVERS_LICENSE             | 2025    | South Carolina Driver's License                                                                                                                                                                                                  |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 1994    | South Carolina Driver's License (Under 21)                                                                                                                                                                                       |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2010    | South Carolina Driver's License (Under 21)                                                                                                                                                                                       |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2018    | South Carolina Driver's License (Under 21)                                                                                                                                                                                       |
| DriversLicense     | LEARNERS_PERMIT             | 2017    | South Carolina Commercial Beginner's Permit / Beginner's Permit                                                                                                                                                                  |
| DriversLicense     | LEARNERS_PERMIT             | 2025    | South Carolina Beginner's Permit                                                                                                                                                                                                 |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2018    | South Carolina Beginner's Permit (Under 21)                                                                                                                                                                                      |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2025    | South Carolina Driver's License (Under 21)                                                                                                                                                                                       |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2025    | South Carolina Beginner's Permit (Under 21)                                                                                                                                                                                      |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | South Carolina Identification Card                                                                                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | South Carolina Identification Card                                                                                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD         | 2025    | South Carolina Identification Card                                                                                                                                                                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | South Carolina Identification Card (Under 21)                                                                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | South Carolina Identification Card (Under 21)                                                                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2025    | South Carolina Identification Card (Under 21)                                                                                                                                                                                    |
| Other              | FIREARMS_LICENSE            | 2020    | South Carolina Concealed Weapons Permit                                                                                                                                                                                          |

### South Dakota

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                                                       |
| :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | South Dakota Driver License / Operator License / Commercial Driver License / Limited - Term Driver License                                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2018    | South Dakota Driver License (Under 21) / Commercial Driver License (Under 21) / Limited - Term Restricted Minor's Permit (Under 21) / Operator License (Under 21) |
| DriversLicense     | LEARNERS_PERMIT             | 2018    | South Dakota Instruction Permit / Limited - Term Instruction Permit                                                                                               |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2018    | South Dakota Instruction Permit (Under 21)                                                                                                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21     | 2026    | South Dakota Driver License (Under 21)                                                                                                                        |
| IdentificationCard | IDENTIFICATION_CARD         | 2010    | South Dakota Identification Card                                                                                                                                  |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | South Dakota Identification Card (Under 21)                                                                                                                       |

### Tennessee

| Type of ID         | Subtype of ID                 | Version | Description                                                                                                                             |
| :----------------- | :---------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE               | 2003    | Tennessee Driver License / Commercial Driver License / Restricted Driver License / Temporary Restricted Driver License / Learner Permit |
| DriversLicense     | DRIVERS_LICENSE               | 2016    | Tennessee Driver License                                                                                                                |
| DriversLicense     | DRIVERS_LICENSE               | 2024    | Tennessee Driver License                                                                                                                |
| DriversLicense     | DRIVERS_LICENSE_UNDER21       | 2011    | Tennessee Driver License (Under 21) / Intermediate Unrestricted Driver License                                                          |
| DriversLicense     | DRIVERS_LICENSE_UNDER21       | 2019    | Tennessee Driver License (Under 21)                                                                                                     |
| DriversLicense     | LEARNERS_PERMIT               | 2011    | Tennessee Learner Permit  / Temporary Learner Permit                                                                                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21       | 2011    | Tennessee Learner Permit (Under 21)                                                                                                     |
| DriversLicense     | TEMPORARY_LEARNERS_PERMIT     | 2011    | Tennessee Temporary Learner Permit                                                                                                      |
| DriversLicense     | DRIVERS_LICENSE_UNDER21       | 2024    | Tennessee Driver License (Under 21)                                                                                                     |
| DriversLicense     | LEARNERS_PERMIT               | 2024    | Tennessee Learner Permit                                                                                                                |
| DriversLicense     | LEARNERS_PERMIT_UNDER21       | 2024    | Tennessee Learner Permit (Under 21)                                                                                                     |
| DriversLicense     | TEMPORARY_LEARNERS_PERMIT     | 2024    | Tennessee Temporary Learner Permit                                                                                                      |
| DriversLicense     | TEMPORARY_DRIVERS_LICENSE     | 2024    | Tennessee Temporary Driver License                                                                                                      |
| IdentificationCard | IDENTIFICATION_CARD           | 2003    | Tennessee Identification Card                                                                                                           |
| IdentificationCard | IDENTIFICATION_CARD           | 2015    | Tennessee Identification Card                                                                                                           |
| IdentificationCard | IDENTIFICATION_CARD           | 2016    | Tennessee Identification Card                                                                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21   | 2016    | Tennessee Identification Card (Under 21)                                                                                                |
| IdentificationCard | IDENTIFICATION_CARD           | 2024    | Tennessee Identification Card                                                                                                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21   | 2024    | Tennessee Identification Card (Under 21)                                                                                                |
| IdentificationCard | TEMPORARY_IDENTIFICATION_CARD | 2024    | Tennessee Temporary Identification Card                                                                                                 |
| IdentificationCard | CITY_IDENTIFICATION_CARD      | 2021    | Tennessee City Identification Card                                                                                                      |
| Other              | FIREARMS_LICENSE              | 2020    | Tennessee Handgun Carry Permit                                                                                                          |
| Other              | FIREARMS_LICENSE              | 2025    | Tennessee Handgun Carry Permit                                                                                                          |

### Texas

| Type of ID         | Subtype of ID                       | Version | Description                                                    |
| :----------------- | :---------------------------------- | :------ | :------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                     | 2002    | Texas Driver License                                           |
| DriversLicense     | DRIVERS_LICENSE                     | 2009    | Texas Driver License / Commercial Driver License               |
| DriversLicense     | DRIVERS_LICENSE                     | 2020    | Texas Driver License                                           |
| DriversLicense     | DRIVERS_LICENSE                     | 2025    | Texas Driver License                                           |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2009    | Texas Provisional Driver License (Under 21)                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2009    | Texas Learner Permit (Under 21)                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2009    | Texas Driver License (Under 21)                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2020    | Texas Driver License (Under 21)                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21              | 2025    | Texas Driver License (Under 21)                                |
| DriversLicense     | LEARNERS_PERMIT                     | 2020    | Texas Commercial Learner Permit                                |
| DriversLicense     | LEARNERS_PERMIT                     | 2025    | Texas Learner Permit                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2020    | Texas Learner Driver License (Under 21)                        |
| DriversLicense     | LEARNERS_PERMIT_UNDER21             | 2025    | Texas Learner Driver License (Under 21)                        |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2020    | Texas Provisional Driver License (Under 21)                    |
| DriversLicense     | PROVISIONAL_DRIVERS_LICENSE_UNDER21 | 2025    | Texas Provisional Driver License (Under 21)                    |
| DriversLicense     | LIMITED_TERM_DRIVERS_LICENSE        | 2020    | Texas Limited-Term Driver License                              |
| IdentificationCard | IDENTIFICATION_CARD                 | 2002    | Texas Identification Card                                      |
| IdentificationCard | IDENTIFICATION_CARD                 | 2009    | Texas Identification Card / Limited - Term Identification Card |
| IdentificationCard | IDENTIFICATION_CARD                 | 2020    | Texas Identification Card / Limited - Term Identification Card |
| IdentificationCard | IDENTIFICATION_CARD                 | 2025    | Texas Identification Card                                      |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2009    | Texas Identification Card (Under 21)                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2020    | Texas Identification Card (Under 21)                           |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21         | 2025    | Texas Identification Card (Under 21)                           |
| IdentificationCard | CITY_IDENTIFICATION_CARD            | 2013    | Texas City Identification Card                                 |
| IdentificationCard | CITY_IDENTIFICATION_CARD            | 2025    | Texas City Identification Card                                 |
| Other              | BIRTH_CERTIFICATE                   | 2018    | Texas Certification of Vital Record                            |
| Other              | FIREARMS_LICENSE                    | 2009    | Texas Concealed Handgun License                                |
| Other              | FIREARMS_LICENSE                    | 2024    | Texas License to Carry Handgun                                 |
| Other              | FIREARMS_LICENSE                    | 2025    | Texas License to Carry Handgun                                 |

### USCIS

| Type of ID        | Subtype of ID                   | Version | Description                   |
| :---------------- | :------------------------------ | :------ | :---------------------------- |
| Permit            | EMPLOYMENT_AUTHORIZATION_CARD   | 2011    | Employment Authorization Card |
| Permit            | EMPLOYMENT_AUTHORIZATION_CARD   | 2018    | Employment Authorization Card |
| Permit            | EMPLOYMENT_AUTHORIZATION_CARD   | 2022    | Employment Authorization Card |
| TravelDocument    | TRAVEL_DOCUMENT                 | 2010    | Travel Document               |
| TravelDocument    | TRAVEL_DOCUMENT                 | 2017    | Travel Document               |
| ResidenceDocument | PERMANENT_RESIDENT_CARD_ALLAGES | 2010    | Permanent Resident Card       |
| ResidenceDocument | PERMANENT_RESIDENT_CARD_ALLAGES | 2015    | Permanent Residence Card      |
| ResidenceDocument | PERMANENT_RESIDENT_CARD_ALLAGES | 2023    | Permanent Resident Card       |

### US Department of State

| Type of ID         | Subtype of ID                  | Version | Description                                                                     |
| :----------------- | :----------------------------- | :------ | :------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                | 2019    | United States Department of State Driver's License / Graduated Driver's License |
| IdentificationCard | GOVERNMENT_IDENTIFICATION_CARD | 2010    | United States Government Identification Card                                    |
| TravelDocument     | DIPLOMATIC_IDENTIFICATION_CARD | 2025    | Diplomatic Identification Card                                                  |
| TravelDocument     | PASSPORT_CARD_ALLAGES          | 2012    | Passport Card                                                                   |
| TravelDocument     | VISA_B1_B2                     | 2008    | B1/B2 VISA - Border Crossing Card                                               |
| TravelDocument     | VISA_B1_B2                     | 2021    | B1/B2 VISA - Border Crossing Card                                               |
| Visa               | VISA_ALLAGES                   | 2009    | VISA                                                                            |
| Visa               | VISA_ALLAGES                   | 2010    | VISA                                                                            |
| Visa               | VISA_ALLAGES                   | 2023    | VISA                                                                            |
| Visa               | VISA_ALLAGES                   | 2024    | Immigrant Visa                                                                  |

### Utah

| Type of ID         | Subtype of ID               | Version | Description                                                                |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2016    | Utah Driver License / Commercial Driver License / Privilege Driver License |
| DriversLicense     | DRIVERS_LICENSE             | 2021    | Utah Driver License                                                        |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2016    | Utah Driver License (Under 21) /  Limited - Term Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2021    | Utah Driver License (Under 21)                                             |
| DriversLicense     | PRIVILEGE_CARD              | 2022    | Utah Driving Privilege Card                                                |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2023    | Utah Privilege Driver License (Under 21)                                   |
| IdentificationCard | IDENTIFICATION_CARD         | 2006    | Utah Identification Card                                                   |
| IdentificationCard | IDENTIFICATION_CARD         | 2016    | Utah Identification Card                                                   |
| IdentificationCard | IDENTIFICATION_CARD         | 2021    | Utah Identification Card                                                   |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2006    | Utah Identification Card (Under 21)                                        |
| Other              | FIREARMS_LICENSE            | 2010    | Utah Concealed Firearm Permit                                              |

### Vermont

| Type of ID         | Subtype of ID                               | Version | Description                                                                                                                                                                                                                                              |
| :----------------- | :------------------------------------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                             | 2013    | Vermont Driver's License                                                                                                                                                                                                                                 |
| DriversLicense     | DRIVERS_LICENSE                             | 2014    | Vermont Enhanced Driver's License / Enhanced Operator's License / Enhanced Commercial Driver's License /                                                                                                                                                 |
| DriversLicense     | DRIVERS_LICENSE                             | 2019    | Vermont Driver's License / Driver's Privilege Card / Commercial Driver's License / Nondomiciled Commercial Driver's License                                                                                                                              |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                     | 2013    | Vermont Driver's License (Under 21) / Driver's Privilage Card (Under 21)                                                                                                                                                                                 |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                     | 2019    | Vermont Driver's License (Under 21) / Junior Driver's License (Under 21) / Junior Driver's Privilege Card (Under 21) / Nondomiciled Commercial Driver's License (Under 21) / Commercial Driver's License (Under 21) / Driver's Privilege Card (Under 21) |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE                    | 2019    | Vermont Enhanced Driver's License                                                                                                                                                                                                                        |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21            | 2014    | Vermont Enhanced Driver's License (Under 21) / Enhanced Operator's License (Under 21)                                                                                                                                                                    |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21            | 2019    | Vermont Enhanced Driver's License (Under 21) /  Enhanced Junior Driver's License (Under 21)                                                                                                                                                              |
| DriversLicense     | LEARNERS_PERMIT                             | 2019    | Vermont Learner's Permit / Nondomiciled Commercial Learner's Permit / Learner's Privilege Card                                                                                                                                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                     | 2003    | Vermont Learner's Permit (Under 21)                                                                                                                                                                                                                      |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                     | 2019    | Vermont Learner's Permit (Under 21) / Commercial Learner's Permit (Under 21) / Learner's Privilege Card (Under 21)                                                                                                                                       |
| DriversLicense     | LEARNERS_PERMIT_VALID_WITHOUT_PHOTO         | 2019    | Vermont Learner Permit (valid without photo)                                                                                                                                                                                                             |
| DriversLicense     | LEARNERS_PERMIT_VALID_WITHOUT_PHOTO_UNDER21 | 2019    | Vermont Learner Permit Under 21 (valid without photo)                                                                                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD                         | 2013    | Vermont Nondriver Identification Card                                                                                                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD                         | 2019    | Vermont Nondriver Identification Card                                                                                                                                                                                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                 | 2013    | Vermont Nondriver Identification Card (Under 21)                                                                                                                                                                                                         |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                 | 2019    | Vermont Nondriver Identification Card (Under 21) / Enhanced Nondriver Identification Card (Under 21)                                                                                                                                                     |

### Virginia

| Type of ID         | Subtype of ID               | Version | Description                                                |
| :----------------- | :-------------------------- | :------ | :--------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2018    | Virginia Driver's License / Commercial Driver's License    |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | Virginia Driver's License                                  |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2018    | Virginia Driver's License (Under 21)                       |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2023    | Virginia Driver's License (Under 21)                       |
| DriversLicense     | LEARNERS_PERMIT             | 2018    | Virginia DL Learner's Permit / CDL Learner's Permit        |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | Virginia DL Learner's Permit / Commercial Learner's Permit |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2018    | Virginia DL Learner's Permit (Under 21)                    |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | Virginia DL Learner's Permit (Under 21)                    |
| IdentificationCard | IDENTIFICATION_CARD         | 2018    | Virginia Identification Card / Children's ID Card          |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | Virginia Identification Card                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2018    | Virginia Identification Card (Under 21)                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | Virginia Identification Card (Under 21)                    |
| Other              | FIREARMS_LICENSE            | 2020    | Virginia Concealed Handgun Permit                          |
| Other              | FIREARMS_LICENSE            | 2021    | Virginia Concealed Handgun Permit                          |

### Washington

| Type of ID         | Subtype of ID                               | Version | Description                                                                                                   |
| :----------------- | :------------------------------------------ | :------ | :------------------------------------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE                             | 2010    | Washington Driver License / Commercial Driver License                                                         |
| DriversLicense     | DRIVERS_LICENSE                             | 2018    | Washington Driver License                                                                                     |
| DriversLicense     | DRIVER_LICENSE_UNDER21                      | 2007    | Washington Driver License (Under 21)                                                                          |
| DriversLicense     | DRIVER_LICENSE_UNDER21                      | 2010    | Washington Driver License (Under 21) / Intermediate License (Under 21) / Commercial Driver License (Under 21) |
| DriversLicense     | DRIVER_LICENSE_UNDER21                      | 2017    | Washington Driver License (Under 21) / Intermediate License (Under 21)                                        |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE                    | 2018    | Washington Enhanced Driver License                                                                            |
| DriversLicense     | ENHANCED_DRIVERS_LICENSE_UNDER21            | 2017    | Washington Enhanced Intermediate Driver License (Under 21) / Enhanced Driver License (Under 21)               |
| DriversLicense     | LEARNERS_PERMIT                             | 2018    | Washington Instruction Permit                                                                                 |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                     | 2017    | Washington Instruction Permit (Under 21)                                                                      |
| DriversLicense     | DRIVERS_LICENSE_VALID_WITHOUT_PHOTO_UNDER21 | 2017    | Washington Driving License Under 21 (valid without photo)                                                     |
| DriversLicense     | LEARNERS_PERMIT_VALID_WITHOUT_PHOTO_UNDER21 | 2017    | Washington Learner Permit Under 21 (valid without photo)                                                      |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD                | 2017    | Washington Enhanced Identification Card                                                                       |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD_UNDER21        | 2017    | Washington Enhanced Identification Card (Under 21)                                                            |
| IdentificationCard | ENHANCED_IDENTIFICATION_CARD_UNDER21        | 2022    | Washington Enhanced Identification Card (Under 21)                                                            |
| IdentificationCard | IDENTIFICATION_CARD                         | 2010    | Washington Identification Card                                                                                |
| IdentificationCard | IDENTIFICATION_CARD                         | 2017    | Washington Identification Card                                                                                |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                 | 2010    | Washington Identification Card (Under 21)                                                                     |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21                 | 2017    | Washington Identification Card (Under 21)                                                                     |
| Other              | FIREARMS_LICENSE                            | 2010    | Washington Concealed Pistol License                                                                           |
| Other              | FIREARMS_LICENSE                            | 2020    | Washington Concealed Pistol License                                                                           |

### West Virginia

| Type of ID         | Subtype of ID               | Version | Description                                                                                                                                                                           |
| :----------------- | :-------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| DriversLicense     | DRIVERS_LICENSE             | 2011    | West Virginia Driver's License / Commercial DL / M - Cycle Only DL / BI - OPTIC Lens DL                                                                                               |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | West Virginia Driver's License                                                                                                                                                        |
| DriversLicense     | DRIVERS_LICENSE             | 2023    | West Virginia Driver's License                                                                                                                                                        |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2011    | West Virginia Driver's License (Under 21) / Commercial DL (Under 21) / M - Cycle Only DL (Under 21) / BI - OPTIC Lens DL (Under 21) / Graduated DL (Under 21) / Level 2 - Intermed DL |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2020    | West Virginia Driver's License (Under 21)                                                                                                                                             |
| DriversLicense     | DRIVERS_LICENSE_UNDER21     | 2023    | West Virginia Intermediate DL (Under 21) / Commercial Driver's License (Under 21) / West Virginia Intermediate DL 2 (Under 21)                                                        |
| DriversLicense     | LEARNERS_PERMIT             | 2020    | West Virginia Instruction Permit                                                                                                                                                      |
| DriversLicense     | LEARNERS_PERMIT             | 2023    | West Virginia Learner's Permit                                                                                                                                                        |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2011    | West Virginia Instruction Permit (Under 21) / CDL INST Permit (Under 21) / Level 1 - INST Permit (Under 21)                                                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2020    | West Virginia Instruction Permit (Under 21)                                                                                                                                           |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2023    | West Virginia Instruction Permit (Under 21)                                                                                                                                           |
| IdentificationCard | IDENTIFICATION_CARD         | 2011    | West Virginia Non - Oper ID Card / Secondary ID                                                                                                                                       |
| IdentificationCard | IDENTIFICATION_CARD         | 2023    | West Virginia Identification Card                                                                                                                                                     |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2011    | West Virginia Non - Oper ID Card (Under 21)  / Secondary ID (Under 21) / Youth ID (Under 21)                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2020    | West Virginia Identification Card (Under 21)                                                                                                                                          |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2023    | West Virginia Identification Card (Under 21)                                                                                                                                          |
| Other              | FIREARMS_LICENSE            | 2009    | West Virginia Concealed Pistol / Revolver Permit                                                                                                                                      |
| Other              | FIREARMS_LICENSE            | 2020    | West Virginia Firearms License                                                                                                                                                        |

### Wisconsin

| Type of ID         | Subtype of ID                           | Version | Description                                                                          |
| :----------------- | :-------------------------------------- | :------ | :----------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE                         | 2012    | Wisconsin Driver License Regular / Commercial Driver License                         |
| DriversLicense     | DRIVERS_LICENSE                         | 2015    | Wisconsin Driver License Regular                                                     |
| DriversLicense     | DRIVERS_LICENSE                         | 2023    | Wisconsin Driver License Regular                                                     |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2005    | Wisconsin Driver License (Under 21)                                                  |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2012    | Wisconsin Driver License Regular (Under 21) / Probationary Driver License (Under 21) |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2015    | Wisconsin Driver License Regular (Under 21) / Commercial Driver License (Under 21)   |
| DriversLicense     | DRIVERS_LICENSE_UNDER21                 | 2023    | Wisconsin Driver License Regular (Under 21) / Probationary Driver License (Under 21) |
| DriversLicense     | LEARNERS_PERMIT                         | 2015    | Wisconsin Instruction Permit                                                         |
| DriversLicense     | LEARNERS_PERMIT                         | 2023    | Wisconsin Instruction Permit                                                         |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                 | 2005    | Wisconsin Instruction Permit (Under 21)                                              |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                 | 2015    | Wisconsin Instruction Permit (Under 21)                                              |
| DriversLicense     | LEARNERS_PERMIT_UNDER21                 | 2023    | Wisconsin Instruction Permit (Under 21)                                              |
| IdentificationCard | IDENTIFICATION_CARD                     | 2012    | Wisconsin Identification Card                                                        |
| IdentificationCard | IDENTIFICATION_CARD                     | 2015    | Wisconsin Identification Card                                                        |
| IdentificationCard | IDENTIFICATION_CARD                     | 2020    | Wisconsin Identification Card                                                        |
| IdentificationCard | IDENTIFICATION_CARD                     | 2023    | Wisconsin Identification Card                                                        |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21             | 2012    | Wisconsin Identification Card (Under 21)                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21             | 2015    | Wisconsin Identification Card (Under 21)                                             |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21             | 2023    | Wisconsin Identification Card (Under 21)                                             |
| IdentificationCard | IDENTIFICATION_CARD_VALID_WITHOUT_PHOTO | 2023    | Wisconsin Identity Card (valid without photo)                                        |
| IdentificationCard | CITY_IDENTIFICATION_CARD | 2020    | City of Milwaukee Municipal ID Card |
| Other              | FIREARMS_LICENSE                        | 2020    | Wisconsin Concealed Carry License                                                    |

### Wyoming

| Type of ID         | Subtype of ID               | Version | Description                                                                               |
| :----------------- | :-------------------------- | :------ | :---------------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE             | 2010    | Wyoming Driver License / Commercial Driver License                                        |
| DriversLicense     | DRIVERS_LICENSE             | 2020    | Wyoming Driver License                                                                    |
| DriversLicense     | DRIVERS_LICENSE             | 2024    | Wyoming Driver License                                                                    |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2004    | Wyoming Driver License (Under 21) / Commercial Driver License (Under 21)                  |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2010    | Wyoming Driver License (Under 21) / Commercial Driver License (Under 21)                  |
| DriversLicense     | DRIVER_LICENSE_UNDER21      | 2020    | Wyoming Driver License (Under 21)                                                         |
| DriversLicense     | LEARNERS_PERMIT             | 2020    | Wyoming Instruction Permit / Limited Term Instruction Permit / Commercial Learners Permit |
| DriversLicense     | LEARNERS_PERMIT_UNDER21     | 2020    | Wyoming Instruction Permit (Under 21)                                                     |
| IdentificationCard | IDENTIFICATION_CARD         | 2004    | Wyoming Identification Card                                                               |
| IdentificationCard | IDENTIFICATION_CARD         | 2019    | Wyoming Identification Card                                                               |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2010    | Wyoming Identification Card (Under 21)                                                    |
| IdentificationCard | IDENTIFICATION_CARD_UNDER21 | 2020    | Wyoming Identification Card (Under 21)                                                    |

---

- Path: `general-reference/supported-ids-oceania`
- URL: https://developer.incode.com/general-reference/supported-ids-oceania/
- Markdown: https://developer.incode.com/general-reference/supported-ids-oceania.md

# Oceania

The following tables list supported identification documents for Oceania, organized by country. The table for Australia is further divided by state.

## Australia (AUS)

### All States

| Type of ID        | Subtype of ID       | Version | Description                                                     |
| :---------------- | :------------------ | :------ | :-------------------------------------------------------------- |
| MedicalCard       | MEDICAL\_CARD       | 2018    | Medicare Card                                                   |
| MedicalCard       | MEDICAL\_CARD       | 2019    | Medicare Card                                                   |
| MedicalCard       | MEDICAL\_CARD       | 2020    | Medicare Card                                                   |
| Military          | MILITARY\_CARD      | 2020    | Military Card                                                   |
| Passport          | NATIONAL\_PASSPORT  | 2008    | Passport                                                        |
| Passport          | NATIONAL\_PASSPORT  | 2022    | Passport                                                        |
| Passport          | EMERGENCY\_PASSPORT | 2025    | Emergency Passport                                              |
| ResidenceDocument | IMMIGRATION\_CARD   | 2023    | Immigration Card                                                |
| ResidenceDocument | RESIDENCE\_PERMIT   | 2017    | Australian Government ImmiCard (Evidence of Immigration Status) |
| ResidenceDocument | RESIDENCE\_PERMIT   | 2018    | Australian Government Permanent Resident Evidence               |

### Capital Territory

| Type of ID         | Subtype of ID                    | Version | Description                                               |
| :----------------- | :------------------------------- | :------ | :-------------------------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | Australian Capital Territory Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | Australian Capital Territory Heavy Vehicle Driver License |
| DriversLicense     | LEARNER\_DRIVERS\_LICENSE        | 2015    | Australian Capital Territory Learner Driver License       |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2015    | Australian Capital Territory Provisional Driver License   |
| DriversLicense     | PROBATIONARY\_DRIVERS\_LICENSE   | 2024    | Australian Capital Territory Probationary Driver License  |
| IdentificationCard | AGE\_CARD                        | 2014    | Australian Capital Territory Age Card                     |
| IdentificationCard | IDENTIFICATION\_CARD             | 2021    | Australian Capital Territory Proof of Identity Card       |

### New South Wales

| Type of ID         | Subtype of ID                    | Version | Description                                  |
| :----------------- | :------------------------------- | :------ | :------------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | New South Wales Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | New South Wales Heavy Vehicle Driver License |
| DriversLicense     | LEARNERS\_PERMIT                 | 2015    | New South Wales Learner Driver License       |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2015    | New South Wales Provisional Driver License   |
| IdentificationCard | IDENTIFICATION\_CARD             | 2012    | New South Wales Photo Card                   |
| Other              | COMPETENCY\_CARD                 | 2022    | New South Wales Competency Card              |
| Other              | FIREARMS\_LICENSE                | 2020    | New South Wales Firearms License             |

### Northern Territory

| Type of ID         | Subtype of ID                    | Version | Description                                                  |
| :----------------- | :------------------------------- | :------ | :----------------------------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2012    | Northern Territory of Australia Driver License               |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | Northern Territory of Australia Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | Northern Territory of Australia Heavy Vehicle Driver License |
| IdentificationCard | IDENTIFICATION\_CARD             | 2015    | Northern Territory of Australia Evidence of Age Card         |

### Queensland

| Type of ID         | Subtype of ID                    | Version | Description                             |
| :----------------- | :------------------------------- | :------ | :-------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | Queensland Driver License               |
| DriversLicense     | DRIVERS\_LICENSE                 | 2020    | Queensland Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | Queensland Heavy Vehicle Driver License |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2020    | Queensland Heavy Vehicle Driver License |
| DriversLicense     | INDUSTRY\_AUTHORITY\_CARD        | 2024    | Queensland Industry Authority Card      |
| IdentificationCard | IDENTIFICATION\_CARD             | 2011    | Queensland Adult Proof of Age Card      |
| IdentificationCard | IDENTIFICATION\_CARD             | 2019    | Queensland Photo Identification Card    |
| Permit              | INDUSTRY\_AUTHORITY\_CARD        | 2024    | Queensland Industry Authority Card      |

### South Australia

| Type of ID         | Subtype of ID                    | Version | Description                                    |
| :----------------- | :------------------------------- | :------ | :--------------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | South Australia Driver's License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | South Australia Heavy Vehicle Driver's License |
| DriversLicense     | LEARNERS\_PERMIT                 | 2015    | South Australia Learner's Permit               |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2015    | South Australia Provisional Driver's License   |
| IdentificationCard | IDENTIFICATION\_CARD             | 2015    | South Australia Proof of Age Card              |

### Tasmania

| Type of ID         | Subtype of ID                    | Version | Description                           |
| :----------------- | :------------------------------- | :------ | :------------------------------------ |
| DriversLicense     | DRIVERS\_LICENSE                 | 2015    | Tasmania Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2015    | Tasmania Heavy Vehicle Driver License |
| DriversLicense     | LEARNERS\_PERMIT                 | 2015    | Tasmania Learner Driver License       |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2015    | Tasmania Provisional Driver License   |
| IdentificationCard | IDENTIFICATION\_CARD             | 2023    | Tasmania Personal Information Card    |

### Victoria

| Type of ID         | Subtype of ID                    | Version | Description                           |
| :----------------- | :------------------------------- | :------ | :------------------------------------ |
| DriversLicense     | DRIVERS\_LICENSE                 | 2014    | Victoria Driver License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2014    | Victoria Heavy Vehicle Driver License |
| DriversLicense     | LEARNERS\_PERMIT                 | 2014    | Victoria Learner Permit               |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2014    | Victoria Probationary Driver License  |
| IdentificationCard | IDENTIFICATION\_CARD             | 2018    | Victoria Proof of Age Card            |
| Other              | MARINE\_LICENSE                  | 2020    | Victoria Marine License               |

### Western Australia

| Type of ID         | Subtype of ID                    | Version | Description                                      |
| :----------------- | :------------------------------- | :------ | :----------------------------------------------- |
| DriversLicense     | DRIVERS\_LICENSE                 | 2016    | Western Australia Driver's License               |
| DriversLicense     | HEAVY\_VEHICLE\_DRIVERS\_LICENSE | 2016    | Western Australia Heavy Vehicle Driver's License |
| DriversLicense     | LEARNERS\_PERMIT                 | 2016    | Western Australia Learner's Permit               |
| DriversLicense     | PROVISIONAL\_DRIVERS\_LICENSE    | 2016    | Western Australia Provisional Driver's License   |
| IdentificationCard | IDENTIFICATION\_CARD             | 2015    | Western Australia Photo Card                     |

## American Samoa (ASM)

| State | Type of ID          | Subtype of ID                          | Version | Description                                   |
| :---- | :------------------ | :------------------------------------- | :------ | :-------------------------------------------- |
| ALL   | DriversLicense      | DRIVERS\_LICENSE                       | 2003    | Driver License                                |
| ALL   | DriversLicense      | DRIVERS\_LICENSE                       | 2021    | Driver License                                |
| ALL   | DriversLicense      | DRIVERS\_LICENSE                       | 2023    | Driver License                                |
| ALL   | DriversLicense      | PROVISIONAL\_DRIVERS\_LICENSE\_UNDER21 | 2003    | Provisional Driver License                    |
| ALL   | DriversLicense      | PROVISIONAL\_DRIVERS\_LICENSE\_UNDER21 | 2021    | American Samoa Provisional License (Under 21) |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD                   | 2003    | Identification Card                           |
| ALL   | IdentificationCard  | IDENTIFICATION\_CARD                   | 2019    | Identification Card                           |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD            | 2023    | Voter Registration Card                       |
| ALL   | ResidenceDocument   | RESIDENCE\_DOCUMENT                    | 2020    | Immigration Identification Card               |

## Federated States of Micronesia (FSM)

| State   | Type of ID     | Subtype of ID      | Version | Description            |
| :------ | :------------- | :----------------- | :------ | :--------------------- |
| ALL     | DriversLicense | DRIVERS\_LICENSE   | 2019    | Driver's License       |
| ALL     | DriversLicense | DRIVERS\_LICENSE   | 2023    | Driver's License       |
| ALL     | DriversLicense | DRIVERS\_LICENSE   | 2025    | Driver's License       |
| ALL     | Passport       | NATIONAL\_PASSPORT | 2019    | Passport               |
| CHUUK   | IdentificationCard | IDENTIFICATION\_CARD | 2025    | Chuuk Identification Card |
| POHNPEI | DriversLicense | DRIVERS\_LICENSE   | 2022    | Pohnpei Driver License |

## Fiji (FJI)

| State | Type of ID          | Subtype of ID                 | Version | Description                  |
| :---- | :------------------ | :---------------------------- | :------ | :--------------------------- |
| ALL   | DriversLicense      | DRIVERS\_LICENSE              | 2010    | Driver License Permit        |
| ALL   | DriversLicense      | LEARNERS\_PERMIT              | 2010    | Learner's Permit             |
| ALL   | DriversLicense      | PROVISIONAL\_DRIVERS\_LICENSE | 2010    | Provisional Driver License   |
| ALL   | Passport            | NATIONAL\_PASSPORT            | 2013    | Passport                     |
| ALL   | Passport            | NATIONAL\_PASSPORT            | 2020    | Passport                     |
| ALL   | VoterIdentification | VOTER\_IDENTIFICATION\_CARD   | 2010    | Voter Identification Card    |
| ALL   | TaxIdentification   | TAX\_IDENTIFICATION\_CARD     | 2023    | Taxpayer Identification Card |

## Kiribati (KIR)

| State | Type of ID | Subtype of ID      | Version | Description |
| :---- | :--------- | :----------------- | :------ | :---------- |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2013    | Passport    |

## Marshall Islands (MHL)

| State | Type of ID | Subtype of ID      | Version | Description |
| :---- | :--------- | :----------------- | :------ | :---------- |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2018    | Passport    |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2024    | Passport    |

## Nauru (NRU)

| State | Type of ID     | Subtype of ID      | Version | Description    |
| :---- | :------------- | :----------------- | :------ | :------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2017    | Driver Licence |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2024    | Passport       |

## New Zealand (NZL)

| State         | Type of ID         | Subtype of ID      | Version | Description                             |
| :------------ | :----------------- | :----------------- | :------ | :-------------------------------------- |
| ALL           | DriversLicense     | DRIVERS\_LICENSE   | 2000    | Driver License                          |
| ALL           | DriversLicense     | DRIVERS\_LICENSE   | 2010    | Driver License                          |
| ALL           | DriversLicense     | DRIVERS\_LICENSE   | 2025    | Driver License                          |
| ALL           | IdentificationCard | AGE\_CARD          | 2024    | Evidence of Age Document                |
| ALL           | MedicalCard        | MEDICAL\_CARD      | 2020    | Kiwi Access Card                        |
| ALL           | Military           | MILITARY\_CARD     | 2020    | New Zealand Defence Force Identity Card |
| ALL           | Passport           | NATIONAL\_PASSPORT | 2009    | Passport                                |
| ALL           | Passport           | NATIONAL\_PASSPORT | 2021    | Passport                                |
| ALL           | Other              | FIREARMS\_LICENSE  | 2024    | Firearms License                        |
| ALL           | Other              | FIREARMS\_LICENSE  | 2025    | Firearms License                        |
| COOK\_ISLANDS | DriversLicense     | DRIVERS\_LICENSE   | 2024    | Driver License                          |

## Northern Mariana Islands (MNP)

| State | Type of ID     | Subtype of ID    | Version | Description    |
| :---- | :------------- | :--------------- | :------ | :------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE | 2021    | Driver License |

## Palau (PLW)

| State | Type of ID         | Subtype of ID        | Version | Description                  |
| :---- | :----------------- | :------------------- | :------ | :--------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2021    | Identification Card          |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2022    | Vehicle Operator License     |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2015    | Passport                     |
| ALL   | TravelDocument     | CONSULAR\_CARD       | 2020    | Consular Identification Card |
| ALL   | TravelDocument     | ENTRY\_PERMIT        | 2024    | Entry Permit                 |

## Papua New Guinea (PNG)

| State | Type of ID         | Subtype of ID        | Version | Description            |
| :---- | :----------------- | :------------------- | :------ | :--------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2010    | Driver's License       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2019    | Driver's License       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2025    | Driver's License       |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2026    | Driver's License       |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2015    | National Identity Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2006    | Passport               |

## French Polynesia (PYF)

| State | Type of ID     | Subtype of ID   | Version | Description                          |
| :---- | :------------- | :-------------- | :------ | :----------------------------------- |
| ALL   | DriversLicense | DRIVER\_LICENSE | 2020    | Permis de Conduire (Driving License) |

## Samoa (WSM)

| State | Type of ID     | Subtype of ID      | Version | Description             |
| :---- | :------------- | :----------------- | :------ | :---------------------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2020    | Drivers License         |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2023    | Private Drivers License |
| ALL   | DriversLicense | LEARNERS\_PERMIT\_UNDER21 | 2025    | Learner's Permit (Under 21) |
| ALL   | Passport       | NATIONAL\_PASSPORT | 2016    | Passport                |

## Solomon Islands (SLB)

| State | Type of ID | Subtype of ID      | Version | Description |
| :---- | :--------- | :----------------- | :------ | :---------- |
| ALL   | DriversLicense | DRIVERS\_LICENSE   | 2023    | Driver License |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2022    | Passport    |

## Tonga (TON)

| State | Type of ID         | Subtype of ID        | Version | Description            |
| :---- | :----------------- | :------------------- | :------ | :--------------------- |
| ALL   | DriversLicense     | DRIVERS\_LICENSE     | 2018    | Driving License        |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2015    | National Identity Card |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2004    | Passport               |

## Tuvalu (TUV)

| State | Type of ID | Subtype of ID      | Version | Description |
| :---- | :--------- | :----------------- | :------ | :---------- |
| ALL   | Passport   | NATIONAL\_PASSPORT | 2021    | Passport    |

## Vanuatu (VUT)

| State | Type of ID         | Subtype of ID        | Version | Description                                           |
| :---- | :----------------- | :------------------- | :------ | :---------------------------------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION\_CARD | 2024    | Carte D'Identite Nationale de Vanuatu (Identity Card) |
| ALL   | Passport           | NATIONAL\_PASSPORT   | 2019    | Passport                                              |

---

- Path: `general-reference/supported-ids-south-america`
- URL: https://developer.incode.com/general-reference/supported-ids-south-america/
- Markdown: https://developer.incode.com/general-reference/supported-ids-south-america.md

# South America

The following tables list supported identification documents for South America, organized by country. The tables for Argentina, Brazil, and Peru are further divided by ID type or state.

## Argentina (ARG)

### All States

| Type of ID         | Subtype of ID              | Version | Description                                                                       |
| :----------------- | :------------------------- | :------ | :-------------------------------------------------------------------------------- |
| DriversLicense     | DRIVERS_LICENSE            | 1958    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1959    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1960    | Licencia de Conducir (Provincia del Chaco) / Driver License                       |
| DriversLicense     | DRIVERS_LICENSE            | 1961    | Licencia de Conducir / Driver License                                             |
| DriversLicense     | DRIVERS_LICENSE            | 1963    | Licencia de Conducir (Provincia del Neuquen) / Driver License                     |
| DriversLicense     | DRIVERS_LICENSE            | 1967    | Licencia de Conductor (Municipalidad de Mocoreta Corrientes) / Driver License     |
| DriversLicense     | DRIVERS_LICENSE            | 1968    | Licencia de Conductor (Municipalidad de Santa Sylvina - Chaco) / Driver License   |
| DriversLicense     | DRIVERS_LICENSE            | 1969    | Licencia de Conductor (Villa Angela - Chaco) / Driver License                     |
| DriversLicense     | DRIVERS_LICENSE            | 1970    | Municipalidad de Colon Licencia de Conductor / Driving License                    |
| DriversLicense     | DRIVERS_LICENSE            | 1971    | Provincia de Formosa Licencia de Conductor / Driving License                      |
| DriversLicense     | DRIVERS_LICENSE            | 1972    | Paclin - Catamarca Licencia de Conductor / Driving License                        |
| DriversLicense     | DRIVERS_LICENSE            | 1973    | Municipalidad de Naschel San Luis Licencia de Conductor / Driving License         |
| DriversLicense     | DRIVERS_LICENSE            | 1974    | Municipalidad Villa el Chocon Licencia de Conductor / Driving License             |
| DriversLicense     | DRIVERS_LICENSE            | 1975    | Municipalidad de Conscripto Bernardi Licencia de Conductor / Driving License      |
| DriversLicense     | DRIVERS_LICENSE            | 1976    | Gobierno de Formosa Licencia de Conducir                                          |
| DriversLicense     | DRIVERS_LICENSE            | 1978    | Municipalidad de Fernández Oro Licencia de Conductor                              |
| DriversLicense     | DRIVERS_LICENSE            | 1979    | Municipalidad de Alcaraz Licencia de Conductor / Driving License                  |
| DriversLicense     | DRIVERS_LICENSE            | 1981    | Municipalidad de Cutral-Co Licencia de Conductor  / Driving License               |
| DriversLicense     | DRIVERS_LICENSE            | 1982    | Municipalidad de Ingeniero Juarez Licencia de Conductor  / Driving License        |
| DriversLicense     | DRIVERS_LICENSE            | 1983    | Municipalidad de Calilegua Licencia de Conductor / Driving License                |
| DriversLicense     | DRIVERS_LICENSE            | 1984    | Licencia de Conducir Unica (Municipalidad de Puerto Vilelas) / Driver License     |
| DriversLicense     | DRIVERS_LICENSE            | 1986    | Licencia de Conductor (Municipalidad de Pampa Blanca) / Driver License            |
| DriversLicense     | DRIVERS_LICENSE            | 1987    | Licencia de Conducir (Driving License)                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1989    | Licencia de Conductor / Driving License                                           |
| DriversLicense     | DRIVERS_LICENSE            | 1990    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1992    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1994    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1995    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1996    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1997    | Licencia de Conducir (Driving License)                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1998    | Licencia de Conducir (Driving License)                                            |
| DriversLicense     | DRIVERS_LICENSE            | 1999    | Licencia de Conducir (Driving License)                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2000    | Licencia Nacional de Conducir (National Driver's License)                         |
| DriversLicense     | DRIVERS_LICENSE            | 2001    | Licencia Nacional de Conducir (National Driver's License)                         |
| DriversLicense     | DRIVERS_LICENSE            | 2002    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2004    | Licencia Nacional de Conducir (National Driver's License)                         |
| DriversLicense     | DRIVERS_LICENSE            | 2005    | Licencia de Conductor (Villa Angela - Chaco) / Driver License                     |
| DriversLicense     | DRIVERS_LICENSE            | 2006    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2007    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2012    | Municipalidad de San Carlos Licencia de Conductor / Driving License               |
| DriversLicense     | DRIVERS_LICENSE            | 2013    | Licencia de Conducir / Driving License (Provincia de la Pampa)                    |
| DriversLicense     | DRIVERS_LICENSE            | 2014    | Licencia de Conducir (Municipalidad de Monte Caseros) / Driver License            |
| DriversLicense     | DRIVERS_LICENSE            | 2016    | Pueblo de Libertador Licencia de Conductor / Driving License                      |
| DriversLicense     | DRIVERS_LICENSE            | 2020    | Licencia de Conducir (Provincia del Chaco) / Driver License                       |
| DriversLicense     | DRIVERS_LICENSE            | 2021    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2022    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2023    | Licencia de Conducir / Driving License                                            |
| DriversLicense     | DRIVERS_LICENSE            | 2024    | Licencia de Conducir / Driving License (Municipio Presidencia Roque Sáenz Peña)   |
| DriversLicense     | DRIVERS_LICENSE            | 2025    | Municipalidad de Alvear Licencia de Conductor / Driving License                   |
| IdentificationCard | DIGITAL_IDENTITY_CARD      | 2019    | Documento Nacional de Identidad (National Identity Document)                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2000    | Documento Nacional de Identidad (National Identity Document)                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2009    | Cedula de Identidad (Identity Card)                                               |
| IdentificationCard | IDENTIFICATION_CARD        | 2012    | Documento Nacional de Identidad (National Identity Document)                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2013    | Cedula de Identidad (Identity Card)                                               |
| IdentificationCard | IDENTIFICATION_CARD        | 2015    | Documento Nacional de Identidad Extranjero (National Foreign Identity Document)   |
| IdentificationCard | IDENTIFICATION_CARD        | 2023    | Documento Nacional de Identidad (National Identity Document)                      |
| IdentificationCard | IDENTIFICATION_CARD        | 2024    | Alcaldia Municipal de San Miguel Carné de Identificación Personal / Identity Card |
| IdentificationCard | POLICE_IDENTIFICATION_CARD | 2020    | Police Identification Card                                                        |
| IdentificationCard | POLICE_IDENTIFICATION_CARD | 2024    | Police Identification Card                                                        |
| Passport           | NATIONAL_PASSPORT          | 2009    | Pasaporte (Passport)                                                              |
| Passport           | NATIONAL_PASSPORT          | 2010    | Pasaporte (Passport)                                                              |
| Passport           | NATIONAL_PASSPORT          | 2014    | Pasaporte (Passport)                                                              |
| Passport           | NATIONAL_PASSPORT          | 2023    | Pasaporte (Passport)                                                              |
| Passport           | NATIONAL_PASSPORT          | 2026    | Pasaporte (Passport)                                                              |

### Córdoba

| Type of ID     | Subtype of ID   | Version | Description                                    |
| :------------- | :-------------- | :------ | :--------------------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2017    | Cordoba Licencia de Conducir (Driving License) |

### Formosa

| Type of ID     | Subtype of ID   | Version | Description                                    |
| :------------- | :-------------- | :------ | :--------------------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2024    | Formosa Licencia de Conducir / Driving License |

### Misiones

| Type of ID     | Subtype of ID   | Version | Description                                     |
| :------------- | :-------------- | :------ | :---------------------------------------------- |
| DriversLicense | DRIVERS_LICENSE | 2008    | Misiones Licencia de Conducir / Driving License |
| DriversLicense | DRIVERS_LICENSE | 2020    | Misiones Licencia de Conducir / Driving License |

### Río Negro

| Type of ID     | Subtype of ID   | Version | Description               |
| :------------- | :-------------- | :------ | :------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2020    | Rio Negro Driving License |

### San Luis

| Type of ID         | Subtype of ID       | Version | Description                                  |
| :----------------- | :------------------ | :------ | :------------------------------------------- |
| IdentificationCard | IDENTIFICATION_CARD | 2024    | San Luis Cedula de Identidad (Identity Card) |

### Yala

| Type of ID     | Subtype of ID   | Version | Description                                 |
| :------------- | :-------------- | :------ | :------------------------------------------ |
| DriversLicense | DRIVERS_LICENSE | 2023    | Yala Licencia de Conducir / Driving License |

## Bolivia (BOL)

| State | Type of ID         | Subtype of ID       | Version | Description                                                 |
| :---- | :----------------- | :------------------ | :------ | :---------------------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2013    | Licencia para Conducir (Driving License)                    |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Licencia para Conducir (Driving License)                    |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2025    | Licencia para Conducir (Driving License)                    |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2001    | Cedula de Identidad (Identity Card)                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2002    | Cedula de Identidad (Identity Card)                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2020    | Cedula de Identidad (Identity Card)                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2023    | Cedula de Identidad (Identity Card)                         |
| ALL   | MedicalCard        | MEDICAL_CARD        | 2010    | Medical Card                                                |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2010    | Passport                                                    |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Passport                                                    |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2021    | Cedula de Identidad de Extranjero (Foreigner Identity Card) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT    | 2024    | Cédula de Identidad de Extranjero (Residence Permit)        |
| ALL   | Visa               | VISA                | 2023    | Visa                                                        |

## Brazil (BRA)

### National IDs

| Type of ID        | Subtype of ID                     | Version | Description                                                                                     |
| :---------------- | :-------------------------------- | :------ | :---------------------------------------------------------------------------------------------- |
| DriversLicense    | DRIVERS_LICENSE                   | 2019    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DRIVERS_LICENSE                   | 2023    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DRIVER_LICENSE                    | 2002    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DRIVER_LICENSE                    | 2005    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DRIVER_LICENSE                    | 2018    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DIGITAL_DRIVERS_LICENSE_PDF       | 2020    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | DRIVER_LICENSE                    | 2022    | Carteira Nacional de Habilitação (Nation Wide Drivers License)                                  |
| DriversLicense    | INTERNATIONAL_DRIVERS_LICENSE     | 2024    | International Driver License                                                                    |
| Other             | BIRTH_CERTIFICATE                 | 2009    | Certidão de Nascimento (Birth Certificate)                                                      |
| Other             | BIRTH_CERTIFICATE                 | 2010    | Certidão de Nascimento (Birth Certificate)                                                      |
| Other             | BIRTH_CERTIFICATE                 | 2011    | Certidão de Nascimento (Birth Certificate)                                                      |
| Other             | BIRTH_CERTIFICATE                 | 2013    | Certidão de Nascimento (Birth Certificate)                                                      |
| Other             | FIREFIGHTER_IDENTIFICATION_CARD   | 2010    | Carteira de Identidade - Corpo de Bombeiros Militar (Identity Card - Military Fire Department)  |
| Other             | FIREFIGHTER_IDENTIFICATION_CARD   | 2011    | Carteira de Identidade - Corpo de Bombeiros Militar (Identity Card - Military Fire Department)  |
| Other             | WORK_AND_SOCIAL_SECURITY_REGISTRY | 2009    | Carteira de Trabalho e Previdência Social (Work Card and Social Security)                       |
| Other             | WORK_AND_SOCIAL_SECURITY_REGISTRY | 2010    | Carteira de Trabalho e Previdência Social (Work Card and Social Security)                       |
| Other             | REFUGEE_IDENTIFICATION_CARD       | 2010    | Refugee Identification Card                                                                     |
| Passport          | NATIONAL_PASSPORT                 | 2010    | Passaporte (Passport)                                                                           |
| Passport          | NATIONAL_PASSPORT                 | 2011    | Passaporte (Passport)                                                                           |
| Passport          | NATIONAL_PASSPORT                 | 2015    | Passaporte (Passport)                                                                           |
| Passport          | NATIONAL_PASSPORT                 | 2018    | Passaporte (Passport)                                                                           |
| Passport          | NATIONAL_PASSPORT                 | 2023    | Passaporte  (Passport)                                                                          |
| ResidenceDocument | CONSULAR_IDENTIFICATION_CARD      | 2017    | Carteira de Matricula Consular (Consular ID Card)                                               |
| ResidenceDocument | MIGRATORY_REGISTER                | 2011    | Documento Provisório de Registro Nacional Migratório (National Migration Registration Document) |
| ResidenceDocument | MIGRATORY_REGISTER                | 2012    | Carteira de Registro Nacional Migratório (National Migration Registration Card)                 |
| ResidenceDocument | MIGRATORY_REGISTER                | 2013    | Carteira de Registro Diplomático (Diplomatic Registration Card)                                 |
| ResidenceDocument | RESIDENCE_PERMIT                  | 2000    | Cedula de identidade de estrangeiro (Foreigner Identity Card)                                   |
| ResidenceDocument | RESIDENCE_PERMIT                  | 2019    | Carteira de Registro Nacional Migratório (National Migration Registration Card)                 |
| Visa              | VISA                              | 2012    | Visa                                                                                            |

### Federal Professional Identity Cards

| Type of ID | Subtype of ID                | Version | Description                                                                                                               |
| :--------- | :--------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------ |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1844    | Identidade Funcional / Functional Identity Card                                                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1845    | Carteira de Identidade Funcional / Functional Identity Card                                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1848    | Cedula de Identidade Profissional (Professional Identity Card)                                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1849    | Cedula de Identidade Profissional (Professional Identity Card)                                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1853    | Carteira de Identidade de Procurador do estado de Santa Catarina (Professional Identity Card for attorneys)               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1855    | Carteira de Identidade Profissional (Professional Identity Card for industrial technicians)                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1857    | Identidade Funcional de Vereador / Professional Identity Card of Councilor                                                |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1858    | Carteira de Identidade Profissional (Professional Identity Card for accountants)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1859    | Carteira de Identidade Profissional (Professional Identity Card)                                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1861    | JETHRO International Chaplain Card                                                                                        |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1864    | Estado do Tocantins Carteira de identidade Funcional / Domestic Identification Card                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1865    | Cartão do Senador da Republica / Republic Senator Card                                                                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1866    | Carteira de Identidade Profissional (Professional Identity Card for employees in Ministry of Finance)                     |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1871    | Carteira de Identidade Parlamentar / Identity Card for employees in Parliament                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1872    | Carteira de Identidade Profissional (Professional Identity Card for people who work in finance)                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1873    | Cedula de Identidade Profissional (Professional Identity Card)                                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1878    | Carteira de Identidade Profissional (Professional Identity Card for economists)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1879    | Carteira de Identidade Profissional (Professional Identity Card for judges)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1881    | Carteira de Identidade Profissional (Professional Identity Card for judges)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1883    | Carteira de Identidade Profissional (Professional Identity Card for inspectors)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1885    | Carteira de Identidade Profissional (Professional Identity Card for physiotherapist)                                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1887    | Carteira de Identidade Profissional (Professional Identity Card for researchers)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1889    | Carteira de Identidade Profissional (Professional Identity Card for opticians)                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1891    | Carteira de Identidade Profissional (Professional Identity Card)                                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1893    | Carteira de Identidade Profissional (Professional Identity Card for real estate brokers)                                  |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1894    | Carteira de Identidade Profissional (Professional Identity Card for representatives)                                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1896    | Carteira de Identidade Profissional (Professional Identity Card for judicial technicians)                                 |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1897    | Carteira de Identidade Profissional (Professional Identity Card for judges)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1900    | Carteira de Identidade Profissional (Professional Identity Card for attorneys)                                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1902    | Carteira de Identidade Profissional (Professional Identity Card for pilots)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1903    | Cedula de Identidade / Domestic Identification Card                                                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1904    | Carteira de Identidade Profissional COFECI-CRECI (Professional Identity Card for real estate agents)                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1905    | Identidade Funcional / Functional Identity Card                                                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1906    | Identidade Funcional / Functional Identity Card                                                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1907    | Carteira de Identidade Profissional (Professional Identity Card for real estate agents)                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1908    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1909    | Carteira de Identidade Profissional  (Biologist Professional Identity Card)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1910    | Carteira de Identidade Profissional (Professional Identity Card for professors)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1911    | Carteira de Identidade Profissional (Administrators Professional Identity Card)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1912    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1913    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1914    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1915    | Carteira de Identidade Profissional  (Professional Identity Card for judiciary)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1916    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1917    | Carteira de Habilitação de Amador (Amateur Driving License)                                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1918    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1919    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1920    | Carteira de Identidade Profissional  (Professional Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1921    | Carteira de Identidade Profissional CRECI (Professional Identity Card for real estate agents)                             |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1922    | Carteira de Identidade Profissional  (Professional Identity Card for judiciary)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1923    | Carteira de Identidade Profissional  (Professional Identity Card for advocates)                                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1925    | Carteira de Identidade Profissional CFBM (Biomedicine Professional Identity Card)                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1926    | Carteira de Identidade Profissional (Professional Identity Card for judges)                                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1929    | Carteira de Identidade Profissional CRP (Professional Identity Card for Psychologists)                                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1930    | Carteira de Identidade Profissional INEP (Professional Identity Card)                                                     |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1931    | Carteira de Identidade Profissional CRECI (Professional Identity Card for real estate agents)                             |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1932    | Carteira de Identidade Profissional CRCSP (Professional Identity Card)                                                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1933    | Carteira de Identidade Profissional - Tribunal de justiça de Minas Gerais (Professional Identity Card)                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1934    | Carteira de Identidade Profissional CRBio (Biologist Professional Identity Card)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1939    | Carteira de Identidade Profissional CREFITO (Physiotherapist Professional Identity Card)                                  |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1943    | Carteira de Identidade Profissional (Professional Identity Card)                                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1944    | Carteira de Identidade Profissional (Professional Identity Card)                                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1945    | Carteira de Identidade Profissional - FENAJ  (Professional Identity Card for journalists)                                 |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1951    | Carteira de Identidade Profissional (Professional Identity Card)                                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1955    | Carteira Nacional de Vigilante - CNV (National Security Guard Card)                                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1956    | Carteira de Identidade Profissional - CRA  (Professional Identity Card for administrators)                                |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1958    | FUNAI - National Indian Foundation card                                                                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1960    | Carteira de Identidade Indígena - FUNAI (Indigenous Identity Card)                                                        |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1961    | Carteira de Identidade de Contabilista (Accountant Identity Card)                                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1962    | Carteira de Identidade Profissional  (Professional Identity Card for those working in the Ministry of Education)          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1963    | Carteira de Identidade Profissional COFEN (Professional Identity Card for nursing technicians)                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1964    | Carteira de Identidade Profissional CFQ (Professional Identity Card for chemists)                                         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1966    | Carteira de Identidade Profissional  (Professional Identity Card for judicial technicians)                                |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1967    | Carteira de Identidade Profissional  (Professional Identity Card for radiology technician)                                |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1971    | Carteira de Identidade Profissional (Professional Identity Card for Psychologists)                                        |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1972    | Carteira de Identidade Profissional CROSP (Professional Identity Card for Dentists)                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1978    | Carteira de Identidade Profissional CFM (Professional Identity Card for doctors)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1979    | Carteira de Identidade Profissional CONFEA (Professional Identity Card for engineers, architects and agronomists)         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1980    | Carteira de Identidade Profissional CAU (Professional Identity Card for architects and urban planners)                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1981    | Cedula de Identidade de Medico (Doctor's Identity Card)                                                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1982    | Carteira de Identidade Profissional COFEN (Professional Identity Card for nursing technicians)                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1983    | Carteira de Identidade Profissional CFMV (Professional Identity Card for veterinarians)                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1984    | Carteira de Identidade Profissional COFEN (Professional Identity Card for nursing assistants)                             |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1985    | Carteira de Identidade de doador de órgãos e tecidos (Organ and tissue donor Identity Card)                               |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1986    | Carteira de Identidade Profissional CFA (Administrators Professional Identity Card)                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1987    | Carteira de Identidade Profissional CBMDF (Identity Card of the Federal District Military Fire Department)                |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1988    | Carteira de Identidade Profissional COFEN (Professional Identity Card for experts)                                        |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1989    | Carteira de Identidade Profissional CRESS (Professional Identity Card for social workers)                                 |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1990    | Carteira de Identidade Profissional CREFONO (Professional Identity Card for speech therapists)                            |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1991    | Carteira de Identidade Profissional CFF (Professional Identity Card for pharmacists)                                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1992    | Carteira de Identidade Profissional CFO (Professional Identity Card for odontologist)                                     |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1994    | Carteira de Identidade Profissional CRTR (Professional Identity Card for radiology technicians)                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1995    | Carteira de Identidade Profissional COFECI-CRECI (Professional Identity Card for real estate agents)                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1996    | Carteira de Identidade Profissional CFP (Professional Identity Card for psychologists)                                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1997    | Carteira de Identidade Profissional CRP (Professional Identity Card for psychologists)                                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1998    | Carteira de Identidade Profissional CFMV (Professional Identity Card for veterinarians)                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 1999    | Carteira de Identidade Profissional CRTR (Professional Identity Card for radiology technicians)                           |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2000    | Carteira de Identidade Profissional CONFEA (Professional Identity Card for engineers, architects and agronomists)         |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2001    | Carteira de Identidade Profissional CFM (Professional Identity Card for doctors)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2002    | Carteira de Identidade Profissional COFECI-CRECI (Professional Identity Card for real estate agents)                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2003    | Carteira de Identidade Profissional OAB (Professional Identity Card for lawyers)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2004    | Carteira de Identidade Profissional OAB (Professional Identity Card for lawyers)                                          |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2005    | Carteira de Identidade Profissional CRC (Professional Identity Card for accounting)                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2006    | Carteira de Identidade Profissional COFEN (Professional Identity Card for nurses and nursing technicians)                 |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2007    | Carteira de Identidade Profissional CFBM (Professional Identity Card for nurses and biomedical sciences)                  |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2012    | Carteira de Identidade Profissional CREFITO (Professional Identity Card for physiotherapists and occupational therapists) |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2015    | Carteira de Identidade Profissional CAU (Professional Identity Card for architects and urban planners)                    |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2016    | Carteira de Identidade Profissional CRESS (Professional Identity Card for social workers)                                 |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2018    | Carteira de identidade Funcional - Ministerio da Saude (Identity Card for Ministry of Health workers)                     |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2019    | Carteira de Identidade Profissional CRA (Administrators Professional Identity Card)                                       |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2020    | Carteira de Identidade Profissional CFF (Professional Identity Card for pharmacists)                                      |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2021    | Carteira de Identidade Profissional CONFEA (Professional Identity Card for engineers and agronomists)                     |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2023    | Carteira de Identidade Profissional CFMV (Professional Identity Card for veterinarians)                                   |
| FederalID  | DOMESTIC_IDENTIFICATION_CARD | 2024    | Carteira de Identidade Profissional CFM (Professional Identity Card for doctors)                                          |

### Federal Police Identity Cards

| Type of ID | Subtype of ID              | Version | Description                                                                                                                 |
| :--------- | :------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------- |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1949    | Police Identity Card                                                                                                        |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1951    | Guarda Civil Municipal / Police Identity Card                                                                               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1952    | Polícia Legislativa Federal / Police Identity Card                                                                          |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1954    | Policial Legislativo Federal / Police Identity Card                                                                         |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1958    | Polícia Militar Identidade Funcional / Police Identity Card                                                                 |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1960    | Guarda Civil Municipal / Police Identity Card                                                                               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1961    | Policia Civil Certificado Digital / Civil Police Digital Certificate                                                        |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1965    | Guarda Civil Carteira de Identidade Funcional / Police Identity Card                                                        |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1967    | Policia Civil Documento de Identidade Funcional / Civil Police Identity Card                                                |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1969    | Estado de Mato Grosso do Sol Policia Civil Identidade / Police Identification Card                                          |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1972    | Campo Grande Guarda Civil Metropolitana / Police Identification Card                                                        |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1973    | Estado de Minas Gerais Policia Civil Identidade Funcional / Police Identification Card                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1974    | Estado de Minas Gerais Identidade Funcional / Police Identification Card                                                    |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1976    | Policia Civil Delegado / Police Identification Card                                                                         |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1977    | Polícia Militar Carteira de Identidade / Military Police Identity Card                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1981    | Polícia Rodoviária Federal (Federal Highway Police Identification Card)                                                     |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1984    | Polícia Militar Carteira de Identidade / Military Police Identity Card                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1985    | Carteira de Identidade Policia Militar / Police Identity Card                                                               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1987    | Polícia Militar Carteira de Identidade / Police Identity Card                                                               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1990    | Carteira de Identidade Policia Militar - Estado de Mato Grosso (Military Police Identity Card - State Mato Grosso)          |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1991    | Police Identification Card                                                                                                  |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1992    | Carteira de Identidade Policia Militar - Estado de Maranhão (Military Police Identity Card - State of Maranhão)             |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1993    | Carteira de Identidade Policia Militar - Estado de Alagoas (Military Police Identity Card - State of Alagoas)               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1994    | Carteira de Identidade Policia Militar - Estado de São Paulo (Military Police Identity Card - State of São Paulo)           |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1995    | Carteira de Identidade Policia Militar - Estado de Roraima (Military Police Identity Card - State of Roraima)               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1996    | Carteira de Identidade Policia Militar - Estado de Pará (Military Police Identity Card - State of Pará)                     |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1997    | Carteira de Identidade Policia Militar - Estado de Espirito Santo (Military Police Identity Card - State of Espirito Santo) |
| FederalID  | POLICE_IDENTIFICATION_CARD | 1998    | Carteira de Identidade Policia Militar - Estado do Acre (Military Police Identity Card - State of Acre)                     |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2001    | Carteira de Identidade Policia Militar - Estado de Paraná (Military Police Identity Card - State of Paraná)                 |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2002    | Carteira de Identidade Policia Militar - Estado do Paraíba (Military Police Identity Card - State of Paraíba)               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2004    | Carteira Nacional de Vigilante (Police Identification Card)                                                                 |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2005    | Carteira de Identidade Policia Militar (Military Police Identity Card)                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2006    | Polícia Militar / Police Identity Card                                                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2007    | Carteira de Identidade Policia Militar (Military Police Identity Card)                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2010    | Carteira de Identidade Policia Militar (Military Police Identity Card)                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2013    | Carteira de Identidade Policia Civil (Civil Police Identity Card)                                                           |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2014    | Carteira de Identidade Policia GOIAS (GOIAS Police Identity Card)                                                           |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2015    | Carteira de Identidade Policia Militar (Military Police Identity Card)                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2016    | Carteira de Identidade Funcional - BRIGADA MILITAR (Military Brigade Identity Card)                                         |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2017    | Carteira de Identidade Policia Militar - Estado do Paraíba (Military Police Identity Card - State of Paraíba)               |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2018    | Identidade Funcional - POLICIA MILITAR (Military Police Identity Card)                                                      |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2019    | Carteira de Identidade - POLICIA MILITAR (Military Police Identity Card)                                                    |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2020    | Carteira de Identidade - POLICIA MILITAR (Military Police Identity Card)                                                    |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2021    | Guarda Municipal Carteira de Idenitdade (Municipal Guard Identity Card)                                                     |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2022    | Carteira de Identidade - POLICIA MILITAR (Military Police Identity Card)                                                    |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2023    | Carteira de Identidade - Policia Militar de Minas Gerais (Identity Card - Military Police of Minas Gerais)                  |
| FederalID  | POLICE_IDENTIFICATION_CARD | 2025    | Polícia Penal Identidade Funcional / Police Identity Card                                                                   |

### Federal Military Identity Cards

| Type of ID | Subtype of ID                | Version | Description                                                                                    |
| :--------- | :--------------------------- | :------ | :--------------------------------------------------------------------------------------------- |
| FederalID  | AIRFORCE_IDENTIFICATION_CARD | 2014    | Carteira de Identidade Militar (Military Identity Card)                                         |
| FederalID  | AIRFORCE_IDENTIFICATION_CARD | 2015    | Carteira de Identidade Militar (Military Identity Card)                                         |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2001    | Carteira de Identidade - Corpo de Bombeiros Militar (Military Identity Card)                   |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2004    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2005    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2006    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2007    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2010    | Carteira de identidade do exercito (Military Identity Card)                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2011    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2012    | Corpo de Bomberios Militar Identidade Funcional / Military Identity Card                        |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2013    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2015    | Military Identity Card                                                                         |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2017    | Military Identification Card                                                                    |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2020    | Carteira de Identidade Militar (Military Identity Card)                                        |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2021    | Bombeiro Militar Identidade Funcional / Military Identity Card                                  |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2022    | Carteira de Identidade Militar (Military Identity Card)                                        |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2023    | Carteira de Identidade Militar (Military Identity Card)                                        |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2024    | Carteira de Identidade - Corpo de Bombeiros Militar (Identity Card - Military Fire Department) |
| FederalID  | MILITAR_IDENTIFICATION_CARD  | 2025    | Carteira de Identidade - Corpo de Bombeiros Militar (Military Identity Card)                   |
| FederalID  | MILITAR_SERVICE_CARD         | 2010    | Certificado de Dispensa de Incorporacao (Certificate of exemption from incorporation)          |
| FederalID  | NAVY_IDENTIFICATION_CARD     | 1990    | Cartao de Identificacao da Marina (Navy Identity Card)                                         |
| FederalID  | NAVY_IDENTIFICATION_CARD     | 2000    | Cartao de Identificacao da Marina (Navy Identity Card)                                         |

### Federal Other IDs

| Type of ID | Subtype of ID                   | Version | Description                                                                                               |
| :--------- | :------------------------------ | :------ | :-------------------------------------------------------------------------------------------------------- |
| FederalID  | DIGITAL_IDENTIFICATION_CARD_PDF | 2024    | Federal Digital Identification Card                                                                       |
| FederalID  | DIGITAL_IDENTIFICATION_CARD_PDF | 2025    | Federal Digital Identification Card                                                                       |
| FederalID  | DIGITAL_IDENTIFICATION_CARD_PDF | 2026    | Federal Digital Identification Card                                                                       |
| FederalID  | DIGITAL_IDENTITY_CARD           | 2021    | Carteira Nacional de Habilitação (Digital Identity Card)                                                  |
| FederalID  | DISABILITY_IDENTIFICATION_CARD  | 2024    | Disability Identification Card                                                                            |
| FederalID  | FEDERAL_IDENTIFICATION          | 2000    | Carteira de Identidade Federal (Federal Identity Card)                                                    |
| FederalID  | IDENTIFICATION_CARD             | 2000    | Carteira Especial de Identidade (Special Identity Card)                                                   |
| FederalID  | IDENTIFICATION_CARD             | 2001    | Titulo Eleitoral (Voter Registration Card)                                                                |
| FederalID  | IDENTIFICATION_CARD             | 2002    | Estado De Rio de Janeiro - Cedula de Identidade (State Rio de Janeiro - Identification Card)              |
| FederalID  | IDENTIFICATION_CARD             | 2004    | Carteira de Identidade Profissional COFEN (Professional Identity Card for nurses and nursing technicians) |
| FederalID  | IDENTIFICATION_CARD             | 2013    | Carteira de Identidade de Contabilista CRC (Accountant Identity Card)                                     |
| FederalID  | IDENTIFICATION_CARD             | 2019    | Carteira de Identidade Federal (Federal Identity Card)                                                    |
| FederalID  | IDENTIFICATION_CARD             | 2020    | Carteira de Identidade Federal (Federal Identity Card)                                                    |
| FederalID  | IDENTIFICATION_CARD             | 2021    | Cedula de Identidade Profissional CREF (Professional Identity Card for physicists)                        |
| FederalID  | IDENTIFICATION_CARD             | 2022    | Carteira de Identidade - Estado de Mato Grosso (Mato Grosso Identity Card)                                |
| FederalID  | IDENTIFICATION_CARD             | 2024    | Estado De Mato Grosso - Carteira de Identidade (State Mato Grosso - Identification Card)                  |
| FederalID  | TAX_IDENTIFICATION              | 2000    | Cadastro de Pessoas Físicas (Taxpayer Registry Identification)                                            |
| FederalID  | TAX_IDENTIFICATION              | 2009    | Cadastro de Pessoas Físicas (Taxpayer Registry Identification)                                            |
| FederalID  | TAX_IDENTIFICATION              | 2010    | Comprovante de Inscrição CPF (Proof of CPF Registration)                                                  |
| FederalID  | TAX_IDENTIFICATION              | 2011    | Cadastro de Pessoas Físicas (Taxpayer Registry Identification)                                            |

## Chile (CHL)

| State | Type of ID         | Subtype of ID       | Version | Description                                                                                 |
| :---- | :----------------- | :------------------ | :------ | :------------------------------------------------------------------------------------------ |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2000    | Licencia de Conductor (Driving License)                                                     |
| ALL   | DriversLicense     | DRIVER_LICENSE      | 2019    | Licencia de Conductor / Driving License                                                     |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2000    | Identification Personal - Cedula de Ciudadania (Personal Identification - Citizenship Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2007    | Cedula de Identidad (Identity Card)                                                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2013    | Cedula de Identidad (Identity Card)                                                         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2024    | Cedula de Identidad (Identity Card)                                                         |
| ALL   | ResidenceDocument  | RESIDENCE_DOCUMENT  | 2025    | Cédula de Identidad Extranjero (Residence Document)                                         |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2013    | Pasaporte (Passport)                                                                        |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2025    | Pasaporte / National Passport                                                               |
| ALL   | Passport           | EMERGENCY_PASSPORT  | 2022    | Pasaporte de Emergencia (Emergency Passport)                                                |
| ALL   | Visa               | VISA                | 2019    | Visa                                                                                        |

## Colombia (COL)

| State | Type of ID         | Subtype of ID               | Version | Description                                                   |
| :---- | :----------------- | :-------------------------- | :------ | :------------------------------------------------------------ |
| ALL   | DriversLicense     | DRIVER_LICENSE              | 2000    | Drivers License                                               |
| ALL   | DriversLicense     | DRIVER_LICENSE              | 2012    | Drivers License                                               |
| ALL   | DriversLicense     | DRIVER_LICENSE              | 2013    | Drivers License                                               |
| ALL   | DriversLicense     | DRIVER_LICENSE              | 2024    | Licencia de Conducción (Driving License)                      |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2000    | Cédula de Ciudadanía                                          |
| ALL   | IdentificationCard | MINORS_ID                   | 2008    | Tarjeta de Identidad (Minors Identity Card)                   |
| ALL   | IdentificationCard | IDENTIFICATION_CARD         | 2020    | Cédula de Ciudadanía                                          |
| ALL   | IdentificationCard | DIPLOMATIC_IDENTIFICATION_CARD | 2023    | Diplomatic Identification Card                                |
| ALL   | Military           | MILITARY_CARD               | 2010    | Ministerio de Defensa Nacional                                |
| ALL   | Military           | MILITARY_CARD               | 2018    | Military Card                                                 |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2007    | Passport                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2015    | Passport                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2018    | Passport                                                      |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2024    | Pasaporte / Passport                                          |
| ALL   | Passport           | NATIONAL_PASSPORT           | 2026    | Pasaporte / Passport                                          |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT            | 2000    | Cédula de Extranjería                                         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT            | 2014    | Cédula de Extranjería                                         |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT            | 2020    | Permiso por Protección Temporal                               |
| ALL   | ResidenceDocument  | IMMIGRATION_CARD            | 2014    | Cedula de Extranjeria (Foreigner ID)                          |
| ALL   | ResidenceDocument  | IMMIGRATION_CARD            | 2015    | Cedula de Extranjería (Immigration Card)                      |
| ALL   | ResidenceDocument  | PEP_TUTOR                   | 2026    | Permiso por Protección Temporal - Tutor                       |
| ALL   | ResidenceDocument  | TEMPORARY_PROTECTION_PERMIT | 2020    | Permiso por Proteccion Temporal (Temporary Protection Permit) |
| ALL   | TravelDocument     | CONSULAR_CARD               | 2023    | Registro Consular / Consular Registration Card                |
| ALL   | Visa               | VISA                        | 2010    | Visa                                                          |
| ALL   | Visa               | VISA                        | 2017    | Visa                                                          |
| ALL   | Visa               | ELECTRONIC_VISA             | 2023    | Electronic Visa                                               |
| ALL   | MedicalCard        | HEALTH_CARD                 | 2022    | Carné de Servicios de Salud / Health Card                     |

## Ecuador (ECU)

| State | Type of ID          | Subtype of ID              | Version | Description                             |
| :---- | :------------------ | :------------------------- | :------ | :-------------------------------------- |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2015    | Licencia de Conducir (Driver's License) |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2018    | Licencia de Conducir (Driver's License) |
| ALL   | DriversLicense      | DRIVERS_LICENSE            | 2019    | Licencia de Conducir (Driver's License) |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD        | 2000    | Cedula de Ciudadania (Identity Card)    |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD        | 2011    | Cedula de Ciudadania (Identity Card)    |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD        | 2020    | Cedula de Identidad (Identity Card)     |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD        | 2021    | Cedula de Ciudadania (Identity Card)    |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD | 2020    | Police Identification Card              |
| ALL   | IdentificationCard  | POLICE_IDENTIFICATION_CARD | 2021    | Police Identification Card              |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD  | 2024    | Voter Identification Card               |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD  | 2025    | Voter Identification Card               |
| ALL   | Military            | MILITARY_CARD              | 2023    | Military Card                           |
| ALL   | Military            | MILITARY_CARD              | 2024    | Military Card                           |
| ALL   | Passport            | NATIONAL_PASSPORT          | 2015    | Pasaporte (Passport)                    |
| ALL   | Passport            | NATIONAL_PASSPORT          | 2020    | Pasaporte (Passport)                    |
| ALL   | TravelDocument      | CONSULAR_ID_CARD           | 2024    | Consular Identity Card                  |
| GALAPAGOS_ISLANDS | ResidenceDocument   | RESIDENCE_PERMIT           | 2026    | Galapagos Islands Residence Permit      |

## Guyana (GUY)

| State | Type of ID         | Subtype of ID       | Version | Description                |
| :---- | :----------------- | :------------------ | :------ | :------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2010    | Driver's License           |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2019    | Driver License             |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2006    | Guyana Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2017    | Guyana Identification Card |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2025    | Guyana Identification Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2014    | Passport                   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Passport                   |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2025    | Passport                   |

## Paraguay (PRY)

| State | Type of ID         | Subtype of ID              | Version | Description                                     |
| :---- | :----------------- | :------------------------- | :------ | :---------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE            | 2017    | Licencia de Conducir (Driver's License)         |
| ALL   | DriversLicense     | DRIVERS_LICENSE            | 2026    | Licencia de Conducir (Driver's License)         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD        | 2008    | Cedula de Identidad Civil (Civil Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD        | 2018    | Cedula de Identidad Civil (Civil Identity Card) |
| ALL   | IdentificationCard | IDENTIFICATION_CARD        | 2023    | Cedula de Identidad Civil (Civil Identity Card) |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT           | 2020    | Residence Permit                                |
| ALL   | ResidenceDocument  | RESIDENCE_PERMIT           | 2024    | Residence Permit                                |
| ALL   | ResidenceDocument  | TEMPORARY_RESIDENCE_PERMIT | 2025    | Temporary Residence Permit                      |
| ALL   | Passport           | NATIONAL_PASSPORT          | 2012    | Pasaporte (Passport)                            |
| ALL   | Passport           | NATIONAL_PASSPORT          | 2014    | Pasaporte (Passport)                            |
| ALL   | Passport           | NATIONAL_PASSPORT          | 2023    | Pasaporte (Passport)                            |
| ALL   | TravelDocument     | CONSULAR_CARD              | 2020    | Consular Card                                   |

## Peru (PER)

### National IDs

| Type of ID         | Subtype of ID               | Version | Description                                                  |
| :----------------- | :-------------------------- | :------ | :----------------------------------------------------------- |
| IdentificationCard | IDENTIFICATION_CARD         | 2000    | Documento Nacional de Identidad (Identity Card)              |
| IdentificationCard | IDENTIFICATION_CARD         | 2001    | Documento Nacional de Identidad (Identity Card)              |
| IdentificationCard | IDENTIFICATION_CARD         | 2013    | Documento Nacional de Identidad (Identity Card)              |
| IdentificationCard | IDENTIFICATION_CARD         | 2020    | Documento Nacional de Identidad (Identity Card)              |
| IdentificationCard | IDENTIFICATION_CARD         | 2025    | Identification Card                                          |
| IdentificationCard | REFUGEE_IDENTIFICATION_CARD | 2019    | Carne de Solicitante de Refugio (Refugee Identity Card)      |
| Military           | MILITARY_CARD               | 2009    | Military Card                                                |
| Military           | MILITARY_CARD               | 2011    | Military Card                                                |
| Military           | MILITARY_CARD               | 2015    | Carnet de Tropa Servicio Militar / Military Card             |
| Military           | MILITARY_CARD               | 2016    | Military Card                                                |
| Military           | MILITARY_CARD               | 2017    | Military Card                                                |
| Military           | MILITARY_CARD               | 2018    | Military Card                                                |
| Military           | MILITARY_CARD               | 2019    | Military Card                                                |
| Military           | MILITARY_CARD               | 2020    | Military Card                                                |
| Military           | MILITARY_CARD               | 2021    | Military Card                                                |
| Military           | MILITARY_CARD               | 2022    | Military Card                                                |
| Military           | MILITARY_CARD               | 2025    | Military Card                                                |
| Military           | MILITARY_CARD               | 2026    | Military Card                                                |
| Passport           | NATIONAL_PASSPORT           | 2000    | Pasaporte (Passport)                                         |
| Passport           | NATIONAL_PASSPORT           | 2014    | Pasaporte (Passport)                                         |
| Passport           | NATIONAL_PASSPORT           | 2016    | Pasaporte (Passport)                                         |
| ResidenceDocument  | RESIDENCE_PERMIT            | 2000    | Residence Permit                                             |
| ResidenceDocument  | RESIDENCE_PERMIT            | 2017    | Carné de Extranjería (Foreigner Identity Card)               |
| ResidenceDocument  | RESIDENCE_PERMIT            | 2021    | Carné de Extranjería (Foreigner Identity Card)               |
| ResidenceDocument  | TEMPORAL_RESIDENCE_PERMIT   | 2018    | Permiso Temporal de Permanencia (Temporary Residence Permit) |
| ResidenceDocument  | TEMPORAL_RESIDENCE_PERMIT   | 2020    | Carné Temporal de Permanencia (Temporary Residence Card)     |
| TravelDocument     | CONSULAR_CARD               | 2020    | Consular Card                                                |
| Visa               | VISA                        | 2024    | Visa                                                         |

### Drivers Licenses

| Type of ID     | Subtype of ID              | Version | Description                                                                                             |
| :------------- | :------------------------- | :------ | :------------------------------------------------------------------------------------------------------ |
| DriversLicense | DRIVERS_LICENSE            | 1880    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1881    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1882    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1883    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1884    | Municipalidad Provincial de Azangaro Licencia de Conducir / Driving License                             |
| DriversLicense | DRIVERS_LICENSE            | 1885    | Municipalidad Provincial de Jauja Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 1889    | Licencia de Conducir (Municipalidad Provincia de Canta) / Driver License                                |
| DriversLicense | DRIVERS_LICENSE            | 1890    | Municipalidad Provincial de Chupaca Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 1892    | Municipalidad Provincial de Cutervo Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 1893    | Municipalidad Provincial de Puno Licencia de Conducir / Driving License                                 |
| DriversLicense | DRIVERS_LICENSE            | 1896    | Municipalidad Provincial de Chiclayo Licencia de Conducir / Driving License                             |
| DriversLicense | DRIVERS_LICENSE            | 1897    | Municipalidad Provincial de la Convencion Licencia de Conducir / Driving License                        |
| DriversLicense | DRIVERS_LICENSE            | 1899    | Municipalidad Provincial de Paita Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 1901    | Municipalidad Provincial de Yauyos Licencia de Conducir / Driving License                               |
| DriversLicense | DRIVERS_LICENSE            | 1902    | Municipalidad Provincial de Tambopata Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1903    | Municipalidad Provincial Sánchez Carrión Licencia de Conducir / Driving License                         |
| DriversLicense | DRIVERS_LICENSE            | 1904    | Municipalidad Provincial de Dos de Mayo Licencia de Conducir / Driving License                          |
| DriversLicense | DRIVERS_LICENSE            | 1905    | Municipalidad Provincial de Huamalies Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1906    | Municipalidad Provincial de Cajamarca Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1907    | Municipalidad Provincial de Andahuaylas Licencia de Conducir / Driving License                          |
| DriversLicense | DRIVERS_LICENSE            | 1910    | Municipalidad Provincial de Acobamba Licencia de Conducir / Driving License                             |
| DriversLicense | DRIVERS_LICENSE            | 1911    | Municipalidad Provincial de Chepén Licencia de Conducir / Driving License                               |
| DriversLicense | DRIVERS_LICENSE            | 1912    | Municipalidad Provincial de Canta Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 1914    | Provincia de Mariscal Caceres - Juanjui Licencia de Conducir / Driving License                          |
| DriversLicense | DRIVERS_LICENSE            | 1915    | Municipalidad Provincial de la Mar San Miguel Licencia de Conducir / Driving License                    |
| DriversLicense | DRIVERS_LICENSE            | 1918    | Municipalidad Provincial de Zarumilla Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1920    | Municipalidad Provincial de Contralmirante Villar Licencia de Conducir / Driving License                |
| DriversLicense | DRIVERS_LICENSE            | 1921    | Municipalidad Provincial de Padre Abad Licencia de Conducir / Driving License                           |
| DriversLicense | DRIVERS_LICENSE            | 1922    | Municipalidad Provincial de Utcubamba Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1923    | Municipalidad Provincial de Ayabaca Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 1924    | Municipalidad Provincial de Condesuyos Licencia de Conducir / Driving License                           |
| DriversLicense | DRIVERS_LICENSE            | 1925    | Municipalidad Provincial de Paucartambo Licencia de Conducir / Driving License                          |
| DriversLicense | DRIVERS_LICENSE            | 1926    | Municipalidad Provincial de Satipo Licencia de Conducir / Driving License                               |
| DriversLicense | DRIVERS_LICENSE            | 1928    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Pallasca Cabana) / Driving License  |
| DriversLicense | DRIVERS_LICENSE            | 1929    | Licencia de Conducir (Municipalidad Provincial de Oxapampa) / Driving License                           |
| DriversLicense | DRIVERS_LICENSE            | 1930    | Licencia de Conducir (Lamas) / Driving License                                                          |
| DriversLicense | DRIVERS_LICENSE            | 1932    | Municipalidad Provincial de Palpa - Ica Licencia de Conducir / Driving License                          |
| DriversLicense | DRIVERS_LICENSE            | 1933    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1934    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1936    | Municipalidad Provincial de Pisco Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 1937    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Ascope) / Driving License           |
| DriversLicense | DRIVERS_LICENSE            | 1938    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1939    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1941    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1942    | Municipalidad Provincial de Chincha Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 1943    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1944    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Coronel Portillo) / Driving License |
| DriversLicense | DRIVERS_LICENSE            | 1945    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1947    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1948    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1949    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1950    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1951    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1953    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1955    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1956    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Camana) / Driving License           |
| DriversLicense | DRIVERS_LICENSE            | 1957    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1958    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1959    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1960    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1961    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1962    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1963    | Municipalidad Provincial de Chucuito - Juli Licencia de Conducir / Driving License                      |
| DriversLicense | DRIVERS_LICENSE            | 1964    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1965    | Municipalidad Provincial de Huanuco Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 1966    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1967    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1968    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1969    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1970    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1974    | Municipalidad Provincial de Rioja Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 1975    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1977    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1978    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1980    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Huaral) / Driving License           |
| DriversLicense | DRIVERS_LICENSE            | 1981    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1983    | Municipalidad Provincial de Antabamba Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 1985    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de la Convencion) / Driving License    |
| DriversLicense | DRIVERS_LICENSE            | 1988    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1989    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1990    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1991    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1993    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1995    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1997    | Licencia de Conducir (Driving License)                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 1998    | Licencia de Conducir Vehiculos Menores (Municipalidad Provincial de Tahuamanu) / Driving License        |
| DriversLicense | DRIVERS_LICENSE            | 1999    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2000    | Licencia de Conducir (Driver License)                                                                   |
| DriversLicense | DRIVERS_LICENSE            | 2002    | Licencia de Conducir Vehiculos Menores (Driver's License for Minor Vehicles)                            |
| DriversLicense | DRIVERS_LICENSE            | 2006    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2009    | Municipalidad Provincial de Atalaya Licencia de Conducir / Driving License                              |
| DriversLicense | DRIVERS_LICENSE            | 2010    | Municipalidad Provincial de Antabamba Licencia de Conducir / Driving License                            |
| DriversLicense | DRIVERS_LICENSE            | 2011    | Licencia de Conducir Vehiculos Menores (Driver's License for Minor Vehicles)                            |
| DriversLicense | DRIVERS_LICENSE            | 2012    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2013    | Municipalidad Provincial de Leoncio Prado Licencia de Conducir / Driving License                        |
| DriversLicense | DRIVERS_LICENSE            | 2015    | Municipalidad Provincial de Canta Licencia de Conducir / Driving License                                |
| DriversLicense | DRIVERS_LICENSE            | 2016    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2019    | Municipalidad Provincial de Maynas Licencia de Conducir / Driving License                               |
| DriversLicense | DRIVERS_LICENSE            | 2020    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2021    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2022    | Licencia de Conducir / Driving License                                                                  |
| DriversLicense | DRIVERS_LICENSE            | 2024    | Municipalidad Provincial de Ferreñafe Licencia de Conducir / Driving License                            |
| DriversLicense | ELECTRONIC_DRIVERS_LICENSE | 2019    | Licencia de Conducir Electrónica / Electronic Drivers License                                           |
| DriversLicense | ELECTRONIC_DRIVERS_LICENSE | 2020    | Licencia de Conducir Electrónica (Electronic Driver License)                                            |
| DriversLicense | ELECTRONIC_DRIVERS_LICENSE | 2024    | Licencia de Conducir Electronica / Electronic Driving License                                           |

## Suriname (SUR)

| State | Type of ID         | Subtype of ID       | Version | Description                  |
| :---- | :----------------- | :------------------ | :------ | :--------------------------- |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2019    | Identification Card          |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2018    | Rijbewijs (Driver's License) |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2021    | Driver License               |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2014    | Paspoort (Passport)          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2018    | Paspoort (Passport)          |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2026    | Paspoort (Passport)          |

## Uruguay (URY)

| State | Type of ID          | Subtype of ID             | Version | Description                                             |
| :---- | :------------------ | :------------------------ | :------ | :------------------------------------------------------ |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2000    | Licencia Nacional de Conductor (Driver License)         |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2014    | Licencia Nacional de Conductor / Driving License        |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2015    | Permiso Unico Nacional de Conduccion (Driver's License) |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2016    | Licencia Nacional de Conductor / Driving License        |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2017    | Licencia Nacional de Conductor / Driving License        |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2018    | Licencia de Conductor / Driving License                 |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2019    | Licencia Nacional de Conductor / Driving License        |
| ALL   | DriversLicense      | DRIVER_LICENSE            | 2023    | Driving License                                         |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2000    | Cedula de Identidad (Identity Card)                     |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2001    | Carteira de Identidade (Identity Card)                  |
| ALL   | IdentificationCard  | IDENTIFICATION_CARD       | 2026    | Carteira Nacional de Identidad (Identification Card)                  |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2014    | Pasaporte (Passport)                                    |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2015    | Pasaporte (Passport)                                    |
| ALL   | Passport            | NATIONAL_PASSPORT         | 2020    | Pasaporte (Passport)                                    |
| ALL   | Visa                | VISA                      | 2023    | Visa                                                    |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2008    | Carte Electoral (Voter Card)                            |
| ALL   | VoterIdentification | VOTER_IDENTIFICATION_CARD | 2010    | Cartao de Eleitor (Voter Card)                          |

## Venezuela (VEN)

| State | Type of ID         | Subtype of ID       | Version | Description                                      |
| :---- | :----------------- | :------------------ | :------ | :----------------------------------------------- |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2000    | Licencia para Conducir (Driver's License)        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2017    | Licencia para Conducir (Driver's License)        |
| ALL   | DriversLicense     | DRIVERS_LICENSE     | 2024    | Licencia para Conducir / Driving License         |
| ALL   | IdentificationCard | IDENTIFICATION_CARD | 2000    | Cedula de Identidad (Identity Card)              |
| ALL   | IdentificationCard | HOMELAND_CARD       | 2020    | Carnet de la Patria / Homeland Card              |
| ALL   | IdentificationCard | DISABILITY_IDENTIFICATION_CARD | 2020    | Disability Identification Card                   |
| ALL   | Military           | MILITARY_CARD       | 2020    | Fuerza Armada Nacional Bolivariana Military Card |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2000    | Pasaporte (Passport)                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2007    | Pasaporte (Passport)                             |
| ALL   | Passport           | NATIONAL_PASSPORT   | 2017    | Pasaporte (Passport)                             |
| ALL   | Visa               | VISA                | 2019    | Visa                                             |

---

- Path: `general-reference/supported-languages`
- URL: https://developer.incode.com/general-reference/supported-languages/
- Markdown: https://developer.incode.com/general-reference/supported-languages.md

# Supported Languages

## Out-of-the-Box Language Support

The Incode Platform (iOS, Android, and Web SDKs) officially supports **English&#x20;**`en`, **Spanish&#x20;**`es`, and **Portuguese&#x20;**`pt`**&#x20;**&#x6F;ut of the box. You can modify strings for each language in the SDKs; for more information and instructions, refer to customization pages for [iOS](/sdk-reference/ios-customization/#localize-display-text), [Android](/sdk-reference/android-customization/#localize-display-text), or [Web](/sdk-reference/web-sdk-2-theming/). Contact your Incode Representative to request Figma files that reflect how each of these languages is showcased in our end user verification journey.&#x20;

## Additional Language Support

For our Native SDKs (iOS and Android), you can provide the translations for additional languages that match the list of English text provided by Incode. The platform will work properly with your configured language.

For our Web SDK, Incode offers AI auto-translations for 50+ additional languages. These strings can be modified in the SDK. Refer to the following list for languages available via auto-translation:

- Amharic: `am`
- Arabic: `ar`
- Azerbaijani: `az`
- Bengali: `bn`
- Bosnian: `bs`
- Burmese: `my`
- Catalan: `ca`
- Cebuano: `ceb`
- Chinese: `zh`
- Chinese Traditional: `zh-HANT`
- Croatian: `hr`
- Czech: `cs`
- Dutch: `nl`
- English (Belize): `en-BZ`
- English (Diego Garcia): `en-DG`
- Estonian: `et`
- French: `fr`
- Georgian: `ka`
- German: `de`
- Greek: `el`
- Haitian Creole: `ht`
- Hebrew: `he`
- Hindi: `hi`
- Hmong: `hmn`
- Hungarian: `hu`
- Indonesian: `id`
- Italian: `it`
- Japanese: `ja`
- Javanese: `jv`
- Kazakh: `kk`
- Khmer: `km`
- Korean: `ko`
- Kyrgyz: `ky`
- Lao: `lo`
- Latvian: `Lv`
- Lithuanian: `Lt`
- Macedonian: `mk`
- Malay: `ms`
- Mongolian: `mn`
- Nepali: `ne`
- Polish: `pl`
- Portuguese (Brazil): `pt-BR`
- Portuguese (Portugal): `pt-PT`
- Romanian: `ro`
- Russian: `ru`
- Serbian: `sr`
- Serbian (Latin): `sr-LATN`
- Slovak: `sk`
- Slovenian: `sl`
- Somali: `so`
- Spanish (Spain): `es-ES`
- Swahili: `sw`
- Tagalog (Philippines): `tl-PH`
- Thai: `th`
- Turkish: `tr`
- Ukrainian: `uk`
- Urdu: `ur`
- Uzbek: `uz`
- Vietnamese: `vi`

---

- Path: `general-reference/sweden`
- URL: https://developer.incode.com/general-reference/sweden/
- Markdown: https://developer.incode.com/general-reference/sweden.md

# Sweden
eKYB in Sweden leverages Creditsafe as the vendor to validate the legitimacy of businesses, including their organisation number, business name, business address, along with UBOs and directors.

## Source

| Source | Description |
| --- | --- |
| Creditsafe | Validates Swedish businesses against Creditsafe's company data, sourced from the Swedish Companies Registration Office (Bolagsverket). |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a KYB search. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb"]`. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `SE`.  |
| taxId | Mandatory | String. Swedish Organisationsnummer or VAT number. See [Tax ID formats](#tax-id-formats) below for details. |
| businessName | Optional | String. Registered name of the business. |
| street | Optional | String. Street name of the business address. |
| houseNo | Optional | String. Building or house number. |
| addressLine2 | Optional | String. Additional address information. |
| city | Optional | String. City of the business address. |
| state | Optional | String. State or region of the business address. |
| postalCode | Optional | String. Swedish postal code. Format: exactly 5 digits (for example, `21586`; may be given with a space as `215 86`). |
| uboNames | Optional | Array of strings. Full legal name(s) of Ultimate Beneficial Owners to check against business records. |
| directors | Optional | Array of strings. Full legal name(s) of directors to check against business records. |

### Tax ID formats



| ID Type | Description | Format | Example |
| --- | --- | --- | --- |
| **Organisationsnummer** (Swedish Organization Number) | Unique identifier for Swedish legal entities | Exactly 10 numeric digits, commonly formatted as `XXXXXX-XXXX` | `5567249775` |
| **VAT number** | Swedish VAT identifier | `SE` + 10-digit organisationsnummer + `01` | `SE556724977501` |

Inputs that do not match either format return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb"],
    "country": "SE",
    "taxId": "5567249775",
    "businessName": "Shoes & Bags Sweden AB",
    "street": "Nornegatan",
    "houseNo": "3",
    "addressLine2": "",
    "city": "MALMÖ",
    "state": "",
    "postalCode": "21586",
    "uboNames": [""],
    "directors": ["Gert Olof Peter Veraeus"]
}
```



### Sample response

```json
{
  "kyb": [
    { "key": "name",                 "sub_label": "Verified" },
    { "key": "tin",                  "sub_label": "Verified" },
    { "key": "address_verification", "sub_label": "Approximate Match" },
    { "key": "cityMatch",            "sub_label": "Verified" },
    { "key": "postalCodeMatch",      "sub_label": "Verified" },
    { "key": "registrationStatus",   "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": {
        "entityType": "Limited liability company"
      }
    },
    {
      "key": "directors_name_match",
      "sub_label": "Verified",
      "directorsName_input": "Gert Olof Peter Veraeus"
    }
  ]
}
```

:::note
**Note on `ubo_name_match`**: If Creditsafe returns no `shareHolders` block for a given company (only `issuedShareCapital`), `ubo_name_match` is omitted from the response entirely rather than returned as `Unverified` — absent shareholder data is not treated as a failed match. This appears to be more common for Swedish companies than for other countries covered so far, and is called out here as a documented behavior pending confirmation against additional Swedish company samples.
:::

### Response fields

| Incode API Key | Status | Definition |
| --- | --- | --- |
| name | Verified, Approximate Match, Unverified | Submitted business name is verified, approximate match, or unverified against Creditsafe's `registeredCompanyName`. Incode performs fuzzy matching. |
| tin | Verified, Unverified | Submitted organisationsnummer (tax ID) is found or not found via Creditsafe's `regNo`. |
| address\_verification | Verified, Approximate Match, Unverified | Submitted address (`houseNo` + `street` + `addressLine2` + `city` + `state` + `postalCode`) is verified, approximate match, or unverified against Creditsafe's `simpleValue` address string. Fuzzy matching is applied to the full address. |
| cityMatch | Verified, Approximate Match, Unverified | Submitted city is verified, approximate match, or unverified against Creditsafe's `city` field. |
| postalCodeMatch | Verified, Unverified | Submitted postal code is verified or unverified against Creditsafe's `postalCode` field. Format: exactly 5 digits (for example, `21586`). |
| registrationStatus | Active, Not active | Current registration status of the business. Sourced from Creditsafe's `status` field (step 1) or `companySummary.companyStatus` (step 2). Possible Creditsafe values include `Active` and `NonActive`, mapped to `Active` / `Not active` respectively. |
| entityType | Legal entity type of the business | The legal form of the business as returned from Creditsafe (for example, `Limited liability company`). Passed through as-is — not fuzzy matched against anything in the request. |
| ubo\_name\_match | Verified, Approximate Match, Unverified (or omitted) | Submitted UBO name is matched against Creditsafe's `shareHolders` block. One entry is returned per submitted UBO name, distinguishable via `uboName_input`. **Omitted entirely** if Creditsafe returns no `shareHolders` data for the company (see note above). |
| directors\_name\_match | Verified, Approximate Match, Unverified | Submitted director name is matched against Creditsafe's `directors` block. One entry is returned per submitted director name, distinguishable via `directorsName_input`. |

Learning more about *Approximate Match*: Approximate Match is generated through Incode's proprietary fuzzy matching algorithm. If approximate match is returned, the algorithm has identified a similar match with the string submitted in relation to the string stored in Creditsafe's data for a particular field. Approximate Match is returned when exact matches are not possible due to misspellings, typographical errors, or slight variations in input data.

## Error responses

See the [eKYB Verification API Reference](/general-reference/ekyb-verification-api-reference/) for standard error responses.

## Single Session Dashboard results

Results for Sweden eKYB are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/system-of-record-argentina`
- URL: https://developer.incode.com/general-reference/system-of-record-argentina/
- Markdown: https://developer.incode.com/general-reference/system-of-record-argentina.md

# Registro Nacional de las Personas (RENAPER)

## Registro Nacional de las Personas (RENAPER)

RENAPER is Argentina’s government authority responsible for identifying citizens and legal residents, capturing biometric and personal data, and issuing the national identity card (DNI). Incode’s platform supports clients that independently obtain credentials through their own contract with RENAPER, allowing them to access RENAPER’s database as part of their verification flows.

## Verification Type

| Verification Type | Supported Document Types              | Data that can be verified                                                           |
| :---------------- | :------------------------------------ | :---------------------------------------------------------------------------------- |
| Face Only     | DNI (Documento Nacional de Identidad) | Document Number (DNI), Gender, Selfie image |
| Data and Face     | DNI (Documento Nacional de Identidad) | Document Number (DNI), Gender, First Name, Last Name, Date of Birth, Selfie Image |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=ARG`

### Face Only

**Request Body**

```json
{
"documentNumber": "12345678",
"base64Image": "{{selfie}}"
}
```

**Response Body**

```json
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "recognitionConfidence": {
            "value": "99.0",
            "status": "OK"
        },
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
             },
             {
                "value": "true",
                "status": "OK",
                "key": "personalNumber"
             }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "99.0",
            "status": "OK"
        }
    }
}
```

### Data and Face

**Request Body**

```javascript
{
"documentNumber": "12345678",
"personalNumber": "20123456789",
"firstName": "JUAN",
"paternalLastName": "GOMEZ",
"birthDate": "1985-03-15",
"base64Image": "{{selfie}}"
}
```

**Response Body**

```javascript
{
    "valid":true,
    "statusCode":0,
    "governmentValidation":{
        "recognitionConfidence":{
            "value":"99.0",
            "status":"OK"
        },
        "validationStatus":{
            "value":"0",
            "status":"OK",
            "key":"ok"
        },
        "ocrValidation":[
            {
                "value":"true",
                "status":"OK",
                "key":"documentNumber"
            },
            {
                "value":"true",
                "status":"OK",
                "key":"personalNumber"
            },
            {
                "value":"true",
                "status":"OK",
                "key":"paternalLastName"
            },
            {
                "value":"true",
                "status":"OK",
                "key":"firstName"
            },
            {
                "value":"true",
                "status":"OK",
                "key":"birthDate"
            }
        ],
        "ocrValidationOverall":{
            "value":"100.0",
            "status":"OK"
        },
        "overall":{
            "value":"99.0",
            "status":"OK"
        }
    }
}
```

---

- Path: `general-reference/system-of-record-australia`
- URL: https://developer.incode.com/general-reference/system-of-record-australia/
- Markdown: https://developer.incode.com/general-reference/system-of-record-australia.md

# Australia

## Data Verification Service (DVS)

DVS is Australia’s government-backed system that enables real-time verification of identity data against official government records. Incode’s platform supports clients that independently obtain approval from DVS and appoint Incode as an Information Match Agent, allowing them to access DVS database as part of their verification flows.

### Verification Type

| Verification Type | Supported Document Types | Data That can be Verified |
|---|---|---|
| Data | Passport, Driver's License | Document Number, First Name, Middle Name, Last Name, Date of Birth, Issue Date, Expiration Date |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=AUS`

### Verification with a Passport

#### Request Body

```javascript
{
   "cic": "PA1234567",                // passport number
   "documentType": "Passport",
   "firstName": "JANE",
   "middleName": "",
   "paternalLastName": "DOE",
   "birthDate": "1985/11/02",
   "address": "456 Collins St, Melbourne VIC 3000"
}

```

#### Response Body

```jsx
{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}
```

### Verification with a Driver's License



#### Request Body

```javascript
{
   "cic": "1234567",                  // document/licence number (primary identifier)
   "refNumber": "ABC123",             // licence card reference number (required for DL)
   "documentType": "DriversLicense",
   "issuerState": "NSW",              // or full state name; mapped to ISO2 internally
   "firstName": "JOHN",
   "middleName": "MICHAEL",
   "paternalLastName": "SMITH",
   "birthDate": "1990/05/15",
   "address": "123 George St, Sydney NSW 2000"
}
```

#### Response Body

```javascript
{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}
```

***

<br />

---

- Path: `general-reference/system-of-record-brazil`
- URL: https://developer.incode.com/general-reference/system-of-record-brazil/
- Markdown: https://developer.incode.com/general-reference/system-of-record-brazil.md

# Brazil

## Serviço Federal de Processamento de Dados (SERPRO)

SERPRO is a state-owned entity in Brazil responsible for providing the core digital infrastructure and identity verification databases for the government and its constituents.

Incode's connection to SERPRO allows for verification of identity data and biometrics against government databases that include driver’s license and taxpayer registry records, providing a robust and secure means of identity verification for our clients.

### Verification Type









| Verification Type | Supported Document Types                                                                                                                                    | Data That Can Be Verified                  |
| :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------- |
| Face Only             | Driver’s License, Identification Card, any identity document with CPF                                                                                                                                            | Document Number, Selfie Image          |
| Data and Face     | Driver’s License, Identification Card, any identity document with CPF                                                                                                                                            | Document Number, Full Name, Date of Birth, Selfie Image (Optional) |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=BRA`

### Request Body

```json
{
    "idNumber": "12345678901", // CPF
    "fullName": "MARIA SANTOS TEST",
    "birthDate": "1990-07-10",
    "base64Image": {{selfie}}
}
```

### Response Body

```json
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "recognitionConfidence": {
            "value": "100.0",
            "status": "OK"
        },
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "fullName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "birthDate"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "100.0",
            "status": "OK"
        }
    }
}
```

---

- Path: `general-reference/system-of-record-chile`
- URL: https://developer.incode.com/general-reference/system-of-record-chile/
- Markdown: https://developer.incode.com/general-reference/system-of-record-chile.md

# Chile

## Servicio de Registro Civil e Identificación (SRCel)

SRCel is Chile’s official government authority responsible for issuing and maintaining civil and identity records. Incode’s platform connects to this database via SINACOFI, a private entity, and clients must independently obtain credentials through their own contract with SINACOFI, allowing them to access the SRCel database as part of their verification flows.

### Verification Type



| Verification Type | Supported Document Types | Data That Can Be Verified                  |
| :---------------- | :----------------------- | :----------------------------------------- |
| Data              | Identification Card      | Identification Number (RUT/RUN), Document Number |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=CHL`

**Request Body**

```javascript
{
"personalNumber": "12345678-9",
"idNumber": "A123456789"
}
```



**Response Body**

```javascript Node
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "personalNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "ocr"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "100.0",
            "status": "OK"
        }
    }
}
```

---

- Path: `general-reference/system-of-record-colombia`
- URL: https://developer.incode.com/general-reference/system-of-record-colombia/
- Markdown: https://developer.incode.com/general-reference/system-of-record-colombia.md

# Colombia

## Registraduría Nacional del Estado Civil (RNEC) and Migración Colombia

RNEC is Chile’s official government authority responsible for maintaining identification documents, civil records, and elections, while Migración Colombia is the official immigration authority responsible for maintaining non-citizen identification data. Incode’s platform supports verification of identity data against these databases as part of clients’ verification flows.

### Verification Type

| Verification Type | Supported Document Types              | Data that can be verified                                                                   |
| :---------------- | :------------------------------------ | :------------------------------------------------------------------------------------------ |
| Data              | Identification Card (Cédula de Ciudadanía, Cédula de Extranjería), Permit Card (Permiso de Protección Temporal) | Document Number, First Name, Middle Name, Paternal Last Name, Maternal Last Name, Issue Date |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=COL`

**Request Body**

```javascript 
{
"documentNumber": "1023456789",
"firstName": "CAMILO",
"middleName": "ANDRES",
"paternalLastName": "RODRIGUEZ",
"maternalLastName": "PEREZ",
"issueDate": "2015/06/20"
}
```

**Response Body**

```javascript 
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            { 
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            { 
                "value": "true",
                "status": "OK",
                "key": "firstName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "middleName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "paternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "maternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "issueDate"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "100.0",
            "status": "OK"
        }
    }
}
```

---

- Path: `general-reference/system-of-record-mexico`
- URL: https://developer.incode.com/general-reference/system-of-record-mexico/
- Markdown: https://developer.incode.com/general-reference/system-of-record-mexico.md

# Mexico

## Instituto Nacional Electoral (INE)

In Mexico, the INE provides biometric verification services, especially using facial recognition technology. The INE manages a comprehensive database with biometric data, including facial images. Incode provides direct connection to the INE for face and data verification.

| Verification Type | Supported Document Types        | Data That Can Be Verified                                                                                                                            |
| :---------------- | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
| Data and Face     | INE Card (Voter Identification) | Name, Date of birth, Personal ID (CURP), Document number (OCR, CIC), Electors key (Clave de Elector), Emission number, Issue Date, Registration Date |
| Data              | INE Card (Voter Identification  | Issue Date, Registration Date, Document number (OCR, CIC), Electors key (Clave de Elector), Emission number                                          |

***

# Standalone API

### Request Body

`POST` `/omni/process/government-validation?countryCode=MEX`

```json
{
    "claveElector": "ABCDEF12345678",
    "curp": "ABCD123456HDFABC01",
    "nombre": "JUANTEST",
    "apellidoPaterno": "GARCIATEST",
    "apellidoMaterno": "LOPEZTEST",
    "anioEmision": "2020",
    "ocr": "1234567890123",
    "cic": "123456789",
    "numeroEmisionCredencial": "01",
    "anioRegistro": "2015",
    "base64Image": {{selfie}}
}
```

### Response Body

```json
{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "recognitionConfidence":{
         "value":"91.1",
         "status":"OK"
      },
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"maternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"personalId"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"electorsKey"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"ocr"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"emissionNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"registrationDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"91.1",
         "status":"OK"
      }
   }
}
```

<br />

---

- Path: `general-reference/system-of-record-south-africa`
- URL: https://developer.incode.com/general-reference/system-of-record-south-africa/
- Markdown: https://developer.incode.com/general-reference/system-of-record-south-africa.md

# South Africa



## Department of Home Affairs (DHA)

DHA is South Africa’s official government authority responsible for civil registration, identity management, citizenship, and immigration control. Incode’s platform connects to the National Population Register maintained by the DHA for the verification of identity data and biometrics as part of clients’ verification flows.

### Verification Type



| Verification Type | Supported Document Types | Data That Can Be Verified |
| --- | --- | --- |
| Data and Face (Face Optional) | Identification Card, Driver’s License, Passport | Document Number, First Name, Paternal Last Name, Maternal Last Name, Issue Date, Selfie Image (Optional) |

## Standalone API

`POST` `/omni/process/government-validation?countryCode=ZAF`

### Request Body

```javascript
{
"idNumber": "1234567890123",
"issuedAt": "2020-01-15",
"firstName": "NAOMI",
"paternalLastName": "KINGS",
"maternalLastName": "",
"base64Image": "{{selfie_base64}}"
}
```

### Response Body

```javascript
{
    "valid": true,
    "statusCode": 0,
    "governmentValidation": {
        "recognitionConfidence": {
            "value": "81.0",
            "status": "OK"
        },
        "validationStatus": {
            "value": "0",
            "status": "OK",
            "key": "ok"
        },
        "ocrValidation": [
            {
                "value": "true",
                "status": "OK",
                "key": "documentNumber"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "firstName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "paternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "maternalLastName"
            },
            {
                "value": "true",
                "status": "OK",
                "key": "issueDate"
            }
        ],
        "ocrValidationOverall": {
            "value": "100.0",
            "status": "OK"
        },
        "overall": {
            "value": "81.0",
            "status": "OK"
        }
    }
}
```

<br />

---

- Path: `general-reference/trust-graph-reason-codes`
- URL: https://developer.incode.com/general-reference/trust-graph-reason-codes/
- Markdown: https://developer.incode.com/general-reference/trust-graph-reason-codes.md

# Trust Graph Reason Codes

When a [TrustGraph](/features-and-modules/trust-graph-overview/) reason category returns `AT_RISK` on a session, the response includes a list of `matches`, each carrying a `reason` field that explains why the category fired. This page lists every reason code emitted by each of the five categories, with its meaning.

Reason codes are an open set. New codes may be added over time as categories evolve. Branch on the codes you know and default anything unrecognized to review rather than assuming a fixed enum.


## Suspected Repeat Fraudster

Category identifier: `SUSPECTED_REPEAT_FRAUDSTER`

| Reason code | Meaning |
| --- | --- |
| `PHYSICAL_LIVENESS_ATTACK` | Physical liveness attack (printed photo, mask, screen replay). |
| `DIGITAL_LIVENESS_ATTACK` | Digital liveness attack (injected or synthetic video). |
| `EVASION_LIVENESS_ATTACK` | Attempt to evade the liveness check. |
| `FACE_RECOGNITION_ATTACK` | Attack targeting face recognition. |
| `DOCUMENT_TAMPERING` | Document was tampered with or forged. |
| `GOVERNMENT_VALIDATION_FAILED` | Identity failed validation against a government source. |
| `LIVENESS` | General liveness-related fraud signal. |

## First-Party Fraud

Category identifier: `FIRST_PARTY_FRAUD`

The First-Party Fraud reason codes are also the list a reporter chooses from when contributing a fraud report back to the network.

| Reason code | Meaning |
| --- | --- |
| `DECEPTIVE_PERSONAL_INFO` | User submitted deceptive personal information. |
| `DOCUMENT_TAMPERING_1ST_PARTY` | Document tampering performed by the user themselves. |
| `REWARDS_BASED_ABUSE` | Abuse of rewards, promotions, or incentives. |
| `SERVICE_ACCESS_ABUSE` | Abuse of service access. |
| `ACCOUNT_SELLING` | Selling or transferring an account. |
| `CIRCULAR_TRADING` | Circular-trading pattern. |
| `FALSE_INVOICING` | False invoicing. |
| `OTHER` | Other first-party fraud reason. |

## Unusual Activity

Category identifier: `UNUSUAL_ACTIVITY`

| Reason code | Meaning |
| --- | --- |
| `SELFIES_MATCHED_DOCUMENTS_DIFFERENT` | Selfies matched, but the associated documents differ. |
| `FACES_ON_IDS_MATCHED_DOCUMENTS_DIFFERENT` | Faces on IDs matched, but the documents differ. |
| `DOCUMENTS_MATCHED_FACES_DIFFERENT` | Documents matched, but the faces differ. |
| `DOCUMENTS_MATCHED_NAMES_DIFFERENT` | Documents matched, but the names differ. |
| `DEVICES_MATCHED_NAMES_DIFFERENT` | Same device, different names. |
| `DEVICES_MATCHED_DOCUMENTS_DIFFERENT` | Same device, different documents. |

## Velocity

Category identifier: `VELOCITY_CHECKS`

Each Velocity reason code corresponds to one tracked attribute reaching the count threshold configured for it within the configured time window.

| Reason code | Meaning |
| --- | --- |
| `FACE_THRESHOLD_REACHED` | The same face exceeded its velocity threshold in the window. |
| `FACE_ON_ID_THRESHOLD_REACHED` | The same face-on-ID exceeded its threshold. |
| `DOCUMENT_NUMBER_THRESHOLD_REACHED` | The same document number exceeded its threshold. |
| `PERSONAL_NUMBER_THRESHOLD_REACHED` | The same personal number exceeded its threshold. |
| `VOTER_NUMBER_THRESHOLD_REACHED` | The same voter number exceeded its threshold. |
| `DEVICE_HASH_THRESHOLD_REACHED` | The same device hash exceeded its threshold. |

## Fraud Rings

Category identifier:

| Reason code | Meaning |
| --- | --- |
| `SAME_FACE_MANY_CLAIMED_IDENTITIES` | Same face across many identities. |
| `SAME_CLAIMED_IDENTITY_MANY_FACES` | Same identity used with many faces. |
| `SAME_FACE_MANY_DOCUMENTS` | Same face across many documents. |
| `SHARED_DEVICE_MANY_APPLICANTS` | One device shared by many applicants. |
| `SAME_ADDRESS_MANY_APPLICANTS` | One address shared by many applicants. |
| `RETRY_ADAPTATION` | Repeated retries adapting to the checks. |
| `SAME_DOCUMENT_MANY_APPLICATIONS` | Same document in many applications. |

## Related pages

- [TrustGraph](/features-and-modules/trust-graph-overview) (Feature Deep Dive): What TrustGraph is, its categories, deployment scopes, and privacy architecture.
- [TrustGraph module configuration](/dashboard-platform-administration/trust-graph-module-configuration): How to configure TrustGraph in the Flow or Workflow Builder.

---

- Path: `general-reference/turkey`
- URL: https://developer.incode.com/general-reference/turkey/
- Markdown: https://developer.incode.com/general-reference/turkey.md

# Turkey

Turkey eKYC verification matches submitted individual data against Turkey's official voter register as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source | API source string | Description |
| --- | --- | --- |
| Turkey Voter Register | `TR_VOTER_REGISTER` | Verifies submitted data against Turkey's official voter register. |

## Turkey Voter Register

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| source | Mandatory | Must be `TR_VOTER_REGISTER`. |
| country | Mandatory | Must be `TR`. |
| firstName | Mandatory | First name of the individual. Can be submitted with or without Turkish characters (for example, `Daşlı` and `Dasli` both match). |
| surName | Mandatory | Last name of the individual. All surnames in one field (for example, `Boztepe Köktürk`). Can be submitted with or without Turkish characters. |
| middleName | Optional | Middle name of the individual. Not included in `fullNameMatch`. |
| dateOfBirth | Optional | Format: `yyyy-mm-dd`. |
| gender | Optional | Accepted values are `M` or `F`. |
| street | Optional | Street, house, and flat number in one field (for example, `Atatürk Caddesi No:12 D:3`). Can be submitted with or without Turkish characters. |
| city | Optional | Province (il) of the individual's address (for example, `İstanbul`, `İzmir`). Provide the province, not the district (ilçe). Sending the province is needed for both `cityMatch` and `streetMatch` to match — a district (for example, `Fatih`, `Bayraklı`) causes both to fail. |
| idNum | Optional | TC Kimlik No (Turkish national identity number). Format: exactly 11 numeric digits, first digit cannot be 0 (for example, `12345678901`). |

:::info
Non-Latin input (for example, Arabic or Cyrillic script) is automatically transliterated to Turkish Latin script before the request is sent. Names and street can also be submitted directly in Latin script with or without Turkish characters — both match. See [Input transliteration](#input-transliteration) below for details.
:::

### Sample request

```json
{
    "plugins": ["kyc"],
    "source": "TR_VOTER_REGISTER",
    "firstName": "Jane",
    "middleName": "Example",
    "surName": "Doe",
    "country": "TR",
    "city": "İstanbul",
    "street": "Atatürk Caddesi No:1 D:1",
    "dateOfBirth": "2000-01-01",
    "gender": "F",
    "idNum": "12345678901"
}
```

### Response fields

Turkey Voter Register anchors verification on full name plus at least one of: date of birth, TC Kimlik No, or street address. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field | Statuses | Description |
| --- | --- | --- |
| `firstNameMatch` | `exact`, `fuzzy`, `nomatch` | Matches first name submitted against the value in the source of truth. |
| `lastNameMatch` | `exact`, `fuzzy`, `nomatch` | Matches last name submitted against the value in the source of truth. |
| `middleNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth. Shown as a standalone field, not included in `fullNameMatch`. |
| `fullNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite match derived from `firstNameMatch` and `lastNameMatch` only. See below for calculation logic. |
| `dobMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth. |
| `genderMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches gender submitted against the value in the source of truth. |
| `streetMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches street address submitted against the value in the source of truth. Only `streetMatch` = `exact` counts toward a low-risk result; `fuzzy` does not. |
| `cityMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches province (il) submitted against the value in the source of truth. |
| `fullAddressMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Composite match derived from `streetMatch` and `cityMatch`. See below for calculation logic. |
| `idNumMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches the Turkish national ID number (TC Kimlik No) submitted against the value in the source of truth. |
| `overallLevel` | `low`, `medium`, `high` | Overall risk level. See below for calculation logic. |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and at least one verified attribute (date of birth, TC Kimlik No, or street address).

- **low** when `fullNameMatch` is `exact` AND at least one of the following is exact: `dobMatch`, `idNumMatch`, or `streetMatch`.
- **high** when `fullNameMatch` is `nomatch` OR all of the following are `nomatch` or `nodata`: `streetMatch`, `dobMatch`, and `idNumMatch`.
- **medium** for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.









### Input transliteration

Non-Latin input (for example, Arabic, Persian, or Cyrillic script) is automatically transliterated to Turkish Latin script before the request is sent to the source of truth. Latin input, including Turkish characters (ç, ğ, ı, İ, ö, ş, ü), is sent exactly as provided.

| Field | Transliteration applied | Rule |
| --- | --- | --- |
| `firstName` | Only if non-Latin | Written in Turkish Latin script using Turkish name forms where they exist (for example, أحمد → Ahmet, Сергей → Sergey). |
| `middleName` | Only if non-Latin | Same rules as `firstName`. |
| `surName` | Only if non-Latin | Written in Turkish Latin script using Turkish spelling conventions. |
| `street` | Only if non-Latin | Written in Turkish Latin script; numbers kept exactly as given. Street words translated to Turkish equivalents (for example, شارع → Caddesi). |
| `city` | Always | Returned as one of Turkey's 81 provinces (il) in its official Turkish spelling. Districts (ilçe) are mapped to their province (for example, Fatih → İstanbul, Bayraklı → İzmir). Non-Latin city input is translated (for example, مرسين → Mersin). |
| `idNum` | Digits only | Non-Western digits converted to 0–9 (for example, ١٢٣ → 123). Nothing else changes. |

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch",   "status": "exact" },
        { "key": "lastNameMatch",    "status": "exact" },
        { "key": "middleNameMatch",  "status": "exact" },
        { "key": "fullNameMatch",    "status": "exact" },
        { "key": "dobMatch",         "status": "exact" },
        { "key": "genderMatch",      "status": "exact" },
        { "key": "streetMatch",      "status": "exact" },
        { "key": "cityMatch",        "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "idNumMatch",       "status": "exact" },
        { "key": "overallLevel",     "status": "low" }
    ]
}
```

---

- Path: `general-reference/united-arab-emirates`
- URL: https://developer.incode.com/general-reference/united-arab-emirates/
- Markdown: https://developer.incode.com/general-reference/united-arab-emirates.md

# United Arab Emirates
# United Arab Emirates

eKYB Prefill in the United Arab Emirates leverages UAE official business registry data to automatically retrieve and populate business information based on a company's registration number, including the business name, registered address, entity type, registration status, and incorporation date, without requiring manual input from the user.



## Source

| Source | Description |
| --- | --- |
| `AE_KYB_PREFILL` | Returns matching UAE business details from official business registry data for prefill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `AE_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `AE`. |
| taxId | Mandatory | String. UAE company registration number. Format varies by emirate and free zone — no format validation is applied. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, may improve match accuracy. |

### Tax ID formats

UAE registration number formats vary by emirate and free zone. No format validation is applied — all formats are accepted as submitted.

| Format | Example |
| --- | --- |
| DMCC Trade License | DMCCXXXXXX |
| DIFC License | Format varies |
| JLT License | DMCC-XXXXXX |

:::note 
UAE registration number formats vary by emirate and free zone — no format validation is applied to `taxId`. All formats are accepted as-is (for example, `000001911`, `DMCC2429`, `6099`). Address data may be returned in Arabic script and is automatically translated to English.
:::

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "AE_KYB_PREFILL",
    "country": "AE",
    "taxId": "000000001",
    "businessName": "EXAMPLE COMPANY LLC"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source, with address and name translated to English where originally in Arabic script. Fields such as `entityType`, `email`, and `phoneNumber` may be absent depending on which registry the business is resolved against.



```json
{
  "kyb-prefill": [
    {
      "tin": "000000001",
      "name": "EXAMPLE COMPANY LLC",
      "registrationStatus": "Active",
      "entityType": "Unknown",
      "registrationDate": "2021-10-17T13:52:55Z",
      "incorporationDate": "2018-12-23",
      "address": "Unit 1, Floor 1, Example Tower, Example Street, Abu Dhabi, AE-AZ, United Arab Emirates",
      "email": null,
      "phoneNumber": null
    }
  ]
}
```

### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | Registration number | The UAE registration number as submitted in the request, confirmed by the source of truth. |
| name | Business name | The registered legal name of the business as returned from the source of truth. Names originally in Arabic are automatically translated to English. |
| registrationStatus | Active, Inactive, Unknown | Current registration status of the business. See Registration status values for details. |
| entityType | Entity type | The legal entity type of the business as returned from the source of truth (for example, `Public`, `Private Company Limited By Shares`, `Trading`). Returns `Unknown` when not available. |
| registrationDate | Date | The date the company was registered in the source registry, as returned from the source of truth. May not be present for all companies. |
| incorporationDate | Date | The date the company was incorporated, as returned from the source of truth. May not be present for all companies. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. Addresses originally in Arabic are automatically translated to English. May not be present for all companies. |
| email | Email address | The business contact email address registered with the source of truth, if available. |
| phoneNumber | Phone number | The business contact phone number registered with the source of truth, if available. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved or inactive. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. UAE Prefill returns the following country-specific 400 errors.

`taxId` is missing or empty:

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, or `country`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```





No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/united-kingdom`
- URL: https://developer.incode.com/general-reference/united-kingdom/
- Markdown: https://developer.incode.com/general-reference/united-kingdom.md

# United Kingdom

eKYB Prefill in the United Kingdom leverages the UK's source of truth to automatically retrieve and populate business information based on a company's Registration Number or VAT Number, including the business name, registered address, entity type, registration status, directors, shareholders, and additional financial and corporate data, without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| United Kingdom | `GB_KYB_PREFILL` | Returns matching UK business details from the UK's source of truth for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint

`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| plugins | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| source | Mandatory | String. Must be `GB_KYB_PREFILL`. Identifies the Prefill source. |
| country | Mandatory | String. Two-letter Alpha-2 country code. Must be `GB`. |
| taxId | Mandatory | String. UK Registration Number or VAT Number. See Tax ID formats for details. |
| businessName | Optional | String. Registered name of the business. When provided, adds `nameMatch` to the response. |
| address | Optional | String. Business address as a freeform string. When provided, adds `addressMatch` to the response. |

### Tax ID formats

The `taxId` field accepts two UK business identifier types. Routing between them is determined automatically by the length of the submitted value after stripping any `GB` prefix.

| ID Type | Format | Example |
| --- | --- | --- |
| **Registration Number** | 7 or 8 numeric digits | `01616165` |
| **VAT Number** | 9 numeric digits, or `GB` + 9 numeric digits | `GB374927709` or `374927709` |

Registration Number (8 digits) and VAT Number (9 digits) never overlap in length, so routing is unambiguous. Inputs of any other length return a 400 error.

### Sample request

```json
{
    "plugins": ["ekyb-prefill"],
    "source": "GB_KYB_PREFILL",
    "country": "GB",
    "taxId": "01234567",
    "businessName": "Northbridge Footwear Ltd",
    "address": "2 Example Street, London, EC1A 1BB"
}
```

### Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source. `nameMatch` and `addressMatch` are only present when `businessName` or `address` were submitted in the request.

```json
{
  "kyb-prefill": [
    {
      "tin": "01234567",
      "vatNo": "GB123456789",
      "name": "Northbridge Footwear Ltd",
      "nameMatch": "Verified",
      "address": "2 Example Street, London, EC1A 1BB",
      "city": "London",
      "postalCode": "EC1A 1BB",
      "entityType": "Private limited with Share Capital",
      "registrationStatus": "Active",
      "registrationDate": "2012-06-18T00:00:00Z",
      "creditRating": "A",
      "creditRatingDescription": "Very Low Risk",
      "industry": "Unknown",
      "industryDesc": "Manufacture of footwear",
      "turnover": { "currency": "GBP", "value": 1026089739 },
      "employeeCount": 789,
      "activityDesc": "The manufacture and distributes sports and leisure footwear and accessories to customers across Europe and is part of one of the major players in the global sports footwear industry.",
      "otherAddresses": [
        { "type": "Main Trading Address", "otherAddress": "18 Harbour Way, Manchester, M1 2AB" },
        { "type": "Trading Address", "otherAddress": "75 Meadow Park, Birmingham, B1 1AA" }
      ],
      "shareholders": [
        { "name": "Summit Athletics Holdings Inc.", "percentSharesHeld": 100 }
      ],
      "ultimateParent": { "name": "Summit Global Industries Inc.", "country": "US" },
      "immediateParent": { "name": "Summit Athletics Holdings Inc.", "country": "US" },
      "beneficialOwners": [
        {
          "name": "Mr Ethan Caldwell",
          "dateOfBirth": "1944-06-01T00:00:00Z",
          "nationality": "American",
          "natureOfControl": "ownership-of-shares-75-to-100-percent,voting-rights-75-to-100-percent,right-to-appoint-and-remove-directors"
        }
      ],
      "websites": ["www.newbalance.co.uk"],
      "directors": [
        { "name": "Mrs Maya Reynolds", "positionName": "Director" },
        { "name": "Mr Lucas Bennett", "positionName": "Director" },
        { "name": "Mrs Sofia Mitchell", "positionName": "Director" },
        { "name": "Mrs Amelia Brooks", "positionName": "Company Secretary" },
        { "name": "Mr Daniel Foster", "positionName": "Director" }
      ]
    }
  ]
}
```
### Response fields

| Key | Value | Description |
| --- | --- | --- |
| tin | Registration Number | The company Registration Number as confirmed by the source of truth. Returned when `taxId` is submitted as a Registration Number. |
| vatNo | VAT Number | The VAT registration number as returned from the source of truth, including `GB` prefix (for example, `GB374927709`). |
| name | Business name | The registered legal name of the business as returned from the source of truth. |
| nameMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file. Only present when `businessName` was submitted in the request. See Name and address match values for details. |
| address | Registered address | The primary registered address of the business as returned from the source of truth. |
| addressMatch | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against the registered address on file. Only present when `address` was submitted in the request. See Name and address match values for details. |
| city | City | The city of the registered address as returned from the source of truth. |
| postalCode | Postal code | The postal code of the registered address as returned from the source of truth. |
| entityType | Entity type | The legal form of the business as returned from the source of truth (for example, `Private limited with Share Capital`). |
| registrationStatus | Registration status | The current company status as returned from the source of truth (for example, `Active`). See Registration status values for details. |
| registrationDate | Date | The date the company was registered, as returned from the source of truth. |
| creditRating | Credit rating value | The standardized credit rating value (for example, `A`). |
| creditRatingDescription | Credit rating description | A human-readable description of the credit rating (for example, `Very Low Risk`). |
| industry | Industry sector | The industry sector of the business. Returns `Unknown` for UK, as this field is not available from the source of truth. |
| industryDesc | Industry description | The primary activity description as returned from the source of truth (for example, `Manufacture of footwear`). |
| turnover | `{currency, value}` | The latest turnover figure as returned from the source of truth. May not be present for all companies. |
| employeeCount | Number | The latest employee count as returned from the source of truth. May not be present for all companies. |
| activityDesc | Activity description | A free-text description of the business's principal activity as returned from the source of truth. |
| otherAddresses | Array of `{type, otherAddress}` | Additional addresses on file (for example, trading addresses), other than the primary registered address. |
| shareholders | Array of `{name, percentSharesHeld}` | Shareholders associated with the business as returned from the source of truth. |
| ultimateParent | `{name, country, registrationNumber}` | Ultimate parent company, if available. Absent when the entity is not a subsidiary. |
| immediateParent | `{name, country, registrationNumber}` | Immediate parent company, if available. Absent when the entity is not a subsidiary. |
| beneficialOwners | Array of `{name, dateOfBirth, nationality, natureOfControl}` | Beneficial owners as returned from the source of truth. UK-specific field — not present in other country responses. |
| websites | Array of strings | Website URLs associated with the business as returned from the source of truth. |
| directors | Array of `{name, positionName}` | Current directors and officers as returned from the source of truth. `positionName` reflects the primary position title on file. |

### Name and address match values

| Status | Description |
| --- | --- |
| Verified | Exact match found against registry data. |
| Approximate Match | Similar match found; may reflect minor differences in naming or address formatting. |
| Unverified | No match found in registry data. |

### Registration status values

| Status | Description |
| --- | --- |
| Active | The company is currently active and registered. |
| Inactive | The company registration is dissolved, struck off, or no longer active. |
| Unknown | The registration status could not be determined. |

## Error responses

For standard HTTP response codes, see the API Error Response page. UK Prefill returns the following country-specific 400 errors.

`taxId` is missing, empty, or not a valid Registration Number (7–8 digits) or VAT Number (9 digits or `GB` + 9 digits):

```json
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid UK Registration Number (7-8 digits) or VAT Number (9 digits, optionally prefixed with GB)",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Any mandatory field (`plugins`, `source`, `country`, or `taxId`) is missing:

```json
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

Wrong country code is provided (any value other than `GB`):

```json
{
    "timestamp": 1782851583695,
    "status": 400,
    "error": "Bad Request",
    "message": "IllegalArgumentException: No enum constant com.incodesmile.onboarding.integration.external.government.ekyb.domain.entity.model.EkybCountry.GB",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

No business match is found for the submitted `taxId`:

```json
{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

## Single Session Dashboard results

Prefill results are available on the Business tab in [single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/united-states-govmatch`
- URL: https://developer.incode.com/general-reference/united-states-govmatch/
- Markdown: https://developer.incode.com/general-reference/united-states-govmatch.md

# United States GovMatch

Incode GovMatch is an identity verification solution that securely confirms identity against state Department of Motor Vehicles (DMV) issuing databases in real time. GovMatch supports two complementary methods to verify a user:

- [GovFaceMatch](#govfacematch): Performs a one-to-one biometric comparison of a user’s live selfie and identity attributes against the photo and identity record held in a participating state DMV database.
- [GovDataMatch](#govdatamatch): Verifies user-submitted identity attributes (including name, date of birth, and document details) against the corresponding DMV record.

As shown in the following map, most states support one of these methods and some states support both. The Incode module determines which method to use based on the state issuing the ID. When both methods are provisioned, priority is given to the GovFaceMatch method.


<Image src="https://developer.incode.com/assets/5d946a5a39fb1b64f27ed55c7e96d0e8.png" align="center" caption="US map showing GovFaceMatch and GovDataMatch support by state" />


<br />

## Verification Methods

### GovFaceMatch

GovFaceMatch is Incode’s direct connection to state DMV systems for biometric face comparison. During verification, the supported document data fields are sent to the DMV. If the document data fields match to a record within the DMV database, the uploaded selfie is compared against the official portrait stored in the state’s DMV database. A successful Face Match guarantees that the Data Match also passed, and provides the highest level of assurance that the person presenting the document is the legitimate holder.

- **Provider**: Direct Incode-to-DMV integration
- **Supported States**: CA\*, GA\*, MS, VA
- **Verification method**: Biometric face matching against DMV photo on file & certain fields required by states.

\* Requires separate approval from state DMV to enable

For more, see [GovFaceMatch Technical Details](/general-reference/dmv-face-match-technical-details/).

### GovDataMatch

GovDataMatch is Incode’s data verification service through AAMVA or through validation of Verifiable Credentials. During verification, the supported document data fields are validated against the data on the record held by the issuing state’s DMV.

- **Provider**: AAMVA network, validation of Verifiable Credentials
- **Supported States**: 46 states (all _except_ AK, CA, LA, MN, UT)
  - For most current state AAMVA provider state coverage information, visit: [https://aamva.org/it-systems-participation-map?id=594](https://aamva.org/it-systems-participation-map?id=594)
- **Verification method**: Data field matching against authoritative DMV records

For more, see [GovDataMatch Technical Details](/general-reference/dmv-data-match-technical-details/).

#### Known State-Level Integration Differences Between Participating GovDataMatch States

As each state has its own independent GovDataMatch integration, data field matching availability is not consolidated to a single standard. Below are the known state-level variations as provided by the latest official AAMVA documentation.


:::info
Incode observes some discrepancy cases in production that are pending official confirmation by AAMVA.
:::

<Accordion title="States that do not support Issue Date verification on ID Cards">
  | State | Notes                                                    |
  | ----- | :------------------------------------------------------- |
  | AZ    | Not supported                                            |
  | DE    | Not supported                                            |
  | ID    | Not supported                                            |
  | KY    | Not supported                                            |
  | MI    | Not supported                                            |
  | ME    | Not supported                                            |
  | NE    | Not supported                                            |
  | NM    | Not supported                                            |
  | NC    | Not available if person previously held a Driver License |
  | RI    | Not supported                                            |
  | TX    | Not supported on ID cards issued pre-2009                |
  | VA    | Not supported                                            |
  | WI    | Not supported                                            |
</Accordion>

<Accordion title="States that do not support Expiration Date verification on ID Cards">
  | State | Reason                                     |
  | ----- | :----------------------------------------- |
  | AZ    | AZ issues ID cards without expiration date |
  | DE    | Data field not available for verification  |
  | ID    | Data field not available for verification  |
  | KY    | Data field not available for verification  |
  | ME    | Data field not available for verification  |
  | MI    | Data field not available for verification  |
  | NE    | Data field not available for verification  |
  | NJ    | Data field not available for verification  |
  | NM    | Data field not available for verification  |
  | NC    | Data field not available for verification  |
  | RI    | Data field not available for verification  |
  | TX    | Data field not available for verification  |
  | VA    | Data field not available for verification  |
  | WI    | Data field not available for verification  |
</Accordion>

<Accordion title="Known Special Cases - All Credentials">
  | State | ID Type                      | Issue                                                 | Impact                                             |
  | ----- | :--------------------------- | :---------------------------------------------------- | :------------------------------------------------- |
  | CO    | Some ID cards                | Some have no expiration date (criteria not specified) | Cannot verify                                      |
  | FL    | Some ID cards                | Some have no expiration date (criteria not specified) | Cannot verify                                      |
  | IL    | ID cards and Driver Licenses | Temporary credentials                                 | Cannot verify issue date on temporary credentials  |
  | IL    | Temporary credentials        | Cannot verify expiration on temporary credentials     | Cannot verify                                      |
  | MA    | ID cards and Driver Licenses | Replacement/duplicate cards                           | New issue date printed but database keeps original |
  | MA    | Pre-2010 ID cards            | No expiration date                                    | Cannot verify                                      |
  | RI    | Old cards                    | No expiration date                                    | Cannot verify                                      |
  | WY    | Very old ID cards            | No expiration date                                    | Cannot verify                                      |
</Accordion>

<Accordion title="Age-Based No Expiration (ID Cards)">
  These states issue ID cards without expiration dates for certain age groups:

  | State | Age Threshold | Card Type        | Notes                                        |
  | ----- | ------------- | ---------------- | -------------------------------------------- |
  | AL    | 62+           | Non-REAL ID only | REAL ID cards always have expiration         |
  | AR    | 60+           | Non-REAL ID only | REAL ID cards always have expiration         |
  | IL    | 65+           | All ID cards     | No expiration for seniors                    |
  | MO    | 70+           | Some ID cards    | Varies by individual                         |
  | OK    | 65+           | Non-REAL ID only | Shows "INDEF"; REAL ID has 4/8 year validity |
  | TN    | 65+           | Non-REAL ID only | REAL ID cards always have expiration         |
  | TX    | 60+           | All ID cards     | No expiration for senior                     |
</Accordion>

<Accordion title="States That Keep Original Issue Date on Replacements">
  These states reuse the original issue date even on replacement cards:

  * AL
  * AR
  * DC
  * FL
  * IN
  * MS
  * NJ
  * SC
  * TX (for "Remade" cards only)
</Accordion>

## Module Configuration

You can add GovMatch to your [Workflows](https://developer.incode.com/docs/workflows-20) or [Flows](https://developer.incode.com/docs/flows-1) using the [Government Record Verification module](https://developer.incode.com/docs/government-record-verification). Then you can [configure the module settings](/dashboard-platform-administration/government-record-verification-dashboard/) to select the applicable fields for the input data and/or face you would like to collect from the end user.



## Single Session Dashboard Result

**GovFaceMatch**


<Image src="https://developer.incode.com/assets/ab30693ff7382bb8491da53a37396ce7.png" align="center" />


**GovDataMatch**


<Image src="https://developer.incode.com/assets/74db13c3755adb6e543f28a00b3299b8.png" align="center" />


### Interpreting GovMatch Results

For each check performed, one of the following 3 statuses is returned:

| **Status** | **Description**          | **Notes**                                                                               |
| ---------- | :----------------------- | --------------------------------------------------------------------------------------- |
| `OK`       | Exact Match Verified     | Session face or data field is an exact match to DMV records                             |
| `FAIL`     | Exact Match Failed       | Mismatch between session face or data field and DMV records                             |
| `UNKNOWN`  | Verification unavailable | The submitted document or region isn’t supported or something went wrong when trying to perform validation. |

For more specific information on scoring and response details, see either [GovFaceMatch](/general-reference/dmv-face-match-technical-details/) or [GovDataMatch](/general-reference/dmv-data-match-technical-details/).

<br />

---

- Path: `general-reference/us-prefill`
- URL: https://developer.incode.com/general-reference/us-prefill/
- Markdown: https://developer.incode.com/general-reference/us-prefill.md

# United States

eKYB Pre-fill in the US leverages official business registry data to automatically retrieve and populate business information based on a company's name and address, including the business name, registered address, entity type, registration status, and directors — without requiring manual input from the user.

## Source

| Country | Source | Description |
| --- | --- | --- |
| United States | `US_KYB_PREFILL` | Returns matching US business details from official business registry data for pre-fill. |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB Prefill API Reference](/general-reference/ekyb-prefill-api-reference/).

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

### Endpoint



`POST /omni/externalVerification/ekyb-prefill`

### Request parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `plugins` | Mandatory | String array. Must be `["ekyb-prefill"]`. Specifies the Prefill flow. |
| `source` | Mandatory | String. Must be `US_KYB_PREFILL`. Identifies the Prefill source. |
| `country` | Mandatory | String. Two-letter Alpha-2 country code. Must be `US`. |
| `businessName` | Mandatory | String. Registered name of the business. |
| `address` | Mandatory | String. Business address as a freeform string. Must contain at minimum city + state (for example: `San Francisco, CA`). City alone is not accepted. |
| `taxId` | Optional | String. US Employer Identification Number (EIN / TIN). When provided, adds `tinMatch` to the response. See Tax ID formats for details. |

### Tax ID formats

EIN (Employer Identification Number), also referred to as TIN, is the US federal tax identifier assigned to businesses by the IRS. Providing `taxId` is optional. When included, it enables IRS TIN verification and adds `tinMatch` to the response.

| Format | Example |
| --- | --- |
| 9 numeric digits, no spaces or special characters | `943320693` |

### Sample request

```javascript Node
{
    "plugins": ["ekyb-prefill"],
    "source": "US_KYB_PREFILL",
    "country": "US",
    "businessName": "Acme Solutions LLC",
    "address": "San Francisco, CA",
    "taxId": "123456789"
}
```

### Sample response



The Prefill response returns business data retrieved directly from the source of truth. `nameMatch`, `addressMatch`, and `tinMatch` reflect the result of comparing submitted inputs against registry data.

```javascript Node
{
  "kyb-prefill": [
    {
      "name": "Acme Solutions LLC",
      "nameMatch": "Approximate Match",
      "address": "742 Nebula Lane, San Francisco, CA 94107",
      "addressMatch": "Approximate Match",
      "tinMatch": "Verified",
      "entityType": "C_CORPORATION",
      "registrationStatus": "Active",
      "directors": [
        { "name": "Ethan Caldwell", "positionName": "Chief Executive Officer" },
        { "name": "Maya Reynolds", "positionName": "Officer" },
        { "name": "Lucas Bennett", "positionName": "Director" },
        { "name": "Sofia Mitchell", "positionName": "Assistant Secretary" }
      ]
    }
  ]
}
```

:::info
`addressMatch` is evaluated against all addresses on file for the business, not only the primary registered address. If the submitted city + state matches any address on file, the result may return as Verified or `Approximate Match` even when the primary registered address is in a different location.

`tinMatch` is only present in the response when `taxId` was submitted in the request. When `taxId` is omitted, all other response fields are still returned.
:::







### Response fields

| Key | Value | Description |
| --- | --- | --- |
| `name` | Business name | The registered legal name of the business as returned from the source of truth. |
| `nameMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `businessName` against the name on file in the source of truth. See Name and address match values for details. |
| `address` | Registered address | The primary registered address of the business as returned from the source of truth. |
| `addressMatch` | Verified, Approximate Match, Unverified | Match result comparing the submitted `address` against all addresses on file for the business. See Name and address match values for details. |
| `tinMatch` | Verified, Potential Match, Unverified | Match result from IRS TIN verification. Only present in the response when `taxId` was submitted in the request. See TIN match values for details. |
| `entityType` | Entity type | The legal entity type of the business as returned from the source of truth (for example, `C_CORPORATION`, `LLC`). |
| `registrationStatus` | Active, Inactive, Unknown | Current registration status of the business. See Registration status values for details. |
| `directors` | Array of `{name, positionName}` | Officers and directors associated with the business as returned from the source of truth. `positionName` reflects the primary title on file. Includes directors, managers, and other officers — role types are not separated. |

### Name and address match values

| Status | Description |
| --- | --- |
| `Verified` | Exact match found against registry data. |
| `Approximate Match` | Similar match found; may reflect minor differences in naming or address formatting. |
| `Unverified` | No match found in registry data. |

### TIN match values

| Status | Description |
| --- | --- |
| `Verified` | The submitted TIN matches IRS records exactly. |
| `Potential Match` | The submitted TIN is a partial or probable match against IRS records. |
| `Unverified` | The submitted TIN does not match IRS records. |

### Registration status values

| Status | Description |
| --- | --- |
| `Active` | The business is actively registered in at least one state. |
| `Inactive` | The business registration is lapsed or dissolved. |
| `Unknown` | The registration status could not be determined. |

### Error responses

For standard HTTP response codes, see the API Error Response page. US Prefill returns the following country-specific 400 errors.

`businessName` is missing or empty:

```javascript Node
{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "Missing required field: businessName.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```

`address` is missing, empty, or cannot be resolved to at least city + state:

```javascript Node
{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "address must contain at minimum city and state.",
    "path": "/omni/externalVerification/ekyb-prefill"
}
```




















## Single Session Dashboard results

Prefill results are available on the Business tab in [Single Session view](/dashboard-platform-administration/single-session-view/).

---

- Path: `general-reference/venezuela`
- URL: https://developer.incode.com/general-reference/venezuela/
- Markdown: https://developer.incode.com/general-reference/venezuela.md

# Venezuela


Venezuela eKYC verification matches submitted individual data against Venezuela's civil register as the source of truth. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common response semantics that apply across all sources.

## Available sources

| Source                   | API source string    | Description                                                   |
| ------------------------- | ----------------------- | ------------------------------------------------------------------ |
| Venezuela Civil Register  | `VE_CIVIL_REGISTER`     | Verifies submitted data against Venezuela's civil register.        |

## Venezuela Civil Register

### Request parameters

| Parameter     | Required  | Description                                                                          |
| ------------- | --------- | --------------------------------------------------------------------------------------- |
| `source`      | Mandatory | Must be `VE_CIVIL_REGISTER`.                                                             |
| `country`     | Mandatory | Must be `VE`.                                                                            |
| `idNum`       | Mandatory | Venezuelan Cédula de Identidad (C.I.). 7 to 9 numeric digits.                            |
| `firstName`   | Mandatory | First name of the individual.                                                            |
| `middleName`  | Optional  | Middle name of the individual.                                                           |
| `surName`     | Mandatory | Last name of the individual.                                                             |
| `dateOfBirth` | Optional  | Format: `yyyy-mm-dd`.                                                                    |

### Sample request

```json
{
    "plugins": ["kyc"], //required field
    "source": "VE_CIVIL_REGISTER", //required field
    "firstName": "Maria", //required field
    "middleName": "Isabel",
    "surName": "Fernandez", //required field
    "idNum": "12345678", //required field
    "country": "VE", //required field
    "dateOfBirth": "1991-08-02"
}
```

### Response fields

Venezuela Civil Register anchors verification on the source-of-truth register. See the [eKYC API Reference](/general-reference/ekyc-api-reference/) for common match field definitions and status values.

| Field             | Statuses                              | Description                                                              |
| ------------------ | -------------------------------------- | ------------------------------------------------------------------------ |
| `firstNameMatch`  | `exact`, `fuzzy`, `nomatch`           | Matches first name submitted against the value in the source of truth.  |
| `middleNameMatch` | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches middle name submitted against the value in the source of truth. |
| `lastNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches last name submitted against the value in the source of truth.   |
| `fullNameMatch`   | `exact`, `fuzzy`, `nomatch`           | Matches full name submitted against the value in the source of truth.   |
| `idNumMatch`      | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches Cédula de Identidad submitted against the value in the source of truth. |
| `dobMatch`        | `exact`, `fuzzy`, `nomatch`, `nodata` | Matches date of birth submitted against the value in the source of truth. |
| `overallLevel`    | `low`, `medium`, `high`               | Overall risk level. See below for calculation logic.                    |

### overallLevel calculation

`overallLevel` is calculated based on the risk associated with the submitted full name and Cédula de Identidad:

- `low` when `fullNameMatch` and `idNumMatch` are both `exact`.
- `high` when `fullNameMatch` or `idNumMatch` is `nomatch`.
- `medium` for all other combinations.

Contact your Incode representative to customize the `overallLevel` calculation for your use case.

### Sample response

```json
{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}
```

<br />

---

- Path: `general-reference/video-selfie-webhook`
- URL: https://developer.incode.com/general-reference/video-selfie-webhook/
- Markdown: https://developer.incode.com/general-reference/video-selfie-webhook.md

# Videoselfie upload webhook

The Video Selfie Upload Webhook is triggered when the video selfie capture process is complete and the video data is successfully uploaded to the session.

## Endpoint details

`POST https://{your-defined-url}`

### Request

Below is an example of the payload that you will get when the webhook triggers

```json Sample request payload
{
    "clientId": "<your_clientId>",
    "flowId" : "<your_flowId>", // the flow or configuration to which this interview belongs
    "interviewId": "<interviewId>" // the interview triggering the webhook (ie, the interview to which the video is attached)
}
```

If you are [authenticating your webhook requests](/general-reference/authorizing-webhooks-requests/) , the webhook will contain the `Authorization` header along with the OAuth2.0 bearer token:

`Authorization: Bearer <ACCESS_TOKEN>`

If you configured additional custom headers, they will be included as well.

### Response

To avoid our [retry policy](/general-reference/webhooks-overview/#retry-policy) to keep sending the same notification over and over, make sure your endpoint returns one of the following:

* Status code `204 No content`
* Status code `200 OK` with a response type `application/json`, for example `{ "success" : true }`

```json Sample response
{
   "success" : true 
}
```

---

- Path: `general-reference/webhooks-onboarding`
- URL: https://developer.incode.com/general-reference/webhooks-onboarding/
- Markdown: https://developer.incode.com/general-reference/webhooks-onboarding.md

# Onboarding Webhooks

This section explains webhooks associated specifically with Incode Onboarding Sessions.

- [Onboarding status webhook](/general-reference/onboarding-status-webhook/): Notifies your server each time a module completes and the onboarding status changes.
- [Video selfie upload webhook](/general-reference/video-selfie-webhook/): Notifies your server when the video selfie capture finishes and the video is uploaded to the session.
- [Proof of payment webhook](/general-reference/payment-proof-webhook/): Delivers payment proof data from documents such as utility bills, once all asynchronous processing completes. Mexico only.
- [Work history webhook](/general-reference/work-history-webhook/): Delivers an individual's IMSS work history once all asynchronous processing completes. Mexico only.
- [INE scraping webhook](/general-reference/ine-scraping-webhook/): Reports when an INE Listas Nominales verification starts and when its results are ready to fetch. Mexico only.
- [Global watchlists webhook](/general-reference/global-watchlists-webhook/): Sends asynchronous updates when a subscribed watchlist search returns new security information.

---

- Path: `general-reference/webhooks-overview`
- URL: https://developer.incode.com/general-reference/webhooks-overview/
- Markdown: https://developer.incode.com/general-reference/webhooks-overview.md

# Incode Webhooks

## What are webhooks?

Webhooks are event notifications. They let your organization's application know when a specific event happens on the  Incode platform or when a process initiated by a user is completed (also known as a callback). Your application can then take action based on the notification.

Webhooks are asynchronous. That means the communication is one-way only, from Incode to your application. You must configure them if you want to use them.

## What webhooks are available?

These webhooks are currently supported:

- [Onboarding status webhook](/general-reference/onboarding-status-webhook/): Triggered every time the status changes for an Onboarding Session.
- [Videoselfie upload webhook](/general-reference/video-selfie-webhook/): Triggered when the video selfie recording file (if applicable) becomes available.
- [Global watchlists webhook](/general-reference/global-watchlists-webhook/): Triggered when a global watchlist result is updated.
- [Face Authentication webhook](/general-reference/face-authentication-webhook/): Triggered when a face authentication either succeeds or fails.
- [Work history webhook](/general-reference/work-history-webhook/): Triggered after processing the work history search for a user. This webhook is exclusive to Mexico.
- [Proof of payment webhook](/general-reference/payment-proof-webhook/): Triggered after processing the payment proof validation for a user. This webhook is exclusive to Mexico.
- [Session webhooks](/general-reference/session-webhooks/): Set of four webhooks triggered by specific events during any type of session from a Flow or Workflow:
  - Session Started
  - Session Failed
  - Session Succeeded
  - Session Pending Review
- [KYB Results](/general-reference/kyb-results-webhook): Triggered when a KYB run's final result is ready, including any checks that were still running when the request returned.

The following webhooks either have been or are soon to be deprecated:

- Authentication webhooks - (soon to be deprecated) Available for 1:1 and 1:N. These contain information about the login attempt, any Identities which could match the face reported by the login, and the Onboarding Session (or interview) which best matches the biometric of the face used to login.
- INE scraping webhook - (Deprecated) Provided INE Scraping results asynchronously.

## Configure webhooks

[Create and configure webhooks](/dashboard-platform-administration/configuration-webhooks-tab/) in Dashboard at **Configuration** > **Webhooks**.


### Configure webhook destination

You can configure a single URL per webhook. All notifications from that webhook will be sent to that destination. If you need the webhook notification to be sent to different endpoints in your system, you must broadcast it internally after receiving it at this single endpoint.

### Configure webhooks custom headers

You can create custom headers that your endpoint receives as part of webhook notifications. You can create more than one header, but all headers are sent for all webhooks. Dynamic values are not supported.

## Retry Policy

Webhook retries will be triggered in either of these scenarios:

- A timeout is received when your endpoint is called.
- A status code returned from your service is not one of:
  - `200 OK` along with the `application/json` header or
  - `204 No content`

The webhook retry policy is exponential. It has an initial interval of 30s, a multiplier of 2.5, and a maximum of 5 attempts. This means the maximum time a webhook can take to reach its destination is approximately 32 minutes, as illustrated in the following table.

| Retry attempt | Delay (seconds) | Delay (minutes) | Total (minutes) |
| :------------ | :-------------- | :-------------- | :-------------- |
| 1             | 30              | 0.50            | 0.5             |
| 2             | 75              | 1.25            | 1.75            |
| 3             | 187.5           | 3.13            | 4.88            |
| 4             | 468.75          | 7.81            | 12.69           |
| 5             | 1,171.88        | 19.53           | 32.22           |

## Allow webhook source IPs

If your organization restricts inbound traffic for your network, make sure the following IP addresses are added to your allow list.

### US Environment

#### SAAS (production):

| IP              | Active                 |
| :-------------- | :--------------------- |
| `54.86.34.156`  | Currently Active       |
| `3.142.125.52`  | Currently Active       |
| `54.85.117.182` | As of February 2, 2026 |
| `3.233.40.153`  | As of February 2, 2026 |

#### SAAS US West (production):

| IP | Active |
| :-- | :-- |
| `52.32.21.78` | As of October 27, 2026 |
| `50.112.229.210` | As of October 27, 2026 |
| `44.228.243.221` | As of October 27, 2026 |

### DEMO (development) Environment

- Since October 2024, `34.198.171.165` (previously `18.210.119.234`).

### EU Environment

#### SAAS EU (production and demo):

| IP              | Active           |
| :-------------- | :--------------- |
| `18.158.116.18` | Currently Active |
| `3.127.31.138`  | As of March 2026 |
| `3.126.52.28`   | As of March 2026 |
| `3.126.161.252` | As of March 2026 |

### Canada Environment

#### SAAS CAN (production)

| IP              | Active           |
| --------------- | ---------------- |
| `3.98.9.116`    | Currently Active |
| `16.174.49.119` | As of July 2026  |
| `40.176.78.96`  | As of July 2026  |

<br />

---

- Path: `general-reference/work-history-webhook`
- URL: https://developer.incode.com/general-reference/work-history-webhook/
- Markdown: https://developer.incode.com/general-reference/work-history-webhook.md

# Work history webhook

<Callout icon="📘" theme="info">
  This webhook is exclusive to Mexico.
</Callout>

The work history webhook provides the work history as soon as all asynchronous processes are complete and the data becomes available. This webhook is triggered when the `omni/process/imss` [endpoint](/reference/processimss/) is called and the data is done processing. This is the recommended approach for obtaining the work history data for an individual.

# Work History Endpoint Details

`POST https://{your-defined-url}`

## Request

Below is an example of the payload that you will get in when the webhook triggers

```json Sample webhook payload
{
    "interviewId": "12fj23j2ong0fs848bfks",
    "requestId": "72456dc1-1234-567c-8b9c-10br11122f9r",
    "workHistory": {
        "name": "Marry Sue",
        "curp": "abc123",
        "apiKey": "myapikey",
        "quotedWeeks": {
            "discountedWeeks": 0,
            "listedWeeks": 131,
            "reinstatedWeeks": 0
        },
        "laborHistoryList": [
            {
                "companyName": "DIRECCION DE ADMINISTRACION CENTRAL",
                "state": "DISTRITO FEDERAL",
                "startingDate": "16/10/2021",
                "endingDate": "03/02/2023",
                "baseSalary": "$2593.5",
                "companyIMSSId": "Y123456789"
            },
            {
                "companyName": "DIRECCION DE ADMINISTRACION CENTRAL",
                "state": "DISTRITO FEDERAL",
                "startingDate": "31/08/2021",
                "endingDate": "15/09/2021",
                "baseSalary": "$2240.5",
                "companyIMSSId": "Y987654321"
            },
            {
                "companyName": "TECNOLOGIAS PUBLICA",
                "state": "DISTRITO FEDERAL",
                "startingDate": "01/07/2020",
                "endingDate": "31/08/2021",
                "baseSalary": "$2240.5",
                "companyIMSSId": "Y123459876"
            }
        ]
    }
}
```

If you are [authenticating your webhook requests](/general-reference/authorizing-webhooks-requests/) , the webhook will contain the `Authorization` header along with the OAuth2.0 bearer token:

`Authorization: Bearer <ACCESS_TOKEN>`

If you configured additional custom headers, they will be included as well.

## Response

To avoid our [retry policy](/general-reference/webhooks-overview/#retry-policy) to keep sending the same notification over and over, make sure your endpoint returns one of the following:

* Status code `204 No content`
* Status code `200 OK` with a response type `application/json`, for example `{ "success" : true }`

---

- Path: `get-started-with-incode/getting-credentials`
- URL: https://developer.incode.com/get-started-with-incode/getting-credentials/
- Markdown: https://developer.incode.com/get-started-with-incode/getting-credentials.md

# Getting Your API Credentials

Before you can make API calls or run SDK integrations, you need an Incode API key and a Client ID. How you get them depends on where you are in the process with Incode.

***

## If Your Organization Is Not Yet a Contracted Customer

New prospects typically start in the **Demo environment**. This is Incode's shared, multitenant evaluation environment. Demo gives you full access to the Omni API for testing and proof-of-concept work without a production commitment.


To request Demo environment access, contact your Incode representative or reach out through [the Incode website](https://incode.com). Once your access is set up, you'll receive a credentials bundle (see [What's in the credentials bundle](#whats-in-the-credentials-bundle) below).

### What to Expect During Evaluation

Demo access typically comes with the following constraints:

- **Time-limited access**: evaluation periods are time-boxed. Your Incode contact can confirm the duration for your engagement
- **Synthetic data only**: use sample or test data during integration work. Avoid real end-user data in the Demo environment
- **Volume and cost controls**: some verification checks in Demo may have usage limits, particularly those that involve third-party data providers
- **Happy-path configuration**: Demo may require specific allowlist settings to test successfully with synthetic IDs. Your Incode contact can assist with this setup

<Note>
Access to a production environment before an MSA is signed is handled on a case-by-case basis and requires explicit approval. If you need production access during your evaluation, discuss this with your Incode contact early in the process.
</Note>

***

## If Your Organization Is a Contracted Customer

Once your contract is in place, you'll typically have access to two environments:

| Environment        | Purpose                                                                                                                                              |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Demo (Sandbox)** | Integration development, testing, CI pipelines. Use synthetic data.                                                                                  |
| **Production**     | Live customer verifications. Your production environment may be SaaS multitenant or a dedicated single-tenant deployment depending on your contract. |

Each environment has its own set of credentials. Keep them separate and never use production credentials in development or test code paths.


***

## What's in the Credentials Bundle

When your environments are provisioned, Incode shares a credentials bundle as described in this table.

| Item           | Description                                              |
| -------------- | -------------------------------------------------------- |
| `clientId`     | Identifies your organization's account in Incode Omni    |
| `apiKey`       | Authenticates your API requests (keep this secret)       |
| API base URL   | The root endpoint for Omni API calls in this environment |
| Onboarding URL | The entry point for hosted onboarding flows              |
| Dashboard URL  | The URL for your Omni Dashboard instance                 |

Credentials are typically shared via a secure link using 1Password. Do not share API keys over email, Slack, or other unencrypted channels.

***

## Managing Your API Keys in Dashboard

Once you have Dashboard access, you can [view and manage your API keys](/dashboard-platform-administration/configuration-api-keys-tab/) under **Configuration → API Keys**.



















***

## Next Steps

With your credentials in hand:

- See API Authentication Overview for how to use your credentials in API requests — required headers, token types, and session management.
- See [Quick Start](/get-started-with-incode/quickstart/) to run your first verification end to end.

---

- Path: `get-started-with-incode/glossary`
- URL: https://developer.incode.com/get-started-with-incode/glossary/
- Markdown: https://developer.incode.com/get-started-with-incode/glossary.md

# Incode Glossary

This page defines the terms you will encounter across the Incode Platform documentation. Terms are grouped by topic. Use the alphabetical index below to jump directly to any term.

***

## Alphabetical Index

[Admin Token](#admin-token) · [Age Assurance](#age-assurance) · [AML](#aml) · [API Key](#api-key) · [Authentication](#authentication) · [Authorization](#authorization) · [Biometric Template](#biometric-template) · [Capture-Only Mode](#capture-only-mode) · [Claims Match](#claims-match) · [Client ID](#client-id) · [Condition Node](#condition-node) · [Configuration ID](#configuration-id) · [Crosscheck](#crosscheck) · [Custom Fields](#custom-fields) · [Customer UUID](#customer-uuid) · [Dashboard](#dashboard) · [Device and Behavior Risk Check](#device-and-behavior-risk-check) · [Deepsight](#deepsight) · [Digital ID Verification](#digital-id-verification) · [Document Verification](#document-verification) · [eKYB](#ekyb) · [eKYC](#ekyc) · [Email Risk Check](#email-risk-check) · [EXIF](#exif) · [External Customer ID](#external-customer-id) · [External ID](#external-id) · [E2EE Mode](#e2ee-mode) · [Face Authentication](#face-authentication) · [Face Match](#face-match) · [Flow](#flow) · [GovMatch](#govmatch) · [IAM](#iam) · [Identity Provider (IdP)](#identity-provider-idp) · [Images](#images) · [Incode Identity](#incode-identity) · [interviewId](#interviewid) · [KYB](#kyb) · [KYC](#kyc) · [Liveness Detection](#liveness-detection) · [Manual Review](#manual-review) · [Module](#module) · [Module Node](#module-node) · [MRZ](#mrz) · [NFC Scan](#nfc-scan) · [OCR](#ocr) · [OIDC](#oidc) · [Omni API](#omni-api) · [Onboarding Attempts](#onboarding-attempts) · [Onboarding Session](#onboarding-session) · [PEP](#pep) · [Phone Risk Check](#phone-risk-check) · [Prizma](#prizma) · [Process Node](#process-node) · [Proof of Address](#proof-of-address) · [Queue](#queue) · [Result Node](#result-node) · [Rules Engine](#rules-engine) · [Score](#score) · [Silent Network Authentication (SNA)](#silent-network-authentication-sna) · [SDK](#sdk) · [Session Status](#session-status) · [Session Token](#session-token) · [UBO](#ubo) · [Video Selfie](#video-selfie) · [Watchlist](#watchlist) · [Webflow](#webflow) · [Webhook](#webhook) · [Workflow](#workflow) · [1:1 Face Authentication](#11-face-authentication) · [1:N Face Authentication](#1n-face-authentication)

***

## Sessions and Identifiers

### Onboarding Session

A container for one user's identity verification process. Every image, document, selfie, score, and event produced during verification is attached to the session. A new session must be created for each verification attempt, even if the same person is attempting again.

_Also called:_ interview, session

→ [Onboarding Session Lifecycle](onboarding-session-lifecycle)

***

### interviewId

The unique identifier for an Onboarding Session. It is an alphanumeric string assigned by the Incode platform when a session starts. Every API call that reads or writes data for a specific session uses the `interviewId` to identify it.

`interviewId` is the term used in code and API parameters. In Dashboard, the same identifier is called the **Session ID**. Both refer to the same value.

***

### Onboarding Attempts

Each time a user goes through the onboarding process, that attempt creates a new Onboarding Session with a unique Session ID (interviewId), regardless of whether the user completed or abandoned the process. Key behaviors include:

- Users can make multiple attempts using the same or different Workflow or Flow.
- Each attempt has its own score, so the same person may have a different result for each attempt.
- Multiple attempts by the same person can be linked using a shared externalCustomerId.

***

### Session Token

A short-lived credential returned when a session is created. The session token is passed to the SDK so the front end can interact with Incode's API on behalf of that specific session. It is separate from the API key, which identifies your organization. The session token identifies one user's session.

Do not expose your API key on the front end. Use the session token on the front end and keep the API key on your back end.

→ [How to get an access token](/reference/how-to-get-an-session-token/)

***

### Admin Token

A credential used by your back end to call Incode API endpoints that require elevated access, such as fetching session results or verifying a face authentication attempt. The admin token is never sent to the front end.

→ [How to get an access token](/reference/how-to-get-an-session-token/)

***

### API Key

A credential that identifies your organization to the Incode platform. It is included as the `x-api-key` header in every API request from your back end. Treat your API key as a secret — do not include it in front-end code or expose it in client-side logs.

→ [Request Header](/reference/how-to-get-an-session-token/#request-header)

***

### Configuration ID

The identifier for a Flow or Workflow configuration as defined in the Omni Dashboard. Also called a **flow ID**. When you initialize an SDK session or start a session via the API, you pass the Configuration ID to tell the platform which set of modules and settings to use for that session.

***

### External Customer ID

A string you define in your own system, such as a user ID or account number, that links an Incode Onboarding Session to a record in your database. It is stored in the session and returned in API responses and webhook payloads so you can match Incode results back to your users. Multiple onboarding attempts by the same person can be linked via the same `externalCustomerId`.

***

### External ID

Similar to External Customer ID, but with different resumption behavior. If a session already exists for a given `externalId`, submitting the same value resumes that session instead of creating a new one. Use this when you want to prevent duplicate sessions for the same user.

***

### Custom Fields

Key-value pairs that allow you to attach additional metadata to an Onboarding Session. Custom Fields are flexible tags you define that can be retrieved later via the API. They are useful for advanced session filtering, analytics, and integrations with external systems.

***

### Customer UUID

A unique identifier assigned to a verified user when their Incode Identity is created after a successful onboarding. It represents the person's biometric identity in the Incode platform and is required for 1:1 face authentication on return visits.

***

### Session Status

The current state of an Onboarding Session. Statuses are set by the platform as modules complete. Key statuses include:

- `UNKNOWN`: Session created but no data collected yet
- `ID_VALIDATION_FINISHED`: ID document processing is complete
- `FACE_VALIDATION_FINISHED`: Selfie and face match processing is complete
- `GOVERNMENT_VALIDATION_FINISHED`: Government database check is complete
- `ONBOARDING_FINISHED`: All modules have run and the session is complete
- `APPROVED`: Session score met the threshold and the user was approved
- `MANUAL_REVIEW`: Session was flagged for human review
- `MANUAL_REVIEW_APPROVED`: A reviewer approved the session
- `MANUAL_REVIEW_REJECTED`: A reviewer rejected the session

→ [Onboarding Session Lifecycle](onboarding-session-lifecycle)

***

## Flows, Workflows, and Modules

### Flow

A legacy configuration method for defining the steps of an Onboarding Session. Flows are configured in Dashboard and referenced by a Configuration ID. New integrations should use **Workflows** instead. Flows remain supported but are no longer the recommended approach.

→ [Flows](flows-1)

***

### Workflow

The current, recommended way to configure an Onboarding Session. A Workflow is built in Dashboard using a visual drag-and-drop builder. It defines which verification modules run, in what order, and what logic determines the outcome. Workflows support conditional branching, meaning different users can follow different paths based on their data or scores.

→ [Workflows Overview](workflows)

***

### Module

A single step in an Onboarding Session. Each module handles one task: for example, capturing an ID document, taking a selfie, or running an eKYC check. Modules are selected and configured when building a Flow or Workflow. Some modules collect data from the user (capture modules), and some process or validate data that was already collected (process modules).

_Also called:_ Verification Module.

→ [Modules Overview and Availability](/features-and-modules/modules-overview-and-availability/)

***

### Module Node

In the Workflow builder, a Module Node represents a step that involves the customer, such as ID capture, selfie capture, or consent. Module nodes are the interactive steps a user sees and acts on during an Onboarding Session.

→ [Create Workflows](/dashboard-platform-administration/workflows-20/#create-workflows)

***

### Process Node

In the Workflow builder, a Process Node runs automatically without customer interaction. It processes or validates data collected by a preceding module: for example, running a face match after a selfie is captured, or performing an eKYC check after ID data is extracted. Process Nodes must follow the relevant Module Nodes in the workflow.

→ [Create Workflows](/dashboard-platform-administration/workflows-20/#create-workflows)

***

### Condition Node

In the Workflow builder, a Condition Node branches the customer journey based on data or scores. For example, a condition can route a customer to manual review if their ID score is below a threshold or skip a step if a previous check already passed. Conditions use AND/OR logic and can evaluate scores, module results, or custom field values.

→ [Conditions for Workflows](/concepts-and-architecture/condition-use-cases/)

***

### Result Node

In the Workflow builder, a Result Node ends a branch of the customer journey. Every branch in a Workflow must end with a Result Node. The Result Node sets the final outcome of the session for that path: `OK`, `FAIL`, `MANUAL`, or `WARN`.

→ [Create Workflows](/dashboard-platform-administration/workflows-20/#create-workflows)

***

### Webflow

A hosted web application created in Dashboard that runs a complete Onboarding Session. Users access it via a URL; no SDK integration is required. Webflows are the no-code option for deploying identity verification.

_Also called:_ Hosted Flow, Onboarding URL.

***

### Rules Engine

A configuration tool in Dashboard that lets you define automatic decision logic for sessions using Flows. Rules evaluate scores and module results to determine whether a session is approved, denied, or sent to manual review without requiring custom back-end code.

→ [Flows](flows-1)

***

### Crosscheck

A comparison step that checks whether a specific piece of data from one source matches the same data from another source within the same session. For example, a crosscheck can compare the name extracted from an ID document against the name on a utility bill submitted as proof of address. Crosschecks are configured in Dashboard and run as Process Nodes in a Workflow.

→ [Fetching Crosscheck Results](fetching-crosscheck-results)

***

## Scores and Decisions

### Score

A numerical value that represents how confident the platform is in the result of a verification step. Each module produces its own score, and the platform calculates an overall session score based on the modules configured as validation modules. Your back end uses scores to approve, reject, or flag sessions for manual review.

Score thresholds are configured per Flow or Workflow in Dashboard.

***

### Manual Review

A state in which a session is held for a human reviewer to examine before a final decision is made. A session enters Manual Review when its score falls in a range defined as requiring human judgment, typically between the automatic-approve and automatic-reject thresholds. Reviewers access flagged sessions through Dashboard.

***

### Queue

A named group to which sessions are assigned when they require manual review. Queues allow organizations to route sessions to specific reviewer teams: for example, by region, product line, or risk level. Queues are configured in Dashboard and can be specified per session when using the Video Conference module.

***

## Verification Capabilities

### Authentication

Authentication is the process of confirming that users are who they say they are. It serves as the initial step in a security procedure.

→ [Onboarding or Authentication: When to Use Each](/concepts-and-architecture/onboarding-vs-authentication/)

***

### Authorization

The process of granting a user permission to access a particular resource or perform a specific function. Authorization is often used interchangeably with access control or client privileges, but it is distinct from authentication: authentication verifies who a user is, while authorization decides what they are allowed to do.

Incode does not provide an authorization layer. Incode returns a result, and your application decides what action to take.

***

### Liveness Detection

A check that confirms a selfie was captured from a live person rather than from a photo, video, or synthetic image. The Incode platform supports both:

- **Passive liveness**: No user action required.
- **Active liveness**: The user is prompted to perform an action.

Incode's liveness detection is certified to ISO/IEC 30107-3.

Liveness detection within Incode's Deepsight suite is divided into three sub-checks:

- **Physical Check**: Masks, printed photos
- **Digital Check**: Screen replay, injected video
- **Evasion Check**: Attempts to bypass detection

→ [Deepsight](/features-and-modules/deepsight/)

***

### Face Match

A comparison between the selfie captured during an Onboarding Session and the photo on the ID document submitted in the same session. A passing face match confirms that the person holding the ID is the same person shown in the document. Face match is a process step that runs after both an ID capture and a selfie capture are complete.

***

### Face Authentication

A post-onboarding capability that lets a previously verified user prove their identity using a selfie. Incode face authentication verifies identity, confirms that users are real, and detects common fraudulent behavior through liveness checks, physical and digital attack detection, image quality checks, and face checks such as lenses, hats, closed eyes, and face masks. Two modes are available: 1:1 (one-to-one) and 1:N (one-to-many).

→ [Face Authentication](/features-and-modules/face-authentication/)

→ [Onboarding or Authentication: When to Use Each](/concepts-and-architecture/onboarding-vs-authentication/)

***

### 1:1 Face Authentication

In one-to-one face authentication, the user provides a selfie and an Authentication Hint—typically their customer UUID—to claim a specific identity. The platform compares the selfie's biometric template against the biometric template stored in that enrolled identity.

***

### 1:N Face Authentication

In one-to-many face authentication, the user provides only a selfie. The platform compares the selfie's biometric template against all enrolled identities in the database and identifies the closest match, without requiring the user to claim an identity first. This capability is unique to Incode among major identity verification platforms.

***

### Incode Identity

A record created in the Incode platform when a user successfully completes an Onboarding Session and is approved. It stores the user's biometric template, extracted from their selfie, and is identified by a Customer UUID. An Incode Identity is required for face authentication on return visits. If any module in the onboarding fails and the session is not approved, an Incode Identity is not created.

→ [View Identites in Dashboard](/dashboard-platform-administration/view-identities/)

***

### Biometric Template

A mathematical representation of a person's facial features, generated from their selfie during onboarding. The template is used for face authentication; it is compared against a new selfie to confirm identity. The template itself is not a photograph; it cannot be reverse engineered into an image.

***

### OCR

Optical Character Recognition (OCR) is the process of extracting text from an image. During an Onboarding Session, Incode uses OCR to read the data printed on an ID document and return it as structured data in the API response. The data extracted depends on the document type: a two-sided document such as a driver's license yields different fields than a one-sided document such as a passport.

***

### Document Verification

The automated process of confirming that a government-issued identity document—such as a passport, driver's license, or national ID—is genuine, unaltered, and has not been previously used to commit fraud. Incode uses more than 35 in-house ML models to analyze ID images in real time. Document validation is available for over 10,000 document types and 200 countries and regions.

Document verification detects:

- Tampered photos and data fields
- Counterfeit or non-compliant document formats
- Reused or duplicated documents across sessions

***

### Digital ID Verification

The automated process of accepting and validating digital identification documents, such as IDs stored in mobile wallets or issued through digital identity systems. Digital ID verification detects available digital IDs on a user's device, validates their authenticity and integrity via cryptographic checks, and automatically routes users to physical document verification when a digital ID is unavailable.

***

### Images

Three main types of images may be captured and linked to an Onboarding Session:

- Front and back images of an ID document (back image applies to two-sided documents such as driver's licenses).
- Selfie images.
- Images of supplementary documents, such as proof of address.

A session may contain more than one image of the same type if a user needs to perform a recapture for any reason.

***

### EXIF

Exchangeable Image File Format (EXIF) metadata is information automatically embedded in an image file by the device that captured it. It travels with the image and usually includes:

- When the photo was taken (timestamp)
- What device took it (camera make, model)
- How it was taken (shutter speed, aperture, focal length, flash)
- Where it was taken (GPS coordinates, if location was enabled)

***

### MRZ

The Machine-Readable Zone (MRZ) is the two or three lines of text at the bottom of a passport or ID card that encode the document's key data in a standardized format. Incode reads and validates MRZ data as part of document verification.

***

### NFC Scan

Near Field Communication (NFC) scan is a method of reading the embedded chip in an ePassport or chip-enabled ID card. NFC scanning retrieves digitally signed data directly from the chip, providing a higher level of document authenticity assurance than optical scanning alone. Available in the iOS, Android, and Flutter SDKs.

***

### GovMatch

A verification step that checks identity data extracted from an ID document against an authoritative government database or registry. This confirms that the identity exists in the official record and matches the data on the document. Incode has direct integrations with government sources in Mexico (RENAPO, CURP, INE, SAT), Brazil, Argentina, Colombia, Chile, Peru, South Africa, Australia, and more.

**Previously called**: Government Validation; Government Verification; Government Record Verification.



→ [GovMatch](/general-reference/government-verification-sources/)

***

### eKYC

Electronic Know Your Customer (eKYC) is a non-document identity check that cross-references a user's data against trusted external data sources—such as credit bureau records, phone number registries, or email risk databases—to confirm the identity exists and is in good standing. eKYC checks supplement document and biometric verification and are commonly required for financial services compliance.

→ [eKYC Module](/features-and-modules/ekyc/)

***

### eKYB

Electronic Know Your Business (eKYB) is a verification check that confirms a business entity is real, legally registered, and not subject to sanctions. eKYB can verify the business name, tax ID, registration status, address, and, where required, the identities of its Ultimate Beneficial Owners (UBOs). Incode supports eKYB in 15+ countries.

→ [eKYB Module](/features-and-modules/ekyb/)

***

### Email Risk Check

An eKYC signal that evaluates the fraud risk of an email address a user submitted during sign-up or login. It analyzes indicators such as email age, reputation, usage patterns, spam signals, and watchlist status to produce a risk score. You can configure that risk score against low, medium, high, or custom thresholds to inform downstream decisioning.

Email Risk Check detects:

- Disposable, temporary, or undeliverable email addresses
- Compromised or breach-exposed accounts
- Suspicious usage patterns associated with fraud

***

### Phone Risk Check

An eKYC signal that evaluates the fraud risk of a phone number a user submitted. It uses carrier data, number type, and historical usage to determine the phone number's validity, activity status, VOIP or prepaid classification, and leak exposure. It also determines a risk level (low, medium, high, or very high) to inform decisioning.

Phone Risk Check detects:

- Recycled, virtual (VoIP), or prepaid numbers commonly linked to fraud
- Inactive, improperly formatted, or undeliverable numbers
- Numbers with known spammer associations

***

### Device and Behavior Risk Check

A passive fraud detection layer that analyzes the user's device environment and behavioral patterns throughout the verification session. Device intelligence covers attributes such as IP address, geolocation, OS/browser configuration, and network anomalies. Behavioral signals capture interaction patterns such as typing cadence, touch dynamics, and navigation flow. Together, they detect bots, account takeovers, and synthetic behavior in real time, triggering step-up verification only when risk is high.

Device and Behavior Risk Check detects:

- Device spoofing, emulation, proxy use, and network anomalies
- Bot-like or scripted interaction patterns
- Session behavior consistent with account takeover or synthetic identity fraud

***

### UBO

The Ultimate Beneficial Owner (UBO) is the individual who ultimately owns or controls a business entity, typically defined as owning 25% or more of the company. Many KYB regulations require businesses to identify and verify their UBOs as part of onboarding.

***

### Proof of Address

A document—such as a utility bill, bank statement, or government letter—that confirms a user's residential address. Incode can capture and process proof of address documents as a module in an Onboarding Session, including OCR extraction of the address and crosscheck comparison against the address on the user's ID.

***

### Watchlist

A list of individuals or entities against which a user's identity is screened. The Incode platform supports three types:

- **Global Watchlist**: Screens against international sanctions lists, Politically Exposed Persons (PEP) databases, and other regulatory watchlists.
- **Custom Watchlist**: A list you manage in Dashboard. Can be configured as a Blocklist (deny matches) or an Allowlist (approve matches).
- **Watchlist for Business**: A list that works together with eKYB.

→ [Watchlists](/features-and-modules/business-watchlist/)

***

### PEP

A Politically Exposed Person (PEP) is an individual who holds or has held a prominent public position, such as a government official, senior executive of a state-owned company, or senior military officer. Regulatory frameworks require organizations to apply enhanced due diligence when onboarding PEPs. Incode's Global Watchlist module screens for PEPs as part of Anti-Money Laundering (AML) compliance.

***

### Age Assurance

A module that estimates a user's age from their selfie using AI, without requiring a government ID. Age Assurance is used in regulated contexts where a platform needs to confirm a user meets a minimum age requirement. It is distinct from age verification via ID document.

When Age Assurance is enabled, session recording options for ID Capture and Face Capture are restricted. Deepsight recordings are deleted on session completion.

Age Assurance requires additional licensing. Contact your Incode Representative.

***

### Video Selfie

A module that records a short video of the customer responding to voice-prompted questions. The video serves as a high-assurance liveness check and produces a video artifact for compliance and audit purposes. This module is unique to Incode: no other major IDV platform in this space offers a voice-prompted video selfie with a recorded Q\&A format.

***

### Silent Network Authentication (SNA)

Silent Network Authentication is a carrier-based phone verification method that confirms a user's possession of a mobile number directly through the mobile network. Instead of relying on one-time passwords (OTP), SNA runs silently in the background. This eliminates user friction and protects against phishing, SIM swaps, and interception attacks. When SNA isn't available for a given number or carrier, flows automatically fall back to SMS OTP.

See [Silent Network Authentication](/features-and-modules/silent-network-authentication-sna/) for full details.

***

### Step-Up



An additional check or document collection for someone who has already completed onboarding. Examples include signing a document, providing proof of address, or upgrading to a higher account tier.

Step-ups run in a new session linked to the user's identity. See [Migration Guide: Step-Up and Additional Checks](/general-reference/step-up-and-additional-checks).



***

### Claims Match

A step that cross-checks verified identity attributes—such as name, date of birth, phone number, or email—from an Incode session against records in an external directory, such as an identity and access management (IAM) system or HR database. Claims match is used to confirm that the person being verified matches a known record in your organization. It is available in Workforce integrations.

***

### Deepsight

Incode's dedicated deepfake and fraud defense suite. Deepsight evaluates the authenticity of a selfie capture across multiple dimensions:

- **Physical Check**: Detects physical spoofs such as printed photos, masks, and mannequins.
- **Digital Check**: Detects digital attacks such as screen replay and injected video feeds.
- **Evasion Check**: Detects attempts to bypass the liveness check system.
- **Behavioral Trust**: Evaluates device and interaction behavior for anomalies.
- **Device Trust**: Assesses the trustworthiness of the device being used.

Deepsight also produces a Media Manipulation Index (MMI) score for document images, indicating whether a document image shows signs of digital manipulation.

Deepsight requires additional licensing. Contact your Incode Representative.

→ [Deepsight](/features-and-modules/deepsight/)

***

## Platform Components

### Dashboard

The web-based administration application for the Incode Platform. Used to configure Flows and Workflows, review session results, manage users and roles, set up webhooks, and access analytics. Both developers and operations teams use Dashboard.

***

### Omni API

The REST API that powers the Incode platform. Your back end uses the Omni API to create sessions, submit verification data, retrieve scores and OCR results, and trigger platform actions. All API requests require an API key header (`x-api-key`) and most session-level requests also require a session token or admin token.

→ API Reference

***

### SDK

&#x20;The software development kit (SDK) is a library that handles the capture UI, camera management, and API communication for an Incode integration. Incode provides SDKs for Web, iOS, Android, React Native, Flutter, Xamarin, Cordova, and Ionic Capacitor. Using an SDK is the recommended integration approach for most use cases. It handles image quality optimization, device compatibility, and data submission automatically.

→ [SDK Reference](/sdk-reference/sdk-reference/)

***

### Prizma

Incode's design system for user interfaces. Prizma provides a documented set of design tokens, component specifications, and customization guidelines that allow you to match the verification UI to your product's visual identity. It supports light and dark mode and includes V1 and V2 component comparisons. No other major IDV platform publishes a design system at this level of detail.

→ [Prizma Design System](/design-and-ux/prizma-design-foundations/)

***

### Capture-Only Mode

An SDK integration mode for iOS and Android SDKs that separates the capture layer from the processing layer. In Capture-Only mode, the Incode SDK handles camera access and image quality optimization, but the captured data is sent to your own back end rather than directly to Incode's processing servers. Useful for privacy-constrained architectures or hybrid setups.

***

### E2EE Mode

End-to-end encryption (E2EE) mode is an integration variant for iOS and Android SDKs in which all captured data is cryptographically encrypted on the device before transmission to Incode's servers. Useful for high-assurance deployments with strict data security requirements. No other major IDV platform publicly documents an E2EE integration mode.

***

### Webhook

An HTTP callback that the Incode platform sends to your back end when a session event occurs: for example, when a session status changes, a module completes, or a video selfie is uploaded. Webhooks let your back end react to verification events without polling the API. Webhook requests can be authenticated using an OAuth 2.0 bearer token.

→ [Webhooks](/general-reference/webhooks-overview/)

***

## Compliance and Regulatory Terms

### KYC

Know Your Customer (KYC) is a regulatory requirement that obligates financial institutions and other regulated organizations to verify the identity of their customers before and during a business relationship. KYC is a core driver for identity verification in banking, fintech, insurance, and other regulated industries.

***

### KYB

Know Your Business (KYB) is the business-entity equivalent of KYC. Organizations in regulated industries must verify that businesses they onboard are legitimate, legally registered, and not subject to sanctions. They must also identify the individuals who own or control them.

***

### AML

Anti-Money Laundering (AML) is a set of laws, regulations, and procedures that require financial institutions to detect and prevent money laundering. KYC and watchlist screening are both components of AML compliance. Incode's platform supports AML workflows through global watchlist screening, eKYC checks, and sanctions screening.

***

### IAM

Identity and access management (IAM) is a framework for controlling who can access what resources in an organization. In the context of Incode's platform, IAM integration refers to connecting Incode's identity verification capabilities with IAM systems such as Okta or Microsoft Entra, so that verification results can drive access decisions.

***

### Identity Provider (IdP)

A system that authenticates users and provides identity assertions to other applications. Incode can act as an Identity Provider using the OpenID Connect (OIDC) protocol, allowing other applications to accept Incode's biometric authentication as a login method.

***

### OIDC

OpenID Connect (OIDC) is an authentication protocol built on top of OAuth 2.0. It allows applications to verify the identity of a user based on authentication performed by an Identity Provider. Incode supports OIDC for both consumer-facing authentication flows and workforce integrations with systems like Okta and Microsoft Entra.

→ [OIDC Automatic Configuration](/concepts-and-architecture/oidc-automatic-configuration/)

→ [OIDC Manual Configuration](/concepts-and-architecture/oidc-manual-configuration/)

***

### Client ID

In the context of OIDC integrations, a client ID is the identifier assigned to your application when it is registered with Incode as an Identity Provider. It is included in OIDC authentication requests to identify which application is requesting authentication.

---

- Path: `get-started-with-incode/incode-devhub-mcp`
- URL: https://developer.incode.com/get-started-with-incode/incode-devhub-mcp/
- Markdown: https://developer.incode.com/get-started-with-incode/incode-devhub-mcp.md

# Connect to the Incode DevHub MCP

The Incode DevHub MCP server lets AI assistants that support the Model Context Protocol (MCP) search and read the Incode Developer Hub, including guides, SDK reference, and REST API reference. The server is public and read-only, and it does not require an API key.

**Endpoint**: `https://developer.incode.com/mcp`

## Claude (web and desktop): custom connector

1. Open **Settings** > **Connectors** > **Add** > **Add custom connector**.
2. For **Name**, enter `Incode DevHub`. For **URL**, enter `https://developer.incode.com/mcp`. Then click **Add**.
3. In a chat, turn the connector on from the tools menu under the prompt box.
4. To confirm it works, ask: "Using the Incode DevHub, how do I get my API credentials?" Claude should search the docs and cite pages from this site.

:::note 
For Team and Enterprise plans, an organization Owner may need to add the connector first, under **Admin settings** > **Connectors**.
:::

## Claude Desktop: config file

Use this option if you prefer to manage connections in a configuration file. It requires [Node.js](https://nodejs.org), because `npx` runs a small bridge program (`mcp-remote`) that connects Claude Desktop to the remote server.

1. Open **Settings** > **Developer** > **Edit Config**.
2. Add the following entry. If the file already has an `mcpServers` section, add `incode-devhub` inside it instead of pasting a second `mcpServers` block.

```json
{
  "mcpServers": {
    "incode-devhub": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://developer.incode.com/mcp"]
    }
  }
}
```

3. Save the file and restart Claude Desktop.

## Claude Code

Run this command in your terminal:

```shell
claude mcp add --transport http incode-devhub https://developer.incode.com/mcp
```

By default, the server is available only in the current project. To make it available everywhere, add `--scope user` before the server name.

To confirm it is connected, run `claude mcp list`.

## Troubleshooting

- **The connector doesn't appear in the tools menu.** Confirm it is added and turned on for the current chat. On Team or Enterprise plans, check with your org Owner.
- **`npx` not found.** Install Node.js, then restart Claude Desktop.
- **Claude Desktop won't start after editing the config.** The JSON is likely invalid, often from a missing comma or a duplicate `mcpServers` block. Check the file with a JSON validator.

---

- Path: `get-started-with-incode/onboarding-session-lifecycle`
- URL: https://developer.incode.com/get-started-with-incode/onboarding-session-lifecycle/
- Markdown: https://developer.incode.com/get-started-with-incode/onboarding-session-lifecycle.md

# Onboarding Session Lifecycle

This page describes the main steps of an Incode Onboarding Session. Understanding these steps helps you successfully integrate Incode with your existing verification and onboarding processes.

![](https://developer.incode.com/assets/80f6b045fd89162d08cf363d56de411d.png)

<br />

The main steps are:

1. **A new Onboarding Session is created**: A new Onboarding session must be created for each onboarding attempt.
2. **The customer completes the Onboarding Session**: The customer goes through the required verification modules, either on the Incode Webflow app or your own web or mobile app powered by the Incode SDK and APIs.
3. **Add-on modules are executed**: Run additional verification modules that may or may not require end-user interaction. This step is optional.
4. **Session is marked as complete**: After all the verification modules have been executed, the session must be marked as complete. This is a critical indicator of the conversion and completion metrics.
5. **Final results and onboarding data retrieval**: Get the final results (Scores) to make decisions and fetch the data collected during onboarding. There are two options:
   - Review and download results on Dashboard.
   - Call the Omni API from your back end. You can trigger this fetch process by notifying your back end from your web or mobile app using App Orchestration. Alternatively, your back end can wait for the Incode Platform [webhook](/get-started-with-incode/glossary/#webhook) notification.

## Onboarding Session Statuses

All Onboarding Sessions have a completion status, which the Incode Platform automatically manages. The status changes depending on which modules are executed during the Onboarding Session.

Not all verification modules influence the session status.

The following diagram shows how statuses change during the Onboarding Session lifecycle:

![](https://developer.incode.com/assets/0a30260ea3d4b14aa66ff53bbc8f6169.png)

Possible statuses include:

- `UNKNOWN`: Initial status. No data has been collected yet.
- `ID_VALIDATION_FINISHED`: ID document validation has finished. OCR data was extracted from the document. A score for this module has been calculated.
- `POST_PROCESSING_FINISHED`: ID post-processing has finished. This status is used in specific implementations where extra data review is required.
- `FACE_VALIDATION_FINISHED`: Face Match has been completed. This module compares the selfie captured with the photo from the ID document. A score for this module has been calculated.
- `GOVERNMENT_VALIDATION_FINISHED`: Validation against a third-party source of truth has finished. A score for this module has been calculated.
- `ONBOARDING_FINISHED`: The Onboarding Session has finished. The session has been marked "Completed." Scores and onboarding data are ready and can be fetched.
- `MANUAL_REVIEW_APPROVED`: A session that was in a \_**Needs Review** state has been manually approved by a reviewer.
- `MANUAL_REVIEW_REJECTED`: A session that was in \_**Needs Review** state has been manually rejected by a reviewer.

***

## Get Onboarding Status

You can get the status of a specific Onboarding Session in one of two ways, depending on the integration type, application architecture, and your internal security policies. You can either:

- Poll the Omni API endpoint `/omni/get/onboarding/status`.
- Use the onboarding webhook notification.

Refer to [Integrate by Platform](/integrate-by-platform/) for available options and integration guides.

<br />

---

- Path: `get-started-with-incode/quickstart`
- URL: https://developer.incode.com/get-started-with-incode/quickstart/
- Markdown: https://developer.incode.com/get-started-with-incode/quickstart.md

# Quick Start: Your First Verification

This guide has two parts:

- [​Part 1](#part-1-create-and-run-a-verification-session) runs a real verification session using a hosted Incode Webflow—no code required. You see exactly what your customers experience before you write a single line of integration code.
- [Part 2](#part-2-integrate-the-web-sdk) walks you through a minimal Web SDK integration that produces the same result programmatically. By the end, your app creates a session, runs ID and selfie capture, and reads the verification score.

***

## Part 1: Create and Run a Verification Session

You will run a test verification session using a template Workflow.

### Step 1.1: Create a Workflow in Dashboard

A Workflow defines the verification steps your users will go through. You need one before you can run a session.

1. Log in to Dashboard and click **Workflows** in the left menu.
2. Click **New**.
3. In the lower left corner of the Workflow builder, click **Template**.
4. Locate the Identity Verification template and click **Use**. This template comes pre-configured with the standard modules for a complete verification: Data Sharing Consent, ID Capture, ID Validation, Face Capture, Face Match, and a result condition.
5. If prompted to replace what's in the canvas with the template, click **Replace with template**.
6. In the top left corner, click **Edit** to give your Workflow a meaningful name.
7. Click **Save & Publish**.

> 📘 Note
>
> You can configure Workflow-level settings and module-level settings to customize the data collected and the user experience. For this quick start, we recommend leaving the default configuration as-is.

For a deeper look at creating Workflows, using templates, and changing configuration settings, see [Workflows](/dashboard-platform-administration/workflows-20/)​.

### Step 1.2: Copy Your Workflow ID and Onboarding URL

When the Workflow is saved, Dashboard assigns it a unique Configuration ID (also called a Workflow ID). Active Workflows also have an Onboarding URL. You will need both later in this guide. To copy them:

1. In the left menu, click **Workflows**.
2. In the Actions column for the Workflow you created, click the three-dot menu.
3. Click **Copy ID**. This is the Workflow ID. Paste it somewhere you can easily access it later.
4. Click **Copy URL**. This is the Onboarding URL. Paste it somewhere you can easily access it later.

You can also generate a session URL on demand from your back end. You will do this in Part 2.

### Step 1.3: Complete a Test Session

1. In the Actions column for the Workflow you created, click **Test workflow**.
2. Scan the QR code on your phone to open the Onboarding.
3. Go through the verification steps:
   1. Grant camera permission when prompted.
   2. Scan the front and back of a government-issued ID.
   3. Take a selfie when prompted.
   4. Wait for the result screen.

The whole process should take under two minutes.

### Step 1.4: Review the Session in Dashboard

In Dashboard, click **Sessions**. Your test session appears. Click it to review the scores, extracted OCR data, captured images, and the overall verification result.

This is what your operations team will see for every user who goes through Onboarding.

> 📘 Note
>
> A session has three phases: capture (the customer), process (Incode), and result (your back-end decision). Part 2 shows how to drive that same flow from your own application code.

***

## Part 2: Integrate the Web SDK

You will build a minimal web application with two parts:

- A **back-end endpoint** that creates an Incode session and returns the session token to your front end.
- A **front-end page** that loads the Incode Web SDK, runs the verification modules, and calls your back end to retrieve the score when the session finishes.

### Step 2.1: Obtain Prerequisites

Before you start, make sure you have:

- Node.js 18 or higher, for the back-end server.
- A browser with camera access. Chrome is recommended. Use your phone for best capture quality.
- Your API key, API URL, and Flow configuration ID.
- The Configuration ID of the Workflow you created in Step 1.1. You can find it in the Workflow's detail view in Dashboard.

> 📘 Note
>
> The demo environment at `https://demo-api.incodesmile.com` is available for testing. Use it in place of your API URL until you are ready for production.

### Step 2.2: Set Up Your Project

1. Create a project folder and install dependencies:
   ```bash
   mkdir incode-quickstart && cd incode-quickstart
   npm init -y
   npm install express node-fetch dotenv
   ```

2) Create a `.env` file in the project root:
   ```bash
   API_URL=https://demo-api.incodesmile.com
   API_KEY=<YOUR_API_KEY>
   FLOW_ID=<YOUR_WORKFLOW_CONFIGURATION_ID> # from Step 1.1
   ```

> ⚠️ Warning
>
> Your API key must never appear in front-end code. This setup keeps it on the back end where it belongs.

### Step 2.3: Create the Back-End Server

1. Create `server.js`:
   ```javascript
   require('dotenv').config();
   const express = require('express');
   const app = express();

   app.use(express.json());
   app.use(express.static('public'));

   const API_URL = process.env.API_URL;
   const API_KEY  = process.env.API_KEY;
   const FLOW_ID  = process.env.FLOW_ID;

   // POST /start — create a new Incode session and return the token to the frontend
   app.post('/start', async (req, res) => {
     try {
       const response = await fetch(`${API_URL}/omni/start`, {
         method: 'POST',
         headers: {
           'Content-Type': 'application/json',
           'api-version': '1.0',
           'x-api-key': API_KEY,
         },
         body: JSON.stringify({
           countryCode: 'ALL',
           configurationId: FLOW_ID,
           // externalCustomerId: req.body.userId, // optional: link to your user record
         }),
       });

       if (!response.ok) {
         throw new Error(`Incode API error: ${response.status}`);
       }

       // Return token and interviewId to the frontend.
       // The frontend only ever sees the token — never the API key.
       const { token, interviewId } = await response.json();
       res.json({ token, interviewId });
     } catch (err) {
       console.error('Session creation failed:', err.message);
       res.status(500).json({ error: 'Could not create session' });
     }
   });

   // POST /finish — mark the session complete and fetch the score
   app.post('/finish', async (req, res) => {
     const { token, interviewId } = req.body;

     try {
       // Fetch the verification score using the session token.
       // X-Incode-Hardware-Id carries the session token for /0/ endpoints.
       const scoreRes = await fetch(`${API_URL}/0/omni/get/score`, {
         method: 'GET',
         headers: {
           'api-version': '1.0',
           'x-api-key': API_KEY,
           'X-Incode-Hardware-Id': token,
         },
       });

       if (!scoreRes.ok) {
         throw new Error(`Score fetch failed: ${scoreRes.status}`);
       }

       const score = await scoreRes.json();

       // In production, apply your business rules here.
       // score.idValidation.overall.status  → 'OK', 'WARN', 'FAIL'
       // score.liveness.overall.status      → 'OK', 'WARN', 'FAIL'
       // score.faceRecognition.overall.status → 'OK', 'WARN', 'FAIL'
       // score.overall.status               → 'OK', 'WARN', 'FAIL', 'MANUAL'

       res.json({ interviewId, score });
     } catch (err) {
       console.error('Finish failed:', err.message);
       res.status(500).json({ error: 'Could not retrieve score' });
     }
   });

   app.listen(3000, () => console.log('Server running at http://localhost:3000'));
   ```
2. Start the server:
   ```bash
   node server.js
   ```

### Step 2.4: Create the Front-End Page

Create a `public/` folder, then create `public/index.html`:

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Incode Quick Start</title>
  <!-- Load the Incode Web SDK from CDN -->
  <script src="https://sdk.incode.com/sdk/onBoarding-1.85.0.js" defer></script>
  <style>
    body { font-family: sans-serif; max-width: 600px; margin: 2rem auto; padding: 0 1rem; }
    #camera-container { width: 100%; min-height: 300px; }
    #result { margin-top: 1.5rem; padding: 1rem; background: #f5f5f5; border-radius: 6px; display: none; }
    pre { font-size: 13px; overflow: auto; }
  </style>
</head>
<body>
  <h1>Identity Verification</h1>
  <p id="status">Starting session...</p>
  <div id="camera-container"></div>
  <div id="result">
    <h2>Verification Complete</h2>
    <pre id="score-output"></pre>
  </div>

  <script>
    const container   = document.getElementById('camera-container');
    const statusEl    = document.getElementById('status');
    const resultEl    = document.getElementById('result');
    const scoreOutput = document.getElementById('score-output');

    let incode  = null;
    let session = null; // { token, interviewId }

    async function init() {
      // Step 1: Ask the backend to create a session. 
      // The API key stays on the server — the frontend only receives the token.
      const res  = await fetch('/start', { method: 'POST' });
      session    = await res.json();

      // Step 2: Initialize the Web SDK with your API URL and the session token.
      // Do NOT pass the API key here.
      incode = window.OnBoarding.create({
        apiURL: 'https://demo-api.incodesmile.com/0', // note the /0 path
        token:  session.token,
      });

      statusEl.textContent = 'Session ready. Starting ID capture...';
      captureIdFront();
    }

    // Step 3: Capture the front of the ID document
    function captureIdFront() {
      incode.renderCamera('front', container, {
        token:         session,
        numberOfTries: 3,
        onSuccess:     captureIdBack,
        onError:       handleError,
      });
    }

    // Step 4: Capture the back of the ID document (skip for passports)
    function captureIdBack() {
      incode.renderCamera('back', container, {
        token:         session,
        numberOfTries: 3,
        onSuccess:     processId,
        onError:       handleError,
      });
    }

    // Step 5: Tell Incode to process the captured ID images
    async function processId() {
      statusEl.textContent = 'Processing ID...';
      container.innerHTML  = '<p>Processing your ID — please wait.</p>';
      await incode.processId({ token: session.token });
      captureSelfie();
    }

    // Step 6: Capture the selfie
    function captureSelfie() {
      statusEl.textContent = 'ID processed. Starting selfie capture...';
      incode.renderCamera('selfie', container, {
        token:         session,
        numberOfTries: 3,
        showTutorial:  true,
        onSuccess:     finishSession,
        onError:       handleError,
      });
    }

    // Step 7: Send the session token to your backend to mark completion and fetch the score
    async function finishSession() {
      statusEl.textContent = 'Verification complete. Fetching results...';
      container.innerHTML  = '';

      const res    = await fetch('/finish', {
        method:  'POST',
        headers: { 'Content-Type': 'application/json' },
        body:    JSON.stringify(session),
      });
      const result = await res.json();

      // Display the score for this tutorial — in production, apply your business rules
      resultEl.style.display    = 'block';
      scoreOutput.textContent   = JSON.stringify(result.score, null, 2);
      statusEl.textContent      = `Session ${result.interviewId} complete.`;
    }

    function handleError(err) {
      statusEl.textContent = `Error: ${err?.message || 'An error occurred'}`;
      console.error(err);
    }

    // Run on page load
    window.addEventListener('DOMContentLoaded', init);
  </script>
</body>
</html>
```

> 📘 Note
>
> The CDN URL above references SDK version `1.85.0`. Always use the latest version — check [Web SDK Release Notes](/release-notes/releases-web-sdk/) for the current version number.

***

### Step 2.5: Run It on Your Phone

The Incode Web SDK requires HTTPS and a real camera. For local development, use a tunneling tool to expose your local server over HTTPS:

```bash
# Using ngrok (install from ngrok.com if needed)
ngrok http 3000
```

Copy the `https://` URL ngrok provides and open it on your phone. Go through the verification as you did in Part 1.

When the selfie capture completes, your back end fetches the score and the result appears on screen.

***

### Step 2.6: Read the Score

Your `/finish` endpoint returns a score object that looks like this:

```json
{
  "idValidation": {
    "overall": {
      "value": "98.0",
      "status": "OK"
    }
  },
  "liveness": {
    "overall": {
      "value": "100.0",
      "status": "OK"
    }
  },
  "faceRecognition": {
    "overall": {
      "value": "97.5",
      "status": "OK"
    }
  },
  "overall": {
    "status": "OK"
  }
}
```

Use the `status` field—not the numeric `value`—to make decisions. The possible status values are:

| Status    | Meaning                                                 |
| --------- | ------------------------------------------------------- |
| `OK`      | Module passed.                                          |
| `WARN`    | Score is borderline; consider routing to manual review. |
| `MANUAL`  | Session requires a human reviewer.                      |
| `FAIL`    | Module failed.                                          |
| `UNKNOWN` | Result could not be determined.                         |

A typical decision pattern in your back end:

```javascript
const { overall } = score;

if (overall.status === 'OK') {
  // Approve the user and continue your onboarding flow
} else if (overall.status === 'WARN' || overall.status === 'MANUAL') {
  // Route to manual review queue
} else {
  // Reject and prompt the user to try again or contact support
}
```

***

## What You Built

In Part 1 you ran a live verification session and saw the result in Dashboard. In Part 2 you built a working integration that:

1. Creates a session from your back end using your API key.
2. Passes only the session token to the front end.
3. Runs ID capture, ID processing, and selfie capture using the Web SDK.
4. Retrieves the verification score from your back end after the session completes.

This is the foundation every Incode web integration is built on. The same pattern applies whether you add more modules, switch to webhooks for async results, or move to a mobile SDK.

***

## What's Next

| Goal                                              | Where to go                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Add consent, geolocation, or eKYC modules         | [Web SDK Reference](/sdk-reference/web-sdk-reference/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Build a React integration                         | [React Native SDK Reference](/sdk-reference/react-native-sdk/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Receive results asynchronously instead of polling | [Webhooks](/general-reference/webhooks-overview/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Use a mobile SDK instead                          | [iOS](/sdk-reference/ios-sdk/) · [Android](/sdk-reference/android-sdk/) · [React Native](/sdk-reference/react-native-sdk/) · [Flutter](/sdk-reference/flutter-sdk/) · [Xamarin](/sdk-reference/xamarin-sdk/) · [Cordova](/sdk-reference/cordova-sdk/) |
| Understand all score fields                       | [Fetch Score Data](/api-reference/get-score/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

<br />

---

- Path: `get-started-with-incode/welcome-to-incode`
- URL: https://developer.incode.com/get-started-with-incode/
- Markdown: https://developer.incode.com/get-started-with-incode.md

# Welcome to Incode

Incode is an [identity verification (IDV)](https://developer.incode.com/get-started-with-incode/what-is-identity-verification/) platform. It helps:

- **Onboard new customers** by confirming their identity exists and they are who they claim to be.
- **Authenticate returning customers** against their identity established during onboarding.

Incode combines document verification, biometric matching, liveness detection, and risk scoring. You can configure the user's journey through these verification checks according to your use case, region, and regulatory requirements. The Incode Platform provides a single ecosystem for configuring and integrating IDV, including low-code and no-code solutions. Review the [Choose Your Integration Path](#choose-your-integration-path) section below for an overview of ways to implement Incode.

***

## Key Concepts

Review these key concepts before you begin:

- **Onboarding Session**: A container for one customer's identity verification process. Every image, score, and result is tied to a unique Session ID, referred to as `interviewId` in the API. A new session is created for each verification attempt.
- **Module:&#x20;**&#x41; single step within a session. Examples include ID document capture, selfie capture, liveness check, face match, and eKYC database lookup. You choose which modules run and in what order by configuring [Workflows](https://developer.incode.com/concepts-and-architecture/workflows/) in Dashboard.
- **Score and Result:&#x20;**&#x57;hen customers complete modules, Incode returns a numerical score for each module and an overall session score. Your backend reads this score to make a decision: approve the customer, route them to manual review, or reject the attempt.

[Read the full glossary](https://developer.incode.com/get-started-with-incode/glossary/)​ for more terms and definitions.

***

## Choose Your Integration Path

Incode supports four integration methods. Choose the one that fits your use case.

| Path                                       | Best for                                                    | Starting point                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------ | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Web SDK**                                | Browser-based applications                                  | [Quick Start: Web SDK](/get-started-with-incode/quickstart/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Mobile SDK** (iOS, Android, Hybrid SDKs) | Native mobile apps—higher capture quality and fraud signals | [Mobile Integration Overview](/integrate-by-platform/mobile-integration-overview/)|
| **API only**                               | Backend batch processing—no SDK or frontend UI required     | [API-Only Integration](/integrate-by-platform/single-onboarding/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **Hosted Workflow URL** (no-code)          | Rapid deployment—Incode hosts the UI, you send users a link | [Flows and Workflows Overview](/integrate-by-platform/web-integrations-flows-workflows/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

If you're not sure which to choose, see the [full comparison of integration options by platform](/integrate-by-platform/).

***

## How a Verification Session Works

Regardless of the path you choose, every Incode integration follows the same four-step sequence:

1. **Your backend creates a session**. Call `POST /omni/start` with your API key. Incode returns a session token. Store this token; all subsequent calls for this customer's verification are scoped to it.

   → [Start session API reference](/api-reference/start/)
2. **Your frontend runs the capture modules.&#x20;**&#x54;he SDK or Workflow guides your customer through the steps you have configured: ID scan, selfie, liveness check, and any others. Pass the session token to the SDK so all captured data is attached to the correct session.

   → [Onboarding process overview](/concepts-and-architecture/onboarding-vs-authentication/)
3. **Mark the session complete**. After the last module runs, call `POST /omni/finish-status` from your backend. This step is required; it signals to Incode that data collection is done and triggers final score calculation.
4. **Fetch scores and make a decision.&#x20;**&#x52;ead the verification score from the API or wait for Incode to send it to your backend via a webhook. Use the score to approve the user, route them to manual review, or reject the attempt.

   → [Session lifecycle and status reference](/get-started-with-incode/onboarding-session-lifecycle/)<br />→ [Webhooks overview](/general-reference/webhooks-overview/)

***

## What to Read Next

| Topic                                            | Link                                                                                                            | Type      |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | --------- |
| Platform concepts and terminology                | [Incode Glossary](/get-started-with-incode/glossary/)                                     | Concepts  |
| What identity verification is and why it matters | [What Is Identity Verification?](/get-started-with-incode/what-is-identity-verification/) | Concepts  |
| Build a working web integration end-to-end       | [Quick Start: Web SDK](/get-started-with-incode/quickstart/)                              | Tutorial  |
| Integrate by Platform                            | [Integrate by Platform](/integrate-by-platform/)                  | Setup     |
| Explore all API endpoints                        | [API Reference](https://developer.incode.com/api-reference/interview/)                              | Reference |
| Receive results asynchronously                   | [Webhooks](/general-reference/webhooks-overview/)                                   | Reference |

***

<br />

---

- Path: `get-started-with-incode/what-is-identity-verification`
- URL: https://developer.incode.com/get-started-with-incode/what-is-identity-verification/
- Markdown: https://developer.incode.com/get-started-with-incode/what-is-identity-verification.md

# What Is Identity Verification?

Identity verification (IDV) is the process of confirming that a person is who they claim to be. It answers two questions:

- Does this identity document belong to a real person?
- Is the person presenting it the same person the document belongs to?

You encounter IDV as a customer whenever you open a bank account online, board a flight, or verify your age on a regulated platform. As a developer, you're responsible for building the integration that makes IDV happen.

***

## Why Applications Need Identity Verification

Regulations in financial services, healthcare, and other industries require organizations to verify the identity of their customers before granting access to certain services. The two most common regulatory frameworks are:

- **Know Your Customer (KYC)**: Requires financial institutions to verify customer identity before and during a business relationship. KYC primarily prevents fraud, money laundering, and terrorist financing. KYC is mandated by Anti-Money Laundering (AML) laws in most jurisdictions.
- **Know Your Business (KYB)**: The KYC equivalent for business entities. Before onboarding a business customer, a regulated organization must verify that the business is real, legally registered, and not subject to sanctions. In many jurisdictions, you must also identify the individuals who ultimately own or control the business, known as Ultimate Beneficial Owners (UBOs).

Beyond regulatory compliance, you can use identity verification to:

- Reduce fraud
- Protect users from account takeover
- Build trust in their platforms

***

## How Identity Verification Works

A typical IDV flow includes three components that work together:

- **Document verification** confirms that an identity document—such as a passport, driver's license, or national ID—is real. This involves checking the document structure, security features, and data fields against known templates for that document type. It also includes checks for document tampering and forgery. Incode supports verification of [4,600+ document types](/general-reference/supported-ids/) across more than 200 countries and territories, including NFC chip reading for ePassports.
- **Biometric verification** confirms that the person presenting the document is the same person pictured in it. The customer takes a selfie, and the platform compares it against the photo on the document using facial recognition. A liveness check—either passive or active—runs at the same time to confirm the selfie is from a live person and not a photograph, screen replay, or synthetic image. Incode's liveness detection is certified to ISO/IEC 30107-3 and ranked among top performers in NIST FRVT testing.
- **Data verification (eKYC)** optionally cross-references the identity data extracted from the document against authoritative external sources—government registries, credit bureaus, or watchlists—to further confirm that the identity exists and is in good standing. Incode connects to government sources in [8+ countries](/general-reference/government-verification-sources/), including deep integrations with Mexican government registries (RENAPO, CURP, INE, SAT) not available through any other platform in this space.

***

## What Can Go Wrong—and How Incode Detects It

Identity fraud takes several forms, and a production IDV system needs to address all of them, including:

- **Document fraud**: Using a forged, altered, or stolen document. Incode's document verification checks physical and digital security features, cross-references OCR-extracted data against document templates, and flags inconsistencies that indicate tampering.
- **Presentation attacks**: Holding up a photo, playing a video, or using a mask to defeat the selfie capture. Incode's passive and active liveness detection, including its [Deepsight](/features-and-modules/deepsight/) deepfake defense suite, detects physical attacks (printed photos and masks) and digital attacks (screen replay, injection attacks, and synthetic face generations) as distinct check categories.
- **Identity spoofing**: Using another real person's documents. The face match between the selfie and the document photo addresses this directly. For returning users, Incode's 1:N face authentication can identify a person against an entire enrolled database without requiring them to claim an identity first—a capability not offered by any other major IDV platform. This makes it particularly effective for detecting repeat fraud attempts under different identities.
- **Synthetic identity fraud**: Combining real and fabricated data to create a fictitious identity. eKYC database checks, combined with device signals and behavioral data captured during the session, help identify patterns that are inconsistent with a genuine user.

***

## The Difference Between Verification, Authentication, and Authorization

These three terms are frequently used interchangeably, but they describe distinct steps in a security flow. Knowing the difference between them prevents integration designs that skip steps or assign responsibilities to the wrong layer. Here's what they mean:

- **Verification** happens once, or periodically when re-verification is required. It establishes who a user is and creates a durable record of that identity. A government ID is checked, a selfie is captured, and the two are matched. This is the foundation of any good onboarding flow.
- **Authentication** happens repeatedly after verification. It confirms that the person accessing your application right now is the same person who was previously verified. Face authentication using a selfie is a common post-verification authentication method. Incode supports both:
  - **1:1 authentication**: The user claims an identity and the selfie is compared against that specific enrolled identity.
  - **1:N authentication**: The selfie is compared against all enrolled identities to identify the person without a prior claim.
  Authentication is also an important part of onboarding flows.
- **Authorization** happens after authentication. It determines whether the verified, authenticated person has permission to perform a specific action or access a specific resource. Authorization is a decision your application makes based on the user's role, account status, jurisdiction, or other business rules. It is outside the scope of the IDV platform itself. Incode confirms who someone is; your application decides what they are allowed to do. Depending on why your application is using IDV, authorization may or may not be necessary.

> 📘 Example
>
> First, a new customer completes onboarding and is verified (verification). They return the next day and pass a selfie check (authentication). Your backend then checks whether their account tier permits the transaction they are requesting (authorization).

***

## Privacy and Data Handling

Identity verification involves collecting sensitive personal data, such as government ID images, selfie photographs, and biometric templates. Your integration is responsible for handling this data in compliance with applicable regulations, including GDPR in Europe and CCPA in California. Key design considerations include:

- **Data minimization**: Only collect what is required for your use case.
- **Consent**: Obtain explicit user consent before capturing biometric data. Incode's Workflow builder includes configurable consent modules for this purpose.
- **Data residency**: Incode supports U.S., EU, and regional deployment options to satisfy data localization requirements.
- **Retention**: Establish and enforce policies for how long verification data is stored.

Incode holds SOC 2 Type II certification and is GDPR and CCPA compliant. HIPAA compliance is also available for healthcare use cases.

***

## What Incode Adds to the Picture

Most IDV platforms handle the core document-plus-selfie flow. Incode offers the expansion and configurability of what happens around that core:

- **Modular Workflow builder**: Configure the exact verification steps your use case requires, with conditional branching logic, without writing orchestration code.
- **LATAM government depth**: Direct integrations with government registries in Mexico, Brazil, Argentina, Colombia, Chile, Peru, and more; a coverage depth not available with any competitor.
- **Flexible integration**: Seven mobile SDK frameworks (iOS, Android, React Native, Flutter, Xamarin, Cordova, Ionic Capacitor), Web SDK, REST API, hosted no-code Flows, kiosk mode, and an end-to-end encrypted integration variant.
- **Session completeness**: A single onboarding session can combine document verification, biometric liveness, eKYC checks, business verification (eKYB), custom forms, consent capture, and a video conference review module if needed.
- **Prizma design system**: A documented, token-based UI customization system with light/dark mode support. It lets your integration look and feel native to your application, as opposed to a generic third-party widget.

***

Now that you understand what identity verification is and what Incode does, the next step is understanding the [core concepts](/get-started-with-incode/glossary/) specific to building with the Incode platform.

---

- Path: `integrate-by-platform/api-batch-processing`
- URL: https://developer.incode.com/integrate-by-platform/api-batch-processing/
- Markdown: https://developer.incode.com/integrate-by-platform/api-batch-processing.md

# API Batch Processing

Incode SDKs use our API to capture and read session data. Therefore, anything added to a session via SDK can also be added via API calls. Batch processing enables you to run a complete onboarding using only API calls in sequential order, without using any of the available SDKs.

This section explains how to set up batch processing for a basic onboarding flow. If your flow includes additional modules, you will need to adjust for them.

:::warning
While batch processing may seem more convenient, Incode cannot guarantee the quality of captured images since you're not using our SDKs. You must already have the user's images before you can run a batch process. Depending on your source for these images, the results of API-based onboardings may be as good as the ones done using the standard, SDK-based onboardings.
:::

## Before You Begin


To follow all the steps for setting up batch processing, make sure you have:

* An API key (provided by Incode)
* A Configuration ID for the flow you want to use. To copy it, go to **Dashboard** > **Flow Builder** > **Flows** or **Workflows**. For Flows, locate the flow you want to use, and click Copy in the Actions column. For Workflows, click the three dots in the Actions column and select **Copy ID**.

<Image border={false} src="https://developer.incode.com/assets/f913b216e9b66236eeace65318fd961c.png" />

* Postman. Sample code and `cURL` requests are shared in the following pages. You can use the `cURL` samples to import them into Postman and try them.

## Basic Onboarding Flow

The following pages explain each of these steps in a basic onboarding flow from a batch processing perspective. We always recommend using our SDKs instead for the best quality results.

* [Start onboarding session](/integrate-by-platform/api-onboarding-start-session/)
* [ID Validation](/integrate-by-platform/api-onboarding-id-validation/)
* [Face Validation](/integrate-by-platform/api-onboarding-face-validation/), including liveness and face match
* [Complete the session](/integrate-by-platform/api-onboarding-complete-session/)

---

- Path: `integrate-by-platform/api-onboarding-complete-session`
- URL: https://developer.incode.com/integrate-by-platform/api-onboarding-complete-session/
- Markdown: https://developer.incode.com/integrate-by-platform/api-onboarding-complete-session.md

# Complete Onboarding Session

## Introduction

Onboarding sessions must be completed in order to finalize session processing. Completing the session results in:

* The session shows as **COMPLETED** on your Incode Dashboard.
* <Image align="center" border={true} src="https://developer.incode.com/assets/96408f57b74beb6626eaad059c064b70.png" className="border" />

  Incode applies any business rules you have set in the Dashboard and recalculates the score based on those rules.
* Incode sets the onboarding status to `ONBOADING_FINISHED` and triggers the [onboarding status webhook](/general-reference/onboarding-status-webhook/) with this status.

To learn more about what happens when you call the endpoint to complete the session, see the [Mark onboarding complete](/api-reference/finish-status-post/) API documentation.

## Sample Code

```curl
curl --location 'https://demo-api.incodesmile.com/0/omni/finish-status' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'X-Incode-Hardware-Id: <your_session_token>'
```
```javascript Nodejs
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://demo-api.incodesmile.com/omni/finish-status',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  }
};

axios(config).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.log(error);
});

```
```java
var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/finish-status"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .GET()
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());
```
```csharp
using var client = new HttpClient();

client.DefaultRequestHeaders.Add("Content-Type", "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.GetAsync("https://demo-api.incodesmile.com/omni/finish-status");
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
```
```python
import requests

url = "https://demo-api.incodesmile.com/omni/finish-status"

headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.get(url, headers=headers)

print(response.text)

```

---

- Path: `integrate-by-platform/api-onboarding-face-validation`
- URL: https://developer.incode.com/integrate-by-platform/api-onboarding-face-validation/
- Markdown: https://developer.incode.com/integrate-by-platform/api-onboarding-face-validation.md

# Face Validation

## Introduction

Incode performs two validations related to a face (or selfie image):

* **Liveness validation**: Performed as soon as you add a selfie image to a session via the endpoint `/omni/add/face/third-party?imageType=selfie`. It protects you against someone uploading a pre-existing photo and claiming it's a selfie.
* **Face Match validation**: Compares the selfie image against the face that appears on an ID uploaded as part of the same session. This check is performed when you call the endpoint `/omni/process/face?imageType=selfie`. It will not work if you have not already uploaded an ID, so it's important to perform these steps in the order we've discussed them (see [ID Validation](/integrate-by-platform/api-onboarding-id-validation/)).

Face validation requires these two endpoint calls and you must perform them in the order shown:

* <Anchor label="Add face/Selfie image" target="_blank" href="ref:addfacebythirdparty">Add face/Selfie image</Anchor>
* <Anchor label="Process face" target="_blank" href="ref:processface">Process face</Anchor>

## Header requirements

Both endpoints require these header values:

| Header                 | Value                                                                                    |
| :--------------------- | :--------------------------------------------------------------------------------------- |
| `x-api-key`            | The API key provided to you by Incode.                                                   |
| `api-version`          | "1.0"                                                                                    |
| `X-Incode-Hardware-Id` | The <Glossary>Session Token</Glossary> obtained when you started the onboarding session. |

## Body/image requirements

Images must be provided in the request body as a base64 encoded string. They must meet these requirements:

* Minimum of 1000 pixels on one dimension, either width or height.
* Cannot exceed 10 MB

## Sample Code

### Add face

```curl
curl --location 'https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=selfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--header 'X-Incode-Hardware-Id: <your_session_token>' \
--data '{
    "base64Image": ""
}'
```
```Text Nodejs
const axios = require('axios');
const fs = require('fs');

// Read your image file and encode as base64
const imageFilePath = 'path/to/your/image.jpg';
const base64 = fs.readFileSync(imageFilePath, { encoding: 'base64' });

const data = JSON.stringify({
  base64Image: base64
});

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=selfie',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  },
  data : data
};

axios(config).then(function (response) {
  console.log(response.data);
});

```
```java
var client = HttpClient.newHttpClient();

// Read your image file and encode as base64
Path imagePath = Path.of("path/to/your/image.jpg");
String base64 = Base64.getEncoder().encodeToString(Files.readAllBytes(imagePath));

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=selfie"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .POST(BodyPublishers.ofString("{\"base64Image\":\"" + base64 + "\"}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());

```
```csharp
using var client = new HttpClient();

// Read your image file and encode as base64
var imageFilePath = "path/to/your/image.jpg";
var base64 = Convert.ToBase64String(File.ReadAllBytes(imageFilePath));

var json = "{\"base64Image\":\"" + base64 + "\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=selfie", content);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);


```
```python
import requests
import base64

# Read your image file and encode as base64
image_file_path = 'path/to/your/image.jpg'
with open(image_file_path, "rb") as image_file:
    base64 = base64.b64encode(image_file.read()).decode('utf-8')

url = "https://demo-api.incodesmile.com/omni/add/face/third-party?imageType=selfie"

payload = {
    "base64Image": base64
}
headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

```

After a face has been added successfully, you can see the liveness score by going to Dashboard > Sessions, then locating and selecting the session.  To learn more the request / response for this endpoint, see the [Add face/Selfie image](/api-reference/add-face-third-party/) API endpoint documentation.

### Process face

```curl
curl --location 'https://demo-api.incodesmile.com/omni/process/face?imageType=selfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--header 'X-Incode-Hardware-Id: <your_session_token>' \
--data '{}'
```
```javascript Nodejs
const axios = require('axios');
const data = JSON.stringify({});

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/process/face?imageType=selfie',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  },
  data : data
};

axios(config).then(function (response) {
  console.log(response.data);
});

```
```java
var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/process/face?imageType=selfie"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .POST(BodyPublishers.ofString("{}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());

```
```csharp
using var client = new HttpClient();

var json = "{}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/process/face?imageType=selfie", content);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);


```
```python
import requests

url = "https://demo-api.incodesmile.com/omni/process/face?imageType=selfie"

payload = {}
headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

```

After a face has been processed successfully, you can see the face-match score by going to Dashboard > Sessions, then locating and selecting the session. To learn more the request / response for this endpoint, see the [Process face](/api-reference/process-face/) API endpoint documentation.

---

- Path: `integrate-by-platform/api-onboarding-id-validation`
- URL: https://developer.incode.com/integrate-by-platform/api-onboarding-id-validation/
- Markdown: https://developer.incode.com/integrate-by-platform/api-onboarding-id-validation.md

# ID Validation

## Introduction

Depending on the type of ID document the user has provided, up to three endpoint calls may be required to validate the ID. If a document only has one side, such as a passport, there is no need to call the `back-id` endpoint. However, endpoints should be called in the general order shown:

1. <Anchor label="Add front side of ID" target="_blank" href="ref:addfrontidv2">Add front side of ID</Anchor> `/omni/add/front-id/v2`
2. <Anchor label="Add back side of ID" target="_blank" href="ref:addbackidv2">Add back side of ID</Anchor> `/omni/add/back-id/v2`
3. <Anchor label="Process Id" target="_blank" href="ref:processid">Process Id</Anchor> `/omni/process/id`

> 📘 Can I reprocess an ID using an existing upload?
>
> No. If you need to reprocess an ID, you must repeat the upload of ID images before calling the `/omni/process/id` endpoint again.

## Header requirements

Each of the three endpoints requires these header values.

| Header                 | Value                                                                                    |
| :--------------------- | :--------------------------------------------------------------------------------------- |
| `x-api-key`            | The API key provided to you by Incode                                                    |
| `api-version`          | "1.0"                                                                                    |
| `X-Incode-Hardware-Id` | The <Glossary>Session Token</Glossary> obtained when you started the onboarding session. |

## Body/image requirements

Images of ID documents must be provided in the request body as a base64 encoded string. Both front and back ID images are subject to these requirements:

* Images should be at least 1000 pixels on one dimension, either width or height.
* Requests cannot exceed 10 MB.
* IDs must be fully visible in the image. No edges or corners should be removed. Otherwise, the image is invalid.
* There should be some padding (space) between the image edges and the ID edges, as illustrated here. Otherwise, the image is invalid.

| Image                                      | Description                                                                                    |
| :----------------------------------------- | :--------------------------------------------------------------------------------------------- |
| ![](https://developer.incode.com/assets/a6aad03e4e670166d2f61d96a032b6ef.png) | Valid image. There's a clear padding between the ID and the image borders. Id is fully visible |
| ![](https://developer.incode.com/assets/2c0a64ad014ba9cd4fc8f1f6f2cdcc0a.png) | Invalid image. The ID is cropped and not fully visible                                         |
| ![](https://developer.incode.com/assets/fa4d5220dc2a0827d7a975f449e6f6c5.png) | Invalid image. While the ID is fully visible, there's no padding with the image borders.       |

## Sample Code

### Front Id

```curl
curl --location 'https://demo-api.incodesmile.com/omni/add/front-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--header 'X-Incode-Hardware-Id: <your_session_token>' \
--data '{
    "base64Image": ""
}'
```
```javascript Nodejs
const axios = require('axios');
const fs = require('fs');

// Read your image file and encode as base64
const imageFilePath = 'path/to/your/image.jpg';
const base64 = fs.readFileSync(imageFilePath, { encoding: 'base64' });

const data = JSON.stringify({
  base64Image: base64
});

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/add/front-id/v2',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(response.data);
})
.catch(function (error) {
  console.log(error);
});

```
```java
var client = HttpClient.newHttpClient();

// Read your image file and encode as base64
Path imagePath = Path.of("path/to/your/image.jpg");
String base64 = Base64.getEncoder().encodeToString(Files.readAllBytes(imagePath));

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/add/front-id/v2"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .POST(BodyPublishers.ofString("{\"base64Image\":\"" + base64 + "\"}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());
```
```csharp
using var client = new HttpClient();

// Read your image file and encode as base64
var imageFilePath = "path/to/your/image.jpg";
var base64 = Convert.ToBase64String(File.ReadAllBytes(imageFilePath));

var json = "{\"base64Image\":\"" + base64 + "\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/add/front-id/v2", content);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
```
```python
import requests
import base64

# Read your image file and encode as base64
image_file_path = 'path/to/your/image.jpg'
with open(image_file_path, "rb") as image_file:
    base64 = base64.b64encode(image_file.read()).decode('utf-8')

url = "https://demo-api.incodesmile.com/omni/add/front-id/v2"

payload = {
    "base64Image": base64
}
headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

```

You don't need to store anything from the response. To learn more about what the response includes, see the [Add front side of ID](/api-reference/add-front-id-v2/) endpoint documentation.

***

### Back Id

```curl
curl --location 'https://demo-api.incodesmile.com/omni/add/back-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--header 'X-Incode-Hardware-Id: <your_session_token>' \
--data '{
    "base64Image": ""
}'
```
```javascript Nodejs
const axios = require('axios');
const fs = require('fs');

// Read your image file and encode as base64
const imageFilePath = 'path/to/your/image.jpg';
const base64 = fs.readFileSync(imageFilePath, { encoding: 'base64' });

const data = JSON.stringify({
  base64Image: base64
});

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/add/back-id/v2',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  },
  data : data
};

axios(config).then(function (response) {
  console.log(response.data);
});

```
```java
var client = HttpClient.newHttpClient();

// Read your image file and encode as base64
Path imagePath = Path.of("path/to/your/image.jpg");
String base64 = Base64.getEncoder().encodeToString(Files.readAllBytes(imagePath));

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/add/back-id/v2"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .POST(BodyPublishers.ofString("{\"base64Image\":\"" + base64 + "\"}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());
```
```csharp
using var client = new HttpClient();

// Read your image file and encode as base64
var imageFilePath = "path/to/your/image.jpg";
var base64 = Convert.ToBase64String(File.ReadAllBytes(imageFilePath));

var json = "{\"base64Image\":\"" + base64 + "\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/add/back-id/v2", content);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
```
```python
import requests
import base64

# Read your image file and encode as base64
image_file_path = 'path/to/your/image.jpg'
with open(image_file_path, "rb") as image_file:
    base64 = base64.b64encode(image_file.read()).decode('utf-8')

url = "https://demo-api.incodesmile.com/omni/add/back-id/v2"

payload = {
    "base64Image": base64
}
headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

```

You don't need to store anything from the response. To learn more about what the response includes, see the [Add back side of ID](/api-reference/add-back-id-v2/) endpoint documentation.

***

### Process Id

```curl
curl --location 'https://demo-api.incodesmile.com/omni/process/id' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--header 'X-Incode-Hardware-Id: <your_session_token>' \
--data '{}'

```
```javascript Nodejs
const axios = require('axios');

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/process/id',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
  }
};

axios(config).then(function (response) {
  console.log(response.data);
});

```
```java
var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/process/id"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .header("X-Incode-Hardware-Id", "<your_session_token>")
  .POST(BodyPublishers.ofString("{}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
System.out.println(response.body());
```
```csharp
using var client = new HttpClient();

var content = new StringContent("{}", Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");
client.DefaultRequestHeaders.Add("X-Incode-Hardware-Id", "<your_session_token>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/process/id", content);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
```
```python
import requests

url = "https://demo-api.incodesmile.com/omni/process/id"

headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>',
    'X-Incode-Hardware-Id': '<your_session_token>'
}

response = requests.post(url, json={}, headers=headers)

print(response.text)

```

This is the final ID validation step. After this step completes successfully, you can see the ID section score by going to **Dashboard** > **Sessions**, then locating and selecting the session. You can also view the score using the [fetch scores api](/api-reference/get-score/).

<ExampleCodeWarning />

:::warning
Do not use these versions unless otherwise stated. They contain variants, beta features and configurations specific for certain use cases. If you have any questions, please contact your CSM.
:::

---

- Path: `integrate-by-platform/api-onboarding-start-session`
- URL: https://developer.incode.com/integrate-by-platform/api-onboarding-start-session/
- Markdown: https://developer.incode.com/integrate-by-platform/api-onboarding-start-session.md

# Start Onboarding Session

## Introduction

Batch process onboardings begin with a call to the [start onboarding](/api-reference/start/) endpoint. This call creates a new Incode onboarding session (sometimes called an interview), and returns a JSON response that contains metadata about the newly created session.

Check the [start onboarding](/api-reference/start/) documentation for a complete reference of the endpoint's inputs and output.

## Requirements

This request uses the following header values and body key/value pairs:

### Headers


| Header        | Value                                 |
| :------------ | :------------------------------------ |
| `api-version` | "1.0"                                 |
| `x-api-key`   | The API Key provided to you by Incode |



### JSON Request Body



| Key                  | Value                                                                                                                                                                                                                                                                                                            |
| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `configurationId`    | **Required**: The Incode Flow identifier, also referred to as the Flow ID, for your new sessions. If you don't know the Flow ID, open Dashboard > Flows, locate the Flow you want to reference, and click Copy Flow ID in the Actions column.                                                                    |
| `externalCustomerId` | **Optional**: ID that links the new onboarding session to a specific ID you provide. You can query all the sessions related to this ID on the Incode Dashboard. For example, you may have assigned an ID to the customer in another system and want to be able to find all sessions related to that customer ID. |

## Handling the JSON response

The metadata returned in the response includes the <Glossary>Session Token</Glossary>. Store this value. It will be needed in subsequent endpoint calls.

## Sample code

```curl
curl --location 'https://demo-api.incodesmile.com/omni/start' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <your_api_key>' \
--data '{
  "countryCode": "ALL",
  "configurationId": "<your_configuration_id>",
  "externalCustomerId" : "<your_user_id>"
}
'
```
```javascript Nodejs
const axios = require('axios');

const data = JSON.stringify({
  countryCode: "ALL",
  configurationId: "<your_configuration_id>",
  externalCustomerId: "<your_user_id>
});

const config = {
  method: 'post',
  url: 'https://demo-api.incodesmile.com/omni/start',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'x-api-key': '<your_api_key>'
  },
  data : data
};

axios(config).then(function (response) {
  const token = response.data.token;
  console.log(token);
}).catch(function (error) {
  console.log(error);
});

```
```java Java
var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://demo-api.incodesmile.com/omni/start"))
  .header("Content-Type", "application/json")
  .header("api-version", "1.0")
  .header("x-api-key", "<your_api_key>")
  .POST(BodyPublishers.ofString("{\"countryCode\":\"ALL\",\"configurationId\":\"<your_configuration_id>\", \"externalCustomerId\": \"<your_user_id>\"}"))
  .build();

var response = client.send(request, BodyHandlers.ofString());
var jsonResponse = new JSONObject(response.body());
var token = jsonResponse.getString("token");
System.out.println(token);
```
```csharp C#
using var client = new HttpClient();

var json = "{\"countryCode\":\"ALL\",\"configurationId\":\"<your_configuration_id>\", \"externalCustomerId\": \"<your_user_id>\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("api-version", "1.0");
client.DefaultRequestHeaders.Add("x-api-key", "<your_api_key>");

var response = await client.PostAsync("https://demo-api.incodesmile.com/omni/start", content);
var responseString = await response.Content.ReadAsStringAsync();
var token = JObject.Parse(responseString)["token"].ToString();
Console.WriteLine(token);
```
```python Python
import requests

url = "https://demo-api.incodesmile.com/omni/start"

payload = {
    "countryCode": "ALL",
    "configurationId": "<your_configuration_id>",
    "externalCustomerId": "<your_user_id>"
}
headers = {
    'Content-Type': 'application/json',
    'api-version': '1.0',
    'x-api-key': '<your_api_key>'
}

response = requests.post(url, json=payload, headers=headers)
token = response.json()['token']
print(token)

```

<ExampleCodeWarning />

:::warning
Do not use these versions unless otherwise stated. They contain variants, beta features and configurations specific for certain use cases. If you have any questions, please contact your CSM.
:::

---

- Path: `integrate-by-platform/backend`
- URL: https://developer.incode.com/integrate-by-platform/backend/
- Markdown: https://developer.incode.com/integrate-by-platform/backend.md

# Incode Omni API Integration

This section covers how to integrate with the Incode Platform using the Omni API. It covers the full onboarding lifecycle: starting a session, generating a URL for that session, running onboarding through direct API calls, and fetching results once onboarding finishes.

- **[Create an Onboarding Session](/integrate-by-platform/single-onboarding/)**: Start a new onboarding session with the `/omni/start` endpoint. This page covers the required headers, request body values, and how to handle the response.

- **[Generate Onboarding URL](/integrate-by-platform/generate-onboarding-url/)**: Generate a unique URL for an onboarding session using the `/omni/onboarding-url` endpoint. This page covers the required headers and includes sample code.

- **[API Batch Processing](/integrate-by-platform/api-batch-processing/)**: Run a complete onboarding using only API calls, in sequential order, without an SDK. This page also covers the setup you need before you begin and links to each step in a basic onboarding flow.

- **[How to Fetch Results and Data](/integrate-by-platform/how-to-fetch-onboarding-results-and-data/)**: Learn what data is available once onboarding finishes, including scores, OCR data, device and geolocation data, and uploaded images. This page also covers how to trigger result retrieval, either through a webhook notification or your own app logic.

---

- Path: `integrate-by-platform/camera-permissions-on-shared-devices`
- URL: https://developer.incode.com/integrate-by-platform/camera-permissions-on-shared-devices/
- Markdown: https://developer.incode.com/integrate-by-platform/camera-permissions-on-shared-devices.md

# Camera Permissions on Shared Devices

The guidance on this page is device configuration guidance intended for **in-branch and in-person deployments**, where shared hardware such as iPads, Surface tablets, and kiosks are operated by staff. It applies to all web integration approaches: Flows/Workflows, iFrame, Redirect URL, WebViews, and Web SDK. It is not needed for consumer flows on personal devices or for native iOS/Android SDKs because the OS handles permission persistence in those cases.

## The issue

The browser and OS control whether camera permission persists between sessions. The Incode SDK cannot override this. Safari on iOS and iPadOS prompts on every session until you set camera permission to **Allow** for the specific site. Chrome and Edge persist permission after the first grant and need no configuration.

On a shared device running dozens of verifications a day, the Safari prompt adds a step to every session. Configure it once per device during provisioning.

## Configure Safari on iPad and iPhone

1. Open Safari and navigate to your verification URL.
2. Tap the **aA** icon in the address bar and open **Website Settings**.
3. Set **_Camera_** to _Allow_.
4. Run one test verification to confirm no prompt appears.

Apply the setting to the URL you actually serve verification from. If you use your own domain or a custom URL, configure that URL rather than an Incode domain.

:::info
**Settings > Safari > Camera** is a global default and does not override a per-site **Ask** setting. You must apply the permission per site.

Safari may reset the permission if you clear website data or re-provision the device. Include this step in your device provisioning checklist.
:::

---

- Path: `integrate-by-platform/fetch-device-info`
- URL: https://developer.incode.com/integrate-by-platform/fetch-device-info/
- Markdown: https://developer.incode.com/integrate-by-platform/fetch-device-info.md

# Fetch Device Information and Geolocation Data

## What is device information and geolocation data?

Device information is all data that helps identify the device used for an onboarding session, such as the user cellphone. This data is not secretly collected. Your application should directly report this to Incode with the related SDK methods. Geolocation data is a subset of device information. Expressed as latitude/longitude, geolocation data represents the physical location in the world where the onboarding took place.

### How can I access device information?

You can view device information for an onboarding session by going to Dashboard > Sessions. Locate and select the session you want to view, then click the Other tab and scroll down to the Device and Location sections.

You can use the [fetch device info](/api-reference/get-device-info/) API endpoint to obtain the information as a JSON response. You can also test the endpoint yourself at preceding link to our API documentation. This is the same API endpoint used by the Incode Dashboard.

When you fetch device information for a given onboarding session yourself, you should always pass the session's unique interview ID, also called the Session ID, to the [fetch device info](/api-reference/get-device-info/) API endpoint.  If you do not pass the interview ID, we will attempt to extract the interview ID from the session token.

## What device information is available?

While device information can vary, you can typically get the following commonly used device information:

* IP address of the device
* IP geolocation of the device (the latitude and longitude of the device IP may differ from the geolocation data of the device itself)
* Device geolocation data
* Hash (unique device identifier)
* Device (for example, the brand or type of cellphone)
* OS Version
* Device model
* Browser (for websdk-created sessions)
* SDK Version

---

- Path: `integrate-by-platform/fetch-extracted-ocr`
- URL: https://developer.incode.com/integrate-by-platform/fetch-extracted-ocr/
- Markdown: https://developer.incode.com/integrate-by-platform/fetch-extracted-ocr.md

# Fetch OCR Data

## What is OCR data?

Optical Character Recognition (OCR) data for an onboarding contains all information extracted from the ID document during the session. This includes both text information and available barcode or machine-readable zone (MRZ) data read and decoded from the back of the ID.

> 📘 Different documents, different data
>
> Data in ID documents can vary widely. Therefore, this endpoint's response is dynamic. It will only contain the information relevant to the detected ID. If you use compiled languages (like Java or C#) to consume these endpoint responses, be aware that your JSON parsers could break if a property you expect is missing.

### How can I fetch OCR data?

To fetch OCR data for a given onboarding session, you should always pass the session's unique interview ID, also called the Session ID, to the [fetch ocr data](/api-reference/get-ocr-data/) API endpoint. You can also test this endpoint at the preceding link. If you do not pass the interview ID, Incode attempts to extract it from the session token.

## Common use cases

### To extract information from the ID document attached to session

The following sample shows some of the most commonly used OCR fields from the ID document. It is not a complete list, since the fields vary from document to document. A longer JSON response example with additional fields is at the end of this article.

```json JSON
{
    "name": {
        "fullName": "",
        "firstName": "",
        "paternalLastName": "",
        "maternalLastName": "", // Optional
        "givenName": "",
        "middleName": "", // Optional
        "nameSuffix": "", // Optional
        "machineReadableFullName": "", // Optional, full name from Barcode or MRZ
        "givenNameMrz": "", // Optional
        "lastNameMrz": "" // Optional
    },
    "address": "", // Optional, address as read from ID
    "addressFields": {
        "street": "", // Optional
        "colony": "", // Optional, not applicable for all countries
        "postalCode": "", // Optional
        "city": "", // Optional
        "state": "" // Optional
    },
    "typeOfId": "", // Id classification, ie: Drivers License, Voter Identification, etc.
    "issuedAt": 0, // Issue date, expressed as a epoch timestamp in milliseconds
    "expireAt": 0, // Expiration date, expressed as a epoch timestamp in milliseconds
    "issuingCountry": "", // Optional
    "documentNumber": "", // Optional
    "fullAddress": true, //Optional. True if address from id is full (has three lines)
    "cic": "", // Mexican INE only
    "ocr": "", // Mexican INE only
}
```

### To extract information from the POA document attached to session

When you need to extract the address or information from a <Glossary>POA</Glossary> document added to a session, you can access these fields in the JSON response:

```json JSON
{
    "documentType": "", // Classifier of the provided POA document
    "poaName": "", // The name that appears in the provided POA document
    "addressStatementEmissionDate": "", // Expiration date, expressed as a epoch timestamp in milliseconds
    "addressFromStatement": "", // Full address read from statement
    "addressFieldsFromStatement": {
        "street": "",
        "colony": "",
        "postalCode": "",
        "city": "",
        "state": ""
    },
}
```

These fields should be enough to answer questions like:

* What's the address in the POA document?
* What name appears in the POA document?
* When was the POA document issued?
* What kind of document was used as POA?

## Other OCR data extraction endpoints

The preceding samples come from the standard [ocr data](/api-reference/get-ocr-data/) endpoint. Incode offers two alternative endpoints for OCR data extraction, although these are less likely to be needed:

- [OCR data v2](/api-reference/get-ocr-data-v2/) wraps the response from the `ocr-data` endpoint under an `ocrData` field. It returns the same data as [ocr data](/api-reference/get-ocr-data/) endpoint.
- [Second Id's OCR data](/api-reference/get-ocr-data-second-id/) is required if your flow is configured to have two ID documents attached to the same session. This will provide you with OCR data from the second ID.

> 📘 Scores and OCR Data
>
> OCR data shows in the Incode Dashboard along with some scoring. This scoring relates solely to the level of confidence on the data extracted from the captured image of the ID. Level of confidence for OCR data does not directly affect or alter the score of a session.

---

- Path: `integrate-by-platform/fetch-images`
- URL: https://developer.incode.com/integrate-by-platform/fetch-images/
- Markdown: https://developer.incode.com/integrate-by-platform/fetch-images.md

# Fetch Images

## What are onboarding images

Any image added to an onboarding session can be retrieved later. Depending the configured flow, images could include selfies, document images, and so on. You can extract these images to store them in your own system.

### How can I fetch onboarding images?

Incode offers two main options:

* Obtaining images as base64 encoded images
* Get temporary links to a URL where you can fetch these images. The links last for only one hour.

### Fetching images as base64

Use the [fetch images](/api-reference/get-images/) API endpoint. You should always pass the session's unique interview ID, also called the Session ID. If you do not pass the interview ID, Incode attempts to extract it from the <Glossary>Session Token</Glossary>.

For the payload, pass an array with the images you wish to fetch: `"images": [""]`. You can see what values are allowed inside the `images` array payload in [fetch images](/api-reference/get-images/) API endpoint documentation. You can also test the endpoint yourself at this link.

> If the user has multiple images of the same type, such as front id, the endpoint will only return the most recently added image.

This sample JSON file shows a formatted request body and response body.

```json json
// request body
{
    "images": [
        "selfie",
        "fullFrameFrontID"
    ]
}

// response body
{
  "selfie": "<base64_image>",
  "fullFrameFrontID": "<base64_image>"
}
```

> 📘 Fetch as few images as possible per request.
>
> If the response exceeds 10 MB, you will receive a 502 error (bad gateway).

### Fetching images as links

Use the [fetch image links](/api-reference/get-images-v2/) endpoint. You should always pass the session's unique interview ID, also called the Session ID. If you do not pass the interview ID, Incode attempts to extract it from the <Glossary>Session Token</Glossary>.

For the payload, pass an array with the images you wish to fetch: `"images": [""]`. 

When you choose to fetch image links, the response includes **all** previous attempts for a given image type, For example, front-id will have all the attempts registered for the user of the front-id capture.

Previous attempts are listed under a `<type>_prevAttemps` field. This is a dictionary where the keys are numeric values representing the timestamp of when the capture was made, shown in [unix time](https://en.wikipedia.org/wiki/Unix_time), in milliseconds.

Cropped versions of images are not available for this endpoint.

### Sample

```json json
// request body
{
    "images": [
        "selfie",
        "fullFrameFrontID"
    ]
}

// response body
{
    "fullFrameFrontID": "<url_latest>",
    "fullFrameFrontID_prevAttempts": {
        "1713571344335": "<url_latest>", // latest timestamp, same link as above (fullFrameFrontID)
        "1713571314141": "<url>"
    },

    "selfie": "<url_latest>",
    "selfie_prevAttempts": {
        "1713571323431": "<url_latest>" // succeeded on first try, same link as above (selfie)
    }
}
```

## Other image extraction endpoints

The preceding endpoints can meet the most common requirements to gather onboarding images. Incode offers two additional endpoints related to image extraction, although these are less likely to be needed:

1. [Second Id's images](/api-reference/get-images-second-id/) is required if your flow is configured to have two ID documents attached to the same session. This will provide you with images related to the second IId.
2. [Fetch concatenated images](/api-reference/get-concatenated-images/) fetches all the latest images combined in a single image.

---

- Path: `integrate-by-platform/fetch-scores`
- URL: https://developer.incode.com/integrate-by-platform/fetch-scores/
- Markdown: https://developer.incode.com/integrate-by-platform/fetch-scores.md

# Fetch Score Data

## What is score data?

Score data includes all results associated with the checks and validations included in a given flow configuration.

### How can I see score data?

You can see this data by either:

* Going to Dashboard > Sessions, locating the session you want to review, and selecting it.
* Using the [fetch scores](/api-reference/get-score/) API endpoint to obtain the data as a JSON response. You can also test this endpoint yourself at the preceding link. This is the same API endpoint used by the Incode Dashboard.

To fetch score data for a given onboarding session, you must pass the session's unique interview ID, also called the Session ID, to the [fetch scores](/api-reference/get-score/) API endpoint. If you do not pass the interview ID, Incode attempts to extract it from the session token.

### When is score data available?

Scores are calculated once an onboarding is finished and after rules have been applied. The associated score data can be viewed or fetched once the onboarding session has been marked as complete via the [finish-status endpoint](/api-reference/finish-status-post/)

## How should I interpret score data?

In the Incode Dashboard, the Overall Status score is presented using the model of a traffic signal:

* **Green**: `OK`; a passing score; that is, a *go*
* **Yellow**: `WARN`; there are concerns in the data score; that is, a *caution*
* **Red**: `FAIL`; that is, a *stop*

Even when you choose to directly fetch the data, keep this model in mind. While there may be dozens of scores and tests in every session, the most important score is always Overall Status. This is a composite score which factors in all the tests included in the settings of your configured flow.

Due to the complex nature of flow's and score calculations, we do not recommend you consider the numeric values of individual validations. Although this might be tempting, the Overall Status should be your guide to the outcome of the completed session.

## Sample JSON File

Following is a sample JSON file as retrieved using the [fetch scores](/api-reference/get-score/) API endpoint. This sample reflects the settings and results of a given flow. Your files will be based on your flows and may not look exactly like this one. However, the sample gives an idea of how you can use it to check the onboarding session's overall status, as well as the overall status per module validation. It also provides an explanation of the different JSON response parameters.

```json JSON
{
  ..., // subscores fields
  "idValidation": {
    "photoSecurityAndQuality": [
      ...
    ],
    "idSpecific": [
 			...
    ],
    "overall": {
      "value": "100.0", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
	"liveness": {
    ...,
    "overall": {
      "value": "100.0", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
  "faceRecognition": {
    "existingUser": true, // If true. this tells you if the user had a previous approved onboarding session
    "existingInterviewId": "", // this is the original approved session from this user
    ...,
    "overall": {
      "value": "83.2", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
  "appliedRule": { // When a rule is applied it appears here
    "name": "Undeage Rule", // Name of the rule that got applied
    "expression": "underageCheck_STATUS == 'FAIL'", // The expression that got applied
    "ruleType": "total", // Type of the rule
    "status": "FAIL", // The new score that got applied
    "incodeScoreOverall": { // The score before it got triggered
      "value": "94.4",
      "status": "OK"
    }
  },
  "overall": {
    "value": "94.4", // avoid validating against this value
    "status": "OK" // this is the value you care about
  },
  "reasonMsg": "" // reason for the obtained overall score
}
```

> 📘 Scores and OCR Data
>
> Optical Character Recognition (OCR) data shows in the Incode Dashboard along with some scoring. This scoring relates solely to the **level of confidence** on the data extracted from the captured image of the ID. Level of confidence for OCR data does not directly affect or alter the score of a session.

---

- Path: `integrate-by-platform/fetch-videos`
- URL: https://developer.incode.com/integrate-by-platform/fetch-videos/
- Markdown: https://developer.incode.com/integrate-by-platform/fetch-videos.md

# Fetch Videoselfie Video File

## What is the videoselfie video file?

This file is available only when the videoselfie module is part of your onboarding flow. In this case, you can fetch the final video file once the user has completed the module. The video might not be immediately available, because it can take a period of time for the video encoded video file to be ready.

## How do I know when the video file is ready?

You can learn when the file is ready in either of these ways:

* Incode can notify you via the [videoselfie upload webhook](/general-reference/video-selfie-webhook/)
* You can apply polling to our [fetch scores](/api-reference/get-score/) endpoint, and check for the ` videoFileIsPresent ` flag as shown in the following example:

```json Score Response
{
  // other scores
  "videoConference": {
    	// ... other scores
      "videoFileIsPresent": {
            "status": "OK" // this one is OK once we have the file available for download
      }
  }
}
```

## How can I fetch video file?

Use the [get download URL of video recording](/api-reference/generatevideoselfiedownloadurl) endpoint to obtain a signed, temporary URL to download the video file. The URL is valid for one hour, but if it expires you can regenerate the URL as many times as needed.

## Sample response

```json
{
    "url": "<signed_url>"
}
```

---

- Path: `integrate-by-platform/generate-onboarding-url`
- URL: https://developer.incode.com/integrate-by-platform/generate-onboarding-url/
- Markdown: https://developer.incode.com/integrate-by-platform/generate-onboarding-url.md

# Generate Onboarding URL

## Introduction

A unique URL can be generated for each onboarding session. Most of the values come from the previously created <Glossary>Session Token</Glossary>. For that reason, configurations that you might want attached to the generated URL, such as `configurationId`  or ` redirectionUrl`, must be sent in the previous [Start onboarding](https://developer.incode.com/api-reference/start/) step.

Check the [fetch onboarding url](https://developer.incode.com/api-reference/onboarding-url/) documentation for a full reference of the endpoint's inputs and output.

## `/omni/onboarding-url` requests

This request uses the following header values:

### Headers

| Header                 | Value                                                                 |
| :--------------------- | :-------------------------------------------------------------------- |
| `X-Incode-Hardware-Id` | **Required**: The <Glossary>Session Token</Glossary> for this session |
| `api-version`          | **Required**: 1.0                                                     |
| `clientId`             | **Required**: Your client ID as provided in the query params.         |

These are the only required header values unless you are only using a QR code. Additional parameters are recommended if your onboarding Flow includes SMS verification, desktop verification, or both. See the [fetch onboarding url](https://developer.incode.com/api-reference/onboarding-url/) documentation for more information.

## Sample code

```curl
curl --location 'https://demo-api.incodesmile.com/0/omni/onboarding-url' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'X-Incode-Hardware-Id: <<TOKEN>>' \

```
```javascript Nodejs
const axios = require('axios');

const params = new URLSearchParams({ clientId: <<clientId> });
const config = {
  url: 'https://demo-api.incodesmile.com/0/omni/onboarding-url',
  headers: { 
    'Content-Type': 'application/json', 
    'api-version': '1.0', 
    'X-Incode-Hardware-Id': <TOKEN>,
  }
};

axios(config).then(function (response) {
  const url = response.data.url;
  console.log(url);
}).catch(function (error) {
  console.log(error);
});

```

---

- Path: `integrate-by-platform/how-to-fetch-onboarding-results-and-data`
- URL: https://developer.incode.com/integrate-by-platform/how-to-fetch-onboarding-results-and-data/
- Markdown: https://developer.incode.com/integrate-by-platform/how-to-fetch-onboarding-results-and-data.md

# How to Fetch Results and Data

## Available Results and Data

Once the onboarding process has finished and all required Incode Modules have been executed, you can get the results. With the Incode Core Modules, you can get the following data:

* Scores Results ([`Fetch scores`](/api-reference/get-score/))
* OCR Data ([`Fetch OCR data`](/api-reference/get-ocr-data/))
* Device Information and Geolocation Data ([`Fetch device info`](/api-reference/get-device-info/))
* Uploaded Images (ID, Selfie, PoA) ([`Fetch image links`](/api-reference/get-images-v2/))

Additional results may be available if your Flow called additional Modules.

## How to Fetch Results and Data

You can trigger fetching the Onboarding Results by notifying your back end in either of the following ways:

* **Incode webhook notification**: In this approach, the Omni Platform notifies your application back end when the onboarding process is finished. [Learn more about Webhooks here](/general-reference/webhooks-overview/).
* **Web or mobile orchestrated**: Here your web or mobile app has control of the onboarding process. In this case, your app is responsible for notifying your back end that the process is finished. Then the back end can fetch the results and data.

---

- Path: `integrate-by-platform/integrate-by-platform`
- URL: https://developer.incode.com/integrate-by-platform/
- Markdown: https://developer.incode.com/integrate-by-platform.md

# Integrate by Platform

Incode supports multiple integration methods across web and mobile platforms. This section guides you through the setup and implementation details for each approach.

Use the tables below to identify the right integration method for your platform and technical requirements.

## Web

These integration methods run Incode’s identity verification in a browser environment. They vary in how much code you write and how much control you have over the user experience.

| Integration Method                                                                                    | What it is                                                                                                                                   | Technical effort                                     |
| ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| [Flows / Workflows](/integrate-by-platform/web-integrations-flows-workflows/) | A hosted, Incode-managed web app your users complete at a URL you share or redirect to. Configured in Dashboard; no front-end code required. | Minimal. Backend session start recommended           |
| [iFrame](/integrate-by-platform/web-integrations-iframe/)                     | Embed the Incode-hosted flow inside your own web page using an HTML `<iframe>`. Keeps users on your domain.                                  | Low. A few lines of code                             |
| [Redirect URL](/integrate-by-platform/web-integrations-redirect-url/)         | Redirect users from your web or mobile app to the Incode-hosted flow, then back to your app on completion.                                   | Low. Backend session start + redirect logic          |
| [WebViews](/integrate-by-platform/web-integrations-webviews/)               | Load the Incode-hosted flow inside a native mobile app’s embedded browser component.                                                         | Moderate. Requires specific native app configuration |
| [Web SDK](/integrate-by-platform/web-integrations-websdk/)                    | Integrate identity verification directly into your custom web application using the Incode Web SDK. Full control over flow and UI.           | High. Requires dedicated front-end development       |

## Mobile

These integration methods use Incode’s native and hybrid mobile SDKs to embed identity verification directly into your iOS, Android, or cross-platform mobile application.

| Platform        | SDK Type   | Technical effort |
| --------------- | ---------- | ---------------- |
| [iOS](/sdk-reference/ios-sdk/)             | Native SDK | High             |
| [Android](/sdk-reference/android-sdk/)         | Native SDK | High             |
| [React Native](/sdk-reference/react-native-sdk/)    | Hybrid SDK | High             |
| [Flutter](/sdk-reference/flutter-sdk/)         | Hybrid SDK | High             |
| [Cordova](/sdk-reference/cordova-sdk/)         | Hybrid SDK | High             |
| [Xamarin](/sdk-reference/xamarin-sdk/)         | Hybrid SDK | High             |

Each platform page covers environment setup, Workflow and Flow-based integration, full SDK integration, and platform-specific advanced configuration.

## API-Only Integration

If you need to orchestrate identity verification server-side without a front-end SDK, you can use the Incode Omni API directly.

See the following references in the API documentation:

- **Create an Onboarding Session**: Start a session and generate an onboarding URL
- **How to Fetch Results and Data**: Retrieve scores, OCR data, images, and device info
- **API Batch Processing**: Run ID validation and face validation programmatically

### Considerations for API-Only integrations

API-Only integrations have no SDK download impact, but they also do not include Incode's on-device Device and Camera trust signals, which the SDKs use to detect face and document deepfakes at the capture layer. With API-Only, deepfake protection relies on server-side video and image analysis. To add device-level protection to an API-Only integration, you should use [Deepsight](/features-and-modules/deepsight/). Deepsight requires additional licensing; contact your Incode representative for more information.

With API-Only, you are also responsible for building the capture experience: selfie capture, document capture, and any user-facing UI are not provided by Incode in this integration model.

<br />

---

- Path: `integrate-by-platform/mobile-integration-overview`
- URL: https://developer.incode.com/integrate-by-platform/mobile-integration-overview/
- Markdown: https://developer.incode.com/integrate-by-platform/mobile-integration-overview.md

# Mobile Integration Overview

Incode provides native and hybrid SDKs for integrating identity verification directly into iOS, Android, and cross-platform mobile applications. Each SDK exposes the same core verification capabilities with platform-appropriate APIs.

## Choosing an approach

Before picking a platform, decide two things: where you want the verification flow defined, and (for native iOS and Android) whether you need a specialized SDK operating mode.

### Where the flow is defined

All mobile SDK integrations support two configuration models:

**Configured in Dashboard (lower effort)**: Your app launches a verification Flow or Workflow configured in Dashboard. Incode renders the verification UI natively inside your app, and you handle the session result in a completion callback. This approach is recommended for most integrations.

**Configured in code (higher effort)**: Your app defines the flow in application code, either running it end to end in a single call or running it section by section with control returned to your app between sections. This is suited to teams that need granular control over the user experience or want to interleave Incode SDK steps with their own screens or logic.

### SDK operating modes (native only)

Native iOS and Android support two specialized SDK modes in addition to the standard mode:

- **Capture-Only SDK**: The SDK captures images and biometric data on-device, and your application handles all network communication with Incode's API. Useful for offline operation, multi-vendor architectures, or cases where you need full control over network behavior.
- **On-Demand Resources (ODR) SDK**: Reduces the initial SDK download size by up to 50% by fetching UI assets and models at runtime.

These modes are available for native iOS and Android only. They are not supported in hybrid SDKs (React Native, Flutter, Xamarin, Cordova, Ionic Capacitor). If your integration requires Capture-Only or ODR, you will need to use a native SDK.

## Native SDKs

Use a native SDK if you are building a dedicated iOS or Android application.

- [iOS SDK Reference](/sdk-reference/ios-sdk/): Swift / Objective-C
- [Android SDK Reference](/sdk-reference/android-sdk/): Kotlin / Java

## Hybrid SDKs

Use a hybrid SDK if you are building a cross-platform application. Hybrid SDKs wrap the native iOS and Android SDKs.

- [React Native SDK Reference](/sdk-reference/react-native-sdk/)
- [Flutter SDK Reference](/sdk-reference/flutter-sdk/)
- [Cordova SDK Reference](/sdk-reference/cordova-sdk/)
- [Xamarin SDK Reference](/sdk-reference/xamarin-sdk/)

## Alternatively: WebViews

If you want to use an Incode-hosted verification flow inside a native app without integrating an SDK, see [WebViews](#). WebViews embed the Incode web flow in a native browser component and require specific app configuration rather than SDK integration.

---

- Path: `integrate-by-platform/single-onboarding`
- URL: https://developer.incode.com/integrate-by-platform/single-onboarding/
- Markdown: https://developer.incode.com/integrate-by-platform/single-onboarding.md

# Create an Onboarding Session

## Considerations

- You must include a `flowId` from a previously created Incode Flow when you start an onboarding session. This ID links the new session to a specific flow. The configurations and thresholds for that Flow are used when the verifications are executed by the Incode APIs.
- Onboarding Sessions must be created in your application back end (never directly from the front-end application) using the Incode API, specifically the `/omni/start ` endpoint.
- You must create a new onboarding session every time an onboarding attempt is executed, even if it is related to the same user. This requirement preserves session integrity and improves performance analytics.

## Session creation

The following diagram shows the initial steps that happen your application, both front and back end. Once your application requests a session start, the Omni API is invoked with the `/omni/start `endpoint.

![](https://developer.incode.com/assets/37214cd649e9b2f4b2882ee3b647ffe0.png)

## The `/omni/start` endpoint

This endpoint is responsible for creating new Incode sessions.  It returns a JSON response that contains metadata about the newly created session.

Check the [start onboarding](/api-reference/start) documentation for a complete reference of the endpoint's inputs and output.

## `/omni/start` requests

This request uses the following header values and body key/value pairs:

### Headers

| Header        | Value                                 |
| :------------ | :------------------------------------ |
| `api-version` | `"1.0"`                               |
| `x-api-key`   | The API Key provided to you by Incode |

### JSON Request Body

| Key                  | Value                                                                                                                                                                                                                                                                                                             |
| :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `configurationId`    | The Incode Flow identifier, also referred to as the Flow ID, for your new sessions. If you don't know the Flow ID, open Dashboard > Flows, locate the Flow you want to reference, and click Copy Flow ID in the Actions column.                                                                                   |
| `externalCustomerId` | **Optional**: ID that links the new onboarding session to a specific ID  you provide. You can query all the sessions related to this ID on the Incode Dashboard. For example, you may have assigned an ID to the customer in another system and want to be able to find all sessions related to that customer ID. |
| `redirectionUrl`     | **Optional**: Used with `/omni/onboarding-url` to redirect to this URL at the end of the flow. You can also configure this on the Incode Dashboard.                                                                                                                                                               |

```shell cURL
curl --location '{user.DEMO_URL}omni/start' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: <<APIKEY>>' \
--data '{
	"countryCode": "ALL",
    "configurationId": "65283accd410a1dd7e965479",
    "externalCustomerId": "someuser0001",
    "redirectionUrl": "http://example.com/"
}'
```
```javascript Javascript
const params = {
  configurationId: <flowId>,
  countryCode: "ALL",
  language: "en-US",
  //externalCustomerId: "someuser0001", //The Id if the user in your system
  //redirectionUrl: "http://example.com/", //The url where the user will be redirected at the end of the onboarding
  
};

const headers = {
  accept: 'application/json',
  'content-type': 'application/json',
  'x-api-key': '<<APIKEY>>',
  'api-version': '1.0'
};

const options = {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(params)
};

const response = await fetch('{user.DEMO_URL}omni/start', options);

const {token, interviewId} = response.json();
```

## Handling the `/omni/start` response

Your application back-end must process the response, which returns multiple values. The following values are specifically needed for your web application.

### The `interviewId`

A unique `interviewId` string (or Session ID) is assigned when a new session is created. Store each `interviewId` you create in your application back end.

### The session `token`

The Web SDK needs a valid session token to communicate with the Incode API. The `/omni/start` response returns a new `token` value each time you create a new session. This JSON Web Token is used to call the Omni APIs required as part of the onboarding process. Learn more about [Session Tokens](/general-reference/get-an-access-token/).

Send back only the `token` and the `interviewId` to the front end. These are the only keys to the `omni/start` response, and the SDKs need these values to work with the Incode Omni API.

---

- Path: `integrate-by-platform/web-integration-overview`
- URL: https://developer.incode.com/integrate-by-platform/web-integration-overview/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integration-overview.md

# Web Integration Overview

Incode provides five approaches for integrating identity verification into web environments. Each approach offers a different balance between implementation simplicity and customization depth.

## Choosing an approach

**[Flows / Workflows](/integrate-by-platform/web-integrations-flows-workflows/)**: This is the starting point for most integrations. They require no front-end code and run entirely on Incode-managed infrastructure. Your backend starts a session, and you share or redirect users to the resulting URL. This approach is well-suited to teams that want to **get live quickly**, and to any integration where you don’t need to customize every aspect of the verification UI.

**[iFrame](/integrate-by-platform/web-integrations-iframe/)**: This embeds the Incode-hosted flow within your own web page, keeping users on your domain throughout. It requires a backend and a small amount of front-end code. Choose iFrame if you want the verification experience to feel seamless within your site.

**[Redirect URL](/integrate-by-platform/web-integrations-redirect-url/)**: Redirect URL covers two sub-patterns. Both require a backend.

- **Redirect only** sends the user to the Incode-hosted flow and retrieves results server-side via webhook or API. The frontend doesn't handle a return.
- **Redirect and Back** sends the user to the flow and receives them back in your app on completion, where the frontend uses a stored session reference to trigger result fetching.

Choose Redirect URL if sending users to a separate page for verification is acceptable.

**[WebViews](/integrate-by-platform/web-integrations-webviews/)**: This option applies when your integration point is a mobile app that loads web content in an embedded browser. WebView support follows the same model as Flows and Workflows: Incode hosts the verification UI, but requires specific configuration in your native app to ensure browser APIs and hardware permissions are available.

**[Web SDK](/integrate-by-platform/web-integrations-websdk/)**: This is the highest-effort option and provides the most control. Your web application hosts the verification UI directly, using Incode’s JavaScript SDK to manage the onboarding flow. This approach is suited to teams with dedicated front-end developers who need custom flow logic or full UI control.

### At a glance

|                           | Flows / Workflows | iFrame  | Redirect URL | WebViews | Web SDK |
| ------------------------- | ----------------- | ------- | ------------ | -------- | ------- |
| Front-end code required   | No                | Minimal | Minimal      | Minimal  | Yes     |
| Backend required          | Recommended       | Yes     | Yes          | Yes      | Yes     |
| Hosted by                 | Incode            | Incode  | Incode       | Incode   | You     |
| User stays on your domain | No                | Yes     | No           | No       | Yes     |
| Custom UI control         | No                | No      | No           | No       | Yes     |

## Before you Begin

The Flows/Workflows, iFrame, and Redirect URL integration methods all share the same Dashboard setup steps. Complete these before starting any of those integrations.

### 1. Create a Workflow

All three integration methods require a configured Workflow in Dashboard. If you haven't created one yet, see [Workflows](/dashboard-platform-administration/workflows-20/) for instructions. Make a note of your Workflow ID; you'll need it when starting sessions via the API.

### 2. Add the Data Sharing Consent module

The Combined Consent (Data Sharing Consent) module is required in all Workflows. Add it to your Workflow in the Workflow Designer before publishing. See [Combined Consent](/features-and-modules/combined-consent/) for details.

### 3. Enable redirect desktop to mobile (recommended)

To reduce fraud and improve conversion, enable **Redirect desktop attempts to mobile** in your Workflow settings. This redirects users who open the verification flow on a desktop to complete it on their mobile device instead. In Dashboard, open your Workflow, click **Settings**, and enable the toggle.

See [Workflows](/dashboard-platform-administration/workflows-20/#create-workflows) for the full settings reference.

### 4. Set a Redirect URL in the Workflow (Redirect URL Only)

If you are implementing the Redirect and Back sub-pattern, set the **Redirect URL** field in your Workflow settings to the return URL in your application (for example, `https://yourapp.com/verification-complete`). This is what Incode uses to send the user back to your app after verification.

This field is optional for Redirect only, iFrame, and Flows/Workflows integrations — but can be useful to present a branded completion screen.

### 5. Obtain your API credentials

You'll need your API URL and API key to call the Incode Omni API from your backend. Keep them server-side and never expose them in client-side code. How you get these depends on where you are in the process with Incode; see [Getting Your API Credentials](/get-started-with-incode/getting-credentials/) for more details.

---

- Path: `integrate-by-platform/web-integrations-customization`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-customization/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-customization.md

# Web Integrations Customization

# Customization Options & Support

Depending on your integration type, you may be able customize the onboarding experience for your end users. This table shows the level and type of support for the available options.

| Customization Type     | No-Code / Low-Code integrations | Web SDK integration                                                  | Additional Instructions                            |
| :--------------------- | :------------------------------ | :------------------------------------------------------------------- | :------------------------------------------------- |
| Logo                   | Yes. Configured in Dashboard.   | Not supported. The onboarding experience is integrated in a web app. | [Styles](/integrate-by-platform/web-integrations-styling/)                                  |
| Colors                 | Yes. Configured in Dashboard.   | Yes. Configured using CSS.                                           | [Styles](/integrate-by-platform/web-integrations-styling/)                                  |
| Font                   | Yes. Configured using CSS.      | Yes. Configured using CSS.                                           | [Styles](/integrate-by-platform/web-integrations-styling/)                                  |
| Shapes and borders     | Yes. Configured using CSS.      | Yes. Configured using CSS.                                           | [Styles](/integrate-by-platform/web-integrations-styling/)                                  |
| Texts and translations | Not supported.                  | Yes. Configured using a JSON file.                                   | [Texts and translations](/integrate-by-platform/web-integrations-localization-and-strings/) |

<br />

---

- Path: `integrate-by-platform/web-integrations-flows-workflows`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-flows-workflows/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-flows-workflows.md

# Flows and Workflows

Flows and Workflows are Incode-hosted web applications that guide end users through an identity verification session. You configure the verification steps in Dashboard, and Incode handles the front end entirely. There is no custom web development required.

This is the simplest integration approach.

## Flows vs. Workflows

Incode supports two configuration models for hosted sessions:

- **Workflows** are the newest, recommended model. They support conditional logic, dynamic routing between verification steps, and more advanced session configuration.
- **Flows** are the legacy model. They remain supported but do not include conditions or dynamic routing. New integrations should use Workflows.

For instructions on creating and configuring Workflows and Flows in Dashboard, see [Workflows](/dashboard-platform-administration/workflows-20/) and [Flows](/dashboard-platform-administration/flows-1/).

## How it works

1. **[Configure a Workflow](/dashboard-platform-administration/workflows-20/) in Dashboard.** Define the verification [modules](/features-and-modules/modules-overview-and-availability/) your users will complete (ID scan, selfie, eKYC, etc.) and any conditional logic.
2. **[Copy the Workflow URL](/dashboard-platform-administration/workflows-20/#other-workflow-actions)**. Find the Workflow you just created at **Flow Builder** > **Workflows**. Click the three dots in the Actions column > **Copy URL**.
3. **Start a session (recommended).** Your backend calls the Incode Omni API to create an onboarding session and generate a session-specific URL. Attaching an `externalCustomerId` at this step links the session to a user in your own system.
4. **Direct your user to the URL.** Share it via SMS, email, or a redirect from your web or mobile app.
5. **Retrieve results.** Read session results directly in Dashboard or configure a webhook to receive real-time notifications when sessions complete.

:::info
  If you do not start a session via the API, you can share the Workflow URL directly with users. This is suitable for simple cases but does not allow you to link sessions to specific users in your system.
:::

## When to use this approach

Flows and Workflows are a good fit when:

- You want to go live quickly without front-end development
- You don’t need to customize the verification UI
- You are handling a high volume of users and want Incode to manage the delivery infrastructure
- You need to send verification links via messaging channels (SMS, WhatsApp, email)

If you need users to remain on your domain, consider the [iFrame](/integrate-by-platform/web-integrations-iframe/) approach instead. If you need full UI control, see [Web SDK](/integrate-by-platform/web-integrations-websdk/).

## Prerequisites

Complete the [Dashboard setup steps](/integrate-by-platform/web-integration-overview/#before-you-begin) in Web Integration Overview before starting this integration. These cover creating a Workflow, adding the Data Sharing Consent module, enabling redirect desktop to mobile, and obtaining your API credentials.

## Starting a session

Call the [Start Onboarding Session](/integrate-by-platform/single-onboarding/) endpoint from your backend to create a session and retrieve an onboarding URL: `POST /omni/start`

Include an `externalCustomerId` in the request body to associate the session with a user in your system. The response includes a `token` and a ready-to-use onboarding URL.

Redirect your user to the URL or share it through your preferred channel.

## Retrieving results

When the user completes the session, you can retrieve results in two ways:

- **Dashboard**: View session scores, OCR data, and status directly in Dashboard.
- **Webhook**: Configure an [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/) or [Session Webhooks](/general-reference/session-webhooks/) to receive notifications when session status changes

For full details on fetching data programmatically, see [How to Fetch Results and Data](/integrate-by-platform/how-to-fetch-onboarding-results-and-data/).

---

- Path: `integrate-by-platform/web-integrations-iframe`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-iframe/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-iframe.md

# iFrame

The iFrame integration embeds the Incode-hosted verification flow inside your own web page using an HTML `<iframe>` element. Your users complete identity verification without leaving your domain, while Incode manages the verification UI and infrastructure.

This approach requires a backend to start sessions and a small amount of front-end code to embed and communicate with the iFrame.

## How it works

1. Your backend starts an onboarding session and generates a session URL.
2. Your front end renders an `<iframe>` pointing to that URL.
3. The user completes identity verification inside the iFrame, on your page.
4. Your app listens for a `postMessage` event from the iFrame to detect session completion, then retrieves results via webhook or API.

## Prerequisites

- An active Incode account with API credentials
- A configured [Workflow](/dashboard-platform-administration/workflows-20/) in Dashboard
- A backend service to call the Incode Omni API and start sessions
- HTTPS on your domain (required for camera and microphone access)

## Starting a session

Call the [Start Onboarding Session](/integrate-by-platform/single-onboarding/) endpoint from your backend: `POST /omni/start`

Include an `externalCustomerId` to link the session to a user in your system. The response includes a session `token` and an onboarding URL. Pass the URL to your front end to use as the `src` of your iFrame.

## Embedding the iFrame

```html
<iframe
  src="https://YOUR_ONBOARDING_URL"
  allow="camera; microphone; geolocation; accelerometer; gyroscope"
  width="100%"
  height="700px"
  frameborder="0"
></iframe>
```

If you create the iFrame with JavaScript, set the same permissions:

```javascript
frame.setAttribute("allow", "camera; microphone; geolocation; accelerometer; gyroscope");
```



The `allow` attribute is required. The browser blocks an embedded iFrame from using device hardware and sensors unless each permission is explicitly granted:

- `camera` **and** `microphone`: Required for ID and selfie capture.
- `accelerometer` **and** `gyroscope`: Required for ID capture on Chrome for Android. Without them, Chrome silently blocks the motion sensors the SDK uses, and ID capture stays on the loading screen.
- `geolocation`: Required to collect location signals.





## Detecting session completion

Listen for a `postMessage` event from the iFrame to know when the user has finished:

```jsx
window.addEventListener('message', (event) => {
  if (event.data?.type === 'ONBOARDING_FINISHED') {
    // Session complete — fetch results or redirect the user
  }
});
```

For a full list of event types, see the [Onboarding Session Lifecycle](/get-started-with-incode/onboarding-session-lifecycle/).

## Retrieving results

Once the session is complete, retrieve results via:

- **Webhook**: Configure an [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/) or [Session Webhooks](/general-reference/session-webhooks/) to receive real-time notifications
- **API**: Call [How to Fetch Results and Data](/integrate-by-platform/how-to-fetch-onboarding-results-and-data/) endpoints directly from your backend

## When to use this approach

The iFrame approach is a good fit when:

- You want users to stay on your domain throughout the verification process
- You have a backend but want to minimize front-end development
- You don't need to customize the verification UI

If you need users to complete verification on a separate page, consider [Redirect URL](/integrate-by-platform/web-integrations-redirect-url/) instead. If you need full UI control, see [Web SDK](/integrate-by-platform/web-integrations-websdk/).

---

- Path: `integrate-by-platform/web-integrations-localization-and-strings`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-localization-and-strings/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-localization-and-strings.md

# Localization and Strings

Incode web products will display in the default language set in the browser, however, you can explicitly set up one of the supported translations. Refer to [Supported Languages](/general-reference/supported-languages/) for a full list.

> 👍 Pro Tip
>
> You can explicitly change the language of your application by appending a 2-digit language code in your app's URL.  _Example_, lang=fr or lang=pt

# Customization in Web

In addition to localization support, you may want to change strings to display different words.

For example, to change a screen that shows the word "Retake" you can choose to show the word "Try again" instead. Here's how to do that.

```json
{
  "common": {
    "retake": "Try again",  //previously the word "Retake" was here
  }
}
```

## Translations Tool

You can use our [translations tool ](https://translations.poc.incodetest.com/) to search for the strings or keys you would like to personalize an generate a sample translation file for you to personalize.


<Image src="https://developer.incode.com/assets/684b321df7bbce99fbe2a00358fde32a.png" align="center" width="500px" />


You can then include the language file during the Web SDK's `create()` method, like below:

```javascript
import { en } from "./en.js";

const incode = await create({
  apiURL: apiURL,
  translations: en,
});

//Allows proper translation loading order
await incode.initialize();
```

<br />

---

- Path: `integrate-by-platform/web-integrations-redirect-url`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-redirect-url/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-redirect-url.md

# Redirect URL

The Redirect URL integration sends users from your web or mobile app to an Incode-hosted verification flow. Incode manages the verification UI and infrastructure; your app manages the redirect and result handling.

There are two sub-patterns depending on whether you need the user to return to your app after verification:

- **Redirect only**: Your app redirects the user to the Incode-hosted flow. Results are retrieved server-side via webhook or API. The frontend doesn't need to handle a return.
- **Redirect and back**: Your app redirects the user to the flow and receives them back on completion via a `redirectionUrl`. The frontend handles the return and uses the session reference to trigger result fetching.

Both patterns work across web and mobile contexts and require a backend to start sessions.

## Choosing a sub-pattern

|                           | Redirect only                         | Redirect and back                             |
| ------------------------- | ------------------------------------- | --------------------------------------------- |
| Frontend handles return   | No                                    | Yes                                           |
| Results retrieved by      | Backend (webhook or API poll)         | Backend, triggered by frontend on return      |
| `redirectionUrl` required | No                                    | Yes                                           |
| Best for                  | Server-driven flows, async processing | Apps that need to react immediately on return |

## Prerequisites

Complete the [Dashboard setup steps](/integrate-by-platform/web-integration-overview/#before-you-begin) in Web Integration Overview before starting this integration. These cover creating a Workflow, adding the Data Sharing Consent module, enabling redirect desktop to mobile, and obtaining your API credentials.

If you are using the **Redirect and back** sub-pattern, ensure you complete the optional Dashboard setup step 4 to set the **Redirect URL** field in your Workflow settings to your return URL.

<Callout icon="📘" theme="info">
  ### **Nobackend (simple case)**

  If you only need to send users through a verification flow and view results in Dashboard, you can share a generic [Workflow URL](/dashboard-platform-administration/workflows-20/#other-workflow-actions) directly without starting a session. This approach does not link sessions to specific users in your system.&#x20;
</Callout>

## Redirect only

Your backend starts a session, generates an onboarding URL, and redirects the user to it. When the session completes, Incode notifies your backend via webhook (or your backend polls for the result). The user does not return to your app via redirect.

![](https://developer.incode.com/assets/20a741e8d35186d9599c73a4bc84c8ef.png)

### Step 1: Start a session (backend)

Call the [Start Onboarding Session](/integrate-by-platform/single-onboarding/) endpoint: `POST /omni/start`.

Request body (key fields):

```json
{
  "configurationId": "YOUR_WORKFLOW_ID",
  "externalCustomerId": "your-user-id"
}
```

Save the `token` and `interviewId` from the response to your database. These are needed later to retrieve results.

### Step 2: Generate the onboarding URL (backend)

Call `/omni/onboarding-url` with the session token:

```jsx
const response = await fetch(`${API_URL}0/omni/onboarding-url`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "api-version": "1.0",
    "X-Incode-Hardware-Id": token,
  },
});

const { url } = await response.json();
```

### Step 3: Redirect the user (frontend)

```jsx
window.location.replace(url);
```

### Step 4: Retrieve results (backend)

Configure an [Onboarding Status Webhook](/general-reference/onboarding-status-webhook/) or [Session Webhooks](/general-reference/session-webhooks/) to receive notification when the session completes, then fetch the results using the `interviewId`.&#x20;

## Redirect and back

Your backend starts a session with a `redirectionUrl` set. When the user finishes verification, Incode redirects them back to that URL. Your frontend reads the session reference it stored before the redirect and calls your backend to fetch results.

![](https://developer.incode.com/assets/a8541b67ff9dae5dd34ec14167623d70.png)

### Step 1: Create a session and generate an onboarding URL (backend)

**1.1 — Create the session**

Call `/omni/start` with a `redirectionUrl`:

```jsx
const params = {
  configurationId: "YOUR_WORKFLOW_ID",
  countryCode: "ALL",
  language: "en-US",
  externalCustomerId: "your-user-id",
  redirectionUrl: "https://yourapp.com/verification-complete",
};

const response = await fetch(`${API_URL}omni/start`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY",
    "api-version": "1.0",
  },
  body: JSON.stringify(params),
});

const { token, interviewId } = await response.json();
```

**1.2 — Save the token and interviewId**

Persist the session `token` and `interviewId` to your database, associated with your user. You will need these to retrieve results after the session completes.

**1.3 — Generate the onboarding URL**

Call `/omni/onboarding-url` with the session token:

```jsx
const response = await fetch(`${API_URL}0/omni/onboarding-url`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "api-version": "1.0",
    "X-Incode-Hardware-Id": token,
  },
});

const { url } = await response.json();
```

> The `/0/` prefix indicates a zero-configuration endpoint — it only needs the session token and derives all other context from it.

**1.4 — Return the URL and interviewId to your frontend**

### Step 2: Store a session reference in the frontend

Before redirecting the user, save the `interviewId` so your return page can access it. The return URL will not carry any session information, so the frontend needs its own reference.

```jsx
const response = await fetch("https://your.backend.app/create-session");
const { interviewId, url } = await response.json();

localStorage.setItem("interviewId", interviewId);
```

### Step 3: Redirect the user

```jsx
window.location.replace(url);
```

### Step 4: Receive the user back

Create the return page your `redirectionUrl` points to. When the user lands here after completing verification, retrieve the `interviewId` from localStorage and call your backend to fetch results.

```jsx
const interviewId = localStorage.getItem("interviewId");

const response = await fetch(
  `https://your.backend.app/fetch-score?interviewId=${interviewId}`
);
const { status } = await response.json();

if (status === "OK") {
  console.log("Verification passed");
} else {
  console.log("Verification did not pass");
}
```

### Step 5: Fetch results in the backend

Receive the `interviewId` from the frontend, use it to look up the session `token` from your database, then call the Incode API to retrieve results.&#x20;

## When to use this approach

Redirect URL (either sub-pattern) is a good fit when:

- You are comfortable sending users to a separate page for verification
- You want minimal front-end code
- You are redirecting from a mobile app's browser or WebView
- You need to send verification links via SMS, WhatsApp, or email (use the URL directly; no redirect logic needed)

If you need users to stay on your domain, consider [iFrame](/integrate-by-platform/web-integrations-iframe/) instead. If you need full UI control, see [Web SDK](/integrate-by-platform/web-integrations-websdk/).

---

- Path: `integrate-by-platform/web-integrations-styling`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-styling/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-styling.md

# Styling and CSS Customization

# Low Code Integrations

If you have chosen a low code integration or are using the quick start guide you can style the web flow application though the Dashboard.

<Image border={false} src="https://developer.incode.com/assets/8f2b40762c1f1a1f7e393e2f8b0e87f6.png" />

## User interface (UI) customization

1. Log in to **Dashboard** > **Configuration** > **Customization**. The first section lets you customize some or all of the elements listed in the next steps.
2. To add your logo, click in the **Logo** field, navigate to and select the saved logo file on your computer, and then click **Open**. The logo must be saved in JPG, PNG, or SVG format.
3. Add a **Subtitle**.
4. Use the **Button** slider to adjust the corner radius.
5. Change the **Button Color** and **Button Color Text**. You can click the colored area on the left of each field to use a selector or enter RGB values, or you can enter a hexadecimal (HEX) color code directly in the field.
6. Click the radio button to include a custom CSS stylesheet. For more information on this advanced option, see the next section on this page.
7. If you don't want the Incode branding to show to your end users, select the **Hide footer branding** checkbox.
8. When you are finished, click **Update UI**.

## Content customization

1. If you haven't already done so, log in to **Dashboard** > **Configuration** > **Customization**.
2. Scroll down to the Content section. This section lets you customize the text fields in your integration.
3. Enter a **Headline** for your finish screen. The default value is _Thank you_.
4. Enter the **Body Text** for your finish screen. The default value is _Your verification is complete_.
5. Enter **SMS Text** for the text message your users receive to start onboarding.
6. When you are finished, click **Update content**.

# Use a custom CSS file

You can use custom CSS stylesheets to adjust the look and feel of your app. This is an advanced technique. For best results, we recommend that your developers use the developer tools in their browser to identity specific DOM elements which can be styled.

In general, all elements prefixed with CSS selector named `Incode` can be referenced and styled in a CSS file, as shown here in the following image. Elements that don't have this prefix are **not** available for customization.

```css Customizable Elements
/*  */
/* Tutorials */
/*  */

/* Tutorial Base */
/* Header Container*/
.IncodeTutorialHeaderContainer {
}
/* Header */
.IncodeTutorialHeader {
}
/* Header Title (h1) */
.IncodeTutorialHeaderTitle {
}
/* Header Subtitle  */
.IncodeTutorialHeaderSubtitle {
}
/* Video */
.IncodeTutorialVideo {
}
/* Button container */
.IncodeTutorialButtonContainer {
}
/* Continue Button */
.IncodeTutorialButton {
}

/* Tutorial Front */
/* Header Container*/
.IncodeTutorialHeaderContainerFront {
}
/* Header */
.IncodeTutorialHeaderFront {
}
/* Header Title (h1) */
.IncodeTutorialHeaderTitleFront {
}
/* Header Subtitle  */
.IncodeTutorialHeaderSubtitleFront {
}
/* Video */
.IncodeTutorialVideoFront {
}
/* Button container */
.IncodeTutorialButtonContainerFront {
}
/* Continue Button */
.IncodeTutorialButtonFront {
}

/* Tutorial Back */
/* Header Container*/
.IncodeTutorialHeaderContainerBack {
}
/* Header */
.IncodeTutorialHeaderBack {
}
/* Header Title (h1) */
.IncodeTutorialHeaderTitleBack {
}
/* Header Subtitle  */
.IncodeTutorialHeaderSubtitleBack {
}
/* Video */
.IncodeTutorialVideoBack {
}
/* Button container */
.IncodeTutorialButtonContainerBack {
}
/* Continue Button */
.IncodeTutorialButtonBack {
}
/* Front tutorial container */
.IncodeCaptureFrontIdTutorial {
}
/* Back tutorial container */
.IncodeCaptureBackIdTutorial {
}
/* Tutorial selfie */

/* Button */
.IncodeTutorialButtonSelfie {
}

/*  */
/* OTP */
/*  */

/* OTP Container */
.IncodeOTP {
}
/* OTP content */
.IncodeOTPContent {
}
/* OTP title */
.IncodeOTPTitle {
}
/* OTP paragraph of the seconds */
.IncodeOTPSecondsParagraph {
}
/* OTP Label with instructions */
.IncodeOTPLabel {
}
/* OTP Code Text p */
.IncodeOTPText {
}
/* OTP timer */
.IncodeOTPTimer {
}
/* OTP error text */
.IncodeOTPError {
}
/* OTP button */
.IncodeOTPButton {
}
/* Each input in OTP */
.IncodeOTPInput {
}

/*  */
/* Conference */
/*  */

/* Modal for exit the conference */
/* Container for modal */
.IncodeAreYouSureModal {
}
/* Modal overlay */
.IncodeAreYouSureModalOverlay {
}
/* Modal close icon button */
.IncodeAreYouSureModalCloseIconButton {
}
/* Modal close icon span */
.IncodeAreYouSureModalCloseIconSpan {
}
/* Title */
.IncodeAreYouSureModalTitle {
}
/* Modal subtitle */
.IncodeAreYouSureModalSubtitle {
}
/* Modal buttons container */
.IncodeAreYouSureModalButtonsContainer {
}
/* Continue PRocess Button */
.IncodeAreYouSureModalContinueProcessButton {
}
/* Disconnect Button */
.IncodeAreYouSureModalDisconnectButton {
}

/* Connecting footer (The one with the SMS message and disconnect button) */
/* Container */
.IncodeSMSMessageContainer {
}
/* SMS message container (only the one with text about sms) */
.IncodeSMSContainer {
}
/* SMS Icon */
.IncodeSMSIconImg {
}
/* SMS text */
.IncodeSmsText {
}
/* Disconnect button */
.IncodeDisconnectButtonQueue {
}

/* Conference Connected Video Call view*/
/* container */
.IncodeConferenceContainer {
}
/* Header */
.IncodeConferenceHeader {
}
/* User video container */
.IncodeSubscriberContainer {
}

/* Bandwidth check */
/* Bandwidth check container */
.IncodeBandwithContainer {
}
/* Bandwidth spinner */
.IncodeBandwidthSpinner {
}
/* Bandwidth title */
.IncodeBandwithTitle {
}
/* Bandwidth image */
.IncodeBandwidthImage {
}
/* Bandwidth subtitle */
.IncodeBandwidthSubtitle {
}
/* Bandwidth text */
.IncodeBandwithText {
}

/* Connecting */
/* Connecting title */
.IncodeConnectingTitle {
}
/* Connecting image */
.IncodeConnectingImage {
}
/* Connecting loading circle container */
.IncodeLoadingCircleContainer {
}
/* Connecting loading circle spinner */
.IncodeLoadingCircleSpinnerInner {
}
/* Connecting loading circle image */
.IncodeLoadingCircleImg {
}
/* Connecting loading circle text */
.IncodeLoadingCircleConnectingText {
}
/* Connecting span */
.IncodeConnectingSpan {
}
/* Connecting SMS container */
.IncodeFooterSmsMessage {
}

/* Executive Ready  */
/* container */
.IncodeExecutiveReadyContainer {
}
/* Ececutive ready title  */
.IncodeExecutiveReadyTitle {
}
/* Ececutive ready image  */
.IncodeExecutiveReadyImage {
}
/* Ececutive is ready message  */
.IncodeExecutiveReadyMessage {
}
/* Actions container (The one with the connect and disconnect button) */
.IncodeExecutiveReadyButtonContainer {
}
/* ready to connect button */
.IncodeExecutiveReadyConnectButton {
}
/* disconnect button (in the executive ready view) */
.IncodeExecutiveReadyDisconnectButton {
}

/* Common */
/* Checkbox */
.IncodeCheckbox {
}
/* Notification container */
.IncodeNotificationContainer {
}

/* Signature */
/* Signature container */
.IncodeSignatureContainer {
}
/* Signature title */
.IncodeSignatureTitle {
}
/* Signature subtitle */
.IncodeSignatureSubtitle {
}
/* Signature canvas container */
.IncodeSignatureCanvasContainer {
}
/* Signature canvas */
.IncodeSignatureCanvas {
}
/* Signature buttons container */
.IncodeSignatureButtonsContainer {
}
/* Signature clear button */
.IncodeSignatureClearButton {
}
/* Signature done button */
.IncodeSignatureDoneButton {
}

/* FaceMatch */
/* FaceMatch container */
.IncodeMatchUserContainer {
}
/* FaceMatch body container */
.IncodeMatchUserBodyContainer {
}
/* FaceMatch title */
.IncodeMatchUserTitle {
}
/* FaceMatch message */
.IncodeMatchUserMessage {
}
/* FaceMatch circles container */
.IncodeMatchUserCirclesContainer {
}
/* FaceMatch circle with ID */
.IncodeMatchUserIDFace {
}
/* FaceMatch circle with face */
.IncodeMatchUserFace {
}
/* FaceMatch circle with second ID */
.IncodeMatchUserIDSecondFace {
}
/* FaceMatch circle with face match */
.IncodeMatchUserFaceMatch {
}
/* FaceMatch container circle buttons */
.IncodeMatchUserContainerContinueButton {
}
/* FaceMatch continue button */
.IncodeMatchUserContinueButton {
}
/* FaceMatch liveness stripe */
.IncodeMatchUserLivenessStripe {
}
/* FaceMatch liveness image */
.IncodeMatchUserLivenessImage {
}

/* CapturePreview */
/* CapturePreview container */
.IncodePreviewContainer {
}
/* CapturePreview message */
.IncodeCapturePreviewMessage {
}
/* CapturePreview message image */
.IncodeCapturePreviewMessageImage {
}
/* CapturePreview image container */
.IncodeCapturePreviewImageContainer {
}
/* CapturePreview image */
.IncodeCapturePreviewImage {
}
/* CapturePreview uploading container */
.IncodeCapturePreviewUploadingContainer {
}
/* CapturePreview uploading text */
.IncodeCapturePreviewUploadingText {
}
/* CapturePreview uploading bar outside */
.IncodeCapturePreviewUploadingBarOutside {
}
/* CapturePreview uploading progress bar */
.IncodeCapturePreviewUploadingProgress {
}

/* Retake */

/* Incode retake container */
.IncodeRetakeContainer {
}
/* Incode retake title */
.IncodeRetakeTitle {
}
/* Incode retake subtitle */
.IncodeRetakeSubtitle {
}
/* Incode retake image container */
.IncodeRetakeImageContainer {
}
/* Incode retake image */
.IncodeRetakeImage {
}
/* Incode retake buttons container */
.IncodeRetakeButtonsContainer {
}
/* Incode retake button */
.IncodeRetakeButton {
}
/* Incode retake continue button */
.IncodeRetakeContinueContainer {
}

/* Legal Modal */

/* Legal modal container */
.IncodeLegalModal {
}
/* Legal modal overlay */
.IncodeLegalModalOverlay {
}
/* Legal modal title */
.IncodeLegalModalTitle {
}
/* Legal modal text */
.IncodeLegalModalTermsText {
}
/* Legal modal buttons container */
.IncodeLegalModalButtonsContainer {
}
/* Legal modal cancel button */
.IncodeLegalModalCancelButton {
}

/* Tutorials */

/* Incode iOS Instructions Container */
.IncodeiOSInstructionsContainer {
}
/* Incode Android Instructions Container */
.IncodeAndroidInstructionsContainer {
}
/* Incode Permissions Reload Button Container */
.IncodePermissionsReloadButtonContainer {
}
/* Incode Allow Permissions Container */
.IncodeAllowPermissionsContainer {
}
/* Incode Allow Permissions Button Container */
.IncodeAllowPermissionsButtonContainer {
}
/* Incode iOS Permissions Container */
.IncodeiOSPermissionsContainer {
}
/* Incode Android Permissions Container */
.IncodeAndroidPermissionsContainer {
}
/* Incode iOS Instructions Content */
.IncodeiOSInstructionsContent {
}
/* Incode Android Instructions Content */
.IncodeAndroidInstructionsContent {
}
/* Incode Allow Permissions Button */
.IncodeAllowPermissionsButton {
}
/* Incode iOS Button */
.IncodeiOSButton {
}
/* Incode Android Permissions Button */
.IncodeAndroidPermissionsButton {
}

/* Incode Login */
/* Main container for the Incode login component. */
.IncodeLoginContainer {
}
/* Container that holds the capture button within the Incode login component. */
.IncodeLoginCaptureButtonContainer {
}
/* Container holding the webcam view in the Incode login component. */
.IncodeLoginWebcamContainer {
}
/* Container for borders in the Incode login component. */
.IncodeLoginBordersContainer {
}
/* Borders during loading states within the Incode login component. */
.IncodeLoginLoadingBorders {
}
/* This class is used to hide login in the Incode login component. */
.IncodeLoginHidder {
}
/* Outer part of the oval-shaped camera frame in the Incode login component. */
.IncodeLoginCameraOvalOuter {
}
/* Inner part of the oval-shaped camera frame in the Incode login component. */
.IncodeLoginCameraOvalInner {
}
/* Frame that indicates the user's face area during login. */
.IncodeLoginFaceFrame {
}
/* Webcam in the Incode login component. */
.IncodeLoginWebcam {
}
/* Text inside the oval-shaped camera frame in the Incode login component. */
.IncodeLoginCameraOvalInnerText {
}
/* Inline notifications that appear within the Incode login component. */
.IncodeLoginNotificationInline {
}

/* Incode Login Desktop */
/* Main container for the Incode login component in desktop view. */
.IncodeLoginDesktopContainer {
}
/* Container that holds the capture button within the Incode login desktop component. */
.IncodeLoginDesktopCaptureButtonContainer {
}
/* Container holding the webcam view in the Incode login desktop component. */
.IncodeLoginDesktopWebcamContainer {
}
/* Class used for styling the face mask in the Incode login desktop component. */
.IncodeLoginDesktopFaceMask {
}
/* Frame that indicates the user's face area during login in the desktop view. */
.IncodeLoginDesktopFaceFrame {
}
/* Webcam in the Incode login desktop component. */
.IncodeLoginDesktopWebcam {
}
/* Notifications that appear within the Incode login desktop component. */
.IncodeLoginDesktopNotification {
}

/* Incode Second Factor */
/* Main container for the second factor authentication component. */
.IncodeSecondFactorContainer {
}
/* Class for div elements requiring margin in the second factor authentication component. */
.IncodeSecondFactorDivWithMargin {
}
/* Input element for the second factor authentication component. */
.IncodeSecondFactorInput {
}
/* Button for the second factor authentication component. */
.IncodeSecondFactorButton {
}

/* Incode Additional ID */
/* Main container for the additional ID component. */
.IncodeAdditionalIDContainer {
}
/* Webcam view in the additional ID component. */
.IncodeAdditionalIDWebcam {
}
/* Preview of the capture in the additional ID component. */
.IncodeAdditionalIDCapturePreview {
}
/* Fake button shown after autocapture timeout in the additional ID component. */
.IncodeAdditionalIDFakeButton {
}
/* Notifications within the additional ID component. */
.IncodeAdditionalIDNotification {
}

/* Incode Capture Desktop Selfie */
/* Main container for the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieContainer {
}
/* Header for the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieHeader {
}
/* Selfie container for the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieSelfieContainer {
}
/* Face mask for the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieFaceMask {
}
/* Frame that indicates the user's face area during selfie capture on desktop. */
.IncodeCaptureDesktopSelfieFaceFrame {
}
/* Webcam in the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieWebcam {
}
/* Notifications in the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieNotification {
}
/* Container for the capture button in the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieCaptureButtonContainer {
}
/* Tutorial for the selfie capture on desktop. */
.IncodeCaptureDesktopSelfieTutorial {
}

/* Incode Capture Document */
/* Main container for the document capture. */
.IncodeCaptureDocumentContainer {
}
/* Webcam view in the document capture. */
.IncodeCaptureDocumentWebcam {
}
/* Retake option in the document capture. */
.IncodeCaptureDocumentRetake {
}
/* Preview of the document capture. */
.IncodeCaptureDocumentPreview {
}
/* Fake button shown after autocapture timeout in the document capture. */
.IncodeCaptureDocumentFakeButton {
}
/* Notifications within the document capture. */
.IncodeCaptureDocumentNotification {
}

/* Incode Capture ID */
/* Main container for the ID capture. */
.IncodeCaptureIdContainer {
}
/* Native button in the ID capture. */
.IncodeCaptureIdNativeButton {
}
/* Image of a question mark in the ID capture. */
.IncodeCaptureIdQuestionMarkImg {
}
/* Webcam view in the ID capture. */
.IncodeCaptureIdWebcam {
}
/* Mask in the ID capture. */
.IncodeCaptureIdMask {
}
/* Fake button shown after autocapture timeout in the ID capture. */
.IncodeCaptureIdFakeButton {
}
/* Message in the fake button in the ID capture. */
.IncodeCaptureIdFakeButtonMessage {
}
/* Arrow down in the fake button in the ID capture. */
.IncodeCaptureIdFakeButtonArrowDown {
}
/* Image in the fake button in the ID capture. */
.IncodeCaptureIdFakeButtonImage {
}

/* Incode Capture Selfie */
/* Main container for the selfie capture. */
.IncodeCaptureSelfieContainer {
}
/* Container for the capture button in the selfie capture. */
.IncodeCaptureSelfieButtonContainer {
}
/* Webcam container for the selfie capture. */
.IncodeCaptureSelfieWebcamContainer {
}
/* Border container for the selfie capture. */
.IncodeCaptureSelfieBordersContainer {
}
/* Loading borders container for the selfie capture. */
.IncodeCaptureSelfieLoadingBordersContainer {
}
/* Class used to hide certain elements or sections within the selfie capture. */
.IncodeCaptureSelfieHidder {
}
/* Outer part of the oval-shaped camera frame in the selfie capture. */
.IncodeCaptureSelfieCameraOvalOuter {
}
/* Preview image for the selfie capture. */
.IncodeCaptureSelfiePreviewImage {
}
/* Webcam in the selfie capture. */
.IncodeCaptureSelfieWebcam {
}
/* Text inside the oval-shaped camera frame in the selfie capture. */
.IncodeCaptureSelfieCameraOvalInnerText {
}
/* Inline notifications that appear within the selfie capture. */
.IncodeCaptureSelfieNotificationInline {
}

/* Incode Choose Camera */
/* Main container for the camera selection component. */
.IncodeChooseCameraContainer {
}
/* Title for the camera selection component. */
.IncodeChooseCameraTitle {
}
/* Preview video for the camera selection component. */
.IncodeChooseCameraPreviewVideo {
}
/* Camera selector in the camera selection component. */
.IncodeChooseCameraSelector {
}
/* Button for the camera selection component. */
.IncodeChooseCameraButton {
}

/* Incode Common Issues Modal */
/* Main container for the common issues modal. */
.IncodeCommonIssuesModal {
}
/* Container within the common issues modal. */
.IncodeCommonIssuesModalContainer {
}
/* Instructions container within the common issues modal. */
.IncodeCommonIssuesModalInstructionsContainer {
}
/* Button container within the common issues modal. */
.IncodeCommonIssuesModalButtonContainer {
}
/* Try again container within the common issues modal. */
.IncodeCommonIssuesModalTryAgainContainer {
}
/* Bottom text within the common issues modal. */
.IncodeCommonIssuesModalBottomText {
}
/* Native camera button in the common issues modal */
.IncodeCommonIssuesModalNativeCameraButton {
}

/* Incode Mask */
/* Container for masks in a horizontal layout. */
.IncodeMaskContainerHorizontal {
}
/* Container for passport mask */
.IncodePassportMaskContainer {
}
/* Mask for passport-related UI. */
.IncodePassportMask {
}
/* Mask for desktop-related UI. */
.IncodeDesktopMask {
}
/* Main container for masks. */
.IncodeMaskContainer {
}
/* Mask related to barcode UI. */
.IncodeMaskBarcode {
}

/* Incode Native Camera */
/* Retake action for native camera UI. */
.IncodeNativeCameraRetake {
}
/* Main container for native camera UI. */
.IncodeNativeCameraContainer {
}
/* Preview of the capture in the native camera UI. */
.IncodeNativeCameraCapturePreview {
}
/* Label for button elements in the native camera UI. */
.IncodeNativeCameraLabelButton {
}
/* Input for native camera UI. */
.IncodeNativeCameraInput {
}
/* Button for native camera UI. */
.IncodeNativeCameraButton {
}
/* Tutorial ID */
.IncodeNativeCameraCaptureIdTutorial {
}
/* Tutorial selfie */
.IncodeNativeSelfieTutorial {
}

/* Incode Enter Curp */
/* Main container for the CURP (Personal ID code for Mexico) entry UI. */
.IncodeEnterCurpContainer {
}
/* Status indicators for the CURP entry UI. */
.IncodeEnterCurpStatus {
}
/* Title for the CURP entry UI. */
.IncodeEnterCurpTitle {
}
/* Form for CURP entry. */
.IncodeEnterCurpForm {
}

/* Incode Desktop Detected */
/* Main container for desktop detection UI. */
.IncodeDesktopDetectedContainer {
}
/* Image related to desktop detection. */
.IncodeDesktopDetectedImage {
}
/* Text associated with desktop detection. */
.IncodeDesktopDetectedText {
}

/* Incode Notifications */
/* Notifications UI for Android devices. */
.IncodeAndroidNotification {
}
/* Notifications UI for iOS devices. */
.IncodeIOSNotification {
}
/* Fake permissions request modal UI. */
.IncodeFakePermissionsRequestModal {
}
/* Container for messages within the fake permissions request modal. */
.IncodeFakePermissionsRequestMessageContainer {
}

/* Incode QR Scanner Tutorial */
/* Main container for the QR scanner tutorial. */
.IncodeQrScannerTutorialContainer {
}
/* Title for the QR scanner tutorial. */
.IncodeQrScannerTutorialTitle {
}
/* Subtitle for the QR scanner tutorial. */
.IncodeQrScannerTutorialSubtitle {
}
/* Container for images within the QR scanner tutorial. */
.IncodeQrScannerTutorialImageContainer {
}
/* Images for the QR scanner tutorial. */
.IncodeQrScannerTutorialImage {
}
/* Button for the QR scanner tutorial. */
.IncodeQrScannerTutorialButton {
}
/* Main container for the QR scanner. */
.IncodeQrScannerContainer {
}
/* Instructions for the QR scanner. */
.IncodeQrScannerInstructions {
}
/* Mask for the QR scanner. */
.IncodeQrScannerMask {
}
/* Webcam for the QR scanner tutorial. */
.IncodeQrScannerTutorialWebcam {
}

/* Incode Contract */
/* Main container for contract UI. */
.IncodeContractContainer {
}
/* Title for the contract. */
.IncodeContractTitle {
}
/* Container for the contract text. */
.IncodeContractTextContainer {
}
/* Contract text. */
.IncodeContractText {
}
/* Container for the contract button. */
.IncodeContractButtonContainer {
}
/* Button for the contract. */
.IncodeContractButton {
}

/* Incode Recorder ID Mask */
/* Main container for the ID mask in the recorder. */
.IncodeRecorderIdMaskContainer {
}
/* Text for the ID mask in the recorder. */
.IncodeRecorderIdMaskText {
}
/* Mask for capturing IDs in the recorder. */
.IncodeRecorderCaptureIdMask {
}

/* Incode Recorder Microphone */
/* Main container for the microphone in the recorder. */
.IncodeRecorderMicrophoneContainer {
}
/* Image of the microphone in the recorder. */
.IncodeRecorderMicrophoneImage {
}

/* Incode Recorder POA Mask */
/* Main container for the POA (Proof of Address) mask in the recorder. */
.IncodeRecorderPOAMaskContainer {
}
/* Top section of the POA mask in the recorder. */
.IncodeRecorderPOAMaskTop {
}
/* Text for the POA mask in the recorder. */
.IncodeRecorderPOAMaskText {
}
/* Bottom section of the POA mask in the recorder. */
.IncodeRecorderPOAMaskBottom {
}
/* Button for the POA mask in the recorder. */
.IncodeRecorderPOAMaskButton {
}

/* Incode Recorder Question Mask */
/* Main container for the question mask in the recorder. */
.IncodeRecorderQuestionMaskContainer {
}
/* Title for the question mask in the recorder. */
.IncodeRecorderQuestionMaskTitle {
}
/* Button for the question mask in the recorder. */
.IncodeRecorderQuestionMaskButton {
}

/* Incode Recorder Tutorial */
/* Main container for the recorder tutorial. */
.IncodeRecorderTutorialContainer {
}
/* Header for the recorder tutorial. */
.IncodeRecorderTutorialHeader {
}
/* Title for the recorder tutorial. */
.IncodeRecorderTutorialTitle {
}
/* Body of the recorder tutorial. */
.IncodeRecorderTutorialBody {
}
/* Image in the recorder tutorial. */
.IncodeRecorderTutorialImage {
}
/* Button for the recorder tutorial. */
.IncodeRecorderTutorialButton {
}

/* Incode Video Recorder */
/* Main container for the video recorder. */
.IncodeVideoRecorderContainer {
}
/* Counter for the video recorder. */
.IncodeVideoRecorderCounter {
}
/* Image indicating recording status in the video recorder. */
.IncodeVideoRecorderRecordingImage {
}
/* Face mask in the video recorder. */
.IncodeVideoRecorderFaceMask {
}
/* Face frame in the video recorder. */
.IncodeVideoRecorderFaceFrame {
}

/* Incode Redirect */
/* Main container for the redirect component. */
.IncodeRedirectContainer {
}
/* Container for QR code items in the redirect component. */
.IncodeRedirectQrItemContainer {
}
/* Title for the redirect component in mobile view. */
.IncodeRedirectTitleMobile {
}
/* List in the redirect component in mobile view. */
.IncodeRedirectListMobile {
}
/* Individual list item in the redirect component. */
.IncodeRedirectItem {
}
/* Container for QR code in the redirect component. */
.IncodeRedirectQrContainer {
}
/* QR code in the redirect component. */
.IncodeRedirectQRCode {
}
/* Container for recommendations in the redirect component. */
.IncodeRedirectContainerRecommendation {
}
/* Title for the redirect component. */
.IncodeRedirectTitle {
}
/* List in the redirect component. */
.IncodeRedirectList {
}
/* Paragraph text in the redirect component. */
.IncodeRedirectParagraph1 {
}
.IncodeRedirectParagraph2 {
}
.IncodeRedirectParagraph3 {
}
/* Container for separator line in the redirect component. */
.IncodeRedirectSeparatorContainer {
}
/* Vertical line in the redirect component. */
.IncodeRedirectVerticalLine {
}
/* Container for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileContainer {
}
/* Message container for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileMessageContainer {
}
/* Image for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileImage {
}
/* Text for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileText {
}
/* List for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileList {
}
/* List item for "Send Verification" mobile in the redirect component. */
.IncodeRedirectSendVerificationMobileListItem {
}
/* Container for "Send Verification" desktop in the redirect component. */
.IncodeRedirectSendVerificationDesktopContainer {
}
/* Image for "Send Verification" desktop in the redirect component. */
.IncodeRedirectSendVerificationDesktopImage {
}
/* Text for "Send Verification" desktop in the redirect component. */
.IncodeRedirectSendVerificationDesktopText {
}
/* Container for "Send SMS" in the redirect component. */
.IncodeRedirectSendSMSContainer {
}
/* Text for "Send SMS" in the redirect component. */
.IncodeRedirectSendSMSText {
}
/* List for "Send SMS" in the redirect component. */
.IncodeRedirectSendSMSList {
}
/* List item for "Send SMS" in the redirect component. */
.IncodeRedirectSendSMSListItem {
}
/* Container for inputs in the redirect component. */
.IncodeRedirectContainerInputs {
}
/* Input field in the redirect component. */
.IncodeRedirectInput {
}
/* Container for SMS sent confirmation in the redirect component. */
.IncodeRedirectSmsSentContainer {
}
/* Paragraph for SMS sent confirmation in the redirect component. */
.IncodeRedirectSmsSentParagraph {
}
/* Paragraph for resend action in the redirect component. */
.IncodeRedirectResendParagraph {
}
/* Footer for desktop view in the redirect component. */
.IncodeRedirectFooterDesktop {
}

/* Incode Redirect Call Finished */
/* Main container for the call finished UI in the redirect component. */
.IncodeRedirectCallFinishedContainer {
}
/* Title for the call finished UI in the redirect component. */
.IncodeRedirectCallFinishedTitle {
}
/* Subtitle for the call finished UI in the redirect component. */
.IncodeRedirectCallFinishedSubtitle {
}
```

<Callout icon="📘" theme="info">
  **NOTE**

  You may need to use the keyword _!important_ to ensure the custom styling is honored property.
</Callout>

## Sample CSS file

To see a sample custom CSS implementation, go to:

* [https://github.com/Incode-Technologies-Example-Repos/web-resource-samples/blob/main/styles/example.css](https://github.com/Incode-Technologies-Example-Repos/web-resource-samples/blob/main/styles/example.css)

---

- Path: `integrate-by-platform/web-integrations-websdk`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-websdk/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-websdk.md

# Web SDK

The Incode Web SDK integrates identity verification directly into your custom web application. You host the verification UI inside your own app, using the SDK's JavaScript methods to control the flow, handle events, and customize the user experience.

This approach gives you the most control of any web integration method. It also requires the most development effort and is best suited to teams with dedicated front-end and back-end developers.

## How it works

1. Your backend starts an onboarding session and returns a session token to your front end.
2. Your front end initializes the Web SDK with that token.
3. The SDK renders verification modules (ID scan, selfie, and so on) directly inside your web app.
4. You handle module completion events and control flow progression in your application code.
5. Your backend fetches results once the session is complete.

## Prerequisites

Complete the [Dashboard setup steps](/integrate-by-platform/web-integration-overview/#before-you-begin) in Web Integration Overview before starting this integration. These cover creating a Workflow, adding the Data Sharing Consent module, enabling redirect desktop to mobile, and obtaining your API credentials.

In addition, you'll need:

- A front-end web application (framework-agnostic; React, Vue, Angular, and vanilla JS are all supported).
- HTTPS (required for camera and microphone access in browsers).

## Get started

For installation, initialization, method reference, and full integration walkthroughs, see the [Web SDK 2.0 Reference](/sdk-reference/incode-web-sdk-2-reference/). If you are still using Web SDK 1.x, refer to [Web SDK Reference](/sdk-reference/web-sdk-reference/) and the considerations below.

## Web SDK 1.x Considerations

Consider the following as you decide whether the Incode Web SDK is right for your implementation:

* Integrating the Web SDK is best suited for experienced front-end and back-end development teams. If you're unfamiliar with web development, using our low-code or no-code integration guides might better suit your needs.
* The Incode Web SDK is compatible with most front-end development frameworks. However, some project configurations might require specific settings.
* Full SDK integration is only compatible with [Flows](/dashboard-platform-administration/flows-1). Workflows are not currently supported.
* Ensure you use the [latest version](/release-notes/releases-web-sdk/) of the Incode Web SDK in your integration to access all features, benefits, and security updates.
* Your web application and development server must run over HTTPS to ensure correct execution of all SDK methods.

### Supported browsers
The Web SDK is designed for mobile devices and mobile browsers:

* Google Chrome for Android
* Safari for iOS

While it works on desktop browsers, it is not recommended for desktop-focused web applications. Webviews and browsers launched inside social media or email apps are NOT supported.

---

- Path: `integrate-by-platform/web-integrations-webviews`
- URL: https://developer.incode.com/integrate-by-platform/web-integrations-webviews/
- Markdown: https://developer.incode.com/integrate-by-platform/web-integrations-webviews.md

# WebViews

A WebView is an embedded browser component within a native mobile application. Rather than building a native SDK integration, you can load Incode’s hosted verification flow (a Workflow or Flow URL) inside a WebView component in their iOS or Android app.

Incode officially supports this integration method for the configurations and modules described on this page.

:::warning
  ### **WebView support limitations**

  The requirements and configurations documented here reflect the first official release of WebView as a supported integration method. Support currently covers v2 integrations only and a defined set of core modules. Contact your Incode representative if you have questions about your specific configuration.
:::

## How it works

WebView integration follows the same model as a standard [Flows / Workflows](/integrate-by-platform/web-integrations-flows-workflows/) integration:

1. Your backend starts an onboarding session and generates a Workflow URL.
2. Your native app loads that URL in a WebView component.
3. The user completes identity verification inside the embedded browser.
4. You retrieve results via Dashboard or webhook.

The key difference from a standard web integration is that your native app must be configured to grant the WebView access to the device hardware and browser APIs that Incode requires.

## Supported platforms and frameworks

| Platform | Supported component        | System browser variant   |
| -------- | -------------------------- | :----------------------- |
| Android  | `WebView` (Android native) | Chrome Custom Tabs       |
| iOS      | `WKWebView`                | `SFSafariViewController` |

## Supported modules

The following modules are validated for WebView use:

- ID Capture (ID scan)
- Face Capture (selfie)
- Proof of Address / Document Capture
- Deepsight
- Face Authentication
- CURP

Other modules may function in WebView environments but are not covered under validated support at this time.

## System requirements

Your native app must meet the following requirements for a WebView integration with Incode to function correctly.

### Required permissions

Your native app must request and pass through the following permissions to the WebView:

- **Camera**: Required for ID scan and selfie capture
- **Microphone**: Required for video selfie and video conference modules
- **Screen recording**: Required for Deepsight
- **Geolocation**: Required if the Geolocation module is included in your flow

Permissions denied at the native app level cannot be recovered inside the WebView. If a user has previously denied a permission, your app must direct them to re-enable it in device settings before launching the WebView.

### Required browser APIs

The following web platform APIs must remain enabled in your WebView configuration:

- `getUserMedia` (camera and microphone access)
- `MediaRecorder`
- JavaScript execution (must not be disabled)
- Local storage / session storage

### Minimum memory

The WebView must have access to sufficient device memory to load Incode's SDK assets and run capture modules. Memory-constrained configurations may cause loading failures, particularly for modules that involve real-time processing (Deepsight, video selfie).

- **RAM:** ≥ 2 GB
- **Free storage:** ≥ 200 MB (iOS); ≥ 200–300 MB (Android)

### Operating system minimums

| Platform | Minimum      | Recommended    |
| :------- | :----------- | :------------- |
| Android  | 7.0 (API 24) | 8.0+ (API 26+) |
| iOS      | 14.5         | 15.0+          |

## Known limitations

- Custom WebView configurations that disable standard browser APIs are not supported.
- Non-standard or deprecated WebView implementations (for example, `UIWebView` on iOS) are not supported.
- Third-party in-app browsers (for example, Instagram or TikTok) may have additional constraints and broken UI behavior. They are not officially supported configurations.
- WebViews embedded inside game or framework engines (for example, Unity) are not covered by standard WebView support.
- Video Selfie and Video Conference module support in WebViews is not yet validated and is excluded from current coverage.&#x20;
- iOS Simulator cannot be used for full module testing (camera, liveness, motion). Use a physical device for Deepsight, liveness, and media module testing.

## Integration guide

### Android (Native WebView)

Configure your `WebView` instance to enable the required permissions and APIs before loading the Incode session URL:

```kotlin
webView.settings.apply {
    javaScriptEnabled = true
    domStorageEnabled = true
    mediaPlaybackRequiresUserGesture = false
    allowFileAccess = true
    allowContentAccess = true
    setGeolocationEnabled(true)
    javaScriptCanOpenWindowsAutomatically = true
}

webView.webChromeClient = object : WebChromeClient() {
    override fun onPermissionRequest(request: PermissionRequest) {
        request.grant(request.resources) // Grant camera, microphone, etc.
    }

    override fun onShowFileChooser(
        webView: WebView,
        filePathCallback: ValueCallback<Array<Uri>>,
        fileChooserParams: FileChooserParams
    ): Boolean {
        // Handle <input type="file"> for document capture
        return true
    }
}

webView.loadUrl(onboardingUrl)
```

Required manifest permissions:

- `INTERNET`
- `CAMERA`
- `RECORD_AUDIO`
- `STORAGE` (only if file uploads or downloads to device storage are needed)

> **Chrome Custom Tabs:** Runs inside the system Chrome process. Host app has limited control; permissions are system-managed.

### iOS (WKWebView)

Configure your `WKWebView` with the appropriate `WKWebViewConfiguration` to allow media capture:

```swift
let config = WKWebViewConfiguration()
config.allowsInlineMediaPlayback = true
config.mediaTypesRequiringUserActionForPlayback = []
config.allowsPictureInPictureMediaPlayback = false

let webView = WKWebView(frame: .zero, configuration: config)
```

On iOS 15 and later, implement the following `WKUIDelegate` methods to enable camera/microphone access and Deepsight/liveness support:

- `decideMediaCapturePermissionsFor`: enables `getUserMedia` for camera and microphone
- `requestDeviceOrientationAndMotionPermissionFor`: required for Deepsight and liveness modules

Your `Info.plist` must include usage descriptions for all permissions your WebView will request. Failure to include these will cause the OS to deny the permission silently. Required keys:

- `NSCameraUsageDescription`
- `NSMicrophoneUsageDescription`
- `NSLocationWhenInUseUsageDescription`
- `NSMotionUsageDescription`

> **SFSafariViewController:** No app-level delegates are required. System Safari handles all permissions using the plist keys above.

## Debugging

WebView sessions can be difficult to debug because native browser developer tools are not accessible by default.

- **Android**: Enable WebView debugging and connect via Chrome DevTools (`chrome://inspect`).
- **iOS**: Enable Web Inspector for your WKWebView and connect via Safari’s Develop menu.

Both test applications (Android `webview.apk` and iOS `IncodeVerifyExample`) support console log forwarding. Contact your Incode representative for access to these test applications.

## Contact

If you are evaluating or implementing a WebViews integration, contact your Incode representative to discuss your configuration and ensure it falls within supported parameters.

---

- Path: `integrate-by-platform/workflow-integration`
- URL: https://developer.incode.com/integrate-by-platform/workflow-integration/
- Markdown: https://developer.incode.com/integrate-by-platform/workflow-integration.md

# Workflow Implementation Options

To utilize the full capabilities of the Incode Omni platform, you can integrate identity verification via Workflows into your application or website. The platform offers a versatile set of integration options, including direct onboarding URLs, iFrame integration, and SDKs for iOS, Android, and React Native platforms. Each method provides a seamless way to incorporate the identity verification process into your user flow, enhancing user experience and security.

## Web - Onboarding URL

The onboarding URL is a straightforward method to start the identity verification process. By directing users to this URL, they can begin their onboarding session without the need for integrating specific SDKs or custom UI elements into your application. This approach is ideal for quick deployments and can be easily shared via email or text message. For more details on how to generate and use the onboarding URL, refer to the section on <Anchor label="Low Code integration" target="_blank" href="/get-started-with-incode/quickstart/">Low Code integration</Anchor> in our detailed guide.

## Mobile Platforms - iOS, Android, React Native

For native mobile applications, the Incode Omni platform provides SDKs for both iOS and Android. These SDKs allow for deep integration into your mobile app, offering a native experience for users and access to additional functionalities that enhance the verification process.

The minimum supported Android version is **21**. The minimum supported iOS version is **iOS 13**.

React Native developers can take advantage of the dedicated React Native SDK to integrate the onboarding session into cross-platform applications. This SDK combines the ease of development in React Native with the robust features of the Incode Omni platform, ensuring a native-like experience across both iOS and Android devices.

Before you start, setup the environment and install the SDK into the project following the details outlined in the environment setup guides. 

### Step 1: Initialize the Incode SDK

The Incode SDK must be initialized before it can be used. Check the following code on how to initialize the Incode SDK on each platform.

```kotlin Android - Kotlin
fun incodeSDKInitialize(app: Application) {
    try {
        IncodeWelcome.Builder(app, Constants.API_URL, Constants.API_KEY)
            .setLoggingEnabled(true)
            .build()

        incodeSDKInitialized = true
    } catch (exception: Exception) {
        incodeSDKInitialized = false
    }
}

private fun setIncodeCommonConfig() {
    val commonConfig: CommonConfig = Builder()
        .setShowExitConfirmation(true)
        .setShowCloseButton(true)
        .build()

    IncodeWelcome.getInstance().setCommonConfig(commonConfig)
}
```
```java Android - Java
public static void incodeSDKInitialize(Application app) {
    try {
        new IncodeWelcome.Builder(app, Constants.API_URL, Constants.API_KEY)
            .setLoggingEnabled(true)
            .build();

        incodeSDKInitialized = true;
    } catch (Exception exception) {
        incodeSDKInitialized = false;
    }
}
    
private void setIncodeCommonConfig() {
    CommonConfig commonConfig = new CommonConfig.Builder()
        .setShowExitConfirmation(true)
        .setShowCloseButton(true)
        .build();

    IncodeWelcome.getInstance().setCommonConfig(commonConfig);
}
```
```swift iOS
func incodeSDKInitialize(api_url: String, api_key: String) {
  IncdOnboardingManager.shared.initIncdOnboarding(url: api_url,
                                                  apiKey: api_key,
                                                  loggingEnabled: true,
                                                  testMode: testMode) { (success, error) in
        print("IncdOnboarding SDK initialization, success: \(success == true), error: \(error?.description ?? "nil")")
        self.dispatchGroup.leave()
    }
}

func setIncodeCommonConfig() {
  IncdOnboardingManager.shared.allowUserToCancel = true
  IncdOnboardingManager.shared.idBackShownAsFrontCheck = true
  IncdOnboardingManager.shared.idFrontShownAsBackCheck = true
}
```
```javascript React Native
const IncodeSDKInitialize = (API_URL, API_KEY) => {
    IncodeSdk.initialize({
      testMode: false,
      apiConfig: {
        url: API_URL,
        key: API_KEY,
      },
      waitForTutorials: true,
    })
      .then((_) => {
        startWorkflow();
      })
      .catch((e) => {
        console.error('Incode SDK failed init', e);
      });
  };
```

### Step 2: Create the session

Next, a session needs to be created in order for the data to be captured. This requires a Configuration ID, which is also known as a flow ID. To configure a flow, check out the [getting started guide](/get-started-with-incode/quickstart/).

```kotlin Android - Kotlin
private fun getSimpleWorkflowSession(): SessionConfig {
    val sessionConfig: SessionConfig = Builder()
        .setConfigurationId(Constants.WORKFLOW_ID)
        .build()

    return sessionConfig
}
```
```java Android - Java
private SessionConfig getSimpleWorkflowSession() {
    SessionConfig sessionConfig = new SessionConfig.Builder()    
        .setConfigurationId(Constants.WORKFLOW_ID)
        .build();

    return sessionConfig;
}
```
```swift iOS
func createWorkflowSessionConfiguration() -> IncdOnboardingSessionConfiguration {
  return IncdOnboardingSessionConfiguration(configurationId: "PASTE_HERE_WORKFLOW_ID")
}
```
```javascript React Native
function getSimpleWorkflowSession() {
  let sessionConfig: {
    region: 'ALL',
      configurationId: WORKFLOW_ID,
  };

  return sessionConfig;
}
```

### Step 3: Execute the Onboarding

Once the SDK is initialized, flow is configured, session is created, and callbacks are implemented, then it is ready for the user to start the flow by calling the `startOnboarding` function.

```kotlin Android - Kotlin
private fun startWorkflow() {
    setIncodeCommonConfig()
    IncodeWelcome.getInstance().startWorkflow(
        activity,
        getSimpleWorkflowSession(),
        getSimpleWorkflowOnboardingListener()
    )
}
```
```java Android - Java
private void startWorkflow() {
    setIncodeCommonConfig();
    IncodeWelcome.getInstance().startWorkflow(
        activity,
        getSimpleWorkflowSession(),
        getSimpleWorkflowOnboardingListener()
    );
}
```
```swift iOS
func startStraightforwardOnboarding() {
  setIncodeCommonConfig()
  let sessionConfig = createWorkflowSessionConfiguration()
  IncdOnboardingManager.shared.presentingViewController = self
  IncdOnboardingManager.shared.startWorkflow(sessionConfig: sessionConfig, delegate: self)
}
```
```javascript React Native
function startWorkflow(){
    let sessionConfig = getSimpleWorkflowSession();

    IncodeSdk.startWorkflow({
      sessionConfig: sessionConfig,
    })
      .then((result) => {
        fetchUserScores();
      })
      .catch((e) => {
        // TODO - Manage Onboarding error
      });
  }
```

### Step 4: Process Results

```kotlin Android - Kotlin
private fun fetchUserScores(interviewId: String) {
    IncodeWelcome.getInstance().getUserScore(FAST, interviewId, object : GetUserScoreListener {
        override fun onUserScoreFetched(result: UserScoreResult) {
            Timber.d("onUserScoreFetched: %s", result)

            validateResultWithBusinessLogic(result)
        }

        override fun onUserCancelled() {
            Timber.d("getUserScore onUserCancelled")
        }

        override fun onError(error: Throwable) {
            Timber.d("getUserScore onError: %s", error)
        }
    })
}

private fun validateResultWithBusinessLogic(result: UserScoreResult) {
    // TODO - Apply business rules to check the scores of the session
}
```
```java Android - Java
private void fetchUserScores(String interviewId) {
    IncodeWelcome.getInstance().getUserScore(FAST, interviewId, new GetUserScoreListener() {
        @Override
        public void onUserScoreFetched(UserScoreResult result) {
            Timber.d("onUserScoreFetched: %s", result);

            validateResultWithBusinessLogic(result);
        }

        @Override
        public void onUserCancelled() {
            Timber.d("getUserScore onUserCancelled");
        }

        @Override
        public void onError(Throwable error) {
            Timber.d("getUserScore onError: %s", error);
        }
    });
}

private void validateResultWithBusinessLogic(UserScoreResult result) {
    // TODO - Apply business rules to check the scores of the session
}
```
```swift iOS
func fetchUserScore() {
  IncdOnboardingManager.shared.getUserScore(userScoreFetchMode: UserScoreFetchMode.fast, interviewId: interviewId ,completion: {
    userScore in
    if(userScore.error != nil) {
      validateResultWithBusinessLogic()
    }
    else {
      // TODO - Manage fetch user score error
    }
  })
}

func validateResultWithBusinessLogic(userScore:UserScore) {
  // TODO - Apply business rules to check the scores of the session
}
```
```Text React Native
function fetchUserScores(interviewId) {
  IncodeSdk.getUserScore({ mode: 'fast' })
    .then((result) => {
    validateResultWithBusinessLogic(result);
  })
    .catch((e) => {
    // TODO - Manage getting User Score error
  });
}

function validateResultWithBusinessLogic(result){
  // TODO - Apply business rules to check the scores of the session
}
```

## Agent initiated

Without any integration, onboarding link can be shared with users via SMS directly from Omni dashboard. This is a use case for call centres or customers who must verify their users identity, but not necessary integrate that into their own platform. In the Session list, with option New Manual Session, link for an onboarding can be sent to the user via SMS.

1. Add user phone number
2. Choose a workflow
3. Send SMS
4. Review session result

<Image align="center" alt="Send the onboarding URL via SMS" border={false} caption="Send the onboarding URL via SMS" src="https://developer.incode.com/assets/f0a1d0398283fcdb60b94b88e0385cfe.png" width="500px" />

---

- Path: `release-notes/1790-translations-change-summary`
- URL: https://developer.incode.com/release-notes/1790-translations-change-summary/
- Markdown: https://developer.incode.com/release-notes/1790-translations-change-summary.md

# EN - English

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Birth Certificate`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Currency`
* `capturePreview.acceptedDocuments.DriversLicense` = `Drivers License`
* `capturePreview.acceptedDocuments.FederalID` = `Federal ID`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Identification Card`
* `capturePreview.acceptedDocuments.label` = `Accepted documents for:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Medical Card`
* `capturePreview.acceptedDocuments.Military` = `Military`
* `capturePreview.acceptedDocuments.noDocuments` = `No documents accepted for this country. `
* `capturePreview.acceptedDocuments.Other` = `Other`
* `capturePreview.acceptedDocuments.Passport` = `Passport`
* `capturePreview.acceptedDocuments.Permit` = `Permit`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Residence Document`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Tax Identification`
* `capturePreview.acceptedDocuments.TravelDocument` = `Travel Document`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Tribal Identification`
* `capturePreview.acceptedDocuments.Unknown` = `Unknown`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Vehicle Registration`
* `capturePreview.acceptedDocuments.Visa` = `Visa`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Voter Identification`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Weapon License`
* `common.refreshPage` = `Refresh`
* `commonIssues.idv2.tryAgain` = `Ok, try again`
* `errors.dynamicImport.failedToLoad` = `Something unexpected error but we took note of it:`
* `errors.dynamicImport.suggestion` = `We'll try again in {{count}} or you can manually refresh`
* `errors.dynamicImport.title` = `Sorry, we encountered an issue`
* `idv2.capture.autoCapture` = `The photo will be taken automatically`
* `idv2.capture.dontMove` = `Don't move your ID for a few seconds`
* `idv2.capture.fillFrame` = `Fill the frame with your ID`
* `idv2.capture.fillFramePassport` = `Fill the frame with your passport`
* `idv2.capture.manualCapture.ariaLabel` = `Manual Capture`
* `idv2.capture.manualCapture.title` = `Manual Capture Button`
* `idv2.capture.notifications.blur.description` = `Zoom in and out, or tap on the ID`
* `idv2.capture.notifications.blur.title` = `ID too blurry`
* `idv2.capture.notifications.glare.description` = `Find a better lighting to avoid reflections`
* `idv2.capture.notifications.glare.title` = `ID with glare`
* `idv2.capture.notifications.notAligned.description` = `Center your ID inside the frame`
* `idv2.capture.notifications.notAligned.title` = `ID is not aligned`
* `idv2.capture.notifications.showBack.description` = `Flip your ID to show its reverse side`
* `idv2.capture.notifications.showBack.title` = `Show the back of ID`
* `idv2.capture.notifications.showFront.description` = `Flip your ID to show its front side`
* `idv2.capture.notifications.showFront.title` = `Show the front of ID`
* `idv2.capture.passport.subtitle` = `Ensure your Passport is readable`
* `idv2.capture.passport.title` = `Scan your passport`
* `idv2.capture.processing.analyzing` = `Analyzing...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} attempts remaining`
* `idv2.capture.processing.continue` = `Continue`
* `idv2.capture.processing.error` = `Error`
* `idv2.capture.processing.errors.classification.subtitle` = `Please ensure entire ID is visible and well lit`
* `idv2.capture.processing.errors.classification.title` = `ID verification failed`
* `idv2.capture.processing.errors.default.subtitle` = `Please try again`
* `idv2.capture.processing.errors.default.title` = `There was a problem`
* `idv2.capture.processing.errors.glare.subtitle` = `Tilt the ID slightly up or down to minimize the reflection`
* `idv2.capture.processing.errors.glare.title` = `Glare present`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimize camera shake by holding your phone steady`
* `idv2.capture.processing.errors.readability.title` = `Info is not readable`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Move ID further away or closer to your phone until the image is focused`
* `idv2.capture.processing.errors.sharpness.title` = `Blur present`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Please try with a different document`
* `idv2.capture.processing.errors.unacceptable.title` = `ID type is not accepted`
* `idv2.capture.processing.errors.upload.subtitle` = `Please check your connection and try again`
* `idv2.capture.processing.errors.upload.title` = `ID scan failed`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capture {{mode}} side of the ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Wrong ID side captured`
* `idv2.capture.processing.scanBack` = `Scan the back`
* `idv2.capture.processing.success` = `Success`
* `idv2.capture.processing.successBackSubtitle` = `Now let's continue`
* `idv2.capture.processing.successFrontSubtitle` = `Now let's capture the back`
* `idv2.capture.processing.successTitle` = `Successfully processed!`
* `idv2.capture.processing.tryAgain` = `Try again`
* `idv2.capture.takingPhoto` = `Taking photo...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `National Identity Card, or Driver's License`
* `idv2.chooser.idButtonTitle` = `Identity Card`
* `idv2.chooser.passportButtonDescription` = `Your country Passport`
* `idv2.chooser.passportButtonTitle` = `Passport`
* `idv2.permissions.alertAlt` = `fake permission alert`
* `idv2.permissions.allow` = `OK, Allow`
* `idv2.permissions.denied.allow` = `Allow`
* `idv2.permissions.denied.ask` = `Ask`
* `idv2.permissions.denied.browser` = `Browser`
* `idv2.permissions.denied.camera` = `Camera`
* `idv2.permissions.denied.changeTo` = `Change to`
* `idv2.permissions.denied.open` = `Open`
* `idv2.permissions.denied.or` = `or`
* `idv2.permissions.denied.refreshPage` = `Refresh page`
* `idv2.permissions.denied.return` = `Return here and press`
* `idv2.permissions.denied.scroll` = `Scroll down to select`
* `idv2.permissions.denied.settings` = `Settings`
* `idv2.permissions.denied.tap` = `Tap`
* `idv2.permissions.denied.title` = `Follow the next steps to allow Incode to access your camera`
* `idv2.permissions.denied.yourBrowser` = `your browser`
* `idv2.permissions.description` = `in order to complete the process`
* `idv2.permissions.dontAllow` = `Don't Allow`
* `idv2.permissions.fakeDenied.alert` = `alert fake focused`
* `idv2.permissions.fakeDenied.allowPermissions` = `Allow permissions`
* `idv2.permissions.fakeDenied.quitProcess` = `Quit process`
* `idv2.permissions.fakeDenied.title` = `Camera permission is required for your document capture`
* `idv2.permissions.fakeDenied.warning` = `warning`
* `idv2.permissions.note` = `Note: Depending on your phone, it may say`
* `idv2.permissions.or` = `or`
* `idv2.permissions.subtitle` = `allow camera permission`
* `idv2.permissions.title` = `We need you to`
* `idv2.permissions.whileUsing` = `While using the app`
* `idv2.tutorial.autoCapture` = `The photo will be taken automatically`
* `idv2.tutorial.startScan` = `Let's scan`
* `idv2.tutorial.subtitle` = `Ensure your ID is readable`
* `idv2.tutorial.title` = `Scan your ID`
* `idv2.uploading.analyzing` = `Analyzing...`
* `idv2.uploading.imageAlt` = `ID capture`
* `onboarding.errors.restartDisabled.message` = `Session restart disabled on Organization level`
* `onboarding.errors.restartDisabled.title` = `Can't restart session`
* `qes.signatureCheck` = `I agree to the issuance of the required certificate and to signing this document electronically.`
* `qes.termsCheck` = `I have read and agree to Incode’s <2>Privacy Policy</2> and Incode’s <6>Terms of Use</6>.`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Old: `Common Issues`
  * New: `Common issues`
* `commonIssues.infoNotReadable`:
  * Old: `Info is not readable`
  * New: `Info not readable`
* `commonIssues.takeManually`:
  * Old: `Take the photo manually`
  * New: `Take photo manually`
* `commonIssues.tryAgain`:
  * Old: `Ok, try again`
  * New: `Try again`
* `ineCheck.verified`:
  * Old: `Identity verified!`
  * New: `Identity submitted for verification`
* `notifications.done`:
  * Old: `Done`
  * New: `Scan completed`
* `notifications.glareDetected`:
  * Old: `Glare present`
  * New: `Glare detected`
* `notifications.glareDetectedDescription`:
  * Old: `Tilt the ID slightly up or down to minimize the reflection`
  * New: `Find a better lighting to avoid reflections`
* `notifications.idTypeUnacceptable`:
  * Old: `ID type is not accepted`
  * New: `Invalid ID document`
* `notifications.idTypeUnacceptableDescription`:
  * Old: `Please try with a different document`
  * New: `Try scanning a different one`
* `notifications.lowSharpness`:
  * Old: `Blur present`
  * New: `Low sharpness`

***

---

- Path: `release-notes/bn-bengali`
- URL: https://developer.incode.com/release-notes/bn-bengali/
- Markdown: https://developer.incode.com/release-notes/bn-bengali.md

# BN - Bengali

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `জন্ম সনদ`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `মুদ্রা`
* `capturePreview.acceptedDocuments.DriversLicense` = `ড্রাইভিং লাইসেন্স`
* `capturePreview.acceptedDocuments.FederalID` = `ফেডারেল আইডি`
* `capturePreview.acceptedDocuments.IdentificationCard` = `পরিচয়পত্র`
* `capturePreview.acceptedDocuments.label` = `এর জন্য গৃহীত নথি:`
* `capturePreview.acceptedDocuments.MedicalCard` = `মেডিকেল কার্ড`
* `capturePreview.acceptedDocuments.Military` = `সামরিক`
* `capturePreview.acceptedDocuments.noDocuments` = `এই দেশের জন্য কোনও নথি গ্রহণযোগ্য নয়। `
* `capturePreview.acceptedDocuments.Other` = `অন্যান্য`
* `capturePreview.acceptedDocuments.Passport` = `পাসপোর্ট`
* `capturePreview.acceptedDocuments.Permit` = `অনুমতি`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `বসবাসের নথি`
* `capturePreview.acceptedDocuments.TaxIdentification` = `কর শনাক্তকরণ`
* `capturePreview.acceptedDocuments.TravelDocument` = `ভ্রমণ নথি`
* `capturePreview.acceptedDocuments.TribalIdentification` = `উপজাতি সনাক্তকরণ`
* `capturePreview.acceptedDocuments.Unknown` = `অজানা`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `যানবাহন নিবন্ধন`
* `capturePreview.acceptedDocuments.Visa` = `ভিসা`
* `capturePreview.acceptedDocuments.VoterIdentification` = `ভোটার শনাক্তকরণ`
* `capturePreview.acceptedDocuments.WeaponLicense` = `অস্ত্র লাইসেন্স`
* `common.refreshPage` = `রিফ্রেশ করুন`
* `commonIssues.idv2.tryAgain` = `ঠিক আছে, আবার চেষ্টা করুন।`
* `errors.dynamicImport.failedToLoad` = `কিছু অপ্রত্যাশিত ত্রুটি কিন্তু আমরা এটি লক্ষ্য করেছি:`
* `errors.dynamicImport.suggestion` = `আমরা {{count}} এ আবার চেষ্টা করব অথবা আপনি ম্যানুয়ালি রিফ্রেশ করতে পারেন।`
* `errors.dynamicImport.title` = `দুঃখিত, আমরা একটি সমস্যার সম্মুখীন হয়েছি।`
* `idv2.capture.autoCapture` = `ছবি স্বয়ংক্রিয়ভাবে তোলা হবে।`
* `idv2.capture.dontMove` = `কয়েক সেকেন্ডের জন্য আপনার আইডি সরাবেন না।`
* `idv2.capture.fillFrame` = `আপনার পরিচয়পত্র দিয়ে ফ্রেমটি পূরণ করুন।`
* `idv2.capture.fillFramePassport` = `আপনার পাসপোর্ট দিয়ে ফ্রেমটি পূরণ করুন।`
* `idv2.capture.manualCapture.ariaLabel` = `ম্যানুয়াল ক্যাপচার`
* `idv2.capture.manualCapture.title` = `ম্যানুয়াল ক্যাপচার বোতাম`
* `idv2.capture.notifications.blur.description` = `জুম ইন এবং আউট করুন, অথবা আইডিতে ট্যাপ করুন`
* `idv2.capture.notifications.blur.title` = `আইডি খুব ঝাপসা`
* `idv2.capture.notifications.glare.description` = `প্রতিফলন এড়াতে আরও ভালো আলো খুঁজুন।`
* `idv2.capture.notifications.glare.title` = `ঝলমলে আইডি`
* `idv2.capture.notifications.notAligned.description` = `ফ্রেমের ভেতরে আপনার আইডি কেন্দ্রীভূত করুন`
* `idv2.capture.notifications.notAligned.title` = `আইডিটি সারিবদ্ধ নয়`
* `idv2.capture.notifications.showBack.description` = `আপনার আইডির উল্টো দিকটি দেখাতে এটি উল্টে দিন।`
* `idv2.capture.notifications.showBack.title` = `আইডির পিছনের দিকটি দেখান`
* `idv2.capture.notifications.showFront.description` = `আপনার আইডির সামনের দিকটি দেখানোর জন্য উল্টে দিন।`
* `idv2.capture.notifications.showFront.title` = `আইডির সামনের অংশ দেখান`
* `idv2.capture.passport.subtitle` = `নিশ্চিত করুন যে আপনার পাসপোর্টটি পঠনযোগ্য`
* `idv2.capture.passport.title` = `আপনার পাসপোর্ট স্ক্যান করুন`
* `idv2.capture.processing.analyzing` = `বিশ্লেষণ করা হচ্ছে...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}} / {{maxAttempts}} প্রচেষ্টা বাকি আছে`
* `idv2.capture.processing.continue` = `চালিয়ে যান`
* `idv2.capture.processing.error` = `ত্রুটি`
* `idv2.capture.processing.errors.classification.subtitle` = `অনুগ্রহ করে নিশ্চিত করুন যে সম্পূর্ণ আইডি দৃশ্যমান এবং আলোকিত।`
* `idv2.capture.processing.errors.classification.title` = `আইডি যাচাইকরণ ব্যর্থ হয়েছে`
* `idv2.capture.processing.errors.default.subtitle` = `অনুগ্রহ করে আবার চেষ্টা করুন।`
* `idv2.capture.processing.errors.default.title` = `একটা সমস্যা ছিল।`
* `idv2.capture.processing.errors.glare.subtitle` = `প্রতিফলন কমাতে আইডিটি সামান্য উপরে বা নীচে কাত করুন।`
* `idv2.capture.processing.errors.glare.title` = `ঝলক বর্তমান`
* `idv2.capture.processing.errors.readability.subtitle` = `আপনার ফোন স্থির রেখে ক্যামেরার কাঁপুনি কম করুন`
* `idv2.capture.processing.errors.readability.title` = `তথ্য পঠনযোগ্য নয়`
* `idv2.capture.processing.errors.sharpness.subtitle` = `ছবিটি ফোকাস না করা পর্যন্ত আইডিটি আপনার ফোনের আরও দূরে বা কাছে সরান`
* `idv2.capture.processing.errors.sharpness.title` = `ঝাপসা দেখাচ্ছে`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `অনুগ্রহ করে অন্য একটি ডকুমেন্ট দিয়ে চেষ্টা করুন।`
* `idv2.capture.processing.errors.unacceptable.title` = `আইডি টাইপ গ্রহণযোগ্য নয়`
* `idv2.capture.processing.errors.upload.subtitle` = `আপনার সংযোগ পরীক্ষা করে আবার চেষ্টা করুন।`
* `idv2.capture.processing.errors.upload.title` = `আইডি স্ক্যান করা যায়নি`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `আইডির {{mode}} পাশ ক্যাপচার করুন`
* `idv2.capture.processing.errors.wrongSide.title` = `ভুল আইডি সাইড ক্যাপচার করা হয়েছে`
* `idv2.capture.processing.scanBack` = `পিছনের দিকটি স্ক্যান করুন`
* `idv2.capture.processing.success` = `সাফল্য`
* `idv2.capture.processing.successBackSubtitle` = `এবার চলুন শুরু করা যাক`
* `idv2.capture.processing.successFrontSubtitle` = `এবার পিছনের দিকটা ধরা যাক।`
* `idv2.capture.processing.successTitle` = `সফলভাবে প্রক্রিয়া করা হয়েছে!`
* `idv2.capture.processing.tryAgain` = `আবার চেষ্টা করুন`
* `idv2.capture.takingPhoto` = `ছবি তোলা হচ্ছে...`
* `idv2.capture.wrongSide.backHint` = `ব্যাক-আইডি-ইঙ্গিত`
* `idv2.capture.wrongSide.frontHint` = `সামনের-আইডি-ইঙ্গিত`
* `idv2.chooser.idButtonDescription` = `জাতীয় পরিচয়পত্র, অথবা ড্রাইভিং লাইসেন্স`
* `idv2.chooser.idButtonTitle` = `পরিচয়পত্র`
* `idv2.chooser.passportButtonDescription` = `আপনার দেশের পাসপোর্ট`
* `idv2.chooser.passportButtonTitle` = `পাসপোর্ট`
* `idv2.permissions.alertAlt` = `জাল অনুমতি সতর্কতা`
* `idv2.permissions.allow` = `ঠিক আছে, অনুমতি দিন`
* `idv2.permissions.denied.allow` = `অনুমতি দিন`
* `idv2.permissions.denied.ask` = `জিজ্ঞাসা করুন`
* `idv2.permissions.denied.browser` = `ব্রাউজার`
* `idv2.permissions.denied.camera` = `ক্যামেরা`
* `idv2.permissions.denied.changeTo` = `পরিবর্তন করুন`
* `idv2.permissions.denied.open` = `খোলা`
* `idv2.permissions.denied.or` = `অথবা`
* `idv2.permissions.denied.refreshPage` = `পৃষ্ঠা রিফ্রেশ করুন`
* `idv2.permissions.denied.return` = `এখানে ফিরে এসে টিপুন`
* `idv2.permissions.denied.scroll` = `নির্বাচন করতে নিচে স্ক্রোল করুন`
* `idv2.permissions.denied.settings` = `সেটিংস`
* `idv2.permissions.denied.tap` = `ট্যাপ করুন`
* `idv2.permissions.denied.title` = `ইনকোডকে আপনার ক্যামেরা অ্যাক্সেস করার অনুমতি দিতে পরবর্তী পদক্ষেপগুলি অনুসরণ করুন।`
* `idv2.permissions.denied.yourBrowser` = `তোমার ব্রাউজার`
* `idv2.permissions.description` = `প্রক্রিয়াটি সম্পন্ন করার জন্য`
* `idv2.permissions.dontAllow` = `অনুমতি দেবেন না`
* `idv2.permissions.fakeDenied.alert` = `জাল ফোকাসড সতর্কতা`
* `idv2.permissions.fakeDenied.allowPermissions` = `অনুমতি দিন`
* `idv2.permissions.fakeDenied.quitProcess` = `প্রক্রিয়াটি বন্ধ করুন`
* `idv2.permissions.fakeDenied.title` = `আপনার ডকুমেন্ট ক্যাপচারের জন্য ক্যামেরার অনুমতি প্রয়োজন`
* `idv2.permissions.fakeDenied.warning` = `সতর্কতা`
* `idv2.permissions.note` = `দ্রষ্টব্য: আপনার ফোনের উপর নির্ভর করে, এটি বলতে পারে`
* `idv2.permissions.or` = `অথবা`
* `idv2.permissions.subtitle` = `ক্যামেরার অনুমতি দিন`
* `idv2.permissions.title` = `আমাদের তোমার দরকার`
* `idv2.permissions.whileUsing` = `অ্যাপটি ব্যবহার করার সময়`
* `idv2.tutorial.autoCapture` = `ছবি স্বয়ংক্রিয়ভাবে তোলা হবে।`
* `idv2.tutorial.startScan` = `স্ক্যান করা যাক।`
* `idv2.tutorial.subtitle` = `নিশ্চিত করুন যে আপনার আইডিটি পঠনযোগ্য।`
* `idv2.tutorial.title` = `আপনার আইডি স্ক্যান করুন`
* `idv2.uploading.analyzing` = `বিশ্লেষণ করা হচ্ছে...`
* `idv2.uploading.imageAlt` = `আইডি ক্যাপচার`
* `onboarding.errors.restartDisabled.message` = `প্রতিষ্ঠান স্তরে সেশন পুনঃসূচনা অক্ষম করা হয়েছে`
* `onboarding.errors.restartDisabled.title` = `সেশন পুনরায় চালু করা যাচ্ছে না`
* `qes.signatureCheck` = `আমি প্রয়োজনীয় শংসাপত্র জারি করতে এবং ইলেকট্রনিকভাবে এই নথিতে স্বাক্ষর করতে সম্মত।`
* `qes.termsCheck` = `আমি ইনকোডের <2>গোপনীয়তা নীতি পড়েছি এবং তাতে সম্মত।</2> এবং ইনকোডের <6> ব্যবহারের শর্তাবলী</6> .`

## ✏️ Modified

* `commonIssues.tryAgain`:
  * Before: `ঠিক আছে, আবার চেষ্টা করুন`
  * Now: `আবার চেষ্টা করুন`
* `notifications.done`:
  * Before: `সম্পন্ন`
  * Now: `স্ক্যান সম্পন্ন হয়েছে`
* `notifications.glareDetected`:
  * Before: `একদৃষ্টি বর্তমান`
  * Now: `চকচকে ভাব শনাক্ত করা হয়েছে`
* `notifications.glareDetectedDescription`:
  * Before: `প্রতিফলন কমাতে আইডিটিকে সামান্য উপরে বা নিচে কাত করুন`
  * Now: `প্রতিফলন এড়াতে আরও ভালো আলো খুঁজুন।`
* `notifications.idTypeUnacceptable`:
  * Before: `আইডি টাইপ গ্রহণ করা হয় না`
  * Now: `অবৈধ আইডি ডকুমেন্ট`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `একটি ভিন্ন নথি দিয়ে চেষ্টা করুন`
  * Now: `অন্য একটি স্ক্যান করার চেষ্টা করুন`
* `notifications.lowSharpness`:
  * Before: `ব্লার বর্তমান`
  * Now: `কম তীক্ষ্ণতা`

---

- Path: `release-notes/bom-version-mapping`
- URL: https://developer.incode.com/release-notes/bom-version-mapping/
- Markdown: https://developer.incode.com/release-notes/bom-version-mapping.md

# BOM Version Mapping

For those updating dependencies manually, all dependency versions since the inception of the BOM will be documented here. The version of `com.incode.sdk:bom` will always correspond to the version of `com.incode.sdk:welcome` it contains.

### `bom` 5.55.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.55.0`
* `com.incode.sdk:core-light` -> `3.0.19`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.11`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.1`



### `bom` 5.54.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.54.0`
* `com.incode.sdk:core-light` -> `3.0.18`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.10`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.1`



### `bom` 5.53.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.53.0`
* `com.incode.sdk:core-light` -> `3.0.17`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.10`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`



### `bom` 5.52.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.52.0`
* `com.incode.sdk:core-light` -> `3.0.16`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.9`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`



### `bom` 5.51.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.51.0`
* `com.incode.sdk:core-light` -> `3.0.16`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.7`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`

### `bom` 5.50.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.50.0`
* `com.incode.sdk:core-light` -> `3.0.15`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.7`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`

### `bom` 5.49.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.49.0`
* `com.incode.sdk:core-light` -> `3.0.14`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.5`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`

### `bom` 5.48.1 Version Mapping

* `com.incode.sdk:welcome` -> `5.48.1`
* `com.incode.sdk:core-light` -> `3.0.13.1`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.4`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`

### `bom` 5.48.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.48.0`
* `com.incode.sdk:core-light` -> `3.0.13`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.4`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`
* `com.incode.sdk:wallets` -> `1.0.0`

### `bom` 5.47.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.47.0`
* `com.incode.sdk:core-light` -> `3.0.12`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.3`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.2`
* `com.incode.sdk:model-face-occlusion` -> `0.2.0`
* `com.incode.sdk:model-age-estimation` -> `2.2.2`

### `bom` 5.46.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.46.0`
* `com.incode.sdk:core-light` -> `3.0.11`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.3`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.1`

### `bom` 5.45.1 Version Mapping

* `com.incode.sdk:welcome` -> `5.45.1`
* `com.incode.sdk:core-light` -> `3.0.10`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.3`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.1`

### `bom` 5.45.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.45.0`
* `com.incode.sdk:core-light` -> `3.0.9`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.3`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.1`

### `bom` 5.44.0-hardened Version Mapping

* `com.incode.sdk:welcome` -> `5.44.0-hardened`
* `com.incode.sdk:core-light` -> `3.0.8`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.2`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.1`

### `bom` 5.44.0 Version Mapping

* `com.incode.sdk:welcome` -> `5.44.0`
* `com.incode.sdk:core-light` -> `3.0.8`
* `com.incode.sdk:extensions` -> `1.2.1`
* `com.incode.sdk:nfc` -> `1.5.2`
* `com.incode.sdk:video-streaming` -> `1.6.0`
* `com.incode.sdk:model-face-recognition` -> `3.5.1`
* `com.incode.sdk:model-id-face-detection` -> `3.5.1`
* `com.incode.sdk:model-liveness-detection` -> `3.2.1`

---

- Path: `release-notes/cordova-migration-guide`
- URL: https://developer.incode.com/release-notes/cordova-migration-guide/
- Markdown: https://developer.incode.com/release-notes/cordova-migration-guide.md

# Migration Guide

## Migration to 4.11.0

### Summary

4.11.0 contains breaking changes. Find the APIs you use below and skip the rest.

| API | Android | iOS | What you need to do |
|---|:-:|:-:|---|
| [startOnboardingSection()](#startonboardingsection) | 💥 | 💥 | Pass boolean recording fields, rename `forcePermissions`, provide a non-blank tag, handle start-up error objects and concurrent calls |
| [startOnboarding(), startOnboardingSection(), startFlow(), startWorkflow()](#startonboarding-startonboardingsection-startflow-startworkflow) | :white_check_mark: | :white_check_mark: | Check for `userCancelled` instead of `onUserCancelled`; handle `interrupted` and the more specific error codes |
| [startFlow()](#startflow) | :white_check_mark: | :white_check_mark: | Read the start-up error object instead of a message string |
| `startWorkflow()` | :white_check_mark: | :white_check_mark: | Handle `activityNotPresent` instead of `unknown` |
| [CurpValidation module](#curpvalidation-module) | :white_check_mark: | :white_check_mark: | Rename `CURPValidation` and `curpData`, pass `validationEnabled` as a boolean, update result checks |
| [Geolocation module](#geolocation-module) | :white_check_mark: | :white_check_mark: | Rename `addGeolocation` to `Geolocation`, pass `isSkippable` as a boolean, align with other updates |
| [Phone and Email modules](#phone-and-email-modules) | :white_check_mark: | :white_check_mark: | Pass `otpVerification` and `defaultRegionPrefix` as a boolean and a number |
| [setLogo()](#android-keep-the-setlogo-drawable) (new, optional) | :white_check_mark: | | If you call `setLogo()`, add the logo drawable to `res/raw/keep.xml` |

### startOnboarding(), startOnboardingSection(), startFlow(), startWorkflow()

#### A cancel reports userCancelled on Android

**Android**. When the user cancels, the error callback now receives `userCancelled`, the same as iOS. Previously, Android sent `onUserCancelled`.

```diff
  function (error) {
-   if (error === "onUserCancelled" || error === "userCancelled") { ... }
+   if (error === "userCancelled") { ... }
  }
```

:::note
A flow that the system ends, such as when it destroys the SDK screen in the background, now fails with the new `interrupted` code on both platforms. Previously, on Android, the flow never ended and no callback was called, and on iOS it failed with `unknown`.
:::

#### Changed error codes

These failures reported `unknown` before. They now have their own code:

| Failure | Platform | Previous | Current |
|---|---|---|---|
| Video Selfie not completed, for a reason other than a denied permission | Android, iOS | `unknown` | `videoSelfieNotCompleted` |
| Location not available | Android | `unknown` | `locationUnavailable` |
| Location permission denied | Android | `unknown` | `permissionsDenied` |
| Audio permission denied, or a fake-camera permission check | iOS | `unknown` | `permissionsDenied` |
| The user did not give biometric consent | Android, iOS | `unknown` | `biometricConsentNotGiven` |
| The biometric consent did not reach Incode | Android, iOS | `unknown` | `biometricConsentNotReceived` |
| The onboarding session could not be created | iOS | `unknown` | `sessionCreationFailed` |
| The CAPTCHA could not be verified | iOS | `unknown` | `captchaNotVerified` |
| A section was started while another one runs | iOS | `unknown` | `sectionAlreadyRunning` |
| The flow has no onboarding session | iOS | `unknown` | `noActiveSession` |
| Not enough free disk space for the SDK's ML models | Android | `unknown` | `insufficientDiskSpace` |
| On-device processing configured with an unsupported setting | Android | `unknown` | `onDeviceProcessingNotCompatible` |

On Android, a failed CAPTCHA still fails with `unknown`. If you handle `unknown` as a catch-all, also handle these codes. See [Results — startOnboardingSection()](/sdk-reference/cordova-results/#startonboardingsection) for the full list.

### startOnboardingSection()

#### Recording configuration

Pass real booleans for `recordSession` and `forcePermission`. Rename `recordSessionConfig.forcePermissions` to `recordSessionConfig.forcePermission`.

```diff
- { recordSession: "true", forcePermissions: "false" }
+ { recordSession: true, forcePermission: false }
```

The old `forcePermissions` key is ignored. Non-boolean values are ignored and default to `false`, without an error callback. Thus, `recordSession: "true"` now leaves recording off. `forcePermission` only applies when `recordSession` is `true`.

Pass `null` in the recording argument position to disable recording. The `startOnboarding()` recording configuration is unchanged.

#### Required section tag

Provide a non-blank string in the `sectionTag` argument position:

```javascript
cordova.exec(onSuccess, onError, "Cplugin", "startOnboardingSection", [
  [{ module: "addId" }],
  { recordSession: true, forcePermission: false },
  "identity-section"
]);
```

A missing, null, blank, or non-string tag now fails with `configError`.

#### Start-up errors and concurrent calls

Read start-up errors as `{ code, message, cause }`, not as strings. Both platforms report `unknownModule` for unknown modules and `configError` for other module configuration errors. Start exceptions report `unknown`.

`cause` is `null` or an object with `type` and `message`. Android also includes `stackTrace`. Errors after the section starts, including cancellation, still arrive as strings.

```javascript
function onError(error) {
  const code = typeof error === "string" ? error : error.code;
  if (code === "sectionAlreadyRunning") {
    console.log("Wait for the running section to finish.");
    return;
  }
  console.log("Section error:", code, error);
}
```

Wait for each section's callback before starting another section. A concurrent call now fails with `sectionAlreadyRunning` on both platforms. It does not replace the running section's callback or results.

See the [API Reference](/sdk-reference/cordova-api-reference/#startonboardingsection) for the full start-up error contract.

### startFlow()

`startFlow()` now runs through the shared Incode bridge, the same as `startWorkflow()`. When the flow cannot start, the error callback receives `{ code, message, cause }` with one of these codes:

| Code | Description |
|---|---|
| `activityNotPresent` | There is no presenting view controller (iOS) or Activity (Android). |
| `configError` | `sessionConfig` has neither a `configurationId` nor a `token`. Rejected before the flow starts. |
| `unknown` | The flow could not start for another reason. |

Previously, iOS passed a plain string, such as `"No presenting view controller available."` or `"Invalid sessionConfig argument for startFlow."`. Previously, Android failed with an invalid-action error. Errors after the flow has started are unchanged. An unknown `moduleId` runs the whole flow, the same as before.

```diff
  cordova.exec(onSuccess, (error) => {
-   console.log(error); // "No presenting view controller available."
+   if (error?.code === 'activityNotPresent' || error?.code === 'configError') {
+     // the flow did not start
+   }
  }, 'Cplugin', 'startFlow', [sessionConfig, moduleId]);
```

### CurpValidation module

The `CurpValidation` module now returns the same result on Android and iOS, and no longer accepts booleans and numbers as strings.

#### CURPValidation Renamed

```diff
- { module: "CURPValidation", validationEnabled: "true" }
+ { module: "CurpValidation", validationEnabled: true }
```

The old name is not accepted: a flow configuration that still uses it fails with an `unknownModule` error.

`validationEnabled` must be a real boolean. The string form (`"true"`, `"false"`) is ignored and the native default applies, which is validation on. A flow that sends `validationEnabled: "false"` therefore now validates the CURP against RENAPO. The plugin logs a warning that names the module and the key.

#### curpData Renamed to curpValidationData

```diff
- const curp = result.curpData;
+ const curp = result.curpValidationData;
```

#### curpValidationData Result

`curpValidationData` now has the same shape on both platforms. See [Results](/sdk-reference/cordova-results/#curpvalidationdata).

| | Before | Now |
|---|---|---|
| CURP rejected by RENAPO | `status: "success"` on Android, `"fail"` on iOS | `status: "fail"`, `valid: false`, `resultCode: "error"` on both |
| SDK error on Android | `status` could be the native error message | `status: "fail"` and a `resultCode` |
| No CURP captured | `curp: ""` | `curp` is omitted |
| No validation response | `data: ""` on iOS | `data` is omitted |
| `validationEnabled: false` | `status: "success"` | `status: "success"` when a CURP was captured, `"fail"` otherwise; `valid` and `data` are omitted |

```diff
- if (result.curpData.status === "success" && result.curpData.curp !== "") { ... }
+ if (result.curpValidationData.status === "success" && result.curpValidationData.curp !== undefined) { ... }
```

On Android, `status: "success"` now means that RENAPO accepted the CURP, as on iOS. If your Android code read `data` to find out whether the CURP was valid, read `status` or `valid` instead. Do not compare `status` with a native error message.

### Geolocation Module

`geoLocationData` result is changed so Android and iOS return the same shape. Skip this section if your app doesn't use the `Geolocation` module.

#### Module name

`addGeolocation` is now `Geolocation`. The old name still works but logs a deprecation warning and will be removed in a future release.

```diff
-{ module: "addGeolocation" }
+{ module: "Geolocation" }
```

#### isSkippable takes a real boolean

`isSkippable` must be a real boolean, with both `Geolocation` and `addGeolocation`. The string form (`"true"` / `"false"`) is ignored, and the default applies: the step is not skippable. A flow that sends `isSkippable: "true"` therefore now ends through `errorCallback` when the user skips or denies location. The plugin logs a warning that names the module and the key.

```diff
-{ module: "addGeolocation", isSkippable: "true" }
+{ module: "Geolocation", isSkippable: true }
```

#### geoLocationData result

`geoLocationData` now has the same shape on both platforms. Check `status` instead of looking for empty strings, and read coordinates from `latitude` and `longitude`:

```diff
-const city = winParam.geoLocationData.addressFields.city;
+const geo = winParam.geoLocationData;
+if (geo.status === "success") {
+  const city = geo.addressFields?.city;
+  const { latitude, longitude } = geo;
+}
```

When `status` is `"fail"`, `error` carries the reason: `permissionsDenied`, `locationUnavailable`, `sslPinningFailed`, `integrityCompromised`, or `unknown`. On Android, an unavailable location used to be dropped silently; it is now reported with `status: "fail"`.

#### state is the country name

`addressFields.state` now holds the country name on both platforms. On Android it previously held the region: for example, `CDMX`. It now holds the country: for example, `Mexico`. This matches the behavior on iOS. `addressFields.city` falls back to the region when the city is unknown. If your app needs the region on Android, it is no longer reported.

#### Non-skippable failure error

On Android, when a non-skippable `Geolocation` step fails, `errorCallback` now receives `permissionsDenied` or `locationUnavailable`. Previously, it received `unknown`. If your app handles this failure through `unknown`, also handle the two new values.

### Phone and Email Modules

`Phone` and `Email` modules no longer accept booleans and numbers as strings. `otpVerification` must be a real boolean, and `defaultRegionPrefix` a real number. The string form (`"true"`, `"52"`) is ignored and the native default applies: no OTP override, and the device's own region prefix. The plugin logs a warning that names the module and the key.

```diff
- { module: "Phone", otpVerification: "true", defaultRegionPrefix: "52" }
+ { module: "Phone", otpVerification: true, defaultRegionPrefix: 52 }

- { module: "Email", otpVerification: "true" }
+ { module: "Email", otpVerification: true }
```

### Android: keep the `setLogo()` drawable

This applies only if you start to use the new `setLogo()` method. No change is necessary if you do not call it.

On Android, `setLogo()` finds the logo drawable by its name at runtime, so no code refers to it. When resource shrinking is on (`shrinkResources true`), the Android shrinker removes the drawable from release builds, and `setLogo()` fails with `appearanceError`. To keep the drawable, add it to `res/raw/keep.xml`, for example with a `resource-file` entry in your `config.xml`:

```xml
<platform name="android">
    <resource-file src="res/logo/keep.xml" target="app/src/main/res/raw/keep.xml" />
</platform>
```

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

See `setLogo()` in the [API Reference](/sdk-reference/cordova-api-reference/#setlogo).

## Migration to 4.10.0

<Accordion title="Migration to 4.10.0">

4.10.0 contains breaking changes: most of them make Android and iOS return the same result and error shapes. Find the APIs you use below and skip the rest.

| API | Android | iOS | What you need to do |
|---|:-:|:-:|---|
| [Installation](#installation) | | :white_check_mark: | Reinstall the iOS platform |
| [`getUserScore()`](#getuserscore) | :white_check_mark: | :white_check_mark: | Read the new result object, update error checks |
| [`faceMatch()`](#facematch) | :white_check_mark: | :white_check_mark: | Update result field names and error handling |
| [`startWorkflow()`](#startworkflow) | :white_check_mark: | :white_check_mark: | Read `error.message` instead of a string |
| [`approve` module result](#approve-module-result) | :white_check_mark: | :white_check_mark: | Rename `approveData` keys |
| [`Phone`, `Email`, `FullName` modules](#phone-email-and-fullname-modules) | :white_check_mark: | :white_check_mark: | Rename `addPhone` and `addEmail`, check for missing values |
| [`setTheme()`](#settheme) | :white_check_mark: | | Rename `positive800` to `positive750` |

### Installation

**iOS.** The plugin now depends on the `IncodeBridgeCommon` pod. It's declared by the plugin, so your app needs no source change, but the pod must be resolved. After updating the plugin, reinstall the iOS platform, or re-run `pod install` in `platforms/ios` if you've made manual changes there:

```bash
cordova platform rm ios
cordova platform add ios
```

### getUserScore()

#### One Result Object on Both Platforms

Previously, Android returned a JSON string, and iOS returned an object nested under `userScoreData.data`. The keys were different. Now, both platforms return the same top-level object:

```javascript
{
  "extendedUserScoreJsonData": "<raw JSON>",
  "overall": { "value": "80.5", "status": "ok" },
  "idValidation":         { "overall": { … }, "photoSecurityAndQuality": [ … ], "idSpecific": [ … ] },
  "liveness":             { "overall": { … }, "livenessScore": { … }, "photoQuality": "70.5" },
  "faceRecognition":      { "overall": { … }, "existingUser": false },
  "governmentValidation": { "overall": { … }, "recognitionConfidence": { … }, "validationStatus": { … }, "ocrValidation": [ … ] }
}
```

See [Results — getUserScore](/sdk-reference/cordova-results/#getuserscore) for the full contract.

```diff
  cordova.exec(function (result) {
-   const score = JSON.parse(result).overallScore;              // Android: "80.5/100"
-   const score = result.userScoreData.data.overallScore;       // iOS
-   const faceScore = result.userScoreData.data.facialRecognitionScore;
+   const score = result.overall.value;                         // "80.5" on both
+   const status = result.overall.status;
+   const faceScore = result.faceRecognition?.overall?.value;
  }, onError, "Cplugin", "getUserScore", ["accurate"]);
```

What changed in the values:

| | Before | Now |
|---|---|---|
| Android payload | JSON string, needed `JSON.parse()` | Object; remove `JSON.parse()` |
| Android score values | `"80.5/100"`, sometimes a localized phrase | `"80.5"`, also in `onUserScoreFetched` |
| iOS status | `warning` | `warn` (set: `ok`, `warn`, `fail`, `unknown`, `manual`, `null`) |
| iOS absent values | `""` | `null` |
| iOS `existingUser` | String `"false"` | Boolean `false` |

Rules to code against:

* `overall` and `extendedUserScoreJsonData` are always present. `overall.value` and `overall.status` are `null` when the SDK returned no overall score.
* `idValidation`, `liveness`, `faceRecognition`, and `governmentValidation` are present only when the SDK returned them, so guard your access. Inside a present section, every key is present and `null` when absent.
* Check lists are always arrays, `[]` when empty. Entries with an `unknown` status are left out of `photoSecurityAndQuality` and `ocrValidation`; `idSpecific` is unfiltered.
* `extendedUserScoreJsonData` is still a raw JSON string (`"{}"` when unavailable) and still needs `JSON.parse()`.

When the `userScore` module runs as part of a flow for iOS, the `{ module: "userScore" }` result still arrives under `userScoreData`, but its value is now the same object that `getUserScore` returns:

```diff
- const score = result.userScoreData.data.overallScore;
+ const score = result.userScoreData.overall.value;
```

#### Errors

`errorCallback` now receives one of these strings on both platforms:

| Error | Meaning |
|---|---|
| `userScoreFailed` | Transport or HTTP failure, mapping failure, submit-only mode, or (iOS only) a completely empty score. |
| `userCancelled` | The user cancelled. Android only: the call shows no UI, so iOS never reports it. |

```diff
  function (error) {
-   if (error === "UserScoreFailed") { ... }   // Android
-   if (error === "onUserCancelled") { ... }   // Android
+   if (error === "userScoreFailed") { ... }
+   if (error === "userCancelled") { ... }
  }
```

* **iOS:** Failures used to reach the **success** callback as `{ "userScoreData": { "debug": "nil" } }`. If you detected them by looking for `debug` or a missing `overall`, move that handling into `errorCallback`.
* **Both:** Submit-only mode, transport/HTTP failures and mapping failures now report `userScoreFailed`. Previously, Android succeeded with an empty payload. If you treated an empty success as "no score yet", handle `userScoreFailed` instead. One difference remains: if the server returns a completely empty score (HTTP 200), iOS reports `userScoreFailed` and Android succeeds with an empty result.

#### Behavior Changes on Android

* `"fast"` **is honored**: Previously, Android ignored `fetchMode` and always fetched `accurate`, its default. Calls passing `"fast"` now get the faster fetch, which can report different scores. Pass `"accurate"` or omit `fetchMode` to keep the old behavior.
* **No remembered** `interviewId`: Previously, Android reused the `interviewId` of the session created earlier in the app's lifetime. Both platforms now use the current session. To score a *different* session, pass its `interviewId` as the new fourth argument:

```javascript
getUserScore(onSuccess, onError, "accurate", interviewId);
```
You can get the `interviewId` from the `onOnboardingSessionCreated` result.

### faceMatch()

These changes affect standalone `faceMatch()` call only. The `addFaceMatch` module's `faceMatchData` is unchanged.

#### Result

| Change | Platform | Update |
|---|---|---|
| `existingUser` renamed to `isExistingUser` | Both | `result.existingUser` → `result.isExistingUser` |
| `status` removed | Both | Use `isFaceMatched` (see below) |
| No longer nested under `faceMatchData` | iOS | `result.faceMatchData.confidence` → `result.confidence` |
| Unavailable fields are left out instead of `0` / `false` / `""` | Both (iOS for `isFaceMatched`, `isNameMatched`, `existingInterviewId`) | Check that the key is present |
| `-1` confidence scores are left out | Android | `confidence === -1` → `confidence === undefined` |

```diff
- if (result.status === "match") { ... }
+ if (result.isFaceMatched === true) { ... }

- if (result.nfcVsIdConfidence > 0.8) { ... }
+ if (result.nfcVsIdConfidence !== undefined && result.nfcVsIdConfidence > 0.8) { ... }
```

- Previously, `status` was always `"match"` or `"mismatch"`. A missing `isFaceMatched` now means no comparison was possible, so it isn't a direct substitute.
- A `0` confidence is still returned: it's a real "no match" score.
- On iOS, a `getUserScore()` call made after `faceMatch()` no longer includes a `faceMatchData` key.

#### Errors

The error callback now receives `{ code, message, cause }`. Previously, on iOS, it was never called: failures arrived at the success callback as `faceMatchData: { debug: "..." }`.

```diff
  function (error) {
-   if (error === "onUserCancelled") { ... }
-   if (error === "FaceMatchFailed") { ... }
+   if (error.code === "userCancelled") { ... }
+   if (error.code === "faceMatchError") { console.log(error.message); }
  }
```

`userCancelled` is Android only. iOS has no separate cancellation signal and reports `faceMatchError`.

### startWorkflow()

The error callback now receives `{ code, message, cause }` on both platforms, as `faceMatch()` does. It used to be a string: `"Failed to start workflow: <message>"` on Android, `"No presenting view controller available."` on iOS.

```diff
  function (error) {
-   console.log(error);
+   console.log(error.message);
  }
```

### approve Module Result

The in-flow `approve` module's `approveData` now uses the same keys as the new [`approve()`](/sdk-reference/cordova-api-reference/#approve) method:

```diff
- { status: "approved", id: "<uuid>", customerToken: "<token>" }
+ { success: true, uuid: "<uuid>", customerToken: "<token>", error: null }
```

```diff
- if (result.approveData.status === "approved") { ... }
+ if (result.approveData.success) { ... }

- const customerId = result.approveData.id;
+ const customerId = result.approveData.uuid;
```

*  When the SDK returns none, `uuid` and `customerToken` are `null` instead of `""`.
* `error` is a flow error string (`sslPinningFailed` or `unknown`) on iOS, and always `null` on Android.

### Phone, Email and FullName Modules

#### addPhone and addEmail Renamed

```diff
- { module: "addPhone" }
+ { module: "Phone" }

- { module: "addEmail", otpVerificationEnabled: "true" }
+ { module: "Email", otpVerification: true }
```

The OTP parameter is now named `otpVerification`, matching the native SDK, and accepts a real boolean. The string form (`"true"`) still works.

#### Empty Capture Values Omitted

`phoneData.phone`, `emailData.email`, and `fullNameData.name` were previously `""` when the SDK captured nothing. The key is now absent instead.

```diff
- if (result.phoneData.phone !== "") { ... }
+ if (result.phoneData.phone !== undefined) { ... }
```

### setTheme()

For Android, the theme color `positive800` is renamed to `positive750`. It represents the same color. Android now ignores the old key and falls back to the default color, as iOS already does.

```diff
 "colorPalette": {
-  "positive800": "#0C5030"
+  "positive750": "#0C5030"
 }
```

</Accordion>

## Migration to 4.9.0

<Accordion title="Migration to 4.9.0">

### Update the Signature V2 title and description string overrides for Android

Signature V2 uses dedicated string resources for the title and description. V1 continues to use the existing string resources.

If you enable V2 and override the V1 strings, add these V2 overrides to your `strings.xml` file:

```xml
<string name="onboard_sdk_signature_capture_title">Your title</string>
<string name="onboard_sdk_signature_capture_description">Your description</string>
```

Keep these V1 overrides if your integration still uses V1:

```xml
<string name="onboard_sdk_signature_title">Your title</string>
<string name="onboard_sdk_signature_description">Your description</string>
```

No change is required if you do not override these strings.

### Video Selfie V2 hides the close button on the camera steps on Android

When Video Selfie V2 is enabled for your account, its camera steps hide the close (X) button, so `cordova.exec(resolve, reject, "Cplugin", "showCloseButton", ["true"])` does not apply to them. The button still shows on the other screens. Video Selfie V1 keeps the button over the camera. No code change is required. If your users rely on the close button to leave a camera step, tell them about the new behavior or keep Video Selfie V1.

### `MLConsentData.status` now reflects the user's choice on iOS

The `addMachineLearningConsent` module used to report `status: true` on iOS whenever the
submission call succeeded, even when the user declined the consent. It now reports the
choice the user made: `true` when the consent was accepted and `false` when it was
declined. The consent stays optional and the flow continues in both cases. If your app
treats `MLConsentData.status` as _submitted_, update it to treat `false` as _declined_
instead of as a module failure.

### Combined Consents stops on an unshowable mandatory consent

A mandatory Combined Consent that has no readable text or checkbox ID can no longer be
silently accepted on iOS. The module ends and the flow stops, so `startOnboarding()` and
`startOnboardingSection()` call the `errorCallback` with the new
`"combinedConsentsNotReceived"` string. Text that is empty or only spaces counts
as missing text. Give the consent text in Dashboard to clear the error. Optional
consents that cannot be shown are still left out and the flow continues, as before.

Handle it alongside the other typed flow errors:

```diff
  function (error) {
    switch (error) {
      case "permissionsDenied":
        break;
+     case "combinedConsentsNotReceived":
+       // A mandatory combined consent is misconfigured in Dashboard.
+       break;
      default:
        break;
    }
  }
```

</Accordion>

## Migration to 4.8.0

<Accordion title="Migration to 4.8.0">

### `setFaceAuthenticationHint` argument renamed to `identityId`

The argument is the expected identity ID, not on-screen hint copy:

```diff
- setFaceAuthenticationHint(success, error, faceAuthenticationHint)
+ setFaceAuthenticationHint(success, error, identityId)

  cordova.exec(success, error, "Cplugin", "setFaceAuthenticationHint", [
-   "Look at the camera",
+   "customer@example.com",
  ]);
```

### `setUXConfig` argument renamed to `jsonConfig`

```diff
- setUXConfig(success, error, config)
+ setUXConfig(success, error, jsonConfig)

  cordova.exec(success, error, "Cplugin", "setUXConfig", [
    JSON.stringify({ showFooter: false }),
  ]);
```

The value is still a JSON string. Only the parameter name changed.

### `initializeSDK()` method parameter `isExternalTokenEnabled` removed

External tokens belong on `sessionConfig.token`. Remove the argument and shift subsequent positional args:

```diff
cordova.exec(success, error, "Cplugin", "initializeSDK", [
  apiKey,
  apiUrl,
  loggingEnabled,
  testMode,
- "true",                 // isExternalTokenEnabled — removed
  clientExperimentId,
  e2eeUrl,
  sslPinningConfig,
+ "standard",             // sdkMode (optional)
+ "false",                // externalAnalyticsEnabled (optional)
+ "false",                // externalScreenshotsEnabled (optional)
]);
```

### `initializeSDK` error payload format

Init failures now return `"<code>: <message>"` on both iOS and Android platforms:

```diff
- if (err === "configError") { ... }
+ if (typeof err === "string" && err.indexOf("configError") === 0) { ... }
```

### Android build requirements raised
This release updates the underlying Android SDK to 5.51.0, which raises the minimum Android toolchain your app must build with. There are no JavaScript API changes; all of the work is in your Android build configuration.

Update the `android` platform preferences in your app's `config.xml`:

```diff
<platform name="android">
-  <preference name="android-compileSdkVersion" value="35" />
+  <preference name="android-compileSdkVersion" value="36" />
+  <preference name="AndroidGradlePluginVersion" value="8.9.1" />
+  <preference name="GradleVersion" value="8.14.5" />
   <preference name="GradlePluginKotlinEnabled" value="true" />
-  <preference name="GradlePluginKotlinVersion" value="1.8.21" />
+  <preference name="GradlePluginKotlinVersion" value="2.2.21" />
</platform>
```

| Requirement | Minimum | Reason|
|-------------|---------|-----|
| `compileSdk` | 36 | Required by the SDK's updated CameraX and Kotlin dependencies. |
| Android Gradle Plugin | 8.9.1 | Required to build against `compileSdk` 36. |
| Gradle | 8.14.5 | AGP 8.9.1 is validated against Gradle 8.14.5 for this SDK release. |
| Kotlin Gradle plugin | 2.2.21 | The SDK is compiled with Kotlin 2.2.21; any module compiling Kotlin source with the SDK on its classpath must be able to read its Kotlin metadata. |
| `kotlinx-coroutines` | 1.9.0 | Required by CameraX 1.6.1. Pulled in transitively; only act if you have explicitly pinned an older version. |
| JDK (to run Gradle) | 17 | Required by AGP 8.9.1. The compiled Java source/target level stays at 11. |

Pure-Java Cordova apps still need the Kotlin plugin bump. The plugin itself contains Kotlin sources that are compiled with the SDK on the classpath.

:::info
The preference key that `cordova-android` reads is `AndroidGradlePluginVersion`. If your `config.xml` uses `android-gradlePluginVersion`, it is silently ignored and you will keep building with the platform's default AGP. Rename it.
:::

### OkHttp packaging exclusion: handled by the plugin

OkHttp/logging-interceptor 5.3.2 and its transitive JSpecify dependency both ship an identical OSGi manifest at `META-INF/versions/9/OSGI-INF/MANIFEST.MF`, which fails APK packaging with a duplicate-resource error. The plugin now declares this exclusion in its own Gradle configuration, so **no action is required** in a standard Cordova integration.

If your build overrides packaging options in a way that drops the plugin's configuration, add the exclusion yourself in `platforms/android/app/build-extras.gradle`:

```groovy
android {
    packaging {
        resources {
            excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
        }
    }
}
```

### Compose Material3 : Compose minimum versions raised

The SDK's Compose-based screens are now built against Compose Material3 1.4.0 and Compose 1.8.0. Cordova apps do not normally resolve Compose directly, so most integrations need no action. Act only if you or another Cordova plugin explicitly pin these libraries below those versions. An older resolved set crashes at runtime (`NoSuchMethodError` / `NoClassDefFoundError` in `androidx.compose.*`) when a Compose screen opens.

</Accordion>

## Migration to 4.7.0

<Accordion title="Migration to 4.7.0">

### `initializeSDK()` method parameter `disableJailbreakDetection` removed

The `disableJailbreakDetection` parameter has been removed from the `initializeSDK()` method. It has no replacement. If you previously set it, remove it and update your positional arguments.

### Removed deprecated setCommonConfig() method. 

The deprecated `setCommonConfig()` method that displayed or hid the close button has been removed. Use `showCloseButton()` instead. 

</Accordion>

## Migration to 4.6.0

<Accordion title="Migration to 4.6.0">

### Renamed `neutral` and `black` color palette tokens on Android

The `neutral` and `black` keys in theme's `colorPalette` have been renamed:
* `neutral` -> `neutralLight`
* `black` -> `neutralDark`

If you provided the theme via a JSON config, rename the keys inside `colorPalette`:
```diff
"colorPalette": {
+  "neutralLight": "#ffffff",
-  "neutral": "#ffffff",
+  "neutralDark": "#000000",
-  "black": "#000000",
  "brand50": "#e5f0ff",
  ...
  "positive500": "#189F60",
  "positive600": "#189F60",
  "positive800": "#0C5030"
}
```

Theme JSON that still uses the old `neutral` and `black` keys will silently fall back to the defaults `#FFFFFF` and `#000000`, because unknown keys are ignored during parsing. Update your JSON to use the new keys to keep your customizations applied.

</Accordion>

## Migration to 4.5.0

<Accordion title="Migration to 4.5.0">

### Changed default value for mask check in SelfieScan module

The default value for the `maskCheckEnabled` parameter in the `addSelfieScan` module has been changed from `false` to `true`. If you did not previously configure this flag, face mask validation will now be enforced by default during face capture.
To preserve the previous behavior, explicitly disable these flags:

```js
{ module: "addSelfieScan", maskCheckEnabled: "false"}
```

### Changed default values for face capture checks in FaceAuthentication module

The default values for the `faceMaskCheck`, `headCoverCheck`, `lensesCheck`, and `eyesClosedCheck` parameters in the `addFaceAuthentication` module have been changed from `false` to `true`. If you did not previously configure these flags, these validations will now be enforced by default during face authentication.

To preserve the previous behavior, explicitly disable these flags:

```js
{
  module: "addFaceAuthentication",
  faceMaskCheck: "false",
  headCoverCheck: "false",
  lensesCheck: "false",
  eyesClosedCheck: "false"
}
```

### SQLCipher attribution required if you ship an open-source licenses screen on Android

Local Room databases used by the SDK are now encrypted at rest with [SQLCipher for Android](https://github.com/sqlcipher/sqlcipher-android), distributed under a BSD-style license. The license requires consumers that redistribute binaries, such as your application, to reproduce its copyright notice "in the documentation and/or other materials provided with the distribution".

If your application includes an "Open Source Licenses" screen, please add the SQLCipher notice listed in [Licenses](/sdk-reference/android-licenses/#sqlcipher-for-android-netzeteticsqlcipher-android). No code change is needed if you do not ship such a screen.

</Accordion>

## Migration to 4.3.0

<Accordion title="Migration to 4.3.0">

### Removed localization keys on iOS
* `incdOnboarding.nameInfo.lastnamePlaceholder`
* `incdOnboarding.ccv.invalidCCV`

### Renamed localization keys on iOS
* `incdOnboarding.email.title` -> `incdOnboarding.userInformation.email.title`
* `incdOnboarding.email.invalidEmail` -> `incdOnboarding.userInformation.email.wrongFormat`
* `incdOnboarding.ccv.title` -> `incdOnboarding.userInformation.securityCode.title`
* `incdOnboarding.nameInfo.title` -> `incdOnboarding.userInformation.fullName.title`
* `incdOnboarding.nameInfo.subtitle` -> `incdOnboarding.userInformation.fullName.subtitle`
* `incdOnboarding.nameInfo.namePlaceholder` -> `incdOnboarding.userInformation.fullName.placeholder`
* `incdOnboarding.nameInfo.continue` -> `incdOnboarding.userInformation.continue`
* `incdOnboarding.ekyc.input.label.fillYourCredentials` -> `incdOnboarding.ekyc.input.title`

</Accordion>

## Migration to 4.2.0

<Accordion title="Migration to 4.2.0">

### Updates to document chooser behavior in `IdScan` module

The **Show document chooser screen** setting in Dashboard or `showIdTypeChooser` in the SDK now control if the document chooser screen appears. Setting `idType` alone no longer hides the chooser and will be ignored.

If you previously pre-set `idType` (either using `idType: ...` in the SDK or in Dashboard) and expected the chooser to be hidden, you must now explicitly disable it or update the Flow configuration accordingly:

```js
{
  module: "addId",
  idType: "passport",
  showIdTypeChooser: "false"
}
```

### Android color palette changes

If you previously customized the application appearance using a config JSON:

```json
{
    "colorPalette": {
        "negative500": "#FF5A5F",
        "negative600": "#E71111",
        "positive500": "#189F60",
        "positive600": "#189F60"
    }
}
```

These keys have now been migrated to the following values:
* `negative500` -> `negative400`
* `negative600` -> `negative500`
* `positive500` -> `positive400`
* `positive600` -> `positive500`

### iOS color palette changes

V2 theme default `colorPalette` values and the JSON keys used for positive and negative semantic colors have changed. If you customize the V2 theme, update your palette to match [About Colors](https://github.com/Incode-Technologies-Example-Repos/Incode-Welcome-Example-iOS/blob/release/5.41.0/USER_GUIDE_CUSTOMIZATION_V2.md#about-colors) in the iOS Customization Guide v2.

### `ID Capture` V2 - Error Screen Customization for Android

**Wrong document side customization**

If you previously customized the `Wrong document side` error screen, add the following new string resources:

```xml
<string name="onboard_sdk_id_capture_error_side_front">Capture the front side of the ID</string>
<string name="onboard_sdk_id_capture_error_side_back">Capture the back side of the ID</string>
```
This previous string is longer used:

```xml
<string name="onboard_sdk_id_capture_error_side">You’ve scanned the wrong document side. Please scan your document again.</string>
```

**No internet connection customization**

If you previously customized the `No internet connection` error screen, add the following new string resource:

```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```
This previously used string is still in use for other error screens and should be kept in your resources:

```xml
<string name="onboard_sdk_id_capture_error_title">There was a problem</string>
```

**Retry button customization**

The retry button is now customized using a different string resource:

```xml
<string name="onboard_sdk_id_capture_retry">Refresh</string>
```
This previously used string is still in use for other error screens and should be kept in your resources:

```xml
<string name="onboard_sdk_no_network_snackbar_action_text">Retry</string>
```

### `Selfie` V2 - Error Screen Customization for Android

**No internet connection customization**

If you previously customized the `No internet connection` error screen, add the following new string resource:

```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```
This previously used string is still in use for other error screens and should be kept in your resources:

```xml
<string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_title">There was a problem</string>
```

### Changes in behavior for device environment detection for Android

The behavior when detecting device environment vulnerabilities has changed:

* **Hook or virtual environment detection**: Detecting hook or virtual environment vulnerabilities in the SDK triggers a native crash, which cannot be caught or handled by application code, resulting in immediate app termination.
* **Emulator and root detection**: The flow is not aborted when emulator and root checks are detected. The onboarding process continues normally.

### API Changes

The following `initializeSDK()` method optional parameters have been removed:
* `disableVirtualEnvironmentDetection`
* `disableRootDetection`
* `disableEmulatorDetection`
* `disableHookCheck`

If you were using these parameters in your code, remove them from your `initializeSDK()` method call. Device environment checks can no longer be disabled.

### Added ability to pass `SessionConfig` to `startFaceLogin()` method for Android

Now you can supply an optional `sessionConfig` parameter to the `startFaceLogin()`, like this:

```js
  let sessionConfig = {}; // Optional

  cordova.exec(
    function (result) {
      console.log("Face login Success: " + result);
    },
    function (error) {
      console.log("Face login Error: " + error);
    }, 
    "Cplugin", 
    "startFaceLogin",
    [sessionConfig]
  );
```

This allows enabling of end-to-end encryption (E2EE) in Face Login mode on Android.

### Added ability to pass `showIdTypeChooser` parameter to the `addId` module

Now you can supply an optional `showIdTypeChooser` parameter to the `addId` module. It will be used by the SDK to decide whether to show the document type chooser. By default, if not supplied, `showIdTypeChooser` param is `true`.

```js
{
  module: "addId", 
  idType: "passport", 
  showIdTypeChooser: "false"
}
```

### `setupOnboardingSession` now accepts a session config object

The `setupOnboardingSession` method now expects a **JSON object** as the first argument instead of a plain string `configurationId`.

If you previously passed `configurationId` as a string, the method will silently fall back to an empty session configuration, which may cause unexpected behavior.

**Before:**
```js
cordova.exec(resolve, reject, "Cplugin", "setupOnboardingSession", ["your-config-id"]);
```

**After:**
```js
var sessionConfig = {
  configurationId: "your-config-id",
  // other optional fields:
  // token: "...",
  // e2eEncryptionEnabled: true,
  // mergeSessionRecordings: false,
  // validationModules: [...],
  // externalId: "...",
  // externalCustomerId: "...",
  // interviewId: "...",
};
cordova.exec(resolve, reject, "Cplugin", "setupOnboardingSession", [sessionConfig]);
```

**Migration:** Wrap your `configurationId` and any other session parameters in a JSON object and pass that object as the first element of the arguments array.

The same applies to `startWorkflow` and `startFlow`, which also accept a session config object as the first argument.

### Updated `startOnboardingSection` method with additional parameters

You now have to provide `recordSessionConfig` and `sectionTag` parameters when calling `startOnboardingSection` to set the session recording configuration and section tagging.

### Expected crashes when running in a virtual environment on Android

It is expected that the app crashes with the following stacktraces when a virtual environment is used. For example:

```
java.lang.NullPointerException
    at com.incode.welcome_sdk.ThemeConfiguration$Builder.setLabelSmallStyle(SourceFile:1066)
    at com.incode.welcome_sdk.f.c(SourceFile:150)
    at com.incode.welcome_sdk.data.local.m.as(SourceFile:22)
    at com.incode.welcome_sdk.IncodeWelcome.startOnboardingSection(SourceFile:18)
```

```
java.lang.NullPointerException: Attempt to get length of null array
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.d(SourceFile:320)
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.i(SourceFile:214)
```

### `Selfie` V2: No Internet Error Screen Retry Button Change on Android

The retry button label shown on the Selfie Scan "No internet" error screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_face_scan_retry">Refresh</string>
```
The previous string was:

```xml
<string name="onboard_sdk_try_again">Try again</string>
```

If you overrode `onboard_sdk_try_again` to customize the retry button on the no internet screen, you must now override `onboard_sdk_face_scan_retry` instead. 
The `onboard_sdk_try_again` string is still used for other retry scenarios.

### `Selfie` V2 - Capture-Only Mode Success Screen Text Change on Android

In capture-only mode, the Selfie Scan success screen now uses a different string resource:

```xml
<string name="onboard_sdk_face_captured">Face captured!</string>
```
This previously used string is still in use for non-capture-only mode and should be kept in your resources:

```xml
<string name="onboard_sdk_enroll_success">Success!</string>
```

### `ID Capture` and `Selfie` V2: Permission Open Settings Screen Text Change on Android

The Open settings label shown on the Permission open settings screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_permission_allow_permission_action">Allow permission</string>
```
This previously used string is still in use for the `Geolocation` module and should be kept in your resources:

```xml
<string name="onboard_sdk_permission_open_setting_action">Open settings</string>
```

### String Customization on iOS

Removed localization key `incdOnboarding.curp.add.generate`.

Renamed localization keys:
* `incdOnboarding.curp.generation.last.name.placeholder` -> `incdOnboarding.curp.generation.first.last.name.placeholder`
* `incdOnboarding.curp.generation.name.placeholder` -> `incdOnboarding.curp.generation.first.name.placeholder`

</Accordion>

## Migration to 4.1.0

<Accordion title="Migration to 4.1.0">

### Upload error screen customization on Android:

If you previously customized the upload error screen, add the following new string resource:

*Add this string:*
```<string name="onboard_sdk_validation_error_button_text">Scan your ID</string>```

*Previous string:*
```<string name="onboard_sdk_id_capture_tutorial_title">Scan your ID</string>```

This string is now used only for customizing the ID Capture V2 tutorial screen title.

### Changed default values in FaceMatch module config on Android (optional)

With the move to UxV2, the showUserExists config is now false by default.

### Migrate any custom ThemeConfiguration to the V2 equivalent on Android

If your previous integration had any UI customization in supported modules through Theme Configuration, these customizations will now need to be migrated to the equivalents in UXv2. See the Migrating Theme Configurations to UXv2 Guide for more details.

</Accordion>

## Migration to 4.0.0

<Accordion title="Migration to 4.0.0">

### Update string resources for the "Need Help" screen in the `IdScan` v2 module on Android

The "Need Help" screen has been redesigned on Android, and the customizable strings have been replaced.
If you override any of the following strings in your app, replace them with the new ones listed below.

No action is required if you do not override these strings.

#### Replaced string resources

Replace overrides of:

```xml
<string name="onboard_sdk_id_capture_help_title">Need help?</string>
<string name="onboard_sdk_id_capture_help_subtitle">Some considerations</string>
<string name="onboard_sdk_id_capture_help_manual_photo_button_text">Take the photo manually</string>
<string name="onboard_sdk_id_capture_help_align_title">Center your document in the frame</string>
<string name="onboard_sdk_id_capture_help_align_subtitle">The photo will be taken automatically</string>
<string name="onboard_sdk_id_capture_help_blur_title">Avoid blurriness on the document</string>
<string name="onboard_sdk_id_capture_help_blur_subtitle">Zoom in and out, or tap on the document</string>
<string name="onboard_sdk_id_capture_help_glare_title">Avoid glare on the document</string>
<string name="onboard_sdk_id_capture_help_glare_subtitle">Find a better lighting to avoid reflections</string>
<string name="onboard_sdk_id_capture_help_darkness_title">Avoid darkness on the document</string>
<string name="onboard_sdk_id_capture_help_darkness_subtitle">Find a place with better lighting</string>
```

with:

```xml
<string name="onboard_sdk_id_capture_common_issues_title">Common issues</string>
<string name="onboard_sdk_id_capture_common_issues_glare_title">Glare present</string>
<string name="onboard_sdk_id_capture_common_issues_glare_subtitle">Tilt the ID slightly up or down to minimize the reflection</string>
<string name="onboard_sdk_id_capture_common_issues_blur_title">Blur present</string>
<string name="onboard_sdk_id_capture_common_issues_blur_subtitle">Move ID further away or closer to your phone until the image is focused</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_title">Info is not readable</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_subtitle">Minimize camera shake by holding your phone steady</string>
<string name="onboard_sdk_id_capture_common_issues_try_again_button">@string/onboard_sdk_try_again</string>
```

### Upgrade compileSdk on Android

With the update of the internal CameraX dependencies, you will need to upgrade your project's `compileSdk` to level 35:

```groovy
compileSdk 35
```

### Update Gradle Wrapper on Android

Android Gradle Wrapper `8.6.0` requires Gradle `8.7` or higher.
Update your Gradle wrapper configuration in `gradle/wrapper/gradle-wrapper.properties`:

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
```

### If you use any of the following optional dependencies on Android, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:nfc:1.5.2'
```

### Response Key Name Changes (Breaking Changes)

This version introduces **breaking changes** to ensure cross-platform consistency between Android and iOS response structures. The following response keys have been renamed:

#### Phone Number Module
**Before:**
```javascript
{
  "phone": {
    "phone": "+1234567890"
  }
}
```

**After:**
```javascript
{
  "phoneData": {
    "phone": "+1234567890"
  }
}
```

**Migration:** Update your code to use `phoneData` instead of `phone` when accessing phone number results.

```diff
  cordova.exec(function(winParam) {
-   const phoneNumber = winParam.phone.phone;
+   const phoneNumber = winParam.phoneData.phone;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"addPhone"}]);
```

#### Signature Module
**Before:**
```javascript
{
  "signaturePath": {
    "status": "success"
  }
}
```

**After:**
```javascript
{
  "signatureData": {
    "status": "success"
  }
}
```

**Migration:** Update your code to use `signatureData` instead of `signaturePath` when accessing signature results.

```diff
  cordova.exec(function(winParam) {
-   const status = winParam.signaturePath.status;
+   const status = winParam.signatureData.status;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"addSignature"}]);
```

#### Face Match Module - Existing User Field
**Before:**
```javascript
{
  "faceMatchData": {
    "status": "match",
    "confidence": 1,
    "isExistingUser": true,
    "isFaceMatched": true,
    "isNameMatched": true
  }
}
```

**After:**
```javascript
{
  "faceMatchData": {
    "status": "match",
    "confidence": 1,
    "existingUser": true,
    "isFaceMatched": true,
    "isNameMatched": true
  }
}
```

**Migration:** Update your code to use `existingUser` instead of `isExistingUser` when accessing face match results.

```diff
  cordova.exec(function(winParam) {
-   const isExisting = winParam.faceMatchData.isExistingUser;
+   const isExisting = winParam.faceMatchData.existingUser;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"addFaceMatch"}]);
```

#### Geolocation Module
**Before:**
```javascript
{
  "geodata": {
    "addressFields": {
      "city": "Belgrade",
      "colony": "Zvezdara",
      "postalCode": "",
      "street": "Banjska",
      "state": ""
    }
  }
}
```

**After:**
```javascript
{
  "geoLocationData": {
    "addressFields": {
      "city": "Belgrade",
      "colony": "Zvezdara",
      "postalCode": "",
      "street": "Banjska",
      "state": ""
    }
  }
}
```

**Migration:** Update your code to use `geoLocationData` instead of `geodata` when accessing geolocation results.

```diff
  cordova.exec(function(winParam) {
-   const city = winParam.geodata.addressFields.city;
+   const city = winParam.geoLocationData.addressFields.city;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"addGeolocation"}]);
```

#### User Consent Module (New Standardized Key)
**Before:**
```javascript
// User consent result was previously returned inconsistently or not at all
```

**After:**
```javascript
{
  "userConsentData": {
    "status": true
  }
}
```

**Migration:** If you're using the user consent module, the result is now consistently returned under the `userConsentData` key on both platforms.

```javascript
  cordova.exec(function(winParam) {
    const consentGiven = winParam.userConsentData.status;
    // Process consent status
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [
    {"module":"addUserConsent", "title":"Privacy Policy", "content":"..."}
  ]);
```

### Why These Changes?

These changes ensure that the JavaScript layer receives identical response structures from both Android and iOS platforms, making it easier to write cross-platform code without platform-specific conditionals.

#### Document Validation Module - `documentData` Structure

**After (Version 4.0.0):**
```javascript
{
  "documentData": {
    "type": "addressStatement",     
    "image": "<base64String>",      
    "address": {                    
      "city": "",
      "colony": "",
      "postalCode": "",
      "street": "",
      "state": ""
    },
    "data": "<rawData>"            
  }
}
```

**Migration:** The structure is now standardized with clear field names. The `type` field indicates the document type (e.g., "addressStatement", "medicalDoc", "paymentProof"), `image` contains the base64-encoded image, and `address` contains structured address information when available.

#### ID Scan Module - `frontIdData` and `backIdData` Structure

**Before:**
```javascript
{
  "frontIdData": {
    "scanStatus": "success",
    "idImageBase64": "<base64String>",
    // ... other Gson-serialized fields
  }
}
```

**After (Version 4.0.0):**
```javascript
{
  "frontIdData": {
    "status": "ok",                   // Renamed from 'scanStatus'. On success: "ok", on error: "unknown", "errorClassification", "errorGlare", "errorSharpness", "errorReadability", "errorInCapture" (iOS only), "errorUnacceptableID" (iOS only), "wrongSide" (iOS only)
    "image": "<base64String>",        // Renamed from 'idImageBase64'
    "classifiedIdType": "ID",         // Classified document type
    "idCategory": "primary",          // 'primary' or 'secondary'
    "chosenIdType": "id"             // Chosen ID type: 'id' or 'passport'
  }
}
```

**Migration:** Update your code to use the new field names:

```diff
  cordova.exec(function(winParam) {
-   const scanStatus = winParam.frontIdData.scanStatus;
+   const scanStatus = winParam.frontIdData.status;
-   const idImage = winParam.frontIdData.idImageBase64;
+   const idImage = winParam.frontIdData.image;
+   const idCategory = winParam.frontIdData.idCategory;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"addFrontId"}]);
```

**Note:** The same structure applies to `backIdData`.

#### ID Process Module - `processIdData` Structure

**After (Version 4.0.0):**
```javascript
{
  "processIdData": {
    "extendedOcrData": "<jsonString>",  // Extended OCR data as JSON string
    "data": {                            // Structured OCR data
      "address": {                       // Address fields
        "city": "",
        "colony": "",
        "postalCode": "",
        "street": "",
        "state": ""
      },
      "fullAddress": "",                 // Complete address string
      "birthDate": 0,                    // Timestamp in milliseconds
      "expirationDate": 0,               // Unix timestamp
      "gender": "",
      "name": "",                        // Full name
      "issueDate": 0,                    // Unix timestamp
      "numeroEmisionCredencial": ""      // Credential emission number
    }
  }
}
```

**Migration:** The OCR data is now structured with clear field names and types. Date fields are provided as timestamps for easier manipulation. Access the structured data through the `data` field:

```javascript
cordova.exec(function(winParam) {
  const ocrData = winParam.processIdData.data;
  const fullName = ocrData.name;
  const birthDate = new Date(ocrData.birthDate);
  const address = ocrData.address.city;
}, function(err) {
  console.log("Error: "+ err);
}, "Cplugin", "startOnboardingSection", [{"module":"processId"}]);
```

#### Selfie Scan Module - `selfieData` Structure

**After (Version 4.0.0):**
```javascript
{
  "selfieData": {
    "status": "success",           
    "image": "<base64String>",     
    "spoofAttempt": false         
  }
}
```

**Migration:** The structure now includes explicit status and spoof detection fields for better fraud prevention handling.

#### Government Validation Module - `govresult` Structure

**Before:**
```javascript
{
  "govresult": true  
}
```

**After (Version 4.0.0):**
```javascript
{
  "govresult": {
    "status": true  
  }
}
```

**Migration:** Update your code to access the status field within the govresult object:

```diff
  cordova.exec(function(winParam) {
-   const isValidated = winParam.govresult;
+   const isValidated = winParam.govresult.status;
  }, function(err) {
    console.log("Error: "+ err);
  }, "Cplugin", "startOnboardingSection", [{"module":"governmentValidation"}]);
```

#### Approve Module - `approveData` Structure

**After (Version 4.0.0):**
```javascript
{
  "approveData": {
    "status": "approved",           
    "id": "<uuid>",                 
    "customerToken": "<token>"     
  }
}
```

**Migration:** The approve result is now structured with clear field names. Previously all fields from the ApproveResult object were serialized via Gson. Now only the essential fields are exposed with consistent naming.

```javascript
cordova.exec(function(winParam) {
  const approvalStatus = winParam.approveData.status;
  const sessionId = winParam.approveData.id;
  const token = winParam.approveData.customerToken;
}, function(err) {
  console.log("Error: "+ err);
}, "Cplugin", "startOnboardingSection", [{"module":"approve"}]);
```

#### NFC Scan Module - `nfcData` Structure

**After (Version 4.0.0):**
```javascript
{
  "nfcData": {
    "birthDate": "",                        
    "compositeCheckDigit": "",              
    "dateOfBirthCheckDigit": "",            
    "documentCode": "",                     
    "documentNumber": "",                  
    "documentNumberCheckDigit": "",          
    "expirationDateCheckDigit": "",         
    "expireAt": "",                         
    "gender": "",                           
    "issuingStateOrOrganization": "",       
    "nationality": "",                      
    "optionalData1": "",                    
    "optionalData2": "",                    
    "personalNumber": "",                   
    "personalNumberCheckDigit": "",         
    "primaryIdentifier": "",                
    "secondaryIdentifier": "",              
    "status": true                          
  }
}
```

**Migration:** The NFC data structure provides comprehensive passport/ID chip information read from NFC-enabled documents. All fields are extracted from the MRZ (Machine Readable Zone) and chip data.

</Accordion>

## Migration to 3.0.0

<Accordion title="Migration to 3.0.0">

- It is mandatory that all sample apps now have to provide a source from where to fetch Incode's Android dependency from. For suggested method please check out the README.md [page](/sdk-reference/cordova-sdk/) and its Additional Steps for Android section.

</Accordion>

## Migration to 2.9.0

<Accordion title="Migration to 2.9.0">

### Optional dependencies
For Android, if you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:video-streaming:1.6.0'
implementation 'com.incode.sdk:extensions:1.2.1'
implementation 'com.incode.sdk:model-face-recognition:3.5.1'
implementation 'com.incode.sdk:model-id-face-detection:3.5.1'
implementation 'com.incode.sdk:model-liveness-detection:3.2.1'
```

### Android minSdk changes
For Android, if you use the video-streaming dependency, you need to upgrade your minSdk to 24 or higher. The requirement is coming from the OpenTok dependency, which now requires a minimum SDK version of 24. This update is necessary to ensure compatibility with the 16KB page size support mandated by Google starting from November 1st 2025. More info (https://developer.android.com/guide/practices/page-sizes).

</Accordion>

## Migration to 2.7.0

<Accordion title="Migration to 2.7.0">

For Android, if you use any of the following optional dependencies, make sure to update to the latest versions
```groovy
implementation 'com.incode.sdk:model-face-recognition:3.5.0'
implementation 'com.incode.sdk:model-id-face-detection:3.5.0'
```
The `qr-face-login` dependency is no longer available and has been removed in this version of the SDK. Please update your project configuration accordingly.
Remove the `qr-face-login` dependency from your `build.gradle`:

- Update Android `minSdkVersion` in you Android projects's `build.gradle`:

```diff
  buildscript {
    ext {
-    minSdkVersion = 21
+    minSdkVersion = 23
    }
  }

```

Remove `com.incode.sdk:camera:1.1.0` dependency in your app’s `build.gradle` file:

```diff
  dependencies {
-    implementation 'com.incode.sdk:camera:1.1.0'
  }
```

</Accordion>

## Migration to 2.5.0

<Accordion title="Migration to 2.5.0">

- Update Android to `compileSdk=34`. It can be done by updating `cordova-android` package in `package.json`:

```diff
+ "cordova-android": "^13.0.0",
```

- Update iOS deployment target to minimum version `13.0` and swift version to `5.0`. Update `config.xml`:

```diff
+ <platform name="ios">
+    <preference name="SwiftVersion" value="5.0" />
+    <preference name="deployment-target" value="13.0" />
+ </platform>
```

</Accordion>

---

- Path: `release-notes/de-german`
- URL: https://developer.incode.com/release-notes/de-german/
- Markdown: https://developer.incode.com/release-notes/de-german.md

# DE - German

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Geburtsurkunde`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Währung`
* `capturePreview.acceptedDocuments.DriversLicense` = `Führerschein`
* `capturePreview.acceptedDocuments.FederalID` = `Bundesausweis`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Identifikationskarte`
* `capturePreview.acceptedDocuments.label` = `Akzeptierte Dokumente für:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Medizinische Karte`
* `capturePreview.acceptedDocuments.Military` = `Militär`
* `capturePreview.acceptedDocuments.noDocuments` = `Für dieses Land werden keine Dokumente akzeptiert. `
* `capturePreview.acceptedDocuments.Other` = `Andere`
* `capturePreview.acceptedDocuments.Passport` = `Reisepass`
* `capturePreview.acceptedDocuments.Permit` = `Erlaubnis`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Aufenthalt Dokument`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Steuerliche Identifizierung`
* `capturePreview.acceptedDocuments.TravelDocument` = `Reisedokument`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Stammesangehörige Identifikation`
* `capturePreview.acceptedDocuments.Unknown` = `Unbekannt`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Fahrzeugzulassung`
* `capturePreview.acceptedDocuments.Visa` = `Visum`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Wähleridentifikation`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Waffenschein`
* `common.refreshPage` = `Auffrischen`
* `commonIssues.idv2.tryAgain` = `Ok, versuchen Sie es noch einmal`
* `errors.dynamicImport.failedToLoad` = `Ein unerwarteter Fehler, aber wir haben ihn zur Kenntnis genommen:`
* `errors.dynamicImport.suggestion` = `Wir versuchen es erneut unter {{count}} oder Sie können manuell aktualisieren`
* `errors.dynamicImport.title` = `Entschuldigung, wir haben ein Problem`
* `idv2.capture.autoCapture` = `Das Foto wird automatisch aufgenommen`
* `idv2.capture.dontMove` = `Bewegen Sie Ihren Ausweis ein paar Sekunden lang nicht.`
* `idv2.capture.fillFrame` = `Füllen Sie den Rahmen mit Ihrer ID`
* `idv2.capture.fillFramePassport` = `Füllen Sie den Rahmen mit Ihrem Reisepass`
* `idv2.capture.manualCapture.ariaLabel` = `Manuelle Erfassung`
* `idv2.capture.manualCapture.title` = `Manuelle Aufnahmetaste`
* `idv2.capture.notifications.blur.description` = `Vergrößern und verkleinern, oder tippen Sie auf die ID`
* `idv2.capture.notifications.blur.title` = `ID zu unscharf`
* `idv2.capture.notifications.glare.description` = `Finden Sie eine bessere Beleuchtung, um Reflexionen zu vermeiden.`
* `idv2.capture.notifications.glare.title` = `ID mit Blendung`
* `idv2.capture.notifications.notAligned.description` = `Zentrieren Sie Ihre ID innerhalb des Rahmens`
* `idv2.capture.notifications.notAligned.title` = `ID ist nicht ausgerichtet`
* `idv2.capture.notifications.showBack.description` = `Drehen Sie Ihren Ausweis um, damit er die Rückseite zeigt.`
* `idv2.capture.notifications.showBack.title` = `Zeigen Sie die Rückseite des Ausweises`
* `idv2.capture.notifications.showFront.description` = `Drehen Sie Ihren Ausweis um, damit er die Vorderseite zeigt.`
* `idv2.capture.notifications.showFront.title` = `Zeigen Sie die Vorderseite des Ausweises`
* `idv2.capture.passport.subtitle` = `Stellen Sie sicher, dass Ihr Reisepass lesbar ist`
* `idv2.capture.passport.title` = `Scannen Sie Ihren Reisepass`
* `idv2.capture.processing.analyzing` = `Analysieren...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} verbleibende Versuche`
* `idv2.capture.processing.continue` = `Weiter`
* `idv2.capture.processing.error` = `Fehler`
* `idv2.capture.processing.errors.classification.subtitle` = `Bitte stellen Sie sicher, dass der gesamte Ausweis sichtbar und gut beleuchtet ist.`
* `idv2.capture.processing.errors.classification.title` = `ID-Überprüfung fehlgeschlagen`
* `idv2.capture.processing.errors.default.subtitle` = `Bitte versuchen Sie es erneut`
* `idv2.capture.processing.errors.default.title` = `Es gab ein Problem`
* `idv2.capture.processing.errors.glare.subtitle` = `Neigen Sie den Ausweis leicht nach oben oder unten, um die Reflexion zu minimieren.`
* `idv2.capture.processing.errors.glare.title` = `Blendung vorhanden`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimieren Sie Kameraverwacklungen, indem Sie Ihr Telefon ruhig halten.`
* `idv2.capture.processing.errors.readability.title` = `Info ist nicht lesbar`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Bewegen Sie die ID weiter weg oder näher an Ihr Handy heran, bis das Bild scharf ist.`
* `idv2.capture.processing.errors.sharpness.title` = `Unschärfe vorhanden`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Bitte versuchen Sie es mit einem anderen Dokument`
* `idv2.capture.processing.errors.unacceptable.title` = `ID-Typ wird nicht akzeptiert`
* `idv2.capture.processing.errors.upload.subtitle` = `Bitte überprüfen Sie Ihre Verbindung und versuchen Sie es erneut`
* `idv2.capture.processing.errors.upload.title` = `ID-Scan fehlgeschlagen`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Erfassen Sie {{mode}} Seite der ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Falsche ID-Seite erfasst`
* `idv2.capture.processing.scanBack` = `Scannen Sie die Rückseite`
* `idv2.capture.processing.success` = `Erfolg`
* `idv2.capture.processing.successBackSubtitle` = `Jetzt geht es weiter`
* `idv2.capture.processing.successFrontSubtitle` = `Jetzt wollen wir die Rückseite erfassen`
* `idv2.capture.processing.successTitle` = `Erfolgreich bearbeitet!`
* `idv2.capture.processing.tryAgain` = `Erneut versuchen`
* `idv2.capture.takingPhoto` = `Das Fotografieren...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-Hinweis`
* `idv2.chooser.idButtonDescription` = `Nationale Identitätskarte oder Führerschein`
* `idv2.chooser.idButtonTitle` = `Identitätskarte`
* `idv2.chooser.passportButtonDescription` = `Ihr Land Reisepass`
* `idv2.chooser.passportButtonTitle` = `Reisepass`
* `idv2.permissions.alertAlt` = `Warnung vor gefälschten Genehmigungen`
* `idv2.permissions.allow` = `OK, Zulassen`
* `idv2.permissions.denied.allow` = `Erlauben Sie`
* `idv2.permissions.denied.ask` = `Fragen Sie`
* `idv2.permissions.denied.browser` = `Browser`
* `idv2.permissions.denied.camera` = `Kamera`
* `idv2.permissions.denied.changeTo` = `Wechseln zu`
* `idv2.permissions.denied.open` = `Öffnen Sie`
* `idv2.permissions.denied.or` = `oder`
* `idv2.permissions.denied.refreshPage` = `Seite aktualisieren`
* `idv2.permissions.denied.return` = `Kehren Sie hierher zurück und drücken Sie`
* `idv2.permissions.denied.scroll` = `Scrollen Sie nach unten und wählen Sie`
* `idv2.permissions.denied.settings` = `Einstellungen`
* `idv2.permissions.denied.tap` = `Tippen Sie auf .`
* `idv2.permissions.denied.title` = `Folgen Sie den nächsten Schritten, um Incode den Zugriff auf Ihre Kamera zu ermöglichen`
* `idv2.permissions.denied.yourBrowser` = `Ihr Browser`
* `idv2.permissions.description` = `um den Vorgang abzuschließen`
* `idv2.permissions.dontAllow` = `Erlauben Sie nicht`
* `idv2.permissions.fakeDenied.alert` = `alert fake fokussiert`
* `idv2.permissions.fakeDenied.allowPermissions` = `Berechtigungen zulassen`
* `idv2.permissions.fakeDenied.quitProcess` = `Beenden des Prozesses`
* `idv2.permissions.fakeDenied.title` = `Für Ihre Dokumentenerfassung ist eine Kameraerlaubnis erforderlich`
* `idv2.permissions.fakeDenied.warning` = `Warnung`
* `idv2.permissions.note` = `Hinweis: Je nach Handy kann es sein, dass es heißt`
* `idv2.permissions.or` = `oder`
* `idv2.permissions.subtitle` = `Kamerazulassung erlauben`
* `idv2.permissions.title` = `Wir brauchen Sie, um`
* `idv2.permissions.whileUsing` = `Während der Nutzung der App`
* `idv2.tutorial.autoCapture` = `Das Foto wird automatisch aufgenommen`
* `idv2.tutorial.startScan` = `Scannen wir`
* `idv2.tutorial.subtitle` = `Stellen Sie sicher, dass Ihre ID lesbar ist`
* `idv2.tutorial.title` = `Scannen Sie Ihre ID`
* `idv2.uploading.analyzing` = `Analysieren...`
* `idv2.uploading.imageAlt` = `ID-Erfassung`
* `onboarding.errors.restartDisabled.message` = `Sitzungsneustart auf Organisationsebene deaktiviert`
* `onboarding.errors.restartDisabled.title` = `Sitzung kann nicht neu gestartet werden`
* `qes.signatureCheck` = `Ich erkläre mich mit der Ausstellung der erforderlichen Bescheinigung und mit der elektronischen Unterzeichnung dieses Dokuments einverstanden.`
* `qes.termsCheck` = `Ich habe die <2>Datenschutzrichtlinien</2> von Incode und die <6>Nutzungsbedingungen</6> von Incode gelesen und stimme diesen zu.`

## ✏️ Modified

* `commonIssues.infoNotReadable`:
  * Before: `Info ist nicht lesbar`
  * Now: `Info nicht lesbar`
* `commonIssues.takeManually`:
  * Before: `Nehmen Sie das Foto manuell auf`
  * Now: `Manuelles Fotografieren`
* `commonIssues.tryAgain`:
  * Before: `Ok, versuchen Sie es noch einmal`
  * Now: `Erneut versuchen`
* `ineCheck.verified`:
  * Before: `Identität bestätigt!`
  * Now: `Zur Überprüfung vorgelegte Identität`
* `notifications.done`:
  * Before: `Erledigt`
  * Now: `Scan abgeschlossen`
* `notifications.glareDetected`:
  * Before: `Blendung vorhanden`
  * Now: `Blendung erkannt`
* `notifications.glareDetectedDescription`:
  * Before: `Neigen Sie den Ausweis leicht nach oben oder unten, um die Reflexion zu minimieren.`
  * Now: `Finden Sie eine bessere Beleuchtung, um Reflexionen zu vermeiden.`
* `notifications.idTypeUnacceptable`:
  * Before: `ID-Typ wird nicht akzeptiert`
  * Now: `Ungültiges ID-Dokument`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Bitte versuchen Sie es mit einem anderen Dokument`
  * Now: `Versuchen Sie, einen anderen zu scannen`
* `notifications.lowSharpness`:
  * Before: `Unschärfe vorhanden`
  * Now: `Geringe Schärfe`

---

- Path: `release-notes/en-bz-englishbelize`
- URL: https://developer.incode.com/release-notes/en-bz-englishbelize/
- Markdown: https://developer.incode.com/release-notes/en-bz-englishbelize.md

# EN-BZ - English (Belize)

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Birth Certificate`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Currency`
* `capturePreview.acceptedDocuments.DriversLicense` = `Drivers License`
* `capturePreview.acceptedDocuments.FederalID` = `Federal ID`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Identification Card`
* `capturePreview.acceptedDocuments.label` = `Accepted documents for:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Medical Card`
* `capturePreview.acceptedDocuments.Military` = `Military`
* `capturePreview.acceptedDocuments.noDocuments` = `No documents accepted for this country. `
* `capturePreview.acceptedDocuments.Other` = `Other`
* `capturePreview.acceptedDocuments.Passport` = `Passport`
* `capturePreview.acceptedDocuments.Permit` = `Permit`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Residence Document`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Tax Identification`
* `capturePreview.acceptedDocuments.TravelDocument` = `Travel Document`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Tribal Identification`
* `capturePreview.acceptedDocuments.Unknown` = `Unknown`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Vehicle Registration`
* `capturePreview.acceptedDocuments.Visa` = `Visa`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Voter Identification`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Weapon License`
* `common.refreshPage` = `Refresh`
* `commonIssues.idv2.tryAgain` = `Ok, try again`
* `errors.dynamicImport.failedToLoad` = `Something unexpected error but we took note of it:`
* `errors.dynamicImport.suggestion` = `We'll try again in {{count}} or you can manually refresh`
* `errors.dynamicImport.title` = `Sorry, we encountered an issue`
* `idv2.capture.autoCapture` = `The photo will be taken automatically`
* `idv2.capture.dontMove` = `Don't move your ID for a few seconds`
* `idv2.capture.fillFrame` = `Fill the frame with your ID`
* `idv2.capture.fillFramePassport` = `Fill the frame with your passport`
* `idv2.capture.manualCapture.ariaLabel` = `Manual Capture`
* `idv2.capture.manualCapture.title` = `Manual Capture Button`
* `idv2.capture.notifications.blur.description` = `Zoom in and out, or tap on the ID`
* `idv2.capture.notifications.blur.title` = `ID too blurry`
* `idv2.capture.notifications.glare.description` = `Find a better lighting to avoid reflections`
* `idv2.capture.notifications.glare.title` = `ID with glare`
* `idv2.capture.notifications.notAligned.description` = `Center your ID inside the frame`
* `idv2.capture.notifications.notAligned.title` = `ID is not aligned`
* `idv2.capture.notifications.showBack.description` = `Flip your ID to show its reverse side`
* `idv2.capture.notifications.showBack.title` = `Show the back of ID`
* `idv2.capture.notifications.showFront.description` = `Flip your ID to show its front side`
* `idv2.capture.notifications.showFront.title` = `Show the front of ID`
* `idv2.capture.passport.subtitle` = `Ensure your Passport is readable`
* `idv2.capture.passport.title` = `Scan your passport`
* `idv2.capture.processing.analyzing` = `Analyzing...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} attempts remaining`
* `idv2.capture.processing.continue` = `Continue`
* `idv2.capture.processing.error` = `Error`
* `idv2.capture.processing.errors.classification.subtitle` = `Please ensure entire ID is visible and well lit`
* `idv2.capture.processing.errors.classification.title` = `ID verification failed`
* `idv2.capture.processing.errors.default.subtitle` = `Please try again`
* `idv2.capture.processing.errors.default.title` = `There was a problem`
* `idv2.capture.processing.errors.glare.subtitle` = `Tilt the ID slightly up or down to minimize the reflection`
* `idv2.capture.processing.errors.glare.title` = `Glare present`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimize camera shake by holding your phone steady`
* `idv2.capture.processing.errors.readability.title` = `Info is not readable`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Move ID further away or closer to your phone until the image is focused`
* `idv2.capture.processing.errors.sharpness.title` = `Blur present`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Please try with a different document`
* `idv2.capture.processing.errors.unacceptable.title` = `ID type is not accepted`
* `idv2.capture.processing.errors.upload.subtitle` = `Please check your connection and try again`
* `idv2.capture.processing.errors.upload.title` = `ID scan failed`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capture {{mode}} side of the ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Wrong ID side captured`
* `idv2.capture.processing.scanBack` = `Scan the back`
* `idv2.capture.processing.success` = `Success`
* `idv2.capture.processing.successBackSubtitle` = `Now let's continue`
* `idv2.capture.processing.successFrontSubtitle` = `Now let's capture the back`
* `idv2.capture.processing.successTitle` = `Successfully processed!`
* `idv2.capture.processing.tryAgain` = `Try again`
* `idv2.capture.takingPhoto` = `Taking photo...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `National Identity Card, or Driver's License`
* `idv2.chooser.idButtonTitle` = `Identity Card`
* `idv2.chooser.passportButtonDescription` = `Your country Passport`
* `idv2.chooser.passportButtonTitle` = `Passport`
* `idv2.permissions.alertAlt` = `fake permission alert`
* `idv2.permissions.allow` = `OK, Allow`
* `idv2.permissions.denied.allow` = `Allow`
* `idv2.permissions.denied.ask` = `Ask`
* `idv2.permissions.denied.browser` = `Browser`
* `idv2.permissions.denied.camera` = `Camera`
* `idv2.permissions.denied.changeTo` = `Change to`
* `idv2.permissions.denied.open` = `Open`
* `idv2.permissions.denied.or` = `or`
* `idv2.permissions.denied.refreshPage` = `Refresh page`
* `idv2.permissions.denied.return` = `Return here and press`
* `idv2.permissions.denied.scroll` = `Scroll down to select`
* `idv2.permissions.denied.settings` = `Settings`
* `idv2.permissions.denied.tap` = `Tap`
* `idv2.permissions.denied.title` = `Follow the next steps to allow Incode to access your camera`
* `idv2.permissions.denied.yourBrowser` = `your browser`
* `idv2.permissions.description` = `in order to complete the process`
* `idv2.permissions.dontAllow` = `Don't Allow`
* `idv2.permissions.fakeDenied.alert` = `alert fake focused`
* `idv2.permissions.fakeDenied.allowPermissions` = `Allow permissions`
* `idv2.permissions.fakeDenied.quitProcess` = `Quit process`
* `idv2.permissions.fakeDenied.title` = `Camera permission is required for your document capture`
* `idv2.permissions.fakeDenied.warning` = `warning`
* `idv2.permissions.note` = `Note: Depending on your phone, it may say`
* `idv2.permissions.or` = `or`
* `idv2.permissions.subtitle` = `allow camera permission`
* `idv2.permissions.title` = `We need you to`
* `idv2.permissions.whileUsing` = `While using the app`
* `idv2.tutorial.autoCapture` = `The photo will be taken automatically`
* `idv2.tutorial.startScan` = `Let's scan`
* `idv2.tutorial.subtitle` = `Ensure your ID is readable`
* `idv2.tutorial.title` = `Scan your ID`
* `idv2.uploading.analyzing` = `Analyzing...`
* `idv2.uploading.imageAlt` = `ID capture`
* `onboarding.errors.restartDisabled.message` = `Session restart disabled on Organization level`
* `onboarding.errors.restartDisabled.title` = `Can't restart session`
* `qes.signatureCheck` = `I agree to the issuance of the required certificate and to signing this document electronically.`
* `qes.termsCheck` = `I have read and agree to Incode’s <2>Privacy Policy</2> and Incode’s <6>Terms of Use</6>.`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Before: `Common Issues`
  * Now: `Common issues`
* `commonIssues.infoNotReadable`:
  * Before: `Info is not readable`
  * Now: `Info not readable`
* `commonIssues.takeManually`:
  * Before: `Take the photo manually`
  * Now: `Take photo manually`
* `commonIssues.tryAgain`:
  * Before: `Ok, try again`
  * Now: `Try again`
* `ineCheck.verified`:
  * Before: `Identity verified!`
  * Now: `Identity submitted for verification`
* `notifications.done`:
  * Before: `Done`
  * Now: `Scan completed`
* `notifications.glareDetected`:
  * Before: `Glare present`
  * Now: `Glare detected`
* `notifications.glareDetectedDescription`:
  * Before: `Tilt the ID slightly up or down to minimize the reflection`
  * Now: `Find a better lighting to avoid reflections`
* `notifications.idTypeUnacceptable`:
  * Before: `ID type is not accepted`
  * Now: `Invalid ID document`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Please try with a different document`
  * Now: `Try scanning a different one`
* `notifications.lowSharpness`:
  * Before: `Blur present`
  * Now: `Low sharpness`

---

- Path: `release-notes/en-english`
- URL: https://developer.incode.com/release-notes/en-english/
- Markdown: https://developer.incode.com/release-notes/en-english.md

# EN - English

## 🆕 Added

* `idv2.permissions.fakeDenied.alert` = `alert fake focused`
* `idv2.permissions.fakeDenied.allowPermissions` = `Allow permissions`
* `idv2.permissions.fakeDenied.quitProcess` = `Quit process`
* `idv2.permissions.fakeDenied.title` = `Camera permission is required for your document capture`
* `idv2.permissions.fakeDenied.warning` = `warning`

---

- Path: `release-notes/en-english-1`
- URL: https://developer.incode.com/release-notes/en-english-1/
- Markdown: https://developer.incode.com/release-notes/en-english-1.md

# EN - English

## 🆕 Added

* `documentCapture.multiPageDocument.step1.description` = `Make sure the entire document is in the frame`
* `documentCapture.multiPageDocument.step1.title` = `Prepare first page`
* `documentCapture.multiPageDocument.step2.description` = `Make sure the entire document is in the frame`
* `documentCapture.multiPageDocument.step2.title` = `Prepare second page`
* `face.tutorial.startCapture` = `Take selfie`
* `face.tutorial.subtitle` = `This allows you to sign in using your face.`
* `face.tutorial.title` = `Take a selfie`
* `idv2.flipAnimation.title` = `Show the back of your ID`

---

- Path: `release-notes/en-english-10`
- URL: https://developer.incode.com/release-notes/en-english-10/
- Markdown: https://developer.incode.com/release-notes/en-english-10.md

# EN - English

## 🆕 Added

* `aes.confirmSignature.finishSigning` = `Finish signing`
* `aes.reviewDocument.subtitle` = `Make sure you've selected the correct file before you continue to sign.`
* `aes.reviewDocument.title` = `Review your document`
* `biometricConsent. consentOptions` = `Consent Options`
* `common.done` = `Done!`
* `common.wontTakeLong` = `This won't take long`
* `curp.verifyManually` = `Verify Manually`
* `customFields.completed` = `Completed!`
* `customFields.continue` = `Continue`
* `customFields.processing` = `Processing...`
* `customFields.title` = `Enter your information`
* `customWatchlist.done` = `Done!`
* `customWatchlist.wontTake` = `This won't take long`
* `digilocker.denied.tryAgain` = `Try again`
* `documentCapture.button.allPagesCaptured` = `All pages captured`
* `documentCapture.button.nextPage` = `Next page`
* `documentCapture.tutorial.continue` = `Continue`
* `documentCapture.tutorial.multiPageDocument.optionalPage.subtitle` = `If there’s another page with relevant information, you can capture it now.`
* `ekyb.addAnotherDirector` = `Add another Director (Optional)`
* `ekyb.directorNameWithNumber` = `Director {{number}} Name`
* `ekyb.directorSurnameWithNumber` = `Director {{number}} Surname`
* `ekyb.error.taxId-cn` = `Enter a valid Chinese Unified Social Credit Code (18 alphanumeric characters)`
* `ekyb.error.taxId-de` = `Enter a valid German tax ID: VAT (DE + 9 digits), HRB (3–6 digits), HRB (6 digits + letter), or HRA (4–6 digits)`
* `ekyb.error.taxId-es` = `Enter a valid Spanish tax ID: NIF (letter + 8 digits), NIE (letter + 7 digits + letter), or DNI (8 digits + letter)`
* `ekyb.error.taxId-gb` = `Enter a valid UK tax ID: Registration Number (7–8 digits) or VAT Number (GB followed by 9 digits, or 9 digits alone)`
* `ekyb.error.taxId-il` = `Enter a valid Israeli Mispar Osek (9 digits)`
* `ekyb.error.taxId-it` = `Enter a valid Italian tax ID: CCIAA/NREA (2 letters + 6–7 digits), company ID (IT + 8 digits), or tax code/VAT (11 digits)`
* `ekyb.error.taxId-mx` = `Enter a valid Mexican RFC: Individual (4 letters + 6 digits + 3 alphanumeric) or Business (3 letters + 6 digits + 3 alphanumeric)`
* `ekyb.error.taxId-ng` = `Enter a valid Nigerian tax ID (10 digits)`
* `ekyb.error.taxId-nl` = `Enter a valid Dutch tax ID: VAT number (NL + 9 digits + B + 2 digits) or KvK number (8 digits)`
* `email.placeholder` = `Email`
* `forms.placeholder.select` = `Select an option`
* `identityReuse.cta.continue` = `Continue with fast verification`
* `identityReuse.cta.verify` = `Verify using ID`
* `identityReuse.description` = `We will only transfer the data requested by {{companyName}} to complete your verification`
* `identityReuse.subtitle` = `You previously verified with one of our partners. Share your data to save time and verify faster.`
* `identityReuse.title` = `Share your details for a faster verification`
* `idOcr.title` = `Please check your data`
* `idv2.capture.expiredId.idScanFailed` = `ID scan failed`
* `idv2.capture.expiredId.pleaseTryWithADifferentId` = `Please try with a different document`
* `idv2.capture.notifications.idScanFailed` = `ID scan failed`
* `idv2.capture.processing.attemptsRemainingLabel` = `attempts remaining`
* `idv2.capture.processing.noAttemptsRemaining` = `No attempts remaining`
* `idv2.chooser.appleWallet` = `Apple Wallet`
* `idv2.chooser.deviceWalletTag` = `Instant`
* `idv2.chooser.googleWallet` = `Google Wallet`
* `idv2.digilocker.consentDeniedDescription` = `Consent to share documents via DigiLocker was not provided. You can try again or choose another way to verify.`
* `idv2.digilocker.consentDeniedTitle` = `Consent denied`
* `idv2.digilocker.openingDigilockerForAuthentication` = `Opening DigiLocker for authentication..`
* `idv2.digilocker.sessionErrorDescription` = `Unable to restore session. Please restart the verification process.`
* `idv2.digilocker.sessionErrorTitle` = `Session Error`
* `idv2.digilocker.takingYouToDigilocker` = `Taking you to DigiLocker..`
* `idv2.digilocker.timeoutDescription` = `The DigiLocker request did not complete within the expected time. Please retry or select an alternate verification method.`
* `idv2.digilocker.timeoutTitle` = `Session timed out..`
* `idv2.digilocker.verificationCompleteTitle` = `Identity successfully verified`
* `idv2.digitalIdUpload.fileTooLargeScreen.cta` = `Choose another file`
* `idv2.digitalIdUpload.fileTooLargeScreen.subtitle` = `The selected file is larger than 5 MB, please upload a smaller one`
* `idv2.digitalIdUpload.fileTooLargeScreen.title` = `File is too large`
* `idv2.permissions.denied.cameraFindSiteAllow` = `Camera <arrow/> Find site <arrow/> Allow`
* `loadingCircle.preparingCamera` = `Preparing camera`
* `manualIdUpload.generic` = `Please upload the correct document`
* `manualIdUpload.glareDetected` = ` Glare present`
* `manualIdUpload.hintIdReadable` = `Ensure text on ID is readable.`
* `manualIdUpload.hintPassportReadable` = `Ensure text on Passport is readable.`
* `manualIdUpload.hintSharpAndGlareFree` = `Photo must be sharp and glare-free.`
* `manualIdUpload.lowSharpness` = `Blur present`
* `manualIdUpload.qualityRejected` = `Image quality is too low.`
* `manualIdUpload.readabilityIssue` = `Info is not readable`
* `manualIdUpload.subtitle` = `Ensure your ID is readable`
* `manualIdUpload.uploadingSubtitle` = `Uploading your file`
* `manualIdUpload.uploadingTitle` = `Hold on a sec...`
* `manualIdUpload.wrongDocument` = `Please upload the correct document`
* `onboarding.errors.onboardingUrlAlreadyUsed.message` = `It looks like this URL is already in use`
* `onboarding.errors.onboardingUrlAlreadyUsed.title` = `Your URL is invalid`
* `otp.resendCodeAvailable` = `You can now resend the code`
* `otp.timerFiveSeconds` = `5 seconds remaining`
* `otp.timerStarted` = `You can request a new code in {{ time }} seconds`
* `otp.timerTenSeconds` = `10 seconds remaining before you can request a new code`
* `otp.verificationCode` = `Verification code`
* `phone.invalidPhone` = `Invalid phone number. Try again.`
* `phone.optIn` = `I agree to receive SMS notifications`
* `phone.serverError` = `Something went wrong. Try again later.`
* `qes.documentsReviewedCheck` = `I confirm that I have reviewed the documents to be signed listed above before signing.`
* `qes.issuanceCheck` = `I agree to the issuance of a Qualified Certificate for electronic signatures by Incode Czech Republic s.r.o., acting as a Qualified Trust Service Provider (QTSP).`
* `qes.newTermsCheck` = `I have read, understood, and agree to the <2>Terms of Use</2> and  <6>Privacy Policy</6> applicable to the issuance and use of this certificate.`
* `qes.qesAcknowledgementCheck` = `I acknowledge that this process will result in a Qualified Electronic Signature (QES), which has the same legal effect as a handwritten signature under EU law (eIDAS, Regulation (EU) 910/2014).`
* `qes.qscdConfirmationCheck` = `I confirm that the signature is created using a Qualified Signature Creation Device (QSCD) and that I maintain sole control over the signing process.`
* `redirect.didntReceiveLinkActions` = `Didn't receive the link? <resend>Resend</resend> or <changePhone>Change phone number</changePhone>`
* `redirect.linkResent` = `Link successfully resent`
* `redirect.linkSentTo` = `To : {{phone}}`
* `signature.fullSignaturePlaceholder` = `Sign here`
* `signature.fullSignatureTitle` = `Draw your signature`
* `signature.initialsPlaceholder` = `Draw your initials here`
* `signature.initialsTitle` = `Write your initials`
* `signature.subtitle` = `Use your finger or mouse`
* `signature.successTitle` = `Signed successfully!`
* `userData.cpf` = `CPF`
* `v2.redirectToMobile.continueOnDesktop` = `Continue on desktop`
* `v2.redirectToMobile.qr.description` = `Scan the QR code to verify on your mobile device.`
* `v2.redirectToMobile.sms.description` = `Enter your phone number to receive a link to verify via SMS`
* `v2.redirectToMobile.sms.sendSms` = `Send link via SMS`
* `v2.redirectToMobile.subtitle` = `You’ll need a valid government-issued ID and a selfie.`
* `v2.redirectToMobile.tabs.0` = `Scan QR`
* `v2.redirectToMobile.tabs.1` = `Send SMS`
* `v2.redirectToMobile.title` = `Verify your identity`
* `v2.settings.language` = `Language`
* `validation.invalidDate` = `Invalid date`
* `verification.errors.countryNotSupported` = `Request unsuccessful. Country not supported for EKYC.`
* `verification.errors.exactly10Characters` = `Must be exactly 10 characters`
* `verification.errors.fieldRequiredDynamic` = `{{fieldName}} is required`
* `verification.errors.idNumRequired` = `National ID number required`
* `verification.errors.invalidPostalCodeFixedLength` = `Please enter a {{length}} digit Postal Code`
* `verification.errors.onlyLettersAndNumbers` = `Only letters and numbers are allowed`
* `verification.errors.taxIdRequired` = `Tax ID is required`
* `verification.labels.panNumber` = `PAN number`
* `watchlistForBusiness.title` = `Watchlist for Business`

## ✏️ Modified

* `aes.confirmSignature.addDocument`:
  * Old: `Add document`
  * New: `Upload document`
* `aes.confirmSignature.fail`:
  * Old: `Something went wrong..`
  * New: `Something went wrong`
* `aes.confirmSignature.subtitle`:
  * Old: `The following documents will be signed`
  * New: `Please accept the terms below to complete your signature.`
* `aes.confirmSignature.terms1.title`:
  * Old: `I accept the terms and conditions of the Trust Center`
  * New: `I accept the terms and conditions of the <2>Trust Center</2>`
* `aes.confirmSignature.title`:
  * Old: `Confirm your signature`
  * New: `Accept and sign`
* `aes.confirmSignature.uploadDescription`:
  * Old: `PDF format supported`
  * New: `Supports PDF files`
* `aes.confirmSignature.viewDocument`:
  * Old: `View doc`
  * New: `View`
* `documentCapture.review.error.description`:
  * Old: `Make sure all the information on the document is clear and legible.`
  * New: `Some pages were unclear or incomplete. Recapture all document pages to continue.`
* `documentCapture.review.error.title`:
  * Old: `Unable to process`
  * New: `Document needs to be recaptured`
* `documentCapture.review.tryAgain`:
  * Old: `Try again`
  * New: `Recapture document`
* `idv2.chooser.digitalIdButtonTitle`:
  * Old: `Digital Id`
  * New: `Digital ID`
* `manualCapture.ariaLabel`:
  * Old: `manual capture button`
  * New: `capture photo`
* `manualIdUpload.uploadPassport`:
  * Old: `Upload passport`
  * New: `Passport`
* `userData.sex`:
  * Old: `Sex`
  * New: `Gender`
* `v2.idError.attemptsLeft_other`:
  * Old: `{{count}} attempt remaining`
  * New: `{{count}} attempts remaining`

---

- Path: `release-notes/en-english-2`
- URL: https://developer.incode.com/release-notes/en-english-2/
- Markdown: https://developer.incode.com/release-notes/en-english-2.md

# EN - English

## 🆕 Added

* `common.attemptsRemaining_other` = `{{count}} attempts remaining`
* `common.attemptsRemaining_one` = `1 attempt remaining`
* `idv2.capture.processing.errors.wrongSide.back.subtitle` = `Capture back side of the ID`
* `idv2.capture.processing.errors.wrongSide.front.subtitle` = `Capture front side of the ID`
* `idv2.needHelp.open` = `Open Need help modal`
* `notifications.centerFaceV2` = `Make sure you align the face within the silhouette`
* `notifications.cropDescription` = `Please try again with your face centered in the frame`
* `notifications.multipleDescription` = `Make sure only one face is visible in the frame`
* `notifications.onFaceAngleV2` = `Align face within the white silhouette`
* `notifications.portraitDescription` = `Please hold your device in portrait mode`
* `notifications.selfie.manualCaptureButtonLabel` = `Manual capture button`
* `notifications.selfie.manualCaptureLabel` = `Manual capture on. Press button to take photo.`
* `notifications.unableToCropDescription` = `Please try again with your face clearly visible`
* `retake.titleFrontLabel` = `Review front ID photo`
* `selfiev2.manualCapture.instructions` = `Center your face in the silhouette and press the button to capture`
* `tutorial.back.titleLabel` = `Now scan the back side of your ID`
* `webviews.step1` = `Go to 'Settings' → 'Apps'`
* `webviews.step2` = `Search for the App`
* `webviews.step3` = `Allow camera permission`

---

- Path: `release-notes/en-english-3`
- URL: https://developer.incode.com/release-notes/en-english-3/
- Markdown: https://developer.incode.com/release-notes/en-english-3.md

# EN - English

## 🆕 Added

* `errors.dynamicImport.suggestion_one` = `We'll try again in {{count}} second or you can manually refresh`
* `errors.dynamicImport.suggestion_other` = `We'll try again in {{count}} seconds or you can manually refresh`
* `idv2.commonIssues.firstStep` = `1. Fill the frame with your ID`
* `idv2.commonIssues.secondStep` = `2. Press the button`
* `verification.labels.gender` = `Gender`
* `verification.labels.idNum` = `National ID Number`
* `verification.labels.idNum1` = `TAX ID Number`

## ✏️ Modified

* `notifications.selfieCaptureFailedDescription`:
  * Before: `We couldn't capture the selfie`
  * Now: `Your selfie will be manually reviewed later`
* `notifications.spoof`:
  * Before: `Selfie capture failed`
  * Now: `Selfie processing failed`
* `notifications.spoofDescription`:
  * Before: `We couldn’t capture selfie. Please try again.`
  * Now: `We couldn’t process your selfie. Please try again`
* `notifications.spoofDescriptionNoTries`:
  * Before: `We couldn’t capture selfie.`
  * Now: `Your selfie will be manually reviewed later`
* `retake.titleBack`:
  * Before: `Review <1>BACK ID</1> photo`
  * Now: `Review BACK ID photo`
* `retake.titleFront`:
  * Before: `Review <1>FRONT ID</1> photo`
  * Now: `Review FRONT ID photo`
* `retake.titlePassport`:
  * Before: `Review <1>PASSPORT</1> photo`
  * Now: `Review PASSPORT photo`
* `selfie.spoof`:
  * Before: `Selfie capture failed`
  * Now: `Selfie processing failed`
* `selfie.spoofDescription`:
  * Before: `We couldn’t capture selfie. Please try again.`
  * Now: `We couldn’t process your selfie. Please try again`
* `tutorial.back.title`:
  * Before: `Now scan the <1>back side</1> of your ID`
  * Now: `Now scan the back side of your ID`
* `videoSelfie.errors.noInternetConnectionDescription`:
  * Before: `Wait for the internet to return to continue the process or connect to an available network`
  * Now: `Wait for the internet to return to continue the process or connect to an available network.`

---

- Path: `release-notes/en-english-4`
- URL: https://developer.incode.com/release-notes/en-english-4/
- Markdown: https://developer.incode.com/release-notes/en-english-4.md

# EN - English

## 🆕 Added

* `documentCapture.skip` = `Skip This Step`
* `idv2.capture.processing.uploading` = `Uploading...`
* `idv2.deepsightPermissions.subtitle` = `permission`
* `idv2.deepsightPermissions.title` = `Allow camera and motion `
* `idv2.permissions.allowPermissionsV2` = `Allow camera permissions`
* `idv2.permissions.inOrderToCompleteTheProcess` = `in order to complete the process`
* `idv2.unacceptedId.acceptedDocuments` = `Accepted documents for:`
* `idv2.unacceptedId.attemptsLeft_other` = `({{count}} attempts left)`
* `idv2.unacceptedId.attemptsLeft_one` = `({{count}} attempt left)`
* `idv2.unacceptedId.birthCertificate` = `Birth Certificate`
* `idv2.unacceptedId.changeMethod` = `Change verification method`
* `idv2.unacceptedId.currency` = `Currency`
* `idv2.unacceptedId.driversLicense` = `Driver's License`
* `idv2.unacceptedId.federalId` = `Federal ID`
* `idv2.unacceptedId.identificationCard` = `Identification Card`
* `idv2.unacceptedId.identificationCardDescription` = `Only INE issued from 2017 onwards.`
* `idv2.unacceptedId.medicalCard` = `Medical Card`
* `idv2.unacceptedId.military` = `Military`
* `idv2.unacceptedId.multipleNationalities` = `Multiple nationalities?`
* `idv2.unacceptedId.noDocuments` = `No documents accepted for this country`
* `idv2.unacceptedId.other` = `Other`
* `idv2.unacceptedId.passport` = `Passport`
* `idv2.unacceptedId.passportDescription` = `Only Passports issued in 2014.`
* `idv2.unacceptedId.permit` = `Permit`
* `idv2.unacceptedId.residenceDocument` = `Residence Document`
* `idv2.unacceptedId.seeDifferentCountry` = `See a different country`
* `idv2.unacceptedId.taxIdentification` = `Tax Identification`
* `idv2.unacceptedId.travelDocument` = `Travel Document`
* `idv2.unacceptedId.tribalIdentification` = `Tribal Identification`
* `idv2.unacceptedId.tryAgain` = `Try again`
* `idv2.unacceptedId.unknown` = `Unknown`
* `idv2.unacceptedId.unknownCountry` = `Unknown`
* `idv2.unacceptedId.vehicleRegistration` = `Vehicle Registration`
* `idv2.unacceptedId.visa` = `Visa`
* `idv2.unacceptedId.voterIdentification` = `Voter Identification`
* `idv2.unacceptedId.weaponLicense` = `Weapon License`
* `notifications.accessDenied` = `Access Denied`
* `notifications.accessDeniedDescription` = `We couldn’t process your selfie. Please try again`
* `notifications.lowQualityImage` = `Low quality conditions`
* `notifications.lowQualityImageDescription` = `Stay still for the capture, and make sure your face is clear and visible`
* `notifications.noAttemptsRemaining` = `No attempts remaining`
* `videoSelfie.processingStep` = `Processing...`

## ✏️ Modified

* `errors.dynamicImport.failedToLoad`:
  * Old: `Something unexpected error but we took note of it:`
  * New: `Some unexpected error happened, but we took note of it:`
* `idv2.capture.processing.errors.unacceptable.subtitle`:
  * Old: `Please try with a different document`
  * New: `Scan another one from the accepted list`
* `idv2.capture.processing.errors.unacceptable.title`:
  * Old: `ID type is not accepted`
  * New: `ID document not accepted`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Tap Camera → Allow`
  * New: `Tap Camera <arrow/> Allow`
* `idv2.permissions.denied.siteSettings`:
  * Old: `Settings → Site settings`
  * New: `Settings <arrow/> Site settings`

---

- Path: `release-notes/en-english-5`
- URL: https://developer.incode.com/release-notes/en-english-5/
- Markdown: https://developer.incode.com/release-notes/en-english-5.md

# EN - English

## 🆕 Added

* `
  desktop.idv2.digitalIdUpload.successfullyProcessed` = `Successfully processed!`
* `email.verified` = `Email verified!`
* `email.verify` = `Verify your email`
* `email.willSendCode` = `We'll send you a code to ensure it's yours`
* `geolocationv2.addressBar` = `On your address bar tap on <strong>AA</strong>`
* `geolocationv2.allowLocationAccess` = `Allow location access`
* `geolocationv2.allowUsing` = `Choose <strong>Allow while using</strong>`
* `geolocationv2.appsBrowser` = `Go to <strong>Apps <arrow/> Your browser</strong>`
* `geolocationv2.appsChrome` = `Go to <strong>Apps <arrow/> Chrome</strong>`
* `geolocationv2.appsFirefox` = `Go to <strong>Apps <arrow/> Firefox</strong>`
* `geolocationv2.appsOpera` = `Go to <strong>Apps <arrow/> Opera</strong>`
* `geolocationv2.choosePermissions` = `Choose <strong>Ask next time</strong> or <strong>While using the app</strong>`
* `geolocationv2.determineLocation` = `We need to determine your current location`
* `geolocationv2.goBackSafari` = `Back to <strong>Settings <arrow/> Safari</strong>`
* `geolocationv2.instructions.allowLocation` = `Allow Location Permissions`
* `geolocationv2.locationOn` = `Make sure <strong>Location Services</strong> is on`
* `geolocationv2.openSettings` = `Open<strong> Settings</strong>`
* `geolocationv2.openSettingsAndroid` = `Open your <strong>device settings</strong>`
* `geolocationv2.permissionsLocation` = `Tap <strong>Permissions <arrow/> Location</strong>`
* `geolocationv2.privacySecurity` = `Open <strong>Privacy & Security</strong>`
* `geolocationv2.refreshPage` = `Refresh page`
* `geolocationv2.returnAndRefresh` = `Return here and <strong>Refresh page</strong>`
* `geolocationv2.scrollDownChrome` = `Scroll down and tap <strong>Chrome</strong>`
* `geolocationv2.scrollDownFirefox` = `Scroll down and tap <strong>Firefox</strong>`
* `geolocationv2.scrollDownOpera` = `Scroll down and tap <strong>Opera</strong>`
* `geolocationv2.skip` = `Skip this step`
* `geolocationv2.tapLocation` = `Tap <strong>Location</strong>`
* `geolocationv2.tapLocationAllow` = `Tap <strong>Location</strong> and choose <strong>Allow</strong>`
* `geolocationv2.tapSettings` = `Tap <strong>Website Settings <arrow/><br>Allow Location Permissions</strong>`
* `idv2.capture.notifications.expiredId` = `Expired ID document`
* `idv2.capture.notifications.useDifferent` = `Use a different ID`
* `idv2.capture.processing.processing` = `Processing...`
* `idv2.capture.processing.scanFront` = `Scan the front`
* `idv2.capture.processing.successBackSubtitleScanFront` = `Now let’s capture the front`
* `idv2.chooser.chooseHowToVerifyTitle` = `Choose how to verify`
* `idv2.chooser.digitalIdUploadButtonTitle` = `Upload Digital ID`
* `idv2.chooser.manualUploadButtonTitle` = `Upload ID`
* `idv2.digitalIdUpload.analyzing` = `Analyzing...`
* `idv2.digitalIdUpload.digitalIdUploadButtonTitle` = `Upload digital ID`
* `idv2.digitalIdUpload.errorScreen.scanId` = `Scan your ID`
* `idv2.digitalIdUpload.loadingSuccess.letsContinue` = `Let's continue`
* `idv2.digitalIdUpload.reviewScreen.description` = `Make sure this is the correct file before you continue verification process.`
* `idv2.digitalIdUpload.reviewScreen.replaceButton` = `Replace file`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton` = `Continue`
* `idv2.digitalIdUpload.reviewScreen.title` = `Review your document`
* `idv2.digitalIdUpload.screenDescription` = `A government-issued PDF file or photo with
   your details, picture and a QR code`
* `idv2.digitalIdUpload.screenTitle` = `Upload your digital ID`
* `idv2.digitalIdUpload.supportedFileTypesCopy` = `PDF file or JPG, PNG photo`
* `idv2.digitalIdUpload.unknownDocumentTypeScreen.errorTitle` = `Couldn’t verify your ID`
* `idv2.digitalIdUpload.wrongDocumentType` = `ID document not accepted`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorSubtitle` = `Use a different ID from the accepted list:`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorTitle` = `ID document not accepted`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.tryAgainButton` = `Try again`
* `idv2.manualUploadLoading.subtitle` = `Uploading your file`
* `idv2.permissions.denied.chrome.fifthStep` = `Then, <strong>refresh the page</strong>`
* `idv2.permissions.denied.chrome.firstStep` = `At the top left of the website <strong>click the lock</strong>`
* `idv2.permissions.denied.chrome.fourthStep` = `Click it, and choose <strong>Allow</strong>`
* `idv2.permissions.denied.chrome.secondStep` = `A small menu will open`
* `idv2.permissions.denied.chrome.thirdStep` = `Look for <strong>Camera</strong>`
* `idv2.permissions.denied.firefox.fifthStep` = `Then, <strong>refresh the page</strong>`
* `idv2.permissions.denied.firefox.firstStep` = `Click the <strong>camera</strong> or the <strong>lock</strong> icon`
* `idv2.permissions.denied.firefox.fourthStep` = `Click it, and choose <strong>Allow</strong>`
* `idv2.permissions.denied.firefox.secondStep` = `A menu will open`
* `idv2.permissions.denied.firefox.thirdStep` = `Look for <strong>Camera</strong>`
* `idv2.permissions.denied.opera.fifthStep` = `Then, <strong>refresh the page</strong>`
* `idv2.permissions.denied.opera.firstStep` = `Click the <strong>lock</strong> icon`
* `idv2.permissions.denied.opera.fourthStep` = `Click it, and choose <strong>Allow</strong>`
* `idv2.permissions.denied.opera.secondStep` = `A small menu will open`
* `idv2.permissions.denied.opera.thirdStep` = `Look for <strong>Camera</strong>`
* `idv2.permissions.denied.safari.fifthStep` = `Click it, and choose <strong>Allow</strong>`
* `idv2.permissions.denied.safari.firstStep` = `At the top left, click <strong>Safari</strong>`
* `idv2.permissions.denied.safari.fourthStep` = `Find where it says <strong>Camera</strong>`
* `idv2.permissions.denied.safari.secondStep` = `Click <strong>Settings for This Website…</strong>`
* `idv2.permissions.denied.safari.sixthStep` = `Then, <strong>refresh the page</strong>`
* `idv2.permissions.denied.safari.thirdStep` = `A box will pop up`
* `nameCapturev2.title` = `Enter your name`
* `nameCapturev2.verified` = `Name verified!`
* `otp.didntReceive` = `Didn’t receive the code?`
* `otp.enterCodeEmail` = `Enter the code we've sent to your email`
* `otp.errorv2` = `Code expired, please try again`
* `otp.resendCode` = `Resend code`
* `otp.resendCountdown` = `Resend code in <strong>{{time}}s</strong>`
* `redirect.didntReceive` = `Didn’t receive the link?`
* `redirect.enterPhoneNumber` = `Enter your phone number to receive a link to verify via SMS`
* `redirect.linkSent` = `Link sent!`
* `redirect.phishingResistance.explanation1` = `You’ll need a valid government-issued ID and a selfie.`
* `redirect.phishingResistance.recommendedBrowser` = `We recommend using Safari on iOS and Chrome on Android.`
* `redirect.phishingResistance.titleClient` = `Verify your identity`
* `redirect.resend` = `Resend`
* `redirect.scanQRTitle` = `Scan QR`
* `redirect.scanQrv2` = `Scan the QR code to verify on your mobile device.`
* `redirect.sendLinkSms` = `Send link via SMS`
* `redirect.sendSms` = `Send SMS`

---

- Path: `release-notes/en-english-6`
- URL: https://developer.incode.com/release-notes/en-english-6/
- Markdown: https://developer.incode.com/release-notes/en-english-6.md

# EN - English

## 🆕 Added

* `curp.continue` = `Continue`
* `curp.dontHave` = `I don't have a CURP`
* `curp.enterCurp` = `Enter your CURP`
* `curp.generate` = `Generate your CURP`
* `curp.generateCta` = `Generate`
* `curp.labels.birthState` = `Birth state`
* `curp.labels.dob` = `Date of birth`
* `curp.labels.femaleV2` = `Female`
* `curp.labels.firstLast` = `First lastname`
* `curp.labels.firstName` = `First name`
* `curp.labels.genderV2` = `Gender`
* `curp.labels.maleV2` = `Male`
* `curp.labels.other` = `Non-binary/Other`
* `curp.labels.secondLast` = `Second lastname`
* `curp.placeholder.curp` = `Your CURP`
* `curp.placeholder.firstLast` = `Your first lastname`
* `curp.placeholder.firstName` = `Your first name`
* `curp.placeholder.gender` = `Choose gender`
* `curp.placeholder.secondLast` = `Your second lastname`
* `curp.placeholder.state` = `Select state`
* `curp.status.checkInfo` = `Please check entered information`
* `curp.status.confirm` = `Confirm your CURP`
* `curp.status.couldntGenerate` = `Couldn't generate CURP`
* `curp.status.edit` = `Edit information`
* `curp.status.generating` = `Generating CURP...`
* `curp.status.notVerified` = `CURP not verified`
* `curp.status.tryAgain` = `Try again`
* `curp.status.verified` = `CURP verified!`
* `curp.status.verifying` = `Verifying your CURP...`
* `faceMatch.continue` = `Continue`
* `faceMatch.facesNoMatch` = `Faces do not match`
* `faceMatch.firstId` = `First ID`
* `faceMatch.id` = `ID`
* `faceMatch.matched` = `Matched!`
* `faceMatch.matching` = `Verifying identity`
* `faceMatch.processing` = `Processing...`
* `faceMatch.secondId` = `Second ID`
* `faceMatch.selfie` = `Selfie`
* `face.tutorial.ageAssuranceStartCapture` = `Verify age`
* `face.tutorial.ageAssuranceSubtitle` = `Your image will not be stored or shared with any third-party to protect your privacy`
* `face.tutorial.ageAssuranceTitle` = `Take a selfie to verify your age`
* `face.tutorial.autoCapture` = `Stay still, selfie will be taken automatically`
* `home.start` = `Start`
* `idv2.ageVerificationPage.ageVerification` = `Age verification`
* `idv2.ageVerificationPage.Continue` = `Continue`
* `idv2.ageVerificationPage.showYourIdAndScanIt` = `Show your ID and scan it`
* `idv2.ageVerificationPage.TheRestOfYourInformationWillBeDeletedToEnsureYourPrivacy` = `The rest of your information will be deleted to ensure your privacy`
* `idv2.ageVerificationPage.weNeedToScanYourIDToKnowYourAge` = `We need to scan your ID to know your age`
* `idv2.ageVerificationPage.weOnlyUseTheDateOfBirthInformation` = `We only use the date of birth information`
* `idv2.barCodeDetection.processingSubtitle` = `We’re verifying your identity`
* `idv2.barCodeDetection.processingTitle` = `Hold on a sec...`
* `idv2.capture.processing.verifying` = `Verifying...`
* `idv2.digitalIdUpload.continue` = `Continue`
* `idv2.digitalIdUpload.errorScreen.pleaseTryScanning` = ` Please try scanning a different document`
* `idv2.digitalIdUpload.errorScreen.thisIdMustBeScanned` = `This ID must be scanned`
* `idv2.digitalIdUpload.reviewScreen.continue` = `Continue`
* `idv2.digitalIdUpload.successfullyProcessed` = `Successfully processed!`
* `onboarding.errors.invalidQRuuid.message` = `It looks like your URL is not valid or expired`
* `onboarding.errors.invalidQRuuid.title` = `Your URL is invalid`
* `otp.enterCodeSMS` = `Enter the code we’ve sent via SMS`
* `phone.verify` = `Verify your phone number`
* `redirect.resendCountdown` = `Resend link in <strong>{{time}}s</strong>`
* `verification.failureTitle` = `Something went wrong`
* `verification.labels.addressDetailsSection` = `Address Details`
* `verification.labels.dlDetailsSection` = `Driver's License Details`
* `verification.placeholder.email` = `email@example.com`
* `verification.placeholder.firstName` = `Your first name`
* `verification.placeholder.lastName` = `Your last name`
* `verification.placeholder.maternalSurname` = `Your maternal surname`
* `verification.placeholder.middleName` = `Your middle name`
* `verification.placeholder.stateCode` = `e.g. {{states}}`
* `verification.placeholder.surname` = `Your surname`
* `verification.submitButton` = `Continue`
* `verification.successTitle` = `eKYC verified!`
* `verification.tryAgain` = `Try again`

## ✏️ Modified

* `idv2.chooser.chooseHowToVerifyTitle`:
  * Old: `Choose how to verify`
  * New: `Select how to verify`
* `idv2.digitalIdUpload.reviewScreen.title`:
  * Old: `Review your document`
  * New: `Review document`
* `idv2.digitalIdUpload.screenDescription`:
  * Old: `A government-issued PDF file or photo with
     your details, picture and a QR code`
  * New: `A government-issued PDF file with your details, picture and a QR code`
* `idv2.digitalIdUpload.screenTitle`:
  * Old: `Upload your digital ID`
  * New: `Upload Digital ID`
* `otp.resendCountdown`:
  * Old: `Resend code in <strong>{{time}}s</strong>`
  * New: `Resend code in {{time}}s`
* `verification.labels.state`:
  * Old: `State Code (e.g. {{states}})`
  * New: `State Code`

---

- Path: `release-notes/en-english-7`
- URL: https://developer.incode.com/release-notes/en-english-7/
- Markdown: https://developer.incode.com/release-notes/en-english-7.md

# EN - English

## 🆕 Added

* `commonIssues.blurPresent` = `Blur present`
* `commonIssues.blurPresentDescription` = `Move ID further away or closer to your phone until the image is focused`
* `commonIssues.glarePresent` = `Glare present`
* `commonIssues.glarePresentDescription` = `Tilt the ID slightly up or down to minimize the reflection`
* `commonIssues.notReadable` = `Info is not readable`
* `commonIssues.notReadableDescription` = `Minimize camera shake by holding your phone steady`
* `encryptionLabel.encryptedPhotos` = `All data is encrypted`
* `home.goToSettings` = `Go to settings`
* `idv2.backTutorial.disclaimer` = `The capture will happen automatically`
* `idv2.backTutorial.subtitle` = `Ensure your ID is readable`
* `idv2.backTutorial.title` = `Show the back of your ID`
* `idv2.capture.allDataIsEncrypted` = `All data is encrypted`
* `idv2.permissions.allowV2` = `Allow`
* `idv2.permissions.subtitleV2` = `This lets the camera perform the capture required for verification`
* `idv2.reverseFlipAnimation.title` = `Show the front of your ID`
* `notifications.faceOccluded` = `Face covered`
* `notifications.faceOccludedDescription` = `Make sure your face is clear and visible`
* `selfiev2.manualCapture.captureButton` = `Take photo`

## ✏️ Modified

* `commonIssues.takeManually`:
  * Old: `Take photo manually`
  * New: `Take the photo manually`
* `face.tutorial.subtitle`:
  * Old: `This allows you to sign in using your face.`
  * New: `Keep a neutral expression, find balanced light and remove any glasses and hats`
* `idv2.capture.autoCapture`:
  * Old: `The photo will be taken automatically`
  * New: `The capture will happen automatically`
* `idv2.capture.fillFrameBack`:
  * Old: `Fill the frame with your back ID`
  * New: `Frame the back of your ID`
* `idv2.capture.fillFrameFront`:
  * Old: `Fill the frame with your ID`
  * New: `Frame the front of your ID`
* `idv2.permissions.allowPermissionsV2`:
  * Old: `Allow camera permissions`
  * New: `Allow camera access`
* `idv2.permissions.dontAllow`:
  * Old: `Don't Allow`
  * New: `Don't allow`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `We only use the camera to capture your ID for secure verification`
  * New: `We only use the camera for the verification process.`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `It helps verify document authenticity and prevent identity fraud`
  * New: `The verification process makes sure you are who you say you are.`
* `idv2.tutorial.autoCapture`:
  * Old: `The photo will be taken automatically`
  * New: `The capture will happen automatically`
* `idv2.tutorial.title`:
  * Old: `Scan your ID`
  * New: `Show the front of your ID`
* `notifications.selfieCaptureFailedDescription`:
  * Old: `Your selfie will be manually reviewed later`
  * New: `Maximum number of attempts reached`
* `notifications.spoofDescriptionNoTries`:
  * Old: `Your selfie will be manually reviewed later`
  * New: `Maximum number of attempts reached`

---

- Path: `release-notes/en-english-8`
- URL: https://developer.incode.com/release-notes/en-english-8/
- Markdown: https://developer.incode.com/release-notes/en-english-8.md

# EN - English

## 🆕 Added

* `ekyb.addressDetails` = `Address Details`
* `ekyb.continue` = `Continue`
* `ekyb.error.title` = `Something went wrong`
* `ekyb.processing` = `Processing`
* `ekyb.success` = `Success`
* `ekyb.tryAgain` = `Try again`
* `idv2.capture.manualCapture.modeSwitchAriaAnnouncement` = `Now using manual capture mode. Press the button to capture photo.`
* `idv2.capture.v2.autoCapture` = `The photo will be taken automatically`
* `idv2.capture.v2.fillFrameBack` = `Fill the frame with your back ID`
* `idv2.capture.v2.fillFrameFront` = `Fill the frame with your ID`
* `idv2.tutorial.v2.autocapture` = `The photo will be taken automatically`
* `idv2.tutorial.v2.title` = `Scan your ID`
* `otp.groupLabel` = `{{charLength}}-digit verification code`
* `v2.capture.label` = `All photos are encrypted`
* `v2.idError.attemptsLeft_one` = `{{count}} attempt remaining`
* `v2.idError.attemptsLeft_other` = `{{count}} attempt remaining`
* `v2.idSuccess.subtitle` = `Now let's capture the back`
* `v2.idSuccess.subtitleBack` = `Let's continue`
* `v2.idSuccess.title` = `Successfully processed!`
* `v2.selfie.camera.loading` = `Loading...`

## ✏️ Modified

* `ekyb.title`:
  * Old: `eKYB verification`
  * New: `eKYB Verification`

---

- Path: `release-notes/en-english-9`
- URL: https://developer.incode.com/release-notes/en-english-9/
- Markdown: https://developer.incode.com/release-notes/en-english-9.md

# EN - English

## 🆕 Added

* `biometricConsent.subtitle` = `Your verification is powered by Incode. To comply with state regulations, we need your consent for biometric processing.`
* `documentCapture.camera.subtitle` = `Make sure it's fully visible and press the button`
* `documentCapture.camera.title` = `Show your full document`
* `documentCapture.commonIssues.dirtyPresent` = `Camera lens is dirty`
* `documentCapture.commonIssues.dirtyPresentDescription` = `Clean your camera lens for a sharper image.`
* `documentCapture.commonIssues.farPresent` = `Document is too far or out of frame`
* `documentCapture.commonIssues.farPresentDescription` = `Make sure all edges are visible on screen.`
* `documentCapture.commonIssues.foldedIdPresent` = `Document is folded`
* `documentCapture.commonIssues.foldedIdPresentDescription` = `Flatten your document and make sure it’s fully open and straight.`
* `documentCapture.commonIssues.shadowPresent` = `Shadows on the document`
* `documentCapture.commonIssues.shadowPresentDescription` = `Move to a brighter area and avoid casting shadows over your document.`
* `documentCapture.errors.fileSizeExceed` = `File exceeds maximum size of {{maxSize}}`
* `documentCapture.review.analyzing` = `Analyzing...`
* `documentCapture.review.continue` = `Continue`
* `documentCapture.review.error.description` = `Make sure all the information on the document is clear and legible.`
* `documentCapture.review.error.title` = `Unable to process`
* `documentCapture.review.errorTitle` = `Something went wrong`
* `documentCapture.review.errorUpload` = `An error occurred when processing your document.`
* `documentCapture.review.replace` = `Replace`
* `documentCapture.review.retake` = `Retake`
* `documentCapture.review.subtitleCaptured` = `Make sure that entire document fits the view, and that the text is readable.`
* `documentCapture.review.subtitleImageUpload` = `Make sure that entire document fits the view, and that the text is readable.`
* `documentCapture.review.subtitlePdfUpload` = `Make sure you’ve selected the correct file before you continue verification process.`
* `documentCapture.review.successTitle` = `Successfully processed!`
* `documentCapture.review.titleCaptured` = `Review your document`
* `documentCapture.review.titleImageUpload` = `Review your selected photo`
* `documentCapture.review.titlePdfUpload` = `Review your document`
* `documentCapture.review.tryAgain` = `Try again`
* `documentCapture.review.uploading` = `Uploading...`
* `documentCapture.tutorial.captureButton` = `Capture document`
* `documentCapture.tutorial.chooseFile` = `Choose from device`
* `documentCapture.tutorial.multiPageDocument.subtitle` = `Take a photo of the next page to continue.`
* `documentCapture.tutorial.multiPageDocument.title` = `Next document page`
* `documentCapture.tutorial.skipButton` = `Skip this step`
* `documentCapture.tutorial.subtitle` = `Take a photo or upload a PDF, JPG or PNG`
* `documentCapture.tutorial.takePhoto` = `Take photo`
* `documentCapture.tutorial.title` = `Verify your document`
* `documentCapture.tutorial.uploadButton` = `Upload document`
* `documentCapture.tutorial.uploadDocument` = `Upload document`
* `ekyb.error.USTaxId` = `Invalid Tax ID. Tax ID should be 9 digits.`
* `idv2.ageVerificationPage.step1of3` = `Step 1 of 3: `
* `idv2.ageVerificationPage.step2of3` = `Step 2 of 3: `
* `idv2.ageVerificationPage.step3of3` = `Step 3 of 3: `
* `idv2.chooser.digitalIdButtonTitle` = `Digital Id`
* `idv2.chooser.loadingDigitalWallet` = `Loading digital wallet...`
* `idv2.flipAnimation.titleToFront` = `Show the front of your ID`
* `idv2.permissions.allowEveryTime` = `Allow every time`
* `idv2.permissions.allowOnlyWhileUsingTheApp` = `Allow only while using the app`
* `idv2.permissions.denied.onDevice` = `on device`
* `idv2.permissions.denied.opera.appsOpera` = `Apps <arrow/> Opera`
* `idv2.permissions.denied.permissionsCamera` = `Persmissions <arrow/> Camera`
* `idv2.permissions.denied.persmissionsCamera` = `Persmissions <arrow/> Camera`
* `idv2.permissions.denied.settingsApp` = `Settings app`
* `idv2.permissions.denied.setTo` = `Set to`
* `idv2.permissions.denied.sitePermissions` = `Site permissions`
* `idv2.permissions.denied.sitesAndDownloads` = `Sites and downloads`
* `idv2.tutorial.subtitleBack` = `Ensure your ID is readable`
* `idv2.tutorial.v2.titleBack` = `Show the back of your ID`
* `manualIdUpload.frontRequiredFirst` = `Please upload front of ID first`
* `manualIdUpload.uploadBackId` = `Upload back of ID`
* `manualIdUpload.uploadFrontId` = `Upload front of ID`
* `manualIdUpload.uploadPassport` = `Upload passport`
* `notifications.noTries` = `Maximum number of attempts reached`
* `selfiev2.autoCapture.defaultAriaInstructions` = `Center your face in the frame.`
* `selfiev2.capture.title` = `Face Capture`
* `verification.errors.ARPostalCodeInvalidFormat` = `Please enter a valid Argentina Postal Code (format: A1111AAA)`
* `verification.errors.CAPostalCodeInvalidFormat` = `Please enter a valid Canadian postal code (format: A1A 1A1).`
* `verification.errors.ESPostalCodeInvalidFormat` = `Please enter a 5 digit Postal Code`
* `verification.errors.UKPostalCodeInvalidFormat` = `Please enter a valid UK Postal Code.`
* `verification.noFormFields` = `No fields were configured for this form.`
* `watchlistBusiness.businessName` = `Business Name`
* `watchlistBusiness.businessNameRequired` = `Business Name field is required`
* `watchlistBusiness.continue` = `Continue`
* `watchlistBusiness.watchlistForBusiness` = `Watchlist for Business`

## ✏️ Modified

* `idv2.permissions.denied.cameraAllow`:
  * Old: `Tap Camera <arrow/> Allow`
  * New: `Camera <arrow/> Allow`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `We only use the camera for the verification process.`
  * New: `We only use the camera to capture your ID for secure verification`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `The verification process makes sure you are who you say you are.`
  * New: `It helps verify document authenticity and prevent identity fraud`
* `idv2.permissions.subtitleV2`:
  * Old: `This lets the camera perform the capture required for verification`
  * New: `This lets you take a photo of your ID and face for verification purposes.`
* `otp.errorv2`:
  * Old: `Code expired, please try again`
  * New: `Something went wrong`

---

- Path: `release-notes/es-es-spanish-spain`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Partida de nacimiento`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Moneda`
* `capturePreview.acceptedDocuments.DriversLicense` = `Permiso de conducir`
* `capturePreview.acceptedDocuments.FederalID` = `Identificación federal`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Tarjeta de identificación`
* `capturePreview.acceptedDocuments.label` = `Documentos aceptados para:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Tarjeta sanitaria`
* `capturePreview.acceptedDocuments.Military` = `Militar`
* `capturePreview.acceptedDocuments.noDocuments` = `No se aceptan documentos para este país. `
* `capturePreview.acceptedDocuments.Other` = `Otros`
* `capturePreview.acceptedDocuments.Passport` = `Pasaporte`
* `capturePreview.acceptedDocuments.Permit` = `Permiso`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Documento de residencia`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identificación fiscal`
* `capturePreview.acceptedDocuments.TravelDocument` = `Documento de viaje`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identificación tribal`
* `capturePreview.acceptedDocuments.Unknown` = `Desconocido`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Matriculación de vehículos`
* `capturePreview.acceptedDocuments.Visa` = `Visa`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identificación de los votantes`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Licencia de armas`
* `common.refreshPage` = `Actualizar`
* `commonIssues.idv2.tryAgain` = `Bien, inténtalo de nuevo.`
* `errors.dynamicImport.failedToLoad` = `Un error algo inesperado pero del que tomamos nota:`
* `errors.dynamicImport.suggestion` = `Lo intentaremos de nuevo en {{count}} o puedes actualizar manualmente`
* `errors.dynamicImport.title` = `Lo sentimos, hemos encontrado un problema`
* `idv2.capture.autoCapture` = `La foto se tomará automáticamente`
* `idv2.capture.dontMove` = `No muevas tu ID durante unos segundos`
* `idv2.capture.fillFrame` = `Rellena el marco con tu DNI`
* `idv2.capture.fillFramePassport` = `Rellena el marco con tu pasaporte`
* `idv2.capture.manualCapture.ariaLabel` = `Captura manual`
* `idv2.capture.manualCapture.title` = `Botón de captura manual`
* `idv2.capture.notifications.blur.description` = `Acercar o alejar la imagen, o pulsar sobre el ID`
* `idv2.capture.notifications.blur.title` = `Identificación demasiado borrosa`
* `idv2.capture.notifications.glare.description` = `Busca una mejor iluminación para evitar reflejos`
* `idv2.capture.notifications.glare.title` = `Identificación con deslumbramiento`
* `idv2.capture.notifications.notAligned.description` = `Centra tu ID dentro del marco`
* `idv2.capture.notifications.notAligned.title` = `El ID no está alineado`
* `idv2.capture.notifications.showBack.description` = `Dale la vuelta a tu DNI para mostrar su reverso`
* `idv2.capture.notifications.showBack.title` = `Mostrar el reverso del DNI`
* `idv2.capture.notifications.showFront.description` = `Dale la vuelta a tu DNI para mostrar su anverso`
* `idv2.capture.notifications.showFront.title` = `Mostrar el anverso del DNI`
* `idv2.capture.passport.subtitle` = `Asegúrese de que su pasaporte es legible`
* `idv2.capture.passport.title` = `Escanee su pasaporte`
* `idv2.capture.processing.analyzing` = `Analizar...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} intentos restantes`
* `idv2.capture.processing.continue` = `Continúe en`
* `idv2.capture.processing.error` = `Error`
* `idv2.capture.processing.errors.classification.subtitle` = `Asegúrese de que toda la identificación sea visible y esté bien iluminada`
* `idv2.capture.processing.errors.classification.title` = `Error en la verificación de la identidad`
* `idv2.capture.processing.errors.default.subtitle` = `Por favor, inténtelo de nuevo`
* `idv2.capture.processing.errors.default.title` = `Hubo un problema`
* `idv2.capture.processing.errors.glare.subtitle` = `Inclina el ID ligeramente hacia arriba o hacia abajo para minimizar el reflejo`
* `idv2.capture.processing.errors.glare.title` = `Resplandor presente`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimiza el movimiento de la cámara sujetando el teléfono con firmeza`
* `idv2.capture.processing.errors.readability.title` = `La información no es legible`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Aleja o acerca el ID al teléfono hasta que la imagen esté enfocada`
* `idv2.capture.processing.errors.sharpness.title` = `Desenfoque presente`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Inténtelo con otro documento`
* `idv2.capture.processing.errors.unacceptable.title` = `No se acepta el tipo de identificación`
* `idv2.capture.processing.errors.upload.subtitle` = `Compruebe su conexión y vuelva a intentarlo.`
* `idv2.capture.processing.errors.upload.title` = `Error en el escaneado de ID`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Captura {{mode}} lado de la identificación`
* `idv2.capture.processing.errors.wrongSide.title` = `Lado de identificación incorrecto capturado`
* `idv2.capture.processing.scanBack` = `Escanear el reverso`
* `idv2.capture.processing.success` = `Éxito`
* `idv2.capture.processing.successBackSubtitle` = `Ahora continuemos`
* `idv2.capture.processing.successFrontSubtitle` = `Ahora vamos a capturar la parte de atrás`
* `idv2.capture.processing.successTitle` = `Procesado con éxito.`
* `idv2.capture.processing.tryAgain` = `Inténtalo de nuevo`
* `idv2.capture.takingPhoto` = `Hacer fotos...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `Documento nacional de identidad o permiso de conducir`
* `idv2.chooser.idButtonTitle` = `Documento de identidad`
* `idv2.chooser.passportButtonDescription` = `Pasaporte de su país`
* `idv2.chooser.passportButtonTitle` = `Pasaporte`
* `idv2.permissions.alertAlt` = `alerta de permiso falso`
* `idv2.permissions.allow` = `OK, Permitir`
* `idv2.permissions.denied.allow` = `Permitir`
* `idv2.permissions.denied.ask` = `Pregunte a`
* `idv2.permissions.denied.browser` = `Navegador`
* `idv2.permissions.denied.camera` = `Cámara`
* `idv2.permissions.denied.changeTo` = `Cambiar a`
* `idv2.permissions.denied.open` = `Abrir`
* `idv2.permissions.denied.or` = `o`
* `idv2.permissions.denied.refreshPage` = `Actualizar página`
* `idv2.permissions.denied.return` = `Vuelva aquí y pulse`
* `idv2.permissions.denied.scroll` = `Desplácese hacia abajo para seleccionar`
* `idv2.permissions.denied.settings` = `Ajustes`
* `idv2.permissions.denied.tap` = `Toque`
* `idv2.permissions.denied.title` = `Siga los siguientes pasos para permitir que Incode acceda a su cámara`
* `idv2.permissions.denied.yourBrowser` = `su navegador`
* `idv2.permissions.description` = `para completar el proceso`
* `idv2.permissions.dontAllow` = `No permita`
* `idv2.permissions.fakeDenied.alert` = `alerta falsa centrada`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permisos`
* `idv2.permissions.fakeDenied.quitProcess` = `Abandonar el proceso`
* `idv2.permissions.fakeDenied.title` = `Se requiere permiso de cámara para la captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `advertencia`
* `idv2.permissions.note` = `Nota: Dependiendo de su teléfono, puede decir`
* `idv2.permissions.or` = `o`
* `idv2.permissions.subtitle` = `permitir permiso de cámara`
* `idv2.permissions.title` = `Necesitamos que`
* `idv2.permissions.whileUsing` = `Al utilizar la aplicación`
* `idv2.tutorial.autoCapture` = `La foto se tomará automáticamente`
* `idv2.tutorial.startScan` = `Escaneemos`
* `idv2.tutorial.subtitle` = `Asegúrese de que su documento de identidad sea legible`
* `idv2.tutorial.title` = `Escanee su DNI`
* `idv2.uploading.analyzing` = `Analizar...`
* `idv2.uploading.imageAlt` = `Captura de ID`
* `onboarding.errors.restartDisabled.message` = `Reinicio de sesión desactivado a nivel de organización`
* `onboarding.errors.restartDisabled.title` = `No se puede reiniciar la sesión`
* `qes.signatureCheck` = `Acepto la expedición del certificado requerido y la firma electrónica de este documento.`
* `qes.termsCheck` = `He leído y acepto la <2>Política de privacidad</2> y las <6>Condiciones de uso</6> de Incode.`

## ✏️ Modified

* `commonIssues.infoNotReadable`:
  * Before: `La información no es legible`
  * Now: `Información no legible`
* `commonIssues.takeManually`:
  * Before: `Hacer la foto manualmente`
  * Now: `Haz la foto manualmente`
* `commonIssues.tryAgain`:
  * Before: `Bien, inténtalo de nuevo.`
  * Now: `Inténtalo de nuevo`
* `ineCheck.verified`:
  * Before: `¡Identidad verificada!`
  * Now: `Identidad sometida a verificación`
* `notifications.done`:
  * Before: `Hecho`
  * Now: `Escaneado finalizado`
* `notifications.glareDetected`:
  * Before: `Brillo detectado`
  * Now: `Deslumbramiento detectado`
* `notifications.glareDetectedDescription`:
  * Before: `Inclina el ID levemente arriba y abajo para minimizar el reflejo`
  * Now: `Busca una mejor iluminación para evitar reflejos`
* `notifications.idTypeUnacceptable`:
  * Before: `No se acepta el tipo de identificación`
  * Now: `Documento no válido`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Por favor intenta con otro documento`
  * Now: `Intenta escanear otro`
* `notifications.lowSharpness`:
  * Before: `Fuera de foco`
  * Now: `Baja nitidez`

---

- Path: `release-notes/es-es-spanish-spain-1`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-1/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-1.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `idv2.permissions.fakeDenied.alert` = `alerta falsa centrada`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permisos`
* `idv2.permissions.fakeDenied.quitProcess` = `Abandonar el proceso`
* `idv2.permissions.fakeDenied.title` = `Se requiere permiso de cámara para la captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `advertencia`

## ✏️ Modified

* `idv2.chooser.idButtonDescription`:
  * Before: `ID o licencia de conducir`
  * Now: `Documento nacional de identidad o permiso de conducir`

---

- Path: `release-notes/es-es-spanish-spain-10`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-10/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-10.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `biometricConsent.subtitle` = `Su verificación es impulsada por Incode. Para cumplir la normativa estatal, necesitamos su consentimiento para el procesamiento biométrico.`
* `documentCapture.camera.subtitle` = `Asegúrate de que está totalmente visible y pulsa el botón`
* `documentCapture.camera.title` = `Muestre su documento completo`
* `documentCapture.commonIssues.dirtyPresent` = `El objetivo de la cámara está sucio`
* `documentCapture.commonIssues.dirtyPresentDescription` = `Limpia el objetivo de tu cámara para obtener una imagen más nítida.`
* `documentCapture.commonIssues.farPresent` = `El documento está demasiado lejos o fuera de cuadro`
* `documentCapture.commonIssues.farPresentDescription` = `Asegúrese de que todos los bordes son visibles en la pantalla.`
* `documentCapture.commonIssues.foldedIdPresent` = `El documento está plegado`
* `documentCapture.commonIssues.foldedIdPresentDescription` = `Aplana el documento y asegúrate de que está completamente abierto y recto.`
* `documentCapture.commonIssues.shadowPresent` = `Sombras sobre el documento`
* `documentCapture.commonIssues.shadowPresentDescription` = `Desplázate a una zona más luminosa y evita proyectar sombras sobre tu documento.`
* `documentCapture.errors.fileSizeExceed` = `El archivo supera el tamaño máximo de {{maxSize}}`
* `documentCapture.review.analyzing` = `Analizar...`
* `documentCapture.review.continue` = `Continúe en`
* `documentCapture.review.error.description` = `Asegúrese de que toda la información del documento es clara y legible.`
* `documentCapture.review.error.title` = `No se puede procesar`
* `documentCapture.review.errorTitle` = `Algo salió mal`
* `documentCapture.review.errorUpload` = `Se ha producido un error al procesar su documento.`
* `documentCapture.review.replace` = `Sustituir`
* `documentCapture.review.retake` = `Retomar`
* `documentCapture.review.subtitleCaptured` = `Asegúrese de que todo el documento se ajusta a la vista y de que el texto es legible.`
* `documentCapture.review.subtitleImageUpload` = `Asegúrese de que todo el documento se ajusta a la vista y de que el texto es legible.`
* `documentCapture.review.subtitlePdfUpload` = `Asegúrese de haber seleccionado el archivo correcto antes de continuar con el proceso de verificación.`
* `documentCapture.review.successTitle` = `Procesado con éxito.`
* `documentCapture.review.titleCaptured` = `Revise su documento`
* `documentCapture.review.titleImageUpload` = `Revisar la foto seleccionada`
* `documentCapture.review.titlePdfUpload` = `Revise su documento`
* `documentCapture.review.tryAgain` = `Inténtalo de nuevo`
* `documentCapture.review.uploading` = `Cargando...`
* `documentCapture.tutorial.captureButton` = `Capturar documento`
* `documentCapture.tutorial.chooseFile` = `Elegir dispositivo`
* `documentCapture.tutorial.multiPageDocument.subtitle` = `Haz una foto de la página siguiente para continuar.`
* `documentCapture.tutorial.multiPageDocument.title` = `Página siguiente`
* `documentCapture.tutorial.skipButton` = `Omitir este paso`
* `documentCapture.tutorial.subtitle` = `Haz una foto o sube un PDF, JPG o PNG`
* `documentCapture.tutorial.takePhoto` = `Tomar foto`
* `documentCapture.tutorial.title` = `Verifique su documento`
* `documentCapture.tutorial.uploadButton` = `Cargar documento`
* `documentCapture.tutorial.uploadDocument` = `Cargar documento`
* `ekyb.error.USTaxId` = `NIF no válido. El NIF debe tener 9 dígitos.`
* `idv2.ageVerificationPage.step1of3` = `Paso 1 de 3: `
* `idv2.ageVerificationPage.step2of3` = `Paso 2 de 3: `
* `idv2.ageVerificationPage.step3of3` = `Paso 3 de 3: `
* `idv2.chooser.digitalIdButtonTitle` = `Identificación digital`
* `idv2.chooser.loadingDigitalWallet` = `Cargando monedero digital...`
* `idv2.flipAnimation.titleToFront` = `Muestre el anverso de su documento de identidad`
* `idv2.permissions.allowEveryTime` = `Permitir siempre`
* `idv2.permissions.allowOnlyWhileUsingTheApp` = `Permitir sólo mientras se utiliza la aplicación`
* `idv2.permissions.denied.onDevice` = `en el dispositivo`
* `idv2.permissions.denied.opera.appsOpera` = `Aplicaciones <arrow/> Opera`
* `idv2.permissions.denied.permissionsCamera` = `Persmisiones <arrow/> Cámara`
* `idv2.permissions.denied.persmissionsCamera` = `Persmisiones <arrow/> Cámara`
* `idv2.permissions.denied.settingsApp` = `Aplicación Ajustes`
* `idv2.permissions.denied.setTo` = `Ajustar a`
* `idv2.permissions.denied.sitePermissions` = `Autorizaciones`
* `idv2.permissions.denied.sitesAndDownloads` = `Sitios y descargas`
* `idv2.tutorial.subtitleBack` = `Asegúrese de que su documento de identidad sea legible`
* `idv2.tutorial.v2.titleBack` = `Muestre el reverso de su documento de identidad`
* `manualIdUpload.frontRequiredFirst` = `Cargue primero el anverso del documento de identidad`
* `manualIdUpload.uploadBackId` = `Cargar el reverso del DNI`
* `manualIdUpload.uploadFrontId` = `Cargar anverso del DNI`
* `manualIdUpload.uploadPassport` = `Cargar pasaporte`
* `notifications.noTries` = `Número máximo de intentos alcanzado`
* `selfiev2.autoCapture.defaultAriaInstructions` = `Centra tu cara en el encuadre.`
* `selfiev2.capture.title` = `Captura facial`
* `verification.errors.ARPostalCodeInvalidFormat` = `Introduzca un código postal argentino válido (formato: A1111AAA)`
* `verification.errors.CAPostalCodeInvalidFormat` = `Introduzca un código postal canadiense válido (formato: A1A 1A1).`
* `verification.errors.ESPostalCodeInvalidFormat` = `Introduzca un código postal de 5 dígitos`
* `verification.errors.UKPostalCodeInvalidFormat` = `Introduzca un código postal válido del Reino Unido.`
* `verification.noFormFields` = `No se ha configurado ningún campo para este formulario.`
* `watchlistBusiness.businessName` = `Nombre comercial`
* `watchlistBusiness.businessNameRequired` = `El campo Nombre de la empresa es obligatorio`
* `watchlistBusiness.continue` = `Continúe en`
* `watchlistBusiness.watchlistForBusiness` = `Lista de vigilancia para empresas`

## ✏️ Modified

* `ekyb.continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `faceMatch.continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.ageVerificationPage.Continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.capture.processing.continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Pulse Cámara <arrow/> Permitir`
  * New: `Cámara <arrow/> Permitir`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Sólo utilizamos la cámara para el proceso de verificación.`
  * New: `Sólo utilizamos la cámara para capturar su identificación para la verificación segura`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `El proceso de verificación garantiza que usted es quien dice ser.`
  * New: `Ayuda a verificar la autenticidad de los documentos y a prevenir el fraude de identidad.`
* `idv2.permissions.subtitleV2`:
  * Old: `Esto permite a la cámara realizar la captura necesaria para la verificación`
  * New: `Te permite hacer una foto de tu DNI y de tu cara con fines de verificación.`
* `matchUser.continue`:
  * Old: `CONTINÚE`
  * New: `Continuar`
* `otp.errorv2`:
  * Old: `Código caducado, inténtelo de nuevo`
  * New: `Algo salió mal`
* `verification.submitButton`:
  * Old: `Continúe en`
  * New: `Continuar`

---

- Path: `release-notes/es-es-spanish-spain-11`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-11/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-11.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `aes.confirmSignature.finishSigning` = `Terminar de firmar`
* `aes.reviewDocument.subtitle` = `Asegúrate de que has seleccionado el archivo correcto antes de seguir firmando.`
* `aes.reviewDocument.title` = `Revise su documento`
* `biometricConsent. consentOptions` = `Opciones de consentimiento`
* `common.done` = `¡Hecho!`
* `common.wontTakeLong` = `Esto no llevará mucho tiempo.`
* `curp.verifyManually` = `Verificar manualmente`
* `customFields.completed` = `¡Terminado!`
* `customFields.continue` = `Continúe en`
* `customFields.processing` = `Procesando...`
* `customFields.title` = `Introduzca sus datos`
* `customWatchlist.done` = `¡Hecho!`
* `customWatchlist.wontTake` = `Esto no llevará mucho tiempo.`
* `digilocker.denied.tryAgain` = `Inténtalo de nuevo`
* `documentCapture.button.allPagesCaptured` = `Todas las páginas capturadas`
* `documentCapture.button.nextPage` = `Página siguiente`
* `documentCapture.tutorial.continue` = `Continúe en`
* `documentCapture.tutorial.multiPageDocument.optionalPage.subtitle` = `Si hay otra página con información relevante, puede capturarla ahora.`
* `ekyb.addAnotherDirector` = `Añadir otro Director (Opcional)`
* `ekyb.directorNameWithNumber` = `Director {{number}} Nombre`
* `ekyb.directorSurnameWithNumber` = `Director {{number}} Apellidos`
* `ekyb.error.taxId-cn` = `Introduzca un código de crédito social unificado chino válido (18 caracteres alfanuméricos)`
* `ekyb.error.taxId-de` = `Introduzca un número de identificación fiscal alemán válido: IVA (DE + 9 dígitos), HRB (3-6 dígitos), HRB (6 dígitos + letra) o HRA (4-6 dígitos).`
* `ekyb.error.taxId-es` = `Introduzca un NIF español válido: NIF (letra + 8 dígitos), NIE (letra + 7 dígitos + letra), o DNI (8 dígitos + letra)`
* `ekyb.error.taxId-gb` = `Introduzca un número de identificación fiscal válido en el Reino Unido: Número de registro (7-8 dígitos) o Número de IVA (GB seguido de 9 dígitos, o 9 dígitos solos).`
* `ekyb.error.taxId-il` = `Introduzca un Mispar Osek israelí válido (9 dígitos)`
* `ekyb.error.taxId-it` = `Introduzca un número de identificación fiscal italiano válido: CCIAA/NREA (2 letras + 6-7 dígitos), identificación de la empresa (IT + 8 dígitos) o código fiscal/IVA (11 dígitos).`
* `ekyb.error.taxId-mx` = `Introduzca un RFC mexicano válido: Individual (4 letras + 6 dígitos + 3 alfanuméricos) o Empresarial (3 letras + 6 dígitos + 3 alfanuméricos).`
* `ekyb.error.taxId-ng` = `Introduzca un NIF nigeriano válido (10 dígitos)`
* `ekyb.error.taxId-nl` = `Introduzca un número de identificación fiscal holandés válido: Número de IVA (NL + 9 dígitos + B + 2 dígitos) o número KvK (8 dígitos)`
* `email.placeholder` = `Correo electrónico`
* `forms.placeholder.select` = `Seleccione una opción`
* `identityReuse.cta.continue` = `Continuar con la verificación rápida`
* `identityReuse.cta.verify` = `Verificar con el DNI`
* `identityReuse.description` = `Sólo transferiremos los datos solicitados por {{companyName}} para completar su verificación`
* `identityReuse.subtitle` = `Se ha verificado previamente con uno de nuestros socios. Comparte tus datos para ahorrar tiempo y verificar más rápido.`
* `identityReuse.title` = `Comparte tus datos para una verificación más rápida`
* `idOcr.title` = `Compruebe sus datos`
* `idv2.capture.expiredId.idScanFailed` = `Error en el escaneado de ID`
* `idv2.capture.expiredId.pleaseTryWithADifferentId` = `Inténtelo con otro documento`
* `idv2.capture.notifications.idScanFailed` = `Error en el escaneado de ID`
* `idv2.capture.processing.attemptsRemainingLabel` = `intentos restantes`
* `idv2.capture.processing.noAttemptsRemaining` = `No quedan intentos`
* `idv2.chooser.appleWallet` = `Cartera Apple`
* `idv2.chooser.deviceWalletTag` = `Instantáneo`
* `idv2.chooser.googleWallet` = `Google Wallet`
* `idv2.digilocker.consentDeniedDescription` = `No se ha proporcionado el consentimiento para compartir documentos a través de DigiLocker. Puede volver a intentarlo o elegir otra forma de verificación.`
* `idv2.digilocker.consentDeniedTitle` = `Consentimiento denegado`
* `idv2.digilocker.openingDigilockerForAuthentication` = `Abrir DigiLocker para la autenticación..`
* `idv2.digilocker.sessionErrorDescription` = `No se ha podido restaurar la sesión. Por favor, reinicie el proceso de verificación.`
* `idv2.digilocker.sessionErrorTitle` = `Error de sesión`
* `idv2.digilocker.takingYouToDigilocker` = `Llevándote a DigiLocker..`
* `idv2.digilocker.timeoutDescription` = `La solicitud de DigiLocker no se ha completado en el tiempo previsto. Vuelva a intentarlo o seleccione un método de verificación alternativo.`
* `idv2.digilocker.timeoutTitle` = `La sesión ha terminado..`
* `idv2.digilocker.verificationCompleteTitle` = `Identidad verificada correctamente`
* `idv2.digitalIdUpload.fileTooLargeScreen.cta` = `Elija otro archivo`
* `idv2.digitalIdUpload.fileTooLargeScreen.subtitle` = `El archivo seleccionado pesa más de 5 MB, cargue uno más pequeño`
* `idv2.digitalIdUpload.fileTooLargeScreen.title` = `El archivo es demasiado grande`
* `idv2.permissions.denied.cameraFindSiteAllow` = `Cámara <arrow/> Buscar sitio <arrow/> Permitir`
* `loadingCircle.preparingCamera` = `Preparar la cámara`
* `manualIdUpload.generic` = `Por favor, cargue el documento correcto`
* `manualIdUpload.glareDetected` = ` Resplandor presente`
* `manualIdUpload.hintIdReadable` = `Asegúrese de que el texto de la identificación sea legible.`
* `manualIdUpload.hintPassportReadable` = `Asegúrese de que el texto del pasaporte es legible.`
* `manualIdUpload.hintSharpAndGlareFree` = `La foto debe ser nítida y sin reflejos.`
* `manualIdUpload.lowSharpness` = `Desenfoque presente`
* `manualIdUpload.qualityRejected` = `La calidad de la imagen es demasiado baja.`
* `manualIdUpload.readabilityIssue` = `La información no es legible`
* `manualIdUpload.subtitle` = `Asegúrese de que su documento de identidad sea legible`
* `manualIdUpload.uploadingSubtitle` = `Cargar el archivo`
* `manualIdUpload.uploadingTitle` = `Espera un segundo...`
* `manualIdUpload.wrongDocument` = `Por favor, cargue el documento correcto`
* `onboarding.errors.onboardingUrlAlreadyUsed.message` = `Parece que esta URL ya está en uso`
* `onboarding.errors.onboardingUrlAlreadyUsed.title` = `Su URL no es válida`
* `otp.resendCodeAvailable` = `Ahora puede volver a enviar el código`
* `otp.timerFiveSeconds` = `Quedan 5 segundos`
* `otp.timerStarted` = `Puede solicitar un nuevo código en {{ time }} segundos`
* `otp.timerTenSeconds` = `Quedan 10 segundos para solicitar un nuevo código`
* `otp.verificationCode` = `Código de verificación`
* `phone.invalidPhone` = `Número de teléfono no válido. Inténtelo de nuevo.`
* `phone.optIn` = `Acepto recibir notificaciones por SMS`
* `phone.serverError` = `Algo ha ido mal. Vuelva a intentarlo más tarde.`
* `qes.documentsReviewedCheck` = `Confirmo que he revisado los documentos a firmar enumerados anteriormente antes de firmar.`
* `qes.issuanceCheck` = `Acepto que Incode Czech Republic s.r.o. emita un Certificado reconocido para firmas electrónicas en calidad de Proveedor de Servicios de Confianza Reconocido (QTSP).`
* `qes.newTermsCheck` = `He leído, comprendo y acepto las <2>Condiciones de uso</2> y la <6>Política de privacidad</6> aplicables a la emisión y uso de este certificado.`
* `qes.qesAcknowledgementCheck` = `Reconozco que este proceso dará lugar a una Firma Electrónica Cualificada (FEC), que tiene el mismo efecto legal que una firma manuscrita en virtud de la legislación de la UE (eIDAS, Reglamento (UE) 910/2014).`
* `qes.qscdConfirmationCheck` = `Confirmo que la firma se ha creado utilizando un Dispositivo Cualificado de Creación de Firma (QSCD) y que mantengo el control exclusivo sobre el proceso de firma.`
* `redirect.didntReceiveLinkActions` = `¿No has recibido el enlace? <resend>Reenviar</resend> o <changePhone>Cambiar número de teléfono</changePhone>`
* `redirect.linkResent` = `Enlace reenviado correctamente`
* `redirect.linkSentTo` = `Para : {{phone}}`
* `signature.fullSignaturePlaceholder` = `Firme aquí`
* `signature.fullSignatureTitle` = `Dibuja tu firma`
* `signature.initialsPlaceholder` = `Dibuje aquí sus iniciales`
* `signature.initialsTitle` = `Escriba sus iniciales`
* `signature.subtitle` = `Utiliza el dedo o el ratón`
* `signature.successTitle` = `Firmado con éxito.`
* `userData.cpf` = `CPF`
* `v2.redirectToMobile.continueOnDesktop` = `Continuar en el escritorio`
* `v2.redirectToMobile.qr.description` = `Escanee el código QR para verificarlo en su dispositivo móvil.`
* `v2.redirectToMobile.sms.description` = `Introduzca su número de teléfono para recibir un enlace para verificar a través de SMS`
* `v2.redirectToMobile.sms.sendSms` = `Enviar enlace por SMS`
* `v2.redirectToMobile.subtitle` = `Necesitarás un documento de identidad válido y un selfie.`
* `v2.redirectToMobile.tabs.0` = `Escanear QR`
* `v2.redirectToMobile.tabs.1` = `Enviar SMS`
* `v2.redirectToMobile.title` = `Verifique su identidad`
* `v2.settings.language` = `Idioma`
* `validation.invalidDate` = `Fecha no válida`
* `verification.errors.countryNotSupported` = `Solicitud rechazada. País no admitido para EKYC.`
* `verification.errors.exactly10Characters` = `Debe tener exactamente 10 caracteres`
* `verification.errors.fieldRequiredDynamic` = `{{fieldName}} es necesario`
* `verification.errors.idNumRequired` = `Número de identificación nacional obligatorio`
* `verification.errors.invalidPostalCodeFixedLength` = `Introduzca un código postal de {{length}} dígitos`
* `verification.errors.onlyLettersAndNumbers` = `Sólo se permiten letras y números`
* `verification.errors.taxIdRequired` = `Se requiere NIF`
* `verification.labels.panNumber` = `Número PAN`
* `watchlistForBusiness.title` = `Lista de vigilancia para empresas`

## ✏️ Modified

* `aes.confirmSignature.addDocument`:
  * Old: `Añadir documento`
  * New: `Cargar documento`
* `aes.confirmSignature.fail`:
  * Old: `Algo salió mal..`
  * New: `Algo salió mal`
* `aes.confirmSignature.subtitle`:
  * Old: `Se firmarán los siguientes documentos`
  * New: `Acepte las condiciones que figuran a continuación para completar su firma.`
* `aes.confirmSignature.terms1.title`:
  * Old: `Acepto las condiciones del Centro de Confianza`
  * New: `Acepto las condiciones del <2>Centro de Confianza</2>`
* `aes.confirmSignature.title`:
  * Old: `Confirme su firma`
  * New: `Aceptar y firmar`
* `aes.confirmSignature.uploadDescription`:
  * Old: `Formato PDF compatible`
  * New: `Admite archivos PDF`
* `aes.confirmSignature.viewDocument`:
  * Old: `Ver documento`
  * New: `Ver`
* `documentCapture.review.error.description`:
  * Old: `Asegúrese de que toda la información del documento es clara y legible.`
  * New: `Algunas páginas no estaban claras o estaban incompletas. Recupere todas las páginas del documento para continuar.`
* `documentCapture.review.error.title`:
  * Old: `No se puede procesar`
  * New: `Es necesario recuperar el documento`
* `documentCapture.review.tryAgain`:
  * Old: `Inténtalo de nuevo`
  * New: `Documento de recaptura`
* `manualCapture.ariaLabel`:
  * Old: `botón de captura manual`
  * New: `capturar foto`
* `manualIdUpload.uploadPassport`:
  * Old: `Cargar pasaporte`
  * New: `Pasaporte`
* `userData.sex`:
  * Old: `Sexo`
  * New: `Género`
* `v2.idError.attemptsLeft_other`:
  * Old: `{{count}} intento restante`
  * New: `{{count}} intentos restantes`
* `verification.errors.surNameRequired`:
  * Old: `Apellidos obligatorios`
  * New: `Apellido obligatorio`

---

- Path: `release-notes/es-es-spanish-spain-2`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-2/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-2.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `documentCapture.multiPageDocument.step1.description` = `Asegúrese de que todo el documento está en el marco`
* `documentCapture.multiPageDocument.step1.title` = `Preparar la primera página`
* `documentCapture.multiPageDocument.step2.description` = `Asegúrese de que todo el documento está en el marco`
* `documentCapture.multiPageDocument.step2.title` = `Preparar la segunda página`
* `face.tutorial.startCapture` = `Hazte un selfie`
* `face.tutorial.subtitle` = `Esto te permite iniciar sesión utilizando tu cara.`
* `face.tutorial.title` = `Hazte un selfie`
* `idv2.flipAnimation.title` = `Muestre el reverso de su documento de identidad`

---

- Path: `release-notes/es-es-spanish-spain-3`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-3/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-3.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `common.attemptsRemaining_other` = `{{count}} intentos restantes`
* `common.attemptsRemaining_one` = `1 intento restante`
* `idv2.capture.processing.errors.wrongSide.back.subtitle` = `Captura del reverso del DNI`
* `idv2.capture.processing.errors.wrongSide.front.subtitle` = `Captura de la cara frontal del DNI`
* `idv2.needHelp.open` = `Abrir el modal Necesita ayuda`
* `notifications.centerFaceV2` = `Asegúrate de alinear la cara dentro de la silueta`
* `notifications.cropDescription` = `Por favor, inténtelo de nuevo con su cara centrada en el marco`
* `notifications.multipleDescription` = `Asegúrate de que sólo se ve una cara en el encuadre`
* `notifications.onFaceAngleV2` = `Alinear la cara dentro de la silueta blanca`
* `notifications.portraitDescription` = `Mantén el dispositivo en modo vertical`
* `notifications.selfie.manualCaptureButtonLabel` = `Botón de captura manual`
* `notifications.selfie.manualCaptureLabel` = `Captura manual activada. Pulse el botón para hacer la foto.`
* `notifications.unableToCropDescription` = `Por favor, inténtelo de nuevo con su cara claramente visible`
* `retake.titleFrontLabel` = `Revisar la foto de carné delantera`
* `selfiev2.manualCapture.instructions` = `Centra tu cara en la silueta y pulsa el botón para capturar`
* `tutorial.back.titleLabel` = `Ahora escanea el reverso de tu DNI`
* `webviews.step1` = `Ve a "Ajustes" → "Aplicaciones".`
* `webviews.step2` = `Buscar la aplicación`
* `webviews.step3` = `Permitir cámara`

---

- Path: `release-notes/es-es-spanish-spain-4`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-4/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-4.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `errors.dynamicImport.suggestion_other` = `Lo intentaremos de nuevo en {{count}} segundos o puede actualizar manualmente`
* `errors.dynamicImport.suggestion_one` = `Lo intentaremos de nuevo en {{count}} segundo o puede actualizar manualmente`
* `idv2.commonIssues.firstStep` = `1. Rellena el marco con tu DNI`
* `idv2.commonIssues.secondStep` = `2. Pulse el botón`
* `verification.labels.gender` = `Género`
* `verification.labels.idNum` = `Número nacional de identidad`
* `verification.labels.idNum1` = `Número de identificación fiscal`

## 🆕 Modified

* `notifications.selfieCaptureFailed`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `notifications.selfieCaptureFailedDescription`:
  * Before: `No pudimos capturar el selfie`
  * Now: `Tu selfie será revisada manualmente más tarde`
* `notifications.spoof`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `notifications.spoofDescription`:
  * Before: `No pudimos tomar tu selfie. Por favor intenta nuevamente `
  * Now: `No pudimos procesar tu selfie. Por favor, intenta de nuevo`
* `notifications.spoofDescriptionNoTries`:
  * Before: `No pudimos capturar selfie.`
  * Now: `Tu selfie será revisada manualmente más tarde`
* `retake.titleBack`:
  * Before: `Revisa la foto del <1>REVERSO</1> del documento`
  * Now: `Revisar la foto del DNI`
* `retake.titleFront`:
  * Before: `Revisa la foto del <1>FRENTE</1> del documento`
  * Now: `Revisar foto de carné FRONTAL`
* `retake.titlePassport`:
  * Before: `Revisión <1>PASAPORTE</1> foto`
  * Now: `Revisión PASAPORTE foto`
* `selfie.spoof`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `selfie.spoofDescription`:
  * Before: `No pudimos tomar tu selfie. Por favor intenta nuevamente`
  * Now: `No pudimos procesar tu selfie. Por favor, intenta de nuevo`
* `tutorial.back.title`:
  * Before: `Ahora escanea el <1>reverso</1> de tu DNI`
  * Now: `Ahora escanea el reverso de tu DNI`
* `videoSelfie.errors.noInternetConnectionDescription`:
  * Before: `Espera a que vuelva internet para continuar el proceso o conéctate a una red disponible`
  * Now: `Espera a que vuelva Internet para continuar el proceso o conéctate a una red disponible.`

---

- Path: `release-notes/es-es-spanish-spain-5`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-5/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-5.md

# ES-ES - Spanish (Spain)

## 🆕 Added

* `documentCapture.skip` = `Omitir este paso`
* `idv2.capture.processing.uploading` = `Cargando...`
* `idv2.deepsightPermissions.subtitle` = `permiso`
* `idv2.deepsightPermissions.title` = `Permitir cámara y movimiento `
* `idv2.permissions.allowPermissionsV2` = `Permitir permisos de cámara`
* `idv2.permissions.inOrderToCompleteTheProcess` = `para completar el proceso`
* `idv2.unacceptedId.acceptedDocuments` = `Documentos aceptados para:`
* `idv2.unacceptedId.attemptsLeft_one` = `({{count}} intento a la izquierda)`
* `idv2.unacceptedId.attemptsLeft_other` = `({{count}} quedan intentos)`
* `idv2.unacceptedId.birthCertificate` = `Partida de nacimiento`
* `idv2.unacceptedId.changeMethod` = `Cambiar el método de verificación`
* `idv2.unacceptedId.currency` = `Moneda`
* `idv2.unacceptedId.driversLicense` = `Permiso de conducir`
* `idv2.unacceptedId.federalId` = `Identificación federal`
* `idv2.unacceptedId.identificationCard` = `Tarjeta de identificación`
* `idv2.unacceptedId.identificationCardDescription` = `Sólo INE emitido a partir de 2017.`
* `idv2.unacceptedId.medicalCard` = `Tarjeta sanitaria`
* `idv2.unacceptedId.military` = `Militar`
* `idv2.unacceptedId.multipleNationalities` = `¿Múltiples nacionalidades?`
* `idv2.unacceptedId.noDocuments` = `No se aceptan documentos para este país`
* `idv2.unacceptedId.other` = `Otros`
* `idv2.unacceptedId.passport` = `Pasaporte`
* `idv2.unacceptedId.passportDescription` = `Solo pasaportes expedidos en 2014.`
* `idv2.unacceptedId.permit` = `Permiso`
* `idv2.unacceptedId.residenceDocument` = `Documento de residencia`
* `idv2.unacceptedId.seeDifferentCountry` = `Ver un país diferente`
* `idv2.unacceptedId.taxIdentification` = `Identificación fiscal`
* `idv2.unacceptedId.travelDocument` = `Documento de viaje`
* `idv2.unacceptedId.tribalIdentification` = `Identificación tribal`
* `idv2.unacceptedId.tryAgain` = `Inténtalo de nuevo`
* `idv2.unacceptedId.unknown` = `Desconocido`
* `idv2.unacceptedId.unknownCountry` = `Desconocido`
* `idv2.unacceptedId.vehicleRegistration` = `Matriculación de vehículos`
* `idv2.unacceptedId.visa` = `Visa`
* `idv2.unacceptedId.voterIdentification` = `Identificación de los votantes`
* `idv2.unacceptedId.weaponLicense` = `Licencia de armas`
* `notifications.accessDenied` = `Acceso denegado`
* `notifications.accessDeniedDescription` = `No hemos podido procesar tu selfie. Vuelve a intentarlo`
* `notifications.lowQualityImage` = `Condiciones de baja calidad`
* `notifications.lowQualityImageDescription` = `Quédese quieto para la captura, y asegúrese de que su cara es clara y visible`
* `notifications.noAttemptsRemaining` = `No quedan intentos`
* `videoSelfie.processingStep` = `Procesando...`

## ✏️ Modified

* `errors.dynamicImport.failedToLoad`:
  * Old: `Un error algo inesperado pero del que tomamos nota:`
  * New: `No esperábamos este error, pero estamos tomando nota.`
* `idv2.capture.processing.errors.unacceptable.title`:
  * Old: `No se acepta el tipo de identificación`
  * New: `Documento de identidad no aceptado`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Pulse Cámara → Permitir`
  * New: `Pulse Cámara <arrow/> Permitir`
* `idv2.permissions.denied.siteSettings`:
  * Old: `Ajustes → Ajustes del sitio`
  * New: `Ajustes <arrow/> Ajustes del sitio`

---

- Path: `release-notes/es-es-spanish-spain-6`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-6/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-6.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `
  desktop.idv2.digitalIdUpload.successfullyProcessed` = `Procesado con éxito.`
* `email.verified` = `Correo electrónico verificado.`
* `email.verify` = `Verifique su correo electrónico`
* `email.willSendCode` = `Te enviaremos un código para asegurarnos de que es tuyo`
* `geolocationv2.addressBar` = `En la barra de direcciones, pulse sobre <strong>AA</strong>`
* `geolocationv2.allowLocationAccess` = `Permitir el acceso a la ubicación`
* `geolocationv2.allowUsing` = `Seleccione <strong>Permitir durante el uso</strong>`
* `geolocationv2.appsBrowser` = `Ir a <strong>Apps <arrow/> Tu navegador</strong>`
* `geolocationv2.appsChrome` = `Ir a <strong>Aplicaciones <arrow/> Chrome</strong>`
* `geolocationv2.appsFirefox` = `Ir a <strong>Aplicaciones <arrow/> Firefox</strong>`
* `geolocationv2.appsOpera` = `Ir a <strong>Apps <arrow/> Opera</strong>`
* `geolocationv2.choosePermissions` = `Elija <strong>Preguntar la próxima vez</strong> o <strong>Mientras usa la aplicación</strong>`
* `geolocationv2.determineLocation` = `Necesitamos determinar su ubicación actual`
* `geolocationv2.goBackSafari` = `Volver a <strong>Ajustes <arrow/> Safari</strong>`
* `geolocationv2.instructions.allowLocation` = `Permitir permisos de ubicación`
* `geolocationv2.locationOn` = `Asegúrate de que <strong>los servicios de localización</strong> están activados`
* `geolocationv2.openSettings` = `Abrir la<strong> configuración</strong>`
* `geolocationv2.openSettingsAndroid` = `Abre <strong>los ajustes de</strong> tu dispositivo`
* `geolocationv2.permissionsLocation` = `Toque <strong>Permisos <arrow/> Ubicación</strong>`
* `geolocationv2.privacySecurity` = `<strong>Privacidad y seguridad</strong> abiertas`
* `geolocationv2.refreshPage` = `Actualizar página`
* `geolocationv2.returnAndRefresh` = `Volver aquí y <strong>Actualizar página</strong>`
* `geolocationv2.scrollDownChrome` = `Desplácese hacia abajo y pulse <strong>Chrome</strong>`
* `geolocationv2.scrollDownFirefox` = `Desplázate hacia abajo y pulsa <strong>Firefox</strong>`
* `geolocationv2.scrollDownOpera` = `Desplácese hacia abajo y pulse <strong>Opera</strong>`
* `geolocationv2.skip` = `Omitir este paso`
* `geolocationv2.tapLocation` = `<strong>Ubicación del</strong> grifo`
* `geolocationv2.tapLocationAllow` = `Pulse <strong>Ubicación</strong> y seleccione <strong>Permitir</strong>`
* `geolocationv2.tapSettings` = `Toque <strong>Configuración del sitio web <arrow/><br>Permitir permisos de ubicación</strong>`
* `idv2.capture.notifications.expiredId` = `Documento de identidad caducado`
* `idv2.capture.notifications.useDifferent` = `Utilizar un ID diferente`
* `idv2.capture.processing.processing` = `Procesando...`
* `idv2.capture.processing.scanFront` = `Escanear el anverso`
* `idv2.capture.processing.successBackSubtitleScanFront` = `Ahora vamos a capturar la parte delantera`
* `idv2.chooser.chooseHowToVerifyTitle` = `Elija cómo verificar`
* `idv2.chooser.digitalIdUploadButtonTitle` = `Cargar ID digital`
* `idv2.chooser.manualUploadButtonTitle` = `Cargar ID`
* `idv2.digitalIdUpload.analyzing` = `Analizar...`
* `idv2.digitalIdUpload.digitalIdUploadButtonTitle` = `Cargar DNI digital`
* `idv2.digitalIdUpload.errorScreen.scanId` = `Escanee su DNI`
* `idv2.digitalIdUpload.loadingSuccess.letsContinue` = `Continuemos`
* `idv2.digitalIdUpload.reviewScreen.description` = `Asegúrese de que se trata del archivo correcto antes de continuar con el proceso de verificación.`
* `idv2.digitalIdUpload.reviewScreen.replaceButton` = `Sustituir archivo`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton` = `Continúe en`
* `idv2.digitalIdUpload.reviewScreen.title` = `Revise su documento`
* `idv2.digitalIdUpload.screenDescription` = `Un archivo PDF o una foto emitida por el gobierno con sus datos, foto y un código QR`
* `idv2.digitalIdUpload.screenTitle` = `Cargue su DNI digital`
* `idv2.digitalIdUpload.supportedFileTypesCopy` = `Archivo PDF o foto JPG, PNG`
* `idv2.digitalIdUpload.unknownDocumentTypeScreen.errorTitle` = `No se ha podido verificar su ID`
* `idv2.digitalIdUpload.wrongDocumentType` = `Documento de identidad no aceptado`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorSubtitle` = `Utilice un ID diferente de la lista aceptada:`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorTitle` = `Documento de identidad no aceptado`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.tryAgainButton` = `Inténtalo de nuevo`
* `idv2.manualUploadLoading.subtitle` = `Cargar el archivo`
* `idv2.permissions.denied.chrome.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.chrome.firstStep` = `En la parte superior izquierda de la página web, <strong>haga clic en el candado</strong>`
* `idv2.permissions.denied.chrome.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.chrome.secondStep` = `Se abrirá un pequeño menú`
* `idv2.permissions.denied.chrome.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.firefox.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.firefox.firstStep` = `Haz clic en la <strong>cámara</strong> o en el icono <strong>del candado</strong> `
* `idv2.permissions.denied.firefox.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.firefox.secondStep` = `Se abrirá un menú`
* `idv2.permissions.denied.firefox.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.opera.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.opera.firstStep` = `Haga clic en el icono <strong>del candado</strong> `
* `idv2.permissions.denied.opera.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.opera.secondStep` = `Se abrirá un pequeño menú`
* `idv2.permissions.denied.opera.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.safari.fifthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.safari.firstStep` = `En la parte superior izquierda, haga clic en <strong>Safari</strong>`
* `idv2.permissions.denied.safari.fourthStep` = `Busca donde pone <strong>Cámara</strong>`
* `idv2.permissions.denied.safari.secondStep` = `Haga clic en <strong>Configuración de este sitio web...</strong>`
* `idv2.permissions.denied.safari.sixthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.safari.thirdStep` = `Aparecerá un cuadro`
* `nameCapturev2.title` = `Introduzca su nombre`
* `nameCapturev2.verified` = `¡Nombre verificado!`
* `otp.didntReceive` = `¿No ha recibido el código?`
* `otp.enterCodeEmail` = `Introduce el código que te hemos enviado a tu correo electrónico`
* `otp.errorv2` = `Código caducado, inténtelo de nuevo`
* `otp.resendCode` = `Reenviar código`
* `otp.resendCountdown` = `Reenvío de código en <strong>{{time}}s</strong>`
* `redirect.didntReceive` = `¿No has recibido el enlace?`
* `redirect.enterPhoneNumber` = `Introduzca su número de teléfono para recibir un enlace para verificar a través de SMS`
* `redirect.linkSent` = `Enlace enviado.`
* `redirect.phishingResistance.explanation1` = `Necesitarás un documento de identidad válido y un selfie.`
* `redirect.phishingResistance.recommendedBrowser` = `Recomendamos utilizar Safari en iOS y Chrome en Android.`
* `redirect.phishingResistance.titleClient` = `Verifique su identidad`
* `redirect.resend` = `Vuelva a enviar`
* `redirect.scanQRTitle` = `Escanear QR`
* `redirect.scanQrv2` = `Escanee el código QR para verificarlo en su dispositivo móvil.`
* `redirect.sendLinkSms` = `Enviar enlace por SMS`
* `redirect.sendSms` = `Enviar SMS`

---

- Path: `release-notes/es-es-spanish-spain-7`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-7/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-7.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `curp.continue` = `Continuar`
* `curp.dontHave` = `No tengo CURP`
* `curp.enterCurp` = `Introduzca su CURP`
* `curp.generate` = `Genera tu CURP`
* `curp.generateCta` = `Generar`
* `curp.labels.birthState` = `Estado de nacimiento`
* `curp.labels.dob` = `Fecha de nacimiento`
* `curp.labels.femaleV2` = `Mujer`
* `curp.labels.firstLast` = `Nombre Apellido`
* `curp.labels.firstName` = `Nombre`
* `curp.labels.genderV2` = `Género`
* `curp.labels.maleV2` = `Hombre`
* `curp.labels.other` = `No binario/Otro`
* `curp.labels.secondLast` = `Segundo apellido`
* `curp.placeholder.curp` = `Su CURP`
* `curp.placeholder.firstLast` = `Su nombre y apellidos`
* `curp.placeholder.firstName` = `Su nombre`
* `curp.placeholder.gender` = `Elige género`
* `curp.placeholder.secondLast` = `Su segundo apellido`
* `curp.placeholder.state` = `Seleccionar estado`
* `curp.status.checkInfo` = `Compruebe la información introducida`
* `curp.status.confirm` = `Confirme su CURP`
* `curp.status.couldntGenerate` = `No se ha podido generar CURP`
* `curp.status.edit` = `Editar información`
* `curp.status.generating` = `Generar CURP...`
* `curp.status.notVerified` = `CURP no verificado`
* `curp.status.tryAgain` = `Inténtalo de nuevo`
* `curp.status.verified` = `¡CURP verificado!`
* `curp.status.verifying` = `Verificando su CURP...`
* `faceMatch.continue` = `Continúe en`
* `faceMatch.facesNoMatch` = `Las caras no coinciden`
* `faceMatch.firstId` = `Primera identificación`
* `faceMatch.id` = `ID`
* `faceMatch.matched` = `¡Emparejado!`
* `faceMatch.matching` = `Verificación de la identidad`
* `faceMatch.processing` = `Procesando...`
* `faceMatch.secondId` = `Segunda identificación`
* `faceMatch.selfie` = `Selfie`
* `face.tutorial.ageAssuranceStartCapture` = `Verificar la edad`
* `face.tutorial.ageAssuranceSubtitle` = `Su imagen no se almacenará ni se compartirá con terceros para proteger su intimidad.`
* `face.tutorial.ageAssuranceTitle` = `Hazte un selfie para verificar tu edad`
* `face.tutorial.autoCapture` = `Quédate quieto, el selfie se tomará automáticamente`
* `home.start` = `Inicio`
* `idv2.ageVerificationPage.ageVerification` = `Verificación de la edad`
* `idv2.ageVerificationPage.Continue` = `Continúe en`
* `idv2.ageVerificationPage.showYourIdAndScanIt` = `Muestra tu DNI y escanéalo`
* `idv2.ageVerificationPage.TheRestOfYourInformationWillBeDeletedToEnsureYourPrivacy` = `El resto de tu información se eliminará para garantizar tu privacidad.`
* `idv2.ageVerificationPage.weNeedToScanYourIDToKnowYourAge` = `Necesitamos escanear tu DNI para saber tu edad`
* `idv2.ageVerificationPage.weOnlyUseTheDateOfBirthInformation` = `Sólo utilizamos los datos de la fecha de nacimiento`
* `idv2.barCodeDetection.processingSubtitle` = `Estamos verificando su identidad`
* `idv2.barCodeDetection.processingTitle` = `Espera un segundo...`
* `idv2.capture.processing.verifying` = `Verificando...`
* `idv2.digitalIdUpload.continue` = `Continuar`
* `idv2.digitalIdUpload.errorScreen.pleaseTryScanning` = ` Por favor, intente escanear un documento diferente`
* `idv2.digitalIdUpload.errorScreen.thisIdMustBeScanned` = `Esta identificación debe escanearse`
* `idv2.digitalIdUpload.reviewScreen.continue` = `Continuar`
* `idv2.digitalIdUpload.successfullyProcessed` = `Procesado con éxito.`
* `onboarding.errors.invalidQRuuid.message` = `Parece que tu URL no es válida o ha caducado`
* `onboarding.errors.invalidQRuuid.title` = `Su URL no es válida`
* `otp.enterCodeSMS` = `Introduzca el código que le hemos enviado por SMS`
* `phone.verify` = `Verifique su número de teléfono`
* `redirect.resendCountdown` = `Reenviar enlace en <strong>{{time}}s</strong>`
* `verification.failureTitle` = `Algo salió mal`
* `verification.labels.addressDetailsSection` = `Dirección`
* `verification.labels.dlDetailsSection` = `Datos del permiso de conducir`
* `verification.placeholder.email` = `email@example.com`
* `verification.placeholder.firstName` = `Su nombre`
* `verification.placeholder.lastName` = `Su apellido`
* `verification.placeholder.maternalSurname` = `Su apellido materno`
* `verification.placeholder.middleName` = `Su segundo nombre`
* `verification.placeholder.stateCode` = `Por ejemplo {{states}}`
* `verification.placeholder.surname` = `Su apellido`
* `verification.submitButton` = `Continúe en`
* `verification.successTitle` = `eKYC verificado`
* `verification.tryAgain` = `Inténtalo de nuevo`

## ✏️ Modified

* `idv2.capture.processing.scanFront`:
  * Old: `Escanear el anverso`
  * New: `Escanea el frente`
* `idv2.capture.processing.successBackSubtitleScanFront`:
  * Old: `Ahora vamos a capturar la parte delantera`
  * New: `Ahora capturemos el frente`
* `idv2.chooser.chooseHowToVerifyTitle`:
  * Old: `Elija cómo verificar`
  * New: `Seleccione cómo verificar`
* `idv2.digitalIdUpload.reviewScreen.title`:
  * Old: `Revise su documento`
  * New: `Revisar documento`
* `idv2.digitalIdUpload.screenDescription`:
  * Old: `Un archivo PDF o una foto emitida por el gobierno con sus datos, foto y un código QR`
  * New: `Un archivo PDF emitido por el gobierno con sus datos, foto y un código QR`
* `idv2.digitalIdUpload.screenTitle`:
  * Old: `Cargue su DNI digital`
  * New: `Cargar ID digital`
* `otp.resendCountdown`:
  * Old: `Reenvío de código en <strong>{{time}}s</strong>`
  * New: `Reenvío de código en {{time}}s`
* `verification.labels.state`:
  * Old: `Código estatal (por ejemplo, {{states}})`
  * New: `Código del Estado`

---

- Path: `release-notes/es-es-spanish-spain-8`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-8/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-8.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `commonIssues.blurPresent` = `Desenfoque presente`
* `commonIssues.blurPresentDescription` = `Aleja o acerca el ID al teléfono hasta que la imagen esté enfocada`
* `commonIssues.glarePresent` = `Resplandor presente`
* `commonIssues.glarePresentDescription` = `Inclina el ID ligeramente hacia arriba o hacia abajo para minimizar el reflejo`
* `commonIssues.notReadable` = `La información no es legible`
* `commonIssues.notReadableDescription` = `Minimiza el movimiento de la cámara sujetando el teléfono con firmeza`
* `encryptionLabel.encryptedPhotos` = `Todos los datos están encriptados`
* `home.goToSettings` = `Ir a la configuración`
* `idv2.backTutorial.disclaimer` = `La captura se realizará automáticamente`
* `idv2.backTutorial.subtitle` = `Asegúrese de que su documento de identidad sea legible`
* `idv2.backTutorial.title` = `Muestre el reverso de su documento de identidad`
* `idv2.capture.allDataIsEncrypted` = `Todos los datos están encriptados`
* `idv2.permissions.allowV2` = `Permitir`
* `idv2.permissions.subtitleV2` = `Esto permite a la cámara realizar la captura necesaria para la verificación`
* `idv2.reverseFlipAnimation.title` = `Muestre el anverso de su documento de identidad`
* `notifications.faceOccluded` = `Rostro cubierto`
* `notifications.faceOccludedDescription` = `Asegúrate de que tu cara sea clara y visible.`
* `selfiev2.manualCapture.captureButton` = `Tomar foto`

## ✏️ Modified

* `commonIssues.takeManually`:
  * Old: `Haz la foto manualmente`
  * New: `Hacer la foto manualmente`
* `face.tutorial.autoCapture`:
  * Old: `Quédate quieto, el selfie se tomará automáticamente`
  * New: `No te muevas, la selfie se tomará automáticamente`
* `face.tutorial.subtitle`:
  * Old: `Esto te permite iniciar sesión utilizando tu cara.`
  * New: `Mantén una expresión neutra, busca una luz equilibrada y quítate las gafas y los sombreros`
* `idv2.capture.autoCapture`:
  * Old: `La foto se tomará automáticamente`
  * New: `La captura se realizará automáticamente`
* `idv2.capture.fillFrameBack`:
  * Old: `Rellena el marco con tu identificación dorsal`
  * New: `Enmarca el reverso de tu DNI`
* `idv2.capture.fillFrameFront`:
  * Old: `Rellena el marco con tu DNI`
  * New: `Encuadre el anverso de su DNI`
* `idv2.permissions.allowPermissionsV2`:
  * Old: `Permitir permisos de cámara`
  * New: `Permitir el acceso a la cámara`
* `idv2.permissions.dontAllow`:
  * Old: `No permita`
  * New: `No permita que`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Sólo utilizamos la cámara para capturar su identificación para la verificación segura`
  * New: `Sólo utilizamos la cámara para el proceso de verificación.`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `Ayuda a verificar la autenticidad de los documentos y a prevenir el fraude de identidad.`
  * New: `El proceso de verificación garantiza que usted es quien dice ser.`
* `idv2.tutorial.autoCapture`:
  * Old: `La foto se tomará automáticamente`
  * New: `La captura se realizará automáticamente`
* `idv2.tutorial.title`:
  * Old: `Escanee su DNI`
  * New: `Muestre el anverso de su documento de identidad`
* `notifications.selfieCaptureFailedDescription`:
  * Old: `Tu selfie será revisada manualmente más tarde`
  * New: `Se alcanzó el número máximo de intentos`
* `notifications.spoofDescriptionNoTries`:
  * Old: `Tu selfie será revisada manualmente más tarde`
  * New: `Se alcanzó el número máximo de intentos`

---

- Path: `release-notes/es-es-spanish-spain-9`
- URL: https://developer.incode.com/release-notes/es-es-spanish-spain-9/
- Markdown: https://developer.incode.com/release-notes/es-es-spanish-spain-9.md

# ES - ES - Spanish (Spain)

## 🆕 Added

* `ekyb.addressDetails` = `Dirección`
* `ekyb.continue` = `Continúe en`
* `ekyb.error.title` = `Algo salió mal`
* `ekyb.processing` = `Tratamiento`
* `ekyb.success` = `Éxito`
* `ekyb.tryAgain` = `Inténtalo de nuevo`
* `idv2.capture.manualCapture.modeSwitchAriaAnnouncement` = `Ahora utiliza el modo de captura manual. Pulse el botón para capturar la foto.`
* `idv2.capture.v2.autoCapture` = `La foto se tomará automáticamente`
* `idv2.capture.v2.fillFrameBack` = `Rellena el marco con tu identificación dorsal`
* `idv2.capture.v2.fillFrameFront` = `Rellena el marco con tu DNI`
* `idv2.tutorial.v2.autocapture` = `La foto se tomará automáticamente`
* `idv2.tutorial.v2.title` = `Escanee su DNI`
* `otp.groupLabel` = `Código de verificación de {{charLength}} dígitos`
* `v2.capture.label` = `Todas las fotos están encriptadas`
* `v2.idError.attemptsLeft_one` = `{{count}} intento restante`
* `v2.idError.attemptsLeft_other` = `{{count}} intento restante`
* `v2.idSuccess.subtitle` = `Ahora vamos a capturar la parte de atrás`
* `v2.idSuccess.subtitleBack` = `Continuemos`
* `v2.idSuccess.title` = `Procesado con éxito.`
* `v2.selfie.camera.loading` = `Cargando...`

---

- Path: `release-notes/es-spanish`
- URL: https://developer.incode.com/release-notes/es-spanish/
- Markdown: https://developer.incode.com/release-notes/es-spanish.md

# ES - Spanish

## 🆕 Added

* `idv2.permissions.fakeDenied.alert` = `alerta falsa centrada`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permisos`
* `idv2.permissions.fakeDenied.quitProcess` = `Abandonar el proceso`
* `idv2.permissions.fakeDenied.title` = `Se requiere permiso de cámara para la captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `advertencia`

---

- Path: `release-notes/es-spanish-1`
- URL: https://developer.incode.com/release-notes/es-spanish-1/
- Markdown: https://developer.incode.com/release-notes/es-spanish-1.md

# ES - Spanish

## 🆕 Added

* `documentCapture.multiPageDocument.step1.description` = `Asegúrese de que todo el documento está en el marco`
* `documentCapture.multiPageDocument.step1.title` = `Preparar la primera página`
* `documentCapture.multiPageDocument.step2.description` = `Asegúrese de que todo el documento está en el marco`
* `documentCapture.multiPageDocument.step2.title` = `Preparar la segunda página`
* `face.tutorial.startCapture` = `Hazte un selfie`
* `face.tutorial.subtitle` = `Esto te permite iniciar sesión utilizando tu cara.`
* `face.tutorial.title` = `Hazte un selfie`
* `idv2.flipAnimation.title` = `Muestre el reverso de su documento de identidad`

## ✏️ Modified

* `idv2.permissions.subtitle`:
  * Before: `permitir permiso de cámara`
  * Now: `permita acceso a la cámara`
* `notifications.fitOverlay`:
  * Before: `Acerca la credencial para llenar el recuadro`
  * Now: `Asegúrate de que la credencial quede dentro del recuadro`
* `notifications.frontClassificationFailed`:
  * Before: `Error en el escaneado de ID`
  * Now: `Error en el escaneado de documento`
* `notifications.idScanFailed`:
  * Before: `Error en el escaneado de ID`
  * Now: `Error en el escaneado de documento`
* `notifications.outOfFocusChange`:
  * Before: `Revisa el lente de la cámara y las condiciones de captura`
  * Now: `Asegúrate de que el documento no esté borroso ni obstruido`
* `settings.selectLanguage`:
  * Before: `Escoge tu idioma`
  * Now: `Escoge tu país/idioma`

---

- Path: `release-notes/es-spanish-10`
- URL: https://developer.incode.com/release-notes/es-spanish-10/
- Markdown: https://developer.incode.com/release-notes/es-spanish-10.md

# ES - Spanish

## 🆕 Added

* `aes.confirmSignature.finishSigning` = `Terminar de firmar`
* `aes.reviewDocument.subtitle` = `Asegúrate de que has seleccionado el archivo correcto antes de seguir firmando.`
* `aes.reviewDocument.title` = `Revise su documento`
* `biometricConsent. consentOptions` = `Opciones de consentimiento`
* `common.done` = `¡Hecho!`
* `common.wontTakeLong` = `Esto no llevará mucho tiempo.`
* `curp.verifyManually` = `Verificar manualmente`
* `customFields.completed` = `¡Terminado!`
* `customFields.continue` = `Continúe en`
* `customFields.processing` = `Procesando...`
* `customFields.title` = `Introduzca sus datos`
* `customWatchlist.done` = `¡Hecho!`
* `customWatchlist.wontTake` = `Esto no llevará mucho tiempo.`
* `digilocker.denied.tryAgain` = `Inténtalo de nuevo`
* `documentCapture.button.allPagesCaptured` = `Todas las páginas capturadas`
* `documentCapture.button.nextPage` = `Página siguiente`
* `documentCapture.tutorial.continue` = `Continúe en`
* `documentCapture.tutorial.multiPageDocument.optionalPage.subtitle` = `Si hay otra página con información relevante, puede capturarla ahora.`
* `ekyb.addAnotherDirector` = `Añadir otro Director (Opcional)`
* `ekyb.directorNameWithNumber` = `Director {{number}} Nombre`
* `ekyb.directorSurnameWithNumber` = `Director {{number}} Apellidos`
* `ekyb.error.taxId-cn` = `Introduzca un código de crédito social unificado chino válido (18 caracteres alfanuméricos)`
* `ekyb.error.taxId-de` = `Introduzca un número de identificación fiscal alemán válido: IVA (DE + 9 dígitos), HRB (3-6 dígitos), HRB (6 dígitos + letra) o HRA (4-6 dígitos).`
* `ekyb.error.taxId-es` = `Introduzca un NIF español válido: NIF (letra + 8 dígitos), NIE (letra + 7 dígitos + letra), o DNI (8 dígitos + letra)`
* `ekyb.error.taxId-gb` = `Introduzca un número de identificación fiscal válido en el Reino Unido: Número de registro (7-8 dígitos) o Número de IVA (GB seguido de 9 dígitos, o 9 dígitos solos).`
* `ekyb.error.taxId-il` = `Introduzca un Mispar Osek israelí válido (9 dígitos)`
* `ekyb.error.taxId-it` = `Introduzca un número de identificación fiscal italiano válido: CCIAA/NREA (2 letras + 6-7 dígitos), identificación de la empresa (IT + 8 dígitos) o código fiscal/IVA (11 dígitos).`
* `ekyb.error.taxId-mx` = `Introduzca un RFC mexicano válido: Individual (4 letras + 6 dígitos + 3 alfanuméricos) o Empresarial (3 letras + 6 dígitos + 3 alfanuméricos).`
* `ekyb.error.taxId-ng` = `Introduzca un NIF nigeriano válido (10 dígitos)`
* `ekyb.error.taxId-nl` = `Introduzca un número de identificación fiscal holandés válido: Número de IVA (NL + 9 dígitos + B + 2 dígitos) o número KvK (8 dígitos)`
* `email.placeholder` = `Correo electrónico`
* `forms.placeholder.select` = `Seleccione una opción`
* `identityReuse.cta.continue` = `Continuar con la verificación rápida`
* `identityReuse.cta.verify` = `Verificar con el DNI`
* `identityReuse.description` = `Sólo transferiremos los datos solicitados por {{companyName}} para completar su verificación`
* `identityReuse.subtitle` = `Se ha verificado previamente con uno de nuestros socios. Comparte tus datos para ahorrar tiempo y verificar más rápido.`
* `identityReuse.title` = `Comparte tus datos para una verificación más rápida`
* `idOcr.title` = `Compruebe sus datos`
* `idv2.capture.expiredId.idScanFailed` = `Error en el escaneado de ID`
* `idv2.capture.expiredId.pleaseTryWithADifferentId` = `Inténtelo con otro documento`
* `idv2.capture.notifications.idScanFailed` = `Error en el escaneado de ID`
* `idv2.capture.processing.attemptsRemainingLabel` = `intentos restantes`
* `idv2.capture.processing.noAttemptsRemaining` = `No quedan intentos`
* `idv2.chooser.appleWallet` = `Cartera Apple`
* `idv2.chooser.deviceWalletTag` = `Instantánea`
* `idv2.chooser.googleWallet` = `Google Wallet`
* `idv2.digilocker.consentDeniedDescription` = `No se ha proporcionado el consentimiento para compartir documentos a través de DigiLocker. Puede volver a intentarlo o elegir otra forma de verificación.`
* `idv2.digilocker.consentDeniedTitle` = `Consentimiento denegado`
* `idv2.digilocker.openingDigilockerForAuthentication` = `Abrir DigiLocker para la autenticación..`
* `idv2.digilocker.sessionErrorDescription` = `No se ha podido restaurar la sesión. Por favor, reinicie el proceso de verificación.`
* `idv2.digilocker.sessionErrorTitle` = `Error de sesión`
* `idv2.digilocker.takingYouToDigilocker` = `Llevándote a DigiLocker..`
* `idv2.digilocker.timeoutDescription` = `La solicitud de DigiLocker no se ha completado en el tiempo previsto. Vuelva a intentarlo o seleccione un método de verificación alternativo.`
* `idv2.digilocker.timeoutTitle` = `La sesión ha terminado..`
* `idv2.digilocker.verificationCompleteTitle` = `Identidad verificada correctamente`
* `idv2.digitalIdUpload.fileTooLargeScreen.cta` = `Elija otro archivo`
* `idv2.digitalIdUpload.fileTooLargeScreen.subtitle` = `El archivo seleccionado pesa más de 5 MB, cargue uno más pequeño`
* `idv2.digitalIdUpload.fileTooLargeScreen.title` = `El archivo es demasiado grande`
* `idv2.permissions.denied.cameraFindSiteAllow` = `Cámara <arrow/> Buscar sitio <arrow/> Permitir`
* `loadingCircle.preparingCamera` = `Preparar la cámara`
* `manualIdUpload.generic` = `Por favor, cargue el documento correcto`
* `manualIdUpload.glareDetected` = ` Resplandor presente`
* `manualIdUpload.hintIdReadable` = `Asegúrese de que el texto de la identificación sea legible.`
* `manualIdUpload.hintPassportReadable` = `Asegúrese de que el texto del pasaporte es legible.`
* `manualIdUpload.hintSharpAndGlareFree` = `La foto debe ser nítida y sin reflejos.`
* `manualIdUpload.lowSharpness` = `Desenfoque presente`
* `manualIdUpload.qualityRejected` = `La calidad de la imagen es demasiado baja.`
* `manualIdUpload.readabilityIssue` = `La información no es legible`
* `manualIdUpload.subtitle` = `Asegúrese de que su documento de identidad sea legible`
* `manualIdUpload.uploadingSubtitle` = `Cargar el archivo`
* `manualIdUpload.uploadingTitle` = `Espera un segundo...`
* `manualIdUpload.wrongDocument` = `Por favor, cargue el documento correcto`
* `onboarding.errors.onboardingUrlAlreadyUsed.message` = `Parece que esta URL ya está en uso`
* `onboarding.errors.onboardingUrlAlreadyUsed.title` = `Su URL no es válida`
* `otp.resendCodeAvailable` = `Ahora puede volver a enviar el código`
* `otp.timerFiveSeconds` = `Quedan 5 segundos`
* `otp.timerStarted` = `Puede solicitar un nuevo código en {{ time }} segundos`
* `otp.timerTenSeconds` = `Quedan 10 segundos para solicitar un nuevo código`
* `otp.verificationCode` = `Código de verificación`
* `phone.invalidPhone` = `Número de teléfono no válido. Inténtelo de nuevo.`
* `phone.optIn` = `Acepto recibir notificaciones por SMS`
* `phone.serverError` = `Algo ha ido mal. Vuelva a intentarlo más tarde.`
* `qes.documentsReviewedCheck` = `Confirmo que he revisado los documentos a firmar indicados anteriormente antes de proceder con la firma.`
* `qes.issuanceCheck` = `Acepto la emisión de un Certificado Cualificado para firma electrónica por parte de Incode Czech Republic s.r.o., actuando como Prestador de Servicios de Confianza Cualificado (QTSP).`
* `qes.newTermsCheck` = `He leído, comprendido y acepto los <2>Términos de Uso</2> y la <6>Política de Privacidad</6> plicables a la emisión y uso de este certificado.`
* `qes.qesAcknowledgementCheck` = `Reconozco que este proceso dará como resultado una Firma Electrónica Cualificada (QES), que tiene el mismo efecto jurídico que una firma manuscrita conforme a la legislación de la UE (eIDAS, Reglamento (UE) 910/2014).`
* `qes.qscdConfirmationCheck` = `Confirmo que la firma se crea mediante un Dispositivo Cualificado de Creación de Firmas (QSCD) y que mantengo el control exclusivo sobre el proceso de firma.`
* `redirect.didntReceiveLinkActions` = `¿No has recibido el enlace? <resend>Reenviar</resend> o <changePhone>Cambiar número de teléfono</changePhone>`
* `redirect.linkResent` = `Enlace reenviado correctamente`
* `redirect.linkSentTo` = `Para : {{phone}}`
* `signature.fullSignaturePlaceholder` = `Firme aquí`
* `signature.fullSignatureTitle` = `Dibuja tu firma`
* `signature.initialsPlaceholder` = `Dibuje aquí sus iniciales`
* `signature.initialsTitle` = `Escriba sus iniciales`
* `signature.subtitle` = `Utiliza el dedo o el ratón`
* `signature.successTitle` = `Firmado con éxito.`
* `userData.cpf` = `CPF`
* `v2.redirectToMobile.continueOnDesktop` = `Continuar en el escritorio`
* `v2.redirectToMobile.qr.description` = `Escanee el código QR para verificarlo en su dispositivo móvil.`
* `v2.redirectToMobile.sms.description` = `Introduzca su número de teléfono para recibir un enlace para verificar a través de SMS`
* `v2.redirectToMobile.sms.sendSms` = `Enviar enlace por SMS`
* `v2.redirectToMobile.subtitle` = `Necesitarás un documento de identidad válido y un selfie.`
* `v2.redirectToMobile.tabs.0` = `Escanear QR`
* `v2.redirectToMobile.tabs.1` = `Enviar SMS`
* `v2.redirectToMobile.title` = `Verifique su identidad`
* `v2.settings.language` = `Idioma`
* `validation.invalidDate` = `Fecha no válida`
* `verification.errors.countryNotSupported` = `Solicitud rechazada. País no admitido para EKYC.`
* `verification.errors.exactly10Characters` = `Debe tener exactamente 10 caracteres`
* `verification.errors.fieldRequiredDynamic` = `{{fieldName}} es necesario`
* `verification.errors.idNumRequired` = `Número de identificación nacional obligatorio`
* `verification.errors.invalidPostalCodeFixedLength` = `Introduzca un código postal de {{length}} dígitos`
* `verification.errors.onlyLettersAndNumbers` = `Sólo se permiten letras y números`
* `verification.errors.taxIdRequired` = `Se requiere NIF`
* `verification.labels.panNumber` = `Número PAN`
* `watchlistForBusiness.title` = `Lista de vigilancia para empresas`

## ✏️ Modified

* `aes.confirmSignature.addDocument`:
  * Old: `Añadir documento`
  * New: `Cargar documento`
* `aes.confirmSignature.fail`:
  * Old: `Algo salió mal..`
  * New: `Algo salió mal`
* `aes.confirmSignature.subtitle`:
  * Old: `Se firmarán los siguientes documentos`
  * New: `Acepte las condiciones que figuran a continuación para completar su firma.`
* `aes.confirmSignature.terms1.title`:
  * Old: `Acepto las condiciones del Centro de Confianza`
  * New: `Acepto las condiciones del <2>Centro de Confianza</2>`
* `aes.confirmSignature.title`:
  * Old: `Confirme su firma`
  * New: `Aceptar y firmar`
* `aes.confirmSignature.uploadDescription`:
  * Old: `Formato PDF compatible`
  * New: `Admite archivos PDF`
* `aes.confirmSignature.viewDocument`:
  * Old: `Ver documento`
  * New: `Ver`
* `documentCapture.review.error.description`:
  * Old: `Asegúrese de que toda la información del documento es clara y legible.`
  * New: `Algunas páginas no estaban claras o estaban incompletas. Recupere todas las páginas del documento para continuar.`
* `documentCapture.review.error.title`:
  * Old: `No se puede procesar`
  * New: `Es necesario recuperar el documento`
* `documentCapture.review.tryAgain`:
  * Old: `Inténtalo de nuevo`
  * New: `Documento de recaptura`
* `manualCapture.ariaLabel`:
  * Old: `botón de captura manual`
  * New: `capturar foto`
* `manualIdUpload.uploadPassport`:
  * Old: `Cargar pasaporte`
  * New: `Pasaporte`
* `userData.sex`:
  * Old: `Sexo`
  * New: `Género`
* `v2.idError.attemptsLeft_other`:
  * Old: `{{count}} intento restante`
  * New: `{{count}} intentos restantes`
* `verification.errors.maternalSurnameRequired`:
  * Old: `Se requiere el apellido materno`
  * New: `El apellido materno es obligatorio`
* `verification.errors.surNameRequired`:
  * Old: `Apellidos son requeridos`
  * New: `Apellido obligatorio`

---

- Path: `release-notes/es-spanish-2`
- URL: https://developer.incode.com/release-notes/es-spanish-2/
- Markdown: https://developer.incode.com/release-notes/es-spanish-2.md

# ES - Spanish

## 🆕 Added

* `common.attemptsRemaining_other` = `{{count}} intentos restantes`
* `common.attemptsRemaining_one` = `1 intento restante`
* `idv2.capture.processing.errors.wrongSide.back.subtitle` = `Captura del reverso del DNI`
* `idv2.capture.processing.errors.wrongSide.front.subtitle` = `Captura de la cara frontal del DNI`
* `idv2.needHelp.open` = `Abrir el modal Necesita ayuda`
* `notifications.centerFaceV2` = `Asegúrate de alinear la cara dentro de la silueta`
* `notifications.cropDescription` = `Por favor, inténtelo de nuevo con su cara centrada en el marco`
* `notifications.multipleDescription` = `Asegúrate de que sólo se ve una cara en el encuadre`
* `notifications.onFaceAngleV2` = `Alinear la cara dentro de la silueta blanca`
* `notifications.portraitDescription` = `Mantén el dispositivo en modo vertical`
* `notifications.selfie.manualCaptureButtonLabel` = `Botón de captura manual`
* `notifications.selfie.manualCaptureLabel` = `Captura manual activada. Pulse el botón para hacer la foto.`
* `notifications.unableToCropDescription` = `Por favor, inténtelo de nuevo con su cara claramente visible`
* `retake.titleFrontLabel` = `Revisar la foto de carné delantera`
* `selfiev2.manualCapture.instructions` = `Centra tu cara en la silueta y pulsa el botón para capturar`
* `tutorial.back.titleLabel` = `Ahora escanea el reverso de tu DNI`
* `webviews.step1` = `Ve a "Ajustes" → "Aplicaciones".`
* `webviews.step2` = `Buscar la aplicación`
* `webviews.step3` = `Permitir cámara`

## ✏️ Modified

* `tutorial.back.title`:
  * Before: `Ahora escanea el <1>reverso</1> de tu ID`
  * Now: `Ahora escanea el <1>reverso</1> de tu DNI`

---

- Path: `release-notes/es-spanish-3`
- URL: https://developer.incode.com/release-notes/es-spanish-3/
- Markdown: https://developer.incode.com/release-notes/es-spanish-3.md

# ES - Spanish

## 🆕 Added

* `errors.dynamicImport.suggestion_one` = `Lo intentaremos de nuevo en {{count}} segundo o puede actualizar manualmente`
* `errors.dynamicImport.suggestion_other` = `Lo intentaremos de nuevo en {{count}} segundos o puede actualizar manualmente`
* `idv2.commonIssues.firstStep` = `1. Rellena el marco con tu DNI`
* `idv2.commonIssues.secondStep` = `2. Pulse el botón`
* `verification.labels.gender` = `Género`
* `verification.labels.idNum` = `Número nacional de identidad`
* `verification.labels.idNum1` = `Número de identificación fiscal`

## ✏️ Modified

* `countries.US`:
  * Before: `EE.UU.`
  * Now: `USA`
* `errors.dynamicImport.failedToLoad`:
  * Before: `No esperábamos este error, pero estamos tomando nota:`
  * Now: `No esperábamos este error, pero estamos tomando nota.`
* `notifications.selfieCaptureFailed`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `notifications.selfieCaptureFailedDescription`:
  * Before: `No pudimos capturar el selfie`
  * Now: `Tu selfie será revisada manualmente más tarde`
* `notifications.spoof`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `notifications.spoofDescription`:
  * Before: `No pudimos tomar tu selfie. Por favor intenta nuevamente `
  * Now: `No pudimos procesar tu selfie. Por favor, intenta de nuevo`
* `notifications.spoofDescriptionNoTries`:
  * Before: `No pudimos capturar selfie.`
  * Now: `Tu selfie será revisada manualmente más tarde`
* `retake.titleBack`:
  * Before: `Revisa la foto del <1>REVERSO</1> del documento`
  * Now: `Revisar la foto del DNI`
* `retake.titleFront`:
  * Before: `Revisa la foto del <1>FRENTE</1> del documento`
  * Now: `Revisar foto de carné FRONTAL`
* `retake.titlePassport`:
  * Before: `Revisión <1>PASAPORTE</1> foto`
  * Now: `Revisión PASAPORTE foto`
* `selfie.spoof`:
  * Before: `Error de captura`
  * Now: `Falló el procesamiento de la selfie`
* `selfie.spoofDescription`:
  * Before: `No pudimos tomar tu selfie. Por favor intenta nuevamente`
  * Now: `No pudimos procesar tu selfie. Por favor, intenta de nuevo`
* `tutorial.back.title`:
  * Before: `Ahora escanea el <1>reverso</1> de tu DNI`
  * Now: `Ahora escanea el reverso de tu DNI`
* `videoSelfie.errors.noInternetConnectionDescription`:
  * Before: `Espera a que vuelva internet para continuar el proceso o conéctate a una red disponible`
  * Now: `Espera a que vuelva Internet para continuar el proceso o conéctate a una red disponible.`

---

- Path: `release-notes/es-spanish-4`
- URL: https://developer.incode.com/release-notes/es-spanish-4/
- Markdown: https://developer.incode.com/release-notes/es-spanish-4.md

# ES - Spanish

## 🆕 Added

* `documentCapture.skip` = `Omitir este paso`
* `idv2.capture.processing.uploading` = `Cargando...`
* `idv2.deepsightPermissions.subtitle` = `permiso`
* `idv2.deepsightPermissions.title` = `Permitir cámara y movimiento `
* `idv2.permissions.allowPermissionsV2` = `Permitir permisos de cámara`
* `idv2.permissions.inOrderToCompleteTheProcess` = `para completar el proceso`
* `idv2.unacceptedId.acceptedDocuments` = `Documentos aceptados para:`
* `idv2.unacceptedId.attemptsLeft_one` = `({{count}} intento a la izquierda)`
* `idv2.unacceptedId.attemptsLeft_other` = `({{count}} quedan intentos)`
* `idv2.unacceptedId.birthCertificate` = `Partida de nacimiento`
* `idv2.unacceptedId.changeMethod` = `Cambiar el método de verificación`
* `idv2.unacceptedId.currency` = `Moneda`
* `idv2.unacceptedId.driversLicense` = `Permiso de conducir`
* `idv2.unacceptedId.federalId` = `Identificación federal`
* `idv2.unacceptedId.identificationCard` = `Tarjeta de identificación`
* `idv2.unacceptedId.identificationCardDescription` = `Sólo INE emitido a partir de 2017.`
* `idv2.unacceptedId.medicalCard` = `Tarjeta sanitaria`
* `idv2.unacceptedId.military` = `Militar`
* `idv2.unacceptedId.multipleNationalities` = `¿Múltiples nacionalidades?`
* `idv2.unacceptedId.noDocuments` = `No se aceptan documentos para este país`
* `idv2.unacceptedId.other` = `Otros`
* `idv2.unacceptedId.passport` = `Pasaporte`
* `idv2.unacceptedId.passportDescription` = `Solo pasaportes expedidos en 2014.`
* `idv2.unacceptedId.permit` = `Permiso`
* `idv2.unacceptedId.residenceDocument` = `Documento de residencia`
* `idv2.unacceptedId.seeDifferentCountry` = `Ver un país diferente`
* `idv2.unacceptedId.taxIdentification` = `Identificación fiscal`
* `idv2.unacceptedId.travelDocument` = `Documento de viaje`
* `idv2.unacceptedId.tribalIdentification` = `Identificación tribal`
* `idv2.unacceptedId.tryAgain` = `Inténtalo de nuevo`
* `idv2.unacceptedId.unknown` = `Desconocido`
* `idv2.unacceptedId.unknownCountry` = `Desconocido`
* `idv2.unacceptedId.vehicleRegistration` = `Matriculación de vehículos`
* `idv2.unacceptedId.visa` = `Visa`
* `idv2.unacceptedId.voterIdentification` = `Identificación de los votantes`
* `idv2.unacceptedId.weaponLicense` = `Licencia de armas`
* `notifications.accessDenied` = `Acceso denegado`
* `notifications.accessDeniedDescription` = `No hemos podido procesar tu selfie. Inténtalo de nuevo`
* `notifications.lowQualityImage` = `Condiciones de baja calidad`
* `notifications.lowQualityImageDescription` = `Quédese quieto para la captura, y asegúrese de que su cara es clara y visible`
* `notifications.noAttemptsRemaining` = `No quedan intentos`
* `videoSelfie.processingStep` = `Procesando...`

## ✏️ Modified

* `idv2.capture.processing.errors.unacceptable.title`:
  * Old: `No se acepta el tipo de identificación`
  * New: `Documento de identidad no aceptado`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Pulse Cámara → Permitir`
  * New: `Pulse Cámara <arrow/> Permitir`
* `idv2.permissions.denied.siteSettings`:
  * Old: `Ajustes → Ajustes del sitio`
  * New: `Ajustes <arrow/> Ajustes del sitio`

---

- Path: `release-notes/es-spanish-5`
- URL: https://developer.incode.com/release-notes/es-spanish-5/
- Markdown: https://developer.incode.com/release-notes/es-spanish-5.md

# ES - Spanish

## 🆕 Added

* `
  desktop.idv2.digitalIdUpload.successfullyProcessed` = `Procesado con éxito.`
* `email.verified` = `Correo electrónico verificado.`
* `email.verify` = `Verifique su correo electrónico`
* `email.willSendCode` = `Te enviaremos un código para asegurarnos de que es tuyo`
* `geolocationv2.addressBar` = `En la barra de direcciones, pulse sobre <strong>AA</strong>`
* `geolocationv2.allowLocationAccess` = `Permitir el acceso a la ubicación`
* `geolocationv2.allowUsing` = `Seleccione <strong>Permitir durante el uso</strong>`
* `geolocationv2.appsBrowser` = `Ir a <strong>Apps <arrow/> Tu navegador</strong>`
* `geolocationv2.appsChrome` = `Ir a <strong>Aplicaciones <arrow/> Chrome</strong>`
* `geolocationv2.appsFirefox` = `Ir a <strong>Aplicaciones <arrow/> Firefox</strong>`
* `geolocationv2.appsOpera` = `Ir a <strong>Apps <arrow/> Opera</strong>`
* `geolocationv2.choosePermissions` = `Elija <strong>Preguntar la próxima vez</strong> o <strong>Mientras usa la aplicación</strong>`
* `geolocationv2.determineLocation` = `Necesitamos determinar su ubicación actual`
* `geolocationv2.goBackSafari` = `Volver a <strong>Ajustes <arrow/> Safari</strong>`
* `geolocationv2.instructions.allowLocation` = `Permitir permisos de ubicación`
* `geolocationv2.locationOn` = `Asegúrate de que <strong>los servicios de localización</strong> están activados`
* `geolocationv2.openSettings` = `Abrir la<strong> configuración</strong>`
* `geolocationv2.openSettingsAndroid` = `Abre <strong>los ajustes de</strong> tu dispositivo`
* `geolocationv2.permissionsLocation` = `Toque <strong>Permisos <arrow/> Ubicación</strong>`
* `geolocationv2.privacySecurity` = `<strong>Privacidad y seguridad</strong> abiertas`
* `geolocationv2.refreshPage` = `Actualizar página`
* `geolocationv2.returnAndRefresh` = `Volver aquí y <strong>Actualizar página</strong>`
* `geolocationv2.scrollDownChrome` = `Desplácese hacia abajo y pulse <strong>Chrome</strong>`
* `geolocationv2.scrollDownFirefox` = `Desplázate hacia abajo y pulsa <strong>Firefox</strong>`
* `geolocationv2.scrollDownOpera` = `Desplácese hacia abajo y pulse <strong>Opera</strong>`
* `geolocationv2.skip` = `Omitir este paso`
* `geolocationv2.tapLocation` = `<strong>Ubicación del</strong> grifo`
* `geolocationv2.tapLocationAllow` = `Pulse <strong>Ubicación</strong> y seleccione <strong>Permitir</strong>`
* `geolocationv2.tapSettings` = `Toque <strong>Configuración del sitio web <arrow/><br>Permitir permisos de ubicación</strong>`
* `idv2.capture.notifications.expiredId` = `Documento de identidad caducado`
* `idv2.capture.notifications.useDifferent` = `Utilizar un ID diferente`
* `idv2.capture.processing.processing` = `Procesando...`
* `idv2.capture.processing.scanFront` = `Escanea el frente`
* `idv2.capture.processing.successBackSubtitleScanFront` = `Ahora capturemos el frente`
* `idv2.chooser.chooseHowToVerifyTitle` = `Elija cómo verificar`
* `idv2.chooser.digitalIdUploadButtonTitle` = `Cargar ID digital`
* `idv2.chooser.manualUploadButtonTitle` = `Cargar ID`
* `idv2.digitalIdUpload.analyzing` = `Analizar...`
* `idv2.digitalIdUpload.digitalIdUploadButtonTitle` = `Cargar DNI digital`
* `idv2.digitalIdUpload.errorScreen.scanId` = `Escanee su DNI`
* `idv2.digitalIdUpload.loadingSuccess.letsContinue` = `Continuemos`
* `idv2.digitalIdUpload.reviewScreen.description` = `Asegúrese de que se trata del archivo correcto antes de continuar con el proceso de verificación.`
* `idv2.digitalIdUpload.reviewScreen.replaceButton` = `Sustituir archivo`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton` = `Continúe en`
* `idv2.digitalIdUpload.reviewScreen.title` = `Revise su documento`
* `idv2.digitalIdUpload.screenDescription` = `Un archivo PDF o una foto emitida por el gobierno con sus datos, foto y un código QR`
* `idv2.digitalIdUpload.screenTitle` = `Cargue su DNI digital`
* `idv2.digitalIdUpload.supportedFileTypesCopy` = `Archivo PDF o foto JPG, PNG`
* `idv2.digitalIdUpload.unknownDocumentTypeScreen.errorTitle` = `No se ha podido verificar su ID`
* `idv2.digitalIdUpload.wrongDocumentType` = `Documento de identidad no aceptado`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorSubtitle` = `Utilice un ID diferente de la lista aceptada:`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorTitle` = `Documento de identidad no aceptado`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.tryAgainButton` = `Inténtalo de nuevo`
* `idv2.manualUploadLoading.subtitle` = `Cargar el archivo`
* `idv2.permissions.denied.chrome.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.chrome.firstStep` = `En la parte superior izquierda de la página web, <strong>haga clic en el candado</strong>`
* `idv2.permissions.denied.chrome.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.chrome.secondStep` = `Se abrirá un pequeño menú`
* `idv2.permissions.denied.chrome.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.firefox.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.firefox.firstStep` = `Haz clic en la <strong>cámara</strong> o en el icono <strong>del candado</strong> `
* `idv2.permissions.denied.firefox.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.firefox.secondStep` = `Se abrirá un menú`
* `idv2.permissions.denied.firefox.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.opera.fifthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.opera.firstStep` = `Haga clic en el icono <strong>del candado</strong> `
* `idv2.permissions.denied.opera.fourthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.opera.secondStep` = `Se abrirá un pequeño menú`
* `idv2.permissions.denied.opera.thirdStep` = `Buscar <strong>cámara</strong>`
* `idv2.permissions.denied.safari.fifthStep` = `Haga clic en él y seleccione <strong>Permitir</strong>`
* `idv2.permissions.denied.safari.firstStep` = `En la parte superior izquierda, haga clic en <strong>Safari</strong>`
* `idv2.permissions.denied.safari.fourthStep` = `Busca donde pone <strong>Cámara</strong>`
* `idv2.permissions.denied.safari.secondStep` = `Haga clic en <strong>Configuración de este sitio web...</strong>`
* `idv2.permissions.denied.safari.sixthStep` = `A continuación, <strong>actualice la página</strong>`
* `idv2.permissions.denied.safari.thirdStep` = `Aparecerá un cuadro`
* `nameCapturev2.title` = `Introduzca su nombre`
* `nameCapturev2.verified` = `¡Nombre verificado!`
* `otp.didntReceive` = `¿No ha recibido el código?`
* `otp.enterCodeEmail` = `Introduce el código que te hemos enviado a tu correo electrónico`
* `otp.errorv2` = `Código caducado, inténtelo de nuevo`
* `otp.resendCode` = `Reenviar código`
* `otp.resendCountdown` = `Reenvío de código en <strong>{{time}}s</strong>`
* `redirect.didntReceive` = `¿No has recibido el enlace?`
* `redirect.enterPhoneNumber` = `Introduzca su número de teléfono para recibir un enlace para verificar a través de SMS`
* `redirect.linkSent` = `Enlace enviado.`
* `redirect.phishingResistance.explanation1` = `Necesitarás un documento de identidad válido y un selfie.`
* `redirect.phishingResistance.recommendedBrowser` = `Recomendamos utilizar Safari en iOS y Chrome en Android.`
* `redirect.phishingResistance.titleClient` = `Verifique su identidad`
* `redirect.resend` = `Vuelva a enviar`
* `redirect.scanQRTitle` = `Escanear QR`
* `redirect.scanQrv2` = `Escanee el código QR para verificarlo en su dispositivo móvil.`
* `redirect.sendLinkSms` = `Enviar enlace por SMS`
* `redirect.sendSms` = `Enviar SMS`

## ✏️ Modified

* `videoSelfie.tutorial.scanFrontId`:
  * Old: `Escanear el anverso del DNI`
  * New: `Escanear el frente del DNI`

---

- Path: `release-notes/es-spanish-6`
- URL: https://developer.incode.com/release-notes/es-spanish-6/
- Markdown: https://developer.incode.com/release-notes/es-spanish-6.md

# ES - Spanish

## 🆕 Added

* `curp.continue` = `Continuar`
* `curp.dontHave` = `No tengo CURP`
* `curp.enterCurp` = `Introduzca su CURP`
* `curp.generate` = `Genera tu CURP`
* `curp.generateCta` = `Generar`
* `curp.labels.birthState` = `Estado de nacimiento`
* `curp.labels.dob` = `Fecha de nacimiento`
* `curp.labels.femaleV2` = `Mujer`
* `curp.labels.firstLast` = `Nombre Apellido`
* `curp.labels.firstName` = `Nombre`
* `curp.labels.genderV2` = `Género`
* `curp.labels.maleV2` = `Hombre`
* `curp.labels.other` = `No binario/Otro`
* `curp.labels.secondLast` = `Segundo apellido`
* `curp.placeholder.curp` = `Su CURP`
* `curp.placeholder.firstLast` = `Su nombre y apellidos`
* `curp.placeholder.firstName` = `Su nombre`
* `curp.placeholder.gender` = `Elige género`
* `curp.placeholder.secondLast` = `Su segundo apellido`
* `curp.placeholder.state` = `Seleccionar estado`
* `curp.status.checkInfo` = `Compruebe la información introducida`
* `curp.status.confirm` = `Confirme su CURP`
* `curp.status.couldntGenerate` = `No se ha podido generar CURP`
* `curp.status.edit` = `Editar información`
* `curp.status.generating` = `Generar CURP...`
* `curp.status.notVerified` = `CURP no verificado`
* `curp.status.tryAgain` = `Inténtalo de nuevo`
* `curp.status.verified` = `¡CURP verificado!`
* `curp.status.verifying` = `Verificando su CURP...`
* `faceMatch.continue` = `Continúe en`
* `faceMatch.facesNoMatch` = `Las caras no coinciden`
* `faceMatch.firstId` = `Primera identificación`
* `faceMatch.id` = `ID`
* `faceMatch.matched` = `¡Emparejado!`
* `faceMatch.matching` = `Verificación de la identidad`
* `faceMatch.processing` = `Procesando...`
* `faceMatch.secondId` = `Segunda identificación`
* `faceMatch.selfie` = `Selfie`
* `face.tutorial.ageAssuranceStartCapture` = `Verificar la edad`
* `face.tutorial.ageAssuranceSubtitle` = `Su imagen no se almacenará ni se compartirá con terceros para proteger su intimidad.`
* `face.tutorial.ageAssuranceTitle` = `Hazte un selfie para verificar tu edad`
* `face.tutorial.autoCapture` = `Quédate quieto, el selfie se tomará automáticamente`
* `home.start` = `Inicio`
* `idv2.ageVerificationPage.ageVerification` = `Verificación de edad`
* `idv2.ageVerificationPage.Continue` = `Continuar`
* `idv2.ageVerificationPage.showYourIdAndScanIt` = `Muestra tu ID y escanéala`
* `idv2.ageVerificationPage.TheRestOfYourInformationWillBeDeletedToEnsureYourPrivacy` = `El resto de tu información será eliminada para asegurar tu privacidad`
* `idv2.ageVerificationPage.weNeedToScanYourIDToKnowYourAge` = `Necesitamos escanear tu ID para saber tu edad`
* `idv2.ageVerificationPage.weOnlyUseTheDateOfBirthInformation` = `Solo utilizamos la información de la fecha de nacimiento`
* `idv2.barCodeDetection.processingSubtitle` = `Estamos verificando su identidad`
* `idv2.barCodeDetection.processingTitle` = `Espera un segundo...`
* `idv2.capture.processing.verifying` = `Verificando...`
* `idv2.digitalIdUpload.continue` = `Continuar`
* `idv2.digitalIdUpload.errorScreen.pleaseTryScanning` = `Intenta escanear un documento diferente`
* `idv2.digitalIdUpload.errorScreen.thisIdMustBeScanned` = `Esta identificación debe escanearse`
* `idv2.digitalIdUpload.reviewScreen.continue` = `Continuar`
* `idv2.digitalIdUpload.successfullyProcessed` = `Procesado con éxito.`
* `onboarding.errors.invalidQRuuid.message` = `Parece que tu URL no es válida o ha caducado`
* `onboarding.errors.invalidQRuuid.title` = `Su URL no es válida`
* `otp.enterCodeSMS` = `Introduzca el código que le hemos enviado por SMS`
* `phone.verify` = `Verifique su número de teléfono`
* `redirect.resendCountdown` = `Reenviar enlace en <strong>{{time}}s</strong>`
* `verification.failureTitle` = `Algo salió mal`
* `verification.labels.addressDetailsSection` = `Dirección`
* `verification.labels.dlDetailsSection` = `Datos del permiso de conducir`
* `verification.placeholder.email` = `email@example.com`
* `verification.placeholder.firstName` = `Su nombre`
* `verification.placeholder.lastName` = `Su apellido`
* `verification.placeholder.maternalSurname` = `Su apellido materno`
* `verification.placeholder.middleName` = `Su segundo nombre`
* `verification.placeholder.stateCode` = `Por ejemplo {{states}}`
* `verification.placeholder.surname` = `Su apellido`
* `verification.submitButton` = `Continúe en`
* `verification.successTitle` = `eKYC verificado`
* `verification.tryAgain` = `Inténtalo de nuevo`

## ✏️ Modified

* `idv2.chooser.chooseHowToVerifyTitle`:
  * Old: `Elija cómo verificar`
  * New: `Seleccione cómo verificar`
* `idv2.digitalIdUpload.reviewScreen.title`:
  * Old: `Revise su documento`
  * New: `Revisar documento`
* `idv2.digitalIdUpload.screenDescription`:
  * Old: `Un archivo PDF o una foto emitida por el gobierno con sus datos, foto y un código QR`
  * New: `Un archivo PDF emitido por el gobierno con sus datos, foto y un código QR`
* `idv2.digitalIdUpload.screenTitle`:
  * Old: `Cargue su DNI digital`
  * New: `Cargar ID digital`
* `otp.resendCountdown`:
  * Old: `Reenvío de código en <strong>{{time}}s</strong>`
  * New: `Reenvío de código en {{time}}s`
* `verification.labels.state`:
  * Old: `Código estatal (por ejemplo {{states}}}}`
  * New: `Código del Estado`

---

- Path: `release-notes/es-spanish-7`
- URL: https://developer.incode.com/release-notes/es-spanish-7/
- Markdown: https://developer.incode.com/release-notes/es-spanish-7.md

# ES - Spanish

## 🆕 Added

* `commonIssues.blurPresent` = `Desenfoque presente`
* `commonIssues.blurPresentDescription` = `Aleja o acerca el ID al teléfono hasta que la imagen esté enfocada`
* `commonIssues.glarePresent` = `Resplandor presente`
* `commonIssues.glarePresentDescription` = `Inclina el ID ligeramente hacia arriba o hacia abajo para minimizar el reflejo`
* `commonIssues.notReadable` = `La información no es legible`
* `commonIssues.notReadableDescription` = `Minimiza el movimiento de la cámara sujetando el teléfono con firmeza`
* `encryptionLabel.encryptedPhotos` = `Todos los datos están encriptados`
* `home.goToSettings` = `Ir a la configuración`
* `idv2.backTutorial.disclaimer` = `La foto se tomará automáticamente`
* `idv2.backTutorial.subtitle` = `Asegúrate de que tu ID sea legible`
* `idv2.backTutorial.title` = `Muestra el reverso de tu ID`
* `idv2.capture.allDataIsEncrypted` = `Toda la data está encriptada`
* `idv2.permissions.allowV2` = `Permitir`
* `idv2.permissions.subtitleV2` = `Esto permite a la cámara realizar la captura necesaria para la verificación`
* `idv2.reverseFlipAnimation.title` = `Muestre el anverso de su documento de identidad`
* `notifications.faceOccluded` = `Rostro cubierto`
* `notifications.faceOccludedDescription` = `Asegúrate de que tu cara sea clara y visible.`
* `selfiev2.manualCapture.captureButton` = `Tomar foto`

## ✏️ Modified

* `commonIssues.takeManually`:
  * Old: `Haz la foto manualmente`
  * New: `Hacer la foto manualmente`
* `face.tutorial.autoCapture`:
  * Old: `Quédate quieto, el selfie se tomará automáticamente`
  * New: `No te muevas, la selfie se tomará automáticamente`
* `face.tutorial.subtitle`:
  * Old: `Esto te permite iniciar sesión utilizando tu cara.`
  * New: `Mantén una expresión neutra, busca una luz equilibrada y quítate las gafas y los sombreros`
* `idv2.capture.autoCapture`:
  * Old: `La foto se tomará automáticamente`
  * New: `La captura se realizará automáticamente`
* `idv2.capture.fillFrameBack`:
  * Old: `Rellena el marco con tu identificación dorsal`
  * New: `Enmarca el reverso de tu DNI`
* `idv2.capture.fillFrameFront`:
  * Old: `Rellena el marco con tu DNI`
  * New: `Encuadre el anverso de su DNI`
* `idv2.permissions.allowPermissionsV2`:
  * Old: `Permitir permisos de cámara`
  * New: `Permitir el acceso a la cámara`
* `idv2.permissions.dontAllow`:
  * Old: `No permita`
  * New: `No permita que`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Sólo utilizamos la cámara para capturar su identificación para la verificación segura`
  * New: `Sólo utilizamos la cámara para el proceso de verificación.`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `Ayuda a verificar la autenticidad de los documentos y a prevenir el fraude de identidad.`
  * New: `El proceso de verificación garantiza que usted es quien dice ser.`
* `idv2.tutorial.autoCapture`:
  * Old: `La foto se tomará automáticamente`
  * New: `La captura se realizará automáticamente`
* `idv2.tutorial.startScan`:
  * Old: `Escaneemos`
  * New: `Escanear`
* `idv2.tutorial.title`:
  * Old: `Escanee su ID`
  * New: `Muestre el anverso de su documento de identidad`
* `notifications.selfieCaptureFailedDescription`:
  * Old: `Tu selfie será revisada manualmente más tarde`
  * New: `Se alcanzó el número máximo de intentos`
* `notifications.spoofDescriptionNoTries`:
  * Old: `Tu selfie será revisada manualmente más tarde`
  * New: `Se alcanzó el número máximo de intentos`

---

- Path: `release-notes/es-spanish-8`
- URL: https://developer.incode.com/release-notes/es-spanish-8/
- Markdown: https://developer.incode.com/release-notes/es-spanish-8.md

# ES - Spanish

## 🆕 Added

* `ekyb.addressDetails` = `Dirección`
* `ekyb.continue` = `Continúe en`
* `ekyb.error.title` = `Algo salió mal`
* `ekyb.processing` = `Tratamiento`
* `ekyb.success` = `Éxito`
* `ekyb.tryAgain` = `Inténtalo de nuevo`
* `idv2.capture.manualCapture.modeSwitchAriaAnnouncement` = `Ahora utiliza el modo de captura manual. Pulse el botón para capturar la foto.`
* `idv2.capture.v2.autoCapture` = `La foto se tomará automáticamente`
* `idv2.capture.v2.fillFrameBack` = `Rellena el marco con tu identificación dorsal`
* `idv2.capture.v2.fillFrameFront` = `Rellena el marco con tu DNI`
* `idv2.tutorial.v2.autocapture` = `La foto se tomará automáticamente`
* `idv2.tutorial.v2.title` = `Escanee su DNI`
* `otp.groupLabel` = `{{charLength}}Código de verificación de -dígitos`
* `v2.capture.label` = `Todas las fotos están encriptadas`
* `v2.idError.attemptsLeft_one` = `{{count}} intento restante`
* `v2.idError.attemptsLeft_other` = `{{count}} intento restante`
* `v2.idSuccess.subtitle` = `Ahora vamos a capturar la parte de atrás`
* `v2.idSuccess.subtitleBack` = `Continuemos`
* `v2.idSuccess.title` = `Procesado con éxito.`
* `v2.selfie.camera.loading` = `Cargando...`

## ✏️ Modified

* `idv2.capture.notifications.showFront.description`:
  * Old: `Dale la vuelta a tu ID para mostrar su reverso`
  * New: `Dale la vuelta a tu DNI para mostrar su anverso`

---

- Path: `release-notes/es-spanish-9`
- URL: https://developer.incode.com/release-notes/es-spanish-9/
- Markdown: https://developer.incode.com/release-notes/es-spanish-9.md

# ES - Spanish

## 🆕 Added

* `biometricConsent.subtitle` = `Su verificación es impulsada por Incode. Para cumplir la normativa estatal, necesitamos su consentimiento para el procesamiento biométrico.`
* `documentCapture.camera.subtitle` = `Asegúrate de que está totalmente visible y pulsa el botón`
* `documentCapture.camera.title` = `Muestre su documento completo`
* `documentCapture.commonIssues.dirtyPresent` = `El objetivo de la cámara está sucio`
* `documentCapture.commonIssues.dirtyPresentDescription` = `Limpia el objetivo de tu cámara para obtener una imagen más nítida.`
* `documentCapture.commonIssues.farPresent` = `El documento está demasiado lejos o fuera de cuadro`
* `documentCapture.commonIssues.farPresentDescription` = `Asegúrese de que todos los bordes son visibles en la pantalla.`
* `documentCapture.commonIssues.foldedIdPresent` = `El documento está plegado`
* `documentCapture.commonIssues.foldedIdPresentDescription` = `Aplana el documento y asegúrate de que está completamente abierto y recto.`
* `documentCapture.commonIssues.shadowPresent` = `Sombras sobre el documento`
* `documentCapture.commonIssues.shadowPresentDescription` = `Desplázate a una zona más luminosa y evita proyectar sombras sobre tu documento.`
* `documentCapture.errors.fileSizeExceed` = `El archivo supera el tamaño máximo de {{maxSize}}`
* `documentCapture.review.analyzing` = `Analizar...`
* `documentCapture.review.continue` = `Continúe en`
* `documentCapture.review.error.description` = `Asegúrese de que toda la información del documento es clara y legible.`
* `documentCapture.review.error.title` = `No se puede procesar`
* `documentCapture.review.errorTitle` = `Algo salió mal`
* `documentCapture.review.errorUpload` = `Se ha producido un error al procesar su documento.`
* `documentCapture.review.replace` = `Sustituir`
* `documentCapture.review.retake` = `Retomar`
* `documentCapture.review.subtitleCaptured` = `Asegúrese de que todo el documento se ajusta a la vista y de que el texto es legible.`
* `documentCapture.review.subtitleImageUpload` = `Asegúrese de que todo el documento se ajusta a la vista y de que el texto es legible.`
* `documentCapture.review.subtitlePdfUpload` = `Asegúrese de haber seleccionado el archivo correcto antes de continuar con el proceso de verificación.`
* `documentCapture.review.successTitle` = `Procesado con éxito.`
* `documentCapture.review.titleCaptured` = `Revise su documento`
* `documentCapture.review.titleImageUpload` = `Revisar la foto seleccionada`
* `documentCapture.review.titlePdfUpload` = `Revise su documento`
* `documentCapture.review.tryAgain` = `Inténtalo de nuevo`
* `documentCapture.review.uploading` = `Cargando...`
* `documentCapture.tutorial.captureButton` = `Capturar documento`
* `documentCapture.tutorial.chooseFile` = `Elegir dispositivo`
* `documentCapture.tutorial.multiPageDocument.subtitle` = `Haz una foto de la página siguiente para continuar.`
* `documentCapture.tutorial.multiPageDocument.title` = `Página siguiente`
* `documentCapture.tutorial.skipButton` = `Omitir este paso`
* `documentCapture.tutorial.subtitle` = `Haz una foto o sube un PDF, JPG o PNG`
* `documentCapture.tutorial.takePhoto` = `Tomar foto`
* `documentCapture.tutorial.title` = `Verifique su documento`
* `documentCapture.tutorial.uploadButton` = `Cargar documento`
* `documentCapture.tutorial.uploadDocument` = `Cargar documento`
* `ekyb.error.USTaxId` = `NIF no válido. El NIF debe tener 9 dígitos.`
* `idv2.ageVerificationPage.step1of3` = `Paso 1 de 3: `
* `idv2.ageVerificationPage.step2of3` = `Paso 2 de 3: `
* `idv2.ageVerificationPage.step3of3` = `Paso 3 de 3: `
* `idv2.chooser.digitalIdButtonTitle` = `Identificación digital`
* `idv2.chooser.loadingDigitalWallet` = `Cargando monedero digital...`
* `idv2.flipAnimation.titleToFront` = `Muestre el anverso de su documento de identidad`
* `idv2.permissions.allowEveryTime` = `Permitir siempre`
* `idv2.permissions.allowOnlyWhileUsingTheApp` = `Permitir sólo mientras se utiliza la aplicación`
* `idv2.permissions.denied.onDevice` = `en el dispositivo`
* `idv2.permissions.denied.opera.appsOpera` = `Aplicaciones <arrow/> Opera`
* `idv2.permissions.denied.permissionsCamera` = `Persmisiones <arrow/> Cámara`
* `idv2.permissions.denied.persmissionsCamera` = `Persmisiones <arrow/> Cámara`
* `idv2.permissions.denied.settingsApp` = `Aplicación Ajustes`
* `idv2.permissions.denied.setTo` = `Ajustar a`
* `idv2.permissions.denied.sitePermissions` = `Autorizaciones`
* `idv2.permissions.denied.sitesAndDownloads` = `Sitios y descargas`
* `idv2.tutorial.subtitleBack` = `Asegúrese de que su documento de identidad sea legible`
* `idv2.tutorial.v2.titleBack` = `Muestre el reverso de su documento de identidad`
* `manualIdUpload.frontRequiredFirst` = `Cargue primero el anverso del documento de identidad`
* `manualIdUpload.uploadBackId` = `Cargar el reverso del DNI`
* `manualIdUpload.uploadFrontId` = `Cargar anverso del DNI`
* `manualIdUpload.uploadPassport` = `Cargar pasaporte`
* `notifications.noTries` = `Número máximo de intentos alcanzado`
* `selfiev2.autoCapture.defaultAriaInstructions` = `Centra tu cara en el encuadre.`
* `selfiev2.capture.title` = `Captura facial`
* `verification.errors.ARPostalCodeInvalidFormat` = `Introduzca un código postal argentino válido (formato: A1111AAA)`
* `verification.errors.CAPostalCodeInvalidFormat` = `Introduzca un código postal canadiense válido (formato: A1A 1A1).`
* `verification.errors.ESPostalCodeInvalidFormat` = `Introduzca un código postal de 5 dígitos`
* `verification.errors.UKPostalCodeInvalidFormat` = `Introduzca un código postal válido del Reino Unido.`
* `verification.noFormFields` = `No se ha configurado ningún campo para este formulario.`
* `watchlistBusiness.businessName` = `Nombre comercial`
* `watchlistBusiness.businessNameRequired` = `El campo Nombre de la empresa es obligatorio`
* `watchlistBusiness.continue` = `Continuar`
* `watchlistBusiness.watchlistForBusiness` = `Lista de vigilancia para empresas`

## ✏️ Modified

* `ekyb.continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `faceMatch.continue`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton`:
  * Old: `Continúe en`
  * New: `Continuar`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Pulse Cámara <arrow/> Permitir`
  * New: `Cámara <arrow/> Permitir`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Sólo utilizamos la cámara para el proceso de verificación.`
  * New: `Sólo utilizamos la cámara para capturar su identificación para la verificación segura`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `El proceso de verificación garantiza que usted es quien dice ser.`
  * New: `Ayuda a verificar la autenticidad de los documentos y a prevenir el fraude de identidad.`
* `idv2.permissions.subtitleV2`:
  * Old: `Esto permite a la cámara realizar la captura necesaria para la verificación`
  * New: `Te permite hacer una foto de tu DNI y de tu cara con fines de verificación.`
* `otp.errorv2`:
  * Old: `Código caducado, inténtelo de nuevo`
  * New: `Algo salió mal`
* `verification.submitButton`:
  * Old: `Continúe en`
  * New: `Continuar`

---

- Path: `release-notes/flutter-migration-guide`
- URL: https://developer.incode.com/release-notes/flutter-migration-guide/
- Markdown: https://developer.incode.com/release-notes/flutter-migration-guide.md

# Migration Guide

## Migration to 4.23.0

### Summary

| API                                                                                                                                  | Android | iOS | What you need to do                                                                                                                                                                                                                                                        |
|--------------------------------------------------------------------------------------------------------------------------------------|---------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`CurpValidation` module](#curpvalidation-module)                                                                                    | ✓       | ✓   | The `CURP` module changed: its result has new fields, and on Android it reports one result per module.                                                                                                                                                                     |
| [Flow methods](#flow-methods): `startOnboarding`, `startOnboardingSection`, `startFlow`, `startFlowFromDeepLink`, `startWorkflow` | ✓       | ✓   | Read the error code in `onError` instead of the message, handle `userCancelled` in `onError` if you do not pass `onUserCancelled`, handle `interrupted` and the new error codes, and handle the eleven new `IncodeSdkFlowError` values in a `switch` without `default`        |
| 💥 [`startOnboardingSection`](#startonboardingsection) (was `startNewOnboardingSection`) | ✓ | ✓ | Rename `startNewOnboardingSection` to `startOnboardingSection` and `flowTag` to `sectionTag`, optionally move `onOnboardingSectionCompleted` (deprecated) to `onSuccess(sectionTag)`. Pass a non-blank `sectionTag`, and handle `configError`, `sectionAlreadyRunning`, `activityNotPresent`, and `noActiveSession` in `onError`. |
| [`startFlow`](#startflow)                                                                                                            | ✓       | ✓   | Read the error code in `onError` instead of the message, and handle `activityNotPresent` and `configError`.                                                                                                                                                                |
| `startWorkflow`                                                                                                                      | ✓       | ✓   | Handle `activityNotPresent` instead of `unknown`.                                                                                                                                                                                                                          |
| [`Geolocation` module](#geolocation-module)                                                                                          | ✓       | ✓   | Read the address from `addressFields`, check `status`, and handle `null` fields; on Android, stop reading `state` as the region, move handling from `onError` into `onGeolocationCompleted`, and match on `permissionsDenied` / `locationUnavailable` instead of `unknown` |
| [Concurrent `startFaceLogin` calls are ignored](#ios-concurrent-startfacelogin-calls-are-ignored)                                    |         | ✓   | Do not start a Face Login while another is in progress                                                                                                                                                                                                                     |
| [`setLogo`](#android-keep-the-setlogo-drawable) (new, optional)                                                                       | ✓       |     | If you call `setLogo`, add the logo drawable to `res/raw/keep.xml`                                                                                                                                                                                                         |

💥 marks a change that breaks compilation.

### `CurpValidation` module

#### `CurpValidationResult` has `status` and `resultCode`

`CurpValidationResult` now carries `status` (`success` / `fail`) and `resultCode`, like `PhoneNumberResult`, `AddEmailResult`, and `AddFullNameResult`. `status` follows `valid`: it is `success` only when RENAPO accepted the CURP.

Code that constructs the result itself, for example in tests, must pass the two new named parameters:

```diff
- CurpValidationResult(curp, valid, data)
+ CurpValidationResult(curp, valid, data, status: 'success', resultCode: 'success')
```

`curp`, `valid`, and `data` are `null` when the SDK has no value. Check for `null` before you use them. For example, `data` is `null` after a failed validation request on Android.

#### `onCurpValidationCompleted` is called once on Android

On Android the callback was called for each failed attempt and then for the final attempt. It is now called once, with the final result, as on iOS. If your code counted calls or treated an earlier call as the final result, use the single call instead.

### Flow methods

`startOnboarding`, `startOnboardingSection`, `startFlow`, `startFlowFromDeepLink`, and `startWorkflow`.

#### `onError` receives an error code

`onError` now receives an `IncodeSdkFlowError` code, such as `permissionsDenied`, instead of the native error message. `startWorkflow` already did this in 4.22.0.

```diff
  IncodeOnboardingSdk.startOnboarding(
    ...
-   onError: (String error) => showMessage(error),
+   onError: (String code) {
+     final error = code.toIncodeSdkFlowError();
+     // handle IncodeSdkFlowError values
+   },
  );
```

#### A cancel without `onUserCancelled` calls `onError`

If you do not pass `onUserCancelled`, a cancelled flow now calls `onError` with `userCancelled`. Previously, no callback was called and the flow did not finish.

#### An interrupted flow calls `onError` with `interrupted`

When the system ends a flow (for example, it destroys the SDK screen), the flow now ends with `onError` and the new `interrupted` code on Android and iOS. Previously, the flow did not finish on Android and called `onError` with `unknown` on iOS.

#### Flow error codes

Some errors now report a more specific `IncodeSdkFlowError` code:

| Case | Android | iOS | Before |
|---|---|---|---|
| Video Selfie not completed, other than a denied permission | `videoSelfieNotCompleted` | `videoSelfieNotCompleted` | `unknown` |
| Location unavailable | `locationUnavailable` | `locationUnavailable` (unchanged) | Android: `unknown`, or `onGeolocationUnavailable` during the Geolocation module |
| Location permission denied | `permissionsDenied` | — | Android: `unknown`, or `onGeolocationUnavailable` during the Geolocation module |
| The onboarding session could not be created | — | `sessionCreationFailed` | iOS: `unknown` |
| The Captcha could not be verified | `unknown` (unchanged: the Android SDK reports a generic error) | `captchaNotVerified` | iOS: `unknown` |
| The user did not give biometric consent | `biometricConsentNotGiven` | `biometricConsentNotGiven` | `unknown` |
| The biometric consent did not reach Incode | `biometricConsentNotReceived` | `biometricConsentNotReceived` | `unknown` |
| A section was started while another one runs | `sectionAlreadyRunning` | `sectionAlreadyRunning` | Android: the running section never finished; iOS: `unknown`. See [`startOnboardingSection`](#startonboardingsection) |
| The flow has no onboarding session | — | `noActiveSession` | iOS: `unknown` |
| Not enough free disk space for the SDK's ML models | `insufficientDiskSpace` | — | Android: `unknown` |
| On-device processing configured with an unsupported setting | `onDeviceProcessingNotCompatible` | — | Android: `unknown` |
| The system interrupted the flow | `interrupted` | `interrupted` | Android: no callback (the flow did not finish); iOS: `unknown` |

#### `IncodeSdkFlowError` has new values

`IncodeSdkFlowError` has eleven new values:
- iOS: `sessionCreationFailed`, `captchaNotVerified`, `noActiveSession`
- Android: `insufficientDiskSpace`, `onDeviceProcessingNotCompatible`
- Both: `activityNotPresent`, `videoSelfieNotCompleted`, `interrupted`, `biometricConsentNotGiven`, `biometricConsentNotReceived`, `sectionAlreadyRunning`. 

A `switch` over `IncodeSdkFlowError` without a `default` clause no longer compiles until you handle these errors.

```diff
  switch (code.toIncodeSdkFlowError()) {
    ...
+   case IncodeSdkFlowError.activityNotPresent:
+   case IncodeSdkFlowError.videoSelfieNotCompleted:
+   case IncodeSdkFlowError.interrupted:
+   case IncodeSdkFlowError.sessionCreationFailed:
+   case IncodeSdkFlowError.captchaNotVerified:
+   case IncodeSdkFlowError.biometricConsentNotGiven:
+   case IncodeSdkFlowError.biometricConsentNotReceived:
+   case IncodeSdkFlowError.sectionAlreadyRunning:
+   case IncodeSdkFlowError.noActiveSession:
+   case IncodeSdkFlowError.insufficientDiskSpace:
+   case IncodeSdkFlowError.onDeviceProcessingNotCompatible:
+     // handle
  }
```

### `startOnboardingSection`

#### `startNewOnboardingSection` is renamed to `startOnboardingSection`

The method is renamed to `startOnboardingSection`, and its `flowTag` parameter is renamed to `sectionTag`. The code does not compile until you rename both.

`onOnboardingSectionCompleted` is deprecated: move its code to `onSuccess`, which now receives the `sectionTag`. `onOnboardingSectionCompleted` still works, and you can still start the next section from it, so this step is optional.

```diff
- IncodeOnboardingSdk.startNewOnboardingSection(
+ IncodeOnboardingSdk.startOnboardingSection(
    flowConfig: flowConfig,
-   flowTag: 'idSection',
+   sectionTag: 'idSection',
-   onOnboardingSectionCompleted: (String flowTag) {
+   onSuccess: (String sectionTag) {
      // Start the next section or call finishFlow.
    },
    onError: (String error) { /* ... */ },
  );
```

#### `sectionTag` must not be blank

An empty or whitespace-only `sectionTag` now calls `onError` with `configError`, and the section does not start. Previously, Android never finished the call for an empty tag, and both platforms started a section with a whitespace-only tag. Pass a non-blank `sectionTag`.

#### Only one section runs at a time

A `startOnboardingSection` call made while another section is running now calls `onError` with `sectionAlreadyRunning`, on Android and iOS. The running section is not affected. Previously, the second call took over the event stream, so the running section stopped reporting results and never finished.

#### Start-up failures call `onError`

Start-up failures now end the call through `onError`, the same way on both platforms:

| Case | Before | Now |
|---|---|---|
| Blank `sectionTag` | Android: the call never finished (empty tag); both: the section started (whitespace-only tag) | `configError` |
| Invalid module configuration in `flowConfig` | Android: a message that never reached `onError`; iOS: `unknownModule` | `configError` |
| Unsupported module in `flowConfig` | `unknownModule` | `unknownModule` (unchanged) |
| Another section runs | Android: the running section never finished; iOS: `unknown` | `sectionAlreadyRunning` |
| No host Activity (Android) | the section started from the application context | `activityNotPresent` |
| No view controller (iOS) | `Error: No rootViewController found`, the call did not end | `activityNotPresent` |
| No onboarding session | Android: a native error; iOS: `noActiveSession` | `noActiveSession` |

### `startFlow`

`onError` now receives an `IncodeSdkFlowError` code, such as `configError`, instead of the native error message. `startWorkflow` already did this.

```diff
  IncodeOnboardingSdk.startFlow(
    ...
-   onError: (String error) => showMessage(error),
+   onError: (String code) {
+     final error = code.toIncodeSdkFlowError();
+     // handle IncodeSdkFlowError values
+   },
  );
```

Start-up failures now end the flow through `onError`:

| Case | Before | Now |
|---|---|---|
| No host Activity (Android) | the flow started from the application context | `activityNotPresent` |
| No view controller (iOS) | `Error: No rootViewController found`, the flow did not end | `activityNotPresent` |
| `sessionConfig` has neither `configurationId` nor `token` | a native error from the flow | `configError` (before the flow starts) |

An unknown `moduleId` runs the whole flow on both platforms, the same as before.

`IncodeSdkFlowError` has a new value: `activityNotPresent`. A `switch` over `IncodeSdkFlowError` without a `default` clause no longer compiles until you handle it.

### `Geolocation` module

#### `GeoLocationResult`

The address moved under `addressFields`, and the result now carries `latitude`, `longitude`, `status`, and `resultCode`. Missing values are `null` instead of `""`:

```diff
 onGeolocationCompleted: (GeoLocationResult result) {
-  if (result.error == null) {
-    final city = result.city;
+  if (result.status == 'success') {
+    final city = result.addressFields?.city;
+    final lat = result.latitude;
   }
 },
```

The top-level `city`, `colony`, `postalCode`, `state`, and `street` fields are removed, so code that reads them no longer compiles. Read them from `addressFields` instead.

#### `state` is the country name

`addressFields.state` now holds the country name on both platforms. On Android it previously held the region (for example `CDMX`); it now holds the country (for example `Mexico`), as it already did on iOS. `addressFields.city` falls back to the region when the city is unknown. If your app needs the region on Android, it is no longer reported.

#### Android: an unavailable location no longer ends the flow

On Android, an unavailable location used to raise an error on the event stream, so your `onError` received `onGeolocationUnavailable` and the call ended even though the native flow continued. It is now delivered to `onGeolocationCompleted` with `status` `fail` and the cause in `error`, as on iOS. Move any handling from `onError` into `onGeolocationCompleted`. A non-skippable failure still ends the flow through `onError`. On Android, `onGeolocationCompleted` receives the `fail` result first, and then `onError` is called.

#### Android: new `onError` codes for a failed non-skippable step

On Android, when a non-skippable `Geolocation` step fails, `onError` now receives `permissionsDenied` or `locationUnavailable` instead of `unknown`. If you match on `unknown` for this case, match on these codes instead.

### iOS: concurrent `startFaceLogin` calls are ignored

On iOS, a `startFaceLogin` call made while another Face Login is in progress is now ignored by the native SDK. Neither `onSuccess` nor `onError` is called for the ignored call, and its `Future` does not complete. Start a Face Login only after the previous one has returned, for example:

```dart
bool _faceLoginInProgress = false;

Future<void> _startFaceLogin(FaceLogin faceLogin) async {
  if (_faceLoginInProgress) return;
  _faceLoginInProgress = true;
  try {
    await IncodeOnboardingSdk.startFaceLogin(
      faceLogin: faceLogin,
      onSuccess: (FaceLoginResult result) { /* ... */ },
      onError: (String error) { /* ... */ },
    );
  } finally {
    _faceLoginInProgress = false;
  }
}
```

### Android: keep the `setLogo` drawable

This applies only if you start to use the new `setLogo` method. No change is necessary if you do not call it.

On Android, `setLogo` finds the logo drawable by its name at runtime, so no code refers to it. When resource shrinking is on (`shrinkResources true`), the Android shrinker removes the drawable from release builds, and `setLogo` calls `onError` with `appearanceError`. To keep the drawable, add it to `android/app/src/main/res/raw/keep.xml`:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

See [`setLogo`](/sdk-reference/flutter-api-reference/#setlogo).

## Migration to 4.22.0

<Accordion title="Migration to 4.22.0">

Three independent areas changed: `OnboardingSessionConfiguration` parameter names, the standalone `faceMatch()`, and theming on Android.

### Renamed `positive800` color palette token on Android

The `positive800` key in the theme's `colorPalette` is now `positive750`, matching the palette exported from the upcoming Incode Studio product.

```diff
"colorPalette": {
  "positive50": "#E4FBF0",
  "positive400": "#189F60",
  "positive500": "#189F60",
-  "positive800": "#0C5030"
+  "positive750": "#0C5030"
}
```

Theme JSON that still uses `positive800` silently falls back to the default, because unknown keys are ignored during parsing. Rename the key to keep your customization applied.

### Stricter theme JSON parsing on Android

Color values must be quoted strings, and a `[light, dark]` pair must not be empty. Values that previously parsed by accident — an unquoted number such as `123456`, a boolean, or `[]` — are now rejected when the theme is parsed.

```diff
 "colorPalette": {
-  "brand500": 123456,
+  "brand500": "#01E240",
-  "gray500": [],
+  "gray500": ["#60667C", "#A3A8B8"]
 }
```

`setTheme` takes the theme as a JSON `String` and has no error callback, so nothing tells you at runtime that a value was rejected — on Android an invalid theme is simply not applied. With the stricter parsing a single bad value is enough to drop the whole theme and fall back to the defaults, so validate your JSON before shipping it.

### `OnboardingSessionConfiguration` parameters renamed

`userRegion` is now `region`, and `onboardingValidationModules` is now `validationModules`.

```diff
  OnboardingSessionConfiguration(
-   userRegion: 'ALL',
-   onboardingValidationModules: [OnboardingValidationModule.id],
+   region: 'ALL',
+   validationModules: [OnboardingValidationModule.id],
  );
```

This affects every entry point that takes an `OnboardingSessionConfiguration`: `startOnboarding()`, `startWorkflow()`, `startFlow()`, `startNewOnboardingSection()` and `setupOnboardingSession()`.

**`region` no longer defaults to `ALL`.** Omitting it previously sent `ALL`; it is now left unset and the SDK default applies. If you relied on the old behaviour, pass it explicitly:

```diff
  OnboardingSessionConfiguration(
-   // userRegion omitted — implicitly "ALL"
+   region: 'ALL',
  );
```

`region` is Android only — iOS has no region parameter and ignores it.

`getUserScore` and the `onUserScoreFetched` callback are now served by Incode's shared cross-platform bridge, so both platforms return the same data in the same shape. Most of the changes below follow from that.

### New required podspec source on iOS

The plugin now depends on `IncodeBridgeCommon`, which is published to its own private spec repository. Add it as a source to your `Podfile`:

```diff
 source 'https://cdn.cocoapods.org/'
 source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
+source 'git@github.com:Incode-Technologies-Example-Repos/IncodeBridgeCommonPodspecs.git'
```

### Score values no longer include the `/100` suffix

Scores are now the raw value the server returned — `80.5` instead of `80.5/100` — in both `getUserScore` results and the `onUserScoreFetched` callback. On Android, a score whose status was `manual` previously came through as a localized "needs review" phrase instead of a number; it is now always the numeric score.

If you displayed the value directly, append the suffix yourself:

```diff
- Text('Score: ${result.overall?.value}')
+ Text('Score: ${result.overall?.value}/100')
```

iOS already reported raw scores, so only Android behavior changes here.

### `fetchMode` now defaults to `accurate` on Android

Omitting `fetchMode` previously selected `UserScoreFetchMode.fast` on Android and `accurate` on iOS. Both platforms now default to `accurate`. To keep the previous Android behavior, pass it explicitly:

```diff
  IncodeOnboardingSdk.getUserScore(
+   fetchMode: UserScoreFetchMode.fast,
    onSuccess: (UserScoreResult result) { ... },
    onError: (String error) { ... },
  );
```

### `getUserScore` reports unified error codes

On iOS, `onError` previously received the native SDK's own error string. Both platforms now deliver one of the `IncodeSdkFlowError` codes, so you can convert instead of matching on messages:

```diff
  onError: (String error) {
-   print('getUserScore failed: $error');
+   switch (error.toIncodeSdkFlowError()) {
+     case IncodeSdkFlowError.userScoreFailed:
+       // No score available for this session.
+       break;
+     case IncodeSdkFlowError.userCancelled:
+       // Android only; this call presents no UI on iOS.
+       break;
+     default:
+       break;
+   }
  },
```

A session that produced no score — for example a submit-only session — previously completed through `onSuccess` with an empty result on Android. It now reports `userScoreFailed`. If you treated an empty result as a valid outcome, move that handling into `onError`.

### `startWorkflow` reports error codes

`startWorkflow`'s `onError` previously received the native SDK's error message. It now receives an `IncodeSdkFlowError` code, as documented, so convert it instead of matching on or displaying the message:

```diff
  onError: (String error) {
-   print('startWorkflow failed: $error');
+   switch (error.toIncodeSdkFlowError()) {
+     case IncodeSdkFlowError.permissionsDenied:
+       // The user denied a permission the Workflow needs.
+       break;
+     case IncodeSdkFlowError.sslPinningFailed:
+       break;
+     default:
+       break;
+   }
  },
```

If you showed `error` to users, map the code to your own text; the native message is no longer passed. `startOnboarding`, `startFlow`, and the section methods are unchanged and still pass the message, apart from the new `unknownModule` code below.

### Unrecognized modules report `unknownModule`

A flow configuration naming a module the wrapper does not recognize, such as a stale name left over from a rename, was previously skipped: the flow ran without that step and still completed through `onSuccess`. `startOnboarding` and `startOnboardingSection` now stop and call `onError` with `unknownModule` instead.

```dart
  onError: (String error) {
    if (error == 'unknownModule') {
      // The flow configuration names a module this SDK version does not support.
    }
  },
```

If you build the flow configuration from data you do not control, such as a remote config, make sure it contains only module names this SDK version supports, or handle `unknownModule` in `onError`.

### `UserScoreResult` sections are now structured objects

`overall`, `faceRecognition`, `liveness` and `idValidation` were `{value, status}` pairs of a private type. They are now public types that carry each section's full breakdown, and `governmentValidation` has been added.

**Existing code keeps compiling.** Every section still answers `value` and `status`, which return its overall score:

```dart
result.idValidation?.value    // '92'
result.idValidation?.status   // UserScoreStatus.ok
```

Newly available, if you want it: the `photoSecurityAndQuality`, `idSpecific` and `ocrValidation` check lists, plus `livenessScore`, `photoQuality`, `existingUser` and `recognitionConfidence`. See [Results](./flutter-results#userscore) for the full structure.

The `onUserScoreFetched` callback now populates these too, for whichever modules the flow ran. Sections that were not evaluated stay `null` and their checklists are empty.

### Fixed a crash on iOS when a score status was `warn` or unset

The iOS wrapper previously sent the Swift case name `warning` rather than the documented `warn`, and an empty string for a status the SDK left unset. `UserScoreResult.fromJson` threw `ArgumentError` on both, so any score containing a `warn` status crashed while parsing. Statuses are now always one of the documented values, and an unset status is `null`. No action is needed.

### `ApprovalResult` has a new `error` field

`ApprovalResult` now carries `error`, a `String?` holding the module-level error reported by the native SDK, taken from `IncodeSdkFlowError`. It is `null` when the module reported no error, and always `null` on Android, whose native result has no equivalent field.

The field is additive: the positional constructor takes it as an optional fourth argument, so existing `ApprovalResult(success, uuid, customerToken)` calls keep working.

```dart
onApproveCompleted: (ApprovalResult result) {
  if (result.error != null) {
    print('Approval reported ${result.error}');
  }
},
```

### `uuid` and `customerToken` are now `null` on iOS instead of empty strings

`ApprovalResult.uuid` and `ApprovalResult.customerToken` have always been declared `String?`, but iOS reported them as `""` when the user was not approved. Both platforms now report `null`, matching the declared type and Android's behavior.

If you tested for empty strings, test for `null` instead:

```dart
// Before
if (result.uuid != '') { … }

// After
if (result.uuid != null) { … }
```

### `approve` callbacks fire exactly once on both platforms

Each run settles exactly once, through `onSuccess`, `onUserCancelled`, or `onError`. On iOS, `onSuccess` was previously delivered from an internal section-completed event and could fail if the approval module had not reported; that path is gone.

`onError` now receives two arguments — the error **code** and a human-readable **message** — instead of a single string. `forceApproval` became optional and defaults to `false`.

```dart
// Before
IncodeOnboardingSdk.approve(
  forceApproval: false,
  onSuccess: (ApprovalResult result) { … },
  onError: (String error) {
    print('Approve error: $error');
  },
);

// After
IncodeOnboardingSdk.approve(
  onSuccess: (ApprovalResult result) { … },
  onError: (String code, String message) {
    print('Approve error: $code — $message');
  },
  onUserCancelled: () { … },
);
```

An approval that ran but did not approve the user is still delivered to `onSuccess`, with `result.success == false`. Only `userCancelled` and flow-level failures reach `onUserCancelled` / `onError`. If `onUserCancelled` is omitted, cancellation is reported to `onError` with the code `userCancelled`.

### `DocumentScan.showDocumentProviderOptions` is deprecated — migrate to `documentSources`

`showDocumentProviderOptions` maps to the deprecated native chooser flags and is not applied by the V2 UI. Use the new `documentSources` parameter, which works with both the V1 and V2 UI and lets you list the exact capture sources offered to the user.

```diff
 flowConfig.addDocumentScan(
   documentType: DocumentType.addressStatement,
-  showDocumentProviderOptions: false,
+  documentSources: [DocumentSource.camera],
 );
```

```diff
 flowConfig.addDocumentScan(
   documentType: DocumentType.addressStatement,
-  showDocumentProviderOptions: true,
+  documentSources: [
+    DocumentSource.camera,
+    DocumentSource.photoUpload,
+    DocumentSource.fileUpload,
+  ],
 );
```

`showDocumentProviderOptions` still compiles and is ignored when `documentSources` is provided. If neither is set, the native SDK default applies. See the [Android migration guide](/release-notes/migration-guide/#4-documentscanbuilder-chooser-flags-deprecated-for-v2---migrate-to-setdocumentsources).

Affects the standalone `faceMatch()` only. The `FaceMatch` module result is unchanged.

### `faceMatch()` parameter `faceMatchType` renamed to `matchType`

Affects the standalone `faceMatch()` only. The `FaceMatch` module result is unchanged.

```diff
- IncodeOnboardingSdk.faceMatch(faceMatchType: FaceMatchType.someValue, ...);
+ IncodeOnboardingSdk.faceMatch(matchType: FaceMatchType.someValue, ...);
```

### `faceMatch()`'s `onError` now receives a code, message and cause

The callback signature changed from `Function(String error)` to
`Function(String code, String message, PlatformException? cause)`,

```diff
  IncodeOnboardingSdk.faceMatch(
-   onError: (String error) {
-     print('faceMatch failed: $error');
+   onError: (String code, String message, PlatformException? cause) {
+     print('faceMatch failed: $code - $message');
    },
    ...
  );
```

`code` is `faceMatchError`, or `userCancelled` on Android when no `onUserCancelled` callback is supplied.

For failures other than cancellation, `onError` previously received the native error text. That text is now in `message`; `code` carries `faceMatchError`.

### Confidence scores of `-1` are `null` on Android

The native SDK returns `-1` for `confidence`, `nfcVsIdConfidence` and `nfcVsSelfieConfidence` when the image needed for the comparison was never uploaded. That `-1` used to reach you as if it were a score. They now return `null` instead, matching iOS.

```diff
- if (result.confidence == -1) { /* nothing to compare */ }
+ if (result.confidence == null) { /* nothing to compare */ }
```

A `0` is unaffected — it is a real "no match" score.

### `otpVerificationEnabled` renamed to `otpVerification`

The parameter on the `Phone` and `Email` modules now uses the native SDK's name.

```diff
- flowConfig.addPhone(otpVerificationEnabled: true);
+ flowConfig.addPhone(otpVerification: true);

- flowConfig.addEmail(otpVerificationEnabled: true);
+ flowConfig.addEmail(otpVerification: true);
```

The module constructors take the same new name:

```diff
- PhoneModule(otpVerificationEnabled: true)
+ PhoneModule(otpVerification: true)

- EmailModule(otpVerificationEnabled: true)
+ EmailModule(otpVerification: true)
```

Omitting the parameter leaves the native SDK setting in place rather than forcing it off.
In practice the native default is also off, so this only matters if your app configures the
SDK-level OTP flag itself.

### `PhoneNumberResult.phone` is now nullable

`phone` changed from `String` to `String?`. The value is absent when the SDK captured
nothing — for example when the user cancelled — so the old non-nullable type could not
represent the real payload.

```diff
- onAddPhoneNumberCompleted: (result) => print(result.phone.length),
+ onAddPhoneNumberCompleted: (result) => print(result.phone?.length ?? 0),
```

### `defaultRegionPrefix` is now range-checked

`PhoneModule.defaultRegionPrefix` accepts `1`–`9999`. Values outside that range are ignored
and the device's own region prefix is used, which is what the SDK documents. Previously an
out-of-range value was dropped on Android but passed through on iOS.

</Accordion>

## Migration to 4.21.0

<Accordion title="Migration to 4.21.0">

### iOS: Geolocation failures on iOS are delivered through `onGeolocationCompleted` for skippable modules instead of `onError`.

A skipped, denied, or unavailable location no longer ends the flow on iOS. It's reported via `GeoLocationResult.error` instead. See [Results](./flutter-results#geolocation).

No change needed to compile. If your `onError` handled this case, move that logic to `onGeolocationCompleted`:

```diff
 onGeolocationCompleted: (GeoLocationResult result) {
+    if (result.error != null) return handleLocationUnavailable();
     saveAddress(result);
 },
 onError: (String error) {
-    handleLocationUnavailable();
     handleFlowError(error);
 },
```

### New `IncodeSdkFlowError.locationUnavailable` case

Add this case to any exhaustive `switch` on `IncodeSdkFlowError`; it won't compile otherwise.

### The user-cancel tracking event is now `userCanceled` (Android only)

The Android SDK reports the user-cancel tracking event as `userCanceled`. It was `userCancelled`. The new spelling matches the other SDK events and the iOS SDK.

If you compare the `event` string delivered to `onEvents`, update it:

```diff
  onEvents: (result) {
-   if (result.event == 'userCancelled') {
+   if (result.event == 'userCanceled') {
      handleUserCancel();
    }
  },
```

Also update every dashboard query, saved report, or server-side rule that matches the literal `userCancelled`.

This does not affect the `onUserCancelled` callback, which is unchanged.

### Update the Signature V2 title and description string overrides (Android only)

Signature V2 uses dedicated string resources for the title and description. V1 continues to use the existing resources.

If you enable V2 and override the V1 strings, add these V2 overrides to your Android `res/values/strings.xml`:

```xml
<string name="onboard_sdk_signature_capture_title">Your title</string>
<string name="onboard_sdk_signature_capture_description">Your description</string>
```

Keep the V1 overrides if your integration still uses V1:

```xml
<string name="onboard_sdk_signature_title">Your title</string>
<string name="onboard_sdk_signature_description">Your description</string>
```

### `MLConsentResult.success` now reflects the user's choice (iOS only)

`success` used to be `true` whenever the submission call succeeded, even if the user
declined. It now reports the choice: `true` accepted, `false` declined. The consent stays
optional and the flow continues either way, so treat `false` as "declined" rather than as
a module failure.

### New `combinedConsentsNotReceived` flow error (iOS only)

A mandatory Combined Consent with no readable text or no checkbox id is no longer silently
accepted; the flow stops and `onError` receives `combinedConsentsNotReceived`. [Edit the consent in Dashboard](/dashboard-platform-administration/configuration-consents-tab) so it has a text to resolve this error. Optional consents that cannot be shown are still skipped, as before.

`combinedConsentsNotReceived` is never emitted on Android, but the enum is shared, so an
exhaustive `switch` over `IncodeSdkFlowError` still needs a branch for it there.

</Accordion>

## Migration to 4.20.0

<Accordion title="Migration to 4.20.0">

### Add the IncodeBridgeCommon CocoaPods source

iOS builds now depend on `IncodeBridgeCommon`. Add this source at the top of your `Podfile`. Access to Incode's GitHub org is required; if you do not have it, contact your Incode representative.

```diff
  source 'https://cdn.cocoapods.org/'
  source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
+ source 'git@github.com:Incode-Technologies-Example-Repos/IncodeBridgeCommonPodspecs.git'
```

Then run `pod install --repo-update` in the `ios` folder.

### `setTheme` and `setUXConfig` take a JSON string

`setTheme(theme:)` and `setUXConfig(jsonConfig:)` now accept a JSON `String` instead of `Map<String, dynamic>`.

```dart
import 'dart:convert';

// Before
await IncodeOnboardingSdk.setTheme(theme: {
  'primaryColor': '#0000FF',
});
await IncodeOnboardingSdk.setUXConfig(jsonConfig: {
  'showProgressBar': true,
});

// After
await IncodeOnboardingSdk.setTheme(
  theme: jsonEncode({
    'primaryColor': '#0000FF',
  }),
);
await IncodeOnboardingSdk.setUXConfig(
  jsonConfig: jsonEncode({
    'showProgressBar': true,
  }),
);
```

You can also pass a JSON file's contents directly.

### Removed and added parameters

* The `waitForTutorials` parameter has been removed from the `init()` method. Configure tutorials per module with `showTutorials` instead: for example, `flowConfig.addIdScan(showTutorials: true)`. See [Modules](./flutter-modules).

### Added `IncodeSdkInitError` codes

`IncodeSdkInitError` now includes `configError` and `invalidInitParams` in addition to `simulatorDetected`, `testModeEnabled`, and `unknown`. Update any exhaustive `switch` on the enum to handle the new cases, or keep a `default`. `onError` continues to receive the error **code** string; a human-readable detail may also be present in the native payload as `message`.

### Minimum Kotlin version raised to 2.2.x

The Android SDK is compiled with Kotlin `2.2.21`. Any module that compiles Kotlin source with the SDK on its classpath must use Kotlin Gradle plugin `2.2.21` or higher.

```groovy
plugins {
  id 'org.jetbrains.kotlin.android' version '2.2.21'
}
```

### Add required OkHttp packaging exclusion

Add the following exclusion to avoid duplicate-resource packaging collisions:

```groovy
android {
  packaging {
    resources {
      excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
    }
  }
}
```

### Upgrade compileSdk / AGP / Gradle wrapper

```groovy
compileSdk 36
```

Use Android Gradle Plugin `8.9.1` or higher and Gradle `8.14.5` or higher.

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.5-bin.zip
```

### Coroutines floor

If your app pins coroutines explicitly, use:

```groovy
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
```

</Accordion>

## Migration to 4.19.0

<Accordion title="Migration to 4.19.0">

### Removed and renamed parameters

* The `disableJailbreakDetection` parameter has been removed from the `init()` method, and has no replacement. If you set it anywhere, remove it; the code will not compile until you do.
* The `IncodeSdkFlowError`'s `jailbreakDetected` error code has been replaced with `integrityCompromised`.

</Accordion>

## Migration to 4.18.0

<Accordion title="Migration to 4.18.0">

### Renamed neutral and black color palette tokens on Android

The `neutral` and `black` keys in theme's `colorPalette` have been renamed:
* `neutral` -> `neutralLight`
* `black` -> `neutralDark`

If you provided the theme via a JSON config, rename the keys inside `colorPalette`:
```diff
"colorPalette": {
+  "neutralLight": "#ffffff",
-  "neutral": "#ffffff",
+  "neutralDark": "#000000",
-  "black": "#000000",
  "brand50": "#e5f0ff",
  ...
  "positive500": "#189F60",
  "positive600": "#189F60",
  "positive800": "#0C5030"
}
```

Theme JSON that still uses the old neutral / black keys will silently fall back to the defaults (#FFFFFF and #000000), because unknown keys are ignored during parsing. Update your JSON to use the new keys to keep your customizations applied.

</Accordion>

## Migration to 4.17.0

<Accordion title="Migration to 4.17.0">

### Required `type` parameter in `MLConsent` module

The `type` parameter of `MLConsent` module is now required. Previously, omitting it on iOS caused the `MLConsent` screen to be skipped silently while the module resolved successfully.

Update existing calls to pass a `MLConsentType`:

```diff
- flowConfig.addMLConsent();
+ flowConfig.addMLConsent(type: MLConsentType.gdpr);
```

Valid values are `MLConsentType.gdpr` and `MLConsentType.us`.

### Changed the default values of `faceMaskCheck`, `eyesClosedCheck`, `headCoverCheck` and `lensesCheck` parameters in SelfieScan and `FaceAuthentication` modules

The default values for the `faceMaskCheck`, `eyesClosedCheck`, `headCoverCheck` and `lensesCheck` parameters in `SelfieScan` and `FaceAuthentication` modules have been changed from `false` to `true`. If you did not previously configure these flags, they will now default to `true` during face capture. To preserve the previous behavior, explicitly disable these flags.

### SQLCipher attribution required if you ship an open-source licenses screen on Android

Local Room databases used by the SDK are now encrypted at rest with [SQLCipher for Android](https://github.com/sqlcipher/sqlcipher-android), distributed under a BSD-style license. The license requires consumers that redistribute binaries (i.e. your application) to reproduce its copyright notice "in the documentation and/or other materials provided with the distribution".

If your application includes an "Open Source Licenses" screen, please add the SQLCipher notice listed in [Licenses](./android-licenses). No code change is needed if you do not ship such a screen.

</Accordion>

## Migration to 4.15.0

<Accordion title="Migration to 4.15.0">

### Removed localization keys on iOS
* Removed localization keys
    - `incdOnboarding.nameInfo.lastnamePlaceholder`
    - `incdOnboarding.ccv.invalidCCV`
* Renamed localization keys:
    - `incdOnboarding.email.title` -> `incdOnboarding.userInformation.email.title`
    - `incdOnboarding.email.invalidEmail` -> `incdOnboarding.userInformation.email.wrongFormat`
    - `incdOnboarding.ccv.title` -> `incdOnboarding.userInformation.securityCode.title`
    - `incdOnboarding.nameInfo.title` -> `incdOnboarding.userInformation.fullName.title`
    - `incdOnboarding.nameInfo.subtitle` -> `incdOnboarding.userInformation.fullName.subtitle`
    - `incdOnboarding.nameInfo.namePlaceholder` -> `incdOnboarding.userInformation.fullName.placeholder`
    - `incdOnboarding.nameInfo.continue` -> `incdOnboarding.userInformation.continue`
    - `incdOnboarding.ekyc.input.label.fillYourCredentials` -> `incdOnboarding.ekyc.input.title`

</Accordion>

## Migration to 4.14.0

<Accordion title="Migration to 4.14.0">

### Removed parameters
* Removed `disableHookDetection`, `disableEmulatorDetection`, `disableRootDetection`, `disableVirtualEnvironmentDetection` parameters from `init` method.
* Removed `simulatorDetected`, `rootDetected`, `hookDetected`, `virtualEnvDetected` from `IncodeSdkFlowError`.

### Document chooser in `addIdScan`

Setting `idType` no longer hides the document chooser screen, on Android and iOS. With `startOnboarding` and `startNewOnboardingSection`, only `showIdTypeChooser: false` hides it, and the Dashboard's **Show document chooser screen** setting is ignored. With `startFlow` and `startWorkflow`, the Dashboard setting applies.

If you set `idType` to skip the chooser, add `showIdTypeChooser: false`:

```diff
  flowConfig.addIdScan(
    idType: IdType.id,
+   showIdTypeChooser: false,
  );
```

### Color palette changes on Android

If you previously customized the application appearance by updating these colors from the color palette:

```json
{
    "colorPalette": {
        "negative500": "#FF5A5F",
        "negative600": "#E71111",
        "positive500": "#189F60",
        "positive600": "#189F60"
    }
}
```

These keys have now been migrated to the following values:
* `negative500` -> `negative400`
* `negative600` -> `negative500`
* `positive500` -> `positive400`
* `positive600` -> `positive500`

The mentioned colors are used for the following Color Modes:
* `Icon/Status/Negative`
* `Icon/Status/Positive`
* `Surface/Status/Positive`
* `Border/Status/Negative Static`
* `Border/Status/Positive Static`

### `ID Capture` V2 - Error Screen Customization on Android

**Wrong document side customization:**

If you previously customized the `Wrong document side` error screen, add the following new string resources:

**Add these strings:**
```xml
<string name="onboard_sdk_id_capture_error_side_front">Capture the front side of the ID</string>
<string name="onboard_sdk_id_capture_error_side_back">Capture the back side of the ID</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_side">You’ve scanned the wrong document side. Please scan your document again.</string>
```

This string is no longer used.

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_title">There was a problem</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

**Retry button customization:**

The retry button is now customized using a different string resource:

```xml
<string name="onboard_sdk_id_capture_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_no_network_snackbar_action_text">Retry</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

### `Selfie` V2 - Error Screen Customization on Android

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_title">There was a problem</string>
```
The previously used string is still in use for other error screens and should be kept in your resources.

### String Customization on iOS
Removed localization key

`incdOnboarding.curp.add.generate`
Renamed localization keys:

`incdOnboarding.curp.generation.last.name.placeholder` -> `incdOnboarding.curp.generation.first.last.name.placeholder`
`incdOnboarding.curp.generation.name.placeholder` -> `incdOnboarding.curp.generation.first.name.placeholder`

#### Changes in behavior for device environment detection on Android

The behavior when detecting device environment vulnerabilities has changed:

* **Hook or virtual environment detection**: Detecting hook or virtual environment vulnerabilities in the SDK triggers a native crash, which cannot be caught or handled by application code, resulting in immediate app termination.
* **Emulator and root detection**: The flow is not aborted when emulator and root checks are detected. The onboarding process continues normally.

### Expected crashes when running in a virtual environment on Android

It is expected that the app crashes with the following stacktraces when a virtual environment is used. For example:

```
java.lang.NullPointerException
    at com.incode.welcome_sdk.ThemeConfiguration$Builder.setLabelSmallStyle(SourceFile:1066)
    at com.incode.welcome_sdk.f.c(SourceFile:150)
    at com.incode.welcome_sdk.data.local.m.as(SourceFile:22)
    at com.incode.welcome_sdk.IncodeWelcome.startOnboardingSection(SourceFile:18)
```

```
java.lang.NullPointerException: Attempt to get length of null array
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.d(SourceFile:320)
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.i(SourceFile:214)
```

### `Selfie` V2 - No Internet Error Screen Retry Button Change on Android

**Retry button customization:**

The retry button label shown on the Selfie Scan no internet error screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_face_scan_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_try_again">Try again</string>
```

If you override `onboard_sdk_try_again` to customize the retry button on the no internet screen, you must now override `onboard_sdk_face_scan_retry` instead.
The `onboard_sdk_try_again` string is still used for other retry scenarios.

### `Selfie` V2 - Capture-Only Mode Success Screen Text Change on Android

**Success label customization:**

In capture-only mode, the Selfie Scan success screen now uses a different string resource:

```xml
<string name="onboard_sdk_face_captured">Face captured!</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_enroll_success">Success!</string>
```

The previously used string is still in use for non-capture-only mode and should be kept in your resources.

### `ID Capture` and `Selfie` V2 - Permission Open Settings Screen Text Change on Android

**Open settings button customization:**

The Open settings label shown on the Permission open settings screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_permission_allow_permission_action">Allow permission</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_permission_open_setting_action">Open settings</string>
```

The previously used string is still in use for the `Geolocation` module and should be kept in your resources.

</Accordion>

## Migration to 4.13.0

<Accordion title="Migration to 4.13.0">

### Upload error screen customization on Android

If you previously customized the upload error screen, add the following new string resource:

*Add this string:*
```<string name="onboard_sdk_validation_error_button_text">Scan your ID</string>```

*Previous string:*
```<string name="onboard_sdk_id_capture_tutorial_title">Scan your ID</string>```

This string is now used only for customizing the ID Capture V2 tutorial screen title.

### Changed default values in FaceMatch module config on Android (optional)

With the move to UxV2, the showUserExists config is now false by default.

</Accordion>

## Migration to 4.12.0

<Accordion title="Migration to 4.12.0">

To keep using methods `addFace`, `removeFace`, `getFaces` and `setFaces` on iOS platform, please migrate to Flutter SDK variant '-l'.

```diff
 onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/IncdOnboardingFlutter.git
-    ref: release/[VERSION]
+    ref: release/[VERSION]-l

```
### Parameter Updates in `IdScan` module
* Remove usage of `enableRotationOnRetakeScreen` (this parameter has been removed).
* Replace `showRetakeScreen` with `showRetakeScreenForManualCapture`.
* Replace `showAutoCaptureRetakeScreen` with `showRetakeScreenForAutoCapture`.

### Update string resources for the "Need Help" screen in the `IdScan` v2 module on Android

The "Need Help" screen has been redesigned on Android, and the customizable strings have been replaced.
If you override any of the following strings in your app, replace them with the new ones listed below.

No action is required if you do not override these strings.

#### Replaced string resources

Replace overrides of:

```xml
<string name="onboard_sdk_id_capture_help_title">Need help?</string>
<string name="onboard_sdk_id_capture_help_subtitle">Some considerations</string>
<string name="onboard_sdk_id_capture_help_manual_photo_button_text">Take the photo manually</string>
<string name="onboard_sdk_id_capture_help_align_title">Center your document in the frame</string>
<string name="onboard_sdk_id_capture_help_align_subtitle">The photo will be taken automatically</string>
<string name="onboard_sdk_id_capture_help_blur_title">Avoid blurriness on the document</string>
<string name="onboard_sdk_id_capture_help_blur_subtitle">Zoom in and out, or tap on the document</string>
<string name="onboard_sdk_id_capture_help_glare_title">Avoid glare on the document</string>
<string name="onboard_sdk_id_capture_help_glare_subtitle">Find a better lighting to avoid reflections</string>
<string name="onboard_sdk_id_capture_help_darkness_title">Avoid darkness on the document</string>
<string name="onboard_sdk_id_capture_help_darkness_subtitle">Find a place with better lighting</string>
```

with:

```xml
<string name="onboard_sdk_id_capture_common_issues_title">Common issues</string>
<string name="onboard_sdk_id_capture_common_issues_glare_title">Glare present</string>
<string name="onboard_sdk_id_capture_common_issues_glare_subtitle">Tilt the ID slightly up or down to minimize the reflection</string>
<string name="onboard_sdk_id_capture_common_issues_blur_title">Blur present</string>
<string name="onboard_sdk_id_capture_common_issues_blur_subtitle">Move ID further away or closer to your phone until the image is focused</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_title">Info is not readable</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_subtitle">Minimize camera shake by holding your phone steady</string>
<string name="onboard_sdk_id_capture_common_issues_try_again_button">@string/onboard_sdk_try_again</string>
```

### Upgrade compileSdk on Android

With the update of the internal CameraX dependencies, you will need to upgrade your project's `compileSdk` to level 35:

```groovy
compileSdk 35
```

### Update Gradle Wrapper on Android

Android Gradle Wrapper `8.6.0` requires Gradle `8.7` or higher.
Update your Gradle wrapper configuration in `gradle/wrapper/gradle-wrapper.properties`:

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
```

</Accordion>

## Migration to 4.10.0

<Accordion title="Migration to 4.10.0">

### E2EE variant removed
RN SDK 'e2ee' variant is no longer distributed, as e2ee functionality is now offered in a standard Flutter SDK variant.

### Android optional dependencies
For Android, if you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:video-streaming:1.6.0'
implementation 'com.incode.sdk:extensions:1.2.1'
implementation 'com.incode.sdk:model-face-recognition:3.5.1'
implementation 'com.incode.sdk:model-id-face-detection:3.5.1'
implementation 'com.incode.sdk:model-liveness-detection:3.2.1'
```

### Android minSdk changes
For Android, if you use the video-streaming dependency, you need to upgrade your minSdk to 24 or higher. The requirement is coming from the OpenTok dependency, which now requires a minimum SDK version of 24. This update is necessary to ensure compatibility with the 16KB page size support mandated by Google starting from November 1st 2025. [More info](https://developer.android.com/guide/practices/page-sizes).

</Accordion>

## Migration to 4.9.0

<Accordion title="Migration to 4.9.0">

### Optional dependencies

For Android, if you use this optional dependency, make sure to update to the latest versions:

```groovy
implementation 'com.incode.sdk:extensions:1.2.1'
```

### Updated resource name

If you wanted to customize the logo at the top of the `IdScan` V2 module, you needed to override the incode logo resource: `onboard_sdk_incode_logo.xml`.\
This resource was not intended to be customizable, so please update your customizations to the new resource name: `onboard_sdk_logo_top.xml`.
By default, this resource is an empty 1x1 image, and you can customize it to your own logo.

</Accordion>

## Migration to 4.7.0

<Accordion title="Migration to 4.7.0">

For Android, if you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:model-face-recognition:3.5.0'
implementation 'com.incode.sdk:model-id-face-detection:3.5.0'
```

The `qr-face-login` dependency is no longer available and has been removed in this version of the SDK. Please update your project configuration accordingly.\
Remove the `qr-face-login` dependency from your `build.gradle`:

</Accordion>

## Migration to 4.6.0

<Accordion title="Migration to 4.6.0">

* Update Android `minSdkVersion` in you Android project's `build.gradle`:

```diff
  buildscript {
    ext {
-    minSdkVersion = 21
+    minSdkVersion = 23
    }
  }

```

Remove `com.incode.sdk:camera:1.1.0` dependency in your app’s `build.gradle` file:

```diff
  dependencies {
-    implementation 'com.incode.sdk:camera:1.1.0'
  }
```

<br />

</Accordion>

## Migration to 4.4.0

<Accordion title="Migration to 4.4.0">

* To enable the new ID capture experience on Android, add the `com.incode.sdk:camera:1.1.0` dependency to your app’s `build.gradle` file:

```diff
  dependencies {
+    implementation 'com.incode.sdk:camera:1.1.0'
  }
```

* If you are using NFC variant of the SDK follow the steps below to enable NFC scanning on iOS:

1. Turn on Near Field Communication Tag Reading under the Capabilities tab for the project’s target. This step:
   * Adds the NFC tag-reading feature to the App ID.
   * Adds the Near Field Communication Tag Reader Session Formats Entitlement to the entitlements file.

2. Add the NFCReaderUsageDescription key as a string item to the Info.plist file. For the value, enter a string that describes the reason the app needs access to the device’s NFC reader. If the app attempts to read a tag without providing this key and string, the app will crash.

3. Add interface for interacting with an ISO 7816 tag to App's Info.plist:

```
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
   <array>
      <string>A0000002471001</string>
      <string>A0000002472001</string>
      <string>00000000000000</string>
   </array>
```

NOTE\
If your app supports devices with iOS prior to 13.0, you will also need to set CoreNFC.framework and CryptoTokenKit.framework as an optional frameworks:

* Select your app target
* Under Build Phases -> Link Binary With Libraries add: CoreNFC.framework, CryptoTokenKit.framework and SwiftUI.framework libraries if they are already not on the list.
* And finally, for all three libraries, under Status, select Optional.

Note that even though NFC Scan module will not be performed on devices with iOS version older than 13, these steps are required because otherwise the app will crash on launch time.

### Example app migration

To run the example app, follow these steps:

1. Navigate to root of the example folder. Create .env file. The file is added in .gitignore so it won't be pushed to the repository. It is used to store your own credentials. Example of the .env file content:

```
# Demo
DEMO_API_URL=YOUR_API_URL
DEMO_API_KEY=YOUR_API_KEY
DEMO_COMBINED_CONSENT_ID=YOUR_COMBINED_CONSENT_ID
DEMO_WORKFLOW_CONFIGURATION_ID=YOUR_WORKFLOW_CONFIGURATION_ID
DEMO_FLOW_CONFIGURATION_ID=YOUR_FLOW_CONFIGURATION_ID
DEMO_DEEP_LINK=YOUR_DEEP_LINK
    
# SaaS
SAAS_API_URL==YOUR_API_URL
SAAS_API_KEY=YOUR_API_KEY
SAAS_COMBINED_CONSENT_ID=YOUR_COMBINED_CONSENT_ID
SAAS_WORKFLOW_CONFIGURATION_ID=YOUR_WORKFLOW_CONFIGURATION_ID
SAAS_FLOW_CONFIGURATION_ID=YOUR_FLOW_CONFIGURATION_ID
SAAS_DEEP_LINK=YOUR_DEEP_LINK
```

2. Run `flutter pub get` to install dependencies.
3. Run the following commands to generate corresponding files for those env values:

```
  flutter pub run build_runner clean
  flutter pub run build_runner build --delete-conflicting-outputs
```

4. The mandatory values to run the app properly are `apiKey` and `apiUrl`. Replace the other values in home.dart based on your needs.
5. Run the app.

</Accordion>

## Migration to 4.3.0

<Accordion title="Migration to 4.3.0">

* iOS integration requires `Podfile` update and SSH access being setup on the machine. Add these lines to the `Podfile`:

```diff
+ source 'https://cdn.cocoapods.org/'
+ source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
```

If you don't have access to the Incode's GitHub repo and SSH setup on the machine, please contact your Incode representative for support.

</Accordion>

## Migration to 3.2.0

<Accordion title="Migration to 3.2.0">

`compileSdk` and/or `compileSdkVersion` should be updated to 34.

</Accordion>

## Migration to 3.0.0

<Accordion title="Migration to 3.0.0">

1. Remove `core-light` dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.6.2' // Required core dependency
}
```

`com.incode.sdk:core-light` dependency is now part of the Flutter SDK itself.

2. Gradle versions should be updated to 7.+, ie. :

```diff
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.2.0'
+        classpath 'com.android.tools.build:gradle:7.4.2'
     }
```

Update gradle distributionUrl in your `gradle-wrapper.properties`:

```diff
-        distributionUrl=https\://services.gradle.org/distributions/gradle-6.9-all.zip
+        distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
```

</Accordion>

## Migration to 2.8.0

<Accordion title="Migration to 2.8.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.6.1' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.6.2' // Required core dependency
}
```

</Accordion>

## Migration to 2.7.0

<Accordion title="Migration to 2.7.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.5.1' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.6.1' // Required core dependency
}
```

2. The following dependencies are optional and needed only in very specific use cases.\
   Make sure you are using the features they provide before adding the dependencies below.
   Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
+ implementation 'com.incode.sdk:kiosk-login:1.3.1' // Optional kiosk-login dependency is only necessary if you are using Kiosk Login feature of the SDK.
+ implementation 'com.incode.sdk:model-liveness-detection:3.0.0' // Optional model-liveness-detection dependency is only necessary if you are using liveness detection feature that runs locally on device. This feature can be used within IncodeOnboardingSdk.startFaceLogin method
+ implementation 'com.incode.sdk:model-face-recognition:3.0.0' // Optional model-face-recognition dependency is only necessary if you are using face recognition feature that runs locally on device. This feature can be used within IncodeOnboardingSdk.startFaceLogin method
}
```

</Accordion>

## Migration to 2.6.0

<Accordion title="Migration to 2.6.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.5.0' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.5.1' // Required core dependency
}
```

</Accordion>

## Migration to 2.4.0

<Accordion title="Migration to 2.4.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.4.0' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.5.0' // Required core dependency
}
```

2. Update `compileSdkVersion` and `targetSdkVersion` in your Android project's `build.gradle` to 33.

3. Bumped `minSdkVersion` into 21 from 17

</Accordion>

## Migration to 2.2.0

<Accordion title="Migration to 2.2.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.3.0' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.4.0' // Required core dependency
}
```

</Accordion>

## Migration to 2.1.0

<Accordion title="Migration to 2.1.0">

1. Update dependency in your Android project's `build.gradle`:

```diff
dependencies {
- implementation 'com.incode.sdk:core-light:2.2.0' // Required core dependency
+ implementation 'com.incode.sdk:core-light:2.3.0' // Required core dependency
}
```

</Accordion>

## Migration to 2.x

<Accordion title="Migration to 2.x">

1. Added `setupOnboardingSession` that replaces `creatingNewOnboardingSession` and `setOnboardingSession`

```diff
- IncodeOnboardingSdk.creatingNewOnboardingSession
+ IncodeOnboardingSdk.setupOnboardingSession
```

```diff
- IncodeOnboardingSdk.setOnboardingSession
+ IncodeOnboardingSdk.setupOnboardingSession
```

2. iOS app setup changed - it is no longer needed to add these lines to the Podfile, so these should be removed when upgrading to 2.x:

```diff
-source 'https://github.com/CocoaPods/Specs.git'
-source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
```

</Accordion>

---

- Path: `release-notes/fr-french`
- URL: https://developer.incode.com/release-notes/fr-french/
- Markdown: https://developer.incode.com/release-notes/fr-french.md

# FR - French

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Acte de naissance`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Monnaie`
* `capturePreview.acceptedDocuments.DriversLicense` = `Permis de conduire`
* `capturePreview.acceptedDocuments.FederalID` = `ID fédéral`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Carte d'identité`
* `capturePreview.acceptedDocuments.label` = `Documents acceptés pour :`
* `capturePreview.acceptedDocuments.MedicalCard` = `Carte médicale`
* `capturePreview.acceptedDocuments.Military` = `Militaire`
* `capturePreview.acceptedDocuments.noDocuments` = `Aucun document n'est accepté pour ce pays. `
* `capturePreview.acceptedDocuments.Other` = `Autres`
* `capturePreview.acceptedDocuments.Passport` = `Passeport`
* `capturePreview.acceptedDocuments.Permit` = `Permis`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Document de résidence`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identification fiscale`
* `capturePreview.acceptedDocuments.TravelDocument` = `Document de voyage`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identification tribale`
* `capturePreview.acceptedDocuments.Unknown` = `Inconnu`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Immatriculation des véhicules`
* `capturePreview.acceptedDocuments.Visa` = `Visa`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identification des électeurs`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Permis de port d'arme`
* `common.refreshPage` = `Rafraîchir`
* `commonIssues.idv2.tryAgain` = `Ok, réessayez`
* `errors.dynamicImport.failedToLoad` = `Il s'agit d'une erreur inattendue, mais nous en avons pris note :`
* `errors.dynamicImport.suggestion` = `Nous réessayerons sur {{count}} ou vous pouvez actualiser manuellement.`
* `errors.dynamicImport.title` = `Désolé, nous avons rencontré un problème`
* `idv2.capture.autoCapture` = `La photo est prise automatiquement`
* `idv2.capture.dontMove` = `Ne bougez pas votre pièce d'identité pendant quelques secondes`
* `idv2.capture.fillFrame` = `Remplissez le cadre avec votre pièce d'identité`
* `idv2.capture.fillFramePassport` = `Remplissez le cadre avec votre passeport`
* `idv2.capture.manualCapture.ariaLabel` = `Capture manuelle`
* `idv2.capture.manualCapture.title` = `Bouton de capture manuelle`
* `idv2.capture.notifications.blur.description` = `Zoom avant et arrière, ou tapez sur l'ID`
* `idv2.capture.notifications.blur.title` = `ID trop flou`
* `idv2.capture.notifications.glare.description` = `Trouver un meilleur éclairage pour éviter les reflets`
* `idv2.capture.notifications.glare.title` = `ID avec éblouissement`
* `idv2.capture.notifications.notAligned.description` = `Centrer l'identifiant à l'intérieur du cadre`
* `idv2.capture.notifications.notAligned.title` = `L'identifiant n'est pas aligné`
* `idv2.capture.notifications.showBack.description` = `Retournez votre carte d'identité pour en montrer le verso`
* `idv2.capture.notifications.showBack.title` = `Montrer le verso de la carte d'identité`
* `idv2.capture.notifications.showFront.description` = `Retournez votre carte d'identité pour en montrer le recto`
* `idv2.capture.notifications.showFront.title` = `Montrer le recto de la carte d'identité`
* `idv2.capture.passport.subtitle` = `Assurez-vous que votre passeport est lisible`
* `idv2.capture.passport.title` = `Scannez votre passeport`
* `idv2.capture.processing.analyzing` = `Analyser...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} tentatives restantes`
* `idv2.capture.processing.continue` = `Continuer`
* `idv2.capture.processing.error` = `Erreur`
* `idv2.capture.processing.errors.classification.subtitle` = `Veillez à ce que l'ensemble de la carte d'identité soit visible et bien éclairé.`
* `idv2.capture.processing.errors.classification.title` = `Échec de la vérification de l'identité`
* `idv2.capture.processing.errors.default.subtitle` = `Veuillez réessayer`
* `idv2.capture.processing.errors.default.title` = `Il y a eu un problème`
* `idv2.capture.processing.errors.glare.subtitle` = `Inclinez légèrement l'ID vers le haut ou vers le bas pour minimiser les reflets.`
* `idv2.capture.processing.errors.glare.title` = `Éblouissement présent`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimisez le bougé de l'appareil photo en maintenant votre téléphone stable`
* `idv2.capture.processing.errors.readability.title` = `Les informations ne sont pas lisibles`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Éloignez ou rapprochez la carte d'identité de votre téléphone jusqu'à ce que l'image soit nette.`
* `idv2.capture.processing.errors.sharpness.title` = `Flou présent`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Veuillez essayer avec un autre document`
* `idv2.capture.processing.errors.unacceptable.title` = `Le type d'identification n'est pas accepté`
* `idv2.capture.processing.errors.upload.subtitle` = `Veuillez vérifier votre connexion et réessayer`
* `idv2.capture.processing.errors.upload.title` = `Échec de la numérisation de l'ID`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capture du côté {{mode}} de l'ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Mauvais côté de l'identifiant capturé`
* `idv2.capture.processing.scanBack` = `Numériser le dos`
* `idv2.capture.processing.success` = `Succès`
* `idv2.capture.processing.successBackSubtitle` = `Poursuivons maintenant`
* `idv2.capture.processing.successFrontSubtitle` = `Maintenant, capturons l'arrière`
* `idv2.capture.processing.successTitle` = `Traitement réussi !`
* `idv2.capture.processing.tryAgain` = `Réessayer`
* `idv2.capture.takingPhoto` = `Prendre des photos...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `Carte d'identité nationale ou permis de conduire`
* `idv2.chooser.idButtonTitle` = `Carte d'identité`
* `idv2.chooser.passportButtonDescription` = `Votre pays Passeport`
* `idv2.chooser.passportButtonTitle` = `Passeport`
* `idv2.permissions.alertAlt` = `fausse alerte de permission`
* `idv2.permissions.allow` = `OK, Autoriser`
* `idv2.permissions.denied.allow` = `Autoriser`
* `idv2.permissions.denied.ask` = `Demander`
* `idv2.permissions.denied.browser` = `Navigateur`
* `idv2.permissions.denied.camera` = `Appareil photo`
* `idv2.permissions.denied.changeTo` = `Passer à`
* `idv2.permissions.denied.open` = `Ouvrir`
* `idv2.permissions.denied.or` = `ou`
* `idv2.permissions.denied.refreshPage` = `Actualiser la page`
* `idv2.permissions.denied.return` = `Revenez ici et appuyez sur`
* `idv2.permissions.denied.scroll` = `Faites défiler vers le bas pour sélectionner`
* `idv2.permissions.denied.settings` = `Paramètres`
* `idv2.permissions.denied.tap` = `Robinet`
* `idv2.permissions.denied.title` = `Suivez les étapes suivantes pour permettre à Incode d'accéder à votre appareil photo`
* `idv2.permissions.denied.yourBrowser` = `votre navigateur`
* `idv2.permissions.description` = `afin d'achever le processus`
* `idv2.permissions.dontAllow` = `Ne pas autoriser`
* `idv2.permissions.fakeDenied.alert` = `alerte fausse focalisée`
* `idv2.permissions.fakeDenied.allowPermissions` = `Autorisations`
* `idv2.permissions.fakeDenied.quitProcess` = `Quitter le processus`
* `idv2.permissions.fakeDenied.title` = `L'autorisation de photographier est requise pour la capture de documents`
* `idv2.permissions.fakeDenied.warning` = `avertissement`
* `idv2.permissions.note` = `Note : En fonction de votre téléphone, il se peut que le message suivant s'affiche`
* `idv2.permissions.or` = `ou`
* `idv2.permissions.subtitle` = `autoriser l'appareil photo`
* `idv2.permissions.title` = `Nous avons besoin de vous pour`
* `idv2.permissions.whileUsing` = `Pendant l'utilisation de l'application`
* `idv2.tutorial.autoCapture` = `La photo est prise automatiquement`
* `idv2.tutorial.startScan` = `Scannons`
* `idv2.tutorial.subtitle` = `Veillez à ce que votre pièce d'identité soit lisible`
* `idv2.tutorial.title` = `Scannez votre carte d'identité`
* `idv2.uploading.analyzing` = `Analyser...`
* `idv2.uploading.imageAlt` = `Capture d'identité`
* `onboarding.errors.restartDisabled.message` = `Le redémarrage de la session est désactivé au niveau de l'organisation`
* `onboarding.errors.restartDisabled.title` = `Impossible de redémarrer la session`
* `qes.signatureCheck` = `Je consens à la délivrance du certificat requis et à la signature électronique de ce document.`
* `qes.termsCheck` = `J'ai lu et j'accepte la <2>politique de confidentialité</2> et les <6>conditions d'utilisation</6> d'Incode.`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Before: `Problèmes communs`
  * Now: `Problèmes courants`
* `commonIssues.infoNotReadable`:
  * Before: `Les informations ne sont pas lisibles`
  * Now: `Informations illisibles`
* `commonIssues.takeManually`:
  * Before: `Prendre la photo manuellement`
  * Now: `Prendre une photo manuellement`
* `commonIssues.tryAgain`:
  * Before: `OK, reprendre`
  * Now: `Réessayer`
* `notifications.done`:
  * Before: `Terminé`
  * Now: `Scan terminé`
* `notifications.glareDetected`:
  * Before: `Éblouissement présent`
  * Now: `Éblouissement détecté`
* `notifications.glareDetectedDescription`:
  * Before: `Inclinez légèrement l'ID vers le haut ou vers le bas pour minimiser les reflets.`
  * Now: `Trouver un meilleur éclairage pour éviter les reflets`
* `notifications.idTypeUnacceptable`:
  * Before: `Le type d'identification n'est pas accepté`
  * Now: `Document d'identification non valide`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Veuillez essayer avec un autre document`
  * Now: `Essayez d'en scanner un autre`
* `notifications.lowSharpness`:
  * Before: `Flou présent`
  * Now: `Faible netteté`

---

- Path: `release-notes/incode-releases`
- URL: https://developer.incode.com/release-notes/
- Markdown: https://developer.incode.com/release-notes.md

# Incode Release Notes Overview

This page tracks the current release status of all Incode components. Use it to check the latest version of any SDK or platform layer, see when it was last updated, and navigate directly to the latest release notes. Release cadences are approximate and subject to change. Contact your Incode representative if you need information about a specific version or an upcoming release. 

Incode SDKs adhere to a 12 month [deprecation policy](/release-notes/sdk-deprecation-policy-and-timeline/).

| Platform                                                                                                             | Latest version | Last updated  | Cadence                                          |
| :------------------------------------------------------------------------------------------------------------------- | :------------- | :------------ | :----------------------------------------------- |
| [Platform](/release-notes/platform-release-notes-2026/) (API / Dashboard / Webflows) | Demo | October 26, 2026 | Weekly, rotating between Demo and SaaS releases. |
| [Web SDK 1.x](/release-notes/releases-web-sdk/)                                                        | 1.94.0           | October 9, 2026 | Monthly                                          |
| [Web SDK 2.x](/release-notes/web-sdk-20-release-notes/)                                                        | 2.4.0           | October 23, 2026 | Monthly                                          |
| [iOS SDK](/release-notes/releases-ios-sdk/)                                                              | 5.51.0           | October 20, 2026 | Bi-weekly|
| [Android SDK](/release-notes/releases-android-sdk/)                                                           | 5.55.0           | October 21, 2026 | Bi-weekly |
| [React Native SDK](/release-notes/releases-rn-sdk/)                                                   | 9.19.0           | October 29, 2026 | Bi-weekly |
| [Flutter SDK](/release-notes/releases-flutter-sdk/)                                                   | 4.22.0           | October 7, 2026 | Bi-weekly                                                |
| [Cordova SDK](/release-notes/releases-cordova-sdk/)                                                   | 4.10.0          | October 7, 2026  | Bi-weekly                                                |
| [Xamarin SDK](/release-notes/releases-xamarin-sdk/)                                                      | 2.0.2          | April 16, 2025  | —                                                |

<br />

---

- Path: `release-notes/migration_guide`
- URL: https://developer.incode.com/release-notes/migration_guide/
- Markdown: https://developer.incode.com/release-notes/migration_guide.md

# Migration guide

## Migration to 5.51.0

### Face Login: Three New Parameters in the startFaceLogin Protocol Requirement

The `startFaceLogin` requirement of the `IncdOnboardingManagerAPI` protocol now includes `localLivenessCheck`, `localAgeEstimation` and `uxMode`:

```swift
func startFaceLogin(
  showTutorials: Bool?,
  customerUUID: String?,
  faceAuthMode: FaceAuthMode?,
  faceAuthModeFallback: Bool?,
  lensesCheck: Bool?,
  faceMaskCheck: Bool?,
  localLivenessCheck: Bool?,   // new
  localAgeEstimation: Bool?,   // new
  forceThemeBackground: Bool,
  logAuthenticationEnabled: Bool?,
  customLogo: UIImage?,
  uxMode: FaceLoginUXMode?,    // new
  streamFramesToken: String?,
  completion: @escaping (_ result: SelfieScanResult) -> Void
)
```

- **Calls made directly on** `IncdOnboardingManager.shared`: No changes needed. The new parameters have default values there. 
- **Calls made through a value typed as** `IncdOnboardingManagerAPI`: Pass the three new parameters. To keep the previous behavior, pass `nil` for all three. 
- **Your own implementations of the protocol, such as test mocks**: Update them to the new signature. An implementation with the old signature still compiles, but the SDK no longer calls it through the protocol.

## Migration to 5.49.0

<Accordion title="Migration to 5.49.0">

### Combined Consents: New IncdFlowError.combinedConsentsNotReceived Case

`IncdFlowError` gains a new case:

```swift
case combinedConsentsNotReceived  // new
```

It is reported through `IncdOnboardingDelegate.onError(_:)` when the backend returns a mandatory consent that has no readable text or no checkbox id, so the user cannot review and accept it. Text that is empty or only spaces counts the same as missing text. The module ends instead of showing the consent, and the flow stops. Give the consent a text in Dashboard to clear the error.

An optional consent that cannot be shown is still left out and the flow continues, as before. If you `switch` exhaustively over `IncdFlowError`, add a handler for this case.

### Machine Learning Consent: status Now Reports the User's Choice

`MachineLearningConsentResult.status` used to report whether the submission call succeeded, so it was `true` even when the user declined the consent. It now reports the choice the user made and Incode recorded:

```swift
func onMachineLearningConsentCompleted(_ result: MachineLearningConsentResult) {
    switch result.status {
    case true:  // the user accepted the consent
    case false: // the user declined the consent
    default:    // the choice could not be recorded, see result.error
    }
}
```

The consent stays optional. The user can continue with or without it, and the flow continues to the next module in both cases. If your compliance rules require the consent, read `status` and apply your own policy. This is a behavior change only, and no call-site changes are required to compile.

### V2 Checkboxes: Drawn from the Theme, Image Assets No Longer Used

The checkbox on the V2 screens is drawn from the V2 color tokens instead of the `incdOnboarding.checkBox.checked` / `incdOnboarding.checkBox.unchecked` image assets, so it now follows the `brand500` color from your theme configuration.

If you override those two assets, the override still applies on the V1 screens but is ignored on the V2 ones. Set the checkbox color through the theme configuration (`brand500`) instead, and check the result on the V2 consent and signing screens.

### Analytics: No Internet Reported as Its Own Screen

The No Internet screen now reports its own analytics screen name instead of sharing the generic error screen. This changes the analytics stream only; no call-site changes are required to compile.

Face Capture is a **replacement**. `faceCapture.genericErrors` is no longer reported at all, and the No Internet screen reports `faceCapture.genericErrors.noConnection` in its place. Any dashboard, funnel or alert keyed on `faceCapture.genericErrors` stops receiving events and needs repointing.

Front ID Capture is **additive**. `idCapture.frontCaptureError` is still reported for other front-capture errors, and the No Internet screen reports `idCapture.frontCaptureError.noConnection` alongside it.

The back ID side is unchanged.

</Accordion>

## Migration to 5.48.0

<Accordion title="Migration to 5.48.0">

### Face Capture and Face Authentication: New videoRecordingFailed Case and Background-Recovery Change

`SelfieScanError` and `FaceAuthenticationError` each gain a new case:

```swift
case videoRecordingFailed  // new
```

The case is reported when the Deepsight video could not be recorded or finalized — for example when the hardware video encoder was invalidated while the app was in the background. It is non-fatal: the face capture itself completes normally, and the failure is surfaced only via the existing `videoRecordingError` field on `SelfieScanResult` / `FaceAuthenticationResult` — the `error` field remains reserved for terminal failures, so existing error handling is unaffected. If you `switch` exhaustively over `SelfieScanError` or `FaceAuthenticationError`, add a handler for this case.

Behavior change: backgrounding the app during Face Capture or Face Authentication used to lose the Deepsight video silently, because the invalidated encoder only failed at finalization. The SDK now discards the pre-background footage and records a fresh clip once the app returns to the foreground, so the uploaded video covers the capture from the resume point onward. No call-site changes are required for this.

</Accordion>

## Migration to 5.47.0

<Accordion title="Migration to 5.47.0">

### ID Capture: New IDFrameAnalysisError.preparingCamera Case

`IDFrameAnalysisError` gains a new case:

```swift
case preparingCamera  // new
```

`preparingCamera` is reported through `IDCaptureFeedback.error` while the ID camera is getting ready, before the preview is shown. It is not an error: capture continues normally once the camera is ready, and the SDK's own screens show the existing "Adjusting camera" copy for it, just like `settingUpStreaming`. If you `switch` exhaustively over `IDFrameAnalysisError`, add a handler for this case.

### testMode Now Allowed on Real Devices

`initIncdOnboarding(...)` with `testMode: true` used to fail on a real device with
`IncdInitError.testModeEnabled`. It now succeeds, so you can develop against a real device with test mode on. The SDK prints a console warning when test mode is enabled to remind you to set it back to `false` before distribution.

`IncdInitError.testModeEnabled` is kept so existing `switch` statements keep compiling, but it is no longer reported. Remove any handling that relied on initialization failing for this reason.

### AES: showCertificateOnSuccess Removed from addAes

The AES module now shows a V2-style success screen instead of listing the signed documents. `showCertificateOnSuccess` had no other effect, so it was removed from `addAes(...)`. Downloading the signed document is unchanged and still follows `AESConfiguration.downloadDocument`. When enabled, the success screen offers a "Download document" action.

Old way:
```swift
flowConfig.addAes(configuration: aesConfiguration, showCertificateOnSuccess: true)
```

New way:
```swift
flowConfig.addAes(configuration: aesConfiguration)
```

The code will not compile until the argument is removed. `AESConfiguration` and `AESResult` are unchanged.

### Electronic Signature (AES/QES): V2 Screens and Localization Key Changes

Both signature modules now run on the Incode Design System V2. The `addQes(...)` API and both result
types are unchanged. User-visible changes include:

- QES now honors `QESConfiguration.uploadDocument`. When enabled, the user picks and uploads a PDF before the signing screen, just like AES. Previously, the flag was ignored, so a session with no documents attached ended with `QESResult.error == .noDocuments`.
- Both signing screens show the close button whenever `IncdOnboardingManager.shared.allowUserToCancel` allows it. Previously, it was suppressed unconditionally.

Localization key changes include:

- Removed (overrides of these keys no longer have any effect):
  - `incdOnboarding.qes.terms1.title`
  - `incdOnboarding.qes.terms2.title`
- Added:
  - `incdOnboarding.qes.consent.qualifiedCertificate`, `.legalEffect`, `.qscd`, `.termsPrivacy`, and `.reviewedDocuments`: The five consent checkboxes on the QES signing screen, replacing the two
    removed keys above.
  - `incdOnboarding.aes.document.namePosition` and `incdOnboarding.qes.document.namePosition`: The document card name used when more than one document is signed.
- Copy updated without renames, so existing overrides keep working: `incdOnboarding.aes.terms1.title`,
  `.terms2.title`, `.terms3.title`, `incdOnboarding.aes.acceptSign.subtitle`,
  `incdOnboarding.aes.document.name`, and `incdOnboarding.qes.document.name`. The last two now hold the single-document name and no longer take a number.

See [Localize Display Text](/sdk-reference/ios-customization#localize-display-text) for the full key list.

### Face Capture and Face Authentication: New videoRecordingError Field and insufficientStorageForVideoRecording Case

`SelfieScanResult` and `FaceAuthenticationResult` gain a new optional field:

```swift
public var videoRecordingError: SelfieScanError?          // on SelfieScanResult
public var videoRecordingError: FaceAuthenticationError?  // on FaceAuthenticationResult
```

`SelfieScanError` and `FaceAuthenticationError` each gain a new case:

```swift
case insufficientStorageForVideoRecording  // new
```

The case is reported when Deepsight video recording is skipped because the device has less than 15 MB of free storage. It is non-fatal: the face capture itself completes normally, and the skip is surfaced only via `videoRecordingError`. The `error` field remains reserved for terminal failures, so existing error handling is unaffected. If you `switch` exhaustively over `SelfieScanError` or `FaceAuthenticationError`, add a handler for this case.

### Signature: New SignatureError.retryLimitReached Case

`SignatureError` gains a new case:

```swift
public enum SignatureError {
  case error(_ error: IncdError)
  case declinedToSignDocument
  case retryLimitReached          // new
}
```

`retryLimitReached` is returned in `SignatureFormResult.error` when the user exceeds the maximum number of allowed signing attempts. If you `switch` exhaustively over `SignatureError`, add a handler for this case.

</Accordion>

## Migration to 5.45.0

<Accordion title="Migration to 5.45.0">

### Model loading API — extended signatures and auto-unload by default

`IncdOnboardingManager.shared.loadModels` and `IncdOnboardingManager.shared.loadModelsSynchronously` now take two additional parameters:
- `modelGroup: ModelGroup` — selects which models to preload. Defaults to `.all`. Use `.idCapture` or `.faceCapture` to load only what the next flow needs.
- `autoUnload: Bool` — when `true` (default), loaded models are released automatically once onboarding finishes or is cancelled, freeing ~80–100 MB. Pass `false` to keep models resident across sessions and release them yourself via `unloadModels()`.

Existing call sites that rely on the previous defaults continue to compile without changes, but the runtime behavior is now different: models that previously stayed in memory between onboardings are released by default. If you want the prior behavior, opt out explicitly.

Old way:
```swift
IncdOnboardingManager.shared.loadModels {
  // models loaded
}

IncdOnboardingManager.shared.loadModelsSynchronously()
```

New way (equivalent, models still released after each onboarding):
```swift
IncdOnboardingManager.shared.loadModels(
  modelGroup: .all,
  autoUnload: true
) {
  // models loaded
}

IncdOnboardingManager.shared.loadModelsSynchronously(
  modelGroup: .all,
  autoUnload: true
)
```

New way (preserve previous behavior — keep models resident across sessions):
```swift
IncdOnboardingManager.shared.loadModels(autoUnload: false) {
  // ...
} 

// release explicitly when you're done with the SDK
IncdOnboardingManager.shared.unloadModels()
```

### Deepsight configuration — unified `DeepsightConfiguration` for Face Capture and Face Authentication

Selfie / Face Capture and Face Authentication now express Deepsight capture through a single `DeepsightConfiguration`, matching the Dashboard flow/workflow model:

- `DeepsightModality`:
  - `.singleFrame` — single frame, no depth data, no video liveness.
  - `.singleFrameWithDepth` — single frame with depth data, no video liveness.
  - `.singleFrameWithDepthAndVideo` — single frame with depth data and recorded video liveness.
- `DeepsightConfiguration(enabled:modality:motion:)` — `enabled` toggles Deepsight, `modality` selects what is captured, `motion` enables motion capture.

#### Selfie scan

The `addSelfieScan` overload that took `requireDepthData` / `videoLivenessRecording` is **deprecated** (not removed). Use the new overload that takes a `DeepsightConfiguration`:

Old way (deprecated):
```swift
config.addSelfieScan(
  requireDepthData: true,
  videoLivenessRecording: true
)
```

New way:
```swift
config.addSelfieScan(
  deepsight: DeepsightConfiguration(
    enabled: true,
    modality: .singleFrameWithDepthAndVideo,
    motion: true
  )
)
```

Mapping from the deprecated parameters:

| Deprecated parameters | New `DeepsightModality` |
| --- | --- |
| `videoLivenessRecording: false` | `.singleFrameWithDepth` (depth captured, preserving previous behavior) |
| `videoLivenessRecording: true` | `.singleFrameWithDepthAndVideo` |

Notes:
- `requireDepthData` no longer affects capture — whether depth is captured is now determined by the modality.
- The new `deepsight` parameter defaults to `DeepsightConfiguration.default` (Deepsight disabled). A bare `addSelfieScan()` therefore now performs a plain single-frame capture (no depth, no video, no motion); pass an explicit `DeepsightConfiguration` to enable them.

#### Face authentication

`FaceAuthenticationConfiguration` now accepts a `DeepsightConfiguration`:

```swift
let config = FaceAuthenticationConfiguration(
  deepsight: DeepsightConfiguration(modality: .singleFrameWithDepthAndVideo, motion: true)
)
```

When a flow/workflow is fetched from the Dashboard, Deepsight is configured automatically from the backend (`ds`, `deepsightLiveness`, and `motion`); no SDK changes are required for flow/workflow-driven onboarding.

### NFC Scan Module — Redesign to Design System V2

The `NFC Scan` module has been migrated to the Incode Design System V2. The public `addNfcScan(...)` API and `NFCScanResult` are unchanged; integration code does not need to be touched. User-visible flow changes:

- After a chip-read failure, a general error screen is shown briefly before the try-again screen.
- The try-again CTA now navigates through the OCR-edit screen so users can confirm document data before retrying. Previously the CTA restarted the scan immediately.
- The passport try-again carousel advances one page per failed attempt (capped at the last page). Previously the carousel was shown only once.
- A dedicated error screen is shown when the device does not support NFC; the module then completes with `NFCScanResult.error == .notAvailable`.

Several `incdOnboarding.nfc.*` strings had their casing/copy updated, and new keys were added for V2-only screens. See [SDK Customization](/sdk-reference/ios-customization/#localize-display-text) for the full key list. No key renames or removals — overrides in your `Localizable.strings` continue to work.

### `disableJailbreakDetection` removed

The public `IncdOnboardingManager.shared.disableJailbreakDetection` property has been removed and has no replacement. If you set it anywhere, remove those calls; the code will not compile until you do.

Old way:
```swift
IncdOnboardingManager.shared.disableJailbreakDetection = true
```

New way: remove the call.

</Accordion>

## Migration to 5.44.0

<Accordion title="Migration to 5.44.0">

### Face Capture validation flags — defaults changed from `false` to `true`

When the dashboard configuration omits `validateLenses`, `validateFaceMask`, `validateClosedEyes`, or `validateHeadCover`, the SDK now defaults them to `true`. If you relied on these being off, set them explicitly to `false` in your dashboard configuration — otherwise the corresponding checks will start running and may reject captures that previously passed.

### `IncdTheme.logo` — now also applied to V2 screens

V2 screens now respect `IncdTheme.logo`, using it before falling back to the host app's `incdOnboardingLogo` asset and then the SDK default (V1 already worked this way). If you previously set `IncdTheme.logo` for V1 and a separate `incdOnboardingLogo` asset expecting V2 to show the asset, V2 will now show `IncdTheme.logo` on both. Leave `IncdTheme.logo` unset to keep V2 on the asset.

</Accordion>

## Migration to 5.43.0

<Accordion title="Migration to 5.43.0">

### `IncdFlowError` and `GeolocationError` — new cases

The reworked `Geolocation` failure UX adds new enum cases. Update any exhaustive `switch` over `IncdFlowError` or `GeolocationError`:

- `IncdFlowError.locationUnavailable` - fired via `IncdOnboardingDelegate.onError(_:)` when a non-skippable `Geolocation` module exhausts its retries on the location-unavailable screen and the user taps `Quit process`.
- `GeolocationError.locationUnavailable` - surfaced via `GeolocationResult.error` when a skippable `Geolocation` module is skipped from either failure screen.

</Accordion>

## Migration to 5.42.0

<Accordion title="Migration to 5.42.0">

- Removed localization keys
  - `incdOnboarding.nameInfo.lastnamePlaceholder`
  - `incdOnboarding.ccv.invalidCCV`
- Renamed localization keys:
  - `incdOnboarding.email.title` -> `incdOnboarding.userInformation.email.title`
  - `incdOnboarding.email.invalidEmail` -> `incdOnboarding.userInformation.email.wrongFormat`
  - `incdOnboarding.ccv.title` -> `incdOnboarding.userInformation.securityCode.title`
  - `incdOnboarding.nameInfo.title` -> `incdOnboarding.userInformation.fullName.title`
  - `incdOnboarding.nameInfo.subtitle` -> `incdOnboarding.userInformation.fullName.subtitle`
  - `incdOnboarding.nameInfo.namePlaceholder` -> `incdOnboarding.userInformation.fullName.placeholder`
  - `incdOnboarding.nameInfo.continue` -> `incdOnboarding.userInformation.continue`
  - `incdOnboarding.ekyc.input.label.fillYourCredentials` -> `incdOnboarding.ekyc.input.title`

</Accordion>

## Migration to 5.41.0

<Accordion title="Migration to 5.41.0">

### CURP Validation Module — Localization Key Changes
 
The CURP Validation module has been redesigned to use the Incode Design System V2. As part of this update:
 
- Removed localization key:
  - `incdOnboarding.curp.add.generate`
- Renamed localization keys:
  - `incdOnboarding.curp.generation.last.name.placeholder` → `incdOnboarding.curp.generation.first.last.name.placeholder`
  - `incdOnboarding.curp.generation.name.placeholder` → `incdOnboarding.curp.generation.first.name.placeholder`
 
If you override CURP-related strings in your `Localizable.strings`, update the keys above. Unused keys can be safely removed.

### ID Document Chooser — `idType` Behavior Change

The visibility of the ID Document Chooser screen is now controlled only by the **"Show document chooser screen"** flag on the Dashboard or `showIdTypeChooser` in `addIdScan`.

- When using startFlow / startWorkflow, the Dashboard setting is respected.
- When using **`startOnboarding` / `startOnboardingSection`**: the Dashboard flag is ignored and visibility is controlled exclusively via `showIdTypeChooser` in `addIdScan`.

Setting `idType` alone no longer hides the chooser and will be ignored.

If you use `startOnboarding` / `startOnboardingSection` and previously relied on `idType` to suppress the chooser, add an explicit `showIdTypeChooser: false`:

```swift
// Before (implicit suppression via idType — no longer works)
addIdScan(idType: .id)

// After (explicit)
addIdScan(idType: .id, showIdTypeChooser: false)
```
 
### V2 Theme Color Palette — Positive and Negative Token Renames
 
The JSON/code keys used for positive and negative semantic colors in `IncdTheme`'s V2 color palette have been renamed. If you customize the color palette via JSON or code, update the following keys:
 
| Old key | New key |
|---|---|
| `negative500` | `negative400` |
| `negative600` | `negative500` |
| `positive600` | `positive500` |
| `positive800` | `positive950` |
 
For the full updated palette reference, see [About Colors](/sdk-reference/ios-customization/#customize-theme-colors-and-fonts) in the Customization Guide v2.

</Accordion>

## Migration to 5.40.0

<Accordion title="Migration to 5.40.0">

- Deprecated `title` and `description` parameters from `addSignature` method.
  - Use `addSignature(descriptionMaxLines:documents:)` and customize text via these keys in your app's `Localizable.strings`:
    - `"incdOnboarding.signature.title"`
    - `"incdOnboarding.signature.description"`

</Accordion>

## Migration to 5.39.0

<Accordion title="Migration to 5.39.0">

- Removed `enableRotationOnRetakeScreen` parameter from `addIdScan` method. Document in the review screen is shown in vertical orientation always.
- Renamed `showRetakeScreen` into `showRetakeScreenForManualCapture` in `addIdScan` method.
- Renamed `showAutoCaptureRetakeScreen` into `showRetakeScreenForAutoCapture` in `addIdScan` method.

</Accordion>


## Migration to 5.38.0

<Accordion title="Migration to 5.38.0">

- Renamed `FaceAuthenticationConfiguration` struct field `showTutorial` to `showTutorials` in order to perserve consistent parameter naming with other modules.
-  Deprecated `enableIdSummaryScreen` parameter from addIdProcess. Now function signature is now `addIdProcess(idCategory: IDCategory)`. Screen will not appear when using v2 UI. IdSummaryScreen will be removed in future update.

</Accordion>

---

- Path: `release-notes/migration-guide`
- URL: https://developer.incode.com/release-notes/migration-guide/
- Markdown: https://developer.incode.com/release-notes/migration-guide.md

# Migration Guide

This page details instructions for migrating to newer versions of the Android Welcome SDK. If you skip versions, apply every section between your current version and the target version, from oldest to newest.

:::info
If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.
:::

## Migration to 5.55.0

### 1. Replace `IncodeThemeConfig.fromJson` and `IncodeUXConfig.fromJson` with `setUIConfigFromJson`

`IncodeThemeConfig.fromJson(context, json)` and `IncodeUXConfig.fromJson(json)` are deprecated. Use `CommonConfig.Builder.setUIConfigFromJson(context, json)`, which reads one JSON document with a `theme` object and a `ux` object and applies both.

The deprecated methods continue to work. `setThemeConfig` and `setUXConfig` are not deprecated; keep using them to configure the theme and UX with Kotlin or Java objects.

**Before (deprecated):**

```kotlin
IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setThemeConfig(IncodeThemeConfig.fromJson(context, themeJson))
        .setUXConfig(IncodeUXConfig.fromJson(uxJson))
        .build()
)
```

**After:**

```kotlin
val jsonString = """
{
  "theme": { "displayMode": "light" },
  "ux": { "showFooter": true, "closeButtonPosition": "topRight" }
}"""

IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setUIConfigFromJson(context, jsonString)
        .build()
)
```

**Before (deprecated):**

```java
IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setThemeConfig(IncodeThemeConfig.fromJson(context, themeJson))
        .setUXConfig(IncodeUXConfig.fromJson(uxJson))
        .build()
);
```

**After:**

```java
String jsonString = "{"
    + "\"theme\": { \"displayMode\": \"light\" },"
    + "\"ux\": { \"showFooter\": true, \"closeButtonPosition\": \"topRight\" }"
    + "}";

IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setUIConfigFromJson(context, jsonString)
        .build()
);
```

Move the content of `themeJson` under the `theme` key and the content of `uxJson` under the `ux` key. The property names inside each object do not change. `setUIConfigFromJson` replaces the theme and the UX configuration set earlier on the builder. If one object is absent or `null`, that part is set to the SDK default. To keep a programmatic UX configuration, call `setUXConfig` after `setUIConfigFromJson`. A document with neither object throws `IllegalArgumentException`.

### 2. Theme logos on V2 screens must be vector or raster images

From 5.55.0, V2 screens show the logo that you set with `ThemeConfiguration.Builder().setLogo()`. Before 5.55.0, V2 screens did not use this logo. V1 screens are not affected.

On V2 screens, this logo must be a vector drawable or a raster image (PNG, JPG, or WebP). V2 screens do not support other XML drawables, for example `layer-list`, `selector`, or `shape`. If the logo is one of these types, the V2 screens stop with an error.

This change applies only when you enable the V2 feature gate and set one of these XML drawables with `ThemeConfiguration.Builder().setLogo()`. If you have a `drawable-night` variant of the logo, it must also be a vector drawable or a raster image.

If your logo is one of these XML drawables, replace it with a vector drawable or a PNG, JPG, or WebP image before you update to 5.55.0. Keep the same resource name, so no code change is necessary.

**Before** (not supported on V2 screens):
```xml
<!-- res/drawable/my_logo.xml -->
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:drawable="@drawable/my_logo_image" />
</layer-list>
```

**After** (supported on V1 and V2 screens), use one of these:
- `res/drawable/my_logo.png` (or `.jpg`, `.webp`)
- `res/drawable/my_logo.xml` as a vector drawable:
```xml
<vector xmlns:android="http://schemas.android.com/apk/res/android"
    android:width="120dp"
    android:height="32dp"
    android:viewportWidth="120"
    android:viewportHeight="32">
    <path
        android:fillColor="#E30613"
        android:pathData="M0,0h120v32h-120z" />
</vector>
```

The code that sets the logo does not change:

```kotlin
ThemeConfiguration.Builder().setLogo(R.drawable.my_logo).build()
```
```java
new ThemeConfiguration.Builder().setLogo(R.drawable.my_logo).build();
```

## Migration to 5.54.0

<Accordion title="Migration to 5.54.0">

### 1. Renamed `IncodeColorPalette.positive800` to `positive750`

To align with Incode Studio's exported palette, `positive800` has been renamed to `positive750` (same color).

If you previously customized this color via Kotlin:

```kotlin
IncodeWelcome
    .getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setThemeConfig(
                IncodeThemeConfig(
                    colorPalette = IncodeColorPalette(
                        positive800 = Color(0xFF0C5030)
                    )
                )
            )
            .build()
    )
```

use `positive750` instead:

```kotlin
IncodeWelcome
    .getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setThemeConfig(
                IncodeThemeConfig(
                    colorPalette = IncodeColorPalette(
                        positive750 = Color(0xFF0C5030)
                    )
                )
            )
            .build()
    )
```

If you provide the theme via a JSON config, rename the key inside `colorPalette`:

**Before**
```json
{
    "colorPalette": {
        "positive800": "#0C5030"
    }
}
```

**After**
```json
{
    "colorPalette": {
        "positive750": "#0C5030"
    }
}
```

Theme JSON that still uses the old `positive800` key will silently fall back to the default, because unknown keys are ignored during parsing. Update your JSON to use `positive750` to keep your customization applied.

### 2. The Google Wallet flow no longer lives in the ID capture screen

The Google Wallet flow moved out of the ID capture screen and into its own screen. These symbols were public only because they sat in UI classes. They are now internal or removed:

| Symbol | Change |
|---|---|
| `WalletIdErrorScreen` | Now internal |
| `InitIdCaptureUiEvent.TryAgainFromWalletError` | Removed |
| `IdCaptureModuleViewModel.IdCaptureStep.UploadGoogleWalletCredential` | Removed |
| `IdCaptureModuleViewModel.IdCaptureStep.UploadGoogleWalletError` | Removed |
| `IdCaptureModuleViewModel.googleWalletRequestJson` | Removed |
| `IdCaptureModuleViewModel.onGoogleWalletCredentialCaptured(String)` | Removed |
| `IdCaptureModuleViewModel.requestGoogleWallet(Activity, String)` | Removed |

All of them were undocumented, and public only by Kotlin's default visibility rather than by design. The SDK has never offered a way to place its screens in your own layout, and it provides no factory or accessor that hands out an `IdCaptureModuleViewModel`, so there was no supported way to reach these members. If you call any of them, remove the call.

To drive the Google Wallet flow yourself, use the non-UI mode described in [Google Wallet ID](/sdk-reference/android-google-wallet-id/). It hands you a `NonUiGoogleWalletController` through `OnboardingListener.onGoogleWalletReady()` and reports every stage on `NonUiGoogleWalletListener`, which replaces all of the above.

**Kotlin:**
```kotlin
// Before 5.54.0: driving the ID capture ViewModel directly.
idCaptureModuleViewModel.googleWalletRequestJson.collect { requestJson ->
    val result = idCaptureModuleViewModel.requestGoogleWallet(activity, requestJson)
    if (result is WalletsWrapper.Result.Success) {
        idCaptureModuleViewModel.onGoogleWalletCredentialCaptured(result.credentialJson)
    }
}

// 5.54.0: the SDK runs the flow and reports each stage.
object : IncodeWelcome.OnboardingListener() {
    override fun onGoogleWalletReady(controller: NonUiGoogleWalletController) {
        controller.start(activity, lifecycleOwner, object : NonUiGoogleWalletListener {
            override fun onLoading() {}
            override fun onUploading() {}

            // Terminal. A rejected upload arrives here with a non-null exception: there is no SDK
            // screen to retry from in this mode, so start another ID module for another attempt.
            override fun onGoogleWalletCompleted(exception: IncodeException?) {}
            override fun onFallback(reason: GoogleWalletFallbackReason) {}
        })
    }
}
```

**Java:**
```java
// Before 5.54.0: driving the ID capture ViewModel directly.
// idCaptureModuleViewModel.getGoogleWalletRequestJson(), requestGoogleWallet(...),
// and onGoogleWalletCredentialCaptured(...) no longer exist.

// 5.54.0: the SDK runs the flow and reports each stage.
new IncodeWelcome.OnboardingListener() {
    @Override
    public void onGoogleWalletReady(NonUiGoogleWalletController controller) {
        controller.start(activity, lifecycleOwner, new NonUiGoogleWalletListener() {
            @Override public void onLoading() {}
            @Override public void onUploading() {}

            // Terminal. A rejected upload arrives here with a non-null exception: there is no SDK
            // screen to retry from in this mode, so start another ID module for another attempt.
            @Override public void onGoogleWalletCompleted(IncodeException exception) {}
            @Override public void onFallback(GoogleWalletFallbackReason reason) {}
        });
    }
};
```

The document chooser behaves as it did in 5.53.0. Cancelling the credential picker returns the user to document selection, and so does Try Again on the upload-error screen, so no code change is needed there. Direct and non-UI invocation cannot offer another document type, so a rejected upload is terminal there: the ID module ends and `OnboardingListener.onError()` reports it. In non-UI mode it also arrives on `onGoogleWalletCompleted` with a non-null exception. Start another ID module if the user should try again.

</Accordion>

## Migration to 5.53.0

<Accordion title="Migration to 5.53.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.

### 1. `IncodeWelcome.Builder.setGoogleWalletEnvironment(...)` and `GoogleWalletEnvironment` have been removed

`setGoogleWalletEnvironment` existed to make Google Wallet requests easier to debug, but its `SANDBOX`/`PRODUCTION` naming did not reflect that purpose, so it has been replaced by `IncodeWelcome.Builder.setGoogleWalletRequestSigned(Boolean)`, which directly controls whether the request declares the signed or unsigned protocol. If you were using `GoogleWalletEnvironment.SANDBOX` to exercise the unsigned protocol for debugging, use `setGoogleWalletRequestSigned(false)` instead.

**Kotlin - before:**
```kotlin
IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletEnvironment(GoogleWalletEnvironment.SANDBOX)
    .build()
```
**Kotlin - after:**
```kotlin
IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletRequestSigned(false)
    .build()
```

**Java - before:**
```java
new IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletEnvironment(GoogleWalletEnvironment.SANDBOX)
    .build();
```
**Java - after:**
```java
new IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletRequestSigned(false)
    .build();
```

### 2. The user-cancel analytics event is now `userCanceled`

The SDK reports the user-cancel event as `userCanceled`. Earlier versions reported it as `userCancelled`. The new spelling agrees with the other SDK events and with the iOS SDK.

The `Event.USER_CANCELLED` constant keeps its name. Only the reported string value changes. If your listener compares the `Event` enum, you need no change.

If you compare the string value, replace `userCancelled` with `userCanceled`:

**Kotlin - before:**
```kotlin
override fun onEvent(event: Event, eventData: HashMap<String, Any>?) {
    if (event.value == "userCancelled") {
        handleUserCancel()
    }
}
```
**Kotlin - after:**
```kotlin
override fun onEvent(event: Event, eventData: HashMap<String, Any>?) {
    if (event.value == "userCanceled") {
        handleUserCancel()
    }
}
```

**Java - before:**
```java
@Override
public void onEvent(Event event, HashMap<String, Object> eventData) {
    if ("userCancelled".equals(event.getValue())) {
        handleUserCancel();
    }
}
```
**Java - after:**
```java
@Override
public void onEvent(Event event, HashMap<String, Object> eventData) {
    if ("userCanceled".equals(event.getValue())) {
        handleUserCancel();
    }
}
```

Also update each dashboard query, saved report, or server-side rule that matches the literal `userCancelled` name.

### 3. Unit tests that load SQLCipher must run on JVM 17 or later

The SDK now uses `net.zetetic:sqlcipher-android:4.17.0`. This version makes the SDK download about 1.3 MB smaller per device, and it removes unused legacy crypto symbols from the bundled native library. It ships Java 17 bytecode.

Your Android application build is not affected. AGP 8 with JDK 17 reads the new bytecode correctly.

Your unit tests are affected if both of these are true:

* The tests run on the JVM. This includes plain JVM unit tests and Robolectric tests.
* The tests load SQLCipher classes. The tests can load them directly, or through the SDK code paths that use the encrypted database.

If those tests run on a JVM older than 17, raise the test toolchain to 17 or later:

```groovy
// build.gradle of the module that runs the tests
java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}
```

Instrumented tests on a device or emulator are not affected.

### 4. Update the Signature V2 title and description string overrides

Signature V2 uses dedicated string resources for the title and description. V1 continues to use the existing string resources.

If you enable V2 and override the V1 strings, add these V2 overrides to your `strings.xml` file:

```xml
<string name="onboard_sdk_signature_capture_title">Your title</string>
<string name="onboard_sdk_signature_capture_description">Your description</string>
```

Keep these V1 overrides if your integration still uses V1:

```xml
<string name="onboard_sdk_signature_title">Your title</string>
<string name="onboard_sdk_signature_description">Your description</string>
```

No change is required if you do not override these strings. The deprecated `Signature.Builder.setTitle(...)` and `setDescription(...)` methods continue to apply to both versions.

### 5. Video Selfie V2 hides the close button on the camera steps

The Video Selfie V2 design hides the close (X) button on the camera steps. `CommonConfig.setShowCloseButton` therefore does not apply to those steps. Video Selfie V1 keeps the button over the camera.

This change applies only when you enable the V2 feature gate.

No code change is required. `setShowCloseButton` continues to apply to the other screens. If your users depend on the close button to leave a camera step, tell them about the new behavior, or keep Video Selfie V1.

</Accordion>

## Migration to 5.51.0

<Accordion title="Migration to 5.51.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.

### 1. Minimum Kotlin version raised to 2.2.x

The SDK is now compiled with Kotlin 2.2.21 (up from 1.9.25), to support the OkHttp/logging-interceptor 5.3.2 upgrade. Any module that compiles Kotlin source with the SDK on its classpath must be able to read the SDK's Kotlin metadata, so your project's Kotlin Gradle plugin must be **2.2.x or newer**. This applies regardless of whether your code calls SDK Kotlin APIs directly - having the SDK on the classpath of a Kotlin compilation is enough to require the newer compiler. Pure-Java modules are unaffected.

No source-level API changes are required on your side - this only affects the minimum Kotlin compiler/plugin version your own build must use.

```groovy
plugins {
    id 'org.jetbrains.kotlin.android' version '2.2.21'
}
```

### 2. Add the required packaging exclusion for OkHttp 5.3.2's duplicate OSGi manifest

OkHttp/logging-interceptor 5.3.2's JPMS module-info jar and the JSpecify jar (a transitive dependency) both ship an identical OSGi manifest at `META-INF/versions/9/OSGI-INF/MANIFEST.MF`. Any app that assembles an APK with OkHttp/logging-interceptor 5.3.2 on its classpath **will** hit a duplicate-resource packaging error from this collision, unless that path is already excluded for another reason. This is a required step for adopting this SDK version, not a fallback for if you happen to see the error - add it to your app's `build.gradle`:

```groovy
android {
    packaging {
        resources {
            excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
        }
    }
}
```

This exclusion only drops the OSGi manifest (unused at runtime) and dedups *any* jar colliding on that path, so it also covers future additions (for example, if BouncyCastle is upgraded later and collides on the same manifest).

### 3. Upgrade compileSdk

With the update of the internal CameraX and Kotlin dependencies, you will need to upgrade your project's `compileSdk` to level 36:

```groovy
compileSdk 36
```

### 4. Update Android Gradle Plugin (AGP)

Bumping `compileSdk` to 36 requires Android Gradle Plugin (AGP) `8.9.1` or higher.
Update your project-level `build.gradle` or `settings.gradle` file to use the new plugin version.

```groovy
classpath "com.android.tools.build:gradle:8.9.1"
```

### 5. Update Gradle Wrapper

AGP `8.9.1` requires Gradle `8.14.5` or higher.
Update your Gradle wrapper configuration in `gradle/wrapper/gradle-wrapper.properties`:

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.5-bin.zip
```

### 6. Migrate to the Kotlin Compose compiler plugin

The SDK now uses the standalone `org.jetbrains.kotlin.plugin.compose` Gradle plugin (introduced with Kotlin 2.x) instead of `composeOptions.kotlinCompilerExtensionVersion`. If your app configures Compose compilation via `composeOptions`, migrate to the new plugin:

**Before:**
```groovy
android {
    buildFeatures { compose = true }
    composeOptions {
        kotlinCompilerExtensionVersion "1.5.15"
    }
}
```

**After:**
```groovy
plugins {
    id 'org.jetbrains.kotlin.plugin.compose' version '2.2.21'
}

android {
    buildFeatures { compose = true }
    // composeOptions block is no longer needed
}
```

### 7. Upgrade kotlinx-coroutines to 1.9.0

CameraX 1.6.1 requires `kotlinx-coroutines` 1.9.0 or higher. Upgrade your coroutines dependency to at least this version:

```groovy
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
```

### 8. Room bumped to 2.8.4

The SDK's internal local storage (Room) is upgraded from 2.6.1 to 2.8.4, to support KSP2 codegen under the Kotlin 2.2.x compiler. Room is used internally only - it is not part of the SDK's public API - so no action is required on your side.

### 9. `deviceStats` removed from `Result` classes that never populated it

The `deviceStats` field has been removed from `BaseResult`. It is now declared only on `IdScanResult` and `SelfieScanResult` - the only results that ever carried it. Every other `*Result` class (e.g. `FaceMatchResult`, `VideoSelfieResult`, `EKYCResult`, `NfcScanResult`) no longer exposes a `deviceStats` field.

If you read `deviceStats` from an `IdScanResult` or `SelfieScanResult`, no change is required. If you read it from any other result type, remove that access - those results always returned the default `DeviceStats(motionStatus = Status.UNCLEAR)` and never carried real device data.

**Kotlin - before:**
```kotlin
val motion = faceMatchResult.deviceStats.motionStatus // always UNCLEAR
```
**Kotlin - after:**
```kotlin
// deviceStats is available only on IdScanResult and SelfieScanResult
val motion = idScanResult.deviceStats.motionStatus
```

**Java - before:**
```java
Status motion = faceMatchResult.deviceStats.getMotionStatus(); // always UNCLEAR
```
**Java - after:**
```java
// deviceStats is available only on IdScanResult and SelfieScanResult
Status motion = idScanResult.deviceStats.getMotionStatus();
```

### 10. `QES` constructor is no longer public - use `QES.Builder`

The `QES` module is now constructed exclusively through `QES.Builder`, matching the other onboarding modules. The direct constructor is no longer accessible, and it also gained new parameters (`uploadDocument`, `providerCode`) in this release, so any previous positional call such as `QES(true)` would have silently changed meaning - the compile error steers you to the unambiguous `QES.Builder` instead.

**Kotlin - before:**
```kotlin
FlowConfig.Builder()
    .addQES(QES(true))
```
**Kotlin - after:**
```kotlin
FlowConfig.Builder()
    .addQES(
        QES.Builder()
            .setDownloadDocument(true)
            .build()
    )
```

**Java - before:**
```java
new FlowConfig.Builder()
    .addQES(new QES(true));
```
**Java - after:**
```java
new FlowConfig.Builder()
    .addQES(
        new QES.Builder()
            .setDownloadDocument(true)
            .build()
    );
```

### 11. `Status` enum gains `UNSUPPORTED` and `COULD_NOT_COMPLETE` values

`Status` gains two new constants, `UNSUPPORTED` and `COULD_NOT_COMPLETE`. `DeviceStats.motionStatus` never emits the new values, so existing runtime behavior for `DeviceStats.motionStatus` is unchanged.

It is source-breaking in Kotlin if you do an exhaustive `when` over `Status` without an `else` branch - such code will now fail to compile until it handles the new constants. A plain Java `switch` statement does not fail to compile when constants are added; it compiles and silently falls through to `default` (or does nothing if there is no `default`), so any Java `switch` over `Status` should add explicit handling for the new values to avoid silently mishandling them.

**Kotlin - before:**
```kotlin
val label = when (status) {
    Status.PASS -> "pass"
    Status.FAIL -> "fail"
    Status.UNCLEAR -> "unclear"
}
```
**Kotlin - after:**
```kotlin
val label = when (status) {
    Status.PASS -> "pass"
    Status.FAIL -> "fail"
    Status.UNCLEAR -> "unclear"
    Status.UNSUPPORTED -> "unsupported"
    Status.COULD_NOT_COMPLETE -> "could not complete"
}
```

**Java - before:**
```java
String label;
switch (status) {
    case PASS: label = "pass"; break;
    case FAIL: label = "fail"; break;
    case UNCLEAR: label = "unclear"; break;
    default: label = "unknown";
}
```
**Java - after:**
```java
String label;
switch (status) {
    case PASS: label = "pass"; break;
    case FAIL: label = "fail"; break;
    case UNCLEAR: label = "unclear"; break;
    case UNSUPPORTED: label = "unsupported"; break;
    case COULD_NOT_COMPLETE: label = "could not complete"; break;
    default: label = "unknown";
}
```

### 10. Minimum Compose Material3 and Compose versions raised to 1.4.0 / 1.8.0

The SDK's Compose-based (V2) screens are now built against **Compose Material3 1.4.0** and **Compose 1.8.0** (foundation / UI). This is not a change to any SDK API - your Kotlin/Java integration code is unaffected - but it raises the minimum versions of these libraries your app must resolve. Because Compose reaches your app transitively and Gradle resolves it with *highest-version-wins*, an app that resolves an older Compose Material3 / Compose set crashes at runtime (`NoSuchMethodError` / `NoClassDefFoundError` in `androidx.compose.*`) when opening a V2 screen such as the phone-number input, a dynamic-form dropdown or date field, or the CURP screen.

Most projects need no action: any app or dependency that pulls Compose Material3 1.4.0 (which itself depends on Compose 1.8.0+) already satisfies this. Act only if you have explicitly pinned these libraries below the required versions - remove the pin or raise it. The two floors are coupled, so aligning Material3 also pulls a compatible Compose set.

</Accordion>

## Migration to 5.50.0

<Accordion title="Migration to 5.50.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.

### 1. Replace `setVideoLivenessRecordingEnabled()` with `setDeepsightConfiguration()`

`SelfieScan.Builder.setVideoLivenessRecordingEnabled()` is deprecated in favor of `setDeepsightConfiguration()`, available on both `SelfieScan.Builder` and `FaceAuthentication.Builder`.

> **Note:** Applies to both `SelfieScan` and `FaceAuthentication`.

| Old | New equivalent |
|-----|----------------|
| `setVideoLivenessRecordingEnabled(false)` | `setDeepsightConfiguration(DeepsightConfiguration.Builder().setModality(DeepsightConfiguration.Modality.SINGLE_FRAME).build())` |
| `setVideoLivenessRecordingEnabled(true)` | `setDeepsightConfiguration(DeepsightConfiguration.Builder().setModality(DeepsightConfiguration.Modality.VIDEO_LIVENESS).build())` |

The new API also exposes the `MULTIMODAL` modality (depth data collected, no video recording) and a `setMotionEnabled()` flag, which previously had no SDK equivalent.

**Before (deprecated):**

```kotlin
SelfieScan.Builder()
    .setVideoLivenessRecordingEnabled(true)
    .build()
```

**After:**

```kotlin
SelfieScan.Builder()
    .setDeepsightConfiguration(
        DeepsightConfiguration.Builder()
            .setModality(DeepsightConfiguration.Modality.VIDEO_LIVENESS)
            .build()
    )
    .build()
```

Java:

```java
new SelfieScan.Builder()
    .setDeepsightConfiguration(
        new DeepsightConfiguration.Builder()
            .setModality(DeepsightConfiguration.Modality.VIDEO_LIVENESS)
            .build()
    )
    .build();
```

</Accordion>

## Migration to 5.49.0

<Accordion title="Migration to 5.49.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.

### 1. Renamed `neutral` and `black` color palette tokens

To align the V2 theme JSON with iOS so a single configuration file works across both platforms, the `neutral` and `black` keys in `IncodeColorPalette` have been renamed:

* `neutral` -> `neutralLight`
* `black`   -> `neutralDark`

If you previously customized these colors via Kotlin:

```kotlin
IncodeWelcome
    .getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setThemeConfig(
                IncodeThemeConfig(
                    colorPalette = IncodeColorPalette(
                        neutral = Color(0xFFFFFFFF),
                        black = Color(0xFF000000)
                    )
                )
            )
            .build()
    )
```

update the parameter names:

```kotlin
IncodeWelcome
    .getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setThemeConfig(
                IncodeThemeConfig(
                    colorPalette = IncodeColorPalette(
                        neutralLight = Color(0xFFFFFFFF),
                        neutralDark = Color(0xFF000000)
                    )
                )
            )
            .build()
    )
```

If you provide the theme via a JSON config, rename the keys inside `colorPalette`:

**Before**
```json
{
    "colorPalette": {
        "neutral": "#FFFFFF",
        "black": "#000000"
    }
}
```

**After**
```json
{
    "colorPalette": {
        "neutralLight": "#FFFFFF",
        "neutralDark": "#000000"
    }
}
```

Theme JSON that still uses the old `neutral` / `black` keys will silently fall back to the defaults (`#FFFFFF` and `#000000`), because unknown keys are ignored during parsing. Update your JSON to use the new keys to keep your customizations applied.

### 2. `SelfieScan.FaceAuthMode.SERVER` deprecated - migrate to `FaceAuthentication`

`SelfieScan.FaceAuthMode.SERVER` is now deprecated. If your integration calls `SelfieScan.Builder().setFaceAuthMode(SelfieScan.FaceAuthMode.SERVER)`, migrate to the [`FaceAuthentication`](/features-and-modules/face-authentication) module instead.

`SelfieScan.FaceAuthMode.LOCAL` (offline face login) and `startFaceLogin()` are not affected and remain fully supported.

### 3. Removed `IncodeWelcome.getReport(...)` and the `ReportListener` interface

The `getReport(interviewId, ReportListener)` method on `IncodeWelcome`, the `ReportListener` callback interface, and the `ResponseEventReport` class have been removed. The backing `/omni/get/report` backend endpoint is deprecated and reports can no longer be generated through the SDK. There is no in-SDK replacement.

If your integration previously invoked `IncodeWelcome.getReport(...)`, remove those calls:

```kotlin
// No longer compiles - remove the call
incodeWelcome.getReport(interviewId, object : ReportListener {
    override fun onReportFetched(uri: Uri?) { /* ... */ }
    override fun onError(error: Throwable) { /* ... */ }
    override fun onUserCancelled() { /* ... */ }
})
```
```java
// No longer compiles - remove the call
incodeWelcome.getReport(interviewId, new ReportListener() {
    @Override public void onReportFetched(Uri uri) { /* ... */ }
    @Override public void onError(Throwable error) { /* ... */ }
    @Override public void onUserCancelled() { /* ... */ }
});
```

### 4. `DocumentScan.Builder` chooser flags deprecated for V2 - migrate to `setDocumentSources(...)`

With the V2 `Document Capture` module enabled, `DocumentScan.Builder.setShowTutorials(...)` and `DocumentScan.Builder.setShowDocumentProviderOptions(...)` no longer affect the flow. The V2 module always opens on an intro screen and configures its source chooser exclusively via the new `setDocumentSources(...)` method. Both flags remain honored in V1.

If you previously used `setShowDocumentProviderOptions(false)` to send the user straight to the camera, configure a single-source set instead:

**Kotlin - before:**
```kotlin
DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setShowDocumentProviderOptions(false)
    .setShowTutorials(false)
    .build()
```
**Kotlin - after:**
```kotlin
DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setDocumentSources(setOf(DocumentScan.DocumentSource.CAMERA))
    .build()
```

**Java - before:**
```java
new DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setShowDocumentProviderOptions(false)
    .setShowTutorials(false)
    .build();
```
**Java - after:**
```java
Set<DocumentScan.DocumentSource> sources = new HashSet<>();
sources.add(DocumentScan.DocumentSource.CAMERA);
new DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setDocumentSources(sources)
    .build();
```

Pass any non-empty subset of `CAMERA`, `FILE_UPLOAD`, and `IMAGE_UPLOAD` to control which submission methods appear on the chooser. For document types that don't accept PDFs (e.g. `DocumentType.MEDICAL_DOC`), `FILE_UPLOAD` is dropped at runtime only when another source remains; configuring exactly `setOf(DocumentScan.DocumentSource.FILE_UPLOAD)` on such a type is rejected with a configuration error before the flow launches, so confirm a camera or image source remains for those document types.

</Accordion>

## Migration to 5.48.0

<Accordion title="Migration to 5.48.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/releases-android-sdk/) for the updated version numbers.

### 1. Changed default values for face capture checks in `SelfieScan` and `VideoSelfie` modules

The defaults for `setHeadCoverCheckEnabled(...)` and `setMaskCheckEnabled(...)` on both `SelfieScan.Builder` and `VideoSelfie.Builder` have been changed from `false` to `true`. If you did not previously configure these flags, head cover and face mask validation will now be enforced by default during face capture.

To preserve the previous behavior, explicitly disable them on the builder(s) you use:

```kotlin
SelfieScan.Builder()
    .setHeadCoverCheckEnabled(false)
    .setMaskCheckEnabled(false)
    .build()

VideoSelfie.Builder()
    .setHeadCoverCheckEnabled(false)
    .setMaskCheckEnabled(false)
    .build()
```
```java
new SelfieScan.Builder()
    .setHeadCoverCheckEnabled(false)
    .setMaskCheckEnabled(false)
    .build();

new VideoSelfie.Builder()
    .setHeadCoverCheckEnabled(false)
    .setMaskCheckEnabled(false)
    .build();
```

### 2. SQLCipher attribution required if you ship an open-source licenses screen

Local Room databases used by the SDK are now encrypted at rest with [SQLCipher for Android](https://github.com/sqlcipher/sqlcipher-android), distributed under a BSD-style license. The license requires consumers that redistribute binaries (i.e. your application) to reproduce its copyright notice "in the documentation and/or other materials provided with the distribution".

If your application includes an "Open Source Licenses" screen, please add the SQLCipher notice listed in [Licenses](/sdk-reference/android-licenses). No code change is needed if you do not ship such a screen.

</Accordion>

## Migration to 5.45.1

<Accordion title="Migration to 5.45.1">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/changelog-special/) for the updated version numbers.

</Accordion>

## Migration to 5.45.0

<Accordion title="Migration to 5.45.0">

> If you are managing dependency versions manually (without the BOM), refer to the Module Versions section in the [release notes](/release-notes/changelog-special/) for the updated version numbers.

### 1. Updates to document chooser behavior in `IdScan` module

The visibility of the document chooser screen is now controlled only by the "Show document chooser screen" flag on the Dashboard or `setShowIdTypeChooser(...)` in the SDK.
    * When using startFlow / startWorkflow, the Dashboard setting is respected.
    * When using startOnboarding / startOnboardingSection, the Dashboard setting is ignored and visibility is controlled exclusively via setShowIdTypeChooser(...).
Setting `idType` alone no longer hides the chooser and will be ignored.

If you previously pre-set `idType` (either using `builder.setIdType(...)` in the SDK or via the Dashboard) and expected the chooser to be hidden, you must now explicitly disable it or update the Flow configuration accordingly:

```kotlin
IdScan.Builder()
    .setIdType(IdScan.IdType.ID)
    .setShowIdTypeChooser(false)
    .build()
```
```java
new IdScan.Builder()
    .setIdType(IdScan.IdType.ID)
    .setShowIdTypeChooser(false)
    .build();
```

### 2. Color palette changes

If you previously customized the application appearance by updating these colors from the color palette:

```kotlin
IncodeWelcome
    .getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setThemeConfig(
                IncodeThemeConfig(
                    colorPalette = IncodeColorPalette(
                        negative500 = Color(0xffff5a5f),
                        negative600 = Color(0xffe71111),
                        positive500 = Color(0xff189f60),
                        positive600 = Color(0xff189f60)
                    )
                )
            )
            .build()
    )
```

or using a config JSON:

```json
{
    "colorPalette": {
        "negative500": "#FF5A5F",
        "negative600": "#E71111",
        "positive500": "#189F60",
        "positive600": "#189F60"
    }
}
```

These keys have now been migrated to the following values:
* `negative500` -> `negative400`
* `negative600` -> `negative500`
* `positive500` -> `positive400`
* `positive600` -> `positive500`

The mentioned colors are used for the following Color Modes:
* `Icon/Status/Negative`
* `Icon/Status/Positive`
* `Surface/Status/Positive`
* `Border/Status/Negative Static`
* `Border/Status/Positive Static`

### 3. `ID Capture` V2 - Error Screen Customization

**Wrong document side customization:**

If you previously customized the `Wrong document side` error screen, add the following new string resources:

**Add these strings:**
```xml
<string name="onboard_sdk_id_capture_error_side_front">Capture the front side of the ID</string>
<string name="onboard_sdk_id_capture_error_side_back">Capture the back side of the ID</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_side">You’ve scanned the wrong document side. Please scan your document again.</string>
```

This string is no longer used.

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_title">There was a problem</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

**Retry button customization:**

The retry button is now customized using a different string resource:

```xml
<string name="onboard_sdk_id_capture_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_no_network_snackbar_action_text">Retry</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

### 4. `Selfie` V2 - Error Screen Customization

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_title">There was a problem</string>
```
The previously used string is still in use for other error screens and should be kept in your resources.

### 5. Changes in behavior for device environment detection

The behavior when detecting device environment vulnerabilities has changed:

* **Hook or virtual environment detection**: Detecting hook or virtual environment vulnerabilities in the SDK triggers a native crash, which cannot be caught or handled by application code, resulting in immediate app termination.
* **Emulator and root detection**: The flow is not aborted when emulator and root checks are detected. The onboarding process continues normally.

### 6. API Changes

#### 6.1 The following `IncodeWelcome.Builder` methods have been removed

```kotlin
IncodeWelcome.Builder.disableVirtualEnvironmentDetection()
IncodeWelcome.Builder.disableRootDetection()
IncodeWelcome.Builder.disableEmulatorDetection()
IncodeWelcome.Builder.disableHookCheck()
```

```java
IncodeWelcome.Builder.disableVirtualEnvironmentDetection()
IncodeWelcome.Builder.disableRootDetection()
IncodeWelcome.Builder.disableEmulatorDetection()
IncodeWelcome.Builder.disableHookCheck()
```

If you were using these methods in your code, remove them from your `IncodeWelcome.Builder` configuration as device environment checks can no longer be disabled.

#### 6.2 The following exceptions have been removed

The following specific exceptions that extended `DeviceEnvironmentException` have been removed:

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.EmulatorDetectedException
com.incode.welcome_sdk.commons.exceptions.IncodeException.RootDetectedException
com.incode.welcome_sdk.commons.exceptions.IncodeException.HookDetectedException
com.incode.welcome_sdk.commons.exceptions.IncodeException.VirtualEnvironmentDetectedException
```

If you were checking for these `Exceptions` in your code, remove any specific handling of them as your app will no longer get this direct feedback.

### 7. Expected crashes when running in a virtual environment

It is expected that the app crashes with the following stacktraces when a virtual environment is used. For example:

```
java.lang.NullPointerException
    at com.incode.welcome_sdk.ThemeConfiguration$Builder.setLabelSmallStyle(SourceFile:1066)
    at com.incode.welcome_sdk.f.c(SourceFile:150)
    at com.incode.welcome_sdk.data.local.m.as(SourceFile:22)
    at com.incode.welcome_sdk.IncodeWelcome.startOnboardingSection(SourceFile:18)
```

```
java.lang.NullPointerException: Attempt to get length of null array
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.d(SourceFile:320)
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.i(SourceFile:214)
```

### 8. `Selfie` V2 - No Internet Error Screen Retry Button Change

**Retry button customization:**

The retry button label shown on the Selfie Scan no internet error screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_face_scan_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_try_again">Try again</string>
```

If you override `onboard_sdk_try_again` to customize the retry button on the no internet screen, you must now override `onboard_sdk_face_scan_retry` instead. 
The `onboard_sdk_try_again` string is still used for other retry scenarios.

### 9. `Selfie` V2 - Capture-Only Mode Success Screen Text Change

**Success label customization:**

In capture-only mode, the Selfie Scan success screen now uses a different string resource:

```xml
<string name="onboard_sdk_face_captured">Face captured!</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_enroll_success">Success!</string>
```

The previously used string is still in use for non-capture-only mode and should be kept in your resources.

### 10. `ID Capture` and `Selfie` V2 - Permission Open Settings Screen Text Change

**Open settings button customization:**

The Open settings label shown on the Permission open settings screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_permission_allow_permission_action">Allow permission</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_permission_open_setting_action">Open settings</string>
```

The previously used string is still in use for the `Geolocation` module and should be kept in your resources.

</Accordion>

## Migration to 5.44.0

<Accordion title="Migration to 5.44.0">

### 1. Upgrade dependencies

#### Consider migrating to the Incode BOM

To help facilitate easier version upgrades, 5.44.0 introduces the Incode Bill of Materials (BOM). This can be used to upgrade all relevant Incode library dependencies from one place instead of multiple steps to upgrade library dependency versions. To get started,

Replace:

```groovy
implementation 'com.incode.sdk:welcome:5.43.0'
implementation 'com.incode.sdk:core-light:3.0.7'
```
```kotlin
implementation("com.incode.sdk:welcome:5.43.0")
implementation("com.incode.sdk:core-light:3.0.7")
```

With:

```groovy
implementation platform('com.incode.sdk:bom:5.44.0')
implementation 'com.incode.sdk:welcome'
implementation 'com.incode.sdk:core-light'
// Plus any other Incode SDK dependencies... (without the version numbers)
```
```kotlin
implementation(platform("com.incode.sdk:bom:5.44.0"))
implementation("com.incode.sdk:welcome")
implementation("com.incode.sdk:core-light")
// Plus any other Incode SDK dependencies... (without the version numbers)
```

See the [Incode Bill of Materials (BOM) section of the Setup Guide](/sdk-reference/android-installation#add-the-incode-bill-of-materials-bom) for more info.

#### or, Upgrade dependencies manually

If you prefer to continue updating all dependencies manually, be sure to update `welcome` as usual:

```groovy
implementation 'com.incode.sdk:welcome:5.44.0'
```
```kotlin
implementation("com.incode.sdk:welcome:5.44.0")
```

and update the `core-light` dependency to the latest version:

```groovy
implementation 'com.incode.sdk:core-light:3.0.8'
```
```kotlin
implementation("com.incode.sdk:core-light:3.0.8")
```


### 2. Upload Digital ID V2

**Upload error screen customization:**

If you previously customized the upload error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_validation_error_button_text">Scan your ID</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_tutorial_title">Scan your ID</string>
```

This string is now used only for customizing the ID Capture V2 tutorial screen title.

### 3. DocumentType has moved

The `DocumentType` class has been moved from the `com.incode.welcome_sdk.ui.camera.id_validation.base` package
to `com.incode.welcome_sdk.data`.

Replace the following `import` statement

```kotlin
com.incode.welcome_sdk.ui.camera.id_validation.base.DocumentType
```

with

```kotlin
com.incode.welcome_sdk.data.DocumentType
```

### 4. Package name change: `selfie_scan` renamed to `selfie_capture`

The package name `selfie_scan` has been renamed to `selfie_capture`.

Update all imports from `com.incode.welcome_sdk.ui.selfie_scan.*` to `com.incode.welcome_sdk.ui.selfie_capture.*` throughout your codebase.

This change was required due to DexGuard constraints around package naming and obfuscation.

### 5. Transition/Loading screen removed

The transition/loading screen that was shown between modules has been completely removed. If your integration had any customization for this screen (e.g., overriding `onboard_sdk_activity_transition.xml`, setting `IncodeTransitionScreenState.isEnabled`, or customizing transition string resources), those customizations can be safely deleted.

### 6. Migrate any custom `ThemeConfiguration` to the V2 equivalent

If your previous integration had any UI customization in supported modules through [Theme Configuration](/sdk-reference/android-customization#configure-v2-theme-and-ux), these customizations will now need to be migrated to the equivalents in UXv2. See the [Migrating Theme Configurations to UXv2 Guide](/sdk-reference/android-customization#configure-v2-theme-and-ux) for more details.

### 7. Changed default values in `FaceMatch` module config (optional)

With the move to UxV2, the `showUserExists` config is now `false` by default.
To preserve the old behavior, you can use:

```kotlin
FaceMatch.Builder()
  .setShowUserExists(true)
  .build()
```
```java
new FaceMatch.Builder()
  .setShowUserExists(true)
  .build();
```

</Accordion>

## Migration to 5.43.0

<Accordion title="Migration to 5.43.0">

### 1. Update core-light dependency to the latest version

```groovy
implementation 'com.incode.sdk:core-light:3.0.7'
```
```kotlin
implementation("com.incode.sdk:core-light:3.0.7")
```

### 2. If you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:nfc:1.5.2'
```
```kotlin
implementation("com.incode.sdk:nfc:1.5.2")
```

### 3. Update string resources for the "Need Help" screen in the `IdScan` v2 module

The "Need Help" screen has been redesigned, and the customizable strings have been replaced.
If you override any of the following strings in your app, replace them with the new ones listed below.

No action is required if you do not override these strings.

#### Replaced string resources

Replace overrides of:

```xml
<string name="onboard_sdk_id_capture_help_title">Need help?</string>
<string name="onboard_sdk_id_capture_help_subtitle">Some considerations</string>
<string name="onboard_sdk_id_capture_help_manual_photo_button_text">Take the photo manually</string>
<string name="onboard_sdk_id_capture_help_align_title">Center your document in the frame</string>
<string name="onboard_sdk_id_capture_help_align_subtitle">The photo will be taken automatically</string>
<string name="onboard_sdk_id_capture_help_blur_title">Avoid blurriness on the document</string>
<string name="onboard_sdk_id_capture_help_blur_subtitle">Zoom in and out, or tap on the document</string>
<string name="onboard_sdk_id_capture_help_glare_title">Avoid glare on the document</string>
<string name="onboard_sdk_id_capture_help_glare_subtitle">Find a better lighting to avoid reflections</string>
<string name="onboard_sdk_id_capture_help_darkness_title">Avoid darkness on the document</string>
<string name="onboard_sdk_id_capture_help_darkness_subtitle">Find a place with better lighting</string>
```

with:

```xml
<string name="onboard_sdk_id_capture_common_issues_title">Common issues</string>
<string name="onboard_sdk_id_capture_common_issues_glare_title">Glare present</string>
<string name="onboard_sdk_id_capture_common_issues_glare_subtitle">Tilt the ID slightly up or down to minimize the reflection</string>
<string name="onboard_sdk_id_capture_common_issues_blur_title">Blur present</string>
<string name="onboard_sdk_id_capture_common_issues_blur_subtitle">Move ID further away or closer to your phone until the image is focused</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_title">Info is not readable</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_subtitle">Minimize camera shake by holding your phone steady</string>
<string name="onboard_sdk_id_capture_common_issues_try_again_button">@string/onboard_sdk_try_again</string>
```

### 4. API Changes

`FaceAuthenticationResult.error` type changed from `FaceAuthenticationException?` to `Throwable?` to support non-domain failures.
Consumers should no longer assume the error is a `FaceAuthenticationException`.

</Accordion>

## Migration to 5.42.0

<Accordion title="Migration to 5.42.0">

### 1. Upgrade compileSdk

With the update of the internal CameraX dependencies, you will need to upgrade your project's `compileSdk` to level 35:

```groovy
compileSdk 35
```

### 2. Update Android Gradle Plugin (AGP)

Bumping `compileSdk` to 35 requires Android Gradle Plugin (AGP) `8.6.0` or higher.
Update your project-level `build.gradle` or `settings.gradle` file to use the new plugin version.

```groovy
classpath "com.android.tools.build:gradle:8.6.0"
```

### 3. Update Gradle Wrapper

AGP `8.6.0` requires Gradle `8.7` or higher.
Update your Gradle wrapper configuration in `gradle/wrapper/gradle-wrapper.properties`:

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
```

### 4. Update core-light dependency to the latest version

```groovy
implementation 'com.incode.sdk:core-light:3.0.6'
```

### 5. If you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:nfc:1.5.1'
```

### 6. API changes

#### 6.1 DeviceEnvironmentException is moved and extended

The `DeviceEnvironmentException` class has been moved from the `com.incode.welcome_sdk.commons.exceptions` package
to `com.incode.welcome_sdk.commons.exceptions.IncodeException`.

Replace the following `import` statement

```kotlin
com.incode.welcome_sdk.commons.exceptions.DeviceEnvironmentException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.DeviceEnvironmentException
```

If you were catching `DeviceEnvironmentExceptions`, you can now also catch more specific exceptions that extend it:

* `EmulatorDetectedException`
* `RootDetectedException`
* `HookDetectedException`
* `VirtualEnvironmentDetectedException`

#### 6.2 PermissionsDeniedException has been replaced

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.video_selfie.PermissionsDeniedException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.PermissionNotGranted
```

#### 6.3 PermissionDeniedException has been replaced

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.PermissionDeniedException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.PermissionNotGranted
```

#### 6.4 CameraPermissionDeniedException has been replaced

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.video_selfie.CameraPermissionDeniedException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.PermissionNotGranted.CameraPermissionNotGranted
```

#### 6.5 MicrophonePermissionDeniedException has been replaced

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.video_selfie.MicrophonePermissionDeniedException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.PermissionNotGranted.RecordAudioPermissionNotGranted
```

#### 6.6 ScreenRecordingPermissionDeniedException has been replaced

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.video_selfie.ScreenRecordingPermissionDeniedException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.PermissionNotGranted.ScreenCapturePermissionNotGranted
```

#### 6.7 UnknownException has been renamed

Replace instances of

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.UnknownException
```

with

```kotlin
com.incode.welcome_sdk.commons.exceptions.IncodeException.GenericException
```

#### 6.8 The following unused exceptions have been removed

```kotlin
com.incode.welcome_sdk.commons.exceptions.ApprovalForbiddenException
com.incode.welcome_sdk.commons.exceptions.ExistingSessionException
```

</Accordion>

---

- Path: `release-notes/migration-guide-1`
- URL: https://developer.incode.com/release-notes/migration-guide-1/
- Markdown: https://developer.incode.com/release-notes/migration-guide-1.md

# Migration Guide

## Migration from 1.X.X to 2.0.0

* Update Android `minSdkVersion` to 23 (`<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">23.0</SupportedOSPlatformVersion>`).
* Replace `OnboardingConfiguration` with the appropriate `OnboardingSessionConfiguration` and/or `OnboardingFlowConfiguration`.
* When calling `AddIdScan` on `OnboardingFlowConfiguration` instead of just one callback `IdScanCallback`, there are now 3 separate callbacks with appropriate results: `IdFrontScanCallback` returning `IdFrontScanResult`, `IdBackScanCallback` returning `IdBackScanResult` and `IdProcessCallback` returning `IdProcessResult`.
* When calling `AddFaceMatch` on `OnboardingFlowConfiguration`, remove the `faceMatchParams` parameter.
* When calling `StartOnboarding`, replace the `OnboardingConfiguration` parameter with 2 parameters `sessionConfig` and `flowConfig`, which are instances of `OnboardingSessionConfiguration` and `OnboardingFlowConfiguration`.
* `SetOnboardingSession` and `CreateNewOnboardingSession` methods are replaced with the `SetupOnboardingSession` method that accepts instances of `OnboardingSessionConfiguration`.
* Remove `interviewId` parameter from `StartOnboardingSection` and pass an instance of `OnboardingFlowConfiguration`.
* From `VerifyFace`, remove `customerToken` parameter, and the result is now `VerifyFaceResult` type instead of `SelfieScanResult`.

---

- Path: `release-notes/platform-release-notes-2026`
- URL: https://developer.incode.com/release-notes/platform-release-notes-2026/
- Markdown: https://developer.incode.com/release-notes/platform-release-notes-2026.md

# Platform Release Notes 2026

This page provides release details for the Incode Platform. This includes updates to Dashboard, the end user Web app experience, backend Server updates, changes to ML models, and new or updated ID Templates. 
Some notes have a tag added to the beginning. These tags indicate that the note requires special attention:

<Pill type="update" />: The change was added for the SaaS release after the initial Demo deployment.

<Pill type="beta" />: The feature, update, or fix applies only to Beta Dashboard. Switch to Beta anytime from within Dashboard.

<Pill type="hotfix" />: The change was deployed outside the typical Demo/SaaS deployment timeline to address a high-priority need.

<Pill type="breaking" />: The feature, update, or fix possibly breaks existing integrations and should be addressed immediately to avoid broken configurations.

## 2026 November 2
_Demo: 26 October 2026 | Production: 2 November 2026_

## Dashboard

### Enhancements

ANALYTICS

- The [new Analytics view](/dashboard-platform-administration/view-analytics/) is now the default view in [Standard Dashboard](/dashboard-platform-administration/choosing-between-standard-and-beta) for all customers. It was previously only available in Beta. You can switch to the classic view any time.
- The *Fraud caught by type* widget has moved from the Overview page to the Fraud dashboard, where it replaces the *Check detection rate* widget. The *Check detection rate* widget is no longer available. The *Conversion funnel* widget has moved from the Overview page to only be on the Conversion page.

ECOSYSTEM

- <Pill type="breaking" /> Self Serve integrations in Ecosystem now use a separate self-serve portal app. In the integration configuration, the portal hostname appears next to an editable URL slug, with a live preview of the link and a copy button. The link includes the integration's client ID. The previous embedded self-serve screens in the Dashboard have been removed, so old Dashboard reset links no longer open them. If you rely on previously-saved links, you will need to update them.

MODULES

- <Pill type="update" /> The Cross Check module has a new name matching option called Smart, available when the left side of the cross check is a full name field such as Full Name, FSL Name, or POA Name. Smart recognizes real-world name variations, such as nicknames and short forms (Bob and Robert), names that sound alike (Smyth and Smith), and a missing or shortened middle name. The string-based name options are now grouped under Fuzzy, which shows a new Match Strictness setting with the options Ultra low, Low, Medium, and High. Each option now has a tooltip that explains how it matches names.



SINGLE SESSION VIEW

- The Unusual Activity section of the single Session view now handles Date of Birth mismatches with two new labels: *Date of Birth mismatch: This face appears with different date of birth across attempts* and *Date of Birth mismatch: This document photo appears with different date of birth across attempts*. This change provides more clarity into what triggered the flag. Previously, these checks were shown under the Document Number reason.

TRUSTGRAPH

- <Pill type="update" /> You can now create more granular Flow rules and Workflow conditions for TrustGraph results. A new **TrustGraph** category offers these options: 
   - TrustGraph (overall)
   - TrustGraph unusual activity
   - TrustGraph velocity
   - TrustGraph suspected repeat fraud
   - TrustGraph first party fraud

   Each of the four specific options lets you build a rule on the individual reasons reported for that category, such as `SELFIES_MATCHED_DOCUMENTS_DIFFERENT` for TrustGraph unusual activity. TrustGraph keeps the previous risk level options, and your existing TrustGraph rules were moved to it, so they keep working as before.



WORKFLOWS

- There is a new condition for the ID Validation process in Workflows called *Document expiration detected*. It runs even when *Disable expiration date check* is on, so you can turn off the check and still route expired IDs to recapture, rejection, or manual review. For related changes to how Workflows handle expired IDs, see the Server section of these notes.
- Workflows 3.0 is now the default Workflow builder in Standard Dashboard for all customers. It was previously only available in Beta. Opening an existing Workflow or creating a new one now opens the new version, and you can switch to the classic version at any time.

<Pill type="beta" /> SESSION DETAILS

- A new *Camera recording quality* section in single Session view now shows the recording quality checks for a session.
- The *Submission method* field in single Session view now appears in the extracted data table of the document section.
- You can now edit OCR data from the single Session view. The OCR card on the Overview takes you to the OCR Detailed section, where you can click **Edit Fields**. The **Save** button becomes available after making changes
- <Pill type="update" /> A new verification question card now appears at the top of session details Overview when the Flow or Workflow includes cross-checks. The card asks *Did the cross-checks pass?* and shows one of four results: *Pass*, *Fail*, *Not run*, or *Inconclusive*. For example, a cross-check with no match gives Fail, and cross-checks that only have missing fields give Inconclusive. Sessions without cross-checks do not show the card.
- <Pill type="update" /> Sessions with US and Mexico IDs now show two new ID quality checks, *Per Field Readability Front* and *Per Field Readability Back*, that show whether the text fields on each side of the ID could be read clearly. These checks are for information only and do not change the session score or decision. Both scores are also included in the CSV export.

### Fixes

ECOSYSTEM

- <Pill type="update" /> Fixed an issue in Ecosystem where the verification link was sometimes not copied and an error appeared after you selected **Generate Verification & Copy Link** on the Helpdesk Verification page. The link now copies as expected.





GENERAL

- Fixed an issue where a new child organization did not inherit its parent organization's settings. A new child organization now starts with the same configuration as its parent. Previously, these settings had to be enabled manually for each new child organization.
- Fixed an issue in Incode ID organizations where the Dashboard showed a wrong message after you tried to delete an identity. The Dashboard now shows that identity deletion is not allowed.
- Fixed an issue where Dashboard rejected some valid URLs, such as a webhook URL ending in `==`, and showed a validation error. These URLs are now accepted in URL fields such as webhooks, organization settings, and Flow and Workflow redirect URLs. URLs that are not valid, such as ftp links or URLs with spaces, are still rejected.

TRUSTGRAPH

- Fixed an issue in Workflows where reopening a saved TrustGraph Suspected Fraud Condition changed the field and attribute you had selected. The Condition now keeps your selection.
- Fixed an issue in Flows where editing a saved TrustGraph category rule showed empty module and operator fields. The rule now shows its module, attribute, operator, and value.
- Fixed an issue in Flows where the value field for new TrustGraph category rules had no list of values. It now offers OK and AT_RISK.
- Fixed an issue in Fraud Ring Explorer where clicking the *First seen* or *Last active* column header again did not switch the list to ascending order.
- Fixed an issue where the Fraud Ring Explorer tour stayed on screen after you used the browser Back button, and appeared on other pages such as Sessions. The tour now closes when you go back.
- Fixed two issues in the Fraud Ring Explorer *Activity over time* chart on a ring's details. The chart no longer shows overlapping date values when you select the *Last 7 days* filter, and the chart title now reads *Activity over time*.
- Fixed an issue where Admin users did not see the *Remove* button on the TrustGraph tab in single Session view, so they could not remove the session from future TrustGraph checks. The button now appears.
- Fixed an issue on the TrustGraph tab of single Session view where a match for *Suspected repeat fraudster* showed the reason as *Short*. The reason now shows the real reported reason.
- <Pill type="update" /> Fixed an issue in single Session view where the *Applied rule* expression showed shortened or corrupted attribute names for TrustGraph category rules. The expression now shows the full attribute names from the rule.
- <Pill type="update" /> Fixed an issue on the TrustGraph tab of single Session view where the *Local* and *Global* columns did not line up between categories, because only some category tables had a *Configuration* column. The columns now have the same width and position in every category.

WORKFLOWS

- Fixed an issue where the Condition panel in view mode showed the wrong next step for each branch of the Condition, whether it is met or not. It now matches the Workflow diagram and edit mode.
- Fixed an issue where module configuration panels in Workflows showed Flow settings and defaults that do not apply to Workflows. The panels now match the classic Workflow builder.

<Pill type="beta" /> SESSION DETAILS

- The **Add further coverage to this flow** section of single Session view now lists Deepsight, GovMatch, TrustGraph, and Risk AI Agent as options.
- Fixed an issue where the yellow match banner did not appear when a session failed the *ID Already Used Check*. The banner now appears, so you can see which session it matched.
- Fixed an issue where long rule text in the *Conditions (Business rules)* modal did not wrap. The text now wraps and each condition shows on its own line.
- Fixed an issue where the Frontend and Backend labels in the event details of the event log were written as two words. They now appear as one word each.

## Web app

### Fixes

- Fixed an issue in Onboarding where incorrect geolocation permission instructions could leave end users stuck in a loop on Android devices after denying the location prompt. The instructions now match how each browser behaves on Android and iOS.
- Fixed an issue in Workforce verification where users with a # character in their username saw a blank screen after selecting Verify and could not sign in. These users can now complete sign-in.
- <Pill type="update" /> Fixed an issue in onboarding where the instruction text on the document capture screen overlapped when the display was zoomed to 200%. The text now displays correctly on both small and large screens.
- <Pill type="update" /> Fixed an issue in onboarding where, after a failed manual Face Capture, the screen showed an empty silhouette with no camera preview and did not respond for a few seconds after the end user selected *Try again*. The screen no longer appears frozen.
- <Pill type="update" /> Fixed an issue in Workflows where an end user who exceeded the maximum number of Video Selfie attempts could restart the session. The session now ends after the maximum number of attempts, the same way it does in Flows.
- <Pill type="update" /> Fixed an issue in OIDC integrations with Verify where end users were not redirected back to the application that started the login after a failed verification. End users are now redirected.

## Server

### Enhancements

- <Pill type="breaking" /> JSON Web Tokens (JWT) issued by the API, including session and admin tokens, are now longer than before as part of a security improvement to how tokens are signed. Incode has supported tokens of up to 2048 characters since February 2025, but until now tokens were often much shorter. Tokens can now reach that full length. Check that any place where your systems store or pass tokens, such as a database column, cookie, or header, can hold at least 2048 characters. A token that is cut off will not be accepted. Tokens issued before the change remain valid, and token expiry is not affected.
- <Pill type="update" /> API rate limits now refill at regular intervals instead of continuously. Your limit per second does not change, but you can now send short bursts of requests as long as you stay within your limit for each interval. If you reach the limit, requests return a 429 error until the next refill. Wait until the time in the Retry-After header of the 429 response before you try again.
- <Pill type="update" /> For Argentina, the CUIL (Tax ID) is now returned as a dedicated `cuil` field in the OCR data. Previously, the CUIL was only available in the government validation response.
- <Pill type="breaking" /> In Workflows, an expired ID no longer stops the end user in Onboarding. The end user continues, and the `add/front-id`, `add/back-id`, and `process/ID` endpoints return `isDocumentExpired` as null. The result still appears in the session score as the *Document expired* check, and you decide what happens next with Conditions. If your Workflows relied on expired IDs being rejected automatically, add a Condition on *Document expired* to ask for another capture or reject the session. Flows are not affected.
- The B2B API now requires a directory match only for Candidate and Helpdesk integrations.
  - For all other integration types, requests succeed even when the login hint is not in the employee directory. The login hint is still required.
  - When there is no match, the display name comes from the name in the request. If no name is sent, the session has no display name.
  - For Candidate and Helpdesk, an unmatched login hint now returns *Login hint not found in directory* instead of *Invalid login hint*.
  - Requests with an unsupported integration type now return a clear error instead of a server error.
- NFC verification now supports more countries. The certificates used to check NFC chip data have been refreshed, so documents from countries that were not covered before, or whose certificates changed since 2023, can now be verified.
- <Pill type="update" /> In [GovMatch](/features-and-modules/government-record-verification/), Mexico RFC validation now returns a new field, `rfcMessageCode`, that gives the specific reason a check failed. Previously, several different causes returned the same generic failure, and an outage at the data source looked the same as an invalid RFC. The field is returned by `/omni/add/rfc-by-curp`, `/api/validate/rfc-by-curp/v2`, and `/omni/validate/rfc`.
    - RFC checks can now tell apart a cancelled RFC, an RFC that is not found, an invalid RFC format, and a data source that is unavailable.
    - When the RFC is calculated from a CURP, a failed CURP lookup returns its own code: `CURP_PROVIDER_UNAVAILABLE` (the CURP could not be checked, so retrying may work), `CURP_NOT_FOUND`, `CURP_INVALID`, or `CURP_DATA_INSUFFICIENT`.
    - Existing fields (`rfcStatus`, `rfcValidationMessage`, `rfcErrorMessage`, and `validRFC`) are unchanged.
- <Pill type="update" /> Improved document classification for Peru Identification Cards. More documents are now matched to the correct version of the card.
- <Pill type="update" /> Improved document classification for Philippines identification documents, including Medical Cards shown on a phone screen. More of these documents are now recognized, so their fields can be extracted.
- <Pill type="update" /> License classes are now extracted more accurately for some driver's licenses from France, Portugal, the Netherlands, and Norway. Text printed on the card that is not a license class, such as words from field labels, is no longer returned as a class. Only license classes recognized for the issuing country are returned.
- <Pill type="update" /> Three ID templates now return additional fields:
    - Peru Identification Card (2013 version): State, City, and District are now extracted from the Departamento, Provincia, and Distrito section on the back of the ID. They are returned in the `state`, `city`, and `district` fields.
    - Israel Identification Card (2013 version): Citizen status is now extracted from the back of the ID and returned in the `mentions` field.
    - Fiji Tax Identification Card (2023 version): Issue Date is now extracted from the front of the card.
- <Pill type="update" /> The two Philippines Medical Card templates (2013 and 2010 versions) have been merged into one. Documents that were previously recognized as the 2013 version are now recognized as the 2010 version. The fields extracted and the rest of the response do not change.

### Fixes

- Fixed an issue where the Phone module could not send a one-time passcode (OTP) by SMS for organizations that use limited access tokens.
- <Pill type="update" /> Fixed an issue where a session could not be completed, and the `/omni/finish-status` endpoint returned a server error, when a Cross Check compared a field that had no value: for example, when CURP Validation failed. The Cross Check now shows a warning for the missing value and the session completes.
- <Pill type="update" /> Binary INE back QR payload returned raw in qrBackContents on /omni/get/ocr-data - Fixed an issue where the encrypted QR code on the back of some Mexican INE IDs was returned as raw binary data in `qrBackContents` on `/omni/get/ocr-data`, which could cause failures for integrations that convert the response to XML or validate string content. Encrypted QR codes that have no readable content are no longer returned in `qrContents` and `qrBackContents`. The public INE URL from the QR code is still returned.
- <Pill type="update" /> Fixed an issue where Business Rules on a second ID did not run for barcode content and DD/Reference Number cross checks. These rules now run the same way they do for the first ID. This also fixes other conditions in the same rule that were blocked, such as detecting a barcode on the second ID. Existing saved rules work without changes.
- <Pill type="update" /> <Pill type="hotfix" /> Fixed an issue where TrustGraph could raise false alerts on Web sessions because of unreliable device identifiers. TrustGraph now uses a Web device identifier only when it comes from Incode's supported device fingerprinting source. The rest of the session data is still used.
- <Pill type="update" /> Fixed an issue where some Argentina Identification Cards failed the Document Classification check, so the *Full name (OCR)* field was not extracted. These documents are now classified correctly.
- <Pill type="update" /> Fixed an issue where some Mexico driver's licenses from Chihuahua failed the Document Classification check, so no data was extracted. These documents are now classified correctly.
- <Pill type="update" /> Fixed an issue in GovMatch where Wisconsin record verification in the Government Record Verification module failed with a missing document ID error when a session had no ID capture and the lookup key was sent as `imageId`. GovMatch now accepts either `imageId` or `imageNumber` as the custom parameter that identifies the record.
- <Pill type="update" /> Fixed an issue where the `/omni/update/videoselfie/config` endpoint could return a server error and not save the Video Selfie configuration when one request updated several settings, such as `transcriptSimilarityThreshold` and `disableFallbacks`. The full configuration now saves in a single request.

## ML

- <Pill type="update" /> The age estimation model has been updated to version 2.3, which improves the accuracy of age estimates. Estimates can differ from those returned by the previous version, so if your rules use an age threshold, review it after the update. The age `version` returned by `/omni/add/face` is now `2.3`.

## ID Templates

### New supported templates

#### NEW CLASSIFICATION SUPPORT

- Belize
  - TravelDocument / CONSULAR_CARD / 2026
- Bhutan
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Cyprus
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Democratic Republic of the Congo
  - TravelDocument / CONSULAR_IDENTITY_CARD / 2019
  - TravelDocument / CONSULAR_IDENTITY_CARD / 2026
- El Salvador
  - IdentificationCard / IDENTIFICATION_CARD / 2009
  - IdentificationCard / IDENTIFICATION_CARD / 2010
  - IdentificationCard / IDENTIFICATION_CARD / 2011
- Equatorial Guinea
  - IdentificationCard / IDENTIFICATION_CARD / 2019
- Gambia
  - DriversLicense / DRIVERS_LICENSE / 2017
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Guinea
  - TravelDocument / CONSULAR_CARD / 2025
- Laos
  - DriversLicense / DRIVERS_LICENSE / 2017
- Liberia
  - DriversLicense / DRIVERS_LICENSE / 2026
  - ResidenceDocument / RESIDENCE_PERMIT / 2026
- Mongolia
  - ResidenceDocument / RESIDENCE_PERMIT / 2026
- Nigeria
  - TravelDocument / CONSULAR_CARD / 2016
- São Tomé and Príncipe
  - IdentificationCard / IDENTIFICATION_CARD / 2015
- Solomon Islands
  - DriversLicense / DRIVERS_LICENSE / 2024
- Turkey
  - IdentificationCard / DISABILITY_IDENTIFICATION_CARD / 2026
- United States of America
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1811
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1812
  - California
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- Vanuatu
  - DriversLicense / DRIVERS_LICENSE / 2015

#### NEW ID SUPPORT

- Djibouti
  - IdentificationCard / IDENTIFICATION_CARD / 2025
- Dominica
  - DriversLicense / DRIVERS_LICENSE / 2007
- East Timor
  - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2025
- Greece
  - Visa / VISA / 2023
- Hungary
  - Visa / VISA / 2023
- Ivory Coast
  - Visa / VISA / 2022
- Jamaica
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Kyrgyzstan
  - DriversLicense / DRIVERS_LICENSE / 2026
- Liechtenstein
  - IdentificationCard / IDENTIFICATION_CARD / 2024
- Luxembourg
  - Passport / NATIONAL_PASSPORT / 2026
- Malaysia
  - Passport / NATIONAL_PASSPORT / 2026
- Marshall Islands
  - Passport / NATIONAL_PASSPORT / 2024
- Mexico
  - Nayarit
    - DriversLicense / DRIVERS_LICENSE / 2026
  - Veracruz
    - DriversLicense / DRIVERS_LICENSE / 2024
- Nepal
  - Passport / NATIONAL_PASSPORT / 2026
- Norway
  - Visa / VISA / 2024
- Poland
  - Visa / VISA / 2020
- Romania
  - Visa / VISA / 2025
- Serbia
  - Passport / NATIONAL_PASSPORT / 2026
- Somalia
  - Somaliland
    - Passport / NATIONAL_PASSPORT / 2018
- South Korea
  - Visa / VISA / 2020
- Togo
  - Visa / VISA / 2023
- United Kingdom
  - OTHER / DIGITAL_RIGHT_TO_WORK_PDF / 2026
- United States of America
  - Florida
    - DriversLicense / TEMPORARY_DRIVERS_LICENSE_UNDER21 / 2017
  - South Dakota
    - DriversLicense / DRIVER_LICENSE_UNDER21 / 2026
  - US Department of State
    - TravelDocument / CONSULAR_CARD / 2019

### Changes to current templates

#### FEATURE UPDATE

- United States of America
  - Hawaii
    - DriversLicense / PROVISIONAL_DRIVERS_LICENSE_UNDER21 / 2026 r1
  - West Virginia
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2023 r1

#### ID CLASSIFICATION IMPROVEMENT

- El Salvador
  - IdentificationCard / IDENTIFICATION_CARD / 2000 r6
- Israel
  - IdentificationCard / IDENTIFICATION_CARD / 2013 r2
- United States of America
  - Florida
    - DriversLicense / DRIVER_LICENSE_UNDER21 / 2017 r3
  - South Dakota
    - DriversLicense / DRIVERS_LICENSE / 2026

#### ID OCR EXTRACTION IMPROVEMENT

- Australia
  - Capital Territory
    - DriversLicense / DRIVERS_LICENSE / 2015 r5
    - DriversLicense / HEAVY_VEHICLE_DRIVERS_LICENSE / 2015 r3
- Brazil
  - Passport / NATIONAL_PASSPORT / 2023 r2
  - ResidenceDocument / RESIDENCE_PERMIT / 2019 r4
- Costa Rica
  - Permit / WORK_PERMIT / 2024 r1
- Democratic Republic of the Congo
  - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2022 r1
- Fiji
  - TaxIdentification / TAX_IDENTIFICATION_CARD / 2023 r1
- Hungary
  - DriversLicense / DRIVERS_LICENSE / 2013 r2
- Iraq
  - IdentificationCard / IDENTIFICATION_CARD / 2010 r1
- Ivory Coast
  - IdentificationCard / IDENTIFICATION_CARD / 2020 r4
- Mexico
  - Jalisco
    - DriversLicense / DRIVER_LICENSE / 2019 r3
- Peru
  - IdentificationCard / IDENTIFICATION_CARD / 2013 r2
- United States of America
  - Mississippi
    - DriversLicense / DRIVER_LICENSE_UNDER21 / 2024 r4
  - Nebraska
    - DriversLicense / IGNITION_INTERLOCK_PERMIT / 2026
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2026 r2
- Vietnam
  - IdentificationCard / IDENTIFICATION_CARD / 1999 r3
  - IdentificationCard / IDENTIFICATION_CARD / 2000 r2

***

## 2026 October 19

<Accordion title="2026 October 19">

_Demo: 12 October 2026 | Production: 19 October 2026_

## Release Highlights

<Pill type="update" /> **TrustGraph is now available** 

TrustGraph is Incode's privacy-preserving trust network that helps you detect repeat fraud. It checks whether identity data from a session has shown up before, in your own history or across the network, and returns real-time signals during the session. 

Add the TrustGraph module to a Flow or Workflow, review results in single Session view, and investigate connected sessions in Fraud Ring Explorer. To learn more, see the [TrustGraph overview](/features-and-modules/trust-graph-overview/). 

Contact your Incode representative if you are interested in this feature.

## Dashboard

### Enhancements

**Modules**

- The module configuration panel in Flows and Workflows now confirms before discarding unsaved edits (Discard changes / Keep editing). Canvas nodes and dimmed module rows do not respond to clicks or keyboard focus while the panel is open. An unedited panel still closes without a prompt.
- There is a new **External Face Match** module for Flows and Workflows. Integrators upload a reference photo via `POST /omni/add/external-face`, and the module runs automatically: at the end of the session in Flows, or when the session reaches the node in Workflows. The module can be configured to match against the ID face, the onboarding selfie, or both, with options for match severity, image quality severity, occlusion, and the usual face-attribute checks (lenses, mask, head cover, closed eyes). Results, including the cropped face pair, appear in the single Session views and contribute to the overall score.
- There is a new risk add-on for eKYC called **Phone Profile**. This check uses the E.164-format phone number entered during Onboarding and returns the name, date of birth, phone validity, country, address(es), and additional candidate profiles associated with the phone number, along with a confidence level and reason codes. Results are surfaced in Rules Engine and Workflow Conditions so you can decision on fields such as *Status of Check*, *Confidence Level*, *Name Returned*, *Age*, and *Is Adult*. Contact your Incode representative if you are interested in this feature.
- eKYC verification is now available for Canada. In the eKYC module, you can select the new *Canada Telco* source for Canada. In Onboarding, the end user enters First Name, Last Name, Date of Birth, and Phone (E.164 format) as mandatory fields. The verification returns per-field match results (exact, fuzzy, nomatch, or unknown), available for review in single Session view.
- <Pill type="update" /> In the Government Record Verification module configuration for Mexico, the fingerprint option is now labeled Fingerprint and Data Validation. This change accompanies a fix to how the overall result is calculated when Face validation is turned off; see the Server > Fixes section of these notes.

**<Pill type="beta" /> Workflows**

- You can search for a module in the Workflow builder "+" menu. The search box returns matching modules and processes together as soon as you start typing, without first having to select the Modules or Processes category.

**<Pill type="beta" /> Single Session View**

- Module cards have been redesigned, including a new display for modules that are not enabled on the session, which replaces the previous "Not on this flow" card.
- The top-level cards are now organized around questions rather than module names, with each card answering a specific question about the session: Is this a real face? Is this a real document? Is this person who they say they are? Is this a low-risk session? Plus optional cards for age verification and face authentication. Each card's answer is based on the modules it contains.
- The top-level Questions row now supports up to seven cards with a minimum of four always visible, and the pill styles across containers have been reconciled for a consistent look.
- Deepsight is split back into two separate cards, one for face and one for document. Trust checks appear in both, and the trust score is surfaced when trust checks fail but the face or document score passes.
- <Pill type="update" /> Face authentication attempt scores in the Detailed view are now shown as a number out of 100, matching the score format used elsewhere in Single Session View. When no numeric score is returned for an attempt, its status is shown instead.
- <Pill type="update" /> Each top-level card now has its own matching section further down the page, using the same question as the card. The previous combined section for a real face and a real document is split into two sections: *Is this a real face?* and *Is this a real document?*

### Fixes

**Ecosystem**

- Fixed an issue in the Directory information page where the Email and Username search returned no results when the search value contained a dot (`.`). Search now returns matches correctly for values that contain a dot.

**General**

- Email validation across Dashboard now accepts valid addresses that were previously blocked, including addresses with an apostrophe in the local part (such as `o'brien@example.com`) and addresses with top-level domains longer than five characters (such as `user@example.technology`). This affects invite flows, directory sync, onboarding session generation, and Ecosystem helpdesk and candidate verification requests.
- Fixed an issue in the side navigation where the Logout item in the user menu displayed a delete (trash) icon. Logout now shows its own icon so the item no longer looks like a delete action.

**<Pill type="beta" /> Single Session View**

- <Pill type="hotfix" /> Fixed a visual issue where top-level cards in a group displayed at different heights. All top-level cards in a group now stretch to match the tallest card in the group.
- Fixed an issue where the KYC header displayed an incorrect pill. The header now shows an *Overall Risk* pill (Low or High) that matches the pill style used in the eKYC checks section.
- Fixed an issue where internal diagnostic fields appeared in the OCR *See details* list. The *Not Extracted*, *Issue Front*, and *Issue Back* rows no longer render, so the list only shows reviewer-facing OCR fields.
- Fixed a visual issue where the user agent string appeared twice in the browser info section. The duplicate row no longer renders.
- Fixed an issue where modules showing _Not run_ that still impacted the session score displayed yellow pills and yellow dots. The pills and dots now appear in red when a _Not run_ state affects the session score, so reviewers can tell at a glance which skipped modules affected the outcome. Modules with _Not run_ states that do not affect the score (such as Deepsight document when it was not expected to run) continue to display as neutral.
- Fixed three issues on the top-level question cards in Single Session View:
   - The **_Is this a low risk session?_** card now shows _Inconclusive_ when a risk module did not run and other risk modules passed, instead of incorrectly showing _Low risk_. 
   - The **Device & Behavioral Signals** pill no longer appears inside that card on sessions where the Deepsight module is present.
   - The pill style now use the standard component style so the cards read consistently across containers.

**<Pill type="beta" /> Workflow Conditions**

- Fixed an issue in the Workflow Condition panel where several signal and signal group names showed acronyms in the wrong case. These now render with the correct capitalization.
- Fixed Workflow Condition panel issues where the signal field placeholder read "Select module" instead of *Search signals* and the property dropdown read "Operator" instead of *Select property*, and the IF row flickered while loading (signal field filled in late, property dropdown appeared then vanished). The labels now match the design and the row shows a loading state until its data is ready.

## Web app
- <Pill type="update" /> <Pill type="hotfix" /> Fixed an issue that prevented the camera from opening during ID and Face capture in Onboarding on iOS 16 and 17 devices.

## Server

### Enhancements

- <Pill type="breaking" /> The following event reporting endpoints have been removed and now return 404 on all environments: `GET /omni/interview-events/generate-report` and `POST /omni/get/report`. The remaining event endpoints are unaffected.
- Device fingerprint vectors are now removed when a session's personal data is deleted through the session cleaning routine, so personal data removal is complete across both session records and the fingerprint store.
- Several directory sync improvements are now available in Ecosystem for Entra and Okta directories:
  - Directory list and detail responses include a new *sync* block that reports current sync state including: status (*PENDING*, *IN_PROGRESS*, *COMPLETED*, or *FAILED*), last successful sync time, latest run timestamps, employee counts (pulled, created, updated, deactivated), and a failure reason when a run fails. A sync open for more than six hours is treated as *FAILED*.
  - The directory's *status* field now reflects admin consent only, and the top-level *lastSyncedAt* is deprecated in favor of *sync.lastSyncedAt*.
  - User-group changes on a directory are refused while a sync is in progress; renaming is still allowed.
- <Pill type="update" /> Proof of Address classification now recognizes additional issuers. Documents from these issuers are now returned with their specific type instead of the generic *otherPoA* type.
- <Pill type="update" /> The processInput API now accepts an `aesSignature` object for AES signing. Send the PDF encoded as Base64 in `base64Pdf`, and set `userConsented` to `true`. Both fields are required, and the selected flow must include the AES module.
- <Pill type="update" /> <Pill type="breaking" /> Nicaraguan ID cards (2018 and 2026 versions) now split the given names when the QR code is read. `firstName` contains only the first given name and `middleName` contains the second, while `givenName` still contains all given names. For example, for the given names JESER GERMAN, `firstName` was previously JESER GERMAN and is now JESER, and `middleName` is GERMAN. If your integration reads `firstName` as the full given name for Nicaraguan IDs, use `givenName` instead. This change comes with the QR reading update described in the ML section of these notes.

### Fixes

- <Pill type="hotfix" /> **Canada document verification strengthening**. Several improvements were made to Canadian document verification:
  - A new organization-level option enables name-order checking in Full Name Crosscheck. When enabled, a document whose given name and surname are swapped against the MRZ, barcode, or QR fails Full Name Crosscheck, for any country. The check only runs on documents whose front separates given name and surname; cards that read only a full name keep the previous behavior. Contact your Incode representative if you are interested in this feature.
  - Document Type Side Crosscheck now fails on front and back combinations from different Canadian provinces. A back is accepted only when it is the same document type from the same province or from a visually similar province group (for example, NL/NS/PEI/NB or AB/NWT/NU). Mixed province combinations and mismatched back types now fail the check.
  - On Ontario 2020 and Quebec 2018 Health Cards, the back barcode now parses gender (Ontario) and reference number (Quebec), so the matching Business Rules Engine checks run on these cards.
  - On Ontario 2020 and Quebec 2018 Health Cards, an unread back barcode now returns Barcode 2D Detected = FAILED, matching the existing behavior for Canadian Driver's License, ID, and BC Services Card.
- <Pill type="hotfix" /> Fixed an issue where a Workflow condition on *OverallEkycLevel* did not evaluate correctly when the overall eKYC level was High, which caused sessions to pass when the condition should have failed them.
- <Pill type="hotfix" /> Improved OCR extraction of the vehicle class list on EU driver's licenses. The post-OCR correction step now splits the raw class string on commas, hyphens, and periods in addition to the forward slash, and applies a mapping of common character confusions (such as `81` to `B1`, `8` to `B`, `CIE` to `C1E`) so misread characters resolve to the correct class. This reduces the share of EU driver's license sessions that return a broken or garbled class set.
- The Exposure check on iOS is now skipped when the OS version is 27 or higher and the iOS SDK version is below 5.49.0, to avoid false Exposure failures caused by a system-level issue in that combination. The check runs normally for iOS SDK 5.49.0 and higher. This is a follow-up to a prior hotfix that applied the exclusion by iOS version alone.
- <Pill type="update" /> Fixed an issue in the Government Record Validation (GovMatch) for Mexico where the overall result was Unknown when the module was configured for Data and Fingerprint validation without Face. The overall result is now calculated only from the enabled checks, and face results are no longer returned when face validation is turned off. The fingerprint option in the module configuration was also renamed; see the Dashboard > Enhancements section of these notes.
- <Pill type="update" /> <Pill type="hotfix" /> Fixed an issue in personal data cleanup where the fields an organization chose to retain were not kept as configured. This affected only a small number of organizations. Your Incode representative can help determine if this applies to your organization.

## ML

- <Pill type="update" /> Deepsight image injection detection has been updated to improve detection of injected images.
- <Pill type="update" /> QR code and barcode reading is improved for many supported ID types, so more documents now return `qrContents`. When a QR code is read but the ID type has no QR parser, the raw QR content is returned, and some QR codes cannot be parsed. This update also changes how names are returned for Nicaraguan ID cards, described in the Server section of these notes.
- <Pill type="update" /> <Pill type="hotfix" /> Document fraud detection models have been updated. The update improves accuracy for Chilean documents, corrects the model used for Mexican documents, and adds new text rules for documents from the United States, Australia, France, Canada, and the Philippines. It also updates classification for Colombian documents and improves Deepsight for Documents and barcode-based fraud detection. Document verification scores for these documents may change as a result.

## ID Templates

### New supported templates

#### ID Classification improvement

- Canada
  - Saskatchewan
    - DriversLicense / DRIVERS_LICENSE / 2011

### Changes to current templates

#### Feature update

- Canada
  - IdentificationCard / CERTIFICATE_OF_INDIAN_STATUS / 2012 r2

#### ID Classification improvement

- Guatemala
  - Passport / NATIONAL_PASSPORT / 2016 r5

#### ID OCR extraction improvement

- Canada
  - Other / INDIAN_STATUS_CERTIFICATE / 2007 r4
- Greece
  - Passport / NATIONAL_PASSPORT / 2020 r5
- Guatemala
  - IdentificationCard / IDENTIFICATION_CARD / 2025 r2
- Israel
  - TravelDocument / TEMPORARY_IMMIGRATION_CERTIFICATE / 2010 r1
- Kenya
  - IdentificationCard / IDENTIFICATION_CARD / 2023 r5
- Peru
  - IdentificationCard / IDENTIFICATION_CARD / 2001 r5
  - IdentificationCard / IDENTIFICATION_CARD / 2013 r1
  - IdentificationCard / IDENTIFICATION_CARD / 2020 r3
  - IdentificationCard / IDENTIFICATION_CARD / 2025 r2
- Philippines
  - IdentificationCard / IDENTIFICATION_CARD / 2020 r2
  - IdentificationCard / IDENTIFICATION_CARD / 2021 r6
  - IdentificationCard / IDENTIFICATION_CARD / 2022 r1
  - IdentificationCard / IDENTIFICATION_CARD / 2023 r3
- Togo
  - IdentificationCard / IDENTIFICATION_CARD / 2021 r2
- Uganda
  - IdentificationCard / IDENTIFICATION_CARD / 2025 r2
- United Kingdom
  - DriversLicense / DRIVER_LICENSE / 2022 r5
  - DriversLicense / PROVISIONAL_DRIVER_LICENSE / 2021 r5

</Accordion>

***

## 2026 October 5

<Accordion title="2026 October 5">

_Demo: 28 September 2026 | Production: 5 October 2026_

## Release Highlights

The Beta Dashboard is now available to all customers. Beta is the same Dashboard, but new features arrive there first. Each user chooses between Standard and Beta for themselves and can switch between them at any time. Throughout the release notes and Dashboard documentation (coming soon), pages or information specific to Beta will use the <Pill type="beta" /> tag.

Opening Dashboard shows a welcome popup with options to try Beta or stay on Standard. When in Beta, a **Back to Standard** switcher is always visible in the left navigation. Channel selection and a *What is in Beta* link are also available under **Settings** > **Account**.

Beta currently includes redesigned experiences for Single Session View, Analytics, Workflows, and Module Configuration. See the Dashboard Enhancements section below for details on each.

## Dashboard

### Enhancements


<Pill type="update" /> **Phone module**

- A new **Lock prefilled phone number** setting is available in the Phone Number Input module configuration. It appears when **Prefill phone number** is enabled. When **Lock prefilled phone number** is turned on, the end user cannot change the prefilled phone number during verification.

<Pill type="update" /> **eKYB Pre-fill**

- eKYB Pre-fill is now available for [Portugal](/general-reference/portugal/). In the eKYB module, you can select *Portugal* from the **Country** dropdown in Pre-fill mode. Pre-fill is available in both Flows and Workflows. During onboarding, the end user enters a **Tax ID** (NIF, 9 digits) as the required input, with **Business Name** and **Address** as optional inputs. The end user cannot edit the pre-filled results. Results include registration details, credit rating, industry, turnover, employee count, shareholders, directors, parent companies, website, and other available company information, and appear in the KYB Pre-fill section of the Business tab in single session view.

<Pill type="update" /> **Ecosystem**

- A new *Enable Generate TAP* toggle is available in the Self Serve Integration settings. When the toggle is on, the *Generate TAP* option is available in the Self Serve Portal, allowing users to generate a Temporary Access Pass (TAP). When it is off, the option is hidden.
- Service desk agents can now start an Incode identity verification directly from a ServiceNow Interaction. An Interaction is the record created when someone calls, chats, or walks up, without opening an Incident first. The result is recorded on the Interaction, so agents confirm who they’re speaking to before acting on the request. To turn it on, select **Interaction** as a record type in the Incode integration settings in ServiceNow.
- ServiceNow administrators can now choose whether the ServiceNow integration sends the user's email address or user ID as the login hint when a verification starts.
- The Self Serve Portal has been redesigned for desktop and mobile. From a single landing page, end users can reset multi-factor authentication, reset their password, or generate a Temporary Access Pass (TAP), with clearer progress, success, and error states. Failed MFA resets can be retried individually without repeating the ones that succeeded, and a generated TAP shows a live expiry countdown. The portal is available in English and Spanish.



<Pill type="beta" /> **Analytics**

- The new Analytics view is the default in the Beta channel. In the Standard channel, the new Analytics view remains available on request.

<Pill type="beta" /> **Single Session View** 

The new Single Session View, currently available in Beta Dashboard, has many improvements: 
- Separate Overview and Detailed tabs to allow for different levels of review and analysis.
- Clarified results and scores. Result summaries, verification-check outcomes, and score presentations across the session view have been refined to make it easier to interpret an individual session at a glance.
- Improved review flow for sessions with multiple attempts. Reviewing a session that includes more than one verification attempt now surfaces per-attempt context more clearly, making it easier to compare attempts and understand which produced the final result.
- New and improved views. Several session view areas have been added or refined, giving reviewers more focused visibility into the data captured during a session.
- The *Checked Address* field has been renamed to *Geocoded (Normalized) Address*.
- A new *NFC Data* table is available in the Document section of the Detailed view. The NFC integrity check now appears in this table instead of in the other checks table.
- The Face Recognition quality checks table now includes additional pass/fail checks, including EXIF timestamp and software checks and face age estimation.
- Each Deepsight category now has an info icon. Hover over the icon to see an explanation of what the category checks, matching the descriptions shown in the Standard view.
- GovMatch results now include INE fingerprint matching in both the Overview and Detailed views. A fingerprint table shows the numerical score and lists each finger for the left and right hand as *Matched* or *Not scanned*.

<Pill type="beta" /> **Module configuration**

The revamped Module Configuration UI is available in the Beta channel for both Flows and Workflows, with several refinements this cycle:

- Modules with no configuration options show a clear *No configuration needed* state instead of an empty panel.
- Toggle cards behave consistently: dependent controls are hidden while the parent toggle is off, preserving any stored value (with a small number of intentional exceptions).
- The Video selfie module configuration panel was redesigned to align with the current design system.

<Pill type="beta" /> **Workflows 3.0**
The Workflow builder in Beta Dashboard has an improved UX, including suggested modules, previews, and a validation mode. Additionally, several readability and usability enhancements were made to the Conditions builder:

    
- Rules read as sentences (for example, *is at least* replaces *>=*) and status checks use direct verbs like *passes* and *fails*.
- Values display in human-friendly form while saving as their canonical codes: full state names, country names in place of codes, and document types sourced from the current catalog.
- Value inputs no longer overlap the delete button or adjacent unit selector, and dates use a design-system picker with *before* and *after* wording.
- Hovering a signal widens the picker into a detail card describing what the signal checks.
- Signal groups appear as a collapsible accordion, and searching auto-expands matching groups with a tag showing which module each result came from.







### Fixes
- <Pill type="update" /> Fixed an issue that caused an error when viewing images for a deleted identity in Dashboard. Dashboard now shows the data that remains for the identity after deletion.
- <Pill type="update" /> Fixed an issue in Ecosystem that caused the employee list in **Helpdesk Verification** and **Candidate Verification** to send a large number of directory requests while scrolling, which could slow the list down for organizations with very large directories. The list now loads efficiently.

## Web app

### Fixes

- Fixed an issue that caused the Digital ID redirect flow to report a session as expired after 30 seconds even when the verification was still in progress. The Onboarding client now follows the polling cadence signaled by the status response and treats only a terminal status as the end of the poll.

## **Server**

### Enhancements

- <Pill type="breaking" /> The deprecated `/omni/identities/search` endpoint has been removed. Integrations that still call this endpoint should switch to a supported alternative before upgrading. Contact your Incode representative for more information.
- The selfie quality check that runs before a GovMatch request has been consolidated into a single shared step across all supported providers. Two intended changes come with this consolidation:
    - GovDataMatch is no longer blocked by the selfie quality check. Previously, some GovDataMatch configurations could still be rejected by it. GovFaceMatch and combined GovDataMatch and GovFaceMatch flows are unaffected.
    - The GovMatch attempts list for a session no longer includes the extra empty entries that the selfie check used to create. Provider attempts continue to be recorded as before. Existing records in the database are unchanged.
   
   The selfie check criteria, the selfie checks failed error, the skip selfie check and skip cropped-ID check organization settings, and the cropped-ID fallback are all unchanged.

- <Pill type="update" /> A new B2B endpoint is available for session continuation. When provided with an interview ID or an external ID, [`omni/b2b/v1/sessions/continue`](/api-reference/b2b-v1-sessions-continue/) returns a session token if the session meets the criteria for continuation.
- <Pill type="update" /> API requests that are authenticated but not permitted to call an endpoint now return a 403 response with a distinct status code and the message “Insufficient access level.” This allows integrations to distinguish a permission restriction from a credential problem, such as a missing or revoked API key.
- <Pill type="update" /> The `/omni/get/ocr-data` response now includes two new fields, `qrFrontContents` and `qrBackContents`, that return the QR code content read from the front and back of the ID. These fields are returned for all document types where a QR code is read. Empty QR results are no longer returned as `null` entries in `qrContents` and `qrBackContents`. Raw QR content that cannot be converted into ID fields, such as the QR code on Philippine ID cards, is still returned in the API but is no longer shown in Dashboard session view.
- <Pill type="update" /> When *US barcode classification* is enabled and the barcode on the back of a US driver's license or ID card cannot be read, the text on the back of the ID is now still read and stored for the session. ID validation checks that depend on back-side data, such as the date of birth cross-check, can now be evaluated for these sessions instead of returning no result, so ID validation scores may change for some sessions. The end user experience is unchanged: the back capture still fails and the end user is asked to recapture.
- <Pill type="update" /> <Pill type="hotfix" /> Fixed an issue in GovMatch for Nigeria where organizations configured with both BVN and NIN providers would always route a gov validation request to whichever provider was configured first, causing genuine users to be rejected when the submitted number belonged to the other provider. GovMatch API requests now accept an optional ID type field to route the request to the correct provider. When no ID type is sent and both providers are configured, GovMatch now calls the second provider if the first returns no match, instead of returning a rejection after the first call. Form-based BVN and NIN flows and single-provider configurations are unchanged.
- <Pill type="update" /> <Pill type="breaking" /> <Pill type="hotfix" /> Brazil eKYC now requires Date of Birth as a mandatory input. Requests without `dateOfBirth` are rejected with `400 Mandatory fields must be submitted in order to enable request. Missing: dateOfBirth`
    - A new result pattern is possible on Brazil eKYC responses when the submitted `dateOfBirth` does not match the government record for the submitted tax ID: `taxIdMatch: exact`, `taxIdDobMatch: nomatch` with reason code `THPDB`, `taxIdNameMatch: unabletoverify`, `taxIdLevel: unabletoverify`, and `overallLevel: medium`. Previously, this response was not emitted because the date of birth was not independently validated against the government record.
    - All other Brazil eKYC behavior is unchanged, including the responses for a non-existent tax ID, for minors, and for all existing reason codes.

### Fixes

-  Fixed an issue that caused the GovMatch module to approve sessions when the government-validation provider could not be reached. In these cases, the GovMatch result is now FAIL instead of UNKNOWN, matching the behavior for other provider errors. You may see more sessions fail GovMatch when the provider is unavailable.
- <Pill type="update" /> Fixed an issue that could cause GovFaceMatch to apply another source's face match threshold when more than one US government validation source ran in the same session. Each source now uses its own configured threshold, and the GovMatch result is scored against the same threshold that was sent with the request. Threshold values have not changed. Each source also now receives the date of birth and name formatting it expects, even when several sources run in the same session.
- <Pill type="update" /> Fixed an issue in GovMatch for Mexico (INE facial validation) where, if an ID had no paternal last name, the maternal last name was sent in the paternal last name field. This caused both last-name checks to fail even when the data on the ID was read correctly. The missing paternal last name is now handled correctly. IDs with a missing maternal last name are unaffected.
- Fixed an issue that caused child organization creation to fail when creating a new child under an existing parent organization. Failed attempts left a partially created organization that could not send webhooks or save webhook authorization settings from Dashboard. If one of your organizations was affected, contact your Incode representative.
- Fixed an issue that caused the Incode ID OIDC `/userinfo` endpoint to return the `sub`, `incode_id.identityId` and `incode_id.username` fields as UUID values instead of the 24-character hexadecimal Incode identity ID documented in the Incode ID integration guide.

## **ML**

- <Pill type="hotfix" /> Physical spoof video detection and shallow fake video detection used by Deepsight have been updated. Physical spoof video detection is now more accurate, and shallow fake video detection is decoupled from physical video and goes now under `digitalManipulationAttack`.
- Barcode reading has been improved for PDF417 and linear (1D) barcodes on supported IDs, most notably on US and Canadian documents such as Ontario health cards. Barcode data is now read more reliably on these documents.

## **ID Templates**

### **New supported templates**

#### New Classification support

- Morocco
    - Passport / NATIONAL_PASSPORT / 2026
- Pakistan
    - IdentificationCard / IDENTIFICATION_CARD / 2026
- United States of America
    - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1813

#### New ID support

- China
    - TravelDocument / EXIT_ENTRY_PERMIT / 2014
- Mauritania
    - Visa / VISA / 2016

### **Changes to current templates**

#### Feature update

- Nigeria
    - IdentificationCard / IDENTIFICATION_CARD / 2010 r2
- United States of America
    - MedicalCard / SOCIAL_SECURITY_CARD / 2015 r1
    - Oklahoma
        - DriversLicense / DRIVERS_LICENSE / 2026 r1

#### ID OCR extraction improvement

- Colombia
    - ResidenceDocument / IMMIGRATION_CARD / 2014 r6
- Iraq
    - DriversLicense / DRIVERS_LICENSE / 2025 r1

</Accordion>

***

## 2026 September 21

<Accordion title="2026 September 21">
_Demo: 14 September 2026 | Production: 21 September 2026_

## Dashboard
### Enhancements
ECOSYSTEM

- Added an email login hint to the Okta identity verification integration, so the end user's email is prefilled on the Okta login screen when they start verification.
- Made several improvements to the Ecosystem Integrations experience across 13 integration types:
  - When a Workflow is selected in an integration, a hint link now opens that Workflow in a new browser tab in the Flow Builder in view mode.
  - The row cursor on the My Integrations list no longer shows a hand on non-clickable areas of a row.
  - **Directory Information** > **Manage** now lands on the My Integrations tab.
- <Pill type="update" /> Directory sync in the Okta and Microsoft Entra integrations is now significantly faster on large directories, so integrators managing large workforce directories see sync operations complete in a fraction of the previous time. In addition, if the sync service restarts mid-sync, the affected directory is available for re-sync within 6 hours instead of 24 hours.

GOVMATCH

- Renamed Government Validation to GovMatch throughout Dashboard for consistent terminology.
- <Pill type="update" /> A new GovDataMatch provider is now available in the GovMatch module configuration for US driver license verification. It runs against AAMVA's update DLDV endpoint to add fuzzy name and address matching, AKA name support, non-commercial driver license status, and indefinite-expiration handling alongside the existing AAMVA data-match coverage.

MODULES

- <Pill type="beta" /> The module configuration experience has been redesigned and is now available in Beta. A banner in Flows and Workflows lets you switch between the new module configuration experience and the previous one. In the new experience:
  - Every module opens in a redesigned configuration panel with a clearer layout and consistent section headings.
  - Modules that come with recommended settings show when a configuration has been changed, and can be set back to the recommended settings in one step.
  - Required fields are labeled *(required)*. When a required field is empty, the panel shows what is missing, and *Save configuration* stays unavailable until it is filled in.
  - Settings that depend on another setting are shown only when that setting is turned on, so each panel shows only the options that apply.
  - The window shown for modules that are not enabled for your organization has been redesigned.
- A new ***Allow selfie upload from gallery*** setting is now available in Face Capture module configuration. When enabled, end users can upload a selfie from their device gallery on the selfie tutorial screen. The setting is disabled by default. Per the setting's inline warning in Dashboard, allowing gallery upload increases fraud risk because captures are not confirmed as coming from a live camera.
- Two new Digital ID methods, iDIN (Netherlands) and FTN (Finnish Trust Network), can now be enabled in the Digital IDs section of the ID Capture module configuration. Contact your Incode representative if you are interested in this feature.
- Several deprecated identity verification providers have been removed and can no longer be selected in module configuration. Sessions run before this change that used these providers remain viewable in Dashboard. The deprecated providers include: 
  - **Indonesia**: WITHTRUSTLINK.
  - **India**: AUTHBRIDGE and AUTHBRIDGE_FACE. As part of the same cleanup, the India eKYC AUTHBRIDGE integration and the India DigiLocker digital wallet have also been removed.
  - **Brazil**: UNICO.
  - **Mexico**: INE_TELCEL and MEX_PASSPORT_PILOT.
  - **Colombia**: OPERATOR_BTC and GSE.

eKYB

- Added Prefill to eKYB module configuration for Workflows, so integrators can now choose between Verification and Prefill for eKYB on Workflows the same way they can on Flows.

eKYC

- New eKYC sources are now available in the eKYC module for the United Kingdom, the Netherlands, and Finland.
  - **United Kingdom**: In the eKYC module, there is one new source: *UK 2X2*. **Name**, **Address**, and **Date of Birth** are all mandatory fields for this source.
  - **Netherlands**: In the eKYC module, there are two new sources: *Netherlands Civil Register + Credit + Telco* and *Netherlands Consumer + Pop Register + Telco*. *Netherlands Civil Register + Credit + Telco* provides **Name** and **Phone** as mandatory fields, and Address and Date of birth as optional. *Netherlands Consumer + Pop Register + Telco* provides **Name** and **Phone** as mandatory fields, and Email, Address, Date of birth, and Gender as optional.
  - **Finland**: In the eKYC module, there is one new source: *Finland Consumer + Pop Register + Telco*. **Name** and **Phone** are mandatory fields, and Email, Address, Date of birth, and Gender are optional.
- Removed three unavailable eKYC sources from the module configuration picker so they can no longer be selected: AR Civil Register, CL Official Census, and US Telco 4.

### Fixes

ESCALATION MANAGEMENT

- Fixed an issue that caused reviewers to be unable to navigate away from the issue selection when escalating a session, requiring them to close and reopen the escalation modal to reach other fields.

GENERAL

- Fixed an issue that caused Admin users to be unable to see the AD agent tab on the module Configuration page.
- Fixed an issue that caused Admin users to be unable to add Webhook and Authentication type filters on the Audit logs tab of the Compliance page.
- <Pill type="update" /> Fixed an issue that caused the Sessions tab on the Identity view to display no results even when linked sessions existed on the identity. The session count on the General tab was accurate throughout; only the Sessions tab list was affected.

## Web app

### Fixes

- Fixed an issue that caused the ID capture screen to become unresponsive to iOS VoiceOver navigation. Users relying on VoiceOver can now move between elements as expected during document capture.
- Fixed an issue that caused the data consent screen to not load in the language selected.
- Fixed an issue that caused the Electronic Signature module in Workflows running with the older Web SDK 1.x to ignore the custom subtitle text and always display the default "Use your finger or mouse" text on the signature screen.
- Fixed an issue that caused the Face Capture screen on the new Onboarding UI to display the camera preview horizontally inverted when ***Assisted Onboarding*** was enabled. Head movement now matches the on-screen preview.

## Server

### Enhancements

- <Pill type="breaking" /> The deprecated `/omni/identities/search/v2` endpoint has been removed. Integrations still calling this endpoint will start receiving an HTTP 404 response; migrate to `omni/b2b/v1/identities/{id}`.
- <Pill type="breaking" /> Three document types have been removed from the Add Document endpoints and are no longer accepted: `medicalDoc`, `thirdId`, and `paymentProof`. Requests using any of these values now return an HTTP 400 error instead of storing the document. Integrations still using these values must switch to a supported type; `document`, `contract`, `signature`, `consent`, and `otherDocument3` remain unchanged. The corresponding ***Third ID*** capture toggle in the ID Capture module and ***POA as Bank Statement*** toggle in the Proof of Address Capture module have also been removed from Dashboard module configuration.
- <Pill type="breaking" /> The `omni/add/front`, `omni/add/back`, and `omni/add/face` endpoints now reject requests with `captureType=UPLOAD` when the flow does not allow manual upload, returning HTTP 400. For `omni/add/front` and `omni/add/back`, the flow must have ***Manual upload ID capture*** enabled in ID Capture module configuration. For `omni/add/face`, the flow must have ***Allow selfie upload from gallery*** enabled in Face Capture module configuration. Integrations that send `UPLOAD` must either enable the matching setting or stop sending `UPLOAD`.
- Added two new GovMatch response fields for US driver license verification: a non-commercial driving privilege status and an indefinite expiration indicator. Both are returned only when the underlying record includes the value, and both display in Dashboard alongside existing GovMatch results.
- Added an optional `sessionScore` query parameter to `GET /omni/b2b/v1/sessions/listing`. When set to `PASS`, only sessions scored `OK` or `MANUAL_OK` are returned; when set to `FAIL`, only sessions scored `FAIL` or `MANUAL_FAIL` are returned; when omitted, results are unchanged. Filtering combines with `maxItems` so integrators can retrieve, for example, the most recent passing session for a given user.
- Expanded back-side OCR support for US identity documents so raw back-side text is now extracted whenever a back image is captured, enabling text-based rule development for US driver licenses and identification cards where extraction was previously unavailable.
- Added support for the Morocco Passport 2026 generation. Extraction handles the addition of Amazigh as a fourth language alongside Arabic, French, and English; the removal of the holder's address from the personal-data page; and the secondary secure portrait on the signature page.
- Extended OCR extraction on the Nigeria Identification Card 2010 template to include the Date of Birth field that appears on the newer layout variant.
- Removed the OCR mask on the following US state document templates to improve field extraction: Indiana Identification Card (2010), Maine Identification Card UNDER21 (2019), Minnesota Enhanced Driver's License UNDER21 (2018), Montana Driver's License UNDER21 (2016), Nebraska Driver's License UNDER21 (2021), North Carolina Learner's Permit UNDER21 (2015), Utah Driver License UNDER21 (2016), Washington Enhanced Driver's License UNDER21 (2017), and West Virginia Driver's License UNDER21 (2020).

### Fixes

- Fixed an issue that caused stray characters, such as dots or digits, from OCR output to appear in the first name and full name fields for certain ID templates. Name fields are now sanitized consistently.
- <Pill type="hotfix" /> Fixed an issue that caused Argentina GovMatch sessions using the premium data source to skip name comparison and return incomplete data match results. The full field set, including **Name**, is now compared again.
- Fixed an issue that caused certain upstream OCR provider errors to be misclassified as document errors instead of transient failures. Sessions now correctly fail over to the backup OCR provider when the primary is degraded.
- Fixed two issues in the OCR pipeline that could cause a session to return an HTTP 500 on unusual orientation or word-list inputs, and tightened how upstream OCR failures are tracked so the failover chain switches providers more reliably.
- Fixed an issue that caused `GET /omni/b2b/v1/identities/{id}` to return the `documentType` of the most recently added document instead of the most recently issued one. The field now consistently reflects the original document shown in Dashboard's Identity Documents tab.
- Fixed an issue that caused Workflows configured with multiple Identity Search modules to fail when the same email was entered in more than one form module. Workflows with multiple Identity Search modules now run to completion in that scenario.
- Fixed an issue in the session data cleanup routine that caused certain PII fields on the Identity and Interview records to be cleared even when they were listed in the retention configuration for PII fields to keep. Those fields are now preserved as configured.
- Fixed an issue that caused many verification sessions started on an iPad in desktop mode to return an inconclusive device check result. These sessions now return a conclusive result.
- <Pill type="update" /> Fixed an issue that caused OIDC-based verifications to return an internal server error on the login step after the end user completed verification successfully. OIDC verifications now complete end to end.
- <Pill type="update" /> Fixed an issue that caused certain Business Rules with numeric operand comparisons, including those referencing geolocation coordinates, face recognition scores, and IP address values, to be silently treated as not triggered when the rule could not be evaluated. Business Rules with these operand types are now evaluated correctly, so configured controls apply as intended.

## ID Templates

### New supported templates

#### Feature update

- United States of America
  - New York
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024

#### ID OCR extraction improvement

- Panama
  - IdentificationCard / YOUTH_IDENTIFICATION_CARD / 2023
- United States of America
  - Arkansas
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
  - Illinois
    - DriversLicense / DRIVERS_LICENSE / 2000
  - Mariana Islands
    - IdentificationCard / CITY_IDENTIFICATION_CARD_UNDER21 / 2025
  - Oklahoma
    - IdentificationCard / IDENTIFICATION_CARD / 2026
  - Tennessee
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021
  - Texas
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025

#### New Classification support

- Central African Republic
  - ResidenceDocument / RESIDENCE_PERMIT / 2026
- Ecuador
  - Galapagos Islands
    - ResidenceDocument / RESIDENCE_PERMIT / 2026
- El Salvador
  - IdentificationCard / IDENTIFICATION_CARD / 2012
  - IdentificationCard / IDENTIFICATION_CARD / 2013
- Ethiopia
  - Addis Ababa
    - ResidenceDocument / RESIDENCE_DOCUMENT / 2026
- Gambia
  - IdentificationCard / IDENTIFICATION_CARD / 2024
- Iraq
  - DriversLicense / DRIVERS_LICENSE / 2022
- Ireland
  - IdentificationCard / IDENTIFICATION_CARD / 2025
- Jamaica
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Malaysia
  - DriversLicense / DRIVER_LICENSE / 2026
- Mali
  - IdentificationCard / REFUGEE_IDENTIFICATION_CARD / 2025
- Moldova
  - DriversLicense / DRIVERS_LICENSE / 2026
- Tunisia
  - ResidenceDocument / RESIDENCE_PERMIT / 2026
- Turkey
  - Other / FIREARMS_LICENSE / 2025
- United States of America
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD_UNDER21 / 2003
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD_UNDER21 / 2004
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1814
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1815
  - Hawaii
    - IdentificationCard / IDENTIFICATION_CARD / 2026
  - New York
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
  - US Department of State
    - TravelDocument / DIPLOMATIC_IDENTIFICATION_CARD / 2025

#### New ID support

- Cameroon
  - Visa / VISA / 2022
- Denmark
  - Faroe Islands
    - DriversLicense / DRIVERS_LICENSE / 2025
- Finland
  - Aland
    - DriversLicense / DRIVERS_LICENSE / 2020
- Mexico
  - Sinaloa
    - DriversLicense / DRIVERS_LICENSE / 2026
- Nigeria
  - IdentificationCard / DIGITAL_IDENTIFICATION_CARD_PDF / 2026
- United States of America
  - Hawaii
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2026
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2026
    - DriversLicense / LEARNERS_PERMIT / 2026
    - DriversLicense / PROVISIONAL_DRIVERS_LICENSE_UNDER21 / 2026
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2026
    - IdentificationCard / IDENTIFICATION_CARD / 2026
  - New York
    - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
- Vietnam
  - TravelDocument / EXIT_ENTRY_PERMIT / 2024

### Changes to current templates

#### Feature update

- Finland
  - DriversLicense / DRIVERS_LICENSE / 2019 r3
- Mexico
  - Baja California
    - DriversLicense / DRIVERS_LICENSE / 2020 r1
  - Sinaloa
    - DriversLicense / DRIVERS_LICENSE / 2018 r4
- United States of America
  - Hawaii
    - DriversLicense / DRIVERS_LICENSE / 2026 r1
  - West Virginia
    - DriversLicense / LEARNERS_PERMIT / 2023 r2

#### ID Classification improvement

- Australia
  - Western Australia
    - DriversLicense / DRIVERS_LICENSE / 2016 r6
    - IdentificationCard / IDENTIFICATION_CARD / 2015 r1
- Cayman Islands
  - Passport / NATIONAL_PASSPORT / 2020 r1
- Indonesia
  - IdentificationCard / IDENTIFICATION_CARD / 2021 r2
- United Kingdom
  - Passport / NATIONAL_PASSPORT / 2020 r2
- United States of America
  - Pennsylvania
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2022 r1

#### ID OCR extraction improvement

- Dominican Republic
  - IdentificationCard / IDENTIFICATION_CARD / 2026 r2
- Ethiopia
  - Passport / NATIONAL_PASSPORT / 2016 r5
- Hong Kong
  - ResidenceDocument / PERMANENT_RESIDENT_IDENTITY / 2018 r4
- Indonesia
  - IdentificationCard / IDENTIFICATION_CARD / 2021 r2
- Iraq
  - DriversLicense / DRIVERS_LICENSE / 2025
- Mexico
  - Sinaloa
    - DriversLicense / DRIVERS_LICENSE / 2018 r2
- Nigeria
  - IdentificationCard / IDENTIFICATION_CARD / 2010
- Palestine
  - Passport / NATIONAL_PASSPORT / 2009 r4
- Republic of North Macedonia
  - IdentificationCard / IDENTIFICATION_CARD / 2008 r1
- Romania
  - IdentificationCard / IDENTIFICATION_CARD / 2022 r5
- Ukraine
  - Passport / NATIONAL_PASSPORT / 2015 r6
- United States of America
  - Alaska
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2025
  - California
    - DriversLicense / DRIVER_LICENSE_UNDER21 / 2025 r2
    - IdentificationCard / IDENTIFICATION_CARD / 2025 r1
  - Indiana
    - IdentificationCard / IDENTIFICATION_CARD / 2010
  - Maine
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2019
  - Minnesota
    - DriversLicense / ENHANCED_DRIVERS_LICENSE_UNDER21 / 2018
  - Montana
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2016
  - Nebraska
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2021
  - North Carolina
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2015
  - Oklahoma
    - IdentificationCard / IDENTIFICATION_CARD / 2023
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2026
    - DriversLicense / LEARNERS_PERMIT / 2026
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2026
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2026
  - Utah
    - DriversLicense / DRIVER_LICENSE_UNDER21 / 2016
  - Washington
    - DriversLicense / ENHANCED_DRIVERS_LICENSE_UNDER21 / 2017
  - West Virginia
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2020
</Accordion>

***

## 2026 September 7

<Accordion title="2026 September 7">
_Demo: 1 September 2026 | Production: 7 September 2026_

## Dashboard
ECOSYSTEM

- Ecosystem now offers a Greenhouse integration. Configuration is available as a tile in the Marketplace. Ecosystem administrators can configure the integration with an integration ID, workflow selection, and client credentials. Separate integrations can be set up for IDV and KYB flows.

ESCALATION MANAGEMENT

- The reason options in the Manual Review issue-selection picker have been updated. Options now show only when the related module is included in the flow or workflow, and shadow mode counts as included. The False Approval picker lists ID Verification, Face Recognition, Liveness, Deepsight, and Other. The False Rejection picker lists the same options plus GovMatch, Risk AI, and Antifraud. The ID Validation Crosscheck picker is now shown only when ID Validation is in the flow and offers Crosscheck, Validity check, MRZ check, and Other.

GENERAL

- The Identity View in Dashboard now shows the latest document per document type in addition to the Original Document from the session where the identity was created. Previously, only the original document was listed.
- For sessions in Needs Review status, the Dashboard session header now displays the custom reason passed via the `newReason` field on the `/omni/manual-review` API. When no custom reason is supplied, the header continues to show the default system message describing why the session was routed to Needs Review.

eKYB PREFILL

- <Pill type="update" /> The eKYB Pre-fill Single Session view now shows a *Business Name Match* pill next to the Registration Number in the Customer Input section for all countries. Previously this was available for US only.
- <Pill type="update" /> Refined the eKYB Pre-fill Single Session view:
    - For India eKYB Pre-fill, the *State Registrations* section now shows all GSTINs for the business, along with the associated Registration State and Status for each.
    - For US eKYB Pre-fill, the *Directors* label has been removed from the Owners, Directors and Personnel section, since the underlying data source does not separate these roles for US.
    - Removed the *X% ownership covered* text from the Owners, Directors and Personnel section title for all countries.
    - Added an *Other Addresses* section for all countries where the information is available, shown below Other Names.
    - Sections with a *Show All* option (UBOs, All GSTINs, Other Names, Other Addresses) now offer a matching *Collapse* option to return the list to its shorter view.

eKYC

- There are new eKYC sources for Venezuela and Colombia:
    - **Venezuela Civil Register**: Mandatory fields are ***Name*** and ***National ID Number***. ***Date of Birth*** is included by default but can be removed in module configuration.
    - **Colombia Civil Register 1**: Mandatory fields are ***Name***, ***National ID Number***, and ***Issue Date***. ***Date of Birth*** and ***Gender*** are included by default but can be removed in module configuration.

- The eKYC module configuration now offers an *Auto fill from OCR* option for the National ID Number and Tax ID Number fields. When enabled, these fields are pre-filled from ID OCR during Onboarding for eKYC sources that require them, including India DMV and Argentina Credit Bureau.

### Fixes

ECOSYSTEM

- Fixed an issue that caused deleted candidates to remain visible in the candidate dropdown on the Candidate Verification page. Deleted candidates are now removed immediately without requiring a page refresh.
-  Fixed an issue that caused Helpdesk and Recruiter roles in Ecosystem to be logged out when opening the Session view. These roles can now open sessions without interruption.
- <Pill type="update" /> Fixed an issue in the Ecosystem Self Serve integration where entering an unknown email address as a login hint displayed a success screen instead of a validation error. Unknown emails now surface the expected validation message.

eKYB

- Fixed the label for the eKYB Checks module on the Modules tab in Dashboard. The label now reads correctly and includes a description of the module.
- Fixed an issue that caused KYB session results to display a map or Street View for the customer-submitted address even when the address could not be verified. Map and Street View are now shown only with a Verified or Approximate Match.
- <Pill type="update" /> Fixed an issue that caused the Single Session view for KYB Verification to appear blank when a session ended with the submitted Tax ID and Business Name not found. Unverified results are now displayed as expected.
- <Pill type="update" /> Fixed an issue that caused the *Business Name* filter in the Dashboard Sessions list to return no results for KYB Pre-fill sessions. The filter now returns matching sessions for both KYB Verification and KYB Pre-fill.

GENERAL

- Fixed several Spanish translations in Dashboard, including the workflow editor label and the Consent module label.
- <Pill type="update" /> Fixed an issue that caused the ML consent checkbox to appear twice when creating a new Data Sharing Consent in Dashboard. The checkbox now appears only once, as a read-only option.
- <Pill type="update" /> Fixed an inconsistency where the *SCORE* column in the Dashboard Sessions list and the score shown on the session detail view could disagree for the same session. The two views now report the same score.
- <Pill type="update" /> Fixed an issue in Virtual Private Cloud (VPC) deployments that caused newly completed sessions to not appear in the Dashboard Sessions list. Sessions now surface as expected.

WORKFLOWS

- <Pill type="update" /> Fixed an issue in the Workflow builder that caused a Condition to become uneditable after a node was added to a branch previously set to *Continue to next step*. The Condition can now be reopened and edited as the Workflow grows.

## Web app

### Enhancements

- The Electronic Signature module has been migrated to UXv2 for both Web flows and Workflows on desktop and mobile.
- KYB company verification is now available for Greece and Ireland. The KYB onboarding flow accepts Tax ID, Business Name, Address, UBO Names, and Director Names. Accepted Tax ID formats vary by country:
  - **Greece**: AFM (9 digits, optionally with an `EL` VAT prefix) or GEMI registration number (11 or 12 digits).
  - **Ireland**: CRO registration number (5-9 digits, numeric) or VAT number (`IE` + 7 digits + 1-2 letters).
  - <Pill type="update" /> **Portugal**: NIF (9 digits), which serves as both the company registration number and VAT number.
- <Pill type="update" /> KYB Pre-fill is now available for two additional countries. The KYB Pre-fill onboarding flow accepts Tax ID as the only mandatory input, with Business Name and Address as optional inputs:
    - **Italy**: CCIAA/NREA (2 letters + 6-7 digits), VAT/Tax Code (11 digits), or Codice Fiscale (16-character alphanumeric, for sole traders).
    - **Germany**: Commercial register number (HRB or HRA followed by digits) or VAT number (DE + 9 digits).
- <Pill type="update" /> Improved the KYB Pre-fill onboarding experience:
    - Corrected the *Tax ID* input label on step 2 of the onboarding flow.
    - For UK KYB Pre-fill, the Address field now appears in the onboarding form when Address is selected as an optional input in module configuration, and supports address autofill.
    - The summary page at the end of the KYB Pre-fill onboarding flow no longer displays pre-fill results to the end user, matching the behavior of standard KYB onboarding.

### Fixes

- Fixed an issue that caused the intro screen to be skipped on desktop when running a Workflow with **Continue to Desktop** enabled. The intro screen now displays as expected on both desktop and mobile.
- Fixed an issue that caused users on Samsung devices to get stuck on the ID capture screen after a failed front ID upload in the UXv1 SDK. Users are now prompted to retry the capture as expected.
- Fixed an issue that caused an infinite loader to appear when Samsung users took a Manual ID Capture in Incode ID Default flows. Manual ID Capture now completes as expected on all supported devices.
- Fixed an issue that caused ID capture to fail after starting a step-up flow when Deepsight was enabled at the provisioning level but disabled at the flow level. The Deepsight configuration set on the flow is now respected during step-up.

## Server

### Enhancements

- The KYB `addressMatch` result now returns at least Approximate Match whenever both `cityMatch` and `postalCodeMatch` are Verified for UK, Italy, France, Germany, and Spain company lookups. Previously, `addressMatch` could be Unverified even when city and postal code both matched. This aligns the behavior in these countries with the existing US logic.
- The KYB pre-fill response for Germany now includes the full set of company details returned by the underlying data source, including `registrationDate`, `creditRating` and `creditRatingDescription`, `industryDesc`, `activityDesc`, `turnover`, `employeeCount`, `websites`, `shareholders`, `ultimateParent`, and `immediateParent`. Previously only a subset of fields was returned.
- Terms and Conditions acceptance for Qualified Electronic Signature (QES) sessions is now recorded server-side as a distinct state before signing. Each session persists which checkboxes were accepted, the personalized contract text shown to the user, the associated links, and a timestamp. The recorded acceptance is available in the Dashboard for audit. Contact your Incode representative if you are interested in this feature.
- The `/omni/b2b/v1/identities/{id}` response now includes a `documents` array with OCR data from the latest session per document type. This applies retroactively to identities and sessions already in the system. Contact your Incode representative if you are interested in this feature.
- <Pill type="update" /> <Pill type="breaking" /> The `POST /omni/customer/add-parent` and `POST /omni/session/add-parent-customer` endpoints have been removed. Any integrations calling these endpoints will need to be updated. Contact your Incode representative if you were relying on this functionality.
- <Pill type="update" /> The KYB Pre-fill API response now includes a `tinMatch` field with a Verified or Unverified result for all countries. Previously this field was returned for US only.
- <Pill type="update" /> The India KYB Pre-fill API response now includes a `state` field for each entry in the `allGSTINs` array, indicating the Indian state associated with each GSTIN.
- <Pill type="update" /> Improved the error reason returned by KYB Verification and KYB Pre-fill for non-US countries when the submitted Tax ID cannot be found. The response now includes a `reasonCodes` field with the message *Tax ID was not found.* to clearly indicate why results are Unverified.

### Fixes

- Fixed an issue that caused only the first Custom Watchlist module in a Workflow to run when the same Workflow contained two or more Custom Watchlist modules. Every Custom Watchlist module in a Workflow now executes and its results are available to any Conditions that follow it.
- Fixed an issue that caused the Custom Watchlist Condition to evaluate as not matched when the ID number or external ID was submitted through a form and *Use fallback search* was enabled. Values submitted through forms are now correctly evaluated against the Custom Watchlist.
- Updated the authentication flow to Colombia government validation to keep the service running after a provider-mandated auth requirement change. No customer action is required.
- Fixed an issue in Colombia government validation that caused sessions submitted with an unsupported document subtype (for example, PEP Tutor or Tarjeta de Identidad) to fail with `USER_NOT_FOUND`. These documents now return `DOCUMENT_TYPE_NOT_SUPPORTED` with an `UNKNOWN` score before the provider is called.
- <Pill type="update" /> Fixed an issue in UK KYB Pre-fill where the `tin` field in the response returned the input Tax ID rather than the company registration number when a VAT number was provided as the input. The `tin` field now returns the 8-digit company registration number regardless of whether the input was a registration number or a VAT number.
- <Pill type="update" /> Fixed an issue in the QR-code handoff between desktop and mobile that caused the same device session identifier to be assigned to both devices. Desktop and mobile sessions in a handoff now receive distinct device session identifiers.
- <Pill type="update" /> Fixed an issue on SaaS where OCR fields that were present on the document but contained no extracted text were returned as `null` instead of an empty string, causing downstream crosschecks on those fields to be skipped. These fields are now returned as empty strings, matching Demo behavior and allowing crosschecks to run as expected. This affected multiple document types across passports, national ID cards, and driver's licenses.
- <Pill type="update" /> The Chilean national ID and foreign-resident Identification Card now include a QR-code cross-check as part of ID verification. Data parsed from the back-of-card QR is automatically compared against OCR and, when available, NFC data to detect tampering.
- <Pill type="update" /> Enabled a *Foldable Document* configuration flag at the template level for document types that are legitimately captured as multi-panel (folded) documents, starting with the Brazil Federal ID. When enabled for a document type, the *Multiple Documents Detection* check no longer fails when a legitimate foldable document is captured in a single frame.
- <Pill type="update" /> Fixed an issue in the OAuth Face authentication flow that caused authentication failures to redirect back to the client without any error information in the query string, making it hard for integrators to surface a meaningful message to end users. Failure responses now include error details in the query string.
- <Pill type="update" /> Fixed an issue in government validation that caused manual OCR corrections to be overridden by the value read from the ID's machine-readable zone (MRZ). When a session's OCR data has been manually updated, government validation now uses the corrected values as submitted, without applying MRZ selection on top. Sessions without manual OCR edits are unaffected.

## ML

- <Pill type="update" /> Improved Deepsight's detection of replay attacks in low-light conditions.
- <Pill type="update" /> Deepsight now detects pan-and-zoom injection attacks on desktop, where a still image is panned or zoomed to imitate a live selfie video. This detection was previously available for mobile only.
- <Pill type="update" /> Updated id-validation with model improvements for Barcode PDF417 verification and Fake ID detection:
    - Barcode PDF417 fraud detection improved for Indiana driver's licenses and IDs.
    - False rejections reduced for Tribal IDs, Ohio, and Oregon.
    - Fake ID detection improved for the Colombia national ID (2000 template), including a new signature-deterioration check.
    - Fake ID detection expanded with additional document-specific rules across US and Canada, including Arizona driver's licenses and IDs, Connecticut driver's licenses and IDs, Nova Scotia driver's licenses and IDs, and the US Passport Card.

## ID Templates

### New supported templates

#### New Classification support

- Austria
  - Other / FIREARMS_LICENSE / 2021
- Bahamas
  - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2026
- Burkina Faso
  - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2020
- Democratic Republic of the Congo
  - IdentificationCard / REFUGEE_IDENTIFICATION_CARD / 2021
- Gabon
  - TravelDocument / CONSULAR_CARD / 2026
- Greece
  - ResidenceDocument / TEMPORARY_PROTECTION_IDENTITY_DOCUMENT / 2026
- Mexico
  - Estado de México
    - DriversLicense / DRIVERS_LICENSE / 2024
- Mongolia
  - IdentificationCard / IDENTIFICATION_CARD / 2020
- Niger
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Papua New Guinea
  - DriversLicense / DRIVERS_LICENSE / 2026
- Peru
  - DriversLicense / DRIVERS_LICENSE / 1880
- Puerto Rico
  - DriversLicense / DRIVERS_LICENSE / 2015
- Samoa
  - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2025
- Saudi Arabia
  - IdentificationCard / IDENTIFICATION_CARD_FOR_FOREIGNERS / 2015
- Serbia
  - Other / FIREARMS_LICENSE / 2021
- Somalia
  - Somaliland
    - Military / MILITARY_CARD / 2025
- Sri Lanka
  - IdentificationCard / IDENTIFICATION_CARD / 2025
- Sudan
  - Military / MILITARY_CARD / 2021
  - Passport / NATIONAL_PASSPORT / 2025
- Turkey
  - IdentificationCard / IDENTIFICATION_CARD_FOR_FOREIGNERS / 2025
- United States of America
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1816
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1817
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1818
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1819
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1820
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1821
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1822
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1823
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1824
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1825
- Yemen
  - DriversLicense / DRIVERS_LICENSE / 2024

#### New ID support

- Burkina Faso
  - IdentificationCard / IDENTIFICATION_CARD / 2026
- Cameroon
  - ResidenceDocument / RESIDENCE_PERMIT / 2026
- Guyana
  - IdentificationCard / IDENTIFICATION_CARD / 2025
- India
  - TravelDocument / CERTIFICATE_OF_REGISTRATION_OCI / 2018
- Iraq
  - IdentificationCard / REFUGEE_IDENTIFICATION_CARD / 2025
  - ResidenceDocument / RESIDENCE_CARD / 2021
- Kazakhstan
  - ResidenceDocument / RESIDENCE_PERMIT / 2014
- Kosovo
  - IdentificationCard / IDENTIFICATION_CARD / 2008
- Philippines
  - IdentificationCard / POLICE_CLEARANCE_IDENTIFICATION_CARD / 2010
- Sudan
  - IdentificationCard / IDENTIFICATION_CARD / 2010
- Suriname
  - Passport / NATIONAL_PASSPORT / 2026
- Turkey
  - Permit / WORK_PERMIT / 2025
- United States of America
  - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1877

### Changes to current templates

#### Feature update

- India
  - TaxIdentification / TAX_DEPARTMENT / 2015 r2
- Mexico
  - CDMX
    - DriversLicense / DIGITAL_DRIVER_LICENSE_APP / 2023 r2

#### ID Classification improvement

- Philippines
  - DriversLicense / DRIVER_LICENSE / 2017 r4
- United States of America
  - New York
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2022 r2
- Zambia
  - DriversLicense / DRIVERS_LICENSE / 2024 r2

#### ID OCR extraction improvement

- El Salvador
  - IdentificationCard / IDENTIFICATION_CARD / 2000 r5
- Guatemala
  - ResidenceDocument / RESIDENCE_PERMIT / 2011 r3
- Japan
  - ResidenceDocument / RESIDENCE_PERMIT / 2016 r1
- Mexico
  - CDMX
    - DriversLicense / DIGITAL_DRIVER_LICENSE_APP / 2023 r2
  - Chiapas
    - DriversLicense / DRIVERS_LICENSE / 2025 r1
  - Estado de México
    - DriversLicense / DRIVERS_LICENSE / 2021 r2
  - Jalisco
    - DriversLicense / DRIVER_LICENSE / 2024 r1
  - Nuevo León
    - DriversLicense / DRIVER_LICENSE / 2021 r1
  - Quintana Roo
    - DriversLicense / DRIVERS_LICENSE / 2001 r1
- Philippines
  - DriversLicense / DRIVER_LICENSE / 2017 r4
- Poland
  - ResidenceDocument / RESIDENCE_PERMIT / 2020 r2
- United Kingdom
  - DriversLicense / PROVISIONAL_DRIVER_LICENSE / 2021 r4
- Zambia
  - DriversLicense / DRIVERS_LICENSE / 2024 r2

</Accordion>

***

## 2026 August 24

<Accordion title="2026 August 24">

_Demo: 17 August 2026 | Production: 24 August 2026_

## Dashboard

### Enhancements

GENERAL

- The eKYB single Session view has been redesigned for both eKYB Verification and eKYB Pre-fill, with a business-oriented layout and an overall status circle summarizing the outcome. US sessions also add a _Found in Registry_ pill for entries retrieved from the registry but not part of the input.
- There is a new setting in the ID Validation module called **ID Validation Deep Check**. When enabled, an additional asynchronous document verification runs after ID capture for Colombian national ID cards, and its result appears as a row in the single Session view. In shadow mode, the check is computed and displayed but does not affect the session decision or score. Contact your Incode representative if you are interested in this feature.
- The Ecosystem marketplace in Dashboard now includes discovery tiles for more integrations. When an integration is enabled for your organization you can configure it directly; otherwise a _Request access_ button lets you contact us about enabling it.



eKYB PRE-FILL

- eKYB Pre-fill is now available for the Netherlands, Spain, France, and the United Kingdom. Pre-fill is currently only available for Flows. In the eKYB module, you can select any of these countries from the _**Prefill Source**_ dropdown in Pre-fill mode. The end user enters a Tax ID as the required input, with Business Name and Address as optional inputs. Accepted Tax ID formats and available result fields vary by country:
  - **Netherlands**: KvK number or VAT number. Results include registration details, credit rating, industry, directors, and other available company information.
  - **Spain**: CIF or VAT number. Results include registration details, credit rating, industry, directors, and other available company information.
  - **France**: SIREN, SIRET, RCS, RC, or VAT number. Results include registration details, credit rating, industry, directors, group structure, and other available company information.
  - **United Kingdom**: Registration Number or VAT Number. Results include registration details, credit rating, industry, directors, shareholders, beneficial owners, website, and other available company information.
- The eKYB Pre-fill section in single Session view now includes a _Pre-fill Customer Input_ box above the _Pre-fill Output_ that shows the Tax ID (always) plus Business Name and Business Address when provided. Match pill labels have been updated to _Verified with Registry_, _Potential Match with Registry_, and _Not Found in Registry_. For US eKYB Pre-fill, the Output also surfaces state registrations, website, address deliverability, and additional business addresses.



FORMS AND DATA ENTRY PREFILL

- In Forms and Data Entry module configuration, the _Editable_ checkbox now defaults to checked for new questions, so prefilled values remain editable by the end user unless you deliberately lock them. Toggling the _Prefill_ checkbox off and back on during editing now preserves the previously selected Prefill source and Editable state instead of clearing them.
- _Nationality_ is now available as a Prefill source option in Forms and Data Entry module configuration alongside the existing prefill sources.
- The Prefill source dropdown in Forms and Data Entry module configuration now displays clear, localized labels (for example _First name_, _Date of birth_, _Issuing state_) in place of the previous raw values. Labels are translated in every Dashboard locale and update when you change the Dashboard language.

eKYC

- <Pill type="update" /> A new *Mexico Civil Register 2* source is now available in the eKYC module for Mexico. In Onboarding, the end user enters First Name and Last Name as mandatory fields along with a CURP as the required ID number. Middle Name, Date of Birth, and Gender are optional.
- <Pill type="update" /> A new *Argentina Credit Bureau 1* source is now available in the eKYC module for Argentina. In Onboarding, the end user enters First Name, Last Name, and Date of Birth as mandatory fields. Middle Name, Gender, Address, Phone, National ID (DNI), and Tax ID (CUIT or CUIL) are optional.


### Fixes

- Fixed an issue with the Deepsight tab in single Session view. When a session had multiple Face Authentication attempts, the tab could display the image and scores from an attempt that was not the latest one. Now, the latest attempt is shown consistently.
- Standardized the styling of the field labels in the Escalation modal.
- Corrected several Spanish translations in the Workflow builder. Changes focused on the save action, the builder label, the delete action, and the word desktop. The post-save screen copy has also been updated for clarity.
- In the Flow builder, the **Save flow** button tooltip could remain visible after clicking and overlap a resulting error toast. The toast now takes priority and displays in the foreground.
- In the single Session view _Other_ tab, the elements in the event log could appear misaligned for events from sessions completed through the web onboarding experience. Event log elements now display correctly aligned.
- In the single Session view _Other_ tab, the _Device_ section could appear empty for sessions completed through Web SDK 2.0 integrations. Device information now displays correctly for these sessions.
- Fixed an issue that prevented tooltips from displaying for module configuration options in Flows.
- <Pill type="update" /> The business address shown in eKYB single Session results now displays a street-level map view of the registered address. Addresses using the extended ZIP+4 postal-code format now resolve to the correct location, consistent with the 5-digit ZIP.
- <Pill type="update" /> Fixed an issue where exporting sessions to CSV from Dashboard produced an empty file. The export now contains the data for the filtered sessions.
- <Pill type="update" /> Fixed an issue that caused Kenya eKYC configurations to not save correctly in the Flow builder.

## Web App (Onboarding)

### Enhancements

- On the Face Capture and Face Authentication modules with UX v2 enabled, the selfie oval is now larger. This makes it easier to align a face during capture, especially on smaller screens.
- In the eKYB Pre-fill onboarding experience, when the Shareholders, Directors, or GSTIN list contains more than three entries, only the first three are shown by default with an option to expand and view the full list.

### Fixes

- On Samsung Internet browser, denying the camera permission on the first prompt and then tapping _Allow permission_ was redirecting the end user to the camera instructions page instead of re-prompting for permission. The permission dialog now correctly reappears, matching the behavior on Chrome and Firefox.
- On certain Android devices, the camera permission dialog could briefly reappear during the ID capture module after the end user rotated the device to landscape and back to portrait. Permission is now retained correctly through orientation changes.
- Several Polish translations in the ID Capture module for Web Workflows have been improved for clarity and consistency.

## Server

### Enhancements

- The `omni/b2b/v1/identities/{id}` response now includes three additional fields: `displayName`, `fullNameMrz`, and `gender`.
- A new `POST /omni/session/continue` endpoint is available for continuing an existing session, for example, when an end user starts onboarding on desktop and wants to continue on mobile. You can call this endpoint within 48 hours of the session starting. This behavior was previously part of `/omni/start`, which continues to work as before for backward compatibility.
- Name parsing has been improved for Colombian ID cards (`IDENTIFICATION_CARD` 2000 and 2020, and `MINORS_ID` 2008). Names on these documents are now split more accurately into first, middle, paternal surname, and maternal surname fields, which resolves cases where government validation was failing due to a missing middle name. `firstName` value changes for names that have a middle name, and `givenName` still carries all given names. On `fullName`, word order is unchanged in this release, though content can shift in the few cases where the parts were corrected.
- <Pill type="update" /> The `POST /omni/session/continue` endpoint now accepts `interviewId` or `externalId` in the request body as alternatives to the onboarding-link `uuid` for locating the session. Exactly one identifier must be provided per request.

### Fixes

- Submitting an ID image that could not be read or resized to `POST /omni/add/front-id/v2` returned a generic server error. The endpoint now returns a client error response identifying the problem, so these cases can be handled and retried by your integration.
- GovMatch for Nigeria identity verification could fail with an unexpected error when the session country code was not available. Validation now proceeds correctly in this scenario without requiring a document scan.
- GovDataMatch for US driver's licenses could return a generic connection error for Puerto Rico IDs instead of the expected _State not supported result_, and could also record the wrong verification provider or an incorrect FAIL status on transient connection errors. Puerto Rico IDs now return _State not supported correctly_, and the correct provider and UNKNOWN status are recorded when a connection error occurs.
- Fixed an issue that caused ID Capture validation errors in mobile SDK integrations when Deepsight was disabled in a Workflow. The ID Capture module's `motion` flag now returns the correct value.
- When an end user uploaded their ID as a file rather than capturing it with the camera, the Deepsight score could fail the session due to missing capture metadata. Deepsight now correctly handles ID uploads without capture metadata, matching the existing behavior for imported credentials such as Apple Wallet.
- Fixed an issue that caused authentication sessions to be sent to manual review after reaching their configured maximum number of failed attempts. The sessions now correctly fail when the maximum is reached.
- When Deepsight ran during Face Authentication and depth data was unavailable, the session was routed to manual review. Face Authentication now returns a match/no-match result directly. Face Capture routing is unchanged and remains customer-configurable via _Allow manual review_.
- Improved error handling on `POST /omni/process/id` when the submitted ID image is smaller than the required minimum dimensions. The endpoint now returns a specific error identifying the issue.
- <Pill type="update" /> Fixed an issue that caused eKYB business verification requests to fail for France, Germany, Italy, Spain, and the United Kingdom. Verification now completes correctly for these countries.
- <Pill type="update" /> Fixed an issue that caused the year of birth from earlier verification modules (for example, ID capture) to be omitted from Global Watchlist requests. The year of birth is now included, improving watchlist match accuracy.

## ML

- The Fake ID check has been improved for Colombia identification cards. The Barcode PDF417 check has been updated to reduce false results for some documents from Canada (Alberta) and USA (Idaho and Hawaii).
- The Motion Attack anti-fraud check now uses an improved detection model for higher accuracy. The change applies automatically to all sessions where this check is enabled.

## ID Templates

### New Supported Templates

FEATURE UPDATE

**United States of America**
- **Alaska**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2023
- **Arkansas**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **California**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2018
- **Illinois**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **Indiana**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **Mariana Islands**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
  - IdentificationCard / CITY_IDENTIFICATION_CARD_UNDER21 / 2025
- **Michigan**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **New Jersey**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2018
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2019
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **New York**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
  - IdentificationCard / CITY_IDENTIFICATION_CARD_UNDER21 / 2023
- **Rhode Island**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **Tennessee**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021
- **Texas**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2013
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **Wisconsin**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020

ID CLASSIFICATION IMPROVEMENT

**Australia**

- **Queensland**
  - Permit / INDUSTRY_AUTHORITY_CARD / 2024

**United States of America**

- **Mariana Islands**
  - IdentificationCard / CITY_IDENTIFICATION_CARD_UNDER21 / 2025
- **New Jersey**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2018
- **New York**
  - IdentificationCard / CITY_IDENTIFICATION_CARD_UNDER21 / 2023

ID OCR EXTRACTION IMPROVEMENT

**Australia**
- **Queensland**
  - Permit / INDUSTRY_AUTHORITY_CARD / 2024

**United States of America**
- **Indiana**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **Michigan**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **New Jersey**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020

NEW CLASSIFICATION SUPPORT

**Algeria**
- DriversLicense / DRIVERS_LICENSE / 2020

**Argentina**
- DriversLicense / DRIVERS_LICENSE / 1958

**Gambia**
- IdentificationCard / IDENTIFICATION_CARD / 2015

**Kyrgyzstan**
- DriversLicense / DRIVERS_LICENSE / 2026

**Mexico**
- **Guerrero**
  - DriversLicense / DRIVERS_LICENSE / 1895

**Peru**
- DriversLicense / DRIVERS_LICENSE / 1881

**Turks and Caicos Islands**
- IdentificationCard / ENDORSEE_IDENTIFICATION_CARD / 2025

**United Kingdom**
- DriversLicense / INTERNATIONAL_DRIVERS_LICENSE / 2025

**United States of America**
- TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1826
- **Alaska**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2023
- **Arkansas**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **California**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2018
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
- **Connecticut**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **Illinois**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2000
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **Mariana Islands**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **New Jersey**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2019
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2022
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2023
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **New York**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
- **Pennsylvania**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
- **Rhode Island**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **Tennessee**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021
- **Texas**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2013
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2025
- **Wisconsin**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020

NEW ID SUPPORT

**Libya**
- Passport / DIPLOMATIC_PASSPORT / 2020

**Mexico**
- **Tabasco**
  - DriversLicense / DRIVERS_LICENSE / 2020

**Myanmar**
- Passport / TRAVEL_DOCUMENT / 2025

**Portugal**
- ResidenceDocument / RESIDENCE_PERMIT / 2023

**United States of America**
- **California**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024
- **Connecticut**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2020
- **New Jersey**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2022
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2023
- **Pennsylvania**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2024

**Uruguay**
- IdentificationCard / IDENTIFICATION_CARD / 2026

### Changes to Current Templates

FEATURE UPDATE

**Azerbaijan**
- DriversLicense / DRIVERS_LICENSE / 2021 r1

**Brazil**
- DriversLicense / DRIVER_LICENSE / 2022 r6

**Colombia**
- IdentificationCard / IDENTIFICATION_CARD / 2000 r10
- IdentificationCard / IDENTIFICATION_CARD / 2020 r5
- IdentificationCard / MINORS_ID / 2008 r7

**Croatia**
- ResidenceDocument / RESIDENCE_PERMIT / 2020 r1

**Mexico**
- VoterIdentification / VOTER_IDENTIFICATION_CARD / 2026 r1
- **Tabasco**
  - DriversLicense / DRIVERS_LICENSE / 2021 r3

**Switzerland**
- ResidenceDocument / RESIDENCE_PERMIT / 2016 r1

**United States of America**
- **California**
  - DriversLicense / DRIVERS_LICENSE / 2025 r1

ID CLASSIFICATION IMPROVEMENT

**Greece**
- ResidenceDocument / ASYLUM_SEEKER_CARD / 2020 r1

ID OCR EXTRACTION IMPROVEMENT

**Canada**
- **Alberta**
  - DriversLicense / DRIVER_LICENSE / 2026 r1
  - IdentificationCard / IDENTIFICATION_CARD / 2026 r1

**Finland**
- DriversLicense / DRIVERS_LICENSE / 2019 r2

**Greece**
- Military / MILITARY_ID / 2022 r1
- ResidenceDocument / ASYLUM_SEEKER_CARD / 2020 r1

**India**
- **Assam**
  - DriversLicense / DRIVERS_LICENSE / 2010 r2

**Japan**
- DriversLicense / DRIVER_LICENSE / 2000 r3

**Nigeria**
- IdentificationCard / IDENTIFICATION_CARD / 1996 r1

**Papua New Guinea**
- DriversLicense / DRIVERS_LICENSE / 2025 r1

**Peru**
- ResidenceDocument / RESIDENCE_PERMIT / 2021 r8

**Poland**
- ResidenceDocument / RESIDENCE_PERMIT / 2020 r1

**Saudi Arabia**
- ResidenceDocument / RESIDENCE_PERMIT / 2015 r3

**Senegal**
- IdentificationCard / IDENTIFICATION_CARD / 2017 r2

**Spain**
- IdentificationCard / IDENTIFICATION_CARD / 2006 r3

**United Kingdom**
- **Isle of Man**
  - DriversLicense / DRIVER_LICENSE / 2022 r1

**United States of America**
- **Alaska**
  - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2019 r1
- **California**
  - DriversLicense / DRIVERS_LICENSE / 2025 r1
  - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2025 r1
  - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2025 r1
- **District of Columbia**
  - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2017 r2
- **Iowa**
  - DriversLicense / DRIVERS_LICENSE / 2013 r2
- **Michigan**
  - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2011 r4
- **North Carolina**
  - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2024 r2
- **Wisconsin**
  - DriversLicense / LEARNERS_PERMIT / 2023 r1

**Zambia**
- DriversLicense / DRIVERS_LICENSE / 2024 r1

</Accordion>

***

## 2026 August 10

<Accordion title="2026 August 10">

_Demo: 3 August 2026 | Production: 10 August 2026_

## Dashboard

### Enhancements

GENERAL

- The Beta Dashboard is now available for customers to try. It's a redesigned Dashboard experience where we're building and previewing our latest work. A banner on the Main Dashboard offers a link to explore the Beta Dashboard, and a banner on the Beta Dashboard lets you return to Main at any time.

eKYC

- Argentina Credit Bureau 1 is now available as a new source for eKYC in Argentina. It checks an individual's submitted name, date of birth, address, phone, national ID, and tax ID against Argentine credit bureau records and returns match results.
- Mexico Civil Register 2 is now available as a new source for eKYC in Mexico. It checks an individual's submitted first name, middle name, last name, date of birth, gender, and ID number against Mexican civil registry records and returns match results.

MODULES

- In the Forms and Data Entry module, the **_Prefill_** toggle now shows a **_Prefill source_** drop-down when enabled, letting you choose which captured ID field prefills a form question. An **_Editable_** toggle then controls whether the end user can edit the prefilled value.
- There is a new setting in the ID Validation module called **Multiple Documents Detection check**. When enabled, it warns when more than one identity document appears in a single capture frame. The check doesn't affect the score by itself, but you can configure a Rule in Flows or a Condition in Workflows to route onboarding based on the result. Contact your Incode representative if you are interested in this feature.
- There is a new setting in the ID Validation module Deepsight configuration called **Visual Anomaly Detection.** When enabled, it finds identity documents whose layout and visual elements are inconsistent with the genuine template for that document type. The result doesn't affect the score by itself, but you can configure a Rule in Flows or a Condition in Workflows to route onboarding based on the result. This check is currently available for the Colombian national ID card (cédula) issued in 2000, with expansion to more documents planned. Deepsight is a separately-licensed feature; contact your Incode representative if you are interested in this feature.
- <Pill type="update" /> eKYB Pre-fill coverage has expanded to include the United Arab Emirates, Saudi Arabia, Australia, the United Kingdom, India, and the United States. For each of these countries, submitting the required business identifiers returns available company details such as name, address, entity type, registration status, and registration date to prefill the eKYB flow. In India, either the Corporate Identification Number (CIN) or the GSTIN can be submitted as the business tax identifier. In the United States, the business name and address are required inputs; if a Tax ID (EIN) is also submitted, the response additionally includes a TIN verification result.

ECOSYSTEM

- The ServiceNow integration tile now displays additional configuration reference fields: **_API base URL_**, **_Issuer URL_**, **_Token URL_**, **_Grant type_**, and **_Scope_**.
- A new **Jira Service Management** integration tile is available in Integrations under the IT Service Management category. It allows help desk agents to verify employee identities directly from a Jira Service Management request using Incode's verification platform. Contact your Incode representative if you are interested in this feature.

DIGITAL ID

- CA DMV Wallet is now available as a Digital ID Acceptance method in the United States, allowing end users to present a California mobile driver's license (mDL) alongside existing Apple Wallet and Google Wallet options.





### Fixes

eKYC

- <Pill type="update" /> Fixed an issue in US eKYC where the apartment input from onboarding was not always passed through to the eKYC source in the address for matching. Apartment values are now included in the address sent to the source for all supported US eKYC sources that accept it.

ECOSYSTEM

- Fixed an issue where, with cookie-based authentication enabled, opening a Self-Serve Portal reset link in a new tab could log the user out of the original Dashboard tab.
- Fixed a visual issue in Helpdesk and Candidate Verification where the employee-search drop-down could render below the verification table when the employee list was long.
- Fixed an issue in Helpdesk Verification where a newly generated verification session didn't appear in the sessions table until the page was reloaded.
- Fixed an issue in Ecosystem's Self-Serve Portal where an employee could be redirected to an outdated form if the verification result couldn't be retrieved, instead of an appropriate error page.
- Fixed an issue where the "Visit documentation" links for the ServiceNow and Auth0 integration tiles pointed to the wrong documentation pages.
- Fixed an issue in Ecosystem where pressing Tab didn't move focus to the next input field on modals across Ecosystem pages.
- In Ecosystem's Integrations configuration, creating a new Active Directory (AD) integration now shows guidance with a direct link to manage AD agents. Configuration tabs now have stable, shareable links with permission-aware fallbacks, and switching tabs no longer loses in-progress form data.
- <Pill type="update" /> Fixed an issue in Ecosystem where employee sync for a Microsoft Entra directory could fail entirely when the synced group contained members that were not users (for example, nested groups, devices, or service principals). Non-user members are now skipped so the sync completes for all valid users.

MODULES

- Fixed an issue where OCR-related errors could cause the Claims Matching module to incorrectly block onboarding completion.

SESSIONS

- Fixed an issue where clicking **Add face to database** in single Session view didn't create a `FACE_ADDED_TO_DATABASE` event in Compliance > Audit Logs.
- Fixed an issue in single Session view where clearing a manually edited, not extracted OCR field didn't actually remove the entered value on save.

IDENTITIES

- Removed several irrelevant technical fields from the Identities page CSV export. The export now only includes relevant identity and verification fields.

***

## Web App (Onboarding)

### Enhancements

**US Smart Capture end to end**

- For US driver's licenses, onboarding now starts ID capture on the back of the document and scans the barcode in parallel with the image. Depending on the barcode and image results, the front ID capture and ID validation steps may be skipped automatically to streamline the flow. This applies to the newer capture experience only; the older UX is unaffected.
- If front ID capture is skipped, face verification is also skipped; the face capture step itself is unaffected.

### Fixes

- Fixed an issue where the Fiscal QR OCR module could fail to complete scanning.
- Fixed an alignment issue on the "Show back of your ID" tutorial screen. The ID image now displays centered as intended.
- Fixed an alignment issue on the Selfie tutorial screen to match the intended design.
- Fixed an issue where mobile redirect enforcement could be bypassed after refreshing the onboarding flow.

***

## Server

### Enhancements

- Added enhanced protections to help ensure the integrity of capture metadata submitted during identity verification sessions.
- The B2B onboarding request endpoint now accepts an optional `externalCustomerId` field, consistent with `omni/start`, allowing integrators to tag the resulting session with their own customer identifier.
- OCR processing now automatically fails over to a backup provider if the primary OCR provider experiences an outage or infrastructure error, helping ensure document processing continues uninterrupted.
- Risk AI fraud and legitimacy reason descriptions are now also provided as codes alongside the English text so they can be localized into your organization's preferred language.
- Added a new anti-spoofing check for Proof of Address documents. The result doesn't affect the score by itself, but you can configure a decline or manual-review rule based on it through Business Rules. Contact your Incode representative if you are interested in this feature.
- <Pill type="update" /> When Deepsight, government validation, Video Selfie, or an anti-fraud check fails on a session, the Risk AI response category is now overridden to High Confidence Fraud. Previously, the Risk AI category could still show as a pass in these cases, which did not reflect the overall session outcome.

### Fixes

- Reduced wait time for US driver's license identity validation checks during provider outages or connectivity issues, so sessions fail faster instead of blocking for up to a minute.
- Fixed an issue where the expiration date crosscheck did not populate for Canadian British Columbia driver's license and ID card documents lacking a machine-readable zone. The check now reconstructs the full expiration date and evaluates correctly.
- Extended the expiration date crosscheck to reconstruct the full expiration date, not just the year, for the Canadian British Columbia Services Card.
- Fixed an issue where the cropped face image could cut off part of user’s face when their head was significantly rotated.
- Fixed an issue where Deepsight Visibility could include modules that were not configured in the flow, showing them as passing when they were never run. Deepsight Visibility now reflects only the modules that are actually configured.
- Fixed an issue where Mexican INE facial government validation could falsely fail sessions when a user's last name exceeded the MRZ field length, due to truncation in the MRZ comparison value.
- Fixed an issue in Colombian government validation where first and middle names are now validated independently; a missing or unrecognized middle name no longer causes the overall name check to fail.
- Fixed an issue where Colombian government validation could fail to match certain compound names or names containing cultural particles, due to rigid, position-based name segmentation. Name matching now uses rules that better reflect how these names are actually structured.
- Fixed an issue where login lookups for directory-synced usernames were case-sensitive, causing enrolled users with an uppercase login hint to be treated as unregistered. Username matching for login is now case-insensitive, consistent with existing employee lookups.
- [Face Authentication](/features-and-modules/face-authentication/) sessions are no longer routed to Manual Review when depth data cannot be captured from the device. Previously these sessions could remain in a pending review state indefinitely for organizations that do not perform manual review. Face Authentication now returns a definitive match or no-match result in these cases. [Face Capture](/features-and-modules/face-capture/) behavior is unchanged and continues to follow the manual review setting in its module configuration.

***

## ML

- Added a new detection model to improve identification of digitally manipulated or injected images during face verification. This works alongside existing video-based manipulation detection.

***

## ID Templates

### New supported templates

NEW CLASSIFICATION SUPPORT

**Angola**

- IdentificationCard / REFUGEE_IDENTIFICATION_CARD / 2025

**Bhutan**

- ResidenceDocument / RESIDENCE_PERMIT / 2020

**Central African Republic**

- VoterIdentification / VOTER_IDENTIFICATION_CARD / 2020

**Croatia**

- ResidenceDocument / SPECIAL_IDENTITY_CARD / 2026

**El Salvador**

- IdentificationCard / IDENTIFICATION_CARD / 2014
- IdentificationCard / IDENTIFICATION_CARD / 2015
- IdentificationCard / IDENTIFICATION_CARD / 2016
- IdentificationCard / IDENTIFICATION_CARD / 2017

**Germany**

- IdentificationCard / DIPLOMATIC_IDENTIFICATION_CARD / 2025

**Jamaica**

- Other / FIREARMS_LICENSE / 2025

**Libya**

- DriversLicense / DRIVERS_LICENSE / 2026

**Mauritania**

- TravelDocument / CONSULAR_CARD / 2025

**Niger**

- Military / MILITARY_CARD / 2020

**Qatar**

- DriversLicense / LEARNERS_PERMIT / 2020

**Somalia**

- **Somaliland**
  - DriversLicense / DRIVERS_LICENSE / 2024
  - IdentificationCard / IDENTIFICATION_CARD / 2026

**Sudan**

- Military / MILITARY_CARD / 2026

**Thailand**

- IdentificationCard / IDENTIFICATION_CARD_FOR_FOREIGNERS / 2026

**United States of America**

- TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1827
- TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1828
- TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1829
- TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1830
- **Hawaii**
  - IdentificationCard / IDENTIFICATION_CARD / 2026

<br />

NEW ID SUPPORT

**Algeria**

- DriversLicense / DRIVERS_LICENSE / 2020

**Aruba**

- Visa / VISA / 2023

**Australia**

- **Queensland**
  - Permit / INDUSTRY_AUTHORITY_CARD / 2024

**Bosnia and Herzegovina**

- IdentificationCard / IDENTIFICATION_CARD / 2003

**Congo**

- ResidenceDocument / RESIDENCE_PERMIT / 2020

**India**

- IdentificationCard / MASKED_IDENTIFICATION_CARD / 2015

**Ireland**

- Passport / NATIONAL_PASSPORT / 2026
- Passport / PASSPORT_CARD / 2026

**Liechtenstein**

- DriversLicense / DRIVERS_LICENSE / 2022

**Paraguay**

- DriversLicense / DRIVERS_LICENSE / 2026

**Philippines**

- Other / PROFESSIONAL_REGULATION_COMMISSION / 2026

**Senegal**

- Passport / NATIONAL_PASSPORT / 2025

**Tajikistan**

- Visa / VISA / 2025

**United States of America**

- **Alaska**
  - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2025
  - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2025
  - IdentificationCard / IDENTIFICATION_CARD / 2025
- **Hawaii**
  - DriversLicense / DRIVERS_LICENSE / 2026
- **Nebraska**
  - DriversLicense / PROVISIONAL_DRIVERS_LICENSE_UNDER21 / 2026

### Changes to current templates

ID CLASSIFICATION IMPROVEMENT

**Antigua and Barbuda**

- DriversLicense / LEARNERS_PERMIT / 2025

**Cyprus**

- ResidenceDocument / RESIDENCE_PERMIT / 2020 r1

**Iceland**

- ResidenceDocument / RESIDENCE_PERMIT / 2020 r1

**Norway**

- ResidenceDocument / RESIDENCE_PERMIT / 2020 r1

**United Kingdom**

- Passport / NATIONAL_PASSPORT / 2015

<br />

ID OCR EXTRACTION IMPROVEMENT

**Bolivia**

- IdentificationCard / IDENTIFICATION_CARD / 2023 r6

**Brazil**

- FederalID / IDENTIFICATION_CARD / 2019 r9

**Botswana**

- IdentificationCard / IDENTIFICATION_CARD / 2020 r1

**India**

- IdentificationCard / MASKED_IDENTIFICATION_CARD / 2015 r1
- **Punjab**
  - DriversLicense / DRIVERS_LICENSE / 2024 r1

**Japan**

- Passport / NATIONAL_PASSPORT / 2006 r2

**Malaysia**

- DriversLicense / DRIVER_LICENSE / 2025 r1

**Uganda**

- IdentificationCard / IDENTIFICATION_CARD / 2025 r1

**United States of America**

- **New York**
  - IdentificationCard / CITY_IDENTIFICATION_CARD / 2021 r1

</Accordion>

***

## 2026 July 27

<Accordion title="2026 July 27">
  _Demo: 20 July 2026 | Production: 27 July 2026_

  ### Release Highlights

  The experience for configuring conditions in the Workflow builder has been redesigned. Now, when configuring a condition:

  - You can give the condition a name. This name appears on the condition node in the canvas. If no name is entered, the node displays "Condition."
  - The **Select module** dropdown includes a search field and filter chips (grouped by module type) alongside the full scrollable module list.&#x20;
  - _A&#x20;_**_Then_** drop-down sets the outcome when the condition is met, and an **_Otherwise_** dropdown sets the outcome when the condition is not met.&#x20;
  - After saving, the condition node in the canvas displays the first configured rule, along with **+N more** when additional rules exist. Hovering over the node shows a tooltip listing all configured rules.
  - The **Then** and **Otherwise** branches are labeled directly on the outgoing connectors in the canvas.

  For more detailed instructions and information on this new experience, refer to the [conditions](https://developer.incode.com/docs/conditions-for-workflows-20) documentation.

  ## Dashboard

  ### Enhancements

  ECOSYSTEM

  - The Identities page in Dashboard now shows all linked sessions for an Identity. Previously, the number of sessions displayed per Identity was limited.
  - A confirmation dialog now appears in Case Management when a reviewer selects **Pass** or **Fail**, matching the confirmation step already used during manual review decisions.
  - A new Auth0 integration tile is available in Integrations under the CIAM category, allowing configuration of Auth0 as a Workforce verification identity provider. Contact your Incode representative if you are interested in this feature.

  MODULES

  - There are two new settings in the Watchlist Business module configuration: **Include date of incorporation** and **Include tax ID**. When enabled, these fields are collected during onboarding and used as additional inputs for the watchlist search, which can help refine matches and reduce false positives. Availability depends on your configured watchlist provider. Contact your Incode representative if you are interested in this feature.
  - There is a new source for India available in eKYC configuration called **India DMV**. It checks an individual's submitted details (name, date of birth, national ID number, and address) against India's official driving-license records and returns per-field match results.
  - There is a new source for Nigeria available in eKYC configuration called **NG MONO BVN**. It checks an individual's submitted details (name, phone, date of birth, and TAX ID Number) against Nigeria's Bank Verification Number (BVN) records and returns per-field match results.
  - The Document Capture module now supports the Colombian RUT form. A new _Process Colombia RUT Form_ option is available in the **_Processing Type_** dropdown. When a RUT is submitted, key fields including **tax ID number**, **identification number**, and **name** are extracted and returned.

  RISK AI

  - Risk AI country coverage has expanded. Standard mode now supports Argentina and Brazil; shadow mode now supports Argentina, Brazil, Russia, the Philippines, and Venezuela.
  - When a Flow or Workflow has Risk AI Agent Shadow Mode enabled, the single Session view now includes a Risk AI Shadow tab that displays what Risk AI would have decided for the session. Contact your Incode representative if you are interested in this feature.

  GENERAL

  - <Pill type="hotfix" /> Users with the users:all custom permission can now create other users with custom permissions. They cannot create users with permissions higher than their own.

  ### Fixes

  ECOSYSTEM

  - Fixed a visual issue where a footer overlapped the page when the date filter was open on the Helpdesk Verification and Candidate Verification pages.
  - Fixed an issue on the Directory Information page where scrolling through a user's Sessions list could cause Sessions to disappear from the table.
  - Fixed an issue on the Helpdesk Verification page where searching for an employee by full name returned no results.
  - <Pill type="hotfix" /> Fixed an issue where Workforce Helpdesk Staff users were logged out of Dashboard when opening any session in certain Workforce verification organizations. These users can now open sessions normally.

  FLOWS

  - Fixed an issue in Flow builder where disabling the **_Mark session as Expired_** setting would not save. The setting can now be disabled and the change persists correctly.

  GENERAL

  - Fixed an issue where users with the Executive role could see Case Management in the left menu in Dashboard without having access to it, resulting in a 404 error. This option no longer appears for users without access.

  MODULES

  - Several improvements have been made to the Digital ID Acceptance dialog in ID Capture module configuration:
    - The header now reflects the current number of supported methods and countries
    - The search placeholder is clearer
    - Methods not yet available show a Coming Soon label, and methods requiring additional setup show a Contact Support label
    - Attribute count styling is now consistent
  - <Pill type="update" /> Fixed an issue where the Face Match Override Data Score setting was missing from the Government Record Verification module configuration for some Mexico INE setups. The setting is now available and applies correctly across INE connection types.

  SESSIONS

  - Fixed an issue where exporting session data as a CSV file could fail when sessions were filtered by Device IP, Device Hash, or Device Model. The export now completes successfully with these filters applied.
  - Fixed an issue in the Face Authentication tab in single Session view where the **X** on the Face Match comparison dialog was not clickable for sessions with more than one Face Authentication attempt.
  - Fixed an issue in the Event Log section in single Session view where icons for certain event types were not centered. All Event Log icons are now aligned.
  - Fixed an issue where the location map image could be missing from a session's exported PDF. The map image is now included as expected.
  - Fixed an inconsistency in single Session view where the motion result shown in the Face Authentication tab could differ from the Behavior result in the Deepsight tab for the same session. Both now use the same source and stay consistent.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  - The login hint field in the Forms and Data Entry module has been improved:
    - It can now be prepopulated by passing a `login_hint` value as a URL parameter in the Onboarding link.
    - The field label now reads "Work email or employee ID" for clarity.
    - Repeated sign-in attempts are now limited: the first few attempts show a retry message, after which the user is prompted to contact their administrator.
    - Tickets
      - Form Module - Login Hint should be prepopulated
      - Form Module - Login Hint improvements
  - The eKYC onboarding form now uses a modernized, multi-screen layout that groups related fields: for example, name, phone, and date of birth on one screen and address on another. This applies to both Flows and Workflows.
  - Updated the loading spinner on UXv2 webflows to the platform's standard design-system spinner.
  - When a Flow or Workflow collects phone or email through the Phone Input or Email Input modules, the eKYC Phone Risk, Advanced Phone Risk, and Email Risk sources now automatically use those values rather than prompting the end user to enter them again. These checks run in the background. This behavior applies when Country is set to Global in the eKYC module.
  - Onboarding now includes strengthened protection against manipulated or injected camera feeds. This applies across every capture step that uses the camera, including ID capture, document capture, Proof of Address, selfie and video selfie, QR and fiscal-code scanning, and face login. Genuine users see the same capture experience as before.
  - <Pill type="update" /> Onboarding now loads faster in the browser. Files the onboarding session needs are delivered more efficiently, so the browser downloads less data on the first load. This is most noticeable for end users on slower or constrained mobile networks.

  ### Fixes

  - Fixed an issue in Onboarding where the ID capture frame could appear blank after an unsuccessful manual capture. A new capture attempt now displays correctly.
  - Fixed an issue in Workflows where enabling the **_Use as selfie_** option in the Video Selfie module could cause the session to fail. This feature, previously available in Flows, now works correctly in Workflows as well.
  - Fixed the French-language wording on the ID capture screen in Onboarding. The screen previously referred specifically to an identity card; it now refers to a document, which better matches the range of documents the step accepts.

  ***

  ## Server

  ### Enhancements

  - Aadhaar numbers are now automatically redacted from results and document images for India Aadhaar identity documents to support local compliance requirements. Other Indian document types are unaffected.
  - The Indonesian national identification number (NIK) is now automatically redacted from results and document images for the Indonesia identity card. Other Indonesian document types are unaffected.
  - Colombia identity card extractions now include three additional fields: printing number, duplicate number, and preparation number. These informational values are returned alongside existing extracted fields.
  - The Proof of Address `fiscalQrUrlResponse` and `addressComponents` responses no longer return `streetType` as an empty string when the value is not extracted. The field is now omitted entirely, matching the convention used elsewhere in the response.
  - Improved Colombia Gov Validation to distinguish a genuine "not found" result from a provider outage or maintenance window. During an outage, the check is now treated as inconclusive and is eligible for retry instead of being returned as a failed match.
  - <Pill type="update" /> Onboarding now loads faster in the browser. Files the onboarding session needs are delivered more efficiently, so the browser downloads less data on the first load. This is most noticeable for end users on slower or constrained mobile networks.
 Watchlist screening can now surface matches against a customer's own uploaded list, in addition to standard watchlist sources. When the configured watchlist provider returns a hit against such a list, the match and its source appear in the watchlist results, including in the single Session Risk tab. Availability depends on your configured watchlist provider. Contact your Incode representative for more information.

  ### Fixes

  - INE facial Gov Validation now distinguishes a temporary INE service outage from a genuine face-match failure in the response, so integrators can tell the two apart programmatically.
  - Fixed an increase in first-name mismatches in INE facial Gov Validation caused by names being truncated in the document's machine-readable zone. The full name is now used for matching.
  - Improved US eKYB address verification so the address match result is consistent with the city and postal code results. Previously, the address could show as verified while the city or postal code did not. Address matching now returns Match, Approximate Match, or No Match aligned with those checks.
  - Fixed an issue where an ID number entered in the Forms and Data Entry module did not override the Session’s existing customer ID, which could cause incorrect Custom Watchlist matching results.
  - Nigeria NIN Gov Validation now returns a distinct not-found result when a National Identification Number (NIN) cannot be matched, instead of a generic service error, so integrators can tell a genuine not-found outcome apart from a service connection failure.

  ***

  ## ML

  - The document verification models have been updated. This release includes:
    - Accuracy improvements to fraud, tampering, and liveness detection models
    - A new visual anomaly detection capability for identity documents
    - Risk AI now supports Venezuela, Russia, and the Philippines
      Expected behavior changes are concentrated in the following document types: Venezuelan and Canadian paper documents (liveness), Mexican INE 2026 and Philippine driver's license 2023 (tampering), and Colombian ID 2000 (fraud and alteration checks).

  - Improved detection of documents that are only partially visible within the capture frame during ID capture. Partially out-of-frame documents are now identified more accurately, prompting the end user to retry.

  - <Pill type="update" /> Onboarding now loads faster in the browser. Files the onboarding session needs are delivered more efficiently, so the browser downloads less data on the first load. This is most noticeable for end users on slower or constrained mobile networks.
 The face liveness models used during the selfie step have been updated to reduce cases where genuine users are incorrectly rejected, including users with medical patches on the face. Spoof protection is maintained. Expected behavior changes are concentrated in selfie captures involving partial face coverings.

  ***

  ## ID Templates

  ### New supported templates

  **Andorra**

  - DriversLicense / DRIVERS_LICENSE / 2025

  **Brazil**

  - FederalID / DIGITAL_IDENTIFICATION_CARD_PDF / 2026

  **Canada**

  - **British Columbia**
    - MedicalCard / SERVICES_CARD / 2022

  **Mexico**

  - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2026

  **South Sudan**

  - Visa / VISA / 2013

  **United States of America**

  - **Florida**
    - Other / FIREARMS_LICENSE / 2025

  ### Changes to current templates

  FEATURE UPDATE

  **Guatemala**

  - IdentificationCard / IDENTIFICATION_CARD / 2016 r6
  - ResidenceDocument / RESIDENCE_PERMIT / 2000 r2
  - ResidenceDocument / RESIDENCE_PERMIT / 2011 r2

  **Indonesia**

  - IdentificationCard / IDENTIFICATION_CARD / 2021 r1

  **Kenya**

  - IdentificationCard / IDENTIFICATION_CARD / 2011 r8

  **Norway**

  - DriversLicense / DRIVER_LICENSE / 2007 r1

  **United States of America**

  - **North Dakota**
    - DriversLicense / LEARNERS_PERMIT_UNDER21 / 2023 r1
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2023 r1

  ID CLASSIFICATION IMPROVEMENT

  **Brazil**

  - DriversLicense / DIGITAL_DRIVERS_LICENSE_PDF / 2020
  - FederalID / DIGITAL_IDENTIFICATION_CARD_PDF / 2024 r1
  - FederalID / DIGITAL_IDENTIFICATION_CARD_PDF / 2025 r1

  **Canada**

  - **Alberta**
    - DriversLicense / DRIVER_LICENSE / 2018

  **Panama**

  - ResidenceDocument / RESIDENCE_PERMIT / 2024 r3

  **Portugal**

  - Passport / NATIONAL_PASSPORT / 2018 r3

  **South Korea**

  - DriversLicense / DRIVER_LICENSE / 2020

  ID OCR EXTRACTION IMPROVEMENT

  **Argentina**

  - IdentificationCard / IDENTIFICATION_CARD / 2015 r9
  - IdentificationCard / IDENTIFICATION_CARD / 2023 r5

  **Bolivia**

  - Passport / NATIONAL_PASSPORT / 2018 r4

  **Brazil**

  - FederalID / DOMESTIC_IDENTIFICATION_CARD / 1967 r1
  - FederalID / POLICE_IDENTIFICATION_CARD / 2017 r1

  **Canada**

  - **Ontario**
    - MedicalCard / MEDICAL_CARD / 2020 r7

  **Colombia**

  - IdentificationCard / IDENTIFICATION_CARD / 2000 r9
  - IdentificationCard / MINORS_ID / 2008 r6

  **El Salvador**

  - IdentificationCard / IDENTIFICATION_CARD / 2000 r4

  **Guatemala**

  - IdentificationCard / IDENTIFICATION_CARD / 2016 r3

  **India**

  - IdentificationCard / MASKED_IDENTIFICATION_CARD / 2015 r1
  - Passport / NATIONAL_PASSPORT / 2019 r4
  - TaxIdentification / TAX_DEPARTMENT / 2015 r1

  **Italy**

  - IdentificationCard / IDENTIFICATION_CARD / 2016 r3

  **Netherlands**

  - DriversLicense / DRIVER_LICENSE / 2025 r3

  **Nicaragua**

  - Passport / NATIONAL_PASSPORT / 2012 r3

  **Panama**

  - ResidenceDocument / RESIDENCE_PERMIT / 2024 r2

  **Paraguay**

  - IdentificationCard / IDENTIFICATION_CARD / 2023 r4

  **Philippines**

  - IdentificationCard / IDENTIFICATION_CARD / 2021 r5
  - IdentificationCard / IDENTIFICATION_CARD / 2023 r1
  - Other / NBI_CLEARANCE / 2020 r2
  - Other / PHILPOST / 2020 r1

  **Puerto Rico**

  - DriversLicense / DRIVERS_LICENSE / 2018 r3

  **Slovakia**

  - IdentificationCard / IDENTIFICATION_CARD / 2022 r1

  **Spain**

  - ResidenceDocument / RESIDENCE_DOCUMENT / 2017 r1

  **Trinidad and Tobago**

  - Passport / NATIONAL_PASSPORT / 2016 r1

  **United States of America**

  - **Michigan**
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2024 r1
  - **Montana**
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2025 r2
  - **Oklahoma**
    - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2026 r1
    - IdentificationCard / IDENTIFICATION_CARD_UNDER21 / 2026 r1

  SENSITIVE PII REDACTION

  **India**

  - IdentificationCard / IDENTIFICATION_CARD / 2005 r9
  - IdentificationCard / IDENTIFICATION_CARD / 2010 r1
  - IdentificationCard / IDENTIFICATION_CARD / 2015 r4
  - IdentificationCard / MASKED_IDENTIFICATION_CARD / 2005 r2
  - IdentificationCard / MASKED_IDENTIFICATION_CARD
</Accordion>

***

## 2026 July 13

<Accordion title="2026 July 13">
  _Demo: 6 July 2026 | Production: 13 July 2026_

  ## Dashboard

  ### Enhancements

  eKYB

  - KYB company verification is now available for India. You can select India for KYB onboarding and submit a business using its tax ID (CIN, LLPIN, or UDYAM), business name, and address, then view the verification results, including company directors. Ultimate Beneficial Owner (UBO) data is not yet supported for India.
  - <Pill type="update" /> KYB pre-fill is now available for Mexico. In eKYB module configuration, you can choose between Verification (existing functionality) or Prefill (new functionality) for the end user experience. When Prefill is selected, the end user enters their RFC and the system performs a lookup to pre-fill the business details. The Business tab in single Session view displays the submitted RFC and the returned details. This functionality is currently only available for Flows.

  SINGLE SESSION VIEW

  - A new _Login Hint_ column is now shown in the Sessions table, and the login hint is also displayed in the session summary at the top of the single session view. Both remain visible even after the session's PII data has been deleted.
  - The single session view now shows a dedicated experience for sessions created from a digital ID. The ID Verification section displays a "Digital ID" badge, and a placeholder appears in place of the captured document image. Existing sessions created from captured documents are unaffected.

  ECOSYSTEM

  - <Pill type="update" /> Identities and Directory information are now linked in Ecosystem. The Directory information view supports filtering by Identity ID and shows the associated Identity for each entry, with a link from each entry to the corresponding Identity page. A single Identity now includes a Directory information section showing the corresponding directory entry.

  GENERAL

  - A new Webhook Custom Body Parameters section is now available in **Configuration** > **Webhooks**, alongside the existing Webhook Custom Headers section. Any key/value pairs you add are included in the OAuth token request sent to your authorization server. This is useful for passing values such as scope, audience, resource, or a tenant identifier.
  - You can now assign a case to yourself in the Case Management System. Your own user now appears in the assignee dropdown when you have permission to assign cases.

  ### Fixes

  - Fixed an issue in Ecosystem where a newly added employee did not appear on the Services > Directory information page until an Okta Directory or Microsoft Entra sync was performed. Such employees are now visible immediately.
  - Fixed an issue in Ecosystem where an identity created through a Helpdesk or Candidate verification was not always recognized in later sessions or verifications for the same user. When this happened, a duplicate identity could be created for the same person. This issue surfaced in organizations configured to delete session PII immediately. Affected sessions are now correctly linked to the existing identity.
  - Fixed an issue on the Deepsight tab of the single session view where a video preview could not be played in Safari. Videos now play correctly in the browser across supported browsers.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  - An optional **Apartment** field is now available in the onboarding form for supported US and Argentine eKYC sources. When provided, the apartment or unit value is included as part of the address sent for verification.

  ### Fixes

  - Fixed an issue where the **Show preview** option in the Face Capture module was not respected on desktop browsers. The captured image preview is now shown on desktop as configured, consistent with mobile.
  - Fixed an issue during assisted onboarding where the captured selfie could appear mirrored on the _Show preview_ screen. The preview now shows the image in the correct orientation.
  - Fixed an issue where retrying ID capture on some Android devices left the user on a loading screen instead of reopening the camera. The camera now reopens correctly on retry.
  - Fixed an issue where scanning the same QR code a second time could show a blank screen instead of the failure result. The correct failure screen is now shown when the QR code has expired.
  - Fixed an issue where the selfie capture oval could be cut off at the bottom on smaller screens during onboarding. The selfie oval is now fully visible.
  - Fixed an issue where the data sharing consent could display in the default language instead of the language selected during onboarding. Consent now displays in the selected language when available, including for region-specific language codes such as "de-DE". It falls back to the default only when no matching language is configured.

  ***

  ## Server

  ### Enhancements

  - <Pill type="update" /> Brazil KYB company verification now supports the new alphanumeric CNPJ tax ID format taking effect in 2026, in addition to the existing numeric format. Business lookups can be submitted using either format.

  ### Fixes

  - Fixed an issue where the score API returned an incomplete failure reason when a session failed due to Face Authentication. The full failure reason is now returned consistently with what is shown in Dashboard.
  - Improved address and postal code match accuracy for eKYB company verification, reducing false Unverified results for valid businesses. This includes matching Malta postal codes correctly regardless of spacing (for example, "ABC 1234" or "ABC1234") and comparing addresses across the eKYB company lookup responses to find the best match.
  - Fixed an issue where Brazil eKYC could fail with a server error. These sessions are now processed correctly.
  - Fixed an issue where adding a face could intermittently fail with a server error when multiple onboarding attempts occurred at the same time. Concurrent attempts are now handled reliably.
  - Fixed an issue where the vertical document number printed on the right side of Russian passports was not extracted correctly. OCR now reads this number reliably during document processing.
  - Fixed an issue where a failed 1:1 Face Authentication attempt returned a server error instead of a proper failed-verification result. These attempts now return the correct failure response, consistent with 1:N behavior.
  - Fixed an issue where sessions over 5 MB did not appear in Dashboard. Large sessions now appear as expected.
  - <Pill type="update" /> Fixed an issue in Ecosystem where a completed identity verification could send duplicate `SESSION_SUCCEEDED` webhook events. A single event is now sent per completed session.
  - <Pill type="update" /> Fixed an issue affecting the British Columbia Services Card (2022) where the document number crosscheck and expiration year crosscheck did not populate even though both values were present on the document. Both crosschecks now populate and pass correctly for this document type. No other document types are affected.

  ***

  ## ML

  - Deepfake and synthetic-media detection has been improved, increasing detection of AI-generated and manipulated selfie images during verification.
  - <Pill type="update" /> Video injection attack detection has been improved, catching a wider range of manipulated or injected video during selfie verification.

  ***

  ## ID Templates

  ### New supported templates

  NEW CLASSIFICATION SUPPORT

  - **Burkina Faso**
    - IdentificationCard / IDENTIFICATION_CARD / 2026
  - **Iraq**
    - Military / MILITARY_CARD / 2026
  - **Jordan**
    - IdentificationCard / IDENTIFICATION_CARD / 2025
  - **Mexico**
    - **Puebla**
      - DriversLicense / DRIVERS_LICENSE / 2026
  - **Turkey**
    - Permit / WORK_PERMIT / 2025
  - **United States of America**
    - TribalIdentification / ENHANCED_TRIBAL_IDENTIFICATION_CARD / 2026
    - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1831
    - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1832
    - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1833
    - TribalIdentification / TRIBAL_IDENTIFICATION_CARD / 1834
    - **Georgia**
      - VoterIdentification / VOTER_IDENTIFICATION_CARD / 2022
    - **Mariana Islands**
      - Other / DRIVERS_LICENSE_UNDER21 / 2025

  NEW ID SUPPORT

  - **Cambodia**
    - Passport / TRAVEL_DOCUMENT / 2023
  - **Canada**
    - **Alberta**
      - DriversLicense / DRIVER_LICENSE / 2026
      - IdentificationCard / IDENTIFICATION_CARD / 2026
  - **Colombia**
    - ResidenceDocument / PEP_TUTOR / 2026
  - **Dominican Republic**
    - DriversLicense / DRIVERS_LICENSE / 2026
  - **Portugal**
    - IdentificationCard / IDENTIFICATION_CARD_FOR_FOREIGNERS / 2024
  - **United Kingdom**
    - Passport / NATIONAL_PASSPORT / 2025
  - **United States of America**
    - **USCIS**
      - TravelDocument / TRAVEL_DOCUMENT / 2010
      - TravelDocument / TRAVEL_DOCUMENT / 2017

  ### Changes to current templates

  FEATURE UPDATE

  - **Luxembourg**
    - DriversLicense / DRIVERS_LICENSE / 2013 r1
  - **Russia**
    - Passport / NATIONAL_PASSPORT / 2008 r5

  ID CLASSIFICATION IMPROVEMENT

  - **Haiti**
    - Passport / NATIONAL_PASSPORT / 2017
  - **India**
    - **Karnataka**
      - DriversLicense / DRIVERS_LICENSE / 2005
  - **Nigeria**
    - IdentificationCard / IDENTIFICATION_CARD / 2016 r3
  - **Saudi Arabia**
    - ResidenceDocument / RESIDENCE_PERMIT / 2020 r1
    - ResidenceDocument / RESIDENCE_PERMIT / 2024 r1

  ID OCR EXTRACTION IMPROVEMENT

  - **Dominican Republic**
    - IdentificationCard / IDENTIFICATION_CARD / 2026 r1
  - **Guatemala**
    - Passport / NATIONAL_PASSPORT / 2016 r4
  - **Honduras**
    - IdentificationCard / IDENTIFICATION_CARD / 2020 r4
  - **Ivory Coast**
    - IdentificationCard / IDENTIFICATION_CARD / 2020 r3
  - **Mexico**
    - **Hidalgo**
      - DriversLicense / DRIVERS_LICENSE / 2022 r1
  - **Nigeria**
    - IdentificationCard / IDENTIFICATION_CARD / 2016 r3
  - **Philippines**
    - MedicalCard / MEDICAL_CARD / 2010 r3
  - **Saudi Arabia**
    - ResidenceDocument / RESIDENCE_PERMIT / 2015 r2
    - ResidenceDocument / RESIDENCE_PERMIT / 2020 r1
    - ResidenceDocument / RESIDENCE_PERMIT / 2024 r1
  - **United States of America**
    - **California**
      - IdentificationCard / IDENTIFICATION_CARD / 2025 r2
    - **Montana**
      - IdentificationCard / IDENTIFICATION_CARD / 2025 r2
    - **Oklahoma**
      - DriversLicense / LEARNERS_PERMIT / 2026 r1
    - **South Carolina**
      - DriversLicense / DRIVERS_LICENSE_UNDER21 / 2025 r1
    - **US Department of State**
      - Visa / VISA_ALLAGES / 2023 r2
      - Visa / VISA_ALLAGES / 2024 r1

  SENSITIVE PII REDACTION

  - **Netherlands**
    - ResidenceDocument / RESIDENCE_PERMIT / 2026 r1
</Accordion>

***

## 2026 June 29

<Accordion title="2026 June 29">
  _Demo: 22 June 2026 | Production: 29 June 2026_

## Dashboard

### Enhancements

ECOSYSTEM

- A ServiceNow integration type is now available in Ecosystem. When configuring a ServiceNow integration, you provide a client ID, client secret, and workflow ID.
- The Candidate Verification table in Ecosystem now shows the verification expiration date and time, so you can see at a glance when a candidate's verification expires.
- The Directory Information page in Ecosystem has been redesigned to align with the Integrations experience. It now has a **People** tab (directory members, with faster search by name, email, or username) and a **Directories** tab (connected directories with their status and last-synced time), along with a cleaner single-person profile.
- When the Hide images setting is enabled for Ecosystem, verification images are no longer displayed in the Dashboard for any session outcome.
- Ecosystem self-service verification workflows now support directory-based recovery. You can configure this using the Forms and Data Entry module and the Identity Search module:
  - Forms and Data Entry: There is a new pre-defined question to collect a **Login hint**.
  - Identity Search: There is a new **_Search Type_** for _Directory_ that looks up a user's directory from the login hint.
    New workflow conditions let you branch on whether a matching directory was found, and a ready-made _Self-Service Reset & Recovery_ template is available.

eKYC

- eKYC is now available for the Philippines. You can configure the new source in the eKYC module to verify an individual by name, date of birth, address, and ID number (TIN, SSS, or GSIS). The address fields collected during Onboarding now include a new _District_ field, commonly required for Philippine addresses, and a corresponding _District Match_ result appears in the session results view alongside the other address match results.
- A new **Argentina - Resident Register** eKYC source is now available when configuring the eKYC module. The onboarding form collects the individual's name, and optionally date of birth, address, and gender, to verify identity for Argentine residents.

GENERAL

- The Sessions list now lets you analyze sessions by device. _Device Model_ is available as a filter within the _Device Data_ section of the filter panel. This filter is only available for sessions created after this release.
- Colombia birth certificates are now supported as a document type. Their extracted data is displayed in single session view, including the holder's national number, full name, date of birth, and place of birth, along with the registered mother's and father's full names and national numbers.

### Fixes

- Fixed an issue in the Event Log in single session view where client events were displayed with the green icon used for system events instead of the purple client-event icon.
- Fixed an issue in the Workflow builder where changes to a Global Watchlist module's configuration were not saved. Configuration changes now persist correctly.
- Fixed an issue where the eKYC results were not displayed in the session results view when eKYC ran together with phone or email risk add-ons. Both eKYC and risk add-on results are now shown.
- Fixed an issue where the Deepsight tab did not display the captured selfie for Face Authentication sessions. The captured image is now shown.
- Fixed an issue where the Risk AI Agent and Risk AI Agent Shadow Mode could both be enabled at the same time. Now, enabling one automatically disables the other.

***

## Web App (Onboarding)

### Fixes

- Fixed an issue in document capture where the onboarding flow ended prematurely instead of advancing to the next module after three unsuccessful capture attempts.
- Fixed an issue where the "Unknown" geolocation status was not translated into the selected onboarding language.
- Fixed a visual issue during selfie capture on certain devices where the capture progress indicators overlapped the camera frame.
- Fixed an issue where the onboarding completion screen displayed the wrong success message after a Mexican INE voter ID government scraping check. The correct success message is now shown.
- Fixed an issue during eKYC where address auto-filled from the ID did not populate the individual address fields and instead placed everything in a single line. The address components (street, city, postal code, and so on) are now filled in correctly.

***

## Server

### Enhancements

- Webhooks now support multiple destinations for the same event type, each with its own authentication. You can register several endpoints for a single event and configure separate credentials per destination. Existing single-destination webhooks continue to work unchanged.
- New watchlist match score variables are now available in Business Rules, letting you build AML risk rules based on the confidence of a watchlist match. Separate scores are provided for sanctions lists and warning lists, and the watchlist risk level now returns a meaningful value. When there is no match, the score defaults to zero so rules evaluate safely.
- KYB company verification now covers Lithuania. You can verify a Lithuanian company by its registration number (Company Code) or VAT number, with verification of company name, registration status, address, directors, and Ultimate Beneficial Owners (UBOs).
- A document configuration can now have barcode reading turned off. This is useful for documents whose barcodes cannot be reliably read, avoiding unnecessary barcode-related check failures.
- <Pill type="update" /> Error code definitions and response statuses for the Colombia Government Verification module changed in June 2026. These changes improve result explainability, reduce ambiguity, and make it easier to interpret session outcomes in Dashboard and via API responses. For more details on these changes, see Error Code Changes for Colombia. Review the status changes carefully. If your implementation uses the impacted error codes for downstream decisioning logic or alerting, you must update your logic.
- <Pill type="update" /> Improved error handling when attaching a signature to a PDF. If the requested page number is outside the document's page range, the request now returns a clear validation error instead of failing with a server error.
- <Pill type="update" /> Session and customer data deletion now also removes Claim Match Result PII data, ensuring this data is fully cleared in line with your data-deletion and retention settings.

### Fixes

- Fixed an intermittent issue where an Ecosystem authorization request could fail with a server error, preventing the user from completing verification. These requests are now processed reliably.
- Fixed an issue where deleting a session via API key removed the associated images but left the document OCR data visible on the Dashboard. Session deletion now removes all associated session data, including OCR results.
- Fixed an issue where rate-limited upstream requests could surface as a generic 400 or 500 error in API responses. Rate-limiting is now correctly propagated as a 429 response, so integrators can detect and handle it appropriately.
- Fixed an issue where sessions using the Video Selfie module with the Use as a selfie option enabled (and no Face Match module) could fail during scoring. These sessions are now scored correctly.
- <Pill type="update" /> Fixed an issue where approving or rejecting a session in manual review could intermittently fail with a server error. Manual review actions now complete reliably.
- <Pill type="update" /> The `SESSION_FAILED` webhook payload now includes a `failureReasons` field. This field provides a stable, deduplicated list of identifiers describing why a session failed, covering module-level reasons (for example, ID Validation, liveness, or Government Validation) as well as outcomes like manual rejection or an expired session link. This lets you programmatically determine the cause of a failure.
- <Pill type="update" /> Fixed an issue in Flows where Face Authentication could force the session's total score to zero when a new user attempted step-up onboarding, preventing identity creation. When a Flow includes a Face Match module to handle this case, Face Authentication no longer affects the total score for new users, allowing the session to be approved and the identity created.

***

## ML

- Improvements to document validation, including expanded barcode support and enhanced fraud detection.
- Improved the reliability of barcode reading during document processing, ensuring barcode data is read correctly.
- Enhanced anti-spoofing detection during selfie capture.

***

## ID Templates

### New supported templates

NEW CLASSIFICATION SUPPORT

- **Costa Rica**
  - IdentificationCard / TARJETA\_DE\_IDENTIDAD\_DE\_MENORES / 2026
- **El Salvador**
  - IdentificationCard / IDENTIFICATION\_CARD / 2026
- **Guyana**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025
- **Ivory Coast**
  - Permit / WORK\_PERMIT / 2025
- **Mexico**
  - **Chihuahua**
    - DriversLicense / DRIVERS\_LICENSE / 2024
  - **Veracruz**
    - DriversLicense / DRIVERS\_LICENSE / 2026
- **Mozambique**
  - TravelDocument / CONSULAR\_CARD / 2025
- **Sudan**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025
- **United States of America**
  - **New York**
    - IdentificationCard / CITY\_IDENTIFICATION\_CARD / 2021
  - **Oklahoma**
    - DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2026
  - **Wyoming**
    - IdentificationCard / IDENTIFICATION\_CARD / 2004

NEW ID SUPPORT

- **Antigua and Barbuda**
  - MedicalCard / SOCIAL\_SECURITY\_BOARD / 2022
- **Argentina**
  - DriversLicense / DRIVERS\_LICENSE / 2006
  - DriversLicense / DRIVERS\_LICENSE / 2007
- **Brazil**
  - FederalID / MILITAR\_IDENTIFICATION\_CARD / 2023
- **Cambodia**
  - DriversLicense / DRIVERS\_LICENSE / 2022
- **Fiji**
  - DriversLicense / PROVISIONAL\_DRIVERS\_LICENSE / 2010
- **Georgia**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025
- **Greece**
  - IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2020
- **Israel**
  - TravelDocument / TEMPORARY\_IMMIGRATION\_CERTIFICATE / 2010
- **Oman**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025
- **Philippines**
  - Military / MILITARY\_CARD / 2019
- **Sudan**
  - DriversLicense / DRIVERS\_LICENSE / 2017
- **United States of America**
  - **Alaska**
    - DriversLicense / DRIVERS\_LICENSE / 2025
    - DriversLicense / LEARNERS\_PERMIT / 2025
  - **Illinois**
    - Other / IDENTIFICATION\_CARD / 2000
  - **Nebraska**
    - DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2026
    - DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2026
    - DriversLicense / LEARNERS\_PERMIT / 2026
    - IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2026
    - IdentificationCard / IDENTIFICATION\_CARD / 2026
- **Tribal Identification**
  - TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1862
  - TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1958
- **Venezuela**
  - Military / MILITARY\_CARD / 2020

### **Changes to current templates**

FEATURE UPDATE

- **Austria**
  - DriversLicense / DRIVER\_LICENSE / 2010 r2
  - DriversLicense / DRIVER\_LICENSE / 2013 r1
- **Croatia**
  - DriversLicense / DRIVERS\_LICENSE / 2013 r1
  - DriversLicense / DRIVERS\_LICENSE / 2024 r1
- **Estonia**
  - DriversLicense / DRIVERS\_LICENSE / 2020 r1
- **Gibraltar**
  - DriversLicense / DRIVERS\_LICENSE / 2023 r1
- **Greece**
  - DriversLicense / DRIVERS\_LICENSE / 2023 r2
- **Ireland**
  - DriversLicense / DRIVER\_LICENSE / 2013 r2
  - DriversLicense / LEARNER\_PERMIT / 2013 r2
- **Lithuania**
  - DriversLicense / DRIVERS\_LICENSE / 2010 r1
    - Lithuania|ALL|DriversLicense|DRIVERS\_LICENSE|2010 r1
- **Luxembourg**
  - DriversLicense / DRIVERS\_LICENSE / 2013 r1
- **Romania**
  - DriversLicense / DRIVERS\_LICENSE / 2013 r1
- **Slovakia**
  - DriversLicense / DRIVERS\_LICENSE / 2013 r1
- **Sweden**
  - DriversLicense / DRIVERS\_LICENSE / 2007 r1
  - DriversLicense / DRIVERS\_LICENSE / 2025 r1

ID CLASSIFICATION IMPROVEMENT

- **Malawi**
  - Passport / NATIONAL\_PASSPORT / 2021 r3
- **Nepal**
  - ResidenceDocument / RESIDENCE\_PERMIT / 2010
- **Sri Lanka**
  - Passport / NATIONAL\_PASSPORT / 2015 r2

ID OCR EXTRACTION IMPROVEMENT

- **Belgium**
  - IdentificationCard / IDENTIFICATION\_CARD / 2014 r3
- **Canada**
  - **Alberta**
    - DriversLicense / DRIVER\_LICENSE / 2009 r2
    - DriversLicense / DRIVER\_LICENSE / 2018 r5
- **Chile**
  - IdentificationCard / IDENTIFICATION\_CARD / 2000 r1
  - IdentificationCard / IDENTIFICATION\_CARD / 2007 r2
  - IdentificationCard / IDENTIFICATION\_CARD / 2024 r9
- **Greece**
  - IdentificationCard / DOMESTIC\_IDENTIFICATION\_CARD / 2016 r3
- **India**
  - **West Bengal**
    - DriversLicense / DRIVERS\_LICENSE / 2024 r1
- **Kenya**
  - IdentificationCard / IDENTIFICATION\_CARD / 2011 r6
- **Malawi**
  - Passport / NATIONAL\_PASSPORT / 2021 r3
- **Mozambique**
  - Passport / NATIONAL\_PASSPORT / 2020 r1 (Incode MRZ)
- **Poland**
  - IdentificationCard / IDENTIFICATION\_CARD / 2015 r4
  - IdentificationCard / IDENTIFICATION\_CARD / 2019 r6
- **Sri Lanka**
  - Passport / NATIONAL\_PASSPORT / 2015 r2
- **Taiwan**
  - IdentificationCard / NATIONAL\_IDENTIFICATION\_CARD / 2005 r1
- **Uganda**
  - DriversLicense / DRIVERS\_LICENSE / 2018 r2
  - DriversLicense / DRIVERS\_LICENSE / 2021 r2
- **United Kingdom**
  - DriversLicense / DRIVER\_LICENSE / 2015 r3
  - DriversLicense / DRIVER\_LICENSE / 2022 r3
  - DriversLicense / PROVISIONAL\_DRIVER\_LICENSE / 2015 r2
  - DriversLicense / PROVISIONAL\_DRIVER\_LICENSE / 2021 r2&#x20;
</Accordion>

***

## 2026 June 15

<Accordion title="2026 June 15" >
  _Demo: 8 June 2026 | Production: 15 June 2026_

## Dashboard

### Enhancements

GENERAL

- A new popup is displayed to all Dashboard users announcing Incode’s new SDK deprecation policy. The banner can be permanently dismissed and includes a link to the full deprecation policy and timeline. We encourage you to review the policy and timeline before your next release cycle to plan any necessary updates to your integration. For more information about the deprecation policy, see SDK Deprecation Policy and Timeline.
- The maximum configurable data deletion period has been extended from 500 to 1096 days (3 years). Organizations can now set data retention periods of up to 3 years, matching the platform-wide maximum.
- When submitting a False Rejection or False Approval decision, the issue selection dropdown now dynamically shows only the categories relevant to the modules that ran in that session. There are three new issue categories available for False Rejection: Deepsight, Risk AI, and Antifraud. Government Validation has been removed as an option for False Approval.

SINGLE SESSION VIEW

- The Risk AI section in the single session view now displays enhanced explainability information, including a response category (High or Low Confidence Fraud or Legit), the top contributing factors that indicate fraud risk, and the top factors that support a legitimate result.

FLOWS & WORKFLOWS

- On organizations with the updated onboarding design (UXv2) enabled, the **Enable new user experience** setting is now turned on by default when creating a new Workflow, consistent with the existing behavior for Flows.

MODULES

- There is a new setting in both the Email and Phone Input modules in Workflows. The settings are called **Skip if email already collected** (in the Email Input module) and **Skip if phone number already collected** (in the Phone Input module). When enabled, the module is automatically skipped in Onboarding if the relevant contact information has already been collected in the current session. Contact your Incode representative if you are interested in this feature.
- When configuring an eKYC module with the country set to Global, at least one Risk Add-On source must now be selected before the configuration can be saved. Previously it was possible to save the module with no sources selected, resulting in onboarding sessions with no data collection.
- The eKYC module in the Workflow builder now supports display mode configuration for fields sourced from ID OCR or Proof of Address. Each field can be set to Editable (default, preserving existing behavior), Read-only (pre-filled and visible but not editable by the end user), or Hidden (not shown during onboarding). Fields sourced from user input are unaffected. If data extraction fails for a field configured as Read-only or Hidden, the field automatically becomes editable so the end user can enter the required value and continue. This option was previously available in Flows only.
- A new **Exclude ID photo from matching** setting is available in the Custom Watchlist module configuration. When enabled, watchlist matching runs against the onboarding selfie only, rather than both the selfie and ID photo. Contact your Incode representative if you are interested in this feature.
- A new **External Decision** process is now available in the Workflow builder. It calls a configured external endpoint during workflow execution and exposes the returned decision value as a named variable for use in Conditions. Contact your Incode representative if you are interested in this feature.
- A new **Exact face match check** setting is now available in the Face Authentication module configuration for both Flows and Workflows. When enabled, the module performs an additional check to detect the use of identical selfies across authentication and onboarding sessions as a fraud prevention measure. The setting is disabled by default. Contact your Incode representative if you are interested in this feature.

### Fixes

- Fixed an issue where creating and publishing a new Workflow failed on organizations that do not have the updated onboarding design (UXv2) enabled. New Workflows can now be saved and published successfully on all organization types.
- Fixed an issue where candidates could not be deleted. Deleted candidates are now removed from the candidate selection dropdown and their sessions are filtered from the candidate sessions view. Underlying session data is preserved and restored if a candidate is re-added with the same login hint.
- <Pill type="update" /> Fixed an issue in the Flow builder where adding the Government Record Verification or Custom Fields module from a module's Related modules tab caused the page to crash. These modules can now be added without error.

***

## Web App (Onboarding)

### Enhancements

- Made several accessibility improvements to the Workforce onboarding redirection screen to better comply with WCAG guidelines. Updates include proper heading hierarchy, ARIA roles for QR code and decorative images, and visual improvements to the Continue on Desktop button so it is distinguishable as an interactive element without relying on color alone.

### Fixes

- Fixed an issue in the KYB onboarding form where UBO and Director entries with only a first name or last name were not submitted correctly. Both single-component and full names are now included as expected.
- Fixed an issue where entering a phone number before switching to email input caused the Continue button to remain disabled even after a valid email was entered. The button now correctly enables after a valid email is provided.
- Fixed a layout issue on the selfie processing failure screen where the "Verified by Incode" badge overlapped the attempt counter text, making the remaining attempts count partially unreadable.
- Fixed two visual issues in the onboarding experience: a white background appearing on the verification details screen and the app version number in the footer is now positioned statically next to the Incode logo rather than scrolling with the page content.
- Fixed an accessibility issue with the date picker in CURP onboarding flows that prevented VoiceOver users from opening the picker using a double tap gesture. The date picker now correctly responds to VoiceOver interactions and focus moves into it once opened.
- Resolved multiple accessibility issues on the web onboarding start screen and settings flow. Updates include proper page heading structure, correct ARIA roles for images, keyboard-accessible settings modal with focus trapping, and a fully accessible language selector that can be operated using a keyboard or screen reader.
- Required fields on the ID OCR input page are now clearly marked for assistive technology users. Each required field label now includes an indicator showing it is required, improving form accessibility compliance.
- Fixed an issue where the Continue button on the landing page remained disabled when switching from phone number to email input after entering an invalid phone number. The Continue button is now correctly available after a valid email is entered, regardless of prior phone number input.
- <Pill type="update" /> Fixed a visual issue in the new onboarding experience (UX v2) on desktop where the passport scanning frame overlapped the "All data is encrypted" text during document capture.
- <Pill type="update" /> Fixed an issue causing certain screens to be missing from the Onboarding flow for organizations that migrated from Workforce.

***

## Server

### Enhancements

- Several enhancements have been made to Session webhooks. All additions are backward-compatible with existing webhook integrations.
  - Notifications now include additional details about the integration type and devices used during a session.
  - A new event called `SESSION_PROGRESS` is sent when a session is resumed, so integrators can track when a user returns to continue a session.
  - A new event called `IDENTITY_ENROLLED` is sent the first time an identity is enrolled, with built-in duplicate prevention to avoid repeated notifications for the same enrollment.
- The Deepsight Face Value score is now available as a condition in the Business Rules engine, allowing rules to be triggered based on the Deepsight face match score.
- Workflows now support additional document types including V5C and FSL.
- The KYB API now correctly handles UBO entries submitted using the `uboName` field. Previously, such entries could be silently dropped during processing; they are now treated as a single-element `uboNames` entry. The `uboNames` field remains the recommended parameter going forward.
- The Face Authentication module now emits `faceAuthenticationSucceeded` and `faceAuthenticationFailed` client events, enabling integrators to respond to authentication outcomes in their implementation.
- KYB company verification is now available for Denmark, Malta, and Bulgaria. The following lookups are now supported:
  - Danish company lookups by registration number and VAT number
  - Maltese company lookups by registration number and VAT number
  - Bulgarian company lookups by unified identification code (UIC/EIK) and VAT number
- A new verification rule is now available in Flows and Workflows that evaluates the outcome of the most recent V5C document scan. The result can be used in Workflow Conditions to automatically fail a session when the latest scan has failed.
- Government validation for Mexican INE can now run using document data and fingerprint without requiring a selfie capture. This enables in-branch verification flows where a face capture is not collected.
- Improved INE (Mexico) government validation matching. MRZ-extracted names are now used as the primary data source for direct INE name matching, with front OCR as a fallback when MRZ is unavailable. This reduces false failures for sessions where front OCR extraction produces inaccurate name data.
- Webhook authentication requests can now include custom body parameters in addition to custom headers, providing more flexibility for integrations that require additional fields in the authentication request body.
- Deepsight scoring has been updated to correctly handle verification flows using mobile driver's licenses (mDLs) or Digital IDs. Checks that are not applicable to these flows no longer affect the Deepsight score.
- The Device Fingerprint API now accepts two optional fields, `algorithmName` and `algorithmVersion`, allowing integrators to pass metadata about the fingerprinting algorithm used. These values are stored with the session and included in the sessions CSV export. This feature is currently available for web only.
- Two new verification rules are now available in the Rules Engine and Conditions for Video Selfie: Back ID Type match and Back ID OCR match. Both support OK, FAIL, and WARN status values, allowing session outcomes to be configured based on whether the back ID captured during Video Selfie matches the ID used during Onboarding.
- Organizations can now be configured to require end-to-end encrypted (E2EE) API calls. When enabled, any API request that does not route through the E2EE endpoint is rejected. Contact your Incode representative if you are interested in this feature.
- <Pill type="update" /> The eKYC source name for Spain ID Merit verification is now `ES_PHONE_REGISTER_2`. The previous source name `ES_1` will be deprecated in a future release. If you are using the Spain eKYC source, you should update your integration to use the new source name.
- <Pill type="update" /> Image quality checks are now performed for all Face Capture submissions, including those using automatic capture. This ensures consistent quality validation regardless of capture method.
- <Pill type="update" /> Barcode2D detection and content fields now surface on the score response for BC Services Card 2022 documents, along with crosschecks for birth date, full name, document number, sex, issue date, expiration date, and reference number. Previously, these fields and crosschecks were not exposed for this document type, even though the barcode was being read.
- <Pill type="update" /> For Hungarian documents, missing diacritical marks are now restored on extracted names and birth place fields when OCR returns them without diacritics. This applies to name, given name, first name, middle name, father's surname, mother's surname, birth name, and birth place. Name restoration is not applied to Hungarian documents issued to foreigners.
- <Pill type="update" /> For Mexican INE government validation, name comparison now intelligently selects between OCR and MRZ name sources based on quality. When the MRZ name appears truncated, OCR is used; when the OCR name contains errors, MRZ is used. This reduces false failures for sessions where one source has incomplete or incorrect last name data.

### Fixes

- Improved error handling for Escalations CSV files uploaded in an incorrect format.
- Fixed an issue with Colombia government validation where sessions were incorrectly failed when the registry returned a status indicating the identity is valid but the person's civil rights are restricted or suspended. These sessions are now treated as a passing government validation result.
- Enhanced the session PDF export with additional information, including age estimation, device details, and all capture attempts (up to three) for both onboarding and authentication. Also fixed a loading spinner issue when downloading the PDF manually from the Dashboard.
- When barcode and OCR name extractions differ only by diacritics, spaces, or hyphens, the OCR-extracted name is now preferred. This prevents false name mismatch failures caused by barcode normalization stripping accented characters.
- Driver's license data verification (GovDataMatch) in the U.S. now supports Pennsylvania. This requires a separate approval process with the PennDOT authority and is a separate provisioned provider vs. AAMVA. Contact your Incode representative for more information.
- Fixed an issue where Deepsight configuration settings were lost when importing a workflow. Deepsight settings are now correctly preserved during workflow import.
- Canadian postal codes containing a space (e.g. "K1A 0A6") are now accepted in eKYC postal code fields, preventing validation failures caused by the space character.
- Fixed an issue where the selfie face match threshold was incorrectly applied to cropped ID photo captures. The correct threshold for cropped ID photos is now used, ensuring sessions are evaluated against the intended configuration.
- Fixed an issue where government validation fallback to a secondary provider returned different results than calling that provider directly. Sessions that trigger the fallback now receive consistent, correct government validation outcomes.
- <Pill type="update" /> Fixed an issue where the approve step could fail with a 500 server error for certain organizations when an internal eligibility flag was unset. Affected sessions now complete approval correctly.

***

## ID Templates

### New supported templates

NEW ID SUPPORT

**Argentina**

- DriversLicense / DRIVERS\_LICENSE / 1990
- DriversLicense / DRIVERS\_LICENSE / 2021
- IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2020

**Australia**

- **New South Wales**
  - Other / FIREARMS\_LICENSE / 2020

**Azerbaijan**

- IdentificationCard / IDENTIFICATION\_CARD / 2025

**Belize**

- ResidenceDocument / PERMANENT\_RESIDENCE\_CARD / 2025

**Bulgaria**

- ResidenceDocument / TEMPORARY\_PROTECTION\_IDENTITY\_DOCUMENT / 2020

**Burkina Faso**

- TravelDocument / CONSULAR\_CARD / 2025

**Colombia**

- Passport / NATIONAL\_PASSPORT / 2026

**Costa Rica**

- Visa / VISA / 2024

**Dominican Republic**

- IdentificationCard / IDENTIFICATION\_CARD / 2026
- Passport / NATIONAL\_PASSPORT / 2026
- TravelDocument / CONSULAR\_CARD / 2021

**Ethiopia**

- Other / REFUGEE\_IDENTIFICATION\_CARD / 2022

**France**

- Military / MILITARY\_ID / 2023

**Gambia**

- MedicalCard / HEALTH\_CARD / 2023

**Guinea**

- VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2020

**India**

- **Andhra Pradesh**
  - DriversLicense / DRIVERS\_LICENSE / 2024
- **West Bengal**
  - DriversLicense / DRIVERS\_LICENSE / 2026

**Indonesia**

- IdentificationCard / IDENTIFICATION\_CARD / 2021

**Iran**

- DriversLicense / DRIVERS\_LICENSE / 2024

**Iraq**

- DriversLicense / DRIVERS\_LICENSE / 2025
- VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2025

**Jordan**

- ResidenceDocument / RESIDENCE\_PERMIT / 2025

**Kyrgyzstan**

- Passport / NATIONAL\_PASSPORT / 2025

**Lebanon**

- IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2025

**Mauritius**

- IdentificationCard / IDENTIFICATION\_CARD\_FOR\_FOREIGNERS / 2022

**Mexico**

- IdentificationCard / SENIOR\_IDENTIFICATION\_CARD / 2024
- IdentificationCard / SENIOR\_IDENTIFICATION\_CARD / 2025

**Namibia**

- VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2020

**Nicaragua**

- IdentificationCard / IDENTIFICATION\_CARD / 2009

**Nigeria**

- TaxIdentification / TAX\_IDENTIFICATION / 2015
- TravelDocument / CONSULAR\_CARD / 2020

**Oman**

- ResidenceDocument / RESIDENCE\_PERMIT / 2025

**Pakistan**

- Other / REFUGEE\_IDENTIFICATION\_CARD / 2024

**Papua New Guinea**

- DriversLicense / DRIVERS\_LICENSE / 2025

**Peru**

- DriversLicense / DRIVERS\_LICENSE / 1999
- Military / MILITARY\_CARD / 2026

**Philippines**

- IdentificationCard / POLICE\_CLEARANCE\_IDENTIFICATION\_CARD / 2025

**Sierra Leone**

- MedicalCard / SOCIAL\_SECURITY\_CARD / 2022

**Solomon Islands**

- DriversLicense / DRIVERS\_LICENSE / 2023

**Somalia**

- DriversLicense / DRIVERS\_LICENSE / 2019
- VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2023

**South Africa**

- Passport / TRAVEL\_DOCUMENT / 2018

**Syrian Arab Republic**

- Passport / TRAVEL\_DOCUMENT / 2025

**Turkey**

- IdentificationCard / IDENTIFICATION\_CARD\_FOR\_FOREIGNERS / 2023

**Uganda**

- IdentificationCard / IDENTIFICATION\_CARD / 2025

**United States of America**

- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1873
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1875
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1886
- **Tennessee**
  - DriversLicense / TEMPORARY\_LEARNERS\_PERMIT / 2011

**Uruguay**

- Passport / NATIONAL\_PASSPORT / 2020

**Venezuela**

- IdentificationCard / DISABILITY\_IDENTIFICATION\_CARD / 2020
- Passport / NATIONAL\_PASSPORT / 2000

**Yemen**

- Passport / NATIONAL\_PASSPORT / 2016

<br />

NEW CLASSIFICATION SUPPORT

**Argentina**

- DriversLicense / DRIVERS\_LICENSE / 1959

**Australia**

- ResidenceDocument / IMMIGRATION\_CARD / 2023

**Belarus**

- ResidenceDocument / RESIDENCE\_PERMIT / 2022

**Burkina Faso**

- TravelDocument / CONSULAR\_CARD / 2026

**Djibouti**

- IdentificationCard / IDENTIFICATION\_CARD / 2024

**Ecuador**

- IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2021

**Federated States of Micronesia**

- **Chuuk**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025

**Georgia**

- **Abhazia**
  - DriversLicense / DRIVERS\_LICENSE / 2025

**Guatemala**

- DriversLicense / DRIVERS\_LICENSE / 2019

**Iraq**

- Military / MILITARY\_CARD / 2025
- Permit / WORK\_PERMIT / 2025

**Libya**

- Passport / SPECIAL\_PASSPORT / 2018

**Mexico**

- **Chiapas**
  - DriversLicense / DRIVERS\_LICENSE / 2022

**Morocco**

- TravelDocument / CONSULAR\_CARD / 2020

**Nicaragua**

- TravelDocument / CONSULAR\_CARD / 2026

**Peru**

- DriversLicense / DRIVERS\_LICENSE / 1883
- Military / MILITARY\_CARD / 2009

**Portugal**

- DriversLicense / DRIVERS\_LICENSE / 2025

**Somalia**

- VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2025

**Thailand**

- Permit / WORK\_PERMIT / 2026

**United States of America**

- Other / CHICAGO\_IDENTIFICATION\_CARD / 2024
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1835
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1836
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1837
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1838
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1841
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1842
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2005
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2006
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2007
- TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2025
- **Arkansas**
  - Other / IDENTIFICATION\_CARD / 2025
- **Mariana Islands**
  - Other / IDENTIFICATION\_CARD\_UNDER21 / 2025
- **US Virgin Islands**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025

**Vietnam**

- IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2023

### **Changes to current templates**

FEATURE UPDATE

**Albania**

- DriversLicense / DRIVERS\_LICENSE / 2005 r1
- DriversLicense / DRIVERS\_LICENSE / 2019 r1

**Andorra**

- DriversLicense / DRIVERS\_LICENSE / 1990 r1

**Argentina**

- DriversLicense / DRIVERS\_LICENSE / 2004 r2

**Belarus**

- DriversLicense / DRIVERS\_LICENSE / 2012 r2

**Belgium**

- DriversLicense / DRIVER\_LICENSE / 2010 r1
- DriversLicense / DRIVER\_LICENSE / 2013 r3

**Bosnia and Herzegovina**

- DriversLicense / DRIVERS\_LICENSE / 2015 r2

**Bulgaria**

- DriversLicense / DRIVERS\_LICENSE / 2013 r3

**Cyprus**

- DriversLicense / DRIVERS\_LICENSE / 2014 r2

**Czech Republic**

- DriversLicense / DRIVERS\_LICENSE / 2004 r1

**Denmark**

- DriversLicense / DRIVER\_LICENSE / 1997 r1
- DriversLicense / DRIVER\_LICENSE / 2013 r1
- DriversLicense / DRIVER\_LICENSE / 2018 r2
- DriversLicense / DRIVER\_LICENSE / 2025 r1
- **Greenland**
  - DriversLicense / DRIVERS\_LICENSE / 2010 r1

**France**

- **New Caledonia**
  - DriversLicense / DRIVERS\_LICENSE / 2024 r1

**Hungary**

- IdentificationCard / IDENTIFICATION\_CARD / 2012 r2
- IdentificationCard / IDENTIFICATION\_CARD / 2016 r3

**Kosovo**

- DriversLicense / DRIVERS\_LICENSE / 2021 r1
- DriversLicense / DRIVERS\_LICENSE / 2024 r1

**Malta**

- DriversLicense / DRIVERS\_LICENSE / 2013 r1

**Netherlands**

- DriversLicense / DRIVER\_LICENSE / 2006 r1

**Norway**

- DriversLicense / DRIVER\_LICENSE / 2013 r2
- DriversLicense / DRIVER\_LICENSE / 2018 r1

**Poland**

- DriversLicense / DRIVERS\_LICENSE / 2002 r1
- DriversLicense / DRIVERS\_LICENSE / 2013 r2

**Saint-Martin**

- DriversLicense / DRIVERS\_LICENSE / 2019 r1

**Serbia**

- DriversLicense / DRIVER\_LICENSE / 2011 r3

**Slovakia**

- DriversLicense / DRIVERS\_LICENSE / 2008 r1
- DriversLicense / DRIVERS\_LICENSE / 2015 r1

**Slovenia**

- DriversLicense / DRIVERS\_LICENSE / 2013 r1
- DriversLicense / DRIVERS\_LICENSE / 2015 r1

**Spain**

- DriversLicense / DRIVER\_LICENSE / 2004 r1
- DriversLicense / DRIVER\_LICENSE / 2013 r3

**Sweden**

- DriversLicense / DRIVERS\_LICENSE / 2013 r1
- DriversLicense / DRIVERS\_LICENSE / 2016 r1

**Ukraine**

- DriversLicense / DRIVERS\_LICENSE / 2005 r2
- DriversLicense / DRIVERS\_LICENSE / 2014 r2
- DriversLicense / DRIVERS\_LICENSE / 2021 r2

**United Kingdom**

- **Falkland Islands**
  - DriversLicense / DRIVERS\_LICENSE / 2020 r1

<br />

ID CLASSIFICATION IMPROVEMENT

**India**

- **Uttar Pradesh**
  - DriversLicense / DRIVERS\_LICENSE / 2019 r1

**United States of America**

- **New York**
  - DriversLicense / DRIVER\_LICENSE / 2022 r3

<br />

ID OCR EXTRACTION IMPROVEMENT

**Benin**

- IdentificationCard / IDENTIFICATION\_CARD / 2017 r1

**Chile**

- DriversLicense / DRIVER\_LICENSE / 2019 r1

**Czech Republic**

- IdentificationCard / IDENTIFICATION\_CARD / 2021 r2

**Ecuador**

- IdentificationCard / IDENTIFICATION\_CARD / 2021 r3

**Estonia**

- DriversLicense / DRIVERS\_LICENSE / 2013 r2

**Finland**

- DriversLicense / DRIVERS\_LICENSE / 2013 r1
- DriversLicense / DRIVERS\_LICENSE / 2019 r1
- **Aland**
  - DriversLicense / DRIVERS\_LICENSE / 2015 r1

**Georgia**

- DriversLicense / DRIVERS\_LICENSE / 2013 r2

**Greece**

- DriversLicense / DRIVERS\_LICENSE / 2009 r3
- DriversLicense / DRIVERS\_LICENSE / 2013 r2

**Hungary**

- DriversLicense / DRIVERS\_LICENSE / 2013 r1
- IdentificationCard / IDENTIFICATION\_CARD / 2012 r2
- IdentificationCard / IDENTIFICATION\_CARD / 2016 r3

**Iceland**

- DriversLicense / DRIVERS\_LICENSE / 1997 r1
- DriversLicense / DRIVERS\_LICENSE / 2002 r1
- DriversLicense / DRIVERS\_LICENSE / 2016 r1

**India**

- **Uttar Pradesh**
  - DriversLicense / DRIVERS\_LICENSE / 2019 r1

<Pill type="update" /> **Kenya**

- IdentificationCard / IDENTIFICATION_CARD / 2011 r6

**Kosovo**

- DriversLicense / DRIVERS\_LICENSE / 2008 r1

**Lithuania**

- DriversLicense / DRIVERS\_LICENSE / 2011 r1
- DriversLicense / DRIVERS\_LICENSE / 2013 r1
- DriversLicense / DRIVERS\_LICENSE / 2017 r1

**Malta**

- DriversLicense / DRIVERS\_LICENSE / 2020 r1

**Netherlands**

- DriversLicense / DRIVER\_LICENSE / 2013 r1
- DriversLicense / DRIVER\_LICENSE / 2018 r7
- DriversLicense / DRIVER\_LICENSE / 2025 r2

**Norway**

- DriversLicense / DRIVER\_LICENSE / 2007 r2
- DriversLicense / DRIVER\_LICENSE / 2023 r1

**Poland**

- DriversLicense / DRIVERS\_LICENSE / 2000 r1
- DriversLicense / DRIVERS\_LICENSE / 2001 r1

**Spain**

- IdentificationCard / IDENTIFICATION\_CARD / 2015 r3 - Incode MRZ
- IdentificationCard / IDENTIFICATION\_CARD / 2021 r4

**Switzerland**

- IdentificationCard / IDENTIFICATION\_CARD / 2023 r1

<Pill type="update" /> **Uganda**

- IdentificationCard / IDENTIFICATION_CARD / 2025
</Accordion>

***

## 2026 June 1

<Accordion title="2026 June 1">
 _Demo: 25 May 2026 | Production: 1 June 2026_

## Dashboard

### Enhancements

eKYC

- A new US eKYC source, US Credit Telco, is now available. It verifies first name, last name, date of birth or SSN (at least one required), along with optional address fields and phone number. The single session view displays individual field match results (exact, fuzzy, no match, or unknown) for each verified field along with an overall match level.
- The single session view now correctly handles Canada eKYC credit file results for files less than 3 years old. When AML regulations prevent returning the credit file number and creation date, placeholder values are displayed instead of empty or incorrect fields.
- <Pill type="update" /> The eKYC module in the Flow builder now supports display mode configuration for fields sourced from ID OCR or Proof of Address. Each field can be set to Editable (default, preserving existing behavior), Read-only (pre-filled and visible but not editable by the end user), or Hidden (not shown during onboarding). Fields sourced from user input are unaffected.

WORKFLOWS & FLOWS

- A new **Enforce Capture Image Attempts** setting is available in flow and workflow settings under User Experience > Session Control. When enabled, users who reach the configured maximum number of capture attempts receive an error and cannot retry.

GENERAL

- When submitting an escalation through Dashboard, you can now select multiple values in the **Issues** drop-down. All selected values are included when creating or uploading an escalation.
- The Hong Kong KYB session results in the Dashboard now display the ownership percentage alongside each verified UBO name.
- The Trust Graph risk indicator for the Known Fraudster Liveness category now displays as "used in a Liveness Spoof Attack" in the Dashboard. The fraud vector modal defaults to Physical Liveness.
- The Privacy Policy and Terms of Use links displayed in the default user consent screen have been updated to point to the latest versions on [incode.com](http://incode.com). The ML data consent checkbox text has also been updated to remove an outdated reference.

### Fixes

- Fixed an issue in Workforce where the Directory Information user list was truncated to 20 or 40 entries after opening a directory profile or applying a filter. The full list is now displayed correctly in all cases.
- Fixed an issue in the Upload Escalation flow where the "Add to Escalation" button remained enabled after removing the uploaded CSV file. The button now correctly resets to a disabled state when the file is removed, preventing unintended resubmission.
- Fixed an issue in the Workflow builder where adding a condition and selecting the No path caused both the Yes and No branches to default to Session PASS. The No branch now correctly defaults to Session FAIL.
- Fixed a missing configuration option in the Workflow builder's ID capture module: the "Add watermark to cropped ID" setting and its tooltip were absent. The option is now available and configurable, consistent with its presence in the Flow builder.
- <Pill type="update" /> Fixed an issue in the Dashboard's Candidate Verification page where changing the link validity duration would retroactively update the confirmation message for a previously generated link. Each link's confirmation message now correctly reflects the validity duration it was generated with.
- <Pill type="hotfix" /> Fixed an issue where sessions flagged for manual review could not be approved or rejected when depth information was missing from the capture data. Affected sessions can now be correctly actioned in the Dashboard.
- <Pill type="hotfix" /> Fixed an issue where sessions flagged for manual review could not be approved or rejected when depth information was missing from the capture data. Affected sessions can now be correctly actioned in the Dashboard.

***

## Web App (Onboarding)

### Enhancements

- Improvements to the KYB onboarding form layout:
  - Input fields are now displayed side-by-side for a more compact form
  - A container outline has been added around the form
  - The overall presentation is better aligned with standard web form patterns
- <Pill type="update" /> Updated the China KYB onboarding form to use a single address input field, replacing the previous multi-field address layout. The address field is now mandatory and maps correctly to the corresponding API field. This change resolves an error that prevented China KYB onboarding sessions from submitting successfully.
- <Pill type="update" /> The browser-based Device Fingerprint now collects an additional set of browser signals, expanding the data available for device identification and fraud detection.

### Fixes

- Fixed an issue where custom fields of type decimal (double) could not be submitted in onboarding flows, even when correctly configured in the Dashboard. Users can now enter and submit decimal values in custom fields.
- Fixed an issue where the eyes closed notification during selfie capture was not displayed in the user's configured language. The notification now correctly respects the onboarding language setting.
- Fixed an issue where valid phone numbers were incorrectly rejected with an invalid format error. Phone number validation now correctly accepts properly formatted numbers for all supported country codes.
- Corrected Polish translations for the face capture and verification screens in Webflow integrations. Three text strings have been updated to use more natural and grammatically accurate Polish language.
- <Pill type="update" /> Fixed an issue where OAuth2-secured onboarding flows failed to redirect correctly when reaching the authentication step.
- <Pill type="hotfix" /> Fixed an issue where the Deepsight Camera Trust check consistently failed for sessions completed on Windows desktop using Google Chrome, even when no genuine camera or device risk was present. The check now correctly reflects actual device risk on Windows Chrome sessions.

***

## Server

### Enhancements

- OCR results now include detailed version metadata for all sub-components used during document processing, including the visual option version, classification set version, and entity extraction pipeline version for each processed side.
- China KYB now uses Incode's in-house algorithm and LLM-based matching on raw data instead of relying on the provider's matching results. This improves accuracy for business names and addresses in Pinyin format.
- Improved edge case handling for Colombia government validation via the Tus Datos provider. Matching accuracy has been improved for sessions where OCR extraction produces names in formats not covered by the standard logic.
- A new error code has been added for AAMVA DLDV verification. Document Number Mismatch represents scenarios where the driver’s license number does not match, but one or more other identity data attributes do match, signifying that the person may be deceased or has been issued a newer driver’s license number. The status for this error code will be FAIL, and this error code will be exposed in Business Rules for handling/decisioning. Contact your Incode Representative or submit a support request if you have questions about this change.
- US government data verification now supports New York for ID documents issued after 2005. This can be provisioned as a separate provider alongside AAMVA DLDV.
- Sessions presenting Indian AADHAR (UIDAI) identification cards are now automatically rejected and no data is processed or stored, in compliance with applicable data protection requirements.
- Organizations can now configure whether set-password invitation emails are sent when new Dashboard users are created. When disabled, new users can only log in via SSO, preventing password-based login bypass. This setting is enabled by default, preserving existing behavior.
- Government Verification for California driver's licenses and IDs now includes digital signature verification for 2025-generation documents. A successful digital signature check confirms the document was issued by the CA DMV and that the barcode data has not been tampered with, enabling accurate distinction between data match and face match results in DMV Face Match sessions.
- Extended EU and UK driver's license restriction code extraction to additional non-standard vehicle classes, including F, K, L, N, P, Q, and others not previously covered. Issue and expiration date extraction for these classes is also now supported.
- The flow configuration API response now includes a `digitalIdConfig` field with per-method configuration for Digital ID capture methods. Each enabled method specifies the requested identity attributes, supporting selective disclosure for mobile Driver's Licenses (mDL/ISO 18013-5).
- The `add/front-id` endpoint (v1 and v2) now accepts an `extractIdFace` boolean parameter. When set to `false`, face extraction and biometric template creation are skipped for that capture. All other processing (OCR, classification, tamper checks, barcode/MRZ) continues normally. Existing behavior is preserved when the parameter is omitted. Required for Quebec CAI/Law 25 compliance and similar privacy regimes.
- Motion attack detection now uses an ML-based scoring model. The ML result feeds directly into the Behavior trust score with a severity level. When no ML result is available, the existing motion check is used as a fallback, preserving current behavior.
- Organizations can now configure multiple OIDC client credentials integrations simultaneously. Previously, OIDC was limited to a single, auto-created integration.
- Added input validation to the `omni/add/device-fingerprint` endpoint. String fields now enforce maximum length limits and requests exceeding those limits return a 400 error with a descriptive message.
- The CSV session export now includes Deepsight score columns: physical attack, digital attack, evasion attack, face overall, document overall, overall, device trust, behavioral trust, and camera trust — each with a status and value field.
- Improved the accuracy of government validation result reporting. Error outcomes are now determined by a defined priority order, and sessions that previously returned an incorrect or overly broad error code now surface the correct result, including individual field match details where applicable.
- <Pill type="update" /> Improved China KYB tax ID matching accuracy. When a tax ID returns no match due to letter case differences between the submitted value and the registry value, the system now performs its own comparison and returns the correct match result.
- <Pill type="update" /> Updated SCIM role mapping for organizations migrated to Convergence phase 2. Legacy Workforce role identifiers used in SCIM configurations are automatically mapped to their current equivalents, preserving existing role-based access behavior.
- <Pill type="update" /> The digital attack check has been split into two distinct checks: deepfake attack and digital manipulation attack. These checks are now available separately in session scores and API responses. The existing digital attack check is preserved for backward compatibility.
- <Pill type="update" /> Improved Colombia government validation to correctly handle sessions where multiple OCR fields return unknown values. Sessions with two or more unextractable fields no longer fail government validation when core identity fields are present and matched.
- <Pill type="update" /> Re-applied the third-generation browser Device Fingerprint signal collection on the server side, which had been temporarily rolled back as part of an OAuth2 hotfix.

### Fixes

- Fixed an issue where Entra EAM enrollment for Workforce failed because the authentication endpoint was receiving a GET request instead of the required POST. Entra External Authentication Method verification now completes successfully.
- Fixed an issue where Gov Validation was incorrectly triggered for sessions presenting documents from countries not provisioned for the client. Sessions from non-provisioned countries now skip the Gov Validation module entirely and are not scored as failures.
- Fixed an issue where PDF documents with oversized page dimensions were rejected during processing. Instead of rejecting, the service now scales the rendering DPI proportionally, ensuring correct processing of PDFs where page dimensions are specified in pixels rather than points.
- Fixed an issue where the document number match type was omitted from Trust Graph continuous monitoring webhook notifications. Webhook payloads now correctly include all match types when a fraud report is found.
- Fixed an issue where sessions completed via the helpdesk verification flow returned an overall score of 0.0 despite passing. The overall score now correctly reflects the session result when Face Authentication is present in the flow but fails due to no existing customer record.
- Fixed multiple data accuracy issues in OCR and MRZ processing: corrected address field extraction for Mexican documents, resolved MRZ data redaction for back-side captures, fixed MRZ parsing for Nigerian ID cards and German driver's licenses, and resolved front barcode parsing for several document types.
- Fixed an issue where onboarding selfie images were incorrectly deleted when the PII deletion job ran, even when the "Retain onboarding selfie & face template" setting was enabled. The setting now correctly prevents selfie data from being removed during PII deletion.
- Fixed a mismatch between SDK-level Deepsight motion configuration and the server-side flow configuration. The flow and workflow configuration endpoints now correctly return motion settings for all relevant capture modules, and server-side validation ensures consistency between SDK flags and the configured flow.
- <Pill type="update" /> Fixed an issue where the Risk AI model received incorrect face recognition score data (reporting a failure status and no confidence value) even for sessions with a passing face recognition result.
- <Pill type="update" /> Fixed an issue where customer identities were not reliably created after successful workflow sessions, even when automatic identity creation was enabled. Identity creation now completes correctly for all qualifying sessions.
- <Pill type="update" /> Fixed an issue where the CURP value extracted from a physical ID document was silently overwritten with an updated CURP returned by the government validation provider.
- <Pill type="hotfix" /> Fixed an issue where KYB UBO and Director verification failed due to a structural change in the company report data returned by the verification provider. The backend now correctly handles both the previous and updated response formats, restoring accurate UBO and Director verification results.
- <Pill type="hotfix" /> Fixed an issue where first and last name components were incorrectly assigned for Hungarian ID documents. Name fields now correctly reflect the split between family name and given name.

***

## ML

- Deployed updated ML model versions:
  - Tamper Check 7.0
  - Barcode PDF417 1.14
  - Fake ID Check 1.19
- Deployed a new custom ZXing-based PDF417 barcode reader to the ML preprocessing service, improving accuracy and decoding reliability for documents with PDF417 barcodes.
- Improved injection attack detection accuracy for web-based onboarding sessions. The frame duplication check has been extended to cover additional points during the capture flow, reducing missed detections.
- Improved the accuracy of Deepsight behavioral and replay attack detection in web-based onboarding sessions, reducing missed detections and strengthening protection against reused video injection attempts.
- Fixed an issue where switching context during the loading screen could break the webcam display in web onboarding flows when Deepsight was enabled.
- Added a new injection attack detection check for mobile onboarding flows. The check runs during the post-capture uploading screen for both ID and selfie capture phases, and is not applied on non-mobile devices.
- Added a new virtual camera detection check for mobile onboarding flows. The check runs during the post-capture uploading screen for both ID and selfie capture phases, may add approximately one second to the uploading screen, and is not applied on non-mobile devices.
- <Pill type="update" /> Improved PDF417 barcode read accuracy across multiple document types and issuing states, reducing incorrect barcode check failures for recently issued documents.

***

## ID Templates

### New supported templates

NEW ID SUPPORT

- **Fiji**
  - DriversLicense / LEARNERS\_PERMIT / 2010
- **Georgia**
  - ResidenceDocument / TEMPORARY\_RESIDENCE\_CARD / 2025
- **Kyrgyzstan**
  - IdentificationCard / IDENTIFICATION\_CARD / 2025
- **Mexico**
  - **Tabasco**
    - DriversLicense / DRIVERS\_LICENSE / 2019
- **Nigeria**
  - IdentificationCard / IDENTIFICATION\_CARD / 2008
  - TravelDocument / CONSULAR\_CARD / 2018
- **Qatar**
  - ResidenceDocument / RESIDENCE\_PERMIT / 2020
- **United States of America**
  - **Nebraska**
    - DriversLicense / DRIVERS\_LICENSE / 2026
  - **Oklahoma**
    - DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2026
    - DriversLicense / LEARNERS\_PERMIT / 2026
    - IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2026

NEW CLASSIFICATION SUPPORT

- **Laos**
  - IdentificationCard / IDENTIFICATION\_CARD / 2023
- **Mexico**
  - MedicalCard / MEDICAL\_CARD / 2026
- **United States of America**
  - TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1839
  - TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1840
  - **Louisiana**
    - IdentificationCard / IDENTIFICATION\_CARD / 2001
  - **Nebraska**
    - DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2026
    - IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2026
    - IdentificationCard / IDENTIFICATION\_CARD / 2026

### **Changes to current templates**

FEATURE UPDATE

- **France**
  - DriversLicense / DRIVER\_LICENSE / 2013 r2
    - [FRA-ALL-DriversLicense-DRIVER\_LICENSE-2013-r2](https://www.notion.so/35a4c3caef4980c392ffeaaf3a9778b0?pvs=21)
- **Germany**
  - DriversLicense / DRIVER\_LICENSE / 2011 r3
- **Indonesia**
  - Passport / NATIONAL\_PASSPORT / 2015 r2
- **Italy**
  - DriversLicense / DRIVER\_LICENSE / 2000 r1
  - DriversLicense / DRIVER\_LICENSE / 2013 r5
- **India**
  - IdentificationCard / IDENTIFICATION\_CARD / 2015 r3
- **Portugal**
  - DriversLicense / DRIVERS\_LICENSE / 2013 r1
- **United Kingdom**
  - DriversLicense / DRIVER\_LICENSE / 2013 r3
  - DriversLicense / DRIVER\_LICENSE / 2015 r2
  - DriversLicense / PROVISIONAL\_DRIVER\_LICENSE / 2013 r1
  - DriversLicense / PROVISIONAL\_DRIVER\_LICENSE / 2015 r1
  - DriversLicense / PROVISIONAL\_DRIVER\_LICENSE / 2021 r1
  - **Wales**
    - DriversLicense / DRIVER\_LICENSE / 2013 r1

ID CLASSIFICATION IMPROVEMENT

- **Romania**
  - IdentificationCard / IDENTIFICATION\_CARD / 2022 r3

ID OCR EXTRACTION IMPROVEMENT

- **Cameroon**
  - Passport / NATIONAL\_PASSPORT / 2021 r1
- **Germany**
  - IdentificationCard / IDENTIFICATION\_CARD / 2010 r5
  - ResidenceDocument / RESIDENCE\_PERMIT / 2019 r3
- **Lithuania**
  - IdentificationCard / IDENTIFICATION\_CARD / 2021 r1
- **United Arab Emirates**
  - ResidenceDocument / GOLDEN\_CARD / 2022 r3 - Incode MRZ
</Accordion>

***

## 2026 May 18

<Accordion title="2026 May 18">
  _Demo: 11 May 2026 | Production: 18 May 2026_

  ## Dashboard

  ### Enhancements

  FACE AUTHENTICATION

  * There is a new setting called **Stateless face match** in the Face Authentication module configuration. When enabled, Face Authentication uses a selfie submitted via API instead of a stored biometric template. This allows users who have deleted their biometric data after onboarding to still use Face Authentication.
  * Updated the warning label in the Face Authentication module configuration. Now you will see this warning: "For webflows, please use OAuth Secured sessions.”

  eKYC

  * Updated the display name for the Spain eKYC phone register source in module configuration from **Spain - Telephone Register** to **Spain Phone Register 2** to align with updated naming conventions.
  * Added two new sources to eKYC for Nigeria:
    * Bank Verification Number (BVN): Displayed in module configuration as **MONO BVN NG**
    * National Identification Number (NIN): Displayed in module configuration as **MONO NIN NG** Both sources include Name, Phone, Date of birth, and Tax ID Number. <Pill type="update" /> Government checks for both sources also support Face Match — the selfie captured during the session is compared against the image from the government verification response, and the result is factored into the session's government verification score.

  ID CAPTURE

  * <Pill type="update" /> A new **Require Date of Birth** setting is available in the ID capture module. When enabled, users are prompted to capture the back of their ID if date of birth was not detected on the front side, even in front-only flows. Disabled by default. Contact your Incode representative if you are interested in this feature.

  WORKFORCE

  * Improved the global email template UX for the Pegasystems Workforce integration, including layout and visual consistency updates across email notifications.
  * <Pill type="update" /> Workforce now supports configurable default link durations for Candidate and Helpdesk verification. The default TTL (time-to-live) can be set in **Configuration** > **General** and overridden per-verification on the Candidate Verification page.
  * <Pill type="update" /> Added an option in the Workforce MDM configuration to hide the enrollment selfie from the verification session.

  GENERAL

  * Fixed column padding in the Compliance tab's Audit Log table to align with the design system specifications used in other tables across the Dashboard.
  * Updated the display label for the selfie quality error code in the single session view. The title now reads "Selfie Image Quality Check Failed" instead of "Selfie Checks Failed" for improved clarity.
  * The government verification feature has been renamed to **GovMatch** in single session view. The tab, score summary, and section titles have been updated to reflect the new product name.
  * <Pill type="update" /> Risk AI Shadow Mode is now available in the Dashboard. When enabled at the organization level, Risk AI scores are calculated in shadow mode without affecting session decisions. Shadow results are visible to Incode Admins in a dedicated Risk AI Shadow tab in the single session view. Shadow mode can be configured independently at the flow and workflow level; when live Risk AI is active, it takes priority over shadow mode.

  ### Fixes

  * Fixed a critical issue in the single session view where ID Verification, OCR data, and Capture Attempts from a second captured ID were overwriting results from the first ID. Each document's results are now displayed independently.
  * Fixed an issue where ID verification results were showing as N/A when a second ID was submitted via manual upload. Results are now correctly attributed and displayed for both documents.
  * Fixed an issue where quickly tapping through the Voice Statement consent prompts allowed users to bypass the voice consent step entirely. The consent flow now correctly enforces completion before proceeding.
  * <Pill type="update" /> Fixed a display issue in single session view where issue type and submitted issue fields did not render correctly when multiple values were present. Both fields now display all values accurately.
  * <Pill type="update" /> Fixed an issue where uploading a logo in the Dashboard's email configuration would cause the logo preview to fail to load. The preview now displays correctly after saving.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * Improved the color contrast of Privacy Policy links on the Biometric Consent screen to meet WCAG 2.2 AA accessibility standards.
  * The ID document upload flow now enforces a maximum file size of 5 MB for PDF uploads. If a user selects a file that exceeds this limit, a clear error message is displayed and they can select a different file to retry.
  * Updated German translations on the Start screen and Age Step Up screen to improve accuracy and clarity.
  * The US KYB onboarding flow now includes address autofill. Users can begin typing their business address and select the correct option from a dropdown, which then populates all address fields automatically. This reduces friction and entry errors.
  * <Pill type="update" /> The KYB onboarding form has been redesigned with a desktop-first layout, improving the experience for business users completing onboarding on desktop. The updated form provides a more polished and professional presentation while maintaining consistency across desktop and mobile.

  ### Fixes

  * Fixed an issue on the eKYC desktop flow where date entry fields appeared dimmed (inactive) after being populated with a valid value.
  * Fixed an incorrect placeholder hint shown for the State Code field in the Argentina eKYC flow. The field now displays the correct format hint (e.g., B, C, K).
  * Fixed an issue where custom branding colors for the Data Sharing Consent screen were not reflected on the checkboxes. Checkboxes now correctly adopt the configured styling.
  * Fixed an issue where the manual capture fallback screen always displayed ID card placement instructions regardless of the document type being captured. Guidance now correctly reflects the document type selected by the user (e.g., passport vs. ID/driver's license).
  * <Pill type="update" /> Fixed an issue where the Deepsight device trust check incorrectly failed for users completing onboarding on a desktop browser using the built-in camera.

  ***

  ## Server

  ### Enhancements

  * The third-party onboarding authentication endpoint is now publicly documented in the Swagger API reference.

  * The Digital ID document submission endpoint now accepts PDF files passed via image URL in addition to the already-supported base64 format.

  * Updated the Slack integration to route users in V2 organizations to the onboarding app, ensuring the correct application is used for verification flows triggered via Slack.

  * Added HMAC-authenticated variants of several session creation and session management endpoints: `omni/hmac/start`, `omni/hmac/add/phone`, `omni/hmac/executive/log-in`, `omni/hmac/external/send-sms`, and `omni/hmac/onboarding-url`. These endpoints behave identically to their standard counterparts but require two additional headers: `RequestDate` and an `Authorization` header containing an HMAC signature. This allows integrators to authenticate API calls using a shared secret key.

  * Added a new `ONBOARDING_STATUS_CHANGE_ENRICHED` webhook type, triggered on `ONBOARDING_FINISHED`, which includes full OCR and score data in the payload and is signed with HMAC headers for recipient verification.

  * EU and UK driver's licenses can now be evaluated against configurable restriction codes extracted from the back of the document (row B, 4th column). Flows and Workflows can be configured to automatically reject licenses based on specific class codes, such as automatic-only driving restrictions.

  * Improved the logic for resolving the user's IP address during device fingerprinting. The system now correctly falls back to the IP address provided in the request body when the header IP is local or invalid, ensuring accurate IP capture for sessions using end-to-end encryption.

  * Added two new data deletion modes:
    * Biometrics-only deletion (removes images, videos, and biometric templates while retaining other session data)
    * Minimum data mode (retains only the selfie image and face template needed for authentication). These modes provide more granular control over data retention and deletion.

  * Updated name parsing for the following Mexican residence document types: `MEX|ALL|ResidenceDocument|TEMPORARY_RESIDENCE_CARD|2022`, `MEX|ALL|ResidenceDocument|TEMPORARY_RESIDENCE_CARD|2000`, `MEX|ALL|ResidenceDocument|PERMANENT_RESIDENCE_CARD|2022`, `MEX|ALL|ResidenceDocument|PERMANENT_RESIDENCE_CARD|2000`, `MEX|ALL|ResidenceDocument|VISITORS_PERMIT|2020`, and `MEX|ALL|ResidenceDocument|VISITORS_PERMIT|2022`. Three changes are included:
    * The `firstName`, `givenName`, and `fullName` fields now return the name in title case as it appears on the document, rather than uppercase
    * Last name separation logic now correctly executes for last names of three letters or fewer
    * When more than two last name parts are present, the full compound surname is preserved in `paternalLastName` rather than attempting an inaccurate split. The `machineReadableFullName`, `givenNameMrz`, and `lastNameMrz` fields are unchanged.

  * Updated the Canada eKYC credit file source to comply with AML regulations: credit file number and creation date are now only returned when the file is at least 3 years old. If the file was created more recently, placeholder values are returned instead.

  * <Pill type="update" /> Under specific configuration, the server now sends a SESSION\_FAILED webhook when a Workforce verification link expires, with a failureReason of LINK\_EXPIRED. Contact your Incode representative if you are interested in this feature.

  ### Fixes

  * Fixed an intermittent 500 error that occurred during ID processing in Workflows when Deepsight was enabled, caused by a concurrency issue in session node handling.
  * Fixed a 500 error that occurred when loading a single session in the Dashboard for sessions where a Face Authentication module had been executed and subsequently cleaned.
  * Fixed an issue where OCR data was not always deleted when a full session deletion was performed. OCR results are now reliably removed as part of the full deletion process.
  * Fixed an issue where the Fraud Risk AI model was not receiving complete cross-check data due to reliance on stale score data. Data collection for the Fraud Risk API call now reads directly from the appropriate source entities.
  * Fixed an issue in the Colombia verification flow where the middle name check incorrectly returned FAIL for users with three or more names. The check now returns UNKNOWN, and the Government Validation score is no longer penalized for this field.
  * Improved error handling for Idemia integration. The server now correctly parses and maps 400 and 500 error responses from Idemia to the appropriate error codes instead of defaulting to a generic Connection Error.
  * Fixed an issue where users were unable to log into Okta after completing an Okta IDP verification flow when a previous Okta IDV flow had already been finished for the same user.
  * <Pill type="update" /> Fixed an issue where a Workforce verification link could be reused without any record of the attempt. Now, if a link is opened a second time, the original session fails immediately and the reuse event is recorded.
  * <Pill type="update" /> Fixed an issue where subsequent onboarding sessions failed after a user's identity had been manually approved in the Dashboard. Selfie capture would fail repeatedly on the next attempt, preventing the session from completing.
  * <Pill type="update" /> Fixed an issue where users with the HIPAA Admin role received a 403 error when attempting to access the Configuration page.
  * <Pill type="update" /> Fixed an issue where sessions using end-to-end encryption displayed an incorrect local IP address instead of the actual public IP address in the single session view. IP addresses are now captured and displayed correctly across Web, iOS, and Android.

  ***

  ## ML

  * Fixed an issue where the Proof of Address module returned synthetic placeholder address data instead of empty values when the uploaded document was of insufficient quality for address extraction. The module now correctly returns empty or null values in these cases.
  * Updated the ID validation service with the following model improvements:
    * Fake ID Check 1.18 — new text-based rules added
    * Screen ID Liveness 7.0
    * Paper ID Liveness 7.0
    * Damaged ID 3.11
    * ID Alteration 3.11
    * Deepsight for Documents 3.11
    * Voided ID 3.11
    * Barcode PDF417 1.13
  * The Colombia birth certificate document type now supports extraction of the place of birth field.

  ***

  ## ID Templates

  ### New supported templates

  **Mexico**

  * Digital Insurance Agents ID / DIGITAL\_INSURANCE\_AGENTS\_ID\_PDF / 2026

  **Nicaragua**

  * Identification Card / IDENTIFICATION\_CARD / 2026

  **United States of America**

  * **Oklahoma**
    * Identification Card / IDENTIFICATION\_CARD / 2026

  ### New classification support

  **United States of America**

  * Tribal Identification / TRIBAL\_IDENTIFICATION\_CARD / 1946
  * **Oklahoma**
    * Identification Card / IDENTIFICATION\_CARD / 2026

  ### **Changes to current templates**

  FEATURE UPDATE

  **Bolivia**

  * Passport / NATIONAL\_PASSPORT / 2018 r5

  **Germany**

  * Driver's License / DRIVER\_LICENSE / 2013 r2

  **Ghana**

  * Voter Identification Card / VOTER\_IDENTIFICATION\_CARD / 2010 r2

  **Guatemala**

  * Identification Card / IDENTIFICATION\_CARD / 2016 r5

  **Portugal**

  * Driver's License / DRIVERS\_LICENSE / 2014 r1

  **United Kingdom**

  * Driver's License / DRIVER\_LICENSE / 2022 r1

  ID OCR EXTRATION IMPROVEMENT

  **Argentina**

  * Identification Card / IDENTIFICATION\_CARD / 2023 r4

  **Ghana**

  * ECOWAS Card / ECOWAS / 2019 r3

  **Guatemala**

  * Identification Card / IDENTIFICATION\_CARD / 2025 r1

  **Indonesia**

  * Driver's License / DRIVER\_LICENSE / 2023 r1
  * Identification Card / IDENTIFICATION\_CARD / 2000 r5

  **Nigeria**

  * Identification Card / IDENTIFICATION\_CARD / 2016 r2

  **Peru**

  * Identification Card / IDENTIFICATION\_CARD / 2000 r2
  * Identification Card / IDENTIFICATION\_CARD / 2025 r1

  **Philippines**

  * Identification Card / IDENTIFICATION\_CARD / 2021 r4

  **Saudi Arabia**

  * Driver's License / DRIVERS\_LICENSE / 2012 r1

  **Thailand**

  * Identification Card / IDENTIFICATION\_CARD / 2001 r2

  **United Kingdom**

  * Driver Card / DRIVER\_CARD / 2018 r2

  **Vietnam**

  * Identification Card / IDENTIFICATION\_CARD / 1999 r2
</Accordion>

***

## 2026 May 4

<Accordion title="2026 May 4">
  _Demo: 27 April 2026 | Production: 4 May 2026_

  ## Release Highlights

  ### Redesigned Dashboard Navigation

  The Dashboard navigation panel has been redesigned. These changes provide a simpler way to interact with and navigate Dashboard in day-to-day operations.

  First, pages have been organized into a structured, grouped layout that replaces the previous flat page list. Pages are now organized into three named sections:

  * **Build & Verify**: Includes Sessions, Identities, Authentications, and Flow Builder. The Flow Builder entry expands to reveal Flows and Workflows as sub-options.
  * **Operations**: Includes Analytics, Custom Watchlists, Compliance, Escalations, Case management, and Status.
  * **Manage**: Includes Users, Configuration, Integrations, and Services. The Services entry expands to reveal Directory information, Helpdesk Verification, and Candidate Verification as related to Integrations.

  The availability of some of these pages is dependent on your configuration. Contact your Incode Representative for more information.

  Next, the organization selector moved from the top of the navigation to the bottom, keeping it out of the way during day-to-day use.

  Finally, you can now set a custom start page by clicking the star icon at the top of the navigation. Choose any page from the list and save your preference. The next time you log in, that page will open automatically. Home is selected by default.

  ## Dashboard

  ### Enhancements

  SINGLE SESSION VIEW

  * Updated the Gov Verification tab of the single session view to align with the Dashboard design system.

  eKYC

  * There is a new source for eKYC Canada called CA Credit Bureau FINTRAC. This source collects a user’s full name, address, and date of birth in onboarding. The single session view displays matching results for data collected.
  * Improved the logic for eKYC Sessions to allow for multiple additional checks to be displayed in the Session results. This means that when **Email Check**, **Phone Check**, and **Advanced Phone Check** are all configured in a Flow or Workflow, all of these checks are run during the onboarding and are displayed in the single session view results.
  * A new US eKYC source, US Credit Bureau 3, is now available for credit bureau verification. This check verifies name, date of birth, address, SSN, phone, and email against US credit bureau records, and returns individual field match results along with an overall match level. Contact your Incode representative if you are interested in this feature.

  DATA & PRIVACY

  * The minimum data mode configuration now supports immediate data deletion scoped to specific session score statuses. When **Immediate data deletion at session completion** is enabled in Configuration > Data, you can select which score statuses trigger deletion (OK, Fail, Manual, etc.) rather than applying deletion to all statuses uniformly. Deletion is also triggered when a session in Manual review transitions to a new status after approval or rejection.
  * <Pill type="update" /> Updated the maximum number of days for data deletion from 180 to 500.

  ### Fixes

  * Fixed an issue that caused Helpdesk employee search to fail. This issue only affected directories with 4000+ employees.
  * Fixed an issue that caused the Copy Flow ID and Copy Workflow URL buttons to not work in Safari.
  * Fixed the “Enabled On” filter in the Identities list so that future dates cannot be selected.
  * Updated the Workflows menu options to display “Workflow” instead of “Flow”.
  * Fixed an incorrect empty state message in Compliance > Data Management. When filters are applied that return no results, the page now displays "No sessions" instead of "No deleted data.”
  * <Pill type="update" /> Fixed an issue that caused custom watchlist matches to now display the watchlist ID in the Risk tab of the single session view. Now, when a session triggers a custom watchlist match, the matched record ID is displayed for both onboarding and authentication sessions.

  INTEGRATIONS ECOSYSTEM

  * Fixed multiple issues in the Integrations Marketplace that were introduced with its initial release.

    Functional fixes:

    * Fixed 500 errors that occurred when:
      * Updating existing Helpdesk, Candidate Verification, and Self-Serve Portal integrations.
      * Saving a Microsoft Entra Directory integration after returning from the Microsoft consent redirect.
      * Attempting to create a second Slack integration. Instead of throwing an error, this is now not an option. By design, only one Slack integration can be configured per organization.
    * Fixed a critical bug where completing the Microsoft Entra Directory admin consent flow returned a 403 Forbidden error instead of redirecting back to the Dashboard. The admin consent flow now completes successfully and redirects as expected.
    * Fixed the browser back button to correctly restore the previously selected tab when navigating away from an integration detail page.
    * Fixed a notification that incorrectly displayed "updated successfully" when creating a new integration for the first time.
    * Fixed a bug where opening an integration configuration would reload and reset unsaved changes every few seconds, preventing users from making edits.
    * Fixed a bug where searching for a term that returned no results on an integration page showed no feedback to the user. A "no results" message is now displayed.
    * Fixed a bug where generating a new client secret in an OpenID Connect integration immediately hid the value instead of displaying it to the user.
    * Fixed a bug where a hardcoded "Workflow1" entry appeared in the workflow selection list for every integration, even when no such workflow existed. The list now correctly reflects only the workflows that have been created.
    * Fixed a missing "Identity verification with a third-party" configuration section that was absent from the Okta IDV Standard integration page.
    * The browser now correctly preserves the current integration page on refresh, rather than redirecting back to the previous integrations list.

    Visual and design fixes to align with the design system include:

    * Incorrect text headings, fonts, and colors across integration detail pages
    * Incorrect image sizes and missing image borders
    * Incorrect logos for Microsoft Entra, Ashby, and OpenID Connect
    * Incorrect background colors for ATS & HR category integrations
    * "Coming soon" section incorrectly displaying with a grey overlay
    * Added a missing demo video on integration detail pages.
    * Fixed broken title and description text for OpenID Connect on the Marketplace page
    * Fixed incorrect authentication method heading and Generate button styling in the Okta IDP integration
    * Fixed the broken Generate button and adjusted styling for the Microsoft Entra integration
    * Fixed incorrect field placeholders, titles, and headings in the OpenID Connect integration

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * Standardized the placement of error messages in the eKYC Verification module. Error messages for all fields are now displayed under the field.
  * Changed the color contrast level on the Unsupported Browser screen to align with a11y standards.
  * The Web SDK now supports the `alwaysCaptureBackOfId` flow configuration flag. When enabled, back-of-ID capture always proceeds regardless of front ID classification result. When disabled or not set, the existing behavior is preserved — back ID capture is skipped if classification fails on the front.
  * The KYB onboarding form now validates tax ID format before submission and displays a clear error message when the entered value does not match the expected format for the selected country. Supported formats include CNPJ for Brazil, company registration and VAT numbers for the UK, VAT and registration formats for Germany, the Netherlands, Spain, and Italy, RFC formats for Mexico, and several others. Previously, an invalid tax ID resulted in a generic error after submission.
  * <Pill type="update" /> Updated the expired ID error screens in the Web App to display messaging specific to the expired ID state, including the list of accepted document types where applicable. Also fixed several related issues: retry counters now persist correctly across page refreshes, redirect logic between front and back ID capture works reliably in all flows, and attempt counters are displayed accurately throughout the capture experience.
  * <Pill type="update" /> The Face Match step in the Web App no longer makes a redundant call to retrieve scores after processing a face. The face match result is now determined directly from the face processing response, reducing unnecessary API calls during the step.

  ### Fixes

  * Fixed the US Smart Capture flow to display the correct instructional messaging for ID Capture.
  * Fixed an issue that caused sessions with multiple document capture modules (including proof of address) to only execute the first one and skip any after that. Now, multiple document capture modules can be used in a single session.
  * Fixed element alignment and spacing in the Geolocation step to match the specifications from the design system.

  ***

  ## Server

  ### Enhancements

  * The platform now verifies encrypted barcode data on driver's licenses and IDs from both South Carolina and Wisconsin. This validation improves document authenticity checks for credentials issued from these states.
  * The maximum session retention period for automatic deletion has been extended from 180 days to 500 days, giving organizations greater flexibility in configuring their data retention policies.
  * Improved the accuracy of Mexican car invoice (Proof of Address) validation by extracting issuer RFC, recipient RFC, and digital tax stamp UUID from the document's QR code. These QR-derived values are returned as new fields alongside the existing OCR-extracted fields.
  * Updated extraction logic for Colombian driver's licenses to support documents with multiple expiration dates across different vehicle categories. Previously, only the first expiration date was extracted, which could cause incorrect rejections for licenses that remain valid for other categories.
  * A new API endpoint, `/omni/b2b/v1/authentications/add-selfie-to-identity`, allows you to add a selfie from an existing session to a user's identity. This supports automated selfie update workflows without requiring manual intervention through the dashboard.
  * The platform now enforces end-to-end encryption for face result submissions. Requests that do not use encryption will return an access denied error unless the organization has explicitly enabled non-encrypted submissions.
  * Removed a legacy behavior that could override a liveness Fail result with a Warn status when the score fell in a specific range. Liveness scores are now passed through directly from the ML model, ensuring scoring accuracy and preventing potential Deepsight bypass.
  * The US KYB API response for business name now returns "Unverified" instead of "Alternate Name" when a TIN is associated with a different business. A separate "Mismatch" label in the TIN task response has also been standardized to "Unverified.”
  * The US KYB API response for business name now consistently returns "Approximate Match" instead of "Similar Match," bringing it in line with the standardized KYB response format used for all other countries.
  * Updated event logging for the document signing endpoints (`/process/sign` and `/process/signQes`) to distinguish between certificate generation calls and actual signing calls. This corrects analytics data that previously double-counted signing events.
  * The Pushed Authorization Request (PAR) endpoint now accepts optional `customFields`, which are passed through to the session start call. This restores the ability to include custom metadata at session initiation when using OAuth2-based flows.
  * Updated the reminder configuration for QES (Qualified Electronic Signature) requests sent through Trust Cloud. Signature request reminders are now sent less frequently, reducing notification volume for end users waiting to sign documents.
  * <Pill type="update" /> Continued improvements to Brazil eKYC name matching accuracy. The updated logic enforces correct name order. If first and last names are swapped in the input, the result is now returned as No Match rather than a partial match. Additionally, at least 50% of the full name string must now match the source of truth to be considered a Match or Approximate Match, reducing false positives on partial name overlaps.
  * <Pill type="update" /> Improved phone number validation to block numbers identified as invalid or suspicious, including formally invalid numbers, even when the validation service returns a non-authentication-related error. Also fixed an issue to prevent sensitive data being exposed in endpoint URLs during validation calls.
  * <Pill type="update" /> Added a face quality filter for Facial Validation and Face and Data Validation in select regions. Prior to sending a session to a Government Verification provider, the system now evaluates the quality of the captured selfie image to filter out poor-quality selfies, reducing error rates caused by quality-related failures (e.g. connection errors or incorrectly rejected sessions). Contact your Incode Representative for more details.
  * <Pill type="update" /> Video Selfie recordings can now be uploaded via a dedicated API endpoint using multipart upload, as an alternative to the pre-signed S3 URL approach. This supports environments where direct S3 access is not permitted. The video is split into chunks of up to 10 MB each; the client initiates the upload, sends chunks sequentially, and calls a completion endpoint to signal that the upload is finished. Contact your Incode Representative if you are interested in this feature.
  * <Pill type="update" /> There is a new setting in the Custom Watchlist module called **Use fallback search**. When enabled, this setting ensures a fallback solution for fetching records. If the primary identifier doesn’t match, the system will attempt a secondary match using other watchlist fields. This increases match coverage, but it also may increase false positives. This setting is off by default.
  * <Pill type="update" /> Added a new fallback government validation provider for Peru (RENIEC) to improve approval rates and reduce verification failures when the primary provider underperforms. This helps maintain onboarding continuity by routing eligible Peru gov-validation checks through the fallback when needed, minimizing drops in pass rates and the need for workarounds or reverts to a different integration.

  ### Fixes

  * Fixed a issue where the full name field was incorrectly overwritten with the mother's name value during document processing for Brazilian IDs. Full name is now returned accurately.
  * Fixed a parsing error that caused the First Name field to always return as FAIL in responses, regardless of the actual verification result. First Name now correctly reflects the verified status.
  * Fixed an issue where ID-only sessions returned a Deepsight overall score without a numeric value. Deepsight now consistently returns a numeric score of 100.0 when the status is Pass and no face capture is included. Deepsight requires additional licensing. Contact your Incode Representative for more information.
  * Fixed a bug where the eKYC source was not being saved correctly for Nigeria NIN verification. The configured source is now persisted and returned as expected.
  * Fixed a bug where flows configured with External Policy (Claims Matching) would return a 500 error when a PAR request was not used. The flow now completes successfully in this configuration.
  * Fixed a bug where the liveness/physical attack score was counted twice when calculating the total face authentication score. The Face Authentication score is now calculated correctly.
  * Resolved the root cause of intermittent 500 errors occurring on the `/add/front-id/v2` and `/add/back-id/v2` endpoints. These endpoints now handle edge cases that previously caused server errors.
  * Fixed a 500 error that occurred during certificate issuance when a password was included in the request. Certificate issuance now completes successfully.
  * Fixed a bug where the `/omni/add/rfc-by-curp` endpoint was not storing CURP validation results in the session. Both CURP and RFC results are now stored and returned by `omni/get/scores`, and the RENAPO check is now visible in the Dashboard without requiring a separate `omni/add/curp` call.
  * Fixed a critical bug where users were not redirected after completing a successful verification session in an OAuth2-secured flow, preventing them from obtaining an authorization code. Redirection now completes as expected following successful verification.

  ***

  ## ML

  * Fixed an issue where name casing normalization applied to Mexican residence documents was interfering with server-side name splitting logic. Name fields on Mexican Temporary Residence Cards, Permanent Residence Cards, and Visitor Permits are now returned with consistent casing that supports accurate field parsing.
  * Updated the document readability model to use mean aggregation instead of minimum score aggregation, and adjusted the detection threshold accordingly. This reduces false rejections on documents where a single word or region scores below threshold, improving acceptance rates for legible documents.

  ***

  ## ID Templates

  ### New supported templates

  **Cameroon**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2023

  **Ethiopia**

  * IdentificationCard / DIGITAL\_IDENTIFICATION\_CARD / 2025

  **Mexico**

  * Other / DIGITAL\_CURP\_CERTIFICATE\_FOR\_MEX\_CITIZENS\_PDF / 2026
  * <Pill type="update" /> IdentificationCard / DIGITAL\_INSURANCE\_AGENTS\_ID\_PDF / 2026

  **Slovenia**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2020

  ### New classification support

  **Cambodia**

  * ResidenceDocument / PERMANENT\_RESIDENCE\_CARD / 2025

  **Iraq**

  * ResidenceDocument / IMMIGRATION\_CARD / 2023

  ### **Changes to current templates**

  ID OCR EXTRACTION IMPROVEMENT

  **Cameroon**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025 r1

  **Colombia**

  * DriversLicense / DRIVER\_LICENSE / 2013 r3

  **France**

  * DriversLicense / DRIVER\_QUALIFICATION\_CARD / 2020 r1

  **India**

  * **Karnataka**
    * DriversLicense / DRIVERS\_LICENSE / 2005 r2

  **Ivory Coast**

  * DriversLicense / DRIVERS\_LICENSE / 2014 r1

  **Japan**

  * DriversLicense / DRIVER\_LICENSE / 2000 r2

  **Mexico**

  * ResidenceDocument / TEMPORARY\_RESIDENCE\_CARD / 2022 r3

  **Netherlands**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2014 r2

  **Philippines**

  * IdentificationCard / DISABILITY\_IDENTIFICATION\_CARD / 1987 r1
  * IdentificationCard / IDENTIFICATION\_CARD / 2023 r2 — Updated to cover both physical and digital card variants, improving OCR accuracy for on-screen and laminated digital IDs.

  **Rwanda**

  * IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2022 r1 — Corrected field extraction order for full name.

  **South Korea**

  * DriversLicense / DRIVER\_LICENSE / 2000 r6 — Resolved misclassification of 2000-series licenses as 2020, and fixed full name extraction.
  * DriversLicense / DRIVER\_LICENSE / 2020 r4

  **United States of America**

  * **California**
    * DriversLicense / DRIVERS\_LICENSE / 2018 r3
</Accordion>

***

## 2026 April 20

<Accordion title="2026 April 20">
  _Demo: 13 April 2026 | Production: 20 April 2026_

  ## Release Highlights

  ### INE Fingerprint Validation

  You can now configure fingerprint capture and validation as part of the Mexican INE (Instituto Nacional Electoral) government identity verification flow. In the Government Record Verification module, when Mexico is the selected country, three new fields are available:

  * Fingerprint Validation
  * Minimum Passing Fingerprints
  * Fingerprint Match Override Score

  When this feature is configured in a Workflow or Flow, users can upload biometric fingerprint data alongside facial and ID information during an onboarding session. This data is then submitted to INE for identity confirmation. The platform automatically selects the optimal fingerprints to submit, preferring a matched pair from both hands, and returns per-finger confidence scores alongside face match results and ID data comparison results.

  This feature supports both remote and in-person (assisted) onboarding modes and is compatible with ANSI, WSQ, and RAW fingerprint image formats. Contact your Incode representative if you are interested in this feature.

  ## Dashboard

  ### Enhancements

  WORKFLOWS & FLOWS

  * Updated the Workflow Builder canvas to improve usability. Changes include:
    * Made the add-node button is always visible (previously hover-only)
    * Added a ghost node preview on hover
    * Display node descriptions with consistent color-coded icons in the add-node dropdown

  MODULES

  * There is a new setting in the Face Capture module called **On-Device Processing**. This setting allows you to enable on-device liveness and age verification, supporting use cases where biometric images must not leave the SDK. Contact your Incode Representative to enable this feature in your organization. Once available, the setting is Off by default.
  * <Pill type="update" /> Added support for Directors in the KYB onboarding flow. When Directors are enabled in the KYB module configuration, an optional Directors input field is available in the onboarding form, similar to the existing UBOs field. Directors and UBOs can be enabled independently. Director input is supported for organizations in the UK, France, Spain, Netherlands, Italy, and Germany.

  CONFIGURATION

  * There are two new settings in Configuration > Data:
    * **Immediate data deletion at session completion**: When enabled, session PII data is deleted as soon as a session is completed, rather than following the organization's scheduled retention policy.
    * **Retain onboarding selfie & face template for authentication**: When enabled, the user's selfie image and face template are preserved after session completion to support re-authentication and claims matching. If any claim-matching fields are configured for retention, this setting must also be enabled. Disabling this setting will clear all claim-matching field selections.

  SINGLE SESSION VIEW

  * Improved the Gov Verification tab in the single session view to display data fields in a more logical order.
  * Added a results display for fingerprint government validation in the single session view. The tab shows pass/fail status for each submitted finger across left and right hand sections, with color-coded indicators for matched, unmatched, and unavailable fingers. A summary banner displays the number of fingerprints matched against the number required to pass. Optional metadata such as device, resolution, image type, and quality score are shown when available.
  * <Pill type="update" /> The single session view now displays additional detail for face ML model results, including a category classification and a text-based description to help explain the outcome of liveness and spoof detection checks.

  OTHER

  * Added French-Canada (fr-CA) as a selectable language when creating custom consent screens.

  ### Fixes

  SESSION RESULTS

  * For sessions with more than one attempt, fixed an issue where Dashboard showed the Fake ID Check result from the first verification attempt instead of the most recent one.
  * Fixed an issue where a rule applied to second ID validation was being displayed in the first ID section of the single session view.
  * Fixed an issue where the Claims Match status did not automatically update after a manual review request was approved or rejected.
  * Fixed an issue where sessions failed to display when the candidate session modal was reopened for the same identity.

  WORKFLOWS & FLOWS

  * Fixed the preview panel in the Flow Builder so that modules are displayed in the order they execute during onboarding rather than mirroring the module list.
  * Fixed an issue where leaving the Workflow Builder without saving could leave an async node in an invalid position, causing a 400 error when attempting to re-open the workflow for editing.
  * Fixed an issue with Conditions in Workflows that caused the last step to be deleted if any previous step was deleted.
  * Updated the Flow Builder “unsaved changes” confirmation dialog so that all text is visible. Previously, there was a heading in white text on a white background.

  FILTERS & DATA DISPLAY

  * Fixed an issue where combining the "Created At" and "Number of Sessions" filters on the Workflow list returned no results.
  * Fixed an issue in Safari where the arrow navigation in date picker filters did not change the displayed month.
  * Fixed an issue where applied filter labels displayed the placeholder text "Selected title" instead of the filter name. This change was applied to filters for Workflows, Escalations, Custom Watchlist, and Compliance.
  * Fixed an issue with date range filters where the start and end date labels appeared in reversed order.
  * Fixed an issue where sorting Identities by Last Verification had no effect.

  INTEGRATIONS

  * Fixed an issue that prevented users from adding more than one redirect URI when creating or editing an OIDC integration.

  ACCESSIBILITY

  * Fixed a keyboard navigation issue where the toggle inside the Live Flow button received its own focus state. This fix aligns with WCAG 2.2 AA standards.
  * Fixed WCAG accessibility issues in the Flow Builder search filter, including a missing region role/aria-label on the wrapper and missing live region announcements for filter results.
  * Updated the color values for the "YES" and "NO" branch labels in the Workflow Builder condition node to meet WCAG 2.2 AA contrast requirements.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  DESKTOP CAPTURE

  * Updated desktop ID capture to attempt the highest available resolution first and step down only on failure. This means that images captured at up to 1920×1080 are now possible on desktop.

  FORMS

  * Updated dropdown fields in custom forms to show a "Select option" placeholder as the default selected value, requiring users to make an explicit selection before the Done button is enabled.

  DOCUMENT CAPTURE

  * <Pill type="update" /> The web document capture flow now supports a variable number of pages for multi-page document types. After capturing the first page, users are prompted to add additional pages or finish the submission. All pages are submitted as part of the same document session, and previously captured pages are preserved if an error occurs.

  ### Fixes

  eKYC

  * Fixed an issue in the eKYC form where a submission error for the postal code field persisted alongside a new inline validation error when the user began re-entering the field.
  * Fixed an issue where clicking the Address field in the eKYC form did not move focus to the input on iOS, requiring users to scroll up to see what they were typing. A minor focus glitch on Android was also resolved.
  * Fixed an issue where the Address field could not be typed into on eKYC forms. Additionally, ensured the mandatory state of fields was respected prior to submission.

  FACE CAPTURE

  * Fixed feedback messages during face capture appearing too far from the face capture frame and too close to the bottom of the screen.
  * Fixed an issue introduced by webcam resolution updates that caused the desktop face capture camera preview to be excessively zoomed in, requiring users to move far from their camera to fit their face in the frame. This issue was resolved for both UXv1 and UXv2.
  * Fixed an issue where both auto capture and manual capture were completely non-functional during selfie capture in Incode Verify V2 flows.

  ANDROID WEB VIEW

  * Fixed an issue on Android 8 devices where tapping and holding within the face capture frame caused the touchscreen to become fully unresponsive, requiring a hard reset to recover.
  * Fixed an issue on the HONOR 200 Lite (Android 14) where the screen went black during face capture and subsequently blocked all web flows from accessing the camera, requiring a device restart to resolve.

  OFFLINE MODE

  * Fixed the Retry button being unresponsive when Incode ID is used with FMF verification in offline mode.
  * Fixed QR code misalignment when saving as PDF on Android devices during offline mode. QR codes are now centered and fully displayed regardless of paper size or orientation.

  PRIVACY & NAVIGATION

  * Fixed an issue where refreshing the Privacy Center page loaded the Privacy Policy screen instead, and navigation back to the Wallet was unreliable until the page was refreshed again.

  GENERAL

  * Fixed a blank screen displayed when launching an onboarding session from a workflow link.
  * <Pill type="update" /> Fixed an issue in the Accept and Sign (AES) screen where the terms and conditions hyperlink was not functional, preventing end users from accessing linked content during the document signing step.
  * <Pill type="update" /> Fixed an issue where tutorial media assets embedded in web-based onboarding flows were inadvertently loading non-essential cookies during end-user sessions. Affected assets now load without passing website-level cookies, ensuring end-user workflows remain isolated from site-level cookie behavior.
  * <Pill type="update" /> Resolved an issue where consent links in embedded and web flows caused broken navigation and resulted in empty sessions. Consent link handling has been corrected to maintain proper flow state.

  LOCALIZATION

  * Fixed error message translations not being applied on the phishing resistance error screen.

  CUSTOMIZATION

  * Fixed the "Continue on Desktop" button on the mobile redirection screen not respecting the custom color set in Dashboard settings.

  EMAIL

  * Fixed emails from the Candidate Verification module incorrectly displaying "Help Desk Verification" instead of "Candidate Verification" in the email content.

  FAN ID

  * Fixed the 'Registration of minors' icon rendering at a larger size than other icons, with misaligned text, in the Tips for Best Experience section on desktop.

  ACCESSIBILITY

  * <Pill type="update" /> Fixed WCAG accessibility issues on the mobile redirect screen:
    * The QR code image was missing an accessible label
    * Instructional text did not meet minimum color contrast requirements
    * Focus was not directed to the page heading for screen reader users.
  * <Pill type="update" /> Fixed a WCAG 2.2 AA compliance issue where animations on ID capture and face capture tutorial and capture screens ran indefinitely without a way to stop them. Animations now end within 5 seconds.
  * <Pill type="update" /> Updated the unsupported browser screen in IDV2 to:
    * Use the updated design
    * Display before the Start screen is shown
    * Meet WCAG 2.2 AA accessibility requirements including sufficient color contrast and correct screen reader handling for decorative images.
  * <Pill type="update" /> Resolved an accessibility issue where users navigating the Combined Consent (Data Sharing Consent) screen with VoiceOver were unable to interact with checkboxes or proceed through the flow. Consent checkboxes are now properly accessible to assistive technologies, and the screen includes appropriate ARIA labeling and focus management.

  ***

  ## Server

  ### Enhancements

  ID CAPTURE

  * When Deepsight is enabled, liveness checks now run whenever any liveness check type is selected, regardless of whether the physical check is turned on. Previously, liveness was not executed if the physical check was disabled. Deepsight requires additional licensing. Contact your Incode Representative if you are interested in Deepsight.
  * Improved city extraction from Canadian ID barcodes for Nova Scotia 2017 templates.
  * Added support for the "T" (Transgender) gender value in OCR extraction, barcode parsing, and validation for Colombian National IDs issued starting in 2026.
  * Added backend support for a new credential emission number field extracted from Mexican INE documents via Proof of Address processing.

  DOCUMENT CAPTURE

  * <Pill type="update" /> Additional fields from Finance Settlement Letter (FSL) documents are now available for use in crosschecks and rules. The vehicle registration number can be crosschecked against other document fields, and new presence-based rules are available for FSL-specific data points including vehicle registration number, agreement reference, account number, sort code, and settlement figure.

  eKYC

  * Added support for US address verification via a new eKYC source (`US_Address_1`). This integration validates US street addresses against USPS deliverability data and returns granular match results for street, city, state, and ZIP code, as well as name matching, deliverability status, address validity, and risk-level reason codes. Contact your Incode Representative if you are interested in this feature.

  eKYB

  * <Pill type="update" /> The UK KYB flow now accepts 9-digit VAT numbers without a country prefix. When a 9-digit tax ID is submitted, the country prefix is automatically appended before the verification request is sent, reducing submission errors for users who enter the numeric portion of their VAT number only.

  LIVENESS & FACE PROCESSING

  * Updated the face processing service to use an improved face occlusion model, providing more accurate detection across low, medium, and high severity levels.

  ON-DEVICE PROCESSING

  * Added a new endpoint for submitting face validation results processed on-device, supporting use cases where biometric data must not leave the SDK. This feature is disabled by default. Contact your Incode representative if you are interested in this feature.

  DATA & PRIVACY

  * Added support for configuring minimum data retention on the Omni platform. Organizations can now specify which claim matching fields to retain after session cleanup via the removal policy settings.
  * <Pill type="update" /> Improved disaster recovery data replication reliability. The replication process now uses the same session approval method as the source environment, and correctly handles cases where a session already exists in the target environment, preventing data duplication when replication runs more than once.

  SECURITY

  * Updated the CryptoService to use FIPS-compliant cryptographic libraries. This change has no impact on external behavior.

  GOVERNMENT VALIDATION

  * <Pill type="update" /> Middle name is now included when performing government validation for Colombia, improving identity match accuracy and reducing fraud risk for users with middle names on their government-issued documents.

  ### Fixes

  DEEPSIGHT

  * Fixed an issue where the score API response was missing the Deepsight component in the reason message when a session ended in warning status due to Deepsight thresholds. Deepsight requires additional licensing. Contact your Incode Representative if you are interested in Deepsight.

  ID CAPTURE

  * Fixed a caching issue in ID capture pre-processing where documents submitted with different ID type parameters were incorrectly returning cached results from a prior request.
  * Fixed an issue where the full name field for Brazilian Identification Cards (2020) issued in the state of Amapá was incorrectly extracted with "AMAPÁ" included as part of the name.
  * Fixed MRZ line format and composite check digit validation failures affecting Korean passports.
  * Fixed an issue where US Smart Capture mode was not functioning correctly on Android and iOS, causing the flow to proceed as a standard front + back + selfie capture instead of the Smart Capture flow.

  WEBHOOKS

  * Fixed an issue where webhook authentication configuration was missing for organizations created via cloning, causing webhook auth updates to fail.

  GENERAL

  * Fixed an incorrect class reference in the Risk AI flow module configuration that was causing Risk AI flows to fail.

  ***

  ## ML

  * Updated Fake ID Check to add text-based validation rules for Polish, American, Filipino, and British documents.
    * <Pill type="update" /> Extended US text-based validation rules to additional state-issued driver's licenses and ID cards.
  * Updated Barcode PDF417 to introduce validation warnings for additional barcode fields and reduce both false rejections and false accepts.
  * Added extraction of the credential emission number field from Mexican INE documents via Proof of Address processing.
  * Improved extraction of name, full address, and issue date from EU and UK Proof of Address documents.
  * <Pill type="update" /> Updated the digital liveness detection model to v10.2.0. This release significantly improves detection of synthetic face spoofs, including deepfake-generated images, reducing missed spoof detections from approximately 75% to under 5% for the affected attack types. Performance on other hard synthetic spoof categories is also improved.

  ***

  ## ID Templates

  ### New supported templates

  **Federated States of Micronesia**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Guinea**

  * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2017

  **Iceland**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2020

  **India**

  * **Bihar**
    * DriversLicense / DRIVERS\_LICENSE / 2024

  **Laos**

  * IdentificationCard / IDENTIFICATION\_CARD / 2024

  **Moldova**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2023

  **United States of America**

  * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1905
  * **Oklahoma**
    * DriversLicense / DRIVERS\_LICENSE / 2026

  ### New classification support

  *<Pill type="update" />* **China**

  * TravelDocument / EXIT\_ENTRY\_PERMIT / 2014

  **Dominican Republic**

  * DriversLicense / DRIVERS\_LICENSE / 2026

  **Ecuador**

  * DriversLicense / DRIVERS\_LICENSE / 2015

  **Romania**

  * ResidenceDocument / RESIDENCE\_CARD / 2020

  **United States of America**

  * **Oklahoma**
    * IdentificationCard / IDENTIFICATION\_CARD / 2026

  ### **Changes to current templates**

  ID OCR EXTRACTION IMPROVEMENTS

  **Andorra**

  * Passport / NATIONAL\_PASSPORT / 2017 r2

  **Australia**

  * **Tasmania**
    * DriversLicense / PROVISIONAL\_DRIVERS\_LICENSE / 2015 r4

  **Brazil**

  * FederalID / DOMESTIC\_IDENTIFICATION\_CARD / 2004 r5
  * FederalID / IDENTIFICATION\_CARD / 2020 r6

  **Colombia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020 r4

  **Ireland**

  * DriversLicense / DRIVER\_LICENSE / 2013 r1

  **Malaysia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2012 r3

  **Mexico**

  * **Baja California Sur**
    * DriversLicense / DRIVERS\_LICENSE / 2016 r1
  * **Puebla**
    * DriversLicense / DRIVERS\_LICENSE / 2018 r1

  **Netherlands**

  * DriversLicense / DRIVER\_LICENSE / 2018 r6
  * IdentificationCard / IDENTIFICATION\_CARD / 2014 r5

  **Nigeria**

  * IdentificationCard / IDENTIFICATION\_CARD / 2022 r4

  **South Korea**

  * Passport / NATIONAL\_PASSPORT / 2008 r4 - Incode MRZ
  * Passport / NATIONAL\_PASSPORT / 2022 r4 - Incode MRZ

  **Ukraine**

  * Passport / NATIONAL\_PASSPORT / 2015 r5

  **United States of America**

  * **Hawaii**
    * DriversLicense / DRIVERS\_LICENSE / 2021 r2 - Incode OCR
  * **Mississippi**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2024 r2
  * **New York**
    * DriversLicense / LEARNERS\_PERMIT / 2022 r3
  * **North Carolina**
    * DriversLicense / LEARNERS\_PERMIT / 2024 r2
  * **US Virgin Islands**
    * DriversLicense / DRIVERS\_LICENSE / 2018 r2
  * **Vermont**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2019 r2
  * **Wisconsin**
    * DriversLicense / DRIVERS\_LICENSE / 2023 r2
</Accordion>

***

## 2026 April 6

<Accordion title="2026 April 6">
  _Demo: 30 March 2026 | Production: 6 April 2026_

  ## Release Highlights

  ### Updates to Expired ID Handling

  <Callout icon="📘" theme="info">
    Currently available for Web implementations only.
  </Callout>

  Starting in this release, expired documents are always detected, classified, and flagged. This impacts the clarity and accuracy of reporting and downstream workflows, especially for compliance and audit use cases. The **Document Expiration Detected** test determines the expiration status of the document as a fact, but does not impact the score or the result.

  You still control whether an expired document should block the user. When a document is determined to be expired, the **Document Expired** test evaluates it against your configurations to determine if the session should pass or fail. By default, expired IDs are not accepted. If you want to specify a different policy, you need to configure the **Disable Expiration Date Check** and **expiration tolerance** settings in the ID Validation module.

  With the changes in this release, even if you choose to allows expired IDs, reviewers still have full visibility that the ID was expired in the session results for compliance and audit needs.

  If you choose to not accept expired IDs, users get clear and immediate feedback in the Onboarding flow and will be prompted to try a different ID. This helps reduce cases where users complete the full flow only to fail at the end due to using expired ID.

  ***

  ## Dashboard

  ### Enhancements

  **General**:

  * Updated the UI and behavior for fields in the Integrations section to align with the look and feel of the rest of Dashboard.
  * When creating or editing a user with the “Executive with custom permissions” role, you can now assign them permissions related to Directory Information, Integrations, Helpdesk verification, and Candidate verification.

  **Single Session View**:

  * The Government Verification tab in the single session view has been updated with the following improvements:
    * **Updated terminology**: "Gov Verification" has replaced "Gov Validation" to align with the official naming convention for the feature.
    * **Streamlined section titles**: "Data Match" and "Face Match" have replaced redundant "score" labels.
    * **Clarified comparison labels**: "Document Data vs Government DB Data" and "Selfie vs Government DB Portrait"
    * **Reordered layout**: Data Match is placed before Face Match to reflect the actual verification workflow.
      These enhancements unify the look and feel of the Gov Verification tab with other areas of Dashboard to deliver a more intuitive experience that helps teams quickly understand and act on identity verification results.

  * Added a new field to the ID OCR section of the single session view called **Credentials Provider**. When the ID submission method is *Imported credential* (as opposed to camera capture or manual entry) this field displays whether the import came from Apple, Google, or Digilocker.

  * Improved the Government Verification results in single session view to align the design system used elsewhere in Dashboard.

  **Workflows & Flows**:

  * There is a new setting in Workflow and Flow settings called **Enable new user experience**. This setting allows administrators to enable UXv2 at the Workflow/Flow level, which helps control when and how you roll out enhanced interface improvements to their end users. UXv2 must be enabled on the backend by your Incode representative before this setting is visible.
  * Implemented multiple WCAG accessibility improvements in the Workflow builder and settings. Improvements include new aria-labels for several fields and more descriptive labels for option buttons on nodes. These improvements ensure a quality experience for users that rely on assistive technologies.
  * Implemented multiple WCAG accessibility improvements in the Flow builder and settings. Improvements include ensuring links are focusable and indicated as links, adding missing heading labels, correctly assigning aria-labels to buttons, and improving the usability of the search filters. These improvements ensure a quality experience for users that rely on assistive technologies.

  **Modules**:

  * The Image Quality check in Face Capture and Face Authentication modules is now enabled by default and cannot be turned off. This ensures the minimum necessary quality is maintained for downstream product performance (like Deepsight or Face Match). The threshold drop-down is still editable and is set to Ultra Low by default. No existing thresholds for this check are impacted by this update.
  * Added **US TELCO 5 as** a new data source for phone-based identity verification in the US eKYC module. The Onboarding user must enter phone number as a required input, with optional name, address, date of birth, SSN, and email fields. Session results include granular match signals for individual name components (first, middle, and last name), address components, and phone activity data.
  * Added **India PAN** as a new data source for PAN-based identity verification in the eKYC module. The Onboarding user must enter name and PAN number as required inputs. Session results include match signals for PAN number and name, along with additional PAN details such as status, status description, holder type, and last updated date.
  * Removed the option for Third ID configuration support from the ID Capture module. You should use the Document Capture module instead.
  * <Pill type="update" /> You can add Phone Number Risk and Advanced Phone Number Risk checks to any eKYC source. When these checks are added, the phone number field becomes required in the onboarding flow. For eKYC sources that don’t include phone number by default, including these checks adds the required phone number field to the onboarding flow.
  * <Pill type="update" /> You can add the Email Risk check to any eKYC source. When this check is added, the email field becomes required in the onboarding flow. For eKYC sources that don’t include email by default, including this check adds the required email field to the onboarding flow.

  ### Fixes

  * Country-specific document capture settings now save reliably and display correctly in exception views. Admins can configure options for a specific document type without those changes incorrectly applying to other document types. These fixes give administrators complete visibility and control over custom configurations across all workflows and document types.
  * Fixed an issue with the Sessions list filter where applying certain date filters would switch to a different filter type.
  * Fixed an issue where the City input from eKYB was not shown in the single session view.
  * Fixed an issue where Helpdesk and Candidate Verification Sessions were not loaded and displayed in the proper order. Now, these Session lists are sorted in ascending order, with the newest at the top.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * The qualified electronic signature (QES) consent flow now includes comprehensive checkboxes to ensure full regulatory compliance with EU eIDAS standards.
  * The biometric consent experience now includes enhanced accessibility features with properly labeled headings, titles, and checkboxes. This makes it easier for all users, including those using assistive technologies, to understand and navigate the consent process with confidence.
  * <Pill type="update" /> The OTP entry field has been redesigned from six separate digit inputs into a single unified input field. This update improves compatibility with native device autofill, allowing verification codes received via SMS or email to populate automatically. Users can also paste a code directly into the field, and verification triggers automatically once all six digits are present.
  * <Pill type="update" /> Enhanced the security of data transmission during the verification flow by migrating to a more secure and performant implementation. This change provides stronger protection for user data without any change to the onboarding experience.

  ### Fixes

  * The eKYB form now includes improved error handling when users change country selections, ensuring validation messages only appear when users interact with fields.
  * Reordered the input fields in the KYB onboarding form so the mandatory fields are listed first.
  * Phone numbers captured in earlier steps now automatically populate the eKYC module including the country code, ensuring seamless data transfer and reducing user errors during identity verification.
  * The biometric consent workflow now seamlessly transitions users from ID capture to the next step.
  * The document capture experience now flows seamlessly without repeating tutorials, ensuring users can complete their verification journey smoothly, especially on devices with varying performance levels.
  * Fixed an issue with the UXv2 ID Capture and Face Capture modules on Web where manual review was not triggered after a user failed all selfie capture attempts. Manual Review now reliably triggers as expected when configured in these modules, ensuring sessions are properly routed for review when needed.
  * Fixed a UI issue in the UXv2 CURP verification step on Web where a “Try again” button could appear even though users couldn’t actually retry. The screen now only shows the appropriate next actions (for example, “Continue” or “Verify manually”), reducing confusion and keeping the onboarding flow consistent.
  * Fixed an issue that caused a configured custom subtitle to be replaced by the generic “Demo app” subtitle.
  * Fixed an issue for specific Android devices that caused the touchscreen function to stop working during the Face Capture step of Onboarding.
  * <Pill type="update" /> Fixed an issue that caused a flow to not start on devices running iOS 14.
  * <Pill type="update" /> Fixed an issue in the Forms and Data Entry module that caused the Done button to be unavailable even after all fields were filled out.
  * <Pill type="update" /> Fixed an issue where postal codes in incorrect formats were accepted without error during UK voter registration. Users who enter an invalid UK postal code will now see a validation error prompting them to enter a correctly formatted value.
  * <Pill type="update" /> Fixed a layout issue on desktop where verification flow pages were aligned to the top of the screen instead of the center. Pages now display centered on desktop as intended.
  * <Pill type="update" /> Fixed an issue where users were prompted to capture the second page of a document twice during the document capture step. The flow now proceeds correctly after the second page is captured and validated.
  * <Pill type="update" /> Resolved a performance issue that started after a prior release that caused a significant increase in onboarding session time. Model loading now completes in the expected timeframe, reducing overall session duration.
  * <Pill type="update" /> Fixed an issue on Android where the selfie tutorial was briefly displayed again after a user tapped "Try Again" following a failed selfie capture. The flow now proceeds directly to the selfie camera without replaying the tutorial.
  * <Pill type="update" /> Resolved an issue where the Deepsight liveness physical check was failing for legitimate users during onboarding in the Android Web View. The physical check now passes correctly under normal onboarding conditions.

  ***

  ## Server

  ### Enhancements

  **General**:

  * Added support for including personally identifiable information (PII) fields when exporting session data to CSV. This setting is OFF by default, but organizations that already have this capability through another method retain current behavior. Contact your Incode representative if you are interested in this feature.

  * Updated backend services to operate in FIPS-compliant mode. None of these changes affect external-facing functionality or service behavior.

  * Improved the accuracy of backside document recognition for US IDs. The system now considers a broader set of possible document types when identifying the back of a document and selects the best match based on what was captured on the front. This results in more reliable classification results.

  * Updated the Apple Wallet integration to follow security best practices for preventing replay attacks. The integration now generates a unique, single-use request token for each session, and both the native and web Apple Wallet flows now support requesting the same specific set of user data fields, ensuring a consistent experience across integration types.

  * Three new NFC-related rules are now available in the Rules Engine (Flows) and as Conditions (Workflows) under a dedicated **NFC** section:
    * **NFC Step Skipped** (Yes/No): indicates whether the user skipped the NFC scanning step
    * **NFC Data Present** (Yes/No): indicates whether NFC data was successfully captured
    * **NFC Data Integrity Check** (OK/Fail): indicates whether the NFC chip data passed integrity validation
      These can be used to enforce NFC requirements. For example, you can use these rules to automatically fail a session when NFC scanning was skipped or when a chip was expected but no data was captured.

  * Added a new configuration option, `alwaysCaptureBackId`, to the `omni/onboarding/flow` API response. This allows the frontend to control whether the back of an ID is always captured, even when front ID classification is unsuccessful. The option defaults to off to maintain existing behavior. API documentation has been updated to reflect this addition.

  * Improved Deepsight's ability to detect AI-generated and synthetic media through enhanced content provenance checks. Contact your Incode representative if you are interested in this feature.

  * The `POST omni/b2b/onboarding/request-new` endpoint now includes `interviewId` in its response, allowing downstream integrations to correlate the onboarding request with the corresponding onboarding completion webhook.

  * The Microsoft Entra ID SCIM integration now supports the `incodeDashboardRole` attribute, allowing organizations to provision and manage Incode Dashboard user roles directly through their Entra ID directory sync.

  * Improved address match logic for US KYB to handle cases where only partial address fields are provided. When a postal code is submitted without a city, `cityMatch` is no longer returned and `postalCodeMatch` reflects the verification result. When a city is submitted without a postal code, `postalCodeMatch` returns as Unverified and `cityMatch` reflects the verification result. In both cases, `addressMatch` returns as Approximate Match.

  * The OAuth Secured Sessions authorize call now accepts a `language` parameter, supporting the same ISO language tags as the standard session start endpoint. This allows the onboarding language to be specified when initiating OAuth-secured sessions.

  * Fixed an issue where certain session-related records were not fully removed when a session was deleted, including workflow execution tracking, verification results, external integration session data, capture attempts, and other associated data.

  **Government Verification**:

  * Improved the accuracy and interpretability of error codes returned by the US Government Verification API. Error codes now reflect the highest-signal result based on available information, distinguishing between input validation failures, connection errors, and provider-level results. Validation and configuration errors that prevent a provider call from being made now return `UNKNOWN` status rather than `FAIL`, ensuring results accurately reflect what the system was and was not able to determine. Refer to the [developer documentation](/general-reference/error-code-changes-for-us-government-verification/) for detailed information on what’s changing and the actions you need to take. For questions about how these changes may affect your implementation, contact your Incode representative.
  * Removed raw provider response data from the US Government Verification API `fetch/scores` response. The API response now only contains fields defined for customer consumption, improving clarity and ensuring customers are not exposed to unprocessed or potentially misleading provider-specific data.
  * Updated provider labels in the US Government Verification Dashboard tab to align with current product naming. AAMVA DLDV provider displays "DMV DATA MATCH".
  * Improved the interpretability of US Government Verification session results in the Omni Dashboard. Error codes are now correctly mapped to Data Match and Government Verification summary section scores, making it easier to understand what passed or failed in a given session without additional assistance.
  * Updated the Data Match response for US Government Verification to improve consistency and completeness across providers.
  * <Pill type="update" /> Added support for a new 451 response code introduced by the government validation service used for Brazil buyer verification. The platform now correctly maps and handles this response code, ensuring accurate verification outcomes and metrics.

  **ID support requests**:

  * Added extraction of the Mother's Maiden Name field from the back of the Hungary Identification Card.
  * Improved classification accuracy for the back side of the Mexico City (CDMX) 2025 Driver's License.
  * Added support for the new Nicaragua Cédula de Identificación issued beginning February 2026.

  ### Fixes

  * Fixed an issue where the NFC Personal Number crosscheck was consistently failing for Chilean IDs, causing an incorrect deduction to the ID Validation score. The fix addresses two encoding patterns specific to Chilean IDs:
    * **Non-EXTRANJERO IDs:** The NFC chip encodes the Personal Number with a three-character MRZ prefix not present in the OCR value. The crosscheck now strips this prefix before comparison.
    * **EXTRANJERO IDs:** When the NFC chip stores only a three-character stub, the crosscheck now returns **Irrelevant** rather than a failure, since a full comparison cannot be made.
      In both cases, formatting characters (`.` and `-`) are stripped from the OCR value prior to comparison to prevent false mismatches.

  * Resolved an issue where OCR fields containing special characters caused an exception during the redaction process. The redaction logic now handles and processes special characters in OCR fields correctly.

  * Fixed an issue where deleting a Microsoft Entra directory integration returned a 500 Internal Server Error. The directory now deletes successfully without errors.

  * Fixed an issue where submitting a verification ID retrieved from a webhook to `GET omni/incode-id/verification/<verificationId>` returned an "Invalid mongo ID format" error. The endpoint now returns the expected verification data.

  * Fixed an issue where Okta directory sync could become blocked when a sync process that obtained a lock failed to release it, preventing subsequent sync attempts until the lock expired or the service restarted.

  * Fixed an issue where ML fraud checks (paper, screen, and ID alternation) produced inconsistent results depending on whether redaction or Age Assurance was enabled in the flow. These checks now behave consistently regardless of other features enabled in the flow configuration.

  * Fixed a response format mismatch in the Mexico KYB Lite API. The `name` and `tin` fields now return `Verified` or `Unverified` instead of `true` or `false`, the `registrationStatus` field now returns title-case values (`Active`, `Inactive`, `Unknown`) instead of all-caps, and the `entityType` field response structure has been updated to be consistent with other KYB country responses.

  * <Pill type="update" /> Resolved an issue where logout requests were failing with a 403 error on Demo and SaaS environments due to incorrect CORS filtering behavior. The connect/logout endpoint is now correctly allowlisted, and logout functions as expected across all environments.

  * <Pill type="update" /> Fixed an issue where the `/omni/fetch-identities` endpoint returned a 400 error instead of the expected identity list. The endpoint now returns results successfully.

  * <Pill type="update" /> Fixed an issue where the logo in Incode Verify and Workforce welcome emails was not loading due to an access error. Logos now display correctly in all outbound verification emails.

  **ID Support Requests**:

  * Fixed an issue where the "Full name (OCR)" field for the Honduras Identification Card was extracted with the extraneous label "FORENAME" included in the value.
  * Fixed an issue where the "Full name (OCR)" field for the Great Britain Passport was extracted incorrectly.
  * Fixed an issue where the "Full name (OCR)" field for the Rwanda Identification Card was returned in last name, first name order. The field now returns names in first name, last name order to match standard extraction conventions.

  ***

  ## ML

  * Deployed an updated cropping model with several improvements across document types:
    * Better alignment for pre-cropped images
    * Improvements for passports, foldable documents, and IDs in general
    * A slight improvement in barcode detection for US and Canadian documents
  * Updated the face occlusion detection model to version 0.2 for web-based onboarding sessions, improving detection of partially obscured faces during identity verification.
  * <Pill type="update" /> Improved MRZ parsing accuracy for Russian passports. The givenNameMrz and lastNameMrz fields now return only valid Latin alphabet characters, excluding numeric characters that were previously being included incorrectly.

  **Deepsight**:

  Deepsight requires additional licensing. Contact your Incode representative for more information.

  * The Deepsight liveness service now returns an `explanation` object in API responses when an attack is detected. The object includes a human-readable `description` of the rejection reason and a `keywords` block containing the attack `category` (e.g., paper, replay, 2D mask, 3D mask, face swap, synthetic face, face animation), as well as indicators for flat depth and video corruption. This makes it easier to understand and act on liveness rejection results without additional interpretation.
  * Improved the tamper-resistance of Deepsight liveness checks for web onboarding sessions. The backend now validates the Deepsight configuration against the flow settings at processing time, ensuring liveness checks cannot be bypassed through client-side modifications.

  ***

  ## ID Templates

  ### **New supported templates**

  NEW CLASSIFICATION SUPPORT

  **Ethiopia**

  * **Oromia**
    * IdentificationCard / IDENTIFICATION\_CARD / 2023

  **Indonesia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2021

  **Laos**

  * IdentificationCard / IDENTIFICATION\_CARD / 2023

  **Nicaragua**

  * IdentificationCard / IDENTIFICATION\_CARD / 2026

  **Peru**

  * DriversLicense / DRIVERS\_LICENSE / 1882

  **South Sudan**

  * IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2023

  **United States of America**

  * **Louisiana**
    * IdentificationCard / IDENTIFICATION\_CARD / 2001
  * **Tribal Indentification**
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2020
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD\_UNDER21 / 2024
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1843

  NEW ID SUPPORT

  **Liberia**

  * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2020

  **Sudan**

  * DriversLicense / DRIVERS\_LICENSE / 2022

  **Somalia**

  * **Somaliland**
    * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2021

  **United States of America**

  * **Montana**
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2025
  * **Wyoming**
    * DriversLicense / DRIVERS\_LICENSE / 2024
  * **Tribal Identification**
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1968

  ### **Changes to current templates**

  ID OCR EXTRACTION IMPROVEMENT

  **France**

  * Passport / NATIONAL\_PASSPORT / 2008 r3 - Incode MRZ

  **Honduras**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020 r3

  **Hungary**

  * IdentificationCard / IDENTIFICATION\_CARD\_FOR\_FOREIGNERS / 2016 r1
  * IdentificationCard / IDENTIFICATION\_CARD / 2012 r1
  * IdentificationCard / IDENTIFICATION\_CARD / 2016 r2
  * IdentificationCard / IDENTIFICATION\_CARD / 2022 r1

  **Mexico**

  * **CDMX**
    * DriversLicense / DIGITAL\_DRIVER\_LICENSE\_APP / 2023 r1

  **Rwanda**

  * IdentificationCard / IDENTIFICATION\_CARD / 2019 r1

  **United States of America**

  * **Montana**
    * DriversLicense / DRIVERS\_LICENSE / 2025 r1

  SENSITIVE PII REDACTION

  **United States of America**

  * **Montana**
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2025 r1 - Age assurance
</Accordion>

***

## 2026 March 23

<Accordion title="2026 March 23">
  _Demo: 16 March 2026 | Production: 23 March 2026_

  ## Release Highlights

  **Simplified Document Chooser**

  The Document Chooser in V2 has been updated to ensure a more consistent user experience and simpler customization.

  * The screen shown during Onboarding always uses a compact card layout regardless of flow or document type. This removes variability and makes UI customization more predictable.
  * The **Show document chooser screen** setting in the ID Capture module is the only control for when the screen is shown. Previously, the Document Chooser could be skipped regardless of this setting when flows were configured to expect only “ID” types.

  The Document Chooser screen is shown in Onboarding by default. To intentionally skip this screen, navigate into your Flows or Workflows and disable the **Show document chooser screen** setting in the ID Capture module.

  ## Dashboard

  ### Enhancements

  **Escalations**:

  The Escalation Management System is not available by default. Contact your Incode Representative if you would to enable this feature for your organization.

  * When creating an Escalation, the value selected in the **Escalation Reason** drop-down dynamically changes the options available in the **Issue** drop-down. Additionally, the **Comment** field is now required for most **Escalation Reasons**. These improvements provide a simpler experience while creating the escalation and more clarity in the escalation once it is submitted.
  * There are two new options in the **Escalation Reason** drop-down when creating an escalation: *Classification* and *ID Validation Crosscheck*. These options populate several new options in the **Issue** drop-down as well:
    * Classification Issue possibilities: Unknown Classification, Incorrect Classification
    * ID Validation Crosscheck Issue possibilities: Document number crosscheck, Personal number crosscheck, Reference number crosscheck, Sex crosscheck, Full name crosscheck, Birth date crosscheck, Expiration date crosscheck
  * When an escalation is first submitted, it now has the status of “Opened”. Previously, all escalations started as “In Progress”, which could be a misrepresentation of its actual status.

  **Workflows and Flows**:

  * Added tooltips to Deepsight settings in Workflows, Flows, and individual module configuration. This provides more context about the settings while you are viewing them, giving you more confidence in your configuration. Deepsight requires additional licensing. Contact your Incode Representative for more information.
  * You can now configure Workflow conditions related to **Claim matching result** and **Claims matching error type**.
    * A **Claim matching result** condition can be configured with *Pass* or *Fail*.
    * A **Claim matching error type** condition can be configured with *Claims not found for identity* or *Claims match failed*.
  * You can now configure Workflow conditions related to **Id expiration offset days**. This allows you to build on the **Expiration tolerance** setting from ID Validation to granularly decide how to handle expired IDs based on how close to the expiration date it is.
  * When building a Workflow, Watchlist Business is now listed with the Modules rather than the Processes. When Watchlist Business is added without eKYB, the configuration options for **Business Name** and **Business Country** default to *Input.* In Onboarding, these fields accept user input rather than using the eKYB data. This update was made for Flows in the previous release.

  **Modules**:

  * Simplified the eKYC module configuration to hide redundant settings when **Country** is set to *Global*.

  **Helpdesk and Candidate Verification**:

  * Improved session search within Helpdesk and Candidate integrations so you can find all sessions associated with a given integration reference more reliably. This includes configurable fallback behavior based on your `disableVerification` setting.
  * Enhanced the filters on the Candidate and Helpdesk Verification sessions lists. You can filter by Name, User Identifier, Last Update, Score, and Session Status.
  * <Pill type="update" /> Switched the endpoints that are called from the Helpdesk and Candidate Verification pages:
    * `GET v1/dashboard/validate-phone`  switched to `POST  /omni/applicant/validate-phone`
    * `POST  /v1/workforce/employee/directory`  switched to `POST  /omni/employees/directory`
    * `POST  /v1/workforce/candidate/directory`  switched to `POST  /omni/candidates/directory`

  ### Fixes

  * Fixed an issue that was causing Sessions from other organizations to show in the Directory Information page.
  * Fixed an issue where the image from Face Authentication was not cropped in the single session view when the session was run on desktop.
  * Fixed an issue with Candidate Verification and Helpdesk Verification that was causing sessions to not be shown.
  * <Pill type="update" /> Fixed an issue that caused the Onboarding app to initiate a redirect when OAuth2 Secured was enabled. Now, in this scenario, the Auth server handles all redirects as expected.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * The taxID validation in US KYB now accepts more formats.
  * <Pill type="update" /> Updated the Brazilian Portuguese translation on the Document Selector screen to more accurately represent the intended meaning.
  * <Pill type="update" /> Added *Netherlands* as an option in the **Country** drop-down in KYB.

  ### Fixes

  * Fixed an issue with Car Invoice processing in the Document Capture module that caused the tutorial to not be shown and the request to capture a second page to be skipped.
  * Phone numbers are now displayed correctly in the user profile and wallet, ensuring accurate area codes and full phone numbers are shown regardless of the user's location.

  ***

  ## Server

  ### Enhancements

  * Updated the logic for the illiteracy check to correctly send users down the verification process that is most functional for them.
  * The Advanced Phone Number Risk check now removes the 1 after the country code in a Mexican phone number (+52 1) prior to sending the `KYXStart` request. This ensures compatibility with updated formats. The system will continue to store and display the number with a 1.
  * Introduced a new field on the template level to indicate whether the template has an NFC chip. This field has been applied to all relevant configurations and templates.
  * Added an optional configuration to use DigiLocker with the ID Capture module. If enabled for your organization, there is a new setting in the module configuration called **Enable Digi Locker**. On the backend, a `digiLocker` property has been added to the  `GET omni/flow/<ID>` API. Both are off/false by default. Contact your Incode representative if you are interested in this feature.
  * The rate limit for `/add/watchlist/single-record` has been updated to reject requests with a 429 error if the rate limit is reached.
  * There is a new optional configuration for **Phone check shadow mode**. When enabled, the 30-second cooldown for sending OTP is ignored. Contact your Incode representative if you are interested in this feature.
  * Updated the logic behind the experience of capture attempts with an expired ID. Expiration information can be returned on `add/front`, `add/back`, `add/barcode`, process ID. At the first detection that the ID is expired, the user is presented with this information and redirected to try with a different ID. This prevents situations where the user runs out of capture attempts with an expired ID.
  * Business customers integrating backend-to-backend with Omni onboarding can now retrieve session-related data using their server token (client credentials flow) when calling the `omni/b2b/onboarding/request-new` API. This enables secure access to required session data endpoints by ID for B2B integrations, reducing integration friction.
  * Updated the NotificationService to support FIPS-compliant cryptography providers, improving security compliance for environments that require FIPS.
  * Added new fields to Proof of Address processing for Mexican Tax Status documents, so `legalName` and `streetType` are now included in `additionalDocumentAttempts` for downstream use.
  * Improved name matching for Brazil eKYC to better handle common Brazilian naming patterns. When the Tax ID match is exact, the system can now return “Approximate Match” in more cases (for example, abbreviated last names or partial names), which helps reduce false mismatches and improve conversion.
  * Improved the Authentication flow so that returning users are recognized more reliably (including when `disableVerifications=true`), reducing cases where an existing user is treated as new.
  * Added support for Ghana Card facial verification via Shrinq for eKYC.
  * <Pill type="update" /> Added support for PAR authorization flow in Onboarding. This is implemented using a hidden parameter in the `/omni/start` endpoint.
  * <Pill type="update" /> Names returned by RENAPER now go through the same special-character normalization as OCR-extracted names before matching, reducing false mismatches for identities with accented or otherwise non-ASCII characters.

  ### Fixes

  * Fixed an issue with `/omni/workforce/workflows` that caused the response to be an empty array instead of returning all workflows.
  * Fixed an issue where Onboarding verification links created via `request-new` could expire too quickly when **QR phishing protection** was enabled. The link TTL is now aligned with the standard onboarding URL TTL for a more reliable start-to-finish verification experience.
  * <Pill type="update" /> Fixed an issue that caused a failed claim matching to still result in a session pass. Now, when claim matching fails, the session is put into manual review as expected.
  * <Pill type="update" /> Fixed an issue that caused a successful OAuth2 verification to throw an error rather than perform the configured redirect.

  ***

  ## ML

  **Improvements for Mexican Constancia de Situación Fiscal documents**:

  * Fixed an issue with OCR extraction of the RFC (tax ID) on Mexican Constancia de Situación Fiscal documents. Previously, this field could be extracted incorrectly if OCR misread a character. This fix results in fewer false errors / rejections and more reliable data capture of the RFC field, reducing the need for manual review or customer resubmission.
  * Added a new field, "Tipo de Vialidad", for OCR extraction from Mexican Constancia de Situación Fiscal.
  * Added a new extracted field for “Denominación/Razón Social” (Legal Name) on Mexican Constancia de Situación Fiscal documents, so the full legal name is available in the structured output payload.

  **General**:

  * Added support for extracting fingerprint and printed signature images from Chile identity cards (2013 and 2024), and returning the new `fingerprintImageID` via the `/omni/get/images` and `/omni/get/images/v2` endpoints for easier retrieval.
  * Implemented server-side readability estimation in the ID Capture service to better detect low-quality document images and improve capture reliability.
  * <Pill type="update" /> Added a video quality validation check for Selfie Video that reduces cases for video sessions falling back to single-frame checks. This change improves overall selfie capture stability by significantly reducing video discards and fallback behavior.

  ***

  ## ID Templates

  ### **New supported templates**

  NEW CLASSIFICATION SUPPORT

  **Colombia**

  * Passport / NATIONAL\_PASSPORT/ 2026

  **Dominican Republic**

  * Military / MILITARY\_CARD / 2026

  **Federated States of Micronesia**

  * DriversLicense / DRIVERS\_LICENSE / 2025

  **Guyana**

  * IdentificationCard / IDENTIFICATION\_CARD / 2006

  **Jamaica**

  * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2015

  **Kyrgyzstan**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025

  **Moldova**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Nigeria**

  * TaxIdentification / TAX\_IDENTIFICATION / 2015

  **New Zealand**

  * DriversLicense / DRIVERS\_LICENSE / 2025

  **United States of America**

  * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1844

  NEW ID SUPPORT

  **Angola**

  * TravelDocument / CONSULAR\_CARD / 2022

  **Australia**

  * Capital Territory
    * IdentificationCard / AGE\_CARD / 2014

  **Spain**

  * ResidenceDocument / ASYLUM\_SEEKER\_CARD / 2021

  **Estonia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025

  **France**

  * Permit / PRIVATE\_HIRE\_DRIVERS\_LICENSE / 2024

  **Grenada**

  * MedicalCard / SOCIAL\_SECURITY\_CARD / 2025

  **Liechtenstein**

  * Passport / NATIONAL\_PASSPORT / 2026

  **Mexico**

  * **Estado de Mexico**
    * DriversLicense / DRIVERS\_LICENSE / 2006
  * **Guerrero**
    * DriversLicense / DRIVERS\_LICENSE / 1955
  * **Quintana Roo**
    * DriversLicense / DRIVERS\_LICENSE / 1998

  **Netherlands**

  * Permit / PRIVATE\_HIRE\_DRIVERS\_LICENSE / 2021

  **Pakistan**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025

  **Philippines**

  * MedicalCard / MEDICAL\_CARD / 2008

  **El Salvador**

  * IdentificationCard / IDENTIFICATION\_CARD / 2018

  **United Nations**

  * IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2019

  **United States of America**

  * **California**
    * Other / IDENTIFICATION\_CARD / 2024
  * **New Jersey**
    * Other / IDENTIFICATION\_CARD / 2020
    * Other / IDENTIFICATION\_CARD / 2021
  * **Tribal Identification**
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1901
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1906
  * **West Virginia**
    * Other / FIREARMS\_LICENSE / 2020

  ### **Changes to current templates**

  FEATURE UPDATE

  **Chile**

  * IdentificationCard / IDENTIFICATION\_CARD / 2013 r8 - Fingerprint
  * IdentificationCard / IDENTIFICATION\_CARD / 2024 r8 - Fingerprint

  **Hong Kong**

  * DriversLicense / DRIVERS\_LICENSE / 2000 r2

  **Mexico**

  * Other / DIGITAL\_CURP\_CERTIFICATE\_FOR\_FOREGINERS\_PDF / 2026 r1

  ID CLASSIFICATION IMPROVEMENT

  **India**

  * **Delhi**
    * DriversLicense / DRIVERS\_LICENSE / 2009 r1

  **Russia**

  * Passport / NATIONAL\_PASSPORT / 2008 r4 - Enrolling back side

  ID OCR EXTRACTION IMPROVEMENT

  **Argentina**

  * IdentificationCard / IDENTIFICATION\_CARD / 2023 r3

  **Bolivia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2001 r5
  * IdentificationCard / IDENTIFICATION\_CARD / 2002 r5
  * IdentificationCard / IDENTIFICATION\_CARD / 2020 r6
  * IdentificationCard / IDENTIFICATION\_CARD / 2023 r5

  **Canada**

  * **Ontario**
    * MedicalCard / MEDICAL\_CARD / 2020 r6

  **India**

  * **Delhi**
    * DriversLicense / DRIVERS\_LICENSE / 2009 r1
  * **Telangana**
    * DriversLicense / DRIVERS\_LICENSE / 2014 r2

  **Russia**

  * Passport / NATIONAL\_PASSPORT / 2008 r4 - Enrolling back side

  **El Salvador**

  * IdentificationCard / IDENTIFICATION\_CARD / 2022 r7

  SENSITIVE PII REDACTION

  **Germany**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2011 r3 - Redact
  * ResidenceDocument / RESIDENCE\_PERMIT / 2019 r2 - Redact
</Accordion>

***

## 2026 March 9

<Accordion title="2026 March 9">
  *Demo: 2 March 2026 | Production: 9 March 2026*

  ## Release Highlights

  **Damaged ID Check**

  There is a new check when validating an ID that looks for physical damage to the document as part of the verification. Physical damage can include severe creases or fading, cuts, and tears.

  This check is enabled by default in the ID Validation module in Workflows and Flows using the **Damaged ID check** setting.

  The outcome of this check is displayed in the ID Quality Tests section of the single session view. The outcome of the check does not directly impact the overall score, but damage may prevent proper OCR or security feature validation. To reject or review sessions that fail the Damaged ID check, set up a rule via Verification Rules.

  ## Dashboard

  ### Enhancements

  * The Escalations table has been reordered to display the most relevant information first. You can also now reorder the columns yourself to customize your view. Any changes you make are saved for your user and persist after a log out.
  * Updated three-dot menus throughout Dashboard to align with the updated look and feel of other menus.
  * Multiple accessibility improvements, including adding the proper heading role to headings and improving the contrast of colors on notification banners.
  * Improved filtering capability for Identities and Authentications pages, making it easier to locate specific entries.
  * In Configuration settings, added four new webhook events: session started, session failed, session succeeded, and session pending review. The payloads from these webhooks provide data about Sessions. They work for both Onboarding and Authentications Sessions.

  **Flows and Workflows**:

  * There is a new setting under Deepsight in Flow and Workflow settings to include trust checks in scoring. Trust checks include device trust, behavioral trust, and camera trust. When Deepsight is enabled for the Flow or Workflow, this setting is automatically enabled as well but can be turned off. This allows you more granularity and control of how Deepsight functions in the Flow or Workflow.

  **Modules**:

  * When building a Flow, Watchlist Business is no longer nested under the eKYB module and can now be used and configured separately. When Watchlist Business is added without eKYB, the configuration options for **Business Name** and **Business Country** default to *Input.* In Onboarding, these fields accept user input rather than using the eKYB data.
    This update will be made to Workflows in a future release.
  * When the eKYC module is configured with the **Enable Email Risk** setting or if the **Source** is set to *Email Risk 1*, the Email field is required during the Onboarding journey. Otherwise, the field is optional.
  * eKYC modules with the UK as the country have a new source option: **UK Voter Register**. This source focuses on address verification based on the user’s voter registration information.
  * Updated the eKYC module configuration in Workflows and Flows so all fields are available and presented consistently. This aligns the experience and functionality across Workflows and Flows.
  * Improved the experience for configuring eKYC modules in Flows and Workflows by moving Countries into a drop-down separate from Sources. With growing country and source support, this improved experience allows you to see countries and sources that can be configured together with more clarity.
  * The eKYC module now supports auto-fill using data extracted from the ID. You can enable this in any or all of the eKYC module configuration field drop-downs by selecting **Auto-fill from ID (OCR)**. This option enhances the user experience by allowing them to not have to manually re-enter data they already submitted via their ID.
  * In the Face Capture module, you can now set **Image Quality Severity** to *Ultra High*. This highest level ensures image processing can produce the most accurate results because it requires exceptional image quality.
  * The User Consent module has been deprecated. Depending on your configuration, it may no longer be visible in the modules list. Any existing uses of User Consent are marked with a *deprecated* tag to prevent further use. You should use the Data Sharing Consent module in any future Flows or Workflows, as well as to replace existing instances of User Consent.

  ### Fixes

  * Fixed an issue in the Workflow builder that did not allow nodes to be reconnected after a condition was deleted.
  * Fixed an issue for accessibility where the focusable order of items inside the Workflow structure did not match the functional order.
  * Fixed an issue that caused the Image Quality check to not display in the single session view when it was enabled. Now, the check is displayed on the Face Recognition tab.
  * Fixed an issue that caused Video Selfie recordings of Front ID, Back ID, or Selfie to freeze or display a black screen at the end of the recordings when Deepsight is enabled on the Flow or Workflow.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * For eKYC and eKYB modules with the UK as the country, the **State** field has been removed from the address collection screen in Onboarding, as the UK does not have states.
  * For eKYB modules with Mexico as the country, the only available fields in Onboarding are **Business Name**, **Postal Code**, and **Tax ID**. All other fields have been removed from this screen for cross-platform consistency.

  **Accessibility**:

  * The entire Face Capture experience is usable and compatible with screen readers and keyboard navigation.
  * Improved accessibility for ID Capture UXv2 in Web implementations.

  ### Fixes

  * Fixed an issue in **OAuth2 Secured** Onboarding Flows/Workflows where users could get stuck on the authorization page even after onboarding completed, and the resulting Session could show an UNKNOWN score. This fix ensures the authorization service polls `/authorization/status` until a final state before proceeding to verify authentication and redirect back with the result.
  * Removed a confusing and incorrect error statement that appeared after a failed Passport scan.
  * Fixed an issue where the **Manual upload ID capture** setting in the ID Capture module in a Workflow did not trigger the on-screen upload option for the Onboarding user.

  ***

  ## Server

  ### Enhancements

  * Added a mitigation for observed fraudulent behavior using Mexico INE documents.
  * Selfie verification is now available in Government Validation for Brazil and South Africa.
  * Added a `additionalAttrs` field to the OCR response for Colombian Cédula de Extranjería to distinguish the following subtypes: `RESIDENTE`, `MIGRANTE`, `TEMPORAL`, and `VISITANTE`.
  * `occlusionSeverity` is now returned in Flow and Workflow `FETCH` endpoints along with `isOcclusionEnabled`.
  * `isQualityCheckEnabled` and `qualityChecksSeverity` are returned in Flow and Workflow `FETCH` endpoints based on the configuration of the Image Quality check in the module.
  * Added optional configuration to set a reverification period. This period would define how long an Authentication is valid before requiring a new Onboarding session. Contact your Incode representative if you are interested in this configuration.
  * Added optional configuration to not store PII data on unsuccessful 1:N Authentications. Contact your Incode representative if you are interested in this configuration.
  * One-time password (OTP) cooldown time is now set to 30 seconds. This means the user must wait a minimum of 30 seconds before requesting a new OTP Authentication code.
  * Updated SMS notification service to use the region code instead of the country code for rate limiting. This helps to better identify SMS messages from countries that use the same country code.
  * Optionally, the Web SDK response can now include a new boolean field, `id_quality_attempt_approved`. This field gets its value from a backend readability score. When enabled, this value can be used to adjust how the SDK evaluates ID image quality. The readability score is only relevant for Mexican documents; for any other documents, the field is not returned.
  * Implemented logic that prevents the first and last names extracted from the ID capture from being overwritten by custom fields.
  * Added support for the IdentityAfrica provider for Kenya eKYB checks. This expands coverage for customers running Kenya business verification.
  * Document multimodal interaction (MMI) is now included in the overall MMI score. This allows Deepsight to more accurately reflect both face and document integrity. If the document MMI is unknown, it is excluded from scoring. Deepsight requires additional licensing. Contact your Incode representative for more information.
  * <Pill type="update" /> There is a new endpoint that returns only the date of birth from the OCR extraction. This is intended for use cases where the returned data needs to be explicitly limited. Other scoped data will be supported in the future. This feature is configuration-dependent. Contact your Incode representative for more information.

  **Workforce**:

  * Added support for OAuth 2.0 Client Credentials B2B integrations to enable the use of Omni Onboarding Flows.
  * Transferred Workforce verification functionality to Omni.
  * Transferred Workforce integration ID to the `omni/start` endpoint to enable claim matching and eventually determine webhook configuration.

  ### Fixes

  * Fixed an issue where the expiration threshold was not applied to secondary ID scans.
  * Aligned the user experience between Flows and Workflows when using Deepsight.
  * Fixed login issues for users with the Helpdesk or Recruiter role.
  * Fixed an issue with bearer tokens being used after OAuth2 Secured verification.
  * <Pill type="update" /> Fixed an issue with password reset when a user’s email was changed in the system.

  ***

  ## ML

  **Improvements for region-based OCR**:

  * Improved OCR consistency for cases using region-based templates. This improvement provides more consistent and reliable extracted fields, reducing mismatches avoiding unexpected OCR differences across environments or processing paths.
  * Region-template-based OCR can now return image-based outputs for supported document templates.

  <Pill type="update" /> Introduced multiple improvements to models, including:

  * Invalidated ID check: Now also rejects documents with a cut corner
  * ID Alteration check: Accuracy improvement
  * Fake ID check: New security features
  * Deepsight for documents: Accuracy improvement
  * Barcode: Fix for false rejections

  ***

  ## ID Templates

  ### New Document Support

  New Classification:

  **Argentina**

  * DriversLicense / DRIVERS\_LICENSE / 1959

  New ID support:

  **Argentina**

  * DriversLicense / DRIVERS\_LICENSE / 2022
  * DriversLicense / DRIVERS\_LICENSE / 2023
  * Passport / NATIONAL\_PASSPORT / 2026

  **Antigua and Barbuda**

  * MedicalCard / MEDICAL\_BENEFITS\_CARD / 2021

  **Burkina Faso**

  * TravelDocument / CONSULAR\_CARD / 2022

  **Belize**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Colombia**

  * IdentificationCard / DIPLOMATIC\_IDENTIFICATION\_CARD / 2023

  **Ghana**

  * IdentificationCard / IDENTIFICATION\_CARD / 2024

  **Guinea**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Mexico**

  * Military / MILITARY\_CARD / 2023
  * **Guerrero**:
    * DriversLicense / DRIVERS\_LICENSE / 1954
  * **Sonora**:
    * DriversLicense / DRIVERS\_LICENSE / 2017

  **Nigeria**

  * IdentificationCard / IDENTIFICATION\_CARD / 2012

  **Peru**

  * DriversLicense / DRIVERS\_LICENSE / 2022

  Sweden

  * IdentificationCard / IDENTIFICATION\_CARD / 2000

  **United States of America**

  * **Montana**:
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2025
    * IdentificationCard / IDENTIFICATION\_CARD / 2025
  * **North Carolina**:
    * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2023

  ### Changes to Existing Templates

  Feature update:

  **Colombia**

  * ResidenceDocument / IMMIGRATION\_CARD / 2014 r5

  * ResidenceDocument / IMMIGRATION\_CARD / 2015 r2

  ID Classification improvement:

  **Brazil**

  * FederalID / IDENTIFICATION\_CARD / 2019 r8

  ID OCR extraction improvement:

  **India**

  * **Andhra Pradesh**:
    * DriversLicense / DRIVERS\_LICENSE / 2010 r1

  **Mexico**

  * **Guerrero**:
    * DriversLicense / DRIVERS\_LICENSE / 19985 r1

  **Panama**

  * Passport / NATIONAL\_PASSPORT / 2019 r2

  **United States of America**

  * **Montana**:
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2025 r1 - Age Assurance

  Sensitive PII redaction:

  **Germany**

  * IdentificationCard / IDENTIFICATION\_CARD / 2021 r4 - Redact
  * Passport / NATIONAL\_PASSPORT / 2017 r5

  **China**

  * **Hong Kong**:
    * ResidenceDocument / PERMANENT\_RESIDENT\_IDENTITY / 2018 r3 - Redact

  **United States of America**

  * **Montana**:
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2025 r1 - Age Assurance
    * IdentificationCard / IDENTIFICATION\_CARD / 2025 r1 - Age Assurance
</Accordion>

***

## 2026 February 23

<Accordion title="2026 February 23">
  *Demo: 12 February 2026 | Production: 23 February 2026*

  ## Dashboard

  ### Enhancements

  * Multiple accessibility enhancements, including improvements to the order of focusable items, drag-and-drop features, button and modal dialog labels, and removed alt text for images that are purely decorative but don’t enhance understanding.
  * You can now export user information from Dashboard. Clicking **Export to CSV** on the Users page downloads a .csv file containing each user’s name, phone, type (role), email, and permissions (if available). This behavior also triggers an audit log entry called USERS\_REPORT\_GENERATED.
  * In Dashboard Configuration, the Directory Settings tab has been renamed to Claims Settings.

  **Flows and Workflows**:

  * The legacy Workflows UI has been deprecated and removed from Dashboard. The new and improved UI is now the only option. Refer to the [Workflows documentation](/dashboard-platform-administration/workflows-20/) if you need help navigating the new experience.

  **Modules**:

  * There is a new Advanced Phone Number Risk check that delivers enhanced risk signals for phone number-based verification.\
    This check includes all capabilities of the existing Phone Number Risk module: global phone number support, active line validation, fraud activity signals, and a risk score based on observed activity. In addition, Advanced Phone Number Risk includes checks for recent porting activity, previous and current carrier information, timestamps for when the number was identified in data breaches and first seen in our data partner network, associated social media platforms, and an overall confidence score that reflects the trustworthiness of the phone number.
    When this check is run in a session, the single session view includes a section for Advanced Phone Number Risk to display results.\
    This is currently configurable using the eKYC module in Flows, with Workflows planned for a later release.
  * There is a new setting for Deepsight called **Ignore missing metadata**. When enabled, no metadata is included in the request, and it does not affect scores. This setting is intended for use with the API integration, not with Incode’s capture methods. You can enable this setting in the Face Capture, Face Authentication, and ID Capture modules. Deepsight requires additional licensing. Contact your Incode representative for more information.
  * Aligned the design of configuration for the Forms and Data Entry module between Flows and Workflows to provide a consistent experience.

  **Workforce only**:

  * There is a new page in Dashboard called **Directory Information**. This page allows you to see all directories that are set up displayed in a table. You can click into each listed directory to view the directory profile.

  ### Fixes

  * Fixed an issue with Identities permissions that allowed users without the correct permissions to see the Identities tab.

  **Flows and Workflows**:

  * The **Redirect Desktop attempts to Mobile** setting is enabled by default when creating a new Flow or Workflow.
  * Previously, saving a Workflow with the **OAuth2 Secured (web only)** setting enabled would reset the toggle to the off position. Now, this setting is preserved when enabled.
  * The **Allowed devices** setting in Workflows is intentionally enabled without the ability to turn it off. This setting is required for the user to be able to go through the Workflow.
  * UI fix: In Workflow settings, the Session timeout expiration unit of time (minutes) was not visible on the screen.
  * UI fix: Added a tooltip to the OAuth2 Secured copy icon in Workflows.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * Aligned the mandatory/optional status of address fields across configurations for the eKYB module for Brazil.
  * When a user attempts ID capture with an unsupported document in UXv2, the error screen now displays a list of supported documents.
  * The eKYB module has been migrated to UXv2.
  * <Pill type="update" /> Added validation for a taxId field in the onboarding flow for US KYB Advanced and US KYB Advanced+. The submitted taxId must be 9 digits. Any other format triggers an on-screen error.

  ### Fixes

  * Fixed an issue where biometric consent was shown in the wrong order during Onboarding.
  * Fixed an issue that caused verification to fail immediately after QR scan when **Phishing resistance** was enabled in the Workflow settings. This setting is now working as expected.
  * Refined error handling for the Face Authentication module to be more specific.
  * Fixed an issue with the ID capture UI on desktop.
  * Aligned the mandatory/optional status of address fields across configurations for the eKYC module for USA.
  * <Pill type="update" /> Fixed an issue that caused Video Selfie to get stuck on the processing screen if the face in the video didn’t match the face in previous onboarding steps. Now, the Video Selfie face capture can be tried again up to 3 attempts.
  * <Pill type="update" /> Improved error handling for email OTP.
  * <Pill type="update" /> Fixed an issue that caused the accepted document list for Serbia to display nothing.

  ***

  ## Server

  ### Highlights

  **SMS Attack Mitigation**:

  We have introduced a comprehensive set of security enhancements to strengthen protection against SMS-based attacks while maintaining reliable message delivery for legitimate users.

  These improvements include:

  * **Pre-send phone number risk validation**: Phone numbers are validated for risk before sending SMS or OTP messages, and rate limiting with configurable cooldown periods prevents automated attacks. These enhancements protect against abuse while maintaining reliable message delivery, ensuring a safer, more secure verification experience for legitimate users.
  * **Consistent rate limiting across all SMS-sending endpoints**: Enhanced security across all SMS-sending endpoints by implementing consistent rate limiting and validation, helping protect against automated SMS-based attacks while ensuring reliable message delivery for legitimate use cases.
  * **Configurable cooldown periods between OTP requests**: This feature introduces configurable delays between OTP requests to the same phone number, helping protect against SMS-based attacks while maintaining a smooth user experience.
  * **SMS-based desktop-to-mobile redirects disabled by default for new organizations**: This enhances security for new organizations by disabling SMS-based desktop-to-mobile redirects by default to reduce exposure to SMS-related attacks. Controlled opt-in is available.

  Together, these enhancements significantly reduce exposure to SMS abuse and automated attacks, while preserving a smooth and secure verification experience.

  ### Enhancements

  * Improved the visibility of watermarking on document images.
  * Updated QR code parsers for Panama and Chile to better handle special characters in documentNumber response data.
  * Improved barcode parsing for addresses from British Columbia documents. Now, the full address is returned from the front of the ID, while structured fields are parsed from the barcode and returned as separate address fields.
  * The `GET /omni/finish-status` endpoint now includes a deprecation notice, signaling a transition to the `POST /omni/finish-status` method for data modification operations. This prepares integrations for upcoming changes that will enhance security and align with REST API best practices.
  * Image quality checks now run consistently during both Face Capture and Face Authentication, providing real-time feedback and scoring aligned with other face attribute validations for a more reliable and seamless verification experience.
  * Added support for Nigeria as a government validation provider, expanding identity verification options and enabling more comprehensive compliance capabilities for regulated workflows.
  * Face Authentication now includes configurable scoring rules based on overall authentication confidence values, giving administrators enhanced control over verification thresholds and enabling more precise security policies tailored to their risk tolerance and use case requirements.
  * <Pill type="update" /> Digital ID PDF upload is now supported for 2026 Mexico CURP Certificate for Foreigners.
  * <Pill type="update" /> Enhanced the Watchlist feature with an optimized template management system that improves performance and scalability. This update enables faster processing of watchlist operations, providing a more responsive experience when managing and verifying users against your organization's watchlists.
  * <Pill type="update" /> Strengthened the security of Onboarding Workflows to ensure that authentication tokens are properly scoped and isolated across tenants. This enhancement protects customer data by preventing unauthorized access to personally identifiable information (PII), giving you greater confidence in the privacy and security of your platform.

  ### Fixes

  * Fixed an issue with an invalid/unauthorized key that was causing  `/omni/incode-id/send-otp` and `/omni/send/sms-otp`  to fail to send the SMS with OTP to the user.
  * Fixed an issue that caused document expiration tolerance to not be applied.
  * Fixed an issue with ID Validation that caused Deepsight to not run with digital IDs. Deepsight requires additional licensing. Contact your Incode representative for more information.
  * Fixed an issue that caused ID Verification checks to fail with digital IDs. This fix ensures accurate validation results and improved reliability for identity verification workflows.
  * Addressed a vulnerability related to temporary password handling during account creation, ensuring sensitive credentials are better protected throughout the user provisioning process to enhance account security.
  * Refined logic for taxID verification in US KYB sessions as well as error handling for when a session returns an unverified taxId.
  * <Pill type="update" /> When a user is blocklisted in a custom watchlist based on multiple identifiers, the system now includes **Face** as one of the blocklist matching factors. This ensures more accurate custom watchlist scores.
  * <Pill type="update" /> Fixed an issue that caused OCR values that were redacted from the document image to still be displayed in single session view.
  * <Pill type="update" /> Fixed an issue that occurred on certain environments where the password setup email did not properly redirect to the necessary page.

  ***

  ## Machine Learning

  * <Pill type="update" /> Deployed several new models for Deepsight. These models introduce the following:
    * Reduced compute time
    * Improved results after applying postprocessing operations on images
    * Increased defense against internally-created synthetic images
    * Improved recall for both Corrupted and Good depth maps
    * Updated API Response that includes outputs from DepthQualityModel
  * <Pill type="update" /> Updated SDK and API models for face processing. These models detect hyperrealistic 3D masks with more accuracy and have minor threshold adjustments.

  ***

  ## ID Templates

  ### New Document Support

  **Philippines**

  * IdentificationCard / SSS\_ID\_CARD / 2025

  ### Changes to Existing Templates

  The following document was updated for ID Classification improvement:

  **Sri Lanka**

  * DriversLicense / DRIVERS\_LICENSE / 2011 R1

  The following documents were updated for OCR extraction improvements:

  **Argentina**

  * IdentificationCard / IDENTIFICATION\_CARD / 2023 r2

  **Brazil**

  * ResidenceDocument / MIGRATORY\_REGISTER / 2012 r3

  **Panama**

  * IdentificationCard / IDENTIFICATION\_CARD / 2010 r4
  * ResidenceDocument / PERMANENT\_RESIDENCE\_CARD / 2015 r3

  **Saudi Arabia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2010 r2
  * IdentificationCard / IDENTIFICATION\_CARD / 2013 r1

  **United States of America**

  * **Alaska**
    * Other / IDENTIFICATION\_CARD / 2023 r1
  * **Arizona**
    * DriversLicense / LEARNERS\_PERMIT / 2023 r1
  * **Pennsylvania**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2017 r2
  * **Tribal Identification Cards**
    * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 2006 r1
</Accordion>

***

## 2026 February 9

<Accordion title="2026 February 9">
  _Originally titled 2026 February 5_

  *Demo: 29 January 2026 | Production: 9 February 2026*

  ## Dashboard

  ### Enhancements

  * Accessibility improvements, including accurate alt text for images and labeled modal dialogs.
  * <Pill type="update" /> The Executive with Custom Permissions role now includes a permissions option for Escalations. This permission allows users to view the Escalations tab and its content. The separate Sessions permission is still needed to view any Sessions associated with an Escalation.

  **Workflow and Flow Configuration and Settings:**

  * In Flow settings, you can now granularly enable or disable Risk AI Agent for available countries. For Workflows, you can accomplish this by adding a condition to look for the country code on the ID. Currently, Risk AI Agent supports Colombia, Mexico, and the United States. Risk AI Agent requires additional licensing. Contact your Incode representative for more information.
  * You can now configure conditions related to Deepsight after the Face Authentication module in a Workflow.

  ### Fixes

  * Fixed an issue that caused an error to display when a custom node was added to the canvas in the new Workflow builder.
  * Fixed an issue where users who updated their email were unable to log in.
  * <Pill type="update" /> Added and improved tooltips for the Document Capture module in Workflows.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * Updated the design of the screen a user sees at the beginning of Onboarding.

  ### Fixes

  * Fixed a bug that caused a “Something went wrong” error screen to display even though the operation was successful.
  * Fixed an issue where the customization was not working for some text on the Onboarding launch screen.
  * <Pill type="update" /> Aligned the mandatory/optional status of address fields across configurations for the eKYB module for USA.

  ***

  ## Server

  ### Enhancements

  * Improved matching for business names that contain characters with accents as well as entities such as additional spaces or dots in the eKYB module for Mexico.
  * Added the left half as a new region of interest for the following templates:
    * NGA|ALL|TravelDocument|CONSULAR\_CARD|2017
    * BGD|ALL|IdentificationCard|IDENTIFICATION\_CARD|2006
  * <Pill type="update" /> Historically, the system automatically added a 1 after the country code (+52) for Mexican phone numbers to ensure consistency with phone number formats. Starting with this release, if a Mexican phone number has a 1 after the country code (+52 1), the 1 is removed prior to sending the SMS to ensure compatibility with the SMS provider. The system will continue to store and display the number with a 1. This change affects the `add/phone` endpoint.
  * <Pill type="update" /> SMS messages sent via API are now limited to 160 characters. Currently-effected endpoints include `/omni/add/phone` and `/omni/organization/{{orgId1}}`. Any messages sent with more than 160 characters will fail until the text is shortened.

  ### Fixes

  * Refined redaction and watermarking capabilities on Sessions with errors. When a document fails classification or is an unknown document type, the image is fully redacted. When classification is successful but some other error is returned, the image is redacted and watermarked according to the requirements of the document type. You can enable watermarking in the ID Capture module.

  ***

  ## Machine Learning

  This release introduces overall improvements across identity verification and fraud prevention, including higher accuracy in liveness checks, enhanced detection of fake and altered documents, better recognition of damaged IDs, expanded document coverage for key markets, and more advanced AI-driven risk assessment for improved decision-making.

  ***

  ## ID Templates

  ### New Document Support

  **Argentina**

  * DriversLicense / DRIVERS\_LICENSE / 1960
  * DriversLicense / DRIVERS\_LICENSE / 1961
  * DriversLicense / DRIVERS\_LICENSE / 1963
  * DriversLicense / DRIVERS\_LICENSE / 2005
  * DriversLicense / DRIVERS\_LICENSE / 2020

  **India**

  * **Chhattisgarh**
    * DriversLicense / DRIVERS\_LICENSE / 2023
  * **Nagaland**
    * DriversLicense / DRIVERS\_LICENSE / 2018
  * IdentificationCard / DIPLOMATIC\_IDENTIFICATION\_CARD / 2023

  **Kazakhstan**

  * DriversLicense / DRIVERS\_LICENSE / 2005

  **Mali**

  * Passport / NATIONAL\_PASSPORT / 2025

  **Mexico**

  * **Guerrero**
    * DriversLicense / DRIVERS\_LICENSE / 1985
  * Military / MILITARY\_CARD / 2018
  * Other / DIGITAL\_CURP\_CERTIFICATE\_FOR\_FOREIGNERS\_PDF / 2026

  **Nepal**

  * DriversLicense / DRIVERS\_LICENSE / 2007

  **Peru**

  * DriversLicense / DRIVERS\_LICENSE / 1889
  * ResidenceDocument / RESIDENCE\_PERMIT / 2000

  **Portugal**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2024

  **Seychelles**

  * DriversLicense / DRIVERS\_LICENSE / 2016

  **Somalia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2016

  **South Sudan**

  * DriversLicense / DRIVERS\_LICENSE / 2023
  * IdentificationCard / IDENTIFICATION\_CARD / 2024

  **Trinidad and Tobago**

  * Permit / WORK\_PERMIT / 2024

  **United States of America**

  * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1845
  * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1849
  * TribalIdentification / TRIBAL\_IDENTIFICATION\_CARD / 1851

  **Vietnam**

  * DriversLicense / DRIVER\_LICENSE / 2025

  ### Changes to Existing Templates

  **Ecuador**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020 - Specific field improvements: `documentNumber`

  **Mexico**

  * **Tlaxcala**
    * DriversLicense / DRIVERS\_LICENSE / 2022 - Template improved in general
</Accordion>

***

## 2026 January 26

<Accordion title="2026 January 26">
  *Demo: 19 January 2026 | Production: 26 January 2026*

  ## **Dashboard**

  ### Highlights

  **Updated Workflow Builder**:

  The Workflow builder has been updated with a new look and feel. Key changes include:

  * Modules, processes, and conditions are always visibly accessible from the canvas
  * All modules and processes can be previewed on hover
  * Drag-and-drop functionality
  * Ability to connect or disconnect nodes to adjust Workflow paths
  * Root node flexibility
  * Visual and design consistency with other aspects of Dashboard

  The new UI is enabled by default. You can temporarily revert to the old UI by clicking **Switch to Old UI** on the Workflows page. This option will continue to be available for a few weeks to help with the transition to the new experience.

  ### Enhancements

  * Multiple accessibility improvements, including accurate alt text on images, labeling and formatting of screen elements, and increased contrast.

  **Single Session View**:

  * **Submission Method**:\
    There is a new field called **Submission Method** in the ID OCR section of the single Session view. Values for this field can be *Captured Document*, *Uploaded File*, or *Imported Credential*.
  * Added a column for Document Attributes to the CSV export from the single Session view. This is already in place in the CSV export from the Sessions list.

  **Workflow and Flow Settings and Module Configuration:**

  * In Workflow and Flow settings, radio buttons and checkboxes have been replaced with toggles. This aligns the visual and functional experience with other areas of Dashboard.
  * **Strict Video Checks**:\
    There is a new configuration option in Face Capture and Face Authentication modules called **Strict Video Checks**. This setting determines whether the system should perform a crosscheck comparing the face from the video and the selfie. The option is only available when Deepsight **Multi-Modal Intelligence** is set to *Single frame + Depth + Video*. Deepsight requires additional licensing. Contact your Incode representative for more information. This setting is available for both Workflows and Flows.
  * **OAuth2 Secured**:\
    There is a new setting in Workflows and Flows called **OAuth2 Secured**. This setting can strengthen the security of the user journey against replay attacks in webflows. When enabled, a redirect URL is required for the Workflow or Flow to save. The OAuth clientid is saved in the configuration settings for future reference.
  * **Enable SNA verification**:\
    There is a new configuration option in the Phone Number Input module called **Enable SNA verification**. This setting uses Silent Network Authentication (SNA) as an alternative to SMS OTP verification. Enabling SNA can improve security, reduce user friction, and lower operational costs associated with SMS delivery. This setting is available for both Workflows and Flows.
  * **Asynchronous Modules**:\
    Workflows now support asynchronous modules with improved clarity and control. When you add an async module to a Workflow, the system provides clear guidance and validation to ensure each async path includes the required Async Resolution step. This enables smoother background processing while end users complete their Onboarding journey. See also the **Asynchronous Modules** entry in Web App enhancements.
  * Removed unused and deprecated modules from Flows, including Stadium Selector and Generate QR.

  ### Fixes

  * Added missing configuration options for face recognition checks such as mask, lenses, and hat validation to the Video Selfie module in Workflows.
  * Updated the tooltip description for the **ID Already Used** check in single Session view to provide a clearer understanding of what the check looks for.
  * Updated error messaging for mutually-exclusive settings in Workflow and Flow configuration.
  * <Pill type="update" /> Fixed an issue with logins for Workforce Dashboard users.

  ***

  ## Web App (Onboarding)

  ### Enhancements

  * **Asynchronous Modules**:\
    Users can now complete the Onboarding flow without needing to wait for asynchronous module results. The system allows the user to move on to the next step in Onboarding while the previous step renders its result in the background. This reduces time spent on loading screens, increasing user satisfaction and Onboarding completion rates. See also the **Asynchronous Modules** entry in Dashboard enhancements.
  * Added analytics tracking for the Digital ID PDF upload feature. These analytics help monitor user behavior, success rates, and potential issues.
  * After the maximum capture attempts are met, a user can continue on to the next step in Onboarding rather than being presented with an error screen.
  * **Age Assurance** is now available with Workflows using UXv2.
  * During a selfie capture using the Face Capture module, when face occlusion checks are configured (lenses, mask, closed eyes) and the user is determined to have one of these elements, a specific error is shown directing them to uncover their face. Previously, a generic error was shown.
  * End users now see an "All data is encrypted" message during the ID capture process.
  * The ID Capture step in Onboarding now includes an updated Common Issues screen to help the user prevent problems like glare and blur in their capture.
  * If you have configured a custom field with the "date" type, the web app user is provided a date picker component rather than a text field.
  * <Pill type="update" /> The camera permission flow in Web has been redesigned to match the streamlined experience already available in our iOS and Android applications.

  ### Fixes

  * Previously, when a Workflow was configured with the ID Validation and CURP Validation modules, the CURP capture screen would always show during the Onboarding Workflow. Now, the CURP capture screen is only shown when the CURP cannot be obtained from the OCR data. This issue and fix are specific to UXv2.
  * Previously, when using an iPad in landscape mode, the ID and Selfie Capture screens would remain white and not load. Now, iPads can load these screens regardless of device orientation.
  * <Pill type="update" /> Fixed an issue where autocapture wasn’t working on iPads after rotating the device from portrait to landscape.

  ***

  ## **Server**

  ### Enhancements

  * The system can now create rules using all address components. This allows for validation on the state from the address on the ID as well as the issuing state, which can differ.
  * An Identity created with a Columbian document will have a national ID number. This 6-10 digit number can be used as a hint in the Face Authentication module.
  * If a Workflow or Flow does not contain the Phone Number Input module, the user cannot use SMS or OTP and the phone number cannot be updated. This enhances SMS security and attack prevention. To allow for SMS or OTP in Onboarding, ensure the Phone Number Input module is added and configured to the relevant Workflows or Flows.
  * If QR Onboarding is enabled, any Onboarding-related SMS will not be sent.
  * When **Age Assurance** is enabled in Workflow or Flow settings, you cannot configure the Face Capture module with **Enable face recording** or the ID Capture module with **Enable ID recording**. **Age Assurance** also ensures any Deepsight recordings are deleted when the Session is complete. Deepsight requires additional licensing. Contact your Incode representative for more information.
  * Previously, configured face attributes, image quality, and liveness were not present in the result if they were not executed and face matching was marked as failed. Now, when these elements are configured but not executed, they are marked as unknown.
  * Enhanced the security and reliability of face login flows by adding support for liveness statistics endpoints in the Crypto service, ensuring seamless end-to-end encryption for biometric authentication processes.
  * Dashboard users can now access comprehensive eKYC attempt data, including both Incode-processed responses and raw third-party provider information through newly structured API endpoints.
  * Venezuelan ID expiration dates now correctly display the last day of the expiration month instead of the first day, accurately reflecting that documents remain valid throughout the entire month stated on the card.
  * A new Risk AI Agent processing node is now available in Workflows, enabling holistic evaluation of all session signals to deliver more accurate and intelligent decision-making. This node is optimized for placement at the end of workflows after ID validation, providing enhanced fraud detection capabilities for U.S.-based onboarding flows.
  * Video selfie scoring is now available and accurately evaluated at the time workflow conditions are processed. This enhancement ensures reliable video selfie validation and improves the accuracy of final workflow decisions, leading to more trustworthy identity verification outcomes.
  * When a Flow does not include the Face Match module but does have the Face Capture module, the Age Estimation result is available in Face Attributes rather than Face Recognition. This only applies if your system is configured for age estimation.
  * The system now allows duplicate email addresses in the same directory during synchronization while maintaining data integrity. When multiple records with identical email addresses exist in a directory, employee search operations will fail during claim matching, preventing ambiguous authentication scenarios and ensuring accurate identity verification. This enhancement is specific to Workforce implementations.
  * City matching for Tel Aviv, Israel has been enhanced to deliver more accurate results. Companies registered in Tel Aviv now receive exact city matches even when the official city name includes additional district information, improving overall data quality and match rate performance.
  * US KYB Sessions now clearly indicate the verification status of Ultimate Beneficial Owners (UBOs) with visual indicators, making it easier to identify valid ownership information at a glance.

  ### Fixes

  * The Government Validation module can use a selfie captured from the Face Authentication module. Previously, it would only use a selfie from the Face Capture module.
  * Enhanced Custom Watchlist accuracy by correcting the device fingerprint logic, ensuring more reliable device matching and improved fraud detection across onboarding sessions.
  * Removed the unused `authentications/generateImageUrl` endpoint due to a vulnerability.
  * When a Session contains a selfie captured from a Face Authentication module and that Session or associated Identity is added to a custom watchlist, the watchlist record now contains the selfie image.
  * Face occlusion check results are now included in the overall score for Face Authentication.
  * Fixed an issue with full frame image rotation during ID preprocessing. This reduces potential errors and improves the overall quality of document capture.
  * The Government Validation module returns clearer statuses for US states that are not supported by AAMVA.
  * <Pill type="update" /> Fixed an issue so Sessions with Government Validation consistently return complete response data across all ID types. This improves data integrity and enables more accurate tracking and reporting for compliance workflows.
  * <Pill type="update" /> Fixed a bug where some fields were not displaying in analytics.

  ***

  ## **ID Templates**

  ### **New supported templates**

  **Argentina**

  * DriversLicense / DRIVER\_LICENSE / 1967
  * DriversLicense / DRIVERS\_LICENSE / 1968
  * DriversLicense / DRIVERS\_LICENSE / 1969

  **American Samoa**

  * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2023

  **Australia**

  * Passport / EMERGENCY\_PASSPORT / 2025
  * Capital Territory / IdentificationCard / AGE\_CARD / 2014 *- Only config file created for Data Collection*
  * New South Wales / Other / FIREARMS\_LICENSE / 2020 *- Only config file created for Data Collection*

  **Benin**

  * Passport / NATIONAL\_PASSPORT / 2024
  * TravelDocument / CONSULAR\_CARD / 2022

  **Belize**

  * ResidenceDocument / PERMANENT\_RESIDENCE\_CARD / 2025 *- Only config file created for Data Collection*

  **Brazil**

  * FederalID / DIGITAL\_IDENTIFICATION\_CARD\_PDF / 2024
  * FederalID / DIGITAL\_IDENTIFICATION\_CARD\_PDF / 2025
  * FederalID / DOMESTIC\_IDENTIFICATION\_CARD / 1844
  * FederalID / DOMESTIC\_IDENTIFICATION\_CARD / 1845

  **China**

  * Passport / DIPLOMATIC\_PASSPORT / 2023

  **Ivory Coast**

  * IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2020 *- Only config file created for Data Collection*

  **Democratic Republic of the Congo**

  * DriversLicense / DRIVERS\_LICENSE / 2018
  * TravelDocument / CONSULAR\_IDENTITY\_CARD / 2021 *- Only config file created for Data Collection*
  * TravelDocument / CONSULAR\_IDENTITY\_CARD / 2022

  **Comoros**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020
  * ResidenceDocument / RESIDENCE\_CARD / 2020 *- Only config file created for Data Collection*

  **Costa Rica**

  * Passport / NATIONAL\_PASSPORT / 2019

  **Denmark**

  * DriversLicense / DRIVER\_LICENSE / 2025
  * Greenland / DriversLicense / DRIVERS\_LICENSE / 2024

  **Dominican Republic**

  * TravelDocument / CONSULAR\_CARD / 2022

  **East Timor**

  * Passport / NATIONAL\_PASSPORT / 2020 *- Only config file created for Data Collection*

  **Egypt**

  * DriversLicense / INTERNATIONAL\_DRIVING\_PERMIT / 2021

  **Estonia**

  * IdentificationCard / DIPLOMATIC\_IDENTIFICATION\_CARD / 2022
  * IdentificationCard / IDENTIFICATION\_CARD / 2025 *- Only config file created for Data Collection*

  **Ethiopia**

  * DriversLicense / DRIVERS\_LICENSE / 2023 *- Only config file created for Data Collection*

  **Gabon**

  * Visa / VISA / 2014

  **Georgia**

  * ResidenceDocument / TEMPORARY\_RESIDENCE\_CARD / 2025 *- Only config file created for Data Collection*

  **Gibraltar**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Guinea**

  * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2020 *- Only config file created for Data Collection*

  **Gambia**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2015 *- Only config file created for Data Collection*

  **Greece**

  * IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2020 *- Only config file created for Data Collection*
  * IdentificationCard / POLICE\_IDENTIFICATION\_CARD / 2025

  **Guyana**

  * DriversLicense / DRIVERS\_LICENSE / 2020 *- Only config file created for Data Collection*

  **Honduras**

  * DriversLicense / DRIVERS\_LICENSE / 2018 *- Only config file created for Data Collection*

  **Indonesia**

  * DriversLicense / DRIVER\_LICENSE / 2024

  **India**

  * **Arunachal Pradesh** / DriversLicense / DRIVERS\_LICENSE / 2023
  * **Nagaland**/ DriversLicense / DRIVER\_LICENSE / 2020
  * **Tamil Nadu** / DriversLicense / DRIVERS\_LICENSE / 2020

  **Interpol**

  * Passport / PASSPORT / 2015 *- Only config file created for Data Collection*

  **Jordan**

  * Military / MILITARY\_CARD / 2022 *- Only config file created for Data Collection*

  **Japan**

  * ResidenceDocument / SPECIAL\_PERMANENT\_RESIDENT\_CERTIFICATE / 2024
  * Visa / VISA / 2024

  **Kosovo**

  * IdentificationCard / IDENTIFICATION\_CARD / 2008 *- Only config file created for Data Collection*
  * IdentificationCard / IDENTIFICATION\_CARD / 2024
  * Passport / NATIONAL\_PASSPORT / 2020 *- Only config file created for Data Collection*
  * ResidenceDocument / RESIDENCE\_PERMIT / 2025

  **Kuwait**

  * DriversLicense / DRIVERS\_LICENSE / 2015 *- Only config file created for Data Collection*

  **Kyrgyzstan**

  * DriversLicense / DRIVERS\_LICENSE / 2020

  **Laos**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025 *- Only config file created for Data Collection*

  **Mexico**

  * DriversLicense / DIGITAL\_FEDERAL\_DRIVERS\_LICENSE\_PDF / 2025
  * **Campeche** / DriversLicense / DRIVERS\_LICENSE / 2020 *- Only config file created for Data Collection*
  * **CDMX** / DriversLicense / DRIVER\_LICENSE / 2025
  * **Guerrero**
    * DriversLicense / DRIVERS\_LICENSE / 1896
    * DriversLicense / DRIVERS\_LICENSE / 1897
    * DriversLicense / DRIVERS\_LICENSE / 1899 *- Only config file created for Data Collection*
    * DriversLicense / DRIVERS\_LICENSE / 1911
    * DriversLicense / DRIVERS\_LICENSE / 1950
  * **Quintana Roo** / DriversLicense / DRIVERS\_LICENSE / 2007
  * **San Luis Potosi** / DriversLicense / DRIVERS\_LICENSE / 2025

  **Mauritius**

  * IdentificationCard / IDENTIFICATION\_CARD / 2025

  **Malaysia**

  * DriversLicense / DRIVER\_LICENSE / 2025

  **Nigeria**

  * IdentificationCard / IDENTIFICATION\_CARD / 1995
  * IdentificationCard / REFUGEE\_IDENTIFICATION\_CARD / 2019
  * TravelDocument / CONSULAR\_CARD / 2017
  * TravelDocument / CONSULAR\_CARD / 2025

  **Nepal**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **New Zealand**

  * **Cook Islands** / DriversLicense / DRIVERS\_LICENSE / 2025 *- Only config file created for Data Collection*
  * **Niue**/ DriversLicense / DRIVERS\_LICENSE / 2020 *- Only config file created for Data Collection*

  **Pakistan**

  * **Khyber Pakhtunkhwa** / DriversLicense / DRIVERS\_LICENSE / 2023

  **Peru**

  * DriversLicense / DRIVER\_LICENSE / 1884
  * DriversLicense / DRIVERS\_LICENSE / 1885
  * DriversLicense / DRIVERS\_LICENSE / 2021
  * DriversLicense / DRIVERS\_LICENSE / 2025 *- Only config file created for Data Collection*
  * Visa / VISA / 2024

  **Philippines**

  * IdentificationCard / SSS\_ID\_CARD / 2025 *- Only config file created for Data Collection*
  * Military / MILITARY\_CARD / 2020 *- Only config file created for Data Collection*
  * Military / MILITARY\_CARD / 2021 *- Only config file created for Data Collection*
  * Other / GSIS\_ECARD\_PLUS / 2020

  **Puerto Rico**

  * Other / FIREARMS\_LICENSE / 2020

  **Republic of Chad**

  * Military / MILITARY\_CARD / 2020 *- Only config file created for Data Collection*

  **Romania**

  * IdentificationCard / DIPLOMATIC\_IDENTIFICATION\_CARD / 2025

  **Saint Kitts and Nevis**

  * IdentificationCard / IDENTIFICATION\_CARD / 2015
  * IdentificationCard / IDENTIFICATION\_CARD / 2016 *- Only config file created for Data Collection*

  **Samoa**

  * DriversLicense / DRIVERS\_LICENSE / 2023

  **Sierra Leone**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020 - Engineering fix: personal number MRZ parsing

  **Slovakia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2023

  **Somalia**

  * **Somaliland** / DriversLicense / DRIVERS\_LICENSE / 2020 *- Only config file created for Data Collection*

  **South Sudan**

  * DriversLicense / DRIVERS\_LICENSE / 2022 *- Only config file created for Data Collection*

  **Sudan**

  * Passport / DIPLOMATIC\_PASSPORT / 2020

  **Sweden**

  * DriversLicense / DRIVERS\_LICENSE / 2025

  **Thailand**

  * IdentificationCard / IDENTIFICATION\_CARD\_FOR\_FOREIGNERS / 2025

  **Togo**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020
  * Passport / NATIONAL\_PASSPORT / 2015 *- Only config file created for Data Collection*
  * ResidenceDocument / RESIDENCE\_PERMIT / 2023 *- Only config file created for Data Collection*

  **Turkish Republic of Northern Cyprus**

  * DriversLicense / DRIVERS\_LICENSE / 2015 *- Only config file created for Data Collection*

  **Turkmenistan**

  * Passport / NATIONAL\_PASSPORT / 2025

  **Turks and Caicos Islands**

  * IdentificationCard / NATIONAL\_STATUS\_CARD / 2022

  **Ukraine**

  * IdentificationCard / DIPLOMATIC\_IDENTIFICATION\_CARD / 2020 *- Only config file created for Data Collection*

  **Uruguay**

  * DriversLicense / DRIVER\_LICENSE / 2019

  **United Kingdom**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2010 *- Only config file created for Data Collection*

  **United States of America**

  * Other / BIRTH\_CERTIFICATE / 2011
  * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2025
  * **Arizona**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Colorado**
    * DriversLicense / DRIVERS\_LICENSE / 1994 - `documentSeriesExpired` enabled on template level
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 1994 - `documentSeriesExpired` enabled on template level
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2014 - `documentSeriesExpired` enabled on template level
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
    * Permit / DRIVER\_INSTRUCTION\_PERMIT\_ALLAGES / 1994 - `documentSeriesExpired` enabled on template level
    * Permit / DRIVER\_INSTRUCTION\_PERMIT\_UNDER18 / 1994 - `documentSeriesExpired` enabled on template level
    * Permit / DRIVER\_INSTRUCTION\_PERMIT\_UNDER21 / 1994 - `documentSeriesExpired` enabled on template level
  * **Connecticut**
    * Other / IDENTIFICATION\_CARD / 2020
  * **Delaware**
    * Other / BIRTH\_CERTIFICATE / 2020
  * **Guam**
    * DriversLicense / DRIVERS\_LICENSE / 2011 - `documentSeriesExpired` enabled on template level
  * **Iowa**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Kansas**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2004 - `documentSeriesExpired` enabled on template level
    * DriversLicense / LEARNERS\_PERMIT / 2013 - `documentSeriesExpired` enabled on template level
  * **Maryland**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Massachusetts**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Missouri**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Montana**
    * DriversLicense / DRIVERS\_LICENSE / 2025
  * **New Jersey**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
    * Other / IDENTIFICATION\_CARD / 2019
  * **New York**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **North Carolina**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2004 - `documentSeriesExpired` enabled on template level
    * DriversLicense / DRIVERS\_LICENSE / 2000 - `documentSeriesExpired` enabled on template level
  * **North Dakota**
    * DriversLicense / LEARNERS\_PERMIT / 2006 - `documentSeriesExpired` enabled on template level
    * DriversLicense / LEARNERS\_PERMIT / 2023
  * **Ohio**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2009 - `documentSeriesExpired` enabled on template level
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Oklahoma**
    * IdentificationCard / IDENTIFICATION\_CARD / 2023
  * **Pennsylvania**
    * Other / BIRTH\_CERTIFICATE / 2020
  * **South Carolina**
    * DriversLicense / DRIVERS\_LICENSE / 1994 - `documentSeriesExpired` enabled on template level
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 1994 - `documentSeriesExpired` enabled on template level
  * **Texas**
    * Other / FIREARMS\_LICENSE / 2024
  * **Tribal Identification**
    * TRIBAL\_IDENTIFICATION\_CARD / 1852
    * TRIBAL\_IDENTIFICATION\_CARD / 1854
    * TRIBAL\_IDENTIFICATION\_CARD / 1856 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1857
    * TRIBAL\_IDENTIFICATION\_CARD / 1859 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1860 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1861 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1862 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1863 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1864 *- Only config file created for Data Collection*
    * TRIBAL\_IDENTIFICATION\_CARD / 1867
    * TRIBAL\_IDENTIFICATION\_CARD / 1868
    * TRIBAL\_IDENTIFICATION\_CARD / 1869
    * TRIBAL\_IDENTIFICATION\_CARD / 1900
    * TRIBAL\_IDENTIFICATION\_CARD / 1903
    * TRIBAL\_IDENTIFICATION\_CARD / 1908
    * TRIBAL\_IDENTIFICATION\_CARD / 1943
    * TRIBAL\_IDENTIFICATION\_CARD / 1961
  * **US Virgin Islands**
    * VoterIdentification / VOTER\_IDENTIFICATION\_CARD / 2015 *- Only config file created for Data Collection*
  * **Virginia**
    * Other / BIRTH\_CERTIFICATE / 2020 *- Only config file created for Data Collection*
  * **Washington**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2007 - `documentSeriesExpired` enabled on template level
  * **West Virginia**
    * DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2023
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2023
  * **Wyoming**
    * Other / FIREARMS\_LICENSE / 2021 *- Only config file created for Data Collection*

  **Vietnam**

  * IdentificationCard / IDENTIFICATION\_CARD / 2020

  **Yemen**

  * Passport / NATIONAL\_PASSPORT / 2017

  **Zambia**

  * MedicalCard / MEDICAL\_CARD / 2023
  * TravelDocument / CONSULAR\_CARD / 2024

  ### **Changes to current templates**

  **Australia**

  * **New South Wales** / DriversLicense / HEAVY\_VEHICLE\_DRIVERS\_LICENSE / 2015 - OCR provider switched to Incode
  * **Queensland** / DriversLicense / HEAVY\_VEHICLE\_DRIVERS\_LICENSE / 2020 - OCR provider switched to Incode
  * **South Australia** / DriversLicense / DRIVERS\_LICENSE / 2015 - OCR provider switched to Incode

  **Bangladesh**

  * IdentificationCard / IDENTIFICATION\_CARD / 2006 - `documentSeriesExpired` enabled on template level

  **Bulgaria**

  * IdentificationCard / IDENTIFICATION\_CARD / 2010 - Specific field improvements: nationality, birthPlace, issuingAuthority
  * IdentificationCard / IDENTIFICATION\_CARD / 2024 - Specific field improvements: nationality, birthPlace, issuingAuthority

  **Bahrain**

  * DriversLicense / DRIVERS\_LICENSE / 2018 - Gender standardised to one letter values

  **Bosnia and Herzegovina**

  * Passport / NATIONAL\_PASSPORT / 2015 - MRZ lines extracted by Incode OCR

  **Brazil**

  * FederalID / DOMESTIC\_IDENTIFICATION\_CARD / 2004 - Specific field improvements: name

  **Canada**

  * Other / FIREARMS\_LICENSE / 2010 - Gender standardised to one letter values
  * **British Columbia**
    * Other / Services Card / 2022 - OCR provider switched to Incode
  * **Ontario**
    * MedicalCard / MEDICAL\_CARD / 2020 - Template switched to entity\_segmentation approach

  **Chile**

  * IdentificationCard / IDENTIFICATION\_CARD / 2013 - New field image(s) extracted
  * IdentificationCard / IDENTIFICATION\_CARD / 2013 - Specific field improvements: PersonalNumber
  * IdentificationCard / IDENTIFICATION\_CARD / 2024 - New field image(s) extracted

  **Czech Republic**

  * IdentificationCard / IDENTIFICATION\_CARD / 2012 - Template improved in general
  * IdentificationCard / IDENTIFICATION\_CARD / 2021 - Specific field improvements: personalNumber
  * ResidenceDocument / RESIDENCE\_PERMIT / 2013 - Template improved in general
  * ResidenceDocument / RESIDENCE\_PERMIT / 2020 - Template improved in general

  **El Salvador**

  * DriversLicense / DRIVER\_LICENSE / 2000 - Gender standardised to one letter values
  * Passport / NATIONAL\_PASSPORT / 2024 - Template improved in general

  **Ghana**

  * TravelDocument / CONSULAR\_CARD / 2023 - Gender standardised to one letter values

  **Hong Kong**

  * ResidenceDocument / PERMANENT\_RESIDENT\_IDENTITY / 2018 - Sensitive data redacted

  **Ireland**

  * Passport / NATIONAL\_PASSPORT / 2006 - Template improved in general. New field added: issuingAuthority
  * ResidenceDocument / RESIDENCE\_PERMIT / 2020 - Template improved in general

  **Italy**

  * DriversLicense / DRIVER\_LICENSE / 2013 - OCR provider switched to Incode OCR

  **Mexico**

  * **Nayarit**
    * DriversLicense / DRIVERS\_LICENSE / 2019 - Gender standardised to one letter values
  * **Quintana Roo**
    * DriversLicense / DRIVERS\_LICENSE / 2002 - Gender standardised to one letter values

  **Mongolia**

  * IdentificationCard / IDENTIFICATION\_CARD / 2013 - Gender standardised to one letter values

  **Mozambique**

  * DriversLicense / DRIVERS\_LICENSE / 2021 - Gender standardised to one letter values

  **Nigeria**

  * Passport / NATIONAL\_PASSPORT / 2019 - Template switched to entity\_segmentation approach. Fallback approach added: regions
  * Passport / NATIONAL\_PASSPORT / 2020 - Template switched to entity\_segmentation approach. Fallback approach added: regions

  **Netherlands**

  * Passport / NATIONAL\_PASSPORT / 2024 - MRZ lines extracted by Incode OCR

  **Panama**

  * IdentificationCard / IDENTIFICATION\_CARD / 2016 - OCR provider switched to Incode
  * IdentificationCard / IDENTIFICATION\_CARD / 2023 - OCR provider switched to Incode

  **Peru**

  * TravelDocument / CONSULAR\_CARD / 2020 - Gender standardised to one letter values

  Philippines

  * IdentificationCard / POLICE\_CLEARANCE\_IDENTIFICATION\_CARD / 2021 - Gender standardised to one letter values
  * Passport / NATIONAL\_PASSPORT / 2016 - OCR provider switched to Incode

  **Paraguay**

  * IdentificationCard / IDENTIFICATION\_CARD / 2018 - OCR provider switched to Incode

  Romania

  * IdentificationCard / IDENTIFICATION\_CARD / 2015 - MRZ lines extracted by Incode OCR
  * IdentificationCard / IDENTIFICATION\_CARD / 2022 - Document classification improved. Specific field improvements: issuingAuthority, issueDate
  * Passport / NATIONAL\_PASSPORT / 2019 - MRZ lines extracted by Incode OCR

  Singapore

  * Passport / NATIONAL\_PASSPORT / 2017 - Sensitive data redacted
  * ResidenceDocument / RESIDENCE\_PERMIT / 2005 - Sensitive data redacted

  **Slovakia**

  * ResidenceDocument / RESIDENCE\_PERMIT / 2019 - Template improved in general
  * ResidenceDocument / RESIDENCE\_PERMIT / 2020 - Template improved in general

  **Spain**

  * IdentificationCard / IDENTIFICATION\_CARD / 2015 - Specific field improvement: name
  * Passport / NATIONAL\_PASSPORT / 2015 - Template switched to entity\_segmentation approach

  **Taiwan**

  * DriversLicense / DRIVERS\_LICENSE / 2015 - Template improved in general. `tamperCheck` disabled on template level. `paperIdLiveness` disabled on template level
  * DriversLicense / DRIVERS\_LICENSE / 2019 - Template improved in general. `tamperCheck` disabled on template level. `paperIdLiveness` disabled on template level

  **United States of America**

  * **Arizona**
    * DriversLicense / LEARNERS\_PERMIT / 2023 - OCR provider switched to Incode
    * DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2023 - OCR provider switched to Incode
  * **Colorado**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2020 - OCR provider switched to Incode
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2022 - OCR provider switched to Incode
  * **District of Columbia**
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2023 - OCR provider switched to Incode
  * **Idaho**
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2023 - OCR provider switched to Incode
  * **Illinois**
    * DriversLicense / DRIVERS\_LICENSE / 2020 - OCR provider switched to Incode
    * IdentificationCard / IDENTIFICATION\_CARD / 2020 - OCR provider switched to Incode
  * **Minnesota**
    * DriversLicense / LEARNERS\_PERMIT / 2018 - OCR provider switched to Incode
  * **Mississippi**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2024 - OCR provider switched to Incode
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2024 - OCR provider switched to Incode
  * **Nebraska**
    * DriversLicense / DRIVERS\_LICENSE / 2017 - OCR provider switched to Incode
  * **New Hampshire**
    * DriversLicense / DRIVERS\_LICENSE / 2011 - `documentSeriesExpired` enabled on template level
    * IdentificationCard / IDENTIFICATION\_CARD / 2017 - OCR provider switched to Incode
  * **New Jersey**
    * Other / IDENTIFICATION\_CARD / 2023 - Gender standardised to one letter values
  * **New York**
    * DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2017 - OCR provider switched to Incode
  * **North Carolina**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2024 - Template improved in general
    * DriversLicense / DRIVERS\_LICENSE / 2024 - OCR provider switched to Incode
  * **North Dakota**
    * DriversLicense / DRIVER\_LICENSE\_UNDER21 / 2023 - OCR provider switched to Incode
  * **Oregon**
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2018 - OCR provider switched to Incode
  * **South Carolina**
    * DriversLicense / LEARNERS\_PERMIT / 2025 - Template improved in general
    * DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2025 - Template improved in general
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2025 - Template improved in general
  * **Tennessee**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2024 - OCR provider switched to Incode
    * DriversLicense / LEARNERS\_PERMIT / 2024 - OCR provider switched to Incode
    * DriversLicense / TEMPORARY\_DRIVERS\_LICENSE / 2024 - OCR provider switched to Incode
    * IdentificationCard / IDENTIFICATION\_CARD / 2015 - OCR provider switched to Incode
    * IdentificationCard / IDENTIFICATION\_CARD\_UNDER21 / 2024 - OCR provider switched to Incode
  * **Washington**
    * DriversLicense / LEARNERS\_PERMIT / 2018 - OCR provider switched to Incode
  * **West Virginia**
    * DriversLicense / DRIVERS\_LICENSE / 2023 - Template improved in general
    * IdentificationCard / IDENTIFICATION\_CARD / 2023 - Template improved in general
  * **Wisconsin**
    * DriversLicense / DRIVERS\_LICENSE\_UNDER21 / 2015 - Document classification improved
    * DriversLicense / LEARNERS\_PERMIT\_UNDER21 / 2023 - OCR provider switched to Incode

  **Yemen**

  * DriversLicense / DRIVERS\_LICENSE / 2019 - Specific field improvements: expirationDate
</Accordion>

<br />

---

- Path: `release-notes/pt-br-portuguese-brazil`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Certidão de nascimento`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Moeda`
* `capturePreview.acceptedDocuments.DriversLicense` = `Carteira de motorista`
* `capturePreview.acceptedDocuments.FederalID` = `ID federal`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Cartão de identificação`
* `capturePreview.acceptedDocuments.label` = `Documentos aceitos para:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Cartão médico`
* `capturePreview.acceptedDocuments.Military` = `Militar`
* `capturePreview.acceptedDocuments.noDocuments` = `Não são aceitos documentos para esse país. `
* `capturePreview.acceptedDocuments.Other` = `Outros`
* `capturePreview.acceptedDocuments.Passport` = `Passaporte`
* `capturePreview.acceptedDocuments.Permit` = `Permissão`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Documento de residência`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identificação fiscal`
* `capturePreview.acceptedDocuments.TravelDocument` = `Documento de viagem`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identificação tribal`
* `capturePreview.acceptedDocuments.Unknown` = `Desconhecido`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Registro de veículos`
* `capturePreview.acceptedDocuments.Visa` = `Visto`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identificação do eleitor`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Licença de arma`
* `common.refreshPage` = `Atualizar`
* `commonIssues.idv2.tryAgain` = `Ok, tente novamente`
* `errors.dynamicImport.failedToLoad` = `Foi um erro inesperado, mas tomamos nota do fato:`
* `errors.dynamicImport.suggestion` = `Tentaremos novamente em {{count}} ou você pode atualizar manualmente`
* `errors.dynamicImport.title` = `Desculpe, encontramos um problema`
* `idv2.capture.autoCapture` = `A foto será tirada automaticamente`
* `idv2.capture.dontMove` = `Não mova seu ID por alguns segundos`
* `idv2.capture.fillFrame` = `Preencha a moldura com sua identificação`
* `idv2.capture.fillFramePassport` = `Preencha a moldura com seu passaporte`
* `idv2.capture.manualCapture.ariaLabel` = `Captura manual`
* `idv2.capture.manualCapture.title` = `Botão de captura manual`
* `idv2.capture.notifications.blur.description` = `Aumente e diminua o zoom ou toque na ID`
* `idv2.capture.notifications.blur.title` = `ID muito embaçada`
* `idv2.capture.notifications.glare.description` = `Encontre uma iluminação melhor para evitar reflexos`
* `idv2.capture.notifications.glare.title` = `Identificação com brilho`
* `idv2.capture.notifications.notAligned.description` = `Centralize sua ID dentro da moldura`
* `idv2.capture.notifications.notAligned.title` = `A ID não está alinhada`
* `idv2.capture.notifications.showBack.description` = `Vire seu documento de identidade para mostrar o verso`
* `idv2.capture.notifications.showBack.title` = `Mostrar o verso do documento de identidade`
* `idv2.capture.notifications.showFront.description` = `Vire sua identificação para mostrar a parte da frente`
* `idv2.capture.notifications.showFront.title` = `Mostrar a frente do documento de identidade`
* `idv2.capture.passport.subtitle` = `Certifique-se de que seu passaporte esteja legível`
* `idv2.capture.passport.title` = `Digitalize seu passaporte`
* `idv2.capture.processing.analyzing` = `Analisando...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} tentativas restantes`
* `idv2.capture.processing.continue` = `Continuar`
* `idv2.capture.processing.error` = `Erro`
* `idv2.capture.processing.errors.classification.subtitle` = `Certifique-se de que toda a identificação esteja visível e bem iluminada`
* `idv2.capture.processing.errors.classification.title` = `Falha na verificação de ID`
* `idv2.capture.processing.errors.default.subtitle` = `Tente novamente`
* `idv2.capture.processing.errors.default.title` = `Houve um problema`
* `idv2.capture.processing.errors.glare.subtitle` = `Incline a ID ligeiramente para cima ou para baixo para minimizar o reflexo`
* `idv2.capture.processing.errors.glare.title` = `Brilho presente`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimize a trepidação da câmera segurando o telefone com firmeza`
* `idv2.capture.processing.errors.readability.title` = `As informações não são legíveis`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Aproxime ou afaste a ID do telefone até que a imagem esteja focada`
* `idv2.capture.processing.errors.sharpness.title` = `Borrão presente`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Tente com um documento diferente`
* `idv2.capture.processing.errors.unacceptable.title` = `O tipo de ID não é aceito`
* `idv2.capture.processing.errors.upload.subtitle` = `Verifique sua conexão e tente novamente`
* `idv2.capture.processing.errors.upload.title` = `Falha na verificação de ID`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capture {{mode}} lado do ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Captura do lado errado da ID`
* `idv2.capture.processing.scanBack` = `Digitalizar o verso`
* `idv2.capture.processing.success` = `Sucesso`
* `idv2.capture.processing.successBackSubtitle` = `Agora vamos continuar`
* `idv2.capture.processing.successFrontSubtitle` = `Agora vamos capturar a parte traseira`
* `idv2.capture.processing.successTitle` = `Processado com sucesso!`
* `idv2.capture.processing.tryAgain` = `Tente novamente`
* `idv2.capture.takingPhoto` = `Tirar fotos...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `Carteira de identidade nacional ou carteira de motorista`
* `idv2.chooser.idButtonTitle` = `Carteira de identidade`
* `idv2.chooser.passportButtonDescription` = `Passaporte de seu país`
* `idv2.chooser.passportButtonTitle` = `Passaporte`
* `idv2.permissions.alertAlt` = `alerta de permissão falsa`
* `idv2.permissions.allow` = `OK, Permitir`
* `idv2.permissions.denied.allow` = `Permitir`
* `idv2.permissions.denied.ask` = `Perguntar`
* `idv2.permissions.denied.browser` = `Navegador`
* `idv2.permissions.denied.camera` = `Câmera`
* `idv2.permissions.denied.changeTo` = `Alterar para`
* `idv2.permissions.denied.open` = `Aberto`
* `idv2.permissions.denied.or` = `ou`
* `idv2.permissions.denied.refreshPage` = `Atualizar página`
* `idv2.permissions.denied.return` = `Volte aqui e pressione`
* `idv2.permissions.denied.scroll` = `Role para baixo para selecionar`
* `idv2.permissions.denied.settings` = `Configurações`
* `idv2.permissions.denied.tap` = `Torneira`
* `idv2.permissions.denied.title` = `Siga as próximas etapas para permitir que o Incode acesse sua câmera`
* `idv2.permissions.denied.yourBrowser` = `Seu navegador`
* `idv2.permissions.description` = `para concluir o processo`
* `idv2.permissions.dontAllow` = `Não permitir`
* `idv2.permissions.fakeDenied.alert` = `alerta falso focado`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permissões`
* `idv2.permissions.fakeDenied.quitProcess` = `Sair do processo`
* `idv2.permissions.fakeDenied.title` = `A permissão da câmera é necessária para a captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `aviso`
* `idv2.permissions.note` = `Observação: Dependendo do seu telefone, ele pode dizer`
* `idv2.permissions.or` = `ou`
* `idv2.permissions.subtitle` = `permitir permissão de câmera`
* `idv2.permissions.title` = `Precisamos que você`
* `idv2.permissions.whileUsing` = `Ao usar o aplicativo`
* `idv2.tutorial.autoCapture` = `A foto será tirada automaticamente`
* `idv2.tutorial.startScan` = `Vamos examinar`
* `idv2.tutorial.subtitle` = `Certifique-se de que sua identificação seja legível`
* `idv2.tutorial.title` = `Digitalize sua identidade`
* `idv2.uploading.analyzing` = `Analisando...`
* `idv2.uploading.imageAlt` = `Captura de ID`
* `onboarding.errors.restartDisabled.message` = `Reinício da sessão desativado no nível da organização`
* `onboarding.errors.restartDisabled.title` = `Não é possível reiniciar a sessão`
* `qes.signatureCheck` = `Concordo com a emissão do certificado exigido e com a assinatura eletrônica deste documento.`
* `qes.termsCheck` = `Li e concordo com a <2>Política de Privacidade</2> da Incode e com os <6>Termos de Uso</6> da Incode.`

## ✏️ Modified

* `commonIssues.infoNotReadable`:
  * Before: `As informações não são legíveis`
  * Now: `Informações não legíveis`
* `commonIssues.takeManually`:
  * Before: `Tirar a foto manualmente`
  * Now: `Tirar foto manualmente`
* `commonIssues.tryAgain`:
  * Before: `Ok, tente novamente`
  * Now: `Tente novamente`
* `ineCheck.verified`:
  * Before: `Identidade verificada!`
  * Now: `Identidade enviada para verificação`
* `notifications.done`:
  * Before: `Feito`
  * Now: `Digitalização concluída`
* `notifications.glareDetectedDescription`:
  * Before: `Incline a CNH ou RG para cima ou para baixo para minimizar o reflexo`
  * Now: `Encontre uma iluminação melhor para evitar reflexos`
* `notifications.idTypeUnacceptable`:
  * Before: `O tipo de ID não é aceito`
  * Now: `Documento de identificação inválido`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Por favor tente com um documento diferente`
  * Now: `Tente escanear um diferente`
* `notifications.lowSharpness`:
  * Before: `Fora de foco`
  * Now: `Baixa nitidez`

---

- Path: `release-notes/pt-br-portuguese-brazil-1`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-1/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-1.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `idv2.permissions.fakeDenied.alert` = `alerta falso focado`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permissões`
* `idv2.permissions.fakeDenied.quitProcess` = `Sair do processo`
* `idv2.permissions.fakeDenied.title` = `A permissão da câmera é necessária para a captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `aviso`

---

- Path: `release-notes/pt-br-portuguese-brazil-10`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-10/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-10.md

# PT - BR - Portuguese (Brazil)

## 🆕 Added

* `biometricConsent.subtitle` = `Sua verificação é feita pela Incode. Para cumprir as normas estaduais, precisamos de seu consentimento para o processamento biométrico.`
* `documentCapture.camera.subtitle` = `Verifique se ele está totalmente visível e pressione o botão`
* `documentCapture.camera.title` = `Mostre seu documento completo`
* `documentCapture.commonIssues.dirtyPresent` = `A lente da câmera está suja`
* `documentCapture.commonIssues.dirtyPresentDescription` = `Limpe a lente da câmera para obter uma imagem mais nítida.`
* `documentCapture.commonIssues.farPresent` = `O documento está muito distante ou fora do quadro`
* `documentCapture.commonIssues.farPresentDescription` = `Certifique-se de que todas as bordas estejam visíveis na tela.`
* `documentCapture.commonIssues.foldedIdPresent` = `O documento está dobrado`
* `documentCapture.commonIssues.foldedIdPresentDescription` = `Achate seu documento e verifique se ele está totalmente aberto e reto.`
* `documentCapture.commonIssues.shadowPresent` = `Sombras no documento`
* `documentCapture.commonIssues.shadowPresentDescription` = `Vá para uma área mais iluminada e evite projetar sombras sobre seu documento.`
* `documentCapture.errors.fileSizeExceed` = `O arquivo excede o tamanho máximo de {{maxSize}}`
* `documentCapture.review.analyzing` = `Analisando...`
* `documentCapture.review.continue` = `Continuar`
* `documentCapture.review.error.description` = `Certifique-se de que todas as informações do documento estejam claras e legíveis.`
* `documentCapture.review.error.title` = `Não é possível processar`
* `documentCapture.review.errorTitle` = `Algo deu errado`
* `documentCapture.review.errorUpload` = `Ocorreu um erro ao processar seu documento.`
* `documentCapture.review.replace` = `Substituir`
* `documentCapture.review.retake` = `Retomar`
* `documentCapture.review.subtitleCaptured` = `Certifique-se de que o documento inteiro se ajuste à visualização e que o texto seja legível.`
* `documentCapture.review.subtitleImageUpload` = `Certifique-se de que o documento inteiro se ajuste à visualização e que o texto seja legível.`
* `documentCapture.review.subtitlePdfUpload` = `Certifique-se de ter selecionado o arquivo correto antes de continuar o processo de verificação.`
* `documentCapture.review.successTitle` = `Processado com sucesso!`
* `documentCapture.review.titleCaptured` = `Revise seu documento`
* `documentCapture.review.titleImageUpload` = `Revisar a foto selecionada`
* `documentCapture.review.titlePdfUpload` = `Revise seu documento`
* `documentCapture.review.tryAgain` = `Tente novamente`
* `documentCapture.review.uploading` = `Carregando...`
* `documentCapture.tutorial.captureButton` = `Capturar documento`
* `documentCapture.tutorial.chooseFile` = `Escolha um dispositivo`
* `documentCapture.tutorial.multiPageDocument.subtitle` = `Tire uma foto da próxima página para continuar.`
* `documentCapture.tutorial.multiPageDocument.title` = `Próxima página do documento`
* `documentCapture.tutorial.skipButton` = `Pular esta etapa`
* `documentCapture.tutorial.subtitle` = `Tire uma foto ou carregue um PDF, JPG ou PNG`
* `documentCapture.tutorial.takePhoto` = `Tirar foto`
* `documentCapture.tutorial.title` = `Verifique seu documento`
* `documentCapture.tutorial.uploadButton` = `Carregar documento`
* `documentCapture.tutorial.uploadDocument` = `Carregar documento`
* `ekyb.error.USTaxId` = `ID fiscal inválido. O ID fiscal deve ter 9 dígitos.`
* `idv2.ageVerificationPage.step1of3` = `Etapa 1 de 3: `
* `idv2.ageVerificationPage.step2of3` = `Etapa 2 de 3: `
* `idv2.ageVerificationPage.step3of3` = `Etapa 3 de 3: `
* `idv2.chooser.digitalIdButtonTitle` = `Identificação digital`
* `idv2.chooser.loadingDigitalWallet` = `Carregando a carteira digital...`
* `idv2.flipAnimation.titleToFront` = `Mostre a frente de seu documento de identidade`
* `idv2.permissions.allowEveryTime` = `Permitir todas as vezes`
* `idv2.permissions.allowOnlyWhileUsingTheApp` = `Permitir somente durante o uso do aplicativo`
* `idv2.permissions.denied.onDevice` = `no dispositivo`
* `idv2.permissions.denied.opera.appsOpera` = `Aplicativos <arrow/> Opera`
* `idv2.permissions.denied.permissionsCamera` = `Persmissions <arrow/> Câmera`
* `idv2.permissions.denied.persmissionsCamera` = `Persmissions <arrow/> Câmera`
* `idv2.permissions.denied.settingsApp` = `Aplicativo de configurações`
* `idv2.permissions.denied.setTo` = `Definir como`
* `idv2.permissions.denied.sitePermissions` = `Permissões do site`
* `idv2.permissions.denied.sitesAndDownloads` = `Sites e downloads`
* `idv2.tutorial.subtitleBack` = `Certifique-se de que sua identificação seja legível`
* `idv2.tutorial.v2.titleBack` = `Mostre o verso de seu documento de identidade`
* `manualIdUpload.frontRequiredFirst` = `Faça o upload da frente do documento de identidade primeiro`
* `manualIdUpload.uploadBackId` = `Fazer upload do verso do documento de identidade`
* `manualIdUpload.uploadFrontId` = `Fazer upload da frente do documento de identidade`
* `manualIdUpload.uploadPassport` = `Fazer upload do passaporte`
* `notifications.noTries` = `Número máximo de tentativas atingido`
* `selfiev2.autoCapture.defaultAriaInstructions` = `Centralize seu rosto no quadro.`
* `selfiev2.capture.title` = `Captura de rosto`
* `verification.errors.ARPostalCodeInvalidFormat` = `Digite um código postal válido da Argentina (formato: A1111AAA)`
* `verification.errors.CAPostalCodeInvalidFormat` = `Digite um código postal canadense válido (formato: A1A 1A1).`
* `verification.errors.ESPostalCodeInvalidFormat` = `Digite um código postal de 5 dígitos`
* `verification.errors.UKPostalCodeInvalidFormat` = `Digite um código postal válido do Reino Unido.`
* `verification.noFormFields` = `Nenhum campo foi configurado para esse formulário.`
* `watchlistBusiness.businessName` = `Nome da empresa`
* `watchlistBusiness.businessNameRequired` = `O campo Nome da empresa é obrigatório`
* `watchlistBusiness.continue` = `Continuar`
* `watchlistBusiness.watchlistForBusiness` = `Lista de observação para empresas`

## ✏️ Modified

* `idv2.permissions.denied.cameraAllow`:
  * Old: `Toque em Câmera <arrow/> Allow`
  * New: `Câmera <arrow/> Permitir`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Usamos a câmera apenas para o processo de verificação.`
  * New: `Usamos a câmera apenas para capturar sua identificação para verificação segura`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `O processo de verificação garante que você é quem diz ser.`
  * New: `Ele ajuda a verificar a autenticidade do documento e a evitar fraudes de identidade`
* `idv2.permissions.subtitleV2`:
  * Old: `Isso permite que a câmera realize a captura necessária para a verificação`
  * New: `Isso permite que você tire uma foto de sua identidade e rosto para fins de verificação.`
* `otp.errorv2`:
  * Old: `O código expirou, tente novamente`
  * New: `Algo deu errado`

---

- Path: `release-notes/pt-br-portuguese-brazil-11`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-11/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-11.md

# PT - BR- Portuguese (Brazil)

## 🆕 Added

* `aes.confirmSignature.finishSigning` = `Concluir a assinatura`
* `aes.reviewDocument.subtitle` = `Certifique-se de ter selecionado o arquivo correto antes de continuar a assinar.`
* `aes.reviewDocument.title` = `Revise seu documento`
* `biometricConsent. consentOptions` = `Opções de consentimento`
* `common.done` = `Pronto!`
* `common.wontTakeLong` = `Isso não vai demorar muito`
* `curp.verifyManually` = `Verificar manualmente`
* `customFields.completed` = `Concluído!`
* `customFields.continue` = `Continuar`
* `customFields.processing` = `Processamento...`
* `customFields.title` = `Insira suas informações`
* `customWatchlist.done` = `Pronto!`
* `customWatchlist.wontTake` = `Isso não vai demorar muito`
* `digilocker.denied.tryAgain` = `Tente novamente`
* `documentCapture.button.allPagesCaptured` = `Todas as páginas capturadas`
* `documentCapture.button.nextPage` = `Próxima página`
* `documentCapture.tutorial.continue` = `Continuar`
* `documentCapture.tutorial.multiPageDocument.optionalPage.subtitle` = `Se houver outra página com informações relevantes, você poderá capturá-la agora.`
* `ekyb.addAnotherDirector` = `Adicionar outro diretor (opcional)`
* `ekyb.directorNameWithNumber` = `Diretor {{number}} Nome`
* `ekyb.directorSurnameWithNumber` = `Diretor {{number}} Sobrenome`
* `ekyb.error.taxId-cn` = `Digite um código de crédito social unificado chinês válido (18 caracteres alfanuméricos)`
* `ekyb.error.taxId-de` = `Digite um ID fiscal alemão válido: VAT (DE + 9 dígitos), HRB (3-6 dígitos), HRB (6 dígitos + letra) ou HRA (4-6 dígitos)`
* `ekyb.error.taxId-es` = `Digite um ID fiscal espanhol válido: NIF (letra + 8 dígitos), NIE (letra + 7 dígitos + letra) ou DNI (8 dígitos + letra)`
* `ekyb.error.taxId-gb` = `Insira um ID fiscal válido do Reino Unido: Número de registro (7-8 dígitos) ou Número de IVA (GB seguido de 9 dígitos ou apenas 9 dígitos)`
* `ekyb.error.taxId-il` = `Digite um Mispar Osek israelense válido (9 dígitos)`
* `ekyb.error.taxId-it` = `Digite um ID fiscal italiano válido: CCIAA/NREA (2 letras + 6-7 dígitos), ID da empresa (IT + 8 dígitos) ou código de imposto/VAT (11 dígitos)`
* `ekyb.error.taxId-mx` = `Digite um RFC mexicano válido: Individual (4 letras + 6 dígitos + 3 alfanuméricos) ou Empresarial (3 letras + 6 dígitos + 3 alfanuméricos)`
* `ekyb.error.taxId-ng` = `Insira um ID fiscal nigeriano válido (10 dígitos)`
* `ekyb.error.taxId-nl` = `Digite um ID fiscal holandês válido: Número de IVA (NL + 9 dígitos + B + 2 dígitos) ou número KvK (8 dígitos)`
* `email.placeholder` = `E-mail`
* `forms.placeholder.select` = `Selecione uma opção`
* `identityReuse.cta.continue` = `Continuar com a verificação rápida`
* `identityReuse.cta.verify` = `Verificar usando a ID`
* `identityReuse.description` = `Somente transferiremos os dados solicitados por {{companyName}} para concluir sua verificação`
* `identityReuse.subtitle` = `Você já fez a verificação com um de nossos parceiros. Compartilhe seus dados para economizar tempo e verificar mais rapidamente.`
* `identityReuse.title` = `Compartilhe seus dados para uma verificação mais rápida`
* `idOcr.title` = `Verifique seus dados`
* `idv2.capture.expiredId.idScanFailed` = `Falha na verificação de ID`
* `idv2.capture.expiredId.pleaseTryWithADifferentId` = `Tente com um documento diferente`
* `idv2.capture.notifications.idScanFailed` = `Falha na verificação de ID`
* `idv2.capture.processing.attemptsRemainingLabel` = `tentativas restantes`
* `idv2.capture.processing.noAttemptsRemaining` = `Nenhuma tentativa restante`
* `idv2.chooser.appleWallet` = `Carteira da Apple`
* `idv2.chooser.deviceWalletTag` = `Instantâneo`
* `idv2.chooser.googleWallet` = `Google Wallet`
* `idv2.digilocker.consentDeniedDescription` = `O consentimento para compartilhar documentos via DigiLocker não foi fornecido. Você pode tentar novamente ou escolher outra forma de verificação.`
* `idv2.digilocker.consentDeniedTitle` = `Consentimento negado`
* `idv2.digilocker.openingDigilockerForAuthentication` = `Abertura do DigiLocker para autenticação...`
* `idv2.digilocker.sessionErrorDescription` = `Não foi possível restaurar a sessão. Reinicie o processo de verificação.`
* `idv2.digilocker.sessionErrorTitle` = `Erro de sessão`
* `idv2.digilocker.takingYouToDigilocker` = `Levando você ao DigiLocker.`
* `idv2.digilocker.timeoutDescription` = `A solicitação do DigiLocker não foi concluída dentro do tempo esperado. Tente novamente ou selecione um método de verificação alternativo.`
* `idv2.digilocker.timeoutTitle` = `O tempo limite da sessão foi atingido.`
* `idv2.digilocker.verificationCompleteTitle` = `Identidade verificada com sucesso`
* `idv2.digitalIdUpload.fileTooLargeScreen.cta` = `Escolha outro arquivo`
* `idv2.digitalIdUpload.fileTooLargeScreen.subtitle` = `O arquivo selecionado é maior que 5 MB, faça o upload de um arquivo menor`
* `idv2.digitalIdUpload.fileTooLargeScreen.title` = `O arquivo é muito grande`
* `idv2.permissions.denied.cameraFindSiteAllow` = `Câmera <arrow/> Localizar site <arrow/> Permitir`
* `loadingCircle.preparingCamera` = `Preparação da câmera`
* `manualIdUpload.generic` = `Faça o upload do documento correto`
* `manualIdUpload.glareDetected` = ` Brilho presente`
* `manualIdUpload.hintIdReadable` = `Certifique-se de que o texto na ID seja legível.`
* `manualIdUpload.hintPassportReadable` = `Verifique se o texto no passaporte está legível.`
* `manualIdUpload.hintSharpAndGlareFree` = `A foto deve estar nítida e sem reflexos.`
* `manualIdUpload.lowSharpness` = `Borrão presente`
* `manualIdUpload.qualityRejected` = `A qualidade da imagem é muito baixa.`
* `manualIdUpload.readabilityIssue` = `As informações não são legíveis`
* `manualIdUpload.subtitle` = `Certifique-se de que sua identificação seja legível`
* `manualIdUpload.uploadingSubtitle` = `Carregamento de seu arquivo`
* `manualIdUpload.uploadingTitle` = `Espere um pouco...`
* `manualIdUpload.wrongDocument` = `Faça o upload do documento correto`
* `onboarding.errors.onboardingUrlAlreadyUsed.message` = `Parece que esse URL já está em uso`
* `onboarding.errors.onboardingUrlAlreadyUsed.title` = `Seu URL é inválido`
* `otp.resendCodeAvailable` = `Agora você pode reenviar o código`
* `otp.timerFiveSeconds` = `5 segundos restantes`
* `otp.timerStarted` = `Você pode solicitar um novo código em {{ time }} segundos`
* `otp.timerTenSeconds` = `10 segundos restantes para que você possa solicitar um novo código`
* `otp.verificationCode` = `Código de verificação`
* `phone.invalidPhone` = `Número de telefone inválido. Tente novamente.`
* `phone.optIn` = `Concordo em receber notificações por SMS`
* `phone.serverError` = `Algo deu errado. Tente novamente mais tarde.`
* `qes.documentsReviewedCheck` = `Confirmo que revisei os documentos a serem assinados listados acima antes de assinar.`
* `qes.issuanceCheck` = `Concordo com a emissão de um Certificado Qualificado para assinaturas eletrônicas pela Incode Czech Republic s.r.o., atuando como um Provedor de Serviços de Confiança Qualificado (QTSP).`
* `qes.newTermsCheck` = `Li, compreendi e concordo com os <2>Termos de Uso</2> e a <6>Política de Privacidade</6> aplicáveis à emissão e ao uso deste certificado.`
* `qes.qesAcknowledgementCheck` = `Reconheço que esse processo resultará em uma Assinatura Eletrônica Qualificada (QES), que tem o mesmo efeito legal que uma assinatura manuscrita de acordo com a legislação da UE (eIDAS, Regulamento (UE) 910/2014).`
* `qes.qscdConfirmationCheck` = `Confirmo que a assinatura foi criada usando um Dispositivo de Criação de Assinatura Qualificada (QSCD) e que mantenho controle exclusivo sobre o processo de assinatura.`
* `redirect.didntReceiveLinkActions` = `Não recebeu o link? <resend>Reenviar</resend> ou <changePhone>alterar o número de telefone</changePhone>`
* `redirect.linkResent` = `Link reenviado com sucesso`
* `redirect.linkSentTo` = `Para : {{phone}}`
* `signature.fullSignaturePlaceholder` = `Assine aqui`
* `signature.fullSignatureTitle` = `Desenhe sua assinatura`
* `signature.initialsPlaceholder` = `Desenhe suas iniciais aqui`
* `signature.initialsTitle` = `Escreva suas iniciais`
* `signature.subtitle` = `Use o dedo ou o mouse`
* `signature.successTitle` = `Assinado com sucesso!`
* `userData.cpf` = `CPF`
* `v2.redirectToMobile.continueOnDesktop` = `Continuar no desktop`
* `v2.redirectToMobile.qr.description` = `Leia o código QR para verificar em seu dispositivo móvel.`
* `v2.redirectToMobile.sms.description` = `Digite seu número de telefone para receber um link para verificação via SMS`
* `v2.redirectToMobile.sms.sendSms` = `Enviar link via SMS`
* `v2.redirectToMobile.subtitle` = `Você precisará de um documento de identidade válido emitido pelo governo e uma selfie.`
* `v2.redirectToMobile.tabs.0` = `Escanear QR`
* `v2.redirectToMobile.tabs.1` = `Enviar SMS`
* `v2.redirectToMobile.title` = `Verifique sua identidade`
* `v2.settings.language` = `Idioma`
* `validation.invalidDate` = `Data inválida`
* `verification.errors.countryNotSupported` = `Solicitação malsucedida. País não suportado para EKYC.`
* `verification.errors.exactly10Characters` = `Deve ter exatamente 10 caracteres`
* `verification.errors.fieldRequiredDynamic` = `{{fieldName}} é necessário`
* `verification.errors.idNumRequired` = `Número de identificação nacional necessário`
* `verification.errors.invalidPostalCodeFixedLength` = `Digite um código postal de {{length}} dígitos`
* `verification.errors.onlyLettersAndNumbers` = `Somente letras e números são permitidos`
* `verification.errors.taxIdRequired` = `É necessário ter uma identificação fiscal`
* `verification.labels.panNumber` = `Número PAN`
* `watchlistForBusiness.title` = `Lista de observação para empresas`

## ✏️ Modified

* `aes.confirmSignature.addDocument`:
  * Old: `Adicionar documento`
  * New: `Carregar documento`
* `aes.confirmSignature.fail`:
  * Old: `Algo deu errado.`
  * New: `Algo deu errado`
* `aes.confirmSignature.subtitle`:
  * Old: `Os seguintes documentos serão assinados`
  * New: `Aceite os termos abaixo para concluir sua assinatura.`
* `aes.confirmSignature.terms1.title`:
  * Old: `Aceito os termos e condições do Trust Center`
  * New: `Aceito os termos e condições do <2>Trust Center</2>`
* `aes.confirmSignature.title`:
  * Old: `Confirme sua assinatura`
  * New: `Aceitar e assinar`
* `aes.confirmSignature.uploadDescription`:
  * Old: `Suporte ao formato PDF`
  * New: `Suporte a arquivos PDF`
* `aes.confirmSignature.viewDocument`:
  * Old: `Ver documento`
  * New: `Ver`
* `documentCapture.review.error.description`:
  * Old: `Certifique-se de que todas as informações do documento estejam claras e legíveis.`
  * New: `Algumas páginas não estavam claras ou estavam incompletas. Recupere todas as páginas do documento para continuar.`
* `documentCapture.review.error.title`:
  * Old: `Não é possível processar`
  * New: `O documento precisa ser recapturado`
* `documentCapture.review.tryAgain`:
  * Old: `Tente novamente`
  * New: `Documento de recaptura`
* `documentSelector.id`:
  * Old: `<p>Carteira de motorista</p><p>Carteira de identidade</p><p>Cartão de residente</p>`
  * New: `Documento Físico`
* `idv2.chooser.digitalIdButtonTitle`:
  * Old: `Identificação digital`
  * New: `ID digital`
* `idv2.chooser.idButtonTitle`:
  * Old: `Carteira de identidade`
  * New: `Documento Físico`
* `manualCapture.ariaLabel`:
  * Old: `botão de captura manual`
  * New: `capturar foto`
* `manualIdUpload.uploadPassport`:
  * Old: `Fazer upload do passaporte`
  * New: `Passaporte`
* `signature.clear`:
  * Old: `Tela transparente`
  * New: `Limpar área`
* `signature.done`:
  * Old: `Feito`
  * New: `Concluir`
* `userData.sex`:
  * Old: `Sexo`
  * New: `Gênero`
* `v2.idError.attemptsLeft_other`:
  * Old: `{{count}} tentativa restante`
  * New: `{{count}} tentativas restantes`

---

- Path: `release-notes/pt-br-portuguese-brazil-2`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-2/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-2.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `documentCapture.multiPageDocument.step1.description` = `Certifique-se de que o documento inteiro esteja no quadro`
* `documentCapture.multiPageDocument.step1.title` = `Preparar a primeira página`
* `documentCapture.multiPageDocument.step2.description` = `Certifique-se de que o documento inteiro esteja no quadro`
* `documentCapture.multiPageDocument.step2.title` = `Preparar a segunda página`
* `face.tutorial.startCapture` = `Tirar uma selfie`
* `face.tutorial.subtitle` = `Isso permite que você faça login usando seu rosto.`
* `face.tutorial.title` = `Tire uma selfie`
* `idv2.flipAnimation.title` = `Mostre o verso de seu documento de identidade`

## ✏️ Modified

* `common.retake`:
  * Before: `Retomar`
  * Now: `Voltar`
* `notifications.dontMove`:
  * Before: `Fique quieto.`
  * Now: `Não se mova.`
* `notifications.getReady`:
  * Before: `Prepare-se e fique quieto...`
  * Now: `Prepare-se e não se mova…`
* `notifications.onFaceAngle`:
  * Before: `Alinhar a face dentro do contorno pontilhado`
  * Now: `Alinhe a face com o contorno pontilhado`
* `retake.instructions1`:
  * Before: `Certifique que o texto do CNH ou RG esteja legível`
  * Now: `Certifique-se de que o texto do CNH ou RG esteja legível`
* `retake.instructions2`:
  * Before: `A captura do CNH ou RG deve ser nítida e sem reflexos`
  * Now: `A imagem do CNH ou RG deve estar nítida e sem reflexos`
* `retake.titleBack`:
  * Before: `Revise a captura da <1>VERSO</1> do CNH ou RG`
  * Now: `Verifique a imagem da <1>VERSO</1> do CNH ou RG`
* `retake.titleFront`:
  * Before: `Revise a captura da <1>FRENTE</1> do CNH ou RG`
  * Now: `Verifique a imagem da <1>FRENTE</1> do CNH ou RG`
* `webcam.hold`:
  * Before: `Fique quieto...`
  * Now: `Não se mova...`

---

- Path: `release-notes/pt-br-portuguese-brazil-3`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-3/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-3.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `common.attemptsRemaining_other` = `{{count}} tentativas restantes`
* `common.attemptsRemaining_one` = `1 tentativa restante`
* `idv2.capture.processing.errors.wrongSide.back.subtitle` = `Capturar o verso da ID`
* `idv2.capture.processing.errors.wrongSide.front.subtitle` = `Capturar a parte frontal da ID`
* `idv2.needHelp.open` = `Abrir o modal Precisa de ajuda`
* `notifications.centerFaceV2` = `Certifique-se de alinhar o rosto dentro da silhueta`
* `notifications.cropDescription` = `Tente novamente com seu rosto centralizado no quadro`
* `notifications.multipleDescription` = `Certifique-se de que apenas um rosto esteja visível no quadro`
* `notifications.onFaceAngleV2` = `Alinhe o rosto com a silhueta branca`
* `notifications.portraitDescription` = `Segure seu dispositivo no modo retrato`
* `notifications.selfie.manualCaptureButtonLabel` = `Botão de captura manual`
* `notifications.selfie.manualCaptureLabel` = `Captura manual ativada. Pressione o botão para tirar a foto.`
* `notifications.unableToCropDescription` = `Tente novamente com seu rosto claramente visível`
* `retake.titleFrontLabel` = `Revisar a foto frontal do documento de identidade`
* `selfiev2.manualCapture.instructions` = `Centralize seu rosto na silhueta e pressione o botão para capturar`
* `tutorial.back.titleLabel` = `Agora, digitalize o verso de seu documento de identidade`
* `webviews.step1` = `Vá para "Configurações" → "Aplicativos".`
* `webviews.step2` = `Pesquisar o aplicativo`
* `webviews.step3` = `Permissão de câmera`

## ✏️ Modified

* `notifications.centerFace`:
  * Before: `Certifique-se de alinhar o rosto dentro do contorno pontilhado`
  * Now: `Alinhe a face dentro do contorno pontilhado`
* `notifications.faceNotFoundDescription`:
  * Before: `Certifique-se de alinhar o rosto dentro do contorno pontilhado`
  * Now: `Alinhe a face dentro do contorno pontilhado`
* `notifications.selfie.one`:
  * Before: `Alinhar a face`
  * Now: `Alinhe a face dentro`
* `notifications.selfie.two`:
  * Before: `com o contorno pontilhado`
  * Now: `do contorno pontilhado`

---

- Path: `release-notes/pt-br-portuguese-brazil-4`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-4/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-4.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `errors.dynamicImport.suggestion_other` = `Tentaremos novamente em {{count}} segundos ou você pode atualizar manualmente`
* `errors.dynamicImport.suggestion_one` = `Tentaremos novamente em {{count}} segundos ou você pode atualizar manualmente`
* `idv2.commonIssues.firstStep` = `1. Preencha a moldura com sua identificação`
* `idv2.commonIssues.secondStep` = `2. Pressione o botão`
* `verification.labels.gender` = `Gênero`
* `verification.labels.idNum` = `Número de identificação nacional`
* `verification.labels.idNum1` = `Número de identificação fiscal`

## 🆕 Modified

* `notifications.selfieCaptureFailed`:
  * Before: `Falha de captura`
  * Now: `Falha no processamento da selfie`
* `notifications.selfieCaptureFailedDescription`:
  * Before: `Não foi possível capturar a selfie`
  * Now: `Sua selfie será revisada manualmente mais tarde`
* `notifications.spoof`:
  * Before: `Falha de captura`
  * Now: `Falha no processamento da selfie`
* `notifications.spoofDescription`:
  * Before: `Não foi possível capturar sua selfie. Por favor, tente novamente`
  * Now: `Não foi possível processar sua selfie. Por favor, tente novamente`
* `notifications.spoofDescriptionNoTries`:
  * Before: `Não foi possível tirar uma selfie.`
  * Now: `Sua selfie será revisada manualmente mais tarde`
* `retake.titleBack`:
  * Before: `Verifique a imagem da <1>VERSO</1> do CNH ou RG`
  * Now: `Revisar a foto da identificação BACK`
* `retake.titleFront`:
  * Before: `Verifique a imagem da <1>FRENTE</1> do CNH ou RG`
  * Now: `Revisar a foto FRONTAL da identificação`
* `retake.titlePassport`:
  * Before: `Revisão da foto <1>do PASSPORT</1> `
  * Now: `Revisão da foto do PASSPORT`
* `selfie.spoof`:
  * Before: `Falha de captura`
  * Now: `Falha no processamento da selfie`
* `selfie.spoofDescription`:
  * Before: `Não foi possível capturar sua selfie. Por favor, tente novamente.`
  * Now: `Não foi possível processar sua selfie. Por favor, tente novamente`
* `tutorial.back.title`:
  * Before: `Agora, digitalize o <1>verso</1> de seu documento de identidade`
  * Now: `Agora, digitalize o verso de seu documento de identidade`
* `videoSelfie.errors.noInternetConnectionDescription`:
  * Before: `Aguarde o retorno da Internet para continuar o processo ou conecte-se a uma rede disponível`
  * Now: `Aguarde o retorno da Internet para continuar o processo ou conecte-se a uma rede disponível.`

---

- Path: `release-notes/pt-br-portuguese-brazil-5`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-5/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-5.md

# PT-BR - Portuguese (Brazil)

## 🆕 Added

* `documentCapture.skip` = `Pular esta etapa`
* `idv2.capture.processing.uploading` = `Carregando...`
* `idv2.deepsightPermissions.subtitle` = `permissão`
* `idv2.deepsightPermissions.title` = `Permitir câmera e movimento `
* `idv2.permissions.allowPermissionsV2` = `Permitir permissões de câmera`
* `idv2.permissions.inOrderToCompleteTheProcess` = `para concluir o processo`
* `idv2.unacceptedId.acceptedDocuments` = `Documentos aceitos para:`
* `idv2.unacceptedId.attemptsLeft_one` = `({{count}} tentativa à esquerda)`
* `idv2.unacceptedId.attemptsLeft_other` = `({{count}} tentativas restantes)`
* `idv2.unacceptedId.birthCertificate` = `Certidão de nascimento`
* `idv2.unacceptedId.changeMethod` = `Alterar o método de verificação`
* `idv2.unacceptedId.currency` = `Moeda`
* `idv2.unacceptedId.driversLicense` = `Carteira de motorista`
* `idv2.unacceptedId.federalId` = `ID federal`
* `idv2.unacceptedId.identificationCard` = `Cartão de identificação`
* `idv2.unacceptedId.identificationCardDescription` = `Somente o INE emitido a partir de 2017.`
* `idv2.unacceptedId.medicalCard` = `Cartão médico`
* `idv2.unacceptedId.military` = `Militar`
* `idv2.unacceptedId.multipleNationalities` = `Várias nacionalidades?`
* `idv2.unacceptedId.noDocuments` = `Não são aceitos documentos para este país`
* `idv2.unacceptedId.other` = `Outros`
* `idv2.unacceptedId.passport` = `Passaporte`
* `idv2.unacceptedId.passportDescription` = `Somente passaportes emitidos em 2014.`
* `idv2.unacceptedId.permit` = `Permissão`
* `idv2.unacceptedId.residenceDocument` = `Documento de residência`
* `idv2.unacceptedId.seeDifferentCountry` = `Ver um país diferente`
* `idv2.unacceptedId.taxIdentification` = `Identificação fiscal`
* `idv2.unacceptedId.travelDocument` = `Documento de viagem`
* `idv2.unacceptedId.tribalIdentification` = `Identificação tribal`
* `idv2.unacceptedId.tryAgain` = `Tente novamente`
* `idv2.unacceptedId.unknown` = `Desconhecido`
* `idv2.unacceptedId.unknownCountry` = `Desconhecido`
* `idv2.unacceptedId.vehicleRegistration` = `Registro de veículos`
* `idv2.unacceptedId.visa` = `Visto`
* `idv2.unacceptedId.voterIdentification` = `Identificação do eleitor`
* `idv2.unacceptedId.weaponLicense` = `Licença de arma`
* `notifications.accessDenied` = `Acesso negado`
* `notifications.accessDeniedDescription` = `Não foi possível processar sua selfie. Por favor, tente novamente`
* `notifications.lowQualityImage` = `Condições de baixa qualidade`
* `notifications.lowQualityImageDescription` = `Fique imóvel para a captura e certifique-se de que seu rosto esteja claro e visível`
* `notifications.noAttemptsRemaining` = `Nenhuma tentativa restante`
* `videoSelfie.processingStep` = `Processamento...`

## ✏️ Modified

* `errors.dynamicImport.failedToLoad`:
  * Old: `Foi um erro inesperado, mas tomamos nota do fato:`
  * New: `Ocorreu um erro inesperado, mas tomamos nota dele:`
* `idv2.capture.processing.errors.unacceptable.title`:
  * Old: `O tipo de ID não é aceito`
  * New: `Documento de identidade não aceito`
* `idv2.permissions.denied.cameraAllow`:
  * Old: `Toque em Câmera → Permitir`
  * New: `Toque em Câmera <arrow/> Allow`
* `idv2.permissions.denied.siteSettings`:
  * Old: `Configurações → Configurações do site`
  * New: `Configurações <arrow/> Configurações do site`

---

- Path: `release-notes/pt-br-portuguese-brazil-6`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-6/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-6.md

# PT - BR - Portuguese (Brazil)

## 🆕 Added

* `
  desktop.idv2.digitalIdUpload.successfullyProcessed` = `Processado com sucesso!`
* `email.verified` = `E-mail verificado!`
* `email.verify` = `Verifique seu e-mail`
* `email.willSendCode` = `Nós lhe enviaremos um código para garantir que seja seu`
* `geolocationv2.addressBar` = `Em sua barra de endereços, toque em <strong>AA</strong>`
* `geolocationv2.allowLocationAccess` = `Permitir acesso ao local`
* `geolocationv2.allowUsing` = `Selecione <strong>Permitir durante o uso</strong>`
* `geolocationv2.appsBrowser` = `Vá para <strong>Apps <arrow/> Seu navegador</strong>`
* `geolocationv2.appsChrome` = `Vá para <strong>Aplicativos <arrow/> Chrome</strong>`
* `geolocationv2.appsFirefox` = `Vá para <strong>Aplicativos <arrow/> Firefox</strong>`
* `geolocationv2.appsOpera` = `Vá para <strong>Aplicativos <arrow/> Opera</strong>`
* `geolocationv2.choosePermissions` = `Escolha <strong>Perguntar na próxima vez</strong> ou <strong>Enquanto estiver usando o aplicativo</strong>`
* `geolocationv2.determineLocation` = `Precisamos determinar sua localização atual`
* `geolocationv2.goBackSafari` = `Voltar para <strong>Configurações <arrow/> Safari</strong>`
* `geolocationv2.instructions.allowLocation` = `Permitir permissões de local`
* `geolocationv2.locationOn` = `Certifique-se de que <strong>os Serviços de Localização</strong> estejam ativados`
* `geolocationv2.openSettings` = `Abrir<strong> configurações</strong>`
* `geolocationv2.openSettingsAndroid` = `Abra <strong>as configurações de</strong> seu <strong>dispositivo</strong>`
* `geolocationv2.permissionsLocation` = `Toque em <strong>Permissions (Permissões) <arrow/> Location (Localização)</strong>`
* `geolocationv2.privacySecurity` = `<strong>Privacidade e segurança</strong> abertas`
* `geolocationv2.refreshPage` = `Atualizar página`
* `geolocationv2.returnAndRefresh` = `Retornar aqui e <strong>atualizar a página</strong>`
* `geolocationv2.scrollDownChrome` = `Role a tela para baixo e toque em <strong>Chrome</strong>`
* `geolocationv2.scrollDownFirefox` = `Role a tela para baixo e toque em <strong>Firefox</strong>`
* `geolocationv2.scrollDownOpera` = `Role a tela para baixo e toque em <strong>Opera</strong>`
* `geolocationv2.skip` = `Pular esta etapa`
* `geolocationv2.tapLocation` = `<strong>Local</strong> da torneira`
* `geolocationv2.tapLocationAllow` = `Toque em <strong>Localização</strong> e escolha <strong>Permitir</strong>`
* `geolocationv2.tapSettings` = `Toque em <strong>Configurações do site <arrow/><br>Permitir permissões de localização</strong>`
* `idv2.capture.notifications.expiredId` = `Documento de identificação vencido`
* `idv2.capture.notifications.useDifferent` = `Use uma ID diferente`
* `idv2.capture.processing.processing` = `Processamento...`
* `idv2.capture.processing.scanFront` = `Escanear a frente`
* `idv2.capture.processing.successBackSubtitleScanFront` = `Agora vamos capturar a frente`
* `idv2.chooser.chooseHowToVerifyTitle` = `Escolha como verificar`
* `idv2.chooser.digitalIdUploadButtonTitle` = `Carregar ID digital`
* `idv2.chooser.manualUploadButtonTitle` = `Carregar ID`
* `idv2.digitalIdUpload.analyzing` = `Analisando...`
* `idv2.digitalIdUpload.digitalIdUploadButtonTitle` = `Carregar ID digital`
* `idv2.digitalIdUpload.errorScreen.scanId` = `Digitalize sua identidade`
* `idv2.digitalIdUpload.loadingSuccess.letsContinue` = `Vamos continuar`
* `idv2.digitalIdUpload.reviewScreen.description` = `Certifique-se de que esse é o arquivo correto antes de continuar o processo de verificação.`
* `idv2.digitalIdUpload.reviewScreen.replaceButton` = `Substituir arquivo`
* `idv2.digitalIdUpload.reviewScreen.replaceFileButton` = `Continuar`
* `idv2.digitalIdUpload.reviewScreen.title` = `Revise seu documento`
* `idv2.digitalIdUpload.screenDescription` = `Um arquivo PDF ou foto emitido pelo governo com seus dados, foto e um código QR`
* `idv2.digitalIdUpload.screenTitle` = `Faça o upload de sua ID digital`
* `idv2.digitalIdUpload.supportedFileTypesCopy` = `Arquivo PDF ou foto JPG, PNG`
* `idv2.digitalIdUpload.unknownDocumentTypeScreen.errorTitle` = `Não foi possível verificar sua ID`
* `idv2.digitalIdUpload.wrongDocumentType` = `Documento de identidade não aceito`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorSubtitle` = `Use uma ID diferente da lista aceita:`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.errorTitle` = `Documento de identidade não aceito`
* `idv2.digitalIdUpload.wrongDocumentTypeScreen.tryAgainButton` = `Tente novamente`
* `idv2.manualUploadLoading.subtitle` = `Carregamento de seu arquivo`
* `idv2.permissions.denied.chrome.fifthStep` = `Em seguida, <strong>atualize a página</strong>`
* `idv2.permissions.denied.chrome.firstStep` = `No canto superior esquerdo do site <strong>, clique no cadeado</strong>`
* `idv2.permissions.denied.chrome.fourthStep` = `Clique nele e selecione <strong>Permitir</strong>`
* `idv2.permissions.denied.chrome.secondStep` = `Um pequeno menu será aberto`
* `idv2.permissions.denied.chrome.thirdStep` = `Procure a <strong>câmera</strong>`
* `idv2.permissions.denied.firefox.fifthStep` = `Em seguida, <strong>atualize a página</strong>`
* `idv2.permissions.denied.firefox.firstStep` = `Clique na <strong>câmera</strong> ou no ícone <strong>de bloqueio</strong> `
* `idv2.permissions.denied.firefox.fourthStep` = `Clique nele e selecione <strong>Permitir</strong>`
* `idv2.permissions.denied.firefox.secondStep` = `Um menu será aberto`
* `idv2.permissions.denied.firefox.thirdStep` = `Procure a <strong>câmera</strong>`
* `idv2.permissions.denied.opera.fifthStep` = `Em seguida, <strong>atualize a página</strong>`
* `idv2.permissions.denied.opera.firstStep` = `Clique no ícone <strong>de cadeado</strong> `
* `idv2.permissions.denied.opera.fourthStep` = `Clique nele e selecione <strong>Permitir</strong>`
* `idv2.permissions.denied.opera.secondStep` = `Um pequeno menu será aberto`
* `idv2.permissions.denied.opera.thirdStep` = `Procure a <strong>câmera</strong>`
* `idv2.permissions.denied.safari.fifthStep` = `Clique nele e selecione <strong>Permitir</strong>`
* `idv2.permissions.denied.safari.firstStep` = `No canto superior esquerdo, clique em <strong>Safari</strong>`
* `idv2.permissions.denied.safari.fourthStep` = `Localize onde está escrito <strong>Câmera</strong>`
* `idv2.permissions.denied.safari.secondStep` = `Clique em <strong>Configurações para este site...</strong>`
* `idv2.permissions.denied.safari.sixthStep` = `Em seguida, <strong>atualize a página</strong>`
* `idv2.permissions.denied.safari.thirdStep` = `Uma caixa será exibida`
* `nameCapturev2.title` = `Digite seu nome`
* `nameCapturev2.verified` = `Nome verificado!`
* `otp.didntReceive` = `Não recebeu o código?`
* `otp.enterCodeEmail` = `Digite o código que enviamos para seu e-mail`
* `otp.errorv2` = `O código expirou, tente novamente`
* `otp.resendCode` = `Reenviar código`
* `otp.resendCountdown` = `Reenviar código em <strong>{{time}}s</strong>`
* `redirect.didntReceive` = `Não recebeu o link?`
* `redirect.enterPhoneNumber` = `Digite seu número de telefone para receber um link para verificação via SMS`
* `redirect.linkSent` = `Link enviado!`
* `redirect.phishingResistance.explanation1` = `Você precisará de um documento de identidade válido emitido pelo governo e uma selfie.`
* `redirect.phishingResistance.recommendedBrowser` = `Recomendamos o uso do Safari no iOS e do Chrome no Android.`
* `redirect.phishingResistance.titleClient` = `Verifique sua identidade`
* `redirect.resend` = `Reenviar`
* `redirect.scanQRTitle` = `Escanear QR`
* `redirect.scanQrv2` = `Leia o código QR para verificar em seu dispositivo móvel.`
* `redirect.sendLinkSms` = `Enviar link via SMS`
* `redirect.sendSms` = `Enviar SMS`

---

- Path: `release-notes/pt-br-portuguese-brazil-7`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-7/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-7.md

# PT - BR - Portuguese (Brazil)

## 🆕 Added

* `curp.continue` = `Continuar`
* `curp.dontHave` = `Eu não tenho uma CURP`
* `curp.enterCurp` = `Digite sua CURP`
* `curp.generate` = `Gerar sua CURP`
* `curp.generateCta` = `Gerar`
* `curp.labels.birthState` = `Estado de nascimento`
* `curp.labels.dob` = `Data de nascimento`
* `curp.labels.femaleV2` = `Feminino`
* `curp.labels.firstLast` = `Nome sobrenome`
* `curp.labels.firstName` = `Primeiro nome`
* `curp.labels.genderV2` = `Gênero`
* `curp.labels.maleV2` = `Masculino`
* `curp.labels.other` = `Não binário/outros`
* `curp.labels.secondLast` = `Segundo sobrenome`
* `curp.placeholder.curp` = `Sua CURP`
* `curp.placeholder.firstLast` = `Seu primeiro sobrenome`
* `curp.placeholder.firstName` = `Seu primeiro nome`
* `curp.placeholder.gender` = `Escolha o gênero`
* `curp.placeholder.secondLast` = `Seu segundo sobrenome`
* `curp.placeholder.state` = `Selecionar estado`
* `curp.status.checkInfo` = `Verifique as informações inseridas`
* `curp.status.confirm` = `Confirme sua CURP`
* `curp.status.couldntGenerate` = `Não foi possível gerar CURP`
* `curp.status.edit` = `Editar informações`
* `curp.status.generating` = `Geração de CURP...`
* `curp.status.notVerified` = `CURP não verificado`
* `curp.status.tryAgain` = `Tente novamente`
* `curp.status.verified` = `CURP verificado!`
* `curp.status.verifying` = `Verificação de seu CURP...`
* `faceMatch.continue` = `Continuar`
* `faceMatch.facesNoMatch` = `Os rostos não coincidem`
* `faceMatch.firstId` = `Primeira ID`
* `faceMatch.id` = `ID`
* `faceMatch.matched` = `Combinado!`
* `faceMatch.matching` = `Verificação de identidade`
* `faceMatch.processing` = `Processamento...`
* `faceMatch.secondId` = `Segunda ID`
* `faceMatch.selfie` = `Selfie`
* `face.tutorial.ageAssuranceStartCapture` = `Verificar a idade`
* `face.tutorial.ageAssuranceSubtitle` = `Sua imagem não será armazenada ou compartilhada com terceiros para proteger sua privacidade`
* `face.tutorial.ageAssuranceTitle` = `Tire uma selfie para verificar sua idade`
* `face.tutorial.autoCapture` = `Fique parado, a selfie será tirada automaticamente`
* `home.start` = `Início`
* `idv2.ageVerificationPage.ageVerification` = `Verificação de idade`
* `idv2.ageVerificationPage.Continue` = `Continuar`
* `idv2.ageVerificationPage.showYourIdAndScanIt` = `Mostre seu documento de identidade e digitalize-o`
* `idv2.ageVerificationPage.TheRestOfYourInformationWillBeDeletedToEnsureYourPrivacy` = `O restante de suas informações será excluído para garantir sua privacidade`
* `idv2.ageVerificationPage.weNeedToScanYourIDToKnowYourAge` = `Precisamos escanear seu documento de identidade para saber sua idade`
* `idv2.ageVerificationPage.weOnlyUseTheDateOfBirthInformation` = `Usamos apenas as informações de data de nascimento`
* `idv2.barCodeDetection.processingSubtitle` = `Estamos verificando sua identidade`
* `idv2.barCodeDetection.processingTitle` = `Espere um pouco...`
* `idv2.capture.processing.verifying` = `Verificando...`
* `idv2.digitalIdUpload.continue` = `Continuar`
* `idv2.digitalIdUpload.errorScreen.pleaseTryScanning` = `Tente escanear um documento diferente`
* `idv2.digitalIdUpload.errorScreen.thisIdMustBeScanned` = `Essa identificação deve ser digitalizada`
* `idv2.digitalIdUpload.reviewScreen.continue` = `Continuar`
* `idv2.digitalIdUpload.successfullyProcessed` = `Processado com sucesso!`
* `onboarding.errors.invalidQRuuid.message` = `Parece que seu URL não é válido ou expirou`
* `onboarding.errors.invalidQRuuid.title` = `Seu URL é inválido`
* `otp.enterCodeSMS` = `Digite o código que enviamos por SMS`
* `phone.verify` = `Verifique seu número de telefone`
* `redirect.resendCountdown` = `Reenviar o link em <strong>{{time}}s</strong>`
* `verification.failureTitle` = `Algo deu errado`
* `verification.labels.addressDetailsSection` = `Detalhes do endereço`
* `verification.labels.dlDetailsSection` = `Detalhes da carteira de motorista`
* `verification.placeholder.email` = `email@example.com`
* `verification.placeholder.firstName` = `Seu primeiro nome`
* `verification.placeholder.lastName` = `Seu sobrenome`
* `verification.placeholder.maternalSurname` = `Seu sobrenome materno`
* `verification.placeholder.middleName` = `Seu nome do meio`
* `verification.placeholder.stateCode` = `Por exemplo {{states}}`
* `verification.placeholder.surname` = `Seu sobrenome`
* `verification.submitButton` = `Continuar`
* `verification.successTitle` = `Verificação de eKYC!`
* `verification.tryAgain` = `Tente novamente`

## ✏️ Modified

* `idv2.capture.processing.scanFront`:
  * Old: `Escanear a frente`
  * New: `Escaneie a frente`
* `idv2.chooser.chooseHowToVerifyTitle`:
  * Old: `Escolha como verificar`
  * New: `Selecione como verificar`
* `idv2.digitalIdUpload.reviewScreen.title`:
  * Old: `Revise seu documento`
  * New: `Documento de revisão`
* `idv2.digitalIdUpload.screenDescription`:
  * Old: `Um arquivo PDF ou foto emitido pelo governo com seus dados, foto e um código QR`
  * New: `Um arquivo PDF emitido pelo governo com seus dados, foto e um código QR`
* `idv2.digitalIdUpload.screenTitle`:
  * Old: `Faça o upload de sua ID digital`
  * New: `Carregar ID digital`
* `otp.resendCountdown`:
  * Old: `Reenviar código em <strong>{{time}}s</strong>`
  * New: `Reenviar código em {{time}}s`
* `verification.labels.state`:
  * Old: `Código do estado (por exemplo, {{states}})`
  * New: `Código estadual`

---

- Path: `release-notes/pt-br-portuguese-brazil-8`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-8/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-8.md

# PT - BR - Portuguese (Brazil)

## 🆕 Added

* `commonIssues.blurPresent` = `Borrão presente`
* `commonIssues.blurPresentDescription` = `Aproxime ou afaste a ID do telefone até que a imagem esteja focada`
* `commonIssues.glarePresent` = `Brilho presente`
* `commonIssues.glarePresentDescription` = `Incline a ID ligeiramente para cima ou para baixo para minimizar o reflexo`
* `commonIssues.notReadable` = `As informações não são legíveis`
* `commonIssues.notReadableDescription` = `Minimize a trepidação da câmera segurando o telefone com firmeza`
* `encryptionLabel.encryptedPhotos` = `Todos os dados são criptografados`
* `home.goToSettings` = `Ir para as configurações`
* `idv2.backTutorial.disclaimer` = `A captura ocorrerá automaticamente`
* `idv2.backTutorial.subtitle` = `Certifique-se de que sua identificação seja legível`
* `idv2.backTutorial.title` = `Mostre o verso de seu documento de identidade`
* `idv2.capture.allDataIsEncrypted` = `Todos os dados são criptografados`
* `idv2.permissions.allowV2` = `Permitir`
* `idv2.permissions.subtitleV2` = `Isso permite que a câmera realize a captura necessária para a verificação`
* `idv2.reverseFlipAnimation.title` = `Mostre a frente de seu documento de identidade`
* `notifications.faceOccluded` = `Rosto coberto`
* `notifications.faceOccludedDescription` = `Certifique-se de que seu rosto esteja claro e visível.`
* `selfiev2.manualCapture.captureButton` = `Tirar foto`

## ✏️ Modified

* `commonIssues.takeManually`:
  * Old: `Tirar foto manualmente`
  * New: `Tirar a foto manualmente`
* `face.tutorial.subtitle`:
  * Old: `Isso permite que você faça login usando seu rosto.`
  * New: `Mantenha uma expressão neutra, encontre equilibrio iluminar e remover óculos e chapéus`
* `idv2.capture.autoCapture`:
  * Old: `A foto será tirada automaticamente`
  * New: `A captura ocorrerá automaticamente`
* `idv2.capture.fillFrameBack`:
  * Old: `Preencha a moldura com seu ID traseiro`
  * New: `Enquadre o verso de sua identidade`
* `idv2.capture.fillFrameFront`:
  * Old: `Preencha a moldura com sua identificação`
  * New: `Enquadre a frente de sua identidade`
* `idv2.permissions.allowPermissionsV2`:
  * Old: `Permitir permissões de câmera`
  * New: `Permitir acesso à câmera`
* `idv2.permissions.dontAllow`:
  * Old: `Não permitir`
  * New: `Não permita que`
* `idv2.permissions.learnMorePage.instructions.1`:
  * Old: `Usamos a câmera apenas para capturar sua identificação para verificação segura`
  * New: `Usamos a câmera apenas para o processo de verificação.`
* `idv2.permissions.learnMorePage.instructions.2`:
  * Old: `Ele ajuda a verificar a autenticidade do documento e a evitar fraudes de identidade`
  * New: `O processo de verificação garante que você é quem diz ser.`
* `idv2.tutorial.autoCapture`:
  * Old: `A foto será tirada automaticamente`
  * New: `A captura ocorrerá automaticamente`
* `idv2.tutorial.title`:
  * Old: `Digitalize sua identidade`
  * New: `Mostre a frente de seu documento de identidade`
* `notifications.selfieCaptureFailedDescription`:
  * Old: `Sua selfie será revisada manualmente mais tarde`
  * New: `Número máximo de tentativas atingido`
* `notifications.spoofDescriptionNoTries`:
  * Old: `Sua selfie será revisada manualmente mais tarde`
  * New: `Número máximo de tentativas atingido`

---

- Path: `release-notes/pt-br-portuguese-brazil-9`
- URL: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-9/
- Markdown: https://developer.incode.com/release-notes/pt-br-portuguese-brazil-9.md

# PT - BR - Portuguese (Brazil)

## 🆕 Added

* `ekyb.addressDetails` = `Detalhes do endereço`
* `ekyb.continue` = `Continuar`
* `ekyb.error.title` = `Algo deu errado`
* `ekyb.processing` = `Processamento`
* `ekyb.success` = `Sucesso`
* `ekyb.tryAgain` = `Tente novamente`
* `idv2.capture.manualCapture.modeSwitchAriaAnnouncement` = `Agora, use o modo de captura manual. Pressione o botão para capturar a foto.`
* `idv2.capture.v2.autoCapture` = `A foto será tirada automaticamente`
* `idv2.capture.v2.fillFrameBack` = `Preencha a moldura com seu ID traseiro`
* `idv2.capture.v2.fillFrameFront` = `Preencha a moldura com sua identificação`
* `idv2.tutorial.v2.autocapture` = `A foto será tirada automaticamente`
* `idv2.tutorial.v2.title` = `Digitalize sua identidade`
* `otp.groupLabel` = `{{charLength}}-Código de verificação de um dígito`
* `v2.capture.label` = `Todas as fotos são criptografadas`
* `v2.idError.attemptsLeft_one` = `{{count}} tentativa restante`
* `v2.idError.attemptsLeft_other` = `{{count}} tentativa restante`
* `v2.idSuccess.subtitle` = `Agora vamos capturar a parte traseira`
* `v2.idSuccess.subtitleBack` = `Vamos continuar`
* `v2.idSuccess.title` = `Processado com sucesso!`
* `v2.selfie.camera.loading` = `Carregando...`

---

- Path: `release-notes/pt-portuguese`
- URL: https://developer.incode.com/release-notes/pt-portuguese/
- Markdown: https://developer.incode.com/release-notes/pt-portuguese.md

# PT - Portuguese

## 🆕 Adicionados

* `capturePreview.acceptedDocuments.BirthCertificate` = `Certidão de nascimento`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Moeda`
* `capturePreview.acceptedDocuments.DriversLicense` = `Carta de condução`
* `capturePreview.acceptedDocuments.FederalID` = `Identificação federal`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Cartão de identificação`
* `capturePreview.acceptedDocuments.label` = `Documentos aceites para:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Cartão médico`
* `capturePreview.acceptedDocuments.Military` = `Militar`
* `capturePreview.acceptedDocuments.noDocuments` = `Não são aceites documentos para este país. `
* `capturePreview.acceptedDocuments.Other` = `Outros`
* `capturePreview.acceptedDocuments.Passport` = `Passaporte`
* `capturePreview.acceptedDocuments.Permit` = `Autorização`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Documento de residência`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identificação fiscal`
* `capturePreview.acceptedDocuments.TravelDocument` = `Documento de viagem`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identificação tribal`
* `capturePreview.acceptedDocuments.Unknown` = `Desconhecido`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Registo de veículos`
* `capturePreview.acceptedDocuments.Visa` = `Visto`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identificação dos eleitores`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Licença de porte de arma`
* `common.refreshPage` = `Atualizar`
* `commonIssues.idv2.tryAgain` = `Ok, tente novamente`
* `errors.dynamicImport.failedToLoad` = `Um erro inesperado, mas que registámos:`
* `errors.dynamicImport.suggestion` = `Tentaremos novamente em {{count}} ou pode atualizar manualmente`
* `errors.dynamicImport.title` = `Lamentamos, mas deparámo-nos com um problema`
* `idv2.capture.autoCapture` = `A fotografia é tirada automaticamente`
* `idv2.capture.dontMove` = `Não mexa no seu ID durante alguns segundos`
* `idv2.capture.fillFrame` = `Preencher a moldura com a sua identificação`
* `idv2.capture.fillFramePassport` = `Preencher a moldura com o seu passaporte`
* `idv2.capture.manualCapture.ariaLabel` = `Captura manual`
* `idv2.capture.manualCapture.title` = `Botão de captura manual`
* `idv2.capture.notifications.blur.description` = `Aumentar e diminuir o zoom, ou tocar no ID`
* `idv2.capture.notifications.blur.title` = `ID demasiado desfocado`
* `idv2.capture.notifications.glare.description` = `Encontrar uma melhor iluminação para evitar reflexos`
* `idv2.capture.notifications.glare.title` = `Identificação com brilho`
* `idv2.capture.notifications.notAligned.description` = `Centrar o seu ID no interior da moldura`
* `idv2.capture.notifications.notAligned.title` = `O ID não está alinhado`
* `idv2.capture.notifications.showBack.description` = `Virar o BI para mostrar o seu verso`
* `idv2.capture.notifications.showBack.title` = `Mostrar o verso do BI`
* `idv2.capture.notifications.showFront.description` = `Vire o seu BI para mostrar a parte da frente`
* `idv2.capture.notifications.showFront.title` = `Mostrar a frente do BI`
* `idv2.capture.passport.subtitle` = `Certificar-se de que o seu passaporte é legível`
* `idv2.capture.passport.title` = `Digitalizar o passaporte`
* `idv2.capture.processing.analyzing` = `Analisar...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} tentativas restantes`
* `idv2.capture.processing.continue` = `Continuar`
* `idv2.capture.processing.error` = `Erro`
* `idv2.capture.processing.errors.classification.subtitle` = `Certifique-se de que toda a identificação está visível e bem iluminada`
* `idv2.capture.processing.errors.classification.title` = `A verificação de ID falhou`
* `idv2.capture.processing.errors.default.subtitle` = `Tente novamente`
* `idv2.capture.processing.errors.default.title` = `Houve um problema`
* `idv2.capture.processing.errors.glare.subtitle` = `Incline a CNH ou RG para cima ou para baixo para minimizar o reflexo`
* `idv2.capture.processing.errors.glare.title` = `Brilho detectado`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimize a vibração da câmara segurando o telemóvel com firmeza`
* `idv2.capture.processing.errors.readability.title` = `Os dados não estão legíveis;`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Afaste ou aproxime a CNH ou RG até que a imagem esteja focada`
* `idv2.capture.processing.errors.sharpness.title` = `Fora de foco`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Por favor tente com um documento diferente`
* `idv2.capture.processing.errors.unacceptable.title` = `O tipo de ID não é aceito`
* `idv2.capture.processing.errors.upload.subtitle` = `Verifique a sua ligação e tente novamente`
* `idv2.capture.processing.errors.upload.title` = `Ocorreu um problema ao digitalizar seu ID`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capturar {{mode}} lado do ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Você capturou o lado errado da CNH ou RG`
* `idv2.capture.processing.scanBack` = `Digitalizar o verso`
* `idv2.capture.processing.success` = `Sucesso`
* `idv2.capture.processing.successBackSubtitle` = `Agora vamos continuar`
* `idv2.capture.processing.successFrontSubtitle` = `Agora vamos capturar a parte de trás`
* `idv2.capture.processing.successTitle` = `Processado com sucesso!`
* `idv2.capture.processing.tryAgain` = `Tentar novamente`
* `idv2.capture.takingPhoto` = `Tirar fotografias...`
* `idv2.capture.wrongSide.backHint` = `dica de retorno`
* `idv2.capture.wrongSide.frontHint` = `dica-front-id`
* `idv2.chooser.idButtonDescription` = `Bilhete de identidade nacional ou carta de condução`
* `idv2.chooser.idButtonTitle` = `Bilhete de Identidade`
* `idv2.chooser.passportButtonDescription` = `Passaporte do seu país`
* `idv2.chooser.passportButtonTitle` = `Passaporte`
* `idv2.permissions.alertAlt` = `alerta de permissão falsa`
* `idv2.permissions.allow` = `OK, Permitir`
* `idv2.permissions.denied.allow` = `Permitir`
* `idv2.permissions.denied.ask` = `Perguntar`
* `idv2.permissions.denied.browser` = `Navegador`
* `idv2.permissions.denied.camera` = `Câmara`
* `idv2.permissions.denied.changeTo` = `Alterar para`
* `idv2.permissions.denied.open` = `Aberto`
* `idv2.permissions.denied.or` = `ou`
* `idv2.permissions.denied.refreshPage` = `Atualizar a página`
* `idv2.permissions.denied.return` = `Regressar aqui e premir`
* `idv2.permissions.denied.scroll` = `Deslocar-se para baixo para selecionar`
* `idv2.permissions.denied.settings` = `Definições`
* `idv2.permissions.denied.tap` = `Torneira`
* `idv2.permissions.denied.title` = `Siga os passos seguintes para permitir que o Incode aceda à sua câmara`
* `idv2.permissions.denied.yourBrowser` = `seu navegador`
* `idv2.permissions.description` = `para completar o processo`
* `idv2.permissions.dontAllow` = `Não permitir`
* `idv2.permissions.fakeDenied.alert` = `alerta falso focado`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permissões`
* `idv2.permissions.fakeDenied.quitProcess` = `Sair do processo`
* `idv2.permissions.fakeDenied.title` = `É necessária autorização da câmara para a captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `aviso`
* `idv2.permissions.note` = `Nota: Dependendo do seu telemóvel, pode dizer`
* `idv2.permissions.or` = `ou`
* `idv2.permissions.subtitle` = `autorização de câmara`
* `idv2.permissions.title` = `Precisamos de si para`
* `idv2.permissions.whileUsing` = `Durante a utilização da aplicação`
* `idv2.tutorial.autoCapture` = `A fotografia é tirada automaticamente`
* `idv2.tutorial.startScan` = `Vamos analisar`
* `idv2.tutorial.subtitle` = `Assegurar que a sua identificação é legível`
* `idv2.tutorial.title` = `Digitalizar a sua identificação`
* `idv2.uploading.analyzing` = `Analisar...`
* `idv2.uploading.imageAlt` = `Captura de ID`
* `onboarding.errors.restartDisabled.message` = `Reinício da sessão desativado a nível da organização`
* `onboarding.errors.restartDisabled.title` = `Não é possível reiniciar a sessão`
* `qes.signatureCheck` = `Aceito a emissão do certificado exigido e a assinatura eletrónica do presente documento.`
* `qes.termsCheck` = `Li e aceito a <2>Política de Privacidade</2> e as <6>Condições de Utilização</6> da Incode.`

## ✏️ Modificados

* `commonIssues.infoNotReadable`:
  * Antes: `As informações não são legíveis`
  * Agora: `Informação não legível`
* `commonIssues.takeManually`:
  * Antes: `Tirar a fotografia manualmente`
  * Agora: `Tirar fotografia manualmente`
* `commonIssues.tryAgain`:
  * Antes: `Ok, tente novamente`
  * Agora: `Tentar novamente`
* `ineCheck.verified`:
  * Antes: `Identidade verificada!`
  * Agora: `Identidade apresentada para verificação`
* `notifications.done`:
  * Antes: `Feito`
  * Agora: `Digitalização concluída`
* `notifications.glareDetectedDescription`:
  * Antes: `Incline a CNH ou RG para cima ou para baixo para minimizar o reflexo`
  * Agora: `Encontrar uma iluminação melhor para evitar reflexos`
* `notifications.idTypeUnacceptable`:
  * Antes: `O tipo de ID não é aceito`
  * Agora: `Documento de identificação inválido`
* `notifications.idTypeUnacceptableDescription`:
  * Antes: `Por favor tente com um documento diferente`
  * Agora: `Tentar digitalizar um diferente`
* `notifications.lowSharpness`:
  * Antes: `Fora de foco`
  * Agora: `Baixa nitidez`

---

- Path: `release-notes/pt-pt-portuguese-portugal`
- URL: https://developer.incode.com/release-notes/pt-pt-portuguese-portugal/
- Markdown: https://developer.incode.com/release-notes/pt-pt-portuguese-portugal.md

# PT-PT - Portuguese (Portugal)

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Certidão de nascimento`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Moeda`
* `capturePreview.acceptedDocuments.DriversLicense` = `Carta de condução`
* `capturePreview.acceptedDocuments.FederalID` = `Identificação federal`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Cartão de identificação`
* `capturePreview.acceptedDocuments.label` = `Documentos aceites para:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Cartão médico`
* `capturePreview.acceptedDocuments.Military` = `Militar`
* `capturePreview.acceptedDocuments.noDocuments` = `Não são aceites documentos para este país. `
* `capturePreview.acceptedDocuments.Other` = `Outros`
* `capturePreview.acceptedDocuments.Passport` = `Passaporte`
* `capturePreview.acceptedDocuments.Permit` = `Autorização`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Documento de residência`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identificação fiscal`
* `capturePreview.acceptedDocuments.TravelDocument` = `Documento de viagem`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identificação tribal`
* `capturePreview.acceptedDocuments.Unknown` = `Desconhecido`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Registo de veículos`
* `capturePreview.acceptedDocuments.Visa` = `Visto`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identificação dos eleitores`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Licença de porte de arma`
* `common.refreshPage` = `Atualizar`
* `commonIssues.idv2.tryAgain` = `Ok, tente novamente`
* `errors.dynamicImport.failedToLoad` = `Um erro inesperado, mas que registámos:`
* `errors.dynamicImport.suggestion` = `Tentaremos novamente em {{count}} ou pode atualizar manualmente`
* `errors.dynamicImport.title` = `Lamentamos, mas deparámo-nos com um problema`
* `idv2.capture.autoCapture` = `A fotografia é tirada automaticamente`
* `idv2.capture.dontMove` = `Não mexa no seu ID durante alguns segundos`
* `idv2.capture.fillFrame` = `Preencher a moldura com a sua identificação`
* `idv2.capture.fillFramePassport` = `Preencher a moldura com o seu passaporte`
* `idv2.capture.manualCapture.ariaLabel` = `Captura manual`
* `idv2.capture.manualCapture.title` = `Botão de captura manual`
* `idv2.capture.notifications.blur.description` = `Aumentar e diminuir o zoom, ou tocar no ID`
* `idv2.capture.notifications.blur.title` = `ID demasiado desfocado`
* `idv2.capture.notifications.glare.description` = `Encontrar uma iluminação melhor para evitar reflexos`
* `idv2.capture.notifications.glare.title` = `Identificação com brilho`
* `idv2.capture.notifications.notAligned.description` = `Centrar o seu ID no interior da moldura`
* `idv2.capture.notifications.notAligned.title` = `O ID não está alinhado`
* `idv2.capture.notifications.showBack.description` = `Virar o BI para mostrar o seu verso`
* `idv2.capture.notifications.showBack.title` = `Mostrar o verso do BI`
* `idv2.capture.notifications.showFront.description` = `Vire o seu BI para mostrar a parte da frente`
* `idv2.capture.notifications.showFront.title` = `Mostrar a frente do BI`
* `idv2.capture.passport.subtitle` = `Certificar-se de que o seu passaporte é legível`
* `idv2.capture.passport.title` = `Digitalizar o passaporte`
* `idv2.capture.processing.analyzing` = `Analisar...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} tentativas restantes`
* `idv2.capture.processing.continue` = `Continuar`
* `idv2.capture.processing.error` = `Erro`
* `idv2.capture.processing.errors.classification.subtitle` = `Certifique-se de que toda a identificação está visível e bem iluminada`
* `idv2.capture.processing.errors.classification.title` = `A verificação de ID falhou`
* `idv2.capture.processing.errors.default.subtitle` = `Tente novamente`
* `idv2.capture.processing.errors.default.title` = `Houve um problema`
* `idv2.capture.processing.errors.glare.subtitle` = `Inclinar o ID ligeiramente para cima ou para baixo para minimizar o reflexo`
* `idv2.capture.processing.errors.glare.title` = `Brilho presente`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimize a vibração da câmara segurando o telemóvel com firmeza`
* `idv2.capture.processing.errors.readability.title` = `As informações não são legíveis`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Afaste ou aproxime o ID do telemóvel até a imagem ficar focada`
* `idv2.capture.processing.errors.sharpness.title` = `Borrão presente`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Tente com um documento diferente`
* `idv2.capture.processing.errors.unacceptable.title` = `O tipo de ID não é aceite`
* `idv2.capture.processing.errors.upload.subtitle` = `Verifique a sua ligação e tente novamente`
* `idv2.capture.processing.errors.upload.title` = `A digitalização de ID falhou`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Capturar {{mode}} lado do ID`
* `idv2.capture.processing.errors.wrongSide.title` = `Lado de identificação incorreto capturado`
* `idv2.capture.processing.scanBack` = `Digitalizar o verso`
* `idv2.capture.processing.success` = `Sucesso`
* `idv2.capture.processing.successBackSubtitle` = `Agora vamos continuar`
* `idv2.capture.processing.successFrontSubtitle` = `Agora vamos capturar a parte de trás`
* `idv2.capture.processing.successTitle` = `Processado com sucesso!`
* `idv2.capture.processing.tryAgain` = `Tentar novamente`
* `idv2.capture.takingPhoto` = `Tirar fotografias...`
* `idv2.capture.wrongSide.backHint` = `dica de retorno`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `Bilhete de identidade nacional ou carta de condução`
* `idv2.chooser.idButtonTitle` = `Bilhete de Identidade`
* `idv2.chooser.passportButtonDescription` = `Passaporte do seu país`
* `idv2.chooser.passportButtonTitle` = `Passaporte`
* `idv2.permissions.alertAlt` = `alerta de permissão falsa`
* `idv2.permissions.allow` = `OK, Permitir`
* `idv2.permissions.denied.allow` = `Permitir`
* `idv2.permissions.denied.ask` = `Perguntar`
* `idv2.permissions.denied.browser` = `Navegador`
* `idv2.permissions.denied.camera` = `Câmara`
* `idv2.permissions.denied.changeTo` = `Alterar para`
* `idv2.permissions.denied.open` = `Aberto`
* `idv2.permissions.denied.or` = `ou`
* `idv2.permissions.denied.refreshPage` = `Atualizar a página`
* `idv2.permissions.denied.return` = `Regressar aqui e premir`
* `idv2.permissions.denied.scroll` = `Deslocar-se para baixo para selecionar`
* `idv2.permissions.denied.settings` = `Definições`
* `idv2.permissions.denied.tap` = `Torneira`
* `idv2.permissions.denied.title` = `Siga os passos seguintes para permitir que o Incode aceda à sua câmara`
* `idv2.permissions.denied.yourBrowser` = `seu navegador`
* `idv2.permissions.description` = `para completar o processo`
* `idv2.permissions.dontAllow` = `Não permitir`
* `idv2.permissions.fakeDenied.alert` = `alerta falso focado`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permissões`
* `idv2.permissions.fakeDenied.quitProcess` = `Sair do processo`
* `idv2.permissions.fakeDenied.title` = `É necessária autorização da câmara para a captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `aviso`
* `idv2.permissions.note` = `Nota: Dependendo do seu telemóvel, pode dizer`
* `idv2.permissions.or` = `ou`
* `idv2.permissions.subtitle` = `autorização de câmara`
* `idv2.permissions.title` = `Precisamos de si para`
* `idv2.permissions.whileUsing` = `Durante a utilização da aplicação`
* `idv2.tutorial.autoCapture` = `A fotografia é tirada automaticamente`
* `idv2.tutorial.startScan` = `Vamos analisar`
* `idv2.tutorial.subtitle` = `Assegurar que a sua identificação é legível`
* `idv2.tutorial.title` = `Digitalizar a sua identificação`
* `idv2.uploading.analyzing` = `Analisar...`
* `idv2.uploading.imageAlt` = `Captura de ID`
* `onboarding.errors.restartDisabled.message` = `Reinício da sessão desativado a nível da organização`
* `onboarding.errors.restartDisabled.title` = `Não é possível reiniciar a sessão`
* `qes.signatureCheck` = `Aceito a emissão do certificado exigido e a assinatura eletrónica do presente documento.`
* `qes.termsCheck` = `Li e aceito a <2>Política de Privacidade</2> e as <6>Condições de Utilização</6> da Incode.`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Before: `Erros comuns`
  * Now: `Problemas comuns`
* `commonIssues.infoNotReadable`:
  * Before: `As informações não são legíveis`
  * Now: `Informação não legível`
* `commonIssues.takeManually`:
  * Before: `Tirar a fotografia manualmente`
  * Now: `Tirar fotografias manualmente`
* `commonIssues.tryAgain`:
  * Before: `Ok, pegue de novo`
  * Now: `Tentar novamente`
* `notifications.done`:
  * Before: `Feito`
  * Now: `Digitalização concluída`
* `notifications.glareDetectedDescription`:
  * Before: `Incline a CNH ou RG para cima ou para baixo para minimizar o reflexo`
  * Now: `Encontrar uma iluminação melhor para evitar reflexos`
* `notifications.idTypeUnacceptable`:
  * Before: `O tipo de ID não é aceito`
  * Now: `Documento de identificação inválido`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Por favor tente com um documento diferente`
  * Now: `Tentar digitalizar um diferente`
* `notifications.lowSharpness`:
  * Before: `Fora de foco`
  * Now: `Baixa nitidez`

---

- Path: `release-notes/releases-android-sdk`
- URL: https://developer.incode.com/release-notes/releases-android-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-android-sdk.md

# Android SDK Release Notes

:::warning
Starting November 1, 2025, Google Play blocks all app submissions and updates targeting Android 15+ that do not support 16 KB page sizes.

Compliance requires upgrading to Android SDK 5.38.0 or higher. It is strongly recommended you upgrade to the latest release.
:::

:::note
Use the BOM to keep SDK module versions aligned when upgrading. If versions are managed manually, refer to the updated dependency versions in the **Module Versions** sections of each release's notes.
:::

## Version 5.55.0 - 2026-Oct-22

### Added (ALL modes)

- Added `CommonConfig.Builder.setUIConfigFromJson(context, json)`, a new function that configures the SDK theme and UX from a single JSON document.
- Added `NfcScan.Builder.setForceV2(Boolean)`. When set to `true`, the `NfcScan` module always shows its V2 screens, even when the other modules in the flow show the legacy UI. Default is `false`, which keeps the current behavior. This option is temporary and will be removed when the SDK ships V2 only.
- Improved analytics for in-screen state changes in the ID Scan and Selfie V2 modules. In Capture-Only and Delayed modes, the Selfie V2 module does not report these states. Some undocumented classes are no longer visible to integrators.
- Added two Statsig feature gates for the UXv2 analytics events: 
   - `uxv2_screen_events_enabled` controls `screenOpened` and `screenClosed` in every V2 module. 
   - `uxv2_extended_tracking_enabled` controls `elementClicked`, `errorTriggered` and `stateChanged` in every module that sends them.

   The legacy (V1) modules keep sending their screen events. The SDK sends a gated event only when its gate is ON for the current session. When the SDK has no value for a gate, it does not send the event. This is the case in Capture-Only and Delayed modes, where Statsig does not run, and in a STANDARD or SUBMIT_ONLY session before Statsig resolves its values or when it fails. When an event is not sent, the SDK also does not call the `EventListener` callbacks for it.
  


### Added (STANDARD mode only)

- Expanded NFC logging in TrueSight to help diagnose scan, portrait-processing, and upload failures.
- Security improvements.
- Face capture now protects its security signals with a key that the server issues for each session.

### Changed (ALL modes)

- Release builds run the SDK's runtime integrity checks during camera capture as well.
- `core-light` now continues the capture when it detects an emulator or a rooted device, the same as the rest of the SDK.
- When you enable `high_res_capture` with `clientExperimentId`, the ID and Selfie modules (including face login) now encode images as JPEG with quality 95 instead of 100. As a result, `IdScanResult.idImageBase64`, `SelfieScanResult.selfieBase64`, `SelfieScanResult.fullFrameSelfieBase64` and the ID and Selfie uploads are smaller, which lowers the risk that they go over the API size limit. Video Selfie does not change.

### Fixed (ALL modes)

- Fixed the selfie injection-anomaly zoom check (`iadZc`) reporting `PASS` when no face was detected in the zoomed frame, so moving the device or covering the lens during the check passed it. That case is now reported as `UNCLEAR` and the exposure-compensation fallback check (`iadEcc`) runs. The check never blocks a capture - only the reported status changes. In Capture-Only mode, the deprecated `SelfieScanResult.idealCaptureEnvironmentTestResult` now carries the fallback check result (for example `2`) instead of `0` for this case.
- In the new ID capture experience `IdScan` V2, the help screen's capture-mode button can now also switch back from manual to automatic capture; previously it only offered switching from automatic to manual.
- Fixed the legacy Video Selfie UI, where the last question card showed under the face-scan guidance at the start of Voice Consent with face recognition. The bottom card now shows only the face-scan guidance until the face is found, then the consent text.
- Fixed the manual capture button not appearing after a failed capture in the `SelfieScan` and `FaceAuthentication` V2 modules. After **Try Again**, the SDK now switches to manual capture when the `setAutoCaptureTimeout` timeout expires.
- Fixed the face occlusion check in `SelfieScan` and `FaceAuthentication` so that each module uses its own `setFaceOcclusionSeverity` or Dashboard `occlusionSeverity` value. `SeverityLevel.ULTRA_HIGH` now uses the HIGH occlusion threshold.
- Refactored several internal screens to use the Activity Result API instead of the deprecated `onActivityResult` callback, and fixed two ID flow problems. If the user exits the ID summary screen with the back button, the flow no longer stops on a loading screen. The SDK now returns the `USER_CANCELLED` result. After all ID capture attempts fail, the failure screen no longer shows again when the SDK closes. Some undocumented classes are no longer visible to integrators.
- Fixed Dynamic Forms opening the next screen at the scroll position of the previous screen. Each screen now starts at the top.
- Fixed the Autofill option filling nothing in the Name module, the Phone Number V2 phone number field, and the Dynamic Forms name fields. After an Autofill, the V2 screens no longer show a yellow highlight behind the field label. Corrected the Holy See dial code to +39.
- Fixed NFC scanning not resuming after screen lock and unlock on some devices.
- Fixed V1 NFC crashes when the screen was locked during chip reading or data upload.
- Fixed a crash in apps that Google Play distributes with Automatic Protection (anti-tampering) turned on.
- Fixed `ThemeConfiguration.Builder.setLogo` having no effect on V2 screens. V2 screens now show this logo, unless `SelfieScan.Builder.setLogo` or `VideoSelfie.Builder.setLogo` sets a logo for that module.
- Fixed Android SDK compatibility with LIMITED token organizations. On a LIMITED organization, if the backend refuses OTP verification, the Phone and Email modules complete with `SUCCESS` and a non-null `error`: the value was collected but not verified.
- Reduced false rejections from the `Behavioral Trust` motion check.
- Fixed the JVM unit tests (JUnit, Robolectric) of apps that use the SDK, which failed with `IllegalAccessError: Update to static final field ... attempted from a different method ... than the initializer method <clinit>` when a test loaded some SDK classes. Most SDK classes, for example `ThemeConfiguration` and the listener and result classes, now load in JVM unit tests. Code that starts the SDK, for example `IncodeWelcome.Builder`, still needs a mock of `IIncodeWelcome`. Apps on devices were not affected.

### Fixed (STANDARD and DELAYED modes only)

- With E2EE enabled, a step sometimes failed because the SDK did not decrypt a server response (`AEADBadTagException` in the logs). The SDK now correctly decrypts responses that arrive at the same time.


### Deprecations (ALL modes)

- Deprecated `IncodeThemeConfig.fromJson(context, json)` and `IncodeUXConfig.fromJson(json)` in favor of `CommonConfig.Builder.setUIConfigFromJson(context, json)`. Both methods continue to work. Programmatic configuration through `setThemeConfig` and `setUXConfig` is not affected.

### Module Versions

- `core-light` 3.0.19
- `nfc` 1.5.11

## Version 5.54.0 - 2026-Sep-30

<Accordion title="5.54.0">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide) for details)

- Renamed `IncodeColorPalette.positive800` to `positive750`, including the matching JSON key, to align with Incode Studio's exported palette.

### Added (ALL modes)

- The SDK now detects at runtime when it is running inside a [Flutter](/sdk-reference/flutter-sdk/), [React Native](/sdk-reference/react-native-sdk/), or [Cordova](/sdk-reference/cordova-sdk/) wrapper and appends the wrapper identity and version to the reported `sdkVersion` (for example `5.54.0 | Flutter 4.17.0`), so wrapper sessions are distinguishable from native ones in dashboard session analytics and TrueSight. Native integrations continue to report a bare version. If a hybrid framework is present but its wrapper marker is missing or renamed, the SDK reports a presence-only fallback with no version (for example `5.54.0 | Flutter (undeclared)`) so the session is still identified as hybrid rather than mislabeled as native.
- Added `gray150`, `gray250`, `gray600`, `gray750`, `positive750`, and `positive950` color tokens to `IncodeColorPalette`, aligning Android's palette with Incode Studio's exported theme.
- Button text color in `IncodeComponents` (`ButtonText`) now supports `hover` and `pressed` states, matching the existing `hover`/`pressed` support for button surface color.
- The `IdInfo` V2 review screen now shows a note under the title explaining that fields marked with an asterisk are required. It appears only when OCR editing is enabled with `IdInfo.Builder.setEditableOcr(true)`.
- Improved analytics for the no internet connection error screen in the ID Scan and Selfie V2 modules.
- Added a Statsig-gated A/B experiment framework for ID Capture. It standardizes the `experimentAssigned` analytics event and enrolls a session in at most one experiment. Every experiment is off by default; nothing changes in the flow until Incode enables it in Statsig. The two changes listed under **Changed (ALL modes)** ship to all users and are not part of an experiment. The experiments this release can run:
  - Camera permission priming sheet on the ID tutorial (IDC-01).
  - Camera permission "How it works" screen with a direct system prompt (IDC-02).
  - Show the captured result instead of the 3-2-1 countdown (IDC-05).
  - Merge the front and back flip animation into the captured state (IDC-07).

### Added (STANDARD mode only)

- [Google Wallet ID](/sdk-reference/android-google-wallet-id/) can now be invoked directly, without the document chooser. Build the `IdScan` module with `setShowIdTypeChooser(false)` and `setIdType(IdScan.IdType.GOOGLE_WALLET_ID)`; previously this combination did nothing and the flow stalled.
- Added a non-UI (headless) mode for the direct Google Wallet flow. Set `isNonUiMode` on the `IdScan` module and the SDK shows no screens of its own: it hands you a `NonUiGoogleWalletController` through `OnboardingListener.onGoogleWalletReady()` and reports progress on `NonUiGoogleWalletListener`.
- Added `GoogleWalletNoCredentialException`, delivered through `OnboardingListener.onError()` on direct and non-UI invocation when the device has no Google Wallet credential for the request. Behind the document chooser the user returns to document selection instead, as in 5.53.0. In 5.53.0 this returned the user to the document chooser with nothing reported, so it could not be told apart from a cancellation.
- The direct Google Wallet flow reports each failure cause separately: a missing `wallets` artifact raises `MissingWalletsDependencyException`, and a request that cannot be fetched reports the underlying error. In 5.53.0 neither case produced a result: the flow stopped with nothing reported.
- A failed Google Wallet upload now ends the flow in a way the user or the integrator can act on. Behind the document chooser, Try Again on the error screen returns the user to document selection so they can finish with a physical document, as in 5.53.0. Direct invocation offers no other document type, so re-sending a credential the back end refused cannot help: the ID module ends and the error is reported through `OnboardingListener.onError()`. Non-UI mode behaves the same, and also reports it on `NonUiGoogleWalletListener.onGoogleWalletCompleted` with a non-null exception.
- Added `GoogleWalletRequestFailedException`, reported through `OnboardingListener.onError()` on direct and non-UI invocation when the Google Wallet credential provider ends a request in a state the SDK cannot interpret. Behind the document chooser the user returns to document selection instead, as in 5.53.0. The provider's own exception is kept as its `cause`. In 5.53.0 such a failure returned the user to the document chooser and reported nothing.
- Added the [`AES` (Advanced Electronic Signature)](/sdk-reference/android-aes-advanced-electronic-signature/) V2 module with the new UI, including a document review step after picking a file, an in-app document viewer with pinch-to-zoom, an on-device download of each signed document when `AES.Builder.setDownloadDocument(true)` is set, and a Try again option on connectivity errors. Unexpected document-upload failures now complete the module with an error result instead of waiting for the user to cancel. Available when the V2 feature gate is enabled.

### Fixed (ALL modes)

- A session that offers Google Wallet on the document chooser no longer fails to start when the optional `wallets` artifact is absent from the build. The SDK already leaves the Google Wallet option out of the chooser in that case, and the user completes with a camera document, so `MissingWalletsDependencyException` is now raised only for direct and non-UI Google Wallet invocation, where no other document type is available.
- Fixed RASP-related application crashes during startup and in integrations without optional SDK dependencies.
- Fixed CameraX reflection failures in apps with code minification enabled.
- Dismissing the Google Wallet credential picker with the back button is now reported as a cancellation. Android's Credential Manager reports that dismissal through its catch-all "unknown" failure type rather than as a cancellation, so the SDK previously reported a `GoogleWalletRequestFailedException` for a user who simply changed their mind.
- Fixed a crash (`NullPointerException`) in `SelfieScan` when the screen closed while the camera stream was still starting.
- Fixed TalkBack issues on the `CombinedConsent` screen: the consent title is announced once and marked as a heading, and the links inside each consent checkbox are reachable as separate focus stops. Required consent checkboxes now show a "(required)" label instead of an asterisk.
- The selfie injection-anomaly zoom check (`iadZc`) now reports `UNCLEAR` or `FAIL` for captures it cannot confirm as continuous. In the selfie and ID capture flows, an injection-anomaly check that does not run reports `UNCLEAR` instead of an empty value.
- Fixed the ID capture shutter flash showing as black when the SDK runs in dark theme. The flash is now always white, whatever theme or color palette is configured.
- Fixed a crash while generating session metadata when an onboarding ended with an error, a cancellation, or `finishOnboarding` before any capture. The SDK now still reports the original result.
- Fixed the `CombinedConsent` screen crashing when a consent link was tapped on a device without a browser, and consent text containing quotes, backslashes, or HTML markup breaking the terms rendering.
- Fixed theme JSON color handling: fully transparent colors (alpha `00`) now survive an `IncodeThemeConfig.toJson` / `fromJson` round-trip instead of turning opaque, and non-string color values (numbers, booleans) or an empty `[light, dark]` array now fail `fromJson` with a `SerializationException`. Note that theme configs that previously parsed by accident (e.g. an unquoted numeric color like `123456`) now throw instead, so catch `SerializationException` at the parse boundary if your color values may be unquoted.
- Fixed the screen titles in the `IdScan` and `IdInfo` V2 modules, and the status screen titles in the `Phone` and `Signature` V2 modules, not being announced as headings by TalkBack.
- Fixed the screen titles and status titles in the `SelfieScan` V2 and `FaceMatch` V2 modules not being announced as headings by TalkBack.
- Fixed the processing screen title in the `NfcScan`, `CurpValidation`, `Email`, `QES`, `IdInfo`, `CustomWatchlist`, `VideoSelfie` and `ProcessId` V2 modules not being announced as a heading by TalkBack.
- Fixed TalkBack labels and focus grouping in text fields, dropdowns, date pickers, and Dynamic Forms radio options. Phone numbers and recognized identifiers now read digit by digit.

### Fixed (Capture-Only mode)

- Fixed an error that made `SelfieScanResult.presignedVideoFilePath` reference an absent file in Capture-Only mode. The SDK now creates `SelfieScanVideoRecordVideoPresigned` before it returns the result. If file creation fails, the SDK shows the standard retry screen.

### Fixed (STANDARD mode only)

- The Google Wallet and Digital ID options were missing from the document chooser in Workflow-based sessions, even when enabled in the workflow configuration. Both now appear, matching Flow-based sessions. Both options exist only in the V2 ID capture UI, so the flow or workflow must also have UX V2 enabled. When the legacy V1 UI runs, the SDK now logs a warning instead of dropping the option without a signal.
- Fixed read-only prefilled COUNTRY and SELECT questions in Dynamic Forms giving no reason in TalkBack for why the field is locked. TalkBack now announces that the ID filled the field and that it cannot be edited, together with the expand/collapse state.

### Changed (ALL modes)

- The camera permission sheet title is now "Allow camera access". It was "Camera permission is required". The new text is translated in all supported languages. Every module that asks for the camera shows it: ID, Selfie, Video Selfie and Document Capture.
- A user who refused the camera permission one time now sees the permission sheet and the system prompt again. Before, the SDK sent this user to the Settings screen. A second refusal sends the user to the Settings screen, as before.

### Changed (STANDARD mode only)

- The `QES` V2 document card title now follows the SDK language when a single document is signed, like the numbered titles already did when multiple documents are signed. Previously it always showed the English "Contract.pdf".
- The `QES` V2 success screen now shows one download action per signed document, each saving that document's own signed PDF. Previously a single download action saved only the most recently signed document.
- On the `QES` V2 Accept and sign screen, the title, subtitle, and document cards now stay fixed at the top and the sign button stays fixed at the bottom; only the consent checkboxes scroll when they do not fit, matching the updated design. Previously the whole content above the sign button scrolled as one block.

### Removals

- The Google Wallet flow moved out of the ID capture screen, so `WalletIdErrorScreen` is now internal and `InitIdCaptureUiEvent.TryAgainFromWalletError`, two `IdCaptureStep` wallet states, and three `IdCaptureModuleViewModel` wallet members were removed. None were part of the integration surface. To drive the flow yourself, use non-UI mode. Please see [Migration Guide](/release-notes/migration-guide) for details.

### Updated dependencies

- `com.guardsquare:dexguard-gradle-plugin:9.15.2` -> `com.guardsquare:dexguard-gradle-plugin:9.15.4`

### Module Versions

- `core-light` 3.0.18
- `wallets` 1.0.1

</Accordion>



## Version 5.53.0 - 2026-September-09



<Accordion title="5.53.0">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide) for details)

- `IncodeWelcome.Builder.setGoogleWalletEnvironment(...)` and the `GoogleWalletEnvironment` class have been removed - the setter and the class no longer exist. `setGoogleWalletEnvironment` existed to make Google Wallet requests easier to debug, but its `SANDBOX`/`PRODUCTION` naming did not reflect that purpose; it has been replaced by `IncodeWelcome.Builder.setGoogleWalletRequestSigned(Boolean)` (default `true`), which directly controls whether the request declares the signed or unsigned protocol. Please see [Migration Guide](/release-notes/migration-guide) for details.
- The user-cancel analytics event is now `userCanceled` instead of `userCancelled`. The `Event.USER_CANCELLED` constant is unchanged, and listeners or queries that match the literal `userCancelled` must use `userCanceled`.
- Signature V2 uses `onboard_sdk_signature_capture_title` and `onboard_sdk_signature_capture_description` as the default title and description. Overrides of `onboard_sdk_signature_title` and `onboard_sdk_signature_description` still apply to V1 only; with the V2 feature gate enabled, override the `_capture_*` keys.

### Added (STANDARD mode only)

- Faster ID Capture: each ID side now completes sooner by starting the document image upload earlier in the capture flow. The improvement is most noticeable on lower-end devices and slower networks.
- Google Wallet requests now support both signed and unsigned protocols, defaulting to signed.

### Added (ALL modes)

- Added `Video Selfie` V2 module with the new UI. Available when the V2 feature gate is enabled. The V2 design hides the close (X) button on the camera steps, so `CommonConfig.setShowCloseButton` does not apply to those steps.
- The `moduleOpened` analytics event now reports the module UX version (`1` for legacy screens, `2` for UXv2) for every module. Previously only some modules reported it, so the dashboard session view could not always tell a UXv1 run from a UXv2 run.
- The `SelfieScan` module reports the version of the selfie implementation that actually ran. `LOGIN` and `MASK_CHECK` now report `1`, because the UXv2 selfie covers enrollment and face authentication only.
- Added the `elementClicked` analytics event for tapped elements on `SelfieScan` and `IdScan` V2 screens.
- Added optional head-movement and hand-gesture liveness checks to the `VideoSelfie` module, enabled via the new `setHeadMovementEnabled()` and `setHandGestureEnabled()` methods in `VideoSelfie.Builder`. Both checks are disabled by default.
- Added `Signature` V2 module with the new Compose UI, including a success screen shown after the signature is submitted. Available when the V2 feature gate is enabled.

### Fixed (ALL modes)

- ID capture with `setTestModeEnabled(true)` on an emulator closed the camera screen with no callback. The ID module now completes with the emulator-detected result and continues the flow.
- Fixed a stale `@Nullable` annotation on `getImagesDirectory()` that no longer matched its behavior (it has returned a guaranteed non-null `File` via internal-storage fallback since 5.50.0); `FileUtils.clearDirectory()` now also tolerates a null directory as defense-in-depth.
- Added `StorageUnavailableException`. Onboarding start now fails fast via `OnboardingListener.onError()` when the device cannot provide a writable images directory, instead of silently failing to persist captures later in the flow.
- Fixed a green (blank) camera preview on devices whose camera HAL accepts the SDK's physical-camera lock but then delivers blank frames (e.g. Xiaomi 15T). The SDK now detects the blank stream within the first few frames and automatically restarts the camera without the lock.
- Removed the SDK's legacy internal back-press interception hook so all back handling now flows through `OnBackPressedDispatcher` / `OnBackPressedCallback`, a prerequisite for predictive-back support. Back-navigation behavior is unchanged.
- Fixed a crash (`IllegalArgumentException`) when host lifecycle events fired while the SDK was still initializing. External event tracking no longer depends on the SDK singleton being ready.
- Fixed a crash (`IndexOutOfBoundsException`) in the `VideoSelfie` module when audio was disabled while every camera scan step was also disabled and only audio-dependent steps (random questions or voice consent) were enabled. `VideoSelfie.Builder.build()` now falls back to enabling the selfie scan step for such configurations, so the module records a valid video instead of crashing.
- Fixed a native crash (SIGABRT) that closed the app during selfie capture on some devices, confirmed on Pixel 11, Pixel 11 Pro, and Pixel 11 Pro XL. Updated `libRecogKitAndroid.so` (RecogKit v3.9.3) so on-device model load no longer aborts when the OS rejects CPU thread pinning.
- When the head-cover or closed-eyes check stopped the capture (`setHeadCoverCheckEnabled` / `setEyesClosedCheckEnabled`), the `VideoSelfie` V2 selfie step kept the previous message. Each check now shows its own message, as the lenses and mask checks already did.

### Fixed (STANDARD mode only)

- Fixed a rare error during cleanup of failed video-streaming sessions.
- Fixed missing `screenClosed` analytics events.

### Known issues

- If a user denies the screen recording permission in `VideoSelfie` V2, the Dashboard session log shows `Mandatory Camera permission not granted.` This log message is incorrect. The `onError` callback still receives the correct `ScreenCapturePermissionNotGranted` exception. A future release will correct the log message.

### Documentation

- Added the [US Smart Capture](/sdk-reference/android-us-smart-capture/) integration guide: enablement, provisioning, supported start APIs, and the `V2` requirement.

### Updated dependencies

- `net.zetetic:sqlcipher-android:4.6.1` -> `net.zetetic:sqlcipher-android:4.17.0`. Reduces the SDK download size by ~1.3 MB per device and removes unused legacy crypto symbols from the bundled native library. This library ships Java 17 bytecode, so consumer unit tests (JVM, Robolectric) that load SQLCipher classes, directly or through the SDK's encrypted-database code paths, must run on JVM 17 or later. Standard Android builds with AGP 8 and JDK 17 are not affected.
- `com.guardsquare:dexguard-gradle-plugin:9.14.3` -> `com.guardsquare:dexguard-gradle-plugin:9.15.2`

### Module Versions

- `core-light` 3.0.17
- `nfc` 1.5.10

</Accordion>

## Version 5.52.0 - 2026-August-20



<Accordion title="5.52.0">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide) for details)
- `Status` gains `UNSUPPORTED` and `COULD_NOT_COMPLETE` values. `DeviceStats.motionStatus` does not emit them. Please see [Migration Guide](/release-notes/migration-guide) for details if you do an exhaustive `when` over `Status`.

### Added (ALL modes)

- Added `OnboardingListener.onInterrupted()` so integrators are notified when Android tears down the SDK Activity stack externally (not via SDK completion, cancel, or close). The callback defaults to a no-op, so existing subclasses need no changes.
- Improved `SelfieScan` and `IdScan` V2 analytics.

### Added (STANDARD mode only)

- Dynamic Forms questions configured with a prefill source in the dashboard are now automatically populated from the user's ID Capture/OCR data before the form is shown.
- Added the final Namirial Review and sign screen with two plain consent checkboxes and a scrollable certificate application form. The Sign button becomes available after both consents are selected.

### Fixed (ALL modes)

- Fixed a duplicate close (X) button appearing on the Combined Consent screen when the close button is enabled.
- Fixed main-thread ANR risk during Sentry re-initialization, `clearLocalData()`, audio recording start/stop retries, and Camera1 open. Those operations now run off the calling thread so the UI stays responsive.
- Security improvements.
- Fixed the published API reference (Javadoc) rendering `<Error class: unknown class>` instead of type names, and some member links that went nowhere. Type names and links are now correct.

### Fixed (STANDARD and Submit-Only modes)

- Fixed captures (including face authentication) being rejected with HTTP 400 `Invalid argument` on devices whose clock was set incorrectly. An incorrect device clock no longer triggers this rejection.

### Fixed (STANDARD mode only)

- Fixed Dynamic Forms country answers being sent and reported as ISO 3166-1 alpha-2 codes (for example, "RS"). Country answers are now sent and reported as alpha-3 (for example, "SRB"), which the dashboard resolves to a country name.

### Module Versions

- `nfc` 1.5.9

</Accordion>

## Version 5.51.0 - 2026-Aug-05



<Accordion title="5.51.0">

### Added dependencies

- `androidx.camera:camera-camera2-pipe:1.6.1`
- `androidx.camera.viewfinder:viewfinder-core:1.5.1` (viewfinder is a separate androidx artifact with its own version line; 1.5.1 is the version CameraX 1.6.1 resolves)

### Updated dependencies

- `androidx.camera:camera-camera2:1.5.1` -> `androidx.camera:camera-camera2:1.6.1`
- `androidx.camera:camera-core:1.5.1` -> `androidx.camera:camera-core:1.6.1`
- `androidx.camera:camera-extensions:1.5.1` -> `androidx.camera:camera-extensions:1.6.1`
- `androidx.camera:camera-lifecycle:1.5.1` -> `androidx.camera:camera-lifecycle:1.6.1`
- `androidx.camera:camera-video:1.5.1` -> `androidx.camera:camera-video:1.6.1`
- `androidx.camera:camera-view:1.5.1` -> `androidx.camera:camera-view:1.6.1`
- `androidx.camera.featurecombinationquery:featurecombinationquery:1.5.1` -> `androidx.camera.featurecombinationquery:featurecombinationquery:1.6.1`
- `androidx.compose.material3:material3:1.3.2` -> `androidx.compose.material3:material3:1.4.0`
- `androidx.compose.ui:ui:1.7.8` -> `androidx.compose.ui:ui:1.8.2`
- `androidx.compose.ui:ui-graphics:1.7.8` -> `androidx.compose.ui:ui-graphics:1.8.2`
- `androidx.lifecycle:lifecycle-process:2.6.2` -> `androidx.lifecycle:lifecycle-process:2.9.0`
- `androidx.lifecycle:lifecycle-runtime-compose:2.7.0` -> `androidx.lifecycle:lifecycle-runtime-compose:2.9.0`
- `androidx.lifecycle:lifecycle-runtime-ktx:2.6.2` -> `androidx.lifecycle:lifecycle-runtime-ktx:2.9.0`
- `androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.2` -> `androidx.lifecycle:lifecycle-viewmodel-ktx:2.9.0`
- `androidx.room:room-compiler:2.6.1` -> `androidx.room:room-compiler:2.8.4`
- `androidx.room:room-rxjava2:2.6.1` -> `androidx.room:room-rxjava2:2.8.4`
- `androidx.room:room-runtime:2.6.1` -> `androidx.room:room-runtime:2.8.4`
- `com.google.devtools.ksp:symbol-processing-api:1.9.25-1.0.20` -> `com.google.devtools.ksp:symbol-processing-api:2.2.21-2.0.5`
- `com.squareup.okhttp3:logging-interceptor:4.12.0` -> `com.squareup.okhttp3:logging-interceptor:5.3.2`
- `com.squareup.okhttp3:okhttp:4.12.0` -> `com.squareup.okhttp3:okhttp:5.3.2`
- `org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.25` -> `org.jetbrains.kotlin:kotlin-stdlib-jdk8:2.2.21`. Any module compiling Kotlin source with the SDK on its classpath now requires Kotlin 2.2.x or newer; see the [Migration Guide](/release-notes/migration-guide/).
- `org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.0` -> `org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3`

### Build requirements

- `compileSdk` must be **36** or higher when embedding this SDK version.
- The Kotlin Gradle plugin must be **2.2.x** (`2.2.21` or newer). The SDK is compiled with Kotlin 2.2.21, so apps on an older Kotlin compiler may fail to compile against it with a Kotlin metadata-incompatibility error.
- Android Gradle Plugin (AGP) **8.9.1** or higher is required (needed for `compileSdk 36`).
- Gradle **8.14.5** or higher is required (needed by AGP 8.9.1).
- `kotlinx-coroutines` **1.9.0** or higher is now required. CameraX 1.6.1 pulls this version in transitively, so no manual declaration is needed, but your project's coroutines version must be at least 1.9.0.

### API Changes (refer to [Migration Guide](/release-notes/migration-guide/) for details)

- The `QES` constructor is no longer public; construct the module via `QES.Builder`. See [Migration Guide](/release-notes/migration-guide/) for details.

### Added (STANDARD mode only)

- Added the `QES` (Qualified Electronic Signature) V2 module with the new Compose UI, including an optional document-upload screen and an in-app document viewer with pinch-to-zoom. Available when the V2 feature gate is enabled.
- Added `QES.Builder.setUploadDocument(...)` and `QES.Builder.setProviderCode(...)` to show a document-upload screen before signing and to select the qualified signature provider for the session.
- Added a Review & Sign experience in the QES module that displays provider-specific terms and consents for the user to review and accept.

### Fixed (ALL modes)

- Sped up `IdScan` and `SelfieScan` by removing the internal frame-rate limit, so the camera now analyzes frames as fast as the device allows for a quicker, smoother capture.
- Security improvements.
- Connectivity checks now use `NetworkCapabilities` instead of the deprecated `getActiveNetworkInfo()` API, so VPN connections are correctly treated as online.
- SDK error logs now always include the full error cause, making reported issues easier to diagnose from device logs.
- Fixed `androidx.compose.*` runtime crashes on Compose (V2) screens. The SDK now requires Compose Material3 1.4.0 and Compose 1.8.0 or newer. Please refer to the [Migration Guide](/release-notes/migration-guide) for details.
- Fixed a crash (`NoClassDefFoundError: okhttp3.internal.Util`) when an integrating app resolved OkHttp/logging-interceptor to a 5.x version different from the SDK's compiled dependency. The SDK's OkHttp and logging-interceptor dependency is now 5.3.2, so integrators pinning OkHttp to 5.x no longer conflict with the SDK's classpath.
- The SDK's internal storage migration could delete a Keystore master key alias shared with the host app's own `EncryptedSharedPreferences`, leaving unrelated host app data permanently undecryptable (`AEADBadTagException`) after upgrade. The migration no longer touches that shared key.
- Fixed authentication device data not syncing to the Dashboard, which caused NA values or missing records. Updating to this version restores syncing.
- Fixed a first-launch race in the SDK's encrypted-database initialization that could permanently corrupt a local database, causing a host-app crash (`OnErrorNotImplementedException`, `file is not a database`) on every later launch, most visibly when opening the selfie camera in Login flows. Affected devices now recover automatically on the next launch: the corrupted database is deleted and recreated. Locally enrolled face templates and unsynced face-login attempts stored in that database are lost, so affected users must re-enroll for local face login.

### Changed (non-CAPTURE_ONLY modes)

- Minimized the data collected and sent when on-device face processing (`SelfieScan.Builder.setOnDeviceFaceResultsSubmissionEnabled(true)`) is enabled, in line with the privacy-centric intent of on-device flows.

### Removals

- Removed the `deviceStats` field from `BaseResult`, so it is no longer present on the `Result` classes that never carried it (for example `FaceMatchResult`, `VideoSelfieResult`, `EKYCResult`). `deviceStats` remains available on `IdScanResult` and `SelfieScanResult`. Please refer to the [Migration Guide](/release-notes/migration-guide) for details.

### Module Versions

- `core-light` 3.0.16
- `nfc` 1.5.8

</Accordion>

## Version 5.50.0 - 2026-July-22





<Accordion title="5.50.0">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide/) for details)

- `SelfieScan.Builder.setVideoLivenessRecordingEnabled(Boolean)` is deprecated. Use `SelfieScan.Builder.setDeepsightConfiguration(...)` instead.
- `IdScan` primary constructor gains `motionEnabled: Boolean = false`. Kotlin source callers are unaffected; Java callers using the primary constructor directly must recompile. `IdScan.Builder` callers are unaffected. Please see [Migration Guide](/release-notes/migration-guide/) for details.

### Added (ALL modes)

- Added `NFC Scan` V2 module. Available when the V2 feature gate is enabled.
- Added a typed date input with a calendar picker to V2 form date fields.
- Added `SelfieScan.Builder.setDeepsightConfiguration(...)` and `FaceAuthentication.Builder.setDeepsightConfiguration(...)` to configure the Deepsight liveness modality (`DeepsightConfiguration.Modality.SINGLE_FRAME`, `DeepsightConfiguration.Modality.MULTIMODAL`, or `DeepsightConfiguration.Modality.VIDEO_LIVENESS`) and motion collection, matching the three options available in the Dashboard.
- Added `DeepsightConfiguration.Builder.setEnabled(Boolean)` to enable or disable Deepsight liveness independently from motion collection. When `false`, liveness modality selection is skipped while `motionEnabled` still applies. Defaults to `true`.
- Added `IdScan.Builder.setMotionEnabled(Boolean)` to enable motion data collection during ID scan in `SdkMode.CAPTURE_ONLY`. In STANDARD, FLOW, and WORKFLOW modes the server-side configuration takes precedence. Defaults to `false`.

### Added (STANDARD, Submit-Only, and Delayed modes)

- Added SDK Diagnostics collection. Enabled by default; opt out with `IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY).setDiagnosticsDataEnabled(false)`. Diagnostics are collected and uploaded for the standard onboarding flows (`startOnboarding`, `startFlow`, `startWorkflow`) in `STANDARD`, `SUBMIT_ONLY`, and `DELAYED` modes. `startOnboardingSection()` and `SdkMode.CAPTURE_ONLY` are not supported yet.

### Added (STANDARD and Submit-Only modes)

- Added `IdScan.Builder.setExtractIdFace(...)` to let integrations skip backend ID-face extraction for regulated-region sessions. Default remains `true`; when set to `false`, the SDK sends `extractIdFace=false` on front-ID uploads, including submit-only encrypted uploads, and downstream face-match is unavailable for that session.

### Added (STANDARD mode only)

- Added Silent Network Authentication (SNA) as an alternative to SMS OTP in the `Phone` V2 module, enabled exclusively through the flow configuration (the `snaVerification` setting in the Dashboard) - there is no client-side API to turn it on. Uncovered numbers, transient failures, and devices below API 24 fall back to SMS OTP automatically. See the [SNA guide](/features-and-modules/silent-network-authentication-sna/) for supported entry points, bundled permissions, the optional `READ_PHONE_STATE` 2G safeguard, and licensing notes.

### Fixed (ALL modes)

- Selfie Scan and Face Authentication capture metadata now reports the Deepsight motion flag even when liveness is off, so the backend can validate it against the flow configuration (matching iOS and ID capture).
- Fixed a crash when calling `deviceStats.getMotionStatus()` from any module result listener.
- Fixed an encrypted-preferences race that could transiently drop a just-written value (such as the session token), occasionally causing authenticated requests to fail.
- Added the `IdInfo` (OCR review) V2 module with the new Compose UI, including a processing screen, a success screen, and a submit-error screen with retry. Available when the V2 feature gate is enabled.
- Fixed an issue where server-side Face Login authentication via `startFaceLogin()` would allow a blocklisted user to log in. The SDK now denies the login (`FaceLoginResult.success` is `false`) on server-side 1:1 and 1:N face authentication, and a new `SelfieScanResult.isBlocklisted` flag is set whenever the backend reports the recognized user as blocklisted.
- Updated Javadocs for `SelfieScan.Builder`.
- Fixed an SDK-init ANR where `IncodeWelcome.Builder.build()` could block the calling thread for multiple seconds on a cold start, causing `Input dispatching timed out` when called synchronously during Activity creation. `build()` now returns promptly regardless of calling thread; database and key setup complete in the background.
- Fixed the `NFC Scan` module ending the flow with an error when it ran as the first module with no prior ID data. The OCR review screen now opens so the user can enter the data manually.
- Fixed the `NFC Scan` module showing the ID type chooser at the wrong step when `idType` was not pre-selected. The chooser now appears before OCR so the user can pick the document type first.

### Fixed (STANDARD mode only)

- Fixed `SelfieScan` V2 so a detected spoof is surfaced on `SelfieScanResult`: `isSpoofAttempt` is now populated (`true`/`false`) and `status` reports `STATUS_SPOOF_DETECTED` instead of `STATUS_GENERIC_ERROR`, matching V1 and the documented contract.
- Fixed `Selfie Scan` and `Face Authentication` getting stuck on the processing screen with no selfie uploaded when the video-liveness recording could not be produced or uploaded (e.g. the camera was invalidated mid-recording). The selfie is now submitted without the recording.
- Fixed an issue where `startOnboarding()` and `startOnboardingSection()` executed the wrong Deepsight liveness mode when a flow was configured with both selfie and face authentication modules.
- Fixed `VideoSelfie` uploads that could time out and leave the video missing on the dashboard. The SDK now retries failed uploads with backoff and surfaces a terminal error after exhausting retries instead of silently dropping the file.

### Fixed (STANDARD, Submit-Only, and Delayed modes)

- Fixed SDK Diagnostics (TrueSight) uploads being dropped after the session token was cleared (for example after `deleteUserLocalData()` or consent denial). Diagnostics now retain buffered entries across tokenless flushes and upload them on the next authenticated flush.

### Fixed (Capture-Only mode)

- Fixed `IdScan.Builder.setMotionEnabled(true)` being ignored in Capture-Only mode, causing the capture metadata to always report motion as disabled regardless of the client-side setting.

### Changed (non-CAPTURE_ONLY modes)

- `SelfieScan.Builder.setDeepsightConfiguration(...)` is now only applied in `SdkMode.CAPTURE_ONLY`. In all other modes (STANDARD, SUBMIT_ONLY, DELAYED) the server/flow configuration takes precedence and any code-side `DeepsightConfiguration` is ignored (a warning is logged).

### Deprecations (ALL modes)

- `SelfieScan.Builder.setVideoLivenessRecordingEnabled(Boolean)` is deprecated in favor of `SelfieScan.Builder.setDeepsightConfiguration(...)`.

### Documentation

- Reorganized the [SDK Customization Guide](/sdk-reference/android-customization/): `V2` customization is now documented first, fully separated from the legacy `V1` sections, and each generation now has its own logo and animations customization sections.
- Updated the [Google Wallet ID Setup And Testing Guide](/sdk-reference/android-google-wallet-id/) for SDK 5.50.0 availability, the `googleWallet` flow field, and direct invocation.

### Added dependencies

- `com.idlayr:idlayr-sdk-android:2.4.0` (vendored inside `onboard.aar`; integrators do not add this themselves - see [Licenses](/sdk-reference/android-licenses))

### Module Versions

- `core-light` 3.0.15
- `nfc` 1.5.7

</Accordion>

## Version 5.49.0 - 2026-June-16



<Accordion title="5.49.0">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide/) for details)

- Removed `IncodeWelcome.getReport(interviewId, ReportListener)`, the `ReportListener` interface, and the `ResponseEventReport` class. The backing `/omni/get/report` backend endpoint is no longer supported and reports cannot be generated through the SDK. Please refer to the [Migration Guide](/release-notes/migration-guide/) for details.
- Renamed `IncodeColorPalette.neutral` to `neutralLight` and `IncodeColorPalette.black` to `neutralDark`, including the matching JSON keys, to align with iOS so a single theme JSON works across both platforms.

### Added (ALL modes)

- Updated `core-light` module to v3.0.14: incorporating libRecogKitAndroid.so v3.9.2; fixing a regression (introduced in 5.42.0) that slowed on-device ML model loading and increased SDK initialization time.
- Added missing Javadocs for `SelfieScanResult` fields and `STATUS_*` constants, including `@since` links to the introducing or deprecating SDK versions where available.
- Added consecutive-frame debouncing for blur and glare real-time feedback in the `IdScan` module so a single bad frame no longer flashes the error pill. Aligns Android with iOS and Web.
- Added `Document Capture` V2 module. Available when the V2 feature gate is enabled.
- Added `DocumentScan.Builder.setDocumentSources(...)` to configure which submission methods (`CAMERA`, `FILE_UPLOAD`, `IMAGE_UPLOAD`) appear on the `Document Capture` chooser. Defaults to all three. For document types that don't accept PDFs, `FILE_UPLOAD` is dropped only when another source remains; configuring exactly `FILE_UPLOAD` on such a type is rejected with a configuration error before launch. Honored by both V1 and V2: in V1 the set refines the provider options chooser shown via `setShowDocumentProviderOptions(true)`; with that chooser disabled, V1 remains camera-only.
- Added `Email` V2 module. Available when the V2 feature gate is enabled.
- Refreshed the `CombinedConsent` module UI to align with the latest Incode design and added dark-mode support.

### Added (STANDARD mode only)

- Added `Custom Watchlist` V2 module. Available when the V2 feature gate is enabled, with dark-mode support.

### Fixed (ALL modes)

- Fixed the first streaming recording sometimes missing at onboarding start due to a token timing issue.
- Fixed `Face Login` reopening the camera and capturing a second time after a successful login flow completed.
- Improved video-liveness recording reliability on devices with flaky camera HAL (e.g. some MediaTek-backed Samsung models): when the camera is invalidated mid-recording and CameraX never delivers the `Finalize` event, the SDK now salvages any partial MP4 already written to disk and queues it for upload instead of dropping the recording.
- Security improvements.
- Improved accessibility behavior for phone input field.
- Fixed a crash in the `CombinedConsent` module when system font size is set to maximum.
- Fixed `SelfieScan` auto-capture being slow or failing to fire on Pixel 6 Pro and other high-density-screen devices in portrait, due to an overly tight face position constraint introduced in 5.45.0.
- Fixed the camera preview being visible on the status bar / notification line during `SelfieScan`, `Face Authentication`, and `Face Login` capture.
- The SDK no longer contributes an `io.sentry.proguard-uuid` `<meta-data>` entry to the host app's merged manifest.
- Fixed the `IdScan` V2 module to respect the configuration when the `setShowRetakeScreenForManualCapture()` method in the `IdScan.Builder` class is set to `false`.
- Fixed a `Duplicate class` build failure when integrating the `onboard` SDK alongside another library whose obfuscated classes occupy the root JVM package.
- Fixed unexpected focus jumps in `Dynamic Forms` fields.
- Added `@since Deprecated in <version>` tags to previously-undocumented deprecated public APIs across the SDK, so consumers can see at a glance when each API was deprecated.
- Rewrote the deprecation messages on `IncodeWelcome.fetchAllFlows()`, `IncodeWelcome.fetchFlow()`, `IncodeWelcome.downloadLibraries()`, `IncodeWelcome.isLibrariesReady()`, `IncodeWelcome.subscribeForLibrariesReady()`, and the `LibraryDownloadError` enum to name the recommended replacements.
- Fixed the `IdScan` V2 success screen displaying "Continue" instead of "Let's continue" on the label shown after a successful ID capture.
- Fixed back-of-ID streaming video not being recorded when the ID is configured as a separate back-only scan (`ScanStep.BACK`). The back-side recording is now finalized and uploaded like the front side.
- Improved error reporting when the E2EE key-exchange (`getPublicKey`) request fails: the resulting error now includes the HTTP status code and the server's error detail instead of a generic message.
- Fixed a crash in the `Video Selfie` module that occurred when the app was minimized while the recorded video was uploading, which left the session marked as Not Completed.

### Deprecations (ALL modes)

- Deprecated `IncodeException.DeviceEnvironmentException` and `IncodeException.isDeviceEnvironmentException()`. Both are unreachable at runtime - the SDK process terminates on detection before this exception can be delivered. Remove any catch blocks or calls referencing these; they are dead code. Both will be removed in a future release.
- Deprecated `SelfieScan.FaceAuthMode.SERVER`. This enum case should not be used for new integrations. Use the [FaceAuthentication](/features-and-modules/face-authentication) module instead. `SelfieScan.FaceAuthMode.LOCAL` (offline Face Login) is not affected.
- Deprecated `DocumentScan.Builder.setShowTutorials(...)` and `DocumentScan.Builder.setShowDocumentProviderOptions(...)` for V2. Both are ignored by the V2 `Document Capture` module — use `setDocumentSources(...)` to configure the chooser. Still honored in V1.

### Updated dependencies

- `org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.20` -> `org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.25`
- `org.jetbrains.kotlin:kotlin-reflect:1.9.20` -> `org.jetbrains.kotlin:kotlin-reflect:1.9.25`
- `org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.20` -> `org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.25`
- `org.jetbrains.kotlin:kotlin-serialization:1.9.20` -> `org.jetbrains.kotlin:kotlin-serialization:1.9.25`
- `com.google.devtools.ksp:1.9.20-1.0.14` -> `com.google.devtools.ksp:1.9.25-1.0.20`
- kotlinCompilerExtensionVersion `1.5.4` -> `1.5.15`
- `com.guardsquare:dexguard-gradle-plugin:9.14.2` -> `com.guardsquare:dexguard-gradle-plugin:9.14.3`

### Fixed (STANDARD mode only)

- Fixed the SDK's built-in Result screen failing to display the user score in non-E2EE flows, due to the deprecated `/omni/get/report` endpoint returning HTTP 500 during an eager pre-fetch on screen entry. The screen now loads results without calling the removed endpoint, and the unused "Reports" button has been removed.
- Fixed loss of the persisted session token after the app process was killed, which caused authenticated requests to fail with HTTP 401 and prevented onboarding from resuming. The token is now retained across process death so flows continue without re-authentication.
- Fixed the ID capture `captureAttemptFinished` event being reported with the wrong name in UXV2 frame-logging flows, so the event now matches the value emitted by all other flows.

### Module Versions

- `core-light` 3.0.14
- `nfc` 1.5.5

</Accordion>

## Version 5.48.1 - 2026-Oct-12


<Accordion title="5.48.1">

### Fixed (ALL modes)

- Fixed a crash in apps that Google Play distributes with Automatic Protection (anti-tampering) turned on.

### Module Versions

- `core-light` 3.0.13.1

</Accordion>

## Version 5.48.0 - 2026-May-22


<Accordion title="5.48.0">

### Added (ALL modes)

- Added Hebrew (`he-IL`) localization for the `onboard` SDK module. Pass `he-IL` to `CommonConfig.Builder.setLocalizationLanguage(...)` to render the SDK UI in Hebrew, and to `SessionConfig.Builder.setLanguage(...)` to enable Hebrew voice-consent transcription. (Both `he-IL` and the legacy Java-style `he_IL` form are accepted by `setLocalizationLanguage`. The Android resource folder uses the legacy ISO 639-1 qualifier `values-iw/` internally — this is a platform requirement and not an integrator-facing identifier.)
- Lottie animations and vector drawables in V2 modules (`IdScan`, `SelfieScan`) now inherit colors from the SDK color scheme, aligned with the [ID capture design guidelines](/design-and-ux/id-capture-design/) and [face capture design guidelines](/design-and-ux/face-capture-design/). Customer-overridden animation resources are automatically detected and left unchanged.
- Local Room databases are now encrypted at rest using SQLCipher. Existing unencrypted databases are automatically migrated to encrypted format on first access. See [Licenses](/sdk-reference/android-licenses/) for the SQLCipher attribution that must be reproduced if your app ships an open-source licenses screen.
- Added a persistent dim overlay around the silhouette on the `SelfieScan` V2 manual capture screen.
- Added `Phone` V2 module. Available when the V2 feature gate is enabled.

### Added (STANDARD mode only)

- Added support for verifying identity using Google Wallet IDs within the `IdScan` module, via the new optional `com.incode.sdk:wallets` dependency. Enable per-module with `IdScan.Builder.setGoogleWalletIdEnabled(true)`, and switch between production and sandbox environments via `IncodeWelcome.Builder.setGoogleWalletEnvironment(...)`. The optional `wallets` module requires `minSdk` 28.

### Fixed (ALL modes)

- Fixed an issue where Kotlin interface callbacks with default implementations in the `onboard` module required empty overrides from Java integrators; they are now emitted as Java `default` methods and are optional overrides for both Kotlin and Java integrators. This includes the per-attempt `SelfieScanListener` and `IdScanListener` callbacks introduced in 5.47.0:
  - `SelfieScanListener.onSelfieScanReady`
  - `SelfieScanListener.onSelfieScanAttemptCompleted`
  - `IdScanListener.onIdScanReady`
  - `IdScanListener.onIdFrontAttemptCompleted`
  - `IdScanListener.onIdBackAttemptCompleted`
- `Face Authentication` V2 module: Fixed `SelfieScan.Builder().setCaptureAttempts` not being respected when the captured selfie did not match the identity provided via `CommonConfig.Builder().setFaceAuthenticationHint(...)`; the flow ended after the first attempt instead of allowing the configured number of retries.
- Fixed button label clipping on long or translated strings: `IncodeButton` now auto-sizes its text, shrinking the font before adding ellipsis, and wraps multi-word labels to two lines.
- Security improvements.
- Fixed the verification-complete confirmation message in `ApproveActivity` and the overall score in `ResultsActivity` (the `SHOW_RESULTS` module) not being announced as accessibility headings by TalkBack.
- Accessibility improvements in the `Dynamic Forms` module.
- Fixed `Login` flow rendering the legacy selfie tutorial instead of the V2 tutorial when `showTutorials` was enabled.
- Updated the `Proof of Address` tutorial screen design and improved the layout of the review screen.
- Fixed inconsistent V1/V2 UX rendering across onboarding modules within a single flow. The V2 feature gate is now properly awaited before the first module starts, so `IdScan`, `SelfieScan`, and other modules consistently render the same UX version.
- Corrected typos, grammar, and British-English spellings in customer-facing Javadoc, KDoc, and Markdown documentation.
- Fixed `SelfieScan.Builder.setLogo(...)` not being applied to the toolbar on the V2 selfie capture screen.
- Changed the default values of the `setHeadCoverCheckEnabled()` and `setMaskCheckEnabled()` methods to `true` in the `SelfieScan.Builder`.
- Changed the default values of the `setHeadCoverCheckEnabled()` and `setMaskCheckEnabled()` methods to `true` in the `VideoSelfie.Builder`.
- Fixed a Spanish localization typo on the camera permission screen: `Salir del processo` is now `Salir del proceso`.

### Fixed (STANDARD mode only)

- Fixed a `VideoSelfieActivity` crash when Android recreates the activity while the video selfie upload screen is being restored.
- Fixed a rare crash (`FileNotFoundException` / `UndeliverableException`) during selfie video upload when `SelfieScanVideoRecordVideo.mp4` was missing or unflushed at upload time. Failures now route through the standard retry UI / `SelfieScanListener.onError` path instead of crashing the flow.

### Added dependencies

- `androidx.credentials:credentials:1.5.0` (required only when using the new optional `wallets` module)
- `androidx.credentials:credentials-play-services-auth:1.5.0` (required only when using the new optional `wallets` module)
- `net.zetetic:sqlcipher-android:4.6.1`

### Module Versions

- `core-light` 3.0.13
- `nfc` 1.5.4
- `wallets` 1.0.0 (new optional module)

</Accordion>

## Version 5.47.0 - 2026-May-07


<Accordion title="5.47.0">

### Added (ALL modes)

- Updated `core-light` module to v3.0.12: incorporating libRecogKitAndroid.so v3.9.1; updating the on-device liveness model used by `SelfieScan` and `FaceAuthentication` (`model-liveness-detection` 3.2.2)
- Added `allAttemptsExhausted` flag to `IdScanResult` and `SelfieScanResult` indicating when capture or upload retries are no longer available.
- Added per-attempt `IdScan` callbacks `onIdFrontAttemptCompleted` / `onIdBackAttemptCompleted` to `IdScanListener` (and `IncodeWelcome.OnboardingListener`). They fire after every individual capture attempt, including intermediate failures. The terminal attempt is signaled when `IdScanResult.allAttemptsExhausted` is `true` or when the attempt succeeds.
- Added per-attempt `SelfieScan` callback `onSelfieScanAttemptCompleted` to `SelfieScanListener` (and `IncodeWelcome.OnboardingListener`). It fires after every individual selfie capture attempt, including intermediate failures. The terminal attempt is signaled when `SelfieScanResult.allAttemptsExhausted` is `true` or when the attempt succeeds.
- Added missing Javadocs for `IncodeWelcome` entry-point APIs.
  - `startOnboarding(...)`
  - `startOnboardingSection(...)` (all overloads)
  - `startWorkflow(...)`
  - `startFaceLogin(...)` (all overloads)
  - `startFlow(...)` (all overloads)
  - `startFlowFromDeeplink(...)` (all overloads)
  - `finishOnboarding(...)`
- Added `Geolocation.setSkippable(boolean)` to control what happens when the user denies the location permission and taps `Skip this step` in the V2 flow. When skippable, the flow continues; otherwise it ends with `OnboardingListener.onError` (and `OnboardingListener.onGeolocationUnavailable`). The flag is also wired up to the dashboard's `Allow user to skip geolocation` toggle for both `Flows` and `Workflows` configurations.
- Updated the V2 Geolocation skip button label to read `Skip this step` when `Geolocation.setSkippable(true)` and `Quit process` when `Geolocation.setSkippable(false)`, on both the permission-denied and location-unavailable screens.
- Added `LocationPermissionDeniedException`, raised by the V2 `Geolocation` flow when the user exits from the permission-denied screen. `GeolocationUnavailableException` is now reserved for the location-unavailable and max-retries exit paths.

### Added (STANDARD mode only)

- Added an on-device face occlusion check available in `SelfieScan` (V1 and V2) and `FaceAuthentication`. Configure it locally via `setFaceOcclusionEnabled(...)` and `setFaceOcclusionSeverity(...)` on the respective `Builder` classes, or from the dashboard's `isOcclusionEnabled` / `occlusionSeverity` settings for the respective modules. The feature requires the new optional `com.incode.sdk:model-face-occlusion` dependency.
- Added the `setOnDeviceFaceResultsSubmissionEnabled()` API to the `SelfieScan` V2 module to support on-device face processing. When enabled, liveness detection and age estimation run entirely on the user's device. No biometric images leave the SDK.
  - `setOnDeviceFaceResultsSubmissionEnabled()` requires E2EE, supports auto-capture only, and has other configuration constraints. See the [On-Device Age Estimation guide](/sdk-reference/android-on-device-age-estimation) and the [Javadoc](https://incode-technologies-example-repos.github.io/Incode-Welcome-Android-example/javadoc/com/incode/welcome_sdk/modules/SelfieScan.Builder.html) for more details. for more details.
- Implemented on-device age estimation in the `SelfieScan` V2 module behind `setOnDeviceFaceResultsSubmissionEnabled()`, available via the new optional `com.incode.sdk:model-age-estimation` dependency.
- Added Digital ID validation for selected PDF files to reject uploads larger than 5 MB with an appropriate error state.

### Fixed (ALL modes)

- Updated the SDK's internal encrypted storage to a more reliable, future-proof implementation. Existing data is migrated transparently on first launch after upgrade.
- Improved reliability of internal encrypted storage on low-end devices that previously experienced intermittent encryption failures.
- Fixed an issue where `Behavioral Trust` results were reported as unknown.
- Removed internal SDK implementation details from the [Javadoc](https://incode-technologies-example-repos.github.io/Incode-Welcome-Android-example/javadoc/index.html) that were not relevant to integration.
- Fixed missing back-side tutorial in the `IdScan` V2 flow when `IdScan.ScanStep.BACK` is used with ID tutorials enabled.
- Fixed `IdScan` V2 reporting `IdScanResult.scanStatus = RESULT_ERROR_UNKNOWN` for wrong-document-side captures; now correctly reports `RESULT_ERROR_WRONG_ID_SIDE`.
- Fixed an issue where `IncodeWelcome.startWorkflow()` only logged a `ModuleConfigurationException` at startup and did not invoke `OnboardingListener.onError()`.
- Fixed the image quality severity configured on the Dashboard being ignored by the `SelfieScan` module; the configured severity is now honored.
- Fixed a rare camera stack issue where `IdScan` or `SelfieScan` could fail during capture on certain devices.

### Module Versions

- `core-light` 3.0.12
- `model-liveness-detection` 3.2.2
- `model-face-occlusion` 0.2.0 (new optional module)
- `model-age-estimation` 2.2.2 (new optional module)

### Added dependencies

- `androidx.datastore:datastore:1.1.7`
- `com.google.crypto.tink:tink-android:1.21.0`

</Accordion>

## Version 5.46.0 - 2026-Apr-27


<Accordion title="5.46.0">

<Callout icon="🚧" theme="warn">
  Use the BOM to keep SDK module versions aligned when upgrading. If versions are managed manually, refer to the updated dependency versions in the **Module Versions** section below.
</Callout>

### Added (ALL modes)

- Added accessibility (TalkBack) support for all Dynamic Forms input fields. Screen readers now announce field labels, required state, current values or hints, and validation errors.
- `Face Authentication`: Enriched unknown error reporting with original exception details and cause chain for better diagnostics on the Dashboard.
- Added the possibility to enable UXV2 modules directly from the Dashboard configuration.
- Enabled high resolution ID and Face capture via `clientExperimentId`. Pass `high_res_capture` (optionally combined with other experiments using `|`, e.g. `experimentV2|high_res_capture`) to opt in.
- Migrated the `CURP` module to the V2 design system (Compose), including a "Non-Binary/Other" gender option.

### Fixed (ALL modes)

- Migrated Dynamic Forms text, date, select, and yes/no fields from legacy theme to V2 design system (`IncodeTheme`), applying consistent styling to match the previously updated phone and country selector inputs.
- Improved TalkBack accessibility in the `IdScan` V2 module: better semantic grouping, button roles, content descriptions, live region announcements, and focus management.
- Improved button accessibility in V2 Compose screens.
- The `SelfieScan` module outline ring now inherits its coloring from the color scheme, aligned with the [face capture design guidelines](/design-and-ux/face-capture-design/).
- Improved accessibility behavior for Compose-based SDK modal components by adding stronger dialog semantics and deterministic initial focus handling for permission and picker dialogs.
- Fixed the overlay transition around the silhouette for `SelfieScan` V2 module.
- Fixed incorrect initial TalkBack focus in `IdScan` V2 by hiding interactive elements during pre-initialization and controlling traversal order for buttons and the module header.
- The SDK now throws an `ExternalTokenRequiredException` when a `/0` URL is configured and no external token is provided — either the base URL, or the E2EE URL while E2EE is enabled. Previously, the E2EE variant caused a crash with `lateinit property has not been initialized` in the E2EE interceptor.
- Fixed an issue where video recording could fail if the recording directory did not exist before starting recording.
- Improved ID capture sharpness on the CameraX (V2) camera stack: enabled best-candidate selection during the capture countdown, and prevented automatic macro camera switching on multi-camera devices (API Level 28+).
- Restored missing camera-opened analytics events on the V2 capture path.
- Fixed a DexGuard class-inlining issue where optional dependency references (Huawei, Sardine) could be merged into SDK classes, causing runtime crashes when those dependencies are not present.
- Fixed dynamic localization not being applied in UXV2 modules due to the localized `Context` not being propagated. The issue was introduced in `5.45.1`.
- Fixed an issue where `Behavioral Trust` results were reported as unknown.
- Fixed an issue where `Behavioral Trust` results were incorrectly reported as a failure on certain devices.
- Improved Lottie animation playback smoothness on the ID capture tutorial screen.
- Improved camera compatibility, reducing false unsupported-device errors.
- Fixed an issue where the `QES` and `AES` module activities did not close after publishing results.
- Introduced unified searchable and plain dropdown components — used by Dynamic Forms (country selector, select inputs) and the `CURP` V2 module — with improved TalkBack announcements, focus handling, and validation feedback. The country selector now supports searching (type to filter).

### Fixed (STANDARD mode only)

- Fixed `IncodeWelcome.SSLConfig` not being accessible as a public API and custom SSL configuration not being applied correctly.

### Module Versions

- `core-light` 3.0.11

### Updated dependencies

- `com.squareup.okhttp3:logging-interceptor:4.9.3` -> `com.squareup.okhttp3:logging-interceptor:4.12.0`
- `org.json:json:20180813` -> `org.json:json:20251224`

</Accordion>

## Version 5.45.1 - 2026-Apr-03





<Accordion title="5.45.1">

<Callout icon="🚧" theme="warn">
  Use the BOM to keep SDK module versions aligned when upgrading. If versions are managed manually, refer to the updated dependency versions in the **Module Versions** section below.
</Callout>

### Added (ALL modes)

- Added dark mode support for drawables in V2 modules. Custom drawables can now provide a `drawable-night` variant that is automatically resolved based on the active display mode.
- Added `MODULE_VERSION` info for `SelfieScan`, `FaceAuthentication` and `FaceMatch` modules to the module-opened analytics event.

### Fixed (ALL modes)

- `IdScan` and `SelfieScan` V2 modules now survive configuration changes (e.g., theme change).
- Fixed close header button visibility issue on the manual photo review screen in `IdScan` V2 flow.
- Fixed an issue where the manual capture button in the `SelfieScan` V2 module was not properly announced by TalkBack because it did not have a `contentDescription`.
- Fixed `setShowFooter(false)` not being applied in the `Geolocation` V2 module - the footer was always visible regardless of the `IncodeUXConfig` setting.
- Fixed missing "Get Ready" circle spinner on selfie capture when face re-enters constraints after being lost or after capture timeout.
- Improved selfie ML model loading performance: models now load lazily on a background thread and in parallel, reducing main thread blocking during SDK initialization and selfie screen startup.

### Module Versions

- `core-light` 3.0.10

</Accordion>

## Version 5.45.0 - 2026-Mar-23


<Accordion title="5.45.0">

<Callout icon="🚧" theme="warn">
  Use the BOM to keep SDK module versions aligned when upgrading. If versions are managed manually, refer to the updated dependency versions in the **Module Versions** section below.
</Callout>

### API Changes (refer to [Migration Guide](/release-notes/migration-guide/) for details)

- Removed the transition/loading screen that was shown between modules. Any customizations related to this screen (e.g., overriding `onboard_sdk_activity_transition.xml`, `IncodeTransitionScreenState`) can be safely removed.
- `IdScan` module: document chooser visibility is now controlled only by Flows and `setShowIdTypeChooser(...)`. Setting `idType` no longer hides the chooser. Please see [Migration Guide](/release-notes/migration-guide/) for details.
- Security improvements.

### Added (ALL modes)

- Added German localization.
- Extended the module customization functionality to align with the [recent design guidelines](/design-and-ux/id-capture-design/). Updated the `IdScan` V2 module to use the new customization system.
- Added Geolocation Module V2. Like other V2 modules (`IdScan`, `SelfieScan`, `ProcessId`, `FaceMatch`), it is available when the feature gate is enabled.
- Implemented new camera loading indicator in `IdScan` V2 module.
- `IdScanResult.idImageBase64` is now populated in all modes in `IdScan` V2. Previously, it was only available in Capture-Only mode.
- Updated the document chooser screen in V2 `IdScan` module to always use a more compact design and to show documents dynamically based on the module configuration.
- Strengthen device environment checks.
- `SelfieScan` V2: tablets are now landscape-locked with an optimized layout. Phone devices remain portrait-locked.
- Updated UI for the [Permission screens](/design-and-ux/face-capture-screens-states/#permission-screens) in the `IdScan` and `SelfieScan` V2 modules.
- Improved feedback during ID capture in the `IdScan` V2 module, with different labels shown in Standard and Capture-Only mode.

### Added (STANDARD mode only)

- Ported these additions from `5.40.2`:
  - Added ability to pass `SessionConfig` to `IncodeWelcome.startFaceLogin()` API. This allows enabling of end-to-end encryption (E2EE) in Face Login mode.
  - Face Login: Security improvements
- Added support for ASYNC modules in Workflows. Currently applies to the `VideoSelfie` module, where the `/omni/finish-status` endpoint is handled on the backend.

### Fixed (ALL modes)

- Bumped DexGuard plugin to 9.13.3 to fix an OOM error caused by bloated consumer ProGuard rules shipped with the AAR.
- Updated the position of the capture frame on the screen according to the [capture screen specification](/design-and-ux/id-capture-specs-guidelines/) for the `IdScan` V2 module.
- Updated the camera feed positioning in the `SelfieScan` module.
- Adjusted the `SelfieScan` module UI to align with the [UXv2 styling](/design-and-ux/face-capture-design/), including new success/error screens, animations, and transitions.
- Fixed potential crashes when backgrounding an app with a Camera-based module (`IdScan`, `SelfieScan`, etc) on screen and returning to the app
- Fixed a rare crash during ID capture upload caused by out-of-bounds bitmap coordinates.
- Fixed an issue with location fetching in the `Geolocation` module; Unavailable location is now handled by falling back to requesting location updates.
- Aligned error screens for the `IdScan` V2 module with [recent design guidelines](/design-and-ux/id-capture-design/).
- Updated capture instructions on success screen in the `IdScan` V2 module.
- Fixed an intermittent error in frame analyzers caused by a race condition in concurrent frame processing.
- Fixed the app getting stuck during `IdScan` when the user declines the screen recording permission with `configureScreenRecording(true, false)` config.
- Fixed image quality checks severity in the `SelfieScan` and `FaceAuthentication` module so that configured thresholds are consistently honored across SDK-based and Dashboard-based configurations.
- Update Close icon on all screens with close button configured, and Help icon on ID Capture V2 screen
- Fixed a `NullPointerException` that could occur when calling `IncodeWelcome.deleteUserLocalData()` if a temporary images directory failed to create.
- Fixed potential `NullPointerExceptions` and `ConcurrentModificationExceptions` that could occur in the `SelfieScan` module when determining the horizontal view angle of the camera.
- Fix content centering problems for the `Face Match` V2 module
- Fixed an issue where the Device Trust check in Deepsight could be marked as "unknown".
- `Face Authentication`: The progress text now shows "Uploading" instead of "Verifying".

### Fixed (Capture-Only mode)

- Improved functionality of the feature flag mechanism when using `setClientExperimentId`, particularly in Capture-Only and Delayed modes.

### Fixed (STANDARD mode only)

- Updated the HTTP method for `/omni/finish-status` from `GET` to `POST`

### Module Versions

- `core-light` 3.0.9
- `nfc` 1.5.3

### Updated dependencies

- `com.guardsquare:dexguard-gradle-plugin:9.13.1` -> `com.guardsquare:dexguard-gradle-plugin:9.13.3`

### Removed dependencies

- `com.guardsquare:dexguard-runtime`

</Accordion>

## Version 5.44.0; `core-light` 3.0.8 - 2026-Feb-25


<Accordion title="5.44.0; core-light 3.0.8">

### API Changes (refer to [Migration Guide](/release-notes/migration-guide/) for details)

- `DocumentType` has been moved

### Added (ALL modes)

- Added support for a bill of materials (BOM) that can be used when integrating libraries from the Incode Omni SDK. Please refer to the [Incode Bill of Materials (BOM) section of the Setup Guide](/sdk-reference/android-installation#add-the-incode-bill-of-materials-bom) and [Migration Guide](/release-notes/migration-guide) for further details.
- Added a lot of missing Javadocs in the following packages/classes/methods of `com.incode.welcome_sdk.`:
  - `CommonConfig.Builder.setShowCloseButton()`
  - `commons.exceptions.*`
  - `commons.exceptions.IncodeException.CaptureRetryAttemptsExceeded`
  - `commons.exceptions.IncodeException.DeviceEnvironmentException.*`
  - `commons.exceptions.video_selfie.*`
  - `data.*`
  - `data.Event.*`
  - `IncodeWelcome.Builder.setTestModeEnabled()`
  - `listeners.*`
  - `modules.*`
- Added a new encryption layer to data the SDK stores in `SharedPreferences`.

### Added (STANDARD mode only)

- Updated the `FaceMatch` module to [UxV2](/design-and-ux/face-match-design/). This update also introduces a new SDK API: `FaceMatch.Builder.setShowLivenessResult()`.

### Added (Capture-Only mode)

- Added the `presignedVideoFilePath` parameter to the `SelfieScanResult` model when `SelfieScan.Builder.()setVideoLivenessRecordingEnabled()` is enabled

### Fixed (ALL modes)

- Fixed recording being cut off at the beginning and occasional video missing in `SelfieScan` and `IdScan`.
- Fixed an issue where the "No internet" bottom bar UI would overlap with the bottom navigation buttons when `targetSdk` is 35+
- Updated manual capture text in the `SelfieScan` module. Updated the manual capture button icon and the layout alignment.
- Added the missing default outer grey circle camera border in the `SelfieScan` module.
- Fixed an issue where the `onSSLPinningFailed()` callback was not called when using `startOnboardingSection()`
- Fixed letter spacing in the `MINIMAL` variant of realtime feedback messages in the `IdScan` module.
- Updated text on the Tutorial and Capture screens in the `IdScan` V2 module to reflect `US Smart Capture`.
- Fixed an issue where the close button could not be shown in the `SelfieScan` module.
- Added missing exclamation mark to the "Success" state message in `SelfieScan`.
- Fixed an issue where `IncodeWelcome.deleteUserLocalData()` was not deleting video liveness and screen recordings from the `IdScan` and `SelfieScan` modules.
- Fix session breaking issues in the `IdScan` V2 flow when the user scans the front side of the document with a covered face.
- Updated the V2 flow maximum header logo height.
- Prevent `ConcurrentModificationException` in `IdScan` and `SelfieScan` V2 that could occur randomly when capturing the photos.

### Added dependencies

- `androidx.security:security-crypto-ktx:1.1.0`

### Updated dependencies

- `com.guardsquare:dexguard-gradle-plugin:9.12.6` -> `com.guardsquare:dexguard-gradle-plugin:9.13.1`
- `com.guardsquare:dexguard-runtime:9.12.6` -> `com.guardsquare:dexguard-runtime:9.13.1`

</Accordion>

## Version 5.43.0; `core-light` 3.0.7; `nfc` 1.5.2 - 2025-Dec-30


<Accordion title="5.43.0; core-light 3.0.7; nfc 1.5.2">

### Added (ALL modes)

- Added support for `allowSkipDocumentCapture` configuration for the `DocumentScan` module, allowing users to skip document capture when enabled. Added `isDocumentValidationSkipped` field to `DocumentValidationResult` to indicate when document validation was skipped.
- Updated wording in the `SelfieScan` V2 module to improve clarity and user guidance during the selfie capture process.
- Added `getDocumentImage()` method to the `DocumentValidationResult` class, which returns the document image as a `Bitmap`.
- Added "minimal" option for the real time feedback shown in the `IdScan` V2 module. This can be configured via `IncodeUXConfig.Builder().setRealtimeFeedbackMessageUIFlavor()`. Available options are `RealtimeFeedbackMessageUIFlavor.STANDARD` and `RealtimeFeedbackMessageUIFlavor.MINIMAL`.
- Updated [Javadoc](https://incode-technologies-example-repos.github.io/Incode-Welcome-Android-example/javadoc/com/incode/welcome_sdk/IncodeWelcome.Builder.html#setClientExperimentId\(java.lang.String\)) for `IncodeWelcome.Builder().setClientExperimentId()` to better reflect proper usage.
- Updated UI in the `FaceMatch` module for compact UI mode. This feature can be enabled via `FaceMatch.Builder().setFaceMatchAnimationEnabled(false)`.
- Performance improvements.
- Added missing Javadocs for the following SDK APIs:
  - Introduced with [Dynamic Localization](/sdk-reference/android-customization/#dynamic-localization) in `5.3.0`:
    - `IncodeWelcome.setStrings()`
    - `IncodeWelcome.setStringArray()`
    - `IncodeWelcome.setQuantityStrings()`
  - Introduced with the `FaceAuthentication` module in `5.40.0`:
    - `FaceAuthenticationListener`
    - `FaceAuthenticationResult`
    - `IncodeWelcome.setFaceAuthenticationHint()`
- Security improvements.
- New Transition screen layout. This screen is now customizable using the new V2 theming system. Check the [Migration Guide](/release-notes/migration-guide/) for more details.
- Updated UI for Need Help screen in the `IdScan` V2 module.
- Added `setHeaderAlignment()` method to `IncodeUXConfig.Builder` to configure alignment of the Header on the applicable screens. Available options are `HeaderAlignment.START`, `HeaderAlignment.CENTER` (default), and `HeaderAlignment.END`.
- Added PDF417 barcode support to the `IdScan` V2 module, enabled per-flow through the dashboard via the US Smart Capture setting.
- Added support for customizing button styles through `IncodeComponents`. Buttons used in V2 modules can now be configured with custom colors for different states (default, hover, pressed, disabled), borders width, color and radius. See [SDK Customization Guide](/sdk-reference/android-customization/#configure-v2-theme-and-ux) for details on component configuration.

### Added (STANDARD mode only)

- The `error` field in `IdScanResult` is now populated when retry attempts are exhausted. The `resultCode` is set to `SUCCESS` because the flow continues. This change applies only to `IdScan` V2, as adding it to V1 would be a breaking change.
- Added a specific error message for cases where face occlusion is detected in the `SelfieScan` and `FaceAuthentication` modules.
- Refactored `SelfieScan` and `Face authentication` V2 modules to use `Compose` UI. These modules are now customizable using the V2 theming system. Check the [Migration Guide](/release-notes/migration-guide/) for more details.

### Fixed (ALL modes)

- Fixed an issue where the Behavioral Trust check in Deepsight could get an unknown result on lower-end devices
- Fixed an issue where the Behavioral Trust check in Deepsight would always get an unknown result if `SelfieScan` v2 was used in the session
- Fixed a potential `OutOfMemoryError` with long, repeated use of the `NfcScan` module.
- Fixed an issue where some legacy model files could be retained on the device following an update of the Android SDK.
- Fixed a compatibility issue that caused crashes on Android 14 and earlier due to conflicts between Kotlin extension methods and Java methods introduced in Android 15. This ensures compatibility across all Android versions.
- Fixed an issue where video upload failed in Face Login mode when using video streaming.
- Fixed an issue in the `SelfieScan` module where tutorials were incorrectly skipped in Face Login mode when `SelfieScan` V2 was enabled.
- Improved error handling in video streaming initialization by checking for required dependency first, before checking for available RAM.
- Fixed an `IllegalStateException` that could occur in the `IdScan` v2, `SelfieScan` v1, and `SelfieScan` v2 modules when the camera was determining what features it supports
- Fixed a `CalledFromWrongThreadException` crash in the `SelfieScan` module that could occur randomly.
- Fixed a `NullPointerException` crash caused by the app failing to access the external files directory. This issue was mostly affecting Pixel devices on Android 15/16 (and possibly others)
- Fixed an issue that caused the SDK to stop producing logs in certain cases.
- Fixed an issue where phantom analytics events were being logged in the `IdScan` V2 module when the Passport is selected.
- Fixed an error that would occur when reading a certain type of NFC chip in the `NfcScan` module.
- Fixed an issue where the `NfcScan` module did not respect the `nfcMaxRetries` setting when an NFC read failed due to (possibly) incorrect OCR data.
- Fixed an issue where the camera hardware cannot be found when the host application is built with ProGuard or R8 enabled.
- Fixed an issue where the flow got stuck on the Transition screen when the camera permission was denied in the `FaceAuthentication` module.

### Fixed (STANDARD mode only)

- Fixed a potential `OutOfMemoryError` with long, repeated use of workflows.
- Fixed an issue in `SelfieScan` module where the UI would get stuck when manual review is triggered after capture attempts are exhausted. The flow now finishes immediately with an error instead of showing broken UI.
- Fixed an issue in the `IdScan` module where Back ID scan would start unexpectedly for one-sided documents after pausing and resuming the app.

### Fixed (Capture-Only mode)

- Fixed an issue where the Behavioral Trust check in Deepsight would always display an unknown result if `SelfieScan` v1 was used in the session due to relevant data missing when invoking `SelfieScanResult.metadata`.
- Fixed an issue where the Device Trust check in Deepsight would always display a potentially false "PASSED" result if `SelfieScan` v1 was used in the session due to relevant data missing when invoking `SelfieScanResult.metadata`.

### Fixed (Submit-Only mode)

- Fixed a `NullPointerException` that happens when publishing the result in the `Selfie` module.

</Accordion>

## Version 5.42.0; `core-light` 3.0.6; `nfc` 1.5.1 - 2025-Nov-28


<Accordion title="5.42.0; core-light 3.0.6; nfc 1.5.1">

### Added (ALL modes)

- Upgrading `compileSdk` to level 35 is required. Please see [Migration Guide](/release-notes/migration-guide/) for details.
- Added Age Assurance UX to the `IdScan` V2.
- Added `croppedDocumentPath` field to `IdScanResult` (applicable only to `IdScan` v2 module), containing the file path to the cropped document image.
- Added a Review Photo screen in the `IdScan` v2 module, shown after the user captures an ID. This feature can be enabled using the `setShowRetakeScreenForAutoCapture()` and `setShowRetakeScreenForManualCapture()` methods in `IdScan.Builder`.

### Added (STANDARD mode only)

- Added info describing which API and configurations were used for starting the SDK to the "Sdk Info" event.
- Added a specific error message for cases where face image quality is too low in the `SelfieScan` module.
- Workflows: added the option to prefill the phone number in the `Phone` module based on the user's previously stored identity.

### Added (STANDARD mode only)

- Added support for `CustomModule` in Workflows, allowing integrators to pause a flow, execute custom logic, and resume at the module's next node. The configured `callbackName` is provided as a string for custom handling.

### Fixed (ALL modes)

- Fixed an issue on Android 14+ devices where the `SelfieScan` module could crash after screen recording permission is granted if an active camera preview is showing. The issue was introduced in 5.36.0.
- Fixed a potential `IllegalStateException` that could occur in the following modules after the app was in the background and came back.
  - `Conference`
  - `CurpValidation`
  - `IdScan` V2
  - `VideoSelfie`
- Fixed UI issues for targetSdk 35
- Refactored exception handling with dedicated hierarchies: `IncodeException.PermissionNotGranted` (camera, microphone, location, NFC) and `IncodeException.DeviceEnvironmentException` (emulator, hooking, virtual environment, root detection). See the [Migration Guide](/release-notes/migration-guide/) for details.
- Fixed an issue where liveness was incorrectly shown as "failed" in the `FaceMatch` module if it came after the `FaceAuthentication` module.
- Fixed crashes on Android 6 that could happen on various screens. The error message was "Error inflating class ImageView".

### Fixed (STANDARD mode only)

- Fixed an issue where the settings for `Closed Eyes` and `Head Cover` checks were not respected in the `SelfieScan` and `Face Authentication` modules when using Workflows.
- Fixed an issue in the `SelfieScan` module where streaming did not record subsequent face capture attempts after the first failed attempt.
- Fixed a crash in the `FaceAuthentication` module when receiving unknown error codes (e.g., `SELFIE_FACE_OCCLUDED`) from the server. Unknown error codes will be mapped to `UNKNOWN` instead of throwing an exception.
- Fixed an issue in the `SelfieScan` module where use of both Deepsight Video Liveness and video streaming via `setStreamFramesEnabled(true)` would log a "Video Streaming Session Failed Due To An Error" event with a `SessionNullOrInvalidParameter` error code. If both of these features are enabled, video streaming will be ignored.
- Fixed an issue where a log message could appear about the device not having enough RAM to support video streaming when the 'video-streaming' dependency wasn't included.
- Updated log messages related to missing optional dependencies to provide clearer debugging information.
- Removed borders around the images in `FaceMatch` module.

### Removals/Deprecations

- Removed the "Referred to executive" screen from the `IdScan` v2 module, and deprecated the `ProcessId.Builder.setEnableIdSummaryScreen()` method.

### Updated dependencies

- `androidx.activity:activity-compose:1.8.2` -> `androidx.activity:activity-compose:1.10.1`
- `androidx.camera:camera-camera2:1.4.2` -> `androidx.camera:camera-camera2:1.5.1`
- `androidx.camera:camera-extensions:1.4.2` -> `androidx.camera:camera-extensions:1.5.1`
- `androidx.camera:camera-lifecycle:1.4.2` -> `androidx.camera:camera-lifecycle:1.5.1`
- `androidx.camera:camera-video:1.4.2` -> `androidx.camera:camera-video:1.5.1`
- `androidx.camera:camera-view:1.4.2` -> `androidx.camera:camera-view:1.5.1`
- `androidx.fragment:fragment:1.6.2` -> `androidx.fragment:fragment:1.8.9`
- `com.android.tools.build:8.1.4` -> `com.android.tools.build:8.6.0`
- `com.google.dagger:dagger:2.48.1` -> `com.google.dagger:dagger:2.57.2`
- `com.google.dagger:dagger-compiler:2.48.1` -> `com.google.dagger:dagger-compiler:2.57.2`
- `gradle-8.0-bin.zip` -> `gradle-8.7-bin.zip`
- `io.insert-koin:koin-android:3.5.3` -> `io.insert-koin:koin-android:4.0.4`
- `io.insert-koin:koin-androidx-compose:3.5.3` -> `io.insert-koin:koin-androidx-compose:4.0.4`

</Accordion>

## Version 5.41.1 - 2025-Nov-12


<Accordion title="5.41.1">

### Fixed (ALL modes)

- Fixed an issue where capturing an image in the `IdScan` and `DocumentScan` v1 modules, as well as the `SelfieScan` v1 and v2 modules, could be slow. For `IdScan` and `DocumentScan`, this could render the "Help" button unresponsive. For the `SelfieScan` module, this could cause the post-capture phase to take longer. This issue was introduced in `5.41.0`

</Accordion>

---

- Path: `release-notes/releases-cordova-sdk`
- URL: https://developer.incode.com/release-notes/releases-cordova-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-cordova-sdk.md

# Cordova SDK Release Notes

## 4.11.0

_30 October 2026_

### CurpValidation

- <Pill type="breaking" /> The `CURPValidation` module has been renamed to `CurpValidation`, the name used on the other platforms. The old name now fails with an `unknownModule` error. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- <Pill type="breaking" /> The `CurpValidation` result key has been renamed from `curpData` to `curpValidationData`. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- <Pill type="breaking" /> The `Phone`, `Email`, and `CurpValidation` modules no longer accept booleans and numbers in string form. Pass `true` and `52`, not `"true"` and `"52"`. A string value is now ignored and the native default applies, so `validationEnabled: "false"` leaves server validation on. The plugin logs a warning that names the module and the key. Omitting `validationEnabled` leaves server validation on, which is the native SDK default.
- `curpValidationData` now has the same shape on both platforms: `curp`, `valid`, `data`, `status` (`success` / `fail`), and `resultCode`. `valid` and `resultCode` are new. See [Results](/sdk-reference/cordova-results/#curpvalidationdata).
- <Pill type="breaking" /> On Android, `curpValidationData.status` is now `fail` when RENAPO rejects the CURP. Previously, it was `success` on Android and `fail` on iOS for the same CURP.
- <Pill type="breaking" /> On Android, `curpValidationData.status` is now `fail` or `success`. Previously, it could contain the native error message.
- <Pill type="breaking" /> `curpValidationData.curp` and `curpValidationData.data` are now omitted when the SDK has no value. Previously, `curp` was `""` on both platforms and `data` was `""` on iOS.
- When `validationEnabled` is `false`, `curpValidationData` has no `valid` or `data` key, because no server check ran. Its `status` is `success` when a CURP was captured, and `fail` otherwise.

### Flow Methods

- <Pill type="breaking" /> For `startOnboardingSection`, pass real booleans for `recordSessionConfig.recordSession` and `recordSessionConfig.forcePermission`. Rename `forcePermissions` to `forcePermission`. Strings such as `"true"` and `"false"` are ignored, so `recordSession: "true"` now leaves recording off without an error callback. Both fields default to `false`. `startOnboarding` keeps its previous recording configuration.
- <Pill type="breaking" /> `startOnboardingSection` requires a non-blank string `sectionTag`. A missing, null, blank, or non-string tag fails with `configError`.
- <Pill type="breaking" /> A `startOnboardingSection` start-up error now returns `{ code, message, cause }` instead of a string. `cause` is an object or `null` on both platforms. Unknown modules report `unknownModule`, other module configuration errors report `configError`, and start exceptions report `unknown`.
- <Pill type="breaking" /> Calling a second `startOnboardingSection` while a section is running fails with `sectionAlreadyRunning` on both platforms. The running section keeps its callback and results. Wait for its callback before starting another section. See the [Migration Guide](/release-notes/cordova-migration-guide/#startonboardingsection).
- <Pill type="breaking" /> Changed the cancel error of `startOnboarding`, `startOnboardingSection`, `startFlow` and `startWorkflow` on Android to `userCancelled`, the same as iOS. Previously, Android reported `onUserCancelled`. See the [Migration Guide](./cordova-migration-guide/current).
- <Pill type="breaking" /> `startFlow` now runs through the shared Incode bridge, the same as `startWorkflow`: 
    - A start-up failure calls the error callback with `{ code, message, cause }`: 
        - `activityNotPresent` without a presenting view controller.
        - `configError` when `sessionConfig` has neither a `configurationId` nor a `token`.
        - `unknown` when the flow cannot start. 
    - Previously, iOS passed a plain message string, and Android failed with an invalid-action error. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- Changed `startOnboarding`, `startOnboardingSection`, `startFlow` and `startWorkflow` to report more specific error codes. Previously, these were `unknown`. See the [Migration Guide](./cordova-migration-guide/).
    - Android:
        - `locationUnavailable` when the location is unavailable
        - `permissionsDenied` when the permission is denied.
        - `insufficientDiskSpace` and `onDeviceProcessingNotCompatible`.
    - iOS:
        - `permissionsDenied` for a denied fake-camera or audio permission.
        - `sessionCreationFailed`, `captchaNotVerified`, `sectionAlreadyRunning` and `noActiveSession`.
    - Both platforms: 
        - `videoSelfieNotCompleted`.
        - `biometricConsentNotGiven` and `biometricConsentNotReceived`.
- `startWorkflow` now reports `activityNotPresent` instead of `unknown` when there is no presenting view controller or Activity.
- Fixed flows on Android that never ended when the system destroyed the SDK screen. The error callback now receives the new `interrupted` code, the same as iOS, which reported `unknown` before. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- Fixed flows that could call the success or error callback more than once. Each flow call now ends with exactly one callback.
- Fixed module results of a previous flow showing up in the result of the next flow on iOS, and after a section on Android.

### Geolocation

- Renamed the `addGeolocation` module to `Geolocation`. The old name still works but is deprecated and logs a warning; it will be removed in a future release. `isSkippable` now accepts a boolean (`true`), which fixes iOS ignoring a boolean `isSkippable: true`. See the [Migration Guide](/release-notes/cordova-migration-guide/#migration-to-4110).
- <Pill type="breaking" /> `isSkippable` must be a real boolean, with both `Geolocation` and `addGeolocation`. The 4.10.0 string form (`isSkippable: "true"`) is now ignored, so the step is not skippable. The plugin logs a warning that names the module and the key. Pass `isSkippable: true`. This also fixes iOS ignoring a boolean `isSkippable: true`. See the [Migration Guide](/release-notes/cordova-migration-guide/#migration-to-4110).
- <Pill type="breaking" /> Changed `geoLocationData` to the shared native contract: `addressFields`, `latitude`, `longitude`, `status`, `resultCode`, and `error`. Address fields are absent instead of `""` when unknown.
- <Pill type="breaking" /> Changed `addressFields.state` on Android to hold the country name, as it already did on iOS. It previously held the region. `addressFields.city` now falls back to the region when the city is unknown, on both platforms.
- Fixed Android silently dropping an unavailable location. It is now reported in `geoLocationData` with `status: "fail"`.
- Added `latitude` and `longitude` to `geoLocationData`, and `error` on Android.
- Changed Android to report a failed non-skippable `Geolocation` step to `errorCallback` as `permissionsDenied` or `locationUnavailable` instead of `unknown`.

### Appearance


- Added the `setLogo()` method. It sets a custom logo for the SDK screens, including every UX V2 screen, such as the `addFaceAuthentication` screens. Pass the name of an image of your app: a drawable resource name on Android, and an image asset name on iOS. If the name cannot be resolved, the error callback receives `appearanceError`. On Android, add the drawable to `res/raw/keep.xml`, or the Android shrinker removes it from release builds. See `setLogo()` in the [API Reference](/sdk-reference/cordova-api-reference/#setlogo) and the [Migration Guide](/release-notes/cordova-migration-guide/#android-keep-the-setlogo-drawable).

Working with Android SDK 5.55.0 and iOS SDK 5.51.0.

## 4.10.0

_7 October 2026_

<Accordion title="4.10.0">

- <Pill type="breaking" /> If a flow configuration includes a module name the SDK doesn't recognize, the call now fails with an `unknownModule` error. Previously, the SDK skipped the module, wrote a log message, and still reported the flow as successful even though the step never ran. Before you upgrade, check your flow configurations for outdated or misspelled module names.
- Added an optional `documentSources` parameter to the `addDocumentScan` [module](/sdk-reference/cordova-modules#adddocumentscan). Pass an array of `"camera"`, `"photoUpload"`, and `"fileUpload"` to restrict the submission methods offered on the source chooser. The parameter defaults to every source the `documentType` supports.
- Added the `approve` method, which allows you to start user approval from your code instead of relying on the flow configuration.
- Changed the `approveData` result of the in-flow `approve` [module](/sdk-reference/cordova-modules#approve) to the same shape the new `approve` method returns: 
    - `status` and `id` are now `success` and `uuid`.
    - A new `error` key was added. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- Added an `integrityCompromised` error case on iOS.
- Added an optional `interviewId` parameter to the `getUserScore` method.
- The `getUserScore` method can now return two new error codes:
    - `userScoreFailed`: No score could be retrieved for the session, for example in submit-only mode or after a network error.
    - `userCancelled`: The user canceled before the score was returned. Android only. On iOS, `getUserScore` shows no UI, so the user can't cancel it.
- <Pill type="breaking" /> If an Android session produces no score, `getUserScore` now fails with `userScoreFailed`. Previously, it succeeded with an empty result. If your app treated an empty result as a valid outcome, move that handling to your error callback.
- Changed the result shape of the `getUserScore` method; it is now an object. It contains the same payload on both Android and iOS. It adds `governmentValidation`, the per-check lists, `livenessScore`, `photoQuality` and `existingUser`.
- Changed the user score values on Android to no longer include the `/100` suffix, in both `getUserScore` results and the `onUserScoreFetched` callback.
- Changed the SDK to report `warn` where it previously reported `warning` status  on iOS. Absent values are `null` instead of `""`.
- On Android, `getUserScore` now uses `fast` mode when you pass `fetchMode: 'fast'`. Previously, it always used `accurate`.
- The plugin now depends on `IncodeBridgeCommon`.
- The plugin now adds the URL schemes that the iOS SDK checks for jailbreak detection to `LSApplicationQueriesSchemes` in your app's `Info.plist`. Entries your app already has are kept. See the [Installation guide](/sdk-reference/cordova-installation/).
- <Pill type="breaking" /> The `addPhone` module has been renamed to `Phone`. See the [Migration Guide](./cordova-migration-guide/current).
- <Pill type="breaking" /> The `addEmail` module has been renamed to `Email`. See the [Migration Guide](./cordova-migration-guide/current).
- Added the `FullName` [module](/sdk-reference/cordova-modules#fullname), which collects the user's first and last name.
- Added `otpVerification` and `defaultRegionPrefix` parameters to the `Phone` module. Neither was previously available in Cordova.
- <Pill type="breaking" /> The `Email` module's `otpVerificationEnabled` parameter has been renamed to `otpVerification`, matching the name used on the other platforms. See the [Migration Guide](./cordova-migration-guide/current).
- `otpVerification` accepts a real boolean (`true`) in addition to the legacy string form (`"true"`). Omitting it leaves the native SDK setting in place.
- `phoneData`, `emailData`, and `fullNameData` now share one shape: the captured value, `status` (`success` / `fail`), and `resultCode`, with both outcome fields populated on both platforms. `resultCode` is the finer detail; both platforms report `success` and `error`, and Android additionally reports `userCancelled` and `emulatorDetected`. On iOS, a cancellation is reported at the session level, not through a module callback. `phoneData` gains `status`; all three gain `resultCode`.
- <Pill type="breaking" /> The captured value (`phone`, `email`, `name`) is now omitted when the SDK has none, instead of arriving as `""`. Check whether the key is present.
- <Pill type="breaking" /> On Android, the `setTheme()` color `positive800` has been renamed to `positive750`, matching its name on iOS. It is the same color. The old key is ignored. See the [Migration Guide](/release-notes/cordova-migration-guide/).

### Changes to standalone faceMatch()

- Added optional `matchType`, `interviewId`, and `idCategory` parameters.
- Added `secondIdConfidence` to the result.
- Renamed the `existingUser` result field to `isExistingUser`.
- Removed `status` from the result. Derive it from `isFaceMatched`.
- Changed the error callback to receive `{ code, message, cause }` instead of a bare string. Codes are `faceMatchError` and `userCancelled`, replacing `"FaceMatchFailed"` and `"onUserCancelled"`.
- Changed the result on iOS to be returned flat, matching Android. It was nested under `faceMatchData`.
- When the native SDK has no value for one of these fields, the plugin now leaves the field out of the result. Previously, it filled in a default of `0`, `false`, or `""`.
    - **Android and iOS**: `nfcVsIdConfidence`, `nfcVsSelfieConfidence`
    - **iOS only**:`isFaceMatched`, `isNameMatched`, and `existingInterviewId`
- When there's no value for one of these fields—for example, because there was nothing to compare—the plugin now leaves the field out of the result. Previously, it filled in a default.<br>To check whether a field has no value, test for `undefined` instead of comparing to the old default. For the fields listed above, a `0` or `false` is now always a real result.

| Field | Platform | Old Default |
|---|---|---|
| `confidence` | Android | `-1` |
| `nfcVsIdConfidence` | Android | `-1` |
|                     | iOS | `0` |
| `nfcVsSelfieConfidence` | Android | `-1` |
|                         | iOS | `0` |
| `isFaceMatched` | iOS | `false` |
| `isNameMatched` | iOS | `false` |
| `existingInterviewId` | iOS | `""` |

- Fixed the error callback never firing on iOS: failures arrived at the success callback as `faceMatchData: { debug: "..." }`.

### Changes to startWorkflow()

- Changed the error callback to receive `{ code, message, cause }` instead of a bare string. It previously read `"Failed to start workflow: <message>"` on Android and `"No presenting view controller available."` on iOS. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- Added the `configError` error code. `startWorkflow()` now reports it when `sessionConfig` has neither a `configurationId` nor a `token`, instead of failing with `unknown` on Android or after failed network requests on iOS.
- Changed `sessionConfig` to be optional, matching React Native. A missing value now falls back to SDK defaults instead of rejecting the call.

Working with Android SDK 5.54.0 and iOS SDK 5.50.0

</Accordion>

## 4.9.0

_16 September 2026_

<Accordion title="4.9.0">

- Added an `appleWalletMerchantID` parameter to `initializeSDK()`, for iOS only.
- Added the `combinedConsentsNotReceived` error case on iOS. A mandatory combined consent that has no readable text or checkbox ID now stops the flow instead of being accepted silently.
- Added the `storageUnavailable` error code, for Android only. The error callback of `startOnboarding()` and `startOnboardingSection()` receives it when the device cannot provide a writable images directory, so the flow now fails at start instead of losing captures later on.
- Changed `MLConsentData.status` on iOS to report the choice the user made: `true` when the consent was accepted and `false` when it was declined. It previously reported `true` whenever the submission succeeded. See the [Migration Guide](/release-notes/cordova-migration-guide/).
- On Android, the Video Selfie V2 camera steps hide the close (X) button, so `cordova.exec(resolve, reject, "Cplugin", "showCloseButton", ["true"])` no longer applies to them.
- On Android, Signature V2 reads the title and description from the new `onboard_sdk_signature_capture_title` and `onboard_sdk_signature_capture_description` string resources. V1 keeps using `onboard_sdk_signature_title` and `onboard_sdk_signature_description`.

Working with Android SDK 5.53.0 and iOS SDK 5.49.0

</Accordion>

## 4.8.0

_28 August 2026_

<Accordion title="4.8.0">

- Added the `setQuantityStrings` method, which is used to localize plural texts on Android. 
- Added optional `initializeSDK()` parameters: `sdkMode`, `externalAnalyticsEnabled`, and `externalScreenshotsEnabled`.
- Added a `sendDiagnosticsData` parameter to `initializeSDK()`, for iOS only. Set it to `false` to prevent the Incode SDK from sending diagnostic data. Defaults to `true`.
- Removed the `isExternalTokenEnabled` parameter from the `initializeSDK()` method. 
- Added the `setSdkMode`, `setLocalizationLanguage`, and `setString` methods.
- Renamed the `setFaceAuthenticationHint` parameter from `faceAuthenticationHint` to `identityId`.
- Renamed the `setUXConfig` parameter from `config` to `jsonConfig`.
- Fixed a bug on iOS where a denied or unavailable location permission during the `addGeolocation` module ended the `startOnboardingSection` call immediately, before the section itself had finished.
- Updated the Android build requirements: `compileSdk` 36, Kotlin Gradle plugin `2.2.21`, Android Gradle Plugin `8.9.1`, Gradle `8.14.5`, kotlinx-coroutines `1.9.0` and JDK 17 are now the minimums. See the [Migration Guide](/release-notes/cordova-migration-guide/).

Working with Android SDK 5.51.0 and iOS SDK 5.47.0

</Accordion>

## 4.7.0

_30 July 2026_

<Accordion title="4.7.0">

- Removed parameter `disableJailbreakDetection` from `initializeSDK()` method.
- Added `integrityCompromised` error case on iOS.
- Removed the deprecated `setCommonConfig()` method. Use `showCloseButton()` instead.

Working with Android SDK 5.50.0 and iOS SDK 5.46.0

</Accordion>

## 4.6.1

_3 July 2026_

<Accordion title="4.6.1">

- Fixed the problem where `initialize` method was freezing UI on Android. It now runs on a background thread.

Working with Android SDK 5.49.0 and iOS SDK 5.44.0

</Accordion>

## 4.6.0

_23 June 2026_

<Accordion title="4.6.0">

- Added `showCloseButton` method to show or hide the close button during onboarding. Deprecated `setCommonConfig` in favour of `showCloseButton`. `setCommonConfig` now internally calls `showCloseButton` and logs a deprecation warning; it will be removed in a future major release.
- Added `setSdkMode` method to switch between `standard`, `captureOnly`, and `submitOnly` modes at runtime without reinitializing the SDK.
- Added `setLocalizationLanguage` method to change the UI language at runtime (e.g. `en`, `es`, `pt`, `he`).
- Added `setString` method to override individual UI strings with custom copy, keyed by the current locale.
- Added `isInitialized` method that returns a boolean indicating whether the SDK has been fully initialized.
- Added optional `voiceConsentLanguage` parameter to `sessionConfig` to set the voice consent language in the VideoSelfie module. Supported values: 'en', 'es', 'pt', and 'he'. Default is English.
- Increased minimum Java version to 11.

Working with Android SDK 5.49.0 and iOS SDK 5.44.0

</Accordion>

## 4.5.0

_2 June 2026_

<Accordion title="4.5.0">

- Added `eyesClosedCheckEnabled` parameter to `addSelfieScan` module.
- Fixed `eyesClosedCheckEnabled`, `headCoverCheckEnabled`, `lensesCheckEnabled`, and `maskCheckEnabled` on iOS not properly disabling checks when set to `"false"` (was passing `false` instead of `nil` to the native SDK).
- Changed default values for `maskCheckEnabled` in `addSelfieScan` module from `false` to `true`.
- Changed default values for `faceMaskCheck`, `headCoverCheck`, `lensesCheck`, and `eyesClosedCheck` in `addFaceAuthentication` module from `false` to `true`.
- Removed the hardcoded Android compileSdkVersion from the Cordova plugin so it inherits the SDK configuration from the host Cordova application.

Working with Android SDK 5.48.0 and iOS SDK 5.44.0

</Accordion>

## 4.4.0

_12 May 2026_

<Accordion title="4.4.0">

- Added optional `sslPinningConfig` to the `initialize` method.
- Added `isSkippable` flag to the `addGeolocation` module. It allows the geolocation step to be skipped. When set to `true`, skipping or denying location permission advances the flow instead of ending the session with a permission error.
- Added `allAttemptsExhausted` flag to `addId` and `addSelfieScan` results indicating when capture or upload retries are no longer available.
- Fixed bug preventing session recording on iOS unless `forcePermissions` was explicitly provided.

Working with Android SDK 5.47.0 and iOS SDK 5.43.0

</Accordion>

## 4.3.0

_30 April 2026_

<Accordion title="4.3.0">

- Added new internal Android dependency `com.incode.sdk.hybrid-bridge`that is required to have to a successful build. In case you're experiencing issues fetching it during gradle sync phase please contact your Incode representative, as your account access might have to be updated.

Working with Android SDK 5.46.0 and iOS SDK 5.42.0

</Accordion>

## 4.2.0

_16 April 2026_

<Accordion title="4.2.0">

- Added support for Android SDK initialization without api key with e2ee url.
- Added optional `showIdTypeChooser` parameter to the `addId` module.
- Added ability to pass `SessionConfig` to `startFaceLogin()` method. This allows enabling of end-to-end encryption (E2EE) in Face Login mode on Android. The `SessionConfig` will have no effect on iOS.
- Added `startOnboarding` method.
- Added `CURPValidation` module to the `startOnboardingSection` method.
- Updated `startOnboardingSection` method to support `recordSessionConfig` and `sectionTag` parameters, both of which are mandatory.
- Changed `setupOnboardingSession`, `startWorkflow`, and `startFlow` to accept a JSON session config object instead of a plain string `configurationId`.
- Removed `autocaptureUXMode` parameter from `addId` on iOS and Android.
- Removed `enableIdSummaryScreen` parameter from `addId` on Android.
- Removed optional parameters `disableHookCheck`, `disableEmulatorDetection`, `disableRootDetection` and `disableVirtualEnvironmentDetection` from `initializeSDK` method.

Working with Android SDK 5.45.1 and iOS SDK 5.41.0

</Accordion>

## 4.1.0 

_5 March 2026_

<Accordion title="4.1.0">

- Fixed issue preventing custom V2 theme from applying when configured via JSON.
- Introduced `startFlow` method.
- Added `addEmail` module to the `startOnboardingSection` method.

Working with Android SDK 5.44.0 and iOS SDK 5.40.0

</Accordion>

## 4.0.0

_28 January 2026_

<Accordion title="4.0.0">

- Introduced `setCommonConfig` method to enable setting of a shared runtime configuration outside of SDK initialization.
- Added `setShowCloseButton` parameter in `setCommonConfig` that shows a close button when set to `true`. Defaults to `false`.
- Fixed issue in `addId` module on iOS preventing `enableFrontShownAsBackCheck` and `enableBackShownAsFrontCheck` from being configurable.
- Fixed issue in `addVideoSelfie` module on iOS and Android preventing `enableFrontShownAsBackCheck` and `enableBackShownAsFrontCheck` from being configurable.
- Added support for End-to-End Encryption (E2EE).
- Aligned module results on Android and iOS.

Working with Android SDK 5.43.0 and iOS SDK 5.39.1

</Accordion>

## 3.0.0

_19 November 2025_

<Accordion title="3.0.0">

- Introduced `startWorkflow` method.
- Removed hardcoded Artifactory credentials from Cordova SDK `build.gradle` on Android.
- Deprecated `enableIdSummaryScreen` parameter from `addId` on iOS. Screen will not appear when using v2 UI. IdSummaryScreen will be removed in future update.
- Updated setTheme method to also configure theme on Android platform for V2 UX.
- Fixed error handling for IncodeException errors on Android.

Working with Android SDK 5.41.1 and iOS SDK 5.38.0

</Accordion>

---

- Path: `release-notes/releases-flutter-sdk`
- URL: https://developer.incode.com/release-notes/releases-flutter-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-flutter-sdk.md

# Flutter SDK Release Notes

## 4.23.0
_30 October 2026_

### CurpValidation

- Added optional `validationEnabled` parameter to the `CURP` module ([`addCurpValidation`](/sdk-reference/flutter-modules/#curp)). When set to to `false`, a CURP is captured in a valid format without a RENAPO check, `valid` and `data` are `null`, and `status` is `success` when a CURP in a valid format was captured. Omit this parameter to keep the native SDK default, which is `true`.
- <Pill type="breaking" /> Added `status` and `resultCode` to `CurpValidationResult`, as on the `Phone`, `Email`, and `FullName` results. `status` follows `valid`: it is `success` only when RENAPO accepted the CURP. The constructor takes them as required named parameters. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- <Pill type="breaking" /> On Android: `onCurpValidationCompleted` is now called once per module, with the final result, as on iOS. Previously it was also called for each failed attempt before the last one. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- `CurpValidationResult` now has the same shape on both platforms. `curp`, `valid`, and `data` are `null` when the SDK has no value, and every level of `data` is a `Map<String, dynamic>`.
- Fixed `onCurpValidationCompleted` failing to parse a result without `data`, for example after a failed validation request on Android.

### Flow methods

- <Pill type="breaking" /> `onError` of `startOnboarding`, `startOnboardingSection`, `startFlow`, and `startFlowFromDeepLink` now receives an `IncodeSdkFlowError` code, such as `permissionsDenied`, instead of the native error message. Convert it with `error.toIncodeSdkFlowError()`. `startWorkflow` already has this functionality. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- <Pill type="breaking" /> When you do not pass `onUserCancelled`, a cancelled flow now calls `onError` with `userCancelled`. Previously, no callback was called.
- <Pill type="breaking" /> A flow that the system interrupted now calls `onError` with the new `interrupted` code on Android and iOS. Previously, the flow never finished on Android and reported `unknown` on iOS.
- <Pill type="breaking" /> `IncodeSdkFlowError` has eleven new values:
   - iOS: `sessionCreationFailed`, `captchaNotVerified`, `noActiveSession`
   - Android: `insufficientDiskSpace`, `onDeviceProcessingNotCompatible`
   - Both: `videoSelfieNotCompleted`, `interrupted`, `biometricConsentNotGiven`, `biometricConsentNotReceived`, `sectionAlreadyRunning`, and `activityNotPresent`.

   A `switch` over `IncodeSdkFlowError` without a `default` no longer compiles until it handles them.
- <Pill type="breaking" /> Some flow errors now report a more specific code where `unknown` was reported before: 
   - `videoSelfieNotCompleted`, `locationUnavailable`, `permissionsDenied`, `biometricConsentNotGiven` and `biometricConsentNotReceived`
   - iOS: `sessionCreationFailed`, `captchaNotVerified` and `noActiveSession`
   - Android: `insufficientDiskSpace` and `onDeviceProcessingNotCompatible`. 

   On Android, an unavailable location now reports `locationUnavailable` or `permissionsDenied` instead of `onGeolocationUnavailable`.
- <Pill type="breaking" /> `startFlow` now reports start-up failures through `onError` and ends the flow:
   - `activityNotPresent` without a host Activity or view controller
   - `configError` when `sessionConfig` has neither a `configurationId` nor a `token`

   Previously, Android started the flow from the application context, and iOS returned `Error: No rootViewController found` without ending the flow.
- <Pill type="breaking" /> Renamed `startNewOnboardingSection` to `startOnboardingSection`, and its `flowTag` parameter to `sectionTag`. `onOnboardingSectionCompleted` still receives the tag. See the [Migration Guide](/release-notes/flutter-migration-guide/#startonboardingsection).
- <Pill type="breaking" /> `startOnboardingSection` now requires a `sectionTag` that is not blank. An empty or whitespace-only `sectionTag` calls `onError` with `configError`, and the section does not start. Previously, Android never finished the call for an empty tag, and both platforms started a section with a whitespace-only tag.
- <Pill type="breaking" /> A `startOnboardingSection` call made while another section runs now calls `onError` with `sectionAlreadyRunning` on Android and iOS, and the running section continues. Previously, the second call took over the event stream, so the running section stopped reporting results and never finished. Start the next section from `onSuccess`, not from `onOnboardingSectionCompleted`.
- <Pill type="breaking" /> `startOnboardingSection` now reports start-up failures through `onError` and ends the call the same way on Android and iOS: 
   - `activityNotPresent` without a host Activity or view controller
   - `noActiveSession` without an onboarding session
   - `unknownModule` for a module this SDK version does not support
   - `configError` for an invalid `flowConfig` or `recordSessionConfig`. 

   Previously, Android started the section from the application context and returned an invalid configuration as a message that never reached `onError`, and iOS reported every configuration error as `unknownModule`.
- `startOnboardingSection` and `startFlow` now run through the shared Incode bridge, so they start and fail the same way on Android and iOS. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- `startWorkflow` now reports `activityNotPresent` instead of `unknown` when there is no host Activity or view controller.
- Added the `videoSelfieNotCompleted`, `interrupted`, `biometricConsentNotGiven`, `biometricConsentNotReceived`, `sessionCreationFailed` (iOS only), `captchaNotVerified` (iOS only), `sectionAlreadyRunning`, `noActiveSession` (iOS only; on Android `startOnboardingSection` only), `insufficientDiskSpace` (Android only), `onDeviceProcessingNotCompatible` (Android only) and `activityNotPresent` codes to `IncodeSdkFlowError`.
- Added an optional `onSuccess` callback to `startOnboardingSection`. It is called once with the `sectionTag` when the section finished, and you can start the next section from it. After a cancel, call `setupOnboardingSession` again before you start the next section.
- Deprecated `onOnboardingSectionCompleted` of `startOnboardingSection`. Use `onSuccess`, which receives the `sectionTag`. `onOnboardingSectionCompleted` still works: it is called with the same tag just before `onSuccess`, and you can still start the next section from it.
- Fixed flows that never finished: a cancelled flow, a finished section, and an Android flow that the system interrupted (Android SDK `onInterrupted`) now end the flow with exactly one final callback. This applies to `startOnboarding`, `startOnboardingSection`, `startFlow`, `startFlowFromDeepLink`, and `startWorkflow`.

### Geolocation

- <Pill type="breaking" /> Changed `GeoLocationResult` to the shared native contract: the address moved to `addressFields`, and `latitude`, `longitude`, `status`, and `resultCode` were added. Address fields are `null` instead of `""` when unknown. The top-level `city`, `colony`, `postalCode`, `state`, and `street` fields are removed; read them from `addressFields`. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- <Pill type="breaking" /> Changed `state` on Android to hold the country name, as it already did on iOS. It previously held the region. `city` now falls back to the region when the city is unknown on both platforms.
- <Pill type="breaking" /> Fixed a bug on Android where an unavailable location raised an `onGeolocationUnavailable` error on the event stream, which ended the `startOnboarding` / `startOnboardingSection` call even when the native SDK continued the flow. It is now delivered to `onGeolocationCompleted` with `status` `fail`, as on iOS.
- Changed `GeoLocationResult.error` to be reported on Android too, with the actual cause instead of a hardcoded `permissionsDenied`.
- Changed `onError` on Android to report `permissionsDenied` or `locationUnavailable` for a non-skippable `Geolocation` failure, instead of `unknown`.
- Changed `addGeolocation` to send `isSkippable` only when you set it, so the native SDK default applies otherwise.


### Enhancements

- Added the [`setLogo`](/sdk-reference/flutter-api-reference/#setlogo) method. It sets a custom logo for the SDK screens, including every UX V2 screen. Pass the name of an image of your app: a drawable resource name on Android, and an image asset name on iOS. If the name cannot be resolved, `onError` is called with `appearanceError`. On Android, add the drawable to `res/raw/keep.xml` or the Android shrinker removes it from release builds.
- <Pill type="breaking" /> On iOS: `startFaceLogin` now ignores a call made while another Face Login is in progress. Neither `onSuccess` nor `onError` is called for the ignored call. Wait for the current Face Login to finish before you start another. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4230).
- On iOS: the local 1:1 `startFaceLogin` now shows "User not found" for a face that does not match the enrolled user. The result is delivered when the user taps **Continue**. The result already reported `faceMatched == false`. Previously, the success screen was shown.

Working with Android SDK 5.55.0 and iOS SDK 5.51.0

## 4.22.0
_7 October 2026_

<Accordion title="4.22.0">



### Enhancements

- Added the `configError` code to `IncodeSdkFlowError`. `startWorkflow` reports it before the Workflow starts when `sessionConfig` has neither a `configurationId` nor a `token`. Previously Android reported a generic SDK error, and iOS failed only after making network requests.
- Added optional `interviewId` parameter to the `getUserScore` method.
- Added `userScoreFailed` and `userCancelled` error codes to `IncodeSdkFlowError` for the `getUserScore` method.
- Added additional fields to the `UserScoreResult` class and turned its sections into structured objects. See [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4220) and [Results](/sdk-reference/flutter-results/#getuserscore) for more details.
- Added `approve` method to programmatically initiate approval of the user.
- Added `error` to `ApprovalResult`. It reports the module-level error from the native SDK using `IncodeSdkFlowError` values.
- Added optional `documentSources` parameter to the `DocumentScan` module. It takes a `List<DocumentSource>` (`camera`, `photoUpload`, `fileUpload`) and defines which capture sources are offered to the user. It applies to both the V1 and V2 UI. `fileUpload` is ignored on both Android and iOS for document types that don't support PDF uploads (`medicalDoc`); if it was the only source, the native SDK default applies.
- Added optional `mergeSessionRecordings` to `OnboardingSessionConfiguration`. It is only honoured by `startWorkflow()` and ignored by the other entry points that take an `OnboardingSessionConfiguration`. Omit it to keep current behaviour.

- <Pill type="breaking" /> `startWorkflow`'s `onError` now receives an `IncodeSdkFlowError` code, such as `permissionsDenied`, instead of the native error message. Convert it with `error.toIncodeSdkFlowError()`. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- <Pill type="breaking" /> The `otpVerificationEnabled` parameter on the `Phone` and `Email` modules is now named `otpVerification`, matching the native SDK. It affects `addPhone()`, `addEmail()`, `PhoneModule`, and `EmailModule`. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- <Pill type="breaking" /> `PhoneNumberResult.phone` is now nullable (`String?`). It was non-nullable, but the value is absent when the SDK captured no number, for example when the user cancelled, which would have thrown at runtime. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- <Pill type="breaking" /> On Android: user score values no longer include the `/100` suffix, in both `getUserScore` results and the `onUserScoreFetched` callback. A score whose status was `manual` previously came through as a localized phrase rather than a number.
- <Pill type="breaking" /> On Android: `getUserScore`'s `fetchMode` now defaults to `accurate`, previously `fast`.
- <Pill type="breaking" /> On Android: `getUserScore` now reports `userScoreFailed` when a session produced no score, instead of completing with an empty result.
- <Pill type="breaking" /> On iOS: the plugin now depends on `IncodeBridgeCommon`, which requires a new spec repository source in your Podfile.
- <Pill type="breaking" /> On iOS: `getUserScore`'s `onError` now delivers `IncodeSdkFlowError` codes instead of the native SDK's error strings.
- <Pill type="breaking" /> Renamed `faceMatch()`'s `faceMatchType` parameter to `matchType`. The `FaceMatch` module's flow-config parameter is still `faceMatchType`.
- <Pill type="breaking" /> Renamed `OnboardingSessionConfiguration`'s `userRegion` parameter to `region`, and `onboardingValidationModules` to `validationModules`. Affects every entry point taking an `OnboardingSessionConfiguration`. `region` no longer defaults to `ALL` when omitted; pass it explicitly if you relied on that. `region` remains Android only. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- <Pill type="breaking" /> Changed `faceMatch()`'s `onError` signature from `Function(String error)` to `Function(String code, String message, PlatformException? cause)`, matching `setQuantityStrings`. Codes are `faceMatchError` and, on Android, `userCancelled`, replacing the previous `"UserCancelled"` string. A cancellation reaches `onError` as `userCancelled` when no `onUserCancelled` callback is supplied.
- <Pill type="breaking" /> Changed `faceMatch()`'s `confidence`, `nfcVsIdConfidence` and `nfcVsSelfieConfidence` on Android to return `null` when there was nothing to compare, instead of `-1`. Check for `null` instead of comparing to `-1`.
- `Phone`, `Email`, and `FullName` results now share one shape on both platforms: the captured value, plus `status` and `resultCode` on `PhoneNumberResult`, `AddEmailResult` and `AddFullNameResult`. Both are non-nullable, so every result carries them on both platforms. `status` (`success` / `fail`) is the portable outcome; `resultCode` is the finer detail, reporting `success` and `error` on both platforms and additionally `userCancelled` and `emulatorDetected` on Android, since on iOS a cancellation is reported at the session level rather than through a module callback.
- `ApprovalResult.uuid` and `ApprovalResult.customerToken` are now `null` on iOS when the user was not approved. Previously they were reported as empty strings. See the [Migration Guide](./flutter-migration-guide).
- `PhoneModule.defaultRegionPrefix` is now validated consistently on both platforms. Values outside `1`-`9999` are ignored and the device's own region prefix is used, matching the documented behavior. Previously an out-of-range value was ignored on Android but passed through on iOS.
- Deprecated the `showDocumentProviderOptions` parameter of the `DocumentScan` module. It maps to the deprecated native chooser flags, is not applied in V2, and is ignored when `documentSources` is provided. Use `documentSources` instead. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- Enhanced jailbreak detection on iOS. Add the URL schemes it queries to `LSApplicationQueriesSchemes` in your app's `Info.plist`. See [Installation](/sdk-reference/flutter-installation/).

### Fixes

- <Pill type="breaking" /> A flow configuration naming an unrecognized module now reports `unknownModule` through `onError` instead of being skipped. Previously, Android silently dropped the module with no log at all; iOS logged it with `print`, which does not reach device logs in release. Either way, the flow ran without the step and still reported success, so a stale module name was invisible. See the [Migration Guide](/release-notes/flutter-migration-guide/).
- Fixed a crash on iOS when a user score contained a `warn` status, or a status the SDK left unset.
- Fixed `faceMatch()`'s `FaceMatchResult.isFaceMatched`, `isNameMatched`, `nfcVsIdConfidence`, `nfcVsSelfieConfidence` and `secondIdConfidence` on iOS returning `false`/`0` when there was no data to compare. They now return `null`, so `false`/`0` means a real result. No action needed unless you need to tell the two apart.

Working with Android SDK 5.54.0 and iOS SDK 5.50.0

</Accordion>



## 4.21.0 
_16 September 2026_

<Accordion title="4.21.0">

- Added optional `minVideoLengthRequired` parameter to the `VideoSelfie` module.
- Added `locationUnavailable` to `IncodeSdkFlowError`.
- Added `storageUnavailable` to `IncodeSdkFlowError`. Android only. Flow APIs report it when the device cannot provide a writable images directory, so the flow now fails at start instead of losing captures later on.
- On Android, the SDK reports the user-cancel tracking event as `userCanceled` instead of `userCancelled`. The `onUserCancelled` callback is unchanged. See the [Migration Guide](./flutter-migration-guide).
- On Android, the Video Selfie V2 camera steps hide the close (X) button, so `showCloseButton` no longer applies to them. Other screens are unaffected.
- On Android, Signature V2 reads its title and description from the new `onboard_sdk_signature_capture_title` and `onboard_sdk_signature_capture_description` string resources. See the [Migration Guide](./flutter-migration-guide).
- Fixed a bug on iOS where a skipped, denied or unavailable location during the `Geolocation` module ended the `startOnboarding` / `startOnboardingSection` call immediately.

Working with Android SDK 5.53.0 and iOS SDK 5.49.0

</Accordion>

## 4.20.0
_27 August 2026_

<Accordion title="4.20.0">

- Added a `setQuantityStrings` method, used to localize plural texts on Android.
- `setTheme` and `setUXConfig` now take a JSON `String` instead of `Map<String, dynamic>`. Encode maps with `jsonEncode` before calling. See the [Migration Guide](./flutter-migration-guide).
- Added an optional `sdkMode` parameter to `init()`. It accepts the same values as `setSdkMode`, so you can set the mode during initialization.
- Added a `sendDiagnosticsData` parameter to `init()`, for iOS only. Set to `false` to prevent the Incode SDK from sending diagnostic data. If omitted, the native SDK default is used (`true`). Ignored on Android.
- Added `configError` and `invalidInitParams` codes to `IncodeSdkInitError`. Initialize failures now also include a human-readable `message`; `onError` still receives the error **code**.
- Removed unused `waitForTutorials` parameter from `init()`. Tutorial behavior is configured per module with `showTutorials`; see [Modules](./flutter-modules).
- Updated the Android build requirements: `compileSdk` 36, Kotlin Gradle plugin `2.2.21`, Android Gradle Plugin `8.9.1`, and Gradle `8.14.5` are now the minimums. See the [Migration Guide](./flutter-migration-guide).

Working with Android SDK 5.51.0 and iOS SDK 5.47.0

</Accordion>

## 4.19.0
_29 July 2026_

<Accordion title="4.19.0">

- Added support for Dart 3.x. The plugin's SDK constraint was widened to `>=2.12.0 <4.0.0`.
- Added optional `voiceConsentLanguage` parameter to `OnboardingSessionConfiguration` to set the voice consent language in the `VideoSelfie` module. Supported values: 'en', 'es', 'pt', and 'he'. Default is English.
- Added SNA (Silent Network Authentication) to `PhoneModule` (only available via Flows integration and on a new variant `-sna`).
- Replaced `jailbreakDetected` error code with `integrityCompromised` in `IncodeSdkFlowError` to indicate that the device integrity has been compromised (e.g., jail-broken or rooted).
- Removed `disableJailbreakDetection` parameter from `init()` method.

Working with Android SDK 5.50.0 and iOS SDK 5.46.0

</Accordion>

## 4.18.0
_23 June 2026_

<Accordion title="4.18.0">

- Added `isInitialized` method that returns a boolean indicating whether the SDK has been fully initialized.
- Deprecated `FaceAuthMode.server` in `startFaceLogin`. Migrate to the `FaceAuthentication` module instead. `FaceAuthMode.local` and `startFaceLogin()` with local mode remain fully supported.
- Deprecated `IncodeSdkFlowError.badEnvDetected`. It is no longer reported: the native SDK now terminates the process when a compromised device environment is detected, so the error can never be delivered via `onError`. It will be removed in a future release.
- Fixed an Android ANR ("Input dispatching timed out" / `FocusEvent`) that could occur at startup. SDK setup calls (`initialize`, `setSdkMode`, `setTheme`, `setUXConfig`, etc.) now run off the platform main thread, with results marshaled back to it.

Working with Android SDK 5.49.0 and iOS SDK 5.44.0

</Accordion>

## 4.17.0
_28 May 2026_

<Accordion title="4.17.0">

- Updated the default values of the `faceMaskCheck`, `eyesClosedCheck`, `headCoverCheck` and `lensesCheck` parameters to `true` in the `FaceAuthentication` module.
- Updated the default values of the `faceMaskCheck` and `lensesCheck` parameters to `true` in the `SelfieScan` module.
- Fixed a bug on iOS where the `MLConsent` module screen was not shown when `type` was not provided. The `type` parameter of `MLConsent` module is now required.
- Fixed: `showCloseButton(allowUserToCancel: false)` now correctly hides the close button on Android. Previously the button was always shown regardless of the parameter value.

Working with Android SDK 5.48.0 and iOS SDK 5.44.0

</Accordion>

## 4.16.0
_12 May 2026_

<Accordion title="4.16.0">

- Added `isSkippable` flag to the `Geolocation` module. It allows the geolocation step to be skipped. When set to `true`, skipping or denying location permission advances the flow instead of ending the session with a permission error.
- Added `allAttemptsExhausted` flag to `IdScanResult` and `SelfieScanResult` indicating when capture or upload retries are no longer available.
- Added per-attempt `IdScan` callbacks `onIdFrontAttemptCompleted` / `onIdBackAttemptCompleted`. They fire after every individual capture attempt, including intermediate failures. The terminal attempt is signaled when `IdScanResult.allAttemptsExhausted` is `true` or when the attempt succeeds.
- Added per-attempt `SelfieScan` callback `onSelfieScanAttemptCompleted`. It fires after every individual selfie capture attempt, including intermediate failures. The terminal attempt is signaled when `SelfieScanResult.allAttemptsExhausted` is `true` or when the attempt succeeds.

Working with Android SDK 5.47.0 and iOS SDK 5.43.0

</Accordion>

## 4.15.0
_29 April 2026_

<Accordion title="4.15.0">

- Added `deleteLocalUserData` method.
- Added new internal Android dependency com.incode.sdk.hybrid-bridge that is required to have to a successful build. In case you're experiencing issues fetching it during gradle sync phase please contact your Incode representative, as your account access might have to be updated.
- Fixed UIScene lifecycle crash on iOS.

Working with Android SDK 5.46.0 and iOS SDK 5.42.0

</Accordion>

## 4.14.0
_7 April 2026_

<Accordion title="4.14.0">

- Added support for Android SDK initialization without api key and with e2ee url.
- <Pill type="breaking" /> Added parameter `showIdTypeChooser` to `IDScan` module. See the [Migration Guide](/release-notes/flutter-migration-guide/#migration-to-4140). ID Document Chooser visibility is now controlled solely by the `showIdTypeChooser` parameter in `addIdScan`. Previously, setting `idType` implicitly hid the chooser. The configured `idType` is now only used as a pre-selection when the chooser is disabled `(showIdTypeChooser == false)`
- Added new parameter `e2eeEncryptionEnabled` for `startFaceLogin` method that enables End-to-End Encryption (E2EE) on Android.
- Introduced `startFaceMatch` method to perform a face match without showing UI.
- Fixed a bug caused by `flowTag` having been an optional parameter of `startNewOnboardingSection`. It is now required to provide a `flowTag` to use `startNewOnboardingSection`.
- Removed parameters `disableHookDetection`, `disableEmulatorDetection`, `disableRootDetection`, `disableVirtualEnvironmentDetection` from `init` method.
- Removed `simulatorDetected`, `rootDetected`, `hookDetected`, `virtualEnvDetected` from `IncodeSdkFlowError`.

Working with Android SDK 5.45.1 and iOS SDK 5.41.0

</Accordion>

## 4.13.0
_26 February 2026_

<Accordion title="4.13.0">

- Added `enableFrontShownAsBackCheck` and `enableBackShownAsFrontCheck` optional parameters to the `VideoSelfie` module.
- Deprecated `autocaptureUxMode` parameter from the `IdScan` module.
- Deprecated `enableIdSummaryScreen` parameter from the `ProcessId` module.
- Fixed issue preventing custom V2 theme from applying when configured via JSON.

Working with Android SDK 5.44.0 and iOS SDK 5.40.0

</Accordion>

## 4.12.0
_6 February 2026_

<Accordion title="4.12.0">

- Added new Flutter SDK variant '-l', so now Flutter SDK is delivered in multiple variants:
  4.12.0: Standard variant
  4.12.0-vc: Includes streaming
  4.12.0-nfc: Includes NFC
  4.12.0-l: Includes local face recognition models
- Removed the `enableRotationOnRetakeScreen` parameter from the `IdScan` module. Captured documents are now always displayed in a vertical orientation on the Review Screen.
- Renamed the `showRetakeScreen` parameter to `showRetakeScreenForManualCapture` in the `IdScan` module.
- Renamed the `showAutoCaptureRetakeScreen` parameter to `showRetakeScreenForAutoCapture` in the `IdScan` module.

Working with Android SDK 5.43.0 and iOS SDK 5.39.1

</Accordion>

## 4.11.0
_2 December 2025_

<Accordion title="4.11.0">

- Added optional `sslPinningEnabled` and `forceSSLPinning` parameters to the `init` method to support SSL pinning configuration.
- Added `title` and `description` params to the `Signature` module.
- Fixed error handling on Android.

Working with Android SDK 5.41.1 and iOS SDK 5.38.0

</Accordion>

---

- Path: `release-notes/releases-ios-sdk`
- URL: https://developer.incode.com/release-notes/releases-ios-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-ios-sdk.md

# iOS SDK Release Notes



## 5.51.0

_20 October 2026_
### Features & Enhancements

- <Pill type="breaking" /> The `startFaceLogin` requirement of the `IncdOnboardingManagerAPI` protocol now includes `localLivenessCheck`, `localAgeEstimation`, and `uxMode` parameters, so calls made through the protocol, and types that implement it, must be updated. Calls made directly on `IncdOnboardingManager.shared` compile unchanged. See the [Migration Guide](/release-notes/migration_guide/).
- Added an optional `uxMode` parameter of type `FaceLoginUXMode` to `startFaceLogin` in the [Face Login](/features-and-modules/user_guide_face_login/) module:
  - `.standard`: Keeps the current experience. This is the default.
  - `.fast`: Shows the camera right away, skips the "Get ready" step, and accepts a face that is farther away, off-center, or at a greater angle than `.standard` allows.
  - `.ultraFast`: Shows no capture screen or tutorial, only a small progress indicator at the top of your app's UI. Captures the same way as `.fast`. If no face is captured within a few seconds, the login ends with `SelfieScanError.userNotFound`. Requires camera permission to already be granted; otherwise, it behaves like `.fast`.
- Added optional `localLivenessCheck` (default `true`) and `localAgeEstimation` (default `false`) parameters to `startFaceLogin`. Both run on device in the `-l` variant. The estimated age is returned in `FaceLoginResult.estimatedAge`.
- If you call `startFaceLogin` while another Face Login is in progress, the SDK now ignores the new call and never calls its completion handler.
- Added `IncdTheme.loadUIConfigFromJson(_:)`, which applies the UX v2 theme and UX configuration from a single JSON document with `theme` and `ux` objects.
- Every `moduleOpened` analytics event now includes `moduleVersion`: `1` for UX v1 and `2` for UX v2. Modules with only one UI version report that version, regardless of the flow's UX version setting.
- Reduced image sizes for [ID Capture](/sdk-reference/module-id-scan/), [Selfie](/sdk-reference/module-selfie/), and [Face Authentication](/sdk-reference/module-face-authentication/) when the `high_res_capture` experiment is enabled. Captures are now encoded as JPEG at quality 90 instead of 100. Capture is unchanged in these modules without the experiment, and in all other modules.
- SDK variants whose vendored dependencies all support arm64e now include an arm64e device slice. Other variants remain arm64 only.

### Fixes

- Fixed local 1:1 Face Login showing the success screen when the face does not match the enrolled user. Your app already received `success == false`. The screen now shows "User not found", and the completion is called when the user taps **Continue**. In `.ultraFast` mode, the progress indicator shows the failure, and the completion is called immediately.
- Fixed the `startFaceLogin` completion being called twice when the user taps **Continue** twice quickly on the error screen, or cancels while the face is being checked.
- Fixed the `startFaceLogin` completion not being called when the user cancels from the Face Login error screen. It is now called with `SelfieScanError.userCancelled`.
- Fixed `syncFaceLoginAttempts` never calling its completion when a stored login attempt had no frame. Every later call then returned `IncdLoginError.loginSyncInProgress` until the app restarted. Attempts without a frame cannot be uploaded, so they are now deleted, and the completion reports `false`.
- Fixed Face Login not sending liveness statistics in SDK variants without the `-l` (Login) suffix. Statistics are now sent in all variants unless `logAuthenticationEnabled` is `false`.
- Fixed the SDK ending the session mid-flow for organizations that use a LIMITED access token. The back end refuses requests for personal data with a `403` and status `4091`, and the SDK treated every `403` as a revoked API key. Now only that request fails, and the session continues. A `403` for invalid credentials still reports a revoked API key. In UX v2 phone and email modules, the screen explains that verification is unavailable. **Continue** advances to the next module. The module returns the entered phone number or email address with `error` set to `.unknown`. This distinguishes an entered but unverified contact from a verified one. UX v1 is unchanged.
- Fixed sessions failing to start when end-to-end encryption (E2EE) is required. The session start request is now encrypted too.
- Fixed issues with error handling when E2EE is enabled.
- Fixed UX version selection issues:
  - After a flow or standalone Face Login completes, the SDK now restores the client's experiment selection before the next flow starts.
  - A UX v2 selection made in Dashboard now applies before ID Capture starts, and it persists after a network disconnection.
  - An ignored concurrent `startFaceLogin` call no longer changes the UX of the login in progress.
- Fixed headless `faceMatch(matchType:idCategory:interviewId:completion:)` returning `IncdError.unknown` after a successful match when `matchType` is `.nfcSelfie` or `idCategory` is `.secondary`. The result now sets `error` only when the face match request fails.
- Fixed the misspelled `isSDKEntierlyInitialized` property name. Use the new `isSDKEntirelyInitialized` property instead. The old property is deprecated but still works the same way.
- Fixed the UX v2 ID Capture result card showing a sharp image of the ID when Age Assurance is enabled. The image is now blurred, as in UX v1, and the processing and uploading steps are titled "Calculating your age…".
- Fixed capture-only [Selfie](/sdk-reference/module-selfie/) not reporting `videoRecordingFailed` when the recorded video could not be delivered.
- Fixed [Video Selfie](/sdk-reference/module-video-selfie/) (v1) recording errors exposing the system message, which could include the recording's file name. Failures now report `VideoSelfieError.internalError` with the error domain and code.
- Fixed a crash during face and ID model initialization while the app was in the background.
- Fixed VoiceOver support on the UX v2 [Combined Consent](/sdk-reference/module-combined-consent/) screen. The title is now announced as a heading and gets focus when the screen loads. Each consent checkbox reads its full text, announces when it is selected, toggles on double-tap, and offers each link in its text as a VoiceOver action.


## 5.50.0

_28 September 2026_

### Features & Enhancements

- The ID capture step (`idScan(enabled:validateId:...)`) in the UX V2 [Video Selfie](/sdk-reference/module-video-selfie/) module now detects the document's orientation and reshapes its guideline overlay to match. It previously only showed a vertical guide.

### Fixes

- Fixed Document Scan (V2) source-selection button being unreachable by VoiceOver, which left VoiceOver users unable to open the document source options.
- Fixed an issue in Face Capture V1 that prevented automatic selfie capture on iPhone 17 running iOS 27.
- Enhanced jailbreak detection. Add the URL schemes listed in the [Setup guide](/sdk-reference/setup-ios/#url-schemes) to `LSApplicationQueriesSchemes` in your app's `Info.plist`.
- Fixed Dashboard reporting only the native SDK version for hybrid integrations. This surfaced in the Device Details section on the [Other tab in single session view](/dashboard-platform-administration/single-session-view/#other). When the SDK runs inside the Flutter, React Native, or Cordova wrapper, the reported SDK version now includes the wrapper name and version (for example `5.50.0-s | Flutter 4.20.0`). This matches what is already reported to analytics. Device identity is unaffected: the device fingerprint hash is still derived from the vendor identifier.
- Fixed the Biometric Consent screen ignoring the integrator theme: the background, card, subtitle, consent copy, link color, spinner and the disabled continue button now follow `IncdTheme`, so the screen stays legible on a dark theme. The unchecked checkbox is tinted from the theme instead of using fixed dark artwork.
- The [ID OCR](/sdk-reference/module-id-info/) module now explains the required-field asterisk. When the screen is editable, a subtitle reads "All fields marked with * are required" under the title. Additionally, the marker moved from a prefix to a suffix, so labels read `Full name *`. Gender is not marked, since it is not required. In view-only mode, the subtitle and the markers are hidden.
- VoiceOver now announces the ID OCR gender options as a single group, and each option reports its selection state and its position: for example, "Male, option, 1 of 2".
- Fixed the Video Selfie recording being uploaded without a content type, so the stored video was typed as `binary/octet-stream` instead of `video/mp4`. The upload request also no longer sends the local file path to storage.
- Fixed an [ID Capture](/sdk-reference/module-id-scan/) crash by synchronizing video stream buffer access and properly stopping the capture pipeline when users cancel.
- Fixed missing heading accessibility semantics on titles in V2 screens.
- Fixed `IncdTheme.loadJsonTheme` and `IncdUXConfig.loadUXConfig` silently ignoring a JSON they could not apply. The reason is now reported to the device console, including when no key was recognized and every value fell back to its default.
- Fixed an intermittent Video Selfie upload error that could leave successful sessions without a video on Dashboard. Connectivity failures are now detected by error code rather than the device's localized error text. A slow but progressing upload is no longer cut off by a fixed 60-second limit. Transient failures are retried automatically with a backoff before the no-internet screen appears.
- Fixed VoiceOver on the V2 [Phone](/sdk-reference/module-phone/) error state. The number field no longer merges with its error message into a single element once an error is shown, so VoiceOver users can still type into it. A failed Continue now moves the VoiceOver cursor onto the field and reads the error instead of only announcing the button turning disabled.
- Fixed the V2 [Selfie](/sdk-reference/module-selfie/), [Face Authentication](/sdk-reference/module-face-authentication/), and [Face Login](/features-and-modules/user_guide_face_login/) screens on iPad in landscape and resized windows. The camera preview now updates when the orientation changes. Landscape support applies on iPadOS 18 and later and follows the host app's supported orientations; on earlier versions, the screens remain portrait and only the resizing fix applies.


## 5.49.0

_8 September 2026_

<Accordion title="5.49.0">

### Features & Enhancements

* Added Dashboard-configured Apple Wallet ID verification as an ID Scan chooser option. Configure `IncdOnboardingManager.shared.appleWalletMerchantID` before starting onboarding.
* The SDK now reports the No Internet screen as its own analytics screen. Front ID Capture reports `idCapture.frontCaptureError.noConnection`. Face Capture reports `faceCapture.genericErrors.noConnection`. The SDK no longer reports `faceCapture.genericErrors`. The back ID side is unchanged.
* Added a UX V2 version of the Video Selfie module.
* Changed the validation order in the Forms & Data Entry module. The Continue button validates the whole form before it submits.
* Changed the validation order in the Phone and Email modules. The Continue button starts enabled and validates the input when the user taps it.

### Fixes

* Fixed Face Capture and Face Authentication on iOS 27 when Deepsight is configured.
* Fixed NFC Scan sending the user back through the data confirmation screen after every failed read. A retry now returns there only when the chip rejects the document number, birth date or expiry date. An interrupted read goes straight back to scanning. The phone moved away from the chip, the user dismissed the system NFC sheet, or the session timed out.
* Fixed a flow starting its first module after its configuration failed to load. The flow had already ended with `IncdFlowError.flowNotFetched` and been dismissed, so the module ran outside it.
* Fixed Combined Consents accepting a mandatory consent that has no readable text or no checkbox id, which let the user continue without seeing or accepting it. Blank text counts the same as missing text. The module now ends and the flow stops with the new `IncdFlowError.combinedConsentsNotReceived`. An optional consent that cannot be shown is still left out, and the SDK logs it.
* In the new ID capture experience, the help screen's capture-mode button can now also switch back from manual to automatic capture; previously it only offered switching from automatic to manual.
* Fixed the ML Consent module reporting the consent as granted when the user declined it. `MachineLearningConsentResult.status` now carries the choice the user made. It is `true` when the consent was accepted, `false` when it was declined, and `nil` when the choice could not be recorded, with `error` set. The consent stays optional and the flow continues either way.
* Combined Consents requested without a configured `language` now default to the SDK's language (the localization override, then the session language, then the device language) as a two-letter code, instead of always English.
* Realigned the V2 color tokens with the design system: corrected shades in the input and checkbox states, the focused input border now uses the focus color, and the secondary button follows its outline-only design. `neutralLight` / `neutralDark` keep working as aliases of `gray0` / `gray1000`.
* Fixed the UX V2 checkbox customization: the V2 checkbox is now drawn from the theme and follows `brand500`.
* The mandatory biometric consent screen now has a UX V2 version, shown when the flow runs in V2, so its checkbox and styling match the following modules.


</Accordion>

## 5.48.0

_19 August 2026_

<Accordion title="5.48.0">

### Features & Enhancements

* Added an `errorTriggered` analytics event for the ID Capture and Face Capture modules.
* Finalized the Namirial QES "Review and sign" screen: consent checkboxes render exactly as returned by Namirial, and a new **Certificate application form** link opens the personalized application form.

### Fixes

* Preserved the passport tutorial when Passport is selected with US Smart Capture.
* Fixed US Smart Capture barcode uploads in Workflows so ID validation follows the server-defined workflow graph.
* Fixed valid Brazilian CPF numbers being rejected by Dynamic Forms and eKYC validation.
* Fixed ID Capture real-time feedback colors inverting with the device appearance; both Standard and Minimal feedback now keep a dark background with readable text in light and dark modes, matching the latest design.
* Fixed Document Scan (V2) returning to the camera screen instead of the source-selection screen when tapping **Recapture document** after an upload error, when multiple document sources are configured.
* Fixed crashes in NFC when reading passports with malformed or truncated chip data; the scan now reports a read error instead of crashing.
* Fixed NFC secure-messaging response verification on AES sessions (PACE/chip authentication): the response MAC was compared against a copy of itself and never actually verified. Tampered responses are now rejected with a checksum error.
* Fixed NFC passport scan always failing chip authentication for users whose date of birth or document expiry falls in the last days of December, caused by a week-numbering year in MRZ key derivation.
* Fixed missing analytics events on permission alerts in the Face Authentication, ID Capture, and Selfie modules.
* Fixed Deepsight video being lost from Selfie and Face Authentication sessions when the app was backgrounded while the camera was active. iOS invalidates the hardware video encoder in the background, which made the recording fail silently at finalization. The recorder now discards the pre-background footage and records a fresh clip once the app returns to the foreground. If the video still cannot be recorded or finalized, the failure is reported through the non-fatal `videoRecordingError` field on `SelfieScanResult` or `FaceAuthenticationResult` (new case `videoRecordingFailed`); the face capture itself completes normally and the `error` field remains reserved for terminal failures.
* Fixed rapid double-taps on the Signature module's **Continue** and **Done** buttons starting duplicate uploads, which could skip a document in multi-document signing flows and report it as signed.

</Accordion>

## 5.47.0

_11 August 2026_

<Accordion title="5.47.0">

### Features & Enhancements

- Added UX V2 version of the Advanced Electronic Signature (AES) module.
- Added UX V2 version of the Qualified Electronic Signature (QES) module.
- **Breaking Change:** `addAes` no longer takes `showCertificateOnSuccess`. The AES success screen confirms the signature and offers **Download document** when the module is configured with `downloadDocument`; see the [Migration Guide](/release-notes/migration_guide/) for the call-site change.
- QES now loads the Namirial (`providerCode` `QES_3`) consent checkboxes from the backend, with the Terms & Conditions and Privacy Policy as links, and shows the signer's name and signing date after signing. The separate Terms & Conditions screen is removed.
- Improved debugger detection in Deepsight. From now on, sessions are flagged if a debugger is detected. To avoid this during development, use `testMode: true` in `initIncdOnboarding`.
- Setting `testMode` to `true` in `initIncdOnboarding` now allows running the app on real devices. Previously, it was reserved for simulators only. The SDK prints a console warning when test mode is enabled to remind developers to disable it before distribution.
- SDK console logs now default to off. Set `loggingEnabled` to `true` to enable them.
- Capture-only Sections API integrations can now call `finishFlow` after the final section completes successfully to clear local session state and receive diagnostics through `onDiagnosticsDataReceived`. Calling it is recommended but remains optional.
- Reworked camera readiness. Models are warmed before the camera starts. The capture UX was improved across Face Capture, Face Authentication and ID Capture.
- Added an `IDFrameAnalysisError.preparingCamera` feedback case, reported while the ID camera is getting ready.
- The Dynamic Forms module can now prefill answers from the user's captured ID. Questions marked as prefillable in Dashboard are populated automatically before the form is shown. A brief loader appears while values are fetched. Answers configured as non-editable render as read-only fields. If the values can't be fetched, the form opens blank and fully editable.
- Failed QES signing attempts now show "Signature failed" instead of a generic error. Whether a "Try again" button appears depends on the reason the back end reports. Expired signing certificates can be retried. Identity data mismatches, missing identity data, and signing-provider problems close the module instead, since retrying won't help.
- Fixed Portuguese translations.
- Added additional horizontal padding to the selfie preparation screen so the text wraps to a second line sooner.

### Fixes

- Fixed the "Get ready" step being skipped when Face Capture, Face Authentication, or Face Login retried after a failed attempt.
- Face Capture and Face Authentication now check that the device has at least 15 MB of free storage before starting Deepsight video recording. If storage is insufficient, the capture continues without video and the skip is reported through the new non-fatal `videoRecordingError` field on `SelfieScanResult` or `FaceAuthenticationResult` (case `insufficientStorageForVideoRecording`). The `error` field remains reserved for terminal failures.
- Fixed the `-[IDDetection findMaxBin:binNum:]` crash (`EXC_BAD_ACCESS` or `KERN_INVALID_ADDRESS`) reported on iOS SDK 5.41.0-d. All model handlers now return a recoverable error when Core ML inference fails or returns partial results, instead of crashing or producing a wrong result.

</Accordion>

## 5.46.0

_20 July 2026_

<Accordion title="5.46.0">

### Features & Enhancements

- Added a Video Selfie hand-gesture step. Enable with `VideoSelfieConfiguration.handGesture(enabled:)`. The user is asked to wave their hand across their face; the gesture is reviewed manually and is not verified on device.
- Added a Video Selfie head-turn liveness challenge. Enable with `VideoSelfieConfiguration.selfieScan(performHeadMovementCheck:)`. After the selfie is captured the user is asked to turn their head in a random 2 of 4 directions (up/down/left/right), verified on device. On iOS 13 and 14 the challenge is limited to left/right only, because Apple Vision provides the pitch angle needed for up/down detection on iOS 15 and later.



- Unified camera permission screens across ID Capture, Face Capture, and Document Scan into a shared module. Face Capture and Document Scan now show the same pre-permission screen that ID Capture V2 uses.
- Updated analytics names for screens from FaceCapture and ID Capture Modules and added new ones for V2 experience.
- Added elementClicked analytics event for ID Capture and Face Capture modules in V2.
- Redesigned Data Entry & Forms Module to UX V2 while removing v1 experience.
- Redesigned Electronic Signature module


- Migrated the OCR / data-confirmation screen to UX V2 (SwiftUI). The legacy V1 OCR view controller and storyboard were removed, and both OCR entry points now route through the V2 screen.

### Fixes

- Fixed ID Capture V2 success screen subtitle showing "Now let's continue" instead of "Let's continue" across all locales
- Fixed an issue in ID Capture that caused `No internet connection` to be presented when the server reports request errors, instead of `Processing failed`.


- Fixed a class of crashes on ID capture, face enrollment, and face login tutorial screens caused by completion handlers firing more than once.
- Fixed manual capture not appearing immediately when `IncdOnboardingManager.shared.selfieTimeout = 0`
- Fixed camera injection test errors being silently swallowed; failed checks now report `.notSupported` instead of leaving the result as `nil`.
- Fixed phone module v1 with SNA activated failing if phone number was formatted with parentheses.
- Fixed Deepsight video missing from Face Capture and Face Authentication sessions when the app was backgrounded during manual capture; video recording now resumes when the app returns to the foreground.

</Accordion>

## 5.45.0

_2 July 2026_

<Accordion title="5.45.0">

### Features & Enhancements

- Added SDK Diagnostics collection. Enabled by default; opt out with `IncdOnboardingManager.shared.sendDiagnosticsData = false`.
- Redesigned the Combined Consent / Data Sharing Consent module for UX V2, aligning it with the latest design while preserving the existing V1 experience.
- Added UX V2 version of Document Scan module


- Extended methods for loading models (`IncdOnboardingManager.shared.loadModels` / `IncdOnboardingManager.shared.loadModelsSynchronously`) with the ability to select which models should be preloaded (all (default), ID-Capture, or Face-Capture) and to enable (default) or disable automatic unloading when onboarding is finished or cancelled. This frees \~80–100 MB that local ML models previously retained in memory between sessions. See [Migration Guide](/release-notes/migration_guide/) for details.
- Added a method for explicit unloading of models (`IncdOnboardingManager.shared.unloadModels`) when the customer wants to control unloading manually.
- Redesigned `NFC Scan` module to use the Incode Design System V2. Public `addNfcScan(...)` API and `NFCScanResult` are unchanged. See [Migration Guide](/release-notes/migration_guide/) for the user-visible flow changes and [Localization Guide](/sdk-reference/ios-customization/#localize-display-text) for updated string keys.
- Added accessiblity voiceOver to Phone Module v2.
- Added a Digital ID file-too-large error screen when the selected PDF exceeds the upload size limit of 5MB.
- Aligned the Deepsight public API with the Dashboard flow/workflow model: new `DeepsightConfiguration` (`enabled`, `modality`, `motion`) and `DeepsightModality` (`singleFrame` / `singleFrameWithDepth` / `singleFrameWithDepthAndVideo`), a new `addSelfieScan(deepsight:)` overload, and `DeepsightConfiguration` support on `FaceAuthenticationConfiguration`. The previous `addSelfieScan(requireDepthData:videoLivenessRecording:)` overload is deprecated (not removed). See [Migration Guide](/release-notes/migration_guide/) for details.
- Added a `motion` parameter to `addIdScan(...)` to enable motion-based checks during ID capture. Default `false`.




- Updated device-identifier mapping with latest iPhones and iPads.


- Added `documentSources` parameter to `addDocumentScan` function

### Fixes

- Fixed Done button in Dynamic Forms not enabling once all fields were populated.
- Fixed Video Selfie incorrectly reporting an internal recording error after the max video length was reached.
- Fixed ID Capture showing `No internet connection` when uploading a PDF larger than 5MB; it now shows the file-too-large error and supports retrying with another file.
- Fixed false "No Internet Connection" snackbar shown during ID capture for non-network errors.


- Fixed dashboard config overriding code-set geolocation `isSkippable` in `startOnboarding`/`startOnboardingSection`.

- Fixed error handling in Phone Module v1 and v2.

- Fixed V1 ID upload now returns the user to the camera when they tap Retry on the no-network snackbar, instead of re-uploading the cached image (avoids the case when backend processed the original request despite a dropped connection).

- Improved internal method swizzling for better third-party SDK compatibility.

- Fixed a Swift task continuation misuse crash in face capture tutorial screens.

</Accordion>

## 5.44.0

_22 May 2026_

<Accordion title="5.44.0">

### Features & Enhancements

- Added Hebrew (`he`) localization. The SDK now ships Hebrew translations for all UI strings, and `IncdLocalization.localizationLanguage` accepts full locale identifiers such as `he-IL` (resolved to `he.lproj` when no exact `lproj` match is found).
- `IncdTheme.logo` now applies to V2 screens in addition to V1. The logo is resolved in the following order: custom `UIImage` set via `IncdTheme.logo`, then the `incdOnboardingLogo` asset from the host app's main bundle, then the SDK bundle's default.
- Added SNA (Silent Network Authentication) to `Phone Module` (Only available via Flows integration and on new variant `-sna`).

### Fixes

- Fixed issue with cancel event being lost when canceling onboarding.
- Fixed ID side validation so wrong-side ID scans show feedback instead of being auto-captured.
- Fixed image buffer processing continuing in the background after cancelling the ID capture screen on V2.
- Fixed Face Capture continuing incorrectly when microphone permission is denied for audio streaming; it now ends with `streamAudioPermissionsDenied`.
- Fixed an issue where the selfie image was missing in Face Match when using Face Authentication.
- Fixed VoiceOver accessibility issues on Face Capture error and ID Capture result screens.
- Fixed button label on ID capture confirmation screen (UX V2).
- Fixed incorrect default config values for Face Capture.
- Fixed issue with user-uploaded document (like for ID Capture or Electronic Signature) not being removed, when local data is cleared.
- Fixed inverted `OcclusionCheck.Severity` thresholds where `.low` and `.high` were swapped, causing occlusion checks to behave with the opposite strictness.
- Fixed camera permission denied alert not appearing in V1 ID Capture and Face Capture, leaving the user stuck with no way to exit onboarding.


</Accordion>

## 5.43.0

_5 May 2026_

<Accordion title="5.43.0">

### Features & Enhancements

- Improved the `Geolocation` module UX by adding a retryable Location Unavailable screen when permission is granted but coordinates or backend confirmation fail, and by surfacing No Internet screen when the backend call fails due to connectivity.
- Updated Subtitle Text on Review Document Scan Screen
- Redesigned `Phone` module
- Added SNA (Silent Network Authentication) to `Phone` module. Activate via Dashboard in supported countries and phone carriers. If SNA is not supported OTP will be used.
- Added Accessibility support for ID-Capture and Face-Capture
- Face occlusion detection threshold is now configurable from the Incode dashboard for Face Capture and Face Auth.
- Added on-device age verification support (available only in -l variant with e2ee configuration).
- Added `allAttemptsExhausted` to `SelfieScanResult` and `IdScanResult`, indicating when capture or upload retries are no longer available.
- Added per-attempt callbacks `onIdFrontAttemptCompleted`, `onIdBackAttemptCompleted`, and `onSelfieAttemptCompleted` to `IncdOnboardingDelegate`, fired after each individual capture attempt with its specific result and status.
- Added skip support to the `Geolocation` module. The new `isSkippable` parameter on `addGeolocation(isSkippable:)` allows the geolocation step to be skipped, and the same behavior is read automatically from the dashboard workflow configuration via `allowUserToSkipGeolocation`. When enabled, skipping or denying location permission advances the flow instead of ending the session with a permission error.
- Reworked the `Geolocation` module's no-permission and location-unavailable screens to honor `isSkippable` parameter:
  - **UI**: When the module is not skippable, the no-permission screen's secondary button changes from `Skip this step` to `Quit process`, and on the location-unavailable screen `Try Again` is replaced with `Quit process` once retries are exhausted. When the module is skippable, the location-unavailable screen falls back to `Skip this step` once retries are exhausted.
  - **Callbacks**: Added `IncdFlowError.locationUnavailable`, fired via `onError` when a non-skippable module exhausts retries on the location-unavailable screen and the user taps `Quit process`. Non-skippable location-permission denials fire `IncdFlowError.permissionsDenied`. For skippable modules, both Skip paths complete the step via `onGeolocationCompleted` with `GeolocationResult.error = .locationUnavailable`.
  - **Analytics**: Added new screen event `GEOLOCATION_UNABLE_TO_VERIFY`, fired when the location-unavailable screen is shown.
  - The location-unavailable screen now caps user-driven retries at 2; the third consecutive failure swaps `Try Again` for `Skip this step` / `Quit process`.


### Fixes

- Fixed Title Overlap with Close Button on Document Scan Flow
- Fixed duplicate screenClosed event being fired for the last screen in a flow.
- Fixed manual capture in Face Authentication not recording deepsight video on subsequent attempts.
- Fixed `deleteLocalUserData` leaving certain session files on the device after being called.


</Accordion>

## 5.42.0

_24 April 2026_

<Accordion title="5.42.0">

### Features & Enhancements

- Added UX V2 Dashboard Configuration for Flows & Workflows
- Redesigned `UserNameInfo` module
- Redesigned `Email` module
- Redesigned `CreditCardCCV` module
- Enabled high resolution ID and Face capture via `clientExperimentId`. Pass `high_res_capture` (optionally combined with other experiments using `|`) to opt in.
- Redesigned `EKYC` module
- Lottie animations are now automatically tinted with the `brand500` color from the color palette, including tutorials, document chooser icons, capture feedback, and loading spinners.
- Improved accepted documents list display on id process screen.

### Fixes

- Fixed an issue where CURP validation could fail in workflows due to the session completing prematurely.
- Added optional `mimeType` to the `DocumentScanResult` model, indicating the MIME type of the content in the `data` field.
- Fixed nudge color on the ID Capture V2 fake permission bottom sheet to `surfaceNeutral200`.
- Fixed a crash in the Video Selfie module when progressing to the next step.
- Fixed an intermittent crash during Face Login.





</Accordion>

## 5.41.0

_7 April 2026_

<Accordion title="5.41.0">

### Features & Enhancements

UI MODERNIZATION

- Redesigned the CURP Validation module to use the Incode Design System V2. Form fields, layout, and typography now align with the V2 theme. See [Migration Guide](/release-notes/migration_guide/) for renamed localization keys.
- Updated design on ID Scan module to display multiline text.
- Updated V2 theme color tokens for positive and negative semantic states. Palette keys `negative500` → `negative400`, `negative600` → `negative500`, `positive600` → `positive500`, `positive800` → `positive950`. If you customize `IncdTheme`'s color palette, see [Migration Guide](/release-notes/migration_guide/).










ID DOCUMENT CHOOSER

- ID Document Chooser now uses a compact card layout only. The screen title has been updated to "Select how to verify" and an **Upload Digital ID** option has been added.
- ID Document Chooser visibility is now controlled solely by the `showIdTypeChooser` parameter in `addIdScan`. Previously, setting `idType` implicitly hid the chooser. The configured `idType` is now only used as a pre-selection when the chooser is disabled (`showIdTypeChooser == false`). See [Migration Guide](/release-notes/migration_guide/) for details.
- Added Dashboard Configuration of the ID Document Chooser Screen.

CAPTURE & PROCESSING FLOW

- Introduced a "Processing" status in the Selfie module. After capture succeeds, users now see a brief indicator before the upload begins, providing clearer feedback between capture and upload.
- Improved the Capture-only flow to use the Analyze screen, with Processing (Security Check) only.
- Processing (Security Check) on Analyze screen, before Uploading.

CONFIGURATION & CUSTOMIZATION

- Selfie image quality threshold is now configurable from the Incode Dashboard.
- Added `.yesno` question input type to the Dynamic Forms module. Questions configured with this type render as a **Yes / No** radio group. Localization keys `incdOnboarding.dynamicform.yes` and `incdOnboarding.dynamicform.no` are available for customization.
- Added support for replacing the default tutorial Lottie animations in ID Scan and Face Scan modules. Place your own `.json` or `.lottie` files in the app's main bundle using the following names: `id_scan_tutorial`, `id_back_scan_tutorial`, `passport_scan_tutorial`, `tutorial_selfie_v2`. Refer to `USER_GUIDE_CUSTOMIZATION_v2` for details.

### Fixes

UI/THEMING

- Fixed incorrect color tokens applied to the Face capture spinner. During active capture, the spinner now uses `.borderFocus`; during uploading it uses `.borderPositiveStatic`. Previously, swapped palette entries caused wrong colors in certain themes.
- Face capture spinner now reflects color from `borderFocus` during capture over the system theme in respect to the `IncdTheme.displayMode`.
- Fixed the Close (X) button on the ID Scan screen displaying different colors depending on the device theme. The button is now always white, consistent with the dark camera overlay background.
- Fixed the Close (X) button on the Face Capture processing screen not following the active theme's text color token.

FACE CAPTURE & AUTHENTICATION

- Fixed the camera freezing for several seconds when opening Face Capture for the first time in a session.
- Fixed missing depth data in face capture sessions.
- Fixed local Face Login (1:1 and 1:N modes) not animating the camera view away before showing the result screen. Behavior now matches the server-side login flow.
- Fixed Face Authentication missing some events and security checks.
- Fixed the Close (X) button in Face Authentication not showing a confirmation dialog when tapped.

ID SCAN

- Fixed missing **Try Again** button on the error state screen in the IDScan module.


- Fixed crash by removing option to cancel flip ID animation.

STABILITY / FREEZES & CRASHES

- Fixed an app freeze triggered by a "Face not found" error on the Front ID scan.
- Fixed an app freeze that occurred when uploading the Secondary ID Scan.
- Fixed an app freeze triggered by completing a usSmartCapture barcode scan.
- Improved Lottie animation loading to be fully asynchronous, preventing potential UI blocking when loading large animation files on the main thread.
- Fixed Selfie, Face Authentication, and Face Login modules incorrectly resuming camera autocapture and video recordings after the app returned from background during the processing or uploading stage.

NETWORKING & SESSION

- Fixed issue where upload request times out when networking is routed through VPN.
- Fixed `onError` delegate not being called when SSL pinning fails during session creation.

ACCESSIBILITY & LOCALIZATION

- Fixed incorrect Spanish and Portuguese translations for the manual capture prompt. The ES/PT strings for "Take the photo manually" now match the English source.
- Fixed missing `accessibilityLabel` on the **Take Photo** button in Selfie Scan, improving VoiceOver support.

</Accordion>


## 5.40.0

_20 February 2026_

<Accordion title="5.40.0">

### Features & Enhancements

- Added **Quit process** button to the screen when user denies camera permissions.
- Fake permission 'Learn more' screen now shows a confirmation dialog when **Quit process** button is tapped.
- Added camera permission event tracking for Face Enroll, Face Login, Video Selfie, Document Scan, and ID Capture modules.
- Limited feedback message title and subtitle to 2 lines on ID Capture v2 screen.
- Turned off swipe gestures to go back between module screens in all iOS versions since they caused crashes.
- Added Geolocation UX V2 module.
- Adjusted UI layout for Manual capture button on ID v2 experience.
- Updated Loading, Error, and Success States for Face Authentication and Face Login V2 experience.
- Adjusted Header text layout on ID Capture v2 to prevent it from overlaying with the **Cancel** button.
- Added backend checks for Lenses, Headwear, Face Mask, and Closed Eyes to Video Selfie.
- Supporting async_resolution node types in Workflows.
- Added Optional Fields to Dynamic Forms.
- Added `presignedVideoFileURL` to `SelfieScanResult`.
- Increased the customer logo height to 35pt on V2 experience.
- ID Capture V2 UI color updates:
  - Capture frame during processing now uses focus500 in light and focus400 in dark mode.
  - Capture countdown background now uses gray900 in both light and dark modes.
  - Capture countdown border gradient removed and now uses gray100 in both light and dark modes.
  - Realtime feedback background now uses gray1000 in both light and dark modes.

### Fixes

- Fixed a crash when user came back from settings after declining camera permissions.
- Fixed PoA document scan showing connection error for unrecognized documents. Increased the document upload timeout.
- Fixed content alignment on Learn More About Camera Permissions screen to be vertically centered.
- Fixed a bug where Video Selfie Module asks to scan back side of an ID document when a passport document is previously scanned.
- Fixed a bug where Video Selfie Module ignored OnlyBack/OnlyFront ID module configurations.
- Fixed camera preview glitch when streaming is enabled during ID capture.
- Fixed Selfie module not transitioning to the next module on Simulators.
- Fixed button padding on ID Capture Help Screen.
- Fixed wrong icon order and overlapping between tooltips and title on Face Match screen.
- Fixed issues with camera injection test in Face Enroll in captureOnly mode.
- Fixed ID Upload screen layout issues on smaller screens.
- Fixed logo size mismatch for V2 experience.
- Fixed button spacing on the camera permission denial screen.
- Fixed minimal realtime feedback overlap on ID Capture screen.
- Fixed ID capture realtime feedback and header subtitle color. It is using now `textBodyTertiaryStatic` color.
- Fixed missing depth data in some cases on manual capture for Face Enroll module.
- Fixed bad exposure on captured face images and ID images.
- Fixed a rare issue where the ID upload screen could be presented twice, causing the capture flow to become unresponsive.
- Fixed an issue where the Face Capture feedback label appeared on the Upload screen after capture.
- Fixed missing No Network screen on ID Capture Upload Screen for V2 experience; network errors now present the no-network screen and retry without consuming the user's upload attempts.
- Fixed customization of realtime feedback text color on Selfie V2.







</Accordion>

## 5.39.1

_9 January 2026_

<Accordion title="5.39.1">

Fixed

- Running onboarding section upon module cancelation is again possible.

</Accordion>

## 5.39.0

_31 December 2025_

<Accordion title="5.39.0">

- Introducing the Non-UI mode for the ID Capture module. Refer to `USER_GUIDE_NON_UI.md` for more.


- Update phone number formatting and validation.
- Postal Code field in EKYB Module now accepts alphabetical characters.
- Fixed a crash that occurred when the user repeatedly tapped the CTA button on Video Tips tutorial screens.
- Added Face Match screens for the v2 experience with `showLivenessStatus` parameter to display liveness status UI (defaults to false in V2, true in V1).
- Added support for `CustomModule` in Workflows. Implement `onCustomModuleStarted` delegate method to pause a flow, execute custom logic, and resume at the module's next node.


- Added a way to skip Document Scan step.
- Added Review screen for the ID Capture V2 experience; In `addIdScan` method, renamed `showRetakeScreen` into `showRetakeScreenForManualCapture`, renamed `showAutoCaptureRetakeScreen` into `showRetakeScreenForAutoCapture`, and removed `enableRotationOnRetakeScreen` parameter; Removed `IncdOnboardingManager.shared.enableRotationOnRetakeScreen` flag.
- Refined UI for Face Capture v2 experience; Added `incdOnboarding.FaceCapture.CaptureButton.cameraIcon` customizable asset for manual capture button icon.


- Added separate error message in Selfie Scan and Face Auth modules when the capturing face is occluded or partially covered.
- Updated Selfie tutorial subtitle text.
- Fixed captureAttemptFinished event module name for ID Capture
- Add additional event data to `onEvents(_:)` delegate method
- Updated Loading and Success Face Capture State for v2 experience
- Updated No Internet Connection Error Screen for v2 experience


- Added parallel barcode scanning to the ID scan module when usSmartCapture is enabled.

</Accordion>

## 5.38.0

_9 November 2025_

<Accordion title="5.38.0">

- V2 user experience now possible when using SDK without api key.
- Fix `setupOnboardingSession`, `startFaceLogin` methods and `onError` delegate callback returning `notInitialized` instead of a `jailbreakDetected` error when being run on jailbroken devices
- Renamed param `showTutorial` to `showTutorials` when configuring Face Authentication module
- Added local authentication statistic data store and manual server sync feature. This feature is used when device is offline while using the local login feature and we need to log authentication attempts to the server at a later time. Setting new `storeLocalAuthenticationEnabled`  flag as true will store the authentication attempts data. Then new API function  `syncFaceLoginAttempts` can be called when device is back online to log all stored attempts. Progress can be tracked using new `IncdLoginDelegate` function `onSyncProgressUpdate(completionPercentage: Float)`.
- Fixed a bug that prevented deepsight from executing when using the sections API.
- Fixed the appearance of the ID Capture 'Common issues' screen on iOS 13.
- Fixed setting mark for manual review when user denies camera permission or cancels selfie capture
- Updated UI of ID Capture Help screen for the V2 experience.
- Added Age assurance tutorial screen for Selfie v2 experience.
- Added Age assurance tutorial screen for ID v2 experience.
- Added support for the V2 UI for Login and Authentication
- Updated processing screen UI for the ID v2 experience.
- Deprecated `enableIdSummaryScreen` parameter from addIdProcess. Now function signature remains `addIdProcess(idCategory: IDCategory)`
- Fixed 3-2-1 counter on V2 ID scan
- Added support for US Smart capture feature in Id capture module. Activate via dashboard. Contact your Incode representative for participating states driver's licence.
- Added metadata field in IdScanResult. It represents proprietary capture metadata, required by the Incode Omni SDK, that is associated with this ID Scan capture session.
- Added frameWithDepth field in SelfieScanResult. It contains a base64-encoded selfie image captured during the Selfie Scan step, enriched with AVDepthData.
- Added new Digital ID flow to ID Scan module

Known Issues:

- ID Scan module: White/black screen may appear briefly upon camera open/closure.

</Accordion>

---

- Path: `release-notes/releases-rn-sdk`
- URL: https://developer.incode.com/release-notes/releases-rn-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-rn-sdk.md

# React Native SDK Release Notes

## 9.19.0

_29 October 2026_

### CurpValidation Module

- <Pill type="breaking" /> Renamed the `CURP` module to `CurpValidation` in flow configuration, in the completion event, and in the exported `CurpValidationCompleteEvent` type (was `CURPCompleteEvent`). Listeners must be updated. See the [migration guide](/release-notes/rn-migration-guide/#migration-to-9190).
- <Pill type="breaking" /> Changed `status` to follow RENAPO's answer on both platforms. When validation is enabled, `status` is `success` only if RENAPO accepts the CURP. A RENAPO rejection sets `status` to `fail`. Before, Android reported a rejected CURP as `success`, and iOS reported it as `fail`.
- <Pill type="breaking" /> Changed Android to emit one `CurpValidation` event, for the final result. Before, Android also emitted an event for each failed attempt. iOS already emitted one event.
- <Pill type="breaking" /> Changed `curp` to be omitted when the SDK has no CURP, instead of `""`. Check whether the key is present.
- Added `valid`, `data`, and `resultCode` to the `CurpValidation` result on both platforms:
    - `valid` indicates whether RENAPO accepted the CURP.
    - `data` is the server response for the CURP check, as an object.
    - `resultCode` has the same values as on the `Phone`, `Email`, and `FullName` modules.
- Changed the result for `validationEnabled: false`. `valid` and `data` are omitted, because no server check ran, and a captured CURP is reported as `success` on both platforms.

### Flow Methods

The flow methods `startOnboarding`, `startOnboardingSection`, `startFlow`, `startWorkflow`, and `startFlowFromDeepLink` now end the same way on Android and iOS, and always settle their promise exactly once. Some of these changes are breaking; see the [migration guide](/release-notes/rn-migration-guide/#migration-to-9190) for the steps to update your app.

- <Pill type="breaking" /> Changed `startOnboarding`, `startOnboardingSection`, `startFlow`, `startWorkflow`, and `startFlowFromDeepLink` to reject with `userCancelled` when the user cancels, instead of resolving with `{ status: 'userCancelled' }`.
- <Pill type="breaking" /> Changed some method rejection codes that were `unknown` before.
    - On both platforms:
         - A Video Selfie failure that is not a denied permission now rejects with `videoSelfieNotCompleted`. 
         - A missing biometric consent now rejects with `biometricConsentNotGiven` or `biometricConsentNotReceived`.
    - On Android:
        - A missing location rejects with `locationUnavailable`.
        - A denied location permission rejects with `permissionsDenied`.
        - Not enough free disk space rejects with `insufficientDiskSpace`
        - An incompatible on-device processing setup rejects with `onDeviceProcessingNotCompatible`.
    - On iOS:
        - A denied audio permission or a fake-permission check rejects with `permissionsDenied`.
        - A flow without an onboarding session rejects with `noActiveSession`. 
- <Pill type="breaking" /> Changed the iOS rejection codes to `sessionCreationFailed` when the onboarding session cannot be created (was `unknown`), and to `captchaNotVerified` when the Captcha cannot be verified (was `Incd::ONBOARDING_ERROR`).
- <Pill type="breaking" /> Changed the start-up rejection codes of `startFlow`: 
    - `activityNotPresent` when there is no host Activity (Android) or view controller (iOS), previously `IncdSDK:startFlow` on iOS.
    - `configError` when `sessionConfig` has neither a `configurationId` nor a `token`, previously `unknown` from the flow on Android.
    - `unknown` when the flow cannot start, previously `Incd::startFlowException` on Android.
- <Pill type="breaking" /> An unknown `moduleId` now runs the whole flow on Android, the same as iOS. It previously rejected with `Incd::invalidModuleId`.
- Added these error codes to `IncodeSdkFlowErrorCode`: `videoSelfieNotCompleted`, `interrupted`, `biometricConsentNotGiven`, `biometricConsentNotReceived`, `sessionCreationFailed` (iOS only), `captchaNotVerified` (iOS only), `sectionAlreadyRunning`, `noActiveSession`, `insufficientDiskSpace` (Android only) and `onDeviceProcessingNotCompatible` (Android only).
- `startFlow` now runs through the shared Incode bridge, so it starts and fails the same way on Android and iOS. See the [migration guide](/release-notes/rn-migration-guide/#migration-to-9190).
- Changed `startWorkflow` to reject with `activityNotPresent` instead of `unknown` when there is no host Activity or view controller.
- Fixed these methods never settling on Android when the system ends the flow: for example, it destroys the SDK screen while the app is in the background. They now reject with the new code `interrupted`, the same as iOS, which rejected with `unknown` before.
- Fixed these methods possibly settling their promise more than once. The first outcome wins.
- Fixed `startFlow` never settling its promise on Android when there was no host Activity. It now rejects with `activityNotPresent`.

### startOnboardingSection

`startOnboardingSection` now works the same way on Android and iOS. Some of these changes are breaking; see the [migration guide](/release-notes/rn-migration-guide/#startonboardingsection).

- <Pill type="breaking" /> `sectionTag` is now required and must not be blank. If it is missing or blank, the call rejects with `configError`.
- <Pill type="breaking" /> Renamed `recordSessionConfig.forcePermissions` to `forcePermission` for `startOnboardingSection`. The new exported type is `OnboardingSectionRecordSessionConfig`, and both of its fields are optional. `startOnboarding` still uses `OnboardingRecordSessionConfig` with `forcePermissions`.
- <Pill type="breaking" /> A second call while a section runs now rejects with `sectionAlreadyRunning` on both platforms. The running section continues.
- <Pill type="breaking" /> A `flowConfig` value that cannot be read, or a `recordSessionConfig` that is not an object, now rejects with `configError`.
- `startOnboardingSection` now rejects with `activityNotPresent` when there is no host Activity (Android) or view controller (iOS), and with `noActiveSession` when no onboarding session is set up.

### Geolocation Module

The `Geolocation` module now follows the shared native contract. This is a breaking change; see the [migration guide](/release-notes/rn-migration-guide/#migration-to-9190).

- <Pill type="breaking" /> The `Geolocation` step result is now `{ addressFields?, latitude?, longitude?, status, resultCode, error? }` instead of five flat address keys. Address values are absent when unknown, instead of `""`.
- <Pill type="breaking" /> A skipped, denied, or unavailable location is now reported through `onStepCompleted` with `status: 'fail'` and an `error` code, on both platforms. It was previously an `onStepError` event, with `module: 'GEOLOCATION'` and a nested status on Android. `onStepError` no longer fires for `Geolocation`, and the `GeolocationErrorEvent` type is removed.
- <Pill type="breaking" /> Changed `state` on Android to hold the country name, as it already did on iOS. It previously held the region. `city` now falls back to the region when the city is unknown, on both platforms.
- Added the `latitude` and `longitude` coordinates to the `Geolocation` result.
- Fixed Android reporting every unavailable location as `permissionsDenied`. The `error` code now reflects the actual cause.
- Changed `onError` on Android to report `permissionsDenied` or `locationUnavailable` for a non-skippable `Geolocation` failure, instead of `unknown`.

### Appearance


- Added the `setLogo` method. It sets a custom logo for the SDK screens, including every UX V2 screen, such as `FaceAuthentication`. Pass the name of an image of your app: a drawable resource name on Android, and an image asset name on iOS. A `logo` set on the `SelfieScan` or `VideoSelfie` module has priority in that module. If the name cannot be resolved, `setLogo` rejects with `appearanceError`. On Android, add the drawable to `res/raw/keep.xml`, or the Android shrinker removes it from release builds. See [`setLogo`](/sdk-reference/react-native-api-reference/#setlogo).

### Other Fixes

- Fixed `approve` on Android crashing the app when the native call throws. It now rejects with `bridgeFailure`.
- Fixed `approve`'s promise never settling on Android when the installed native SDK has no handler for the method. It now rejects with `methodNotSupportedByBridge`.
- Fixed `startOnboarding` and `startOnboardingSection` on Android never settling the promise when a `flowConfig` value cannot be read, such as a value of the wrong type. `startOnboarding` now rejects with `Incd::StartOnboardingException`. `startOnboardingSection` now rejects with `configError`.
- Fixed `startOnboardingSection` on Android never settling the promise when no activity is present. It now rejects with `activityNotPresent`, like `startOnboarding` and `approve`.
- <Pill type="breaking" /> (types): `IncodeSdkFlowErrorCode` gains `'unknownModule'`, `'methodNotSupportedByBridge'`, `'bridgeFailure'`, and `'activityNotPresent'`, the codes that the SDK already rejects with. Exhaustive `switch` statements over it need new cases. See the [migration guide](/release-notes/rn-migration-guide/#migration-to-9190).

Working with Android SDK 5.55.0 and iOS SDK 5.51.0.

## 9.18.0

*7 October 2026*

<Accordion title="9.18.0">

`approve`, `getUserScore`, `faceMatch`, and `startWorkflow` now return the same payloads and error codes on Android and iOS, and the `Phone`, `Email`, and `FullName` modules now follow the shared native contract. Several of these changes are breaking; see the [migration guide](/release-notes/rn-migration-guide/#migration-to-9180) for the steps to update your app.

### approve

- `approve` now resolves `{ success, uuid, customerToken, error }` instead of `{ status, id, customerToken }`. The `status` string is replaced by the `success` boolean, `id` is renamed to `uuid`, and the new `error` field reports an iOS-only approval error (always `null` on Android). `uuid`, `customerToken`, and `error` are `null` when the SDK has no value for them, instead of an empty string.
- `approve` now rejects on every failure with the native error code and message. It previously resolved `{ status: 'userCancelled' }` on Android when the user cancelled, and never settled at all on iOS on a non-success path.
- The `Approve` module step event now carries the same `{ success, uuid, customerToken, error }` payload as `approve` on both platforms.
- Standalone `approve` now emits an `ONBOARDING_STEP_COMPLETED` event for the `Approve` module on iOS, matching Android.
- The `forceApproval` argument of `approve` is now optional and defaults to `false`.

### getUserScore and the UserScore module

- Added optional `interviewId` parameter to the `getUserScore` method.
- Added `userScoreFailed` and `userCancelled` error codes, reported by the `getUserScore` method.
- Renamed the `getUserScore` method's `mode` parameter to `fetchMode`. The old name is no longer read, so a call still passing `mode` silently falls back to the `accurate` default.
- Changed the result shape of the `getUserScore`. It now contains the same payload on both Android and iOS. And it has the full score surface as `UserScoreResult` — `overall`, `idValidation` (with the `photoSecurityAndQuality` and `idSpecific` check lists), `liveness` (with `livenessScore` and `photoQuality`), `faceRecognition` (with `existingUser`), `governmentValidation` (with `recognitionConfidence`, `validationStatus` and `ocrValidation`), plus `extendedUserScoreJsonData`.
- Changed the `UserScore` module's step-complete event, it now delivers that same `UserScoreResult` shape, replacing `{ extendedUserScoreJsonData, data: { overallScore, status, facialRecognitionScore, existingUser, idVerificationScore, livenessOverallScore } }`. The `UserScore` type is removed.
- Changed user score values to no longer include the `/100` suffix on Android, in both `getUserScore` results and the `onUserScoreFetched` callback.
- Changed `getUserScore` on Android to report `userScoreFailed` when a session produced no score, instead of completing with an empty result.
- Changed the SDK to report `warn` where it previously reported `warning` status on iOS, and absent values are `null` instead of `""`.
- Changed the SDK on iOS to reject the promise when the score cannot be fetched, instead of resolving with an empty result.
- Changed the SDK to no longer emit a `{ debug: … }` payload on iOS when the score is empty, the result is always well-formed.

### faceMatch

- Added optional `interviewId`, `matchType`, and `idCategory` parameters to `faceMatch`.
- Added `idCategory`, `isFaceMatched`, `isNameMatched`, `nfcVsIdConfidence`, `nfcVsSelfieConfidence`, and `secondIdConfidence` to `faceMatch`'s result on Android. These already existed on iOS.
- Renamed `faceMatch`'s result field `existingUser` to `isExistingUser` on Android. iOS already used `isExistingUser`.
- Changed `faceMatch`'s rejection code to `faceMatchError` with the native error message, from `IncdSDK:faceMatch` / `"Error"` on iOS and `EUNSPECIFIED` on Android.
- Changed `faceMatch`'s user-cancellation code to `userCancelled`, from `Incd::FaceMatch::UserCancelled`. Other methods keep their own `Incd::…::UserCancelled` codes.
- Changed `faceMatch`'s result fields on iOS to be omitted when the native SDK has no value, instead of defaulted to `false`/`0`.
- Changed `faceMatch`'s `confidence`, `nfcVsIdConfidence` and `nfcVsSelfieConfidence` on Android to be omitted when there was nothing to compare, instead of returned as `-1`. Check whether the key is present instead of comparing to `-1`.
- Changed `faceMatch` to resolve, with those fields omitted, instead of rejecting when no confidence score can be produced.
- Removed `status` from `faceMatch`'s result. Derive it from `isFaceMatched`.
- Fixed `faceMatch`'s promise never settling when the installed native SDK has no handler for the method. It now rejects with `methodNotSupportedByBridge`.
- Split the `faceMatch` TypeScript types: `FaceMatchResult` is the standalone result; `FaceMatchCompleteEvent` keeps its own shape for the module event.

### startWorkflow

- Added the `configError` flow error code. `startWorkflow` now rejects with it when `sessionConfig` has neither a `configurationId` nor a `token`. Previously this failed with `unknown` on Android, and on iOS only after failed network requests. `IncodeSdkFlowErrorCode` gains `'configError'`, so exhaustive `switch` statements over it need a new case.
- Changed `startWorkflow`'s rejection code for a missing presenting screen to `unknown` on both platforms, from `Incd::StartWorkflowException` on Android and `IncdSDK:startWorkflow` on iOS.

### startOnboarding and startOnboardingSection

- <Pill type="breaking" /> A `flowConfig` entry with a module name that the SDK does not recognize now rejects the promise with `unknownModule`. Before, iOS omitted the step and the flow still resolved with `success`, and Android threw an uncaught exception instead of rejecting. A flow that still uses the old `Name` module now rejects; rename it to `FullName`.

### Phone, Email, and FullName modules

- <Pill type="breaking" /> `Name` module renamed to `FullName` — in flow configuration, in the completion event, and in the exported `FullNameCompleteEvent` type (was `NameCompleteEvent`). Listeners must be updated.
- Omitting `otpVerification` on the `Phone` and `Email` modules now leaves the native SDK setting in place instead of forcing `false`.
- Added `defaultRegionPrefix` to the `Phone` module — a dialing-code override in the range `1`–`9999`. Out-of-range values are ignored.
- `Phone`, `Email`, and `FullName` results now share one shape: `status` (`success` / `fail`) plus `resultCode`, both populated on both platforms. `resultCode` is the finer detail — both platforms report `success` and `error`, and Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback. `Phone` gains `status`; `Email` and `FullName` gain `resultCode`.
- <Pill type="breaking" /> On Android, a failed `FullName` reported the native SDK's error message as `status`, so the value was an arbitrary sentence. It is now `fail`, like every other module.
- <Pill type="breaking" /> On iOS, a failed `Phone` arrived as a step error while Android delivered a completed event. It is now a completed event carrying `status: "fail"` on both platforms, matching `Email` and `FullName`.
- <Pill type="breaking" /> The captured value (`phone`, `email`, `name`) is now omitted when the SDK has none, instead of arriving as `null` or `""`. Check whether the key is present.
- If the native SDK cannot add a `Phone`, `Email`, or `FullName` step from its configuration, the SDK now logs a warning (`Module <name> was not added: <reason>`) and omits that step. The flow still starts and resolves without the step, so a faulty configuration does not reject the promise. Check the device log if one of these steps does not show.
- <Pill type="breaking" /> (types): `resultCode` on `Phone` was declared as `'success' | 'error' | 'userCancelled' | 'emulatorDetected'` but the runtime delivered the SDK's upper-snake names (`SUCCESS`, `USER_CANCELLED`). The runtime now matches the declared type. `FullNameCompleteEvent` also gains the `name` field, which it emitted but never declared.

### iOS Installation

- The plugin now depends on `IncodeBridgeCommon`.

Working with Android SDK 5.54.0 and iOS SDK 5.50.0.

</Accordion>

## 9.17.0

*15 September 2026*

<Accordion title="9.17.0">

- Added optional `logo` parameter to the `SelfieScan` module.
- Added optional `logo` parameter to the `VideoSelfie` module.
- Added `storageUnavailable` to `IncodeSdkFlowErrorCode`. Android only. It is reported when the device cannot provide a writable images directory at flow start.
- <Pill type="breaking" /> On Android, every event name delivered through `onEvents` now uses the SDK's camelCase value form (for example, `userCanceled`, `moduleOpened`) instead of the SDK enum constant name (for example, `USER_CANCELLED`, `MODULE_OPENED`). The `{ status: 'userCancelled' }` value resolved by the flow promises is unchanged.
- On Android, the Video Selfie V2 camera steps hide the close (X) button, so `showCloseButton(true)` no longer applies to them.
- On Android, Signature V2 reads the title and description from the new `onboard_sdk_signature_capture_title` and `onboard_sdk_signature_capture_description` string resources. V1 keeps using `onboard_sdk_signature_title` and `onboard_sdk_signature_description`.
- Added an optional `documentSources` parameter to the `DocumentScan` module (`camera`, `photoUpload`, `fileUpload`). It supersedes the now-deprecated `showDocumentProviderScreen` flag, which is still honored when `documentSources` is omitted.
- Added `combinedConsentsNotReceived` to `IncodeSdkFlowErrorCode`. The flow rejects with this code when a mandatory Combined Consent cannot be shown because it has no readable text or checkbox ID. iOS only.
- Fixed `onStepCompleted` not firing for the `VideoSelfie` module on Android. The event was previously only emitted on iOS. It now emits `{ module: 'VideoSelfie', result: { status: boolean } }` on both platforms.

Working with Android SDK 5.53.0 and iOS SDK 5.49.0.

</Accordion>

## 9.16.0

*28 August 2026*

<Accordion title="9.16.0">

- Added optional `sslPinningConfig.forceSSLPinning` to `initialize` (defaults to `false` when omitted).
- Added `sendDiagnosticsData` (iOS only) parameter to `initialize`. Set to `false` to prevent the Incode SDK from sending diagnostics data. Defaults to `true`.
- Removed `waitForTutorials` parameter from `initialize` method.
- Fixed Android build failure on React Native 0.80+ caused by a Kotlin nullability mismatch in `BaseActivityEventListener` overrides.
- Fixed Android build failure on React Native 0.81+ (`Unresolved reference 'currentActivity'`).
- `setTheme` now takes `{ theme }` instead of `{ jsonTheme }`. `setFaceAuthenticationHint` now takes `{ identityId }` instead of a string or `{ faceAuthenticationHint }`. The TypeScript parameter for `showCloseButton` is now `allowUserToCancel` (was `shouldShowCloseButton`); call sites stay `showCloseButton(true)`.
- `setTheme` and `setUXConfig` now reject with `appearanceError` on failure instead of resolving `{ success: false }`.
- On iOS `showCloseButton`, `setLocalizationLanguage`, and `setString` now settle their promises. They previously returned immediately without waiting for the native call.
- Appearance methods `setSdkMode`, `setTheme`, `setUXConfig`, and `setLocalizationLanguage` now type as `Promise<void>`. `setLocalizationLanguage` was previously typed as `Promise<string>`.
- Added new required parameters `locale` and `quantityStrings` to the `setQuantityStrings` method.
- Removed `strings` parameter from the `setQuantityStrings` method.
- Modified the `setQuantityStrings` method to, when erroring out, return a code specific to the cause of the error alongside a message and native stack trace, instead of returning a `SET_QUANTITY_STRINGS_ERROR` code.

Working with Android SDK 5.51.0 and iOS SDK 5.47.0.

</Accordion>

## 9.15.0

*28 July 2026*

<Accordion title="9.15.0">

- Added `integrityCompromised` and removed `jailbreakDetected` from `IncodeSdkFlowErrorCode`.
- Removed `disableJailbreakDetection` parameter from `initialize` method.

Working with Android SDK 5.50.0 and iOS SDK 5.46.0.

</Accordion>

## 9.14.0

*26 June 2026*

<Accordion title="9.14.0">

- Added `setSdkMode` method to change the SDK mode (`standard`, `captureOnly`, or `submitOnly`) after initialization.
- Added optional `voiceConsentLanguage` parameter to `OnboardingSessionConfig` to set the voice consent language in the `VideoSelfie` module. Supported values: 'en', 'es', 'pt', and 'he'. Default is English.
- Updated `IncodeSdkFlowError`. Removed `badEnvDetected` from `IncodeSdkFlowErrorCode`.
- Deprecated `showTutorial` parameter in `DocumentScan` module for Android.
- Fixed `setString` on Android always applying string overrides for the `en` locale regardless of the language set via `setLocalizationLanguage`.

Working with Android SDK 5.49.0 and iOS SDK 5.44.0.

</Accordion>

## 9.13.0

*26 May 2026*

<Accordion title="9.13.0">

- Added `isInitialized` method to provide a hint on whether the native SDK has been initialized or not.
- Updated `onStepUpdated` to fire per-attempt events for `IdScanFront`, `IdScanBack`, and `SelfieScan` modules, in addition to the existing `Conference` updates.
- Updated `onStepUpdated` signature to take a `{ module, listener }` object (matching `onStepCompleted`/`onStepError`), replacing the previous bare-listener form.
- Updated the default values of the `lensesCheck` and `faceMaskCheck` parameters to `true` in the `SelfieScan` module.

Working with Android SDK 5.48.0 and iOS SDK 5.44.0.

</Accordion>

## 9.12.0

*13 May 2026*

<Accordion title="9.12.0">

- Added `isSkippable` flag to the `Geolocation` module. It allows the geolocation step to be skipped. When set to `true`, skipping or denying location permission advances the flow instead of ending the session with a permission error.
- Added `allAttemptsExhausted` flag to `IdScanResult` and `SelfieScanResult` indicating when capture or upload retries are no longer available.

Working with Android SDK 5.47.0 and iOS SDK 5.43.0.

</Accordion>

## 9.11.0

*28 April 2026*

<Accordion title="9.11.0">

- <Pill type="breaking" /> On iOS, setting `idType` no longer hides the document chooser in the `IdScan` and `IdScanFront` modules: pass `showIdTypeChooser: false` to hide it. See the [migration guide](/release-notes/rn-migration-guide/#migration-to-9110).
- Added new internal Android dependency `com.incode.sdk.hybrid-bridge` that is required to have to a successful build. In case you're experiencing issues fetching it during gradle sync phase please contact your Incode representative, as your account access might have to be updated.

Working with Android SDK 5.46.0 and iOS SDK 5.42.0.

</Accordion>

## 9.10.0

*26 March 2026*

<Accordion title="9.10.0">

- Added support for Android SDK initialization without api key with e2ee url.
- <Pill type="breaking" /> Added the `showIdTypeChooser` parameter to the `IdScan` and `IdScanFront` modules. On Android, setting `idType` no longer hides the document chooser: pass `showIdTypeChooser: false` to hide it. See the [migration guide](/release-notes/rn-migration-guide/#migration-to-9100).
- Added new parameter `e2eeEncryptionEnabled` for `startFaceLogin` method that enables End-to-End Encryption (E2EE) on Android.
- Deprecated `autocaptureUxMode` parameter from the `IdScan` module.
- Deprecated `enableIdSummaryScreen` parameter from the `ProcessId` module.
- Removed parameters `disableHookCheck`, `disableEmulatorDetection`, `disableRootDetection`, `disableVirtualEnvironmentDetection` from `initialize` method.
- Removed `simulatorDetected`, `rootDetected`, `hookDetected`, `virtualEnvDetected` from `IncodeSdkFlowError`.

Working with Android SDK 5.45.0 and iOS SDK 5.40.0.

</Accordion>

## 9.9.0

*27 February 2026*

<Accordion title="9.9.0">

- Removed the `enableRotationOnRetakeScreen` parameter from the `IdScan` module. Captured documents are now always displayed in a vertical orientation on the Review Screen.
- Renamed the `showRetakeScreen` parameter to `showRetakeScreenForManualCapture` in the `IdScan` module.
- Renamed the `showAutoCaptureRetakeScreen` parameter to `showRetakeScreenForAutoCapture` in the `IdScan` module.
- Fixed issue preventing custom V2 theme from applying when configured via JSON.

Working with Android SDK 5.44.0 and iOS SDK 5.40.0.

</Accordion>

## 9.8.0

*09 January 2026*

<Accordion title="9.8.0">

- Fixed 'TypeError' appearing for API methods `finishOnboardingFlow`, `approve`, `deleteLocalUserData` and 'faceMatch' for React Native versions 0.8+.
- Added `CombinedConsent` module.

Working with Android SDK 5.43.0 and iOS SDK 5.39.1.

</Accordion>

## 9.7.0

*24 November 2025*

<Accordion title="9.7.0">

- Fixed error handling on Android.

Working with Android SDK 5.41.1 and iOS SDK 5.38.0.

</Accordion>

## 9.6.1

*23 October 2025*

<Accordion title="9.6.1">

- Fixed compatibility issue for new React Native architectures.

Working with Android SDK 5.40.1 and iOS SDK 5.37.0.

</Accordion>

---

- Path: `release-notes/releases-web-sdk`
- URL: https://developer.incode.com/release-notes/releases-web-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-web-sdk.md

# Web SDK Release Notes

## 1.94.0
_9 October 2026_

### Session expiry

- Any SDK request that answers HTTP 401 now ends the active `render*` / `execute*` method: it unmounts and calls that method's own `onError` once with a `SessionExpiredError` (`statusCode: 401`, `code` / `type: 'SESSION_EXPIRED'`, extends `WebClientError`). Previously the user was left on a retry screen and the integrator was never notified. This applies whether the method is called on the `create()` instance or imported from the package root after `setup()`.
- `SessionExpiredError` is exported from the package root, and `FlowRendererError['type']` (the `executeFlow` `onError` payload) gains `'SESSION_EXPIRED'`.
- Direct API methods (`processId`, `ocrData`, …) keep throwing `WebClientError` as before.
- A failed best-effort device telemetry request no longer ends an otherwise valid session.
- Fixed the device telemetry request sending an invalid credential after Face Capture, which could drop mobile users onto a "session expired" screen.

**Integration required:** the SDK no longer shows its own retry screen when the session expires. Handle `SESSION_EXPIRED` in `onError`, show your own message, and start a new session:

```js
  import { create, SessionExpiredError } from '@incodetech/welcome';
  const incode = create({ apiURL: 'https://demo-api.incodesmile.com' });
  incode.renderCaptureFace(document.getElementById('camera'), {
    token: session,
    onSuccess: (result) => {
      // step finished
    },
    onError: (err) => {
      if (err instanceof SessionExpiredError || err?.type === 'SESSION_EXPIRED') {
        // the SDK has already unmounted: show a "session expired" message,
        // then create a new session and restart the flow
        return;
      }
      // handle other failures
    },
  });
```

- For TypeScript: add a `'SESSION_EXPIRED'` case to any exhaustive `switch` on `FlowRendererError['type']`.
- Detection depends on the API returning CORS headers on its 401 responses. Where it does not, the browser hides the status from the SDK and the previous behaviour applies.

### ID / Face capture

- Denying the camera permission on Face Capture or refreshing after a denial no longer advances the Flow or Workflow without a capture. Workflows reload on a permission refresh instead of moving to the next step.
- UXv1 back-ID-only Flows keep the manual upload option in the document chooser. Manual upload requests only the back image.
- FiscalQR: denying the camera permission on iOS Safari now shows the camera-permission instructions screen instead of a blank camera view; other camera errors show an inline message.

### eKYC

- Germany `DE_PHONE_MOBILE_REGISTER` support: first name, last name and phone mandatory; middle name, date of birth and address optional; no state field; 5-digit postal code; phone of 10 to 13 digits including country code.
- Norway `NO_CONS_POP_REG` support: first and last name mandatory; date of birth, phone, email and address optional; no state field; 4-digit postal code; 8-digit phone.
- `phoneProfile` risk addon: a `RISK_ADDONS_ONLY` config with `riskAddons: ['phoneProfile']` renders only the phone field, prefilled read-only from a prior OTP step.
- Brazil `BR_TAX_PHONE_REGISTER`: the ID number field is labelled "CPF" and must be exactly 11 digits.
- Peru `PE_CIVIL_REGISTER_2`: show the optional Middle Name field.
- Fix the Continue button staying disabled with every visible field filled on forms without a state text input (reported for CO and BR sources).

### eKYB

- Austria `AT_KYB_PREFILL` pre-fill: mandatory Tax ID (FN commercial register number such as `FN 123456a`, or the `ATU` + 8-digit VAT number), with optional Business Name and Address.
- Belgium `BE_KYB_PREFILL`: the Tax ID accepts the officially printed BCE/KBO formats (`0656.908.546`, `0656 908 546`, `656.908.546`, `656 908 546`) in addition to the bare number and the `BE0` VAT form.

### Security, theming & platform

- Update the ML WASM kit to v2.14.51.
- The SDK now reports its build as `<version>+<short sha>` (for example `1.94.0+1a2b3c4`) in device fingerprint, capture metadata and i18n. Split on `+` to get the release line. A `version` passed to `create()` / `setup()` still takes precedence.
- An empty `version` passed to `create()` / `setup()` now falls back to the built-in SDK version.

[Download 1.94.0](https://sdk.incode.com/sdk/onBoarding-1.94.0.js)

## 1.93.0
_11 September 2026_

<Accordion title="1.93.0">

### Added

* ID capture `onEvent` callback — emits `idCapture.started` and `idCapture.completed` per side (`front` | `back` | `passport`) so integrators can observe the front→back boundary when `captureMode: 'both'`
* Dynamic form pre-fill from captured ID/OCR — opted-in questions are seeded before render; non-editable fields stay read-only but still submit; fetch failure falls back to a blank, editable form
* Document capture support for IRS W-8BEN (`processW8BenOcr`, single-page) and W-8BEN-E (`processW8BenEOcr`, multi-page)
* Headless `renderWallet` surfaces `NO_CREDENTIAL` when no wallet credential is available; a chooser-less Digital ID-only config reports `INCONSISTENT_FLOW_CONFIGURATION` instead of a silent dead-end

### Fixed

* Show the ID scan failed message when retry attempts are exhausted, instead of a generic processing error
* Desktop IDV2 manual-capture preview no longer looks cropped, zoomed, or letterboxed
* Prevent scrollbar flicker on desktop at some zoom levels; lock scroll during capture when the host page is taller than the viewport
* Anchor the IDV2 manual capture button to the bottom of the viewport so it cannot land inside the ID frame
* Improve iOS VoiceOver responsiveness during ID capture by pacing frame processing
* Honor the Dashboard **Enforce Capture Image Attempts** setting at runtime — the attempt budget survives refresh, back navigation, and re-init; exhausted budgets emit `NO_MORE_TRIES`
* Combined consent now loads in the language selected during the flow
* Workflow electronic signature respects the configured custom subtitle

### Changed

* US Smart Capture restores the barcode fast path: when the back-side PDF417 barcode is decoded, skip the 3-2-1 countdown and go to the "Hold on" analyzing screen

Download [1.93.0](https://sdk.incode.com/sdk/onBoarding-1.93.0.js)

</Accordion>

## 1.92.1
_26 August 2026_

<Accordion title="1.92.1">

### Fixed

- Webpack build issues solved

[Download 1.92.1](https://sdk.incode.com/sdk/onBoarding-1.92.1.js)

</Accordion>

## 1.92.0
_19 August 2026_

<Accordion title="1.92.0">

### Deepsight

- Configuration and enablement should match dashboard configuration for deepsight to work correctly.

### eKYC

- India ID number support
- India DMV (`IN_DMV`) support
- Nigeria `NG_MONO_BVN` support
- UK EKPB prefill
- Mexico eKYC prefill adjustments
- Improve apartment-field logic

### eKYB

- W4B `dateOfIncorporation` support

### UIConfig

- Add `uiConfig` and `onClose` to `renderCamera('document', …)` for per-flow theming and close handling

```js
  import { create } from '@incodetech/welcome';
  const incode = create({ apiURL: 'https://demo-api.incodesmile.com' });
  incode.renderCamera('document', document.getElementById('camera'), {
    token: session, // or rely on create()/start() session
    onSuccess: (result) => {
      // document uploaded / step finished
    },
    onError: (err) => {
      // handle failure
    },
    // Theme / brand this flow without org-level dashboard config
    uiConfig: {
      branding: {
        logo: { src: 'https://cdn.example.com/logo.svg', height: 32 },
        hideFooterBranding: true,
        // hideHeaderBranding: true,
      },
      closeButton: {
        show: true,
        position: 'left', // or 'right'
        // offset: 16,
      },
      theming: {
        designTokens: {
          color: {
            brand: { primary: '#EC0000' },
          },
        },
      },
      helpButton: { show: true },
      // notifications: { minimal: true },
    },
    // Fired when the user taps the X (then the SDK unmounts itself)
    onClose: () => {
      // navigate away, resume host UI, analytics, etc.
    },
  });
```

### ID / Face capture

- Hide camera loading overlay when continuing from V1 manual ID review
- Center ID flip ("Show the back of your ID") Lottie animation
- Center IDV2 manual-capture tooltip text in standalone embeds
- Fix selfie frame on specific iOS devices
- Delay Selfie V2 capture frame until camera is visibly playing
- Honor `ChooseCamera` `deviceId` on V1 desktop selfie / face auth (spread props before `deviceId`)
- Prevent excess scrollable area on webcam capture pages
- Text-magnification layout — top text grows downward; manual capture button stays in viewport
- Samsung/Android Chrome — tab switch no longer flashes permission screen or breaks stream; wait for visibility before `getUserMedia`; release recorder before retry
- Force OpenVidu (not OpenTok) for ID/selfie recording sessions in non-production
- Propagate expired-token init errors to `renderCaptureId` / `renderCaptureFace` `onError` as `SESSION_EXPIRED` (401)
- Honor custom `tutorialText` title/subtitle on every multi-page document tutorial step
- Honor configured `lottieScriptUrl` for IDV2 capture-feedback notifications
- Add `crossOrigin="anonymous"` to Lottie player loader so cross-origin script errors are not opaque

### Security, theming & platform

- Remove vulnerable bundled `uuid` — switch recorder to in-repo `@incodetech/opentok-react`; pin `openvidu-browser` → uuid 11.1.1
- SDK deprecation policy — `setup()` warns once when release is ≥12 months old
- Share `applyDashboardTheme` across workflow and flow so workflow buttons pick up brand color

[Download 1.92.0](https://sdk.incode.com/sdk/onBoarding-1.92.0.js)

</Accordion>

## 1.91.0
_17 July 2026_

<Accordion title="1.91.0">

### Fixed

- Fixed executeWorkflow infinite loading animation displayed after workflow is finished when showFinishScreen: false
- Fixed typo in ID capture V2 attempts remaining
- Fixed Electronic Signature - Signature canvas had incorrect sizing and spacing on mobile and tablet
- Editable and non-editable OCR were wrongly connected to dashboard settings
- Gov validation | Wrong success message for successful scraping
- Device specific | Flows | Workflows | Selfie oval is cut off on smaller screens
- eKYC | Module skipped when country configured as "global"
- The ID capture zoomed in specific devices
- Face capture cannot be loaded and is eventually skipped if it isn’t the first module
- Samsung A14 | Camera stream is lagging significantly
- Camera was zoomed on some devices with two or more cameras
- Document Capture - The camera was zoomed
- Retry attempt was not getting launch | iOS devices
- ID Capture UXv1 | ID preview was horizontal
- Video Selfie - White screen when only “speech” module and useOpenVidu was enabled
- Openvidu is now default and only provider for video recording
- Overall security and injections attacks fixed

[Download 1.91.0](https://sdk.incode.com/sdk/onBoarding-1.91.0.js)

</Accordion>

## 1.90.0
_12 June 2026_

<Accordion title="1.90.0">

### Minor Changes

- EKYB desktop improvements
- US_CREDIT_TELCO support
- Center face capture error modal title under icon
- New countries ekyb country grid
- Fix signature canvas
- Hk support for ekyb
- EKYC displayMode support
- EKYB Address autocomplete
- Address is mandatory for EKYB china
- Electronic Signature Layout fix

### Patch Changes

- Fix V2 ID capture bottom UI overlap on wide, short desktop viewports.
- Center the eKYC information verification loader; refine Permissions layout on large screens; fix the permissions modal close action and primary/secondary button order.
- Fix V2 ID capture layout
- Localize `USER_CANCELLED` messages when closing ID or face capture (`errors.userCancelledIdFlow`, `errors.userCancelledFaceFlow`)
- Reset default browser margins on `dl` and `dd` in UserInfo
- Fix `executeWorkflow` firing `/omni/workflow/info` and `/omni/workflow/current/node` twice when called without a `token`.
- Use Stable Version always on i18n fallback
- Add CDN fallback for translation loading
  When the primary i18nexus translations endpoint fails (network error or non-2xx response), the SDK now retries the same `{lng}/{ns}` resource against `https://cdn.incodesmile.com/translations/{version}/{lng}/{ns}.json`.&#x20;
- Update custom watchlist UI to match V2 design: replace modal loader with a shared StatusPage component using design-system Page, LoadingIcon, and SuccessIcon, with updated translation keys and accessibility focus on success.
- DocumentCapture: hide the upload option when `onlyAllowCapture: true` is passed. Removed the no-op `onlyCapture` and `nativeCamera` props from `DocumentCaptureProps`.
- Allow DOUBLE custom field type to accept decimal values
- Add guards to VideoSelfie buttons
- Fix `EncryptionLabel` overlapping the attempts text and primary CTA on desktop ID processing screens (`IdAnalyzing`, `IdSuccess`, `IdError`). The label is now rendered once inside `IdProcessingLayout`'s full-size `FrameContainer` (matching `CaptureOverlay`'s structure) so its absolute positioning math lines up with the camera frame, instead of being placed inside the `maxH: 900` content Flex where the math drifted on tall viewports.
- In V2 capture flows, when the user loses or revokes camera access mid-session, the camera overlay now shows the Denied instructions component so guidance matches the rest of the V2 permission experience.
- Disable "Tap when done" in the Video Selfie voice consent step until the recorder has captured at least the minimum required duration of audio. Prevents fast-tap races where the session finished without a voice consent recording attached.

[Download 1.90.0](https://sdk.incode.com/sdk/onBoarding-1.90.0.js)

</Accordion>

## 1.89.1
_12 May 2026_

<Accordion title="1.89.1">

### Fixed

- Fixed rate of False Negatives

[Download 1.89.1](https://sdk.incode.com/sdk/onBoarding-1.89.1.js)

</Accordion>

## 1.89.0
_4 May 2026_

<Accordion title="1.89.0">

### Added

- Document Capture design changed to V2, please refer to Figma for more info.
  - `nativeCamera` options removed, instead, use `onlyCapture` or `onlyUpload`.
    - `onlyCapture`: Will provide regular Incode camera overlay and capture with UI
    - `onlyUpload`: Will show system's file upload and camera
- Added support for multiple pages documents on Document Capture V2
- OTP for CURP improved, now is just one field and detects SMS auto complete.
- V2 flows can be activated via Dashboard configuration, please check your provisioning to support this on your flows.


### Fixed

- Fixed vulnerabilities on lodash library
- Do not upload or make unnecessary call for recording on CaptureOnly
- Biometric consent now shows correctly on certain ID that need it
- A11Y fixes for Face Capture
- Fixed transitions and smooth animations for CURP
- EKYC fields focus in correctly
- On Workflows, clicking "Refresh Page" button skips ID/Selfie capture

### Removed

- Third ID support is removed

[Download 1.89.0](https://sdk.incode.com/sdk/onBoarding-1.89.0.js)

</Accordion>

## 1.88.0
_16 March 2026_

<Accordion title="1.88.0">

### Added

- Adds help button config into ui config

- Add onLog callback support to renderCaptureId and renderCaptureFace

  - `onLog` callback is now available as an optional parameter in both `renderCaptureId` and `renderCaptureFace` methods
  - Callback receives `{ type: string; payload: { [key: string]: unknown } }` - same structure as `renderCamera`'s `onLog`
  - Enables clients to maintain their tracking logic when migrating from `renderCamera` to the newer SDK methods
  - V1 and V2 capture flows both support the callback; key events (e.g. `captureAttemptFinished`) are forwarded to `onLog`

- Adds `throwOnCameraPermissionDenied`

  - Added a new optional `throwOnCameraPermissionDenied` boolean prop to `renderCaptureId`, `renderCaptureFace`, and `renderAuthFace`. When enabled, the SDK immediately calls `onError` with a `PERMISSION_DENIED` error code instead of showing the built-in denied/learn-more permission screens.

  This gives integrators full control over the camera permission denied UX, allowing them to handle the error in their own application layer.

  **Affected render functions**

  - `renderCaptureId`
  - `renderCaptureFace`
  - `renderAuthFace`

  **Usage**

  ```ts
  incode.renderCaptureId(container, {
    session,
    captureConfig,
    onSuccess: handleSuccess,
    onError: handleError,
    throwOnCameraPermissionDenied: true,
  });

  incode.renderCaptureFace(container, {
    session,
    captureConfig,
    onSuccess: handleSuccess,
    onError: handleError,
    throwOnCameraPermissionDenied: true,
  });

  incode.renderAuthFace(container, {
    session,
    authHint,
    onSuccess: handleSuccess,
    onError: handleError,
    throwOnCameraPermissionDenied: true,
  });
  ```

  **Error shape**

  When camera permission is denied and `throwOnCameraPermissionDenied` is set, the `onError` callback receives:

  ```ts
  {
    code: 'PERMISSION_DENIED',
    message: 'Error in permissions',
    error: Error('PERMISSION_DENIED')
  }
  ```

  **Default behavior**

  When `throwOnCameraPermissionDenied` is not set (default `false`), the SDK continues to show the built-in permission denied and learn-more screens as before. No breaking changes.

- Improved document capture logging consistency and expanded support for passport document detection

### Fixed

- Update `swiper` dependency and remove unused `jspdf` dependency
- Move Sardine updateConfig to fire on screen change instead of module change

</Accordion>

## 1.87.0

*11 February 2026*

<Accordion title="1.87.0">

### Added

- Sentry Analytics (might require activation, please request to CS/SE)

### Fixed

- Unable to retry selfie capture after failed attempt on V1 when deepsight enabled
- Low quality conditions shown instead of remove hat/lens/mask
- Move resources to vanity CDN -> cdn.incodesmlite.com

[Download 1.87.0](https://sdk.incode.com/sdk/onBoarding-1.87.0.js)

</Accordion>

## 1.86.1

*16 January 2026*

<Accordion title="1.86.1">

### Fixed

- Fixed types

[Download 1.86.1](https://sdk.incode.com/sdk/onBoarding-1.86.1.js)

</Accordion>

## 1.86.0

*24 December 2025*

<Accordion title="1.86.0">

### Added

- When E2EE is enabled in Deepsight, videos are correctly encrypted
- Added face occlusion error for Selfie on both V1 and V2

### Fixed

- Issue where sometime ID module failed when BackID was enabled
- Sometimes fail screen is visible before the onError function is called
- Fixed layout for data entry on forms
- Remaining attempts showing correctly when capturing ID
- Execute face checks correctly on VS
- Fixed time for capturing on selfie
- CaptureID sometimes incorrectly detected borders of IDs
- Sardine Risk now updates on each module
- Fixed high risk vulnerabilities on SDK

[Download 1.86.0](https://sdk.incode.com/sdk/onBoarding-1.86.0.js)

</Accordion>

## 1.85.0

*21 November 2025*

<Accordion title="1.85.0">

### Added

- Recordings added to CaptureOnly when `enableIdRecording` enabled
- Tutorial can be skipped on document capture with `showTutorial:false`
- Phone and Email hint support
- Added `processFinanceSettlement` to `renderCamera("document")` method
- Close button can be hidden with `hideHeaderBranding` on `uiConfig`

### Fixed

- Autocapture timeout resets when module is closed
- RenderAuthFace crashing on second attempt
- Attempts counter on Selfie Capture v2
- Preview showing correctly on autocapture for ID v2
- Close buttons working on tutorial
- Moving to landscape/portrait on iPad no longer breaks layout
- `sendFingerprint` correctly sends cached information even when called multiple times

[Download 1.85.0](https://sdk.incode.com/sdk/onBoarding-1.85.0.js)

</Accordion>

## 1.84.0

*10 October 2025*

<Accordion title="1.84.0">

### Added

- New renderAuthFace module for identity verification, this uses v2
- New executeFlow module to provide a flow ID and execute from start to end without extra configuration
- Added captureOnly mode for v2, supporting deepsight
  **NOTE: Deepsight must be enabled and access to deepsight blobs might need to be requested.**
- Implement DMV scan and support to scan back -> front
- Improved loading times for camera

### Fixed

- Selfie checks are performed on renderLogin
- Better rendering for tablets
- Fixed small issues on Signature Screen
- Blank screens when switching apps
- Support for horizontal mode on Ipad

[Download 1.84.0](https://sdk.incode.com/sdk/onBoarding-1.84.0.js)

</Accordion>

## 1.83.1

*30 October 2025*

<Accordion title="1.83.1">

### Fixed

- OTP screen cleans correctly after failed attempt and doesn't flash anymore

[Download 1.83.1](https://sdk.incode.com/sdk/onBoarding-1.83.1.js)

</Accordion>

---

- Path: `release-notes/releases-xamarin-sdk`
- URL: https://developer.incode.com/release-notes/releases-xamarin-sdk/
- Markdown: https://developer.incode.com/release-notes/releases-xamarin-sdk.md

# Xamarin SDK Release Notes

## 2.0.2 
_16 April 2026_

- Removed Sentry Crash Reporting for Android platform.

Using iOS 5.37.0, Android 5.38.0

## 2.0.1 
_25 December 2025_

* Fix `Invalid Bundle - The bundle contains disallowed nested bundles` when uploading .ipa to AppStore on iOS.
* Removed Sentry binding project and added Sentry nuget package(v5.0.0) on Android.

## 2.0.0
_21 October 2025_

* Added 3 new modules `IdFront`, `IdBack` and `ProcessId`.
* `OnboardingConfiguration` replaced with `OnboardingSessionConfiguration`, which now has two additional fields `token` and `externalId`.
* `OnboardingFlowConfiguration` removed properties `FaceMatchParameters` and `IdScanCallback`. Added new properties `IdFrontScanParameters`, `IdBackScanParameters`, `IdFrontScanCallback`, `IdBackScanCallback` and `IdProcessCallback`.
* `OnboardingFlowConfiguration` method `AddIdScan` now has 3 optional callback parameters `idFrontScanCallback`, `idBackScanCallback` and `idProcessCallback`.
* `OnboardingFlowConfiguration` added methods `AddIdFrontScan`, `AddIdBackScan` and `AddProcessId`.
* `OnboardingFlowConfiguration` in method `AddFaceMatch`, parameter `faceMatchParams` is removed.
* `Init` method is taking one more optional parameter `disableJailbreak`, which disables specified checks for the iOS platform.
* `StartOnboarding` method is now taking 2 parameters `sessionConfig` and `flowConfig`.
* `SetOnboardingSession` and `CreateNewOnboardingSession` methods are replaced with `SetupOnboardingSession` method that accepts `sessionConfig` param of type `OnboardingSessionConfiguration`.
* `StartOnboardingSection` method `interviewId` parameter is removed.
* `VerifyFace` method `customerToken` parameter is removed, and the result is now `VerifyFaceResult` type instead of `SelfieScanResult`.
* `IdValidationResult` type is removed and 3 separate result types are introduced `IdFrontScanResult`, `IdBackScanResult` and `IdProcessResult`.
* `FaceMatchParams` type is removed.

Using iOS 5.37.0, Android 5.38.0 and .Net 9.0

---

- Path: `release-notes/rn-migration-guide`
- URL: https://developer.incode.com/release-notes/rn-migration-guide/
- Markdown: https://developer.incode.com/release-notes/rn-migration-guide.md

# Migration Guide

## Migration to 9.19.0

This version contains breaking changes. Find the APIs you use below and skip the rest.

| API | Android | iOS | What you need to do |
|-----|:-:|:-:|---------------------|
| [CurpValidation module](#curpvalidation-module) | ✓ | ✓ | Rename `CURP` in flow config and listeners; update `status` checks and empty-value checks |
| [Flow methods](#flow-methods): `startOnboarding`, `startOnboardingSection`, `startFlow`, `startWorkflow`, `startFlowFromDeepLink` | ✓ | ✓ | Handle `userCancelled` in `catch` instead of checking `status`; review `unknown` checks; handle `interrupted`; on iOS, replace `Incd:ONBOARDING_ERROR` / `Incd::ONBOARDING_ERROR` with the new codes |
| [startFlow](#startflow) | ✓ | ✓ | Update the start-up error codes in `catch`; stop relying on `Incd::invalidModuleId` |
| 💥 [startOnboardingSection](#startonboardingsection) | ✓ | ✓ | Always pass a non-blank `sectionTag`; rename `recordSessionConfig.forcePermissions` to `forcePermission`; handle `sectionAlreadyRunning` and `configError` in `catch` |
| [startWorkflow](#start-up-errors) | ✓ | ✓ | Handle `activityNotPresent` instead of `unknown` for a missing host Activity or view controller |
| [Geolocation module](#geolocation-module) | ✓ | ✓ | Read the address from `addressFields`, check `status`, and treat absent fields as unknown; on Android, stop reading `state` as the region; move `onStepError` logic into `onStepCompleted`, update `error` comparisons, and remove `GeolocationErrorEvent` |
| [Other fixes](#other-fixes) | ✓ | ✓ | Apply the changes: new `IncodeSdkFlowErrorCode` values; on Android, changes to `approve`, `startOnboarding` and `startOnboardingSection` |

### CurpValidation Module

The `CurpValidation` module (previously `CURP`) now takes its parameters and results from the shared native contract, so it returns the same payload on Android and iOS. Find the APIs your app calls and apply their changes.

#### CURP module renamed to CurpValidation

The module is now `CurpValidation` everywhere: in flow configuration, in the completion event,
and the event type. The old name is not accepted. A flow that still uses `CURP` rejects
with `unknownModule`.

```diff
- { module: 'CURP', validationEnabled: true }
+ { module: 'CurpValidation', validationEnabled: true }
```

Listeners change too:

```diff
  IncodeSdk.onStepCompleted({
-   module: 'CURP',
+   module: 'CurpValidation',
    listener: (e) => { /* ... */ },
  });
```

The exported event type is renamed to match:

```diff
- import type { CURPCompleteEvent } from 'react-native-incode-sdk';
+ import type { CurpValidationCompleteEvent } from 'react-native-incode-sdk';
```

#### `status` follows RENAPO's answer

When validation is enabled, `status` is `success` only if RENAPO accepts the CURP.
A RENAPO rejection sets `status` to `fail`, with `resultCode: "error"`. On Android,
a rejected CURP was previously reported as `success`. If your Android code treated `success`
as "a CURP was entered", check `curp` instead.

```diff
- if (e.result.status === 'success') { /* CURP entered, maybe not valid */ }
+ if (e.result.curp !== undefined) { /* CURP entered */ }
+ if (e.result.valid === true) { /* RENAPO accepted it */ }
```

With `validationEnabled: false`, `valid` and `data` are omitted and a captured CURP is
`success`. Before, Android reported `fail` and iOS reported `success`.

#### One event per module on Android

Android emitted a `CURP` event for each failed attempt, and one more for the final result.
It now emits one `CurpValidation` event, for the final result, as iOS does. If your listener
counted attempts or acted on the first event, update it to expect one event.

#### curp is omitted when absent

When no CURP was captured, entered, or generated, `curp` is omitted.

```diff
- if (e.result.curp !== '') { ... }
+ if (e.result.curp !== undefined) { ... }
```

### Flow Methods

#### A cancelled flow rejects with userCancelled

`startOnboarding`, `startOnboardingSection`, `startFlow`, `startWorkflow`, and `startFlowFromDeepLink` previously resolved with `{ status: 'userCancelled' }` when the user cancelled. They now reject with the code `userCancelled`. The resolved `status` is always `success`.

```diff
  try {
    const result = await IncodeSdk.startOnboarding({ flowConfig });
-   if (result.status === 'userCancelled') {
-     // the user closed the flow
-   }
  } catch (e) {
+   if (e.code === 'userCancelled') {
+     // the user closed the flow
+   }
  }
```

:::note
When the system ends a flow, for example by destroying the SDK screen while the app is in the background, the promise now rejects with the new code `interrupted` on both platforms. Before, the promise never settled on Android, and on iOS it rejected with `unknown`. A user cancellation still rejects with `userCancelled`.
:::

#### Changed rejection codes

These failures rejected with `unknown` before. They now have their own code, the same on Android and iOS:

| Failure | Platform | Previous | Current |
|---------|----------|----------|---------|
| Video Selfie not completed, for a reason other than a denied permission | Android, iOS | `unknown` | `videoSelfieNotCompleted` |
| Location not available | Android | `unknown` | `locationUnavailable` |
| Location permission denied | Android | `unknown` | `permissionsDenied` |
| Audio permission denied, or a fake-permission check | iOS | `unknown` | `permissionsDenied` |
| The user did not give biometric consent | Android, iOS | `unknown` | `biometricConsentNotGiven` |
| The biometric consent did not reach Incode | Android, iOS | `unknown` | `biometricConsentNotReceived` |
| Not enough free disk space for the SDK's ML models | Android | `unknown` | `insufficientDiskSpace` |
| On-device processing configured with an unsupported setting | Android | `unknown` | `onDeviceProcessingNotCompatible` |

On iOS, these failures reject with a new code. `error.message` carries the detail:

| Failure | Previous | Current |
|---------|----------|---------|
| The onboarding session could not be created | `unknown` | `sessionCreationFailed` |
| The CAPTCHA could not be verified | `Incd::ONBOARDING_ERROR` | `captchaNotVerified` |
| The flow has no onboarding session | `unknown` | `noActiveSession` |

On Android, a failed Captcha still rejects with `unknown`, because the Android SDK reports only a generic error.

If your app checks the old codes, check for the new ones. See the [flow error codes](/sdk-reference/react-native-results/) for the full list.

### startFlow

#### Start-up errors

| Failure | Platform | Previous | Current |
|---------|----------|----------|---------|
| No host Activity / view controller | Android | promise never settled | `activityNotPresent` |
| No host Activity / view controller | iOS | `IncdSDK:startFlow` | `activityNotPresent` |
| `sessionConfig` has neither `configurationId` nor `token` | Android, iOS | `unknown` (from the flow) | `configError` (before the flow starts) |
| The flow cannot start | Android | `Incd::startFlowException` | `unknown` |

`startWorkflow` also rejects with `activityNotPresent`, instead of `unknown`, when there is no host Activity or view controller.

#### Unknown moduleId

On Android, an unknown `moduleId` previously rejected with `Incd::invalidModuleId`. It now runs the whole flow, the same as iOS. Pass a valid module name if you resume a session from a module.

```diff
  try {
    await IncodeSdk.startFlow({ sessionConfig, moduleId });
  } catch (e) {
-   if (e.code === 'Incd::invalidModuleId' || e.code === 'IncdSDK:startFlow') {
+   if (e.code === 'activityNotPresent' || e.code === 'configError') {
      // handle
    }
  }
```

### startOnboardingSection

`startOnboardingSection` now checks its arguments the same way on Android and iOS.

#### sectionTag is required

`sectionTag` must be a non-blank string. If it is missing or blank, the call rejects with `configError`.

```diff
  await IncodeSdk.startOnboardingSection({
    flowConfig: [{ module: 'IdScan' }],
+   sectionTag: 'idSection',
  });
```

#### forcePermissions renamed to forcePermission

For `startOnboardingSection`, `recordSessionConfig` now has the type `OnboardingSectionRecordSessionConfig`. Its key is `forcePermission` (singular), and both keys are optional. The old key `forcePermissions` is not read, so the value falls back to `false`.

`startOnboarding` does not change. It still uses `OnboardingRecordSessionConfig` with `forcePermissions`.

```diff
  await IncodeSdk.startOnboardingSection({
    flowConfig,
    sectionTag: 'idSection',
-   recordSessionConfig: { recordSession: true, forcePermissions: true },
+   recordSessionConfig: { recordSession: true, forcePermission: true },
  });
```

If `recordSessionConfig` is present and is not an object, the call rejects with `configError`.

#### One section at a time

If you call `startOnboardingSection` while a section runs, the second call rejects with `sectionAlreadyRunning` on Android and iOS. The running section continues. Before, iOS rejected with `unknown`. Wait for the running section to settle before you start the next one.

#### Start-up errors

| Failure | Platform | Previous | Current |
|---------|----------|----------|---------|
| `sectionTag` missing or blank | Android, iOS | accepted | `configError` |
| `recordSessionConfig` is not an object | Android, iOS | ignored | `configError` |
| A `flowConfig` value cannot be read | Android | promise never settled | `configError` |
| A section is already running | Android, iOS | `unknown` (iOS) | `sectionAlreadyRunning` |
| No onboarding session | Android, iOS | `unknown` (iOS) | `noActiveSession` |

```diff
  } catch (e) {
+   if (e.code === 'configError') {
+     // check sectionTag, recordSessionConfig and the flowConfig values
+   }
+   if (e.code === 'sectionAlreadyRunning') {
+     // wait for the running section to settle
+   }
  }
```

### Geolocation Module

The `Geolocation` module now takes its parameters and results from the shared native contract, so it reports the same payload on Android and iOS. Apply these changes if your app reads `Geolocation` results.

#### Result shape

The address moved under `addressFields`, and coordinates and an outcome were added. Fields the SDK has no value for are absent instead of `""`.

```diff
 IncodeSdk.onStepCompleted({
   module: 'Geolocation',
   listener: (e) => {
-    const city = e.result.city;
+    if (e.result.status === 'success') {
+      const city = e.result.addressFields?.city;
+      const { latitude, longitude } = e.result;
+    }
   },
 });
```

#### state is the country name

`state` now holds the country name on both platforms. On Android it previously held the region (for example `CDMX`); it now holds the country (for example `Mexico`), as it already did on iOS. `city` falls back to the region when the city is unknown. If your app needs the region on Android, it is no longer reported.

#### Skipped or unavailable locations are completed steps

A skipped, denied, or unavailable location no longer fires `onStepError`. It is reported through `onStepCompleted` with `status: 'fail'`, and the reason is in `error`. Move any `onStepError({ module: 'Geolocation' })` logic into your `onStepCompleted` listener, and remove references to the `GeolocationErrorEvent` type:

```diff
-IncodeSdk.onStepError({
-  module: 'Geolocation',
-  listener: (e) => handleNoLocation(e.status),
-});
+IncodeSdk.onStepCompleted({
+  module: 'Geolocation',
+  listener: (e) => {
+    if (e.result.status === 'fail') handleNoLocation(e.result.error);
+  },
+});
```

The `error` values are `permissionsDenied`, `locationUnavailable`, `sslPinningFailed`, `integrityCompromised`, and `unknown`, replacing `unknownError` and `noLocationExtracted`. When `isSkippable` is `false`, the flow still ends through `onError`. On Android, `onStepCompleted` first reports the `fail` result, and then `onError` fires.

:::note
**Behavior change (Android):** A failed non-skippable `Geolocation` step now reaches `onError` as `permissionsDenied` or `locationUnavailable`, instead of `unknown`. Update any `onError` logic that checks for `unknown` after a `Geolocation` failure.
:::

### Other Fixes

#### New IncodeSdkFlowErrorCode values

`IncodeSdkFlowErrorCode` gains `unknownModule`, `methodNotSupportedByBridge`,
`bridgeFailure`, and `activityNotPresent`. The SDK already rejects with these codes. Now
the type declares them, so `e.code` checks against them type-check. Code that switches
exhaustively over `IncodeSdkFlowErrorCode` must handle the new values.

```diff
  switch (e.code) {
    // ...
+   case 'unknownModule':
+   case 'methodNotSupportedByBridge':
+   case 'bridgeFailure':
+   case 'activityNotPresent':
+     // ...
+     break;
  }
```

#### approve on Android

`approve` now rejects with `bridgeFailure` when the native call throws. Before, the app
crashed. It rejects with `methodNotSupportedByBridge` when the installed native SDK has no
handler for `approve`. Before, the promise never settled.

```diff
  } catch (e) {
+   if (e.code === 'methodNotSupportedByBridge' || e.code === 'bridgeFailure') {
+     // the installed native SDK does not match this SDK version
+   }
  }
```

#### startOnboarding and startOnboardingSection on Android

If the SDK cannot read a `flowConfig` value, such as a value of the wrong type,
`startOnboarding` rejects with `Incd::StartOnboardingException` and `startOnboardingSection`
rejects with `configError`. `error.message` gives the reason.
Before, the promise never settled.

If no activity is present, `startOnboardingSection` rejects with `activityNotPresent`, like
`startOnboarding` and `approve`. Before, the promise never settled.

```diff
  } catch (e) {
+   if (e.code === 'Incd::StartOnboardingException' || e.code === 'configError') {
+     // check the flowConfig values against the module reference
+   }
  }
```

## Migration to 9.18.0

<Accordion title="Migration to 9.18.0">

### Summary

`approve`, `getUserScore`, `faceMatch`, and `startWorkflow` now run through the shared Incode bridge, so each one returns the same payloads and error codes on Android and iOS. The `Phone`, `Email`, and `FullName` modules likewise now take their parameters and results from the shared native contract. Most of the changes below follow from that. Find the APIs your app calls and apply their changes:

| API | Android | iOS | What you need to do |
|-----|:-:|:-:|---------------------|
| [`approve`](#approve) | ✓ | ✓ | Update result reads and `Approve` step listeners, and handle `userCancelled` in `catch` |
| [`getUserScore` / `UserScore` module](#getuserscore-and-the-userscore-module) | ✓ | ✓ | Rename `mode` to `fetchMode`, remap field reads, and add error handling |
| [`faceMatch`](#facematch) | ✓ | ✓ | Derive the match from `isFaceMatched`, update `catch` blocks, and guard optional fields |
| [`startWorkflow`](#startworkflow) | ✓ | ✓ | Update `catch` blocks |
| [`startOnboarding` / `startOnboardingSection`](#startonboarding-and-startonboardingsection) | ✓ | ✓ | Fix module names in `flowConfig` and handle `unknownModule` in `catch` |
| [`Phone`, `Email`, and `FullName` modules](#phone-email-and-fullname-modules) | ✓ | ✓ | Rename `Name` in flow config and listeners, update `resultCode` comparisons and empty-value checks |
| [iOS specific changes](#ios-specific-changes) | | ✓ | Apply the changes |
| [Android specific changes](#android-specific-changes) | ✓ | | Apply the changes |

### `approve`

#### Approval result fields

`approve` now resolves the same payload the `Approve` module step event reports. The `status` string is replaced by a `success` boolean, `id` is renamed to `uuid`, and a new `error` field reports an iOS-only approval error. `uuid`, `customerToken`, and `error` are `null` when the SDK has no value for them; they were previously empty strings.

| Previous | Current |
|----------|---------|
| `status: 'approved' \| 'failed'` | `success: boolean` |
| `id: string` | `uuid: string \| null` |
| `customerToken: string` | `customerToken: string \| null` |
| — | `error: string \| null` (iOS only, always `null` on Android) |

```diff
- const { status, id, customerToken } = await IncodeSdk.approve({ forceApproval: false });
- if (status === 'approved') { /* ... */ }
+ const { success, uuid, customerToken, error } = await IncodeSdk.approve({ forceApproval: false });
+ if (success) { /* ... */ }
```

#### Approve step event payload

`ApproveCompleteEvent.result` is the same `ApprovalResult` type, so the `Approve` module step event changed with it on both platforms. Update `onStepCompleted` listeners registered for the `Approve` module.

```diff
  IncodeSdk.onStepCompleted({
    module: 'Approve',
-   listener: ({ result }) => console.log(result.status, result.id),
+   listener: ({ result }) => console.log(result.success, result.uuid),
  });
```

Standalone `approve` also emits this event on iOS now. It previously fired on Android only, so an iOS listener may see an `Approve` step event where it saw none before.

#### Approve now rejects on cancellation

`approve` rejects the promise on every failure, with the native error code and message. On Android it previously resolved `{ status: 'userCancelled' }` when the user cancelled the section; on iOS the promise never settled at all. Wrap the call in `try/catch` and handle `userCancelled` there.

```diff
- const result = await IncodeSdk.approve({ forceApproval: false });
- if (result.status === 'userCancelled') { /* ... */ }
+ try {
+   const result = await IncodeSdk.approve({ forceApproval: false });
+ } catch (e) {
+   if (e.code === 'userCancelled') { /* ... */ }
+ }
```

The other error codes are `approvalError` (Android only, the approval flow could not be configured) and any `IncodeSdkFlowErrorCode` value, such as `sslPinningFailed` or `unknown`.

An approval that ran but did not approve the user is not an error. It resolves with `success: false`.

### `getUserScore` and the `UserScore` module

`getUserScore` and the `UserScore` module now share one result shape, produced by the shared Incode bridge, so both platforms return identical payloads.

#### Renamed `getUserScore` parameter `mode` -> `fetchMode`

```diff
-await IncodeSdk.getUserScore({ mode: 'accurate' });
+await IncodeSdk.getUserScore({ fetchMode: 'accurate' });
```

The old name is no longer read. A call still passing `mode` does not raise an error, it silently falls back to the `accurate` default, so update every call site even where TypeScript does not flag it.

#### Changed the `getUserScore` result shape

`getUserScore` now resolves with `UserScoreResult` instead of the `data`-wrapped object. The `UserScore` type is removed.

Previously, as declared by the `UserScore` type:

```ts
{
  extendedUserScoreJsonData: string;
  data: {
    overallScore: string;
    status: 'ok' | 'warn' | 'unknown' | 'fail' | 'manual';
    facialRecognitionScore: string;
    existingUser: boolean;
    idVerificationScore: string;
    livenessOverallScore: string;
  };
}
```

iOS did not always honour that declaration at runtime — see [Changed score value and status formats](#changed-score-value-and-status-formats) below.

Now, with every score expressed as a `{ value, status }` pair (`…` abbreviates that pair):

```ts
{
  extendedUserScoreJsonData: string;
  overall: { value: string | null; status: UserScoreStatus | null };
  idValidation?: { overall: …; photoSecurityAndQuality: UserScoreCheck[]; idSpecific: UserScoreCheck[] };
  liveness?: { overall: …; livenessScore: …; photoQuality: string | null };
  faceRecognition?: { overall: …; existingUser: boolean };
  governmentValidation?: { overall: …; recognitionConfidence: …; validationStatus: UserScoreCheck; ocrValidation: UserScoreCheck[] };
}
```

Map your existing field reads as follows:

| Previously | Now |
|---|---|
| `result.data.overallScore` | `result.overall.value` |
| `result.data.status` | `result.overall.status` |
| `result.data.facialRecognitionScore` | `result.faceRecognition?.overall.value` |
| `result.data.existingUser` | `result.faceRecognition?.existingUser` |
| `result.data.idVerificationScore` | `result.idValidation?.overall.value` |
| `result.data.livenessOverallScore` | `result.liveness?.overall.value` |
| `result.extendedUserScoreJsonData` | `result.extendedUserScoreJsonData` (unchanged) |

A section key is present only when the server returned that section, so `idValidation`, `liveness`, `faceRecognition` and `governmentValidation` are optional and need a `?.` guard. `overall` and `extendedUserScoreJsonData` are always present.

```diff
-const score = await IncodeSdk.getUserScore({ mode: 'accurate' });
-console.log(score.data.overallScore, score.data.status);
-console.log(score.data.livenessOverallScore);
+const score = await IncodeSdk.getUserScore({ fetchMode: 'accurate' });
+console.log(score.overall.value, score.overall.status);
+console.log(score.liveness?.overall.value);
```

#### Changed the `UserScore` module step-complete event

The `UserScore` module's step-complete event now delivers that same `UserScoreResult`, so the field mapping in the table above applies here too.

```diff
 IncodeSdk.onStepCompleted({
   module: 'UserScore',
   listener: (e) => {
-    console.log(e.result.data.overallScore);
+    console.log(e.result.overall.value);
   },
 });
```

On iOS the event no longer carries a `{ debug: … }` payload when the score is empty; the result is always well formed.

#### Changed score value and status formats

These apply to `getUserScore` and the `UserScore` module event alike.

* **Android**: score values no longer carry the `/100` suffix. `"80.5/100"` is now `"80.5"`. Strip any parsing that split on `/`.
* **iOS**: the `warn` status was previously reported as `warning`. Update comparisons against that value.
* **iOS**: `existingUser` is now a boolean rather than the string `"true"` / `"false"`.
* **Both**: absent values are `null` rather than `""`. A check like `if (score.overall.value)` still works, but `=== ''` does not.

`extendedUserScoreJsonData` carries the same content on both platforms, but not the same bytes: Android re-serializes the parsed response, so key order and numeric formatting can differ. Parse this field, never compare or hash it across platforms.

#### `getUserScore` now rejects when the score cannot be fetched

On iOS the promise previously resolved with an empty result when the fetch failed. Both platforms now reject, so add error handling if you did not have it:

```diff
-const score = await IncodeSdk.getUserScore({ fetchMode: 'accurate' });
-console.log(score.overall.value);
+try {
+  const score = await IncodeSdk.getUserScore({ fetchMode: 'accurate' });
+  console.log(score.overall.value);
+} catch (error) {
+  console.error(error.code, error.message);
+}
```

The rejection `code` is one of:

* `userScoreFailed` — the score could not be fetched: a transport or HTTP failure, or a session that produced no score. On Android this replaces the previous behaviour of completing with an empty result.
* `userCancelled` — the user cancelled. Not expected in practice, since this call shows no UI, and it never occurs on iOS.

### `faceMatch`

All changes affect the standalone `IncodeSdk.faceMatch()` only. The `FaceMatch` module event from `startOnboarding`/`startFlow` is unchanged.

#### Removed `status` from the result

Derive it from `isFaceMatched`:

```diff
- if (result.status === 'match') { ... }
+ if (result.isFaceMatched === true) { ... }
```

Not a straight substitution: `status` was always `'match'` or `'mismatch'`, whereas an absent `isFaceMatched` now means no comparison was possible.

`FaceMatchResult` and `FaceMatchCompleteEvent` were one shared type and are now separate — `FaceMatchResult` describes only the standalone call. If you used it to type a module event handler, switch to `FaceMatchCompleteEvent`, which still has `status`.

#### Result field `existingUser` renamed to `isExistingUser`

**Android only** — iOS already returned `isExistingUser`.

```diff
- console.log(result.existingUser);
+ console.log(result.isExistingUser);
```

#### Rejection codes changed

`faceMatchError` replaces `IncdSDK:faceMatch` (iOS) and `EUNSPECIFIED` (Android). `userCancelled` replaces `Incd::FaceMatch::UserCancelled`, matching the Flutter and Cordova SDKs.

```diff
  } catch (e) {
-   if (e.code === 'IncdSDK:faceMatch') { ... }
-   if (e.code === 'Incd::FaceMatch::UserCancelled') { ... }
+   if (e.code === 'faceMatchError') { console.log(e.message); }
+   if (e.code === 'userCancelled') { ... }
  }
```

`userCancelled` is **Android only** — iOS has no distinct cancellation signal, so cancellations there reject with `faceMatchError`. Other SDK methods keep their own `Incd::…::UserCancelled` codes.

#### Unavailable fields are omitted on iOS, not defaulted

`isFaceMatched`, `isNameMatched`, `nfcVsIdConfidence`, `nfcVsSelfieConfidence`, `secondIdConfidence` were `false`/`0` when the native SDK had no value, and `existingInterviewId` was `""`. They are now absent, so a present value is always real.

```diff
- if (result.nfcVsIdConfidence > 0.8) { ... }
+ if (result.nfcVsIdConfidence !== undefined && result.nfcVsIdConfidence > 0.8) { ... }
```

#### Confidence scores of `-1` are omitted on Android, not returned

The native SDK returns `-1` for `confidence`, `nfcVsIdConfidence` and `nfcVsSelfieConfidence` when the image needed for the comparison was never uploaded. That `-1` used to reach you as if it were a score. The key is now absent instead, matching iOS.

```diff
- if (result.confidence === -1) { /* nothing to compare */ }
+ if (result.confidence === undefined) { /* nothing to compare */ }
```

A `0` is unaffected — it is a real "no match" score.

#### Resolves instead of rejecting when no confidence score is available

On Android this previously rejected with `IncdSDK:faceMatch` / `Error`. It now resolves with the unavailable fields omitted. If you caught that rejection to detect "no comparison possible", check for the absence of `isFaceMatched` instead.

### `startWorkflow`

#### Rejection code changed for a missing presenting screen

`startWorkflow` rejects with `unknown` on both platforms when there is no screen to present the flow on, matching the code already used for other unclassified failures. This replaces `Incd::StartWorkflowException` on Android and `IncdSDK:startWorkflow` on iOS.

```diff
  } catch (e) {
-   if (e.code === 'Incd::StartWorkflowException') { ... } // Android
-   if (e.code === 'IncdSDK:startWorkflow') { ... }         // iOS
+   if (e.code === 'unknown') { ... }
  }
```

### `startOnboarding` and `startOnboardingSection`

#### An unknown module name now rejects

If a `flowConfig` entry names a module that the SDK does not recognize, `startOnboarding` and `startOnboardingSection` reject with `unknownModule`. `error.message` gives the module name. Before, iOS left the step out and the flow still resolved with `success`, so the user never saw the module. Android threw an uncaught exception instead of rejecting the promise.

The usual cause is the old `Name` module. Rename it to `FullName`, as the next section shows.

```diff
  } catch (e) {
+   if (e.code === 'unknownModule') {
+     // a flowConfig entry has a misspelled or removed module name
+   }
  }
```

### `Phone`, `Email`, and `FullName` modules

#### `Name` module renamed to `FullName`

The module is now `FullName` everywhere — flow configuration, the completion event, and
the event type.

```diff
- { module: 'Name' }
+ { module: 'FullName' }
```

Listeners change too:

```diff
  IncodeSdk.onStepCompleted({
-   module: 'Name',
+   module: 'FullName',
    listener: (e) => { /* ... */ },
  });
```

The exported event type is renamed to match:

```diff
- import type { NameCompleteEvent } from 'react-native-incode-sdk';
+ import type { FullNameCompleteEvent } from 'react-native-incode-sdk';
```

#### Module results share one shape

`Phone`, `Email`, and `FullName` now return the same fields on both platforms.

```diff
- { phone: "+15555555555", resultCode: "SUCCESS" }
+ { phone: "+15555555555", status: "success", resultCode: "success" }
```

`status` is the portable outcome, `resultCode` the finer detail. Check existing code for
the two changes below, then for the two platform-specific failure changes that follow:

```diff
// resultCode values are now camelCase, matching what the types always declared
- if (e.result.resultCode === 'SUCCESS') { ... }
+ if (e.result.resultCode === 'success') { ... }

// the captured value is omitted when the SDK has none, rather than null or ""
- if (e.result.phone !== '') { ... }
+ if (e.result.phone !== undefined) { ... }
```

**Android `FullName` failure `status`.** A failed `FullName` used to report the native
SDK's error message as `status`, so the value was an arbitrary sentence. It is now `fail`,
like every other module.

```diff
- if (e.result.status !== 'success') { showError(e.result.status); }
+ if (e.result.status !== 'success') { showError(e.result.resultCode); }
```

**iOS `Phone` failure delivery.** A failed `Phone` used to arrive as a step *error* on iOS
and as a completed event on Android. It is now a completed event carrying
`status: "fail"` on both platforms, matching `Email` and `FullName`. If you handled iOS
phone failures in an error handler, move that logic to the module listener.

#### A step that cannot be added is skipped

If the native SDK cannot add a `Phone`, `Email`, or `FullName` step from its configuration, the SDK logs `Module <name> was not added: <reason>` and leaves that step out of the flow. The flow still starts, and the promise resolves without that step. The promise does not reject. If one of these steps does not show, look for this warning in the device log (Logcat tag `INCD` on Android, the Xcode console on iOS).

### iOS specific changes

#### New `IncodeBridgeCommon` pod dependency

The iOS plugin now depends on the `IncodeBridgeCommon` pod, declared by the plugin itself. No source change is needed in your app, but the new pod has to be resolved, so reinstall the pods after updating the plugin:

```sh
pod install
```

#### Add URL schemes to `Info.plist` on iOS

The iOS SDK 5.50.0 jailbreak detection queries a set of URL schemes. Add them to `LSApplicationQueriesSchemes` in your app's `Info.plist`:

```xml
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>cydia</string>
  <string>undecimus</string>
  <string>sileo</string>
  <string>zbra</string>
  <string>filza</string>
  <string>activator</string>
  <string>installer</string>
  <string>saily</string>
  <string>xina</string>
  <string>dopamine</string>
</array>
```

If your app already declares `LSApplicationQueriesSchemes`, keep the existing array and add only the missing entries. Keep the combined list within Apple's limit: 50 entries when linked with iOS 15–26 SDKs, or 25 with iOS 27 and later.

#### Review OCR required-field marker on iOS

The Review OCR screen now shows a subtitle, "All fields marked with * are required.", and the asterisk moved from a prefix to a suffix (`Full name *`). If you override the Review OCR strings with `setString`, set the new `incdOnboarding.ocr.requiredSubTitle` key too.

### Android specific changes

#### Android theme color `positive800` renamed to `positive750`

The Android SDK 5.54.0 renamed the `positive800` color to `positive750` (same color) to match Incode Studio's exported palette. If the theme JSON you pass to `setTheme` sets `colorPalette.positive800`, rename the key. Unknown keys are ignored, so the old key does not raise an error: the color silently falls back to the default.

```diff
  await IncodeSdk.setTheme({
    theme: JSON.stringify({
      colorPalette: {
-       positive800: '#0C5030',
+       positive750: '#0C5030',
      },
    }),
  });
```

#### Stricter theme color parsing on Android

`setTheme` on Android now rejects with `appearanceError` when a color in the theme JSON is not a string (for example an unquoted number like `123456` or a boolean), or is an empty `[light, dark]` array. Such themes were previously applied by accident. Quote every color value, for example `"#123456"`.

</Accordion>

## Migration to 9.17.0

<Accordion title="Migration to 9.17.0">

### <Pill type="breaking" /> Android event names delivered through `onEvents` now use the SDK value form

Every event name delivered through `onEvents` on Android changed from the SDK enum constant name (for example, `USER_CANCELLED`, `MODULE_OPENED`) to the SDK's camelCase value (for example, `userCanceled`, `moduleOpened`). This matches what iOS has always emitted. Any code that compares an Android event name against the old constant-name strings must be updated.

```diff
  IncodeSdk.onEvents((eventBatch) => {
    for (const e of eventBatch.events) {
-     if (e.event === 'USER_CANCELLED') {
+     if (e.event === 'userCanceled') {
        handleUserCancel();
      }
    }
  });
```

Also, update every dashboard query, saved report, or server-side rule that matches the old constant-name strings.

This does not affect the flow promises. `startOnboarding`, `startFlow`, `startWorkflow`, and `startOnboardingSection` still resolve with `{ status: 'userCancelled' }`.

### New `storageUnavailable` flow error code on Android

`IncodeSdkFlowErrorCode` gains `storageUnavailable`. Flow APIs reject with it when the device cannot provide a writable images directory at flow start. Code that switches exhaustively over `IncodeSdkFlowErrorCode` must handle the new value.

### Signature V2 title and description string overrides on Android

If the Signature V2 experience is enabled for your account and you override the V1 title and description strings, add the V2 overrides to your Android `res/values/strings.xml`:

```xml
<string name="onboard_sdk_signature_capture_title">Your title</string>
<string name="onboard_sdk_signature_capture_description">Your description</string>
```

Keep the V1 overrides if your integration still uses Signature V1:

```xml
<string name="onboard_sdk_signature_title">Your title</string>
<string name="onboard_sdk_signature_description">Your description</string>
```

No change is required if you do not override these strings. The `title` and `description` parameters of the `Signature` module keep applying to both versions.

### Video Selfie V2 hides the close button on the camera steps on Android

When Video Selfie V2 is enabled for your account, its camera steps hide the close (X) button, so `IncodeSdk.showCloseButton(true)` does not apply to them. The button still shows on the other screens. Video Selfie V1 keeps the button over the camera. No code change is required. If your users rely on the close button to leave a camera step, tell them about the new behavior or keep Video Selfie V1.

### Unit tests that load SQLCipher must run on JVM 17 or later on Android

The Android SDK now uses `net.zetetic:sqlcipher-android:4.17.0`, which ships Java 17 bytecode. Your app build is not affected: AGP 8 with JDK 17 reads it correctly. JVM unit tests (including Robolectric) that load SQLCipher classes, directly or through SDK code paths that use the encrypted database, must run on JVM 17 or later:

```groovy
// build.gradle of the module that runs the tests
java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}
```

Instrumented tests on a device or emulator are not affected.

### `MLConsent` status now reflects the user's choice on iOS

The `MLConsent` module step used to report a successful status whenever the submission call succeeded, even when the user declined the consent. It now reports the choice the user made: a successful status when the consent was accepted and a failed status when it was declined. The consent stays optional and the flow continues in both cases. If your app treats the `MLConsent` status as _submitted_, update it to treat a failed status as _declined_.

### Combined Consents stops on an unshowable mandatory consent on iOS

A mandatory Combined Consent that has no readable text or checkbox ID can no longer be silently accepted. The module ends and the flow stops with an error delivered to your `onError` handler, so `startOnboarding` and `startFlow` reject with the new `combinedConsentsNotReceived` code. Text that is empty or only spaces counts as missing text. Give the consent text in Dashboard to clear the error. Optional consents that cannot be shown are still left out and the flow continues, as before.

</Accordion>

## Migration to 9.16.0

<Accordion title="Migration to 9.16.0">

### Add the IncodeBridgeCommon CocoaPods source

iOS builds now depend on `IncodeBridgeCommon`. Add this source at the top of your `Podfile`. Access to Incode's GitHub org is required; if you do not have it, contact your Incode representative.

```diff
  source 'https://cdn.cocoapods.org/'
  source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
+ source 'git@github.com:Incode-Technologies-Example-Repos/IncodeBridgeCommonPodspecs.git'
```

Then run `pod install --repo-update` in the `ios` folder.

### Appearance argument names

These methods use new argument names. Update call sites accordingly.

| Method | Previous | Current |
|--------|----------|---------|
| `setTheme` | `{ jsonTheme }` | `{ theme }` |
| `setFaceAuthenticationHint` | `string` or `{ faceAuthenticationHint }` | `{ identityId }` |

```js
await IncodeSdk.setTheme({ theme: JSON.stringify(theme) });
await IncodeSdk.setFaceAuthenticationHint({ identityId: 'customer@example.com' });
```

The TypeScript parameter for `showCloseButton` is now `allowUserToCancel` instead of `shouldShowCloseButton`. JavaScript call sites stay `showCloseButton(true)` and do not need to change.

### Appearance return types

`setLocalizationLanguage` is now `Promise<void>`; it was incorrectly typed as `Promise<string>`. `setSdkMode`, `setTheme`, and `setUXConfig` are now `Promise<void>`; they were `Promise<any>`. Call sites that only `await` these methods do not need to change.

### Appearance errors

`setTheme` and `setUXConfig` now reject the promise with `appearanceError` when the payload is missing or invalid. They previously resolved `{ success: false, error }`. Wrap these calls in `try/catch` if you need to handle a failed theme or UX config.

The other appearance methods (`setSdkMode`, `setString`, `setLocalizationLanguage`, `showCloseButton`, `setFaceAuthenticationHint`) already rejected on failure.

### iOS promise settlement

On iOS, `showCloseButton`, `setLocalizationLanguage`, and `setString` now wait for the native call to finish before the promise resolves. Previously, those methods were fire-and-forget on iOS; `await` returned immediately.

### Removed parameters
- Removed the `waitForTutorials` parameter from the `initialize` method.

### Changed default behavior for SSL pinning

Previously, enabling SSL pinning (`sslPinningConfig.enabled: true`) always forced pinning enforcement, with no way to opt out. Starting in 9.16.0, forced enforcement is controlled by the new `forceSSLPinning` field and defaults to `false`.

If you rely on strict/forced SSL pinning enforcement, you must now explicitly set:

```js
sslPinningConfig: { enabled: true, forceSSLPinning: true }
```

Omitting `forceSSLPinning` now results  in non-forced enforcement.

### Minimum Kotlin version raised to 2.2.x

The Android SDK is compiled with Kotlin `2.2.21`. Any module that compiles Kotlin source with the SDK on its classpath must use Kotlin Gradle plugin `2.2.21` or higher.

```groovy
plugins {
  id 'org.jetbrains.kotlin.android' version '2.2.21'
}
```

### Add required OkHttp packaging exclusion

Add the following exclusion to avoid duplicate-resource packaging collisions:

```groovy
android {
  packaging {
    resources {
      excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
    }
  }
}
```

### Upgrade compileSdk / AGP / Gradle wrapper

```groovy
compileSdk 36
```

Use Android Gradle Plugin `8.9.1` or higher and Gradle `8.14.5` or higher.

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.5-bin.zip
```

### Coroutines floor

If your app pins coroutines explicitly, use:

```groovy
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
```

### React Native 0.78 Android build compatibility note

If you hit `KotlinTopLevelExtension` or Kotlin toolchain alignment issues with React Native `0.78.x` and Kotlin `2.2.x`, disable RNGP Java/Kotlin auto-alignment and enforce Java 17 compile options in your Android projects.

</Accordion>

## Changed the signature and functionality of the `setQuantityStrings` method

<Accordion title="Changed the signature and functionality of the `setQuantityStrings` method">

The `setQuantityStrings` method's `strings` parameter was removed and, in its place, `locale` and `quantityStrings` parameters were introduced. The first one accepts a language code such as `"en"`, `"es"`, or `"en-US"`, and the latter a map shaped as `plural name → quantity keyword → value`. With this change, multi-locale-per-call support was removed. Callers integrating two or more languages must now call the method once per locale, like this:

**Before:**
```js
await IncodeSdk.setQuantityStrings({
  en: {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d attempt remaining",
      other: "%d attempts remaining"
    }
  },
  es: {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d intento restante",
      other: "%d intentos restantes"
    }
  }
});
```

**After:**
```js
await IncodeSdk.setQuantityStrings(
  'en',
  {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d attempt remaining",
      other: "%d attempts remaining"
    }
  }
);

await IncodeSdk.setQuantityStrings(
  'es',
  {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d intento restante",
      other: "%d intentos restantes"
    }
  }
);
```

Now, when erroring out, the method returns a code specific to the cause of the error alongside a message and native stack trace, instead of returning a `SET_QUANTITY_STRINGS_ERROR` code.

</Accordion>

## Migration to 9.15.0

<Accordion title="Migration to 9.15.0">

### Removed parameters
- Removed `disableJailbreakDetection` parameter from `initialize` method.
- Removed `jailbreakDetected` from `IncodeSdkFlowErrorCode`.

</Accordion>

## Migration to 9.14.0

<Accordion title="Migration to 9.14.0">

### Renamed neutral and black color palette tokens on Android

The neutral and black keys in theme's colorPalette have been renamed:

neutral -> neutralLight
black -> neutralDark
If you provided the theme via a JSON config, rename the keys inside colorPalette:

```diff
"colorPalette": {
+  "neutralLight": "#ffffff",
-  "neutral": "#ffffff",
+  "neutralDark": "#000000",
-  "black": "#000000",
  "brand50": "#e5f0ff",
  ...
  "positive500": "#189F60",
  "positive600": "#189F60",
  "positive800": "#0C5030"
}
```

Theme JSON that still uses the old neutral / black keys will silently fall back to the defaults (#FFFFFF and #000000), because unknown keys are ignored during parsing. Update your JSON to use the new keys to keep your customizations applied.

</Accordion>

## Migration to 9.13.0

<Accordion title="Migration to 9.13.0">

### Changed the default values of `lensesCheck` and `faceMaskCheck` parameters in SelfieScan module

The default values for `lensesCheck` and `faceMaskCheck` parameters in `SelfieScan` module have been changed from `false` to `true`. If you did not previously configure these flags, they will now be enforced by default during face capture.
To preserve the previous behavior, explicitly disable these flags.

### SQLCipher attribution required if you ship an open-source licenses screen on Android

Local Room databases used by the SDK are now encrypted at rest with [SQLCipher for Android](https://github.com/sqlcipher/sqlcipher-android), distributed under a BSD-style license. The license requires consumers that redistribute binaries (i.e. your application) to reproduce its copyright notice "in the documentation and/or other materials provided with the distribution".

If your application includes an "Open Source Licenses" screen, please add the SQLCipher notice listed in [Licenses](https://developer.incode.com/docs/licenses-open-source-attributions). No code change is needed if you do not ship such a screen.

</Accordion>

## Migration to 9.11.0

<Accordion title="Migration to 9.11.0">

### Document chooser in the `IdScan` module on iOS

**iOS.** Setting `idType` no longer hides the document chooser screen. With `startOnboarding` and `startOnboardingSection`, only `showIdTypeChooser: false` hides it, and the Dashboard's **Show document chooser screen** setting is ignored. With `startFlow` and `startWorkflow`, the Dashboard setting applies.

If you set `idType` to skip the chooser, add `showIdTypeChooser: false`. The same applies to `IdScanFront`.

```diff
  {
    module: 'IdScan',
    idType: 'id',
+   showIdTypeChooser: false,
  }
```

### Removed localization keys on iOS

- `incdOnboarding.nameInfo.lastnamePlaceholder`
- `incdOnboarding.ccv.invalidCCV`

### Renamed localization keys on iOS

- `incdOnboarding.email.title` -> `incdOnboarding.userInformation.email.title`
- `incdOnboarding.email.invalidEmail` -> `incdOnboarding.userInformation.email.wrongFormat`
- `incdOnboarding.ccv.title` -> `incdOnboarding.userInformation.securityCode.title`
- `incdOnboarding.nameInfo.title` -> `incdOnboarding.userInformation.fullName.title`
- `incdOnboarding.nameInfo.subtitle` -> `incdOnboarding.userInformation.fullName.subtitle`
- `incdOnboarding.nameInfo.namePlaceholder` -> `incdOnboarding.userInformation.fullName.placeholder`
- `incdOnboarding.nameInfo.continue` -> `incdOnboarding.userInformation.continue`
- `incdOnboarding.ekyc.input.label.fillYourCredentials` -> `incdOnboarding.ekyc.input.title`

</Accordion>

## Migration to 9.10.0

<Accordion title="Migration to 9.10.0">

### Removed parameters
- Removed `disableHookDetection`, `disableEmulatorDetection`, `disableRootDetection`, `disableVirtualEnvironmentDetection` parameters from `init` method.
- Removed `simulatorDetected`, `rootDetected`, `hookDetected`, `virtualEnvDetected` from `IncodeSdkFlowError`.

### Document chooser in the `IdScan` module on Android

**Android.** Setting `idType` no longer hides the document chooser screen. With `startOnboarding` and `startOnboardingSection`, only `showIdTypeChooser: false` hides it, and the Dashboard's **Show document chooser screen** setting is ignored. With `startFlow` and `startWorkflow`, the Dashboard setting applies.

If you set `idType` to skip the chooser, add `showIdTypeChooser: false`. The same applies to `IdScanFront`.

```diff
  {
    module: 'IdScan',
    idType: 'id',
+   showIdTypeChooser: false,
  }
```

### Color palette changes on Android

If you previously customized the application appearance by updating these colors from the color palette:

```json
{
    "colorPalette": {
        "negative500": "#FF5A5F",
        "negative600": "#E71111",
        "positive500": "#189F60",
        "positive600": "#189F60"
    }
}
```

These keys have now been migrated to the following values:
- `negative500` -> `negative400`
- `negative600` -> `negative500`
- `positive500` -> `positive400`
- `positive600` -> `positive500`

The mentioned colors are used for the following Color Modes:
- `Icon/Status/Negative`
- `Icon/Status/Positive`
- `Surface/Status/Positive`
- `Border/Status/Negative Static`
- `Border/Status/Positive Static`

### `ID Capture` V2 - Error Screen Customization on Android

**Wrong document side customization:**

If you previously customized the `Wrong document side` error screen, add the following new string resources:

**Add these strings:**
```xml
<string name="onboard_sdk_id_capture_error_side_front">Capture the front side of the ID</string>
<string name="onboard_sdk_id_capture_error_side_back">Capture the back side of the ID</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_side">You’ve scanned the wrong document side. Please scan your document again.</string>
```

This string is no longer used.

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_id_capture_error_title">There was a problem</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

**Retry button customization:**

The retry button is now customized using a different string resource:

```xml
<string name="onboard_sdk_id_capture_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_no_network_snackbar_action_text">Retry</string>
```

The previously used string is still in use for other error screens and should be kept in your resources.

### `Selfie` V2 - Error Screen Customization on Android

**No internet connection customization:**

If you previously customized the `No internet connection` error screen, add the following new string resource:

**Add this string:**
```xml
<string name="onboard_sdk_no_internet_title">No internet connection</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_title">There was a problem</string>
```
The previously used string is still in use for other error screens and should be kept in your resources.

#### Changes in behavior for device environment detection on Android

The behavior when detecting device environment vulnerabilities has changed:

- **Hook or virtual environment detection**: Detecting hook or virtual environment vulnerabilities in the SDK triggers a native crash, which cannot be caught or handled by application code, resulting in immediate app termination.
- **Emulator and root detection**: The flow is not aborted when emulator and root checks are detected. The onboarding process continues normally.

### Expected crashes when running in a virtual environment on Android

It is expected that the app crashes with the following stacktraces when a virtual environment is used. For example:

```
java.lang.NullPointerException
    at com.incode.welcome_sdk.ThemeConfiguration$Builder.setLabelSmallStyle(SourceFile:1066)
    at com.incode.welcome_sdk.f.c(SourceFile:150)
    at com.incode.welcome_sdk.data.local.m.as(SourceFile:22)
    at com.incode.welcome_sdk.IncodeWelcome.startOnboardingSection(SourceFile:18)
```

```
java.lang.NullPointerException: Attempt to get length of null array
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.d(SourceFile:320)
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.i(SourceFile:214)
```

### `Selfie` V2 - No Internet Error Screen Retry Button Change on Android

**Retry button customization:**

The retry button label shown on the Selfie Scan no internet error screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_face_scan_retry">Refresh</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_try_again">Try again</string>
```

If you override `onboard_sdk_try_again` to customize the retry button on the no internet screen, you must now override `onboard_sdk_face_scan_retry` instead.
The `onboard_sdk_try_again` string is still used for other retry scenarios.

### `Selfie` V2 - Capture-Only Mode Success Screen Text Change on Android

**Success label customization:**

In capture-only mode, the Selfie Scan success screen now uses a different string resource:

```xml
<string name="onboard_sdk_face_captured">Face captured!</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_enroll_success">Success!</string>
```

The previously used string is still in use for non-capture-only mode and should be kept in your resources.

### `ID Capture` and `Selfie` V2 - Permission Open Settings Screen Text Change on Android

**Open settings button customization:**

The Open settings label shown on the Permission open settings screen now uses a dedicated string resource:

```xml
<string name="onboard_sdk_permission_allow_permission_action">Allow permission</string>
```

**Previous string:**
```xml
<string name="onboard_sdk_permission_open_setting_action">Open settings</string>
```

The previously used string is still in use for the `Geolocation` module and should be kept in your resources.

</Accordion>

## Migration to 9.9.0

<Accordion title="Migration to 9.9.0">

### Parameter Updates in `IdScan` module
- Remove usage of `enableRotationOnRetakeScreen` (this parameter has been removed).
- Replace `showRetakeScreen` with `showRetakeScreenForManualCapture`.
- Replace `showAutoCaptureRetakeScreen` with `showRetakeScreenForAutoCapture`.

### Upload error screen customization on Android:

If you previously customized the upload error screen, add the following new string resource:

*Add this string:*
```<string name="onboard_sdk_validation_error_button_text">Scan your ID</string>```

*Previous string:*
```<string name="onboard_sdk_id_capture_tutorial_title">Scan your ID</string>```

This string is now used only for customizing the ID Capture V2 tutorial screen title.

### Changed default values in FaceMatch module config on Android (optional)

With the move to UxV2, the showUserExists config is now false by default.

</Accordion>

## Migration to 9.8.0

<Accordion title="Migration to 9.8.0">

- Removed `enableRotationOnRetakeScreen` parameter for `IDScan` module.

### Update string resources for the "Need Help" screen in the `IdScan` v2 module on Android

The "Need Help" screen has been redesigned on Android, and the customizable strings have been replaced.
If you override any of the following strings in your app, replace them with the new ones listed below.

No action is required if you do not override these strings.

#### Replaced string resources

Replace overrides of:

```xml
<string name="onboard_sdk_id_capture_help_title">Need help?</string>
<string name="onboard_sdk_id_capture_help_subtitle">Some considerations</string>
<string name="onboard_sdk_id_capture_help_manual_photo_button_text">Take the photo manually</string>
<string name="onboard_sdk_id_capture_help_align_title">Center your document in the frame</string>
<string name="onboard_sdk_id_capture_help_align_subtitle">The photo will be taken automatically</string>
<string name="onboard_sdk_id_capture_help_blur_title">Avoid blurriness on the document</string>
<string name="onboard_sdk_id_capture_help_blur_subtitle">Zoom in and out, or tap on the document</string>
<string name="onboard_sdk_id_capture_help_glare_title">Avoid glare on the document</string>
<string name="onboard_sdk_id_capture_help_glare_subtitle">Find a better lighting to avoid reflections</string>
<string name="onboard_sdk_id_capture_help_darkness_title">Avoid darkness on the document</string>
<string name="onboard_sdk_id_capture_help_darkness_subtitle">Find a place with better lighting</string>
```

with:

```xml
<string name="onboard_sdk_id_capture_common_issues_title">Common issues</string>
<string name="onboard_sdk_id_capture_common_issues_glare_title">Glare present</string>
<string name="onboard_sdk_id_capture_common_issues_glare_subtitle">Tilt the ID slightly up or down to minimize the reflection</string>
<string name="onboard_sdk_id_capture_common_issues_blur_title">Blur present</string>
<string name="onboard_sdk_id_capture_common_issues_blur_subtitle">Move ID further away or closer to your phone until the image is focused</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_title">Info is not readable</string>
<string name="onboard_sdk_id_capture_common_issues_info_not_readable_subtitle">Minimize camera shake by holding your phone steady</string>
<string name="onboard_sdk_id_capture_common_issues_try_again_button">@string/onboard_sdk_try_again</string>
```

### Upgrade compileSdk on Android

With the update of the internal CameraX dependencies, you will need to upgrade your project's `compileSdk` to level 35. CameraX 1.6.1 already pulls `kotlinx-coroutines` transitively, so no manual dependency declaration is needed. The minimum supported `kotlinx-coroutines` version is 1.9.0:

```groovy
compileSdk 35
```

### Update Gradle Wrapper on Android

Android Gradle Wrapper `8.6.0` requires Gradle `8.7` or higher.
Update your Gradle wrapper configuration in `gradle/wrapper/gradle-wrapper.properties`:

```properties
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
```

### If you use any of the following optional dependencies on Android, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:nfc:1.5.1'
```

</Accordion>

## Migration to 9.6.0

<Accordion title="Migration to 9.6.0">

### E2EE variant removed
RN SDK 'e2ee' variant is no longer distributed, as e2ee functionality is now offered in a standard RN SDK variant.

### Android optional dependencies
For Android, if you use any of the following optional dependencies, make sure to update to the latest versions

```groovy
implementation 'com.incode.sdk:nfc:1.4.4'
implementation 'com.incode.sdk:video-streaming:1.6.0'
implementation 'com.incode.sdk:extensions:1.2.1'
implementation 'com.incode.sdk:model-face-recognition:3.5.1'
implementation 'com.incode.sdk:model-id-face-detection:3.5.1'
implementation 'com.incode.sdk:model-liveness-detection:3.2.1'
```

### Android minSdk changes
For Android, if you use the video-streaming dependency, you need to upgrade your minSdk to 24 or higher. The requirement is coming from the OpenTok dependency, which now requires a minimum SDK version of 24. This update is necessary to ensure compatibility with the 16KB page size support mandated by Google starting from November 1st 2025. More info (https://developer.android.com/guide/practices/page-sizes).

</Accordion>

## Migration to 9.5.0

<Accordion title="Migration to 9.5.0">

### Optional dependencies
For Android, if you use any of the following optional dependencies, make sure to update to the latest versions:

```groovy
implementation 'com.incode.sdk:extensions:1.2.0'
implementation 'com.incode.sdk:nfc:1.4.3'
```

### Updated resource name

If you wanted to customize the logo at the top of the `IdScan` V2 module, you needed to override the incode logo resource: `onboard_sdk_incode_logo.xml`.
This resource was not intended to be customizable, so please update your customizations to the new resource name: `onboard_sdk_logo_top.xml`.
By default, this resource is an empty 1x1 image, and you can customize it to your own logo.

</Accordion>

## Migration to 9.4.0

<Accordion title="Migration to 9.4.0">

For Android, if you use any of the following optional dependencies, make sure to update to the latest versions:

```groovy
implementation 'com.incode.sdk:model-face-recognition:3.5.0'
implementation 'com.incode.sdk:model-id-face-detection:3.5.0'
implementation 'com.incode.sdk:nfc:1.4.2'
```

The `qr-face-login` dependency is no longer available and has been removed in this version of the SDK. Please update your project configuration accordingly.
Remove the `qr-face-login` dependency from your `build.gradle`:

</Accordion>

## Migration to 9.3.0

<Accordion title="Migration to 9.3.0">

- Update Android `minSdkVersion` in you Android projects's `build.gradle`:

```diff
  buildscript {
    ext {
-    minSdkVersion = 21
+    minSdkVersion = 23
    }
  }

```

Remove `com.incode.sdk:camera:1.1.0` dependency in your app’s `build.gradle` file:

```diff
  dependencies {
-    implementation 'com.incode.sdk:camera:1.1.0'
  }
```

For Expo integrations, update your `app.json`:

```diff
{
  "expo": {
    "plugins": [
      [
        {
- "addCamera": "1.1.0"
        }
      ]
    ]
  }
}

```

If you are using NFC variant of the SDK follow the steps below to enable NFC scanning on iOS:

1. Turn on Near Field Communication Tag Reading under the Capabilities tab for the project’s target. This step:
   - Adds the NFC tag-reading feature to the App ID.
   - Adds the Near Field Communication Tag Reader Session Formats Entitlement to the entitlements file.

2. Add the NFCReaderUsageDescription key as a string item to the Info.plist file. For the value, enter a string that describes the reason the app needs access to the device’s NFC reader. If the app attempts to read a tag without providing this key and string, the app will crash.
3. Add interface for interacting with an ISO 7816 tag to App's Info.plist:
```
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
   <array>
      <string>A0000002471001</string>
      <string>A0000002472001</string>
      <string>00000000000000</string>
   </array>
```
NOTE
If your app supports devices with iOS prior to 13.0, you will also need to set CoreNFC.framework and CryptoTokenKit.framework as an optional frameworks:

Select your app target
Under Build Phases -> Link Binary With Libraries add: CoreNFC.framework, CryptoTokenKit.framework and SwiftUI.framework libraries if they are already not on the list.
And finally, for all three libraries, under Status, select Optional.
Note that even though NFC Scan module will not be performed on devices with iOS version older than 13, these steps are required because otherwise the app will crash on launch time.

If you are using Expo with the NFC variant, in order for it to work on Android it is necessary to:
  - Bump `expo-incode-sdk-configuration` version to 1.1.4 in `package.json`.

```diff
  {
  "dependencies": {
-   "@incode-sdks/expo-incode-sdk-configuration": "1.1.3"
+   "@incode-sdks/expo-incode-sdk-configuration": "1.1.4"
  }
}
```

  - Add `addNfc` plugin in `app.json`.

```diff
"plugins": [
  [
    "@incode-sdks/expo-incode-sdk-configuration",
    {
      "artifactoryUserName": "client_artifactory_username",
      "artifactoryPassword": "client_artifactory_password",
      "addIncodeSourceToPodfile": true,
      "cameraUsageDescription": "The SDK uses the camera in order to verify the identity of the customer, e.g. in ID scan, Selfie scan and so on.",
      "locationWhenInUseUsageDescription": "The SDK uses the current user location in order to detect exact location for Geolocation step.",
      "microphoneUsageDescription": "The SDK uses microphone for performing a video call during Video Conference step or for doing speech recognition during Video Selfie.",
+     "addNfc": "1.3.5"
    }
  ]
]
```

</Accordion>

## Migration to 9.1.0

<Accordion title="Migration to 9.1.0">

To enable the new ID capture experience on Android, add the `com.incode.sdk:camera:1.1.0` dependency to your app’s `build.gradle` file:

```diff
  dependencies {
+    implementation 'com.incode.sdk:camera:1.1.0'
  }
```

For Expo integrations, update your `app.json` to enable the new ID capture experience:

```diff
{
  "expo": {
    "plugins": [
      [
        {
+ "addCamera": "1.1.0"
        }
      ]
    ]
  }
}
```

</Accordion>

## Migration to 9.0.0

<Accordion title="Migration to 9.0.0">

- RN SDK is now delivered in multiple versions:\
  `9.0.0`: Standard version
  `9.0.0-vc`: Includes streaming
  `9.0.0-e2ee`: Includes end-to-end encryption
- Remove Android `com.incode.sdk:core-light` dependency in your app's `build.gradle`:\
  `dependencies {
        implementation 'com.incode.sdk:core-light:2.6.4'
    }`
- Add these lines to the Podfile:\
  `source 'https://cdn.cocoapods.org/'`
  `source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'`
  If you don't have access to the Incode's GitHub repo and SSH setup on the machine, please contact your Incode representative for support.
- For Expo integrations minimum 1.1.2 expo configuration plugin is required:\
  `"@incode-sdks/expo-incode-sdk-configuration": "1.1.2"`

\*Only for Expo integrations - Update app.json and remove `coreLightVersion`param.

</Accordion>

## Migration to 8.1.0

<Accordion title="Migration to 8.1.0">

- The requirement for a minimum supported React Native version of 0.74 has been removed. You can now use this library with earlier versions of React Native, as long as they meet other necessary dependencies.

</Accordion>

## Migration to 8.0.0

<Accordion title="Migration to 8.0.0">

- The minimum supported React Native version is 0.74 due to the requirements of `compileSdk 34` and `classpath("org.jetbrains.kotlin:kotlin-gradle-plugin")`. Please upgrade your project to React Native version 0.74 or higher to ensure compatibility.

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.6.3'
+    implementation 'com.incode.sdk:core-light:2.6.4'
  }
```

- Update `compileSdk` version to 34:

```diff
  android {
-    compileSdk 33
+    compileSdk 34
  }
```

- Expo integration. Update `plugins` field in `app.json`:

```diff
 "plugins": [
      [
        "@incode-sdks/expo-incode-sdk-configuration",
        {
-    "coreLightVersion": "2.6.3"
+    "coreLightVersion": "2.6.4"
        }
      ]
   ]
```

</Accordion>

## Migration to 6.4.0

<Accordion title="Migration to 6.4.0">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.6.2'
+    implementation 'com.incode.sdk:core-light:2.6.3'
  }
```

- Expo integration. Update `plugins` field in `app.json`:

```diff
 "plugins": [
      [
        "@incode-sdks/expo-incode-sdk-configuration",
        {
-    "coreLightVersion": "2.6.2"
+    "coreLightVersion": "2.6.3"
        }
      ]
   ]
```

</Accordion>

## Migration to 6.2.0

<Accordion title="Migration to 6.2.0">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.6.1'
+    implementation 'com.incode.sdk:core-light:2.6.2'
  }
```

- Expo integration. Update `plugins` field in `app.json`:

```diff
 "plugins": [
      [
        "@incode-sdks/expo-incode-sdk-configuration",
        {
-    "coreLightVersion": "2.6.1"
+    "coreLightVersion": "2.6.2"
        }
      ]
   ]
```

</Accordion>

## Migration to 6.1.0

<Accordion title="Migration to 6.1.0">

- Expo integration. Update `plugins` field in `app.json`:

```diff
 "plugins": [
      [
        "@incode-sdks/expo-incode-sdk-configuration",
        {
+    "coreLightVersion": "2.6.1"
        }
      ]
   ]
```

</Accordion>

## Migration to 6.0.0

<Accordion title="Migration to 6.0.0">

- Update Incode SDK dependency in `package.json`:

```diff
  "dependencies": {
-    "react-native-incode-sdk": "https://sdk-js.s3.amazonaws.com/react-native/react-native-incode-sdk-5.6.0-nvc.tgz"
+    "@incode-sdks/react-native-incode-sdk": "^6.0.0"
  }
```

- Update `Podfile`:

If RN >= 0.69 remove this line:

```diff
-   pod 'react-native-incode-sdk', :path => '../node_modules/react-native-incode-sdk/'
```

If RN \< 0.69 update this line:

```diff
-    pod 'react-native-incode-sdk', :path => '../node_modules/react-native-incode-sdk/'
+    pod 'react-native-incode-sdk', :path => '../node_modules/@incode-sdks/react-native-incode-sdk/'
```

- Update `App.js`:

```diff
-   import IncodeSdk from 'react-native-incode-sdk';
+   import IncodeSdk from '@incode-sdks/react-native-incode-sdk';
```

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.5.1
+    implementation 'com.incode.sdk:core-light:2.6.1'
  }

```

</Accordion>

## Migration to 5.6.1

<Accordion title="Migration to 5.6.1">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.5.0
+    implementation 'com.incode.sdk:core-light:2.5.1'
  }

```

</Accordion>

## Migration to 5.4.0

<Accordion title="Migration to 5.4.0">

- Update Android `minSdkVersion` in you Android projects's `build.gradle`:

```diff
  buildscript {
    ext {
-    minSdkVersion = 17
-    compileSdkVersion = 31
-    targetSdkVersion = 31
+    minSdkVersion = 21
+    compileSdkVersion = 21
+    targetSdkVersion = 21
    }
  }

```

</Accordion>

## Migration to 5.3.0

<Accordion title="Migration to 5.3.0">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.3.0
+    implementation 'com.incode.sdk:core-light:2.5.0'
  }

```

</Accordion>

## Migration to 5.2.1

<Accordion title="Migration to 5.2.1">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.2.0
+    implementation 'com.incode.sdk:core-light:2.3.0'
  }

```

</Accordion>

## Migration to 5.1.0

<Accordion title="Migration to 5.1.0">

Removed `startFaceLogin` parameter `customerToken`, specify only `customerUUID`.

</Accordion>

## Migration to 5.x

<Accordion title="Migration to 5.x">

1. `startOnboarding` and `startOnboardingSection` parameter name `config` renamed to `flowConfig`.

```diff
IncodeSdk.startOnboarding({
-     config: [
+     flowConfig: [
        { module: 'IdScan' },
        { module: 'SelfieScan' },
        { module: 'FaceMatch' },
      ],
    })
```

```diff
IncodeSdk.startOnboardingSection({
-     config: [
+     flowConfig: [
        { module: 'IdScan' },
        { module: 'SelfieScan' },
        { module: 'FaceMatch' },
      ],
    })
```

2. Added `setupOnboardingSession` that replaces `creatingNewOnboardingSession` and `setOnboardingSession`

```diff
- await IncodeSdk.creatingNewOnboardingSession({})
+ await IncodeSdk.setupOnboardingSession({})
```

```diff
- await IncodeSdk.setOnboardingSession({})
+ await IncodeSdk.setupOnboardingSession({})
```

3. `validationModules` param of `createNewOnboardingSession` and `setOnboardingSession` is now part of `setupOnboardingSession` method's `sessionConfig` param

```diff
- await IncodeSdk.createNewOnboardingSession({
-        sessionConfig: {
-         ...
-        },
-        validationModules: ['id', 'liveness'],
+ await IncodeSdk.setupOnboardingSession({
+        sessionConfig: {
+         ...
+         validationModules: ['id', 'liveness'],
+        },
```

```diff
- await IncodeSdk.setOnboardingSession({
-        sessionConfig: {
-         ...
-        },
-        validationModules: ['id', 'liveness'],
+ await IncodeSdk.setupOnboardingSession({
+        sessionConfig: {
+         ...
+         validationModules: ['id', 'liveness'],
+        },
```

</Accordion>

## Migration to 4.5.0-nvc

<Accordion title="Migration to 4.5.0-nvc">

- Update Android dependency in you app's `build.gradle`:

```diff
  dependencies {
-    implementation 'com.incode.sdk:core-light:2.0.0
+    implementation 'com.incode.sdk:core-light:2.2.0'
  }

```

</Accordion>

## Migration to 4.4.1-nvc

<Accordion title="Migration to 4.4.1-nvc">

- In your Android app's `build.gradle` file set `compileSdkVersion` to 31 or higher.

</Accordion>

## Migration to 4.4.0-nvc

<Accordion title="Migration to 4.4.0-nvc">

`UserScoreCompleteEvent` fields are now reorganized differently:

- Basic parsed user score results are stored in `result.data`
- Full UserScore data is set as raw JSON in `result.extendedUserScoreJsonData` field

</Accordion>

## Migration to 4.x

<Accordion title="Migration to 4.x">

`initialize` method changes:

- Removed `conferenceUrl` parameter method that wasn't used.
- Removed `regionCode` parameter, now part of `OnboardingSessionConfig` object that is available as an optional parameter in `startOnboarding`, `createOnboardingSession`, and `setOnboardingSession` methods.

`startOnboarding` method changes:

- Removed `interviewId` parameter, now part of `sessionConfig` object that is available as an optional parameter
- Removed `configurationId` parameter, now part of `sessionConfig` object that is available as an optional parameter
- Added optional `sessionConfig` parameter, `OnboardingSessionConfig` object where you can specify all session parameters.

`createOnboardingSession` method changes:

- Removed unused `verifiers` parameter
- Added optional `sessionConfig` parameter, `OnboardingSessionConfig` object where you can specify all session parameters.
- Added `validationModules` parameter, where you can specify the list of validation modules used for a session.

`startOnboardingSection` method changes:

- Removed `interviewId` parameter. Please specify it either in `createOnboardingSession` or `setOnboardingSession` via `sessionConfig` parameter.

</Accordion>

## Migration to 3.2.x

<Accordion title="Migration to 3.2.x">

How ID results were provided before 3.2.x:

```js
const setupListeners = () => {
  // returns a callback to unregister your listener, e.g. when your screen is getting unmounted
  const complete = IncodeSdk.onStepCompleted;
  return [
    complete({
      module: 'IdScan',
      listener: (e) => {
        console.log('ID scan result:', e.result);
      },
    }),
  ];
};
```

How to listen for ID results in 3.2.x:

```js
const setupListeners = () => {
  // returns a callback to unregister your listener, e.g. when your screen is getting unmounted
  const complete = IncodeSdk.onStepCompleted;
  return [
    complete({
      module: 'IdScanFront',
      listener: (e) => {
        console.log('ID scan front result:', e.result);
      },
    }),
    complete({
      module: 'IdScanBack',
      listener: (e) => {
        console.log('ID scan back result: ', e.result);
      },
    }),
    complete({
      module: 'ProcessId',
      listener: (e) => {
        console.log('ProcessId result: ', e.result.extendedOcrData);
      },
    }),
  ];
};
```

### iOS Podfile changes

Standard SDK:

Replace

```
pod 'react-native-incode-sdk', :path => '../node_modules/react-native-incode-sdk'
```

with:

```
pod 'react-native-incode-sdk', :path => '../node_modules/react-native-incode-sdk/ios'
```

Dynamic Delivery:

Replace

```
pod 'react-native-incode-sdk/ODR', :path => '../node_modules/react-native-incode-sdk'
```

with:

```
pod 'react-native-incode-sdk/ODR', :path => '../node_modules/react-native-incode-sdk/ios'
```

</Accordion>

## Migration to 3.1.x

<Accordion title="Migration to 3.1.x">

If you wish to keep using standard/Non-Dynamic Delivery version of the SDK on Android platform, please add this dependency in you app's `build.gradle`:

```
implementation 'com.incode.sdk:core-light:2.0.0'
```

</Accordion>

---

- Path: `release-notes/sdk-1800`
- URL: https://developer.incode.com/release-notes/sdk-1800/
- Markdown: https://developer.incode.com/release-notes/sdk-1800.md

# SDK 1.80.0

---

- Path: `release-notes/sdk-1801`
- URL: https://developer.incode.com/release-notes/sdk-1801/
- Markdown: https://developer.incode.com/release-notes/sdk-1801.md

# SDK 1.80.1

---

- Path: `release-notes/sdk-1810`
- URL: https://developer.incode.com/release-notes/sdk-1810/
- Markdown: https://developer.incode.com/release-notes/sdk-1810.md

# SDK 1.81.0

---

- Path: `release-notes/sdk-1820`
- URL: https://developer.incode.com/release-notes/sdk-1820/
- Markdown: https://developer.incode.com/release-notes/sdk-1820.md

# SDK 1.82.0

---

- Path: `release-notes/sdk-1830`
- URL: https://developer.incode.com/release-notes/sdk-1830/
- Markdown: https://developer.incode.com/release-notes/sdk-1830.md

# SDK 1.83.0

---

- Path: `release-notes/sdk-1840`
- URL: https://developer.incode.com/release-notes/sdk-1840/
- Markdown: https://developer.incode.com/release-notes/sdk-1840.md

# SDK 1.84.0

---

- Path: `release-notes/sdk-1850`
- URL: https://developer.incode.com/release-notes/sdk-1850/
- Markdown: https://developer.incode.com/release-notes/sdk-1850.md

# SDK 1.85.0

---

- Path: `release-notes/sdk-1860`
- URL: https://developer.incode.com/release-notes/sdk-1860/
- Markdown: https://developer.incode.com/release-notes/sdk-1860.md

# SDK 1.86.0

---

- Path: `release-notes/sdk-1870`
- URL: https://developer.incode.com/release-notes/sdk-1870/
- Markdown: https://developer.incode.com/release-notes/sdk-1870.md

# SDK 1.87.0

---

- Path: `release-notes/sdk-1880`
- URL: https://developer.incode.com/release-notes/sdk-1880/
- Markdown: https://developer.incode.com/release-notes/sdk-1880.md

# SDK 1.88.0

---

- Path: `release-notes/sdk-1890`
- URL: https://developer.incode.com/release-notes/sdk-1890/
- Markdown: https://developer.incode.com/release-notes/sdk-1890.md

# SDK 1.89.0

---

- Path: `release-notes/sdk-deprecation-policy-and-timeline`
- URL: https://developer.incode.com/release-notes/sdk-deprecation-policy-and-timeline/
- Markdown: https://developer.incode.com/release-notes/sdk-deprecation-policy-and-timeline.md

# SDK Deprecation Policy and Timeline

Incode SDK versions are supported for **12 months** after their release date. Versions older than 12 months from their release date are _not_ supported. Security fixes are applied to the latest supported minor/patch only.

We provide a minimum of **6 months' notice** via email before deprecating any SDK version, giving you ample time to plan and execute your migration. During this period, we continue to provide critical security patches and technical support until the end of support date is reached.

The [full deprecation policy](https://trust.incode.com/product/incodetechnologies/software-deprecation-policy) is available on the Incode Trust Center.

:::info
  We strongly recommend upgrading to the latest version of our SDKs to ensure uninterrupted service, maintain security compliance, and deliver the best possible experience to your users.
:::

This page details the end of support dates for all currently-supported versions of each SDK. Use the menu on the right to jump to the SDK section you want to review.

## Android SDK

The latest version of Android SDK is **5.55.0**. [Release notes](/release-notes/releases-android-sdk), [reference documentation](/sdk-reference/android-sdk), and a [migration guide](/release-notes/migration-guide) are available.

The following table details the Android SDK versions currently supported and their planned End of Support date.

| Version | Release Date | End of Support |
| :------ | :----------- | :------------- |
| 5.55    | 2026 Oct 21  | 2027 Oct 21    |
| 5.54    | 2026 Sept 30 | 2027 Sept 30   |
| 5.53    | 2026 Sept 8  | 2027 Sept 8    |
| 5.52    | 2026 Aug 20  | 2027 Aug 20    |
| 5.51    | 2026 Aug 5   | 2027 Aug 5     |
| 5.50    | 2026 July 22 | 2027 July 22   |
| 5.49    | 2026 June 16 | 2027 June 16   |
| 5.48    | 2026 May 22  | 2027 May 22    |
| 5.47    | 2026 May 7   | 2027 May 7     |
| 5.46    | 2026 Apr 27  | 2027 Apr 27    |
| 5.45.1  | 2026 Apr 06  | 2027 Apr 6     |
| 5.45    | 2026 Mar 23  | 2027 Mar 23    |
| 5.44    | 2026 Feb 25  | 2027 Feb 25    |
| 5.43    | 2025 Dec 30  | 2026 Dec 30    |
| 5.42    | 2025 Nov 28  | 2026 Nov 28    |
| 5.41.1  | 2025 Nov 12  | 2026 Nov 12    |
| 5.41    | 2025 Oct 17  | 2026 Oct 17    |
| 5.40.3  | 2026 Jan 30  | 2027 Jan 30    |
| 5.40.2  | 2026 Jan 8   | 2027 Jan 8     |

## iOS SDK

The latest version of iOS SDK is **5.51.0**. [Release notes](/release-notes/releases-ios-sdk), [reference documentation](/sdk-reference/ios-sdk), and a [migration guide](/release-notes/migration_guide) are available.

The following table details the iOS SDK versions currently supported and their planned End of Support date.

| Version | Release Date | End of Support |
| :------ | :----------- | :------------- |
| 5.51    | 2026 Oct 20  | 2027 Oct 20    |
| 5.50    | 2026 Sept 28 | 2027 Sept 28   |
| 5.49    | 2026 Sept 8  | 2027 Sept 8    |
| 5.48    | 2026 Aug 19  | 2027 Aug 19    |
| 5.47    | 2026 Aug 11  | 2027 Aug 11    |
| 5.46    | 2026 July 20 | 2027 July 20   |
| 5.45    | 2026 July 2  | 2027 July 2    |
| 5.44    | 2026 May 22  | 2027 May 22    |
| 5.43    | 2026 May 5   | 2027 May 5     |
| 5.42    | 2026 Apr 24  | 2027 Apr 24    |
| 5.41    | 2026 Apr 7   | 2027 Apr 7     |
| 5.40    | 2026 Feb 19  | 2027 Feb 19    |
| 5.39.1  | 2026 Jan 9   | 2027 Jan 9     |
| 5.39    | 2025 Dec 31  | 2026 Dec 31    |
| 5.38    | 2025 Nov 9   | 2026 Nov 9     |

## Hybrid SDKs

These SDKs follow the deprecation cycle of the corresponding Android and iOS versions.

### React Native

The latest version of React Native SDK is **9.19.0**. [Release notes](/release-notes/releases-rn-sdk), [reference documentation](/sdk-reference/react-native-sdk), and a [migration guide](/release-notes/rn-migration-guide) are available.

| Version | Release Date | End of Support             |
| :------ | :----------- | :------------------------- |
| 9.18    | 2026 Oct 7   | Android 5.54 \| iOS 5.50   |
| 9.17    | 2026 Sept 16 | Android 5.53 \| iOS 5.49   |
| 9.16    | 2026 Aug 28  | Android 5.51 \| iOS 5.47   |
| 9.15    | 2026 July 27 | Android 5.50 \| iOS 5.46   |
| 9.14    | 2026 Jun 26  | Android 5.49 \| iOS 5.44   |
| 9.13    | 2026 May 26  | Android 5.48 \| iOS 5.44   |
| 9.12    | 2026 May 13  | Android 5.47 \| iOS 5.43   |
| 9.11    | 2026 Apr 29  | Android 5.46 \| iOS 5.42   |
| 9.10    | 2026 Mar 26  | Android 5.45 \| iOS 5.40   |
| 9.9     | 2026 Feb 27  | Android 5.44 \| iOS 5.40   |
| 9.8     | 2026 Jan 9   | Android 5.43 \| iOS 5.39.1 |
| 9.7     | 2025 Nov 24  | Android 5.41.1 \| iOS 5.38 |

### Flutter

The latest version of Flutter SDK is **4.22.0**. [Release notes](/release-notes/releases-flutter-sdk), [reference documentation](/sdk-reference/flutter-sdk), and a [migration guide](/release-notes/flutter-migration-guide) are available.

| Version | Release Date | End of Support             |
| :------ | :----------- | :------------------------- |
| 4.22    | 2026 Oct 7   | Android 5.54 \| iOS 5.50   |
| 4.21    | 2026 Sept 16 | Android 5.53 \| iOS 5.49   |
| 4.20    | 2026 Aug 27  | Android 5.51 \| iOS 5.47   |
| 4.19    | 2026 July 29 | Android 5.50 \| iOS 5.46   |
| 4.18    | 2026 Jun 23  | Android 5.49 \| iOS 5.44   |
| 4.17    | 2026 May 28  | Android 5.48 \| iOS 5.44   |
| 4.16    | 2026 May 12  | Android 5.47 \| iOS 5.43   |
| 4.15    | 2026 Apr 29  | Android 5.46 \| iOS 5.42   |
| 4.14    | 2026 Apr 7   | Android 5.45.1 \| iOS 5.41 |
| 4.13    | 2026 Feb 26  | Android 5.44 \| iOS 5.40   |
| 4.12    | 2026 Feb 4   | Android 5.43 \| iOS 5.39.1 |
| 4.11    | 2025 Dec 2   | Android 5.41.1 \| iOS 5.38 |

### Cordova

The latest version of Cordova SDK is **4.10.0**. [Release notes](/release-notes/releases-cordova-sdk), [reference documentation](/sdk-reference/cordova-sdk), and a [migration guide](/release-notes/cordova-migration-guide) are available.

| Version | Release Date | End of Support               |
| :------ | :----------- | :--------------------------- |
| 4.10    | 2026 Oct 7   | Android 5.54 \| iOS 5.50     |
| 4.9     | 2026 Sept 16 | Android 5.53 \| iOS 5.49     |
| 4.8     | 2026 Aug 28  | Android 5.51 \| iOS 5.47     |
| 4.7     | 2026 July 30 | Android 5.50 \| iOS 5.46     |
| 4.6.1   | 2026 July 3  | Android 5.49 \| iOS 5.44     |
| 4.6     | 2026 June 23 | Android 5.49 \| iOS 5.44     |
| 4.5     | 2026 June 2  | Android 5.48 iOS 5.44        |
| 4.4     | 2026 May 12  | Android 5.47 \| iOS 5.43     |
| 4.3     | 2026 Apr 30  | Android 5.46 \| iOS 5.42     |
| 4.2     | 2026 Apr 16  | Android 5.45.1 \| iOS 5.41   |
| 4.1     | 2026 Mar 5   | Android 5.44 \| iOS 5.40     |
| 4.0     | 2026 Jan 28  | Android 5.43.0 \| iOS 5.39.1 |
| 3.0     | 2025 Nov 19  | Android 5.41.1 \| iOS 5.38   |

### Xamarin

The latest version of Xamarin SDK is **2.0.1**. [Release notes](/release-notes/releases-xamarin-sdk), [reference documentation](/sdk-reference/xamarin-sdk), and a [migration guide](/release-notes/migration-guide-1) are available.

| Version | Release Date | End of Support                             |
| :------ | :----------- | :----------------------------------------- |
| 2.0.2   | 2025 Apr 16  | Android 5.38 \| iOS 5.37  |
| 2.0.1   | 2025 Dec 25  | Android 5.38 \| iOS 5.37  |
| 2.0     | 2025 Oct 21  | Android 5.38 \| iOS 5.37  |

## Web SDK 1.x

The latest version of the legacy Web SDK is **1.94.0**. [Release notes](/release-notes/releases-web-sdk), [reference documentation](/sdk-reference/web-sdk-reference), and a [migration guide for V1 to V2](/release-notes/websdk-user-experience-v2-migration-guide) are available.

The following table details the legacy Web SDK versions currently supported and their planned End of Support date.

| Version | Release Date | End of Support |
| :------ | :----------- | :------------- |
| 1.94    | 2026 Oct 9   | 2027 Oct 9     |
| 1.93    | 2026 Sept 11 | 2027 Sept 11   |
| 1.92.1  | 2026 Aug 26  | 2027 Aug 26    |
| 1.92    | 2026 Aug 19  | 2027 Aug 19    |
| 1.91    | 2026 July 17 | 2027 July 17   |
| 1.90    | 2026 June 12 | 2027 June 12   |
| 1.89.1  | 2026 May 12  | 2027 May 12    |
| 1.89    | 2026 May 4   | 2027 May 4     |
| 1.88    | 2026 Mar 16  | 2027 Mar 16    |
| 1.87    | 2026 Feb 11  | 2027 Feb 11    |
| 1.86.1  | 2026 Jan 16  | 2027 Jan 16    |
| 1.86    | 2025 Dec 24  | 2026 Dec 24    |
| 1.85    | 2025 Nov 21  | 2026 Nov 21    |
| 1.83.1  | 2025 Oct 30  | 2026 Oct 30    |

## Web SDK 2.x

The latest version of the legacy Web SDK is **2.4.0**. [Release notes](/release-notes/web-sdk-20-release-notes/), [reference documentation](/sdk-reference/incode-web-sdk-2-reference), and a [migration guide for V1 to V2](/release-notes/websdk-user-experience-v2-migration-guide) are available.

The following table details the Web SDK 2.x versions currently supported and their planned End of Support date.

| Version | Release Date | End of Support |
| :------ | :----------- | :------------- |
| 2.3.2   | 2026 Oct 9   | 2027 Oct 9     |
| 2.3.1   | 2026 Sept 29 | 2027 Sept 29   |
| 2.3     | 2026 Sept 25 | 2027 Sept 25   |
| 2.2     | 2026 Aug 21  | 2027 Aug 21    |
| 2.1.1   | 2026 July 30 | 2027 July 30   |
| 2.1     | 2026 July 10 | 2027 July 10   |
| 2.0.1   | 2026 May 18  | 2027 May 18    |
| 2.0     | 2026 May 15  | 2027 May 15    |

---

- Path: `release-notes/spanish-1790`
- URL: https://developer.incode.com/release-notes/spanish-1790/
- Markdown: https://developer.incode.com/release-notes/spanish-1790.md

# ES - Spanish

## 🆕 Agregados

* `capturePreview.acceptedDocuments.BirthCertificate` = `Partida de nacimiento`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Moneda`
* `capturePreview.acceptedDocuments.DriversLicense` = `Permiso de conducir`
* `capturePreview.acceptedDocuments.FederalID` = `Identificación federal`
* `capturePreview.acceptedDocuments.IdentificationCard` = `Tarjeta de identificación`
* `capturePreview.acceptedDocuments.label` = `Documentos aceptados para:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Tarjeta sanitaria`
* `capturePreview.acceptedDocuments.Military` = `Militar`
* `capturePreview.acceptedDocuments.noDocuments` = `No se aceptan documentos para este país. `
* `capturePreview.acceptedDocuments.Other` = `Otros`
* `capturePreview.acceptedDocuments.Passport` = `Pasaporte`
* `capturePreview.acceptedDocuments.Permit` = `Permiso`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Documento de residencia`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Identificación fiscal`
* `capturePreview.acceptedDocuments.TravelDocument` = `Documento de viaje`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Identificación tribal`
* `capturePreview.acceptedDocuments.Unknown` = `Desconocido`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Matriculación de vehículos`
* `capturePreview.acceptedDocuments.Visa` = `Visa`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Identificación de los votantes`
* `capturePreview.acceptedDocuments.WeaponLicense` = `Licencia de armas`
* `common.refreshPage` = `Actualizar`
* `commonIssues.idv2.tryAgain` = `Bien, inténtalo de nuevo.`
* `errors.dynamicImport.failedToLoad` = `No esperábamos este error, pero estamos tomando nota:`
* `errors.dynamicImport.suggestion` = `Lo intentaremos de nuevo en {{count}} o puedes actualizar manualmente`
* `errors.dynamicImport.title` = `Lo sentimos, hemos encontrado un problema`
* `idv2.capture.autoCapture` = `La foto se tomará automáticamente`
* `idv2.capture.dontMove` = `No muevas tu ID durante unos segundos`
* `idv2.capture.fillFrame` = `Rellena el marco con tu ID`
* `idv2.capture.fillFramePassport` = `Rellena el marco con tu pasaporte`
* `idv2.capture.manualCapture.ariaLabel` = `Captura manual`
* `idv2.capture.manualCapture.title` = `Botón de captura manual`
* `idv2.capture.notifications.blur.description` = `Acercar o alejar la imagen, o pulsar sobre el ID`
* `idv2.capture.notifications.blur.title` = `Identificación demasiado borrosa`
* `idv2.capture.notifications.glare.description` = `Busca una mejor iluminación para evitar reflejos`
* `idv2.capture.notifications.glare.title` = `Identificación con brillo`
* `idv2.capture.notifications.notAligned.description` = `Centra tu ID dentro del marco`
* `idv2.capture.notifications.notAligned.title` = `El ID no está alineado`
* `idv2.capture.notifications.showBack.description` = `Dale la vuelta a tu ID para mostrar su reverso`
* `idv2.capture.notifications.showBack.title` = `Mostrar el reverso del ID`
* `idv2.capture.notifications.showFront.description` = `Dale la vuelta a tu ID para mostrar su reverso`
* `idv2.capture.notifications.showFront.title` = `Mostrar el reverso del ID`
* `idv2.capture.passport.subtitle` = `Asegúrese de que su pasaporte es legible`
* `idv2.capture.passport.title` = `Escanee su pasaporte`
* `idv2.capture.processing.analyzing` = `Analizando...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}}/{{maxAttempts}} intentos restantes`
* `idv2.capture.processing.continue` = `Continuar`
* `idv2.capture.processing.error` = `Error`
* `idv2.capture.processing.errors.classification.subtitle` = `Asegúrese de que toda la identificación sea visible y esté bien iluminada`
* `idv2.capture.processing.errors.classification.title` = `Error en la verificación de la identidad`
* `idv2.capture.processing.errors.default.subtitle` = `Por favor, inténtelo de nuevo`
* `idv2.capture.processing.errors.default.title` = `Hubo un problema`
* `idv2.capture.processing.errors.glare.subtitle` = `Inclina el ID levemente arriba y abajo para minimizar el reflejo`
* `idv2.capture.processing.errors.glare.title` = `Brillo detectado`
* `idv2.capture.processing.errors.readability.subtitle` = `Minimiza el movimiento de la cámara sosteniendo tu teléfono estable`
* `idv2.capture.processing.errors.readability.title` = `Datos no legibles`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Aleja o acerca el ID de tu teléfono hasta que la imagen esté enfocada`
* `idv2.capture.processing.errors.sharpness.title` = `Fuera de foco`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Por favor intenta con otro documento`
* `idv2.capture.processing.errors.unacceptable.title` = `No se acepta el tipo de identificación`
* `idv2.capture.processing.errors.upload.subtitle` = `Compruebe su conexión y vuelva a intentarlo.`
* `idv2.capture.processing.errors.upload.title` = `Hubo un problema al escanear tu ID`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Captura {{mode}} lado de la identificación`
* `idv2.capture.processing.errors.wrongSide.title` = `Se capturó el lado incorrecto del documento`
* `idv2.capture.processing.scanBack` = `Captura el reverso del documento`
* `idv2.capture.processing.success` = `Éxito`
* `idv2.capture.processing.successBackSubtitle` = `Ahora continuemos`
* `idv2.capture.processing.successFrontSubtitle` = `Ahora vamos a capturar la parte de atrás`
* `idv2.capture.processing.successTitle` = `Procesado con éxito.`
* `idv2.capture.processing.tryAgain` = `Inténtalo de nuevo`
* `idv2.capture.takingPhoto` = `Hacer fotos...`
* `idv2.capture.wrongSide.backHint` = `back-id-hint`
* `idv2.capture.wrongSide.frontHint` = `front-id-hint`
* `idv2.chooser.idButtonDescription` = `ID o licencia de conducir`
* `idv2.chooser.idButtonTitle` = `ID`
* `idv2.chooser.passportButtonDescription` = `Pasaporte de su país`
* `idv2.chooser.passportButtonTitle` = `Pasaporte`
* `idv2.permissions.alertAlt` = `alerta de permiso falso`
* `idv2.permissions.allow` = `OK, Permitir`
* `idv2.permissions.denied.allow` = `Permitir`
* `idv2.permissions.denied.ask` = `Pregunta a`
* `idv2.permissions.denied.browser` = `Navegador`
* `idv2.permissions.denied.camera` = `Cámara`
* `idv2.permissions.denied.changeTo` = `Cambiar a`
* `idv2.permissions.denied.open` = `Abrir`
* `idv2.permissions.denied.or` = `o`
* `idv2.permissions.denied.refreshPage` = `Actualizar página`
* `idv2.permissions.denied.return` = `Vuelva aquí y pulse`
* `idv2.permissions.denied.scroll` = `Desplácese hacia abajo para seleccionar`
* `idv2.permissions.denied.settings` = `Ajustes`
* `idv2.permissions.denied.tap` = `Toque`
* `idv2.permissions.denied.title` = `Siga los siguientes pasos para permitir que Incode acceda a su cámara`
* `idv2.permissions.denied.yourBrowser` = `su navegador`
* `idv2.permissions.description` = `para completar el proceso`
* `idv2.permissions.dontAllow` = `No permita`
* `idv2.permissions.fakeDenied.alert` = `alerta falsa centrada`
* `idv2.permissions.fakeDenied.allowPermissions` = `Permitir permisos`
* `idv2.permissions.fakeDenied.quitProcess` = `Abandonar el proceso`
* `idv2.permissions.fakeDenied.title` = `Se requiere permiso de cámara para la captura de documentos`
* `idv2.permissions.fakeDenied.warning` = `advertencia`
* `idv2.permissions.note` = `Nota: Dependiendo de su teléfono, puede decir`
* `idv2.permissions.or` = `o`
* `idv2.permissions.subtitle` = `permitir permiso de cámara`
* `idv2.permissions.title` = `Necesitamos que`
* `idv2.permissions.whileUsing` = `Al utilizar la aplicación`
* `idv2.tutorial.autoCapture` = `La foto se tomará automáticamente`
* `idv2.tutorial.startScan` = `Escaneemos`
* `idv2.tutorial.subtitle` = `Asegúrese de que su documento de identidad sea legible`
* `idv2.tutorial.title` = `Escanee su ID`
* `idv2.uploading.analyzing` = `Analizar...`
* `idv2.uploading.imageAlt` = `Captura de ID`
* `onboarding.errors.restartDisabled.message` = `Reinicio de sesión desactivado a nivel de organización`
* `onboarding.errors.restartDisabled.title` = `No se puede reiniciar la sesión`
* `qes.signatureCheck` = `Acepto la expedición del certificado requerido y la firma electrónica de este documento.`
* `qes.termsCheck` = `He leído y acepto la <2>Política de privacidad</2> y las <6>Condiciones de uso</6> de Incode.`

## ✏️ Modificados

* `commonIssues.commonIssues`:
  * Antes: `Errores Comunes`
  * Ahora: `Problemas comunes`
* `commonIssues.infoNotReadable`:
  * Antes: `La información no es legible`
  * Ahora: `Información no legible`
* `commonIssues.takeManually`:
  * Antes: `Hacer la foto manualmente`
  * Ahora: `Haz la foto manualmente`
* `commonIssues.tryAgain`:
  * Antes: `Ok, tomar de nuevo`
  * Ahora: `Inténtalo de nuevo`
* `ineCheck.verified`:
  * Antes: `Identidad válida!`
  * Ahora: `Identidad enviada para su verificación`
* `notifications.done`:
  * Antes: `Hecho`
  * Ahora: `Escaneado finalizado`
* `notifications.glareDetectedDescription`:
  * Antes: `Inclina el ID levemente arriba y abajo para minimizar el reflejo`
  * Ahora: `Busca una mejor iluminación para evitar reflejos`
* `notifications.idTypeUnacceptable`:
  * Antes: `No se acepta el tipo de identificación`
  * Ahora: `Documento no válido`
* `notifications.idTypeUnacceptableDescription`:
  * Antes: `Por favor intenta con otro documento`
  * Ahora: `Intenta escanear otro`
* `notifications.lowSharpness`:
  * Antes: `Fuera de foco`
  * Ahora: `Baja nitidez`

---

- Path: `release-notes/sr-latn-serbia-latin`
- URL: https://developer.incode.com/release-notes/sr-latn-serbia-latin/
- Markdown: https://developer.incode.com/release-notes/sr-latn-serbia-latin.md

# SR-LATN - Serbian (Latin)

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Извод из матичне књиге рођених`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Валута`
* `capturePreview.acceptedDocuments.DriversLicense` = `Возачка дозвола`
* `capturePreview.acceptedDocuments.FederalID` = `Федерална ИД`
* `capturePreview.acceptedDocuments.IdentificationCard` = `лична карта`
* `capturePreview.acceptedDocuments.label` = `Прихваћена документа за:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Медицал Цард`
* `capturePreview.acceptedDocuments.Military` = `Војска`
* `capturePreview.acceptedDocuments.noDocuments` = `За ову земљу нису прихваћени документи. `
* `capturePreview.acceptedDocuments.Other` = `Остало`
* `capturePreview.acceptedDocuments.Passport` = `Пасош`
* `capturePreview.acceptedDocuments.Permit` = `Дозвола`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Документ о пребивалишту`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Пореска идентификација`
* `capturePreview.acceptedDocuments.TravelDocument` = `Путна исправа`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Идентификација племена`
* `capturePreview.acceptedDocuments.Unknown` = `Непознато`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Регистрација возила`
* `capturePreview.acceptedDocuments.Visa` = `Виса`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Идентификација бирача`
* `capturePreview.acceptedDocuments.WeaponLicense` = `лиценца за оружје`
* `common.refreshPage` = `Освежи`
* `commonIssues.idv2.tryAgain` = `Ок, покушај поново`
* `errors.dynamicImport.failedToLoad` = `Нешто неочекивана грешка, али смо је приметили:`
* `errors.dynamicImport.suggestion` = `Покушаћемо поново за {{count}} или можете ручно да освежите`
* `errors.dynamicImport.title` = `Жао нам је, наишли смо на проблем`
* `idv2.capture.autoCapture` = `Фотографија ће бити снимљена аутоматски`
* `idv2.capture.dontMove` = `Не померајте своју личну карту на неколико секунди`
* `idv2.capture.fillFrame` = `Попуните оквир својим личним документом`
* `idv2.capture.fillFramePassport` = `Попуните оквир својим пасошем`
* `idv2.capture.manualCapture.ariaLabel` = `Мануал Цаптуре`
* `idv2.capture.manualCapture.title` = `Дугме за ручно снимање`
* `idv2.capture.notifications.blur.description` = `Увећајте и умањите приказ или додирните ИД`
* `idv2.capture.notifications.blur.title` = `ИД је превише мутан`
* `idv2.capture.notifications.glare.description` = `Пронађите боље осветљење да бисте избегли рефлексије`
* `idv2.capture.notifications.glare.title` = `ИД са одсјајем`
* `idv2.capture.notifications.notAligned.description` = `Центрирајте свој ИД унутар оквира`
* `idv2.capture.notifications.notAligned.title` = `ИД није поравнат`
* `idv2.capture.notifications.showBack.description` = `Окрените своју личну карту да покажете њену полеђину`
* `idv2.capture.notifications.showBack.title` = `Покажите полеђину личне карте`
* `idv2.capture.notifications.showFront.description` = `Окрените своју личну карту да покажете њену предњу страну`
* `idv2.capture.notifications.showFront.title` = `Покажите предњу страну ИД-а`
* `idv2.capture.passport.subtitle` = `Уверите се да је ваш пасош читљив`
* `idv2.capture.passport.title` = `Скенирајте пасош`
* `idv2.capture.processing.analyzing` = `Анализирање...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}} / {{maxAttempts}} преосталих покушаја`
* `idv2.capture.processing.continue` = `Настави`
* `idv2.capture.processing.error` = `Грешка`
* `idv2.capture.processing.errors.classification.subtitle` = `Уверите се да цео ИД буде видљив и добро осветљен`
* `idv2.capture.processing.errors.classification.title` = `Верификација личне карте није успела`
* `idv2.capture.processing.errors.default.subtitle` = `Покушајте поново`
* `idv2.capture.processing.errors.default.title` = `Дошло је до проблема`
* `idv2.capture.processing.errors.glare.subtitle` = `Нагните ИД благо нагоре или надоле да бисте умањили одраз`
* `idv2.capture.processing.errors.glare.title` = `Одсјај присутан`
* `idv2.capture.processing.errors.readability.subtitle` = `Смањите подрхтавање камере мирним држањем телефона`
* `idv2.capture.processing.errors.readability.title` = `Информације нису читљиве`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Померите ИД даље или ближе свом телефону док се слика не фокусира`
* `idv2.capture.processing.errors.sharpness.title` = `Блур пресент`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Покушајте са другим документом`
* `idv2.capture.processing.errors.unacceptable.title` = `Тип ИД-а није прихваћен`
* `idv2.capture.processing.errors.upload.subtitle` = `Проверите своју везу и покушајте поново`
* `idv2.capture.processing.errors.upload.title` = `Скенирање ИД-а није успело`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Снимите {{mode}} страну ИД-а`
* `idv2.capture.processing.errors.wrongSide.title` = `Погрешна страна је снимљена`
* `idv2.capture.processing.scanBack` = `Скенирајте позадину`
* `idv2.capture.processing.success` = `Успех`
* `idv2.capture.processing.successBackSubtitle` = `Сада да наставимо`
* `idv2.capture.processing.successFrontSubtitle` = `Сада ухватимо леђа`
* `idv2.capture.processing.successTitle` = `Успешно обрађено!`
* `idv2.capture.processing.tryAgain` = `Покушајте поново`
* `idv2.capture.takingPhoto` = `Сликање...`
* `idv2.capture.wrongSide.backHint` = `бацк-ид-хинт`
* `idv2.capture.wrongSide.frontHint` = `фронт-ид-хинт`
* `idv2.chooser.idButtonDescription` = `Национална лична карта или возачка дозвола`
* `idv2.chooser.idButtonTitle` = `лична карта`
* `idv2.chooser.passportButtonDescription` = `Пасош ваше земље`
* `idv2.chooser.passportButtonTitle` = `Пасош`
* `idv2.permissions.alertAlt` = `лажно упозорење о дозволи`
* `idv2.permissions.allow` = `ОК, дозволи`
* `idv2.permissions.denied.allow` = `Дозволи`
* `idv2.permissions.denied.ask` = `Питај`
* `idv2.permissions.denied.browser` = `Бровсер`
* `idv2.permissions.denied.camera` = `Камера`
* `idv2.permissions.denied.changeTo` = `Промените у`
* `idv2.permissions.denied.open` = `Отвори`
* `idv2.permissions.denied.or` = `или`
* `idv2.permissions.denied.refreshPage` = `Освежи страницу`
* `idv2.permissions.denied.return` = `Вратите се овде и притисните`
* `idv2.permissions.denied.scroll` = `Померите се надоле да бисте изабрали`
* `idv2.permissions.denied.settings` = `Подешавања`
* `idv2.permissions.denied.tap` = `Додирните`
* `idv2.permissions.denied.title` = `Пратите следеће кораке да бисте дозволили Инцоде-у да приступи вашој камери`
* `idv2.permissions.denied.yourBrowser` = `ваш претраживач`
* `idv2.permissions.description` = `како би се процес завршио`
* `idv2.permissions.dontAllow` = `Не дозволи`
* `idv2.permissions.fakeDenied.alert` = `упозорење лажно фокусирано`
* `idv2.permissions.fakeDenied.allowPermissions` = `Дозволи дозволе`
* `idv2.permissions.fakeDenied.quitProcess` = `Прекините процес`
* `idv2.permissions.fakeDenied.title` = `За снимање вашег документа потребна је дозвола камере`
* `idv2.permissions.fakeDenied.warning` = `упозорење`
* `idv2.permissions.note` = `Напомена: У зависности од вашег телефона, може да каже`
* `idv2.permissions.or` = `или`
* `idv2.permissions.subtitle` = `дозволите дозволу за камеру`
* `idv2.permissions.title` = `Потребан си нам`
* `idv2.permissions.whileUsing` = `Док користите апликацију`
* `idv2.tutorial.autoCapture` = `Фотографија ће бити снимљена аутоматски`
* `idv2.tutorial.startScan` = `Хајде да скенирамо`
* `idv2.tutorial.subtitle` = `Уверите се да је ваш ИД читљив`
* `idv2.tutorial.title` = `Скенирајте свој ИД`
* `idv2.uploading.analyzing` = `Анализирање...`
* `idv2.uploading.imageAlt` = `ИД цаптуре`
* `onboarding.errors.restartDisabled.message` = `Поновно покретање сесије је онемогућено на нивоу организације`
* `onboarding.errors.restartDisabled.title` = `Није могуће поново покренути сесију`
* `qes.signatureCheck` = `Сагласан сам са издавањем захтеваног сертификата и електронским потписивањем овог документа.`
* `qes.termsCheck` = `Прочитао сам и прихватам Инцоде-ову <2>политику приватности</2> и Инцоде-ови <6>услови коришћења</6> .`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Before: `Uobičajeni problemi`
  * Now: `Уобичајена питања`
* `commonIssues.takeManually`:
  * Before: `Снимите фотографију ручно`
  * Now: `Фотографишите ручно`
* `commonIssues.tryAgain`:
  * Before: `Ok, pokušaj ponovo`
  * Now: `Покушајте поново`
* `notifications.done`:
  * Before: `Готово`
  * Now: `Скенирање је завршено`
* `notifications.glareDetected`:
  * Before: `Одсјај присутан`
  * Now: `Откривен је одсјај`
* `notifications.glareDetectedDescription`:
  * Before: `Нагните ИД благо нагоре или надоле да бисте умањили одраз`
  * Now: `Пронађите боље осветљење да бисте избегли рефлексије`
* `notifications.idTypeUnacceptable`:
  * Before: `Тип ИД-а није прихваћен`
  * Now: `Неважећи лични документ`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Покушајте са другим документом`
  * Now: `Покушајте да скенирате други`
* `notifications.lowSharpness`:
  * Before: `Блур пресент`
  * Now: `Ниска оштрина`

---

- Path: `release-notes/sr-serbian`
- URL: https://developer.incode.com/release-notes/sr-serbian/
- Markdown: https://developer.incode.com/release-notes/sr-serbian.md

# SR - Serbian

## 🆕 Added

* `capturePreview.acceptedDocuments.BirthCertificate` = `Извод из матичне књиге рођених`
* `capturePreview.acceptedDocuments.country` = `{{country}}`
* `capturePreview.acceptedDocuments.Currency` = `Валута`
* `capturePreview.acceptedDocuments.DriversLicense` = `Возачка дозвола`
* `capturePreview.acceptedDocuments.FederalID` = `Федерална ИД`
* `capturePreview.acceptedDocuments.IdentificationCard` = `лична карта`
* `capturePreview.acceptedDocuments.label` = `Прихваћена документа за:`
* `capturePreview.acceptedDocuments.MedicalCard` = `Медицал Цард`
* `capturePreview.acceptedDocuments.Military` = `Војска`
* `capturePreview.acceptedDocuments.noDocuments` = `За ову земљу нису прихваћени документи. `
* `capturePreview.acceptedDocuments.Other` = `Остало`
* `capturePreview.acceptedDocuments.Passport` = `Пасош`
* `capturePreview.acceptedDocuments.Permit` = `Дозвола`
* `capturePreview.acceptedDocuments.ResidenceDocument` = `Документ о пребивалишту`
* `capturePreview.acceptedDocuments.TaxIdentification` = `Пореска идентификација`
* `capturePreview.acceptedDocuments.TravelDocument` = `Путна исправа`
* `capturePreview.acceptedDocuments.TribalIdentification` = `Идентификација племена`
* `capturePreview.acceptedDocuments.Unknown` = `Непознато`
* `capturePreview.acceptedDocuments.VehicleRegistration` = `Регистрација возила`
* `capturePreview.acceptedDocuments.Visa` = `Виса`
* `capturePreview.acceptedDocuments.VoterIdentification` = `Идентификација бирача`
* `capturePreview.acceptedDocuments.WeaponLicense` = `лиценца за оружје`
* `common.refreshPage` = `Освежи`
* `commonIssues.idv2.tryAgain` = `Ок, покушај поново`
* `errors.dynamicImport.failedToLoad` = `Нешто неочекивана грешка, али смо је приметили:`
* `errors.dynamicImport.suggestion` = `Покушаћемо поново за {{count}} или можете ручно да освежите`
* `errors.dynamicImport.title` = `Жао нам је, наишли смо на проблем`
* `idv2.capture.autoCapture` = `Фотографија ће бити снимљена аутоматски`
* `idv2.capture.dontMove` = `Не померајте своју личну карту на неколико секунди`
* `idv2.capture.fillFrame` = `Попуните оквир својим личним документом`
* `idv2.capture.fillFramePassport` = `Попуните оквир својим пасошем`
* `idv2.capture.manualCapture.ariaLabel` = `Мануал Цаптуре`
* `idv2.capture.manualCapture.title` = `Дугме за ручно снимање`
* `idv2.capture.notifications.blur.description` = `Увећајте и умањите приказ или додирните ИД`
* `idv2.capture.notifications.blur.title` = `ИД је превише мутан`
* `idv2.capture.notifications.glare.description` = `Пронађите боље осветљење да бисте избегли рефлексије`
* `idv2.capture.notifications.glare.title` = `ИД са одсјајем`
* `idv2.capture.notifications.notAligned.description` = `Центрирајте свој ИД унутар оквира`
* `idv2.capture.notifications.notAligned.title` = `ИД није поравнат`
* `idv2.capture.notifications.showBack.description` = `Окрените своју личну карту да покажете њену полеђину`
* `idv2.capture.notifications.showBack.title` = `Покажите полеђину личне карте`
* `idv2.capture.notifications.showFront.description` = `Окрените своју личну карту да покажете њену предњу страну`
* `idv2.capture.notifications.showFront.title` = `Покажите предњу страну ИД-а`
* `idv2.capture.passport.subtitle` = `Уверите се да је ваш пасош читљив`
* `idv2.capture.passport.title` = `Скенирајте пасош`
* `idv2.capture.processing.analyzing` = `Анализирање...`
* `idv2.capture.processing.attemptsRemaining` = `{{attempts}} / {{maxAttempts}} преосталих покушаја`
* `idv2.capture.processing.continue` = `Настави`
* `idv2.capture.processing.error` = `Грешка`
* `idv2.capture.processing.errors.classification.subtitle` = `Уверите се да цео ИД буде видљив и добро осветљен`
* `idv2.capture.processing.errors.classification.title` = `Верификација личне карте није успела`
* `idv2.capture.processing.errors.default.subtitle` = `Покушајте поново`
* `idv2.capture.processing.errors.default.title` = `Дошло је до проблема`
* `idv2.capture.processing.errors.glare.subtitle` = `Нагните ИД благо нагоре или надоле да бисте умањили одраз`
* `idv2.capture.processing.errors.glare.title` = `Одсјај присутан`
* `idv2.capture.processing.errors.readability.subtitle` = `Смањите подрхтавање камере мирним држањем телефона`
* `idv2.capture.processing.errors.readability.title` = `Информације нису читљиве`
* `idv2.capture.processing.errors.sharpness.subtitle` = `Померите ИД даље или ближе свом телефону док се слика не фокусира`
* `idv2.capture.processing.errors.sharpness.title` = `Блур пресент`
* `idv2.capture.processing.errors.unacceptable.subtitle` = `Покушајте са другим документом`
* `idv2.capture.processing.errors.unacceptable.title` = `Тип ИД-а није прихваћен`
* `idv2.capture.processing.errors.upload.subtitle` = `Проверите своју везу и покушајте поново`
* `idv2.capture.processing.errors.upload.title` = `Скенирање ИД-а није успело`
* `idv2.capture.processing.errors.wrongSide.subtitle` = `Снимите {{mode}} страну ИД-а`
* `idv2.capture.processing.errors.wrongSide.title` = `Погрешна страна је снимљена`
* `idv2.capture.processing.scanBack` = `Скенирајте позадину`
* `idv2.capture.processing.success` = `Успех`
* `idv2.capture.processing.successBackSubtitle` = `Сада да наставимо`
* `idv2.capture.processing.successFrontSubtitle` = `Сада ухватимо леђа`
* `idv2.capture.processing.successTitle` = `Успешно обрађено!`
* `idv2.capture.processing.tryAgain` = `Покушајте поново`
* `idv2.capture.takingPhoto` = `Сликање...`
* `idv2.capture.wrongSide.backHint` = `бацк-ид-хинт`
* `idv2.capture.wrongSide.frontHint` = `фронт-ид-хинт`
* `idv2.chooser.idButtonDescription` = `Национална лична карта или возачка дозвола`
* `idv2.chooser.idButtonTitle` = `лична карта`
* `idv2.chooser.passportButtonDescription` = `Пасош ваше земље`
* `idv2.chooser.passportButtonTitle` = `Пасош`
* `idv2.permissions.alertAlt` = `лажно упозорење о дозволи`
* `idv2.permissions.allow` = `ОК, дозволи`
* `idv2.permissions.denied.allow` = `Дозволи`
* `idv2.permissions.denied.ask` = `Питај`
* `idv2.permissions.denied.browser` = `Бровсер`
* `idv2.permissions.denied.camera` = `Камера`
* `idv2.permissions.denied.changeTo` = `Промените у`
* `idv2.permissions.denied.open` = `Отвори`
* `idv2.permissions.denied.or` = `или`
* `idv2.permissions.denied.refreshPage` = `Освежи страницу`
* `idv2.permissions.denied.return` = `Вратите се овде и притисните`
* `idv2.permissions.denied.scroll` = `Померите се надоле да бисте изабрали`
* `idv2.permissions.denied.settings` = `Подешавања`
* `idv2.permissions.denied.tap` = `Додирните`
* `idv2.permissions.denied.title` = `Пратите следеће кораке да бисте дозволили Инцоде-у да приступи вашој камери`
* `idv2.permissions.denied.yourBrowser` = `ваш претраживач`
* `idv2.permissions.description` = `како би се процес завршио`
* `idv2.permissions.dontAllow` = `Не дозволи`
* `idv2.permissions.fakeDenied.alert` = `упозорење лажно фокусирано`
* `idv2.permissions.fakeDenied.allowPermissions` = `Дозволи дозволе`
* `idv2.permissions.fakeDenied.quitProcess` = `Прекините процес`
* `idv2.permissions.fakeDenied.title` = `За снимање вашег документа потребна је дозвола камере`
* `idv2.permissions.fakeDenied.warning` = `упозорење`
* `idv2.permissions.note` = `Напомена: У зависности од вашег телефона, може да каже`
* `idv2.permissions.or` = `или`
* `idv2.permissions.subtitle` = `дозволите дозволу за камеру`
* `idv2.permissions.title` = `Потребан си нам`
* `idv2.permissions.whileUsing` = `Док користите апликацију`
* `idv2.tutorial.autoCapture` = `Фотографија ће бити снимљена аутоматски`
* `idv2.tutorial.startScan` = `Хајде да скенирамо`
* `idv2.tutorial.subtitle` = `Уверите се да је ваш ИД читљив`
* `idv2.tutorial.title` = `Скенирајте свој ИД`
* `idv2.uploading.analyzing` = `Анализирање...`
* `idv2.uploading.imageAlt` = `ИД цаптуре`
* `onboarding.errors.restartDisabled.message` = `Поновно покретање сесије је онемогућено на нивоу организације`
* `onboarding.errors.restartDisabled.title` = `Није могуће поново покренути сесију`
* `qes.signatureCheck` = `Сагласан сам са издавањем захтеваног сертификата и електронским потписивањем овог документа.`
* `qes.termsCheck` = `Прочитао сам и прихватам Инцоде-ову <2>политику приватности</2> и Инцоде-ови <6>услови коришћења</6> .`

## ✏️ Modified

* `commonIssues.commonIssues`:
  * Before: `Уобичајени проблеми`
  * Now: `Уобичајена питања`
* `commonIssues.takeManually`:
  * Before: `Снимите фотографију ручно`
  * Now: `Фотографишите ручно`
* `commonIssues.tryAgain`:
  * Before: `Ок, покушај поново`
  * Now: `Покушајте поново`
* `notifications.done`:
  * Before: `Готово`
  * Now: `Скенирање је завршено`
* `notifications.glareDetected`:
  * Before: `Одсјај присутан`
  * Now: `Откривен је одсјај`
* `notifications.glareDetectedDescription`:
  * Before: `Нагните ИД благо нагоре или надоле да бисте умањили одраз`
  * Now: `Пронађите боље осветљење да бисте избегли рефлексије`
* `notifications.idTypeUnacceptable`:
  * Before: `Тип ИД-а није прихваћен`
  * Now: `Неважећи лични документ`
* `notifications.idTypeUnacceptableDescription`:
  * Before: `Покушајте са другим документом`
  * Now: `Покушајте да скенирате други`
* `notifications.lowSharpness`:
  * Before: `Блур пресент`
  * Now: `Ниска оштрина`

---

- Path: `release-notes/translations-release-notes`
- URL: https://developer.incode.com/release-notes/translations-release-notes/
- Markdown: https://developer.incode.com/release-notes/translations-release-notes.md

# WEB SDK Translations Release Notes

---

- Path: `release-notes/translations-summary-1790`
- URL: https://developer.incode.com/release-notes/translations-summary-1790/
- Markdown: https://developer.incode.com/release-notes/translations-summary-1790.md

# SDK 1.79.0

---

- Path: `release-notes/web-sdk-20-release-notes`
- URL: https://developer.incode.com/release-notes/web-sdk-20-release-notes/
- Markdown: https://developer.incode.com/release-notes/web-sdk-20-release-notes.md

# Web SDK 2.0 Release Notes

Every published release of the Incode Web SDK 2.x packages, newest first.

`@incodetech/core` and `@incodetech/web` are versioned in lock-step — a given release number always
refers to both packages, and they must be installed at matching versions. New integrations should
start from [Getting Started](/sdk-reference/web-sdk-2-getting-started/).

```bash
npm install @incodetech/web@latest @incodetech/core@latest
```

:::warning
These release notes are specific to Web SDK 2.x. For Web SDK 1.x, you can find those release notes [here](/release-notes/releases-web-sdk/). The 1.x (`@incodetech/welcome`) and 2.x package lines are versioned independently.

**Do not attempt to upgrade or implement without support**. Contact your Incode representative to check if you are a candidate for this upgrade. 
:::

## 2.4.0

_23 October 2026_

### Added

- **Device wallet** verification runs headless through `renderWallet()` and `createDeviceWalletManager()` from `@incodetech/core/id`. Start Apple Wallet or Google Wallet mDL verification from your own button, with no Incode UI. See [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/).
- **Digital ID bank redirect** works in Workflow. `<incode-workflow>` accepts `digitalIdReturnUrl` and `digitalIdReturn`, and resumes the ID Capture step when the user returns from the bank. See [Workflow](/sdk-reference/web-sdk-2-module-workflow/#digital-id-bank-redirect).
- **ID Capture** shows one chooser card for each enabled Digital ID bank provider, with the provider's name and logo. Custom UIs read `digitalIdRedirectOptions` from the `chooser` state and pass `{ providerId }` to `selectDocument()`. See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).
- **ID Capture** lets the user return to automatic capture from the Help screen after switching to manual capture.
- **ID Capture** supports signed Google Wallet requests when the backend issues them.
- **Global UI config** gains three options. See [Global UI Config](/sdk-reference/web-sdk-2-theming/#global-ui-config).
  - `showCloseButton` and `closeButtonPosition` show a close button. After the user confirms, the module stops and `onError` reports `USER_CANCELLED`.
  - `helpButtonPosition` moves the capture help button on ID Capture and Document Capture.
  - `realtimeFeedbackMessageUIFlavor: 'minimal'` shows the ID capture feedback message without its animation.
- **Session expiry** ends mounted modules, Flows, and Workflows when a request for the current session returns HTTP 401. The SDK releases the camera and reports `SESSION_EXPIRED` once through `onError`. Headless integrations can subscribe with `onSessionExpired()` from `@incodetech/core/session`. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#session-expiry).
- **eKYC** supports the `phoneProfile` risk addon. See [eKYC](/sdk-reference/web-sdk-2-module-ekyc/#risk-addons).
- **Workflow** adds `oauth2Secured` to the `onFinish` meta. For an OAuth2-secured workflow, skip your own redirect so that the authorization server redirects the user. See [Workflow](/sdk-reference/web-sdk-2-module-workflow/#configuration).
- **Document Capture** accepts the `processIneMex` and `processColombiaRutForm` processing types. See [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/).
- **Phone number helpers** are available from `@incodetech/core/phone-number`: `getCallingCode`, `formatPhoneAsYouType`, `formatExamplePhoneNumber`, `parsePhoneNumber`, `isValidPhoneNumber`, and the `CountryCode` type.

### Changed

- <Pill type="breaking" /> **WASM loading** checks each WASM file against the official files for this SDK release, and does not run a file that does not match. Strict Content-Security-Policies must allow `blob:` in `script-src`, and self-hosted WASM must be the unmodified distribution for this version. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#wasm-integrity-checks).
- **Identity Reuse** submits on one tap: a document card or "Scan a new document" continues at once. The screen adds a "What data will be shared?" sheet and a Privacy Policy link. If you style, test, or override the previous picker, see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#identity-reuse).
- **Flow completion** redirects only to absolute `https` URLs. For any other `redirectionUrl`, the completion screen shows instead. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#flow-completion-redirects).
- **ID Capture** capture-only responses leave `frontImage` undefined for a back-only capture. If your TypeScript code reads `response.frontImage.blob`, check `frontImage` first; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#capture-only-id-responses).
- **Field Comparison** uses optimistic validation. Continue starts enabled, and submitting a blank name shows a required-field error. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#field-comparison-validation).
- **WASM console output** is off by default. Set `wasm.showLogs: true` before the first WASM load to see it. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).
- **TrueSight diagnostics** are available again, and `setup({ trueSight: { enabled: false } })` turns them off. While a session runs, the SDK keeps a pending record in `localStorage` under `incode.truesight.pending.*`, and can send it on a later page load.
- **Language selection** gives the `lang` URL query parameter priority over a saved language. The SDK no longer reads the language from the `i18next` cookie, the URL hash, or the URL path and subdomain.
- **Initial downloads** are smaller. Permission-denied screens, optional ID screens, phone number rules, the PDF worker, and the SVG sanitizer load only when they are needed. CSS is minified, and icons are smaller.

### Fixed

- **ID Capture**
  - The countdown shows 3, 2, 1 on low-end Android devices, and the processing screen shows immediately after capture. Custom UIs can animate the countdown with the new `countdownStepMs` capture-state field.
  - Capture-only mode honors `onlyFront` and calls `onCapture` for a back-only capture.
  - "No attempts remaining" shows after a failed capture when `captureAttempts` is omitted.
  - The wrong-side error names the correct side of the ID.
  - Desktop webcam previews are mirrored, so on-screen movement follows the user.
  - The device wallet tile shows when a wallet is enabled in the Digital ID methods, including in Workflows.
  - System errors show the shared error page with a reload option.
  - The document chooser title wraps at its intended width.
- **Selfie and Authentication**
  - A retry after a rejected manual capture stays in manual capture.
  - A tap on the tutorial "Start capture" button continues the flow when face detection is still loading.
  - Selfie no longer stays on the uploading screen after a manual capture on iOS Safari.
  - A face-detection initialization failure reports an error instead of retrying without end.
- **Uploads** of ID and Selfie images wait 35 seconds before they show the retryable upload error, so large images can finish on slow connections.
- **Sessions** record whether each ID and selfie image was captured automatically or manually.
- **Face Match** includes both ID portraits when second ID capture is enabled.
- **Workflow** stores a second ID upload separately instead of replacing the first ID.
- **Document Capture** processes proof of address, bank statements, and the other OCR document types correctly. The "file too large" error shows the configured `maxFileSize`.
- **eKYC**
  - `checkAddress: false` hides the address fields.
  - Values prefilled from a document scan stay editable, so the user can correct a misread value.
  - The US SSN field hides the digits with a show/hide toggle.
- **Dynamic Forms** aligns fields in Workflows, shows prefilled alpha-3 country and nationality values, and keeps the required asterisk on prefilled fields.
- **Country dropdowns** list countries alphabetically by localized name, and typed searches ignore accents. Watchlist for Business lists every country.
- **Flow and Workflow**
  - `onFinish` carries the dashboard end-screen title and text for Workflows and after a mobile handoff. In token mode, see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#workflow-completion-copy).
  - The Dashboard `disableUnsupportedBrowserScreen` setting is honored. The headless Workflow `loading` state carries `workflowConfig`.
  - Self-loading Flows include `interviewId` on every flow event, and `onFlowEvent` reliably receives `flow.started` and `flow.ready`.
  - QR and SMS links to mobile keep the active UI language.
  - A Flow finishes after Video Selfie reaches its maximum execution time instead of showing a blank screen.
- **Video Selfie**
  - Voice consent records audio under a Content-Security-Policy that blocks third-party script hosts. The MP3 encoder loads from your application's origin.
  - The closed-eyes guidance is translated.
- **PDF previews** work under a Content-Security-Policy without `script-src data:`.
- **Published type declarations** typecheck with `skipLibCheck: false`.
- **Accessibility**: keyboard focus stays visible on fields with errors, and dropdowns have stronger focus indicators and icon contrast. Screen readers announce a dropdown selection once and keyboard type-ahead finds country names.
- **Security**, privacy, and antifraud hardening.

### Removed

- <Pill type="breaking" /> **Manual ID and Selfie upload** is removed. Remove `manualUploadIdCapture`, `manualUploadSelfieCapture`, and the manual-upload states and methods, and use camera capture or Digital ID instead. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-4-0/#manual-upload-removal).

Install: `npm install @incodetech/web@2.4.0 @incodetech/core@2.4.0`

## 2.3.2

_9 October 2026_

<Accordion title="2.3.2">

### Added

- **eKYC** supports the `US_CREDIT_TELCO` source. First and last name are required, and the user provides a date of birth, an SSN, or both. Street, apartment, city, state, ZIP code, and a US phone number are optional. See [eKYC](/sdk-reference/web-sdk-2-module-ekyc/).

### Fixed

- **Workflow** no longer marks sessions as failed under rules that check the face-recognition result when every module passed. Face matching runs in the Face Match step, as in Web SDK 1, for `<incode-workflow>` and headless Workflow integrations. In a Workflow, the Selfie `finished` state's `processResponse` is empty; read the match result from Face Match. Flow and standalone Selfie captures are unchanged. See [Workflow](/sdk-reference/web-sdk-2-module-workflow/).
- **eKYC** prefills the date of birth from the scanned ID instead of leaving the field blank and locked.

Install: `npm install @incodetech/web@2.3.2 @incodetech/core@2.3.2`

</Accordion>



## 2.3.1

_29 September 2026_

<Accordion title="2.3.1">

### Fixed

- **ID Capture** shows an undistorted capture preview when the card is held vertically, or when the back is captured after a vertical front.

Install: `npm install @incodetech/web@2.3.1 @incodetech/core@2.3.1`

</Accordion>

## 2.3.0

_25 September 2026_

<Accordion title="2.3.0">

### Added

- **Digital ID** supports bank verification within ID Capture, including return-to-app handling, cancellation feedback, and a confirmation screen. See [Digital ID bank redirect](/sdk-reference/digital-id-redirect/).
- **ID Capture** supports mobile driver's licenses from supported device wallets. Users can retry a failed wallet attempt or choose another capture method. See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).
- **Selfie** offers optional photo upload from the tutorial through `manualUploadSelfieCapture`. Headless integrations must handle the new upload state and tutorial field; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#headless-states-and-test-fixtures).
- **Dynamic Forms** is available as the standalone `<incode-dynamic-forms>` component. See [Dynamic Forms](/sdk-reference/web-sdk-2-module-dynamic-forms/).
- **Electronic Signature** supports the Namirial qualified-signature review and signing journey, including provider terms and signed-document retrieval. See [Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/).
- **Video Selfie** accepts an explicit `steps` order for standalone and headless integrations. See [Video Selfie](/sdk-reference/web-sdk-2-module-video-selfie/).
- **Flow** accepts `redirectToMobileUrl` to customize the mobile handoff destination. See [IncodeFlow](/sdk-reference/web-sdk-2-incodeflow-component/).
- **Self-hosting** supports release-matched assets with explicit configuration and no fallback to the Incode CDN. Flow and Workflow preserve the supplied configuration. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/#hosting-wasm-files).
- **Browser support guidance** offers a link-copy action and a choice to continue in unsupported environments. Review [browser integration changes](/sdk-reference/web-sdk-2-upgrade-2-3-0/#browser-support-screens).
- **Custom UI integrations** gain actor-based manager factories for Certificate Issuance, Custom Fields, Custom Watchlist, Fiscal QR, Government Validation, and Watchlist for Business. Authentication, Certificate Issuance, Government Validation, and Watchlist for Business also support external-manager rendering. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/).

### Changed

- **Setup** returns before feature-management initialization finishes by default. If you read feature values immediately after setup, await readiness or opt into blocking initialization; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#feature-management-readiness).
- <Pill type="breaking" /> **Government Validation / INE Validation** shows progress and advances after the server request, without result or OTP screens. Custom integrations must remove the retired configuration, methods, and states; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#government-validation).
- **Custom Fields** and **Watchlist for Business** use optimistic validation: Continue starts enabled, and invalid submission reveals required-field errors. Custom UIs should follow the [validation guidance](/sdk-reference/web-sdk-2-upgrade-2-3-0/#form-validation).
- **Headless capture UIs** gain ID loading, tutorial, permission, and camera presentation fields. Update exhaustive state handling and typed fixtures as described in the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#headless-states-and-test-fixtures).
- **ID Capture** lists accepted document types when a document is rejected. If you read `acceptedDocuments`, entries are now strings; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#accepted-document-types).
- **Flow startup** loads the home screen sooner and downloads Redirect to Mobile code when needed. Workflow loads camera-processing resources when capture starts.
- **Translations** ship with the SDK and load by locale, removing runtime requests to the translation-catalog service for default production integrations. Custom translation sources remain supported. See [Internationalization](/sdk-reference/web-sdk-2-i18n/).
- **Initial downloads** are smaller, with independently cached fonts. If you copy stylesheets or inject their contents yourself, update your asset deployment using the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#self-hosted-assets-and-fonts).
- **Document Capture** honors `sendBase64`: omitted or `false` uses file uploads; `true` retains base64 uploads. Integrations that customize upload handling should review the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#document-capture-uploads).
- **Experiment assignment events** use `experimentAssigned`. Update consumers filtering the former plural name; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#event-and-error-handling).
- **Video Selfie** enforces the configured recording-duration and validation-attempt limits. Custom hosts must handle the terminal outcomes described in the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#video-selfie-terminal-outcomes).
- **TrueSight diagnostics** are temporarily unavailable. The setup option remains accepted, and regular SDK analytics are unaffected. See the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#truesight-diagnostics).
- Updated the bundled on-device processing runtime, with security and anti-injection hardening. Self-hosted deployments must refresh their complete asset distribution; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#self-hosted-assets-and-fonts).

### Fixed

- **ID Capture** mirrors the active camera correctly and preserves image proportions and framing. Camera sizing and Selfie retry previews also improve on affected iOS devices.
- **ID Capture** restores required-front capture in US Smart Capture, supports back-only manual uploads, and completes both documents when standalone second-ID capture is enabled.
- **Capture recovery** handles stalled uploads and processing failures without leaving users indefinitely on a loading screen. Standalone capture also uploads correctly when resources load lazily.
- **Video Selfie** starts correctly in Workflow, recovers camera switching on devices that cannot open both cameras together, and handles returning from a backgrounded tab. See [Video Selfie](/sdk-reference/web-sdk-2-module-video-selfie/).
- **Capture recordings** preserve retries within the capture step and release camera resources on exit. Recording smoothness and playback improve on affected Android and iOS devices.
- **Fiscal QR** displays camera-permission recovery guidance instead of a blank camera view. Custom UIs must handle `permissionDenied`; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#headless-states-and-test-fixtures).
- **Dynamic Forms** omits blank optional answers and provides a retry screen for submission failures. Custom UIs must handle `submitFailed`; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#headless-states-and-test-fixtures).
- **Consent cancellation** shows the shared error screen in Flow and Workflow. Error messages can be absent; use the [updated callback guidance](/sdk-reference/web-sdk-2-upgrade-2-3-0/#event-and-error-handling).
- **Branding and localization** render dashboard SVG logos reliably, apply configured border radii consistently, and update early browser-support screens when translations load. Video Selfie questions and consent use the selected supported session language.
- **Accessibility** improves required-field labels, form and dialog headings, capture-progress announcements, manual-capture guidance, and bottom-sheet dismissal. Browser-support screens also provide clearer copy and usable recovery instructions. See [Browser Support](/sdk-reference/incode-web-sdk-2-reference/#browser-support).

### Removed

- <Pill type="breaking" /> **Personhood** is unavailable in 2.3.0. Remove its imports and usage before upgrading; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#removed-apis).
- <Pill type="breaking" /> The deprecated **Document Upload** module is removed. Direct importers must migrate supported document-upload use cases to Document Capture; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#removed-apis).
- <Pill type="breaking" /> The custom `recording.capability` option is removed from capture configuration. Use SDK-managed recording; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#removed-apis).
- <Pill type="breaking" /> `WasmUtilProvider.getVersions()` is removed without a replacement. Remove calls from custom integrations; see the [upgrade guide](/sdk-reference/web-sdk-2-upgrade-2-3-0/#removed-apis).

Install: `npm install @incodetech/web@2.3.0 @incodetech/core@2.3.0`

</Accordion>

## 2.2.0

_21 August 2026_
<Accordion title="2.2.0">

### Added

- **Asset overrides** — replace the built-in SVG illustrations and Lottie animations by key. Set
  `assets` and `animations` on `UiConfig` globally, or on `FlowConfig` and any module component's
  `config` for one element; per-instance wins over global wins over the built-in default. An override
  takes a URL, raw SVG markup, a precompiled SVG component, or Lottie JSON, and falls back to the
  default if it fails. Accessibility metadata always comes from the SDK, not your input. New types:
  `AssetKey`, `AnimationKey`, `AssetOverride`, `AnimationOverride`, `AssetOverrides`,
  `AnimationOverrides`, `SvgComponent`. See [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/).
- **Loader presentation control** — `spinner?: SpinnerPresentation` on `UiConfig` globally, and on
  `FlowConfig`, `WorkflowComponentConfig`, and any module component's `config` per instance. It carries
  `renderMode` (`'spinnerAndText' | 'spinnerOnly' | 'textOnly'`) and `size`. One global setting now
  reaches module-internal loaders — ID camera preparation, camera permissions — that a flow-level
  setting never reached. New types: `SpinnerConfig`, `SpinnerPresentation`, `SpinnerRenderMode`.
- **Feature management** — `setup({ featureManagement, environment })` lets the SDK evaluate
  Incode-managed feature gates, experiments, layers, and parameter stores. Enabled by default; pass
  `featureManagement: false` to skip it, and no third-party code is fetched. Identity is anonymous by
  default — no API key is sent, the stable device ID and cross-page persistence are off, and `ip` and
  `country` are redacted. Configure with `clientExperimentId`, `disableStableId`,
  `disablePersistence`, `custom`, `appVersion`, and `redactedUserInfo`. Reads live on
  `@incodetech/core/feature-management` and never throw — they fall back to the default you pass. This
  adds the Statsig browser client, loaded lazily and only when enabled. See
  [Third-Party Dependencies](/sdk-reference/web-sdk-2-third-party-dependencies/).
- `setup({ trueSight: { enabled: false } })` opts the session out of Incode SDK-health diagnostics,
  which are enabled by default.
- `setup({ flow })` and `setup({ theme })` control what a standalone module loads up front. `flow:
  false` skips flow prefetch and config merging, `flow: { preload, mergeConfig }` enables each on its
  own; `theme: false` disables the session theme, `theme: { preload: true }` fetches it during
  `setup()`. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/).
- **US Smart Capture reads the ID barcode end-to-end**, matching 1.x. On-device barcode scanning runs
  alongside back-of-ID capture, and a back-only US ID can skip front capture, ID processing, and Face
  Match. If no barcode is read, capture falls back to the normal back-of-ID upload. See
  [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).
- **Document Capture** gains an `onlyPdf` flag that restricts uploads to PDF files, plus
  method-selection and common-issues screens. See [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/).
- **Dynamic Forms** gains prefill and login-hint handling. See [Dynamic Forms](/sdk-reference/web-sdk-2-module-dynamic-forms/).
  - `prefillValue` on `DynamicFormsConfig`, and `loginHintPrefill` on `FlowBaseConfig` and
    `WorkflowBaseConfig`, seed the single answer of a one-screen, one-question form — a login hint your
    page reads from a URL parameter, for example. The field stays editable, and a multi-field form is
    never touched.
  - A question with `prefillSource` is populated from the customer's captured ID. `Question` gains
    `prefillSource` and `editable`, and the `inputting` and `submitting` states gain
    `prefilledQuestionIds` and `nonEditableQuestionIds`. Non-editable prefilled fields render read-only
    with a "from ID" marker and still submit. `PHONE` and `MULTISELECT` are excluded; an unresolved
    value stays blank and editable.
  - An invalid login hint shows an inline field error so the customer retries in place. Exhausted
    attempts park the module on a terminal screen, adding `attemptsExhausted` to `DynamicFormsState`.
- **Geolocation** gains `maxAttempts` (default `3`), `retry()` and `quit()` manager methods, and `error`
  and `noNetwork` states. Device failures no longer all report as permission denied — a timeout or
  unavailable position now routes to a retryable screen. `@incodetech/web/extensibility` exports a
  shared `ConnectionError` screen. See [Geolocation](/sdk-reference/web-sdk-2-module-geolocation/).
- **Headless ID capture can render the optimizing phase.** Declare
  `IdCaptureConfig.supportsOptimizingStatus` when you render `captureStatus === 'optimizing'` from
  `candidateImageUrl ?? previewImageUrl`. `'optimizing'` joins the `captureStatus` union, and capture
  state gains `candidateImageUrl` (display only) and `optimizingDwellMs`. Leave the flag unset and the
  phase never runs. See [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/).
- `@incodetech/web/government-validation` and its `/styles.css` subpath export, so the module can be
  imported standalone like the others. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/).
- **Design system** (`@incodetech/web/extensibility`): `PasswordInputComposed`, a password field with a
  show/hide toggle and an optional requirements checklist you supply results for; an `invalid` prop on
  `InputComposed` that sets `aria-invalid` without a message; and `textSize` (`'M' | 'S'`) on
  `RadioButtonComposed`.
- `--input-surface-hover` and `--dropdown-surface-hover` tokens drive the hover state on inputs and
  dropdowns. See [Theming and Styling](/sdk-reference/web-sdk-2-theming/).

### Changed

- **`captureMode` semantics changed in Document Capture.** `'camera'` is now capture-only, where it
  previously offered both. Omit `captureMode` to keep capture plus upload with a method selector.
  `'file'` remains upload-only. See [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/).
- **Selfie and Authentication concealment uses one field.** `selfieConcealmentOption` (`'OPTION_NONE' |
  'OPTION_SILHOUETTE' | 'OPTION_2D' | 'OPTION_3D'`) on `BaseFaceCaptureConfig` and the `SELFIE` /
  `AUTHENTICATION` flow config replaces `obfuscateWithAvatar` and `avatarVariant`. Flows and workflows
  read it from your dashboard node configuration; standalone integrations set it directly. The avatar
  stays cosmetic — detection, quality, liveness, and upload run on the real frames.
- **Face Match is skipped when the ID has no front portrait.** Under US Smart Capture, a back-only ID
  gives nothing to compare, so Face Match self-completes rather than running a match that cannot
  succeed. Flow and workflow now agree. Selfie capture is unaffected.
- **`PermissionStatus` gained `'checking'`**, distinct from `'idle'`. If you switch exhaustively on it,
  render nothing for `'checking'`. Reading the value needs no change.
- **Two CSS class names are namespaced:** `SignatureCanvas*` → `IncodeSignatureCanvas*`, and
  `ImageDocumentCapturePdfPreview*` → `IncodeImageDocumentCapturePdfPreview*`. Update your selectors if
  you target either. See [Theming and Styling](/sdk-reference/web-sdk-2-theming/).
- **`documentCapture.*` analytics screen names were realigned.** Re-check your mappings against
  [Dashboard Events](/sdk-reference/web-sdk-2-events/) if you key logic off screen names.
- **Dynamic Forms and CURP Validation desktop layouts** put fields in a contained scroll region with
  the button in a fixed footer, matching ID OCR and eKYB. Mobile is unchanged. Dynamic Forms no longer
  submits on Enter, also matching ID OCR and eKYB.
- **A non-repeatable flow whose session already finished no longer starts.** It shows the localized
  finished-session screen and reports `SESSION_FINISHED` through the flow error callback.
- **Video Selfie follows the current design end to end.** ID capture starts detecting immediately,
  wrong-side and success feedback render in the frame, camera switches get a full-screen transition,
  and the final screen releases camera and microphone first. The recording manager exposes `flippingId`
  and `success`. Each step allows three validation attempts; exhausting an ID side skips the remaining
  ID steps. Camera, network, and upload failures no longer consume an attempt or end the recording —
  call `manager.retry()`. See [Video Selfie](/sdk-reference/web-sdk-2-module-video-selfie/).
- **Video Selfie errors and uploads are more resilient.** Error screens show translated copy instead of
  raw network detail, with the raw message kept on `state.error`. The recording streams in retried
  chunks, so an interruption salvages all but the final seconds. A failed selfie upload retries in
  place, then re-runs only the selfie step inside the same recording.
- **Redirect to Mobile** applies a 30-second cooldown before an SMS link can be resent, and shows an
  error state when sending fails. See [Redirect to Mobile](/sdk-reference/web-sdk-2-module-redirect-to-mobile/).

### Fixed

- **Camera permission is no longer requested on every capture module inside an Android WebView.** A
  WebView has no persistent permission store, so the "allow camera" screen reappeared before each
  module even though no system prompt followed. The screen also no longer flashes during a permission
  check. iOS WebKit and Firefox for Android genuinely re-prompt, so they are unchanged.
- **The published stylesheets no longer style your page.** Unscoped utility selectors (`.flex`,
  `.container`, `.rounded`) collided with integrator design systems; every published selector is now
  anchored to an Incode-namespaced class, attribute, or element, enforced by a build check. Dead CSS
  goes with it — `base.css` drops from 464 KB to 392 KB, `flow/styles.css` from 256 KB to 156 KB. See
  [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/).
- **Three stylesheet subpaths resolved to files that were never built.** Importing
  `@incodetech/web/signature/styles.css`, `.../electronic-signature/styles.css`, or
  `.../qe-signature/styles.css` failed in every bundler, as the module docs instruct. All three resolve
  now, and the electronic-signature family shares one stylesheet. No import path changed.
- **`config.onlyFront` reaches the backend.** The ID module dropped it silently. It is now sent on the
  front upload, and the SDK honors the answer — `onlyFront` is a statement about the document that the
  server may decline, so a two-sided document still asks for the back, passports included. Use your
  dashboard's front-only configuration to force front-only capture. Manual upload hides the back slot
  after the front file alone, matching 1.x. See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).
- **Global asset and animation overrides were silently discarded** by `<incode-flow>`,
  `<incode-workflow>`, and standalone modules. An override that fails at runtime now falls back to the
  built-in default instead of rendering blank, URLs are validated, and unknown keys warn in
  development.
- **ID Capture:** capture works in Firefox for Android; the frame and preview respect a detected
  passport's orientation; "Unable to process" appears when Document Capture attempts are exhausted; and
  the selfie Age Assurance notice appears even when `showTutorial` is `false`, since that copy doubles
  as the age-estimation privacy notice.
- **Preview mirroring follows the camera actually opened**, via a new `usingBackCamera` capture-state
  flag rather than the static `assistedOnboarding` config. A desktop without a rear camera now shows a
  mirrored front-camera view; mobile keeps the unmirrored rear view.
- **Privacy Lens and the 2D avatar are usable on low-tier devices.** They render in a dedicated worker
  on Chromium browsers, with an improved main-thread fallback elsewhere, and no longer judder during
  capture. Avatar initialization also works in webpack-bundled apps, where it previously always failed.
- **Workflow:** the launch "Get Started" screen reopens on desktop after leaving an injected Redirect
  to Mobile step, instead of jumping into the first module.
- **Shared components:** the error icon on inputs, checkboxes, radio buttons, and phone, date, and
  textarea fields returns to its intended size; loaders use the default light secondary spinner color
  again; a long localized camera-permission title no longer overlaps the desktop modal close button;
  and Face Match no longer scrolls the page during its animations.
- **Accessibility (WCAG 2.2 AA)** across Document Capture, Electronic Signature, Redirect to Mobile,
  and shared components: preview images and the PDF viewer gain accessible names and a real reading
  path; focus is restored across review states and after closing a document; camera pages expose
  landmarks and correct headings; help opens in a dialog that keeps assistive technology out of the
  background; consent links are underlined and meet contrast minimums; the phone field reports as
  required and identifies its autocomplete purpose; and searchable dropdowns expose their filter as an
  editable combobox.
- Antifraud and device-integrity hardening.

### Deprecated

- `SpinnerConfig.title` and `SpinnerConfig.subtitle`. Set loader copy through the `loadingCircle.*`
  i18n translations instead — a literal string in config does not follow a runtime language change.
  Still honored in 2.2.0; removal targeted for 2.3.0. See [Internationalization](/sdk-reference/web-sdk-2-i18n/).

### Removed

- **The `CPF_OCR` flow key and the `@incodetech/core/cpf-ocr`, `@incodetech/web/cpf-ocr`, and
  `@incodetech/web/cpf-ocr/styles.css` subpath exports.** CPF-only capture is part of ID OCR now: a
  flow using `useCPF` keeps its `ID_OCR` step, preserves its configuration, and enables `cpfOnly`.
  Import `formatCPF` and `isValidCPF` from `@incodetech/core/id-ocr`. See [ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/).
- **`state.debugFrame`** from `SelfieState`, `AuthenticationState`, and `IdCaptureState`. It was
  already always `undefined`. If you need per-frame pipeline frames, contact us — a purpose-built,
  opt-in hook is the intended replacement.
- **The Geolocation manager's `reset()` method** and its `RESET` event. No state handled the event, so
  no behavior is lost, but drop the call if you make it.

Install: `npm install @incodetech/web@2.2.0 @incodetech/core@2.2.0`

</Accordion>

## 2.1.1

_30 July 2026_

<Accordion title="2.1.1">

### Changed

- `@incodetech/core` and `@incodetech/web` now publish ISC license metadata and a `LICENSE` file, so
  automated license scanners resolve the packages instead of rejecting them for missing license
  information. Metadata only — no API or runtime behavior changes.
- Updated the bundled on-device processing runtime.

### Fixed

- The SDK now initializes on hardened hosts and in webviews where Web Storage is unavailable —
  removed, blocked, or replaced. Values that cannot be persisted are skipped and reads fall back to
  defaults, instead of the SDK failing to start.
- Antifraud, device-integrity, and anti-injection hardening.

Install: `npm install @incodetech/web@2.1.1 @incodetech/core@2.1.1`

</Accordion>

## 2.1.0

_10 July 2026_

<Accordion title="2.1.0">

### Added

- **Certificate Issuance** module (`CERTIFICATE_ISSUANCE`) — password capture, digital certificate
  issuance, and download. Available as `createCertificateIssuanceManager` from
  `@incodetech/core/certificate-issuance` and as `<incode-certificate-issuance>`. See
  [Certificate Issuance](/sdk-reference/web-sdk-2-module-certificate-issuance/).
- **Fiscal QR** module (`FISCAL_QR`) — scans a Mexican fiscal (SAT) QR code, resolves its URL, and
  submits it for verification.
- **Field Comparison** module (`FIELD_COMPARISON`) — collects a first and last name and submits them
  for backend verification.
- **INE Validation** (`INE_VALIDATION`) — the Mexican government / INE check, available through the
  same manager and component as [Government Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/).
- **ML Consent** (`ML_CONSENT`) — supported in both flows and workflows through the shared mandatory<br />consent module.
- **Video Selfie** with local recording.
- **Privacy Lens** — an opt-in cosmetic avatar rendered in place of the live camera preview during
  selfie and authentication capture, with a reassurance banner above the capture frame. Detection,
  quality, liveness, and upload continue to run on the real camera frames; enable it from your
  dashboard configuration.
- `setup()` gained options for controlling third-party dependencies and self-hosting:
  - `fingerprint: false` — skips client-side device-fingerprint submission.
  - `ipLookup: false` — skips the client IP lookup.
  - `i18n` — supply your own i18n instance (`@incodetech/web`).
  - `wasm: { basePath }` — serve the on-device processing assets from your own origin. See
    [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).
  - `devMode` and `wasm: { showLogs }` — development diagnostics. Do not enable in production.
- `extractIdFace: false` on `IdCaptureConfig` skips face extraction from the ID document, for flows
  that do not run a biometric comparison. See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).
- `showFinishScreenBySessionStatus` on the workflow configuration renders a finish screen specific to
  the resolved session status. See [Workflow](/sdk-reference/web-sdk-2-module-workflow/).
- ID Capture and Face Capture emit new events:
  - `errorTriggered` for every front-end error state — capture and upload errors, expired document,
    offline or degraded network, and fatal errors — with an `{ errorName, errorCode, reason }`
    payload.
  - `background` and `foreground` when the page's visibility changes during an active session,
    carrying the current screen. A session opened in an already-hidden tab reports it on start. See
    [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/).
- Form modules expose per-field validation. `validateField()` on the manager triggers validation for
  a single field on blur, and a `validationErrors` map on the state drives the displayed messages.
  Available on **eKYC**, **eKYB**, **Dynamic Forms**, **ID OCR**, and **CURP Validation**.
- Flow and workflow failures now carry a machine-readable `moduleErrorCode`, and Incode API error
  codes and messages are surfaced across the flow and workflow lifecycle.
- A flow's `onFinish` result includes the end-screen texts configured in your dashboard.
- **eKYC** renders phone and email fields when `riskAddons` are configured.
- **Dynamic Forms** renders `YESNO` questions as a Yes/No dropdown.
- `<incode-workflow>` supports a self-loading mode.
- **Watchlist**, **Watchlist for Business**, and Incode Watchlist nodes now resolve in workflows.
- Transactional Risk Intelligence (TRI) telemetry.

- **Personhood** — a passive liveness check that runs without an onboarding session,
  available through `createPersonhoodManager()` from `@incodetech/core/personhood`.

### Changed

- **Forms use optimistic validation.** The Continue button starts enabled on each screen. Submitting
  with empty required fields reports every missing field at once and disables the button until they
  are corrected; typing clears the error for that field. Format errors (phone, email, CPF, CNPJ, SSN,
  postal code) report on blur. Applies to **eKYC**, **eKYB**, **Dynamic Forms**, **ID OCR**, the
  phone and email input screens, and the OTP code screens.
- **Form state shape changed with it.** If you read form state directly:
  - `errors` is replaced by `validationErrors`, whose entries are `{ key, params? }`.
  - `submitAttempted` is removed — the state machine now writes errors for all invalid fields on
    submit, so no separate flag is needed to gate display.
  - `isValid` and `canSubmit` now mean "no validation error is currently displayed" rather than "the
    form would pass validation". Existing `disabled={!isValid}` bindings keep working under the new
    optimistic meaning.
  - `computeEkycDisplayErrors` and `computeEkybDisplayErrors` are no longer exported; errors live
    entirely on `state.validationErrors`.
- **Authentication:** `USER_IS_NOT_RECOGNIZED` is retryable up to the configured capture-attempt
  limit (default 3) and then advances the flow, matching Web SDK 1.x, instead of ending the session on
  the first failure.
- When face authentication fails with an advanceable terminal error (`NONEXISTENT_CUSTOMER`,
  `HINT_NOT_PROVIDED`), the orchestrator advances so the backend can route the customer to
  enrollment, rather than terminating.
- A desktop-to-mobile handoff that finishes on mobile now completes the journey, instead of resuming
  the desktop session at the next module.
- **Government Validation** shows a loading spinner while a check is still in progress, replacing the
  success check mark that appeared prematurely.
- Manual capture is disabled when the Selfie or Authentication module runs with on-device face result
  submission enabled.
- Analytics screen names were realigned across modules and new typed module tokens added. If you key
  logic off screen names in tracked events, re-check your mappings against
  [Dashboard Events](/sdk-reference/web-sdk-2-events/).
- Consent and mandatory-consent copy is fetched in the active SDK language instead of always in
  English.
- Core JavaScript is minified, reducing bundle size. See [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/).
- Default fonts are self-hosted with the package rather than fetched from a third-party CDN. See
  [Third-Party Dependencies](/sdk-reference/web-sdk-2-third-party-dependencies/).

### Fixed

- **ID Capture:** expired-ID retry handling restored to 1.x parity; the back-of-ID prompt is skipped
  when the backend accepts a single-sided document even with `alwaysCaptureBackOfId` set; Continue
  buttons are labelled correctly on the front-ID success screen when no back scan is needed; the
  desktop preview is mirrored so on-screen movement matches the user; `previewImageUrl` is restored
  in the capture-only flow so the post-capture screen advances; the manual-capture tooltip no longer
  shifts the layout.
- **Manual ID upload:** validation errors appear beneath the slot that failed instead of once at the
  bottom; uploaded slots survive switching between the ID and Passport tabs; images are normalized to
  JPEG before size validation; the quality-rejected error is no longer shown when the attempt was
  approved.
- **Digital ID upload:** an excluded country or unaccepted document shows the failure screen instead
  of silently continuing.
- **Face Match:** server-side face processing always runs before results are read; face match is
  skipped and the flow continues when the session was captured with `extractIdFace: false`; liveness
  snackbar labels are translated.
- **Selfie:** the on-device selfie assets load reliably when a warm-up is already in flight.
- **Custom Watchlist** calls the custom watchlist endpoint. The global **Watchlist** module is
  unchanged.
- **CURP Validation:** the retry / manual-verify option is restored after a failed validation, and
  the verifying text is hidden while idle.
- **Geolocation:** an unresolvable location renders localized copy instead of a literal `"Unknown"`,
  and the desktop permission-denied screen is localized.
- **Electronic Signature:** a session never associates more than one document; a signing error shows
  for three seconds and then finishes; error states route correctly by backend error type; a
  successful `signQes` response is treated as success; the signature canvas border renders on
  iOS 14.
- **Field Comparison** submits names in the shape the dashboard expects, so they appear on the
  session.
- **Document Capture** follows the camera-permission instructions before opening the camera, and PDFs
  render in an in-page viewer instead of a native embed that showed an OS-level "Open" button on iOS
  Safari and mobile Chromium.
- **Workflow and Flow:** `DYNAMIC_FORMS` is registered and the flow advances when face-auth attempts
  are exhausted; the finish-status call is no longer issued on the desktop when the handoff completed
  on mobile; the active workflow node is used when fetching finish status, so hosts receive the
  completion redirect.
- **Redirect to Mobile:** "Change phone number" works after an SMS resend hits the limit; a transient
  error no longer flashes on desktop right after the module loads.
- The finish-process screen shown while the session result resolves no longer renders a title-less
  spinner.
- Camera tracks are stopped explicitly at module transitions, and the rear camera is selected for
  back-camera capture on desktop and tablet devices.
- Language selection from the home-screen settings modal survives a page reload.
- A `TypeError` no longer appears in the console immediately after a flow completes.
- Standalone `@incodetech/web` imports for `redirect-to-mobile`, `cpf-ocr`, `document-capture`, and
  `field-comparison` resolve correctly. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/).
- Street-level address selections are validated in **eKYC** and **eKYB** — choosing a city-level
  autocomplete result now reports that a street-level address is required.
- Accessibility (WCAG 2.2 AA) fixes across capture, forms, and shared components: error messages are
  programmatically associated with their fields; processing and transition screens announce once
  instead of exposing fragmented text; dropdowns announce as select-only comboboxes with their
  required and invalid state; buttons keep an accessible name while loading; modals move initial focus
  to the dialog heading; scroll containers are keyboard-operable; placeholder text meets contrast
  minimums; and the camera-permission "requesting" screen no longer announces behind the native OS
  prompt.

Install: `npm install @incodetech/web@2.1.0 @incodetech/core@2.1.0`

</Accordion>

## 2.0.1
_18 May 2026_

<Accordion title="2.0.1">

### Fixed

- Republished the 2.0.0 artifacts with their build output. Version 2.0.0 shipped without it and is
  deprecated on npm — install `2.0.1` or newer.
- **Digital ID upload:** an excluded country or unaccepted document now shows the failure screen
  instead of silently continuing the flow; `captureAttempts` is honored exactly, rather than allowing
  one extra attempt; the terminal "no more attempts" screen is rendered and waits for the customer
  before returning to the document chooser; and the analyzing screen's status announcement is no
  longer visible on screen.

Install: `npm install @incodetech/web@2.0.1 @incodetech/core@2.0.1`

</Accordion>

## 2.0.0
_15 May 2026_

<Accordion title="2.0.0">

<Callout icon="❗️" theme="error">
  ### Do not install 2.0.0. It was published without its build output and is deprecated on npm. Use `2.0.1` or newer.
</Callout>

Initial general availability of Web SDK 2.0 — a ground-up rewrite distributed as the
`@incodetech/core` and `@incodetech/web` npm packages, replacing the 1.x
`@incodetech/welcome` script bundle.

### Added

- Three integration paths from one package set: the `<incode-flow>` drop-in component, an
  orchestrator driving individual module web components, and headless managers for fully custom UI.
  See [Getting Started](/sdk-reference/web-sdk-2-getting-started/) and [Module Patterns](/sdk-reference/web-sdk-2-module-patterns/).
- Every consumer-facing module ships as a standard Web Component with its own CSS entry point, so it
  works in any framework. See [Web Components](/sdk-reference/web-sdk-2-web-components/) and
  [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).
- Design-token theming, asset overrides, and internationalization. See
  [Theming & Styling](/sdk-reference/web-sdk-2-theming/), [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/), and
  [Internationalization](/sdk-reference/web-sdk-2-i18n/).
- Full TypeScript types across the public API, and per-module entry points for bundle splitting. See
  [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/) and [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/).

</Accordion>

---

- Path: `release-notes/websdk-user-experience-v2-migration-guide`
- URL: https://developer.incode.com/release-notes/websdk-user-experience-v2-migration-guide/
- Markdown: https://developer.incode.com/release-notes/websdk-user-experience-v2-migration-guide.md

# User Experience V2 Migration Guide

## Step One: Upgrade the Incode Web SDK

The full UXv2 experience is available starting on [WebSDK version 1.83.0](/release-notes/releases-web-sdk/#/). Depending on your integration type (CDN or Package manager), you should update to the latest Web SDK version.

```html CDN( con scripttag)
 <!-- Include Incode Web SDK inside the head tag -->
  <script src="https://sdk.incode.com/sdk/onBoarding-{user.WEB_SDK_VERSION}.js" defer></script>
```
```json package.json
  "dependencies": {
    //...
    "@incodetech/welcome": "^{user.WEB_SDK_VERSION}"
  }
```

## Step Two: Replace ID capture-related methods

The new `renderCaptureId()` is a streamlined method. It incorporates the previously separate steps into a centralized  ID capture process, as shown in the image.

For example, instead of using `renderDocumentSelector()` ➔ `renderCamera("front")` ➔`renderCamera("back")`, and/or `renderCamera("passport")`, you now use only `renderCaptureId()`. All logic is handled internally. The following code shows the changes you must make for the new ID capture experience.

```javascript
// Remove all the logic and chaining of methods for:
// renderDocumentSelector()
// if id ➔ renderCamera('front') ➔ renderCamera('back')
// if passport ➔ renderCamera('passport')  

// Use the single method renderCaptureId()
incode.renderCaptureId(cameraContainer, {
  session: incodeSession,
  onSuccess: processId, // Method to call incode.processId();
  onError: showError,
  //forceIdV2: true, // Optional: To force UXv2 during development, leave it blank for production.
  //uiConfig: UiConfig, // Optional: custom theming.
});
```

### 2.1. Where are all my `options`?

<Callout icon="⚙️" theme="default">
  Previously, many parameters had to be passed with the `options` object. Now, most parameters are automatically retrieved by the **ID Capture module** in your Flow or Workflow configuration.
</Callout>

| Previous option name | New option/module configuration                               | Description                                                           |
| :------------------- | :------------------------------------------------------------ | :-------------------------------------------------------------------- |
| `onSuccess`          | No change                                                     | Callback function to be executed after a successful capture.          |
| `onError`            | No change                                                     | Callback function to be executed after a capture error.               |
| `token`              | `session`                                                     | Incode Session token.                                                 |
| `numberOfTries`      | ID Capture ➔ "Number of image capture attempts"               | Number of opportunities the user has to perform a successful capture. |
| `timeout`            | ID Capture ➔ "Autocapture Timeout" and "ID detection timeout" | Timeouts in seconds before enabling the manual capture mode.          |
| `showTutorial`       | ID Capture ➔ "ID capture tutorial"                            | Toggle on/off Incode capture tutorials.                               |
| `isRecordingEnabled` | ID Capture ➔ "Enable ID recording"                            | Records a brief video of the moment of capture.                       |

### 2.2. What happened to the `renderDocumentSelector()` method?

You can toggle the Document Selector screen by selecting the option **ID Capture ➔ "Show document chooser screen"**. You'll find this in your Flow or Workflow configuration, as shown here.

<Image align="center" border={true} src="https://developer.incode.com/assets/ce1d5cd19e1fcedb3a3b20b10ce7ca27.png" className="border" />

The document selector screen is optional. The new capture experience recognizes the document type and adjusts automatically. However, the screen provides a custom UI that can assist the user in capturing the passport more effectively.

:::warning
  The `processId()` method is still required after capturing the ID document.
:::

## Step Three: Replace the `renderCamera('selfie')` method

The new `renderCaptureFace()` method is a direct replacement of `renderCamera('selfie')` The following code shows the changes you must make for the new face capture experience.

```javascript
// Remove renderCamera('selfie')

// Use the method renderCaptureFace()
incode.renderCaptureFace(cameraContainer, {
  session: incodeSession,
  onSuccess: processFace, // Method to call incode.processFace();
  onError: showError,
  //forceV2: true, // Optional: To force UXv2 during development, leave it blank for production.
  //uiConfig: UiConfig, // Optional: custom theming.
});
```

### 3.1. Where are all my`options`?

<Callout icon="⚙️" theme="default">
  Previously, many parameters had to be passed with the `options` object. Now, most parameters are automatically retrieved by the **Face Capture module** in your Flow or Workflow configuration.
</Callout>

| Previous option name | New option/module configuration | Description |
|----------------------|---------------------------------|-------------|
| `onSuccess` | No change | Callback function to be executed after a successful capture. |
| `onError` | No change | Callback function to be executed after a capture error. |
| `token` | `session` | Incode Session token. |
| `numberOfTries` | Face Capture ➔ "Number of image capture attempts" | Number of opportunities the user has to make a successful capture. |
| `timeout` | Face Capture ➔ "Autocapture Timeout" | Timeout in seconds before enabling the manual capture mode. |
| `showTutorial` | Face Capture ➔ "Face capture tutorial" | Toggle on/off Incode capture tutorials. |
| `isRecordingEnabled` | Moved to: Face Capture ➔ "Enable face recording" | Records a brief video of the moment of capture. |
| `assistedOnboarding` | Module Configuration: Face Capture ➔ "Assisted Onboarding" | Allows the rear camera to be used for face capture instead of the front camera, enabling a second person to assist the user. |
| `hatCheckEnabled` | Face capture ➔ "Hat Validation" | Enables the hat detection check. |
| `lensesCheckEnabled` | Face capture ➔ "Lenses Validation" | Enables the glasses detection check. |
| `maskCheckEnabled` | Face capture ➔ "Mask Validation" | Enables the face mask detection check. |
| `eyesClosedCheckEnabled` | Face capture ➔ "Closed eyes validation" | Enables the closed eyes detection check. |

## Step Four: Call `processFace()` after

In order to complete the face capture process with the new UI/UX experience, you must call the `processFace()` method after the face capture. The following code shows the changes you must make.

```javascript
async function processFace() {
  try {
    const results = await incode.processFace(incodeSession); // {token: 'sdfsfs....sdfsdf'}
    console.log("processFace results", results);
    nextStep();
  } catch (error) {
    showError(error);
  }
}
```

## Step Five: Customization

Previously, customers who wanted to customize the capture experience used CSS classes. The new UX v2 uses **Design Tokens** as shown here.

### uiConfig

```typescript
export type UiConfig = {
  branding?: {
    logo?: { src?: string; height?: string };
    hideFooterBranding?: boolean;
  };
  closeButton?: {
    show?: boolean;
    position?: 'left' | 'right';
    offset?: number | string;
  };
  theming?: {
    designTokens?: DesignTokens
    shirtColor?: string;
  };
  notifications?: {
    minimal?: boolean;
  };
};
```

You can now customize the UI by passing an object with the value to overwrite, as shown in the following code. This allows for more direct customization while still maintaining a coherent UI.

```javascript
const UiConfig = {
  theming: {
    designTokens: {
      button: {
        primary: {
          surface: { default: '#fda9cc', hover: '#fa91bd' },
          text: { default: '#ffffff' },
        }
      },
    }
  },
};

incode.renderCaptureId(cameraContainer, {
  session: incodeSession,
  onSuccess: processId, // Method to call incode.processId();
  onError: showError,
  uiConfig: UiConfig, // Optional: custom theming.
}
```

For more information, review the Theming page.

## Step Six: Turn on the UXv2 experience

Once you've completed these changes, just turn on the new experience. To do so, set `forceIdV2` in `renderIdCapture` and `forceV2`in `renderFaceCapture` to `true`.

---

- Path: `sdk-reference/advanced`
- URL: https://developer.incode.com/sdk-reference/advanced/
- Markdown: https://developer.incode.com/sdk-reference/advanced.md

# Advanced


<Component slug="web-2-x-implementation-warning" />

Advanced capabilities for teams with specialized integration, performance, or security requirements. Most integrations won't need these; reach for them when the standard setup doesn't fit.

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode): Run the SDK without its default UI so you can build your own front end on top of Incode's capture and verification flows.
- [Dashboard Events](/sdk-reference/web-sdk-2-events): Receive and respond to events the Dashboard emits during a session.
- [Web Components](/sdk-reference/web-sdk-2-web-components): Embed SDK functionality as custom elements in your page.
- [Session Management](/sdk-reference/web-sdk-2-session-api): Control session lifecycle, persistence, and recovery.
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm): Configure the SDK's WebAssembly modules for your deployment.
- [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization): Reduce SDK payload size and improve load performance.
- [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture): Run face capture processing in the browser instead of on Incode's servers.
- [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee): Encrypt sensitive data client-side so it stays unreadable in transit and at rest.

---

- Path: `sdk-reference/android-accept-video-selfie`
- URL: https://developer.incode.com/sdk-reference/android-accept-video-selfie/
- Markdown: https://developer.incode.com/sdk-reference/android-accept-video-selfie.md

# Accept Video Selfie

The Accept Video Selfie module presents a consent screen that asks the user to agree to having a video selfie recorded later in the flow. It signals once the user accepts. This module is in beta.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern​ 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

## Add Accept Video Selfie

1. Add the module with `addAcceptVideoSelfie()`:

   ```kotlin
   flowConfigBuilder.addAcceptVideoSelfie()
   ```
   ```java
   flowConfigBuilder.addAcceptVideoSelfie();
   ```

2. Add the [Video Selfie](/sdk-reference/android-video-selfie/) module directly after Accept Video Selfie.

### Example

The example below adds Accept Video Selfie before the Video Selfie step, then listens for the user's acceptance through `onUserAcceptedVideoSelfie()`.

```kotlin
val videoSelfie = VideoSelfie.Builder()
    .setSelfieMode(VideoSelfie.SelfieMode.SELFIE_MATCH)
    .build()

val flowConfig = FlowConfig.Builder()
    .addAcceptVideoSelfie()
    .addVideoSelfie(videoSelfie)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onUserAcceptedVideoSelfie() {
        // User accepted the video selfie recording. Continue the flow.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addAcceptVideoSelfie()
    // ... add the Video Selfie step after it
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onUserAcceptedVideoSelfie() {
        // User accepted the video selfie recording. Continue the flow.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Accept Video Selfie has no configurable settings. It is added with the no-argument `addAcceptVideoSelfie()` method.

## Result

Accept Video Selfie does not deliver a result payload to the `OnboardingListener`. It signals completion through the no-argument `onUserAcceptedVideoSelfie()` callback, which fires when the user accepts the video selfie recording.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For the related result type, see `AcceptVideoSelfieResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-advanced-integration-dynamic-delivery`
- URL: https://developer.incode.com/sdk-reference/android-advanced-integration-dynamic-delivery/
- Markdown: https://developer.incode.com/sdk-reference/android-advanced-integration-dynamic-delivery.md

# Dynamic Delivery

If you want to keep your app download size small, you can use Google Play Feature Delivery to download the Incode Android SDK on demand, at runtime, as a Dynamic Feature Module. You can then uninstall the module when it's no longer needed. This page walks through the full setup: creating the Dynamic Module, configuring Gradle, installing at runtime, and testing. Dynamic Delivery is available for both Google and Huawei devices.

<Callout icon="🚧" theme="warn">
  ### You cannot isolate the whole SDK

  It is not possible to isolate the **whole** SDK into a dynamic module. The main, smaller part needs to be declared as a direct dependency. The core part, which contains larger files, can be separated into a dynamic module.
</Callout>

***

## Requirements

- You must use the Android App Bundle format when publishing your app.
- Dynamic Feature Modules are supported on devices running Android 5.0 (API Level 21) or later.

***

## Choose Your Mobile Services Path

Google Play Feature Delivery requires Google Mobile Services (GMS). For Huawei devices without GMS, use Huawei Dynamic Ability with Huawei Mobile Services (HMS).

| Your Target Devices               | Use                                                  | Implementation                                                                                               |
| --------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Have Google Mobile Services (GMS) | Google Play Feature Delivery                         | The step-by-step flow on this page.                                                                          |
| Are Huawei devices without GMS    | Huawei Dynamic Ability (Huawei Mobile Services, HMS) | Integration is very similar to Google's; classes and methods are named similarly.                            |
| Need to support both              | Build flavors and per-service install classes        | See [Supporting both GMS and HMS](#support-both-google-mobile-services-and-huawei-mobile-services) below. |

***

## Set Up Dynamic Delivery

Complete the following steps in order.

### Add the Repository and Dependencies

1. In your project-level `build.gradle`, add the GitHub Packages repository with the provided credentials:
   ```groovy
   allprojects {
       repositories {
           ...
           maven {
               url "https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages"
               credentials {
                   username = "incode-customers"
                   password = "GITHUB_TOKEN"
               }
           }
       }
       ...
   }
   ```
   ```kotlin
   allprojects {
       repositories {
           ...
           maven {
               url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
               credentials {
                   username = "incode-customers"
                   password = "GITHUB_TOKEN"
               }
           }
       }
       ...
   }
   ```
2. In your module-level `app/build.gradle`, add the following to the `android{}` closure:
   ```groovy
   compileOptions {
       sourceCompatibility JavaVersion.VERSION_1_8
       targetCompatibility JavaVersion.VERSION_1_8
   }
   ```
   ```kotlin
   compileOptions {
       sourceCompatibility =  JavaVersion.VERSION_1_8
       targetCompatibility = JavaVersion.VERSION_1_8
   }
   ```
3. Still in `app/build.gradle`, add the Incode library dependencies:
   ```groovy
   dependencies {
       ...

       // Google Play Core
       implementation 'com.google.android.play:core:1.10.3' // There might be a newer version available

       // Incode Welcome SDK
       api 'com.incode.sdk:welcome:5.55.0'
   }
   ```
   ```kotlin
   dependencies {
       ...

       // Google Play Core
       implementation("com.google.android.play:core:1.10.3") // There might be a newer version available

       // Incode Welcome SDK
       api("com.incode.sdk:welcome:5.55.0")
   }
   ```

### Enable SplitCompat in Your Application

If you have an `Application` class, make it extend `SplitCompatApplication`:

```kotlin
import com.google.android.play.core.splitcompat.SplitCompatApplication

class BaseApplication : SplitCompatApplication() {
    // ...
}
```
```java
import com.google.android.play.core.splitcompat.SplitCompatApplication;

public class BaseApplication extends SplitCompatApplication {
    // ...
}
```

If you don't have an `Application` class, add the following attribute to the `<application>` element in your `AndroidManifest.xml`:

```xml
<application
    android:name="com.google.android.play.core.splitcompat.SplitCompatApplication"
    ...
    >
```

### Create the Dynamic Module in Android Studio

1. In Android Studio, go to **File** > **New** > **New Module**.
2. Select **Dynamic Feature Module**.
3. Click **Next**.
4. Enter a **Module Name**. For example, `incode_core`.
5. Click **Next**.
6. Enter a **Module Title**. For example, `Incode Core`.
7. Set **Install-Time Inclusion** to _Do not include module at install-time (on-demand only)_.
8. Enable **Fusing**.
9. Click **Finish**.

### Review the Changes Android Studio Made

Wait for Android Studio to finish syncing, then review the following changes:

- A new module named `incode_core` has been added.
- In `app/build.gradle`, the following line has been added to the `android{}` closure:
  ```
  dynamicFeatures = [':incode_core']
  ```

* In `app/res/values/strings.xml`, the following string has been added:
  ```xml
  <string name="title_incode_core">Incode Core</string>
  ```

This is the user-friendly module name that could potentially be shown to the user.

### Add the Module Name String Resource

Open `app/res/values/strings.xml` and add the following string resource:

```xml
<string name="module_name_incode_core" translatable="false">incode_core</string>
```

You will use this string resource when referencing your Dynamic Module. Its value must match the **Module Name** you [configured previously](#create-the-dynamic-module-in-android-studio).

### Configure the Dynamic Module's build.gradle

1. Open `incode_core/build.gradle` and add the following to the `android{}` closure:
   ```groovy
   compileOptions {
       sourceCompatibility JavaVersion.VERSION_1_8
       targetCompatibility JavaVersion.VERSION_1_8
   }
   ```
   ```kotlin
   compileOptions {
       sourceCompatibility = JavaVersion.VERSION_1_8
       targetCompatibility = JavaVersion.VERSION_1_8
   }
   ```

2. Add dependencies as [described](/sdk-reference/android-installation/#declare-dependencies).

:::info
The `incode_core` module does not need to contain any other code.
:::

### Add NDK ABI Filters

In your module-level `[module]/build.gradle`, add the following NDK ABI filters to the `defaultConfig{}` closure:

```groovy build.gradle (Module)
ndk {
    abiFilters "arm64-v8a", "armeabi-v7a", "x86", "x86_64"
}
```
```kotlin build.gradle.kts (Module)
ndk {
    abiFilters.addAll(listOf("arm64-v8a", "armeabi-v7a", "x86", "x86_64"))
}
```

The Gradle configuration is now complete.

### Install the Module at Runtime

Before using the Incode Android SDK, make sure that the `Incode Core` Dynamic Module is installed. If it isn't, use the Google Play Core library to download and install it.

You can use this example code in an Activity:

```kotlin
    // ...
    private lateinit var splitInstallManager: SplitInstallManager
    private var splitInstallListener: SplitInstallStateUpdatedListener? = null
    // ...

    override fun onCreate(savedInstanceState: Bundle?) {
        // ...
        splitInstallManager = SplitInstallManagerFactory.create(this)
        checkIfInstalled()
        // ...
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        // ...
        when (requestCode) {
            REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD -> {
                if (resultCode == RESULT_OK) {
                    // User accepted; Dynamic Module will soon start installing
                } else {
                    // User denied the installation prompt; Dynamic Module will not be installed
                }
            }
        }
        // ...
    }

    private fun checkIfInstalled() {
        val moduleName = getString(R.string.module_name_incode_core)
            if (splitInstallManager.installedModules.contains(moduleName)) {
                onIncodeSdkInstalled()
            } else {
                // Starting download of dynamic feature module
                val request = SplitInstallRequest.newBuilder()
                    .addModule(moduleName)
                    .build()

                splitInstallListener?.let {
                    splitInstallManager.unregisterListener(it)
                }
                splitInstallListener = SplitInstallStateUpdatedListener { state ->
                when (state.status()) {
                    SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION -> {
                        /*
                          This may occur when attempting to download a sufficiently large module.
                          In order to see this, the application has to be uploaded to the Play Store.
                          Then features can be requested until the confirmation path is triggered.
                         */
                        try {
                            splitInstallManager.startConfirmationDialogForResult(
                                state,
                                this,
                                REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD
                            )
                        } catch (_: IntentSender.SendIntentException) {
                            finish()
                        }
                    }
                    SplitInstallSessionStatus.DOWNLOADING -> {
                        // You can use this method to update a progress indicator, for example:
                        // progressBar.max = state.totalBytesToDownload().toInt()
                        // progressBar.progress = state.bytesDownloaded().toInt()
                    }
                    SplitInstallSessionStatus.INSTALLING -> {
                        // Download complete; Installing...
                        // progressBar.progress = state.bytesDownloaded().toInt()
                    }
                    SplitInstallSessionStatus.INSTALLED -> {
                        splitInstallListener?.let {
                            splitInstallManager.unregisterListener(it)
                        }
                        onIncodeSdkInstalled()
                    }
                    SplitInstallSessionStatus.FAILED -> {
                        splitInstallListener?.let {
                            splitInstallManager.unregisterListener(it)
                        }
                        // Install failed
                    }
                    else -> {
                        Log.d(TAG, "Unhandled state ${state.status()}")
                    }
                }
            }.also {
                splitInstallManager.registerListener(it)
                splitInstallManager.startInstall(request)
            }
        }
    }

    private fun onIncodeSdkInstalled() {
        // Everything is ready; You can start the Incode SDK now
    }

    companion object {
        private const val REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD = 0x8A7 // Use your own value
    }
```
```java
    // ...
    private static final int REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD = 0x8A7; // Use your own value
    private SplitInstallManager splitInstallManager;
    private SplitInstallStateUpdatedListener splitInstallListener;
    // ...

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        // ...
        splitInstallManager = SplitInstallManagerFactory.create(this);
        checkIfIncodeSdkInstalled();
        // ...
    }

    private void onIncodeSdkInstalled() {
        // Everything is ready; You can start the Incode SDK now
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        // ...
        if (requestCode == REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD) {
            if (resultCode == RESULT_OK) {
                // User accepted; Dynamic Module will soon start installing
            } else {
                // User denied the installation prompt; Dynamic Module will not be installed
            }
        }
        // ...
    }

    private void checkIfIncodeSdkInstalled() {
        final String moduleName = getString(R.string.module_name_incode_core);
        if (splitInstallManager.getInstalledModules().contains(moduleName)) {
            // Dynamic feature module is already installed; Done!
            onIncodeSdkInstalled();
        } else {
            // Starting download of dynamic feature module
            SplitInstallRequest request = SplitInstallRequest.newBuilder()
                .addModule(moduleName)
                .build();

            if (splitInstallListener != null) {
                splitInstallManager.unregisterListener(splitInstallListener);
            }
            splitInstallListener = new SplitInstallStateUpdatedListener() {
                @Override
                public void onStateUpdate(@NonNull SplitInstallSessionState state) {
                    switch (state.status()) {
                        case SplitInstallSessionStatus.PENDING:
                            break;
                        case SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION:
                            /*
                              This may occur when attempting to download a sufficiently large module.
                              In order to see this, the application has to be uploaded to the Play Store.
                              Then features can be requested until the confirmation path is triggered.
                             */
                            try {
                                splitInstallManager.startConfirmationDialogForResult(state, MyActivity.this, REQUEST_CODE_CONFIRM_MODULE_DOWNLOAD);
                            } catch (IntentSender.SendIntentException e) {
                                finish();
                            }
                            break;
                        case SplitInstallSessionStatus.DOWNLOADING:
                            // You can use this method to update a progress indicator, for example:
                            //progressBar.setMax((int) state.totalBytesToDownload());
                            //progressBar.setProgress((int) state.bytesDownloaded());
                            break;
                        case SplitInstallSessionStatus.INSTALLING:
                            // Download complete; Installing...
                            //progressBar.setProgress((int) state.bytesDownloaded());
                            break;
                        case SplitInstallSessionStatus.INSTALLED:
                            if (splitInstallListener != null) {
                                splitInstallManager.unregisterListener(splitInstallListener);
                            }
                            // Done!
                            onIncodeSdkInstalled();
                            break;
                        case SplitInstallSessionStatus.FAILED:
                            if (splitInstallListener != null) {
                                splitInstallManager.unregisterListener(splitInstallListener);
                            }
                            // Install failed
                            break;
                        default:
                            Log.w(TAG, "Unhandled state:%s", state.status());
                            break;
                    }
                }
            };
            splitInstallManager.registerListener(splitInstallListener);
            splitInstallManager.startInstall(request);
        }
    }
```

### Test Your Implementation

<Callout icon="🚧" theme="warn">
  ### Warning

  If you run your application from Android Studio, the Dynamic Module is installed together with the app, and the code for downloading and installing the module never executes.
</Callout>

To test downloading and installing the Dynamic Module, upload your App Bundle to Google Play. Google Play requires the Android App Bundle format to handle on-demand requests.

Publishing the project on the Play Console requires graphic assets. For testing, you can use the sample assets from the [Google Codelab](https://github.com/googlecodelabs/android-dynamic-features/tree/master/graphic_assets) on Dynamic Features.

To test quickly without waiting for approval, publish in the Internal Testing track.

For a step-by-step guide, follow the [Play Console Guide on how to upload an app](https://support.google.com/googleplay/android-developer/answer/9859152).

***

## Support Both Google Mobile Services and Huawei Mobile Services

You can support both GMS and HMS using `build flavors` and separate classes for downloading Dynamic Modules, one for each service.

***

## Helpful Links

- [Google Dynamic Delivery](https://developer.android.com/codelabs/on-demand-dynamic-delivery)
- [Huawei Dynamic Ability](https://developer.huawei.com/consumer/en/training/course/video/C101641376082448202)

***

See [API Reference](/sdk-reference/android-api-reference/) for full KDoc/Javadoc, or contact Incode support if you run into integration issues.

---

- Path: `sdk-reference/android-aes-advanced-electronic-signature`
- URL: https://developer.incode.com/sdk-reference/android-aes-advanced-electronic-signature/
- Markdown: https://developer.incode.com/sdk-reference/android-aes-advanced-electronic-signature.md

# AES (Advanced Electronic Signature)

The AES (Advanced Electronic Signature) module shows the user documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant.

For an overview of this module and how it works, see [Advanced Electronic Signature](/features-and-modules/advanced-electronic-signature/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add AES

1. Add the [ID Scan](/sdk-reference/android-id-scan/), [Selfie Scan](/sdk-reference/android-selfie-scan/), and [Phone](/sdk-reference/android-phone/) modules before AES. They can be added in any order, but all three must be present in the flow. Calling `addAES` without these prerequisites throws `ModuleConfigurationException`.
2. Add the module with `addAES()` (default config) or `addAES(aes)` (custom config):

   ```kotlin
   flowConfigBuilder.addAES()
   // or with a configured instance:
   flowConfigBuilder.addAES(aes)
   ```
   ```java
   flowConfigBuilder.addAES();
   // or with a configured instance:
   flowConfigBuilder.addAES(aes);
   ```

### Example

The example below builds a custom `AES` configuration that shows the upload screen and downloads the signed PDF, adds the required ID Scan, Selfie Scan, and Phone modules ahead of it, and listens for the result through `onAESCompleted()`.

```kotlin
val aes = AES.Builder()
    .setUploadDocument(true)
    .setDownloadDocument(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addPhone()
    .addAES(aes)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onAESCompleted(aesResult: AESResult) {
        // AES step finished. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
AES aes = new AES.Builder()
    .setUploadDocument(true)
    .setDownloadDocument(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addPhone()
    .addAES(aes)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onAESCompleted(@NonNull AESResult aesResult) {
        // AES step finished. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `AES.Builder`.

| Setting                        | Description                                                                                                                        |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `setUploadDocument(Boolean)`   | If `true`, shows the AES upload screen before the normal AES screens. Defaults to `false`.                                         |
| `setDownloadDocument(Boolean)` | If `true`, downloads signed PDFs and shows the Confirmed Signature Details screen at the end of the AES flow. Defaults to `false`. |

For the complete option set, see `AES.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

AES delivers an `AESResult` to the `onAESCompleted(AESResult)` callback on the `OnboardingListener`. Key fields include:

- `documentSigning`: `true` if the document was signed using an advanced electronic signature.
- `resourcesNotFound`: `true` if the required signing resources could not be found.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `ResultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the step fails, the error surfaces through `OnboardingListener.onError(Throwable)`.

For all fields, see `AESResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-antifraud`
- URL: https://developer.incode.com/sdk-reference/android-antifraud/
- Markdown: https://developer.incode.com/sdk-reference/android-antifraud.md

# Antifraud

The Antifraud Check module compares the current Session against prior Sessions and known identities to detect signs of fraud.

For an overview of this module and how it works, see [Antifraud Check](/features-and-modules/antifraud-check/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Antifraud

Add the module with `addAntifraud()`. Add Antifraud as the last module in your flow. The one exception is when you also use the [Custom Watchlist](/sdk-reference/android-custom-watchlist/) module. In that case, call `addAntifraud()` first, then `addCustomWatchlist()`.

```kotlin
flowConfigBuilder.addAntifraud()
```
```java
flowConfigBuilder.addAntifraud();
```

### Example

The example below adds Antifraud as the only step in the flow and listens for the result through `onAntifraudCompleted()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addAntifraud()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onAntifraudCompleted(antifraudResult: AntifraudResult) {
        // Antifraud step completed. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addAntifraud()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onAntifraudCompleted(@NonNull AntifraudResult antifraudResult) {
        // Antifraud step completed. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Antifraud has no configurable settings. It is constructed with a no-argument constructor, and `addAntifraud()` adds it for you.

## Result

Antifraud delivers an `AntifraudResult` to the `onAntifraudCompleted(AntifraudResult)` callback on the `OnboardingListener`. Key fields include:

- `result`: `true` when the antifraud check passed.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `AntifraudResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-api-key-rotation`
- URL: https://developer.incode.com/sdk-reference/android-api-key-rotation/
- Markdown: https://developer.incode.com/sdk-reference/android-api-key-rotation.md

# API Key Rotation

API keys used to initialize the SDK can be rotated at any time for security reasons. This page shows how to detect a revoked key during an onboarding session and reinitialize the SDK with the replacement key so the user can continue.

You can revoke keys and generate new ones from [Dashboard](/dashboard-platform-administration/configuration-api-keys-tab). The SDK does not rotate keys itself; it reacts to a key being revoked.

***

## Rotate Keys

When an API key is revoked from Dashboard, every onboarding session using that key is aborted. The SDK reports the revocation through your error callback:

`onError(Throwable)` on `IncodeWelcome.OnboardingListener()`

That callback is where you detect the revocation and replace the key. The rotation flow has three steps, explained below. Complete them in order.

### Detect the Revoked Key

In your error handler, check for the rotation error type. The error is an `ApiKeyRotationException`.

```kotlin Android - Kotlin
override fun onError(error: Throwable) {
    if (error is ApiKeyRotationException) {
        // Your logic for the rotation of the key
    }
}
```
```java Android - Java
@Override
public void onError(@NonNull Throwable error) {
    if (error instanceof ApiKeyRotationException) {
        // Your logic for the rotation of the key
    }
}
```


### Reinitialize with the New Key

When you have a new API key, reinitialize the SDK with it. Pass the new key in place of the original and apply any optional configuration exactly as you did on first initialization.

```kotlin Android - Kotlin
IncodeWelcome.Builder(application, apiUrl, apiKeyRotatedIn)
    ... // optional configuration
    .build()

// SDK has been reinitialized successfully
```
```java Android - Java
new IncodeWelcome.Builder(getApplication(), apiUrl, apiKeyRotatedIn)
    ... // optional configuration
    .build();

// SDK has been reinitialized successfully
```
```swift iOS - Swift
IncdOnboardingManager.shared.initIncdOnboarding(url: url, apiKey: newApiKey) { (success, _) in
    // SDK has been reinitialized successfully
}
```

### Resume or Restart Onboarding

After the SDK reinitializes, you can resume the old session or start a new onboarding session.

***

For help, see [API Reference](/sdk-reference/android-api-reference) or contact Incode support.

---

- Path: `sdk-reference/android-api-reference`
- URL: https://developer.incode.com/sdk-reference/android-api-reference/
- Markdown: https://developer.incode.com/sdk-reference/android-api-reference.md

# API Reference

The API Reference is the generated Javadoc and KDoc for the Incode Android SDK. It is the authoritative source for the `IncodeWelcome` SDK: classes, methods, parameters, return types, and result models.

## Current API Reference

See the [API Javadoc](https://incode-technologies-example-repos.github.io/Incode-Welcome-Android-example/) for the full `IncodeWelcome` SDK specification. Use the API Reference for exact method signatures, parameter types, and result-model fields. For step-by-step setup and flow guidance, see [Getting Started](/sdk-reference/android-getting-started/). For anything not covered in the API Javadoc or this documentation, contact your customer success manager or Incode support.

## Older Versions

Find older versions of the API Javadoc on [GitHub](https://github.com/Incode-Technologies-Example-Repos/Incode-Welcome-Android-example/tree/master/docs). Browse the version tags to locate a specific release. Contact your customer success manager for access to older versions.

---

- Path: `sdk-reference/android-approval`
- URL: https://developer.incode.com/sdk-reference/android-approval/
- Markdown: https://developer.incode.com/sdk-reference/android-approval.md

# Approval

The Approval module finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. By default, it runs with no UI and approves silently, but you can toggle the UI, silent face match, and forced approval.

In Dashboard, Approval isn't a module. It's a flow setting you enable when building the flow. The SDK receives no callback when Approval executes at flow end. If you need that notification, [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) won't work. Use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step) instead, adding the module to a `FlowConfig` in code as shown on this page.

Approval is not available in [Capture-Only mode](/sdk-reference/android-capture-only-sdk/); adding it there throws `ModuleNotAvailableException`.

## Add Approval

1. Add Approval after the capture and verification modules it depends on, such as [Selfie Scan](/sdk-reference/android-selfie-scan/), [ID Scan](/sdk-reference/android-id-scan/) (or [QR Scan](/sdk-reference/android-qr-scan/)), and [Face Match](/sdk-reference/android-face-match/). Because the decision reflects the user's overall score across those steps, Approval should be one of the last modules in the flow.
2. Add the module with one of the `addApproval` overloads:

   ```kotlin
   // Default configuration: no UI, no silent face match, scores enforced
   flowConfigBuilder.addApproval()

   // Toggle UI and silent face match
   flowConfigBuilder.addApproval(showUi, silentFaceMatch)

   // Also control whether approval is forced regardless of score
   flowConfigBuilder.addApproval(showUi, silentFaceMatch, forceApproval)
   ```
   ```java
   // Default configuration: no UI, no silent face match, scores enforced
   flowConfigBuilder.addApproval();

   // Toggle UI and silent face match
   flowConfigBuilder.addApproval(showUi, silentFaceMatch);

   // Also control whether approval is forced regardless of score
   flowConfigBuilder.addApproval(showUi, silentFaceMatch, forceApproval);
   ```

### Example

The example below adds the capture and verification steps Approval depends on, then adds Approval in its default configuration and listens for the result through `onApproveCompleted()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addFaceMatch()
    .addApproval()
    .build()

val onboardingListener = object : IncodeWelcome.OnboardingListener() {
    override fun onApproveCompleted(approveResult: ApproveResult) {
        // User approval completed
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }
}

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addFaceMatch()
    .addApproval()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onApproveCompleted(@NonNull ApproveResult approveResult) {
        // User approval completed
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }
};

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
);
```

## Configuration Options

Approval has no `Builder`. Configure it through the parameters of the `addApproval` overloads.

| Setting           | Description                                                                                                                          |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `showUi`          | Shows the Approval module UI. Defaults to `false`, so approval runs silently.                                                        |
| `silentFaceMatch` | Performs face processing inside the Approval module. Do not use this together with the Face Match module, or an exception is thrown. |
| `forceApproval`   | If `true`, the user is approved with any score. If `false`, only users with an overall score above the threshold are approved.       |

The approval decision and the score thresholds this module enforces also depend on your Flow or Workflow configuration, not just these parameters.

For the complete option set, see `Approval` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Approval delivers an `ApproveResult` to the `onApproveCompleted(approveResult)` callback on `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if the approval was successful; otherwise, `false`.
- `uuid`: The Session UUID associated with this approval; `null` when unavailable.
- `token`: The Session token associated with this approval; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the approval step fails, the error surfaces through `OnboardingListener.onError(Throwable)` and the onboarding flow is aborted. Approval does not define its own exception subtype.

For all fields, see `ApproveResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-captcha`
- URL: https://developer.incode.com/sdk-reference/android-captcha/
- Markdown: https://developer.incode.com/sdk-reference/android-captcha.md

# Captcha

The Captcha module presents a CAPTCHA challenge during onboarding to verify human interaction and reduce automated abuse. It then returns the user's response to your app.<br /><br />In Dashboard, Captcha isn't a standalone module. Instead, enable "OTP configuration" in the module settings when adding the Email or Phone module. How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Captcha

Add the module with `addCaptcha()`.

```kotlin
flowConfigBuilder.addCaptcha()
```
```java
flowConfigBuilder.addCaptcha();
```

### Example

The example below adds Captcha as the only step in the flow and listens for the result through `onCaptchaCollected()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addCaptcha()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onCaptchaCollected(captchaResult: CaptchaResult) {
        // CAPTCHA step completed. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addCaptcha()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onCaptchaCollected(@NonNull CaptchaResult captchaResult) {
        // CAPTCHA step completed. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Captcha has no configurable options. It is added with `addCaptcha()` and has no `Builder`. For the class reference, see `Captcha` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Captcha delivers a `CaptchaResult` to the `onCaptchaCollected(CaptchaResult)` callback on the `OnboardingListener`. This callback is declared by `CaptchaListener`. Key fields include:

- `captchaResponse`: The CAPTCHA response string. Can be `null` when `resultCode` is not `SUCCESS`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`. Captcha does not define a module-specific exception subtype. Failures are reported with the generic `Throwable` carried in `CaptchaResult.error`. This same `Throwable` is also available on the shared `onError` path.

For all fields, see `CaptchaResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-capture-only-integration`
- URL: https://developer.incode.com/sdk-reference/android-capture-only-integration/
- Markdown: https://developer.incode.com/sdk-reference/android-capture-only-integration.md

# Capture-Only End-to-End Integration

[Deepsight](/features-and-modules/deepsight/) is Incode's liveness technology. During capture, the device collects extra signals: depth data, a short selfie video, and motion data. The back end uses these signals to find spoofing attempts.

This page shows how to use Deepsight with Capture-Only Mode. In Capture-Only Mode, the Android SDK captures the images and signals but does not send them to Incode; your integration sends them with the Omni API. Use this mode when your app needs to control when and how captures are sent to your own back end. This page gives the SDK configuration, the order of the API calls, and a sample request for each call, for two flows:

- **[Basic flow](#basic-flow)**: An ID Capture module and a Selfie module. The user scans an ID and takes a selfie with Deepsight.
- **[Video Selfie Flow](#video-selfie-flow)**: The basic flow plus a Video Selfie module. The user records a video that can hold a second ID scan, a selfie, and voice consent. The back end compares this recording with earlier captures.

You can also [run these flows without Deepsight](#flows-without-deepsight).

## Before You Start

You need these four items:

- An SDK integrated in `SdkMode.CAPTURE_ONLY`. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/).
- Android SDK 5.54.0 or later. Earlier versions do not have the Deepsight configuration API. Versions 5.50.0 to 5.53.x have it, but `SelfieScanResult.presignedVideoFilePath` can reference a file that does not exist, which stops `omni/recordings/import`.
- An [API key](/get-started-with-incode/getting-credentials/) for your environment.
- A Dashboard flow (`configurationId`) with:
    - Deepsight turned on in the [Flow](/dashboard-platform-administration/flows-1/#flow-settings) or [Workflow](/dashboard-platform-administration/workflows-20/#workflow-settings) Settings tab.
    - The Deepsight settings of the [Face Capture](/dashboard-platform-administration/face-capture-dashboard/#configuration-options) module set to match the SDK `modality`.
    - Face Capture and [ID Capture](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) modules with Motion set to match the SDK `motion`.


:::warning
Set the Deepsight and Motion options in the SDK to the same values as the flow configuration in Dashboard. The two control different things: Dashboard tells the back end which signals to expect, and the SDK configuration decides which signals the device collects. If they differ, the back end rejects the call with `Invalid capture metadata`. The next section gives the two settings.
:::

The examples use `WELCOME_API_URL` and `WELCOME_API_KEY`, the same names as the [installation](/sdk-reference/android-installation/) examples. Replace them with the API URL and the API key of your environment.

:::warning
Make these calls from your back end. The API key gives full access to your environment. Do not put the API key in the app, and do not call the Omni API from the device. The app sends the captures to your back end, and your back end makes the calls on this page.
:::

Every call to `WELCOME_API_URL` after `omni/start` needs these headers. An upload to a pre-signed URL does not use them.

| Header | Value |
| --- | --- |
| `x-api-key` | `WELCOME_API_KEY`, the API key of your environment. |
| `api-version` | `1.0` |
| `X-Incode-Hardware-Id` | The `token` value that `omni/start` returned. |
| `Content-Type` | `application/json`, with two exceptions. Step 15 of the Video Selfie flow sends the audio file with `audio/mp4`. The part upload of the [alternative upload route](#alternative-upload-the-video-selfie-in-parts) sends each chunk with `application/octet-stream`. |

## SDK Configuration for Deepsight

Deepsight needs two changes in the SDK code, one for the ID scan and one for the selfie scan.

### ID Scan

`IdScan.Builder.setMotionEnabled(Boolean)` is available since Android SDK 5.50.0. It writes the motion flag into the capture metadata. The default value is `false`.

Set the same value as the Motion option of the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module in Dashboard. If the two differ, the back end rejects `omni/add/front-id/v2` with `Invalid capture metadata`.


```kotlin
val idScan = IdScan.Builder()
    .setIdType(IdScan.IdType.ID)
    .setMotionEnabled(true)
    .build()
```

```java
IdScan idScan = new IdScan.Builder()
    .setIdType(IdScan.IdType.ID)
    .setMotionEnabled(true)
    .build();
```

### Selfie Scan

`SelfieScan.Builder.setDeepsightConfiguration(DeepsightConfiguration)` is available since Android SDK 5.50.0. It replaces `setVideoLivenessRecordingEnabled(Boolean)`, which is deprecated. See the [Migration Guide](/release-notes/migration-guide/#1-replace-setvideolivenessrecordingenabled-with-setdeepsightconfiguration).

The configuration has three independent fields:

| Field | Default | Description |
| --- | --- | --- |
| `setEnabled(Boolean)` | `true` | Turns Deepsight liveness on or off. When `false`, the SDK ignores the modality. |
| `setModality(Modality)` | `SINGLE_FRAME` | The capture mode. The SDK applies it only when `enabled` is `true`. |
| `setMotionEnabled(Boolean)` | `false` | Turns motion collection on or off. This field is independent of the other two. |

The three modality values are:

| Modality | Depth data | Video recording |
| --- | --- | --- |
| `SINGLE_FRAME` | No | No |
| `MULTIMODAL` | Yes | No |
| `VIDEO_LIVENESS` | Yes | Yes |

```kotlin
val selfieScan = SelfieScan.Builder()
    .setDeepsightConfiguration(
        DeepsightConfiguration.Builder()
            .setEnabled(true)
            .setModality(DeepsightConfiguration.Modality.VIDEO_LIVENESS)
            .setMotionEnabled(true)
            .build()
    )
    .build()
```

```java
SelfieScan selfieScan = new SelfieScan.Builder()
    .setDeepsightConfiguration(
        new DeepsightConfiguration.Builder()
            .setEnabled(true)
            .setModality(DeepsightConfiguration.Modality.VIDEO_LIVENESS)
            .setMotionEnabled(true)
            .build()
    )
    .build();
```

:::info

  The SDK applies `setDeepsightConfiguration()` and `IdScan.Builder.setMotionEnabled()` in `SdkMode.CAPTURE_ONLY` only. In other modes, the server configuration has priority and the SDK writes a warning to the log.
:::

### Result Fields

Read these fields from the capture results and send them to the API:

| Callback | Result | Field | Send it to |
| --- | --- | --- | --- |
| `onIdFrontCompleted()` | `IdScanResult` | `idImageBase64`, `metadata` | `omni/add/front-id/v2` |
| `onIdBackCompleted()` | `IdScanResult` | `idImageBase64`, `metadata` | `omni/add/back-id/v2` |
| `onSelfieScanCompleted()` | `SelfieScanResult` | `fullFrameSelfieBase64`, `metadata` | `omni/add/face/third-party` |
| `onSelfieScanCompleted()` | `SelfieScanResult` | `presignedVideoFilePath` | `omni/recordings/import` |
| `onVideoRecorded()` | `VideoSelfieResult` | `videoFilePath` | The URL from `omni/generateVideoSelfieUrl` |
| `onVideoRecorded()` | `VideoSelfieResult` | `idFrontImagePath` | `omni/videoselfie/compare-id/v2`, `omni/videoselfie/compare-ocr/v2` |
| `onVideoRecorded()` | `VideoSelfieResult` | `idBackImagePath` | `omni/videoselfie/compare-back-id/v2`, `omni/videoselfie/compare-back-ocr/v2` |

:::info
The SDK populates `metadata` in `SdkMode.CAPTURE_ONLY` only. In every other mode the field is `null`.

The SDK populates `videoFilePath` and `presignedVideoFilePath` on `SelfieScanResult` in `SdkMode.CAPTURE_ONLY`, and only when the modality is `VIDEO_LIVENESS`. In every other case both fields are `null`. Send `presignedVideoFilePath`, and keep `SelfieScanResult.videoFilePath` for local diagnosis only.
:::

Every asset field of `VideoSelfieResult` is a file path. The result has no base64 field. Read each file, then encode the image files as base64 for the JSON requests. Send the audio file and the video recording as binary.

## Basic Flow

Use this flow for Deepsight with an ID scan and a selfie scan.

Call the endpoints in this order. A tag shows which capture module a step belongs to. Make a tagged step only when that module is in the flow. A step with no tag always applies.

1. `POST /omni/start`
2. `POST /omni/add/device-fingerprint`
3. **ID scan, front side**: `POST /omni/add/front-id/v2?onlyFront=false`

4. **ID scan, back side**: `POST /omni/add/back-id/v2` 
5. **ID scan**: `POST /omni/process/id` 
6. **Selfie with Deepsight video**: `POST /omni/recordings/import` 
7. **Selfie Scan**: `POST /omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID` 
8. **Selfie Scan**: `POST /omni/process/face?imageType=selfie` 
9. `POST /omni/finish-status`

:::warning

  The `onlyFront` query parameter of step 3 tells the back end whether a back image follows.

  - To scan both sides, use `IdScan.Builder.setScanStep(ScanStep.BOTH)`, send `onlyFront=false`, and make step 4.
  - To scan the front only, use `setScanStep(ScanStep.FRONT)`, send `onlyFront=true`, and omit step 4.

  `ScanStep.BOTH` is the default.
:::

:::info
Send the device fingerprint with `omni/add/device-fingerprint` directly after `omni/start`, before any capture. The SDK does the same in `SdkMode.STANDARD`: it sends the device fingerprint as part of the session setup, before the first module starts. Send it once for each session.
:::

### Which Steps Apply

Each tagged step needs its module in the flow and its data in the result.

| Steps | Make them when | Flow configuration | Result field |
| --- | --- | --- | --- |
| 3 | the flow scans the front of a document | `FlowConfig.Builder.addID(...)` | `IdScanResult.idImageBase64` from `onIdFrontCompleted()` |
| 4 | the flow scans the back of a document | `addID(...)` with `IdScan.Builder.setScanStep(ScanStep.BOTH)`, the default | `IdScanResult.idImageBase64` from `onIdBackCompleted()` |
| 5 | the flow scans a document | `addID(...)` | none, this call carries no image |
| 6 | the selfie records a video for deepsight | `setDeepsightConfiguration(...)` with `Modality.VIDEO_LIVENESS` | `SelfieScanResult.presignedVideoFilePath` |
| 7, 8 | the flow takes a selfie | `FlowConfig.Builder.addSelfieScan(...)` | `SelfieScanResult.fullFrameSelfieBase64` |

If a module is not in the flow, its callback never fires and its result field is never set. If a module is in the flow and its field is `null`, the capture did not complete. Record the fault, as described for the [Video Selfie Flow](#video-selfie-flow).

### Start the Session

`omni/start` creates the interview. The response gives the `token` value for the `X-Incode-Hardware-Id` header of every later call.

```bash
curl --location 'WELCOME_API_URL/omni/start' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--data '{
    "configurationId": "YOUR_FLOW_ID"
}'
```

### Add the Device Fingerprint

Deepsight needs the device fingerprint. Read it from the SDK with `IncodeWelcome.getInstance().getDeviceFingerprint().toJson()`. This method returns the exact JSON body for the call. Send it without changes.

```kotlin
val fingerprintJson = IncodeWelcome.getInstance().getDeviceFingerprint().toJson()
```

```java
String fingerprintJson = IncodeWelcome.getInstance().getDeviceFingerprint().toJson();
```

```bash
curl --location 'WELCOME_API_URL/omni/add/device-fingerprint' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data "$FINGERPRINT_JSON"
```

The body has this shape. The values change with the device and the SDK version, so do not copy them.

```json
{
    "sdkVersion": "5.50.0",
    "hash": "1234",
    "ip": "10.11.11.11",
    "osVersion": "31",
    "deviceModel": "MAO-LX9",
    "data": "{\"crossApp\":true,\"totalRam\":8018219008,\"availableRam\":4677599232}",
    "deviceType": "ANDROID",
    "algorithmName": "androidId",
    "algorithmVersion": "1.0.0"
}
```

### Add the Front of the ID

Send `idImageBase64` and `metadata` from the `IdScanResult` that `onIdFrontCompleted` returns.

```bash
curl --location 'WELCOME_API_URL/omni/add/front-id/v2?onlyFront=false' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.idImageBase64",
    "metadata": "result.metadata"
}'
```

### Add the Back of the ID

Send `idImageBase64` and `metadata` from the `IdScanResult` that `onIdBackCompleted` returns.

```bash
curl --location 'WELCOME_API_URL/omni/add/back-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.idImageBase64",
    "metadata": "result.metadata"
}'
```

### Process the ID

```bash
curl --location 'WELCOME_API_URL/omni/process/id' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

### Send the Deepsight Video

`SelfieScanResult.presignedVideoFilePath` is a file path, not the video itself. Read that file as plain text. Then send the text in the `video` field without a change. The contents are already base64. Do not encode them again.

If `presignedVideoFilePath` is `null`, there is no recording to send. Omit this step, and send the selfie without a `recordingId`.

With the `VIDEO_LIVENESS` modality this field must hold a path. A `null` value means the recording failed, and the session gets no video liveness check. Record the fault.

```bash
curl --location 'WELCOME_API_URL/omni/recordings/import' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "type": "selfie",
    "video": "CONTENTS_OF_PRESIGNED_VIDEO_FILE"
}'
```

The response gives a `recordingId`. Keep this value for the next call.

### Send the Selfie Scan Image

Send `fullFrameSelfieBase64` and `metadata` from the `SelfieScanResult` that `onSelfieScanCompleted` returns. Add the `recordingId` from the previous step as a query parameter.

```bash
curl --location 'WELCOME_API_URL/omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.fullFrameSelfieBase64",
    "metadata": "result.metadata"
}'
```

### Process the Selfie Scan Image

This call runs the face checks on the selfie from step 7. The request body is empty.

```bash
curl --location 'WELCOME_API_URL/omni/process/face?imageType=selfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

### Finish the Session

This call closes the session. Make it after all the capture and process calls. The request body is empty.

```bash
curl --location 'WELCOME_API_URL/omni/finish-status' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

## Video Selfie Flow

Use this flow for Deepsight with an ID scan, a selfie scan, and a Video Selfie.

Call the endpoints in this order. A tag shows which capture module a step belongs to. Make a tagged step only when that module is in the flow. A step with no tag always applies.

1. `POST /omni/start`
2. `POST /omni/add/device-fingerprint`
3. **ID scan, front side**: `POST /omni/add/front-id/v2?onlyFront=false` 
4. **ID scan, back side**: `POST /omni/add/back-id/v2` 
5. **ID scan**: `POST /omni/process/id` 
6. **Selfie Scan with Deepsight video**: `POST /omni/recordings/import` 
7. **Selfie Scan**: `POST /omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID` 
8. **Selfie Scan**: `POST /omni/process/face?imageType=selfie` 
9. **Video Selfie, front document**: `POST /omni/videoselfie/compare-id/v2` 
10. **Video Selfie, front document**: `POST /omni/videoselfie/compare-ocr/v2` 
11. **Video Selfie, back document**: `POST /omni/videoselfie/compare-back-id/v2` 
12. **Video Selfie, back document**: `POST /omni/videoselfie/compare-back-ocr/v2` 
13. **Video Selfie, image**: `POST /omni/add/face/third-party?imageType=videoSelfie` 
14. **Video Selfie, image**: `POST /omni/process/face?imageType=videoSelfie` 
15. **Video Selfie, speech check**: `POST /omni/add/speech?audioOnly=true` 
16. **Video Selfie, consent face check**: `POST /omni/videoselfie/voiceconsent/add/face` 
17. `GET /omni/generateVideoSelfieUrl`
18. `PUT` the Video Selfie recording to the returned URL
19. `POST /omni/finish-status`

The questions and the consent phrase come from a call you make before the module starts. It is not part of this sequence. See [Get the Questions and the Consent Phrase](#get-the-questions-and-the-consent-phrase).

:::warning
Voice consent for the record needs no API call. Steps 15 and 16 ask the back end to check the consent. They are not what records it. The Video Selfie recording already holds the audio and the video of the user who speaks the phrase, and steps 17 and 18 send that recording.

  If you collect the consent as a record only, omit steps 15 and 16. Omit them even when `setVoiceConsentEnabled(true)` is set. Make step 15 to check the words the user said. Make step 16 to match the face of the user during the consent.
:::

Steps 1 to 8 and step 19 are the same as the [Basic Flow](#basic-flow).

### Which Steps Apply

Each tagged step needs its Video Selfie step to have run and put its data in the result. Steps 17 and 18 carry no tag because the Video Selfie always records.

| Steps | Make them when | Builder option | Default | Result field |
| --- | --- | --- | --- | --- |
| 9, 10 | the Video Selfie scans the front of the document | `setIdScanEnabled(true)` | on | `idFrontImagePath` |
| 11, 12 | the Video Selfie scans the back of the document | `setIdScanEnabled(true)` | on | `idBackImagePath` |
| 13, 14 | the Video Selfie takes a selfie | `setSelfieScanEnabled(true)` | on | `selfieImagePath` |
| 15 | the recording has audio **and** you want the back end to check what the user said | `setVoiceConsentEnabled(true)` or `setRandomQuestionsEnabled(true)` | off | `audioFilePath` |
| 16 | the consent has a face frame **and** you want the back end to match that face | `setVoiceConsentFaceRecognitionEnabled(true)`, `setVoiceConsentEnabled(true)`, and `setSelfieScanEnabled(true)`. All three are necessary. | off | `voiceConsentSelfiePath` |

`setDisableAudio(true)` stops the recording of audio. The default is `false`. With audio off, `audioFilePath` and `voiceConsentSelfiePath` are `null` and you omit steps 15 and 16.

The four comparison options (`setFrontIdComparisonEnabled`, `setFrontIdOcrComparisonEnabled`, `setBackIdComparisonEnabled`, and `setBackIdOcrComparisonEnabled`) have no effect in `SdkMode.CAPTURE_ONLY`. The SDK makes no comparison calls in this mode. Your back end decides which comparisons to make when it makes or omits steps 9 to 12.

:::info
A `null` field is not always a skipped step. Your configuration decides which calls to make. The result field tells you what to send.

  If you did not enable a step, its field is `null` and you omit its calls. That is the normal case.

  If you did enable a step and its field is `null`, the capture did not complete. Do not treat this as a skipped step. Record the fault and examine it. The session continues without that check, and no error tells you so.
:::



### Get the Questions and the Consent Phrase

Make this call only if you want the back end to check the words the user said.

Make it before the Video Selfie module starts. It returns the question and answer pairs of your API key. Give that text to the SDK with `setRandomQuestions(...)` and the voice consent options, so the user reads the same text that the back end scores in step 15. If the text on screen is not the same text, the check fails for a user who said the phrase correctly.

In `SdkMode.CAPTURE_ONLY` the SDK does not make this call. It shows only the text you give it. In `SdkMode.STANDARD` the SDK makes the call itself at the start of the step and shows what it returns.

```bash
curl --location 'WELCOME_API_URL/omni/get/questionAndAnswer?numberOfQuestions=1&returnVoiceConsentQuestion=true' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

The response gives a list of questions. The entry with `id` `0` is the consent phrase.

### Steps 9 to 12: Compare the Documents

The comparison calls use the ID frames that the Video Selfie module captured, not the frames from steps 3 and 4. Read the file at `VideoSelfieResult.idFrontImagePath` or `VideoSelfieResult.idBackImagePath`. Then encode the bytes as base64 with no line breaks.

| Step | Endpoint | Image |
| --- | --- | --- |
| 9 | `omni/videoselfie/compare-id/v2` | `idFrontImagePath` |
| 10 | `omni/videoselfie/compare-ocr/v2` | `idFrontImagePath` |
| 11 | `omni/videoselfie/compare-back-id/v2` | `idBackImagePath` |
| 12 | `omni/videoselfie/compare-back-ocr/v2` | `idBackImagePath` |

Send each pair of calls only when the matching frame is in the result:

- If `idFrontImagePath` is set, make steps 9 and 10.
- If `idBackImagePath` is set, make steps 11 and 12.
- If a field is `null`, omit the two steps for that side. If the Video Selfie scanned that side, a `null` value means the capture failed.

This is the same rule the SDK applies in the STANDARD mode. There, the SDK gives the Video Selfie one scan step for each side of the document, then compares each side as it captures it.

`VideoSelfie.Builder.setIdScanEnabled(true)` gives the Video Selfie a front step and a back step, so a two-sided document sets both fields and all four steps apply. In `SdkMode.CAPTURE_ONLY` the comparison options do not remove any of these steps. To omit a comparison, do not make its call.

:::info
The result gives paths, not images. `VideoSelfieResult` has no base64 fields. Your app must read each file and encode it.
:::

### Step 9: Compare the ID

This call makes sure that the document in the Video Selfie is the same type as the document from step 3.

```bash
curl --location 'WELCOME_API_URL/omni/videoselfie/compare-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_ID_FRONT_IMAGE_PATH"
}'
```

Response (`200`):

```json
{
    "typeOfId": "DriversLicense",
    "idTypeMatched": true,
    "issueYear": 2017,
    "faceRecognitionConfidence": 1.0,
    "idSideMatched": true
}
```

Response (`400`):

```json
{
    "timestamp": 1775238442064,
    "status": 4020,
    "error": "Image to compare not found.",
    "message": "BadRequestException: Unable to compare images - template not found",
    "path": "/omni/videoselfie/compare-id/v2"
}
```

| Error code | Meaning |
| --- | --- |
| `1003` | Face cropping failure. |
| `4019` | Face not found. |
| `4020` | Image to compare not found. |
| `5003` | Unsatisfied image size. |
| `5004` | Document alignment failed. |
| `5005` | Document not found. |

### Step 10: Compare the OCR Data

This call makes sure that the data on the document in the Video Selfie is the same as the data from step 3.

```bash
curl --location 'WELCOME_API_URL/omni/videoselfie/compare-ocr/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_ID_FRONT_IMAGE_PATH"
}'
```

Response (`200`):

```json
{
    "success": true
}
```

A `400` response has the same shape as step 9. The error codes are `5003`, `5004`, and `5005`.

### Steps 11 and 12: Compare the Back of the Document

These two calls are the back-side counterparts of steps 9 and 10. Send the base64 of the file at `VideoSelfieResult.idBackImagePath`.

```bash
curl --location 'WELCOME_API_URL/omni/videoselfie/compare-back-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_ID_BACK_IMAGE_PATH"
}'
```

```bash
curl --location 'WELCOME_API_URL/omni/videoselfie/compare-back-ocr/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_ID_BACK_IMAGE_PATH"
}'
```

The responses have the same shape as steps 9 and 10.

### Steps 13 and 14: Send the Video Selfie Image

These two calls are optional. Make them when the Video Selfie takes a selfie, so when `selfieImagePath` is set.

Steps 13 and 14 use the same two endpoints as steps 7 and 8, but they send a different image. Step 7 sends the image from the Selfie Scan module. Step 13 sends the image that the Video Selfie module captured during the video. The `imageType` query parameter tells the back end which image it receives.

| Steps | Module | Image | `imageType` |
| --- | --- | --- | --- |
| 7, 8 | Selfie Scan | `SelfieScanResult.fullFrameSelfieBase64` | `selfie` |
| 13, 14 | Video Selfie | `VideoSelfieResult.selfieImagePath` | `videoSelfie` |

:::warning
`FACE_MATCH` changes the `imageType`. The value of `imageType` in steps 13 and 14 follows `VideoSelfie.Builder.setSelfieMode(...)`:

  - `SelfieMode.SELFIE_MATCH`, the default, sends `imageType=videoSelfie`. The back end compares the Video Selfie image with the earlier selfie.
  - `SelfieMode.FACE_MATCH` sends `imageType=selfie`. The Video Selfie image becomes the selfie of the session, and the back end compares it with the ID.

  The examples below show the default.
:::

```bash
curl --location 'WELCOME_API_URL/omni/add/face/third-party?imageType=videoSelfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_SELFIE_IMAGE_PATH"
}'
```

Step 14 processes that frame. The response gives a `confidence` value. Keep it for step 16.

```bash
curl --location 'WELCOME_API_URL/omni/process/face?imageType=videoSelfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

Response (`200`):

```json
{
    "confidence": 1
}
```

### Step 15: Send the Voice Consent Audio

This call is optional. Make it to check the words the user said. It needs `audioFilePath` to be set. Omit it if you collect the consent as a record only. The recording in steps 17 and 18 holds the audio either way.

Before the module starts, get the questions and the consent phrase and give them to the SDK. See [Get the Questions and the Consent Phrase](#get-the-questions-and-the-consent-phrase).

Step 15 sends the recording at `VideoSelfieResult.audioFilePath`. The body is the audio file itself, not JSON, so this call uses `Content-Type: audio/mp4`. The speech recognition runs inside this call. There is no process step after it.

```bash
curl --location 'WELCOME_API_URL/omni/add/speech?audioOnly=true' \
--header 'Content-Type: audio/mp4' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data-binary '@/path/to/audioFilePath.mp4'
```

:::warning
The iOS SDK uses a different speech endpoint. The iOS SDK calls `omni/add/speech/v2` with a JSON body. The Android SDK calls `omni/add/speech?audioOnly=true` with the audio file as the request body. If you write one back end for both platforms, make it accept the shape each platform sends.
:::

### Step 16: Send the Voice Consent Face

Optional. Make this call to match the face of the user during the consent. It needs `voiceConsentSelfiePath` to be set.

Omit it if you do not want this second face check. The consent is still recorded.

Send the frame at `VideoSelfieResult.voiceConsentSelfiePath` as base64, with the `confidence` value from step 14. The `threshold` is the bar the score is measured against. The SDK sends the recognition threshold, which you set with `CommonConfig.Builder.setRecognitionThreshold(...)`. The default is `0.6`.

```bash
curl --location 'WELCOME_API_URL/omni/videoselfie/voiceconsent/add/face' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "BASE64_OF_VOICE_CONSENT_SELFIE_PATH",
    "confidence": 1,
    "threshold": 0.6
}'
```

### Step 17: Get the Upload URL

This call reserves a pre-signed Amazon S3 URL for the Video Selfie recording. Make it after the comparison and face calls, then send the recording to that URL in step 18.

```bash
curl --location 'WELCOME_API_URL/omni/generateVideoSelfieUrl' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

The response gives the URL for the recording:

```json
{
    "url": "PRESIGNED_UPLOAD_URL"
}
```

### Step 18: Send the Recording

Send the file at `VideoSelfieResult.videoFilePath` to the `url` from step 17.

```bash
curl --location --request PUT 'PRESIGNED_UPLOAD_URL' \
--header 'Content-Type: video/mp4' \
--data-binary '@/path/to/videoSelfie.mp4'
```

To send the recording in parts instead of one request, read [Alternative: Upload the Video Selfie in Parts](#alternative-upload-the-video-selfie-in-parts).

## Alternative: Upload the Video Selfie in Parts

Both Video Selfie flows send the recording to a pre-signed S3 URL in one request. Three Omni endpoints send the same recording in parts instead.

Use it in place of steps 17 and 18 of the [Video Selfie Flow](#video-selfie-flow). Use one route or the other, never both.

Select this route when one of these is true:

- Your security policy does not permit a direct upload to Amazon S3.
- The recording is large, and one request for the whole file is not reliable.

:::info
The SDK does not use this route. In the `STANDARD` mode the SDK always reserves one URL and sends the recording in a single request. The endpoints below are an API-only route for Capture-Only mode.
:::

### Start the Upload

The response gives an `uploadId`. Every later call needs this value.

```bash
curl --location --request POST 'WELCOME_API_URL/omni/video-selfie/upload/initiate' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Send the Parts

The API gateway rejects a request larger than 10 MB. Divide the video into parts of about 7 MB, which keeps each request below that limit. For example, `split -b 7000000 archive.mp4 chunk_` writes the files `chunk_aa`, `chunk_ab`, and `chunk_ac`. Do not send parts near the 10 MB limit. Each request carries more than the part itself, so parts of 9 MB can still fail. 7 MB is the tested value.



Send each part in its own call. Increase `partNumber` by 1 for each part.

```bash
curl --location 'WELCOME_API_URL/omni/video-selfie/upload/part?uploadId=UPLOAD_ID&partNumber=1' \
--header 'Content-Type: application/octet-stream' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data-binary '@/path/to/chunk_aa'
```

Each response gives an `eTag`. Keep each `eTag` with its part number.

### Complete the Upload

This call tells the back end to put the parts together into one recording. Send the `uploadId` from the first call and the `partNumber` and `eTag` of each part.

```bash
curl --location 'WELCOME_API_URL/omni/video-selfie/upload/complete' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "uploadId": "abc123",
    "parts": [
        { "partNumber": 1, "eTag": "bcae19" },
        { "partNumber": 2, "eTag": "d4f921" },
        { "partNumber": 3, "eTag": "a1b2c3" }
    ]
}'
```

Obey these four rules for the upload in parts:

- Read the `uploadId` from the response of the first call. Do not write it into the code.
- Number the parts in sequence, from 1.
- Send the parts in the same order as the divided files.
- Put every part in the `parts` array. A missing part makes the assembly fail.

## Flows Without Deepsight

Every flow on this page uses Deepsight. To run the same flow without it, make these two changes:

1. In the SDK, set `setEnabled(false)` on the `DeepsightConfiguration`, and set `setMotionEnabled(false)` on both the `DeepsightConfiguration` and the `IdScan.Builder`. Set the same values in the Dashboard flow.
2. Omit the Deepsight video. With `setEnabled(false)` the SDK records no video, so `presignedVideoFilePath` is `null`. Omit `POST /omni/recordings/import` and omit the `recordingId` query parameter of `omni/add/face/third-party`.

Every other call stays, in the same order.

## Additional APIs

These calls are optional. They read data from a session that is complete.

### Get the Session Score

```bash
curl --location 'WELCOME_API_URL/omni/get/score' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Get the OCR Data of the ID

```bash
curl --location 'WELCOME_API_URL/omni/get/ocr-data' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Get the Session Images

Base64 strings are large. Ask for the images that you need, in one call.

```bash
curl --location --request POST 'WELCOME_API_URL/omni/get/images' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "images": [
        "fullFrameFrontID",
        "fullFrameBackID",
        "selfie",
        "signatureImageID",
        "ghostSignatureImageID",
        "ghostPortraitImageID"
    ]
}'
```

### Get the Deepsight Video

```bash
curl --location 'WELCOME_API_URL/omni/generateSessionRecordingDownloadUrl?interviewId=INTERVIEW_ID&type=selfie' \
--header 'Accept: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: WELCOME_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

## Clean Up the Local Data

Call `IncodeWelcome.deleteUserLocalData(context)` after the flow exits. Call it from the success, error, and cancellation callbacks. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/).

Send or copy every capture you need before you make this call. On the error and cancellation paths the uploads can be incomplete, and the call removes the files permanently.

For additional help, see the [Android API Reference](/sdk-reference/android-api-reference/) or contact Incode support.

---

- Path: `sdk-reference/android-capture-only-sdk`
- URL: https://developer.incode.com/sdk-reference/android-capture-only-sdk/
- Markdown: https://developer.incode.com/sdk-reference/android-capture-only-sdk.md

# Capture-Only Mode

Capture-Only mode runs the Incode capture experience on-device and returns the resulting photos and videos through callbacks, without sending data to Incode for processing. Use it when you want Incode's auto-capturing camera UX but do not want the SDK to upload or process the media. Every API call is fully decoupled and can be made in any order, any number of times. You are responsible for whatever you do with the captured media afterward.

***

## How It Works

The capture APIs perform local checks, auto-capture the photo when conditions are met, and return the captured photo through a callback.

The diagram below shows the recommended data flow when using Capture-Only mode. The SDK captures locally and hands the media to the host app. The host app sends it to the customer server, which calls the Incode API and decides whether to repeat the capture.

Each module follows the same pattern, but the completion callback, the result type, and the fields it carries change. Read the below diagram once to understand the pattern, then view the diagram for module you are integrating: [ID Scan](#id-scan), [Selfie Scan](#selfie-scan), or [Video Selfie](#video-selfie). Each module-specific diagram includes the exact callback signature and every result field your app receives.

```mermaid
sequenceDiagram
    autonumber
    participant App as Host App
    participant SDK as Incode SDK
    participant Server as Customer Server

    App->>SDK: init in CAPTURE_ONLY mode
    Note over App,SDK: Keep a singleton reference so the SDK<br/>is not cleared from memory

    loop For each module in the flow (any order, any number of times)
        App->>SDK: startOnboardingSection(module)
        SDK->>SDK: local checks, auto capture
        SDK-->>App: module completion callback with result
        SDK-->>App: onOnboardingSectionCompleted
        Note over App,SDK: Only start the next section<br/>after onOnboardingSectionCompleted
        App->>Server: upload captured media
        Server->>Server: call Incode API, analyze response
        alt capture not acceptable
            Server-->>App: request re-capture
            App->>SDK: startOnboardingSection(module) again
        end
    end

    App->>SDK: deleteUserLocalData
```

### ID Scan

The diagram below shows the recommended data flow when using Capture-Only mode for the [ID Scan](/sdk-reference/android-id-scan/)​ module.

```mermaid
sequenceDiagram
    autonumber
    participant App as Host App
    participant SDK as Incode SDK
    participant Server as Customer Server

    App->>SDK: startOnboardingSection(IdScan FRONT)
    SDK-->>App: onIdFrontCompleted(IdScanResult)
    Note right of App: idImagePath (file URI)<br/>idImageBase64 (base64)<br/>chosenIdType<br/>metadata
    SDK-->>App: onOnboardingSectionCompleted
    App->>Server: upload front ID photo
    Server-->>App: OK or repeat front scan

    App->>SDK: startOnboardingSection(IdScan BACK)
    SDK-->>App: onIdBackCompleted(IdScanResult)
    Note right of App: idImagePath (file URI)<br/>idImageBase64 (base64)<br/>chosenIdType<br/>metadata
    SDK-->>App: onOnboardingSectionCompleted
    App->>Server: upload back ID photo
    Server-->>App: OK or repeat back scan
```

### Selfie Scan

The diagram below shows the recommended data flow when using Capture-Only mode for the [Selfie Scan](/sdk-reference/android-selfie-scan/)​ module.

```mermaid
sequenceDiagram
    autonumber
    participant App as Host App
    participant SDK as Incode SDK
    participant Server as Customer Server

    App->>SDK: startOnboardingSection(SelfieScan)
    SDK-->>App: onSelfieScanCompleted(SelfieScanResult)
    Note right of App: croppedSelfieImgPath (file URI)<br/>fullFrameSelfieImgPath (file URI)<br/>selfieBase64 (base64)<br/>fullFrameSelfieBase64 (base64)<br/>metadata
    SDK-->>App: onOnboardingSectionCompleted
    App->>Server: upload selfie
    Server-->>App: OK or repeat selfie scan
```

### Video Selfie

The diagram below shows the recommended data flow when using Capture-Only mode for the [Video Selfie](/sdk-reference/android-video-selfie/) module.

```mermaid
sequenceDiagram
    autonumber
    participant App as Host App
    participant SDK as Incode SDK
    participant Server as Customer Server

    App->>SDK: startOnboardingSection(VideoSelfie)
    SDK-->>App: onVideoRecorded(VideoSelfieResult)
    Note right of App: videoFilePath (file URI)<br/>audioFilePath (file URI)<br/>selfieImagePath (file URI)<br/>idFrontImagePath (file URI)<br/>idBackImagePath (file URI)<br/>documentImagePath (file URI)<br/>voiceConsentSelfiePath (file URI)
    SDK-->>App: onOnboardingSectionCompleted
    App->>Server: upload video selfie assets
    Server-->>App: OK or repeat video selfie
```

***

## Supported Modules

Capture-Only mode supports the following modules:

| Module                                                                                 | Description                                                                                                                                                                              |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Intro](/sdk-reference/android-intro/)                 | Displays an introduction screen at the start of an onboarding flow.                                                                                                                      |
| [Name](/sdk-reference/android-name/)                   | Allows the user to enter their name.                                                                                                                          |
| [Phone](/sdk-reference/android-phone/)                 | Allows the user to enter their phone number.                                                                                                                  |
| [Email](/sdk-reference/android-email/)                 | Allows the user to enter their email address.                                                                                                                 |
| [ID Scan](/sdk-reference/android-id-scan/)             | Captures the front and back of a government-issued ID or passport. Select the document type via `IdScan.Builder.setIdType`. |
| [NFC Scan](/sdk-reference/android-nfc-scan-2/)         | Reads the secure NFC chip embedded in ICAO 9303-compliant travel documents (such as e-passports) and returns the document holder's data.                                                 |
| [Document Scan](/sdk-reference/android-document-scan/) | Captures a document image, such as a proof of address or other supporting document.                                                                          |
| [Selfie Scan](/sdk-reference/android-selfie-scan/)     | Captures the user's face with the device camera and runs liveness detection and face recognition.                                                                                        |
| [Geolocation](/sdk-reference/android-geolocation/)     | Requests location permission, reads the device's current location, and returns the coordinates along with an address breakdown.                                                          |
| [Signature](/sdk-reference/android-signature/)         | Allows the user to draw a signature by hand.                                                                                              |
| [Video Selfie](/sdk-reference/android-video-selfie/)   | Records a short video of the user during the session and runs liveness and face-match checks.                                                                                            |

***

## Set Up Capture-Only Mode

Complete the following steps in order.

### Initialize the SDK for Capture-Only

Add the following to the class that extends `Application` and set the SDK mode to `SdkMode.CAPTURE_ONLY`. You can only make capture API calls after the SDK has been initialized with `build()`.

```kotlin
override fun onCreate() {
    super.onCreate()
    ...
    IncodeWelcome.Builder(this)
        .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. logs are enabled by default
        .setSdkMode(SdkMode.CAPTURE_ONLY) // enable CAPTURE_ONLY mode
        .build()
    ...
}
```
```java
@Override
public void onCreate() {
    super.onCreate();
    ...
    new IncodeWelcome.Builder(this)
        .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. logs are enabled by default
        .setSdkMode(SdkMode.CAPTURE_ONLY) // enable CAPTURE_ONLY mode
        .build();
    ...
}
```

- `build()` creates the `IncodeWelcome` singleton. You can only make capture API calls after initialization.
- `setLoggingEnabled()` is optional. Logs are enabled by default.

See [API Reference](/sdk-reference/android-api-reference/) for the complete specification of `IncodeWelcome.Builder`.

### Perform Capture SDK Calls

Build the module you want to capture, wrap it in a `FlowConfig`, and start an onboarding section. Results arrive on the `OnboardingListener` callbacks. The examples below show an ID scan and a selfie scan.

```kotlin
// IdScan

IncodeWelcome.getInstance().setSdkMode(SdkMode.CAPTURE_ONLY)
try {
    val idScan: IdScan = IdScan.Builder()
        .setShowIdTutorials(true)
        .build()

    val flowConfig: FlowConfig = FlowConfig.Builder()
        .setFlowTag("ID scan section")
        .addID(idScan)
        .build()

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, object : OnboardingListener() {
            override fun onIdFrontCompleted(frontIdScanResult:IdScanResult) {}

            overide fun onIdBackCompleted(backIdScanResult:IdScanResult) {}

            override fun onError(error: Throwable) {}

            override fun onUserCancelled() {}

            override fun onInterrupted() {}

            override fun onOnboardingSectionCompleted(flowTag: String) {
                // ID scan section complete
            }
        }
    )
} catch (e: ModuleConfigurationException) {
    e.printStackTrace()
}

// SelfieScan
IncodeWelcome.getInstance().setSdkMode(SdkMode.CAPTURE_ONLY)
try {
    val selfieScan = SelfieScan.Builder()
        .setShowTutorials(true)
        .build()

    val flowConfig: FlowConfig = FlowConfig.Builder()
        .setFlowTag("Selfie scan section")
        .addSelfieScan(selfieScan)
        .build()

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, object : OnboardingListener() {
            override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
                // Use selfieScanResult to read the result photo
            }

            override fun onError(error: Throwable) {}

            override fun onUserCancelled() {}

            override fun onInterrupted() {}

            override fun onOnboardingSectionCompleted(flowTag: String) {
                // Selfie scan section complete
            }
        }
    )
} catch (e: ModuleConfigurationException) {
    e.printStackTrace()
}
```
```java
// IdScan

IncodeWelcome.getInstance().setSdkMode(com.incode.welcome_sdk.SdkMode.CAPTURE_ONLY);
try {
    IdScan idScan = new IdScan.Builder()
        .setShowIdTutorials(true)
        .build();

    FlowConfig flowConfig = new FlowConfig.Builder()
        .setFlowTag("ID scan section")
        .addID(idScan)
        .build();

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, new IncodeWelcome.OnboardingListener() {
            @Override
            public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {}

            @Override
            public void onIdBackCompleted(@NonNull IdScanResult backIdScanResult) {}

            @Override
            public void onError(@NonNull Throwable error) {}

            @Override
            public void onUserCancelled() {}

            @Override
            public void onInterrupted() {}

            @Override
            public void onOnboardingSectionCompleted(@NonNull String flowTag) {
                // ID scan section complete
            }
        }
    );
} catch (ModuleConfigurationException e) {
    e.printStackTrace();
}

// SelfieScan

IncodeWelcome.getInstance().setSdkMode(com.incode.welcome_sdk.SdkMode.CAPTURE_ONLY);
try {
    SelfieScan selfieScan = new SelfieScan.Builder()
        .setShowTutorials(true)
        .build();

    FlowConfig flowConfig = new FlowConfig.Builder()
        .setFlowTag("Selfie scan section")
        .addSelfieScan(selfieScan)
        .build();

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, new IncodeWelcome.OnboardingListener() {
            @Override
            public void onSelfieScanCompleted(@NonNull SelfieScanResult selfieScanResult) {
                // Use selfieScanResult to read the result photo
            }

            @Override
            public void onError(@NonNull Throwable error) {}

            @Override
            public void onUserCancelled() {}

            @Override
            public void onInterrupted() {}

            @Override
            public void onOnboardingSectionCompleted(@NonNull String flowTag) {
                // Selfie scan section complete
            }
        }
    );
} catch (ModuleConfigurationException e) {
    e.printStackTrace();
}
```

### Forward Metadata for Deepsight

If your organization uses Deepsight, forward the `metadata` field from `IdScanResult` and `SelfieScanResult` to the corresponding `omni/add/*` API request. Deepsight's downstream checks depend on this field. If you omit it, those checks run without the data they need.

### Clean Up Local User Data

After the flow exits, call `IncodeWelcome.deleteUserLocalData(context)` to delete all local user data generated during the flow.

<Callout icon="❗️" theme="error">
  ### Always call deleteUserLocalData()

  Call `deleteUserLocalData()` to remove the local user data the flow generated. Call it from your success, error, and cancellation callbacks.
</Callout>

Call `deleteUserLocalData()` in the following callbacks:

```kotlin
fun onSuccess()
fun onError()
fun onUserCancelled()
```
```java
public void onSuccess()
public void onError()
public void onUserCancelled()
```

***

## Supported API Configurations

The builders below show every configuration supported in Capture-Only mode. The `...` placeholders stand for the values you supply.

### FlowConfig

`FlowConfig` assembles the modules in order for the section you start.

```kotlin
val flowConfig = FlowConfig.Builder()
    .setFlowTag(...)
    .addIntro(...)
    .addName()
    .addPhone(...)
    .addEmail(...)
    .addID(...)
    .addNfcScan(...)
    .addDocumentScan(...)
    .addSelfieScan(...)
    .addGeolocation()
    .addSignature(...)
    .addVideoSelfie(...)
    .build()
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .setFlowTag(...)
    .addIntro(...)   
    .addName()
    .addPhone(...)
    .addEmail(...)
    .addID(...)
    .addNfcScan(...)
    .addDocumentScan(...)
    .addSelfieScan(...)
    .addGeolocation()
    .addSignature(...)
    .addVideoSelfie(...)
    .build();
```

### CommonConfig

`CommonConfig` holds settings shared across modules: thresholds, navigation, localization, and theming.

```kotlin
val commonConfig = CommonConfig.Builder()
    .setIdGlareThreshold(...)
    .setIdBlurThreshold(...)
    .setShowCloseButton(...)
    .setShowExitConfirmation(...)
    .setLocalizationLanguage(...)
    .setThemeConfiguration(...)
    .build()
```
```java
CommonConfig commonConfig = new CommonConfig.Builder()
    .setIdGlareThreshold(...)
    .setIdBlurThreshold(...)
    .setShowCloseButton(...)
    .setShowExitConfirmation(...)
    .setLocalizationLanguage(...)
    .setThemeConfiguration(...)
    .build();
```

For the complete `Builder` options for each capture module, see [Document Scan](/sdk-reference/android-document-scan/), [ID Scan](/sdk-reference/android-id-scan/), [Selfie Scan](/sdk-reference/android-selfie-scan/), and [Video Selfie](/sdk-reference/android-video-selfie/). The same options apply in Capture-Only mode.

***

## Customizable Strings

Every user-facing string the SDK shows can be overridden, including in Capture-Only flows. For the full list of string keys, see [Customization > Override Strings](/sdk-reference/android-customization#override-strings/).

***

For help, see [API Reference](/sdk-reference/android-api-reference/) or contact Incode support.

---

- Path: `sdk-reference/android-combined-consent`
- URL: https://developer.incode.com/sdk-reference/android-combined-consent/
- Markdown: https://developer.incode.com/sdk-reference/android-combined-consent.md

# Combined Consent

The Combined Consent module shows the user one or more preconfigured consents to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey. Consents are [configured in Dashboard](/dashboard-platform-administration/configuration-consents-tab/); the module presents what your Flow or Workflow configuration provides.

For an overview of this module and how it works, see [Data Sharing Consent](/features-and-modules/combined-consent/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Combined Consent

Add the module with `addCombinedConsent()`, passing a `CombinedConsent` instance built with its `Builder`.

```kotlin
flowConfigBuilder.addCombinedConsent(combinedConsent)
```
```java
flowConfigBuilder.addCombinedConsent(combinedConsent);
```

### Example

The example below builds a `CombinedConsent` with a combined consents ID, adds it to the flow, and listens for the result through `onCombinedConsentCompleted()`.

To get the consent ID, first create Data Sharing Consent in the Dashboard under Configuration → Consents, then copy the resulting ID.

```kotlin
val combinedConsent = CombinedConsent.Builder()
    .setCombinedConsentsId("YOUR_COMBINED_CONSENTS_ID")
    .build()

val flowConfig = FlowConfig.Builder()
    .addCombinedConsent(combinedConsent)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onCombinedConsentCompleted(combinedConsentResult: CombinedConsentResult) {
        // Consent step finished. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
CombinedConsent combinedConsent = new CombinedConsent.Builder()
    .setCombinedConsentsId("YOUR_COMBINED_CONSENTS_ID")
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addCombinedConsent(combinedConsent)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onCombinedConsentCompleted(@NonNull CombinedConsentResult combinedConsentResult) {
        // Consent step finished. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Build the module with `CombinedConsent.Builder`. The table below lists the common options.

| Setting                                              | Description                                                                                 |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `setCombinedConsentsId(String)`                      | Sets the ID of the preconfigured combined consents to present. Ignored in DELAYED SDK mode. |
| `setOfflineCombinedConsentData(CombinedConsentData)` | Sets the offline consent data. Used only in DELAYED SDK mode.                               |

For the complete option set, see `CombinedConsent.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Combined Consent delivers a `CombinedConsentResult` to the `onCombinedConsentCompleted(CombinedConsentResult)` callback on the `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if the combined consent was submitted successfully; otherwise, `false`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `CombinedConsentResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-common-implementation-patterns`
- URL: https://developer.incode.com/sdk-reference/android-common-implementation-patterns/
- Markdown: https://developer.incode.com/sdk-reference/android-common-implementation-patterns.md

# Integration Approaches

After you've [installed and initialized](/sdk-reference/android-installation/) the Incode Android SDK, choose an integration approach. This involves choosing:

- **An integration path**: How much UI and orchestration the SDK owns.
- **An integration pattern**: Where the identity verification (IDV) flow is defined and how it runs.

Choose the path first, then the pattern that fits your product.

***

## Integration Paths

The SDK supports three integration paths, each offering a different level of control. Start with the simplest path that meets your requirements.

### Path 1: Full Onboarding Flow

The SDK owns the UI from start to finish. You define the [modules](/sdk-reference/android-individual-modules/) you want and pass them to the SDK. The SDK then runs those modules in sequence and returns results through a listener.

This is the simplest path and the recommended starting point for most integrations.

### Path 2: Split Flow

The SDK owns each module screen: the camera UI, the capture experience, and the on-device guidance. You own the order of modules and the screens between them. Use this when you need to insert your own screens between Incode steps or run only part of an identity verification journey.

### Path 3: Capture-Only

The SDK owns only the capture UI. You own everything before and after capture. This path is not recommended unless your platform has strict security or orchestration requirements.

See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/).

***

## Integration Patterns

The SDK supports three integration patterns. Each pattern determines where the flow is defined and how it runs.

### Pattern 1: Configure Flows Locally and Run End to End

Define the flow in code using `FlowConfig`. Pass it to `startOnboarding()`. The SDK runs every module in sequence and returns control to your app when the flow finishes.

Use this pattern with **Integration Path 1: Full Onboarding Flow**.

See [Configure Flows Locally and Run End to End](/sdk-reference/android-configure-flows-locally-and-run-end-to-end/)​.

### Pattern 2: Configure Flows Locally and Run Step by Step

Define the flow in code as one or more sections. Run each section with `startOnboardingSection()`. Control returns to your app between sections, so you can insert your own screens or logic, branch based on intermediate results, or split a long flow into discrete steps.

Use this pattern with **Integration Path 2: Split Flow**.

See [Configure Flows Locally and Run Step by Step](/sdk-reference/android-configure-flows-locally-and-run-step-by-step/)​.

### Pattern 3: Run Flows Configured in Dashboard

Define the flow in Dashboard, then start it with `startFlow()` or `startWorkflow()`. Reference the flow by ID. The SDK pulls the modules and configuration from Dashboard; you don't need to define a `FlowConfig` locally. Activate the flow in Dashboard before starting the session. Use this when you want to update the flow without releasing a new app version.

Dashboard supports two flow types: Flows and Workflows. They behave differently depending on the integration path:

- **Flows** support **Integration Path 1: Full Onboarding Flow** only.
- **Workflows** support **Integration Path 1: Full Onboarding Flow** and **Integration Path 2: Split Flow**.

See [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/)​.

***

## Choose Your Integration Approach

| Goal                                                              | Path                                                                                                     | Pattern                                                                                                            | Entry Point                                                                                       |
| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| Run a full IDV flow with the least code possible                  | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow)                                             | [Pattern 1: Configure Flows Locally and Run End to End](#pattern-1-configure-flows-locally-and-run-end-to-end)     | `startOnboarding()`                                                                               |
| Insert your own screens or logic between SDK steps                | [​Path 2: Split Flow](#path-2-split-flow)                                                                | [Pattern 2: Configure Flows Locally and Run Step by Step](#pattern-2-configure-flows-locally-and-run-step-by-step) | `startOnboardingSection()`                                                                        |
| Update the flow from Dashboard without an app release (Flows)     | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow)                                             | [Pattern 3: Run Flows Configured in Dashboard](#pattern-3-run-flows-configured-in-dashboard)                             | `startFlow()`                                                                                     |
| Update the flow from Dashboard without an app release (Workflows) | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow) or [Path 2: Split Flow](#path-2-split-flow) | [Pattern 3: Run Flows Configured in Dashboard](#pattern-3-run-flows-configured-in-dashboard)                             | `startWorkflow()`                                                                                 |
| Build a fully custom capture experience                           | [Path 3: Capture-Only](#path-3-capture-only)                                                             | N/A                                                                                                                | See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/) |

***

## What's Next

Use the table below to find the page you need.

| Task                                                                                                                                 | Page                                                                                                     |
| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| View a complete, buildable reference integration                                                                                     | [Example Implementation](/sdk-reference/android-example-implementation/) |
| View the module catalog for building a `flowConfig`                                                                                  | [Individual Modules](/sdk-reference/android-individual-modules/)                                                             |
| View the result and error objects returned when a flow finishes.                                                                     | [Results](/sdk-reference/android-results-reference/)                     |
| View the full specification of `startOnboarding()`, `startOnboardingSection()`, `startWorkflow()`, `FlowConfig`, and `SessionConfig` | [API Reference](/sdk-reference/android-api-reference/)                   |

<br />

---

- Path: `sdk-reference/android-conference-assisted-video`
- URL: https://developer.incode.com/sdk-reference/android-conference-assisted-video/
- Markdown: https://developer.incode.com/sdk-reference/android-conference-assisted-video.md

# Conference (Assisted Video)

The Conference (Assisted Video) module connects the user with a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements.

For an overview of this module and how it works, see [Video Conference](/features-and-modules/video-conference/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

Conference is not available in [Capture-Only mode](/sdk-reference/android-capture-only-sdk/); adding it there throws `ModuleNotAvailableException`.

## Add Conference

1. Ensure you've [declared](/sdk-reference/android-installation/#declare-dependencies) the `com.incode.sdk:video-streaming` dependency in your `[module]/build.gradle`.
2. Before Conference, add the following:
   - A [Selfie Scan](/sdk-reference/android-selfie-scan/) module
   - Either of the following, with its matching validation:
     - An [ID Scan](/sdk-reference/android-id-scan/) module, validated with [Face Match](/sdk-reference/android-face-match/)
     - A [QR Scan](/sdk-reference/android-qr-scan/) module, validated with [Government Validation](/sdk-reference/android-government-validation/)
       Ordering is validated, so configuration verification fails if Conference doesn't come after these steps.
3. Add the module with one of the `addConference` overloads:

   ```kotlin
   // Default configuration
   flowConfigBuilder.addConference()

   // Disable the microphone when the user enters the conference
   flowConfigBuilder.addConference(disableMicOnCallStart = true)
   ```
   ```java
   // Default configuration
   flowConfigBuilder.addConference();

   // Disable the microphone when the user enters the conference
   flowConfigBuilder.addConference(true);
   ```

### Example

The example below adds Conference after the prerequisite capture and validation modules, disables the microphone on call start, and listens for queue position, estimated wait time, and conference completion.

```kotlin
val flowConfig = FlowConfig.Builder()
    // ... add the prerequisite capture and validation modules first
    .addConference(disableMicOnCallStart = true)
    .build()

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    object : OnboardingListener() {
        override fun onEstimatedWaitingTime(waitingTimeInSeconds: Int) {
            // Show the estimated wait before the agent connects
        }

        override fun onQueuePositionChanged(newQueuePosition: Int) {
            // 0 means it is the user's turn
        }

        override fun onConferenceEnded() {
            // The video conference has finished
        }

        override fun onError(error: Throwable) {}

        override fun onUserCancelled() {}
    }
)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    // ... add the prerequisite capture and validation modules first
    .addConference(true)
    .build();

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    new IncodeWelcome.OnboardingListener() {
        @Override
        public void onEstimatedWaitingTime(int waitingTimeInSeconds) {
            // Show the estimated wait before the agent connects
        }

        @Override
        public void onQueuePositionChanged(int newQueuePosition) {
            // 0 means it is the user's turn
        }

        @Override
        public void onConferenceEnded() {
            // The video conference has finished
        }

        @Override
        public void onError(@NonNull Throwable error) {}

        @Override
        public void onUserCancelled() {}
    }
);
```

## Configuration Options

Build the module with `Conference.Builder`. The module exposes a single option.

| Setting                             | Description                                                     |
| ----------------------------------- | --------------------------------------------------------------- |
| `setDisableMicOnCallStart(Boolean)` | Mutes the microphone when the user first enters the conference. |

For the complete option set, see `Conference.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Conference does not deliver a result payload to your listener. Completion is signaled by `onConferenceEnded()` on the `OnboardingListener`. While the user waits for an agent, the listener also receives:

- `onQueuePositionChanged(Int)`: The user's position in the queue, where `0` means it is their turn.
- `onEstimatedWaitingTime(Int)`: The estimated wait in seconds. Called once.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For the listener callbacks, see `IncodeWelcome.OnboardingListener` in [API Reference](/sdk-reference/android-api-reference/). The callbacks above are also declared by `VideoConferenceListener`, `QueuePositionChangeListener`, and `EstimatedWaitingTimeListener`.

---

- Path: `sdk-reference/android-configure-flows-locally-and-run-end-to-end`
- URL: https://developer.incode.com/sdk-reference/android-configure-flows-locally-and-run-end-to-end/
- Markdown: https://developer.incode.com/sdk-reference/android-configure-flows-locally-and-run-end-to-end.md

# Configure Flows Locally and Run End to End

This is the standard integration pattern for the Incode Android SDK. It involves:

- Defining the onboarding flow locally in code with `FlowConfig`
- Implementing an `OnboardingListener` to receive results
- Running the session with one call to `startOnboarding()`

The SDK presents the Incode UI for each module in turn.

Use this integration pattern when you want full control over the flow in client code. If you prefer to define the flow in Dashboard instead, see [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/). If you need to insert your own screens or logic between SDK modules, see [Configure Flows Locally and Run Step by Step](/sdk-reference/android-configure-flows-locally-and-run-step-by-step/). For more information about these patterns, see [Common Integration Approaches](/sdk-reference/android-common-implementation-patterns/#integration-patterns).

This page covers session creation and section execution only. Ensure you have followed the steps to [Install and Initialize](/sdk-reference/android-installation/) the Incode Android SDK first.


## Imports and Package Paths

The snippets below use short class names. The full package paths are:

- `com.incode.welcome_sdk`: Entry point and core classes, including `IncodeWelcome`, `FlowConfig`, and `SessionConfig`.
- `com.incode.welcome_sdk.modules`: Module config classes, such as `IdScan`, `SelfieScan`, and `FaceMatch`.
- `com.incode.welcome_sdk.results`: Result types, such as `IdScanResult`, `SelfieScanResult`, and `FaceMatchResult`.

`OnboardingListener` is a nested class. Import it as `IncodeWelcome.OnboardingListener`. See [API Reference](/sdk-reference/android-api-reference/) for the full package layout.


## Set Up This Integration Pattern

The pattern uses four objects and one call: initialize the SDK, build a `FlowConfig`, create an `OnboardingListener`, and call `startOnboarding()`

`startOnboarding()` requires a `SessionConfig` argument: Its contents are optional; pass `SessionConfig.Builder().build()` if you don't need to customize the session. `CommonConfig` is a separate optional customization. Both are covered below.

### Build a Flow Configuration

In the `Activity` where you want to show the onboarding UI, build a `FlowConfig` inside `onCreate()`. Add the modules you want in the flow:

```kotlin
val flowConfig: FlowConfig = FlowConfig.Builder()
    .addPhone()
    .addID(IdScan.Builder()
        .setIdType(IdScan.IdType.ID)
        .setShowIdTutorials(true)
        .setWaitForTutorials(true)
        .build())
    .addProcessId(ProcessId.Builder().build())
    .addDocumentScan(DocumentScan.Builder().build())
    .addGeolocation()
    .addSelfieScan(SelfieScan.Builder().build())
    .addFaceMatch()
    .addUserConsent(UserConsent.Builder().build())
    .addSignature()
    .addCaptcha()
    .addVideoSelfie()
    .addConference()
    .build()
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
        .addPhone()
        .addID(new IdScan.Builder()
            .setIdType(IdScan.IdType.ID)
            .setShowIdTutorials(true)
            .setWaitForTutorials(true)
            .build())
        .addProcessId(new ProcessId.Builder().build())
        .addDocumentScan(new DocumentScan.Builder().build())
        .addGeolocation()
        .addSelfieScan(new SelfieScan.Builder().build())
        .addFaceMatch()
        .addUserConsent(new UserConsent.Builder().build())
        .addSignature()
        .addCaptcha()
        .addVideoSelfie()
        .addConference()
        .build();
```

This creates a `FlowConfig` with all the modules you want in the onboarding flow. Omitted modules are not shown. Modules appear in the order you add them to the builder.

:::warning
Some modules are mandatory. Some modules have order dependencies. For example, every onboarding flow needs the [ID Scan](/sdk-reference/android-id-scan/) and [Selfie Scan](/sdk-reference/android-selfie-scan/) modules, and the Results module must come after modules that add or process data. If any of these rules are broken, `FlowConfig.Builder.build()` throws `ModuleConfigurationException`.
:::

Each module has its own configuration options exposed through its `Builder` class. See each page in the [Individual Modules](/sdk-reference/android-individual-modules/) catalog for details.

A few general notes:

- Some modules require a module config instance obtained and customized through the module's `Builder` class. For example, `IdScan.Builder().build()` for the ID Scan module.
- Some modules show tutorials by default. Disable them by calling `setShowTutorials(false)` on the builder.

See [API Reference](/sdk-reference/android-api-reference/) for the complete `FlowConfig` specification.

### Create a Callback to Receive SDK Results

Implement an `OnboardingListener` to receive results from each module and from the overall flow:

```kotlin
val onboardingListener: OnboardingListener = object : OnboardingListener() {
    override fun onOnboardingSessionCreated(token: String?, interviewId: String?, region: String) {
        // Onboarding Session Created successfully
    }

    override fun onIntroCompleted() {
        // Intro screen completed
    }

    override fun onAddPhoneCompleted(phoneNumberResult: PhoneNumberResult) {
        // Add phone completed
    }

    override fun onQRScanCompleted(qrScanResult: QRScanResult) {
        // QR scan completed
    }

    override fun onIdFrontCompleted(frontIdScanResult: IdScanResult) {
        // Scanning the front of an ID completed
    }

    override fun onIdBackCompleted(backIdScanResult: IdScanResult) {
        // Scanning the back of an ID completed
    }

    override fun onIdProcessed(idProcessResult: IdProcessResult) {
        // ID Validation completed
    }

    override fun onNfcScanCompleted(nfcScanResult: NfcScanResult) {
        // NFC scan completed
    }

    override fun onDocumentValidationCompleted(
        documentType: DocumentType,
        result: DocumentValidationResult
    ) {
        // Document validation completed
    }

    override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
        // Selfie scan completed
    }

    override fun onFaceMatchCompleted(faceMatchResult: FaceMatchResult) {
        // Face match completed
    }

    override fun onSignatureCollected(signatureFormResult: SignatureFormResult) {
        // Signature collected
    }

    override fun onUserConsentCompleted() {
        // User consent complete
    }

    override fun onVideoRecorded(videoSelfieResult: VideoSelfieResult) {
        // Video selfie finished successfully
    }

    override fun onCaptchaCollected(captchaResult: CaptchaResult) {
        // Captcha collected
    }

    override fun onGeolocationFetched(geolocationResult: GeolocationResult) {
        // Geolocation collected
    }

    override fun onApproveCompleted(approveResult: ApproveResult) {
        // User's onboarding approval completed
    }

    override fun onResultsShown(userScoreResult: UserScoreResult) {
        // Results shown to the user
    }

    override fun onQueuePositionChanged(newQueuePosition: Int) {
        // Queue position for the video call changed
    }

    override fun onEstimatedWaitingTime(waitingTimeInSeconds: Int) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    override fun onConferenceEnded() {
        // Called when the video conference has ended
    }

    override fun onSuccess() {
        // User successfully finished whole onboarding flow
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }

    override fun onUserCancelled() {
        // User cancelled the flow
    }

    override fun onInterrupted() {
        // Incode SDK was interrupted (e.g. OS reclaimed the activity while backgrounded)
    }    
}
```
```java
OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onOnboardingSessionCreated(@Nullable String token, @Nullable String interviewId, @NonNull String region) {
        // Onboarding Session Created successfully
    }

    @Override
    public void onIntroCompleted() {
        // Intro screen completed
    }

    @Override
    public void onAddPhoneCompleted(@NonNull PhoneNumberResult phoneNumberResult) {
        // Add phone completed
    }

    @Override
    public void onQRScanCompleted(@NonNull QRScanResult qrScanResult) {
        // QR scan completed
    }

    @Override
    public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {
        // Scanning the front of an ID completed
    }

    @Override
    public void onIdBackCompleted(@NonNull IdScanResult backIdScanResult) {
        // Scanning the back of an ID completed
    }

    @Override
    public void onIdProcessed(@NonNull IdProcessResult idProcessResult) {
        // ID Validation completed
    }

    @Override
    public void onNfcScanCompleted(@NonNull NfcScanResult nfcScanResult) {
        // NFC scan completed
    }

    @Override
    public void onDocumentValidationCompleted(@NonNull DocumentType documentType, @NonNull DocumentValidationResult result) {
        // Document validation completed
    }

    @Override
    public void onSelfieScanCompleted(@NonNull SelfieScanResult selfieScanResult) {
        // Selfie scan completed
    }

    @Override
    public void onFaceMatchCompleted(@NonNull FaceMatchResult faceMatchResult) {
        // Face match completed
    }

    @Override
    public void onSignatureCollected(@NonNull SignatureFormResult signatureFormResult) {
        // Signature collected
    }

    @Override
    public void onUserConsentCompleted() {
        // User consent complete
    }

    @Override
    public void onVideoRecorded(@NonNull VideoSelfieResult videoSelfieResult) {
        // Video selfie finished successfully
    }

    @Override
    public void onCaptchaCollected(@NonNull CaptchaResult captchaResult) {
        // Captcha collected
    }

    @Override
    public void onGeolocationFetched(@NonNull GeolocationResult geolocationResult) {
        // Geolocation collected
    }

    @Override
    public void onApproveCompleted(@NonNull ApproveResult approveResult) {
        // User's onboarding approval completed
    }

    @Override
    public void onResultsShown(@NonNull UserScoreResult userScoreResult) {
        // Results shown to the user
    }

    @Override
    public void onQueuePositionChanged(int newQueuePosition) {
        // Queue position for the video call changed
    }

    @Override
    public void onEstimatedWaitingTime(int waitingTimeInSeconds) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    @Override
    public void onConferenceEnded() {
        // Called when the video conference has ended
    }

    @Override
    public void onSuccess() {
        // User successfully finished whole onboarding flow
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }

    @Override
    public void onUserCancelled() {
        // User cancelled the flow
    }

    @Override
    public void onInterrupted() {
        // Incode SDK was interrupted (e.g. OS reclaimed the activity while backgrounded)
    }
};
```

For the shape and fields of each result object, see [Results](/sdk-reference/android-results-reference/).

The SDK has multiple exit paths. Call `IncodeWelcome.deleteUserLocalData(context)` after the flow ends to delete all local user data. This is a static method that takes a `Context`. Call `deleteUserLocalData()` in these callbacks:

```kotlin
fun onSuccess()
fun onError(error: Throwable)
fun onUserCancelled()
```
```java
public void onSuccess()
public void onError(Throwable error)
public void onUserCancelled()
```

### Start the Onboarding Process

After creating the `FlowConfig` and `OnboardingListener` objects, start your session by calling `startOnboarding()`. The only signature is `startOnboarding(context, sessionConfig, flowConfig, onboardingListener)`, so a `SessionConfig` argument is **required**. Its contents are optional. If you don't need to bind a Dashboard flow, resume a session, or set custom fields, pass an empty `SessionConfig.Builder().build()`. See [Session Configuration](#session-configuration) below for customization options.

```kotlin
val sessionConfig: SessionConfig = SessionConfig.Builder().build() // or a customized SessionConfig (see below)
IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder().build(); // or a customized SessionConfig (see below)
IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

See [API Reference](/sdk-reference/android-api-reference/) for the complete specification of the `startOnboarding()` method and the `OnboardingListener` interface.


## Optional Configuration

These two configuration objects are optional. Use them to bind a Dashboard flow, resume a session, or adjust thresholds and UX behaviors.

### Session Configuration

Customize the onboarding session by creating a `SessionConfig`. Use these `SessionConfig.Builder` APIs:

| API                       | Description                                                                                                                                                                                         |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setConfigurationId`      | Specifies the flow ID from Dashboard to use the configurations applied to that flow. You still must add onboarding steps via `FlowConfig` to display the flow to the user.                          |
| `setValidationModuleList` | Sets the list of onboarding validation modules used for user scoring and approval. Defaults to `id`, `liveness`, `faceRecognition`.                                                                 |
| `setCustomFields`         | Provides a list of custom fields stored for this session.                                                                                                                                           |
| `setInterviewId`          | Specifies the ID of the onboarding session. Use to resume an existing session.                                                                                                                      |
| `setExternalToken`        | Specifies the JSON Web Token (JWT) of the onboarding session. Use to resume an existing session, or to run a session your backend created. See [Token-based Setup](/sdk-reference/android-token-based-setup/).                     |
| `setExternalId`           | Sets an ID used outside of the Incode Platform. If the first session is interrupted and a session with the same `externalId` already exists, that session is resumed instead of creating a new one. |
| `setExternalCustomerId`   | Sets an ID similar to `setExternalId`, but always creates a new session if interrupted, even if a session with the same `externalCustomerId` already exists.                                        |
| `setQueueName`            | Specifies the queue the user enters after the flow completes when using the Conference module. If none is specified, the user goes to the default queue.                                            |

```kotlin
val sessionConfig: SessionConfig = SessionConfig.Builder()
    .setConfigurationId("xxxxxxxxxxxxxxxx")
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId("xxxxxxxxxxxxxxxx")
    .build();
```

To resume an existing session, for example one started API to API:

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setInterviewId(...)
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setInterviewId(...)
    .build();
```

### Common Configuration

Customize thresholds or UX behaviors by creating a `CommonConfig`. Use these `CommonConfig.Builder` APIs:

| API                                   | Description                                                                                                                    |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `setShowCloseButton`                  | Shows or hides the close button on all screens. Hidden by default.                                                             |
| `setShowExitConfirmation`             | Shows or hides a dialog asking a user to confirm they want to leave the flow after pressing the back button. Shown by default. |
| `setShowDelayedOnboardingIntroScreen` | Shows or hides the introduction screen when the SDK starts in Delayed mode. Shown by default.                                  |

:::info
Only on-device thresholds get overridden by calling the APIs above.
:::

```kotlin
val commonConfig = CommonConfig.Builder()
    .setShowCloseButton(...)
    .setShowExitConfirmation(...)
    .setShowDelayedOnboardingIntroScreen(...)
    .build()

IncodeWelcome.getInstance().setCommonConfig(commonConfig)
```
```java
CommonConfig commonConfig = new CommonConfig.Builder()
        .setShowCloseButton(...)
        .setShowExitConfirmation(...)
        .setShowDelayedOnboardingIntroScreen(...)
        .build();

IncodeWelcome.getInstance().setCommonConfig(commonConfig);
```

---

- Path: `sdk-reference/android-configure-flows-locally-and-run-step-by-step`
- URL: https://developer.incode.com/sdk-reference/android-configure-flows-locally-and-run-step-by-step/
- Markdown: https://developer.incode.com/sdk-reference/android-configure-flows-locally-and-run-step-by-step.md

# Configure Flows Locally and Run Step by Step

This Android SDK integration pattern gives you full control over the onboarding experience. Instead of passing a single flow to the SDK and waiting for it to finish, you create an onboarding session, split the flow into sections, and run each section with `startOnboardingSection`. Control returns to your app between sections, so you can show your own screens, make decisions, or call your back end before continuing.

Use this pattern when you need to insert your own UI between capture steps, group modules into logical sections, or branch based on intermediate results. If you prefer to define the flow in Dashboard instead, see [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/). If you want full control over the flow in client code, see [Configure Flows Locally and Run End to End](/sdk-reference/android-configure-flows-locally-and-run-end-to-end/). For more information about these patterns, see [Common Integration Approaches](/sdk-reference/android-common-implementation-patterns/).

This page covers session creation and section execution only. Ensure you have followed the steps to [Install and Initialize](/sdk-reference/android-installation/) the Incode Android SDK first.

***

## Set Up This Integration Pattern

Complete the following steps in order.

### Create a New Onboarding Session

Before calling any other Onboarding SDK components, create a new onboarding session with `setupOnboardingSession` and an `OnboardingSessionListener`:

```kotlin
val sessionConfig: SessionConfig = SessionConfig.Builder().build()

IncodeWelcome.getInstance().setupOnboardingSession(
    sessionConfig,
    object : OnboardingSessionListener {
        override fun onOnboardingSessionCreated(
            token: String?,
            interviewId: String?,
            region: String
        ) {
            // Onboarding Session Created successfully
        }

        override fun onError(error: Throwable) {}
        override fun onUserCancelled() {}
    })
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder().build();

IncodeWelcome.getInstance().setupOnboardingSession(
    sessionConfig,
    new OnboardingSessionListener() {
        @Override
        public void onOnboardingSessionCreated(@Nullable String token, @Nullable String interviewId, @NonNull String region) {
            // Onboarding Session Created successfully
        }

        @Override
        public void onError(@NonNull Throwable error) {
        }

        @Override
        public void onUserCancelled() {
        }
    });
```

You can optionally specify a list of `OnboardingValidationModule` items. This list determines which modules are used for verification and calculation of the onboarding score. If you pass `null` as the `validationModuleList`, the default values are used: `id`, `faceRecognition`, and `liveness`.

```kotlin
val validationModuleList = listOf(
    OnboardingValidationModule.id,
    OnboardingValidationModule.secondId,
    OnboardingValidationModule.faceRecognition,
    OnboardingValidationModule.liveness,
    OnboardingValidationModule.faceRecognitionSecondId,
    OnboardingValidationModule.governmentValidation,
    OnboardingValidationModule.governmentOcrValidation,
    OnboardingValidationModule.governmentFaceValidation,
    OnboardingValidationModule.videoSelfie,
    OnboardingValidationModule.faceMask
)

val sessionConfig: SessionConfig = SessionConfig.Builder()
    ...
    .setValidationModuleList(validationModuleList)
    .build()
```
```java
List<OnboardingValidationModule> validationModuleList = new ArrayList<>();
validationModuleList.add(OnboardingValidationModule.id);
validationModuleList.add(OnboardingValidationModule.secondId);
validationModuleList.add(OnboardingValidationModule.faceRecognition);
validationModuleList.add(OnboardingValidationModule.liveness);
validationModuleList.add(OnboardingValidationModule.faceRecognitionSecondId);
validationModuleList.add(OnboardingValidationModule.governmentValidation);
validationModuleList.add(OnboardingValidationModule.governmentOcrValidation);
validationModuleList.add(OnboardingValidationModule.governmentFaceValidation);
validationModuleList.add(OnboardingValidationModule.videoSelfie);
validationModuleList.add(OnboardingValidationModule.faceMask);

SessionConfig sessionConfig = new SessionConfig.Builder()
        ...
        .setValidationModuleList(validationModuleList)
        .build();
```

You can also determine validation modules based on a specific Flow by passing a flow configuration ID.

### Create a Callback to Receive SDK Results

Implement an `OnboardingListener` to receive results from each module as sections run:

```kotlin
val onboardingListener: OnboardingListener = object : OnboardingListener() {
    override fun onOnboardingSessionCreated(token: String?, interviewId: String?, region: String) {
        // Onboarding Session Created successfully
    }

    override fun onIntroCompleted() {
        // Intro screen completed
    }

    override fun onAddPhoneCompleted(phoneNumberResult: PhoneNumberResult) {
        // Add phone completed
    }

    override fun onQRScanCompleted(qrScanResult: QRScanResult) {
        // QR scan completed
    }

    override fun onIdFrontCompleted(frontIdScanResult: IdScanResult) {
        // Scanning the front of an ID completed
    }

    override fun onIdBackCompleted(backIdScanResult: IdScanResult) {
        // Scanning the back of an ID completed
    }

    override fun onIdProcessed(idProcessResult: IdProcessResult) {
        // ID Validation completed
    }

    override fun onNfcScanCompleted(nfcScanResult: NfcScanResult) {
        // NFC scan completed
    }

    override fun onDocumentValidationCompleted(
        documentType: DocumentType,
        result: DocumentValidationResult
    ) {
        // Document validation completed
    }

    override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
        // Selfie scan completed
    }

    override fun onFaceMatchCompleted(faceMatchResult: FaceMatchResult) {
        // Face match completed
    }

    override fun onSignatureCollected(signatureFormResult: SignatureFormResult) {
        // Signature collected
    }

    override fun onUserConsentCompleted() {
        // User consent complete
    }

    override fun onVideoRecorded(videoSelfieResult: VideoSelfieResult) {
        // Video selfie finished successfully
    }

    override fun onCaptchaCollected(captchaResult: CaptchaResult) {
        // Captcha collected
    }

    override fun onGeolocationFetched(geolocationResult: GeolocationResult) {
        // Geolocation collected
    }

    override fun onApproveCompleted(approveResult: ApproveResult) {
        // User's onboarding approval completed
    }

    override fun onResultsShown(userScoreResult: UserScoreResult) {
        // Results shown to the user
    }

    override fun onQueuePositionChanged(newQueuePosition: Int) {
        // Queue position for the video call changed
    }

    override fun onEstimatedWaitingTime(waitingTimeInSeconds: Int) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    override fun onConferenceEnded() {
        // Called when the video conference has ended
    }

    override fun onSuccess() {
        // User successfully finished whole onboarding flow
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }

    override fun onUserCancelled() {
        // User cancelled the flow
    }
}
```
```java
OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onOnboardingSessionCreated(@Nullable String token, @Nullable String interviewId, @NonNull String region) {
        // Onboarding Session Created successfully
    }

    @Override
    public void onIntroCompleted() {
        // Intro screen completed
    }

    @Override
    public void onAddPhoneCompleted(@NonNull PhoneNumberResult phoneNumberResult) {
        // Add phone completed
    }

    @Override
    public void onQRScanCompleted(@NonNull QRScanResult qrScanResult) {
        // QR scan completed
    }

    @Override
    public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {
        // Scanning the front of an ID completed
    }

    @Override
    public void onIdBackCompleted(@NonNull IdScanResult backIdScanResult) {
        // Scanning the back of an ID completed
    }

    @Override
    public void onIdProcessed(@NonNull IdProcessResult idProcessResult) {
        // ID Validation completed
    }

    @Override
    public void onNfcScanCompleted(@NonNull NfcScanResult nfcScanResult) {
        // NFC scan completed
    }

    @Override
    public void onDocumentValidationCompleted(@NonNull DocumentType documentType, @NonNull DocumentValidationResult result) {
        // Document validation completed
    }

    @Override
    public void onSelfieScanCompleted(@NonNull SelfieScanResult selfieScanResult) {
        // Selfie scan completed
    }

    @Override
    public void onFaceMatchCompleted(@NonNull FaceMatchResult faceMatchResult) {
        // Face match completed
    }

    @Override
    public void onSignatureCollected(@NonNull SignatureFormResult signatureFormResult) {
        // Signature collected
    }

    @Override
    public void onUserConsentCompleted() {
        // User consent complete
    }

    @Override
    public void onVideoRecorded(@NonNull VideoSelfieResult videoSelfieResult) {
        // Video selfie finished successfully
    }

    @Override
    public void onCaptchaCollected(@NonNull CaptchaResult captchaResult) {
        // Captcha collected
    }

    @Override
    public void onGeolocationFetched(@NonNull GeolocationResult geolocationResult) {
        // Geolocation collected
    }

    @Override
    public void onApproveCompleted(@NonNull ApproveResult approveResult) {
        // User's onboarding approval completed
    }

    @Override
    public void onResultsShown(@NonNull UserScoreResult userScoreResult) {
        // Results shown to the user
    }

    @Override
    public void onQueuePositionChanged(int newQueuePosition) {
        // Queue position for the video call changed
    }

    @Override
    public void onEstimatedWaitingTime(int waitingTimeInSeconds) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    @Override
    public void onConferenceEnded() {
        // Called when the video conference has ended
    }

    @Override
    public void onSuccess() {
        // User successfully finished whole onboarding flow
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }

    @Override
    public void onUserCancelled() {
        // User cancelled the flow
    }
};
```

For the shape and fields of each result object, see [Results](/sdk-reference/android-results-reference/).

The SDK has multiple exit paths. Call `IncodeWelcome.deleteUserLocalData(context)` after the flow ends to delete all local user data. This is a static method that takes a `Context`. Call `deleteUserLocalData()` in these callbacks:

```kotlin
fun onSuccess()
fun onError(error: Throwable)
fun onUserCancelled()
```
```java
public void onSuccess()
public void onError(Throwable error)
public void onUserCancelled()
```

### Split the Flow into Sections

After the session is created, split the flow into sections based on your needs:

- Call `setFlowTag(String)` for each section.
- Call `IncodeWelcome.getInstance().finishOnboarding()` at the end of the flow, before the `CONFERENCE` or `RESULTS` modules. This marks the end of the flow and closes the session on the server.

### Create an Onboarding Section

Build a `FlowConfig` for the section, tag it with `setFlowTag`, add the modules it should run, and start it with `startOnboardingSection`. After all sections are complete, call `finishOnboarding`:

```kotlin
// Create section
val flowConfig: FlowConfig = FlowConfig.Builder()
    .setFlowTag("section 1") // Make sure to tag your flow section
    .addIntro(Intro.Builder().build())
    .addPhone()
    .addID()
    .build()

// Start section
IncodeWelcome.getInstance().startOnboardingSection(
    activityContext,
    flowConfig,
    onboardingListener
)

// Call when all finished
IncodeWelcome.getInstance().finishOnboarding(activityContext, object : FinishOnboardingListener {
    override fun onOnboardingFinished() {
        IncodeWelcome.deleteUserLocalData(activityContext) // recommended to delete local user data at this point
    }
    ...
})
```
```java
// Create section
FlowConfig flowConfig = new FlowConfig.Builder()
    .setFlowTag("section 1") // Make sure to tag your flow section
    .addIntro(new Intro.Builder().build())
    .addPhone()
    .addID()
    .build();

// Start section
IncodeWelcome.getInstance().startOnboardingSection(
    activityContext,
    flowConfig,
    onboardingListener);

// Call when all finished
IncodeWelcome.getInstance().finishOnboarding(activityContext, new FinishOnboardingListener() {
    @Override
    public void onOnboardingFinished() {
        IncodeWelcome.deleteUserLocalData(activityContext); // recommended to delete local user data at this point
    }
    ...
});
```

For the full list of modules you can add to a section and how to configure each one, see the [Individual Modules](/sdk-reference/android-individual-modules/) catalog.

***

## Section Flow Requirements

### Receive the "Section Complete" Callback

`OnboardingListener` contains a callback for the section completed event, `onOnboardingSectionCompleted()`.

<Callout icon="❗" theme="error">
  ### Warning

  Start subsequent sections only from`onOnboardingSectionCompleted()`. Starting a section from a module callback such as `onIdFrontCompleted()`) does not work correctly.
</Callout>

```kotlin
override fun onOnboardingSectionCompleted(flowTag: String) {
    ...
    startNextSection() // This will not work properly in module callback methods (example: `onIdFrontCompleted()`)
    // Use `onOnboardingSectionCompleted()` if you need to start other sections from the `Listener`
}

fun startNextSection() {
    val nextFlowConfig: FlowConfig = FlowConfig.Builder()
        .setFlowTag("NEXT_SECTION_FLOW_TAG") // add modules
        ...
        .build()
    IncodeWelcome.getInstance().startOnboardingSection(
        activityContext,
        nextFlowConfig,
        this
    )
}
```
```java
@Override
public void onOnboardingSectionCompleted(@NonNull String flowTag) {
    ...
    startNextSection(); // This will not work properly in module callback methods (example: `onIdFrontCompleted()`)
    // Use `onOnboardingSectionCompleted()` if you need to start other sections from the `Listener`
}

@Override
public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {
    ...
    // startNextSection(); // DON'T DO THIS HERE! Do it in `onOnboardingSectionCompleted()` instead!
}

public void startNextSection() {
    FlowConfig nextFlowConfig = new FlowConfig.Builder()
        .setFlowTag("NEXT_SECTION_FLOW_TAG")
        // add modules
        ...
        .build();

    IncodeWelcome.getInstance().startOnboardingSection(
        activityContext,
        nextFlowConfig,
        onboardingListener);
}
```

The module callbacks such as `onIdFrontCompleted()` deliver results as each module finishes. For the result and error objects each callback returns, see [Results](/sdk-reference/android-results-reference/).

### Resume an Existing Onboarding Session

To resume an existing session after the app was uninstalled and reinstalled mid-flow, call  `setupOnboardingSession` before any other API calls. This resets the configuration that was lost during uninstall.

Create a `SessionConfig` instance with the existing `interviewId`. You can also set the `validationModuleList`:

```kotlin
val validationModuleList = listOf(
    OnboardingValidationModule.id,
    OnboardingValidationModule.faceRecognition,
    OnboardingValidationModule.liveness,
    OnboardingValidationModule.governmentValidation
)

val sessionConfig: SessionConfig = SessionConfig.Builder()
    .setInterviewId(interviewId) // Set interviewId
    .setValidationModuleList(validationModuleList) // Set validationModuleList (optional)
    .build()

IncodeWelcome.getInstance().setupOnboardingSession(sessionConfig, object : OnboardingSessionListener {
    override fun onOnboardingSessionCreated(
        token: String?,
        interviewId: String?,
        region: String
    ) {
        // it's safe to call individual APIs again
    }

    override fun onError(throwable: Throwable) {}
    override fun onUserCancelled() {}
})
```
```java
List<OnboardingValidationModule> validationModuleList = new ArrayList<>();
validationModuleList.add(OnboardingValidationModule.id);
validationModuleList.add(OnboardingValidationModule.faceRecognition);
validationModuleList.add(OnboardingValidationModule.liveness);
validationModuleList.add(OnboardingValidationModule.governmentValidation);

SessionConfig sessionConfig = new SessionConfig.Builder()
        .setInterviewId(interviewId) // Set interviewId
        .setValidationModuleList(validationModuleList) // Set validationModuleList (optional)
        .build();

IncodeWelcome.getInstance().setupOnboardingSession(sessionConfig, new OnboardingSessionListener() {
    @Override
    public void onOnboardingSessionCreated(@Nullable String token, @Nullable String interviewId, @NonNull String region) {
        // it's safe to call individual APIs again
    }
    @Override
    public void onError(@NonNull Throwable throwable) {
    }
    @Override
    public void onUserCancelled() {
    }
});
```

<br />

---

- Path: `sdk-reference/android-curp-validation`
- URL: https://developer.incode.com/sdk-reference/android-curp-validation/
- Markdown: https://developer.incode.com/sdk-reference/android-curp-validation.md

# CURP Validation

The CURP Validation module validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

For an overview of this module and how it works, see [CURP Validation](/features-and-modules/curp-validation/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add CURP Validation

Add the module with `addCurpValidation()`, or pass a configured instance to `addCurpValidation(curpValidation)`.

```kotlin
flowConfigBuilder.addCurpValidation()
```
```java
flowConfigBuilder.addCurpValidation();
```

CURP Validation ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds a `CurpValidation` with validation enabled, adds it to the flow, and listens for the result through `onCurpValidationCompleted()`.

```kotlin
val curpValidation = CurpValidation.Builder()
    .setValidationEnabled(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addCurpValidation(curpValidation)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onCurpValidationCompleted(curpValidationResult: CurpValidationResult) {
        // CURP validation finished. Inspect the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
CurpValidation curpValidation = new CurpValidation.Builder()
    .setValidationEnabled(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addCurpValidation(curpValidation)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onCurpValidationCompleted(@NonNull CurpValidationResult curpValidationResult) {
        // CURP validation finished. Inspect the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Build the module with `CurpValidation.Builder` when you need to set an option. The table below lists the most common option.

| Setting                         | Description                                                                                    |
| ------------------------------- | ---------------------------------------------------------------------------------------------- |
| `setValidationEnabled(boolean)` | Controls whether the entered CURP is validated against the RENAPO service. Defaults to `true`. |

For the complete option set, see `CurpValidation.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

CURP Validation delivers a `CurpValidationResult` to the `onCurpValidationCompleted(CurpValidationResult)` callback on the `OnboardingListener`. Key fields include:

- `curp`: The validated CURP string; `null` when unavailable.
- `isValid`: `true` when the CURP was validated successfully; otherwise, `false`.
- `data`: Additional CURP validation data as key/value pairs. May be empty or `null`.
- `isFinalAttempt`: `true` when this was the last allowed validation attempt.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. There is no CURP-specific exception subtype.

For all fields, see `CurpValidationResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-custom-module`
- URL: https://developer.incode.com/sdk-reference/android-custom-module/
- Markdown: https://developer.incode.com/sdk-reference/android-custom-module.md

# Custom Module

The Custom Module pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues. It does this by handing your app a `callbackName`, then resuming the Workflow at the next node once you report a result. It exists only inside dashboard-defined Workflows, not in locally built flows.

For an overview of this module and how it works, see [Custom Module](/features-and-modules/custom-module/).

Unlike most modules, Custom Module is available only through the Workflows API. You must use [integration Pattern​ 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. It cannot be added to a local `FlowConfig`. You place it in a Workflow in Dashboard, and it surfaces in the SDK through a listener callback rather than a `FlowConfig.Builder` method.

This module is available for SDK 5.42.0 and later.

## Add Custom Module

1. In Dashboard, [add a Custom Module node to your Workflow](/dashboard-platform-administration/custom-module-dashboard/) and set its `callbackName`. This is just a string the SDK delivers to your app. On Android, there is no automatic function invocation. Your app decides how to interpret the value: for example, by mapping it to a method or branching on it.
2. Activate the Workflow and note its ID.
3. In your app, start the session with the Workflows API. Set the Workflow ID with `SessionConfig.Builder.setConfigurationId(workflowId)`, then call `IncodeWelcome.startWorkflow(context, sessionConfig, onboardingListener)`.
4. Handle the module by overriding `onCustomModuleStarted` on your `OnboardingListener`. If you don't override it, the default implementation does nothing, and the Workflow will not advance past the node. Always provide an implementation that calls `onCustomModuleCompleted`.

### Example

The example below starts a session with a Workflow ID, overrides `onCustomModuleStarted` to run custom logic based on `callbackName`, and reports the result with `onCustomModuleCompleted`.

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setConfigurationId(workflowId)
    .build()

val listener = object : IncodeWelcome.OnboardingListener() {
    override fun onCustomModuleStarted(
        callbackName: String,
        onCustomModuleCompleted: (CustomModuleStatus) -> Unit
    ) {
        // Run your custom logic based on callbackName, then report a result.
        val status = runCustomLogic(callbackName)
        onCustomModuleCompleted(status)
    }

    override fun onError(error: Throwable) {
        // Handle errors.
    }
}

IncodeWelcome.getInstance().startWorkflow(activityContext, sessionConfig, listener)
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId(workflowId)
    .build();

IncodeWelcome.OnboardingListener listener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onCustomModuleStarted(
        String callbackName,
        Function1<CustomModuleStatus, Unit> onCustomModuleCompleted
    ) {
        // Run your custom logic based on callbackName, then report a result.
        CustomModuleStatus status = runCustomLogic(callbackName);
        onCustomModuleCompleted.invoke(status);
    }

    @Override
    public void onError(Throwable error) {
        // Handle errors.
    }
};

IncodeWelcome.getInstance().startWorkflow(activityContext, sessionConfig, listener);
```

## Configuration Options

Custom Module has no client-side `Builder` options. Its only setting, the `callbackName`, is configured on the Custom Module node in the Workflow in Dashboard. The SDK delivers that name to your app at runtime.

For the Workflow APIs that drive it, see `IncodeWelcome` and `SessionConfig.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

There is no result payload object. The module signals through the `CustomModuleListener.onCustomModuleStarted(callbackName, onCustomModuleCompleted)` callback on your `OnboardingListener`. You then call `onCustomModuleCompleted` with a `CustomModuleStatus` to report the outcome of your custom logic. Once you report a status, the SDK submits it and advances the Workflow to the next node.

`CustomModuleStatus` is an Enum with the following values:

- `OK`
- `FAIL`
- `WARN`
- `UNKNOWN`

Errors surface via `OnboardingListener.onError(Throwable)`. There is no module-specific exception subtype for Custom Module.

For the full callback and status definitions, see `CustomModuleListener` and `CustomModuleStatus` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-custom-watchlist`
- URL: https://developer.incode.com/sdk-reference/android-custom-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/android-custom-watchlist.md

# Custom Watchlist

The Custom Watchlist module screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It requires no user interaction; a brief progress screen is shown while the check runs. The lists and matching criteria are driven by your Incode configuration.

For an overview of this module and how it works, see [Custom Watchlist](/features-and-modules/custom-watchlist/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Custom Watchlist

Add the module with `addCustomWatchlist()`. If you also use the [Antifraud](/sdk-reference/android-antifraud/) module, call `addAntifraud()` first, then `addCustomWatchlist()`, so Custom Watchlist runs after Antifraud.

```kotlin
flowConfigBuilder.addCustomWatchlist()
```
```java
flowConfigBuilder.addCustomWatchlist();
```

Custom Watchlist ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below adds Custom Watchlist as the only step in the flow and listens for the result through `onCustomWatchlistProcessed()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addCustomWatchlist()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onCustomWatchlistProcessed(customWatchlistResult: CustomWatchlistResult) {
        // Custom watchlist step processed. Inspect the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addCustomWatchlist()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onCustomWatchlistProcessed(@NonNull CustomWatchlistResult customWatchlistResult) {
        // Custom watchlist step processed. Inspect the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Custom Watchlist has no configurable options. It is added with a no-argument builder method. The watchlist sources and matching behavior are controlled by your Incode Flow or Workflow configuration.

For the complete option set, see `CustomWatchlist` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Custom Watchlist delivers a `CustomWatchlistResult` to the `onCustomWatchlistProcessed(CustomWatchlistResult)` callback on your `IncodeWelcome.OnboardingListener`. Key fields include:

- `success`: `true` if the custom watchlist check completed successfully; otherwise, `false`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`. This module does not define a module-specific exception type.

For all fields, see `CustomWatchlistResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-customization`
- URL: https://developer.incode.com/sdk-reference/android-customization/
- Markdown: https://developer.incode.com/sdk-reference/android-customization.md

# Customization

The Incode Android SDK is highly customizable. You can match onboarding flows to your brand and product. This page covers everything you can change, including:

- Theme colors and font
- Buttons and other UI elements
- The V2 header logo
- Runtime theme configuration
- Every customizable string, including dynamic and runtime localization
- Custom logos, supplemental text, and videos
- V2 theme, UX, and themed vector configuration, built with Jetpack Compose

## Get Started

Most integrations only need colors, fonts, and a logo. Consult other sections when you have a specific need.

Most sections cover the classic, View-based screens and shared elements across the SDK. The new V2 modules use Jetpack Compose and a separate JSON or object-based configuration system. See [Configure V2 Theme and UX](#configure-v2-theme-and-ux) for those. Some settings, like fonts and the header logo, exist in both systems. This page documents both.

| Task                                                                   | Section                                                                 |
| ---------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| Recolor the SDK and apply your fonts                                   | [Customize Theme Colors and Fonts](#customize-theme-colors-and-fonts)   |
| Display your logo                                                      | [Add a Custom Logo](#add-a-custom-logo)                                 |
| Display your header logo (V2 only)                                     | [Customize the V2 Header Logo](#customize-the-v2-header-logo)           |
| Change button shape, size, color, and style                            | [Customize Buttons](#customize-buttons)                                 |
| Restyle dialogs, progress bars, camera outlines, and other UI elements | [Customize Other UI Elements](#customize-other-ui-elements)             |
| Swap styles at runtime based on user preference                        | [Configure Runtime Styles](#configure-runtime-styles)                   |
| Change any on-screen text, particularly for translation                | [Localize Display Text](#localize-display-text)                         |
| Add supplemental copy on selfie screens                                | [Add Custom Supplemental Text](#add-custom-supplemental-text)           |
| Replace tutorial and feedback animations                               | [Replace Videos with Custom Videos](#replace-videos-with-custom-videos) |
| Enable the V2 UI                                                       | [Enable V2 UI](#enable-v2-ui)                                           |
| Theme the V2 Compose modules                                           | [Configure V2 Theme and UX](#configure-v2-theme-and-ux)                 |
| Override V2 vector drawables with your own icons or graphics           | [Customize V2 Vector Drawables](#customize-v2-vector-drawables)         |

## Customize Theme Colors and Fonts

You can customize the main theme, background, and text colors. You can also change the fonts.

### Main Theme Colors

Add the following colors to your `colors.xml`:

```xml
<color name="onboard_sdk_colorPrimary">@color/onboard_sdk_brand_accentPrimary</color>
<color name="onboard_sdk_colorPrimaryDark">@color/onboard_sdk_brand_accentSecondary</color>
<color name="onboard_sdk_colorAccent">@color/onboard_sdk_brand_accentPrimary</color>
```

`onboard_sdk_colorPrimaryDark` is currently not used.

These colors signify success, warning, and failure throughout the SDK. By default, they are shades of green, orange, and red. You can customize them by adding the following colors to your `colors.xml`:

```xml
<color name="onboard_sdk_state_destructive">#FF5C6F</color>
<color name="onboard_sdk_state_warn">#F3AB3C</color>
<color name="onboard_sdk_state_success">#0CD5A2</color>
```

The following near-grayscale colors are predefined in the SDK:

```xml
<color name="onboard_sdk_darkest">#000000</color>
<color name="onboard_sdk_darkIndigo">#20263D</color>
<color name="onboard_sdk_indigo">#2F2D51</color>
<color name="onboard_sdk_dark">#636670</color>
<color name="onboard_sdk_darkGray">#979797</color>
<color name="onboard_sdk_gray">#BCBCBC</color>
<color name="onboard_sdk_lightGray">#E9E9EB</color>
<color name="onboard_sdk_offWhite">#F9FAFF</color>
<color name="onboard_sdk_white">#FFFFFF</color>
```

### Background Colors

To change background colors in the SDK, add the following items to your `styles.xml`:

```xml
<item name="onboard_sdk_BackgroundLight" type="color">@color/onboard_sdk_lightGray</item>
<item name="onboard_sdk_BackgroundDark" type="color">@color/onboard_sdk_darkIndigo</item>
<item name="onboard_sdk_BackgroundWindow" type="color">@color/onboard_sdk_white</item>
<item name="onboard_sdk_BackgroundWindow_Selfie" type="color">@color/onboard_sdk_white</item>
```

The window background is white by default on the [Selfie Scan](/sdk-reference/android-selfie-scan/) screen. This helps when taking a selfie in low-light conditions.

### Text Colors

The SDK has five text colors. To change them, add the following items to your `styles.xml`:

```xml
<item name="onboard_sdk_TextColorDefault" type="color">@color/onboard_sdk_darkIndigo</item>
<item name="onboard_sdk_TextColorLabel" type="color">@color/onboard_sdk_dark</item>
<item name="onboard_sdk_TextColorPlaceholder" type="color">@color/onboard_sdk_gray</item>
<item name="onboard_sdk_TextColorDisabled" type="color">@color/onboard_sdk_lightGray</item>
<item name="onboard_sdk_TextColorInverted" type="color">@color/onboard_sdk_white</item>
```

### Fonts

To change the fonts in the SDK, add the following items to your `styles.xml`:

```xml
<item name="onboard_sdk_FontFamilyBold" type="font">@font/your_custom_font_bold</item>
<item name="onboard_sdk_FontFamilyRegular" type="font">@font/your_custom_font_regular</item>

<item name="onboard_sdk_FontFamilyBold_v2" type="font">@font/your_custom_font_bold</item>
<item name="onboard_sdk_FontFamilyMedium_v2" type="font">@font/your_custom_font_medium</item>
<item name="onboard_sdk_FontFamilyRegular_v2" type="font">@font/your_custom_font_regular</item>
```

## Add a Custom Logo

You can show a custom logo at the top of supported screens. The default logo resource is a 1x1 px transparent image. To use a custom logo, override the default image by adding an image resource to your `res/drawable-???` folders. For best results, use an image about 100 x 25px.

The image resource needs to have the following name:

```
onboard_sdk_logo_top
```

To change this logo programmatically, update the `ThemeConfiguration`:

```kotlin
ThemeConfiguration.Builder().setLogo(@DrawableRes Int)
```
```java
ThemeConfiguration.Builder().setLogo(@DrawableRes int);
```

This method changes the logo on V1 screens and, from version 5.55.0, on V2 screens. On V1 screens, this method requires the `extensions` [dependency](/sdk-reference/android-installation/#declare-dependencies). Without this dependency, V1 screens show the default logo. V2 screens do not need this dependency.

The Selfie Scan and Video Selfie modules let you show a custom logo just for their own screens.

To add a custom logo at build time, override the following image resources:

```
Selfie: onboard_sdk_selfie_logo_top
VideoSelfie: onboard_sdk_video_selfie_logo_top
```

To add a custom logo at runtime, use the following `Builder` methods:

```kotlin
SelfieScan.Builder().setLogo(@DrawableRes Int)
VideoSelfie.Builder().setLogo(@DrawableRes Int)
```
```java
SelfieScan.Builder().setLogo(@DrawableRes int);
VideoSelfie.Builder().setLogo(@DrawableRes int);
```

:::note
On V2 screens, a logo that you set with a `setLogo()` method must be a vector drawable or a raster image (PNG, JPG, or WebP). V2 screens do not support other XML drawables, for example `layer-list`, `selector`, or `shape`. V1 screens support all drawable types.
:::

:::info


  If you inject a custom logo in more than one way, the SDK applies this precedence for supported screens:

  - A module-specific custom logo resource provided at runtime through one of the `setLogo()` methods.
  - A module-specific custom logo resource provided at build time.
  - An override of the generic logo resource, `onboard_sdk_logo_top`, provided at runtime.
  - An override of the generic logo resource, `onboard_sdk_logo_top`, provided at build time.
:::

## Customize the V2 Header Logo

You can change the V2 header logo in two ways:

- At runtime, use `ThemeConfiguration.Builder().setLogo()`. Refer to [Add a Custom Logo](#add-a-custom-logo).
- At build time, override the `onboard_sdk_logo_header.xml` drawable file in your `drawable` folder.

:::info
If you set a logo in more than one way, the V2 screens use this order:

1. A module logo that you set with `SelfieScan.Builder().setLogo()` or `VideoSelfie.Builder().setLogo()`. This logo shows on the capture screens of that module.
2. The logo that you set with `ThemeConfiguration.Builder().setLogo()`.
3. The `onboard_sdk_logo_header` drawable.
:::

### Dark Mode Support

To provide a different logo for dark mode, place a night-qualified variant in your `drawable-night` folder:

- `drawable/onboard_sdk_logo_header.xml`: used in light mode
- `drawable-night/onboard_sdk_logo_header.xml`: used in dark mode

The SDK automatically resolves the correct variant based on the active display mode. If you don't provide a `drawable-night` variant, the SDK uses the light mode drawable for both modes.

The same rule applies to a drawable that you give to `setLogo()`.

### Logo Size Guidelines

- Maximum height is 36dp, in Android density-independent pixels. Width is flexible.
- Logos taller than 36dp are automatically resized to a height of 36dp, keeping their aspect ratio.
- Logos shorter than 36dp display at their original size.

## Customize Buttons

You can customize buttons at three levels:

- [Individual attributes](#basic-button-customization), for quick changes
- [Full per-style overrides](#advanced-button-customization), for advanced changes
- The [selfie manual shutter button](#selfie-manual-shutter-button-customization), using a drawable swap

### Basic Button Customization

Customize individual attributes of the default buttons.

To customize the corner radius of the buttons in the SDK, override the following dimension in your `dimens.xml`:

```xml
<dimen name="onboard_sdk_btn_rounded_radius">32dp</dimen>
```

To change the size of the buttons, override the following dimension in your `dimens.xml`. The suggested value for full-width buttons is 20dp.

```xml
<dimen name="onboard_sdk_btn_margins">80dp</dimen>
```

To change the colors of the buttons, override the following colors in your `colors.xml`:

```xml
<!-- Button Primary -->
<color name="onboard_sdk_btn_primary_background_color">@color/onboard_sdk_colorPrimary</color>
<color name="onboard_sdk_btn_primary_border_color">@color/onboard_sdk_colorPrimary</color>

<!-- Button Primary Pressed -->
<color name="onboard_sdk_btn_primary_background_color_pressed">@color/onboard_sdk_darkIndigo</color>
<color name="onboard_sdk_btn_primary_border_color_pressed">@color/onboard_sdk_darkIndigo</color>

<!-- Button Primary Disabled -->
<color name="onboard_sdk_btn_primary_background_color_disabled">@color/onboard_sdk_IconColorDisabled</color>
<color name="onboard_sdk_btn_primary_border_color_disabled">@color/onboard_sdk_IconColorDisabled</color>

<!-- Button Secondary -->
<color name="onboard_sdk_btn_secondary_background_color">@color/onboard_sdk_white</color>
<color name="onboard_sdk_btn_secondary_border_color">@color/onboard_sdk_darkIndigo</color>

<!-- Button Secondary Pressed -->
<color name="onboard_sdk_btn_secondary_background_color_pressed">@color/onboard_sdk_darkIndigo</color>
<color name="onboard_sdk_btn_secondary_border_color_pressed">@color/onboard_sdk_darkIndigo</color>

<!-- Button Secondary Disabled -->
<color name="onboard_sdk_btn_secondary_background_color_disabled">@color/onboard_sdk_white</color>
<color name="onboard_sdk_btn_secondary_border_color_disabled">@color/onboard_sdk_IconColorDisabled</color>

<!-- Id Validation capture feedback background -->
<color name="onboard_sdk_id_capture_feedback_background_color">@color/onboard_sdk_black</color>
```

To customize the appearance of the checkboxes, override the following drawable files in your `drawable` folder:

- `onboard_sdk_checkbox_empty.xml`
- `onboard_sdk_checkbox_selected.xml`
- `onboard_sdk_checkbox2_empty.xml`
- `onboard_sdk_checkbox2_selected.xml`

You can also customize other properties. Add these to your `styles.xml` to override them:

```xml
<item name="onboard_sdk_ButtonPrimary_FontFamily" type="font">@font/onboard_sdk_FontFamilyBold</item>
<item name="onboard_sdk_ButtonPrimary_TextColor" type="color">@color/onboard_sdk_text_colors_button_primary</item>
<item name="onboard_sdk_ButtonPrimary_Background" type="drawable">@drawable/onboard_sdk_btn_primary</item>
<item name="onboard_sdk_ButtonPrimary_MaxLines" type="integer">1</item>
<item name="onboard_sdk_ButtonPrimary_BorderWidth" type="dimen">1dp</item>

<item name="onboard_sdk_ButtonSecondary_FontFamily" type="font">@font/onboard_sdk_FontFamilyBold</item>
<item name="onboard_sdk_ButtonSecondary_TextColor" type="color">@color/onboard_sdk_text_colors_button_secondary</item>
<item name="onboard_sdk_ButtonSecondary_Background" type="drawable">@drawable/onboard_sdk_btn_secondary</item>
<item name="onboard_sdk_ButtonSecondary_MaxLines" type="integer">1</item>
<item name="onboard_sdk_ButtonSecondary_BorderWidth" type="dimen">1dp</item>

<item name="onboard_sdk_ButtonText_FontFamily" type="font">@font/onboard_sdk_FontFamilyBold</item>
<item name="onboard_sdk_ButtonText_TextColor" type="color">@color/onboard_sdk_text_colors_button_text</item>
<item name="onboard_sdk_ButtonText_Background" type="drawable">@android:color/transparent</item>
<item name="onboard_sdk_ButtonText_MaxLines" type="integer">1</item>

<item name="onboard_sdk_ButtonBig_TextSize" type="dimen">20sp</item>
<item name="onboard_sdk_ButtonBig_PaddingStart" type="dimen">80sp</item>
<item name="onboard_sdk_ButtonBig_PaddingEnd" type="dimen">80sp</item>
<item name="onboard_sdk_ButtonBig_PaddingTop" type="dimen">20sp</item>
<item name="onboard_sdk_ButtonBig_PaddingBottom" type="dimen">20sp</item>
<item name="onboard_sdk_ButtonBig_TextAllCaps" type="bool">false</item>

<item name="onboard_sdk_ButtonMedium_TextSize" type="dimen">16sp</item>
<item name="onboard_sdk_ButtonMedium_PaddingStart" type="dimen">48sp</item>
<item name="onboard_sdk_ButtonMedium_PaddingEnd" type="dimen">48sp</item>
<item name="onboard_sdk_ButtonMedium_PaddingTop" type="dimen">12sp</item>
<item name="onboard_sdk_ButtonMedium_PaddingBottom" type="dimen">12sp</item>
<item name="onboard_sdk_ButtonMedium_TextAllCaps" type="bool">true</item>

<item name="onboard_sdk_ButtonSmall_TextSize" type="dimen">12sp</item>
<item name="onboard_sdk_ButtonSmall_PaddingStart" type="dimen">14sp</item>
<item name="onboard_sdk_ButtonSmall_PaddingEnd" type="dimen">14sp</item>
<item name="onboard_sdk_ButtonSmall_PaddingTop" type="dimen">12sp</item>
<item name="onboard_sdk_ButtonSmall_PaddingBottom" type="dimen">12sp</item>
<item name="onboard_sdk_ButtonSmall_TextAllCaps" type="bool">true</item>

<item name="onboard_sdk_IncodeSnackbar_Background_Color" type="color">@color/onboard_sdk_state_destructive</item>
<item name="onboard_sdk_IncodeSnackbar_Content_TextColor" type="color">@color/onboard_sdk_white</item>
<item name="onboard_sdk_IncodeSnackbar_Content_TextSize" type="dimen">14sp</item>
<item name="onboard_sdk_IncodeSnackbar_Content_FontFamily" type="font">@font/onboard_sdk_FontFamilyRegular</item>
<item name="onboard_sdk_IncodeSnackbar_Content_FontWeight" type="integer">700</item>
<item name="onboard_sdk_IncodeSnackbar_Action_TextColor" type="color">@color/onboard_sdk_white</item>
<item name="onboard_sdk_IncodeSnackbar_Action_TextSize" type="dimen">20sp</item>
<item name="onboard_sdk_IncodeSnackbar_Action_FontFamily" type="font">@font/onboard_sdk_FontFamilyRegular</item>
<item name="onboard_sdk_IncodeSnackbar_Action_FontWeight" type="integer">700</item>
```

### Advanced Button Customization

To fully customize buttons, specify your own styles in `styles.xml`. There are three button types: `Primary`, `Secondary`, and `Text`. Each type has three variants: `Big`, `Medium`, and `Small`. You can customize common styles, such as `onboard_sdk_ButtonPrimary`, `onboard_sdk_ButtonSecondary`, and `onboard_sdk_ButtonText`. You can also customize individual variants, such as `onboard_sdk_ButtonPrimaryBig`. By default, medium and small variants use `textAllCaps = true`.

```xml
<style name="onboard_sdk_ButtonPrimary" parent="onboard_sdk_BaseButtonPrimary">
    <item name="android:background">@drawable/my_custom_background_drawable</item>
    ...
</style>

<style name="onboard_sdk_ButtonPrimaryBig" parent="onboard_sdk_BaseButtonPrimaryBig">
    <item name="layout_constraintWidth_min">200dp</item>
    ...
</style>

<style name="onboard_sdk_ButtonPrimaryMedium" parent="onboard_sdk_BaseButtonPrimaryMedium">...</style>

<style name="onboard_sdk_ButtonPrimarySmall" parent="onboard_sdk_BaseButtonPrimarySmall">...</style>

<style name="onboard_sdk_ButtonSecondary" parent="onboard_sdk_BaseButtonSecondary">...</style>

<style name="onboard_sdk_ButtonSecondaryBig" parent="onboard_sdk_BaseButtonSecondaryBig">...</style>

<style name="onboard_sdk_ButtonSecondaryMedium" parent="onboard_sdk_BaseButtonSecondaryMedium">...</style>

<style name="onboard_sdk_ButtonSecondarySmall" parent="onboard_sdk_BaseButtonSecondarySmall">...</style>

<style name="onboard_sdk_ButtonText" parent="onboard_sdk_BaseButtonText">...</style>

<style name="onboard_sdk_ButtonTextBig" parent="onboard_sdk_BaseButtonTextBig">...</style>

<style name="onboard_sdk_ButtonTextMedium" parent="onboard_sdk_BaseButtonTextMedium">...</style>

<style name="onboard_sdk_ButtonTextSmall" parent="onboard_sdk_BaseButtonTextSmall">...</style>

<style name="onboard_sdk_ButtonPrimaryV2" parent="onboard_sdk_BaseButtonPrimary"></style>

<style name="onboard_sdk_ButtonPrimaryMediumV2" parent="onboard_sdk_BaseButtonPrimaryMediumV2"></style>

<style name="onboard_sdk_ButtonPrimaryBigV2" parent="onboard_sdk_BaseButtonPrimaryBigV2"></style>
```

### Selfie Manual Shutter Button Customization

To customize the appearance of the manual shutter button in the [Selfie Scan](/sdk-reference/android-selfie-scan/) module, override the following drawable files in your `res/drawable` folder:

- `onboard_sdk_selfie_btn_shutter_background.xml`
- `onboard_sdk_selfie_btn_shutter_icon.xml`

## Customize Other UI Elements

Colors, fonts, and button customization cover most use cases. If you need control over additional elements, use the overrides below.

### Exit Dialog

To change the color of exit dialog buttons and texts, override the following colors:

```xml
<!-- Update the color of all exit dialog texts -->
<item name="onboard_sdk_ExitDialog_TextColor" type="color">@color/onboard_sdk_black</item>

<!-- Update each color individually -->
<item name="onboard_sdk_ExitDialog_TextColor_Title" type="color">@color/onboard_sdk_ExitDialog_TextColor</item>
<item name="onboard_sdk_ExitDialog_TextColor_Description" type="color">@color/onboard_sdk_ExitDialog_TextColor</item>
<item name="onboard_sdk_ExitDialog_TextColor_PositiveButton" type="color">@color/onboard_sdk_ExitDialog_TextColor</item>
<item name="onboard_sdk_ExitDialog_TextColor_NegativeButton" type="color">@color/onboard_sdk_ExitDialog_TextColor</item>
```

To change the exit dialog color and font of the positive and negative buttons, override the following styles:

```xml
<!-- Postive Button -->
<style name="onboard_sdk_ExitDialog_PositiveButton" parent="onboard_sdk_BaseExitDialog_PositiveButton">
    <item name="android:fontFamily">@font/onboard_sdk_FontFamilyRegular</item>
    <item name="android:textColor">@color/onboard_sdk_ExitDialog_TextColor_PositiveButton</item>
</style>

<!-- Negative Button -->
<style name="onboard_sdk_ExitDialog_NegativeButton" parent="onboard_sdk_BaseExitDialog_NegativeButton">
    <item name="android:fontFamily">@font/onboard_sdk_FontFamilyRegular</item>
    <item name="android:textColor">@color/onboard_sdk_ExitDialog_TextColor_NegativeButton</item>
</style>
```

To customize the exit dialog itself, override the following style:

```xml
<style name="onboard_sdk_ExitDialog" parent="onboard_sdk_BaseExitDialog">
    <!-- Exit Dialog Font -->
    <item name="android:fontFamily">@font/onboard_sdk_FontFamilyRegular</item>
    <!-- Exit Dialog Title text color -->
    <item name="android:textColor">@color/onboard_sdk_ExitDialog_TextColor_Title</item>
    <!-- Exit Dialog Description text color -->
    <item name="android:textColorPrimary">@color/onboard_sdk_ExitDialog_TextColor_Description</item>
    <!-- Exit Dialog Positive Button style -->
    <item name="buttonBarPositiveButtonStyle">@style/onboard_sdk_ExitDialog_PositiveButton</item>
    <!-- Exit Dialog Negative Button style -->
    <item name="buttonBarNegativeButtonStyle">@style/onboard_sdk_ExitDialog_NegativeButton</item>
</style>
```

### Selfie Camera Outline

To change the color of the camera outline on the [Selfie Scan](/sdk-reference/android-selfie-scan/) screen, override the following color:

```xml
<item name="onboard_sdk_SelfieCircleCameraOutline" type="color">@android:color/black</item>
```

### Upload Progress Bar

To change the style of the progress bar shown while uploading documents, override these items in your `styles.xml`:

```xml
<item name="onboard_sdk_ProgressBar_Height" type="dimen">6dp</item>
<item name="onboard_sdk_ProgressBar_ProgressDrawable" type="drawable">@drawable/onboard_sdk_progress_bar_round</item>
```

By default, the progress bar uses the `onboard_sdk_BackgroundLight` and `onboard_sdk_colorPrimary` colors.

### Capture Failed: Common Issues Items

To change the background for each item on the Capture Failed > Common Issues screen, override the following drawable:

```xml
@drawable/onboard_sdk_background_capture_error_item
```

Or simply override the color:

```xml
<item name="onboard_sdk_Background_CaptureErrorItem" type="color">@color/onboard_sdk_lightGray</item>
```

### Countdown Animation: ID and Passport Scan

To change the background and text color of the countdown animation on the [ID Scan](/sdk-reference/android-id-scan/) screen, override the following colors:

```xml
<item name="onboard_sdk_CountdownAnimation_BackgroundColor" type="color">@color/onboard_sdk_brand_accentPrimary</item>
<item name="onboard_sdk_CountdownAnimation_TextColor" type="color">@color/onboard_sdk_white</item>
```

### Video Selfie Waveform

To change the color of the waveform on the [Video Selfie](/sdk-reference/android-video-selfie/) screen, override the following color:

```xml
<item name="onboard_sdk_Waveform" type="color">@color/onboard_sdk_white</item>
```

### Complete List of Customizable UI Element Styles

<Accordion title="View complete list of customizable styles">
  Override these styles in your `styles.xml`:

  ```xml
  <style name="onboard_sdk_Headline1" parent="onboard_sdk_BaseHeadline1">...</style>

  <style name="onboard_sdk_Headline2" parent="onboard_sdk_BaseHeadline2">...</style>

  <style name="onboard_sdk_Headline3" parent="onboard_sdk_BaseHeadline3">...</style>

  <style name="onboard_sdk_Headline4" parent="onboard_sdk_BaseHeadline4">...</style>

  <style name="onboard_sdk_InputSpecial" parent="onboard_sdk_BaseInputSpecial">...</style>

  <style name="onboard_sdk_InputBig" parent="onboard_sdk_BaseInputBig">...</style>

  <style name="onboard_sdk_InputSmall" parent="onboard_sdk_BaseInputSmall">...</style>

  <style name="onboard_sdk_InputEditText" parent="onboard_sdk_BaseInputEditText">...</style>

  <style name="onboard_sdk_InputEditTextError" parent="onboard_sdk_BaseInputEditTextError">...</style>

  <style name="onboard_sdk_InputSpinner" parent="onboard_sdk_BaseInputSpinner">...</style>

  <style name="onboard_sdk_BodyBig" parent="onboard_sdk_BaseBodyBig">...</style>

  <style name="onboard_sdk_BodyLead" parent="onboard_sdk_BaseBodyLead">...</style>

  <style name="onboard_sdk_BodyQuote" parent="onboard_sdk_BaseBodyQuote">...</style>

  <style name="onboard_sdk_BodyLongText" parent="onboard_sdk_BaseBodyLongText">...</style>

  <style name="onboard_sdk_LabelBig" parent="onboard_sdk_BaseLabelBig">...</style>

  <style name="onboard_sdk_LabelSmall" parent="onboard_sdk_BaseLabelSmall">...</style>

  <style name="onboard_sdk_ButtonPrimary" parent="onboard_sdk_BaseButtonPrimary">...</style>

  <style name="onboard_sdk_ButtonPrimaryBig" parent="onboard_sdk_BaseButtonPrimaryBig">...</style>

  <style name="onboard_sdk_ButtonPrimaryMedium" parent="onboard_sdk_BaseButtonPrimaryMedium">...</style>

  <style name="onboard_sdk_ButtonPrimarySmall" parent="onboard_sdk_BaseButtonPrimarySmall">...</style>

  <style name="onboard_sdk_ButtonSecondary" parent="onboard_sdk_BaseButtonSecondary">...</style>

  <style name="onboard_sdk_ButtonSecondaryBig" parent="onboard_sdk_BaseButtonSecondaryBig">...</style>

  <style name="onboard_sdk_ButtonSecondaryMedium" parent="onboard_sdk_BaseButtonSecondaryMedium">...</style>

  <style name="onboard_sdk_ButtonSecondarySmall" parent="onboard_sdk_BaseButtonSecondarySmall">...</style>

  <style name="onboard_sdk_ButtonText" parent="onboard_sdk_BaseButtonText">...</style>

  <style name="onboard_sdk_ButtonTextBig" parent="onboard_sdk_BaseButtonTextBig">...</style>

  <style name="onboard_sdk_ButtonTextMedium" parent="onboard_sdk_BaseButtonTextMedium">...</style>

  <style name="onboard_sdk_ButtonTextSmall" parent="onboard_sdk_BaseButtonTextSmall">...</style>

  <style name="onboard_sdk_ProgressBar" parent="onboard_sdk_BaseProgressBar">...</style>

  <style name="onboard_sdk_ProgressBarIndeterminate" parent="onboard_sdk_BaseProgressBarIndeterminate">...</style>

  <style name="onboard_sdk_Divider" parent="onboard_sdk_BaseDivider">...</style>

  <style name="onboard_sdk_BottomSheetItem" parent="onboard_sdk_BaseBottomSheetItem">...</style>

  <style name="onboard_sdk_ScanFeedbackTextSmall" parent="onboard_sdk_BaseScanFeedbackTextSmall">...</style>

  <style name="onboard_sdk_ScanFeedbackTextMedium" parent="onboard_sdk_BaseScanFeedbackTextMedium"/>

  <style name="onboard_sdk_ScanFeedbackTextBig" parent="onboard_sdk_BaseScanFeedbackTextBig">...</style>

  <style name="onboard_sdk_ManualCaptureInstructionsText" parent="onboard_sdk_BaseManualCaptureInstructionsText">...</style>

  <style name="onboard_sdk_ExitDialog_PositiveButton" parent="onboard_sdk_BaseExitDialog_PositiveButton">...</style>

  <style name="onboard_sdk_ExitDialog_NegativeButton" parent="onboard_sdk_BaseExitDialog_NegativeButton">...</style>

  <style name="onboard_sdk_ExitDialog" parent="onboard_sdk_BaseExitDialog">...</style>

  <style name="onboard_sdk_CountdownAnimationBackground" parent="onboard_sdk_BaseCountdownAnimationBackground">...</style>

  <style name="onboard_sdk_CountdownAnimationText" parent="onboard_sdk_BaseCountdownAnimationText">...</style>

  <style name="onboard_sdk_IncodeSnackbar_Content" parent="onboard_sdk_IncodeSnackbar_BaseContent">...</style>

  <style name="onboard_sdk_IncodeSnackbar_Action" parent="onboard_sdk_IncodeSnackbar_BaseAction">...</style>

  <style name="onboard_sdk_IncodeSnackbar_Background" parent="onboard_sdk_IncodeSnackbar_BaseBackground">...</style>
  ```
</Accordion>

Some UI elements have their own styles inherited from these general styles. They can also be customized individually:

```xml
<!-- Need Help Button (inherits from onboard_sdk_ButtonSecondarySmall) -->
<style name="onboard_sdk_ButtonNeedHelp" parent="onboard_sdk_BaseButtonNeedHelp"></style>

<!-- Need Help Manual Capture Button (inherits from onboard_sdk_ButtonTextSmall) -->
<style name="onboard_sdk_ButtonNeedHelpManualCapture" parent="onboard_sdk_BaseButtonNeedHelpManualCapture"></style>

<!-- Manual Capture Instructions Text (inherits from onboard_sdk_LabelBig) -->
<style name="onboard_sdk_ManualCaptureInstructionsText" parent="onboard_sdk_BaseManualCaptureInstructionsText"></style>
```

## Configure Runtime Styles

You can dynamically load styles in the SDK. Do this when you have multiple styles for a single view, such as a button, and want to switch between them based on your users' preferences.

1. Ensure you've [declared](/sdk-reference/android-installation/#declare-dependencies) the `extensions` dependency in your `[module]/build.gradle`.
2. Create your theme:
   ```xml
   <style name="CustomTheme" parent="Theme.AppCompat.Light.NoActionBar">
       <item name="colorPrimary">#00B2FD</item>
       <item name="colorPrimaryDark">#2266D8</item>
       <item name="colorAccent">#00B2FD</item>
       <item name="android:textColor">#20263D</item>
       <item name="android:windowBackground">#FFFFFF</item>
       <item name="android:windowTranslucentStatus">true</item>
       <item name="android:windowContentTransitions">true</item>
   </style>
   ```
3. Create a `ThemeConfiguration` and set it through `CommonConfig`.
   ```kotlin
   val themeConfiguration: ThemeConfiguration = ThemeConfiguration.Builder()
       .setCustomTheme(R.style.CustomTheme)
       .build()

   val commonConfig: CommonConfig = CommonConfig.Builder()
       .setThemeConfiguration(themeConfiguration)
       .build()

   IncodeWelcome.getInstance().setCommonConfig(commonConfig)
   ```
   ```java
   ThemeConfiguration themeConfiguration = new ThemeConfiguration.Builder()
       .setCustomTheme(R.style.CustomTheme)
       .build();

   CommonConfig commonConfig = new CommonConfig.Builder()
       .setThemeConfiguration(themeConfiguration)
       .build();

   IncodeWelcome.getInstance().setCommonConfig(commonConfig);
   ```
4. Create your own styles in XML:
   ```xml
   <style name="Headline1">
       <item name="android:fontFamily">@font/onboard_sdk_FontFamilyBold</item>
       <item name="android:textColor">#2266D8</item>
       <item name="android:textSize">32sp</item>
       <item name="android:maxLines">2</item>
       <item name="android:lineSpacingExtra">0sp</item>
       <item name="android:gravity">center_horizontal</item>
       <item name="autoSizeTextType">uniform</item>
       <item name="autoSizeMinTextSize">10sp</item>
   </style>

   <style name="Headline2">
       <item name="android:fontFamily">@font/onboard_sdk_FontFamilyBold</item>
       <item name="android:textColor">#2266D8</item>
       <item name="android:textSize">26sp</item>
       <item name="android:maxLines">2</item>
       <item name="android:lineSpacingExtra">0sp</item>
       <item name="android:gravity">center_horizontal</item>
       <item name="autoSizeTextType">uniform</item>
       <item name="autoSizeMinTextSize">10sp</item>
   </style>
   ```
   Or extend the SDK styles:
   ```xml
   <style name="Headline1" parent="onboard_sdk_Headline1">
       <item name="android:fontFamily">@font/onboard_sdk_FontFamilyBold</item>
       <item name="android:textColor">#2266D8</item>
       <item name="android:textSize">32sp</item>
       <item name="android:maxLines">2</item>
   </style>
   ```
5. `ThemeConfiguration` offers methods for applying your own style to each view type, such as `Headline1` and `LabelBig`. Use any of the following methods to override the default styles:

<Accordion title="View all available methods">
  ```kotlin
  val themeConfiguration: ThemeConfiguration = ThemeConfiguration.Builder()
      .setHeadline1Style(R.style.Headline1)
      .setHeadline2Style(R.style.Headline2)
      .setHeadline3Style(R.style.Headline3)
      .setHeadline4Style(R.style.Headline4)
      .setBodyBigStyle(R.style.BodyBig)
      .setBodyLeadStyle(R.style.BodyLead)
      .setBodyQuoteStyle(R.style.BodyQuote)
      .setBodyLongTextStyle(R.style.BodyLongText)
      .setLabelBigStyle(R.style.LabelBig)
      .setLabelSmallStyle(R.style.LabelSmall)
      .setBottomSheetItemStyle(R.style.BottomSheetItem)
      .setScanFeedbackTextBigStyle(R.style.ScanFeedbackTextBig)
      .setScanFeedbackTextSmallStyle(R.style.ScanFeedbackTextSmall)
      .setManualCaptureInstructionsTextStyle(R.style.ManualCaptureInstructionsText)
      .setFaceMatchProgressTextBigStyle(R.style.FaceMatchProgressTextBig)
      .setFaceMatchProgressTextMediumStyle(R.style.FaceMatchProgressTextMedium)
      .setInputSpecialStyle(R.style.InputSpecial)
      .setInputBigStyle(R.style.InputBig)
      .setInputSmallStyle(R.style.InputSmall)
      .setInputEditTextStyle(R.style.Input)
      .setInputEditTextErrorStyle(R.style.InputError)
      .setInputSpinnerStyle(R.style.InputSpinner)
      .setSpinnerStyle(R.style.Spinner)
      .setButtonPrimaryBigStyle(R.style.ButtonBig)
      .setButtonPrimaryBigAltStyle(R.style.ButtonBigAlt)
      .setButtonPrimaryMediumStyle(R.style.ButtonMedium)
      .setButtonPrimarySmallStyle(R.style.ButtonSmall)
      .setButtonSecondaryBigStyle(R.style.ButtonSecondaryBig)
      .setButtonSecondaryMediumStyle(R.style.ButtonSecondaryMedium)
      .setButtonSecondarySmallStyle(R.style.ButtonSecondarySmall)
      .setButtonTextBigStyle(R.style.ButtonTextBig)
      .setButtonTextMediumStyle(R.style.ButtonTextMedium)
      .setButtonTextSmallStyle(R.style.ButtonTextSmall)
      .setButtonNeedHelpManualCaptureStyle(R.style.ButtonNeedHelpManualCapture)
      .setDividerStyle(R.style.DividerStyle)
      .setCountdownAnimationBackgroundStyle(R.style.CountdownAnimationBackground)
      .setCountdownAnimationTextStyle(R.style.CountdownAnimationText)
      .build()

  val commonConfig: CommonConfig = CommonConfig.Builder()
      .setThemeConfiguration(themeConfiguration)
      .build()

  IncodeWelcome.getInstance().setCommonConfig(commonConfig)
  ```

  ```java
  ThemeConfiguration themeConfiguration = new ThemeConfiguration.Builder()
      .setHeadline1Style(R.style.Headline1)
      .setHeadline2Style(R.style.Headline2)
      .setHeadline3Style(R.style.Headline3)
      .setHeadline4Style(R.style.Headline4)
      .setBodyBigStyle(R.style.BodyBig)
      .setBodyLeadStyle(R.style.BodyLead)
      .setBodyQuoteStyle(R.style.BodyQuote)
      .setBodyLongTextStyle(R.style.BodyLongText)
      .setLabelBigStyle(R.style.LabelBig)
      .setLabelSmallStyle(R.style.LabelSmall)
      .setBottomSheetItemStyle(R.style.BottomSheetItem)
      .setScanFeedbackTextBigStyle(R.style.ScanFeedbackTextBig)
      .setScanFeedbackTextSmallStyle(R.style.ScanFeedbackTextSmall)
      .setManualCaptureInstructionsTextStyle(R.style.ManualCaptureInstructionsText)
      .setFaceMatchProgressTextBigStyle(R.style.FaceMatchProgressTextBig)
      .setFaceMatchProgressTextMediumStyle(R.style.FaceMatchProgressTextMedium)
      .setInputSpecialStyle(R.style.InputSpecial)
      .setInputBigStyle(R.style.InputBig)
      .setInputSmallStyle(R.style.InputSmall)
      .setInputEditTextStyle(R.style.Input)
      .setInputEditTextErrorStyle(R.style.InputError)
      .setInputSpinnerStyle(R.style.InputSpinner)
      .setSpinnerStyle(R.style.Spinner)
      .setButtonPrimaryBigStyle(R.style.ButtonBig)
      .setButtonPrimaryBigAltStyle(R.style.ButtonBigAlt)
      .setButtonPrimaryMediumStyle(R.style.ButtonMedium)
      .setButtonPrimarySmallStyle(R.style.ButtonSmall)
      .setButtonSecondaryBigStyle(R.style.ButtonSecondaryBig)
      .setButtonSecondaryMediumStyle(R.style.ButtonSecondaryMedium)
      .setButtonSecondarySmallStyle(R.style.ButtonSecondarySmall)
      .setButtonTextBigStyle(R.style.ButtonTextBig)
      .setButtonTextMediumStyle(R.style.ButtonTextMedium)
      .setButtonTextSmallStyle(R.style.ButtonTextSmall)
      .setButtonNeedHelpManualCaptureStyle(R.style.ButtonNeedHelpManualCapture)
      .setDividerStyle(R.style.DividerStyle)
      .setCountdownAnimationBackgroundStyle(R.style.CountdownAnimationBackground)
      .setCountdownAnimationTextStyle(R.style.CountdownAnimationText)
      .build();

  CommonConfig commonConfig = new CommonConfig.Builder()
      .setThemeConfiguration(themeConfiguration)
      .build();

  IncodeWelcome.getInstance().setCommonConfig(commonConfig);
  ```
</Accordion>

## Localize Display Text

There are three ways to change the text the SDK displays:

- [Override](#override-stringsxml) `strings.xml` at build time
- Replace strings programmatically with [dynamic localization](#dynamic-localization)
- [Switch](#runtime-localization) the SDK language at runtime

The SDK ships default text for four locales: English, Spanish, Portuguese, and German (`en`, `es`, `pt`, `de`).

### Override strings.xml

To change specific text shown to the user throughout the flow, add the strings you want to customize to your app's `strings.xml`. If your app supports multiple languages, add translations to the matching `strings.xml` files too.

Use the string key names from the catalog below. For example, to change the intro screen title:

```xml
<string name="onboard_sdk_intro_title">For this process you will need:</string>
```

### Dynamic Localization

You can override the SDK's text programmatically using dynamic localization. This requires the `extensions` [dependency](/sdk-reference/android-installation/#declare-dependencies).

Call `IncodeWelcome.getInstance().setStrings()` to update the SDK's texts and labels:

```kotlin
val textToLocalize: java.util.HashMap<String, CharSequence> = HashMap()

// Use any string key from resources
textToLocalize["onboard_sdk_enter_phone_number"] = "My Label"
textToLocalize["onboard_sdk_intro_title"] = "My Title"

IncodeWelcome.getInstance().setStrings(Locale("en"), textToLocalize)
```

```java
IncodeWelcome.getInstance().setStrings(new Locale("en"), new HashMap<String, String>() {
    {
        // Use any string key from resources
        put("onboard_sdk_enter_phone_number", "My Label");
        put("onboard_sdk_intro_title", "My Title");
    }
});
```

String arrays and quantity strings can also be updated with these APIs:

```kotlin
IncodeWelcome.getInstance().setStringArray(Locale?, Map<String, Array<CharSequence>>?)
IncodeWelcome.getInstance().setQuantityStrings(Locale?, Map<String, Map<QuantityKeyword, CharSequence>?>?)
```

```java
IncodeWelcome.getInstance().setStringArray(Locale, Map<String, Array<CharSequence>>);
IncodeWelcome.getInstance().setQuantityStrings(Locale, Map<String, Map<QuantityKeyword, CharSequence>>);
```

### Runtime Localization

You can change the SDK language at runtime. This requires the `extensions` [dependency](/sdk-reference/android-installation/#declare-dependencies).

Set the SDK language programmatically through the `CommonConfig.Builder().setLocalizationLanguage()` API:

```kotlin
val LANGUAGE_CODE_PORTUGUESE = "pt_BR"

        ...

IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setLocalizationLanguage(LANGUAGE_CODE_PORTUGUESE)
        .build()
)
```

```java
String LANGUAGE_CODE_PORTUGUESE = "pt_BR";

        ...

IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setLocalizationLanguage(LANGUAGE_CODE_PORTUGUESE)
        .build()
);
```

Supported values for `setLocalizationLanguage()`:

| Value     | Language             |
| --------- | -------------------- |
| `"en_US"` | English              |
| `"es_ES"` | Spanish              |
| `"pt_BR"` | Brazilian Portuguese |
| `"de_DE"` | German               |
| `"he_IL"` | Hebrew               |


<Accordion title="View all customizable text elements">

```xml
  <string name="onboard_sdk_dialog_camera_permissions_mandatory_title">Incode Welcome needs\nCamera access to work</string>
  <string name="onboard_sdk_dialog_location_permissions_mandatory_title">Incode Welcome needs\nLocation access to work</string>
  <string name="onboard_sdk_dialog_microphone_permissions_mandatory_title">Incode Welcome needs\nMicrophone access to work</string>
  <string name="onboard_sdk_dialog_camera_permissions_mandatory_subtitle">Please open Settings, go to\nApp Permissions and enable Camera</string>
  <string name="onboard_sdk_dialog_location_permissions_mandatory_subtitle">Please open Settings, go to\nApp Permissions and enable Location</string>
  <string name="onboard_sdk_dialog_microphone_permissions_mandatory_subtitle">Please open Settings, go to\nApp Permissions and enable Microphone</string>

  <string name="onboard_sdk_dialog_permission_btn_open_settings">Open settings</string>
  <string name="onboard_sdk_btn_continue">Continue</string>
  <string name="onboard_sdk_btn_back">Back</string>
  <string name="onboard_sdk_ok">OK</string>
  <string name="onboard_sdk_btn_skip">Skip</string>
  <string name="onboard_sdk_btn_quit">Quit</string>
  <string name="onboard_sdk_btn_next">Next</string>
  <string name="onboard_sdk_btn_start">Start</string>
  <string name="onboard_sdk_btn_state_loading">Loading…</string>
  <string name="onboard_sdk_bullet_point" translatable="false">\u2022</string>

  <!-- Generic -->
  <string name="onboard_sdk_input_field_invalid_value">Invalid input</string>
  <string name="onboard_sdk_loader_preparing_camera">Preparing camera</string>
  <string name="onboard_sdk_input_field_required_state_voice_over">Required field</string>
  <string name="onboard_sdk_input_field_clear_selection_voice_over">Clear selection</string>
  <string name="onboard_sdk_dropdown_hint">Select an option</string>
  <string name="onboard_sdk_dropdown_voice_over_expanded">Expanded</string>
  <string name="onboard_sdk_dropdown_voice_over_collapsed">Collapsed</string>
  <string name="onboard_sdk_dropdown_selected">Selected</string>
  <string name="onboard_sdk_dropdown_not_selected">Not selected</string>
  <string name="onboard_sdk_dropdown_search_no_results">No results</string>

  <!-- IntroActivity -->
  <string name="onboard_sdk_intro_title">For this process you will need:</string>
  <string name="onboard_sdk_intro_check_id">Valid ID</string>
  <string name="onboard_sdk_intro_check_passport">Valid Passport</string>
  <string name="onboard_sdk_intro_check_id_or_passport">Valid ID or Passport</string>
  <string name="onboard_sdk_intro_check_address">Recent Proof of Address</string>
  <string name="onboard_sdk_intro_check_selfie">To take a Selfie</string>
  <string name="onboard_sdk_intro_check_medical_doc">Valid Medical Document</string>
  <string name="onboard_sdk_intro_check_other_doc">Valid Document</string>
  <string name="onboard_sdk_intro_data_protected_label">Your data is protected by Incode</string>
  <string name="onboard_sdk_intro_data_protected_highlighted_text">Incode</string>
  <string name="onboard_sdk_intro_confirm_btn">I Confirm</string>
  <string name="onboard_sdk_intro_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- PhoneNumberActivity -->
  <string name="onboard_sdk_enter_phone_number">Enter phone number</string>
  <string name="onboard_sdk_error_unknown_error">Unknown error</string>
  <string name="onboard_sdk_phone_number_check_box_description">Yes, I’d like to receive important messages from %1$s on my phone</string>
  <string name="onboard_sdk_phone_number_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- PhoneNumberActivity V2 -->
  <string name="onboard_sdk_phone_verify_subtitle">We\'ll send you a code to ensure it\'s yours</string>
  <string name="onboard_sdk_phone_verified_success">Phone verified!</string>
  <string name="onboard_sdk_phone_national_placeholder" translatable="false">(123) 123-45-67</string>
  <string name="onboard_sdk_phone_max_attempts_error">Something went wrong</string>
  <string name="onboard_sdk_phone_refresh">Refresh</string>

  <!-- PhoneNumberActivity: Accessibility - Search Country dropdown -->
  <string name="onboard_sdk_phone_country_dropdown_a11y_label">Country code, %1$s, %2$s</string>
  <string name="onboard_sdk_phone_country_list_a11y_label">Country list</string>
  <string name="onboard_sdk_phone_country_row_a11y_label">%1$s, %2$s</string>

  <!-- PhoneNumberActivity: Accessibility - Pane title announced when the screen loads or when focus returns -->
  <string name="onboard_sdk_phone_screen_pane_title_a11y">Phone number verification</string>

  <!-- PhoneNumberActivity: Accessibility - Label for the search field  -->
  <string name="onboard_sdk_phone_country_search_a11y_label">Search countries</string>

  <!-- PhoneNumberActivity: Phone field -->
  <string name="onboard_sdk_phone_number_a11y_label">Phone number</string>

  <!-- PhoneNumberActivity: Accessibility - Continue button -->
  <string name="onboard_sdk_phone_continue_loading_a11y">Submitting, please wait</string>

  <!-- PhoneNumberActivity: Accessibility - Empty state announcement for country search results -->
  <string name="onboard_sdk_phone_country_results_empty_a11y">No countries found</string>

  <!-- EmailAddressActivity -->
  <string name="onboard_sdk_enter_email_address">Enter your email</string>
  <string name="onboard_sdk_enter_email">Verify your email</string>
  <string name="onboard_sdk_enter_email_subtitle">We’ll send you a code to ensure it’s yours</string>
  <string name="onboard_sdk_enter_email_input_placeholder">Email</string>
  <string name="onboard_sdk_email_address_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_email_btn_continue">@string/onboard_sdk_email_address_btn_continue</string>
  <string name="onboard_sdk_email_verified">Email verified!</string>
  <string name="onboard_sdk_email_something_went_wrong">Something went wrong</string>

  <!-- EMAIL OTP -->
  <string name="onboard_sdk_email_otp_enter_code">Enter the code we’ve sent to your email</string>
  <string name="onboard_sdk_email_otp_error_message">Something went wrong</string>
  <string name="onboard_sdk_email_otp_resend_or_change_email">Didn’t receive the code? Resend code or Change email</string>
  <string name="onboard_sdk_email_otp_resend_code">Resend code</string>
  <string name="onboard_sdk_generic_otp_resend_code_in_x_seconds">Resend code in %ds</string>

  <!-- NameActivity -->
  <string name="onboard_sdk_enter_name">Enter your name</string>

  <!-- Common SelectSourceActivity -->
  <string name="onboard_sdk_select_document_source_photo_library">Photo Library</string>
  <string name="onboard_sdk_select_document_source_take_photo">Take Photo</string>
  <string name="onboard_sdk_select_document_source_browse">Browse…</string>
  <string name="onboard_sdk_select_document_source_error_opening_file">Error opening file</string>
  <string name="onboard_sdk_select_document_source_error">No app available to select content</string>

  <!-- DocumentCaptureActivity (V2) -->
  <string name="onboard_sdk_document_capture_chooser_title">Verify your document</string>
  <string name="onboard_sdk_document_capture_chooser_subtitle">Take a photo or upload a PDF, JPG or PNG.</string>
  <string name="onboard_sdk_document_capture_chooser_subtitle_no_pdf">Take a photo or upload a JPG or PNG.</string>
  <string name="onboard_sdk_document_capture_only_subtitle">Take a photo of your document to continue.</string>
  <string name="onboard_sdk_document_capture_upload_only_subtitle">Upload a PDF, JPG or PNG.</string>
  <string name="onboard_sdk_document_capture_upload_only_subtitle_no_pdf">Upload a JPG or PNG.</string>
  <string name="onboard_sdk_document_capture_btn_capture">Capture document</string>
  <string name="onboard_sdk_document_capture_btn_upload">Upload document</string>
  <string name="onboard_sdk_document_capture_btn_skip">Skip this step</string>
  <string name="onboard_sdk_document_capture_source_take_photo">Take photo</string>
  <string name="onboard_sdk_document_capture_source_camera_roll">Choose from camera roll</string>
  <string name="onboard_sdk_document_capture_source_choose_file">Choose file</string>
  <string name="onboard_sdk_document_capture_camera_title">Show your full document</string>
  <string name="onboard_sdk_document_capture_camera_subtitle">Make sure it’s fully visible and press the button</string>
  <string name="onboard_sdk_document_capture_review_btn_replace">Replace</string>
  <string name="onboard_sdk_document_capture_review_pdf_subtitle">Make sure you’ve selected the correct file before you continue the verification process.</string>
  <string name="onboard_sdk_document_capture_success_title">Successfully processed!</string>
  <string name="onboard_sdk_document_capture_common_issues_title">Common issues</string>
  <string name="onboard_sdk_document_capture_common_issues_out_of_frame_title">Document is too far or out of frame</string>
  <string name="onboard_sdk_document_capture_common_issues_out_of_frame_subtitle">Make sure all edges are visible on screen.</string>
  <string name="onboard_sdk_document_capture_common_issues_folded_title">Document is folded</string>
  <string name="onboard_sdk_document_capture_common_issues_folded_subtitle">Flatten your document and make sure it’s fully open and straight.</string>
  <string name="onboard_sdk_document_capture_common_issues_shadows_title">Shadows on the document</string>
  <string name="onboard_sdk_document_capture_common_issues_shadows_subtitle">Move to a brighter area and avoid casting shadows over your document.</string>
  <string name="onboard_sdk_document_capture_common_issues_lens_title">Camera lens is dirty</string>
  <string name="onboard_sdk_document_capture_common_issues_lens_subtitle">Clean your camera lens for a sharper image.</string>
  <string name="onboard_sdk_document_capture_common_issues_btn_try_again">Try again</string>
  <string name="onboard_sdk_document_capture_analyzing_title">Analyzing…</string>
  <string name="onboard_sdk_document_capture_uploading_title">Uploading…</string>
  <string name="onboard_sdk_document_capture_error_title">Document needs to be recaptured</string>
  <string name="onboard_sdk_document_capture_error_subtitle">Some pages were unclear or incomplete. Recapture all document pages to continue.</string>
  <string name="onboard_sdk_document_capture_error_btn_recapture">Recapture document</string>
  <string name="onboard_sdk_document_capture_no_connection_btn_refresh">Refresh</string>
  <string name="onboard_sdk_document_capture_exhausted_title">Unable to process</string>
  <string name="onboard_sdk_document_capture_exhausted_subtitle">Maximum number of attempts reached.</string>
  <string name="onboard_sdk_document_capture_exhausted_btn_continue">Continue</string>

  <!-- SelectAddressStatementSourceActivity -->
  <string name="onboard_sdk_select_address_statement_source_title">Upload a document to verify your identity</string>
  <string name="onboard_sdk_select_address_statement_source_subtitle">This can be any legal documentation that proves your address.</string>
  <string name="onboard_sdk_select_address_statement_source_bottom_text">Take a photo or upload a PDF, JPG, or PNG</string>
  <string name="onboard_sdk_select_address_statement_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_address_statement_source_btn_skip">Skip this step</string>

  <!-- SelectPaymentProofSourceActivity -->
  <string name="onboard_sdk_select_payment_proof_source_title">Upload your proof of payment</string>
  <string name="onboard_sdk_select_payment_proof_source_subtitle">This can be a document from your bank or electronic invoice that shows a specific transaction.</string>
  <string name="onboard_sdk_select_payment_proof_source_bottom_text">Take a photo or upload JPG, PNG</string>
  <string name="onboard_sdk_select_payment_proof_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_payment_proof_source_btn_skip">Skip this step</string>

  <!-- SelectMedicalDocSourceActivity -->
  <string name="onboard_sdk_select_medical_doc_source_title">Upload your medical document</string>
  <string name="onboard_sdk_select_medical_doc_source_subtitle">This can be a document that shows you are medically insured.</string>
  <string name="onboard_sdk_select_medical_doc_source_bottom_text">Take a photo or upload JPG, PNG</string>
  <string name="onboard_sdk_select_medical_doc_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_medical_doc_source_btn_skip">Skip this step</string>

  <!-- SelectOtherDocument1SourceActivity -->
  <string name="onboard_sdk_select_other_document_1_source_title">Upload a document to verify your identity</string>
  <string name="onboard_sdk_select_other_document_1_source_subtitle">This can be any legal documentation that proves your identity.</string>
  <string name="onboard_sdk_select_other_document_1_source_bottom_text">Take a photo or upload JPG, PNG</string>
  <string name="onboard_sdk_select_other_document_1_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_other_document_1_source_btn_skip">Skip this step</string>

  <!-- SelectOtherDocument2SourceActivity -->
  <string name="onboard_sdk_select_other_document_2_source_title">Upload a document to verify your identity</string>
  <string name="onboard_sdk_select_other_document_2_source_subtitle">This can be any legal documentation that proves your identity.</string>
  <string name="onboard_sdk_select_other_document_2_source_bottom_text">Take a photo or upload JPG, PNG</string>
  <string name="onboard_sdk_select_other_document_2_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_other_document_2_source_btn_skip">Skip this step</string>

  <!-- SelectOtherDocument3SourceActivity -->
  <string name="onboard_sdk_select_other_document_3_source_title">Upload a document to verify your identity</string>
  <string name="onboard_sdk_select_other_document_3_source_subtitle">This can be any legal documentation that proves your identity.</string>
  <string name="onboard_sdk_select_other_document_3_source_bottom_text">Take a photo or upload JPG, PNG</string>
  <string name="onboard_sdk_select_other_document_3_source_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_select_other_document_3_source_btn_skip">Skip this step</string>

  <!-- TutorialDocumentScanActivity -->
  <string name="onboard_sdk_tutorial_document_scan_title">Place your document within the frame and take the photo</string>
  <string name="onboard_sdk_tutorial_document_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- TutorialSelfieActivity -->
  <string name="onboard_sdk_tutorial_selfie_title">Let’s take a selfie</string>
  <string name="onboard_sdk_tutorial_selfie_subtitle">Keep a neutral expression, find balanced light, and remove any glasses or hats</string>
  <string name="onboard_sdk_tutorial_selfie_animation_content_description">Place your phone an arm’s distance in front of your face. The image will be taken automatically.</string>
  <string name="onboard_sdk_age_verification_selfie_title">Age verification</string>
  <string name="onboard_sdk_age_verification_selfie_subtitle">Please take a selfie to estimate your age, your data is private, your face is not stored or shared</string>
  <string name="onboard_sdk_age_verification_selfie_instructions">@string/onboard_sdk_tutorial_selfie_subtitle</string>

  <!-- TutorialSelfieV2 -->
  <string name="onboard_sdk_tutorial_selfie_v2_title">Take a selfie</string>
  <string name="onboard_sdk_tutorial_selfie_v2_subtitle">Keep a neutral expression, find balanced light and remove any glasses and hats</string>
  <string name="onboard_sdk_tutorial_selfie_v2_instructions">Stay still, photo will be taken automatically</string>
  <string name="onboard_sdk_tutorial_selfie_v2_button_text">Take selfie</string>
  <string name="onboard_sdk_age_verification_selfie_v2_title">Take a selfie to verify your age</string>
  <string name="onboard_sdk_age_verification_selfie_v2_subtitle">Your image will not be stored or shared with any third-party to protect your privacy</string>
  <string name="onboard_sdk_age_verification_selfie_v2_instructions">Stay still, selfie will be taken automatically</string>
  <string name="onboard_sdk_age_verification_selfie_v2_button_text">Verify age</string>

  <!-- IDTypeChooserActivity -->
  <string name="onboard_sdk_id_type_chooser_title">Select what document you want to scan</string>
  <string name="onboard_sdk_btn_id">Driver License\nID Card\nResident Card</string>
  <string name="onboard_sdk_btn_passport">Passport\nVisa</string>

  <!-- TutorialFrontActivity -->
  <string name="onboard_sdk_tutorial_front_1_title">Place your\nID inside the frame</string>
  <string name="onboard_sdk_tutorial_front_2_title">Avoid\nshadows and glare </string>
  <string name="onboard_sdk_tutorial_front_3_title">Make sure\nthe photo is sharp</string>
  <string name="onboard_sdk_tutorial_front_4_title">Make sure\ninfo is readable</string>
  <string name="onboard_sdk_tutorial_front_voice_over">Place your ID up to the back camera of your phone and slowly move the ID while holding your phone in position. The capture will happen automatically.</string>

  <!-- TutorialPassportActivity -->
  <string name="onboard_sdk_tutorial_passport_1_title">Place your Passport inside the\nframe and take a photo</string>
  <string name="onboard_sdk_tutorial_passport_2_title">Avoid\nshadows and glare </string>
  <string name="onboard_sdk_tutorial_passport_3_title">Make sure\nthe photo is sharp</string>
  <string name="onboard_sdk_tutorial_passport_4_title">Make sure\ninfo is readable</string>
  <string name="onboard_sdk_tutorial_passport_voice_over">@string/onboard_sdk_tutorial_front_voice_over</string>

  <!-- TutorialBackActivity -->
  <string name="onboard_sdk_tutorial_back_title">Now show the\nback side of your ID</string>
  <string name="onboard_sdk_tutorial_back_title_highlighted_part">back side</string>
  <string name="onboard_sdk_tutorial_back_subtitle_1">Avoid shadows and glare</string>
  <string name="onboard_sdk_tutorial_back_subtitle_2">The photo will be taken automatically</string>
  <string name="onboard_sdk_tutorial_back_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_tutorial_back_voice_over">@string/onboard_sdk_tutorial_front_voice_over</string>

  <!-- IdValidationFeedback -->
  <string name="onboard_sdk_validation_autocapture_hold_still">Don’t move!\nTaking photo…</string>
  <string name="onboard_sdk_validation_fill_rectangle_with_id">Fill the rectangle\nwith your ID</string>
  <string name="onboard_sdk_validation_fill_rectangle_with_passport">Fill the rectangle\nwith your Passport</string>
  <string name="onboard_sdk_validation_warn_show_front">Show the front of the ID</string>
  <string name="onboard_sdk_validation_warn_show_back">Show the back of the ID</string>
  <string name="onboard_sdk_validation_manual_capture_instructions">1. Put ID in the frame\n2. Press capture button</string>
  <string name="onboard_sdk_validation_warn_id_too_dark">Too dark</string>
  <string name="onboard_sdk_validation_warn_id_out_of_focus">ID out of focus</string>
  <string name="onboard_sdk_validation_warn_id_glare_detected">Glare detected</string>
  <string name="onboard_sdk_validation_warn_passport_too_dark">Too dark</string>
  <string name="onboard_sdk_validation_warn_passport_out_of_focus">Passport out of focus</string>
  <string name="onboard_sdk_validation_warn_passport_glare_detected">Glare detected</string>
  <string name="onboard_sdk_validation_success">All good!</string>
  <string name="onboard_sdk_validation_voice_over_back_camera_started">Back camera has started</string>
  <string name="onboard_sdk_validation_voice_over_warn_id_glare_detected">Glare on ID</string>
  <string name="onboard_sdk_validation_voice_over_id_too_close">Move phone further from the ID</string>
  <string name="onboard_sdk_validation_voice_over_id_too_far">Move phone closer to the ID</string>
  <string name="onboard_sdk_validation_voice_over_autocapture_capturing">Capturing</string>
  <string name="onboard_sdk_validation_voice_over_autocapture_success">Capture success</string>
  <string name="onboard_sdk_validation_voice_over_enter_manual_mode">Double tap on the screen to capture, or bottom right button if you need help with capturing</string>
  <string name="onboard_sdk_voice_over_shutter_button">Take photo</string>
  <string name="onboard_sdk_validation_id_type_not_digital_id">Please try with a different document</string>
  <string name="onboard_sdk_validation_digital_id_file_size_error_title">File is too large</string>
  <string name="onboard_sdk_validation_digital_id_file_size_error_subtitle">The selected file is larger than 5MB, please upload a smaller one</string>
  <string name="onboard_sdk_validation_btn_choose_another_file">Choose another file</string>
  <string name="onboard_sdk_validation_id_wallet_error_title">Couldn’t verify your ID</string>
  <string name="onboard_sdk_validation_id_wallet_error_subtitle">Please try again</string>

  <!-- IdValidationActivity -->
  <string name="onboard_sdk_validation_show_front">Show the front of the ID</string>
  <string name="onboard_sdk_validation_show_front_secondary_text">@string/onboard_sdk_validation_show_front</string>
  <string name="onboard_sdk_validation_show_back">Show the back of the ID</string>
  <string name="onboard_sdk_validation_show_back_secondary_text">@string/onboard_sdk_validation_show_back</string>
  <string name="onboard_sdk_validation_show_passport">Show passport page with photo</string>
  <string name="onboard_sdk_id_scan_v1_camera_loading_feedback">Please wait,\nadjusting camera</string>
  <string name="onboard_sdk_id_scan_help_btn">Help</string>
  <string name="onboard_sdk_id_scan_close_btn">Close</string>
  <string name="onboard_sdk_id_scan_help_common_issue_1">ID too far or out of frame</string>
  <string name="onboard_sdk_id_scan_help_common_issue_subtext_1"></string>
  <string name="onboard_sdk_id_scan_help_common_issue_2">Glare or shadows on ID</string>
  <string name="onboard_sdk_id_scan_help_common_issue_subtext_2"></string>
  <string name="onboard_sdk_id_scan_help_common_issue_3">Camera lens dirty</string>
  <string name="onboard_sdk_id_scan_help_common_issue_subtext_3"></string>
  <string name="onboard_sdk_id_scan_help_btn_ok">OK, try again</string>
  <string name="onboard_sdk_id_scan_help_btn_manual_capture">I prefer to capture the photo manually</string>
  <string name="onboard_sdk_document_scan_help_common_issues">Common issues</string>
  <string name="onboard_sdk_document_scan_help_common_issue_1">Document is too far or out of frame</string>
  <string name="onboard_sdk_document_scan_help_common_issue_subtext_1"></string>
  <string name="onboard_sdk_document_scan_help_common_issue_2">Document is folded</string>
  <string name="onboard_sdk_document_scan_help_common_issue_subtext_2"></string>
  <string name="onboard_sdk_document_scan_help_common_issue_3">Glare or shadows on the document</string>
  <string name="onboard_sdk_document_scan_help_common_issue_subtext_3"></string>
  <string name="onboard_sdk_document_scan_help_common_issue_4">Camera lens is dirty</string>
  <string name="onboard_sdk_document_scan_help_common_issue_subtext_4"></string>
  <string name="onboard_sdk_document_scan_help_btn_ok">OK, try again</string>

  <!-- ReviewActivity -->
  <string name="onboard_sdk_review_your_photo">Review your photo</string>
  <string name="onboard_sdk_review_your_photo_hint1">Ensure that the text on the ID is readable</string>
  <string name="onboard_sdk_review_your_photo_hint2">The ID photo must be sharp and without glare</string>
  <string name="onboard_sdk_review_your_photo_btn_scan_again">@string/onboard_sdk_validation_address_btn_scan_again</string>
  <string name="onboard_sdk_validation_address_btn_scan_again">"&lt;   Retake photo"</string>
  <string name="onboard_sdk_review_your_photo_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- ReviewActivity - Proof of Address -->
  <string name="onboard_sdk_review_your_document">Review your document</string>
  <string name="onboard_sdk_review_your_document_hint">Make sure that entire document fits the view, and that the text is readable.</string>

  <!-- IdDocumentSelection -->
  <string name="onboard_sdk_id_capture_title">ID capture</string>
  <string name="onboard_sdk_id_document_selection_identity_card">Identity Card</string>
  <string name="onboard_sdk_id_document_selection_identity_card_subtitle">National Identity Card,\nor Driver’s License</string>
  <string name="onboard_sdk_id_document_selection_passport">Passport</string>
  <string name="onboard_sdk_id_document_selection_passport_subtitle">Your country Passport</string>
  <string name="onboard_sdk_id_document_selection_footer">verified by</string>
  <string name="onboard_sdk_id_document_selection_title_compact">Select how to verify</string>
  <string name="onboard_sdk_id_document_selection_digital_id">Upload Digital ID</string>

  <!-- IdCaptureIntro -->
  <string name="onboard_sdk_id_capture_tutorial_title">Show the front of your ID</string>
  <string name="onboard_sdk_id_capture_tutorial_subtitle">Ensure your ID is readable</string>
  <string name="onboard_sdk_id_capture_tutorial_hint">The capture will happen automatically</string>
  <string name="onboard_sdk_id_capture_tutorial_hint_permission">Next, you’ll be asked to allow camera access</string>
  <string name="onboard_sdk_id_capture_how_it_works">How it works</string>
  <string name="onboard_sdk_id_capture_how_it_works_title">How it works</string>
  <string name="onboard_sdk_id_capture_how_it_works_subtitle">Your scan is secure and takes less than a minute</string>
  <string name="onboard_sdk_id_capture_how_it_works_row_camera">Camera access is only used during the scan</string>
  <string name="onboard_sdk_id_capture_how_it_works_row_not_saved">Your ID is never saved to this device</string>
  <string name="onboard_sdk_id_capture_how_it_works_row_encrypted">Data is encrypted end-to-end</string>
  <string name="onboard_sdk_id_capture_lets_scan">Let\'s scan</string>
  <string name="onboard_sdk_id_capture_upload_pdf">Upload PDF</string>

  <string name="onboard_sdk_id_capture_barcode_tutorial_title">Show the back of your ID</string>
  <string name="onboard_sdk_id_capture_back_side_tutorial_title">Show the back of your ID</string>

  <string name="onboard_sdk_id_capture_intro_title_passport">Scan your Passport</string>
  <string name="onboard_sdk_id_capture_intro_subtitle_passport">Ensure your Passport is readable</string>

  <string name="onboard_sdk_id_capture_intro_title_digital_id">Upload Digital ID</string>
  <string name="onboard_sdk_id_capture_intro_subtitle_digital_id">A government-issued PDF file with your details, picture and a QR code</string>

  <!-- ReviewDigitalIdScreen -->
  <string name="onboard_sdk_digital_id_review_title">Review document</string>
  <string name="onboard_sdk_digital_id_review_subtitle">Make sure this is the correct file before you continue verification process.</string>
  <string name="onboard_sdk_digital_id_review_replace_file">Replace file</string>

  <!-- DigitalIdUploadSuccessScreen -->
  <string name="onboard_sdk_digital_id_lets_continue">Let\'s continue</string>

  <!-- PermissionOnboarding -->
  <string name="onboard_sdk_permission_not_granted_generic_title">Mandatory permission not granted</string>
  <string name="onboard_sdk_permission_allow">Allow permission</string>
  <string name="onboard_sdk_permission_quit">Quit process</string>
  <string name="onboard_sdk_permission_intro_title">Allow camera access</string>
  <string name="onboard_sdk_permission_intro_subtitle">This lets you take a photo of your ID and face for verification purposes.</string>
  <string name="onboard_sdk_btn_allow">Allow</string>
  <string name="onboard_sdk_btn_do_not_allow">Don’t allow</string>

  <string name="onboard_sdk_permission_camera_rationale_title">Camera permission is required</string>
  <string name="onboard_sdk_permission_rationale_p1">We only use the camera to capture your ID for secure verification</string>
  <string name="onboard_sdk_permission_rationale_p2">It helps verify document authenticity and prevent identity fraud</string>
  <string name="onboard_sdk_permission_rationale_p3">We protect your data, and it is only used for verification</string>
  <string name="onboard_sdk_permission_rationale_p4">This is required to verify your identity</string>

  <string name="onboard_sdk_permission_open_setting_camera_title">Allow Incode to access your camera</string>
  <string name="onboard_sdk_permission_open_setting_camera_subtitle">This lets you capture your documents in order to complete the process.</string>
  <string name="onboard_sdk_permission_open_setting_action">Open settings</string>
  <string name="onboard_sdk_permission_allow_permission_action">Allow permission</string>

  <!-- IdCaptureCamera -->
  <string name="onboard_sdk_id_capture_box_hint_id_not_aligned">ID is not aligned</string>
  <string name="onboard_sdk_id_capture_box_hint_id_not_aligned_subtitle">Center your ID inside the frame</string>

  <string name="onboard_sdk_id_capture_box_hint_id_blurry">ID too blurry</string>
  <string name="onboard_sdk_id_capture_box_hint_id_blurry_subtitle">Zoom in and out, or tap on the ID</string>

  <string name="onboard_sdk_id_capture_box_hint_id_glare">ID with glare</string>
  <string name="onboard_sdk_id_capture_box_hint_id_glare_subtitle">Find a better lighting to avoid reflections</string>

  <string name="onboard_sdk_id_capture_box_hint_id_too_dark">Image too dark</string>
  <string name="onboard_sdk_id_capture_box_hint_id_too_dark_subtitle">Find a place with better lighting</string>

  <string name="onboard_sdk_id_capture_fill_the_frame_id">Frame the front of your ID</string>
  <string name="onboard_sdk_id_capture_fill_the_frame_passport">Fill the frame with your passport</string>
  <string name="onboard_sdk_id_capture_fill_the_frame_back_id">Frame the back of your ID</string>
  <string name="onboard_sdk_id_capture_manual_capture_instructions">1. Fill the frame with your ID\n2. Press the button</string>
  <string name="onboard_sdk_id_capture_manual_capture_voice_over">Now using manual capture mode. Use manual capture button to capture ID.</string>
  <string name="onboard_sdk_manual_capture_btn">Manual capture</string>

  <string name="onboard_sdk_id_capture_box_hint_wrong_id_side_front">Show the front of ID</string>
  <string name="onboard_sdk_id_capture_box_hint_wrong_id_side_front_subtitle">Flip your ID to show its front side</string>

  <string name="onboard_sdk_id_capture_box_hint_wrong_id_side_back">Show the back of ID</string>
  <string name="onboard_sdk_id_capture_box_hint_wrong_id_side_back_subtitle">Flip your ID to show its reverse side</string>

  <string name="onboard_sdk_id_capture_hint_photo_will_be_taken">The capture will happen automatically</string>

  <string name="onboard_sdk_id_capture_hint_taking_photo">Taking photo…</string>
  <string name="onboard_sdk_id_capture_hint_do_not_move">Don’t move your ID for a few seconds</string>

  <string name="onboard_sdk_id_capture_review_photo_title">Review your photo</string>
  <string name="onboard_sdk_id_capture_review_photo_subtitle">Ensure that the text on the ID is readable and that the photo is sharp and without glare.</string>
  <string name="onboard_sdk_id_capture_review_photo_btn_retake">Retake</string>
  <string name="onboard_sdk_id_capture_review_photo_btn_continue">@string/onboard_sdk_btn_continue</string>

  <string name="onboard_sdk_id_capture_successfully_processed">Successfully processed!</string>
  <string name="onboard_sdk_id_capture_successfully_captured">Successfully captured!</string>
  <string name="onboard_sdk_id_capture_capture_result_title">Successfully captured</string>
  <string name="onboard_sdk_id_capture_optimizing_capture">Optimizing your capture…</string>
  <string name="onboard_sdk_id_capture_now_capture_back">Now let’s capture the back</string>
  <string name="onboard_sdk_id_capture_now_capture_front">Now let’s capture the front</string>
  <string name="onboard_sdk_id_capture_now_capture_continue">Let’s continue</string>
  <string name="onboard_sdk_id_capture_show_the_back">Show the back of your ID</string>

  <string name="onboard_sdk_id_capture_common_issues_title">Common issues</string>
  <string name="onboard_sdk_id_capture_common_issues_glare_title">Glare present</string>
  <string name="onboard_sdk_id_capture_common_issues_glare_subtitle">Tilt the ID slightly up or down to minimize the reflection</string>
  <string name="onboard_sdk_id_capture_common_issues_blur_title">Blur present</string>
  <string name="onboard_sdk_id_capture_common_issues_blur_subtitle">Move ID further away or closer to your phone until the image is focused</string>
  <string name="onboard_sdk_id_capture_common_issues_info_not_readable_title">Info is not readable</string>
  <string name="onboard_sdk_id_capture_common_issues_info_not_readable_subtitle">Minimize camera shake by holding your phone steady</string>
  <string name="onboard_sdk_id_capture_common_issues_try_again_button">@string/onboard_sdk_try_again</string>
  <string name="onboard_sdk_id_capture_help_manual_photo_button_text">Take the photo manually</string>
  <string name="onboard_sdk_id_capture_help_auto_photo_button_text">Take the photo automatically</string>

  <string name="onboard_sdk_id_capture_analyzing">Analyzing…</string>
  <string name="onboard_sdk_id_capture_processing">Processing…</string>
  <string name="onboard_sdk_id_capture_uploading">Uploading…</string>

  <string name="onboard_sdk_id_capture_scan_the_front">Scan the front</string>
  <string name="onboard_sdk_id_capture_scan_the_back">Scan the back</string>
  <string name="onboard_sdk_id_capture_retake_scan">Try again</string>

  <!-- IdCapture Accepted Documents (customizing these strings is not recommended) -->
  <string name="onboard_sdk_id_capture_accepted_documents_unknown">Unknown</string>
  <string name="onboard_sdk_id_capture_accepted_documents_passport">Passport</string>
  <string name="onboard_sdk_id_capture_accepted_documents_visa">Visa</string>
  <string name="onboard_sdk_id_capture_accepted_documents_drivers_license">Driver\'s License</string>
  <string name="onboard_sdk_id_capture_accepted_documents_identification_card">Identification Card</string>
  <string name="onboard_sdk_id_capture_accepted_documents_permit">Permit</string>
  <string name="onboard_sdk_id_capture_accepted_documents_currency">Currency</string>
  <string name="onboard_sdk_id_capture_accepted_documents_residence_document">Residence Document</string>
  <string name="onboard_sdk_id_capture_accepted_documents_travel_document">Travel Document</string>
  <string name="onboard_sdk_id_capture_accepted_documents_birth_certificate">Birth Certificate</string>
  <string name="onboard_sdk_id_capture_accepted_documents_vehicle_registration">Vehicle Registration</string>
  <string name="onboard_sdk_id_capture_accepted_documents_other">Other</string>
  <string name="onboard_sdk_id_capture_accepted_documents_weapon_license">Weapon License</string>
  <string name="onboard_sdk_id_capture_accepted_documents_tribal_identification">Tribal Identification</string>
  <string name="onboard_sdk_id_capture_accepted_documents_voter_identification">Voter Identification</string>
  <string name="onboard_sdk_id_capture_accepted_documents_military">Military</string>
  <string name="onboard_sdk_id_capture_accepted_documents_tax_identification">Tax Identification</string>
  <string name="onboard_sdk_id_capture_accepted_documents_federal_id">Federal ID</string>
  <string name="onboard_sdk_id_capture_accepted_documents_medical_card">Medical Card</string>

  <!-- GeolocationActivity -->
  <string name="onboard_sdk_determine_location">We need to determine your current location</string>
  <string name="onboard_sdk_current_location_label">You are currently in:</string>
  <string name="onboard_sdk_location_unavailable">Location not\ndetermined</string>
  <string name="onboard_sdk_btn_finish">Finish</string>
  <string name="onboard_sdk_geolocation_btn_continue">@string/onboard_sdk_btn_continue</string>
  <!-- Geolocation v2 -->
  <string name="onboard_sdk_geolocation_allow_location_title">Allow location access</string>
  <string name="onboard_sdk_geolocation_allow_location_subtitle">to complete the process</string>
  <string name="onboard_sdk_geolocation_btn_skip_this_step">Skip this step</string>
  <string name="onboard_sdk_geolocation_fetching_title">Determining your location…</string>
  <string name="onboard_sdk_geolocation_location_unavailable_title">Unable to verify your location</string>
  <string name="onboard_sdk_geolocation_location_unavailable_subtitle">Your location signal may be weak or not\naccurate enough. Please move to an area with better signal and try again.</string>
  <string name="onboard_sdk_geolocation_no_network_title">No internet connection</string>
  <string name="onboard_sdk_geolocation_no_network_subtitle">Wait for the internet to return to continue the process or connect to an available network.</string>
  <string name="onboard_sdk_geolocation_refresh">Refresh</string>
  <string name="onboard_sdk_geolocation_btn_quit_process">Quit process</string>

  <!-- SelfieActivity -->
  <string name="onboard_sdk_face_scan_custom_message"> </string>
  <string name="onboard_sdk_face_scan_manual_capture_instructions">Align your face within the silhouette and press the button to capture</string>
  <string name="onboard_sdk_face_scan_not_operational">Face scan not ready</string>
  <string name="onboard_sdk_face_scan_get_ready">Get ready…</string>
  <string name="onboard_sdk_face_scan_low_image_quality">Ensure your face is clearly visible with no obstructions</string>
  <string name="onboard_sdk_face_scan_face_occlusion_detected">Remove anything covering your face</string>
  <string name="onboard_sdk_face_scan_warn_selfie_too_dark">Too dark</string>
  <string name="onboard_sdk_mask_check_info">Put on your\nface mask</string>
  <string name="onboard_sdk_feedback_remove_lenses">Take off your glasses</string>
  <string name="onboard_sdk_feedback_face_mask_detected">Face mask detected</string>
  <string name="onboard_sdk_feedback_open_eyes">Keep your eyes open</string>
  <string name="onboard_sdk_feedback_remove_head_cover">Remove head coverings such as hats and caps</string>
  <string name="onboard_sdk_feedback_multiple_faces_detected">Make sure you are the only person in the frame</string>
  <string name="onboard_sdk_feedback_position_your_face">Look at the camera</string>
  <string name="onboard_sdk_feedback_position_your_face_for_age_estimation">Look at the camera to estimate your age</string>
  <string name="onboard_sdk_feedback_face_tilted">Don’t tilt your head</string>
  <string name="onboard_sdk_feedback_face_rotated_left">Turn right</string>
  <string name="onboard_sdk_feedback_face_rotated_right">Turn left</string>
  <string name="onboard_sdk_feedback_align_face">Align your face within the silhouette and look at the camera</string>
  <string name="onboard_sdk_feedback_blurred_crop">Too blurry.\nClean the camera and hold still.</string>
  <string name="onboard_sdk_feedback_face_too_far">Move closer</string>
  <string name="onboard_sdk_feedback_face_too_close">Move away</string>
  <string name="onboard_sdk_feedback_taking_photo">Don’t move!\nTaking photo…</string>
  <string name="onboard_sdk_processing">Processing…</string>
  <string name="onboard_sdk_spoof_detected">Poor conditions for selfie. Try in another place.</string>
  <string name="onboard_sdk_voice_over_feedback_camera_activated">Front camera activated</string>
  <string name="onboard_sdk_voice_over_feedback_blurred_crop">Image not focused, adjust</string>
  <string name="onboard_sdk_voice_over_feedback_face_too_close">Move phone further, please.</string>
  <string name="onboard_sdk_voice_over_feedback_face_too_far">Move phone closer to you, please.</string>
  <string name="onboard_sdk_voice_over_feedback_open_eyes">Keep your eyes open</string>
  <string name="onboard_sdk_voice_over_feedback_remove_head_cover">Remove head coverings such as hats and caps</string>
  <string name="onboard_sdk_voice_over_feedback_remove_lenses">Take off your glasses</string>
  <string name="onboard_sdk_voice_over_feedback_face_mask_detected">Take off your face mask</string>
  <string name="onboard_sdk_voice_over_feedback_face_tilted">Don’t tilt your head</string>
  <string name="onboard_sdk_voice_over_feedback_face_rotated_left">Turn right a bit</string>
  <string name="onboard_sdk_voice_over_feedback_face_rotated_right">Turn left a bit</string>
  <string name="onboard_sdk_voice_over_feedback_align_face">Hold phone in front of your face</string>
  <string name="onboard_sdk_voice_over_feedback_multiple_faces_detected">@string/onboard_sdk_feedback_multiple_faces_detected</string>
  <string name="onboard_sdk_voice_over_feedback_face_scan_not_operational">@string/onboard_sdk_face_scan_not_operational</string>
  <string name="onboard_sdk_voice_over_feedback_too_dark">@string/onboard_sdk_validation_warn_id_too_dark</string>
  <string name="onboard_sdk_voice_over_face_scan_enter_manual_mode">Double tap anywhere on the screen to capture</string>
  <string name="onboard_sdk_voice_over_face_scan_get_ready">Get ready…</string>
  <string name="onboard_sdk_voice_over_face_scan_low_image_quality">Ensure your face is clearly visible with no obstructions</string>
  <string name="onboard_sdk_voice_over_face_scan_face_occlusion_detected">Make sure nothing is covering your face</string>

  <!-- SignatureFormActivity -->
  <string name="onboard_sdk_signature_title">Digital signature</string>
  <string name="onboard_sdk_signature_description">Please sign in the box below to create your digital signature for signing the document.</string>
  <string name="onboard_sdk_signature_sign_here">Sign here</string>
  <string name="onboard_sdk_signature_btn_clear_canvas">Clear canvas</string>
  <string name="onboard_sdk_signature_btn_done">Done</string>
  <string name="onboard_sdk_signature_capture_title">Draw your signature</string>
  <string name="onboard_sdk_signature_capture_description">Use your finger or mouse</string>
  <string name="onboard_sdk_signature_success_title">Signed successfully!</string>
  <string name="onboard_sdk_signature_canvas_accessibility_label">Signature canvas</string>
  <string name="onboard_sdk_signature_canvas_accessibility_empty">Empty. Draw your signature in this area.</string>
  <string name="onboard_sdk_signature_canvas_accessibility_signed">Signature added.</string>

  <!-- VideoSelfieActivity -->
  <string name="onboard_sdk_video_selfie_feedback_selfie">Look at the camera</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_processing">Processing…</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_success">Looking good!</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_spoof_detected">Poor conditions for selfie, try in another place</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_lenses_detected">Glasses detected</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_mask_detected">Mask detected</string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_error_continue">Continuing the flow. Please wait…</string>
  <string name="onboard_sdk_video_selfie_feedback_too_dark">It’s too dark</string>
  <string name="onboard_sdk_video_selfie_feedback_too_blurry">Too blurry</string>
  <string name="onboard_sdk_video_selfie_feedback_take_off_mask">Take off your mask</string>
  <string name="onboard_sdk_video_selfie_feedback_take_off_glasses">Take off your glasses</string>
  <string name="onboard_sdk_video_selfie_feedback_dont_tilt_head">Don’t tilt your head</string>
  <string name="onboard_sdk_video_selfie_feedback_turn_right">Turn right</string>
  <string name="onboard_sdk_video_selfie_feedback_turn_left">Turn left</string>
  <string name="onboard_sdk_video_selfie_feedback_align_face">Align face to frame</string>
  <string name="onboard_sdk_video_selfie_feedback_move_closer">Move closer</string>
  <string name="onboard_sdk_video_selfie_feedback_move_away">Move away</string>
  <string name="onboard_sdk_video_selfie_feedback_look_at_camera">Look at the camera</string>
  <string name="onboard_sdk_video_selfie_feedback_remove_head_cover">Remove head coverings such as hats and caps</string>
  <string name="onboard_sdk_video_selfie_feedback_keep_eyes_open">Keep your eyes open</string>
  <string name="onboard_sdk_video_selfie_processing_title">Processing…</string>
  <string name="onboard_sdk_video_selfie_success_title">All good!</string>
  <string name="onboard_sdk_video_selfie_recording_in_progress">Recording…</string>
  <string name="onboard_sdk_video_selfie_step_progress">Step %1$d of %2$d</string>
  <string name="onboard_sdk_video_selfie_recording_permission_title">Give recording permission</string>
  <!-- ID-step realtime capture hints reuse the ID Capture onboard_sdk_id_capture_box_hint_* strings (see the ID Capture section) -->
  <string name="onboard_sdk_video_selfie_id_error_scan_failed_try_again">ID scan failed, try again</string>
  <string name="onboard_sdk_video_selfie_id_error_scan_failed">ID scan failed</string>
  <string name="onboard_sdk_video_selfie_id_error_name_failed_try_again">Name verification failed, try again</string>
  <string name="onboard_sdk_video_selfie_id_error_name_failed">Name verification failed</string>
  <string name="onboard_sdk_video_selfie_id_error_photo_failed_try_again">ID photo verification failed, try again</string>
  <string name="onboard_sdk_video_selfie_id_error_photo_failed">ID photo verification failed</string>
  <string name="onboard_sdk_video_selfie_id_error_type_mismatch_try_again">ID type mismatch, show the same ID</string>
  <string name="onboard_sdk_video_selfie_id_error_type_mismatch">ID type mismatch</string>
  <string name="onboard_sdk_video_selfie_flip_id_title">Show the back of your ID</string>
  <string name="onboard_sdk_video_selfie_speech_error_title">Something went wrong…</string>
  <string name="onboard_sdk_video_selfie_speech_error_suggestion_1">Be in a place with less ambient noise</string>
  <string name="onboard_sdk_video_selfie_speech_error_suggestion_2">Preferably use the microphone of your headphones</string>
  <string name="onboard_sdk_video_selfie_speech_error_suggestion_3">Be very clear with the pronunciation</string>
  <string name="onboard_sdk_video_selfie_speech_error_try_again">Try again</string>
  <string name="onboard_sdk_video_selfie_audio_fetch_error_title">Something went wrong…</string>
  <string name="onboard_sdk_video_selfie_feedback_voice_consent">Say\n“%1$s”\nout loud</string>
  <string name="onboard_sdk_video_selfie_recording_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_video_selfie_default_question_1">Say your full name out loud</string>
  <string name="onboard_sdk_video_selfie_default_question_2">Say your address out loud</string>
  <string name="onboard_sdk_video_selfie_default_question_3">Say your gender out loud</string>
  <string name="onboard_sdk_video_selfie_default_answer_1"></string>
  <string name="onboard_sdk_video_selfie_default_answer_2"></string>
  <string name="onboard_sdk_video_selfie_default_answer_3"></string>
  <string name="onboard_sdk_video_selfie_default_consent">I accept the terms &amp; conditions</string>
  <string name="onboard_sdk_vs_switch_to_back_camera">Switching to back camera…</string>
  <string name="onboard_sdk_vs_switch_to_front_camera">Switching to front camera…</string>
  <string name="onboard_sdk_vs_improving_resolution">Improving resolution…</string>
  <string name="onboard_sdk_vs_custom_message"> </string>
  <string name="onboard_sdk_video_selfie_feedback_selfie_no_match">No match. Try again.</string>
  <string name="onboard_sdk_video_selfie_feedback_id_processing">Processing…</string>
  <string name="onboard_sdk_video_selfie_feedback_id_scan_failed">ID scan failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_id_scan_failed">ID scan failed</string>
  <string name="onboard_sdk_video_selfie_feedback_id_type_match_failed">ID type mismatch. Please show the same ID.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_id_type_match_failed">ID type mismatch</string>
  <string name="onboard_sdk_video_selfie_feedback_id_photo_verification_failed">ID photo verification failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_feedback_final_id_photo_verification_failed">ID photo verification failed</string>
  <string name="onboard_sdk_video_selfie_feedback_id_name_verification_failed">Name verification failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_feedback_final_id_name_verification_failed">Name verification failed</string>
  <string name="onboard_sdk_video_selfie_feedback_passport_scan_failed">Scan failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_passport_scan_failed">Scan failed</string>
  <string name="onboard_sdk_video_selfie_feedback_passport_type_match_failed">ID type mismatch. Please show the same ID.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_passport_type_match_failed">ID type mismatch</string>
  <string name="onboard_sdk_video_selfie_feedback_passport_photo_verification_failed">Passport photo verification failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_passport_photo_verification_failed">Passport photo verification failed</string>
  <string name="onboard_sdk_video_selfie_passport_photo_verification_failed">Passport photo verification failed</string>
  <string name="onboard_sdk_video_selfie_feedback_passport_name_verification_failed">Name verification failed. Please try again.</string>
  <string name="onboard_sdk_video_selfie_final_feedback_passport_name_verification_failed">Name verification failed</string>
  <string name="onboard_sdk_video_selfie_question_error_title">Something went wrong</string>
  <string name="onboard_sdk_video_selfie_question_error_suggestion_1">Be in a place with less ambient noise</string>
  <string name="onboard_sdk_video_selfie_question_error_suggestion_2">Preferably use the microphone of your headphones</string>
  <string name="onboard_sdk_video_selfie_question_error_suggestion_3">Be very clear with the pronunciation</string>
  <string name="onboard_sdk_speech_to_text_btn_try_again">Try Again</string>
  <string name="onboard_sdk_video_selfie_uploading">Uploading video…</string>
  <string name="onboard_sdk_video_selfie_upload_success">Video Successfully Uploaded</string>
  <string name="onboard_sdk_video_selfie_upload_failed">Processing failed…</string>
  <string name="onboard_sdk_video_selfie_upload_failed_subtitle">Something went wrong processing your video selfie. Please try again.</string>
  <string name="onboard_sdk_video_selfie_upload_processing_retry">Retry</string>
  <string name="onboard_sdk_video_selfie_feedback_no_network">No internet connection</string>
  <string name="onboard_sdk_video_selfie_allow_screen_recording_title">For legal reasons, we need you to</string>
  <string name="onboard_sdk_video_selfie_allow_screen_recording_subtitle">\“Allow screen recording\” and \“Allow Microphone\”</string>
  <string name="onboard_sdk_video_selfie_allow_screen_recording_subtitle_highlight">\u0020and\u0020</string>
  <string name="onboard_sdk_video_selfie_start">Start video selfie</string>
  <string name="onboard_sdk_video_selfie_checks_start">Start video selfie</string>
  <string name="onboard_sdk_video_selfie_tap_to_answer">Tap to answer</string>
  <string name="onboard_sdk_video_selfie_tap_when_done">Tap when done</string>
  <string name="onboard_sdk_video_selfie_gesture_turn_left">Turn your head to the left</string>
  <string name="onboard_sdk_video_selfie_gesture_turn_right">Turn your head to the right</string>
  <string name="onboard_sdk_video_selfie_gesture_turn_up">Tilt your head up</string>
  <string name="onboard_sdk_video_selfie_gesture_turn_down">Tilt your head down</string>
  <string name="onboard_sdk_video_selfie_hand_gesture">Wave your hand across each side of your face</string>
  <string name="onboard_sdk_video_selfie_keep_waving">Keep waving…</string>
  <string name="onboard_sdk_video_selfie_tap_to_speak">Tap to speak</string>
  <string name="onboard_sdk_video_selfie_press_to_continue">Once said, press to continue</string>
  <string name="onboard_sdk_video_selfie_answer_out_loud">Please answer out loud</string>
  <string name="onboard_sdk_video_selfie_say_out_loud">Please say out loud</string>
  <string name="onboard_sdk_video_selfie_voice_consent_success">All good!</string>
  <string name="onboard_sdk_video_selfie_voice_consent_status_success">All good!</string>
  <string name="onboard_sdk_video_selfie_upload_modules_partially_complete">Not all modules have been completed…</string>
  <string name="onboard_sdk_video_selfie_upload_processing">Kindly hold on and refrain from closing this, as it may take some time to finish…</string>
  <string name="onboard_sdk_video_selfie_switch_to_back_camera">Switching to back camera</string>
  <string name="onboard_sdk_video_selfie_switch_to_front_camera">Switching to front camera</string>
  <string name="onboard_sdk_video_selfie_switching_to_back_camera">Switching to back camera</string>
  <string name="onboard_sdk_video_selfie_switching_to_front_camera">Switching to front camera</string>
  <string name="onboard_sdk_video_selfie_improving_resolution">Improving resolution</string>
  <string name="onboard_sdk_video_selfie_voice_consent_dialog_title">Finished speaking?</string>
  <string name="onboard_sdk_video_selfie_voice_consent_dialog_description">Did you say \"%1$s?\" If you haven’t, please try again.</string>
  <string name="onboard_sdk_video_selfie_finished_speaking_dialog_description">Did you say \"%1$s?\" If you haven’t, please try again.</string>
  <string name="onboard_sdk_video_selfie_center_face_in_frame">Center face in frame to continue</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_title">Microphone permissions are legally required to continue</string>
  <string name="onboard_sdk_video_selfie_allow_permissions">Allow permissions</string>
  <string name="onboard_sdk_video_selfie_btn_quit_process">Quit process</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_title">@string/onboard_sdk_video_selfie_allow_permissions</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_subtitle">To continue with the onboarding process, we will need you to enable:</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_list_title">Microphone permission</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_item_1">Open settings</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_item_2">Tap on Apps &amp; Notifications or Apps</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_item_3">Tap on the name of this app</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_item_4">Select App Permissions or Permission Manager</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_instructions_item_5">Toggle the switch</string>
  <string name="onboard_sdk_video_selfie_allow_audio_permissions_mandatory_dialog_disclaimer">Remember, the specific steps might vary based on your device and the version of the operating system it’s running.</string>
  <string name="onboard_sdk_video_selfie_face_match_fail">Faces do not match</string>

  <!-- VideoSelfieChecksActivity -->
  <string name="onboard_sdk_video_selfie_check_recording_permission">Give recording permission</string>
  <string name="onboard_sdk_video_selfie_check_front_id_scan">Scan the front of ID</string>
  <string name="onboard_sdk_video_selfie_check_back_id_scan">Scan the back of ID</string>
  <string name="onboard_sdk_video_selfie_check_passport_scan">Scan your passport photo page</string>
  <string name="onboard_sdk_video_selfie_check_selfie_scan">Look at your front camera</string>
  <string name="onboard_sdk_video_selfie_check_hand_gesture">Wave your hand at the camera</string>
  <string name="onboard_sdk_video_selfie_check_random_questions">Answer some questions out loud</string>
  <string name="onboard_sdk_video_selfie_check_voice_consent">Speak the words displayed on the screen</string>
  <string name="onboard_sdk_video_selfie_front_id_pane_title">Scan the front of ID</string>
  <string name="onboard_sdk_video_selfie_back_id_pane_title">Scan the back of ID</string>
  <string name="onboard_sdk_video_selfie_selfie_pane_title">Look at your front camera</string>
  <string name="onboard_sdk_video_selfie_questions_pane_title">Answer some questions out loud</string>
  <string name="onboard_sdk_video_selfie_voice_consent_pane_title">Speak the words displayed on the screen</string>
  <string name="onboard_sdk_video_selfie_hand_gesture_pane_title">Wave your hand across your face</string>
  <string name="onboard_sdk_video_selfie_head_movement_left">Turn your head to the left</string>
  <string name="onboard_sdk_video_selfie_head_movement_right">Turn your head to the right</string>
  <string name="onboard_sdk_video_selfie_head_movement_up">Turn your head upwards</string>
  <string name="onboard_sdk_video_selfie_head_movement_down">Turn your head downwards</string>
  <string name="onboard_sdk_video_selfie_pose_accepted_a11y">Pose accepted</string>
  <string name="onboard_sdk_video_selfie_wave_hand_title">Wave your hand across each side of your face</string>
  <string name="onboard_sdk_video_selfie_wave_hand_button">Tap when done</string>
  <string name="onboard_sdk_video_selfie_wave_hand_done">Done</string>
  <string name="onboard_sdk_video_selfie_wave_hand_confirm_enabled_a11y">Tap when done is now enabled</string>
  <string name="onboard_sdk_video_selfie">Video selfie</string>
  <string name="onboard_sdk_video_selfie_checks_description">For legal reasons, we must recheck your documents. You’ll be requested to:</string>

  <!-- VoiceConsentDialog -->
  <string name="onboard_sdk_voice_consent_dialog_button_done">Yes, I’m done</string>
  <string name="onboard_sdk_voice_consent_dialog_button_try_again">Try again</string>

  <!-- ExitDialog -->
  <string name="onboard_sdk_exit_dialog_title">Are you sure you want to quit?</string>
  <string name="onboard_sdk_exit_dialog_message">This will quit the process and all the progress will be lost.</string>
  <string name="onboard_sdk_exit_dialog_positive_button">Quit</string>
  <string name="onboard_sdk_exit_dialog_negative_button">Get back</string>

  <!-- Edit OCR screen -->
  <string name="onboard_sdk_edit_ocr_title">Please check your data</string>
  <string name="onboard_sdk_edit_ocr_document">Document number</string>
  <string name="onboard_sdk_edit_ocr_expiry_date">Expiry Date</string>
  <string name="onboard_sdk_edit_ocr_date_of_birth">Date of Birth</string>

  <!-- NFC Symbol Confirmation screen -->
  <string name="onboard_sdk_epassport_filter_title">Is this symbol visible on your passport cover?</string>
  <string name="onboard_sdk_eid_filter_title">Is this symbol visible on the front or back of your ID?</string>

  <!-- No NFC Hardware screen -->
  <string name="onboard_sdk_no_nfc_hardware_title">We’re sorry, you’re unable to continue the process on this phone</string>
  <string name="onboard_sdk_no_nfc_hardware_instruction">Your phone doesn’t have the ability to scan the chip in the document. Please try again using a different phone.</string>

  <!-- NFC Scanning screen -->
  <string name="onboard_sdk_scan_passport_title_start">Let’s scan the passport chip</string>
  <string name="onboard_sdk_scan_passport_title_no_worries">No worries, let’s try again</string>
  <string name="onboard_sdk_scan_passport_title_not_working">If that didn’t work…</string>
  <string name="onboard_sdk_scan_passport_title_still_not_working">If that still didn’t work…</string>
  <string name="onboard_sdk_scan_passport_instruction_start">Hold your phone close to the front cover.</string>
  <string name="onboard_sdk_scan_passport_instruction_start_front_text_to_highlight">front cover</string>
  <string name="onboard_sdk_scan_passport_instruction_front">Remove your passport from any folder or cover and hold your phone close to the front cover of your passport.</string>
  <string name="onboard_sdk_scan_passport_instruction_try">Try holding your phone close to the %1$s of your passport. If nothing happens, try slowly moving your phone across the page.</string>
  <string name="onboard_sdk_scan_passport_instruction_first_text_to_highlight">first page</string>
  <string name="onboard_sdk_scan_passport_instruction_photo_text_to_highlight">photo page</string>
  <string name="onboard_sdk_scan_passport_instruction_back_text_to_highlight">inner back page</string>
  <string name="onboard_sdk_scan_id_title_start">Read the chip on the ID</string>
  <string name="onboard_sdk_scan_id_instruction_first">1. Hold the ID against the phone’s center back.</string>
  <string name="onboard_sdk_scan_id_instruction_second">2. Make sure your ID and phone are touching.</string>
  <string name="onboard_sdk_scan_id_instruction_third">3. Hold still until scanning is complete.</string>
  <string name="onboard_sdk_scan_id_instruction_first_text_to_highlight">phone’s center back</string>
  <string name="onboard_sdk_scan_id_instruction_second_text_to_highlight">are touching</string>
  <string name="onboard_sdk_scan_id_instruction_third_text_to_highlight">Hold still</string>
  <string name="onboard_sdk_btn_start_scan">Start scanning</string>
  <string name="onboard_sdk_dialog_nfc_access_mandatory_title">Incode Welcome needs\nNFC access to work</string>
  <string name="onboard_sdk_dialog_nfc_access_mandatory_subtitle">Please open Settings and enable NFC</string>

  <!-- Scanning Bottom Sheet -->
  <string name="onboard_sdk_scan_bottom_sheet_title_ready">Ready to scan</string>
  <string name="onboard_sdk_scan_bottom_sheet_title_scanning">Scanning, hold still…</string>
  <string name="onboard_sdk_scan_bottom_sheet_instruction_ready">Once you see a change on the screen, keep the phone steady</string>
  <string name="onboard_sdk_scan_bottom_sheet_instruction_scanning">Scanning, don’t move your phone</string>
  <string name="onboard_sdk_scan_bottom_sheet_instruction_scanned">Scan successful</string>
  <string name="onboard_sdk_scan_bottom_sheet_instruction_uploading">Uploading, please wait…</string>
  <string name="onboard_sdk_scan_bottom_sheet_instruction_failed">We couldn’t scan the chip</string>

  <!-- Don't Move Dialog -->
  <string name="onboard_sdk_dont_move_dialog_title">Keep your phone and document still</string>
  <string name="onboard_sdk_dont_move_dialog_instruction">Make sure you don’t move while scanning is in progress.</string>

  <!-- Common NFC Scanning issues Screen -->
  <string name="onboard_sdk_nfc_scan_help_common_issues">Common issues</string>
  <string name="onboard_sdk_nfc_scan_help_common_issue_1">Passport is covered</string>
  <string name="onboard_sdk_nfc_scan_help_common_issue_2">Phone is far away from the document</string>
  <string name="onboard_sdk_nfc_scan_help_common_issue_3">Chip is on another page in the passport</string>
  <string name="onboard_sdk_nfc_scan_help_common_issue_4">Moving the phone while scanning has initiated</string>
  <string name="onboard_sdk_nfc_scan_help_common_issue_5">Phone cover interferes with the scan</string>
  <string name="onboard_sdk_nfc_btn_ok_try_again">OK, try again</string>

  <!-- NFC Scan results Screen -->
  <string name="onboard_sdk_document_nfc_scan_result_success">Document chip scan succeeded</string>
  <string name="onboard_sdk_document_nfc_scan_result_failure">Unable to authenticate document chip</string>

  <!-- OTHER STRINGS -->
  <string name="onboard_sdk_success">Success</string>
  <string name="onboard_sdk_try_again">Try again</string>
  <string name="onboard_sdk_error_retry">Try again</string>

  <string name="onboard_sdk_no_internet_title">No internet connection</string>
  <string name="onboard_sdk_no_internet_connection">Wait for the internet to return to continue the process or connect to an available network.</string>
  <string name="onboard_sdk_unknown_server_error">Oops… something went wrong. Please try later.</string>

  <!-- OTP -->
  <string name="onboard_sdk_generic_otp_veryfing">Verifying…</string>
  <string name="onboard_sdk_generic_otp_incorrect_code">Incorrect code. Please try again.</string>
  <string name="onboard_sdk_generic_otp_try_again_in_x_seconds">Didn’t receive the code? Try again in %d seconds</string>
  <string name="onboard_sdk_generic_otp_try_again">Try again</string>

  <!-- SMS OTP -->
  <string name="onboard_sdk_sms_otp_title">Verify your phone number</string>
  <string name="onboard_sdk_sms_otp_subtitle">Please enter the code we’ve sent via SMS</string>
  <string name="onboard_sdk_sms_otp_try_again_or_change_number">Didn’t receive the code? Try again or Change phone number</string>
  <string name="onboard_sdk_sms_otp_try_again">Try again</string>
  <string name="onboard_sdk_sms_otp_change_phone_number">Change phone number</string>

  <!-- SMS OTP V2 -->
  <string name="onboard_sdk_sms_otp_headline">Enter the code we’ve sent via SMS</string>
  <string name="onboard_sdk_sms_resend_code_or_change_number">Didn’t receive the code? Resend code or Change phone number</string>
  <string name="onboard_sdk_sms_otp_resend_code">Resend code</string>
  <string name="onboard_sdk_sms_otp_incorrect_code">Invalid code. Please try again.</string>

  <!-- MachineLearningConsentActivity -->
  <string name="onboard_sdk_ml_consent_title" translatable="false">Machine Learning Consent</string>
  <string name="onboard_sdk_ml_consent_checkbox">I confirm that I have read and accept (optional)</string>

  <!-- ConferenceConnectionActivity -->
  <string name="onboard_sdk_conference_hang_on">Hang on</string>
  <string name="onboard_sdk_conference_hang_on_subtitle">We’re connecting you with a representative</string>
  <string name="onboard_sdk_conference_average_waiting_time_msg">This usually takes 2 – 3 minutes.</string>
  <string name="onboard_sdk_conference_interviewer_name">Thomas Keys</string>
  <string name="onboard_sdk_conference_interviewer_connected">connected</string>

  <!-- TutorialQRScanActivity -->
  <string name="onboard_sdk_qr_tip_title">Locate the QR code inside the document</string>
  <string name="onboard_sdk_qr_tip_subtitle">QR code will be read automatically</string>
  <string name="onboard_sdk_qr_tip_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- QRScanActivity -->
  <string name="onboard_sdk_qr_scan_feedback_top">Place the QR code\ninside the box</string>
  <string name="onboard_sdk_qr_scan_help_btn">Help</string>
  <string name="onboard_sdk_qr_scan_help_common_issues">Common issues</string>
  <string name="onboard_sdk_qr_scan_help_common_issue_1">QR cropped out of frame</string>
  <string name="onboard_sdk_qr_scan_help_common_issue_2">QR too close or too far</string>
  <string name="onboard_sdk_qr_scan_help_common_issue_3">Bad capture angle</string>
  <string name="onboard_sdk_qr_scan_help_common_issue_4">Blurred or damaged QR</string>
  <string name="onboard_sdk_qr_scan_help_btn_ok">OK, try again</string>
  <string name="onboard_sdk_qr_scan_processing">Processing…</string>
  <string name="onboard_sdk_qr_scan_success">Done!</string>
  <string name="onboard_sdk_qr_scan_failed">QR scan\nunsuccessful!</string>

  <!-- IdValidationFeedback -->
  <string name="onboard_sdk_validation_on_server_in_progress">Processing…</string>
  <string name="onboard_sdk_validation_front_id_validated">ID front validated!</string>
  <string name="onboard_sdk_validation_back_id_validated">All done!</string>
  <string name="onboard_sdk_validation_passport_validated">All done!</string>
  <string name="onboard_sdk_validation_glare_detected">Glare present</string>
  <string name="onboard_sdk_validation_glare_detected_hint">Tilt the ID slightly up or down to minimize the reflection</string>
  <string name="onboard_sdk_validation_sharpness_failed">Blur present</string>
  <string name="onboard_sdk_validation_sharpness_failed_hint">Move ID further away or closer to your phone until the image is focused</string>
  <string name="onboard_sdk_validation_passport_sharpness_failed">Blur present</string>
  <string name="onboard_sdk_validation_passport_sharpness_failed_hint">Move passport further away or closer to your phone until the image is focused</string>
  <string name="onboard_sdk_validation_wrong_side_id">Wrong ID side captured</string>
  <string name="onboard_sdk_validation_wrong_side_front_id_hint">Please capture the front side of the ID</string>
  <string name="onboard_sdk_validation_wrong_side_back_id_hint">Please capture the back side of the ID</string>
  <string name="onboard_sdk_validation_shadow_failed">Shadow detected</string>
  <string name="onboard_sdk_validation_classification_failed">ID scan failed</string>
  <string name="onboard_sdk_validation_passport_classification_failed">Passport scan failed</string>
  <string name="onboard_sdk_validation_front_id_scan_failure">Front ID scan fail</string>
  <string name="onboard_sdk_validation_back_id_scan_failure">Back ID scan fail</string>
  <string name="onboard_sdk_validation_passport_scan_failure">Passport scan fail</string>
  <string name="onboard_sdk_validation_front_id_scan_success">Front ID scan success</string>
  <string name="onboard_sdk_validation_back_id_scan_success">Back ID scan success</string>
  <string name="onboard_sdk_validation_front_id_no_face">No face found in ID</string>
  <string name="onboard_sdk_validation_id_type_unacceptable">ID type is not accepted</string>
  <string name="onboard_sdk_validation_id_type_unacceptable_hint">Please try with a different document</string>
  <string name="onboard_sdk_validation_btn_try_again">Try Again</string>
  <plurals name="onboard_sdk_validation_attempts_remaining">
      <item formatted="true" quantity="one">%d attempt remaining</item>
      <item formatted="true" quantity="other">%d attempts remaining</item>
  </plurals>
  <string name="onboard_sdk_validation_no_attempts_remaining">No attempts remaining</string>
  <string name="onboard_sdk_validation_error_button_text">Scan your ID</string>
  <string name="onboard_sdk_validation_btn_retake_photo">Retake Photo</string>
  <string name="onboard_sdk_validation_btn_use_another_id">Use another ID</string>
  <string name="onboard_sdk_validation_capture_failed_title">Couldn’t capture</string>
  <string name="onboard_sdk_validation_validation_referred_title">Referred to an executive</string>
  <string name="onboard_sdk_validation_validation_referred_subtitle">We will notify you with the result</string>
  <string name="onboard_sdk_validation_no_document_detected_title">No document detected</string>

  <!-- IdValidationActivity -->
  <string name="onboard_sdk_id_scan_failed_common_issues">Common issues</string>
  <string name="onboard_sdk_id_scan_failed_common_issue_1">Shadows or\nglare present</string>
  <string name="onboard_sdk_id_scan_failed_common_issue_2">Photo\nis blurred</string>
  <string name="onboard_sdk_id_scan_failed_common_issue_3">Info is\nnot readable</string>
  <string name="onboard_sdk_id_scan_help_glare_present_title">Glare present</string>
  <string name="onboard_sdk_id_scan_help_glare_present_hint">Tilt the ID slightly up or down to minimize the reflection</string>
  <string name="onboard_sdk_id_scan_help_blur_present_title">Blur present</string>
  <string name="onboard_sdk_id_scan_help_blur_present_hint">Move ID further away or closer to your phone until the image is focused</string>
  <string name="onboard_sdk_id_scan_help_info_not_readable_title">Info is not readable</string>
  <string name="onboard_sdk_id_scan_help_info_not_readable_hint">Minimize camera shake by holding your phone steady</string>
  <string name="onboard_sdk_validation_referred_to_executive_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_validation_id_readability_failed">Info is not readable</string>
  <string name="onboard_sdk_validation_passport_readability_failed">Info is not readable</string>
  <string name="onboard_sdk_validation_id_readability_failed_hint">Minimize camera shake by holding your phone steady</string>
  <string name="onboard_sdk_validation_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- ProcessIdActivity -->
  <string name="onboard_sdk_process_id_loading_title">Hold on a sec…</string>
  <string name="onboard_sdk_process_id_loading_subtitle">We’re verifying your identity</string>

  <!-- GoogleWalletActivity -->
  <string name="onboard_sdk_wallet_id_loading_title">@string/onboard_sdk_process_id_loading_title</string>
  <string name="onboard_sdk_wallet_id_loading_subtitle">Getting your wallet ready</string>

  <!-- IdInfoActivity -->
  <string name="onboard_sdk_id_info_retake">Retake</string>
  <string name="onboard_sdk_id_info_title">Please check your data</string>
  <string name="onboard_sdk_id_info_required_fields_subtitle">All fields marked with * are required.</string>
  <string name="onboard_sdk_id_info_full_name">Full name</string>
  <string name="onboard_sdk_id_info_date_of_birth">Date of birth</string>
  <string name="onboard_sdk_id_info_sex">Sex</string>
  <string name="onboard_sdk_id_info_male">Male</string>
  <string name="onboard_sdk_id_info_female">Female</string>
  <string name="onboard_sdk_id_info_address">Address</string>
  <string name="onboard_sdk_id_info_document_number">Document number</string>
  <string name="onboard_sdk_id_info_expiry_date">Expiry date</string>
  <string name="onboard_sdk_id_info_error_message">An error occurred while submitting OCR data.</string>

  <!-- TaxId Validation -->
  <string name="onboard_sdk_tax_id">Tax ID</string>
  <string name="onboard_sdk_enter_tax_id">Enter your Tax ID</string>
  <string name="onboard_sdk_tax_id_validation_in_progress">Validating your Tax ID</string>
  <string name="onboard_sdk_tax_id_verified">Tax ID verified!</string>
  <string name="onboard_sdk_tax_id_not_verified">Tax ID not verified!</string>

  <!-- CURP Validation -->
  <string name="onboard_sdk_enter_curp">Enter your CURP</string>
  <string name="onboard_sdk_confirm_curp">Confirm your CURP</string>
  <string name="onboard_sdk_curp">CURP</string>
  <string name="onboard_sdk_curp_not_valid">Invalid CURP</string>
  <string name="onboard_sdk_no_curp">I don’t have my CURP</string>
  <string name="onboard_sdk_btn_generate_curp">Generate</string>

  <string name="onboard_sdk_curp_validation_in_progress">Verifying your CURP…</string>
  <string name="onboard_sdk_curp_verified">CURP verified!</string>
  <string name="onboard_sdk_curp_not_verified">CURP not verified</string>

  <string name="onboard_sdk_curp_generating_in_progress">Generating CURP…</string>
  <string name="onboard_sdk_curp_generating_failure_title">Couldn’t generate CURP</string>
  <string name="onboard_sdk_curp_generating_failure_subtitle">Please check entered information</string>
  <string name="onboard_sdk_curp_generating_failure_btn_edit_information">Edit information</string>

  <string name="onboard_sdk_curp_generate_title">Generate your CURP</string>
  <string name="onboard_sdk_curp_first_name">Name</string>
  <string name="onboard_sdk_curp_first_last_name">Last name</string>
  <string name="onboard_sdk_curp_second_last_name">Second last name</string>
  <string name="onboard_sdk_curp_gender">Gender</string>
  <string name="onboard_sdk_curp_birth_date">Date of birth</string>
  <string name="onboard_sdk_curp_state">Birth state</string>
  <string name="onboard_sdk_btn_generate">Generate</string>
  <string name="onboard_sdk_curp_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- TutorialAgeAssurance -->
  <string name="onboard_sdk_tutorial_age_assurance_title">Age verification</string>
  <string name="onboard_sdk_tutorial_age_assurance_subtitle">We need to scan your ID to know your age</string>
  <string name="onboard_sdk_tutorial_age_assurance_label_1">Show your ID and scan it</string>
  <string name="onboard_sdk_tutorial_age_assurance_label_2">We only use the date of birth information</string>
  <string name="onboard_sdk_tutorial_age_assurance_label_3">The rest of your information will be deleted to ensure your privacy</string>
  <string name="onboard_sdk_tutorial_age_assurance_btn_continue">@string/onboard_sdk_btn_continue</string>

  <!-- SelfieActivity -->
  <string name="onboard_sdk_enroll_success">Success!</string>
  <string name="onboard_sdk_face_captured">Face captured!</string>
  <string name="onboard_sdk_login_success">Success</string>
  <string name="onboard_sdk_login_failed">Access denied</string>
  <string name="onboard_sdk_mask_check_success">Success</string>
  <string name="onboard_sdk_mask_check_failed">Face mask not detected</string>
  <string name="onboard_sdk_selfie_manual_capture_voice_over">Now using manual capture mode. Use manual capture button to capture selfie.</string>
  <string name="onboard_sdk_selfie_uploading">Uploading…</string>
  <string name="onboard_sdk_selfie_verifying">Verifying…</string>
  <string name="onboard_sdk_face_scan_error_4010">Make sure you are the only one in the frame</string>
  <string name="onboard_sdk_face_scan_error_4019">Position your face in the center of the frame</string>
  <string name="onboard_sdk_face_scan_error_1003">Position your face in the center of the frame</string>
  <string name="onboard_sdk_face_scan_error_3004">Position your face in the center of the frame</string>
  <string name="onboard_sdk_face_scan_error_3005">Move closer so your face fits the frame</string>
  <string name="onboard_sdk_face_scan_error_3006">Photo blurry. Clean the lens and hold still.</string>
  <string name="onboard_sdk_face_scan_error_3007">Too dark. Try moving elsewhere.</string>
  <string name="onboard_sdk_face_scan_error_3008">Something went wrong. Please try later.</string>
  <string name="onboard_sdk_face_scan_error_3009">Something went wrong. Please try later.</string>
  <string name="onboard_sdk_face_scan_error_3010">Couldn’t capture. Try moving elsewhere.</string>
  <string name="onboard_sdk_face_scan_error_4077">Stay still for the capture, and make sure your face is clear and visible</string>
  <string name="onboard_sdk_face_scan_no_network">No internet connection</string>
  <string name="onboard_sdk_face_scan_failed_feedback_face_not_aligned_title">Face not aligned</string>
  <string name="onboard_sdk_face_scan_failed_feedback_face_not_aligned_hint">Make sure you align your face with the white silhouette</string>
  <string name="onboard_sdk_face_scan_failed_feedback_lenses_detected_title">Lenses detected</string>
  <string name="onboard_sdk_face_scan_failed_feedback_lenses_detected_hint">Take off your glasses to ensure a clear capture</string>
  <string name="onboard_sdk_face_scan_failed_feedback_face_mask_detected_title">Face mask detected</string>
  <string name="onboard_sdk_face_scan_failed_feedback_face_mask_detected_hint">Take off your face mask to ensure a clear capture</string>
  <string name="onboard_sdk_face_scan_failed_feedback_too_dark_title">Too dark</string>
  <string name="onboard_sdk_face_scan_failed_feedback_too_dark_hint">Adjust the lighting or move closer to a light source</string>
  <string name="onboard_sdk_face_scan_failed_feedback_eyes_closed_title">Eyes closed</string>
  <string name="onboard_sdk_face_scan_failed_feedback_eyes_closed_hint">Keep your eyes open during the capture</string>
  <string name="onboard_sdk_face_scan_failed_feedback_head_covered_title">Head covered</string>
  <string name="onboard_sdk_face_scan_failed_feedback_head_covered_hint">Remove head coverings such as hats and caps</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_title">Selfie capture failed</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_failed_hint">We couldn’t capture your selfie. Please try again</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_low_quality_title">Low quality conditions</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_face_covered_title">Face covered</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_face_covered_hint">Make sure your face is clear and visible</string>
  <string name="onboard_sdk_face_scan_failed_feedback_selfie_capture_total_failure_hint">Maximum number of attempts reached</string>
  <plurals name="onboard_sdk_face_scan_attempts_remaining">
      <item formatted="true" quantity="one">%d attempt remaining</item>
      <item formatted="true" quantity="other">%d attempts remaining</item>
  </plurals>
  <string name="onboard_sdk_face_scan_retry">Refresh</string>

  <!-- FaceMatchActivity -->
  <string name="onboard_sdk_recognition_result_title">Verifying identity</string>
  <string name="onboard_sdk_recognition_result_id">ID</string>
  <string name="onboard_sdk_recognition_result_first_id">First ID</string>
  <string name="onboard_sdk_recognition_result_second_id">Second ID</string>
  <string name="onboard_sdk_recognition_result_nfc">NFC</string>
  <string name="onboard_sdk_recognition_result_selfie">Selfie</string>
  <string name="onboard_sdk_recognition_result_success">Matched!</string>
  <string name="onboard_sdk_recognition_result_fail">Faces do not match</string>
  <string name="onboard_sdk_recognition_result_fail_id">@string/onboard_sdk_recognition_result_fail</string>
  <string name="onboard_sdk_recognition_result_fail_nfc">@string/onboard_sdk_recognition_result_fail</string>
  <string name="onboard_sdk_recognition_result_liveness_success">Liveness success</string>
  <string name="onboard_sdk_recognition_result_liveness_failed">Liveness failed</string>
  <string name="onboard_sdk_recognition_result_user_already_exists">User already exists</string>
  <string name="onboard_sdk_recognition_result_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_recognition_result_progress_title">Checking your photos</string>
  <string name="onboard_sdk_recognition_result_progress_subtitle">This may take a few seconds</string>
  <string name="onboard_sdk_questionmark" translatable="false">\?</string>

  <!-- ApproveActivity -->
  <string name="onboard_sdk_approve_success">Identity confirmed!</string>
  <string name="onboard_sdk_approve_fail">Your identity couldn’t be confirmed</string>

  <!-- GovernmentValidationActivity -->
  <string name="onboard_sdk_ine_validation_in_progress">Connecting to government check…</string>
  <string name="onboard_sdk_ine_validation_async">Identity submitted for verification</string>
  <string name="onboard_sdk_ine_validation_success">Identity verified!</string>
  <string name="onboard_sdk_ine_validation_failure">Identity not\nverified</string>
  <string name="onboard_sdk_ine_validation_connection_error">Government check connection error</string>
  <string name="onboard_sdk_ine_validation_ine_infrastructure_error">Government check infrastructure error</string>
  <string name="onboard_sdk_ine_validation_module_not_supported_error">Module not supported error</string>
  <string name="onboard_sdk_ine_validation_missing_document_identifier_error">Missing document identifier</string>
  <string name="onboard_sdk_ine_validation_missing_selfie_error">Missing selfie</string>
  <string name="onboard_sdk_ine_validation_user_not_found_error">User not found</string>
  <string name="onboard_sdk_ine_validation_user_not_in_database">User not in government check DB</string>
  <string name="onboard_sdk_ine_validation_insufficient_lookup_data">Insufficient lookup data</string>

  <!-- CaptchaActivity -->
  <string name="onboard_sdk_btn_submit">Submit</string>
  <string name="onboard_sdk_captcha_incorect_code">Incorrect code. Please try again.</string>
  <string name="onboard_sdk_captcha_general_error">Something went wrong. Please try again.</string>
  <string name="onboard_sdk_captcha_title">Please enter the\n following code</string>
  <plurals name="onboard_sdk_captcha_x_seconds_left">
      <item formatted="true" quantity="one">%d second left</item>
      <item formatted="true" quantity="other">%d seconds left</item>
  </plurals>
  <string name="onboard_sdk_captcha_generating_code">Generating new code…</string>

  <!-- VideoConferenceActivity -->
  <string name="onboard_sdk_conference_chat_send">Send</string>
  <string name="onboard_sdk_chat_hint">Write a message</string>
  <string name="onboard_sdk_chat_with">Chat with %1$s</string>

  <!-- CustomWatchlistActivity -->
  <string name="onboard_sdk_custom_watchlist_uploading_information">Uploading information…</string>
  <string name="onboard_sdk_custom_watchlist_processing_subtitle">This won’t take long.</string>
  <string name="onboard_sdk_custom_watchlist_result_success">Success</string>
  <string name="onboard_sdk_custom_watchlist_result_success_v2">Success!</string>
  <string name="onboard_sdk_custom_watchlist_result_fail">Could not process information</string>

  <!-- GlobalWatchlistActivity -->
  <string name="onboard_sdk_global_watchlist_title">Fill out your credentials</string>
  <string name="onboard_sdk_global_watchlist_process_result_description">This might take a while. Please keep the app opened…</string>
  <string name="onboard_sdk_global_watchlist_something_went_wrong">Something went wrong</string>
  <string name="onboard_sdk_global_watchlist_hint_nationality">Select</string>
  <string name="onboard_sdk_global_watchlist_name_form_hint">First Name</string>
  <string name="onboard_sdk_global_watchlist_name_form_title">First Name</string>
  <string name="onboard_sdk_global_watchlist_name_form_error_message">First name is required</string>
  <string name="onboard_sdk_global_watchlist_last_name_form_hint">Last Name</string>
  <string name="onboard_sdk_global_watchlist_last_name_form_title">Last Name</string>
  <string name="onboard_sdk_global_watchlist_last_name_form_error_message">Last name is required</string>
  <string name="onboard_sdk_global_watchlist_country_form_title">Country</string>
  <string name="onboard_sdk_global_watchlist_country_form_error_message">Country is required</string>
  <string name="onboard_sdk_global_watchlist_dob_form_hint" translatable="false">DD / MM / YYYY</string>
  <string name="onboard_sdk_global_watchlist_dob_form_title">Date of Birth</string>
  <string name="onboard_sdk_global_watchlist_dob_form_error_message">Date of Birth required</string>

  <!-- eKYB -->
  <string name="onboard_sdk_ekyb_title">Fill out your business credentials</string>
  <string name="onboard_sdk_ekyb_business">Business name</string>
  <string name="onboard_sdk_ekyb_error_name_mandatory">Business name cannot be empty</string>
  <string name="onboard_sdk_ekyb_house_number">House Number</string>
  <string name="onboard_sdk_ekyb_house_number_form_error_message">House number is required</string>
  <string name="onboard_sdk_ekyb_street">Street</string>
  <string name="onboard_sdk_ekyb_street_form_error_message">@string/onboard_sdk_ekyc_street_form_error_message</string>
  <string name="onboard_sdk_ekyb_business_address_2">Address 2 (optional)</string>
  <string name="onboard_sdk_ekyb_country">Country</string>
  <string name="onboard_sdk_ekyb_country_form_error_message">@string/onboard_sdk_ekyc_country_form_error_message</string>
  <string name="onboard_sdk_ekyb_city">City</string>
  <string name="onboard_sdk_ekyb_city_form_error_message">@string/onboard_sdk_ekyc_city_form_error_message</string>
  <string name="onboard_sdk_ekyb_state">State</string>
  <string name="onboard_sdk_ekyb_state_form_error_message">@string/onboard_sdk_ekyc_state_form_error_message</string>
  <string name="onboard_sdk_ekyb_zipcode">Postal code</string>
  <string name="onboard_sdk_ekyb_zipcode_form_error_message">@string/onboard_sdk_ekyc_postal_form_error_message</string>
  <string name="onboard_sdk_ekyb_tax_id">Tax ID number</string>
  <string name="onboard_sdk_ekyb_business_failure">Business not verified…</string>
  <string name="onboard_sdk_ekyb_btn_confirm">Confirm</string>

  <!-- EKYCActivity -->
  <string name="onboard_sdk_ekyc_country_us_string">United States</string>
  <string name="onboard_sdk_ekyc_country_us_key" translatable="false">US</string>
  <string name="onboard_sdk_ekyc_country_br_string">Brazil</string>
  <string name="onboard_sdk_ekyc_nationality_brazilian_string">BRAZILIAN</string>
  <string name="onboard_sdk_ekyc_nationality_naturalized_brazilian_string">NATURALIZED BRAZILIAN</string>
  <string name="onboard_sdk_ekyc_nationality_foreigner_string">FOREIGNER</string>
  <string name="onboard_sdk_ekyc_nationality_foreigner_key" translatable="false">foreigner</string>
  <string name="onboard_sdk_ekyc_nationality_brazilian_born_abroad_string">BRAZILIAN BORN ABROAD</string>
  <string name="onboard_sdk_ekyc_country_form_title">Country</string>
  <string name="onboard_sdk_ekyc_country_form_error_message">Country is required</string>
  <string name="onboard_sdk_ekyc_name_form_hint">Name</string>
  <string name="onboard_sdk_ekyc_name_form_title">First Name</string>
  <string name="onboard_sdk_ekyc_name_form_error_message">First name is required</string>
  <string name="onboard_sdk_ekyc_last_name_form_hint">Last Name</string>
  <string name="onboard_sdk_ekyc_last_name_form_title">Last Name</string>
  <string name="onboard_sdk_ekyc_last_name_form_error_message">Last name is required</string>
  <string name="onboard_sdk_ekyc_house_number_form_title">House Number</string>
  <string name="onboard_sdk_ekyc_house_number_form_hint">House Number</string>
  <string name="onboard_sdk_ekyc_house_number_form_error_message">House number is required</string>
  <string name="onboard_sdk_ekyc_street_form_hint">Street</string>
  <string name="onboard_sdk_ekyc_street_form_title">Street</string>
  <string name="onboard_sdk_ekyc_street_form_error_message">Street is required</string>
  <string name="onboard_sdk_ekyc_street_house_number_missing_message">House number is required</string>
  <string name="onboard_sdk_ekyc_postal_form_title">Postal code</string>
  <string name="onboard_sdk_ekyc_postal_form_error_message">Postal code is required</string>
  <string name="onboard_sdk_ekyc_postal_format_not_valid_message_us">Please enter a 5 or 9 digit Postal Code</string>
  <string name="onboard_sdk_ekyc_postal_format_not_valid_message_br">Please enter a 5 or 8 digit Postal Code</string>
  <string name="onboard_sdk_ekyc_state_form_hint">Any State</string>
  <string name="onboard_sdk_ekyc_state_form_title">State</string>
  <string name="onboard_sdk_ekyc_state_form_error_message">State is required</string>
  <string name="onboard_sdk_ekyc_city_form_hint">Any City</string>
  <string name="onboard_sdk_ekyc_city_form_title">City</string>
  <string name="onboard_sdk_ekyc_city_form_error_message">City is required</string>
  <string name="onboard_sdk_ekyc_email_form_hint" translatable="false">email@incode.com</string>
  <string name="onboard_sdk_ekyc_email_form_title">Email</string>
  <string name="onboard_sdk_ekyc_email_form_error_message">Email is required</string>
  <string name="onboard_sdk_ekyc_email_format_not_valid_message">Invalid email format</string>
  <string name="onboard_sdk_ekyc_phone_form_title">Phone Number</string>
  <string name="onboard_sdk_ekyc_phone_form_error_message">Phone is required</string>
  <string name="onboard_sdk_ekyc_phone_format_not_valid_message">Invalid phone format</string>
  <string name="onboard_sdk_ekyc_tax_id_form_us_title">SSN</string>
  <string name="onboard_sdk_ekyc_tax_id_form_br_title">CPF</string>
  <string name="onboard_sdk_ekyc_tax_id_form_us_error_message">SSN is required</string>
  <string name="onboard_sdk_ekyc_tax_id_form_br_error_message">CPF is required</string>
  <string name="onboard_sdk_ekyc_tax_id_format_not_valid_message_us">Please enter a valid number</string>
  <string name="onboard_sdk_ekyc_dob_form_hint" translatable="false">DD / MM / YYYY</string>
  <string name="onboard_sdk_ekyc_dob_form_title">Date of Birth</string>
  <string name="onboard_sdk_ekyc_dob_form_error_message">Date of Birth required</string>
  <string name="onboard_sdk_ekyc_nationality_form_error_message">Nationality is required</string>
  <string name="onboard_sdk_ekyc_nationality_form_title">Nationality</string>
  <string name="onboard_sdk_ekyc_main_title">Fill out your credentials</string>
  <string name="onboard_sdk_ekyc_invalid_text_error_message">This value seems invalid. Please recheck it.</string>
  <string name="onboard_sdk_ekyc_loading_message">Verifying…</string>
  <string name="onboard_sdk_ekyc_success_message">Verified!</string>
  <string name="onboard_sdk_ekyc_fail_message">Person not verified…</string>
  <string name="onboard_sdk_ekyc_btn_confirm">Confirm</string>

  <!-- ActivityResults -->
  <string name="onboard_sdk_error_token_expired">The access token has expired</string>
  <string name="onboard_sdk_results_yes">Yes</string>
  <string name="onboard_sdk_results_no">No</string>

  <string name="onboard_sdk_results_fetching_in_progress">Fetching results…</string>

  <string name="onboard_sdk_results_fragment_title_id_verification">ID Verification</string>
  <string name="onboard_sdk_results_fragment_title_liveness_check">Liveness Check</string>
  <string name="onboard_sdk_results_fragment_title_facial_recognition">Facial Recognition</string>
  <string name="onboard_sdk_results_fragment_title_government_validation">Government + Incode Check</string>

  <string name="onboard_sdk_results_needs_review">NEEDS REVIEW</string>
  <string name="onboard_sdk_id_verification_manual_check_needed">Manual check needed</string>

  <string name="onboard_sdk_section_title_photo_security_and_quality">Photo security &amp; quality</string>

  <string name="onboard_sdk_section_title_id_specific">ID specific</string>

  <string name="onboard_sdk_facial_recognition_label_selfie">Selfie</string>
  <string name="onboard_sdk_facial_recognition_label_id">ID Scan</string>

  <string name="onboard_sdk_facial_recognition_match">It’s a match!</string>
  <string name="onboard_sdk_facial_recognition_mismatch">No match</string>

  <string name="onboard_sdk_government_label_selfie">Incode Selfie</string>
  <string name="onboard_sdk_government_label_ine">Government Check Data</string>

  <string name="onboard_sdk_government_face_match">It’s a match!</string>
  <string name="onboard_sdk_government_face_mismatch">No match</string>

  <string name="onboard_sdk_section_title_ocr_validation">OCR Validation</string>

  <string name="onboard_sdk_choose_provider">Choose provider:</string>
  <string name="onboard_sdk_provider_incode">Incode</string>
  <string name="onboard_sdk_provider_nom151" translatable="false">NOM-151</string>

  <!-- UserConsentActivity -->
  <string name="onboard_sdk_user_consent_title">Consent for Biometric Processing</string>
  <string name="onboard_sdk_user_consent_description"><![CDATA[
  I consent to the capture, collection, enrollment, use, retention, processing, and disclosure of a scan of my face geometry (i.e. faceprint) and information derived from the barcode of the identification card I provide as follows:<br>
  <br>
  - **Purpose:** verifying my identity pursuant to Incode’s [Privacy Policy](https://policies.incodesmile.com/omni-privacy-mobile/)<br>
  <br>
  - **Data Collected:** facial geometry/faceprint/image; data contained in/obtained by scanning the barcode of a government-issued identification card provided by me (including, e.g., name, address, DOB, license type, sex, height, weight, eye color, ID number)<br>
  <br>
  - **Retention Period:** earliest of: (i) so long as necessary for identity verification purposes; or (ii) stated [Data Retention Period](https://policies.incodesmile.com/omni-privacy-mobile/#data-retention) (e.g. IL (3 yrs following last engagement), TX (1 yr following exhaustion of purpose)).
  ]]>
  </string>
  <string name="onboard_sdk_btn_reports">Reports</string>
  <string name="onboard_sdk_user_consent_btn_finish">I agree</string>
  <string name="onboard_sdk_btn_cancel">Cancel</string>
  <string name="onboard_sdk_user_consent_checkbox">I have read and agree to Incode’s [Privacy Policy](https://policies.incodesmile.com/omni-privacy-mobile/) and Incode’s [Terms of Use](https://policies.incodesmile.com/terms-of-use/).</string>
  <string name="onboard_sdk_user_consent_cancel_dialog_title">User consent is mandatory</string>
  <string name="onboard_sdk_user_consent_cancel_dialog_message">Are you sure you want to quit the process?</string>
  <string name="onboard_sdk_user_consent_cancel_dialog_button_positive">Quit</string>
  <string name="onboard_sdk_user_consent_cancel_dialog_button_negative">Continue</string>
  <!-- CombinedConsentActivity -->
  <string name="onboard_sdk_combined_consent_required_label">(required)</string>
  <string name="onboard_sdk_combined_consent_open_link_action">Open link</string>
  <string name="onboard_sdk_report_not_available">Sorry, report is not available at the moment.</string>
  <string name="onboard_sdk_show_report_app_unavailable">Sorry, there is no PDF viewer app installed on this device. Please install it first.</string>
  <string name="onboard_sdk_qr_scan_not_operational">QR scan not ready. Please update Google Play Services.</string>

  <string name="onboard_sdk_property_tamperCheck">Tamper Check</string>
  <string name="onboard_sdk_property_postitCheck">Postit Check</string>
  <string name="onboard_sdk_property_alignment">Alignment</string>
  <string name="onboard_sdk_property_fakeCheck">Fake Check</string>
  <string name="onboard_sdk_property_idLiveness">ID Liveness</string>
  <string name="onboard_sdk_property_screenIdLiveness">Screen Id Liveness</string>
  <string name="onboard_sdk_property_paperIdLiveness">Paper Id Liveness</string>
  <string name="onboard_sdk_property_readabilityCheck">Readability Check</string>
  <string name="onboard_sdk_property_balancedLightFront">Balanced light (front side)</string>
  <string name="onboard_sdk_property_balancedLightBack">Balanced light (back side)</string>
  <string name="onboard_sdk_property_sharpnessFront">Sharpness (front side)</string>
  <string name="onboard_sdk_property_sharpnessBack">Sharpness (back side)</string>
  <string name="onboard_sdk_property_incodeTamperCheck">Incode TamperCheck</string>
  <string name="onboard_sdk_property_incodeFakeCheck">Incode FakeCheck</string>
  <string name="onboard_sdk_property_incodeCrossCheck">Incode CrossCheck</string>
  <string name="onboard_sdk_property_incodeIdLiveness">Incode ID Liveness</string>
  <string name="onboard_sdk_property_qrCheck">QR check</string>
  <string name="onboard_sdk_property_issueDateCheck">Issue Date Check</string>
  <string name="onboard_sdk_property_documentIdCheck">Document ID Check</string>
  <string name="onboard_sdk_property_2DBarcodeRead">2D Barcode Read</string>
  <string name="onboard_sdk_property_birthDateCheckDigit">Birth Date Check Digit</string>
  <string name="onboard_sdk_property_birthDateCrosscheck">Birth Date Crosscheck</string>
  <string name="onboard_sdk_property_birthDateValidity">Birth Date Valid</string>
  <string name="onboard_sdk_property_underageCheck">Underage Check</string>
  <string name="onboard_sdk_property_compositeCheckDigit">Composite Check Digit</string>
  <string name="onboard_sdk_property_documentClassification">Document Classification</string>
  <string name="onboard_sdk_property_documentCrosscheckAggregation">Document Crosscheck Aggregation</string>
  <string name="onboard_sdk_property_documentExpired">Document Expired</string>
  <string name="onboard_sdk_property_documentNumberCheckDigit">Document Number Check Digit</string>
  <string name="onboard_sdk_property_documentNumberCrosscheck">Document Number Crosscheck</string>
  <string name="onboard_sdk_property_documentTypeSideCrosscheck">Document Type Side Crosscheck</string>
  <string name="onboard_sdk_property_expirationDateCheckDigit">Expiration Date Check Digit</string>
  <string name="onboard_sdk_property_expirationDateCrosscheck">Expiration Date Crosscheck</string>
  <string name="onboard_sdk_property_expirationDateValidity">Expiration Date Valid</string>
  <string name="onboard_sdk_property_documentSeriesExpired">Document Series Expired</string>
  <string name="onboard_sdk_property_fullNameCrosscheck">Full Name Crosscheck</string>
  <string name="onboard_sdk_property_imageTamperingCheck">Image Tampering Check</string>
  <string name="onboard_sdk_property_issueDateValidity">Issue Date Valid</string>
  <string name="onboard_sdk_property_issuingStateValidity">Issuing State Valid</string>
  <string name="onboard_sdk_property_qrScan">QR Scan</string>
  <string name="onboard_sdk_property_photoPrinting">Photo Printing</string>
  <string name="onboard_sdk_property_personalNumberCrosscheck">Personal Number Crosscheck</string>
  <string name="onboard_sdk_property_sexCrosscheck">Sex Crosscheck</string>
  <string name="onboard_sdk_property_visibleColorResponse">Visible Color Response</string>
  <string name="onboard_sdk_property_visiblePattern">Visible Pattern</string>
  <string name="onboard_sdk_property_visiblePhotoFeatures">Visible Photo Features</string>
  <string name="onboard_sdk_property_emissionNumberCrosscheck">Emission Number Crosscheck</string>
  <string name="onboard_sdk_property_liveness_score">Liveness Score</string>
  <string name="onboard_sdk_property_photo_quality">Photo Quality</string>
  <string name="onboard_sdk_property_user_already_in_database">User already in database</string>
  <string name="onboard_sdk_property_photo_comparison">Photo Comparison</string>
  <string name="onboard_sdk_property_issueDate">Issue Date Valid</string>
  <string name="onboard_sdk_property_firstName">First Name Valid</string>
  <string name="onboard_sdk_property_maternalLastName">Maternal Last Name Valid</string>
  <string name="onboard_sdk_property_paternalLastName">Paternal Last Name Valid</string>
  <string name="onboard_sdk_property_ocr">OCR Valid</string>
  <string name="onboard_sdk_property_personalId">Personal Id Valid</string>
  <string name="onboard_sdk_property_electorsKey">Electors Key Valid</string>
  <string name="onboard_sdk_property_emissionNumber">Emission Number Valid</string>
  <string name="onboard_sdk_property_registrationDate">Registration Date Valid</string>
  <string name="onboard_sdk_results_btn_done">Done</string>

  <!-- NoNetworkSnackbar -->
  <string name="onboard_sdk_no_network_snackbar_content_text">No internet connection</string>
  <string name="onboard_sdk_no_network_snackbar_action_text">Retry</string>
  <string name="onboard_sdk_no_network_snackbar_warning_icon_content_description">warning icon</string>

  <!-- Delayed Onboarding -->
  <string name="onboard_sdk_you_are_offline">You’re offline</string>
  <string name="onboard_sdk_offline_onboarding_description">If you do the onboarding offline, you’ll have to sync the data when you restore connectivity.</string>
  <string name="onboard_sdk_no_connection">No connection</string>

  <!-- AESActivity -->
  <string name="onboard_sdk_aes_title">Confirm your signature</string>
  <string name="onboard_sdk_aes_documents_list_title">The following documents will be signed:</string>
  <string name="onboard_sdk_aes_documents_list_item_title">Contract %d</string>
  <string name="onboard_sdk_aes_documents_list_item_view_doc">View doc</string>
  <string name="onboard_sdk_aes_checkbox_terms_and_condtions">I accept the terms and conditions of the Trust Center</string>
  <string name="onboard_sdk_aes_checkbox_generate_certificate">I wish to sign the contract electronically. Please generate the required certificate for me</string>
  <string name="onboard_sdk_aes_checkbox_legal_binding">I would like to sign the displayed contract in a legally binding way by means of the ensuing signature procedures</string>
  <string name="onboard_sdk_aes_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_aes_success">Success!</string>
  <string name="onboard_sdk_aes_something_went_wrong">Something went wrong.</string>
  <string name="onboard_sdk_aes_open_pdf_error">Please install an app that can open a PDF</string>
  <string name="onboard_sdk_aes_signing_title">Document signing in progress. Please wait, this may take some time.</string>
  <string name="onboard_sdk_aes_confirmed_signature_title">Confirmed signature!</string>
  <string name="onboard_sdk_aes_confirmed_signature_documents_list_title">The following documents were signed:</string>
  <string name="onboard_sdk_aes_btn_continue_and_finish">Continue and finish</string>
  <string name="onboard_sdk_aes_upload_screen_error_file_type">Please select a PDF file</string>

  <!-- AES V2 -->
  <string name="onboard_sdk_aes_upload_title">Upload a document to sign</string>
  <string name="onboard_sdk_aes_upload_subtitle">Supports PDF files</string>
  <string name="onboard_sdk_aes_upload_btn">Upload document</string>
  <string name="onboard_sdk_aes_review_title">Review your document</string>
  <string name="onboard_sdk_aes_review_subtitle">Make sure you’ve selected the correct file before you continue to sign.</string>
  <string name="onboard_sdk_aes_review_btn_replace">Replace</string>
  <string name="onboard_sdk_aes_encrypted_disclaimer">All data is encrypted</string>
  <string name="onboard_sdk_aes_accept_title">Accept and sign</string>
  <string name="onboard_sdk_aes_accept_subtitle">Please accept the terms below to complete your signature.</string>
  <string name="onboard_sdk_aes_consent_terms_conditions">I accept the Terms and Conditions of the [Trust Center](%1$s).</string>
  <string name="onboard_sdk_aes_consent_generate_certificate">I request to sign this contract electronically and to have the required digital certificate issued to me.</string>
  <string name="onboard_sdk_aes_consent_legal_binding">I confirm that I wish to sign this contract in a legally binding manner using the applicable electronic signature procedures.</string>
  <string name="onboard_sdk_aes_btn_finish_signing">Finish signing</string>
  <string name="onboard_sdk_aes_view_document">View</string>
  <string name="onboard_sdk_aes_view_document_position">View document %1$d of %2$d</string>
  <string name="onboard_sdk_aes_document_name">Contract.pdf</string>
  <string name="onboard_sdk_aes_document_name_position">Contract %1$d.pdf</string>
  <string name="onboard_sdk_aes_viewer_title">View document</string>
  <string name="onboard_sdk_aes_viewer_loading">Loading document…</string>
  <string name="onboard_sdk_aes_viewer_page_of">Page %1$d of %2$d</string>
  <string name="onboard_sdk_aes_viewer_zoom_in">Zoom in</string>
  <string name="onboard_sdk_aes_viewer_zoom_out">Zoom out</string>
  <string name="onboard_sdk_aes_processing">Processing…</string>
  <string name="onboard_sdk_aes_success_title">Signed successfully!</string>
  <string name="onboard_sdk_aes_error_generic_title">Something went wrong</string>
  <string name="onboard_sdk_aes_error_signature_title">Signature failed</string>
  <string name="onboard_sdk_aes_btn_try_again">Try again</string>
  <string name="onboard_sdk_aes_download_document">Download document</string>
  <string name="onboard_sdk_aes_download_document_position">Download document %1$d</string>
  <string name="onboard_sdk_aes_download_document_position_voice_over">Download document %1$d of %2$d</string>
  <string name="onboard_sdk_aes_download_document_started">Downloading PDF…</string>
  <string name="onboard_sdk_aes_download_document_error">Unable to download the PDF</string>

  <!-- QESActivity -->
  <string name="onboard_sdk_qes_title">Confirm your signature</string>
  <string name="onboard_sdk_qes_documents_list_title">The following documents will be signed:</string>
  <string name="onboard_sdk_qes_documents_list_item_title">Contract %d</string>
  <string name="onboard_sdk_qes_documents_list_item_view_doc">View doc</string>
  <string name="onboard_sdk_qes_checkbox_terms_and_conditions">I have read and agree to Incode’s [Privacy Policy](https://policies.incodesmile.com/omni-privacy-mobile/) and Incode’s [Terms of Use](https://policies.incodesmile.com/terms-of-use/).</string>
  <string name="onboard_sdk_qes_checkbox_generate_certificate">I agree to the issuance of the required certificate and to signing this document electronically.</string>
  <string name="onboard_sdk_qes_btn_continue">@string/onboard_sdk_btn_continue</string>
  <string name="onboard_sdk_qes_success">Success!</string>
  <string name="onboard_sdk_qes_something_went_wrong">Something went wrong.</string>
  <string name="onboard_sdk_qes_open_pdf_error">Please install an app that can open a PDF</string>
  <string name="onboard_sdk_qes_signing_title">Document signing in progress. Please wait, this may take some time.</string>
  <string name="onboard_sdk_qes_confirmed_signature_title">Confirmed signature!</string>
  <string name="onboard_sdk_qes_confirmed_signature_documents_list_title">The following documents were signed:</string>
  <string name="onboard_sdk_qes_btn_continue_and_finish">Continue and finish</string>
  <string name="onboard_sdk_qes_signed_document">Your document has been signed.</string>
  <string name="onboard_sdk_qes_download_document_title">Download your document</string>
  <string name="onboard_sdk_qes_download_document_description">Your signed document is ready. Save it securely for your records or to share as needed.</string>
  <string name="onboard_sdk_qes_download_document_btn_title">Download Document</string>
  <string name="onboard_sdk_qes_download_pdf_position">Download PDF %1$d</string>
  <string name="onboard_sdk_qes_download_pdf_position_voice_over">Download PDF %1$d of %2$d</string>
  <string name="onboard_sdk_qes_download_document_position">Download document %1$d</string>
  <string name="onboard_sdk_qes_download_document_position_voice_over">Download document %1$d of %2$d</string>
  <string name="onboard_sdk_qes_document_name">Contract.pdf</string>
  <string name="onboard_sdk_qes_document_name_position">Contract %1$d.pdf</string>

  <!-- QES V2: Provider Review & Sign -->
  <string name="onboard_sdk_qes_certificate_application_form">Certificate application form</string>
  <string name="onboard_sdk_qes_certificate_application_form_title">Certificate application form</string>

  <!-- AntifraudActivity -->
  <string name="onboard_sdk_antifraud_process">Processing…</string>

  <!-- IdCaptureCamera -->
  <string name="onboard_sdk_id_capture_error_title">ID scan failed</string>
  <string name="onboard_sdk_id_capture_error_unacceptable_title">ID document not accepted</string>
  <string name="onboard_sdk_id_capture_error_unacceptable_empty_list_title">No documents accepted\n for this country</string>
  <string name="onboard_sdk_id_capture_accepted_documents_for_country">Accepted documents for:</string>
  <string name="onboard_sdk_id_capture_error_glare_title">Glare present</string>
  <string name="onboard_sdk_id_capture_error_glare">Tilt the ID slightly up or down to minimize the reflection</string>
  <string name="onboard_sdk_id_capture_error_blur_title">Blur present</string>
  <string name="onboard_sdk_id_capture_error_blur">Move ID further away or closer to your phone until the image is focused</string>
  <string name="onboard_sdk_id_capture_error_missing_document">ID scan failed</string>
  <string name="onboard_sdk_id_capture_error_side_title">Wrong document side</string>
  <string name="onboard_sdk_id_capture_error_side_front">Capture the front side of the ID</string>
  <string name="onboard_sdk_id_capture_error_side_back">Capture the back side of the ID</string>
  <string name="onboard_sdk_id_capture_error_unacceptable">Use a different ID from the accepted list:</string>
  <string name="onboard_sdk_id_capture_error_shadow"></string>
  <string name="onboard_sdk_id_capture_error_readability_title">Info is not readable</string>
  <string name="onboard_sdk_id_capture_error_readability">Minimize camera shake by holding your phone steady</string>
  <string name="onboard_sdk_id_capture_encrypted_photos_disclaimer">All data is encrypted</string>
  <string name="onboard_sdk_id_capture_retry">Refresh</string>
  <string name="onboard_sdk_id_capture_processing_your_id_description">%1$s. We are processing your ID.</string>

  <!-- BiometricConsentActivity -->
  <string name="onboard_sdk_bio_consent_default_title">Request for biometric processing</string>
  <string name="onboard_sdk_bio_consent_desc">Your verification is powered by Incode. To comply with state regulations, we need your consent for biometric processing.</string>
  <string name="onboard_sdk_bio_consent_default_text">I consent to Incode’s collection, use, retention, and disclosure of my biometric information (i.e. faceprint) and information derived from scanning the barcode of my identification card to verify my identity, and to Incode’s Privacy Policy.\nIncode permanently deletes biometric information by the earlier of (i) the time at which the purpose for which it was collected has been satisfied or (ii) three years after my last interaction with Incode.</string>

  <!-- Dynamic Forms -->
  <string name="onboard_sdk_dynamic_forms_input_text_hint">Write your answer here…</string>
  <string name="onboard_sdk_dynamic_forms_date_hint">Enter date</string>
  <string name="onboard_sdk_dynamic_forms_country_selector_hint">Search for country</string>
  <string name="onboard_sdk_dynamic_forms_phone_format_not_valid_message">Invalid phone format</string>
  <string name="onboard_sdk_dynamic_forms_tax_id_format_not_valid_message_us">Please enter a valid number</string>
  <string name="onboard_sdk_dynamic_forms_email_format_not_valid_message">Invalid email format</string>

  <!-- Kiosk Login -->
  <string name="onboard_sdk_kiosk_login_feedback_position_your_face">@string/onboard_sdk_feedback_position_your_face</string>
  <string name="onboard_sdk_kiosk_login_feedback_face_tilted">@string/onboard_sdk_feedback_face_tilted</string>
  <string name="onboard_sdk_kiosk_login_feedback_face_rotated_left">@string/onboard_sdk_feedback_face_rotated_left</string>
  <string name="onboard_sdk_kiosk_login_feedback_face_rotated_right">@string/onboard_sdk_feedback_face_rotated_right</string>
  <string name="onboard_sdk_kiosk_login_feedback_remove_lenses">@string/onboard_sdk_feedback_remove_lenses</string>
  <string name="onboard_sdk_kiosk_login_feedback_user_not_found">You’re not enrolled</string>
  <string name="onboard_sdk_kiosk_login_lid_uploading">@string/onboard_sdk_selfie_uploading</string>
  <string name="onboard_sdk_kiosk_login_lid_done">Done!</string>

  <!-- Accessibility pane titles (announced by TalkBack on screen transitions) -->
  <string name="onboard_sdk_age_verification_tutorial_pane_title">Age verification tutorial</string>
  <string name="onboard_sdk_id_capture_tutorial_pane_title">ID capture tutorial</string>
  <string name="onboard_sdk_id_capture_pane_title">ID capture screen</string>
  <string name="onboard_sdk_document_selection_pane_title">Document selection</string>
  <string name="onboard_sdk_digital_id_upload_pane_title">Digital ID upload screen</string>
  <string name="onboard_sdk_digital_id_upload_error_pane_title">Digital ID upload error</string>
  <string name="onboard_sdk_digital_id_upload_success_pane_title">Digital ID upload success</string>
  <string name="onboard_sdk_review_digital_id_pane_title">Review digital ID</string>
  <string name="onboard_sdk_wallet_id_upload_error_pane_title">Wallet ID upload error</string>
  <string name="onboard_sdk_face_capture_pane_title">Face capture screen</string>
  <string name="onboard_sdk_face_capture_tutorial_pane_title">Face capture tutorial</string>
  <string name="onboard_sdk_face_match_pane_title">Face match</string>

  <!-- NFC scan help and input-field validation strings -->
  <string name="onboard_sdk_date_field_open_calendar_voice_over">Open calendar</string>
  <string name="onboard_sdk_date_field_invalid_date_error">Enter a valid date in DD/MM/YYYY format</string>
  <string name="onboard_sdk_email_format_not_valid_message">Invalid email format</string>
  <string name="onboard_sdk_no_nfc_hardware_unable_to_continue_title">We’re sorry, you’re unable to continue the process</string>
  <string name="onboard_sdk_no_nfc_hardware_allowed_documents_instruction">Only passports and phones with NFC are allowed.</string>
  <string name="onboard_sdk_nfc_settings_title">Enable NFC scanning</string>
  <string name="onboard_sdk_nfc_settings_subtitle">To read your document, NFC needs to be enabled. Tap below and we’ll take you straight to the right setting.</string>
  <string name="onboard_sdk_nfc_settings_open_button">Open Settings</string>
  <string name="onboard_sdk_scan_passport_title_page">Scan the %1$s</string>
  <string name="onboard_sdk_scan_passport_title_back_text_to_highlight">back page</string>
  <string name="onboard_sdk_scan_id_instruction_start">Hold your phone close to the ID. Make sure they are touching, and hold still until scanning is complete.</string>
  <string name="onboard_sdk_nfc_scan_modal_title_scanning">Scanning…</string>
  <string name="onboard_sdk_nfc_scan_modal_title_success">Done</string>
  <string name="onboard_sdk_nfc_scan_modal_instruction_scanning">Processing, don’t move your phone</string>
  <string name="onboard_sdk_nfc_scan_modal_instruction_scanned">Successfully scanned!</string>
  <string name="onboard_sdk_nfc_scan_modal_hold_still">Hold still…</string>
  <string name="onboard_sdk_nfc_processing_title">Processing…</string>
  <string name="onboard_sdk_nfc_processing_subtitle">We’re verifying your identity</string>
  <string name="onboard_sdk_nfc_scan_help_button">Help</string>
  <string name="onboard_sdk_nfc_scan_help_title">Common issues</string>
  <string name="onboard_sdk_nfc_scan_help_passport_in_cover">Passport is in cover</string>
  <string name="onboard_sdk_nfc_scan_help_phone_too_far">Phone is far away from the document</string>
  <string name="onboard_sdk_nfc_scan_help_passport_chip_on_another_page">Chip is on another page in the passport</string>
  <string name="onboard_sdk_nfc_scan_help_phone_moved">Moving the phone while scanning has initiated</string>
  <string name="onboard_sdk_nfc_scan_help_phone_cover_interference">Phone cover interferes with the scan</string>
  <string name="onboard_sdk_nfc_scan_help_try_again_button">OK, try again</string>
  <string name="onboard_sdk_nfc_scan_result_identity_verified">Identity successfully verified</string>
```
</Accordion>



## Add Custom Supplemental Text

The [Selfie Scan](/sdk-reference/android-selfie-scan/) and [Video Selfie](/sdk-reference/android-video-selfie/) modules let you add custom supplemental text near the bottom of their screens, alongside the existing text.

Override the following string resources to insert custom text. These can be overridden in [strings.xml](#override-stringsxml) or using [dynamic localization](#dynamic-localization):

- Selfie: `onboard_sdk_face_scan_custom_message`
- VideoSelfie: `onboard_sdk_vs_custom_message`



## Replace Videos with Custom Videos

The SDK uses Lottie animations for videos. To use your own videos, put the matching Lottie `.json` or `.lottie` files in your `res/raw` directory.

Android raw resources are referenced by name only, without the file extension. Your replacement file must use the **same name** as the original, but it doesn't need to match the original file extension. For example, you can replace `onboard_sdk_lottie_tutorial_selfie_v2.lottie` with a file named `onboard_sdk_lottie_tutorial_selfie_v2.json`, or replace a `.json` file with a `.lottie` file the same way.

### Tutorial Animations: V1

| File | Screen |
|---|---|
| `onboard_sdk_lottie_tutorial_id_front.json` | ID front tutorial |
| `onboard_sdk_lottie_tutorial_id_back.json` | ID back tutorial |
| `onboard_sdk_lottie_tutorial_passport.json` | Passport tutorial |
| `onboard_sdk_lottie_tutorial_selfie.json` | Selfie tutorial |
| `onboard_sdk_lottie_tutorial_qr_scan.json` | QR scan tip |

### Tutorial Animations: V2

| File | Screen |
|---|---|
| `onboard_sdk_lottie_tutorial_selfie_v2.lottie` | [Selfie Scan](/sdk-reference/android-selfie-scan/) tutorial |
| `onboard_sdk_id_capture_tutorial_id.lottie` | [ID Scan](/sdk-reference/android-id-scan/) tutorial |
| `onboard_sdk_id_capture_tutorial_passport.lottie` | Passport capture tutorial |
| `onboard_sdk_id_capture_tutorial_barcode.lottie` | Barcode capture tutorial |

### ID Capture Animations: V2

| File | Screen |
|---|---|
| `onboard_sdk_id_capture_flip.json` | ID capture: flip card prompt |
| `onboard_sdk_id_capture_laser_id.json` | ID capture: scanning laser |
| `onboard_sdk_id_capture_laser_id_vertical.json` | ID capture: vertical scanning laser |
| `onboard_sdk_id_capture_laser_passport.json` | Passport capture: scanning laser |
| `onboard_sdk_id_capture_laser_passport_vertical.json` | Passport capture: vertical scanning laser |

### ID Capture Feedback Animations: V2

| File | Screen |
|---|---|
| `onboard_sdk_id_capture_align.lottie` | ID capture: alignment suggestion |
| `onboard_sdk_id_capture_blur.lottie` | ID capture: blur detected |
| `onboard_sdk_id_capture_glare.lottie` | ID capture: glare detected |
| `onboard_sdk_id_capture_too_dark.lottie` | ID capture: too dark |
| `onboard_sdk_id_capture_wrong_id_side_front.lottie` | ID capture: wrong side, front |
| `onboard_sdk_id_capture_wrong_id_side_back.lottie` | ID capture: wrong side, back |

### Other Animations

| File | Screen |
|---|---|
| `onboard_sdk_lottie_id_processing.json` | ID processing |
| `onboard_sdk_lottie_error_selfie_positioning.json` | [Selfie Scan](/sdk-reference/android-selfie-scan/) error feedback |

### Lottie Files for the Optional NFC Dependency

| File | Screen |
|---|---|
| `onboard_sdk_lottie_android_nfc_id_modal_animation.json` | [NFC Scan](/sdk-reference/android-nfc-scan-2/) bottom sheet: ID |
| `onboard_sdk_lottie_android_nfc_passport_modal_animation.json` | NFC Scan bottom sheet: Passport |
| `onboard_sdk_lottie_tutorial_nfc_scan_1.json` | NFC Scan tutorial: step 1 |
| `onboard_sdk_lottie_tutorial_nfc_scan_2.json` | NFC Scan tutorial: step 2 |
| `onboard_sdk_lottie_tutorial_nfc_scan_3.json` | NFC Scan tutorial: step 3 |
| `onboard_sdk_lottie_tutorial_nfc_scan_4.json` | NFC Scan tutorial: step 4 |
| `onboard_sdk_lottie_tutorial_nfc_scan_front_cover.json` | NFC Scan tutorial: front cover |
| `onboard_sdk_lottie_tutorial_nfc_scan_id.json` | NFC Scan tutorial: ID |



## Enable V2 UI

Contact your Incode representative to enable the v2 (Jetpack Compose) UI. The v2 modules are opt-in. How you turn them on depends on how you start onboarding.

- **Server-driven Flows and Workflows:** Use `startFlow()` or `startWorkflow()` to start onboarding. In Dashboard, open the Flow or Workflow, click the **Settings** tab, and turn on **Enable new user experience**. The SDK reads the UX version when it fetches this configuration. You don't need to change any code.
- **Client-configured Flows:** Use `startOnboarding()` to start onboarding. These flows have no server configuration to carry the UX version. Opt in explicitly at initialization with `setClientExperimentId("experimentV2")`:

```kotlin
IncodeWelcome.Builder(application, API_URL, API_KEY)
    .setClientExperimentId("experimentV2")
    // ... other configuration
    .build()
```

```java
new IncodeWelcome.Builder(application, API_URL, API_KEY)
    .setClientExperimentId("experimentV2")
    // ... other configuration
    .build();
```

`setClientExperimentId("experimentV2")` opts every supported module into the v2 UI.

:::info
Coordinate with Your ECSM. `setClientExperimentId` drives A/B experiments and can change the UX broadly. Confirm the right value and approach with your Enterprise Customer Success Manager (ECSM) before you ship.


:::

## Configure V2 Theme and UX

The V2 modules were built using Jetpack Compose. To support customization, Incode offers a tool that follows this architecture. It supports two types of customization: Theme and UX. You can configure both through JSON with one call to `setUIConfigFromJson` (see [Theme and UX Configuration from a single JSON](#theme-and-ux-configuration-from-a-single-json)), or through their own configuration objects.

### Theme Configuration via JSON

:::note
`IncodeThemeConfig.fromJson` is deprecated since 5.55.0 and continues to work. The example below uses the flat shape that `fromJson` accepts. For new integrations, use `setUIConfigFromJson` and put this content under a `theme` key; see [Theme and UX Configuration from a single JSON](#theme-and-ux-configuration-from-a-single-json).
:::

<Accordion title="View an example JSON configuration">
  The example below groups color tokens by purpose: neutrals for backgrounds, brand colors for buttons and links, gray shades for general UI, a secondary brand accent, and status colors for errors, warnings, and success states.

  ```kotlin
  val json = """
  {
    "displayMode": "light",
    "typography": {
      "family": {
        "text": {
          "android": {
            "regular": "onboard_sdk_dm_sans_regular",
            "bold": "onboard_sdk_dm_sans_bold",
            "medium": "onboard_sdk_dm_sans_medium"
          },
          "ios": {
            "regular": "DMSans-Regular",
            "bold": "DMSans-Bold",
            "medium": "DMSans-Medium"
          }
        },
        "display": {
          "android": {
            "regular": "onboard_sdk_dm_sans_regular",
            "bold": "onboard_sdk_dm_sans_bold",
            "medium": "onboard_sdk_dm_sans_medium"
          },
          "ios": {
            "extraBold": "DMSans-ExtraBold"
          }
        }
      },
      "letterSpacing": {
        "none": 0,
        "medium": -0.5,
        "large": -1.0,
        "extraLarge": -1.5
      }
    },
    "colorPalette": {
      "neutralLight": "#ffffff",
      "neutralDark": "#000000",
      "brand50": "#e5f0ff",
      "brand200": "#99c3ff",
      "brand300": "#66a6ff",
      "brand400": "#3388ff",
      "brand500": "#006aff",
      "brand600": "#0055cc",
      "brand900": "#21273b",
      "gray50": "#FCFCFD",
      "gray100": "#EBECEF",
      "gray150": "#D9DAE1",
      "gray200": "#C6C8D2",
      "gray250": "#B5B8C5",
      "gray300": "#A3A8B8",
      "gray500": "#60667C",
      "gray600": "#4D5264",
      "gray700": "#3A3E4B",
      "gray750": "#30333E",
      "gray800": "#262831",
      "gray900": "#14151A",
      "gray1000": "#000000",
      "brandSecondary50": "#F2E2FE",
      "brandSecondary500": "#820AD1",
      "negative50": "#FFF0F0",
      "negative400": "#FF5A5F",
      "negative500": "#E71111",
      "negative950": "#240001",
      "warning50": "#FFF7EB",
      "warning400": "#FFB647",
      "warning500": "#FF9900",
      "warning950": "#523100",
      "positive50": "#E4FBF0",
      "positive400": "#45B380",
      "positive500": "#189F60",
      "positive750": "#0C5030",
      "positive950": "#03190E",
      "focus400": "#0099FF",
      "focus500": "#006AFF"
    },
    "components": {
      "buttons": [
        {
          "style": "primary",
          "surface": {
            "default": ["#000000", "#E8E8E8"],
            "hover": "#04FF5C",
            "pressed": "#00B540",
            "disabled": ["#EBECEF", "#000000"]
          },
          "text": {
            "default": ["#FFFFFF", "#000000"],
            "hover": ["#FFFFFF", "#000000"],
            "pressed": ["#FFFFFF", "#000000"],
            "disabled": ["#959595", "#666666"]
          },
          "border": {
            "color": {
              "default": "#00D149",
              "hover": "#04FF5C",
              "pressed": "#00B540",
              "disabled": "#EBECEF"
            },
            "width": 0,
            "radius": 15
          }
        }
      ]
    }
  }
  """
  ```
</Accordion>

Provide it to the SDK like this:

```kotlin
IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setThemeConfig(IncodeThemeConfig.fromJson(context, json))
        .build()
)
```
```java
IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setThemeConfig(IncodeThemeConfig.fromJson(context, json))
        .build());
```



- `displayMode` can be `"light"`, `"dark"`, or `"system"`. If not set, the default is `"light"`.
- `typography/family/text/android/variable` takes priority over statically provided fonts. If you set it, the SDK ignores other fields in the same object and uses the variable.
- When you apply JSON, your resources must include fonts with the predefined names, or parsing fails. For example, if you set `typography/family/text/android/variable` to `"dm_sans_variable"`, your project must contain `R.font.dm_sans_variable`.
- `letterSpacing` is defined in sp units on Android.
- All properties are optional.
- `colorPalette.positive800` was renamed to `positive750` in 5.54.0. See the [Migration Guide](/release-notes/migration-guide) if you were setting it directly.
- `components.buttons[].text` supports `hover` and `pressed`, applied to the button label the same way `surface.hover`/`surface.pressed` apply to the button background.

### Theme Configuration via Object

<Accordion title="View an example object configuration">

  ```kotlin
  import androidx.compose.ui.graphics.Color
  import androidx.compose.ui.text.font.Font
  import androidx.compose.ui.text.font.FontFamily
  import androidx.compose.ui.text.font.FontWeight
  import androidx.compose.ui.unit.dp
  import androidx.compose.ui.unit.sp
  import com.incode.welcome_sdk.CommonConfig
  import com.incode.welcome_sdk.DisplayMode
  import com.incode.welcome_sdk.IncodeWelcome
  import com.incode.welcome_sdk.commons.theme.ButtonBorder
  import com.incode.welcome_sdk.commons.theme.ButtonBorderColor
  import com.incode.welcome_sdk.commons.theme.ButtonSurface
  import com.incode.welcome_sdk.commons.theme.ButtonText
  import com.incode.welcome_sdk.commons.theme.ColorState
  import com.incode.welcome_sdk.commons.theme.IncodeButtonStyle
  import com.incode.welcome_sdk.commons.theme.IncodeColorPalette
  import com.incode.welcome_sdk.commons.theme.IncodeComponents
  import com.incode.welcome_sdk.commons.theme.IncodeThemeConfig
  import com.incode.welcome_sdk.commons.theme.IncodeTypography
  import com.incode.welcome_sdk.views.composables.IncodeButtonStyleName

  IncodeWelcome
      .getInstance()
      .setCommonConfig(
          CommonConfig.Builder()
              .setThemeConfig(
                  IncodeThemeConfig(
                      displayMode = DisplayMode.SYSTEM,
                      typography = IncodeTypography(
                          family = IncodeTypography.Family(
                              text = FontFamily(
                                  Font(R.font.onboard_sdk_dm_sans_regular, FontWeight.Normal),
                                  Font(R.font.onboard_sdk_dm_sans_medium, FontWeight.Medium),
                                  Font(R.font.onboard_sdk_dm_sans_bold, FontWeight.Bold)
                              ),
                              display = FontFamily.SansSerif
                          ),
                          letterSpacing = IncodeTypography.LetterSpacing(
                              none = 0f.sp,
                              medium = (-0.5f).sp,
                              large = (-1.0f).sp,
                              extraLarge = (-1.5f).sp
                          ),
                          fontWeight = IncodeTypography.Weight(
                              regular = FontWeight.Normal,
                              medium = FontWeight.Medium,
                              bold = FontWeight.Bold,
                              extraBold = FontWeight.ExtraBold
                          ),
                      ),
                      colorPalette = IncodeColorPalette(
                          neutralLight = Color(0xffffffff),
                          neutralDark = Color(0xff000000),
                          brand50 = Color(0xffe5f0ff),
                          brand200 = Color(0xff99c3ff),
                          brand300 = Color(0xff66a6ff),
                          brand400 = Color(0xff3388ff),
                          brand500 = Color(0xff006aff),
                          brand600 = Color(0xff0055cc),
                          brand900 = Color(0xff21273b),
                          gray50 = Color(0xfffcfcfd),
                          gray100 = Color(0xffebecef),
                          gray150 = Color(0xffd9dae1),
                          gray200 = Color(0xffc6c8d2),
                          gray250 = Color(0xffb5b8c5),
                          gray300 = Color(0xffa3a8b8),
                          gray500 = Color(0xff60667c),
                          gray600 = Color(0xff4d5264),
                          gray700 = Color(0xff3a3e4b),
                          gray750 = Color(0xff30333e),
                          gray800 = Color(0xff262831),
                          gray900 = Color(0xff14151a),
                          gray1000 = Color(0xff000000),
                          brandSecondary50 = Color(0xfff2e2fe),
                          brandSecondary500 = Color(0xff820ad1),
                          positive50 = Color(0xFFE4FBF0),
                          positive400 = Color(0xff45B380),
                          positive500 = Color(0xff189f60),
                          // positive800 was renamed to positive750 in 5.54.0.
                          positive750 = Color(0xff0c5030),
                          positive950 = Color(0xff03190e),
                          warning50 = Color(0xfffff7eb),
                          warning400 = Color(0xffffb647),
                          warning500 = Color(0xffff9900),
                          warning950 = Color(0xff523100),
                          negative50 = Color(0xfffff0f0),
                          negative400 = Color(0xffff5a5f),
                          negative500 = Color(0xffe71111),
                          negative950 = Color(0xff240001),
                          focus400 = Color(0xff0099FF),
                          focus500 = Color(0xff006AFF)
                      ),
                      components = IncodeComponents(
                          buttons = listOf(
                              // Primary Button Style
                              IncodeButtonStyle(
                                  style = IncodeButtonStyleName.Primary,
                                  surface = ButtonSurface(
                                      default = ColorState(
                                          light = Color(0xFF006AFF),
                                          dark = Color(0xFF0052CC)
                                      ),
                                      hover = ColorState(
                                          light = Color(0xFF0052CC),
                                          dark = Color(0xFF003D99)
                                      ),
                                      pressed = ColorState(
                                          light = Color(0xFF003D99),
                                          dark = Color(0xFF002966)
                                      ),
                                      disabled = ColorState(
                                          light = Color(0xFFE5F0FF),
                                          dark = Color(0xFF1A1A1A)
                                      )
                                  ),
                                  text = ButtonText(
                                      default = ColorState(
                                          light = Color(0xFFFFFFFF),
                                          dark = Color(0xFFFFFFFF)
                                      ),
                                      hover = ColorState(
                                          light = Color(0xFFFFFFFF),
                                          dark = Color(0xFFFFFFFF)
                                      ),
                                      pressed = ColorState(
                                          light = Color(0xFFFFFFFF),
                                          dark = Color(0xFFFFFFFF)
                                      ),
                                      disabled = ColorState(
                                          light = Color(0xFF8FA3BF),
                                          dark = Color(0xFF666666)
                                      )
                                  ),
                                  border = ButtonBorder(
                                      radius = 15.dp
                                  )
                              ),
                              // Secondary Button Style
                              IncodeButtonStyle(
                                  style = IncodeButtonStyleName.Secondary,
                                  text = ButtonText(
                                      default = ColorState(
                                          light = Color(0xFF006AFF),
                                          dark = Color(0xFF4A9EFF)
                                      ),
                                      hover = ColorState(
                                          light = Color(0xFF006AFF),
                                          dark = Color(0xFF4A9EFF)
                                      ),
                                      pressed = ColorState(
                                          light = Color(0xFF006AFF),
                                          dark = Color(0xFF4A9EFF)
                                      ),
                                      disabled = ColorState(
                                          light = Color(0xFFC6C8D2),
                                          dark = Color(0xFF666666)
                                      )
                                  )
                              )
                          )
                      )
                  )
              )
              .build()
      )
  ```
</Accordion>

If Java is your primary language:

1. Create a Kotlin wrapper for the Incode theme configuration:
   ```kotlin
   object IncodeThemeKotlinHelper {

       fun configureTheme() =
           IncodeThemeConfig(
               typography = IncodeTypography(),
               colorPalette = IncodeColorPalette(),
               components = IncodeComponents(listOf()),
               displayMode = DisplayMode.SYSTEM
           )
   }
   ```
2. Call it from your Java code:
   ```java
   IncodeWelcome.getInstance()
       .setCommonConfig(new CommonConfig.Builder()
           .setThemeConfig(IncodeThemeKotlinHelper.configureTheme())
           .build()
       );
   ```

### UX Configuration via JSON

:::note
`IncodeUXConfig.fromJson` is deprecated since 5.55.0 and continues to work. The example below uses the flat shape that `fromJson` accepts. For new integrations, use `setUIConfigFromJson` and put this content under a `ux` key; see [Theme and UX Configuration from a single JSON](#theme-and-ux-configuration-from-a-single-json).
:::

Example JSON:

```kotlin
val jsonString = """
{
  "showFooter": true,
  "closeButtonPosition": "topLeft",
  "helpButtonPosition": "bottomRight",
  "headerAlignment": "center",
  "realtimeFeedbackMessageUIFlavor": "standard"
}"""
```
```java
String jsonString = "{\n" +
                "  \"showFooter\": true,\n" +
                "  \"closeButtonPosition\": \"topLeft\",\n" +
                "  \"helpButtonPosition\": \"bottomRight\",\n" +
                "  \"headerAlignment\": \"center\",\n" +
                "  \"realtimeFeedbackMessageUIFlavor\": \"standard\"\n" +
                "}";
```

Apply the configuration to the SDK:

```kotlin
IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setUXConfig(IncodeUXConfig.fromJson(jsonString))
        .build())
```
```java
IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setUXConfig(IncodeUXConfig.fromJson(jsonString))
        .build());
```

<Accordion title="View available properties and their possible values">
  | Property                          | Type    | Values                                                                              | Default       | Description                                                    |
  | --------------------------------- | ------- | ----------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------- |
  | `showFooter`                      | Boolean | `true` or `false`                                                                   | `true`        | Controls whether the SDK shows the "Verified by Incode" footer |
  | `closeButtonPosition`             | String  | `TOP_LEFT` or `topLeft`, `TOP_RIGHT` or `topRight`                                  | `topRight`    | Position of the close button                                   |
  | `helpButtonPosition`              | String  | `TOP_LEFT` or `topLeft`, `TOP_RIGHT` or `topRight`, `BOTTOM_RIGHT` or `bottomRight` | `bottomRight` | Position of the help button                                    |
  | `realtimeFeedbackMessageUIFlavor` | String  | `STANDARD` or `standard`, `MINIMAL` or `minimal`                                    | `standard`    | Visual flavor of real-time feedback messages                   |
  | `headerAlignment`                 | String  | `CENTER` or `center`, `START` or `start`, `END` or `end`                            | `center`      | Alignment of the header                                        |
</Accordion>

### UX Configuration via Object

```kotlin
IncodeWelcome.getInstance()
    .setCommonConfig(
        CommonConfig.Builder()
            .setUXConfig(IncodeUXConfig.Builder()
                .setShowFooter(true)
                .setCloseButtonPosition(CloseButtonPosition.TOP_RIGHT)
                .setHelpButtonPosition(HelpButtonPosition.BOTTOM_RIGHT)
                .setHeaderAlignment(HeaderAlignment.CENTER)
                .setRealtimeFeedbackMessageUIFlavor(RealtimeFeedbackMessageUIFlavor.STANDARD)
                .build())
            .build())
```
```java
IncodeWelcome.getInstance()
    .setCommonConfig(new CommonConfig.Builder()
        .setUXConfig(new IncodeUXConfig.Builder()
            .setShowFooter(true)
            .setCloseButtonPosition(CloseButtonPosition.TOP_RIGHT)
            .setHelpButtonPosition(HelpButtonPosition.BOTTOM_RIGHT)
            .setHeaderAlignment(HeaderAlignment.CENTER)
            .setRealtimeFeedbackMessageUIFlavor(RealtimeFeedbackMessageUIFlavor.STANDARD)
            .build())
        .build());
```

### Theme and UX Configuration from a single JSON

One JSON document can hold a `theme` object and a `ux` object. Use `setUIConfigFromJson` to apply both with one call.

Example JSON:

```json
{
  "theme": {
    "displayMode": "light",
    "colorPalette": {
      "brand500": "#FF00AE",
      "brand600": "#CC008B"
    },
    "components": {
      "buttons": [
        {
          "style": "primary",
          "surface": { "default": "#FF00AE", "pressed": "#CC008B" },
          "text": { "default": "#FFFFFF" }
        }
      ]
    }
  },
  "ux": {
    "showFooter": true,
    "closeButtonPosition": "topRight",
    "helpButtonPosition": "bottomRight",
    "headerAlignment": "center",
    "realtimeFeedbackMessageUIFlavor": "standard"
  }
}
```

The `theme` object accepts the same properties as [Theme Configuration via JSON](#theme-configuration-via-json). The `ux` object accepts the same properties as [UX Configuration via JSON](#ux-configuration-via-json).

Load this JSON into a `jsonString` variable, then apply it to the SDK:

```kotlin
IncodeWelcome.getInstance().setCommonConfig(
    CommonConfig.Builder()
        .setUIConfigFromJson(context, jsonString)
        .build())
```
```java
IncodeWelcome.getInstance().setCommonConfig(
    new CommonConfig.Builder()
        .setUIConfigFromJson(context, jsonString)
        .build());
```

Notes:

- `setUIConfigFromJson` is a setter. It replaces the theme and the UX configuration set earlier on the builder, like every other setter.
- If the `theme` object is absent or `null`, the SDK uses the default theme.
- If the `ux` object is absent or `null`, the SDK uses the default UX configuration.
- If neither object is present, the SDK throws an `IllegalArgumentException`. A flat document with theme and UX keys at the root is not supported.
- `setThemeConfig` and `setUXConfig` continue to work. To combine a JSON theme with a programmatic UX configuration, call `setUXConfig` after `setUIConfigFromJson`. The last call wins.
- Invalid JSON throws the same exceptions as `IncodeThemeConfig.fromJson` and `IncodeUXConfig.fromJson`: `SerializationException` for a malformed document or structure, `IllegalArgumentException` for an invalid value such as a color.

## Customize V2 Vector Drawables

Vector drawables in V2 flow screens automatically match your brand theme's colors. The SDK resolves these colors from the [Prizma Design System](/design-and-ux/prizma-design-foundations/) at runtime, based on a path-naming convention in the vector XML.

### How It Works

The SDK dynamically recolors any vector path whose `android:name` starts with the prefix `onboard_sdk_themed_`. The full naming format is:

```
onboard_sdk_themed_[fill|stroke]_<colorName>[_<description>]
```

- `fill` or `stroke`: An optional target property. Defaults to `fill` if omitted.
- `<colorName>`: A camelCase color token name from the [Prizma Design System](/design-and-ux/prizma-design-foundations/), such as `iconAccent` or `surfaceBrand50`.
- `<description>`: An optional, human-readable label for designers. The SDK ignores it at runtime.

At runtime, the SDK replaces the fill or stroke color of each themed path with the resolved color token value. It leaves paths without the prefix unchanged, including gradients.

### Default Behavior

By default, the SDK's vector drawables use theming tokens for their brand-colored areas. If you customize theming primitives in your color palette, these areas automatically follow.

### Overriding a Vector Drawable

To replace any SDK vector drawable, override its resource in your app's `res/drawable/` folder using the same file name.

When you override a drawable:

- **With a raster image, such as PNG, JPG, or WebP**: The SDK detects that the resource isn't a vector drawable and shows it as-is, without theming. No crash occurs.
- **With a custom vector, in XML**: If your vector doesn't include any paths with the `onboard_sdk_themed_` prefix, the SDK skips theming and renders the vector as-is. If you include `onboard_sdk_themed_` prefixed paths, the SDK applies the matching theme colors.

### Creating a Themed Custom Vector

If you want your custom vector to use the SDK's dynamic theming, add the `onboard_sdk_themed_` prefix to the `android:name` of any path you want recolored:

```xml
<vector xmlns:android="http://schemas.android.com/apk/res/android"
    android:width="40dp"
    android:height="40dp"
    android:viewportWidth="40"
    android:viewportHeight="40">

    <!-- This path's fill will be recolored to the iconAccent token -->
    <path
        android:name="onboard_sdk_themed_iconAccent_background"
        android:pathData="M0,0h40v40H0z"
        android:fillColor="#007AFF"/>

    <!-- This path's fill will be recolored to the surfaceBrand50 token -->
    <path
        android:name="onboard_sdk_themed_fill_surfaceBrand50_highlight"
        android:pathData="M5,5h30v30H5z"
        android:fillColor="#E6F0FF"/>

    <!-- This path's stroke will be recolored to the borderAccent token -->
    <path
        android:name="onboard_sdk_themed_stroke_borderAccent_outline"
        android:pathData="M2,2h36v36H2z"
        android:strokeWidth="2"
        android:fillColor="#00000000"
        android:strokeColor="#007AFF"/>

    <!-- This path is NOT themed (no prefix) - it keeps its original color -->
    <path
        android:pathData="M10,10h20v20H10z"
        android:fillColor="#FFFFFF"/>

</vector>
```

Different paths in the same vector can reference different theme colors. The `android:fillColor` value in the XML is the default fallback. It's visible only if the SDK can't apply theming: for example, outside the SDK's Compose theme.

### Available Color Names

You can use any color token from the [Prizma Design System](/design-and-ux/prizma-design-foundations/) as the `<colorName>` segment.

---

- Path: `sdk-reference/android-document-scan`
- URL: https://developer.incode.com/sdk-reference/android-document-scan/
- Markdown: https://developer.incode.com/sdk-reference/android-document-scan.md

# Document Scan

The Document Scan module captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera. For some document types, the server performs [OCR](/get-started-with-incode/glossary/#ocr) and returns the extracted data.

For an overview of this module and how it works, see [Document Capture](/features-and-modules/document-capture/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Document Scan

Add the module with `addDocumentScan(documentScan)`. Document Scan ships both a v1 (legacy View) UI and a v2 (Jetpack Compose) UI; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

```kotlin
flowConfigBuilder.addDocumentScan(documentScan)
```
```java
flowConfigBuilder.addDocumentScan(documentScan);
```

### Example

The example below builds a `DocumentScan` configured for an `ADDRESS_STATEMENT` document type with tutorials enabled, adds it to a `FlowConfig`, and starts onboarding. The `OnboardingListener` receives the result in `onDocumentValidationCompleted`.

```kotlin
val documentScan = DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setShowTutorials(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addDocumentScan(documentScan)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onDocumentValidationCompleted(
        documentType: DocumentType,
        documentValidationResult: DocumentValidationResult
    ) {
        // Document captured. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
DocumentScan documentScan = new DocumentScan.Builder()
    .setDocumentType(DocumentType.ADDRESS_STATEMENT)
    .setShowTutorials(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addDocumentScan(documentScan)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onDocumentValidationCompleted(
        @NonNull DocumentType documentType,
        @NonNull DocumentValidationResult documentValidationResult
    ) {
        // Document captured. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `DocumentScan.Builder`. The table below lists the most common options.

| Setting                                   | Description                                                                                                                              |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `setDocumentType(DocumentType)`           | Sets the type of document the module looks for: for example, `ADDRESS_STATEMENT`, `MEDICAL_DOC`, `PAYMENT_PROOF`, or `OTHER_DOCUMENT_1`. |
| `setShowTutorials(Boolean)`               | Shows tutorials on how to capture the document.                                                                                          |
| `setWaitForTutorials(Boolean)`            | Waits for the tutorial to finish before starting capture.                                                                                |
| `setShowDocumentProviderOptions(Boolean)` | Allows the user to choose between using the camera to scan the document and uploading its file.                                          |
| `setAllowSkipDocumentCapture(Boolean)`    | Lets the user skip document capture.                                                                                                     |

The data extracted by OCR depends on the configured `DocumentType`. For example, `getAddressStatementData()` and `addressFields` apply to `DocumentType.ADDRESS_STATEMENT`, and `getMedicalDocData()` applies to `DocumentType.MEDICAL_DOC`.

For the complete option set, see `DocumentScan.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

The module delivers a `DocumentValidationResult` to the `onDocumentValidationCompleted(DocumentType, DocumentValidationResult)` callback on the `OnboardingListener`. Key fields include:

- `documentPath`: A URI pointing to the captured document. Available only when the user chose to scan the document. When the SDK runs in `SdkMode.STANDARD`, this is always `null`.
- `addressFields`: Address fields read from an address statement; `null` if the address couldn't be read or the `DocumentType` is not `ADDRESS_STATEMENT`.
- `mimeType`: The document's MIME type: for example, `image/jpeg`, `image/png`, or `application/pdf`. Empty string when unknown.
- `isDocumentValidationSkipped`: `true` if the user skipped document capture; otherwise, `false`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

For address statements, read `addressFields`. `getDocumentImage()` returns the captured document as a `Bitmap`.

If the module fails, the error surfaces through `OnboardingListener.onError(Throwable)`.

For all fields, see `DocumentValidationResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-dynamic-forms`
- URL: https://developer.incode.com/sdk-reference/android-dynamic-forms/
- Markdown: https://developer.incode.com/sdk-reference/android-dynamic-forms.md

# Dynamic Forms

The Dynamic Forms module presents one or more custom form screens to collect information from a user.

For an overview of this module and how it works, see [Forms and Data Entry](/features-and-modules/forms-and-data-entry/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

This module is available for SDK 5.32.0 and later.

## Add Dynamic Forms

Add the module with `addDynamicForms(dynamicForms)`. In most integrations, the screens and questions come from your Incode Flow or Workflow configuration, so an empty `DynamicForms` is common. You can also build screens and questions in code with `DynamicForms.Builder` when you need to define them client-side.

```kotlin
flowConfigBuilder.addDynamicForms(dynamicForms)
```
```java
flowConfigBuilder.addDynamicForms(dynamicForms);
```

### Example

The example below builds an empty `DynamicForms`, adds it to a `FlowConfig` with a flow tag, and starts an onboarding section. The listener reads the user's answers from `onDynamicFormsCompleted`.

```kotlin
try {
    val dynamicForms = DynamicForms.Builder()
        .build()

    val flowConfig = FlowConfig.Builder()
        .setFlowTag("Dynamic forms section")
        .addDynamicForms(dynamicForms)
        .build()

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, object : OnboardingListener() {
            override fun onDynamicFormsCompleted(dynamicFormsResult: DynamicFormsResult) {
                // Read dynamicFormsResult.answers
            }

            override fun onError(error: Throwable) {}

            override fun onUserCancelled() {}

            override fun onOnboardingSectionCompleted(flowTag: String) {
                // Dynamic forms section complete
            }
        }
    )
} catch (e: ModuleConfigurationException) {
    e.printStackTrace()
}
```
```java
try {
    DynamicForms dynamicForms = new DynamicForms.Builder()
        .build();

    FlowConfig flowConfig = new FlowConfig.Builder()
        .setFlowTag("Dynamic forms section")
        .addDynamicForms(dynamicForms)
        .build();

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, new IncodeWelcome.OnboardingListener() {
            @Override
            public void onDynamicFormsCompleted(@NonNull DynamicFormsResult dynamicFormsResult) {
                // Read dynamicFormsResult.getAnswers()
            }

            @Override
            public void onError(@NonNull Throwable error) {}

            @Override
            public void onUserCancelled() {}

            @Override
            public void onOnboardingSectionCompleted(@NonNull String flowTag) {
                // Dynamic forms section complete
            }
        }
    );
} catch (ModuleConfigurationException e) {
    e.printStackTrace();
}
```

## Configuration Options

Configure the module with `DynamicForms.Builder`.

| Setting               | Description                                               |
| --------------------- | --------------------------------------------------------- |
| `addScreen(screen)`   | Adds a single `DynamicForms.Screen` to the form.          |
| `addScreens(screens)` | Adds a list of `DynamicForms.Screen` objects to the form. |

Each `DynamicForms.Screen` holds a `title`, a `hideTitle` flag, and a list of `DynamicForms.Screen.Question`. A question carries its `id`, `questionText`, an `inputType`, a `predefinedQuestionType`, optional `options`, and an `isOptional` flag.

For the complete option set, see `DynamicForms.Builder`, `DynamicForms.Screen`, and `DynamicForms.Screen.Question` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Dynamic Forms delivers a `DynamicFormsResult` to the `onDynamicFormsCompleted(DynamicFormsResult)` callback on the `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if the dynamic forms were submitted successfully; otherwise, `false`.
- `answers`: The list of answered form entries; `null` when unavailable. Each entry (`DynamicFormQuestionnaireModel`) contains the following:
  - `interviewId`: The interview ID the answer belongs to; `null` when unavailable.
  - `questionId`: The unique identifier of the question.
  - `question`: The question text shown to the user.
  - `inputType`: The input type of the question. One of: `NUMBER`, `CPF`, `COUNTRY`, `DATE`, `PHONE`, `EMAIL`, `TEXT`, `YESNO`, or `SELECT`.
  - `selectedAnswer`: The user's answer (`AnswerModel` with a `detail` string); `null` when unanswered.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`. This module does not define a module-specific exception subtype.

For all fields, see `DynamicFormsResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-e2ee`
- URL: https://developer.incode.com/sdk-reference/android-e2ee/
- Markdown: https://developer.incode.com/sdk-reference/android-e2ee.md

# End-to-End Encryption

End-to-end encryption (E2EE) adds an extra layer of security by encrypting the data transmitted between the server and client. The process begins with a key exchange; the client and server share keys for encrypting and decrypting messages. This exchange ensures all later communications are encrypted. Only the intended server and client can decrypt the messages.

***

## Security

The Incode Android SDK uses the Android platform's standard cryptographic APIs (`javax.crypto`) for all cryptographic operations:

- RSA-OAEP with SHA-256 asymmetric encryption for secure key exchange
- AES-GCM symmetric encryption for securing server requests and responses

***

## Enable End-to-End Encryption

Complete the following steps in order.

### Set Up a Custom Server for E2EE

Initialize the Welcome SDK with a custom server for E2EE, supplying the `E2EE_URL`:

```kotlin
IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY, E2EE_URL)
    .build()
```
```java
new IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY, E2EE_URL)
    .build();
```

### Enable E2EE via SessionConfig

Turn on E2EE when building your `SessionConfig`:

```kotlin
val sessionConfig: SessionConfig = SessionConfig.Builder()
    .setE2eEncryptionEnabled(true)
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setE2eEncryptionEnabled(true)
    .build();
```

### Start Onboarding

Pass the `SessionConfig` to [startOnboarding](/sdk-reference/android-configure-flows-locally-and-run-end-to-end/), [setupOnboardingSession](/sdk-reference/android-configure-flows-locally-and-run-step-by-step/), [startFlow](/sdk-reference/android-run-flows-configured-online/), or [startWorkflow](/sdk-reference/android-run-flows-configured-online/), depending on your integration approach.

<br />

---

- Path: `sdk-reference/android-ekyb`
- URL: https://developer.incode.com/sdk-reference/android-ekyb/
- Markdown: https://developer.incode.com/sdk-reference/android-ekyb.md

# eKYB (Electronic Know Your Business)

The eKYB module collects and verifies a business entity's identity data, such as business name, address, and tax ID. The fields that are collected and how the checks are evaluated depend on your Incode Flow or Workflow configuration.

For an overview of this module and how it works, see [eKYB (electronic Know Your Business)](/features-and-modules/ekyb/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add eKYB

Add the module with `addEKYB(ekybModule)`.

```kotlin
flowConfigBuilder.addEKYB(ekybModule)
```
```java
flowConfigBuilder.addEKYB(ekybModule);
```

### Example

The example below builds an `EKYB` module showing all three fields, adds it to the flow, and listens for the result through `onEKYBChecksCompleted()`.

```kotlin
val ekybModule = EKYB.Builder()
    .setShowBusinessName(true)
    .setShowAddress(true)
    .setShowTaxId(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addEKYB(ekybModule)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onEKYBChecksCompleted(ekybResult: EKYBResult) {
        // eKYB checks completed. Inspect ekybResult for the per-check results.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
EKYB ekybModule = new EKYB.Builder()
    .setShowBusinessName(true)
    .setShowAddress(true)
    .setShowTaxId(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addEKYB(ekybModule)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onEKYBChecksCompleted(EKYBResult ekybResult) {
        // eKYB checks completed. Inspect ekybResult for the per-check results.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `EKYB.Builder`. These options control which form fields the module shows.

| Setting                        | Description                                                |
| ------------------------------ | ---------------------------------------------------------- |
| `setShowBusinessName(Boolean)` | Shows or hides the Business Name field. Default is `true`. |
| `setShowAddress(Boolean)`      | Shows or hides the address fields. Default is `true`.      |
| `setShowTaxId(Boolean)`        | Shows or hides the Tax ID field. Default is `true`.        |

For the complete option set, see `EKYB.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

eKYB delivers an `EKYBResult` to the `onEKYBChecksCompleted(EKYBResult)` callback on the `OnboardingListener`. Key fields include:

- `resultTests`: The list of individual eKYB check results; empty when none. Each entry (`EKYBResultCheck`) contains the following:
  - `key`: The identifier of the check performed.
  - `status`: The outcome of the check; `null` when unavailable.
  - `subLabel`: A secondary label describing the check; `null` when unavailable.
  - `message`: A human-readable message for the check; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`.

For all fields, see `EKYBResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-ekyc`
- URL: https://developer.incode.com/sdk-reference/android-ekyc/
- Markdown: https://developer.incode.com/sdk-reference/android-ekyc.md

# eKYC (Electronic Know Your Customer)

The eKYC (electronic Know Your Customer) module collects and verifies a user's personal identity data against authoritative data sources. This data can include the user's name, email, address, phone, tax ID, date of birth, and nationality. This module can prefill fields from data captured earlier in the flow, such as a scanned document, and validate them against your Incode configuration.

For an overview of this module and how it works, see [eKYC (electronic Know Your Customer)](/features-and-modules/ekyc/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add eKYC

Add the module with `addEKYC(ekycModule)`. The fields shown and the verification behavior depend on the eKYC module configuration in your Flow or Workflow in Dashboard.

```kotlin
flowConfigBuilder.addEKYC(ekycModule)
```
```java
flowConfigBuilder.addEKYC(ekycModule);
```

### Example

The example below builds an `EKYC` module that verifies the name and address fields, sourcing the name from a scanned document, adds it to a `FlowConfig` with a flow tag, and starts an onboarding section.

```kotlin
val ekyc = EKYC.Builder()
    .setVerifyName(true)
    .setVerifyAddress(true)
    .setNameSource(EKYC.DataInputSource.DOCUMENT)
    .build()

val flowConfig = FlowConfig.Builder()
    .setFlowTag("eKYC section")
    .addEKYC(ekyc)
    .build()

IncodeWelcome.getInstance()
    .startOnboardingSection(activityContext, flowConfig, object : OnboardingListener() {
        override fun onEKYCChecksCompleted(ekycResult: EKYCResult) {
            // eKYC checks complete
        }

        override fun onError(error: Throwable) {}

        override fun onUserCancelled() {}

        override fun onOnboardingSectionCompleted(flowTag: String) {}
    })
```
```java
EKYC ekyc = new EKYC.Builder()
    .setVerifyName(true)
    .setVerifyAddress(true)
    .setNameSource(EKYC.DataInputSource.DOCUMENT)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .setFlowTag("eKYC section")
    .addEKYC(ekyc)
    .build();

IncodeWelcome.getInstance()
    .startOnboardingSection(activityContext, flowConfig, new IncodeWelcome.OnboardingListener() {
        @Override
        public void onEKYCChecksCompleted(@NonNull EKYCResult ekycResult) {
            // eKYC checks complete
        }

        @Override
        public void onError(@NonNull Throwable error) {}

        @Override
        public void onUserCancelled() {}

        @Override
        public void onOnboardingSectionCompleted(@NonNull String flowTag) {}
    });
```

## Configuration Options

Configure the module with `EKYC.Builder`. Every field is visible by default. The most common options control which fields appear and where their data comes from.

| Setting                                  | Description                                                                                      |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `setVerifyName(Boolean)`                 | Shows or hides the name field.                                                                   |
| `setVerifyAddress(Boolean)`              | Shows or hides the address fields.                                                               |
| `setVerifyDateOfBirth(Boolean)`          | Shows or hides the date of birth field.                                                          |
| `setVerifyTaxId(Boolean)`                | Shows or hides the tax ID field.                                                                 |
| `setNameSource(EKYC.DataInputSource)`    | Sets where the name field is populated from: `USER_INPUT`, `DOCUMENT`, or `PROOF_OF_ADDRESS`.    |
| `setAddressSource(EKYC.DataInputSource)` | Sets where the address field is populated from: `USER_INPUT`, `DOCUMENT`, or `PROOF_OF_ADDRESS`. |

`EKYC.createDefault()` returns an instance with all fields visible.

The `DataInputSource` options let you prefill a field from a scanned `DOCUMENT` or a `PROOF_OF_ADDRESS` document instead of `USER_INPUT`. For a field to prefill, the source data must already be available in the flow.

For the complete option set, see `EKYC.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

eKYC delivers an `EKYCResult` to the `onEKYCChecksCompleted(ekycResult)` callback on the `OnboardingListener`. Key fields include:

- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. eKYC does not define a module-specific exception subtype.

For all fields, see `EKYCResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-email`
- URL: https://developer.incode.com/sdk-reference/android-email/
- Markdown: https://developer.incode.com/sdk-reference/android-email.md

# Email

The Email module collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

For an overview of this module and how it works, see [Email Input](/features-and-modules/email-input/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Email

1. Add the module with `addEmail()` (default config) or `addEmail(email)` (custom config):

```kotlin
flowConfigBuilder.addEmail()
// or with a configured instance:
flowConfigBuilder.addEmail(email)
```
```java
flowConfigBuilder.addEmail();
// or with a configured instance:
flowConfigBuilder.addEmail(email);
```

2. If your flow also uses the [Conference](/sdk-reference/android-conference-assisted-video/) or [Approval](/sdk-reference/android-approval/) modules, add them after Email.

Email ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds an `Email` module with OTP verification enabled, adds it to the flow, and listens for the result through `onAddEmailCompleted()`.

```kotlin
val email = Email.Builder()
    .setOtpVerificationEnabled(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addEmail(email)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onAddEmailCompleted(emailAddressResult: EmailAddressResult) {
        // Email captured. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
Email email = new Email.Builder()
    .setOtpVerificationEnabled(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addEmail(email)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onAddEmailCompleted(@NonNull EmailAddressResult emailAddressResult) {
        // Email captured. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `Email.Builder`. The table below lists the available option.

| Setting                              | Description                                                                                                                                                                                                                              |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setOtpVerificationEnabled(Boolean)` | If `true`, shows OTP verification after the user enters an email address. Defaults to `false`. In [Capture-Only mode](/sdk-reference/android-capture-only-sdk/), OTP is not activated even when enabled. |

For the complete option set, see `Email.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Email delivers an `EmailAddressResult` to the `onAddEmailCompleted(EmailAddressResult)` callback on the `OnboardingListener`. Key fields include:

- `email`: The email address the user entered; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it. When `resultCode` is `SUCCESS`, OTP verification is on, and the organization is limited and not permitted to send or check the code, the `Throwable` that describes the refusal: the email address was collected but not verified. Otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the step fails, the error surfaces via `OnboardingListener.onError(Throwable)`. Email does not define a module-specific exception subtype.

For all fields, see `EmailAddressResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-example-implementation`
- URL: https://developer.incode.com/sdk-reference/android-example-implementation/
- Markdown: https://developer.incode.com/sdk-reference/android-example-implementation.md

# Example Implementation

The Incode Android SDK ships with a full example app that demonstrates an end-to-end integration you can run, read, and adapt. It shows how to initialize the SDK and run an onboarding flow with a real, buildable project. Use it as a reference while you build your own flow.

The example app lives in a dedicated GitHub repository:

[Incode-Welcome-Android-example](https://github.com/Incode-Technologies-Example-Repos/Incode-Welcome-Android-example)

:::tip
The example repository is private. Reach out to your customer success manager to request access.
:::

<br />

---

- Path: `sdk-reference/android-face-authentication`
- URL: https://developer.incode.com/sdk-reference/android-face-authentication/
- Markdown: https://developer.incode.com/sdk-reference/android-face-authentication.md

# Face Authentication

The Face Authentication module captures a returning user's face with the device camera and matches it against the face already enrolled for that user. It then returns a pass or fail result.

For an overview of this module and how it works, see [Face Authentication](/features-and-modules/face-authentication/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Face Authentication

Add the module with one of the `addFaceAuthentication` overloads. Face Authentication runs against an existing enrolled user, so your Flow or Workflow must identify that user: for example, through your session configuration. Whether the module is available depends on your Incode Flow or Workflow configuration.

```kotlin
// Default configuration
flowConfigBuilder.addFaceAuthentication()

// Custom configuration
flowConfigBuilder.addFaceAuthentication(faceAuthentication)
```
```java
// Default configuration
flowConfigBuilder.addFaceAuthentication();

// Custom configuration
flowConfigBuilder.addFaceAuthentication(faceAuthentication);
```

Face Authentication ships both a v1 (legacy View) and a v2 (Compose) capture UI; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds a `FaceAuthentication` module with tutorials shown, adds it to the flow, and listens for the result through `onFaceAuthenticationCompleted()`.

```kotlin
val faceAuthentication = FaceAuthentication.Builder()
    .setShowTutorials(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addFaceAuthentication(faceAuthentication)
    .build()

val onboardingListener = object : IncodeWelcome.OnboardingListener() {
    override fun onFaceAuthenticationCompleted(faceAuthenticationResult: FaceAuthenticationResult) {
        // Face authentication completed
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }
}

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
)
```
```java
FaceAuthentication faceAuthentication = new FaceAuthentication.Builder()
    .setShowTutorials(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addFaceAuthentication(faceAuthentication)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onFaceAuthenticationCompleted(@NonNull FaceAuthenticationResult faceAuthenticationResult) {
        // Face authentication completed
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }
};

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
);
```

## Configuration Options

Configure the module with `FaceAuthentication.Builder`. The table below lists the most commonly used options.

| Setting                        | Description                                                                                                                                                                                                                                                     |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setShowTutorials`             | Shows a tutorial before the scan. Default is `true`.                                                                                                                                                                                                            |
| `setAutoCaptureTimeout`        | Sets the auto-capture timeout, in seconds.                                                                                                                                                                                                                      |
| `setCaptureAttempts`           | Sets the number of capture attempts.                                                                                                                                                                                                                            |
| `setMaskCheckEnabled`          | Enables local face-mask detection during capture. Default is `true`.                                                                                                                                                                                            |
| `setImageQualityCheckSeverity` | Sets how strict the image quality check is during capture.                                                                                                                                                                                                      |
| `setFaceOcclusionEnabled`      | Enables a face occlusion check. Requires the `model-face-occlusion` [dependency](/sdk-reference/android-installation/#declare-dependencies), or a `MissingModelFaceOcclusionDependencyException` is thrown when the check runs. |

For the complete option set, see `FaceAuthentication.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Face Authentication delivers a `FaceAuthenticationResult` to the `onFaceAuthenticationCompleted(faceAuthenticationResult)` callback on `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if face authentication succeeded; otherwise, `false`.
- `customerUUID`: The customer UUID associated with the authenticated face; `null` when unavailable.
- `selfieBase64`: The Base64-encoded selfie image captured during authentication; `null` when unavailable. Redacted from `toString()` to avoid leaking PII.
- `encryptedSelfieBase64`: Base64-encoded encrypted selfie image; `null` when unavailable. Redacted from `toString()` to avoid leaking PII.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

The captured selfie fields are redacted from `FaceAuthenticationResult.toString()` to avoid leaking PII in logs.

Errors surface through `OnboardingListener.onError(Throwable)`. This module can deliver a module-specific `FaceAuthenticationException`. This exception carries a `FaceAuthenticationErrorCode`. For example, `isSpoofAttemptDetected()` reports a detected spoof attempt.

For all fields, see `FaceAuthenticationResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-face-match`
- URL: https://developer.incode.com/sdk-reference/android-face-match/
- Markdown: https://developer.incode.com/sdk-reference/android-face-match.md

# Face Match

The Face Match module compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a confidence score. Matching is performed on the server. The module can also report whether the face already belongs to an existing user.

For an overview of this module and how it works, see [Face Match](/features-and-modules/face-match/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

Face Match is not available in [Capture-Only mode](/sdk-reference/android-capture-only-sdk/); adding it there throws `ModuleNotAvailableException`.

## Add Face Match

1. Add an [ID Scan](/sdk-reference/android-id-scan/) or [QR Scan](/sdk-reference/android-qr-scan/) module, and a [Selfie Scan](/sdk-reference/android-selfie-scan/) module, before Face Match. Face Match depends on these earlier capture steps so there are two faces to compare.
2. Add the module with one of the `addFaceMatch` overloads:

   ```kotlin
   // Default configuration
   flowConfigBuilder.addFaceMatch()

   // Custom configuration
   flowConfigBuilder.addFaceMatch(faceMatch)
   ```
   ```java
   // Default configuration
   flowConfigBuilder.addFaceMatch();

   // Custom configuration
   flowConfigBuilder.addFaceMatch(faceMatch);
   ```

Face Match ships both a v1 (legacy View) and a v2 (Jetpack Compose) UI; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below adds ID Scan and Selfie Scan before Face Match, builds a `FaceMatch` module comparing the ID photo against the selfie, and listens for the result through `onFaceMatchCompleted()`.

```kotlin
val faceMatch = FaceMatch.Builder()
    .setMatchType(FaceMatch.MatchType.ID_SELFIE)
    .build()

val flowConfig = FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addFaceMatch(faceMatch)
    .build()

val onboardingListener = object : IncodeWelcome.OnboardingListener() {
    override fun onFaceMatchCompleted(faceMatchResult: FaceMatchResult) {
        // Face match completed
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }
}

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
)
```
```java
FaceMatch faceMatch = new FaceMatch.Builder()
    .setMatchType(FaceMatch.MatchType.ID_SELFIE)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addFaceMatch(faceMatch)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onFaceMatchCompleted(@NonNull FaceMatchResult faceMatchResult) {
        // Face match completed
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }
};

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
);
```

## Configuration Options

Configure the module with `FaceMatch.Builder`. The table below lists the most commonly used options.

| Setting                        | Description                                                                                                                                           |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setMatchType`                 | Selects what to compare: `MatchType.ID_SELFIE`, `MatchType.NFC_SELFIE`, or `MatchType.NFC_3_WAY`. The NFC match types require captured NFC chip data. |
| `setIdCategory`                | Sets the `IdCategory` values to match against, replacing any previously set values.                                                                   |
| `setShowUserExists`            | Shows or hides the label indicating the user already exists. Default is `false`.                                                                      |
| `setShowLivenessResult`        | Shows or hides the liveness result label. Default is `false`.                                                                                         |
| `setFaceMatchAnimationEnabled` | Shows or hides the face match animation. Disabling it puts the module in compact UI mode.                                                             |

The match type and the thresholds used to decide a pass or fail also depend on your Incode Flow or Workflow configuration, not just these options.

For the complete option set, see `FaceMatch.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Face Match delivers a `FaceMatchResult` to the `onFaceMatchCompleted(faceMatchResult)` callback on `OnboardingListener`. Key fields include:

- `confidence`: Recognition confidence between the selfie and ID photo. A value above `0.6` means the selfie matched the front ID; `-1` means no front ID was uploaded.
- `secondIdConfidence`: Recognition confidence between the selfie and the second ID photo (same scale as `confidence`).
- `nfcVsSelfieConfidence`: Recognition confidence between the selfie and NFC chip photo. A value above `0.6` means a match; `-1` means no NFC image was uploaded.
- `nfcVsIdConfidence`: Recognition confidence between the front ID photo and NFC chip photo. A value above `0.6` means a match; `-1` means either no front ID image or no NFC image was uploaded.
- `idCategories`: The list of `IdCategory` values used in the face matching process.
- `isExistingUser`: `true` if the user already exists in the database; otherwise, `false`.
- `existingInterviewId`: The interview ID of the existing user, if one exists; otherwise, `null`.
- `isNameMatched`: `true` if the existing user's name matches the current user's name (use together with `isExistingUser`); otherwise, `false`.
- `isFaceMatched`: If the faces matched.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the module fails, the onboarding flow is aborted and the error surfaces through `OnboardingListener.onError(Throwable)`. Face Match does not deliver a module-specific exception subtype.

For all fields, see `FaceMatchResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-geolocation`
- URL: https://developer.incode.com/sdk-reference/android-geolocation/
- Markdown: https://developer.incode.com/sdk-reference/android-geolocation.md

# Geolocation

The Geolocation module requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city. You can configure whether the user is allowed to skip the step when a location fix is not available.

For an overview of this module and how it works, see [Geolocation](/features-and-modules/geolocation-2/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Geolocation

Add the module with `addGeolocation()` (default config) or `addGeolocation(geolocation)` (custom config). Geolocation requests location permission at runtime. If the user denies permission, the outcome depends on whether you set the module as skippable.

```kotlin
flowConfigBuilder.addGeolocation()
// or with a configured instance:
flowConfigBuilder.addGeolocation(geolocation)
```
```java
flowConfigBuilder.addGeolocation();
// or with a configured instance:
flowConfigBuilder.addGeolocation(geolocation);
```

Geolocation ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds a `Geolocation` module that is not skippable, adds it to the flow, and listens for both the fetched result and the unavailable case.

```kotlin
val geolocation = Geolocation.Builder()
    .setSkippable(false)
    .build()

val flowConfig = FlowConfig.Builder()
    .addGeolocation(geolocation)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onGeolocationFetched(geolocationResult: GeolocationResult) {
        // Location captured. Process the result.
    }

    override fun onGeolocationUnavailable(error: Throwable) {
        // No location fix was obtained.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
Geolocation geolocation = new Geolocation.Builder()
    .setSkippable(false)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addGeolocation(geolocation)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onGeolocationFetched(@NonNull GeolocationResult geolocationResult) {
        // Location captured. Process the result.
    }

    @Override
    public void onGeolocationUnavailable(@NonNull Throwable error) {
        // No location fix was obtained.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `Geolocation.Builder`. The table below lists the available option.

| Setting                 | Description                                                                                                                                                                                                                                                                                       |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setSkippable(Boolean)` | Controls the outcome when the user exits without a location fix, whether by denying permission and skipping, or by exhausting retries on the unavailable screen. If `true`, the flow continues with `ResultCode.SUCCESS`. If `false`, the flow ends with `ResultCode.ERROR`. Defaults to `false`. |

For the complete option set, see `Geolocation.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Geolocation delivers a `GeolocationResult` to the `onGeolocationFetched(GeolocationResult)` callback on the `OnboardingListener`. When no location fix is obtained, `onGeolocationUnavailable(Throwable)` is called instead. Key fields include:

- `addressFields`: The captured location broken down into address fields (`AddressFields`); `null` when unavailable.
- `latitude`: The latitude of the captured location, in degrees.
- `longitude`: The longitude of the captured location, in degrees.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. The `Throwable` passed to `onGeolocationUnavailable` is a `GeolocationUnavailableException` when no location fix could be determined. It is a `LocationPermissionDeniedException` when the user denies location permission and exits the step.

For all fields, see `GeolocationResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-getting-started`
- URL: https://developer.incode.com/sdk-reference/android-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/android-getting-started.md

# Getting Started

This section covers everything you need to set up the Incode Android SDK. Follow the pages in this section in order, then layer in the optional and advanced features you need.

## Setup

Follow these steps to set up the SDK:

1. Ensure your devices meet the [device requirements](/sdk-reference/android-sdk/#device-requirements).
2. Ensure your build environment meets the [build requirements](/sdk-reference/android-installation/#build-requirements).
3. [Install](/sdk-reference/android-installation/) the SDK: add repositories, enforce Java 8, add the Incode Bill of Materials (BOM), declare dependencies, declare required permissions, add optional permissions, and initialize the SDK.
4. Choose an [integration approach](/sdk-reference/android-common-implementation-patterns/).
5. Run your first identity verification (IDV) flow.

## Optional and Advanced Features

Once your basic integration is running, add the features you need:

- [Dynamic Delivery](/sdk-reference/android-advanced-integration-dynamic-delivery/): Download the Incode SDK on demand, at runtime, as a Dynamic Feature Module. Available for Google and Huawei devices.
- [End-to-End Encryption (E2EE)](/sdk-reference/android-e2ee/): Enforce end-to-end encryption of capture artifacts.
- [Token-Based Setup](/sdk-reference/android-token-based-setup/): Use the SDK without an API key by passing a backend-created token.
- [Google Wallet ID](/sdk-reference/android-google-wallet-id/): Set up the SDK to allow users to verify their identity using their Google Wallet Digital ID instead of scanning a physical document.

Also, browse the [full catalog of available modules](/sdk-reference/android-individual-modules/).

<br />

---

- Path: `sdk-reference/android-global-watchlist`
- URL: https://developer.incode.com/sdk-reference/android-global-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/android-global-watchlist.md

# Global Watchlist

The Global Watchlist module screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. Watchlist sources and matching behavior are controlled by your Incode Flow or Workflow configuration. Screening matches and decisions are evaluated server-side. Retrieve the detailed screening outcome from Dashboard or your scoring response.

For an overview of this module and how it works, see [Watchlist](/features-and-modules/watchlist/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Global Watchlist

Add the module with `addGlobalWatchlist()`.

```kotlin
flowConfigBuilder.addGlobalWatchlist()
```
```java
flowConfigBuilder.addGlobalWatchlist();
```

### Example

The example below adds Global Watchlist as the only step in the flow and listens for the result through `onGlobalWatchlistProcessed()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addGlobalWatchlist()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onGlobalWatchlistProcessed(globalWatchlistResult: GlobalWatchlistResult) {
        // Global watchlist step processed. Inspect the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addGlobalWatchlist()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onGlobalWatchlistProcessed(@NonNull GlobalWatchlistResult globalWatchlistResult) {
        // Global watchlist step processed. Inspect the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Global Watchlist has no configurable options. It is added with a no-argument builder method. You can restrict the module to specific watchlist categories and specify matching criteria through your Incode Flow or Workflow configuration.

## Result

Global Watchlist delivers a `GlobalWatchlistResult` to the `onGlobalWatchlistProcessed(GlobalWatchlistResult)` callback on the `OnboardingListener`. Key fields include:

- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `GlobalWatchlistResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-google-wallet-id`
- URL: https://developer.incode.com/sdk-reference/android-google-wallet-id/
- Markdown: https://developer.incode.com/sdk-reference/android-google-wallet-id.md

# Google Wallet ID

This feature verifies a user's identity using their Google Wallet Digital ID instead of scanning a physical document. This page covers setup, the runtime flow, sandbox device configuration, and how to test the happy path and edge cases.

Google Wallet ID is available for:

- SDK version 5.48.0 or later
- SDK API level 28 or later


## How It Works

Google Wallet appears as a verification option in the [ID Scan](/sdk-reference/android-id-scan/) module's document chooser when the integration is configured for Device Wallet verification. The user selects a Google Wallet Digital ID and approves sharing the requested fields. The SDK then sends the returned credential to Incode's back end for verification.

Incode's back end provides the Google Wallet request. That request controls which ID type and credential fields are requested from Google Wallet.


## Prerequisites

- Include the `com.incode.sdk:wallets` dependency only for integrations that need Google Wallet ID support. Customers not using this feature should omit it.

- The `com.incode.sdk:wallets` dependency controls whether Google Wallet is available. What happens when it's missing depends on how Google Wallet is invoked:
    - **Direct or non-UI invocation** throws `MissingWalletsDependencyException`. Google Wallet is the entire module in this case, so there's no other document type to fall back to.
    - **Through the document chooser**, the session continues without interruption. The Google Wallet option is hidden, and the user completes the flow with a camera capture instead.
    - To make Google Wallet available, add the `com.incode.sdk:wallets` dependency. To remove it from the chooser entirely, turn off the **Enable Device Wallet verification** setting in the Dashboard [ID Capture configuration](/dashboard-platform-administration/id-capture-dashboard/#configuration-options).
- Enable Device Wallet verification in the Dashboard [ID Capture module configuration](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) for the specific Flow or Workflow where Google Wallet ID should be offered.
- Prepare a sandbox-ready Google account and device for testing. Production verification may require package name and signing certificate authorization with Google Wallet.


## Set Up Google Wallet ID

Complete the following steps in order.

### Add the Optional Artifact

Use the SDK [BOM](/sdk-reference/android-installation/#add-the-incode-bill-of-materials-bom) if the integration already relies on it. Otherwise, pin each artifact version explicitly. See [Installation](/sdk-reference/android-installation/#declare-dependencies) for full dependency setup and [BOM Version Mapping](/release-notes/bom-version-mapping/) for BOM-to-module version mapping.

```gradle
android {
    defaultConfig {
        minSdk 28
    }
}

dependencies {
    implementation platform("com.incode.sdk:bom:5.55.0")
    implementation "com.incode.sdk:welcome"
    implementation "com.incode.sdk:core-light"
    implementation "com.incode.sdk:wallets"
}

```

### Select Whether the Google Wallet Request Is Signed

The `setGoogleWalletRequestSigned()` value determines if the request is signed or not. Setting to `true` signs the request; setting to `false` does not. The default value is `true`.

Set to `false` only for debugging. You can leave as `true` when testing with Google Wallet sandbox and test ID passes.

```kotlin
IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletRequestSigned(false)
    .build()
```
```java
new IncodeWelcome.Builder(application, apiUrl, apiKey)
    .setGoogleWalletRequestSigned(false)
    .build();
```

Remove the entire `.setGoogleWalletRequestSigned(false)` line for production. The SDK will use the signed protocol automatically.

### Enable Google Wallet for the ID Scan Module

To determine whether Google Wallet ID is offered during Onboarding, use Dashboard configuration for a Flow or Workflow, or programmatic configuration for a locally configured flow.

For Dashboard configuration, open the specific Flow or Workflow where Google Wallet ID should be available. In the ID Capture [module configuration](/dashboard-platform-administration/id-capture-dashboard/#configuration-options), turn on **Enable Device Wallet Verification** and make sure **Show Document Chooser Screen** is selected.

For programmatic configuration, use `IdScan.Builder().setGoogleWalletIdEnabled(true)` when building the module. Use `IdScan.BuilderNonUi` for non-UI mode.

## Runtime Flow

When the user selects Google Wallet, the following steps occur:

1. **The SDK confirms Wallet support is available.** The app must include the optional wallets dependency and use a supported Android version.
2. **The Incode back end provides the wallet request.** The request defines which ID and which fields to request from the user's Google Wallet.
3. **The SDK shows Google Wallet in document selection.** The option appears when the ID Scan module is configured for Device Wallet verification and the document chooser screen is enabled.
4. **Google Wallet opens for user consent.** The user selects a matching Wallet ID pass and approves sharing the requested fields.
5. **The SDK continues the onboarding flow.** When verification succeeds, the SDK advances to the next module. 
    - If credential selection is cancelled or interrupted, or no matching credential exists on the device, the user returns to document selection and can choose another document type. 
    - If backend verification fails after the credential is captured, the SDK shows an error screen. The **Try Again** option on the error screen returns the user to document selection. This ensures that a credential the back end keeps rejecting does not block the flow. 
    - Direct invocation offers no other document type, so it shows no error screen at all; the ID module ends and the failure is reported through `OnboardingListener.onError()`.


## Sequence Diagram

The wallet request is fetched before the user starts the Wallet interaction. The user then taps Google Wallet, the SDK passes that request to Google Wallet through Android Credential Manager, and the returned credential is sent to the Incode back end for verification.

```mermaid
sequenceDiagram
    autonumber
    participant App as Client app
    participant SDK as Incode SDK
    participant BE as Incode backend
    participant Wallet as Google Wallet / Credential Manager

    App->>SDK: Start Flow or Workflow
    Note over App,SDK: SDK initialization and onboarding start
    SDK->>BE: Fetch configuration and wallet request
    Note over SDK,BE: Incode decides requested ID and fields
    BE-->>SDK: Return IdScan config plus wallet request
    Note over SDK: Request is kept until user action
    SDK-->>App: Render document chooser
    Note over App,SDK: Google Wallet button is visible when enabled
    App->>SDK: User taps Google Wallet
    SDK->>Wallet: Pass wallet request to Credential Manager
    Note over SDK,Wallet: Previously received request is used here
    Wallet->>Wallet: User authenticates and consents
    Note over Wallet: Google Wallet shares approved data
    Wallet-->>SDK: Return credential response
    Note over SDK: Response arrives inside the client app process
    SDK->>BE: Send credential for verification
    Note over SDK,BE: Incode backend validates the shared data
    BE-->>SDK: Return verification result
    SDK-->>App: Continue onboarding
```

## Non-UI (Headless) Mode

By default, Google Wallet is offered as one of the options in the SDK's document chooser. To trigger it directly instead - for example from your own custom button - disable the chooser and set the ID type explicitly:

```kotlin
IdScan.Builder()
    .setShowIdTypeChooser(false)
    .setIdType(IdScan.IdType.GOOGLE_WALLET_ID)
    .build()
```

On top of that direct-trigger configuration, you can also opt out of the SDK's own screens entirely and render your own UI instead:

```kotlin
IdScan.Builder()
    .setShowIdTypeChooser(false)
    .setIdType(IdScan.IdType.GOOGLE_WALLET_ID)
    .build()
    .apply { isNonUiMode = true }
```

Direct invocation has no document chooser behind it, so a cancelled or failed attempt cannot send the user back to one. It ends the ID module instead and calls `OnboardingListener.onUserCancelled()` or `onError()`. Selecting Google Wallet from the SDK's chooser is unaffected: the user still returns to the chooser and can pick another document type.

When non-UI mode is enabled, the SDK shows no screens for this flow. Instead, `IncodeWelcome.OnboardingListener.onGoogleWalletReady(controller)` hands you a `NonUiGoogleWalletController`. Implement `NonUiGoogleWalletListener` to drive your own entry, loading, error, and fallback UI:

```kotlin
override fun onGoogleWalletReady(controller: NonUiGoogleWalletController) {
    controller.start(activity, lifecycleOwner, object : NonUiGoogleWalletListener {
        override fun onLoading() {
            // Show your own loading UI - the credential picker is about to appear.
        }

        override fun onUploading() {
            // Credential captured, verifying with the backend.
        }

        override fun onGoogleWalletCompleted(exception: IncodeException?) {
            // Terminal outcome - success if exception is null. A rejected upload arrives here too.
        }

        override fun onFallback(reason: GoogleWalletFallbackReason) {
            when (reason) {
                GoogleWalletFallbackReason.CANCELLED,
                GoogleWalletFallbackReason.INTERRUPTED -> {
                    // User backed out of the credential picker.
                }
                GoogleWalletFallbackReason.NO_CREDENTIAL_AVAILABLE -> {
                    // No Google Wallet credential exists on this device.
                }
            }
        }
    })
}
```

- `controller.cancel()` ends the flow and fires `onUserCancelled()` on the `OnboardingListener`, same as the hosted flow's close button. It also stops any request or upload that is still in progress, so no further `NonUiGoogleWalletListener` callback arrives after it.
- `onGoogleWalletCompleted` and `onFallback` are both terminal: no further callback follows for this flow. The matching `OnboardingListener.onUserCancelled()` or `onError()` arrives separately, on the main thread. To offer the user a different document type, start a new ID module from that callback rather than from `onFallback`, so the new flow does not race the old one's teardown.
- A rejected upload is terminal in this mode: it arrives on `onGoogleWalletCompleted` with a non-null exception, and the ID module ends. The SDK draws no retry screen here, so start another ID module if the user should try again. The hosted flow differs: there the user gets an error screen whose Try Again returns them to the document chooser.
- The SDK releases the controller when the flow ends, so there is nothing to clean up yourself. To stop a flow early, call `controller.cancel()`; it reports `USER_CANCELLED` so the ID module ends. Abandoning a flow without reporting anything would leave the module waiting.
- A controller drives one flow. After it ends - through an outcome or `cancel()` - `start()` and `cancel()` both do nothing. Start another ID module to get a new controller.
- Call `start()` again from a host that was recreated, for example by a configuration change. The flow continues where it was: an upload in progress is not interrupted and the user is not asked for the credential a second time.
- Destroying the host only stops the reporting; the flow keeps running so a recreated host can resume it. Call `controller.cancel()` when the user is leaving for good, so the ID module ends instead of waiting for a host that never returns.
- The overall onboarding flow (advancing to the next module, `onUserCancelled()`, `onError()`) behaves exactly as it does for the hosted flow - only on-screen UI ownership changes.

### Failure causes

The SDK separates the three reasons a direct Google Wallet flow can fail before a credential is captured:

| Cause | What you receive |
|---|---|
| The device holds no credential for the request | `onFallback(NO_CREDENTIAL_AVAILABLE)`, or `GoogleWalletNoCredentialException` on `onError()` |
| The optional `wallets` artifact is missing from the app | `MissingWalletsDependencyException`. Direct and non-UI invocation only. Behind the document chooser the option is left out and the session continues. |
| The wallet request could not be fetched (network or backend) | The underlying error |
| The credential provider ended the request in a state the SDK cannot interpret | `GoogleWalletRequestFailedException`, with the provider's exception as its `cause` |



## Test Google Wallet ID

Complete the following steps in order.

### Set Up Testing Devices

Sandbox testing requires two Android devices. Device 1 simulates an ePassport. Device 2 stores the ID pass in Google Wallet and runs the SDK test app.

**Set Up Device 1: Passport Simulator**

1. Confirm the device is running Android 9 or later.
2. Install the Utopia ePassport Simulator app from Google documentation.
3. Create a new passport entry and keep it available for [MRZ](/get-started-with-incode/glossary#mrz) and [NFC](/get-started-with-incode/glossary/#nfc-scan) steps.

:::note
Pixel 6 worked reliably for this role during testing. Samsung S25 Ultra did not work as expected.
:::

**Set Up Device 2: Wallet and SDK Test Device**

1. Confirm the device is running Android 9 or later, not rooted.
2. Install the Google Wallet app. If it's already installed, update it if needed.
3. Enroll in Google Play Services beta:
   1. Open [Google Play Services beta enrollment](https://play.google.com/apps/testing/com.google.android.gms).
   2. Select **Become a tester**.
   3. Update Google Play Services after enrollment is available.
4. Set up screen lock.
5. Enable Bluetooth and Nearby Devices.
6. Use an eligible or allowlisted Gmail account.

**Request Sandbox Access if the Sandbox Toggle Is Hidden**

1. Use the [Google Pay Sandbox Access Request form](https://docs.google.com/forms/d/e/1FAIpQLSfqSLRGXk9QdYKdwPVVrLsE2-5tYwlpgC-D5afL4a_AaZ5tcQ/viewform?pli=1).
2. Submit the Gmail account used on Device 2.
3. Wait up to 24 hours, reboot occasionally, then check for TapAndPay Environment again.

**Enable Sandbox Mode on Device 2**

1. Open **Settings > Google > All Services**.
2. Open **TapAndPay Environment**.
3. Switch from **Production** to **Sandbox**.
4. Restart the device.
5. Open Google Wallet and confirm sandbox mode is shown at the bottom of Wallet settings.

If TapAndPay settings are not visible, use this direct Android settings entry point:

```bash
adb shell am start -n com.google.android.gms/com.google.android.gms.tapandpay.settings.TapAndPaySettingsActivity
```

:::warning
Do not use a personal production Wallet for sandbox switching. Switching Wallet environments can affect existing Wallet data on the device. Use dedicated test devices and dedicated test accounts whenever possible.
:::

### Test ID Pass

1. **Install the ePassport simulator on Device 1.** Install the Utopia ePassport Simulator app and create a new passport entry. Keep the entry available for [MRZ](/get-started-with-incode/glossary#mrz) and [NFC](/get-started-with-incode/glossary/#nfc-scan) steps.
2. **Start adding the ID pass on Device 2.** Open Google Wallet and select **Add to Wallet** > **ID** > **ID pass**.
3. **Complete MRZ entry.** Use the passport details from Device 1. If the scan is blocked by the simulator UI, enter the MRZ details manually.
4. **Complete NFC handoff.** Place Device 1 against the back of Device 2 during the NFC scan, with the simulator passport entry open.
5. **Verify the pass exists.** Open the ID pass in Google Wallet and confirm the pass details match the simulator entry.

### Test Happy Path

1. Install a build that includes `com.incode.sdk:wallets` on an Android 9 or later device.
2. Initialize the SDK with the default Google Wallet request signing (`true`, signed) - do not call `setGoogleWalletRequestSigned(...)`.
3. Use a Flow or Workflow where the ID Capture module has **Enable Device Wallet Verification** turned on and **Show Document Chooser Screen** selected.
4. Make sure Device 2 is in Google Wallet sandbox mode and has a test ID pass.
5. Start the onboarding session and navigate to the ID Scan document selection screen.
6. Verify that the **Google Wallet** option is visible.
7. Select **Google Wallet**.
8. Verify the Android credential selector opens and shows the matching Wallet ID pass.
9. Select the pass and approve the Wallet consent prompt.
10. Verify the SDK shows processing, completes verification, and advances to the next module or completes ID Scan successfully.

### Test Negative and Edge Cases

| Scenario                                                                                     | Expected Result                                                                                             |
| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Cancel the credential selector                                                               | The user returns to document selection and can pick another document type; the SDK does not crash.           |
| Use Device 2 with no matching Wallet ID pass                                                 | Google Wallet may show no matching IDs. Confirm that the requested ID and fields match the test credential. |
| Use a Flow or Workflow where **Enable Device Wallet Verification** is off                    | Google Wallet is not shown.                                                                                 |
| Run a direct full-SDK `IdScan` with Google Wallet enabled but without the wallets dependency | `MissingWalletsDependencyException`.                                                                        |
| Run a Flow or Workflow with Device Wallet verification on, but without the wallets dependency | The session starts and completes. The document chooser offers the camera document types only, with no Google Wallet option. |
| Force a failed verification response                                                         | The SDK shows the Wallet ID upload error screen and the user can select **Try Again**.                      |
| Test on API level 27 or lower with the wallets artifact included                             | The app should not be considered a supported integration because the module requires API level 28 or later. |
| Repeat the happy path with `setGoogleWalletRequestSigned(false)`                              | The credential request completes with the unsigned protocol for debugging or environments where signing is not yet enabled. |

If Wallet shows no matching IDs, the request from the Incode back end does not match any credential in Google Wallet, or the device is pointed at the wrong Google Wallet environment. Recheck the test ID pass, sandbox state, requested ID type, and requested attributes.


## Troubleshooting

| Symptom                                                   | Likely Cause                                                                                                         | Fix                                                                                                                                                                                                    |
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Google Wallet option is not visible in document selection | Missing dependency; Dashboard option is disabled; document chooser is disabled; the wallet request is not available. | Confirm you have the `com.incode.sdk:wallets`, dependency; confirm you're using API level 28 or later; confirm **Enable Device Wallet Verification** and **Show Document Chooser Screen** are enabled. |
| Build fails after adding wallets                          | Application `minSdk` is lower than 28.                                                                               | Raise app `minSdk` to 28 or remove wallets from integrations that do not use Google Wallet ID.                                                                                                         |
| TapAndPay Environment is not visible                      | Google account is not allowlisted or the device needs a reboot/update.                                               | Submit the sandbox access form; wait up to 24 hours; update Google Play Services; reboot; open settings through ADB.                                                                                   |
| Wallet app does not show the ID option                    | Device or account is not eligible; sandbox is not enabled; Google Wallet is outdated.                                | Use an eligible Gmail account; update Wallet and Play Services; verify sandbox mode.                                                                                                                   |
| Credential selector says there are no matching IDs        | The request provided by the Incode back end does not match the test pass, requested attributes, or environment.      | Compare the requested ID type and fields with the Google-supported credential attributes and check the `setGoogleWalletRequestSigned` value used for debugging.                                                                        |
| SDK shows "Couldn't verify your ID"                       | Wallet credential verification failed.                                                                               | Check network logs, session validity, and the Incode back end verification response.                                                                                                                   |
| User backs out of Google Wallet                           | Credential request was cancelled, interrupted, or no credential was selected.                                        | Expected behavior: the user returns to document selection. With direct invocation there is no chooser to return to, so `onUserCancelled()`/`onError()` fires instead.                                  |


## External References

- [Google Wallet sandbox mode](https://developers.google.com/wallet/identity/verify/sandbox)
- [Create a test ID pass in Google Wallet](https://developers.google.com/wallet/identity/verify/create-test-id)
- [Supported credential attributes in Google Wallet](https://developers.google.com/wallet/identity/verify/supported-credential-attributes)
- [OpenID4VP 1.0 specification](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html)


See [API Reference](/sdk-reference/android-api-reference/) for the full KDoc/Javadoc API surface, or contact Incode support if you run into integration issues.

---

- Path: `sdk-reference/android-government-validation`
- URL: https://developer.incode.com/sdk-reference/android-government-validation/
- Markdown: https://developer.incode.com/sdk-reference/android-government-validation.md

# Government Validation

The Government Validation module validates identity data extracted from a user's ID against an authoritative government registry. The process runs in the background and isn't visible to the user. It can also match the user's photo in the government database against their captured selfie. Whether the validation runs and what it checks also depend on your Incode Flow or Workflow configuration.

For an overview of this module and how it works, see [Government Record Verification](/features-and-modules/government-record-verification/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

Government Validation is not available in [Capture-Only mode](/sdk-reference/android-capture-only-sdk/); adding it there throws `ModuleNotAvailableException`.

## Add Government Validation

1. Add an [ID Scan](/sdk-reference/android-id-scan/) or [QR Scan](/sdk-reference/android-qr-scan/) module, and a [Selfie Scan](/sdk-reference/android-selfie-scan/) module, before Government Validation. Government Validation depends on these earlier capture steps so there is document data and a face to validate.
2. Add the module with one of the `addGovernmentValidation` overloads:

   ```kotlin
   // Default configuration
   flowConfigBuilder.addGovernmentValidation()

   // Custom configuration
   flowConfigBuilder.addGovernmentValidation(governmentValidation)
   ```
   ```java
   // Default configuration
   flowConfigBuilder.addGovernmentValidation();

   // Custom configuration
   flowConfigBuilder.addGovernmentValidation(governmentValidation);
   ```

### Example

The example below adds ID Scan and Selfie Scan before Government Validation, builds a `GovernmentValidation` module with the animation shown, and listens for the result through `onGovernmentValidationCompleted()`.

```kotlin
val governmentValidation = GovernmentValidation.Builder()
    .setSkipAnimation(false)
    .build()

val flowConfig = FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addGovernmentValidation(governmentValidation)
    .build()

val onboardingListener = object : IncodeWelcome.OnboardingListener() {
    override fun onGovernmentValidationCompleted(success: Boolean) {
        // Government validation completed; success indicates whether it passed
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }
}

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
)
```
```java
GovernmentValidation governmentValidation = new GovernmentValidation.Builder()
    .setSkipAnimation(false)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addGovernmentValidation(governmentValidation)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onGovernmentValidationCompleted(boolean success) {
        // Government validation completed; success indicates whether it passed
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }
};

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
);
```

## Configuration Options

Configure the module with `GovernmentValidation.Builder`. The table below lists the one option it exposes.

| Setting            | Description                                                                                                             |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| `setSkipAnimation` | Sets whether the animation that plays in this module is skipped. `true` skips it, `false` plays it. Default is `false`. |

For the complete option set, see `GovernmentValidation.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Government Validation does not return a result payload object to the integrator. The flow signals completion through the `onGovernmentValidationCompleted(success)` callback on `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if government validation completed successfully; otherwise, `false`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors are not delivered through this callback. If the flow is aborted, for example due to a network failure or an unavailable module, the error surfaces via `OnboardingListener.onError(Throwable)`. There is no module-specific exception subtype for Government Validation.

For the related API surface, see `GovernmentValidation` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-id-info`
- URL: https://developer.incode.com/sdk-reference/android-id-info/
- Markdown: https://developer.incode.com/sdk-reference/android-id-info.md

# ID Info

The ID Info module extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr)​. It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields.

For an overview of this module and how it works, see [Review OCR Data](/dashboard-platform-administration/review-ocr-data-dashboard/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add ID Info

1. Add [ID Scan](/sdk-reference/android-id-scan/), then [Process ID](/sdk-reference/android-process-id/), before ID Info. ID Info reviews data that has already been captured and processed, so it only works when these two modules run before it, in that order.
2. Add the module with `addIdInfo()` (default config) or `addIdInfo(idInfo)` (custom config):

   ```kotlin
   flowConfigBuilder.addIdInfo()
   // or with a configured instance:
   flowConfigBuilder.addIdInfo(idInfo)
   ```
   ```java
   flowConfigBuilder.addIdInfo();
   // or with a configured instance:
   flowConfigBuilder.addIdInfo(idInfo);
   ```

ID Info ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds an `IdInfo` module with editable [OCR](/get-started-with-incode/glossary/#ocr) enabled for the first captured ID, adds it to the flow after the ID Scan and Process ID modules, and listens for the result through `onIdInfoCompleted()`.

```kotlin
val idInfo = IdInfo.Builder()
    .setEditableOcr(true)
    .setIdCategory(IdCategory.FIRST)
    .build()

val flowConfig = FlowConfig.Builder()
    // ... add the ID Scan and Process ID steps first
    .addIdInfo(idInfo)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onIdInfoCompleted(idInfoResult: IdInfoResult) {
        // ID info confirmed. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
IdInfo idInfo = new IdInfo.Builder()
    .setEditableOcr(true)
    .setIdCategory(IdCategory.FIRST)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    // ... add the ID Scan and Process ID steps first
    .addIdInfo(idInfo)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onIdInfoCompleted(@NonNull IdInfoResult idInfoResult) {
        // ID info confirmed. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `IdInfo.Builder`. The table below lists the available options.

| Setting                     | Description                                                                                           |
| --------------------------- | ----------------------------------------------------------------------------------------------------- |
| `setEditableOcr(Boolean)`   | Lets the user edit the OCR-extracted fields instead of only reviewing them.                           |
| `setIdCategory(IdCategory)` | Selects which captured ID in the flow the data applies to: `IdCategory.FIRST` or `IdCategory.SECOND`. |

For the complete option set, see `IdInfo.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

ID Info delivers an `IdInfoResult` to the `onIdInfoCompleted(IdInfoResult)` callback on the `OnboardingListener`. Key fields include:

- `fullName`: The full name read from the ID; `null` when unavailable.
- `dateOfBirth`: The date of birth read from the ID; `null` when unavailable.
- `sex`: The sex read from the ID; `null` when unavailable.
- `address`: The address read from the ID; `null` when unavailable.
- `documentNumber`: The document number read from the ID; `null` when unavailable.
- `documentExpiryDate`: The document expiry date read from the ID; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`.

For all fields, see `IdInfoResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-id-scan`
- URL: https://developer.incode.com/sdk-reference/android-id-scan/
- Markdown: https://developer.incode.com/sdk-reference/android-id-scan.md

# ID Scan

The ID Scan module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. It is the entry point for most identity-capture flows.

For an overview of this module and how it works, see [ID Capture](/features-and-modules/id-capture/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add ID Scan

1. If you plan to enable frame streaming with `setStreamFramesEnabled`, ensure you've [declared](/sdk-reference/android-installation/#declare-dependencies) the `com.incode.sdk:video-streaming` dependency in your `[module]/build.gradle`.
2. Add the module with one of the `addID` overloads:

   ```kotlin
   // Default configuration
   flowConfigBuilder.addID()

   // Custom configuration built with IdScan.Builder
   flowConfigBuilder.addID(idScan)
   ```
   ```java
   // Default configuration
   flowConfigBuilder.addID();

   // Custom configuration built with IdScan.Builder
   flowConfigBuilder.addID(idScan);
   ```
3. Add [Process ID](/sdk-reference/android-process-id/) after ID Scan. ID Scan captures the document images, and Process ID then runs validation on what was captured.

ID Scan ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds an `IdScan` module with tutorials shown, adds it to the flow followed by Process ID, and listens for the front and back capture results separately.

```kotlin
val idScan = IdScan.Builder()
    .setShowIdTutorials(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addID(idScan)
    .addProcessId(ProcessId.Builder().build())
    .build()

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    object : OnboardingListener() {
        override fun onIdFrontCompleted(frontIdScanResult: IdScanResult) {
            // Front of the document captured
        }

        override fun onIdBackCompleted(backIdScanResult: IdScanResult) {
            // Back of the document captured
        }

        override fun onError(error: Throwable) {}

        override fun onUserCancelled() {}
    }
)
```
```java
IdScan idScan = new IdScan.Builder()
    .setShowIdTutorials(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addID(idScan)
    .addProcessId(new ProcessId.Builder().build())
    .build();

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    new IncodeWelcome.OnboardingListener() {
        @Override
        public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {
            // Front of the document captured
        }

        @Override
        public void onIdBackCompleted(@NonNull IdScanResult backIdScanResult) {
            // Back of the document captured
        }

        @Override
        public void onError(@NonNull Throwable error) {}

        @Override
        public void onUserCancelled() {}
    }
);
```

## Configuration Options

Configure the module with `IdScan.Builder`. The table below lists the most commonly used options.

| Setting                                      | Description                                                                                                                                         |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setShowIdTutorials(Boolean)`                | Shows or hides the tutorial screen that explains how to scan an ID.                                                                                 |
| `setShowIdTypeChooser(Boolean)`              | Shows or hides the document type selector. When hidden, the type from `setIdType` is used.                                                          |
| `setIdType(IdScan.IdType)`                   | Sets the document type when the selector is not shown (`ID`, `PASSPORT`, `DIGITAL_ID`, `GOOGLE_WALLET_ID`).                                         |
| `setScanStep(IdScan.ScanStep)`               | Selects which sides are captured (`FRONT`, `BACK`, or `BOTH`).                                                                                      |
| `setShowRetakeScreenForAutoCapture(Boolean)` | Controls whether the review/retake screen appears after auto capture.                                                                               |
| `setCaptureAttempts(Integer)`                | Sets the number of allowed capture attempts.                                                                                                        |
| `setStreamFramesEnabled(Boolean)`            | Turns on frame streaming and requires the optional `video-streaming` dependency described above. It is ignored on devices with 2 GB of RAM or less. |

When both `setShowIdTypeChooser(true)` and `setIdType(...)` are provided, the chooser takes precedence and the explicitly set type is ignored.

For the complete option set, see `IdScan.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

ID Scan delivers an `IdScanResult` through two separate `OnboardingListener` callbacks, one per captured side: `onIdFrontCompleted(IdScanResult)` and `onIdBackCompleted(IdScanResult)`. Key fields include:

- `idImagePath`: The URI pointing to the captured front and back ID or passport image.
- `idImageBase64`: The Base64-encoded string of the captured front and back ID or passport bitmap.
- `croppedFacePath`: The URI to the face photo cropped from the ID; `null` when no face can be extracted.
- `croppedDocumentPath`: The URI to the cropped document photo; `null` when it can't be extracted. This result is available for SDK versions 5.42.0 and newer.
- `base64Barcode`: The Base64-encoded content of the scanned PDF417 barcode; `null` if no barcode was read. This result is available for SDK versions 5.43.0 and newer.
- `chosenIdType`: The document type the user chose: `ID` or `Passport`.
- `classifiedIdType`: The document type returned by the server.
- `idCategory`: Whether this is the first or second ID captured.
- `actualIdType`: The derived (read-only) resolved type; uses `classifiedIdType` when present, otherwise falls back to `chosenIdType`.
- `issueName`: The legal name on the document.
- `issueYear`: The year the document was issued.
- `countryCode`: The country code of the document's issuing country.
- `scanStatus`: The integer status code for the scan:
  - `0`: OK
  - `-2`: user cancelled
  - `-1`: unknown error
  - Specific failure codes for fake, glare, sharpness, shadow, unreadable, and emulator
  - `10`: back returns `RESULT_SKIPPED` when only the front is scanned.
- `failReason`: The reason the scan failed; `null` when the scan succeeds.
- `isOnlyFront`: `true` if only the front of the ID was scanned.
- `isOnlyBack`: `true` if only the back of the ID was scanned.
- `skipBackIdCapture`: `true` if back-ID scanning should be skipped.
- `allAttemptsExhausted`: `true` if all retry attempts are used up. This reflects the current side, front or back, independently.
- `faceExtractionSkipped`: `true` when the back end intentionally skipped extracting the face image and biometric template from the front ID; `croppedFacePath` is then expected to be `null` and ID-selfie face match is unavailable.
- `metadata`: The proprietary capture metadata required by the SDK. Populated only when `SdkMode` is `CAPTURE_ONLY`. This result is available for SDK versions 5.39.0 and newer.
- `idealCaptureEnvironmentTestResult`: The result of the ideal-capture-environment test. This result was deprecated in SDK version 5.39.0; use `metadata` instead.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. There is no ID Scan-specific exception subtype.

For all fields, see `IdScanResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-individual-modules`
- URL: https://developer.incode.com/sdk-reference/android-individual-modules/
- Markdown: https://developer.incode.com/sdk-reference/android-individual-modules.md

# Modules

The Incode Android SDK is composed of single-purpose **modules**. You assemble an onboarding flow by adding modules to a `FlowConfig.Builder`, passing it to `startOnboarding()`, and receiving each module's output through your `OnboardingListener`. This page lists each module in categories.

<Callout icon="📘" theme="info">
  ### Terminology

  "Module" here refers to an onboarding **step**, such as ID Scan or Video Selfie. You add them at runtime with `FlowConfig.Builder.add*()`.

  This is different from the Gradle **packaging modules**, like `welcome`, `nfc`, and `video-streaming`, that you [declare as dependencies](/sdk-reference/android-installation/#declare-dependencies) during installation. The **Dependency** column below tells you which packaging module each Incode SDK module needs. Anything marked `onboard` is included with the core SDK.
</Callout>

Each module is configured through its `Builder` and returns a result object through a dedicated callback on the listener. The linked guides cover detailed configuration for the most common modules. See [API Reference](/sdk-reference/android-api-reference/) for the full option set and result fields.

:::warning
Module requirements are enforced per module, not by a single blanket check. For example, `FlowConfig.Builder.build()` throws `ModuleConfigurationException` when the AES module is not placed after the OTP module, and `ModuleNotAvailableException` when a module that is unavailable in Capture-Only mode is added. Individual modules validate their own prerequisites (such as a required companion module or ordering) when added or run, some throwing `InvalidModuleOrderException`. See each module's page for its specific requirements.
:::

The following tables can help you choose which modules to use. They are divided by category. Module descriptions are general. Exact behavior depends on your Flow or Workflow configuration.

***

## Collect Identity Data

These modules gather raw inputs from users. No pass/fail determination is made; these modules receive and record.

| Module                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Dependency                                                                                                                                                                  |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Document Scan](/sdk-reference/android-document-scan) | Captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera. In Dashboard, this is the [Document Capture](/dashboard-platform-administration/document-capture-dashboard) module.                                                                                                                                                                                                                                                                                                                      | `welcome`                                                                                                                                                                   |
| [Dynamic Forms](/sdk-reference/android-dynamic-forms) | Presents one or more custom form screens to collect information from a user. In Dashboard, this is the [Forms and Data Entry](/dashboard-platform-administration/forms-and-data-entry-dashboard) module.                                                                                                                                                                                                                                                                                                                                                                                                                                  | `welcome`                                                                                                                                                                   |
| [Email](/sdk-reference/android-email)                 | Collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address. In Dashboard, this is the [Email Input](/dashboard-platform-administration/email-input-dashboard) module.                                                                                                                                                                                                                                                                                                                                                                                                           | `welcome`                                                                                                                                                                   |
| [Geolocation](/sdk-reference/android-geolocation)     | Requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city. Also available as a non-UI method, so you can call it without showing Incode's UI. In Dashboard, this is the [Geolocation](/dashboard-platform-administration/geolocation-dashboard) module.                                                                                                                                                                                                                                             | `welcome`                                                                                                                                                                   |
| [ID Info](/sdk-reference/android-id-info)             | Extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary#ocr). It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields. Add it after Process ID, which must run after ID Scan. In Dashboard, this is [Review OCR Data](/dashboard-platform-administration/review-ocr-data-dashboard) module.                                                                                                                                                      | `welcome`                                                                                                                                                                   |
| [ID Scan](/sdk-reference/android-id-scan)             | Captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. Supports a non-UI builder, so you can capture without showing Incode's UI. Most flows must include this module. Add it before Process ID. In Dashboard, this is the [ID Capture](/dashboard-platform-administration/id-capture-dashboard) module.                                                                                                                                                                                                                                                  | `welcome`;<br />`video-streaming` for frame streaming;                                                                                                                      |
| [Name](/sdk-reference/android-name)                   | Collects the user's name and sends it to the server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `welcome`                                                                                                                                                                   |
| [NFC Scan](/sdk-reference/android-nfc-scan-2)         | Reads the secure [NFC](/get-started-with-incode/glossary#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image. Add it after the ID Scan and Process ID modules. When a flow captures multiple IDs, NFC Scan applies only to the first ID. In Dashboard, this is the [NFC Scan](/dashboard-platform-administration/nfc-scan-dashboard) module.                                                                                                                                                     | `nfc`                                                                                                                                                                       |
| [Phone](/sdk-reference/android-phone)                 | Collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS. In Dashboard, this is the [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard) module.                                                                                                                                                                                                                                                                                                                                                                                                      | `welcome`                                                                                                                                                                   |
| [QR Scan](/sdk-reference/android-qr-scan)             | Captures the QR code on the back of an ID, decodes its identity data, and sends it to the server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `welcome`                                                                                                                                                                   |
| [Selfie Scan](/sdk-reference/android-selfie-scan)     | Captures the user's face with their device's camera and runs configurable liveness, face recognition and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using [1:1](/get-started-with-incode/glossary#11-face-authentication) or [1:N](/get-started-with-incode/glossary#1n-face-authentication) face authentication. Most flows must include this module. In Dashboard, this is the [Face Capture](/dashboard-platform-administration/face-capture-dashboard) module. | `welcome`;<br />`video-streaming` for frame and audio streaming;<br />`model-liveness-detection`, `model-age-estimation`, and `model-face-occlusion` for on-device results |
| [Video Selfie](/sdk-reference/android-video-selfie)   | Records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent. Add it after a module that captures a selfie, such as Selfie Scan. In Dashboard, this is the [Video Selfie](/dashboard-platform-administration/video-selfie-dashboard) module.                                                                                                                                                                                                                                  | `welcome`;<br />`model-face-recognition` when voice consent is enabled                                                                                                      |

## Verify and Authenticate

These modules run checks against collected data to produce a pass/fail or match/no-match determination.

| Module                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Dependency                                                                                       |
| ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| [Antifraud](/sdk-reference/android-antifraud)                         | Compares the current Session against prior Sessions and known identities to detect signs of fraud. In Dashboard, this is the [Antifraud Check](/dashboard-platform-administration/antifraud-check-dashboard) module.                                                                                                                                                                                                                                                                                                                                                                                                                   | `welcome`                                                                                        |
| [CURP Validation](/sdk-reference/android-curp-validation)             | Validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it. In Dashboard, this is the [CURP Validation](/dashboard-platform-administration/curp-validation-dashboard) module.                                                                                                                                                                                                                                         | `welcome`                                                                                        |
| [Custom Watchlist](/sdk-reference/android-custom-watchlist)           | Screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It runs as a background process and isn't visible to the end user. In Dashboard, this is the [Custom Watchlist](/dashboard-platform-administration/custom-watchlist-dashboard) module.                                                                                                                                                                                                                                     | `welcome`                                                                                        |
| [eKYB (electronic Know Your Business)](/sdk-reference/android-ekyb)   | Collects and verifies a business entity's identity data, such as business name, address, and tax ID. In Dashboard, this is the [eKYB](/dashboard-platform-administration/ekyb-dashboard) module.                                                                                                                                                                                                                                                                                                                                                                                                                                       | `welcome`                                                                                        |
| [eKYC (electronic Know Your Customer)](/sdk-reference/android-ekyc)   | Collects and verifies a user's personal identity data against authoritative data sources. This data can include the user's name, email, address, phone, tax ID, date of birth, and nationality. This module can prefill fields from data captured earlier in the flow, such as a scanned document, and validate them against your Incode configuration. In Dashboard, this is the [eKYC](/dashboard-platform-administration/ekyc-dashboard) module.                                                                                                                                                                                    | `welcome`                                                                                        |
| [Face Authentication](/sdk-reference/android-face-authentication)     | Captures a returning user's face with the device camera and matches it against the face already enrolled for that user. It then returns a pass or fail result. In Dashboard, this is the [Face Authentication](/dashboard-platform-administration/face-authentication-dashboard) module.                                                                                                                                                                                                                                                                                                                                               | `welcome`;<br />`model-liveness-detection`;<br />`model-face-recognition` for on-device results |
| [Face Match](/sdk-reference/android-face-match)                       | Compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a confidence score. Add it after Selfie Scan and at least one of the following: ID Scan, NFC Scan, or QR Scan. Also available as a non-UI method, so you can call it without showing Incode's UI. In Dashboard, this is the [Face Match](/dashboard-platform-administration/face-match-dashboard) module.                                                                                                                                                                                                           | `welcome`                                                                                        |
| [Global Watchlist](/sdk-reference/android-global-watchlist)           | Screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. In Dashboard, this is the [Watchlist](/dashboard-platform-administration/watchlist-dashboard) module.                                                                                                                                                                                                                                                                                                                                             | `welcome`                                                                                        |
| [Government Validation](/sdk-reference/android-government-validation) | Validates identity data extracted from a user's ID against an authoritative government registry. The process runs in the background and isn't visible to the user. It can also match the user's photo in the government database against their captured selfie. Add it after Selfie Scan and at least one of the following: ID Scan, NFC Scan, or QR Scan. In Dashboard, this is the [Government Record Verification](/dashboard-platform-administration/government-record-verification-dashboard) module. | `welcome`                                                                                        |
| [Process ID](/sdk-reference/android-process-id)                       | Determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Scan](/sdk-reference/android-id-scan) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result. Add it before ID Info and after ID Scan. Also available as a non-UI method, so you can call it without showing Incode's UI. In Dashboard, this is the [ID Validation](/dashboard-platform-administration/id-validation-dashboard) module.                                                                                 | `welcome`                                                                                        |
| [Tax ID Validation](/sdk-reference/android-tax-id-validation)         | Collects a user's tax identification number and validates its format and structure.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `welcome`                                                                                        |

## Capture Signatures and Consent

These modules capture legally binding signatures and record user consent.

| Module                                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Dependency |
| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [AES (Advanced Electronic Signature)](/sdk-reference/android-aes-advanced-electronic-signature) | Shows the user documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant. In Dashboard, this is the [Advanced Electronic Signature](/dashboard-platform-administration/advanced-electronic-signature-dashboard-1) module.                                                                                                                                                                                                | `welcome`  |
| [Combined Consent](/sdk-reference/android-combined-consent)                                     | Shows the user one or more preconfigured [consents](/dashboard-platform-administration/configuration-consents-tab) to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey. This module supports offline mode for delayed consent. In Dashboard, this is the [Data Sharing Consent](/dashboard-platform-administration/data-sharing-consent-dashboard) module.                                            | `welcome`  |
| [Machine Learning Consent](/sdk-reference/android-machine-learning-consent)                     | Captures the user's consent to process their biometric data for machine-learning purposes. It records their response on the server. You choose the consent text variant (US or GDPR style) that matches your compliance needs.                                                                                                                                                                                                                                                                                                                                                            | `welcome`  |
| [QES (Qualified Electronic Signature)](/sdk-reference/android-qes)                              | Shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states. In Dashboard, this is the [Qualified Electronic Signature](/dashboard-platform-administration/qualified-electronic-signature-dashboard-1) module. | `welcome`  |
| [Signature](/sdk-reference/android-signature)                                                   | Captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent. In Dashboard, this is the [Electronic Signature](/dashboard-platform-administration/electronic-signature-dashboard) module.                                                                                                                                                                                                                                                                                                     | `welcome`  |
| [User Consent](/sdk-reference/android-user-consent)                                             | Shows a custom consent agreement for the user to review and accept.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `welcome`  |

## Add Human-Assisted Verification

These modules introduce a live agent into the IDV process.

| Module                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                         | Dependency        |
| ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| [Conference (Assisted Video)](/sdk-reference/android-conference-assisted-video) | Connects the user with a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements. In Dashboard, this is the [Video Conference](/dashboard-platform-administration/video-conference-dashboard) module. | `video-streaming` |

## Configure the User Experience

These modules shape the user experience of a Workflow or Flow, including routing decisions. They do not collect or verify data.

| Module                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                    | Dependency |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [Custom Module](/sdk-reference/android-custom-module) | Pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues. It does this by handing your app a `callbackName`, then resuming the Workflow at the next node once you report a result. In Dashboard, this is the [Custom Module](/dashboard-platform-administration/custom-module-dashboard). | `welcome`  |

## View Results
| Module                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Dependency |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [Results](/sdk-reference/android-results) | Shows a screen summarizing the data captured during onboarding, including OCR fields, captured images, and identity scores. It returns an overall user score. Add it after the modules that add or process the data it summarizes, such as ID Scan and Selfie Scan. Also available as a non-UI method, so you can call it without showing Incode's UI. In Dashboard, this is the [Show Results](/features-and-modules/field-comparison-1) module. | `welcome`  |

## Configure Android-Specific Experiences

These modules have no Dashboard equivalent. They exist only in the Android SDK.

| Module                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                          | Dependency |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [Accept Video Selfie](/sdk-reference/android-accept-video-selfie) | Presents a consent screen that asks the user to agree to having a video selfie recorded later in the flow. It signals once the user accepts. This module is in beta. Add it before Video Selfie.                                                                                                                                                                                                                     | `welcome`  |
| [Approval](/sdk-reference/android-approval)                       | Finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. By default, it runs with no UI and approves silently, but you can toggle the UI, silent face match, and forced approval. Add it after the modules that add or process the data it summarizes, such as ID Scan and Selfie Scan.                                                           | `welcome`  |
| [Captcha](/sdk-reference/android-captcha)                         | Presents a CAPTCHA challenge during onboarding to verify human interaction and reduce automated abuse. It then returns the user's response to your app. In Dashboard, this feature can be enabled when adding the [Email Input](/dashboard-platform-administration/email-input-dashboard) or [Phone Number](/dashboard-platform-administration/phone-number-input-dashboard) Input module. | `welcome`  |
| [Intro](/sdk-reference/android-intro)                             | Displays an introduction screen. It lists the documents and checks the user will need to complete.                                                                                                                                                                                                                                                                                                                   | `welcome`  |

***

## Helpers Used by Every Integration

These aren't modules, but every integration uses them to configure a session and receive results. See [Configure Flows Locally and Run End to End](/sdk-reference/android-configure-flows-locally-and-run-end-to-end/) for end-to-end usage and [API Reference](/sdk-reference/android-api-reference/) for the full surface.

| Helper                                  | Purpose                                                                                                                                           |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SessionConfig`                         | Configures the onboarding session: Flow or Workflow ID, validation modules, external token or ID, and custom fields.                              |
| `FlowConfig`                            | Declares which modules run and in what order. Build it with `FlowConfig.Builder` and the `add*()` methods shown on each individual module's page. |
| `CommonConfig`                          | Cross-cutting UI options that apply to the whole flow, such as the close button and exit confirmation.                                            |
| `OnboardingListener`                    | The callback interface that delivers each module's result object and flow-level events.                                                           |
| `startOnboarding()` / `startWorkflow()` | Entry points on `IncodeWelcome` that launch a flow from a `FlowConfig` or a Dashboard-defined Workflow.                                           |
| `deleteUserLocalData()`                 | Clears the captured session data from the device. Call it after you're done with a session.                                                       |

***

## Non-UI APIs

You can use a specific set of modules without showing Incode's UI. These modules deliver results through specific callbacks. You don't need to add them to the flow or section configuration.

```kotlin
IncodeWelcome.getInstance().faceMatch(interviewId: String?, idCategory: IdCategory?, faceMatchListener: FaceMatchListener)
IncodeWelcome.getInstance().faceMatch(interviewId: String?, matchType: FaceMatch.MatchType?, idCategory: IdCategory?, faceMatchListener: FaceMatchListener)
IncodeWelcome.getInstance().geolocation(context: Context, interviewId: String?, geolocationListener: GeolocationListener)
IncodeWelcome.getInstance().processId(interviewId: String?, idCategory: IdCategory?, idProcessListener: IdProcessListener)
IncodeWelcome.getInstance().processLaborHistory(interviewId: String?, curp: String, laborHistoryListener: ProcessLaborHistoryListener)
IncodeWelcome.getInstance().processPaymentProof(interviewId: String?, processPaymentProofListener: ProcessPaymentProofListener)
IncodeWelcome.getInstance().getPaymentProofInfo(interviewId: String?, getPaymentProofInfoListener: PaymentProofInfoListener)
IncodeWelcome.getInstance().getUserScore(idResultsFetchMode: IDResultsFetchMode, interviewId: String?, getUserScoreListener: GetUserScoreListener)
```
```java
IncodeWelcome.getInstance().faceMatch(@Nullable String interviewId, @Nullable IdCategory idCategory, @NonNull FaceMatchListener faceMatchListener)
IncodeWelcome.getInstance().faceMatch(@Nullable String interviewId, @Nullable FaceMatch.MatchType matchType, @Nullable IdCategory idCategory, @NonNull FaceMatchListener faceMatchListener)
IncodeWelcome.getInstance().geolocation(@NonNull Context context, @Nullable String interviewId, @NonNull GeolocationListener geolocationListener)
IncodeWelcome.getInstance().processId(@Nullable String interviewId, @Nullable IdCategory idCategory, @NonNull IdProcessListener idProcessListener)
IncodeWelcome.getInstance().processLaborHistory(@Nullable String interviewId, @NonNull String curp, @NonNull ProcessLaborHistoryListener laborHistoryListener)
IncodeWelcome.getInstance().processPaymentProof(@Nullable String interviewId, @NonNull ProcessPaymentProofListener processPaymentProofListener)
IncodeWelcome.getInstance().getPaymentProofInfo(@Nullable String interviewId, @NonNull PaymentProofInfoListener getPaymentProofInfoListener)
IncodeWelcome.getInstance().getUserScore(@NonNull IDResultsFetchMode idResultsFetchMode, @Nullable String interviewId, @NonNull GetUserScoreListener getUserScoreListener)
```

:::info
### Non-UP APIs vs. Capture-Only Mode
Non-UI APIs skip the UI but still send data to Incode for processing, while [Capture-Only mode](/sdk-reference/android-capture-only-sdk/) keeps the UI but skips sending data to Incode.
:::

For full method signatures, see [API Reference](/sdk-reference/android-api-reference/). For result and error objects, see [Results](/sdk-reference/android-results-reference/).

---

- Path: `sdk-reference/android-installation`
- URL: https://developer.incode.com/sdk-reference/android-installation/
- Markdown: https://developer.incode.com/sdk-reference/android-installation.md

# Installation

This page covers everything you need to add the Incode Android SDK to your project. It covers build requirements, repository and dependency setup with Gradle, the Incode Bill of Materials (BOM), required and optional permissions, initializing the SDK, and enabling test mode. After the project builds, [choose an integration approach](/sdk-reference/android-common-implementation-patterns/).


## Build Requirements

Ensure your build environment meets the following minimum requirements:

- **Java**: Java 8 in your module-level `[module]/build.gradle`, applied to both `sourceCompatibility` and `targetCompatibility`. This page explains where to set this.
- **compileSdk**: 35 or higher. The SDK's bundled AndroidX dependencies require apps to compile against API 35 or later. If your `compileSdk` is lower, the build fails the AAR-metadata check with `... require ... compile against version 35 or later`. Set `compileSdk 35` or higher in your module-level `build.gradle`. This is independent of `minSdk` and `targetSdk`.
- **minSdk**: 23; raise to 24 if you use `video-streaming`. Raise to 28 if you use Google Wallet.
- **targetSdk**: Your choice; the SDK itself targets API 33.
- **Build tooling**: Android Gradle Plugin 8.6.0, Gradle 8.7, Kotlin 1.9.25. Newer compatible versions also work. Matching your Android Studio's bundled AGP avoids IDE sync slowdowns.

Also, ensure your devices meet the [device requirements](/sdk-reference/android-sdk/#device-requirements). Then complete the following steps in order.


## Add Repositories

The Incode Android SDK is distributed through GitHub Packages. To receive credentials, contact your enterprise customer success manager or [help@incode.com](mailto:help@incode.com).

:::warning
**Artifactory Distribution Has Ended**

Support for Artifactory distribution ended September 19, 2025. If you are using Artifactory in your production integration, migrate to GitHub Packages to maintain uninterrupted access to the SDK.
:::

The code blocks below use the project-level `build.gradle`. On projects that use Gradle's centralized repository management, which is the default for newer Android Studio projects, add the same `repositories { }` entries to the `dependencyResolutionManagement` block in `settings.gradle` instead. The URLs and credentials are identical. If you keep them in the project `build.gradle`, make sure `settings.gradle` is not set to `RepositoriesMode.FAIL_ON_PROJECT_REPOS`.

### Add the GitHub Packages Repository

Add the following to your project-level `build.gradle`. For more information about declaring repositories, see the [Gradle documentation](https://docs.gradle.org/current/userguide/declaring_repositories.html).

```groovy build.gradle (Project)
repositories {
    maven {
        url "https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages"
        credentials {
            username = "incode-customers"
            password = "YOUR_GITHUB_TOKEN"
        }
    }
}
```
```kotlin build.gradle.kts (Project)
repositories {
    maven {
        url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
        credentials {
            username = "incode-customers"
            password = "YOUR_GITHUB_TOKEN"
        }
    }
}
```

Keep `username` as `incode-customers`. Replace `YOUR_GITHUB_TOKEN` with the access token Incode provides. The token must have the `read:packages` scope and access to the `android-omni-packages` registry, or dependency resolution fails with `401 Unauthorized`. Do not commit the token. Store it outside source control - for example, in `~/.gradle/gradle.properties` or an environment variable - and read it in:

```groovy build.gradle (Project)
credentials {
    username = "incode-customers"
    password = providers.gradleProperty("incode.githubToken").get()
}
```

### Add the JitPack Repository

The SDK depends on JitPack. Add the following Maven repository.

```groovy build.gradle (Project)
repositories {
    maven { url "https://jitpack.io" }
}
```
```kotlin build.gradle.kts (Project)
repositories {
    maven("https://jitpack.io")
}
```

### Add Google and Maven Central

If the Google and Maven Central repositories are not already in your project-level `build.gradle` file, add them.

```groovy build.gradle (Project)
repositories {
    google()
    mavenCentral()
}
```
```kotlin build.gradle.kts (Project)
repositories {
    google()
    mavenCentral()
}
```

Combined, your project-level repositories should look like this:

```groovy build.gradle (Project)
repositories {
    google()
    mavenCentral()

    maven { url "https://jitpack.io" }
    maven {
        url "https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages"
        credentials {
            username = "incode-customers"
            password = "YOUR_GITHUB_TOKEN"
        }
    }
}
```
```kotlin build.gradle.kts (Project)
repositories {
    google()
    mavenCentral()

    maven("https://jitpack.io")
    maven {
        url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
        credentials {
            username = "incode-customers"
            password = "YOUR_GITHUB_TOKEN"
        }
    }
}
```


## Enforce Java 8

Add the following code inside your `android{}` block in your `[module]/build.gradle`. `[module]` refers to your app or library module, not an [Incode SDK module](/sdk-reference/android-individual-modules/).

```groovy build.gradle (Module)
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
```
```kotlin build.gradle.kts (Module)
compileOptions {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}
```



## Add the Incode Bill of Materials (BOM)

The Incode BOM streamlines dependency version control. When you specify the BOM's version, it automatically ensures all Incode dependencies in your project use compatible versions. You don't need to assign versions to each dependency individually. Update the BOM version to update all dependencies at once. See [BOM Version Mapping](/release-notes/bom-version-mapping/) for the latest version.

Specifying the BOM only downloads a POM file with a version mapping. You must still [declare each dependency](#declare-dependencies) individually in your `[module]/build.gradle`.

Add the BOM to the `dependencies` block in your `[module]/build.gradle`.

```groovy build.gradle (Module)
dependencies {
    ...

    implementation platform('com.incode.sdk:bom:5.55.0')
}
```
```kotlin build.gradle.kts (Module)
dependencies {
    ...

    implementation(platform("com.incode.sdk:bom:5.55.0"))
}
```



## Declare Dependencies

Add the following to your `[module]/build.gradle`. `welcome` and `core-light` are required. All others are optional; add them only if your integration uses the features they provide. If you [added the Incode BOM](#add-the-incode-bill-of-materials-bom), omit version numbers.

```groovy build.gradle (Module)
dependencies {
    ...

    // Incode Omni SDK
    implementation 'com.incode.sdk:welcome' // Required core dependency
    implementation 'com.incode.sdk:core-light' // Required core dependency

    // The following dependencies are optional and needed only in very specific use cases.
    // Make sure you are using the features they provide before adding the dependencies below.
    implementation 'com.incode.sdk:extensions' // Optional dependency
    implementation 'com.incode.sdk:nfc' // Optional dependency
    implementation 'com.incode.sdk:video-streaming' // Optional dependency

    implementation 'com.incode.sdk:model-face-recognition' // Optional dependency
    implementation 'com.incode.sdk:model-liveness-detection' // Optional dependency
    implementation 'com.incode.sdk:model-face-occlusion' // Optional dependency
    implementation 'com.incode.sdk:model-age-estimation' // Optional dependency
    implementation 'com.incode.sdk:wallets' // Optional dependency
}
```
```kotlin build.gradle.kts (Module)
dependencies {
    ...

    // Incode Omni SDK
    implementation("com.incode.sdk:welcome") // Required core dependency
    implementation("com.incode.sdk:core-light") // Required core dependency

    // The following dependencies are optional and needed only in very specific use cases.
    // Make sure you are using the features they provide before adding the dependencies below.
    implementation("com.incode.sdk:extensions") // Optional dependency
    implementation("com.incode.sdk:nfc") // Optional dependency
    implementation("com.incode.sdk:video-streaming") // Optional dependency

    implementation("com.incode.sdk:model-face-recognition") // Optional dependency
    implementation("com.incode.sdk:model-liveness-detection") // Optional dependency
    implementation("com.incode.sdk:model-face-occlusion") // Optional dependency
    implementation("com.incode.sdk:model-age-estimation") // Optional dependency
    implementation("com.incode.sdk:wallets") // Optional dependency
}
```

| Dependency                 | Type     | Description                                                                                                                                                                                                                                                                                                                             |
| :------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `welcome`                  | Required | Core dependency; contains all core SDK functionality and the `IncodeWelcome` entry point.                                                                                                                                                                                                                                               |
| `core-light`               | Required | Contains image-processing libraries used throughout the SDK.                                                                                                                                                                                                                                                                            |
| `extensions`               | Optional | Required for custom theme configuration, dynamic localization, and runtime localization. See [Customization](/sdk-reference/android-customization/).                                                                                                                                                    |
| `nfc`                      | Optional | Required for the NFC Scan module. See [NFC Scan](/sdk-reference/android-nfc-scan-2/) for additional configuration.                                                                                                                                                                                      |
| `video-streaming`          | Optional | Required by the [Conference module](/sdk-reference/android-conference-assisted-video/) and the `streamFrames` feature in the [ID Scan](/sdk-reference/android-id-scan/) and [Selfie Scan](/sdk-reference/android-selfie-scan/) modules. |
| `model-face-recognition`   | Optional | Required for on-device face recognition. Used by face login in the [Selfie Scan module](/sdk-reference/android-selfie-scan/)​ only.                                                                                                                                                                     |
| `model-liveness-detection` | Optional | Required for on-device liveness detection in the [Selfie Scan module](/sdk-reference/android-selfie-scan/) via `SelfieScan.Builder().setFaceAuthMode(SelfieScan.FaceAuthMode.LOCAL)`.                                                                                                                   |
| `model-face-occlusion`     | Optional | Required for on-device face occlusion detection in the [Selfie Scan module](/sdk-reference/android-selfie-scan/) via `SelfieScan.Builder().setFaceOcclusionEnabled(true)`.                                                                                                                              |
| `model-age-estimation`     | Optional | Required for on-device age estimation in the [Selfie Scan module](/sdk-reference/android-selfie-scan/) via `SelfieScan.Builder().setOnDeviceFaceResultsSubmissionEnabled(true)`.                                                                                                                        |
| `wallets`                  | Optional | Required for wallet integrations, including Google Wallet ID.                                                                                                                                                                                                                                                                           |

After adding dependencies, build the project. [Troubleshoot](/sdk-reference/android-troubleshooting/) if you encounter errors. For the version mapped to each dependency, see [BOM Version Mapping](/release-notes/bom-version-mapping/).

### Override a Dependency Version

Overriding a BOM dependency version is not recommended. If necessary, specify the version where it would normally be omitted.

```groovy build.gradle (Module)
dependencies {
    ...

    implementation platform('com.incode.sdk:bom:5.55.0')

    // Required core dependencies
    implementation 'com.incode.sdk:welcome'
    implementation 'com.incode.sdk:core-light'

    // Optional dependencies
    implementation('com.incode.sdk:video-streaming') {
        version {
            strictly 'x.x.x-1'
        }
    }
}
```
```kotlin build.gradle.kts (Module)
dependencies {
    ...

    implementation(platform("com.incode.sdk:bom:5.55.0"))

    // Required core dependencies
    implementation("com.incode.sdk:welcome")
    implementation("com.incode.sdk:core-light")

    // Optional dependencies
    implementation("com.incode.sdk:video-streaming") {
        version {
            strictly("x.x.x-1")
        }
    }
}
```



## Declare Required Permissions

The SDK declares the following permissions in its manifest files:

- `com.incode.sdk:welcome`
  ```xml
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.VIBRATE" />
  <uses-permission android:name="android.permission.CAMERA" />
  <uses-permission android:name="android.permission.RECORD_AUDIO" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
  <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
  ```
- `com.incode.sdk:nfc`
  ```xml
  <uses-permission android:name="android.permission.NFC" />
  ```

The `Phone` module’s Silent Network Authentication (SNA) feature adds further network permissions through the SDK that powers it. They are merged into your app automatically and need no declaration on your side; see [Enable Silent Network Authentication](/sdk-reference/android-phone#enable-silent-network-authentication) for the details.

If your app does not use the screen recording features of the ID Scan, Selfie Scan, or Video Selfie modules, you can omit the foreground service permissions. Add the following to your `AndroidManifest.xml`:

```xml AndroidManifest.xml
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" tools:node="remove" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" tools:node="remove" />
```

If the manifest fails to merge during a build, [troubleshoot](/sdk-reference/android-troubleshooting/).








:::info
  ### Camera Lint Warning

  The SDK manifest declares `<uses-feature android:name="android.hardware.camera" />`, so the merged manifest already advertises the camera requirement. If Android Lint flags `PermissionImpliesUnsupportedHardware` on your own module, declare the feature explicitly in your `AndroidManifest.xml`:

  `<uses-feature android:name="android.hardware.camera" android:required="false" />`

  Use `android:required="false"` only if you want your app installable on devices without a camera. The SDK's capture flows require one.
:::



## Add Optional Permissions

Some SDK features work better with additional permissions. These permissions may subject your app to additional scrutiny when publishing on Google Play. Declare them only if your app has an existing use case for them.

### Query All Apps on Android 11+

On Android 11 and later, root detection skips additional actions. This can result in some rooted devices going undetected. Add the following permission to enable the SDK's root detection to take more actions and find evidence of a rooted device.

```xml
<uses-permission android:name="android.permission.QUERY_ALL_PACKAGES" />
```

On earlier Android versions, actions that require `QUERY_ALL_PACKAGES` are taken by default.

### Enable Higher Sampling Rates on Android 12+

On Android 12 and later, the second highest sample rate is used by default when determining the device's `motionStatus` for the ID Scan and Selfie Scan modules. Add the following permission to maximize the sampling rate used.

```xml
<uses-permission android:name="android.permission.HIGH_SAMPLING_RATE_SENSORS" />
```

On earlier Android versions, the highest sampling rate is used automatically.



## Initialize the SDK

Add the following to the class that extends `Application`:

```kotlin
override fun onCreate() {
    super.onCreate()
    ...
    IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
        .setSSLConfig(sslConfig) // optional SSL config for on-premise servers
        .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. These are enabled by default
        .build()
    ...
}
```
```java
@Override
public void onCreate() {
    super.onCreate();
    ...
    new IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
            .setSSLConfig(sslConfig) // optional SSL config for on-premise servers
            .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. These are enabled by default
            .build();
    ...
}
```

- `WELCOME_API_URL` and `WELCOME_API_KEY` are provided by Incode.
- `build()` creates the `IncodeWelcome` singleton. You can only make SDK API calls after initialization.
- `setSSLConfig()` is optional. Use it to specify SSL config for your own on-prem servers.
- `setLoggingEnabled()` is optional. Use it to enable or turn off logcat logs. Logs are enabled by default.

See [API Reference](/sdk-reference/android-api-reference/) for the complete specification of the `IncodeWelcome.Builder` and `SSLConfig`.

### Opt Out of Diagnostics

Optionally opt out of SDK diagnostics collection. Diagnostics are enabled by default for `startOnboarding`, `startFlow`, `startWorkflow`, and `startOnboardingSection`. `CAPTURE_ONLY` mode is not supported yet. Disable at init time via the `Builder`:

```kotlin
IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
    .setDiagnosticsDataEnabled(false)
    .build()
```
```java
new IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
        .setDiagnosticsDataEnabled(false)
        .build();
```

Or at any time after init via `IncodeWelcome.getInstance()`:

```kotlin
IncodeWelcome.getInstance().setDiagnosticsDataEnabled(false)
```
```java
IncodeWelcome.getInstance().setDiagnosticsDataEnabled(false);
```

### Initialize from an Activity

Incode recommends initializing the SDK in your `Application` class's `onCreate()` method, as shown above. If you initialize within an `Activity` instead, guard the call with `isInitialized()` inside `onCreate()`:

```kotlin
override fun onCreate() {
    super.onCreate()
    ...
    if (!IncodeWelcome.isInitialized()) {
        IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
            .setSSLConfig(sslConfig) // optional SSL config for on-premise servers
            .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. These are enabled by default
            .build()
    }
    ...
}
```
```java
@Override
public void onCreate() {
    super.onCreate();
    ...
    if (!IncodeWelcome.isInitialized()) {
        new IncodeWelcome.Builder(this,WELCOME_API_URL,WELCOME_API_KEY)
        .setSSLConfig(sslConfig) // optional SSL config for on-premise servers
        .setLoggingEnabled(loggingEnabled) // enable/disable logcat logs. These are enabled by default
        .build();
    }
    ...
}
```

### Initialize with an External ID

You can key a session to an identifier from your own system rather than relying only on a session token. On Android, this is expressed as two methods on `SessionConfig.Builder`:

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setExternalId("<YOUR_EXTERNAL_ID>")
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setExternalId("<YOUR_EXTERNAL_ID>")
    .build();
```

- `setExternalId`: An ID used outside the Incode Platform. If a session with the same `externalId` already exists, it is resumed instead of creating a new one.
- `setExternalCustomerId`: Similar to `setExternalId`, but always creates a new session instead of resuming.

Pass the configuration when you start a flow. See [Common Integration Approaches](/sdk-reference/android-common-implementation-patterns/).

To initialize the SDK without an API key and start a session your backend created, see [Token-based Setup](/sdk-reference/android-token-based-setup/).



## Enable Test Mode

Test Mode lets you run and test the SDK on an emulator during development. Add `setTestModeEnabled(true)` to the `IncodeWelcome.Builder` chain in your `Application` class.

```kotlin
IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
    .setTestModeEnabled(true) // enable Test Mode for emulator testing
    .build()
```
```java
new IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY)
    .setTestModeEnabled(true) // enable Test Mode for emulator testing
    .build();
```

With Test Mode enabled, camera-dependent modules skip capture on an emulator. Instead, they show a placeholder screen and finish automatically with an emulator-detected result code:

- Document Scan, Face Match, Selfie Scan, and Video Selfie: `ResultCode.EMULATOR_DETECTED` as `resultCode`.
- ID Scan: `IdResults.RESULT_EMULATOR_DETECTED` as `frontIdResult` and `backIdResult`.

:::warning

  Remove `setTestModeEnabled(true)` before you build for production. Test Mode is for development only.
:::



## What's Next

After the project successfully builds, you can begin [integration](/sdk-reference/android-common-implementation-patterns/)​.

<br />

---

- Path: `sdk-reference/android-intro`
- URL: https://developer.incode.com/sdk-reference/android-intro/
- Markdown: https://developer.incode.com/sdk-reference/android-intro.md

# Intro

The Intro module displays an introduction screen. It lists the documents and checks the user will need to complete.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

## Add Intro

Add the module with `addIntro(intro)`. Intro is meant to run first, so add it before your capture modules.

```kotlin
flowConfigBuilder.addIntro(intro)
```
```java
flowConfigBuilder.addIntro(intro);
```

### Example

The example below builds an `Intro` listing the ID and selfie checks, adds it as the first step in the flow, and continues once the user finishes the screen.

```kotlin
val intro = Intro.Builder()
    .setIntroChecks(listOf(IntroChecks.ID, IntroChecks.SELFIE))
    .build()

val flowConfig = FlowConfig.Builder()
    .addIntro(intro)
    // ... add your capture modules after it
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onIntroCompleted() {
        // The user finished the intro screen. Continue the flow.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
Intro intro = new Intro.Builder()
    .setIntroChecks(Arrays.asList(IntroChecks.ID, IntroChecks.SELFIE))
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addIntro(intro)
    // ... add your capture modules after it
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onIntroCompleted() {
        // The user finished the intro screen. Continue the flow.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `Intro.Builder`. At least one intro check is required, or the module fails configuration.

| Setting                                   | Description                                                                                                                                                 |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setIntroChecks(List<IntroChecks>)`       | Sets the list of documents and checks shown on the intro screen: for example, `ID`, `PASSPORT`, `SELFIE`, and `PROOF_OF_ADDRESS`. At least one is required. |
| `setAllowContinueWithoutConsent(boolean)` | Lets the user continue from the intro screen without explicitly accepting. Defaults to `false`.                                                             |

The intro checks you list should reflect the capture modules you add to the same flow, so the screen matches what the user is actually asked to complete.

For the complete option set, see `Intro.Builder` and the `IntroChecks` values in [API Reference](/sdk-reference/android-api-reference/).

## Result

Intro does not deliver a result payload to the `OnboardingListener`. It signals completion through the no-argument `onIntroCompleted()` callback, which fires when the user finishes the intro screen.

If the module cannot complete, errors surface through `OnboardingListener.onError(Throwable)`.

---

- Path: `sdk-reference/android-known-issues`
- URL: https://developer.incode.com/sdk-reference/android-known-issues/
- Markdown: https://developer.incode.com/sdk-reference/android-known-issues.md

# Known Issues

This page lists the known issues, limitations, and intentional constraints you are most likely to run into with the Incode Android SDK. Each entry describes a lasting, customer-facing issue, not a temporary bug. The [release notes](/release-notes/releases-android-sdk/) track and resolve temporary bugs.

This list is a quick summary. The [release notes](/release-notes/releases-android-sdk/) and [Migration Guide](/release-notes/migration-guide/) hold the authoritative, version-specific notes. Check those pages for the exact release where a behavior changed, or a limitation started or ended.

***

## NFC

- **NFC reads only the first ID.** In a flow that captures multiple IDs, NFC scanning supports only the first captured ID. See [NFC Scan](/sdk-reference/android-nfc-scan-2/).
- **The SDK tries PACE protocol, then falls back to BAC.** See [NFC Scan](/sdk-reference/android-nfc-scan-2/) for retry behavior.

***

## Capture-Only Mode

- **Forward `metadata` to the Incode API.** When [Deepsight](/features-and-modules/deepsight/) is enabled in Capture-Only mode, the `metadata` field must be forwarded from `IdScanResult` and `SelfieScanResult` to the Incode API. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/#forward-metadata-for-deepsight).

***

## Delayed Mode

- **Limited module support.** Delayed mode, also called offline mode, supports only the Combined Consent, Document Scan, Face Match, ID Scan, Process ID, and Selfie Scan modules. See [SDK Modes](/sdk-reference/android-sdk-modes/).

***

## On-Device Face Processing for Selfie Scan V2

- **Constrained configuration.** `SelfieScan.Builder.setOnDeviceFaceResultsSubmissionEnabled(...)` requires end-to-end encryption and auto-capture. See [Selfie Scan](/sdk-reference/android-selfie-scan/#configuration-options).

***

## Video Streaming

- **Minimum RAM requirement.** Video streaming requires more than 2 GB of RAM. On devices with 2 GB or less, `setStreamFramesEnabled(true)` is ignored.
- **Mutually exclusive with Deepsight Video Liveness.** If you enable both Deepsight Video Liveness and video streaming on the Selfie Scan module, video streaming is ignored.
- **Higher `minSdk`**. The optional `video-streaming` dependency requires `minSdk` 24 or higher. See [Installation](/sdk-reference/android-installation/#build-requirements).

***

## Emulators and Test Mode

- **Emulators return dummy results, not real captures.** With Test Mode enabled, camera-dependent modules return a dummy result, such as `ResultCode.EMULATOR_DETECTED`. Remove `setTestModeEnabled(true)` before you build for production. See [Installation](/sdk-reference/android-installation/#enable-test-mode).

***

## Device Environment Detection

- **Hook or virtual-environment detection ends the app.** Detecting a hook or virtual environment crashes the app immediately. Your code cannot catch or handle this crash. Emulator and root detection do not stop onboarding, and you cannot disable any of these checks. See [Migration Guide](/release-notes/migration-guide/#4-selfie-v2---error-screen-customization).

***

## Layout and Orientation

- **Selfie capture is orientation-locked.** In Selfie Scan UI v2, tablets are locked to landscape and phones are locked to portrait. See [Selfie Scan](/sdk-reference/android-selfie-scan/#add-selfie-scan).

***

## Optional Dependencies and minSdk

- **Google Wallet ID requires `minSdk`.** The optional `wallets` dependency, used for Google Wallet ID verification, requires `minSdk` 28. See [Google Wallet](/sdk-reference/android-google-wallet-id/) and [Installation](/sdk-reference/android-installation/#build-requirements).

***

## Version Line Scope

- **The `6.x.x` line is not yet feature-complete.** The `6.0.0` line supports only the Face Authentication, Face Match, ID Scan, Process ID, and Selfie Scan modules, plus a subset of optional dependencies. It does not include the UI v1 module variants. Use the `5.x.x` line if your integration needs anything outside that scope. See Changelog.

<br />

---

- Path: `sdk-reference/android-licenses`
- URL: https://developer.incode.com/sdk-reference/android-licenses/
- Markdown: https://developer.incode.com/sdk-reference/android-licenses.md

# Licenses

The Android SDK is proprietary software. Copyright 2026 Incode Technologies. All rights reserved. Its binary also includes some open-source components, used under the licenses identified below. Each entry lists a copyright notice and the component's source. For adapted snippets, the entry lists an author name instead of a copyright notice. Every section ends with a link to the full license text.

***

## Apache License Version 2.0

These components are included in the SDK binary under the Apache License, Version 2.0:

| Component                                                                    | Copyright                                         | Source                                                                                                                                                                        |
| ---------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| BitmapUtils.getTransformationMatrix()                                        | 2015 The TensorFlow Authors. All rights reserved. | [https://github.com/tensorflow/tensorflow](https://github.com/tensorflow/tensorflow); <br />file: `tensorflow/tools/android/test/jni/`<br />`object_tracking/ImageUtils.java` |
| BlurTransformation                                                           | 2020 Wasabeef                                     | [https://github.com/wasabeef/glide-transformations](https://github.com/wasabeef/glide-transformations)                                                                        |
| ObservableTransformers                                                       | 2016-2019 David Karnok                            | [https://github.com/akarnokd/RxJavaExtensions](https://github.com/akarnokd/RxJavaExtensions)                                                                                  |
| ObservableValve                                                              | 2016-2019 David Karnok                            | [https://github.com/akarnokd/RxJavaExtensions](https://github.com/akarnokd/RxJavaExtensions)                                                                                  |
| PageIndicatorView                                                            | 2017 Roman Danylyk                                | [https://github.com/romandanylyk/PageIndicatorView](https://github.com/romandanylyk/PageIndicatorView); <br />incorporated files: `commons/ui/page_indicator_view/`           |
| PhoneNumberFormattingTextWatcher                                             | 2008 The Android Open Source Project              | [https://android.googlesource.com/](https://android.googlesource.com/)                                                                                                        |
| SignatureView: touchStart, touchMove, touchUp, and TOUCH\_TOLERANCE portions | 2017 Google Inc.                                  | [https://github.com/google-developer-training/android-advanced](https://github.com/google-developer-training/android-advanced); <br />file: `CanvasExample/MyCanvasView.java` |
| slide\_in\_right and slide\_out\_left animations                             | 2007 The Android Open Source Project              | [https://android.googlesource.com/](https://android.googlesource.com/)                                                                                                        |

Full license text: [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)

***

## BSD 3-Clause License

The SDK binary includes one component under the BSD 3-Clause License. This license requires you to reproduce the copyright notice, list of conditions, and disclaimer verbatim in any documentation or materials you distribute. If your app includes an "Open Source Licenses" screen, include the notice below to meet this requirement.

### SQLCipher for Android: net.zetetic:sqlcipher-android

Source: [https://github.com/sqlcipher/sqlcipher-android](https://github.com/sqlcipher/sqlcipher-android)
Upstream license file: [https://github.com/sqlcipher/sqlcipher-android/blob/master/LICENSE](https://github.com/sqlcipher/sqlcipher-android/blob/master/LICENSE)

<Accordion title="Copyright notice, conditions, and disclaimer">

> Copyright (c) 2008-2023, ZETETIC LLC. All rights reserved.
>
> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
>
> - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
> - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
> - Neither the name of the ZETETIC LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
>
> THIS SOFTWARE IS PROVIDED BY ZETETIC LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ZETETIC LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

</Accordion>

***

## Creative Commons Attribution-ShareAlike 3.0 (CC BY-SA 3.0)

These code snippets come from Stack Overflow answers, published under the Creative Commons Attribution-ShareAlike 3.0 Unported License:

| Component                                                                                    | Author           | Source                                                                                                                                                                                                         |
| -------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CustomTypefaceSpan                                                                           | Weston           | [https://stackoverflow.com/a/9800616](https://stackoverflow.com/a/9800616)                                                                                                                                     |
| IOUtils.getIPAddress()                                                                       | Rüdiger Herrmann | [https://stackoverflow.com/a/13007325](https://stackoverflow.com/a/13007325)                                                                                                                                   |
| NfcScanBottomSheet.onCreateDialog(): handles back-press and cancel-on-touch-outside behavior | Not listed       | [https://stackoverflow.com/questions/60067397/how-to-disable-back-button-on-second-bottom-sheet-dialog](https://stackoverflow.com/questions/60067397/how-to-disable-back-button-on-second-bottom-sheet-dialog) |
| ViewExtensions.isOverlapping(): detects overlapping views                                    | Not listed       | [https://stackoverflow.com/questions/26252710/detect-if-views-are-overlapping](https://stackoverflow.com/questions/26252710/detect-if-views-are-overlapping)                                                   |

Full license text: [https://creativecommons.org/licenses/by-sa/3.0/legalcode](https://creativecommons.org/licenses/by-sa/3.0/legalcode)

***



## MIT License

These components are included in the SDK binary under the MIT License:

| Component                 | Copyright                                                    | Source                                                                                                                                                                                                         |
| ------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Marked: a Markdown parser | 2011-2024 Christopher Jeffrey                                | [https://github.com/markedjs/marked](https://github.com/markedjs/marked)                                                                                                                                       |
| OtpView                   | 2019 Aabhas Jindal                                           | [https://github.com/aabhasr1/OtpView](https://github.com/aabhasr1/OtpView); <br />incorporated files: `commons/ui/otp/`                                                                                        |
| Sentry: portions used     | 2018 [Sentry](https://sentry.io) and individual contributors | [https://github.com/getsentry/sentry-java](https://github.com/getsentry/sentry-java); <br />incorporated files: `IncodeSentry`, `IncodeSentryHubAdapter`, `UncaughtExceptionHandlerIntegration`, `SentryUtils` |

Full license text: [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)

## Commercial - IDLayr SDK (`com.idlayr:idlayr-sdk-android`)

The IDLayr SDK provides Silent Network Authentication (SNA) for phone-number
verification and is vendored into the SDK binary so that integrators do not need
to configure the IDLayr private maven repository. Use is governed by the
commercial license agreement between Incode Technologies and 4Auth Limited
(trading as IDlayr).

Source: https://gitlab.com/tru-id/idlayr-sdk-android
Vendor: 4Auth Limited (https://idlayr.com)

> Copyright © 2026 4Auth Limited (trading as IDlayr). All rights reserved.
>
> This software is licensed under a commercial license agreement.
> Unauthorized use, distribution, or modification is prohibited.

---

- Path: `sdk-reference/android-machine-learning-consent`
- URL: https://developer.incode.com/sdk-reference/android-machine-learning-consent/
- Markdown: https://developer.incode.com/sdk-reference/android-machine-learning-consent.md

# Machine Learning Consent

The Machine Learning Consent module captures the user's consent to process their biometric data for machine-learning purposes. It records their response on the server. You choose the consent text variant (US or GDPR style) that matches your compliance needs.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

## Add Machine Learning Consent

Add the module with `addMachineLearningConsent(machineLearningConsent)`.

```kotlin
flowConfigBuilder.addMachineLearningConsent(machineLearningConsent)
```
```java
flowConfigBuilder.addMachineLearningConsent(machineLearningConsent);
```

### Example

The example below builds a `MachineLearningConsent` module with the US consent variant, adds it to the flow, and listens for the result through `onMachineLearningConsentCompleted()`.

```kotlin
val machineLearningConsent = MachineLearningConsent.Builder()
    .setConsentType(MachineLearningConsent.ConsentType.US)
    .build()

val flowConfig = FlowConfig.Builder()
    .addMachineLearningConsent(machineLearningConsent)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onMachineLearningConsentCompleted(result: MachineLearningConsentResult) {
        // Consent step completed. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
MachineLearningConsent machineLearningConsent = new MachineLearningConsent.Builder()
    .setConsentType(MachineLearningConsent.ConsentType.US)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addMachineLearningConsent(machineLearningConsent)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onMachineLearningConsentCompleted(@NonNull MachineLearningConsentResult result) {
        // Consent step completed. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `MachineLearningConsent.Builder`. The table below lists the available option.

| Setting                                              | Description                                                                                             |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `setConsentType(MachineLearningConsent.ConsentType)` | Selects the consent text variant: `ConsentType.US` or `ConsentType.GDPR`. Defaults to `ConsentType.US`. |

For the complete option set, see `MachineLearningConsent.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Machine Learning Consent delivers a `MachineLearningConsentResult` to the `onMachineLearningConsentCompleted(MachineLearningConsentResult)` callback on the `OnboardingListener`. Key fields include:

- `isSuccess`: `true` if the machine learning consent was submitted successfully; otherwise, `false`.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not define a module-specific exception subtype.

For all fields, see `MachineLearningConsentResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-name`
- URL: https://developer.incode.com/sdk-reference/android-name/
- Markdown: https://developer.incode.com/sdk-reference/android-name.md

# Name

The Name module collects the user's name and sends it to the server.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

## Add Name

Add the module with `addName()`.

```kotlin
flowConfigBuilder.addName()
```
```java
flowConfigBuilder.addName();
```

### Example

The example below adds Name as the only step in the flow and listens for the result through `onAddNameCompleted()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addName()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onAddNameCompleted(nameResult: NameResult) {
        // Name captured. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addName()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onAddNameCompleted(@NonNull NameResult nameResult) {
        // Name captured. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Name has no configurable options. It has no `Builder`, so you add it with the no-argument `addName()` method.

## Result

Name delivers a `NameResult` to the `onAddNameCompleted(NameResult)` callback on the `OnboardingListener`. Key fields include:

- `name`: The name captured from the user; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface via `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `NameResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-nfc-scan-2`
- URL: https://developer.incode.com/sdk-reference/android-nfc-scan-2/
- Markdown: https://developer.incode.com/sdk-reference/android-nfc-scan-2.md

# NFC Scan

The NFC Scan module reads the secure [NFC](/get-started-with-incode/glossary/#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image. When a flow captures multiple IDs, NFC Scan applies only to the first ID.

For an overview of this module and how it works, see [NFC Scan](/features-and-modules/nfc/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add NFC Scan

1. Ensure you've [declared](/sdk-reference/android-installation/#declare-dependencies) the `nfc` dependency in your `[module]/build.gradle`.
2. Add [ID Scan](/sdk-reference/android-id-scan/), then [Process ID](/sdk-reference/android-process-id/), before NFC Scan. NFC Scan reads the chip after the document has been captured and processed.
3. Add the module with `addNfcScan(nfcScan)`:

   ```kotlin
   flowConfigBuilder.addNfcScan(nfcScan)
   ```
   ```java
   flowConfigBuilder.addNfcScan(nfcScan);
   ```

### Example

The example below builds an `NfcScan` module that shows the NFC symbol confirmation screen and processes the chip data, adds it to the flow after the ID Scan and Process ID steps, and listens for the result through `onNfcScanCompleted()`.

```kotlin
val nfcScan = NfcScan.Builder()
    .setShowNfcSymbolConfirmationScreen(true)
    .setProcessNfcData(true)
    .build()

val flowConfig = FlowConfig.Builder()
    // ... add the ID Scan and Process ID steps first
    .addNfcScan(nfcScan)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onNfcScanCompleted(nfcScanResult: NfcScanResult) {
        // NFC scan completed. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
NfcScan nfcScan = new NfcScan.Builder()
    .setShowNfcSymbolConfirmationScreen(true)
    .setProcessNfcData(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    // ... add the ID Scan and Process ID steps first
    .addNfcScan(nfcScan)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onNfcScanCompleted(@NonNull NfcScanResult nfcScanResult) {
        // NFC scan completed. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

### Transparent Background Mode

To show the NFC scanning bottom sheet on a transparent background, so your screen remains visible during the scan, configure the module like this:

```kotlin
val nfcScan = NfcScan.Builder()
    .setShowTutorials(false)
    .setShowNfcSymbolConfirmationScreen(false)
    .setIdType(IdScan.IdType.PASSPORT) // or ID
    .setShowInitialDataConfirmationScreen(false)
    // ... other builder options as needed
    .build()
```
```java
NfcScan nfcScan = new NfcScan.Builder()
    .setShowTutorials(false)
    .setShowNfcSymbolConfirmationScreen(false)
    .setIdType(IdScan.IdType.PASSPORT) // or ID
    .setShowInitialDataConfirmationScreen(false)
    // ... other builder options as needed
    .build();
```

## Configuration Options

Configure the module with `NfcScan.Builder`. The table below lists the most common options.

| Setting                                       | Description                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setShowNfcSymbolConfirmationScreen(Boolean)` | Shows a screen asking the user whether their document contains an NFC chip. If you disable this, handle the no-chip case yourself so a user whose document has no NFC chip does not get stuck.                                                                                                                                                                                                            |
| `setProcessNfcData(Boolean)`                  | Submits the chip data to the back end for identity validation. When enabled, two additional `FaceMatch.MatchType` options become available beyond the default `ID_SELFIE`: `NFC_SELFIE` compares the chip portrait to the selfie, and `NFC_3_WAY` compares the cropped ID image, the chip portrait, and the selfie. See [Face Match](/sdk-reference/android-face-match/). |
| `setShowTutorials(Boolean)`                   | Shows tutorials on how to scan the document.                                                                                                                                                                                                                                                                                                                                                              |
| `setIdType(IdScan.IdType)`                    | Sets the document type to use for NFC scanning.                                                                                                                                                                                                                                                                                                                                                           |
| `setNfcMaxRetries(Integer)`                   | Sets the maximum number of NFC scan attempts. Default: `5`.                                                                                                                                                                                                                                                                                                                                               |
| `setForceV2(Boolean)`                         | Always shows the V2 screens for this module, even when the other modules in the flow show the legacy UI. Default: `false`. This option is temporary and will be removed when the SDK ships V2 only.                                                                                                                                                                                                      |

For each NFC read, the SDK tries the PACE protocol first and falls back to BAC when PACE is unavailable or fails. PACE and BAC are alternatives, not both required. An NFC chip whose access protocol the device cannot complete fails the scan and routes through the retries configured using `NfcScan.Builder.setNfcMaxRetries(...)`.

For the complete option set, see `NfcScan.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

NFC Scan delivers an `NfcScanResult` to the `onNfcScanCompleted(NfcScanResult)` callback on the `OnboardingListener`. Key fields include:

- `compositeCheckDigit`: The Machine Readable Zone (MRZ) composite check digit (DG1); `<` when unset.
- `dateOfBirth`: The date of birth in `yyMMdd` format (DG1).
- `dateOfBirthCheckDigit`: The check digit for the date of birth; `<` when unset.
- `dateOfExpiry`: The document expiry date in `yyMMdd` format (DG1).
- `dateOfExpiryCheckDigit`: The check digit for the expiration date; `<` when unset.
- `documentCode`: The MRZ document code. One of the following: `TD1`, `TD2`, `TD3`, `MRVA`, or `MRVB`. The default is `TD3`.
- `documentNumber`: The 9 most-significant digits of the document number.
- `documentNumberCheckDigit`: The check digit for the document number; `<` when unset.
- `gender`: The document holder's gender. One of the following: `MALE`, `FEMALE`, `UNKNOWN`, or `UNSPECIFIED`.
- `issuingStateOrOrganization`: The issuing state or organization as a 3-letter code.
- `nationality`: The document holder's nationality as a 3-letter code.
- `optionalData1`: First optional data field (ID-1 and ID-3 style MRZs).
- `optionalData2`: Second optional data field (ID-1 style MRZs only); may be `null`.
- `personalNumber`: Personal number, if encoded in `optionalData1`.
- `personalNumberCheckDigit`: The check digit for the personal number (TD3 only); may be `null`.
- `primaryIdentifier`: The document holder's last name.
- `secondaryIdentifier`: The document holder's first name.
- `secondaryIdentifierComponents`: The secondary identifier split into its individual components.
- `dg1EncodedData`: The Base64-encoded string of the entire MRZ (DG1).
- `faceBitmap`: The document holder's face image decoded from the chip (DG2); `null` when unavailable.
- `dg2EncodedData`: The Base64-encoded DG2 (encoded face features); `null` when unavailable.
- `sodEncodedData`: The Base64-encoded Document Security Object (SOD); `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. If the `nfc` library dependency is missing when this module runs, the SDK delivers a `MissingNfcDependencyException` to that callback.

For the authoritative field definitions, see `NfcScanResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-on-device-age-estimation`
- URL: https://developer.incode.com/sdk-reference/android-on-device-age-estimation/
- Markdown: https://developer.incode.com/sdk-reference/android-on-device-age-estimation.md

# Android On Device Age Estimation
On-Device Age Estimation runs the face-analysis pipeline - face detection, positioning, liveness, and age estimation - entirely on the user's device during Face Capture (the `SelfieScan` module). On this path, no selfie image, video, or biometric frames are uploaded to Incode. Only structured analysis results (for example: liveness, face quality, and the estimated age) are submitted to the Incode backend. On-device processing requires E2EE: the SDK enforces it for the session and encrypts the submitted metadata client-side.

Because the biometric capture never leaves the device, the feature also skips the normal selfie image upload, video/frame recording upload, and manual capture. Age decisioning is performed on the backend from the submitted results.

> 📘 Availability
>
> On-Device Age Estimation is available on Android Welcome SDK `5.47.0` and later, in `STANDARD` mode only. It requires using UX V2, the `SelfieScan` module in `SelfieScan.Mode.ENROLL`, and is not supported for Face Login.

## Prerequisites

This guide assumes the Welcome SDK is already installed and initializing in your app. If you are starting from scratch, complete [Android SDK Setup](/sdk-reference/android-installation) (GitHub Packages, dependencies, permissions) and the [SDK Integration guide](/sdk-reference/android-sdk) first, then return here.

Before you enable On-Device Age Estimation, make sure the following are in place:

- **Android Welcome SDK `5.47.0` or later** in `SdkMode.STANDARD`.
- **The two on-device model dependencies** added to your app's module `build.gradle` / `build.gradle.kts`. These are optional for the Welcome SDK overall, but **required** for On-Device Age Estimation:

```groovy build.gradle (Module)
dependencies {
    // Required for On-Device Age Estimation
    implementation 'com.incode.sdk:model-liveness-detection'
    implementation 'com.incode.sdk:model-age-estimation'
}
```
```kotlin build.gradle.kts (Module)
dependencies {
    // Required for On-Device Age Estimation
    implementation("com.incode.sdk:model-liveness-detection")
    implementation("com.incode.sdk:model-age-estimation")
}
```

  Versions are managed by the Incode BOM. See the [BOM Version Mapping](/release-notes/bom-version-mapping) for the versions bundled with each SDK release. If either dependency is missing while the feature is enabled, `SelfieScan.Builder.build()` throws `MissingModelLivenessDetectionDependencyException` or `MissingModelAgeEstimationDependencyException`.

- **E2EE enabled for your organization and a valid E2EE URL.** End-to-end encryption is required for on-device processing. If E2EE is not enabled on the session, the flow ends with `OnDeviceProcessingNotCompatibleException` (reason `MISSING_E2EE`). See the [E2EE Integration Guide](/sdk-reference/android-e2ee) for the full setup.
- **A Flow configured in the Incode Dashboard with an accessible Flow ID** (used as the `configurationId` on the session) if you use the server-driven `startFlow()` path.
- **No conflicting capture routing.** Frame streaming and screen recording must be disabled on this path, because both would send frames off-device. See [Error handling](#error-handling) for the exact conditions.
- **The V2 (Compose) selfie UI.** On-device processing runs only on the V2 selfie UI; a flow routed through the legacy V1 UI raises `OnDeviceProcessingNotCompatibleException` (reason `V1_NOT_SUPPORTED`). See [Enable the V2 UI](#enable-the-v2-ui) for how to turn it on per start method.

> 📘 Minimum SDK
>
> The `model-age-estimation` module targets the SDK's mandatory `minSdk 23` and ships the same ABIs as the rest of the SDK, so it adds no new device or hardware gate for this feature. See [Android SDK Setup](/sdk-reference/android-installation) for the supported ABIs and base packaging.

## Configure On-Device Processing

For server-driven flows, log in to the Dashboard to enable **On-Device Processing** on the Face Capture module configuration in your Flow or Workflow.

### Server-driven Flows and Workflows (recommended)

1. In the left menu, click **Flow Builder** > **Flows** OR **Workflows**.
2. Open your Flow or Workflow.
3. Open the configuration panel for the Face Capture module.
4. Enable **On-Device Processing**. This ensures that liveness and age estimation run entirely on the user's device. No biometric images leave the SDK.
5. If using Workflows, click **Save configurations**. Flow configurations save automatically.
6. Once the configuration panel closes, if using Workflows, click **Save & Publish**. If using Flows, click **Save Changes**.

The SDK reads this setting from the flow automatically. There is no code flag to set.

### Client-configured Flows (alternative)

If you build your own `FlowConfig` in code and start the flow with `startOnboarding()`, set the flag explicitly with `SelfieScan.Builder().setOnDeviceFaceResultsSubmissionEnabled(true)` (see step 3 below). The flag defaults to `false`.

## Enable the V2 UI

On-device age estimation runs only on the V2 (Compose) selfie UI. A Flow on the legacy V1 UI raises `OnDeviceProcessingNotCompatibleException` (reason `V1_NOT_SUPPORTED`). Turn V2 on the way you would for any V2 integration. For the full mechanism and the ECSM caveat, see [Enabling the `V2` UI](/sdk-reference/android-customization#enable-v2-ui) in the SDK Customization guide.

### Server-driven Flows and Workflows (recommended)

1. In the left menu, click **Flow Builder** > **Flows** OR **Workflows**.
2. Open your Flow or Workflow configured for on-device processing.
3. Click the **Settings** tab.
4. Toggle **Enable new user experience** on.
5. For Flows, click **Save Changes**. For Workflows, click **Save & Publish**.

### Client-configured Flows (alternative)

Enable V2 explicitly at initialization with `IncodeWelcome.Builder.setClientExperimentId("experimentV2")` (see step 1 below).

## Integration steps

### 1. Initialize the SDK

Initialize the Welcome SDK, supplying your custom E2EE server URL as the fourth constructor argument, then obtain the singleton instance.

```kotlin
IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY, E2EE_URL)
    // Opts client-configured flows (startOnboarding) into UX V2 - see "Enabling the V2 UI".
    .setClientExperimentId("experimentV2")
    .build()

val incodeWelcome = IncodeWelcome.getInstance()
```
```java
new IncodeWelcome.Builder(this, WELCOME_API_URL, WELCOME_API_KEY, E2EE_URL)
    // Opts client-configured flows (startOnboarding) into UX V2 - see "Enabling the V2 UI".
    .setClientExperimentId("experimentV2")
    .build();

IncodeWelcome incodeWelcome = IncodeWelcome.getInstance();
```

### 2. Create the session configuration

Create a `SessionConfig` that references your Dashboard Flow ID and enables E2EE. The `configurationId` is identical to the Dashboard flow ID (use "Copy flow ID" in the Dashboard).

```kotlin
val sessionConfig: SessionConfig = SessionConfig.Builder()
    .setConfigurationId(FLOW_ID)
    .setE2eEncryptionEnabled(true)
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId(FLOW_ID)
    .setE2eEncryptionEnabled(true)
    .build();
```

Because `setE2eEncryptionEnabled()` is a likely target for fraudsters, protect this code against reverse engineering. See the [E2EE Integration Guide](/sdk-reference/android-e2ee) for the full hardening guidance.

### 3. Start the flow

Unlike iOS, Android does not use a presenting view controller. You pass an Android `Context` and the SDK launches its own activities.

**Server-driven flow (recommended).** With on-device processing enabled in the Dashboard, no code flag is needed. Start the flow with `startFlow()`:

```kotlin
IncodeWelcome.getInstance().startFlow(
    activityContext,
    sessionConfig,
    onboardingListener)
```
```java
IncodeWelcome.getInstance().startFlow(
    activityContext,
    sessionConfig,
    onboardingListener);
```

**Server-driven workflow.** Workflows are also server-driven. Enable "On-Device Processing" on the Face Capture step of your Workflow configuration in the Dashboard, set the session's `configurationId` to the Workflow ID, and start it with `startWorkflow()`. No code flag is needed:

```kotlin
IncodeWelcome.getInstance().startWorkflow(
    activityContext,
    sessionConfig,
    onboardingListener)
```
```java
IncodeWelcome.getInstance().startWorkflow(
    activityContext,
    sessionConfig,
    onboardingListener);
```

**Client-configured flow (alternative).** If you build the `FlowConfig` in code, enable the feature on the `SelfieScan` module and start the flow with `startOnboarding()`:

```kotlin
val flowConfig: FlowConfig = FlowConfig.Builder()
    // ... other modules
    .addSelfieScan(
        SelfieScan.Builder()
            .setOnDeviceFaceResultsSubmissionEnabled(true)
            .build())
    .build()

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    // ... other modules
    .addSelfieScan(
        new SelfieScan.Builder()
            .setOnDeviceFaceResultsSubmissionEnabled(true)
            .build())
    .build();

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener);
```

The SDK validates on-device compatibility at flow start on every path. If any requirement is not met, the flow ends via `OnboardingListener.onError(...)` (see [Error handling](#error-handling)).

### 4. Handle the result

The `SelfieScanResult` is delivered to your `OnboardingListener` through `onSelfieScanCompleted(selfieScanResult)`. Errors are delivered asynchronously to `onError(error)`.

```kotlin
val onboardingListener = object : IncodeWelcome.OnboardingListener {
    // ... other flow callbacks

    override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
        // The selfie image and video were never uploaded to Incode on this path.
        // Continue your flow using the structured result.
    }

    override fun onError(error: Throwable) {
        if (error is OnDeviceProcessingNotCompatibleException) {
            // A requirement for on-device processing was not met.
        }
    }
}
```
```java
IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    // ... other flow callbacks

    @Override
    public void onSelfieScanCompleted(SelfieScanResult selfieScanResult) {
        // The selfie image and video were never uploaded to Incode on this path.
        // Continue your flow using the structured result.
    }

    @Override
    public void onError(Throwable error) {
        if (error instanceof OnDeviceProcessingNotCompatibleException) {
            // A requirement for on-device processing was not met.
        }
    }
};
```

> 📘 Result on the on-device path
>
> Because no server-side face evaluation runs on this path, `SelfieScanResult.isSpoofAttempt` stays `null`. The estimated age is computed on-device and submitted to Incode as part of the structured results; it is not returned in `SelfieScanResult`.
>
> The `SelfieScanResult` still contains the locally captured selfie image (`selfieBase64` / `fullFrameSelfieBase64`, and the local `croppedSelfieImgPath` / `fullFrameSelfieImgPath`). The on-device guarantee is that these image bytes are never uploaded to Incode - not that the local result is image-less. Handle them on-device according to your own privacy requirements.

## Compatible configuration matrix

On-device age estimation only works in a narrow, privacy-preserving configuration. Unusual Flow / Workflow / `FlowConfig` combinations that are valid for a normal Face Capture will abort the session when on-device processing is enabled. Use this matrix when configuring any on-device age-estimation integration.

| Setting | Required value | Where to set it | If wrong |
|:---|:---|:---|:---|
| SDK mode | `SdkMode.STANDARD` | App init | Feature unavailable |
| Welcome SDK version | `5.47.0`+ | App dependencies / BOM | Feature unavailable |
| Model artifacts | `model-liveness-detection` **and** `model-age-estimation` present | App `build.gradle` | `MissingModel*DependencyException` at `SelfieScan.Builder.build()` |
| E2EE | Enabled on the session + valid E2EE URL at SDK init | `SessionConfig.setE2eEncryptionEnabled(true)` + 4-arg `IncodeWelcome.Builder` | `OnDeviceProcessingNotCompatibleException` (`MISSING_E2EE`) |
| On-Device Processing | **On** for the Face Capture module | Dashboard Face Capture config, **or** `SelfieScan.Builder().setOnDeviceFaceResultsSubmissionEnabled(true)` for client-built flows | On-device path not entered |
| UX V2 | **On** ("Enable new user experience") | Dashboard Flow/Workflow **Settings**, **or** `setClientExperimentId("experimentV2")` for client-built flows | `OnDeviceProcessingNotCompatibleException` (`V1_NOT_SUPPORTED`) |
| Selfie mode | `SelfieScan.Mode.ENROLL` | Face Capture / `SelfieScan` config | Face Login / auth modes are not supported |
| Frame streaming / "Enable face recording" | **Off** | Dashboard Face Capture, **or** do not call `setStreamFramesEnabled(true)` | `OnDeviceProcessingNotCompatibleException` (`FRAME_STREAMING`) |
| Screen recording | **Off** | `FlowConfig.Builder.configureScreenRecording(false, ...)` | `OnDeviceProcessingNotCompatibleException` (`SCREEN_RECORDING`) |
| Manual capture | Disabled by the SDK on this path | N/A (not configurable when on-device is on) | Manual-capture UI / timeout fallbacks do not apply; keep auto-capture healthy |
| Start path | `startFlow` / `startWorkflow` (recommended) or `startOnboarding` with the flag above | App code | Same compatibility checks run on every path |

> 📘 Expected differences vs a normal Face Capture
>
> On this path the SDK does **not** upload the selfie image or video, does **not** expose manual capture, and does **not** run server-side face evaluation (`SelfieScanResult.isSpoofAttempt` stays `null`). Server-side checks that depend on a stored selfie (for example Face Recognition / Face Match scores) may return N/A even if those modules appear later in the same Flow or Workflow. Configure age decisioning from the on-device structured results your backend receives, not from selfie-dependent scores.

## Error handling

Two distinct failures can occur when the feature is misconfigured:

- **`MissingModelLivenessDetectionDependencyException` / `MissingModelAgeEstimationDependencyException`** - thrown synchronously from `SelfieScan.Builder.build()` when the feature is enabled but the required optional model dependency is absent. Fix by adding the dependencies from [Prerequisites](#prerequisites).
- **`OnDeviceProcessingNotCompatibleException`** - delivered asynchronously to `OnboardingListener.onError(...)` at flow start when the configuration is incompatible. It carries one of the following reasons:

| Reason            | Meaning                                                                  | Fix                                                                                    |
|:------------------|:-------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|
| `MISSING_E2EE`    | E2EE is not enabled on the session.                                      | Call `SessionConfig.Builder.setE2eEncryptionEnabled(true)`.                             |
| `FRAME_STREAMING` | Frame streaming is enabled on the same `SelfieScan`.                     | Disable frame streaming (do not call `setStreamFramesEnabled(true)` / face recording). |
| `SCREEN_RECORDING`| Screen recording is configured for the flow.                             | Call `FlowConfig.Builder.configureScreenRecording(false, ...)`.                        |
| `V1_NOT_SUPPORTED`| The flow routes through the legacy V1 selfie UI (for example Face Login).| Use the V2 selfie UI in enrollment mode.                                               |

## Related guides

- [Android SDK Setup](/sdk-reference/android-installation) - base install, dependencies, and permissions this guide builds on.
- [SDK Integration guide](/sdk-reference/android-sdk) - the core onboarding integration.
- [E2EE Integration Guide](/sdk-reference/android-e2ee) - required setup for on-device processing.
- [SDK Customization guide](/sdk-reference/android-customization#enable-v2-ui) - how to enable and customize the `V2` UI.
- [BOM Version Mapping](/release-notes/bom-version-mapping) - versions of the `model-age-estimation` and `model-liveness-detection` dependencies.

---

- Path: `sdk-reference/android-phone`
- URL: https://developer.incode.com/sdk-reference/android-phone/
- Markdown: https://developer.incode.com/sdk-reference/android-phone.md

# Phone

The Phone module collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS.

For an overview of this module and how it works, see [Phone Number Input](/features-and-modules/phone-number-input/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Phone

1. Add the module with `addPhone()` (default config) or `addPhone(phone)` (custom config):

```kotlin
flowConfigBuilder.addPhone()
// or with a configured instance:
flowConfigBuilder.addPhone(phone)
```
```java
flowConfigBuilder.addPhone();
// or with a configured instance:
flowConfigBuilder.addPhone(phone);
```

2. If your flow also uses the [AES (Advanced Electronic Signature)](/sdk-reference/android-aes-advanced-electronic-signature/) module, add it after Phone. AES requires Phone, along with ID Scan and Selfie Scan, to run first.

Phone ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below builds a `Phone` module with OTP verification enabled, adds it to the flow, and listens for the result through `onAddPhoneCompleted()`.

```kotlin
val phone = Phone.Builder()
    .setOtpVerificationEnabled(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addPhone(phone)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onAddPhoneCompleted(phoneNumberResult: PhoneNumberResult) {
        // Phone number captured. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
Phone phone = new Phone.Builder()
    .setOtpVerificationEnabled(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addPhone(phone)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onAddPhoneCompleted(@NonNull PhoneNumberResult phoneNumberResult) {
        // Phone number captured. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `Phone.Builder`. The table below lists the available options.

| Setting                              | Description                                                                                                                                                                                                                            |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setOtpVerificationEnabled(Boolean)` | If `true`, shows OTP verification after the user enters a phone number. Defaults to `false`. In [Capture-Only mode](/sdk-reference/android-capture-only-sdk/), OTP is not activated even when enabled. |
| `setDefaultRegionPrefix(Integer)`    | Sets a dialing prefix that overrides the prefix derived from the carrier or the device's current region. Valid values are up to 4 digits. Do not add a leading `+`.                                                                    |

For the complete option set, see `Phone.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Enable Silent Network Authentication

Silent Network Authentication (SNA) is a phone number verification method that authenticates users through their mobile network using real-time carrier signals. You can enable SNA for the Phone module. SNA is only available in Flows in Dashboard, not Workflows.

1. Use Android SDK version 5.50.0 or higher. There is no separate `-sna` variant. No additional Maven repository or credentials are required.
2. In a Flow in Dashboard, turn on **_Enable SNA verification_** in the [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard/) module.
3. Start the onboarding flow using one of the following approaches:
   - `startFlow`: Specify `configurationId` inside `SessionConfig.Builder().setConfigurationId()`, and provide it as `sessionConfig` to `startFlow`.

     The Flow configuration drives SNA; no additional code is required.
   - `startOnboarding` or Sections (where your app builds the `FlowConfig`: Specify `configurationId` inside `SessionConfig.Builder().setConfigurationId()`, and provide it as `sessionConfig` to `startOnboarding` or `setupOnboardingSession`. Then pass the Phone module in your `FlowConfig`. For Sections, call `startOnboardingSection` with that Phone module.

     The Flow configuration enables SNA; there is no client-side API to turn it on.

<Accordion title="Requirements and fallback behavior">
- SNA requires Android API level 24 or higher. On older devices, the SDK silently falls back to SMS OTP.
- SNA also falls back to SMS OTP automatically when:
  - The number or carrier is not SNA-covered
  - There is no cellular data path: for example, airplane mode or a VPN-tunneled connection
  - On a transient verification failure
- The network permissions SNA requires (`CHANGE_NETWORK_STATE`, `ACCESS_WIFI_STATE`, `CHANGE_WIFI_STATE`) are bundled with the SDK and added to your app’s merged manifest automatically; you do not need to declare them. They are normal, install-time permissions, so no user prompt is involved.
- Optionally declaring the `READ_PHONE_STATE` runtime permission enables a 2G-network safety check that routes devices on insecure 2G networks straight to SMS OTP. The SDK never requests the permission itself. See the [Add Optional Permissions section of Installation](/sdk-reference/android-installation/#add-optional-permissions).
- The third-party SDK that powers SNA is bundled inside `onboard.aar`; no additional Maven repository or credentials are required. If your app ships an open-source/third-party licenses screen, reproduce its license attribution. See [Licenses](/sdk-reference/android-licenses/).
- Bundling adds roughly 150 KB to the `onboard` artifact. The bundled SDK stays dormant unless the flow configuration enables SNA. It is never loaded on devices below API level 24.
- Onboarding driven by the Workflows API does not support SNA yet. Phone module configuration in Workflows does not expose an SNA setting. Use a flow configuration (`configurationId`) for SNA.
</Accordion>

## Result

Phone delivers a `PhoneNumberResult` to the `onAddPhoneCompleted(PhoneNumberResult)` callback on the `OnboardingListener`. Key fields include:

- `phone`: The phone number captured from the user; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it. When `resultCode` is `SUCCESS`, OTP verification is on, and the organization is limited and not permitted to send or check the code, the `Throwable` that describes the refusal: the phone number was collected but not verified. Otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `PhoneNumberResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-process-id`
- URL: https://developer.incode.com/sdk-reference/android-process-id/
- Markdown: https://developer.incode.com/sdk-reference/android-process-id.md

# Process ID

The Process ID module determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Scan](/sdk-reference/android-id-scan/) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result.

For an overview of this module and how it works, see [ID Validation](/features-and-modules/id-validation-module/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Process ID

1. Add [ID Scan](/sdk-reference/android-id-scan/) before Process ID. Process ID validates the document captured by the ID Scan module. The user-facing capture happens in the ID Scan step that runs before it; Process ID itself shows a validation screen (see below for its v1/v2 variants).
2. Add the module with `addProcessId(processId)`:

   ```kotlin
   flowConfigBuilder.addProcessId(processId)
   ```
   ```java
   flowConfigBuilder.addProcessId(processId);
   ```

3. Add [ID Info](/sdk-reference/android-id-info/) after Process ID. The OCR data Process ID returns is what the ID Info step reads.

Process ID ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2.

### Example

The example below adds ID Scan and Process ID to the flow, and listens for the validation result through `onIdProcessed()`.

```kotlin
val idScan = IdScan.Builder().build()
val processId = ProcessId.Builder().build()

val flowConfig = FlowConfig.Builder()
    .addID(idScan)
    .addProcessId(processId)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onIdProcessed(idProcessResult: IdProcessResult) {
        // ID validated. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
IdScan idScan = new IdScan.Builder().build();
ProcessId processId = new ProcessId.Builder().build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addID(idScan)
    .addProcessId(processId)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onIdProcessed(@NonNull IdProcessResult idProcessResult) {
        // ID validated. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `ProcessId.Builder`. The table below lists the most common option.

| Setting                     | Description                                                                                                                                                |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setIdCategory(IdCategory)` | Sets which captured document this step validates, `IdCategory.FIRST` or `IdCategory.SECOND`, when the flow captures more than one ID. Defaults to `FIRST`. |

When a flow captures two IDs, use `setIdCategory(IdCategory.FIRST)` and `setIdCategory(IdCategory.SECOND)` on separate Process ID modules to validate each captured document.

`setEnableIdSummaryScreen(Boolean)` is deprecated as of SDK 5.42.0 and no longer applies to the new UI.

For the complete option set, see `ProcessId.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Process ID delivers an `IdProcessResult` to the `onIdProcessed(IdProcessResult)` callback on the `OnboardingListener`. Key fields include:

- `ocrData`: The OCR data extracted from the processed ID (`IncodeWelcome.OCRData`); `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If validation cannot be completed, the error surfaces through `OnboardingListener.onError(Throwable)`.

For all fields, see `IdProcessResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-qes`
- URL: https://developer.incode.com/sdk-reference/android-qes/
- Markdown: https://developer.incode.com/sdk-reference/android-qes.md

# QES (Qualified Electronic Signature)

The QES (Qualified Electronic Signature) module shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states.

For an overview of this module and how it works, see [Qualified Electronic Signature](/features-and-modules/qualified-electronic-signature/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add QES

1. Add identity check modules before QES. This can include [ID Scan](/sdk-reference/android-id-scan/) and [Selfie Scan](/sdk-reference/android-selfie-scan/)​.
2. Add the module with `addQES(qes)`.

   ```kotlin
   flowConfigBuilder.addQES(qes)
   ```
   ```java
   flowConfigBuilder.addQES(qes);
   ```

### Example

The example below builds a `QES` module that downloads the signed PDF, adds it to the flow, and listens for the result through `onQESCompleted()`.

```kotlin
val qes = QES.Builder()
    .setDownloadDocument(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addQES(qes)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onQESCompleted(qesResult: QESResult) {
        // QES step finished. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
QES qes = new QES.Builder()
    .setDownloadDocument(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addQES(qes)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onQESCompleted(@NonNull QESResult qesResult) {
        // QES step finished. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `QES.Builder`. The table below lists the available option.

| Setting                        | Description                                                                                                                        |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `setDownloadDocument(Boolean)` | If `true`, downloads signed PDFs and shows the Confirmed Signature Details screen at the end of the QES flow. Defaults to `false`. |

For the complete option set, see `QES.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

QES delivers a `QESResult` to the `onQESCompleted(QESResult)` callback on the `OnboardingListener`. Key fields include:

- `documentSigning`: `true` if the document was signed using a qualified electronic signature.
- `resourcesNotFound`: `true` if the required signing resources could not be found.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the step fails, the error surfaces through `OnboardingListener.onError(Throwable)`. This module does not define a module-specific exception subtype.

For all fields, see `QESResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-qr-scan`
- URL: https://developer.incode.com/sdk-reference/android-qr-scan/
- Markdown: https://developer.incode.com/sdk-reference/android-qr-scan.md

# QR Scan

The QR Scan module captures the QR code on the back of an ID, decodes its identity data, and sends it to the server. Your Incode Flow or Workflow configuration determines whether the module runs and what the decoded payload is used for.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

QR Scan requires camera access. The SDK requests the camera permission during the flow.

## Add QR Scan

1. Add the module with the no-argument `addQRScan()` overload for default behavior, or `addQRScan(showTutorials)` to control whether the tutorial screens appear:

   ```kotlin
   flowConfigBuilder.addQRScan()
   // or with the tutorial option:
   flowConfigBuilder.addQRScan(showTutorials = true)
   ```
   ```java
   flowConfigBuilder.addQRScan();
   // or with the tutorial option:
   flowConfigBuilder.addQRScan(true);
   ```

2. If your flow also uses [Conference](/sdk-reference/android-conference-assisted-video/), [Approval](/sdk-reference/android-approval/), or an INE validation step, add them after QR Scan. `FlowConfig.Builder.build()` throws `ModuleConfigurationException` if QR Scan follows any of these steps.

### Example

The example below adds QR Scan with tutorials shown and reads the decoded value from the result.

```kotlin
val flowConfig: FlowConfig = FlowConfig.Builder()
    .addQRScan(showTutorials = true)
    .build()

val onboardingListener: OnboardingListener = object : OnboardingListener() {
    override fun onQRScanCompleted(qrScanResult: QRScanResult) {
        // Read the decoded QR value
        val decoded = qrScanResult.value
    }

    override fun onError(error: Throwable) {}

    override fun onUserCancelled() {}
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addQRScan(true)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onQRScanCompleted(@NonNull QRScanResult qrScanResult) {
        // Read the decoded QR value
        String decoded = qrScanResult.value;
    }

    @Override
    public void onError(@NonNull Throwable error) {}

    @Override
    public void onUserCancelled() {}
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

QR Scan has no `Builder`. Its single option is supplied through the `addQRScan` overload or the `QRScan` constructor.

| Setting         | Description                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------ |
| `showTutorials` | When `true` (the default), shows the tutorial screens that explain the QR scan process before capture. |

For the complete option set, see `QRScan` in [API Reference](/sdk-reference/android-api-reference/).

## Result

QR Scan delivers a `QRScanResult` through the `onQRScanCompleted(QRScanResult)` callback on the `OnboardingListener`. Key fields include:

- `value`: The value decoded from the scanned QR code; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. If the decoded QR code cannot be uploaded to the server, the SDK delivers a `QRCodeUploadException`.

For all fields, see `QRScanResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-results`
- URL: https://developer.incode.com/sdk-reference/android-results/
- Markdown: https://developer.incode.com/sdk-reference/android-results.md

# Results

The Results module shows a screen summarizing the data captured during onboarding, including OCR fields, captured images, and identity scores. It returns an overall user score.


How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

Results is not available in [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/).

## Add Results

1. Add an [ID Scan](/sdk-reference/android-id-scan/) or [QR Scan](/sdk-reference/android-qr-scan/) module before Results. If you want to include [Selfie Scan](/sdk-reference/android-selfie-scan/) in your flow, add it before Results as well. Results depends on the data those earlier steps produce, and the SDK validates this ordering.
2. Add the module with one of the `addResults` overloads:

   ```kotlin
   // Default fetch mode (ACCURATE)
   flowConfigBuilder.addResults()

   // Or choose how results are fetched
   flowConfigBuilder.addResults(IncodeWelcome.IDResultsFetchMode.FAST)
   ```
   ```java
   // Default fetch mode (ACCURATE)
   flowConfigBuilder.addResults();

   // Or choose how results are fetched
   flowConfigBuilder.addResults(IncodeWelcome.IDResultsFetchMode.FAST);
   ```

### Example

The example below adds ID Scan and Selfie Scan before Results, and reads the score and status from `onResultsShown()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addID()
    .addSelfieScan()
    .addResults()
    .build()

val sessionConfig = SessionConfig.Builder().build()

IncodeWelcome.getInstance().startOnboarding(
    activity,
    sessionConfig,
    flowConfig,
    object : IncodeWelcome.OnboardingListener() {
        override fun onResultsShown(userScoreResult: UserScoreResult) {
            val score = userScoreResult.overallScore
            val status = userScoreResult.overallStatus
        }
    }
)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
        .addID()
        .addSelfieScan()
        .addResults()
        .build();

SessionConfig sessionConfig = new SessionConfig.Builder().build();

IncodeWelcome.getInstance().startOnboarding(
        activity,
        sessionConfig,
        flowConfig,
        new IncodeWelcome.OnboardingListener() {
            @Override
            public void onResultsShown(UserScoreResult userScoreResult) {
                String score = userScoreResult.overallScore;
                ResultsStatus status = userScoreResult.overallStatus;
            }
        }
);
```

## Configuration Options

Results has no `Builder`. Its only option is the results fetch mode, passed to `addResults(...)`.

| Setting                       | Description                                                                                      |
| ----------------------------- | ------------------------------------------------------------------------------------------------ |
| `IDResultsFetchMode.ACCURATE` | Shows results only after all results are calculated, for greater precision. This is the default. |
| `IDResultsFetchMode.FAST`     | Shows partial, less precise results sooner.                                                      |

For the complete option set, see `Results` and `IncodeWelcome.IDResultsFetchMode` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Results delivers a `UserScoreResult` through the `onResultsShown(UserScoreResult)` callback on `IncodeWelcome.OnboardingListener`. Key fields include:

- `overallScore`: The overall score as a string; for example, `"80.5/100"`. `null` when unavailable.

- `overallStatus`: The overall result status (`ResultsStatus`); `null` when unavailable. One of the following:
  - `OK`: Passed.
  - `WARN`: Passed with warnings.
  - `FAIL`: Failed.
  - `UNKNOWN`: Status could not be determined.
  - `MANUAL`: Manual review needed.

- `idVerificationResults`: Results of all ID verification checks (`IdVerificationResults`); `null` when unavailable.

- `livenessCheckResults`: Results of the liveness checks (`LivenessCheckResults`); `null` when unavailable.

- `facialRecognitionResults`: Results of the facial recognition checks (`FacialRecognitionResults`); `null` when unavailable.

- `governmentValidationResults`: Results of the government validation checks (`GovernmentValidationResults`); `null` when unavailable.

- `extendedUserScoreJsonData`: Additional score data as key/value pairs; may be empty.

- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the module fails, the error surfaces through `OnboardingListener.onError(Throwable)`. This module does not deliver a module-specific exception subtype.

For all fields, see `UserScoreResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-results-reference`
- URL: https://developer.incode.com/sdk-reference/android-results-reference/
- Markdown: https://developer.incode.com/sdk-reference/android-results-reference.md

Every module in an onboarding flow reports its outcome to your `IncodeWelcome.OnboardingListener`. Most modules deliver a **result object** through a dedicated callback. A few modules only signal completion, using a no-argument callback or a Boolean callback.

This page lists every result and error object. The groups match the categories on [Modules](/sdk-reference/android-individual-modules). For the full field list of a result type, go to its module page or [API Reference](/sdk-reference/android-api-reference).

Call `IncodeWelcome.deleteUserLocalData(context)` from `onSuccess()`, `onError(Throwable)`, and `onUserCancelled()` after you finish a session to [clean up local user data](/sdk-reference/android-capture-only-sdk#clean-up-local-user-data).

## Result Delivery

Results arrive on the module's success callback, such as `onIdProcessed(IdProcessResult)`. `IncodeWelcome.OnboardingListener` declares this callback. Some callbacks also appear on narrower listener interfaces, such as `IdProcessListener` and `PhoneNumberListener`.

`ResultCode` is the shared status most result objects carry, typically inherited from `BaseResult`. It reports the module's outcome, such as `SUCCESS`, `ERROR`, `USER_CANCELLED` or `EMULATOR_DETECTED`. See `ResultCode` in [API Reference](/sdk-reference/android-api-reference).

Some modules do not return a result object. They signal completion with a no-argument callback, such as `onUserConsentCompleted()`, or a Boolean callback, such as `onTaxIdValidationCompleted(boolean)`. When a related result type exists internally, the tables below name it so you can find its fields in [API Reference](/sdk-reference/android-api-reference), even though the type is never passed to your listener.

## Error Delivery

Errors surface on the shared `OnboardingListener.onError(Throwable)` path. The throwable is a generic `Throwable` unless a module defines its own exception subtype. Each table's Module-Specific Errors section notes any exception types.

When a result object has an `error` field, that field carries the same failure cause for that step.

## Collect Identity Data

| Module                                    | Result Object              | Delivered Via                                                                                         |
| ----------------------------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------- |
| [Document Scan](/sdk-reference/android-document-scan) | `DocumentValidationResult` | `onDocumentValidationCompleted(DocumentType, DocumentValidationResult)`                               |
| [Dynamic Forms](/sdk-reference/android-dynamic-forms) | `DynamicFormsResult`       | `onDynamicFormsCompleted(DynamicFormsResult)`                                                         |
| [Email](/sdk-reference/android-email)                 | `EmailAddressResult`       | `onAddEmailCompleted(EmailAddressResult)`                                                             |
| [Geolocation](/sdk-reference/android-geolocation)     | `GeolocationResult`        | `onGeolocationFetched(GeolocationResult)`; `onGeolocationUnavailable(Throwable)` when there is no fix |
| [ID Info](/sdk-reference/android-id-info)             | `IdInfoResult`             | `onIdInfoCompleted(IdInfoResult)`                                                                     |
| [ID Scan](/sdk-reference/android-id-scan)             | `IdScanResult`             | `onIdFrontCompleted(IdScanResult)` and `onIdBackCompleted(IdScanResult)`                              |
| [Name](/sdk-reference/android-name)                   | `NameResult`               | `onAddNameCompleted(NameResult)`                                                                      |
| [NFC Scan](/sdk-reference/android-nfc-scan-2)           | `NfcScanResult`            | `onNfcScanCompleted(NfcScanResult)`                                                                   |
| [Phone](/sdk-reference/android-phone)                 | `PhoneNumberResult`        | `onAddPhoneCompleted(PhoneNumberResult)`                                                              |
| [QR Scan](/sdk-reference/android-qr-scan)             | `QRScanResult`             | `onQRScanCompleted(QRScanResult)`                                                                     |
| [Selfie Scan](/sdk-reference/android-selfie-scan)          | `SelfieScanResult`         | `onSelfieScanCompleted(SelfieScanResult)`                                                             |
| [Video Selfie](/sdk-reference/android-video-selfie)   | `VideoSelfieResult`        | `onVideoRecorded(VideoSelfieResult)`                                                                  |

### Module-Specific Errors

Unless noted below, a module's errors surface on the shared `onError` path.

- **Geolocation**: On `onGeolocationUnavailable`, `GeolocationUnavailableException` fires if there is no fix. `LocationPermissionDeniedException` fires if the user denies permission.
- **NFC Scan**: `MissingNfcDependencyException`, thrown when the `nfc` library dependency is absent.
- **QR Scan**: `QRCodeUploadException`, thrown when Incode cannot upload the decoded code.
- **Video Selfie**: `VideoSelfieException` subtypes: `SelfieNotMatchedException`, `AudioNotMatchedException`, `FacesNotMatchedException`, `MaxVideoLengthReachedException`, and `VideoUploadException`.

## Verify and Authenticate

| Module                                                    | Result Object                                           | Delivered Via                                             |
| --------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------- |
| [Antifraud](/sdk-reference/android-antifraud)                         | `AntifraudResult`                                       | `onAntifraudCompleted(AntifraudResult)`                   |
| [CURP Validation](/sdk-reference/android-curp-validation)             | `CurpValidationResult`                                  | `onCurpValidationCompleted(CurpValidationResult)`         |
| [Custom Watchlist](/sdk-reference/android-custom-watchlist)           | `CustomWatchlistResult`                                 | `onCustomWatchlistProcessed(CustomWatchlistResult)`       |
| [eKYB (Electronic Know-Your-Business)](/sdk-reference/android-ekyb)   | `EKYBResult`                                            | `onEKYBChecksCompleted(EKYBResult)`                       |
| [eKYC (Electronic Know-Your-Customer)](/sdk-reference/android-ekyc)   | `EKYCResult`                                            | `onEKYCChecksCompleted(EKYCResult)`                       |
| [Face Authentication](/sdk-reference/android-face-authentication)     | `FaceAuthenticationResult`                              | `onFaceAuthenticationCompleted(FaceAuthenticationResult)` |
| [Face Match](/sdk-reference/android-face-match)                       | `FaceMatchResult`                                       | `onFaceMatchCompleted(FaceMatchResult)`                   |
| [Global Watchlist](/sdk-reference/android-global-watchlist)           | `GlobalWatchlistResult`                                 | `onGlobalWatchlistProcessed(GlobalWatchlistResult)`       |
| [Government Validation](/sdk-reference/android-government-validation) | No payload. Related type: `GovernmentValidationResult`. | `onGovernmentValidationCompleted(boolean success)`        |
| [Process ID](/sdk-reference/android-process-id)                       | `IdProcessResult`                                       | `onIdProcessed(IdProcessResult)`                          |
| [Tax ID Validation](/sdk-reference/android-tax-id-validation)         | No payload. Related type: `TaxIdValidationResult`.      | `onTaxIdValidationCompleted(boolean isSuccess)`           |

### Module-Specific Errors

Unless noted below, a module's errors surface on the shared `onError` path.

- **Face Authentication**: `FaceAuthenticationException`, carrying a `FaceAuthenticationErrorCode`, such as a detected spoof attempt.

## Capture Signatures and Consent

These modules' errors surface on the shared `onError` path.

| Module                                                          | Result object                                  | Delivered via                                                                                       |
| --------------------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [AES (Advanced Electronic Signature)](/sdk-reference/android-aes-advanced-electronic-signature)           | `AESResult`                                    | `onAESCompleted(AESResult)`                                                                         |
| [Combined Consent](/sdk-reference/android-combined-consent)                 | `CombinedConsentResult`                        | `onCombinedConsentCompleted(CombinedConsentResult)`                                                 |
| [Machine Learning Consent](/sdk-reference/android-machine-learning-consent) | `MachineLearningConsentResult`                 | `onMachineLearningConsentCompleted(MachineLearningConsentResult)`                                   |
| [QES (Qualified Electronic Signature)](/sdk-reference/android-qes)          | `QESResult`                                    | `onQESCompleted(QESResult)`                                                                         |
| [Signature](/sdk-reference/android-signature)                               | `SignatureFormResult`                          | `onSignatureCollected(SignatureFormResult)`                                                         |
| [User Consent](/sdk-reference/android-user-consent)                         | No payload. Related type: `UserConsentResult`. | `onUserConsentCompleted()`, a no-argument callback. `onUserCancelled()` fires if the user declines. |

## Add Human-Assisted Verification

This module's errors surface on the shared `onError` path.

| Module                                               | Result object                                                                  | Delivered via                                                                                                        |
| ---------------------------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
| [Conference (Assisted Video)](/sdk-reference/android-conference-assisted-video) | No payload. Related type: `VideoConferenceResult`. Not passed to the callback. | `onConferenceEnded()`. Queue updates arrive through `onQueuePositionChanged(int)` and `onEstimatedWaitingTime(int)`. |

## Configure the User Experience

This module's errors surface on the shared `onError` path.

| Module                                    | Result object | Delivered via                                                                                                                                               |
| ----------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Custom Module](/sdk-reference/android-custom-module) | No payload.   | `CustomModuleListener.onCustomModuleStarted(callbackName, onCustomModuleCompleted)`. You return a `CustomModuleStatus`: `OK`, `FAIL`, `WARN`, or `UNKNOWN`. |

## Configure Android-Specific Experiences

These modules' errors surface on the shared `onError` path.

| Module                                                | Result object                                        | Delivered via                                          |
| ----------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------ |
| [Accept Video Selfie](/sdk-reference/android-accept-video-selfie) | No payload. Related type: `AcceptVideoSelfieResult`. | `onUserAcceptedVideoSelfie()`, a no-argument callback. |
| [Approval](/sdk-reference/android-approval)                       | `ApproveResult`                                      | `onApproveCompleted(ApproveResult)`                    |
| [Captcha](/sdk-reference/android-captcha)                         | `CaptchaResult`                                      | `onCaptchaCollected(CaptchaResult)`                    |
| [Intro](/sdk-reference/android-intro)                             | No payload.                                          | `onIntroCompleted()`, a no-argument callback.          |
| [Results](/sdk-reference/android-results)                         | `UserScoreResult`                                    | `onResultsShown(UserScoreResult)`                      |

---

- Path: `sdk-reference/android-risk-analysis-1`
- URL: https://developer.incode.com/sdk-reference/android-risk-analysis-1/
- Markdown: https://developer.incode.com/sdk-reference/android-risk-analysis-1.md

# Risk Analysis

Risk Analysis is an optional Incode feature, built in collaboration with [Sardine](https://www.sardine.ai/), that adds fraud and risk signals to your onboarding flow. This page walks you through three steps to enable it: create a session, initialize the SDK with the resulting token as the external ID, and view results in the Sardine dashboard.

Risk Analysis is available for SDK versions 5.17.0 and later.

***

## Prerequisites

Risk Analysis depends on the Sardine SDK. View Sardine's [Getting Started documentation](https://docs.sardine.ai/docs/risk/getting-started) and learn how to [set up the Sardine Android SDK](https://docs.sardine.ai/docs/risk-sdk/android) by adding the Sardine SDK dependency. You must have Sardine credentials to access their documentation; see their [getting API access](https://docs.sardine.ai/docs/risk/api-access) guide if you need credentials.

***

## Set Up Risk Analysis

### Create an Onboarding Session

Create an onboarding session to receive an `access_token`.

In the command below, replace `YOUR_SESSION_KEY` and `YOUR_CUSTOMER_ID` with actual values: For example, `"sessionKey": "e821b8fe-e3b4-4d90-b792-919c8bc3341e-test"` and `"customerId": "incode-test"`.

```bash
curl --location --request POST 'https://api.sandbox.sardine.ai/v1/identity-documents/tokens' \
--header 'Authorization: Basic <base64(api-key:api-secret)>' \
--header 'Content-Type: application/json' \
--data-raw '{
"sessionKey": "YOUR_SESSION_KEY",
"customerId": "YOUR_CUSTOMER_ID",
"platform": "android",
"provider": "incode"
}'
```

Run the command, then store the `access_token` from the response for the next step.

### Initialize the SDK

Once you have an `access_token`, use it as the external ID of the Incode session. This keys the Incode session to the identifier Sardine already uses, so the two systems refer to the same session. Provide the `access_token` to `SessionConfig.Builder.setExternalId(access_token)` when you build the `SessionConfig`, before you start the flow. See [Initialize with an External ID](/sdk-reference/android-installation/#initialize-with-an-external-id).

### See Risk Analysis on the Sardine Dashboard

After the flow completes, Risk Analysis results are available in the [Sardine dashboard](https://dashboard.sandbox.sardine.ai/document-verifications). Contact your Incode representative for access.

***

For help, see [API Reference](/sdk-reference/android-api-reference/) or contact your Incode representative.

---

- Path: `sdk-reference/android-run-flows-configured-online`
- URL: https://developer.incode.com/sdk-reference/android-run-flows-configured-online/
- Markdown: https://developer.incode.com/sdk-reference/android-run-flows-configured-online.md

# Run Flows Configured in Dashboard

This integration pattern for the Android SDK uses the Workflows API. The Workflows API runs onboarding flows defined in Dashboard instead of in your app. It uses modules and configurations you set up in Dashboard, so you don't need to define flows locally through `FlowConfig.Builder`. You can change a Workflow's configuration in Dashboard without modifying your code.

Unlike [local patterns](/sdk-reference/android-common-implementation-patterns/#integration-patterns), where you assemble the flow and configure each module in code, flow content is configured in Dashboard. The modules included in the flow and their settings come from the activated Workflow. Your app only needs to reference it by ID.

This page covers session creation and section execution only. Ensure you have followed the steps to [Install and Initialize](/sdk-reference/android-installation/) the Incode Android SDK first.

For the modules a Workflow can include, see [Individual Modules](/sdk-reference/android-individual-modules/). For instructions on configuring Workflows in Dashboard, see [Configure Workflows](/dashboard-platform-administration/workflows-20/).

***

## Set Up This Integration Pattern

Complete the following steps in order.

### Create a Callback to Receive SDK Results

Implement an `OnboardingListener` to receive results from the Workflow's modules and the overall flow:

```kotlin
val onboardingListener: OnboardingListener = object : OnboardingListener() {
    override fun onOnboardingSessionCreated(token: String?, interviewId: String?, region: String) {
        // Onboarding Session Created successfully
    }

    override fun onIntroCompleted() {
        // Intro screen completed
    }

    override fun onAddPhoneCompleted(phoneNumberResult: PhoneNumberResult) {
        // Add phone completed
    }

    override fun onQRScanCompleted(qrScanResult: QRScanResult) {
        // QR scan completed
    }

    override fun onIdFrontCompleted(frontIdScanResult: IdScanResult) {
        // Scanning the front of an ID completed
    }

    override fun onIdBackCompleted(backIdScanResult: IdScanResult) {
        // Scanning the back of an ID completed
    }

    override fun onIdProcessed(idProcessResult: IdProcessResult) {
        // ID Validation completed
    }

    override fun onNfcScanCompleted(nfcScanResult: NfcScanResult) {
        // NFC scan completed
    }

    override fun onDocumentValidationCompleted(
        documentType: DocumentType,
        result: DocumentValidationResult
    ) {
        // Document validation completed
    }

    override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
        // Selfie scan completed
    }

    override fun onFaceMatchCompleted(faceMatchResult: FaceMatchResult) {
        // Face match completed
    }

    override fun onSignatureCollected(signatureFormResult: SignatureFormResult) {
        // Signature collected
    }

    override fun onUserConsentCompleted() {
        // User consent complete
    }

    override fun onVideoRecorded(videoSelfieResult: VideoSelfieResult) {
        // Video selfie finished successfully
    }

    override fun onCaptchaCollected(captchaResult: CaptchaResult) {
        // Captcha collected
    }

    override fun onGeolocationFetched(geolocationResult: GeolocationResult) {
        // Geolocation collected
    }

    override fun onApproveCompleted(approveResult: ApproveResult) {
        // User's onboarding approval completed
    }

    override fun onResultsShown(userScoreResult: UserScoreResult) {
        // Results shown to the user
    }

    override fun onQueuePositionChanged(newQueuePosition: Int) {
        // Queue position for the video call changed
    }

    override fun onEstimatedWaitingTime(waitingTimeInSeconds: Int) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    override fun onConferenceEnded() {
        // Called when the video conference has ended
    }

    override fun onSuccess() {
        // User successfully finished whole onboarding flow
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }

    override fun onUserCancelled() {
        // User cancelled the flow
    }
}
```
```java
OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onOnboardingSessionCreated(@Nullable String token, @Nullable String interviewId, @NonNull String region) {
        // Onboarding Session Created successfully
    }

    @Override
    public void onIntroCompleted() {
        // Intro screen completed
    }

    @Override
    public void onAddPhoneCompleted(@NonNull PhoneNumberResult phoneNumberResult) {
        // Add phone completed
    }

    @Override
    public void onQRScanCompleted(@NonNull QRScanResult qrScanResult) {
        // QR scan completed
    }

    @Override
    public void onIdFrontCompleted(@NonNull IdScanResult frontIdScanResult) {
        // Scanning the front of an ID completed
    }

    @Override
    public void onIdBackCompleted(@NonNull IdScanResult backIdScanResult) {
        // Scanning the back of an ID completed
    }

    @Override
    public void onIdProcessed(@NonNull IdProcessResult idProcessResult) {
        // ID Validation completed
    }

    @Override
    public void onNfcScanCompleted(@NonNull NfcScanResult nfcScanResult) {
        // NFC scan completed
    }

    @Override
    public void onDocumentValidationCompleted(@NonNull DocumentType documentType, @NonNull DocumentValidationResult result) {
        // Document validation completed
    }

    @Override
    public void onSelfieScanCompleted(@NonNull SelfieScanResult selfieScanResult) {
        // Selfie scan completed
    }

    @Override
    public void onFaceMatchCompleted(@NonNull FaceMatchResult faceMatchResult) {
        // Face match completed
    }

    @Override
    public void onSignatureCollected(@NonNull SignatureFormResult signatureFormResult) {
        // Signature collected
    }

    @Override
    public void onUserConsentCompleted() {
        // User consent complete
    }

    @Override
    public void onVideoRecorded(@NonNull VideoSelfieResult videoSelfieResult) {
        // Video selfie finished successfully
    }

    @Override
    public void onCaptchaCollected(@NonNull CaptchaResult captchaResult) {
        // Captcha collected
    }

    @Override
    public void onGeolocationFetched(@NonNull GeolocationResult geolocationResult) {
        // Geolocation collected
    }

    @Override
    public void onApproveCompleted(@NonNull ApproveResult approveResult) {
        // User's onboarding approval completed
    }

    @Override
    public void onResultsShown(@NonNull UserScoreResult userScoreResult) {
        // Results shown to the user
    }

    @Override
    public void onQueuePositionChanged(int newQueuePosition) {
        // Queue position for the video call changed
    }

    @Override
    public void onEstimatedWaitingTime(int waitingTimeInSeconds) {
        // Called only once with the estimated waiting time in the queue. Waiting time is in seconds.
    }

    @Override
    public void onConferenceEnded() {
        // Called when the video conference has ended
    }

    @Override
    public void onSuccess() {
        // User successfully finished whole onboarding flow
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }

    @Override
    public void onUserCancelled() {
        // User cancelled the flow
    }
};
```

For the shape and fields of each result object, see [Results](/sdk-reference/android-results-reference/).

The SDK has multiple exit paths. Call `IncodeWelcome.deleteUserLocalData(context)` after the flow ends to delete all local user data. This is a static method that takes a `Context`. Call `deleteUserLocalData()` in these callbacks:

```kotlin
fun onSuccess()
fun onError(error: Throwable)
fun onUserCancelled()
```
```java
public void onSuccess()
public void onError(Throwable error)
public void onUserCancelled()
```

### Create the Session Configuration

Use the `SessionConfig.Builder` API `setConfigurationId()` to specify the Workflow ID from Dashboard. This tells the SDK which modules and configuration to use. Ensure the Workflow is activated in Dashboard before starting the session.

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setConfigurationId(workflowId)
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId(workflowId)
    .build();
```

### Start the Onboarding Session

Start the session using the one of the following:

- `startWorkflow()` runs the modules defined for the Workflow in Dashboard and reports progress and results through the `onboardingListener`.
  ```kotlin
  IncodeWelcome.getInstance().startWorkflow(
      activityContext,
      sessionConfig,
      onboardingListener)
  ```
  ```java
  IncodeWelcome.getInstance().startWorkflow(
      activityContext,
      sessionConfig,
      onboardingListener);
  ```
- `startFlow()` runs the modules defined for the Flow in Dashboard and reports progress through the `onboardingListener`.
  ```kotlin
  IncodeWelcome.getInstance().startFlow(
      activityContext,
      sessionConfig,
      onboardingListener)
  ```
  ```java
  IncodeWelcome.getInstance().startFlow(
      activityContext,
      sessionConfig,
      onboardingListener);
  ```

<br />

---

- Path: `sdk-reference/android-sdk`
- URL: https://developer.incode.com/sdk-reference/android-sdk/
- Markdown: https://developer.incode.com/sdk-reference/android-sdk.md

# Incode Android SDK Reference

The Incode Android SDK adds end-to-end identity verification (IDV) to your app. The UI supports custom themes, so IDV looks and feels like your product. The Android SDK ships as AAR artifacts through Gradle or Maven, organized into modules that are versioned together through the Incode Bill of Materials (BOM). You only manage one version number. This page explains what the SDK can do and how it works.
























***

## Capabilities

The Incode Android SDK supports:

- **Identity capture**: ID scan, document capture, and [OCR](/get-started-with-incode/glossary#ocr) data extraction.
- **Liveness and biometrics**: Selfie capture, video selfie, liveness detection, and face match.
- **NFC**: Data extraction from [NFC](/get-started-with-incode/glossary#nfc-scan) chips in passports and supported ID documents.
- **Compliance and risk**: Device and behavioral risk analysis.
- **Wallets**: IDV with a Google Wallet Digital ID.
- **Customization**: Theming, localization, and custom assets so the IDV experience matches your brand.

***

## Integration Approaches

The SDK supports three integration paths, each offering a different level of control. Start with the simplest path that meets your requirements.

- **Full Onboarding Flow**: The SDK owns the full UI from start to finish.
- **Split Flow**: You own the order of modules and the screens between them.
- **Capture-Only**: You own everything, with no Incode UI. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/).

For Paths 1 and 2, there is a further decision: how the flow is configured and executed. See [Integration Approaches](/sdk-reference/android-common-implementation-patterns/) for the full breakdown of paths and patterns.

***

## Runtime Modes

The mode controls when and whether captured data is sent to Incode for processing. Regardless of the integration path you choose, the SDK runs in one of three modes:

- **Standard**: Sends captured data to Incode for processing as IDV runs.
- **Capture-Only**: Captures on-device without sending anything to Incode. You submit from your back end.
- **Delayed**: Captures offline and syncs once connected.

See [SDK Modes](/sdk-reference/android-sdk-modes/) for how to select a mode.

***

## Dependencies

The SDK is modular. There are no build variants; it is a single distribution. Add only the dependencies your integration requires. Use the BOM to pin all dependencies to compatible versions from a single version number. See [BOM Version Mapping](/release-notes/bom-version-mapping/).

| Dependency                 | Type        | Description                                                                                                                                                                                                                                                                                                                             |
| :------------------------- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `welcome`                  | Required    | Core dependency; contains all core SDK functionality.                                                                                                                                                                                                                                                                                   |
| `core-light`               | Required    | Contains image-processing libraries used throughout the SDK.                                                                                                                                                                                                                                                                            |
| `bom`                      | Recommended | Bill of Materials that pins all Incode dependencies to compatible versions from a single version number.                                                                                                                                                                                                                                |
| `extensions`               | Optional    | Required for custom theme configuration, dynamic localization, and runtime localization.                                                                                                                                                                                                                                                |
| `nfc`                      | Optional    | Required for the [NFC Scan module](/sdk-reference/android-nfc-scan-2/).                                                                                                                                                                                                                                 |
| `video-streaming`          | Optional    | Required by the [Conference module](/sdk-reference/android-conference-assisted-video) and the `streamFrames` feature in the [ID Scan](/sdk-reference/android-id-scan) and [Selfie Scan](/sdk-reference/android-selfie-scan) modules. |
| `model-face-recognition`   | Optional    | Required for on-device face recognition. Used by face login in the [Selfie Scan module](/sdk-reference/android-selfie-scan)​ only.                                                                                                                                                                     |
| `model-liveness-detection` | Optional    | Required for on-device liveness detection in the [Selfie Scan module](/sdk-reference/android-selfie-scan).                                                                                                                                                                                             |
| `model-face-occlusion`     | Optional    | Required for on-device face occlusion detection in the [Selfie Scan module](/sdk-reference/android-selfie-scan).                                                                                                                                                                                       |
| `model-age-estimation`     | Optional    | Required for on-device age estimation in the [Selfie Scan module](/sdk-reference/android-selfie-scan).                                                                                                                                                                                                 |
| `wallets`                  | Optional    | Required for wallet integrations, including Google Wallet ID.                                                                                                                                                                                                                                                                           |

***

## Device Requirements

The SDK runs on physical Android devices that meet the following minimum requirements:

- **RAM:** 3 GB

- **Back-facing camera:** 5 MP

- **Front-facing (selfie) camera:** 2 MP

- **NFC hardware:** Required for the [NFC Scan module](/sdk-reference/android-nfc-scan-2)

- **Network:** An active HTTPS connection to the Incode Platform

***

## Data Handling and Privacy

The SDK runs the on-device half of identity verification. At a high level:

- **On-device capture and inference**: ID images, selfie and liveness video, and NFC chip data are captured on the device. The on-device ML models extract their features locally. These models cover liveness detection, presentation-attack detection, face recognition, ID face detection, face occlusion, and age estimation.
- **Encrypted transmission**: Artifacts and verification requests are captured and sent to the Incode Platform over an encrypted channel. You can also enforce end-to-end encryption. See [End-to-End Encryption (E2EE)](/sdk-reference/android-e2ee/).
- **No sensitive logging**: The SDK does not log personally identifiable information (PII) or capture content. Its published AAR artifacts are obfuscated to prevent reverse engineering.
- **Server-authoritative result**: The Incode Platform holds the authoritative verification result for your back end to consume server-side. The SDK reports each module's outcome to your app through the listener.
- **Transient local state**: The SDK keeps only transient, encrypted session state data on the device. Call `deleteUserLocalData()` when you are finished with a session.

***

## What's Next

Use the table below to find the page you need.

| Task                                               | Page                                                                                                                    |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Learn the correct order of steps to set up the SDK | [Getting Started](/sdk-reference/android-getting-started/)                              |
| Add the SDK to your project                        | [Installation](/sdk-reference/android-installation)                                    |
| Choose your integration path and pattern           | [Common Integration Approaches](/sdk-reference/android-common-implementation-patterns) |
| Capture data without sending it to Incode          | [Capture-Only Mode](/sdk-reference/android-capture-only-sdk)                           |
| Integrate Google Wallet Digital ID verification    | [Google Wallet ID](/sdk-reference/android-google-wallet-id)                            |
| Implement device and behavior risk analysis        | [Risk Analysis](/sdk-reference/android-risk-analysis-1)                                |
| Browse modules and their configuration options     | [Individual Modules](/sdk-reference/android-individual-modules)                        |
| Read documents via NFC                             | [NFC Scan](/sdk-reference/android-nfc-scan-2)                                          |
| Customize colors, fonts, and text                  | [Customization](/sdk-reference/android-customization)                                  |
| Look up result and error objects by module         | [Results](/sdk-reference/android-results-reference)                                    |
| Browse the full public API                         | [API Reference](/sdk-reference/android-api-reference)                                  |
| Solve a build problem                              | [Troubleshooting](/sdk-reference/android-troubleshooting)                              |
| Upgrade an existing integration                    | [Migration Guide](/sdk-reference/migration-guide)                                      |
| Check what changed in a release                    | [Android SDK Release Notes](/sdk-reference/releases-android-sdk)                       |
| Map BOM versions to module versions                | [BOM Version Mapping](/sdk-reference/bom-version-mapping)                              |

For help, contact your enterprise customer success manager or email [help@incode.com](mailto:help@incode.com).

---

- Path: `sdk-reference/android-sdk-modes`
- URL: https://developer.incode.com/sdk-reference/android-sdk-modes/
- Markdown: https://developer.incode.com/sdk-reference/android-sdk-modes.md

# SDK Modes

The SDK runs in one of three modes. The mode controls how and when captured data is sent to Incode. Choose the mode that matches your integration's network, privacy, and timing requirements.

| Mode             | What It Does                                                                                                                    | When To Use It                                                                                                                                                                                                              |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Standard**     | Captures data and sends it to Incode in real time as the flow runs.                                                             | The default. Use when the device has connectivity and you want server-side validation as each step completes.                                                                                                               |
| **Capture-Only** | Captures media on-device without sending it to Incode. You retain the captured data and submit it later from your own back end. | Use when capture and submission must be decoupled, or capture happens in an environment without a direct path to Incode. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/). |
| **Delayed**      | Captures onboardings offline and syncs them to Incode when a connection is available.                                           | Use when capture happens offline and validation can wait for connectivity.                                                                                                                                                  |

***

## Standard Mode

Standard mode is the default. The SDK captures each module's data and sends it to Incode as the flow progresses. Server-side validation results are available in real time through the result callbacks. No additional configuration is required.

See [Getting Started](/sdk-reference/android-getting-started/) for the standard integration.

***

## Capture-Only Mode

Capture-Only mode captures media on the device without sending it to Incode during the flow. Your back end submits the captured data separately. This mode uses a dedicated integration path.

See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/) for the full guide.

***

## Delayed Mode

Delayed mode captures onboardings offline and syncs them to Incode when a connection is available. It currently supports the following modules: [Combined Consent](/sdk-reference/android-combined-consent/), [Document Scan](/sdk-reference/android-document-scan/), [Face Match](/sdk-reference/android-face-match/), [ID Scan](/sdk-reference/android-id-scan/), [Process ID](/sdk-reference/android-process-id/), and [Selfie Scan](/sdk-reference/android-selfie-scan/).

### Enable Delayed Mode

1. Set Delayed mode using `SdkMode(DELAYED)`:
   ```kotlin
   IncodeWelcome.getInstance().setSdkMode(SdkMode.DELAYED)
   ```
   ```java
   IncodeWelcome.getInstance().setSdkMode(SdkMode.DELAYED);
   ```
2. Create a `SessionConfig` and `FlowConfig` with the supported modules for Delayed mode. Follow the steps for your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns).
3. Call `startOnboarding(...)`:
   ```kotlin
   IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
   ```
   ```java
   IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
   ```

### Sync Delayed Onboardings

An active internet connection is required. Call the following to sync offline onboardings:

```kotlin
IncodeWelcome.getInstance().syncDelayedOnboardings(object : SyncDelayedOnboardingListener {
    override fun onDelayedOnboardingSyncCompleted(delayedOnboardingSyncResult: DelayedOnboardingSyncResult) {
        ...
    }

    override fun onError(delayedOnboardingSyncError: DelayedOnboardingSyncError) {
        ...
    }

    override fun onCancelled() {
        ...
    }
})
```
```java
IncodeWelcome.getInstance().syncDelayedOnboardings(new SyncDelayedOnboardingListener() {
    @Override
    public void onDelayedOnboardingSyncCompleted(@NonNull DelayedOnboardingSyncResult delayedOnboardingSyncResult) {
        ...
    }

    @Override
    public void onError(@NonNull DelayedOnboardingSyncError delayedOnboardingSyncError) {
        ...
    }

    @Override
    public void onCancelled() {
        ...
    }
});
```

<br />

---

- Path: `sdk-reference/android-selfie-scan`
- URL: https://developer.incode.com/sdk-reference/android-selfie-scan/
- Markdown: https://developer.incode.com/sdk-reference/android-selfie-scan.md

# Selfie Scan

The Selfie Scan module captures the user's face with their device's camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using [1:1](/get-started-with-incode/glossary/#11-face-authentication) or [1:N](/get-started-with-incode/glossary/#1n-face-authentication) face authentication.

For an overview of this module and how it works, see [Face Capture](/features-and-modules/face-capture/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Selfie Scan

Add the module with one of the `addSelfieScan` overloads. Most onboarding flows require Selfie Scan, and some modules depend on ordering: for example, [Face Match](/sdk-reference/android-face-match/) needs Selfie Scan and an ID or QR Scan added first. `FlowConfig.Builder.build()` throws `ModuleConfigurationException` if a required module or ordering rule is broken.

```kotlin
// Default configuration
flowConfigBuilder.addSelfieScan()

// Custom configuration
flowConfigBuilder.addSelfieScan(selfieScan)
```
```java
// Default configuration
flowConfigBuilder.addSelfieScan();

// Custom configuration
flowConfigBuilder.addSelfieScan(selfieScan);
```

Selfie Scan ships both a v1 (legacy View) and a v2 (Jetpack Compose) capture screen; the active one depends on your Incode configuration. Contact your Incode representative to enable v2. In v2, tablets are landscape-locked with an optimized layout and phones are portrait-locked.

### Example

The example below builds a `SelfieScan` module with tutorials shown, adds it to the flow, and listens for the result through `onSelfieScanCompleted()`.

```kotlin
val selfieScan = SelfieScan.Builder()
    .setShowTutorials(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addSelfieScan(selfieScan)
    .build()

val onboardingListener = object : IncodeWelcome.OnboardingListener() {
    override fun onSelfieScanCompleted(selfieScanResult: SelfieScanResult) {
        // Selfie scan completed
    }

    override fun onError(error: Throwable) {
        // Onboarding flow was aborted due to error
    }
}

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
)
```
```java
SelfieScan selfieScan = new SelfieScan.Builder()
    .setShowTutorials(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addSelfieScan(selfieScan)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onSelfieScanCompleted(@NonNull SelfieScanResult selfieScanResult) {
        // Selfie scan completed
    }

    @Override
    public void onError(@NonNull Throwable error) {
        // Onboarding flow was aborted due to error
    }
};

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    onboardingListener
);
```

## Configuration Options

Configure the module with `SelfieScan.Builder`. The scan mode and where liveness and recognition run also depend on your Incode Flow or Workflow configuration, not just these options.

| Setting                                   | Description                                                                                                                                                                                                                                                                                                                                                     |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setMode`                                 | Sets the scan mode: `Mode.ENROLL`, `Mode.LOGIN`, or `Mode.MASK_CHECK`. Default is `Mode.ENROLL`.                                                                                                                                                                                                                                                                |
| `setFaceAuthMode`                         | Runs face detection and liveness on `LOCAL` or the `SERVER`. Default is `FaceAuthMode.SERVER`.                                                                                                                                                                                                                                                                  |
| `setShowTutorials`                        | Shows a tutorial before the scan. Default is `true`.                                                                                                                                                                                                                                                                                                            |
| `setMaskCheckEnabled`                     | Enables local face-mask detection during capture.                                                                                                                                                                                                                                                                                                               |
| `setCameraFacing`                         | Selects `CameraFacing.FRONT` or `CameraFacing.BACK`. Default is `CameraFacing.FRONT`. Has no effect in some SDK versions; check `SelfieScan.Builder` in [API Reference](/sdk-reference/android-api-reference/) for current behavior.                                                                                            |
| `setAutoCaptureTimeout`                   | Sets the selfie auto-capture timeout, in seconds.                                                                                                                                                                                                                                                                                                               |
| `setOnDeviceFaceResultsSubmissionEnabled` | Runs liveness detection and age estimation on-device, submitting only the score to the backend. Requires [end-to-end encryption](/sdk-reference/android-e2ee/), the liveness-detection and age-estimation model dependencies, and the V2 UI; incompatible with frame streaming, screen recording, and video liveness recording. |

In `CAPTURE_ONLY` mode, captured media stays on the device. See [Capture-Only Mode](/sdk-reference/android-capture-only-sdk/) for the capture-only data flow.

For the complete option set, see `SelfieScan.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Selfie Scan delivers a `SelfieScanResult` to the `onSelfieScanCompleted(selfieScanResult)` callback on `OnboardingListener`. Key fields include:

- `isSpoofAttempt`: `false` if user is a real person; `true` if there was a spoof attempt. Populated only when a server-side face evaluation runs and `status` is `STATUS_OK` or `STATUS_SPOOF_DETECTED`; otherwise, `null`, including in Capture-Only, on-device, and offline modes.

- `hasFaceMask`: `true` if a face mask is detected, `false` if not, `null` if the check wasn't performed.

- `croppedSelfieImgPath`: The file path to the cropped selfie image.

- `fullFrameSelfieImgPath`: The file path to the full-frame selfie image.

- `status`: The selfie scan status. One of the following:
  - `STATUS_OK` (0): All preconditions for checking liveness are met.
  - `STATUS_LENSES_DETECTED` (1): The user is wearing lenses.
  - `STATUS_TOO_DARK` (2): The photo is too dark for reliable results.
  - `STATUS_TOO_BLURRY` (3): The photo is too blurry for reliable results.
  - `STATUS_FACE_NOT_FOUND` (4): No face meeting the constraints was found.
  - `STATUS_FACE_TOO_SMALL` (5): The face dimensions are insufficient.
  - `STATUS_INSUFFICIENT_PHOTO_QUALITY` (6): Photo quality too low to check liveness. This is often because of bad lighting.
  - `STATUS_GENERIC_ERROR` (7): A generic error occurred while producing the result.
  - `STATUS_NO_RESULT` (9): No status has been produced yet.
  - `STATUS_MASK_DETECTED` (10): The user is wearing a mask.
  - `STATUS_CLOSED_EYES_DETECTED` (11): The user has their eyes closed.
  - `STATUS_HEAD_COVER_DETECTED` (12): A head covering such as a hat is detected.
  - `STATUS_SPOOF_DETECTED` (13): A spoof attempt is detected.

- `selfieBase64`: The Base64-encoded cropped selfie image. Redacted from `toString()`.

- `fullFrameSelfieEncryptedBase64`: The encrypted Base64-encoded full-frame selfie image. Redacted from `toString()`.

- `fullFrameSelfieBase64`: The Base64-encoded full-frame selfie image. Redacted from `toString()`.

- `metadata`: Proprietary capture metadata required by the SDK. Populated only when `SdkMode` is `CAPTURE_ONLY`; otherwise, `null`.

- `videoFilePath`: The path to the original, unencrypted video-liveness recording. Populated only when `setVideoLivenessRecordingEnabled(true)` and `SdkMode` is `CAPTURE_ONLY`; otherwise, `null`. For transmission, use `presignedVideoFilePath`.

- `presignedVideoFilePath`: The path to the video-liveness file prepared for back-end transmission. It contains base64 text and is not cryptographically encrypted. Populated only when `setVideoLivenessRecordingEnabled(true)` and `SdkMode` is `CAPTURE_ONLY`; otherwise, `null`.

- `allAttemptsExhausted`: `true` if no further capture or upload retries are available for this selfie scan.

- `isBlocklisted`: `true` if the recognized user is on the blocklist and login was denied (`faceLoginResult.success` is `false`). Set only during server-side face authentication in `LOGIN` mode; always `false` in LOCAL mode. This result is available for SDK versions 5.50.0 and newer.

- `faceRecognitionConfidence`: The similarity score between stored face and captured selfie. This result was deprecated in SDK version 5.2.0.

- `isFaceMatched`: If the stored face and selfie match. This result was deprecated in SDK version 5.35.0; use `faceLoginResult.success` instead.

- `spoofConfidence`: The likelihood of a spoofing attempt. This result was deprecated in SDK version 5.2.0; use `isSpoofAttempt` instead.

- `maskConfidence`: The likelihood the person is wearing a mask. This result was deprecated in SDK version 5.18.0; use `hasFaceMask` instead.

- `selfieEncryptedBase64`: The encrypted Base64 cropped selfie. This result was deprecated in SDK version 5.12.0; use `selfieBase64` / `fullFrameSelfie*`.

- `idealCaptureEnvironmentTestResult`: The result of the ideal-capture-environment test. This result was deprecated in SDK version 5.39.0; use `metadata` instead.

- `faceLoginResult`: The result of the Face Login operation populated in `SelfieScan.Mode.LOGIN`. One of the following:
  - `success`: `true` if the face login succeeded; otherwise, `false`.
  - `customerUUID`: The customer UUID of the recognized user; `null` when unavailable.
  - `interviewId`: The interview ID for the login session; `null` when unavailable.
  - `interviewToken`: The interview token for the login session; `null` when unavailable.
  - `token`: The session token associated with the login; `null` when unavailable.
  - `transactionId`: The transaction ID for the login operation; `null` when unavailable.

- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced. In `CAPTURE_ONLY` mode this info is also available in `metadata`.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the scan cannot complete, the flow is aborted and the error surfaces via `OnboardingListener.onError(Throwable)`.

For all fields, see `SelfieScanResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-signature`
- URL: https://developer.incode.com/sdk-reference/android-signature/
- Markdown: https://developer.incode.com/sdk-reference/android-signature.md

# Signature

The Signature module captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent.

For an overview of this module and how it works, see [Electronic Signature](/features-and-modules/electronic-signature-module/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

## Add Signature

Add the module with `addSignature()`, or pass a configured instance with `addSignature(signature)`. If you do not need to customize the module, use the no-argument `addSignature()` method instead of building an instance.

```kotlin
flowConfigBuilder.addSignature()
```
```java
flowConfigBuilder.addSignature();
```

### Example

The example below adds a default `Signature` module to the flow and listens for the result through `onSignatureCollected()`.

```kotlin
val signature = Signature.Builder().build()

val flowConfig = FlowConfig.Builder()
    .addSignature(signature)
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onSignatureCollected(signatureFormResult: SignatureFormResult) {
        // Signature collected. Process the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
Signature signature = new Signature.Builder().build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addSignature(signature)
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onSignatureCollected(@NonNull SignatureFormResult signatureFormResult) {
        // Signature collected. Process the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Configure the module with `Signature.Builder`. Both options are deprecated in favor of overriding the SDK string resources.

| Setting                                | Description                                                                                                |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `setTitle(int titleResId)`             | Sets the title text shown on the Signature screen. Deprecated; override the string resource instead.       |
| `setDescription(int descriptionResId)` | Sets the description text shown on the Signature screen. Deprecated; override the string resource instead. |

For the complete option set, see `Signature.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Signature delivers a `SignatureFormResult` to the `onSignatureCollected(SignatureFormResult)` callback on the `OnboardingListener`. Key fields include:

- `signaturePath`: The URI pointing to the captured signature image; `null` when unavailable.
- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

If the step fails, the error surfaces via `OnboardingListener.onError(Throwable)`. There is no Signature-specific exception subtype.

For all fields, see `SignatureFormResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-tax-id-validation`
- URL: https://developer.incode.com/sdk-reference/android-tax-id-validation/
- Markdown: https://developer.incode.com/sdk-reference/android-tax-id-validation.md

# Tax ID Validation

The Tax ID Validation module collects a user's tax identification number and validates its format and structure. Your Incode Flow or Workflow configuration determines what the validation checks and how the result is interpreted.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

## Add Tax ID Validation

Add the module with `addTaxIdValidation()`.

```kotlin
flowConfigBuilder.addTaxIdValidation()
```
```java
flowConfigBuilder.addTaxIdValidation();
```

### Example

The example below adds Tax ID Validation as the only step in the flow and listens for the result through `onTaxIdValidationCompleted()`.

```kotlin
val flowConfig = FlowConfig.Builder()
    .addTaxIdValidation()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onTaxIdValidationCompleted(isSuccess: Boolean) {
        // Tax ID validation step completed. isSuccess reports whether validation succeeded.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)
```
```java
FlowConfig flowConfig = new FlowConfig.Builder()
    .addTaxIdValidation()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onTaxIdValidationCompleted(boolean isSuccess) {
        // Tax ID validation step completed. isSuccess reports whether validation succeeded.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);
```

## Configuration Options

Tax ID Validation has no configurable options. It is constructed with a no-argument constructor, and `addTaxIdValidation()` adds it for you.

## Result

Tax ID Validation does not deliver a result payload object through the `OnboardingListener`. Completion is signaled by the `onTaxIdValidationCompleted(boolean)` callback, where the `isSuccess` flag reports whether the tax ID validation step succeeded.

If the step fails with an error, it surfaces through `OnboardingListener.onError(Throwable)`. This module does not define a module-specific exception subtype.

For the related listener interface, see `TaxIdValidationListener` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-third-party-libraries`
- URL: https://developer.incode.com/sdk-reference/android-third-party-libraries/
- Markdown: https://developer.incode.com/sdk-reference/android-third-party-libraries.md

# Third-Party Libraries

The Incode Android SDK builds on a set of third-party libraries and services. This page lists them by purpose so you can complete your own privacy review, Google Play Data safety form, and internal SDK inventory. It describes the SDK's own dependencies; your app may add others.

> 📘 Scope and accuracy
>
> - Exact pinned versions move with each release. The authoritative, per-version list lives in the API Changes and dependency sections of the [release notes](/release-notes/releases-android-sdk/).
> - This page groups dependencies by purpose rather than reproducing the full transitive tree.
> - Tools used only to build the SDK (the Kotlin compiler, Gradle, annotation processors) are not shipped in your app and are omitted.
> - Libraries used only by the Incode sample/demo app are out of scope; they are not part of the published SDK and do not ship in your app.

## How data is handled

Capture and biometric processing happen on the device. The SDK sends capture artifacts and verification requests to the Incode Platform over an encrypted channel. It does not log PII or captured content.

For more detail, see **Data Handling and Privacy** in the [Incode Android SDK Reference](/sdk-reference/android-sdk/) and [End-to-End Encryption (E2EE)](/sdk-reference/android-e2ee/).

## Capture, media, and on-device processing

| Library                                | Purpose                                                             | Used by                                 |
| -------------------------------------- | ------------------------------------------------------------------- | --------------------------------------- |
| AndroidX CameraX (`androidx.camera:*`) | Camera capture and preview                                          | ID, selfie, and document capture        |
| JPEG2000 decoder (`dev.keiji.jp2`)     | Decodes the portrait image stored on an ID chip                     | [NFC Scan](/sdk-reference/android-nfc-scan-2/)         |
| JMRTD + SCUBA                          | Standard eMRTD (ePassport) chip-reading protocol stack (BAC / PACE) | [NFC Scan](/sdk-reference/android-nfc-scan-2/)         |
| Screen/video recording (`HBRecorder`)  | Records the video session                                           | [Video Selfie](/sdk-reference/android-video-selfie/) |

The SDK's on-device machine-learning models (liveness / presentation-attack detection, face recognition, ID face detection, face occlusion, age estimation) are Incode components, shipped as the `model-*` modules - see [Incode Android SDK Reference](/sdk-reference/android-sdk/). They run locally on the device.

## Networking and storage

| Library                                          | Purpose                                                      |
| ------------------------------------------------ | ------------------------------------------------------------ |
| Retrofit + OkHttp                                | HTTP client for requests to the Incode platform              |
| kotlinx.serialization, `org.json`                | Request/response serialization                               |
| Room                                             | Local database (used for delayed / offline onboarding state) |
| SQLCipher, AndroidX Security Crypto, Google Tink | Standard encryption libraries for on-device data at rest     |
| AndroidX DataStore                               | Encrypted local preferences / session state                  |

## Platform services

| Library / service                                                          | Purpose                                                        | Notes                                                                                                                             |
| -------------------------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Google Play Services - base, location, vision (`com.google.android.gms:*`) | Platform services and device location                          | Used on devices with Google Play Services                                                                                         |
| Huawei Mobile Services - location                                          | Device location on Huawei devices without Google Play Services | Selected at runtime when Google Play Services is unavailable - see [Advanced Integration: Dynamic Delivery](/sdk-reference/android-advanced-integration-dynamic-delivery/) |
| AndroidX Credentials (`androidx.credentials:*`)                            | Provisioning a credential to Google Wallet                     | [Google Wallet ID](/sdk-reference/android-google-wallet-id/) and the wallets dependency                                                                  |

## Contact, localization, and UI

| Library                                                   | Purpose                                                                          |
| --------------------------------------------------------- | -------------------------------------------------------------------------------- |
| libphonenumber (`io.michaelrocks:libphonenumber-android`) | Phone-number parsing and validation - [Phone](/sdk-reference/android-phone/)                  |
| Lottie, Paris, Material Components, Accompanist           | UI, theming, and animations - see [Customization](/sdk-reference/android-customization/) |
| restring, reword, viewpump                                | Runtime string localization                                                      |

## Real-time video

| Library / service      | Purpose                                                                                                                                                 |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OpenTok (Vonage Video) | Real-time video conferencing with a remote agent - [Conference (Assisted Video)](/sdk-reference/android-conference-assisted-video/). Pulled in by the `video-streaming` dependency. |

## Telemetry and diagnostics

| Service | Purpose                           | Notes                                                                                            |
| ------- | --------------------------------- | ------------------------------------------------------------------------------------------------ |
| Statsig | Feature flags and experimentation | Disabled automatically in Capture-Only and Delayed (offline) modes                               |
| Sentry  | Crash and error reporting         | Can be turned off with `setCrashReportingEnabled(false)` - see [Installation](/sdk-reference/android-installation/) |

## Risk and antifraud

| Capability           | Purpose                                                | Notes                                                                                                                                             |
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Device-risk provider | Optional third-party device-risk and antifraud signals | Active only when enabled by your Incode configuration; the SDK runs without it when it is not provisioned. See [Antifraud](/sdk-reference/android-antifraud/). |

## Framework and utility libraries

These support the SDK internally and do not collect end-user data:

- Dependency injection: Dagger, Koin
- Asynchronous / reactive: RxJava 2, Kotlin Coroutines
- Logging: Timber (the SDK does not log PII or capture content)

## Release hardening

The SDK's published release artifacts are obfuscated. This is a build-time step; it does not change the runtime behavior your integration relies on.

## Related pages

- [Release notes](/release-notes/releases-android-sdk/) - exact dependency versions per release, in the dependency sections
- [Incode Android SDK Reference](/sdk-reference/android-sdk/) - SDK overview, modules, and data-handling summary
- [Installation](/sdk-reference/android-installation/) - dependencies you declare, and how to disable crash reporting
- [Individual Modules](/sdk-reference/android-individual-modules/) - the module catalog

<br />

---

- Path: `sdk-reference/android-token-based-setup`
- URL: https://developer.incode.com/sdk-reference/android-token-based-setup/
- Markdown: https://developer.incode.com/sdk-reference/android-token-based-setup.md

# Token-based Setup

Initialize the Android SDK without an API key by providing only an `apiUrl` to `IncodeWelcome.Builder`, then using a session `token` to configure your onboarding session.

Token-based setup is a security measure that avoids exposing your API key in the mobile app. Instead of embedding the API key or sending it to the app, your backend uses the API key to create a session token, then sends that token to the app to start the onboarding session. This prevents attackers from extracting the API key and calling Incode APIs on your behalf.

## Prerequisites

- A session `token` issued by your backend.
- The `apiUrl` provided by Incode.

## Set up the SDK with a token

Token-based setup has three steps: initialize the SDK with only an `apiUrl`, configure the session with a `token`, then start onboarding or set up a section-based flow.

### 1. Initialize the SDK without an API key

Provide only the `apiUrl` to `IncodeWelcome.Builder`. Omit the API key.

```kotlin
IncodeWelcome.Builder(application, "https://your.api.url")
    // optional configuration
    .build()
```
```java
new IncodeWelcome.Builder(application, "https://your.api.url")
    // optional configuration
    .build();
```

If your `apiUrl` ends with `/0`, a token is mandatory: the SDK throws `ExternalTokenRequiredException` when the token is missing. The same applies to the E2EE URL when [End-to-End Encryption](/sdk-reference/android-e2ee/) is enabled.

### 2. Configure the session with a token

After initialization succeeds, create a `SessionConfig` and pass your session `token` to `setExternalToken`.

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setExternalToken("YOUR_TOKEN")
    .build()
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setExternalToken("YOUR_TOKEN")
    .build();
```

### 3. Start onboarding or set up a section-based flow

Pass the configured `sessionConfig` to `startOnboarding()`, `setupOnboardingSession()`, or any of the online-configured flow methods. Token-based setup works with all three [Common Implementation Patterns](/sdk-reference/android-common-implementation-patterns/).

```kotlin
// Section-based - create or resume the session first
IncodeWelcome.getInstance().setupOnboardingSession(sessionConfig, onboardingSessionListener)

// End-to-end - pass the token in sessionConfig to startOnboarding
IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)

// Dashboard flows - same sessionConfig
IncodeWelcome.getInstance().startFlow(activityContext, sessionConfig, onboardingListener)
IncodeWelcome.getInstance().startWorkflow(activityContext, sessionConfig, onboardingListener)
```
```java
// Section-based - create or resume the session first
IncodeWelcome.getInstance().setupOnboardingSession(sessionConfig, onboardingSessionListener);

// End-to-end - pass the token in sessionConfig to startOnboarding
IncodeWelcome.getInstance().startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);

// Dashboard flows - same sessionConfig
IncodeWelcome.getInstance().startFlow(activityContext, sessionConfig, onboardingListener);
IncodeWelcome.getInstance().startWorkflow(activityContext, sessionConfig, onboardingListener);
```

## Token expiration

Tokens are long-lived, so expiration during a session is unlikely. If a token does expire mid-session, the backend returns a 401 error, which is propagated to the SDK. Tokens cannot be refreshed; the user must start a new onboarding session, which generates a new token.

---

- Path: `sdk-reference/android-troubleshooting`
- URL: https://developer.incode.com/sdk-reference/android-troubleshooting/
- Markdown: https://developer.incode.com/sdk-reference/android-troubleshooting.md

# Troubleshooting

This page lists common build and runtime errors when integrating the Incode Android SDK, each with its cause and fix. [Install the SDK](/sdk-reference/android-installation/) if you haven't already.

***

## Runtime Crash in androidx.compose.\* (NoSuchMethodError / NoClassDefFoundError)

```
java.lang.NoClassDefFoundError: Failed resolution of: Landroidx/compose/material3/ExposedDropdownMenuAnchorType;
```

Or a `java.lang.NoSuchMethodError` / `AbstractMethodError` naming a class in `androidx.compose.material3`, `androidx.compose.foundation`, or `androidx.compose.ui`, thrown when a Compose screen opens. Depending on the screen, this can involve a Material3 control (a dynamic-form dropdown or date field, the CURP screen) or a more common building block such as a scrolling list or a tappable field (the phone-number input, country pickers, and most V2 screens).

**Cause**: The SDK's Compose screens are compiled against specific versions of `androidx.compose.material3`, `androidx.compose.foundation`, and `androidx.compose.ui`. Two kinds of API make this version-sensitive:

- Some Material3 APIs the SDK uses are annotated `@ExperimentalMaterial3Api`, which carries **no binary-compatibility guarantee**, so their compiled class and method signatures can change between minor releases (for example the `ExposedDropdownMenu` family and `DatePicker`).
- Stable Compose APIs that simply *gained a parameter* in a newer release. Because the SDK is compiled against the newer version, its bytecode binds the newer signature (for example `LazyColumn` / `LazyRow` / `LazyVerticalGrid`, which gained an `overscrollEffect` parameter, and `Modifier.pointerInput`, in Compose 1.8).

Compose reaches your app transitively, resolved by Gradle's highest-version-wins rule. If your app resolves any of these artifacts **below** the version the SDK was built against, the signature the SDK's bytecode calls does not exist there, the call cannot be linked at runtime, and the screen crashes.

This SDK version is built against **Compose Material3 1.4.0** and **Compose 1.8** (foundation / UI), so your app must resolve `androidx.compose.material3` to **1.4.0 or later** and `androidx.compose.foundation` / `androidx.compose.ui` to **1.8.0 or later**. The two floors are coupled, since Material3 1.4.0 itself depends on Compose 1.8, so satisfying Material3 1.4.0 normally pulls a compatible Compose set automatically. Earlier SDK releases were built against Material3 1.3.2 / Compose 1.7; this requirement applies from this version onward.

**Fix**: In most projects nothing is required. If your app or any of its dependencies pulls Material3 1.4.0 (and therefore Compose 1.8) or newer, Gradle's highest-wins resolution already satisfies it. Act only if you have explicitly pinned Material3 or Compose below those versions:

- Remove any `resolutionStrategy.force`, strict version, or dependency `constraint` holding `androidx.compose.material3` below 1.4.0, or `androidx.compose.foundation` / `androidx.compose.ui` (or their `-android` artifacts) below 1.8.0.
- If you deliberately manage Compose versions, align Material3 to 1.4.0 or newer together with a matching Compose UI / Foundation set at 1.8.0 or newer, for example via the Compose BOM.

Confirm the version your app actually resolves with:

```
./gradlew :app:dependencies --configuration releaseRuntimeClasspath | grep -E 'compose\.(material3|foundation|ui)'
```

***

## Class Was Compiled with an Incompatible Version of Kotlin

```
Class 'com.incode.welcome_sdk.IncodeWelcome' was compiled with an incompatible version of Kotlin.
The binary version of its metadata is 2.2.0, expected version is 2.1.0.
```

Reported at build time (not at runtime) against any SDK class your code references. Unlike the runtime crash above, this error stops your app from compiling at all.

**Cause**: The SDK is compiled with Kotlin 2.2.21, so its classes carry Kotlin metadata version 2.2.0. The Kotlin compiler reads metadata at most one minor version ahead of its own, so a 2.0.x compiler reads metadata up to 2.1 and rejects the SDK's classes. The SDK's OkHttp and logging-interceptor 5.3.2 dependencies also ship Kotlin metadata built with 2.2.x, which compilers older than 2.2.x cannot read. The minimum Kotlin version for apps integrating this SDK version is therefore **2.2.x**, and matching the SDK's own 2.2.21 or newer is recommended. The version that matters is the Kotlin compiler (Kotlin Gradle plugin) your app builds with, not the `kotlin-stdlib` your dependencies resolve.

**Fix**: Upgrade your project's Kotlin Gradle plugin to 2.2.x (`2.2.21` or newer), for example:

```groovy
plugins {
    id 'org.jetbrains.kotlin.android' version '2.2.21'
}
```

Java-only apps that do not apply the Kotlin plugin are unaffected, since the metadata check is performed only by the Kotlin compiler.

***

## Attribute application\@allowBackup Value Conflict

```
Attribute application@allowBackup value=(true) from AndroidManifest.xml is also present at [com.incode.sdk:welcome:x.x.x] AndroidManifest.xml value=(false).
Suggestion: add 'tools:replace="android:allowBackup"' to `<application>` element at AndroidManifest.xml to override.
```

**Cause**: Your `AndroidManifest.xml` sets `allowBackup` to `true`, but the SDK sets it to `false`.

**Fix**: Setting `allowBackup` to `true` is a potential security risk. Incode recommends setting it to `false`.

If you need to allow backups, add `tools:replace="android:allowBackup"` to the `<application>` element in your `AndroidManifest.xml`. If you already have attributes in `tools:replace`, separate them with commas.

***

## Static Interface Methods Are Only Supported Starting with Android N

```
Static interface methods are only supported starting with Android N (--min-api 24): Lbutterknife/Unbinder;lambda$static$0()V
Error while dexing. The dependency contains Java 8 bytecode. Please enable desugaring by adding the following to build.gradle
android {
    compileOptions {
        sourceCompatibility 1.8
        targetCompatibility 1.8
}}
```

**Fix**: Add the following to the `android{}` block in your `module]/build.gradle`.

```groovy build.gradle (Module)
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
```
```kotlin build.gradle.kts (Module)
compileOptions {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}
```

***

## All Modules with Native Libraries Must Support the Same Set of ABIs

```
Execution failed for task ':app:packageDebugBundle'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.Workers$ActionFacade
   > All modules with native libraries must support the same set of ABIs, but module 'base' supports '[X86, ARMEABI_V7A, ARM64_V8A, X86_64, MIPS, ARMEABI]' and module 'incode_core' supports '[ARMEABI_V7A, X86, X86_64, ARM64_V8A]'.
- problem when generating bundles.
```

**Fix**: Add the following NDK ABI filters to the `defaultConfig{}` block in your `[module]/build.gradle`.

```groovy build.gradle (Module)
ndk {
    abiFilters "arm64-v8a", "armeabi-v7a", "x86", "x86_64"
}
```
```kotlin build.gradle.kts (Module)
ndk {
    abiFilters.addAll(listOf("arm64-v8a", "armeabi-v7a", "x86", "x86_64"))
}
```

***

## FATAL EXCEPTION: RxCachedThreadScheduler

```
E/AndroidRuntime: FATAL EXCEPTION: RxCachedThreadScheduler-2
    Process: com.incode.welcome.example, PID: 6842
    io.reactivex.exceptions.UndeliverableException: The exception could not be delivered to the consumer because it has already canceled/disposed the flow or the exception has nowhere to go to begin with. Further reading: https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0#error-handling | java.lang.NoSuchMethodError: No virtual method log(ILjava/lang/String;Ljava/lang/Throwable;)V in class Lokhttp3/internal/platform/Platform; or its super classes (declaration of 'okhttp3.internal.platform.Platform' appears in /data/app/com.incode.welcome.example-HnCVs4pdPTZBq3BhFsJmdQ==/base.apk!classes3.dex)
        at io.reactivex.plugins.RxJavaPlugins.onError(RxJavaPlugins.java:367)
        at io.reactivex.internal.schedulers.ScheduledRunnable.run(ScheduledRunnable.java:69)
        at io.reactivex.internal.schedulers.ScheduledRunnable.call(ScheduledRunnable.java:57)
        at java.util.concurrent.FutureTask.run(FutureTask.java:266)
        at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:301)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1167)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:641)
        at java.lang.Thread.run(Thread.java:919)
    Caused by: java.lang.NoSuchMethodError: No virtual method log(ILjava/lang/String;Ljava/lang/Throwable;)V in class Lokhttp3/internal/platform/Platform; or its super classes (declaration of 'okhttp3.internal.platform.Platform' appears in /data/app/com.incode.welcome.example-HnCVs4pdPTZBq3BhFsJmdQ==/base.apk!classes3.dex)
        at okhttp3.logging.HttpLoggingInterceptor$Logger$1.log(HttpLoggingInterceptor.java:114)
        at okhttp3.logging.HttpLoggingInterceptor.intercept(HttpLoggingInterceptor.java:173)
        at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.kt:100)
        at okhttp3.internal.connection.RealCall.getResponseWithInterceptorChain$okhttp(RealCall.kt:197)
        at okhttp3.internal.connection.RealCall.execute(RealCall.kt:148)
        at retrofit2.OkHttpCall.execute(OkHttpCall.java:186)
        at retrofit2.adapter.rxjava2.CallExecuteObservable.subscribeActual(CallExecuteObservable.java:45)
        at io.reactivex.Observable.subscribe(Observable.java:12267)
        at retrofit2.adapter.rxjava2.BodyObservable.subscribeActual(BodyObservable.java:34)
        at io.reactivex.Observable.subscribe(Observable.java:12267)
        at io.reactivex.internal.operators.observable.ObservableMap.subscribeActual(ObservableMap.java:32)
        at io.reactivex.Observable.subscribe(Observable.java:12267)
        at io.reactivex.internal.operators.observable.ObservableSubscribeOn$SubscribeTask.run(ObservableSubscribeOn.java:96)
        at io.reactivex.Scheduler$DisposeTask.run(Scheduler.java:578)
        at io.reactivex.internal.schedulers.ScheduledRunnable.run(ScheduledRunnable.java:66)
        at io.reactivex.internal.schedulers.ScheduledRunnable.call(ScheduledRunnable.java:57)
        at java.util.concurrent.FutureTask.run(FutureTask.java:266)
        at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:301)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1167)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:641)
        at java.lang.Thread.run(Thread.java:919)
```

**Cause**: The `okhttp3:okhttp` dependency version does not match `okhttp3:logging-interceptor` or `okhttp3:okhttp-urlconnection`. For example, the following version mismatch causes this crash:

- `okhttp3:logging-interceptor:3.4.0`
- `okhttp3:okhttp-urlconnection:3.4.1`
- `okhttp3:okhttp:4.5.0`

**Fix**: Match the versions of `okhttp3:logging-interceptor` and `okhttp3:okhttp-urlconnection` to `okhttp3:okhttp`. For the example above, set both to `4.5.0`:

```groovy build.gradle (Module)
dependencies {
    ...

    implementation 'com.squareup.okhttp3:logging-interceptor:4.5.0'
    implementation 'com.squareup.okhttp3:okhttp-urlconnection:4.5.0'
}
```
```kotlin build.gradle.kts (Module)
dependencies {
    ...

    implementation("com.squareup.okhttp3:logging-interceptor:4.5.0")
    implementation("com.squareup.okhttp3:okhttp-urlconnection:4.5.0")
}
```

The crash also occurs if only one of `logging-interceptor` or `okhttp-urlconnection` is present and mismatched. Both must match `okhttp3:okhttp`.

***

## InvalidUserCodeException: Build Was Configured to Prefer Settings

```
org.gradle.api.InvalidUserCodeException: Build was configured to prefer settings repositories over project repositories but repository 'maven' was added by build file 'build.gradle'
```

**Cause**: On Gradle 6.8 or later, repositories must be declared in the `dependencyResolutionManagement` block in `settings.gradle`, not in the project-level `build-gradle`.

**Fix**: Move the `maven` repository declaration from `build.gradle` to `settings-gradle`. See [Stack Overflow](https://stackoverflow.com/questions/69163511/build-was-configured-to-prefer-settings-repositories-over-project-repositories-b) for more information.

```groovy settings.gradle
dependencyResolutionManagement {
    ...
    repositories {
        ...
        maven {
            url "https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages"
            credentials {
                username = "incode-customers"
                password = "GITHUB_TOKEN"
            }
        }
    }
}
```
```kotlin settings.gradle.kts
dependencyResolutionManagement {
    ...
    repositories {
        ...
        maven {
            url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
            credentials {
                username = "incode-customers"
                password = "GITHUB_TOKEN"
            }
        }
    }
}
```

***

## A problem Occurred Evaluating Root Project

**Cause**: Your build was configured to prefer settings repositories over project repositories, but the `google()` repository was added by `build-gradle`.

**Fix**: In `settings.gradle`, set `repositoriesMode` to `RepositoriesMode.PREFER_PROJECT`.

```groovy settings.gradle
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_PROJECT)
    repositories {
        google()
        mavenCentral()
    }
}
```
```kotlin settings.gradle.kts
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_PROJECT)
    repositories {
        google()
        mavenCentral()
    }
}
```

***

## Sentry Compatibility Issues

The SDK has included Sentry for crash reporting since version 5.24.0. As of version 5.39.0, the SDK uses Sentry version 7.22.6. If your project has its own Sentry integration, or another dependency includes one, you may encounter errors. The sub-sections below cover the most common failures, as well as how to disable crash reporting if needed.

### Your Sentry Integration Appears Broken After Integrating the SDK

**Cause**: Java-based crash reporting tools rely on the ordering of `Thread.UncaughtExceptionHandlers`. Occasionally, crashes are not passed down handler chain correctly.

**Fix**: Swap the initialization order of your Sentry integration and `IncodeWelcome.Builder()...build()`. If the issue persists, [disable SDK crash reporting](#disable-sdk-crash-reporting).

### Fatal Error During SentryAndroid.init(...) at Runtime

**Cause**: The following crash can occur with projects using Sentry 6.x.x.

```
java.lang.RuntimeException: Unable to get provider io.sentry.android.core.SentryInitProvider: java.lang.RuntimeException: Failed to initialize Sentry's SDK
...
Caused by: java.lang.RuntimeException: Failed to initialize Sentry's SDK
...
Caused by: java.lang.reflect.InvocationTargetException
...
Caused by: java.lang.NoSuchMethodError: No virtual method setEnableScopeSync(Z)V...
```

**Fix**: Upgrade to SDK 5.25.0 or newer and apply the following workaround:

1. Exclude the Sentry library from SDK:
   ```groovy build.gradle (Module)
   implementation ('com.incode.sdk:welcome:5.25.0') { // Mandatory dependency
       exclude group: 'io.sentry', module: 'sentry' // Use this line if you're on Incode SDK version older than 5.39.0
       exclude group: 'io.sentry', module: 'sentry-android' // Use this line if you're on Incode SDK 5.39.0 or newer
   }
   ```
   ```kotlin build.gradle.kts (Module)
   implementation("com.incode.sdk:welcome:5.25.0") { // Mandatory dependency 
       exclude(group = "io.sentry", module = "sentry") // Use this line if you're on Incode SDK version older than 5.39.0
       exclude(group = "io.sentry", module = "sentry-android") // Use this line if you're on Incode SDK 5.39.0 or newer
   }
   ```

2. [Disable SDK crash reporting](#disable-sdk-crash-reporting)​.

### Fatal Exception: java.lang.NoSuchMethodError: No virtual method getMainThreadChecker()

**Cause**: Projects using Sentry 8.x.x or a dependency that includes it may encounter the following crash due to breaking changes between Sentry 7.x.x and 8.x.x:

```
Fatal Exception: java.lang.NoSuchMethodError: No virtual method getMainThreadChecker()Lio/sentry/util/thread/IMainThreadChecker; in class Lio/sentry/SentryOptions; or its super classes (declaration of 'io.sentry.SentryOptions' appears in ...)
```

**Fix**: You have two options.

**Option 1: Downgrade Sentry to 7.x.x**

If your project adds Sentry 8 or later directly, remove the `implementation` line. The project will fall back to Sentry 7.x.x included with the SDK.

```groovy build.gradle (Module)
implementation 'io.sentry:sentry-android:8.x.x'
```
```kotlin build.gradle.kts (Module)
implementation("io.sentry:sentry-android:8.x.x")
```

If another dependency adds Sentry 8 or later, exclude it:

```groovy build.gradle (Module)
implementation ('other.dependency.including.sentry:8.x.x') {
    exclude group: 'io.sentry', module: 'sentry'
}
```
```kotlin build.gradle.kts (Module)
implementation("other.dependency.including.sentry:8.x.x") { // Mandatory dependency 
    exclude(group = "io.sentry", module = "sentry")
}
```

**Option 2: Upgrade the SDK and Disable Crash Reporting**

SDK 5.39.0 includes workarounds for the breaking changes between Sentry 7.x.x and 8.x.x. Upgrade to version 5.39.0 or later to prevent the crash. These workarounds prevent crashes but do not make crash reporting functional. [Disable SDK crash reporting](#disable-sdk-crash-reporting)​.

### Disable SDK Crash Reporting

If an issue is becoming difficult to resolve, you can disable SDK crash reporting.

```kotlin
IncodeWelcome.Builder()
    ...
    .setCrashReportingEnabled(false)
    .build()
```
```java
new IncodeWelcome.Builder()
    ...
    .setCrashReportingEnabled(false)
    .build();
```

<br />

---

- Path: `sdk-reference/android-us-smart-capture`
- URL: https://developer.incode.com/sdk-reference/android-us-smart-capture/
- Markdown: https://developer.incode.com/sdk-reference/android-us-smart-capture.md

# US Smart Capture

This page covers **Android SDK** behavior for US Smart Capture: version gates, which start APIs honor the Dashboard flag, `SdkMode` limits, and code samples.

Dashboard enablement, GovFace Match provisioning, jurisdiction coverage, and conflicting ID options are configured by Incode. Contact your Incode representative for those steps.

US Smart Capture is a Dashboard option on ID Capture used with **GovFace Match** (DMV Face Match). The Android SDK applies `usSmartCapture: true` only when you start the session with certain APIs. There is **no** public `IdScan.Builder` API to turn it on in code.

US Smart Capture is available for:

- Android SDK `5.41.0` or later for the Dashboard option
- Android SDK `5.43.0` or later for the PDF417 barcode-first path on `IdScan` `V2`
- Organizations provisioned for GovFace Match / DMV Face Match

Use Dashboard-configured [Flows](https://developer.incode.com/docs/mobile-flow) and [Workflows](https://developer.incode.com/docs/mobile-workflow) with `startFlow()` or `startWorkflow()`. Local `FlowConfig` composition cannot enable this option.

***

## Prerequisites

Complete [Android setup](/sdk-reference/android-installation/) and SDK initialization before you enable US Smart Capture.

- Use Android SDK `5.43.0` or later for the barcode-first `V2` path. The Dashboard option exists from `5.41.0`.
- Complete Dashboard and GovFace Match setup with your Incode representative.
- Enable the `V2` UI on the Flow or Workflow. The barcode-first UX runs only on the `V2` `IdScan` path. If the session runs on legacy `V1` UI, the SDK falls back to ordinary front-and-back capture with no error. See [Enable the `V2` UI](#enable-the-v2-ui).
- Pass the Flow ID to `SessionConfig.setConfigurationId(...)` when you call `startFlow()`, or the Workflow ID when you call `startWorkflow()`.
- Prefer `startFlow()` or `startWorkflow()`. US Smart Capture is not supported on `startOnboarding(...)` with a `configurationId`. See [Supported Start APIs](#supported-start-apis).
- Use `SdkMode.STANDARD` (the default). US Smart Capture is not supported in Capture Only or Delayed mode. See [SDK Modes](#sdk-modes).

***

## Enable the `V2` UI

US Smart Capture's barcode UX exists only on the `V2` `IdScan` path. For server-driven Flows and Workflows, turn on **Enable new user experience** on the Flow or Workflow **Settings** tab, then save and publish as required by the Dashboard.

Full detail for both server-driven and client-configured integrations lives in [Enabling the `V2` UI](/sdk-reference/android-customization#enable-v2-ui) in the SDK Customization guide.

<Callout icon="📘" theme="info">
  ### Note

  If US Smart Capture is on in the Dashboard but the session still uses `V1` UI, the SDK proceeds as a normal front-and-back `IdScan` with no error. Turn on **Enable new user experience** on every Flow or Workflow that uses US Smart Capture.
</Callout>

***

## Supported Start APIs

| Start API | Honors the Dashboard `usSmartCapture` flag? | Notes |
| --- | --- | --- |
| `startFlow(context, sessionConfig, listener)` | **Yes** | Pass a **Flow** ID via `SessionConfig.setConfigurationId(...)`. The SDK builds the flow from the Dashboard and applies `usSmartCapture` from the ID Capture module. **Recommended for Flows.** |
| `startWorkflow(context, sessionConfig, listener)` | **Yes** | Pass a **Workflow** ID via `SessionConfig.setConfigurationId(...)`. Applied per ID node from the workflow module configuration. **Recommended for Workflows.** |
| `startOnboarding(context, sessionConfig, flowConfig, listener)` with `SessionConfig.setConfigurationId(...)` | **No** | US Smart Capture is not supported on this entry point. The Dashboard checkbox can look enabled while capture stays front-and-back. Use `startFlow()` or `startWorkflow()` instead. |
| `startOnboarding(...)` with a fully client-built `FlowConfig` | **N/A** | There is no public `IdScan.Builder` API to enable US Smart Capture in code. |
| `startOnboardingSection(...)` | **No** | US Smart Capture is not supported on this entry point. Use `startFlow()` or `startWorkflow()` instead. |

`SessionConfig.setConfigurationId(...)` accepts the ID of the Dashboard configuration you intend to run. Use a Flow ID with `startFlow()`, and a Workflow ID with `startWorkflow()`. Do not pass a Workflow ID to `startFlow()`.

### Example: Flow

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setConfigurationId(FLOW_ID)
    .build()

IncodeWelcome.getInstance().startFlow(
    activityContext,
    sessionConfig,
    onboardingListener
)
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId(FLOW_ID)
    .build();

IncodeWelcome.getInstance().startFlow(
    activityContext,
    sessionConfig,
    onboardingListener);
```

### Example: Workflow

```kotlin
val sessionConfig = SessionConfig.Builder()
    .setConfigurationId(WORKFLOW_ID)
    .build()

IncodeWelcome.getInstance().startWorkflow(
    activityContext,
    sessionConfig,
    onboardingListener
)
```
```java
SessionConfig sessionConfig = new SessionConfig.Builder()
    .setConfigurationId(WORKFLOW_ID)
    .build();

IncodeWelcome.getInstance().startWorkflow(
    activityContext,
    sessionConfig,
    onboardingListener);
```

***

## SDK Modes

US Smart Capture requires a Dashboard-driven Flow or Workflow started with `startFlow()` or `startWorkflow()`. Those APIs reject Capture Only and Delayed modes. Use `SdkMode.STANDARD` (the default) for this integration.

| SDK mode | US Smart Capture supported? | Notes |
| --- | --- | --- |
| `SdkMode.STANDARD` | **Yes** | Use with `startFlow()` or `startWorkflow()` and a Dashboard configuration that has US Smart Capture enabled. |
| `SdkMode.CAPTURE_ONLY` | **No** | Capture Only does not support `startFlow()` or `startWorkflow()`. There is also no public `IdScan.Builder` API to enable US Smart Capture in a client-built `FlowConfig`. |
| `SdkMode.DELAYED` | **No** | Delayed mode does not support `startFlow()` or `startWorkflow()`. Offline capture also cannot use the barcode upload path that US Smart Capture depends on. |

If you need Capture Only or Delayed onboarding, use a standard front-and-back `IdScan` path instead of US Smart Capture.

***

## Troubleshooting

| Symptom | Likely cause | What to check |
| --- | --- | --- |
| US Smart Capture is on in the Dashboard, but the app still does front-then-back capture | Unsupported start API | Confirm you call `startFlow()` with a Flow ID, or `startWorkflow()` with a Workflow ID. Avoid `startOnboarding()` / `startOnboardingSection()` for this option. |
| Same as above, but you already use `startFlow()` or `startWorkflow()` | `V2` UI off | Turn on **Enable new user experience** on the Flow or Workflow **Settings** tab, then save and publish. |
| Back or barcode capture runs, but front is still required | Jurisdiction or provisioning | Confirm the driver's license state is covered under your GovFace Match provisioning with your Incode representative. |
| US Smart Capture is missing or unavailable in the ID Capture module | Feature not enabled for your organization | Ask your Incode representative to enable US Smart Capture / GovFace Match for your organization. |
| Capture behavior looks wrong when other ID Capture options are also on | Conflicting options in the Dashboard | Disable **Barcode Capture** and **Back ID Only** on the same ID Capture module. Leave only **US Smart Capture** enabled. |
| Capture Only or Delayed session ignores US Smart Capture | Unsupported SDK mode | Use `SdkMode.STANDARD` with `startFlow()` or `startWorkflow()`. See [SDK Modes](#sdk-modes). |

***

## Related Guides

- [Android setup](/sdk-reference/android-installation/)
- [Mobile Integration: Flows](https://developer.incode.com/docs/mobile-flow)
- [Mobile Integration: Workflows](https://developer.incode.com/docs/mobile-workflow)
- [SDK Customization - Enabling the `V2` UI](/sdk-reference/android-customization#enable-v2-ui)
- [Government Verification Sources](https://developer.incode.com/docs/government-verification)
- [User Guide](https://developer.incode.com/docs/user-guide)

---

- Path: `sdk-reference/android-user-consent`
- URL: https://developer.incode.com/sdk-reference/android-user-consent/
- Markdown: https://developer.incode.com/sdk-reference/android-user-consent.md

# User Consent

The User Consent module shows a custom consent agreement for the user to review and accept. Use it to capture an explicit, recorded agreement at a chosen point in the flow. The consent step records acceptance against the current onboarding session; the exact downstream behavior depends on your Incode Flow or Workflow configuration.

There is no Dashboard equivalent for this module, so you cannot use [integration Pattern 3](/sdk-reference/android-common-implementation-patterns/#pattern-3-run-flows-configured-in-dashboard) to add it. You must use [Pattern 1](/sdk-reference/android-common-implementation-patterns/#pattern-1-configure-flows-locally-and-run-end-to-end) or [2](/sdk-reference/android-common-implementation-patterns/#pattern-2-configure-flows-locally-and-run-step-by-step), adding the module to a `FlowConfig` in code as shown on this page.

For acceptance of multiple statements on one screen, see [Combined Consent](/sdk-reference/android-combined-consent/). For biometric or machine learning data consent, see [Machine Learning Consent](/sdk-reference/android-machine-learning-consent/).

## Add User Consent

1. Add the module with `addUserConsent(userConsent)`.

   ```kotlin
   flowConfigBuilder.addUserConsent(userConsent)
   ```
   ```java
   flowConfigBuilder.addUserConsent(userConsent);
   ```

2. Add any [Approval](/sdk-reference/android-approval/) or [Results](/sdk-reference/android-results/) modules after User Consent.

### Example

The example below builds a `UserConsent` module with a title and body, adds it to a `FlowConfig` with a flow tag, and starts an onboarding section.

```kotlin
try {
    val userConsent = UserConsent.Builder()
        .setTitle("Terms and conditions")
        .setContent("I agree to the terms and conditions.")
        .build()

    val flowConfig = FlowConfig.Builder()
        .setFlowTag("User consent section")
        .addUserConsent(userConsent)
        .build()

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, object : OnboardingListener() {
            override fun onUserConsentCompleted() {
                // User accepted the consent
            }

            override fun onError(error: Throwable) {}

            override fun onUserCancelled() {}

            override fun onOnboardingSectionCompleted(flowTag: String) {
                // User consent section complete
            }
        }
    )
} catch (e: ModuleConfigurationException) {
    e.printStackTrace()
}
```
```java
try {
    UserConsent userConsent = new UserConsent.Builder()
        .setTitle("Terms and conditions")
        .setContent("I agree to the terms and conditions.")
        .build();

    FlowConfig flowConfig = new FlowConfig.Builder()
        .setFlowTag("User consent section")
        .addUserConsent(userConsent)
        .build();

    IncodeWelcome.getInstance()
        .startOnboardingSection(activityContext, flowConfig, new IncodeWelcome.OnboardingListener() {
            @Override
            public void onUserConsentCompleted() {
                // User accepted the consent
            }

            @Override
            public void onError(@NonNull Throwable error) {}

            @Override
            public void onUserCancelled() {}

            @Override
            public void onOnboardingSectionCompleted(@NonNull String flowTag) {
                // User consent section complete
            }
        }
    );
} catch (ModuleConfigurationException e) {
    e.printStackTrace();
}
```

## Configuration Options

Configure the module with `UserConsent.Builder`. The table below lists the common options.

| Setting              | Description                                                         |
| -------------------- | ------------------------------------------------------------------- |
| `setTitle(String)`   | Sets the heading shown above the consent body text.                 |
| `setContent(String)` | Sets the consent body text the user reviews and accepts or rejects. |

For the complete option set, see `UserConsent.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

User Consent does not deliver a result payload to the `OnboardingListener`. The `onUserConsentCompleted()` callback signals that the user accepted the consent. If the user rejects the consent, the `onUserCancelled()` callback fires instead. Any failure surfaces on `onError(Throwable)`.

<br />For the related result type and its fields, see `UserConsentResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/android-video-selfie`
- URL: https://developer.incode.com/sdk-reference/android-video-selfie/
- Markdown: https://developer.incode.com/sdk-reference/android-video-selfie.md

# Video Selfie

The Video Selfie module records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent.

For an overview of this module and how it works, see [Video Selfie](/features-and-modules/video-selfie/).

How you use this module depends on your [integration pattern](/sdk-reference/android-common-implementation-patterns/#integration-patterns). In Patterns 1 and 2, you add the module to a `FlowConfig` in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with `startFlow()` or `startWorkflow()` as shown on [Run Flows Configured in Dashboard](/sdk-reference/android-run-flows-configured-online/).

Video Selfie is not available in [Capture-Only mode](/sdk-reference/android-capture-only-sdk/); adding it there throws `ModuleNotAvailableException`.

Screen recording requires API level 21 or later.

## Add Video Selfie

1. Add a selfie step before Video Selfie: either an [ID Scan](/sdk-reference/android-id-scan/) that captures a selfie, or the [Selfie Scan](/sdk-reference/android-selfie-scan/) module. The face captured here is matched against that selfie, so omitting it causes the module to fail with `SelfieNotMatchedException`.
2. Add the module with one of the `addVideoSelfie` overloads:

   ```kotlin
   // Default configuration
   flowConfigBuilder.addVideoSelfie()

   // Custom configuration built with VideoSelfie.Builder
   flowConfigBuilder.addVideoSelfie(videoSelfie)
   ```
   ```java
   // Default configuration
   flowConfigBuilder.addVideoSelfie();

   // Custom configuration built with VideoSelfie.Builder
   flowConfigBuilder.addVideoSelfie(videoSelfie);
   ```

### Example

The example below builds a `VideoSelfie` module with selfie matching and liveness enabled, adds it to the flow, and listens for the result through `onVideoRecorded()`.

```kotlin
val videoSelfie = VideoSelfie.Builder()
    .setSelfieMode(VideoSelfie.SelfieMode.SELFIE_MATCH)
    .setLivenessEnabled(true)
    .build()

val flowConfig = FlowConfig.Builder()
    .addVideoSelfie(videoSelfie)
    .build()

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    object : OnboardingListener() {
        override fun onVideoRecorded(videoSelfieResult: VideoSelfieResult) {
            // Video recorded and uploaded
        }

        override fun onError(error: Throwable) {}

        override fun onUserCancelled() {}
    }
)
```
```java
VideoSelfie videoSelfie = new VideoSelfie.Builder()
    .setSelfieMode(VideoSelfie.SelfieMode.SELFIE_MATCH)
    .setLivenessEnabled(true)
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addVideoSelfie(videoSelfie)
    .build();

IncodeWelcome.getInstance().startOnboarding(
    activityContext,
    sessionConfig,
    flowConfig,
    new IncodeWelcome.OnboardingListener() {
        @Override
        public void onVideoRecorded(@NonNull VideoSelfieResult videoSelfieResult) {
            // Video recorded and uploaded
        }

        @Override
        public void onError(@NonNull Throwable error) {}

        @Override
        public void onUserCancelled() {}
    }
);
```

## Configuration Options

Configure the module with `VideoSelfie.Builder`. The table below lists the most commonly used options.

| Setting                                 | Description                                                                                                                                                                                         |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setSelfieMode(VideoSelfie.SelfieMode)` | Sets the comparison mode for the captured selfie. `SELFIE_MATCH` (default) matches the new selfie against a previously captured selfie; `FACE_MATCH` matches it against the previously captured ID. |
| `setLivenessEnabled(Boolean)`           | Enables or disables the liveness check.                                                                                                                                                             |
| `setHeadMovementEnabled(Boolean)`       | When `true`, adds an active head-movement liveness check to the selfie scan step. Applies only when the selfie scan step is enabled. The default value is `false`.                                                        |
| `setHandGestureEnabled(Boolean)`        | When `true`, adds a hand-gesture step that asks the user to wave a hand across their face. The default value is `false`.                                                                                                  |
| `setShowTutorials(Boolean)`             | Shows or hides the tutorial screen before recording.                                                                                                                                                |
| `setMaxVideoLength(Int)`                | Sets the maximum recording length.                                                                                                                                                                  |
| `setDisableAudio(Boolean)`              | When `true`, records video without audio. The default value is `false`.                                                                                                                                                                       |
| `setLogo(Int)`                          | Sets a drawable resource shown during recording. This logo has priority over `ThemeConfiguration.Builder().setLogo()`.                                                                              |

For the complete option set, see `VideoSelfie.Builder` in [API Reference](/sdk-reference/android-api-reference/).

## Result

Video Selfie delivers a `VideoSelfieResult` through the `OnboardingListener` callback `onVideoRecorded(VideoSelfieResult)`. Key fields include:

- `videoFilePath`: The URI pointing to the recorded video file; `null` when unavailable.
- `audioFilePath`: The URI pointing to the recorded audio file; `null` when unavailable.
- `selfieImagePath`: The URI pointing to the captured selfie image; `null` when unavailable.
- `idFrontImagePath`: The URI pointing to the captured ID front image; `null` when unavailable.
- `idBackImagePath`: The URI pointing to the captured ID back image; `null` when unavailable.
- `documentImagePath`: The URI pointing to the captured document image; `null` when unavailable.
- `voiceConsentSelfiePath`: The URI pointing to the voice-consent selfie image; `null` when unavailable.

- Fields inherited from `BaseResult`:
  - `resultCode`: The `ResultCode` for this result.
  - `error`: When `resultCode` is `ERROR`, the `Throwable` that caused it; otherwise, `null`.
  - `deviceStats`: The `DeviceStats` snapshot of the device state when the result was produced.
  - `motionStatus`: Device motion assessment during capture. One of the following:
    - `UNCLEAR`: Motion could not be determined; the default.
    - `PASS`: Device motion was within acceptable limits.
    - `FAIL`: Excessive device motion was detected.

Errors surface through `OnboardingListener.onError(Throwable)`. For this module, the throwable is a `VideoSelfieException` subtype: `SelfieNotMatchedException`, `AudioNotMatchedException`, or `VideoUploadException`.

For all fields, see `VideoSelfieResult` in [API Reference](/sdk-reference/android-api-reference/).

---

- Path: `sdk-reference/cordova-api-reference`
- URL: https://developer.incode.com/sdk-reference/cordova-api-reference/
- Markdown: https://developer.incode.com/sdk-reference/cordova-api-reference.md

# API Reference

This page is the complete reference for every public JavaScript API the Incode Onboarding Cordova Plugin exposes. All APIs are invoked through the Cordova bridge feature name `Cplugin`:

```javascript
cordova.exec(successCallback, errorCallback, "Cplugin", "<action>", [...args]);
```

The plugin also exposes wrapper functions in `Cplugin.js`; the underlying `cordova.exec` call is shown for each method below.

## Table of Contents

- **Lifecycle & configuration**: [initializeSDK](#initializesdk), [isInitialized](#isinitialized), [showCloseButton](#showclosebutton), [setSdkMode](#setsdkmode)
- **Customization**: [setTheme](#settheme), [setUXConfig](#setuxconfig), [setLocalizationLanguage](#setlocalizationlanguage), [setString](#setstring), [setQuantityStrings](#setquantitystrings), [setFaceAuthenticationHint](#setfaceauthenticationhint), [setLogo](#setlogo)
- **Session & flow**: [setupOnboardingSession](#setuponboardingsession), [startOnboarding](#startonboarding), [startOnboardingSection](#startonboardingsection), [startFlow](#startflow), [startWorkflow](#startworkflow)
- **Results & finalization**: [getUserScore](#getuserscore), [faceMatch](#facematch), [finishOnboarding](#finishonboarding), [startFaceLogin](#startfacelogin), [deleteUserLocalData](#deleteuserlocaldata), [approve](#approve)
- **Event handling**: [flowListeners](#flowlisteners)




## Shared Types

Common types used by multiple API methods.

### sessionConfig

Used by `setupOnboardingSession()`, `startOnboarding()`, `startFlow()`, `startWorkflow()`, and, on Android, `startFaceLogin()`.

- `configurationId`: Dashboard Flow or Workflow configuration ID. `startFlow()` and `startWorkflow()` require `configurationId` or `token`.
- `region`: `"ALL"`, `"BR"`, or `"IN"`. `"ALL"` covers all regions; `"BR"` is Brazil and `"IN"` is for India.
- `queue`: Queue name the session attaches to.
- `interviewId`: Existing session ID to resume.
- `token`: External session token from your back end. `configurationId` can be omitted when this is passed.
- `externalId`: Client-side identifier used outside Incode.
- `externalCustomerId`: Links the session to an entity in an external system.
- `e2eEncryptionEnabled`: Enable end-to-end encryption. Requires `e2eeUrl` to have been passed to `initializeSDK()`. Boolean.
- `mergeSessionRecordings`: Merge ID and face capture recordings into a single video. Boolean.
- `voiceConsentLanguage`: Voice consent language for `addVideoSelfie`: `"en"` for English, `"es"` for Spanish, `"pt"` for Portuguese, or `"he"` for Hebrew.
- `validationModules`: List of validation modules to enable. Array of strings.
- `customFields`: Custom key-value data attached to the session. Object.

### recordSessionConfig

The two flow methods use different recording configurations.

For `startOnboardingSection()`:

- `recordSession`: Boolean. `true` enables ID and selfie capture screen recording. Default: `false`.
- `forcePermission`: Boolean. `true` makes recording permissions mandatory. Default: `false`. Applies only when `recordSession` is `true`.

Use real booleans, not `"true"` or `"false"`. Non-boolean values are ignored and default to `false`, without an error callback. `recordSession: "true"` leaves recording disabled. The old `forcePermissions` key is ignored. An absent or `null` configuration disables recording. A non-null value that is not an object fails with `configError`.

For `startOnboarding()`:

- `recordSession`: `"true"` enables ID and selfie capture screen recording. Accepts a boolean or the string `"true"` / `"false"`.
- `forcePermissions`: `"true"` aborts the session if the user denies permissions. Accepts a boolean or the string `"true"` / `"false"`.

## Lifecycle and Configuration

### initializeSDK()

Initializes the native Incode SDK. Must be called at least once per app lifecycle before any other operation.

**Signature**

```javascript
initializeSDK(successCallback, errorCallback, apiKey, apiUrl, loggingEnabled, testMode, clientExperimentId, e2eeUrl, sslPinningConfig, sdkMode, externalAnalyticsEnabled, externalScreenshotsEnabled, sendDiagnosticsData, appleWalletMerchantID)
```

**Required parameters**

- `apiKey`: API key provided by Incode. May be empty or `null` when authenticating with a session `token` instead — see [Token-based Setup](/sdk-reference/cordova-token-based-setup/) and [`sessionConfig.token`](#sessionconfig).
- `apiUrl`: API base URL provided by Incode.

**Optional parameters**

- `loggingEnabled`: Enable SDK logging. String `"true"` or `"false"`. Default is `"true"`.
- `testMode`: Simulator or emulator mode. Set `"true"` on simulators and emulators. String `"true"` or `"false"`. Default is `"false"`.
- `clientExperimentId`: Enroll in experimental features, for example, UXv2 (`"experimentV2"`). String or `null`. Default is `null`.
- `e2eeUrl`: E2EE endpoint URL. Required if `e2eEncryptionEnabled` is used in any session. String or `null`. Default is `null`.
- `sslPinningConfig`: Object `enabled: boolean, forceSSLPinning: boolean`. `enabled` turns on SSL pinning. `forceSSLPinning` controls what happens when a pinning check fails: when `true`, the connection is dropped; when `false`, network traffic continues even after a failed pinning check. Default is `enabled: false, forceSSLPinning: false`.
- `sdkMode`: SDK operating mode at initialization. `"standard"`, `"captureOnly"`, or `"submitOnly"`. Default is `"standard"`. Can also be changed later via [`setSdkMode()`](#setsdkmode).
- `externalAnalyticsEnabled`: Enable external analytics. String `"true"` or `"false"`. Default is `"true"`.
- `externalScreenshotsEnabled`: Allow external screenshots. String `"true"` or `"false"`. Default is `"true"`.
- `sendDiagnosticsData`: Enables or disables sending of SDK diagnostics to Incode. String `"true"` or `"false"`. **iOS only** — accepted but ignored on Android. Default is `"true"`.
- `appleWalletMerchantID`: Apple Wallet merchant ID. When set, the Dashboard-configured Apple Wallet ID verification option becomes available in the ID Scan chooser. Must be set at initialization, before onboarding starts. String or `null`. **iOS only**; accepted but ignored on Android. Default is `null`, which leaves the option off.

**Callbacks**

- **Success:** SDK initialized. No structured payload.
- **Error:** string `"<code>: <message>"`. Codes: `simulatorDetected`, `testModeEnabled`, `invalidInitParams`, `configError`, `unknown`. See [Results — initializeSDK()](/sdk-reference/cordova-results/#initializesdk).

**Example**

```javascript
cordova.exec(
  function () { console.log("Initialized"); },
  function (err) {
    // err is "<code>: <message>" — match on code prefix if needed
    if (typeof err === "string" && err.indexOf("configError") === 0) {
      console.log("Invalid initialize config:", err);
    } else {
      console.log("Init error:", err);
    }
  },
  "Cplugin",
  "initializeSDK",
  [
    "YOUR_API_KEY",
    "https://your.api.url",
    "true",
    "false",
    null,
    null,
    { enabled: false, forceSSLPinning: false },
    "standard",
    "false",
    "false",
    "true"
  ]
);
```

_On iOS, calling `initializeSDK()` more than once per app lifecycle is a no-op. See [Known Issues](/sdk-reference/cordova-known-issues/)._

### isInitialized()

Returns whether the native SDK is fully initialized.

**Signature**

```javascript
isInitialized(successCallback, errorCallback)
```

**Parameters**

- None.

**Callbacks**

- **Success:** boolean. `true` if initialized, `false` otherwise.

**Example**

```javascript
cordova.exec(
  function (initialized) { console.log("Initialized:", initialized); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "isInitialized",
  []
);
```

### showCloseButton()

Shows or hides the close and cancel button during onboarding flows.

**Signature**

```javascript
showCloseButton(successCallback, errorCallback, allowUserToCancel)
```

**Optional parameters**

- `allowUserToCancel`: `"true"` shows the button, `"false"` hides it. String. Default is `"false"`.

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "showCloseButton", ["true"]);
```

### setSdkMode()

Switches the SDK operating mode at runtime without reinitializing.

**Signature**

```javascript
setSdkMode(successCallback, errorCallback, sdkMode)
```

**Required parameters**

- `sdkMode`: `"standard"`, `"captureOnly"`, or `"submitOnly"`. `"captureOnly"` works offline and captures ID and selfie images without validations. `"submitOnly"` submits previously captured data without new captures.

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "setSdkMode", ["captureOnly"]);
```

## Customization


### setTheme()

Applies a custom theme. Accepts a JSON string in the V2 cross-platform format or the V1 iOS-legacy format. Call before starting any section or flow.

**Signature**

```javascript
setTheme(successCallback, errorCallback, theme)
```

**Required parameters**

- `theme`: The theme JSON string. See [Customization — setTheme()](/sdk-reference/cordova-customization/#settheme).

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "setTheme", [jsonThemeString]);
```

### setUXConfig()

Sets UX configuration at runtime.

**Signature**

```javascript
setUXConfig(successCallback, errorCallback, jsonConfig)
```

**Required parameters**

- `jsonConfig`: UX configuration JSON string, for example `{ "showFooter": false }`. See [Customization — setUXConfig](/sdk-reference/cordova-customization/#setuxconfig).

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "setUXConfig", [JSON.stringify({ showFooter: false })]);
```

### setLocalizationLanguage()

Sets the UI language at runtime.

**Signature**

```javascript
setLocalizationLanguage(successCallback, errorCallback, language)
```

**Required parameters**

- `language`: `"en"`, `"es"`, `"pt"`, or `"he"`.

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "setLocalizationLanguage", ["es"]);
```

### setString()

Overrides individual UI strings with custom copy, keyed by the current locale.

**Signature**

```javascript
setString(successCallback, errorCallback, strings)
```

**Required parameters**

- `strings`: Map of platform-specific locale keys to custom strings. Object. See [Customization — setString()](/sdk-reference/cordova-customization/#setstring).

**Example**

```javascript
cordova.exec(
  function () {}, function (err) {},
  "Cplugin", "setString",
  [{ "incdOnboarding.userInformation.email.title": "Your email" }]
);
```

### setQuantityStrings()

Overrides the SDK's pluralized (quantity) strings. These are strings that change depending on a count — for example "1 attempt remaining" versus "3 attempts remaining". Call it after `initializeSDK()` and before starting onboarding.

:::info
**Android only**
  `setQuantityStrings()` has no effect on iOS.
:::

**Signature**

```javascript
setQuantityStrings(successCallback, errorCallback, locale, quantityStrings)
```

**Required parameters**

- `locale`: A BCP 47 language tag such as `"en"`, `"es"`, or `"en-US"`.
- `quantityStrings`: Single nested object shaped as `plural name → quantity keyword → value`:
  - **Plural name** — the SDK string resource key to override (for example, `"onboard_sdk_validation_attempts_remaining"`).
  - **Quantity keyword** — one of `"zero"`, `"one"`, `"two"`, `"few"`, `"many"`, or `"other"` (matched case-insensitively). Provide the forms that apply to the target language; `"other"` is the required fallback.
  - **Value** — the localized string. Use `%d` as the placeholder for the count.

**Error callback**

The error callback receives a JSON object (not a string):

```javascript
{
  code: string,       // for example, "configError"
  message: string,
  cause: {            // null when no underlying throwable
    type: string,     // Java exception class name
    message: string | null,
    stackTrace: string
  } | null
}
```

Use optional chaining when reading cause fields (`error.cause?.type`). Missing `locale` or `quantityStrings` returns `code: "configError"` with `cause: null`.

**Example**

```javascript
const quantityStrings = {
  "onboard_sdk_validation_attempts_remaining": {
    "one": "%d attempt remaining",
    "other": "%d attempts remaining"
  }
};
cordova.exec(
  function(result) {
    console.log("setQuantityStrings Success");
  },
  function(error) {
    console.log("setQuantityStrings Error:", error.code, error.message, error.cause?.type);
  },
  "Cplugin",
  "setQuantityStrings",
  ["en", quantityStrings]
);
```

### setFaceAuthenticationHint()

Provides an identity hint to speed up face authentication by indicating which identity is expected.

**Signature**

```javascript
setFaceAuthenticationHint(successCallback, errorCallback, identityId)
```

**Required parameters**

- `identityId`: Identity id used as the face authentication hint.

**Example**

```javascript
cordova.exec(function () {}, function (err) {}, "Cplugin", "setFaceAuthenticationHint", ["customer@example.com"]);
```

### setLogo()

Sets a custom logo for the SDK screens. The logo shows on every UX V2 screen, such as the `addFaceAuthentication` screens, and on the V1 screens. Call it after `initializeSDK()` and before you start a flow.

**Signature**

```javascript
setLogo(successCallback, errorCallback, logo)
```

**Required parameters**

- `logo`: Name of an image of your app. Use the same name on both platforms.
  - Android: A drawable resource name (`res/drawable/<name>`). On V2 screens, use a vector drawable or a raster image (PNG, JPG, or WebP). V2 screens do not support other XML drawables such as `layer-list`, `selector`, or `shape`. On V1 screens, the logo requires the `com.incode.sdk:extensions` dependency, which the plugin includes.
  - iOS: An image asset name from your asset catalog or main bundle.

**Callbacks**

- `successCallback`: Receives `"success"`.
- `errorCallback`: Receives `"appearanceError: <message>"` if `logo` is missing, or if the name does not match an image of your app. The SDK then keeps its current logo.

**Example**

```javascript
cordova.exec(
  function () { console.log("Logo set"); },
  function (err) { console.log("setLogo error:", err); },
  "Cplugin",
  "setLogo",
  ["logo"]
);
```

To add the image to your app, see [Customization — setLogo()](/sdk-reference/cordova-customization/#setlogo).

**Android: keep the drawable in release builds**

On Android, the logo is a drawable resource of your app. The SDK finds it by name at runtime, so no code refers to it. When resource shrinking is on (`shrinkResources true`), the Android shrinker removes the drawable from release builds. `setLogo()` then works in debug builds but fails with `appearanceError` in release builds. To keep the drawable, add it to `res/raw/keep.xml`:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/logo" />
```

## Session and Flow

### setupOnboardingSession()

Creates or resumes an onboarding session. Returns `interviewId` and `token`.

**Signature**

```javascript
setupOnboardingSession(successCallback, errorCallback, sessionConfig)
```

**Required parameters**

- `sessionConfig`: Session configuration. See [Shared types — sessionConfig](#sessionconfig).

**Callbacks**

- **Success:** `{ interviewId: string, token: string }`. On iOS the payload may also include `regionCode`.

**Example**

```javascript
var sessionConfig = {
  configurationId: "your-flow-id",
  externalId: "your-external-id",
  e2eEncryptionEnabled: false,
  region: "ALL"
};
cordova.exec(
  function (data) { console.log(data.interviewId, data.token); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setupOnboardingSession",
  [sessionConfig]
);
```

_Since 4.2.0, this method accepts a session config object, not a plain `configurationId` string._

### startOnboarding()

Creates a session and runs a complete, locally-defined flow end to end.

**Signature**

```javascript
startOnboarding(successCallback, errorCallback, sessionConfig, flowConfig, recordSessionConfig)
```

**Required parameters**

- `sessionConfig`: Session configuration. See [Shared types — sessionConfig](#sessionconfig).
- `flowConfig`: Array of module objects. See [Modules](/sdk-reference/cordova-modules/).

**Optional parameters**

- `recordSessionConfig`: Recording configuration. See [Shared types — recordSessionConfig](#recordsessionconfig). Object or `null`. Default is `null`.

**Callbacks**

- **Success:** aggregated module results. See [Results — startOnboarding()](/sdk-reference/cordova-results/#startonboarding).

**Example**

```javascript
cordova.exec(
  function (result) { console.log("Done:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startOnboarding",
  [
    { configurationId: "your-workflow-id" },
    [{ module: "addId" }, { module: "addSelfieScan" }, { module: "addFaceMatch" }],
    { recordSession: "false", forcePermissions: "false" }
  ]
);
```

### startOnboardingSection()

Runs one section of a previously set-up session. Can be called multiple times, one section at a time.

**Signature**

```javascript
startOnboardingSection(successCallback, errorCallback, flowConfig, recordSessionConfig, sectionTag)
```

**Required parameters**

- `flowConfig`: Array of module objects. See [Modules](/sdk-reference/cordova-modules/).
- `sectionTag`: Non-blank string echoed back in the result. Missing, null, blank, or non-string values fail with `configError`.

**Recording argument**

- `recordSessionConfig`: Optional recording configuration. See [Shared types - recordSessionConfig](#recordsessionconfig). Pass an object or `null` in this position before `sectionTag`.

**Callbacks**

- **Success:** `{ status, sectionTag, ...moduleResults }`. See [Results — startOnboardingSection()](/sdk-reference/cordova-results/#startonboardingsection).
- **Start-up error:** `{ code, message, cause }`. `cause` is `null` or an object with `type` and `message`. Android also includes `stackTrace`.
- **Error after start:** Typed string, including `"userCancelled"`. See [Results - startOnboardingSection()](/sdk-reference/cordova-results/#startonboardingsection).

| Start-Up Code | Meaning |
|---|---|
| `activityNotPresent` | No host Activity or presenting view controller. |
| `unknownModule` | The module list contains an unknown module name. |
| `configError` | Invalid module configuration, invalid `sectionTag`, or a non-object `recordSessionConfig`. |
| `sectionAlreadyRunning` | Another section runs. Its callback and results remain unchanged. |
| `noActiveSession` | No onboarding session is available (Android pre-start check). iOS reports this through the section's error string. |
| `unknown` | The SDK could not start the section. |

Call `setupOnboardingSession()` before the first section. Wait for each section's callback before starting another section.

**Example**

```javascript
cordova.exec(
  function (result) { console.log(result.status, result.sectionTag); },
  function (err) { console.log("Error:", typeof err === "string" ? err : err.code); },
  "Cplugin",
  "startOnboardingSection",
  [[{ module: "addId" }], { recordSession: false, forcePermission: false }, "section-001"]
);
```

### startFlow()

Starts a session based on a `configurationId`, optionally resuming it from a specific module.

**Signature**

```javascript
startFlow(successCallback, errorCallback, sessionConfig, moduleId)
```

**Required parameters**

- `sessionConfig`: Session configuration. `configurationId` or `token` is required. See [Shared types — sessionConfig](#sessionconfig).

**Optional parameters**

- `moduleId`: Case-sensitive module identifier to start from, for example `"EMAIL"` or `"PHONE"`. Omit to start from the first module. It is applied only when `sessionConfig.interviewId` is also provided. An unknown value starts from the first module.

**Errors**

When the flow cannot start, the error callback receives `{ code, message, cause }`: `activityNotPresent` without a presenting view controller (iOS) or Activity (Android), `configError` when `sessionConfig` has neither a `configurationId` nor a `token`, and `unknown` otherwise. Errors after the flow has started are reported as for `startOnboarding()`.

**Example**

```javascript
cordova.exec(
  function (winParam) { console.log("Result:", winParam); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startFlow",
  [{ configurationId: "your-flow-id", interviewId: "interview-id" }, "EMAIL"]
);
```

#### Valid `moduleId` values

`moduleId` values correspond to the module identifier rather than the local `flowConfig` module name. Use these case-sensitive values when calling `startFlow()`:

| Module | Android `moduleId` | iOS `moduleId` |
|---|---|---|
| Phone | `PHONE` | `PHONE` |
| DocumentScan | `DOCUMENT_CAPTURE` | `DOCUMENT_CAPTURE` |
| Geolocation | `GEOLOCATION` | `GEOLOCATION` |
| UserConsent | `USER_CONSENT` | `USER_CONSENT` |
| CombinedConsent | `COMBINED_CONSENT` | `combinedConsents` |
| Signature | `SIGNATURE` | `SIGNATURE` |
| VideoSelfie | `VIDEO_ONBOARDING` | `VIDEO_ONBOARDING` |
| IdScan | `ID` | `ID` |
| IdScanFront | `ID_CAPTURE` | Not available |
| IdScanBack | `BACK_ID` | Not available |
| ProcessId | `PROCESS_ID` | `processId` |
| Conference | `CONFERENCE` | `CONFERENCE` |
| SelfieScan | `SELFIE` | `SELFIE` |
| FaceMatch | `FACE_MATCH` | `FACE_MATCH` |
| QrScan | `QR_SCAN` | `qrScan` |
| Captcha | `OTP` | `OTP` |
| Email | `EMAIL` | `EMAIL` |
| Approve | `USER_APPROVAL` | `userApproval` |
| UserScore | `SHOW_RESULTS` | `SHOW_RESULTS` |
| MLConsent | `ML_CONSENT` | `ML_CONSENT` |
| GovernmentValidation | `GOVT_VALIDATION` | `GOVT_VALIDATION` |
| Antifraud | `ANTIFRAUD` | `ANTIFRAUD` |
| CustomWatchlist | `INCODE_WATCHLIST` | `INCODE_WATCHLIST` |
| GlobalWatchlist | `WATCHLIST` | `WATCHLIST` |
| Aes | `AE_SIGNATURE` | `AES` |
| Name | `NAME_CAPTURE` | `NAME_CAPTURE` |
| CURP | `CURP_VALIDATION` | `CURP_VALIDATION` |
| OCREdit | `EDITABLE_OCR` | Not available |
| eKYB | `EKYB` | `EKYB` |
| eKYC | `EKYC` | `EKYC` |
| NFCScan | `NFC_SCAN` | `nfcScan` |
| FaceAuthentication | `LOGIN` | `AUTHENTICATION` |

`ACCEPT_VIDEO_SELFIE` is an Android local-only identifier and is not valid as a `startFlow()` `moduleId`.

### startWorkflow()

Starts a workflow defined in Dashboard, end to end.

**Signature**

```javascript
startWorkflow(successCallback, errorCallback, sessionConfig)
```

**Required parameters**

- `sessionConfig`: Session configuration. `configurationId` or `token` is required. See [Shared types — sessionConfig](#sessionconfig).

**Errors**

The error callback receives `{ code, message, cause }`.

`sessionConfig` must include a non-empty `configurationId` or `token`. Otherwise, `startWorkflow()` fails with `configError` before the Workflow starts, without making any network requests. An `interviewId` alone is not enough. 

For all error codes, see [Results — startWorkflow()](/sdk-reference/cordova-results/#startworkflow).

**Example**

```javascript
cordova.exec(
  function (result) { console.log("Result:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startWorkflow",
  [{ configurationId: "your-workflow-id", region: "ALL" }]
);
```

## Results and Finalization

### getUserScore()

Fetches identity verification scores and results.

**Signature**

```javascript
getUserScore(successCallback, errorCallback, fetchMode, interviewId)
```

**Optional parameters**

- `fetchMode`: `"fast"` or `"accurate"`, case-insensitive. Controls the trade-off between speed and accuracy of the returned score. Default is `"accurate"`; unrecognized values also fall back to `"accurate"`.
- `interviewId`: Session to fetch the score for. Omit to target the current session. String or `null`. Default is `null`.

**Callbacks**

- **Success:** Score payload. See [Results — getUserScore()](/sdk-reference/cordova-results/#getuserscore).
- **Error:** Typed string—`userScoreFailed`, `userCancelled`. See [Results — Error Reference](/sdk-reference/cordova-results/#getuserscore-errors-typed-strings).

**Example**

```javascript
cordova.exec(
  function (result) {
    console.log("Score:", JSON.stringify(result));
  },
  function (error) {
    console.log("Error:", error);
  },
  "Cplugin",
  "getUserScore",
  ["accurate"]
);
```

### faceMatch()

Performs a server-side face match without UI.

**Signature**

```javascript
faceMatch(successCallback, errorCallback, matchType, interviewId, idCategory)
```

**Optional Parameters**

- `matchType`: Which sources are compared—`"idSelfie"`, `"nfcSelfie"`, or `"nfc3Way"`. Omit to use the native SDK default.
- `interviewId`: Identifier of the session to run the match against. Defaults to the current session's interview.
- `idCategory`: Which scanned ID to use—`"primary"` or `"secondary"`. Default is `"primary"`.

**Callbacks**

- **Success:** The face match result, flat and identical on both platforms. See [Results — faceMatch()](/sdk-reference/cordova-results/#facematch). Fields are only present when the native SDK actually produced a value.
- **Error:** An object `{ code, message, cause }`, where `message` carries the native detail. `cause` is always present and carries the underlying native exception's description on Android, or `null` on iOS.

| code | Meaning | Platforms |
|--------|---------|-----------|
| `faceMatchError` | Any native failure. | Both |
| `userCancelled` | The user dismissed the operation. | Android only. The native iOS SDK has no distinct cancellation signal, so a cancellation there is reported as `faceMatchError`. |
| `methodNotSupportedByBridge` | The installed native bridge has no handler for this method. The plugin's native dependency is older than its JS layer. | Android only |
| `bridgeFailure` | The native call threw before producing a result. | Android only |

Treat `userCancelled` as an optional refinement of `faceMatchError`, not a separate branch you must guard by platform. Handling both unconditionally works everywhere; the `userCancelled` check simply never matches on iOS.

**Example**

```javascript
cordova.exec(
  function (res) {
    console.log("Matched:", res.isFaceMatched, "confidence:", res.confidence);
  },
  function (err) {
    if (err.code === "userCancelled") return;
    console.log("Face match failed:", err.message);
  },
  "Cplugin",
  "faceMatch",
  ["idSelfie", null, "primary"]
);
```

### finishOnboarding()

Finalizes the session. Call exactly once after all sections or modules complete successfully.

**Signature**

```javascript
finishOnboarding(successCallback, errorCallback)
```

**Parameters**

- None.

**Example**

```javascript
cordova.exec(
  function () { console.log("Finished"); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "finishOnboarding",
  []
);
```

### startFaceLogin()

Authenticates an enrolled user via face login.

**Signature**

```javascript
startFaceLogin(successCallback, errorCallback, sessionConfig)
```

**Optional parameters**

- `sessionConfig`: Enables E2EE in face login on Android (no effect on iOS). Object or `null`. Default is `null`.

**Callbacks**

- **Success:** face login result object. See [Results — startFaceLogin()](/sdk-reference/cordova-results/#startfacelogin).
- **Error:** platform-specific string from the native SDK. See [Results — startFaceLogin()](/sdk-reference/cordova-results/#startfacelogin).

**Example**

```javascript
cordova.exec(
  function (result) { console.log("Face login success:", result); },
  function (error) { console.log("Face login error:", error); },
  "Cplugin",
  "startFaceLogin",
  [{}]
);
```

### deleteUserLocalData()

Deletes the SDK's local cached user data. Call after finishing all steps.

**Signature**

```javascript
deleteUserLocalData(successCallback, errorCallback)
```

**Parameters**

- None.

**Example**

```javascript
cordova.exec(
  function () { console.log("Local data deleted"); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "deleteUserLocalData",
  []
);
```

### approve()

Decides whether to approve the user, and adds approved users to the Incode database. This module has no UI on either platform. Run it after the modules the approval decision depends on.

**Signature**

```javascript
approve(successCallback, errorCallback, forceApproval)
```

**Optional parameters**

- `forceApproval`: Approves the user regardless of the onboarding score. Boolean. Defaults to `false`.

**Callbacks**

- **Success**: `{ success, uuid, customerToken, error }`. See [Results — approveData](/sdk-reference/cordova-results/#approvedata). A user who ran through approval but was not approved is a success with `success: false`, not an error.
- **Error**: `code`, using the codes below.

| Error code       | Platform     | Meaning                                                  |
| ---------------- | ------------ | -------------------------------------------------------- |
| `approvalError`  | Android      | The approval flow could not be configured.                |
| `userCancelled`  | Android, iOS | The user dismissed the section.                               |
| `sslPinningFailed` | Android, iOS | SSL pinning failure (MITM or bad certificate).           |
| `unknown`        | Android, iOS | Unexpected or unmapped error.                             |

**Example**

```javascript
cordova.exec(
  function (result) {
    console.log("Approved:", result.success, "uuid:", result.uuid);
  },
  function (error) {
    console.log("Error approve:", error);   // e.g. userCancelled
  },
  "Cplugin",
  "approve",
  [false]
);
```

## Event Handling

### flowListeners

The Cordova plugin does not expose a separate event-emitter or listener API. Flow events are delivered through the standard Cordova success and error callback pair passed to each API call. Internally, the native side implements `IncodeWelcome.OnboardingListener` and fires results through the corresponding callbacks.

#### How it works

```
startOnboardingSection(successCallback, errorCallback, flowConfig, ...)
       │
       ├─ Each module completes  ─► native listener accumulates results
       │
       ├─ Section finishes       ─► successCallback({ status, sectionTag, ...moduleResults })
       │
       ├─ Cannot start          ─► errorCallback({ code, message, cause })
       │
       └─ Error or user cancel   ─► errorCallback(typedErrorString)
```

#### Callback contract

| Event                          | Delivered via     | Payload                                                       |
| ------------------------------ | ----------------- | ------------------------------------------------------------- |
| Section completed              | `successCallback` | `{ status: "success", sectionTag: string, ...moduleResults }` |
| Section cannot start           | `errorCallback`   | `{ code, message, cause }`. See [startOnboardingSection()](#startonboardingsection). |
| User canceled                 | `errorCallback`   | `"userCancelled"` on both platforms.                         |
| Flow interrupted by the system | `errorCallback`  | `"interrupted"`                                               |
| Permissions denied             | `errorCallback`   | `"permissionsDenied"`                                         |
| Video Selfie not completed     | `errorCallback`   | `"videoSelfieNotCompleted"`                                   |
| Face authentication failed     | `errorCallback`   | `"faceAuthenticationFailed"`                                  |
| SSL pinning failed             | `errorCallback`   | `"sslPinningFailed"`                                           |
| Storage unavailable            | `errorCallback`   | `"storageUnavailable"` (Android)                              |
| Location unavailable           | `errorCallback`   | `"locationUnavailable"`                                       |
| Integrity compromised          | `errorCallback`   | `"integrityCompromised"` (iOS)                                |
| CAPTCHA not verified           | `errorCallback`   | `"captchaNotVerified"` (iOS; Android: `"unknown"`)            |
| Biometric consent not given    | `errorCallback`   | `"biometricConsentNotGiven"`                                  |
| Biometric consent not received | `errorCallback`   | `"biometricConsentNotReceived"`                               |
| Section already running        | `errorCallback`   | Start-up object with `code: "sectionAlreadyRunning"` on both platforms. |
| No active session              | `errorCallback`   | `"noActiveSession"` (iOS)                                     |
| Insufficient disk space        | `errorCallback`   | `"insufficientDiskSpace"` (Android)                           |
| On-device processing not compatible | `errorCallback` | `"onDeviceProcessingNotCompatible"` (Android)              |
| Combined consents not received | `errorCallback`   | `"combinedConsentsNotReceived"` (iOS)                         |
| Unknown error                  | `errorCallback`   | `"unknown"`                                                   |

Detailed face-authentication failure reasons appear on [`faceAuthenticationData.error`](/sdk-reference/cordova-results/#faceauthenticationdata), not as the section `errorCallback` string. See [Results — startOnboardingSection()](/sdk-reference/cordova-results/#startonboardingsection) for the full list.

#### Module-level results

Each module that completes during a section contributes a key to the success payload. You do not need to register any additional listeners; all results are aggregated and returned in the single `successCallback`. See [Results — Module result objects](/sdk-reference/cordova-results/#module-result-objects) for the full list of keys and their shapes.

#### Example: listening for section completion

```javascript
cordova.exec(
  function (result) {
    console.log("Status:", result.status);           // "success"
    console.log("Tag:", result.sectionTag);
    console.log("ID front:", result.frontIdData);
    console.log("Selfie:", result.selfieData);
    console.log("Face match:", result.faceMatchData);
  },
  function (error) {
    switch (typeof error === "string" ? error : error.code) {
      case "permissionsDenied":
        // Prompt user to grant camera or location permissions.
        break;
      case "faceAuthenticationFailed":
        // Face authentication module failed.
        break;
      case "sslPinningFailed":
        // SSL pinning failure.
        break;
      case "userCancelled":
        // User cancelled the flow.
        break;
      case "interrupted":
        // The system ended the flow.
        break;
      default:
        console.log("Unhandled error:", error);
    }
  },
  "Cplugin",
  "startOnboardingSection",
  [flowConfig, recordSessionConfig, sectionTag]
);
```

---

- Path: `sdk-reference/cordova-common-implementation-patterns`
- URL: https://developer.incode.com/sdk-reference/cordova-common-implementation-patterns/
- Markdown: https://developer.incode.com/sdk-reference/cordova-common-implementation-patterns.md

# Common Implementation Patterns

This section describes the three most common ways to integrate the Incode Onboarding Cordova Plugin. The patterns differ in two ways: where the flow is defined (in your app code versus on the Incode Dashboard) and how much control your host application keeps while the flow runs.

This page explains each pattern and when to use it. Pick the one that fits your product, then follow its dedicated page for the full walkthrough.

## Where flows are defined

The three patterns split into two configuration models:

- **Configured locally.** You build a `flowConfig` array in code, adding the modules you want and the order they run in. Patterns 1 and 2 use this model. See [Modules](/sdk-reference/cordova-modules/) for the catalog of modules you can add and the per-module configuration parameters.
- **Configured online.** The flow is defined on the Incode Dashboard as a Workflow or a Flow. Your code references it by ID, so you can change the configuration on the dashboard without shipping a new app build. Pattern 3 uses this model.

## The three patterns

### 1. Configure flows locally and run end to end

Build a `flowConfig` in code, then hand the whole flow to the SDK with a single `startOnboarding()` call. The SDK runs every module in sequence and returns control to your app when the flow finishes.

Use this when you want the simplest integration and the SDK can own the full onboarding experience from start to finish.

Walkthrough: [Configure Flows Locally and Run End to End](/sdk-reference/cordova-configure-flows-locally-and-run-end-to-end/)

### 2. Configure flows locally and run step by step

Build the flow as one or more sections in code and run each section with `startOnboardingSection()`. Control returns to your host application between sections, so you can insert your own screens, run business logic, or branch the flow based on intermediate results before starting the next section.

Use this when you need to interleave your own UI or logic with the SDK modules, or split a long flow into discrete steps.

Walkthrough: [Configure Flows Locally and Run Step by Step](/sdk-reference/cordova-configure-flows-locally-and-run-step-by-step/)

### 3. Run flows configured online

Define the flow on the Incode Dashboard, then start it with `startWorkflow()` or `startFlow()`. The SDK pulls the modules and configuration from the dashboard, so you do not define a `flowConfig` locally.

Incode distinguishes between **Workflows** (governed by Conditions) and **Flows** (governed by the Rules Engine). `startWorkflow()` runs the former; `startFlow()` runs the latter. See the walkthrough for the distinction and when to use each.

Use this when you want to change the onboarding configuration from the dashboard without releasing a new app version.

Walkthrough: [Run Flows Configured Online](/sdk-reference/cordova-run-flows-configured-online/)

## Choosing a pattern

| If you want to...                                         | Use                                 | Entry point                        |
| --------------------------------------------------------- | ----------------------------------- | ---------------------------------- |
| Run a full flow with the least code                       | Configure locally, run end to end   | `startOnboarding()`                |
| Insert your own screens or logic between SDK steps        | Configure locally, run step by step | `startOnboardingSection()`         |
| Change the flow from the dashboard without an app release | Run flows configured online         | `startWorkflow()` or `startFlow()` |

All three patterns require that the SDK is initialized first. See [Installation](/sdk-reference/cordova-installation/) for the `initializeSDK()` call and its arguments.

## Sample app

A complete, runnable example covering all three patterns is available in the [CordovaSampleApp](https://github.com/Incode-Technologies-Example-Repos/CordovaSampleApp) repository. Clone it, add your Incode credentials, then build and run on a device. See the repository README for full setup instructions.

## Related pages

- [Modules](/sdk-reference/cordova-modules/): The module catalog for building a `flowConfig`.
- [Results](/sdk-reference/cordova-results/): The result and error objects returned when a flow finishes.
- [API Reference](/sdk-reference/cordova-api-reference/): Full signatures for every method mentioned on this page.

---

- Path: `sdk-reference/cordova-configure-flows-locally-and-run-end-to-end`
- URL: https://developer.incode.com/sdk-reference/cordova-configure-flows-locally-and-run-end-to-end/
- Markdown: https://developer.incode.com/sdk-reference/cordova-configure-flows-locally-and-run-end-to-end.md

# Configure Flows Locally and Run End to End

This pattern uses `startOnboarding()` to run a locally-defined flow from start to finish in a single call. The SDK creates the session, runs every module in the order you specify, and returns aggregated results when the flow finishes.

Use this pattern when you want the simplest integration and the SDK can own the full onboarding experience without your app intervening between modules.

## Prerequisite

The SDK must be initialized before you call `startOnboarding()`. See [Installation](/sdk-reference/cordova-installation/) for the `initializeSDK()` call and its arguments.

## Walkthrough

1. Define the session configuration and the list of modules to run. 
2. Optionally define session recording settings.
3. Call `startOnboarding()`.

```js
let sessionConfig = {
  configurationId: "your-workflow-id", // optional, applies dashboard settings
  region: "ALL",
  mergeSessionRecordings: false
};

let flowConfig = [
  { module: "Phone" },
  { module: "addId", showIdTypeChooser: "true", showTutorials: "true" },
  { module: "addDocumentScan", documentType: "ADDRESS_STATEMENT" },
  { module: "Geolocation", isSkippable: true },
  { module: "addSelfieScan", showTutorials: "true" },
  { module: "addFaceMatch" },
  { module: "addSignature" },
  { module: "addVideoSelfie" }
];

let recordSessionConfig = {
  recordSession: "false",
  forcePermissions: "false"
};

cordova.exec(
  function (result) {
    console.log("Onboarding completed:", result);
    // result contains the aggregated module results
  },
  function (error) {
    console.log("Onboarding error:", error);
  },
  "Cplugin",
  "startOnboarding",
  [sessionConfig, flowConfig, recordSessionConfig]
);
```

## Arguments

- `sessionConfig`: Session-level configuration. See [API Reference](/sdk-reference/cordova-api-reference/) for the full list of fields. `configurationId` is optional; when provided, the Dashboard-level session settings for that configuration are applied. Module execution order always comes from your local `flowConfig`.
- `flowConfig`: An array of module objects describing which modules to run and in what order. See [Modules](/sdk-reference/cordova-modules/) for every module and its parameters.
- `recordSessionConfig`: Optional session recording configuration.

## Results

The success callback receives an object containing the aggregated results of every module in the flow. The error callback receives a typed error string. See [Results](/sdk-reference/cordova-results/) for the full structure of the success payload and the list of possible error strings.

## Related Pages

- [Modules](/sdk-reference/cordova-modules/): Every module available in `flowConfig` and its parameters.
- [Results](/sdk-reference/cordova-results/): The structure of the success payload and the list of error strings.
- [API Reference](/sdk-reference/cordova-api-reference/): The full signature of `startOnboarding()` and every field on `sessionConfig` and `recordSessionConfig`.

---

- Path: `sdk-reference/cordova-configure-flows-locally-and-run-step-by-step`
- URL: https://developer.incode.com/sdk-reference/cordova-configure-flows-locally-and-run-step-by-step/
- Markdown: https://developer.incode.com/sdk-reference/cordova-configure-flows-locally-and-run-step-by-step.md

# Configure Flows Locally and Run Step by Step

This pattern breaks a locally-defined flow into sections your app runs one at a time. Control returns to your app between sections, so you can display your own intermediate UI, run business logic, or branch based on intermediate results before starting the next section.

Use this pattern when you need to interleave your own UI or logic with the SDK modules, or when you want to split a long flow into discrete steps.

## Prerequisite

The SDK must be initialized before you start a session. See [Installation](/sdk-reference/cordova-installation/) for the `initializeSDK()` call and its arguments.

## Lifecycle

The step-by-step pattern uses five methods, called in this order:

1. `setupOnboardingSession()`: Create the session. Returns an `interviewId` and `token`.
2. `startOnboardingSection()`: Run one section. This method can be called multiple times; each method runs only one section at a time. Wait for each section's callback before starting the next.
3. `getUserScore()`: Fetch verification scores and results. Skip if you don't need scores, or if you use the inline `userScore` module in a section.
4. `finishOnboarding()`: Finalize the session. Call exactly once, after all sections succeed.
5. `deleteUserLocalData()`: Clear local cache. Skip if you don't need local cleanup.



## Walkthrough

### Step 1: Set Up the Session

```js
let sessionConfig = {
  configurationId: "your-flow-id",   // optional
  externalId: "your-external-id",    // optional
  e2eEncryptionEnabled: false,       // optional
  region: "ALL"                      // optional
};
cordova.exec(
  function (data) {
    console.log("Session ready. interviewId:", data.interviewId, "token:", data.token);
    runFirstSection();
  },
  function (err) { console.log("setupOnboardingSession error:", err); },
  "Cplugin",
  "setupOnboardingSession",
  [sessionConfig]
);
```

### Step 2: Run a Section

Use real booleans in `recordSessionConfig` and the singular key `forcePermission`. Strings are ignored, so `recordSession: "true"` leaves recording disabled. `sectionTag` must be a non-blank string.

Wait for the section's callback before starting another section. A concurrent call fails with `sectionAlreadyRunning` and leaves the running section unchanged.

```js
function runFirstSection() {
  let flowConfig = [
    { module: "addId", showIdTypeChooser: "true" },
    { module: "addSelfieScan" },
    { module: "addFaceMatch", matchType: "idSelfie" }
  ];
  let recordSessionConfig = { recordSession: false, forcePermission: false };
  let sectionTag = "identity-section-001";
  cordova.exec(
    function (result) {
      console.log("Section status:", result.status);         
      console.log("Section tag:", result.sectionTag);
      console.log("Front ID:", result.frontIdData);
      console.log("Face match:", result.faceMatchData);
      // Call startOnboardingSection again for the next section,
      // or proceed to finishing the session.
      finishSession();
    },
    function (error) {
      const code = typeof error === "string" ? error : error.code;
      console.log("Section error:", code, error);
    },
    "Cplugin",
    "startOnboardingSection",
    [flowConfig, recordSessionConfig, sectionTag]
  );
}
```

Start-up errors return `{ code, message, cause }`. Errors after the section starts remain strings. See the [API Reference](/sdk-reference/cordova-api-reference/#startonboardingsection).

### Step 3: Fetch the User Score (Optional)

```js
function fetchScore() {
  cordova.exec(
    function (result) {
      console.log("Score:", JSON.stringify(result));
      cleanup();
    },
    function (error) {
      console.log("getUserScore error:", error);
    },
    "Cplugin",
    "getUserScore",
    ["fast"] // "fast" | "accurate"
  );
}
```

### Step 4: Finish the Session

```js
function finishSession() {
  cordova.exec(
    function () {
      console.log("Onboarding finished");
      fetchScore(); // optional, only if you need scores
    },
    function (err) { console.log("finishOnboarding error:", err); },
    "Cplugin",
    "finishOnboarding",
    []
  );
}
```

### Step 5: Delete Local Data (Optional)

```js
function cleanup() {
  cordova.exec(
    function () { console.log("Local data deleted"); },
    function (err) { console.log("deleteUserLocalData error:", err); },
    "Cplugin",
    "deleteUserLocalData",
    []
  );
}
```

## Notes

- You can start multiple sections, but only one at a time. Wait for each section's callback before starting the next.
- Section result payloads vary depending on which modules ran in the section. See [Results](/sdk-reference/cordova-results/) for the full structure.

## Related Pages

- [Modules](/sdk-reference/cordova-modules/): Every module available in `flowConfig` and its parameters.
- [Results](/sdk-reference/cordova-results/): The structure of section results and the list of error strings.
- [API Reference](/sdk-reference/cordova-api-reference/): The full signatures of `setupOnboardingSession()`, `startOnboardingSection()`, `finishOnboarding()`, `getUserScore()`, and `deleteUserLocalData()`.

---

- Path: `sdk-reference/cordova-customization`
- URL: https://developer.incode.com/sdk-reference/cordova-customization/
- Markdown: https://developer.incode.com/sdk-reference/cordova-customization.md

# Customization

The Incode Onboarding Cordova Plugin exposes several APIs for customizing the UI: theming, string overrides, localization, UX options, and asset replacement. This page documents each customization API.

## V1 and V2 screens

The plugin has two generations of UI:

- **V2 screens** are the redesigned, cross-platform UX used on Android and iOS. Opt into V2 by passing `"experimentV2"` as the `clientExperimentId` parameter to `initializeSDK()`.
- **V1 screens** are the legacy UX. If `clientExperimentId` is not set to `"experimentV2"`, iOS and Android use V1.

`setTheme()` supports both formats. Some options (like `setUXConfig()`'s `showFooter`) apply only to V2 screens. Each method section below notes V1 or V2 applicability where relevant.

The Cordova plugin passes customization JSON directly to the native SDKs; there is no separate API for selecting between V1 and V2 customization schemas.


## setTheme()

`setTheme()` accepts a JSON string describing the theme. Two formats are supported:

- **V2** (cross-platform, current). Recommended for new integrations.
- **V1** (legacy only).

Call `setTheme()` before starting any onboarding section or flow.

```javascript
cordova.exec(
  function () { console.log("Theme applied"); },
  function (err) { console.log("setTheme error:", err); },
  "Cplugin",
  "setTheme",
  [jsonThemeString]
);
```

### V2 theme

The V2 theme is composed of `displayMode`, `typography`, `colorPalette`, and `components.buttons`.

```json
{
  "displayMode": "light",
  "typography": {
    "family": {
      "text": {
        "android": {
          "regular": "onboard_sdk_dm_sans_regular",
          "bold": "onboard_sdk_dm_sans_bold",
          "medium": "onboard_sdk_dm_sans_medium"
        },
        "ios": {
          "regular": "DMSans-Regular",
          "bold": "DMSans-Bold",
          "medium": "DMSans-Medium"
        }
      },
      "display": {
        "android": {
          "regular": "onboard_sdk_dm_sans_regular",
          "bold": "onboard_sdk_dm_sans_bold",
          "medium": "onboard_sdk_dm_sans_medium"
        },
        "ios": {
          "extraBold": "DMSans-ExtraBold"
        }
      }
    },
    "letterSpacing": {
      "none": 0,
      "medium": -0.5,
      "large": -1.0,
      "extraLarge": -1.5
    }
  },
  "colorPalette": {
    "neutralLight": "#ffffff",
    "neutralDark": "#000000",
    "brand50": "#e5f0ff",
    "brand200": "#99c3ff",
    "brand300": "#66a6ff",
    "brand400": "#3388ff",
    "brand500": "#006aff",
    "brand600": "#0055cc",
    "brand900": "#21273b",
    "gray50": "#FCFCFD",
    "gray100": "#EBECEF",
    "gray200": "#C6C8D2",
    "gray300": "#A3A8B8",
    "gray500": "#60667C",
    "gray700": "#3A3E4B",
    "gray800": "#262831",
    "gray900": "#14151A",
    "brandSecondary50": "#F2E2FE",
    "brandSecondary500": "#820AD1",
    "negative50": "#FFF0F0",
    "negative500": "#FF5A5F",
    "negative600": "#E71111",
    "negative950": "#240001",
    "warning50": "#FFF7EB",
    "warning400": "#FFB647",
    "warning500": "#FF9900",
    "warning950": "#523100",
    "positive50": "#E4FBF0",
    "positive600": "#189F60",
    "positive750": "#0C5030"
  }
}
```

#### displayMode

| Key           | Values                | Description        |
| ------------- | --------------------- | ------------------ |
| `displayMode` | `"light"` or `"dark"` | Base display mode. |

#### typography

| Key                      | Description                                                              |
| ------------------------ | ------------------------------------------------------------------------ |
| `family.text.android`    | Android font resource names for body text: `regular`, `bold`, `medium`. |
| `family.text.ios`        | iOS font names for body text: `regular`, `bold`, `medium`.              |
| `family.display.android` | Android font resource names for display and headline text.               |
| `family.display.ios`     | iOS font names for display and headline text: for example, `extraBold`. |
| `letterSpacing`          | Letter-spacing tokens: `none`, `medium`, `large`, `extraLarge`.          |

#### colorPalette

| Key group          | Keys                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------- |
| Neutral            | `neutralLight`, `neutralDark`                                                         |
| Brand              | `brand50`, `brand200`, `brand300`, `brand400`, `brand500`, `brand600`, `brand900`     |
| Gray               | `gray50`, `gray100`, `gray150`, `gray200`, `gray250`, `gray300`, `gray500`, `gray600`, `gray700`, `gray750`, `gray800`, `gray900` |
| Brand secondary    | `brandSecondary50`, `brandSecondary500`                                               |
| Negative (errors)  | `negative50`, `negative500`, `negative600`, `negative950`                             |
| Warning            | `warning50`, `warning400`, `warning500`, `warning950`                                 |
| Positive (success) | `positive50`, `positive600`, `positive750`, `positive950`                              |

#### components.buttons

Each entry in `components.buttons` targets a button style (`"primary"`, `"secondary"`, `"text"`) and lets you override surface color, text color, and border per state.

```json
{
  "components": {
    "buttons": [
      {
        "style": "primary",
        "surface": {
          "default": "#006aff",
          "hover": "#3388ff",
          "pressed": "#0055cc",
          "disabled": "#C6C8D2"
        },
        "text": {
          "default": "#ffffff",
          "disabled": "#A3A8B8"
        },
        "border": {
          "color": {
            "default": "#006aff",
            "hover": "#3388ff",
            "pressed": "#0055cc",
            "disabled": "#C6C8D2"
          },
          "width": 0,
          "radius": 200
        }
      }
    ]
  }
}
```



| Field                   | Description                                                          |
| ----------------------- | -------------------------------------------------------------------- |
| `style`                 | Which button type to style: `"primary"`, `"secondary"`, or `"text"`. |
| `surface.default`       | Background color in the default state. Accepts a single hex color or, to separate light and dark mode colors, an array of two hex colors: `["#lightHex", "#darkHex"]`.                                |
| `surface.hover`         | Background color on hover; primarily web and desktop.               |
| `surface.pressed`       | Background color when pressed or tapped.                             |
| `surface.disabled`      | Background color when the button is disabled.                        |
| `text.default`          | Label text color in the default state. Accepts a single hex color or, to separate light and dark mode colors, an array of two hex colors: `["#lightHex", "#darkHex"]`.                                 |
| `text.disabled`         | Label text color when disabled.                                      |
| `border.color.default`  | Border color in the default state.                                   |
| `border.color.hover`    | Border color on hover.                                               |
| `border.color.pressed`  | Border color when pressed.                                           |
| `border.color.disabled` | Border color when disabled.                                          |
| `border.width`          | Border width in points or dp; `0` for no border.                    |
| `border.radius`         | Corner radius in points or dp.                                       |

### V1 theme

The V1 theme applies only to legacy screens. It is composed of `colors`, `fonts`, `buttons`, `labels`, and `customComponents`.

```json
{
  "colors": {
    "accent": "#00B2FD",
    "primary": "#20263D",
    "background": "#FFFFFF",
    "secondaryBackground": "#E9E9EB",
    "success": "#0CD5A2",
    "error": "#FF5C6F",
    "warning": "#F3AB3C",
    "cancel": "#20263D"
  },
  "fonts": {
    "buttonBig": { "name": "CircularXXTT-Black", "size": "20" },
    "buttonMedium": { "name": "CircularXXTT-Black", "size": "16" },
    "buttonSmall": { "name": "CircularXXTT-Black", "size": "12" },
    "title": { "name": "CircularXXTT-Black", "size": "25" },
    "hugeTitle": { "name": "CircularXXTT-Black", "size": "40" },
    "subtitle": { "name": "CircularXXTT-Black", "size": "18" },
    "boldedSubtitle": { "name": "CircularXXTT-Bold", "size": "18" },
    "smallSubtitle": { "name": "CircularXXTT-Black", "size": "14" },
    "info": { "name": "CircularXXTT-Black", "size": "16" },
    "body": { "name": "CircularXXTT-Medium", "size": "14" },
    "boldedBody": { "name": "CircularXXTT-Bold", "size": "14" },
    "textFieldBig": { "name": "CircularXXTT-Black", "size": "20" },
    "textFieldMedium": { "name": "CircularXXTT-Black", "size": "15" }
  },
  "buttons": {
    "primary": {
      "states": {
        "normal": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#00B2FD",
          "borderColor": "",
          "borderWidth": 0,
          "cornerRadius": 32,
          "shadowColor": "#000000",
          "shadowOffset": [0, 5],
          "shadowOpacity": 0.15,
          "shadowRadius": 9,
          "textColor": "#FFFFFF",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        },
        "highlighted": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#20263D",
          "borderColor": "",
          "borderWidth": 0,
          "cornerRadius": 32,
          "shadowColor": "#000000",
          "shadowOffset": [0, 5],
          "shadowOpacity": 0.15,
          "shadowRadius": 9,
          "textColor": "#00B2FD",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        },
        "disabled": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#E9E9EB",
          "borderColor": "",
          "borderWidth": 0,
          "cornerRadius": 32,
          "shadowColor": "#000000",
          "shadowOffset": [0, 5],
          "shadowOpacity": 0,
          "shadowRadius": 9,
          "textColor": "#FFFFFF",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        }
      },
      "big": {
        "height": 64,
        "minWidth": 200,
        "contentInsets": { "top": 19, "left": 32, "bottom": 19, "right": 32 },
        "kerning": 0
      },
      "medium": {
        "height": 46,
        "minWidth": 0,
        "contentInsets": { "top": 12, "left": 24, "bottom": 12, "right": 24 },
        "kerning": 0
      }
    },
    "secondary": {
      "states": {
        "normal": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#FFFFFF",
          "borderColor": "#20263D",
          "borderWidth": 1,
          "cornerRadius": 32,
          "shadowColor": "",
          "shadowOffset": [0, 0],
          "shadowOpacity": 0,
          "shadowRadius": 0,
          "textColor": "#20263D",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        },
        "highlighted": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#20263D",
          "borderColor": "#20263D",
          "borderWidth": 1,
          "cornerRadius": 32,
          "shadowColor": "",
          "shadowOffset": [0, 0],
          "shadowOpacity": 0,
          "shadowRadius": 0,
          "textColor": "#00B2FD",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        },
        "disabled": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#FFFFFF",
          "borderColor": "#E9E9EB",
          "borderWidth": 1,
          "cornerRadius": 32,
          "shadowColor": "",
          "shadowOffset": [0, 0],
          "shadowOpacity": 0,
          "shadowRadius": 0,
          "textColor": "#E9E9EB",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        }
      },
      "big": {
        "height": 64,
        "minWidth": 200,
        "contentInsets": { "top": 19, "left": 32, "bottom": 19, "right": 32 },
        "kerning": 0
      },
      "medium": {
        "height": 46,
        "minWidth": 0,
        "contentInsets": { "top": 12, "left": 24, "bottom": 12, "right": 24 },
        "kerning": 0
      }
    },
    "text": {
      "states": {
        "normal": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "",
          "borderColor": "",
          "borderWidth": 0,
          "cornerRadius": 0,
          "shadowColor": "",
          "shadowOffset": [0, 0],
          "shadowOpacity": 0,
          "shadowRadius": 0,
          "textColor": "#20263D",
          "transform": { "a": 1, "b": 0, "c": 0, "d": 1, "tx": 0, "ty": 0 }
        }
      },
      "big": {
        "height": 40,
        "minWidth": 200,
        "contentInsets": { "top": 8, "left": 16, "bottom": 8, "right": 16 },
        "kerning": 0
      },
      "medium": {
        "height": 30,
        "minWidth": 0,
        "contentInsets": { "top": 12, "left": 24, "bottom": 12, "right": 24 },
        "kerning": 0
      }
    },
    "help": {
      "states": {
        "normal": {
          "animateStateChange": true,
          "alpha": 1,
          "backgroundColor": "#00B2FD",
          "cornerRadius": 32,
          "textColor": "#FFFFFF"
        }
      },
      "big": {
        "height": 64,
        "minWidth": 200,
        "contentInsets": { "top": 19, "left": 32, "bottom": 19, "right": 32 },
        "kerning": 0
      }
    }
  },
  "labels": {
    "title": { "textColor": "#20263D", "kerning": 0 },
    "secondaryTitle": { "textColor": "#FFFFFF", "kerning": 0 },
    "subtitle": { "textColor": "#20263D", "kerning": 0 },
    "secondarySubtitle": { "textColor": "#FFFFFF", "kerning": 0 },
    "smallSubtitle": { "textColor": "#20263D", "kerning": 0 },
    "info": { "textColor": "#636670", "kerning": 0 },
    "secondaryInfo": { "textColor": "#FFFFFF", "kerning": 0 },
    "body": { "textColor": "#20263D", "kerning": 0 },
    "secondaryBody": { "textColor": "#FFFFFF", "kerning": 0 },
    "code": { "textColor": "#20263D", "kerning": 16 }
  },
  "customComponents": {
    "cameraFeedback": {
      "alpha": 0.8,
      "backgroundColor": "#000000",
      "cornerRadius": 20,
      "textBackgroundColor": "",
      "textColor": "#FFFFFF"
    },
    "idCaptureHelp": {
      "commonIssueLayoutOrientation": "horizontal"
    },
    "idSideLabel": {
      "alpha": 1,
      "backgroundColor": "#FFFFFF",
      "borderColor": "",
      "borderWidth": 0,
      "cornerRadius": 5
    },
    "separator": {
      "alpha": 1.0,
      "color": "#20263D",
      "cornerRadius": 0,
      "padding": 24,
      "thickness": 1
    },
    "signature": {
      "signatureColor": "#04BD19",
      "canvasBorderColor": "#EC03FC"
    },
    "idAutocaptureCountdown": {
      "backgroundColor": "#00B2FD",
      "numberColor": "#FFFFFF"
    }
  }
}
```

V1 theme sections:

| Section            | Description                                                                                                                           |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `colors`           | Semantic colors: `accent`, `primary`, `background`, `secondaryBackground`, `success`, `error`, `warning`, `cancel`.                   |
| `fonts`            | Per-role font name and size: buttons, titles, subtitles, body, info, text fields, and so on.                                          |
| `buttons`          | Per-type (`primary`, `secondary`, `text`, `help`) state styling (`normal`, `highlighted`, `disabled`) plus `big` and `medium` sizing. |
| `labels`           | Per-role text color and kerning.                                                                                                      |
| `customComponents` | Component-specific styling: `cameraFeedback`, `idCaptureHelp`, `idSideLabel`, `separator`, `signature`, `idAutocaptureCountdown`.     |

## setString()

Override individual UI strings with custom copy. `setString()` accepts an object mapping locale keys to custom strings. The key format is platform-specific and is defined by the underlying Android and iOS SDKs.

Refer to the native SDK customization documentation for the current keys:

- **Android:** [Android SDK customization](/sdk-reference/android-customization/)
- **iOS:** [iOS SDK customization](/sdk-reference/ios-customization/)

```javascript
let strings = {
  "someKey": "Your custom string"
  // ...more keys
};
cordova.exec(
  function () { console.log("Strings overridden"); },
  function (err) { console.log("setString error:", err); },
  "Cplugin",
  "setString",
  [strings]
);
```

String keys are overridden for the current locale.

## setLocalizationLanguage()

Change the UI language at runtime. Accepts a language code string.

| Code | Language   |
| ---- | ---------- |
| `en` | English    |
| `es` | Spanish    |
| `pt` | Portuguese |
| `he` | Hebrew     |

```javascript
cordova.exec(
  function () { console.log("Language set"); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setLocalizationLanguage",
  ["es"]
);
```

## setUXConfig()

Set UX configuration at runtime. Accepts a JSON string.

| Option       | Type    | Description                                                        |
| ------------ | ------- | ------------------------------------------------------------------ |
| `showFooter` | boolean | Show or hide the footer in V2 `addId` and `addSelfieScan` modules. |

```javascript
let jsonConfig = JSON.stringify({ showFooter: false });
cordova.exec(
  function () {},
  function (err) { console.log("setUXConfig error:", err); },
  "Cplugin",
  "setUXConfig",
  [jsonConfig]
);
```

## setFaceAuthenticationHint()

Provides an identity hint to speed up face authentication by indicating which identity is expected. Accepts an identity id string.

```javascript
cordova.exec(
  function () {},
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setFaceAuthenticationHint",
  ["customer@example.com"]
);
```

## showCloseButton()

Show or hide the close and cancel button during onboarding flows. Accepts a string: `"true"` shows the button, `"false"` hides it.

```javascript
cordova.exec(
  function () {},
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "showCloseButton",
  ["true"]
);
```

_`showCloseButton()` replaces `setCommonConfig()`, which was removed in 4.7.0._

## setLogo()

Shows your logo on the SDK screens. The logo shows on every V2 screen, such as the `addFaceAuthentication` screens, and on the V1 screens. Accepts the name of an image of your app: a drawable resource name on Android, and an image asset name on iOS. Use the same name on both platforms.

```javascript
cordova.exec(
  function () {},
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setLogo",
  ["logo"]
);
```

If the name does not match an image of your app, the error callback receives `"appearanceError: <message>"`. For the details, see `setLogo()` in the [API Reference](/sdk-reference/cordova-api-reference/#setlogo).

To add the image to the native projects, declare it with `resource-file` in your app's `config.xml`:

```xml
<platform name="android">
    <resource-file src="res/logo/logo.png" target="app/src/main/res/drawable/logo.png" />
    <resource-file src="res/logo/keep.xml" target="app/src/main/res/raw/keep.xml" />
</platform>
<platform name="ios">
    <resource-file src="res/logo/logo.png" />
</platform>
```

On Android, `keep.xml` keeps the drawable in release builds. The SDK finds the drawable by name at runtime, so without it the Android shrinker can remove the drawable:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/logo" />
```

## Asset instructions

### Custom fonts on Android

1. Place your font files (`.ttf` or `.otf`) in `res/font/` of the Android app.
2. Reference them by their resource name in the V2 theme `typography.family` block (for example, `"regular": "onboard_sdk_dm_sans_regular"`). The resource name must match the file name (without extension).

### Custom fonts on iOS

1. Add the font files to your iOS project (drag them in and ensure they are part of the app target's "Copy Bundle Resources").
2. Register them in `Info.plist` under the `UIAppFonts` (Fonts provided by application) array.
3. Reference them by their PostScript font name in the theme JSON (for example, `"regular": "DMSans-Regular"`).

### Custom icons and videos

Icon and video replacement is not handled by the Cordova plugin. Follow the native SDK asset customization instructions:

- **Android:** [Android SDK customization](/sdk-reference/android-customization/)
- **iOS:** [iOS SDK customization](/sdk-reference/ios-customization/)

---

- Path: `sdk-reference/cordova-delete-local-session-data`
- URL: https://developer.incode.com/sdk-reference/cordova-delete-local-session-data/
- Markdown: https://developer.incode.com/sdk-reference/cordova-delete-local-session-data.md

# Delete Local Session Data

Delete all local user data that was collected during onboarding from the device by calling `deleteUserLocalData()`.&#x20;
Use this method after onboarding completes to clear session data on the device, or when complying with data retention requirements.

## When to call `deleteUserLocalData()`

### End-to-end flows (`startOnboarding()`, `startFlow()`, `startWorkflow()`)

Call `deleteUserLocalData()` in the success or error callback of the final flow/section call, after the user has finished or abandoned the flow.

### Section-based flows (`startOnboardingSection()`)

Do not call `deleteUserLocalData()` before `finishOnboarding()` or between sections. Calling it too early prevents the onboarding session from completing. Call it only after `finishOnboarding()` succeeds.

### Example

```javascript
cordova.exec(
  function () { console.log("Local data deleted"); },
  function (err) { console.log("deleteUserLocalData error:", err); },
  "Cplugin",
  "deleteUserLocalData",
  []
);
```

There is no structured result payload, only success/failure via the standard Cordova callbacks. The success callback confirms deletion completed; the error callback fires if deletion fails.&#x20;

---

- Path: `sdk-reference/cordova-e2ee`
- URL: https://developer.incode.com/sdk-reference/cordova-e2ee/
- Markdown: https://developer.incode.com/sdk-reference/cordova-e2ee.md

# End-to-End Encryption (E2EE)

End-to-End Encryption (E2EE) adds a layer of security to communications between the client and Incode's servers by encrypting transmitted data. The client and server first exchange keys for encrypting and decrypting messages. After this exchange, all subsequent communications are encrypted, and only the intended server and client can decrypt them.

## Prerequisites

- A custom E2EE server URL provided by Incode.

## Enable End-to-End Encryption

End-to-End Encryption (E2EE) setup takes three steps: initialize the SDK with a custom server URL, enable E2EE on the session configuration, and pass the session configuration to the SDK.

### 1. Initialize the SDK with a custom E2EE server

Pass your `e2eeUrl` to the `initializeSDK()` method.

```javascript
cordova.exec(
  function () { console.log("SDK initialized"); },
  function (err) { console.log("Init error:", err); },
  "Cplugin",
  "initializeSDK",
  [
    "YOUR_API_KEY",              // apiKey
    "https://your.api.url",      // apiUrl
    "true",                      // loggingEnabled
    "false",                     // testMode
    null,                        // clientExperimentId
    "https://your.e2ee.url",     // e2eeUrl — required when using E2EE
    { enabled: false, forceSSLPinning: false } // sslPinningConfig
    // optional: "standard", "false", "false" — sdkMode, externalAnalyticsEnabled, externalScreenshotsEnabled
  ]
);
```

### 2. Enable E2EE on the session configuration

Set `e2eEncryptionEnabled` to `true` on your `sessionConfig`.

```javascript
var sessionConfig = {
  e2eEncryptionEnabled: true,
};
```

### 3. Pass the session configuration to the SDK

Pass the configured `sessionConfig` to either `setupOnboardingSession()` (for section-based flows):

```javascript
// Section-based
cordova.exec(
  function (data) { console.log("Session:", data.interviewId, data.token); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setupOnboardingSession",
  [sessionConfig]
);
```

or to `startOnboarding()` , `startFlow()`, or `startWorkflow()` (for end-to-end flows):

```javascript
// startOnboarding
cordova.exec(
  function (result) { console.log("Done:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startOnboarding",
  [sessionConfig, flowConfig, recordSessionConfig]
);

// startFlow — dashboard flow, optionally from a module
cordova.exec(
  function (result) { console.log("Done:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startFlow",
  [{ configurationId: "your-flow-id", e2eEncryptionEnabled: true }, "EMAIL"] // moduleId optional
);

// startWorkflow — dashboard workflow, end to end
cordova.exec(
  function (result) { console.log("Done:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startWorkflow",
  [{ configurationId: "your-workflow-id", e2eEncryptionEnabled: true }]
);
```

## End-to-End Encryption in Face Login

Face Login has its own End-to-End Encryption (E2EE) parameter, `e2eEncryptionEnabled`. E2EE is disabled by default for Face Login and supported on Android only. See [Face Login](/sdk-reference/cordova-face-login/) for details.

```javascript
cordova.exec(
  function (result) { console.log("Face login success:", result); },
  function (err) { console.log("Face login error:", err); },
  "Cplugin",
  "startFaceLogin",
  [{ e2eEncryptionEnabled: true }]
);
```

## Verify End-to-End Encryption is working

If End-to-End Encryption (E2EE) is enabled but not properly configured, the SDK returns an error. If E2EE is working, the SDK sends and receives requests to and from the E2EE server, and the requests themselves are encrypted. Check your logs to confirm.

Contact your Incode representative if you need help diagnosing an E2EE issue.

---

- Path: `sdk-reference/cordova-face-login`
- URL: https://developer.incode.com/sdk-reference/cordova-face-login/
- Markdown: https://developer.incode.com/sdk-reference/cordova-face-login.md

# Face Login

Face Login authenticates a user by performing a face match between a captured selfie and a previously enrolled face. Call `startFaceLogin()` to authenticate an enrolled user. The only argument is an optional `sessionConfig` object.

## Prerequisites

- The SDK is initialized. See [Installation](/sdk-reference/cordova-installation/).
- The user has an approved account with an enrolled face.

Enrollment happens as a byproduct of a standard onboarding flow that includes the `addFaceMatch` module. Alternatively, an admin can enroll a user by clicking **Add face to Database** in Dashboard.

## Start Face Login

```javascript
cordova.exec(
  function (result) { console.log(JSON.stringify(result)); },
  function (err) { console.log(err); },
  "Cplugin",
  "startFaceLogin",
  []  // or [{ e2eEncryptionEnabled: true }] on Android for E2EE
);
```

## FaceLoginResult

On **iOS**, the success callback receives a mapped object with these fields:

- `image`: object. Selfie image captured during login (`pngBase64`, and `encryptedBase64` when E2EE is enabled).
- `spoofAttempt`: bool. `true` indicates the user tried to spoof the system (using a photo, screen, or other method). `false` indicates a real person.
- `faceMatched`: bool. `true` if the faces matched, `false` otherwise.
- `customerUUID`: string or `null`. Unique user identifier if authentication succeeded. `null` if `faceMatched` is `false`.
- `interviewId`: string. Session ID in which the user was approved.
- `interviewToken`: string. Session token in which the user was approved.
- `token`: string. Token that can be used for further API calls.
- `transactionId`: string. Unique identifier of the Face Login attempt.
- `hasFaceMask`: bool. Indicator if the login attempt failed because the user was wearing a face mask.

On **Android**, the callback receives the native `SelfieScanResult` JSON (Gson). See [Results — startFaceLogin()](/sdk-reference/cordova-results/#startfacelogin).

## End-to-End Encryption (E2EE)

:::info
  End-to-End Encryption (E2EE) for Face Login is supported on Android only.
:::

By default, Face Login does not use E2EE. To enable it, set `e2eEncryptionEnabled` to `true`.

```javascript
// Android only; requires e2eeUrl in initializeSDK
cordova.exec(success, error, "Cplugin", "startFaceLogin", [
  { e2eEncryptionEnabled: true }
]);
```

See [End-to-End Encryption (E2EE)](/sdk-reference/cordova-e2ee/) for full E2EE setup.

---

- Path: `sdk-reference/cordova-getting-started`
- URL: https://developer.incode.com/sdk-reference/cordova-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/cordova-getting-started.md

# Getting Started

The Incode Onboarding Cordova Plugin lets your Cordova, Capacitor, or Ionic app run identity verification and onboarding flows on iOS and Android. This section walks you through installing the plugin, choosing an SDK mode, and picking an implementation pattern.

## Start here

1. **[Install the plugin](/sdk-reference/cordova-installation/)** and complete per-platform setup for Android and iOS.
2. **[Choose an SDK mode](/sdk-reference/cordova-sdk-modes/)** based on whether your app captures and validates online, or captures only. (Android only)
3. **[Choose an implementation pattern](/sdk-reference/cordova-common-implementation-patterns/)** based on whether your flows run locally or are configured from the Dashboard.

## Your first flow

After the SDK is installed and initialized, the minimal call to run an onboarding flow with `startOnboarding()` looks like this:

```javascript
cordova.exec(
  function (result) { console.log("Onboarding completed:", result); },
  function (error) { console.log("Onboarding error:", error); },
  "Cplugin",
  "startOnboarding",
  [
    { region: "ALL" },
    [{ module: "addId" }, { module: "addSelfieScan" }, { module: "addFaceMatch" }],
    { recordSession: "false" }
  ]
);
```

This captures an ID, takes a selfie, and matches the two. For the full argument breakdown and every available method, see the [API Reference](/sdk-reference/cordova-api-reference/).

## Optional and advanced setup

- **[End-to-End Encryption (E2EE)](/sdk-reference/cordova-e2ee/):** encrypt session data in transit between the SDK and Incode's backend.
- **[Token-based Setup](/sdk-reference/cordova-token-based-setup/):** initialize the SDK using a short-lived token instead of a long-lived API key.
- **[Delete Local Session Data](/sdk-reference/cordova-delete-local-session-data/):** clear session data stored on the device.
- **[Troubleshooting](/sdk-reference/cordova-troubleshooting/):** common install and build issues.

---

- Path: `sdk-reference/cordova-installation`
- URL: https://developer.incode.com/sdk-reference/cordova-installation/
- Markdown: https://developer.incode.com/sdk-reference/cordova-installation.md

# Installation

Install the Incode Onboarding Cordova Plugin and complete per-platform setup for Android and iOS.

## Prerequisites

- **Node.js** version 18 or later, for the Cordova CLI and your app.
- **Cordova CLI** version 11 or later. Install with `npm install -g cordova`.
- **Android Studio / SDK**: minSdk 23+, `compileSdk` 36, Android Gradle Plugin 8.9.1, Gradle 8.14.5, Kotlin 2.2.21, JDK 17 to run Gradle. Required for Android builds.
- **Xcode** with iOS 13 or later target. Required for iOS builds (macOS only).
- **Incode API credentials**: API key and base URL, provided by Incode.
- **GitHub personal access token** with `read:packages` scope, for Incode's Android Maven repository.

## Install the Plugin

```bash
cordova plugin add https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]
```

For the NFC variant (NFC-capable hardware required):

```bash
cordova plugin add "https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]-nfc"
```

The SDK uses the camera to capture ID and face, so add the camera plugin:

```bash
cordova plugin add cordova-plugin-camera
```

If you use the geolocation module, add the geolocation plugin as well:

```bash
cordova plugin add cordova-plugin-geolocation
```

Then add the platforms you target. Pin the platform versions confirmed compatible with the SDK rather than relying on defaults:

```bash
cordova platform add android@^14.0.1
cordova platform add ios@^7.1.1   # macOS only
```

## Android Setup

The Incode Android SDK requires a recent Android toolchain. Set these preferences in your app's `config.xml`:

```xml
<platform name="android">
    <preference name="android-compileSdkVersion" value="36" />
    <preference name="AndroidGradlePluginVersion" value="8.9.1" />
    <preference name="GradleVersion" value="8.14.5" />
    <preference name="GradlePluginKotlinEnabled" value="true" />
    <preference name="GradlePluginKotlinVersion" value="2.2.21" />
</platform>
```

The Kotlin plugin is required even in a pure-JavaScript Cordova app, because the plugin ships Kotlin sources. The preference key that `cordova-android` reads is `AndroidGradlePluginVersion`. If your `config.xml` uses `android-gradlePluginVersion`, it is silently ignored.

Android resolves the Incode native SDK from Incode's GitHub Maven package repository, which requires authentication. Modify your project's `build.gradle` to include the GitHub Packages repository with credentials provided by Incode.

The Maven repository that hosts the native dependency is:

```
https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages
```

Add a hook within the `config.xml` file inside `widget`, after your `platform` element. It will be triggered after platform is added:&#x20;

```xml
<hook type="after_platform_add" src="hooks/after_platform_add/add-incode-maven-repo.js" />
```

`add-incode-maven-repo.js` content that can be reused:

```javascript
#!/usr/bin/env node

const fs = require('fs');
const path = require('path');

const repoBlock = `maven {
    url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
     credentials {
        username = "incode-customers"
        password = project.findProperty("github_token") ?: System.getenv("GITHUB_TOKEN")
    }
}`;

function removeIncodeMavenBlocks(block) {
    let idx = 0;
    while (true) {
        const mavenIndex = block.indexOf('maven {', idx);
        if (mavenIndex === -1) break;
        // Only consider blocks containing the Incode repo URL
        const urlIdx = block.indexOf('repo.incode.com/artifactory/libs-incode-welcome', mavenIndex);
        if (urlIdx === -1) {
            idx = mavenIndex + 7;
            continue;
        }
        // Find the matching closing brace for maven { ... }
        let braceCount = 0;
        let endIdx = mavenIndex;
        let found = false;
        for (; endIdx < block.length; endIdx++) {
            if (block[endIdx] === '{') braceCount++;
            else if (block[endIdx] === '}') braceCount--;
            if (braceCount === 0 && endIdx > mavenIndex) {
                found = true;
                break;
            }
        }
        if (found) {
            block = block.slice(0, mavenIndex) + block.slice(endIdx + 1);
            idx = mavenIndex; // Continue searching after removed block
        } else {
            break; // Malformed, stop
        }
    }
    return block;
}

function insertRepoFirst(block) {
    block = removeIncodeMavenBlocks(block);
    return block.replace(/repositories\s*\{/, match => `${match}\n${repoBlock}\n`);
}

function patchGradle(context) {
    const projectRoot = context.opts && context.opts.projectRoot ? context.opts.projectRoot : process.cwd();
    const appGradlePath = path.join(projectRoot, 'platforms/android/app/build.gradle');
    if (!fs.existsSync(appGradlePath)) {
        console.log('app/build.gradle not found:', appGradlePath);
        return;
    }
    let appGradle = fs.readFileSync(appGradlePath, 'utf8');

    // Patch buildscript
    appGradle = appGradle.replace(/(buildscript\s*\{[\s\S]*?)(\n\s*dependencies\s*\{)/, (match, p1, p2) => {
        let beforeDeps = p1;
        if (/repositories\s*\{/.test(beforeDeps)) {
            beforeDeps = insertRepoFirst(beforeDeps);
        } else {
            beforeDeps = beforeDeps.replace(/buildscript\s*\{/, m => `${m}\n    repositories {\n${repoBlock}\n    }\n`);
        }
        return beforeDeps + p2;
    });

    // Patch allprojects
    appGradle = appGradle.replace(/(allprojects\s*\{[\s\S]*?)(\n\s*task |\n\s*ext |\n\s*android |\n\s*\/\*|$)/, (match, p1, p2) => {
        let beforeNext = p1;
        if (/repositories\s*\{/.test(beforeNext)) {
            beforeNext = insertRepoFirst(beforeNext);
        } else {
            beforeNext = beforeNext.replace(/allprojects\s*\{/, m => `${m}\n    repositories {\n${repoBlock}\n    }\n`);
        }
        return beforeNext + p2;
    });

    fs.writeFileSync(appGradlePath, appGradle, 'utf8');
}

// Cordova will call as a function during the build, but allow running directly for manual testing
module.exports = patchGradle;
if (require.main === module) {
    patchGradle({ opts: { projectRoot: process.cwd() } });
}
```

## iOS Setup

iOS native dependencies are managed through CocoaPods. They are installed when you add the iOS platform. If pod installation fails, run `pod repo update` and re-add the platform:

```bash
cordova platform rm ios && cordova platform add ios@^7.1.1
```

The plugin adds the URL schemes the SDK checks for jailbreak detection to `LSApplicationQueriesSchemes` in your app's `Info.plist`: 


- `cydia`
- `undecimus`
- `sileo`
- `zbra`
- `filza`
- `activator`
- `installer`
- `saily`
- `xina`
- `dopamine`

Entries your app already declares are kept. Keep the combined list within Apple's limit: 50 entries when linked with iOS version 15–26, or 25 entries with iOS 27 and later.

## Initialize the SDK

On startup, call `initializeSDK()` with your Incode API key and base URL:

```javascript
cordova.exec(
  function () { console.log("SDK ready"); },
  function (err) { console.log("Init error:", err); },
  "Cplugin",
  "initializeSDK",
  [
    "YOUR_API_KEY",              // apiKey
    "https://your.api.url",      // apiUrl
    "true",                      // loggingEnabled
    "false",                     // testMode
    "experimentV2",              // clientExperimentId (opts iOS into V2 UI; use null for V1)
    "https://your.e2ee.api.url", // e2eeUrl
    { enabled: false, forceSSLPinning: false } // sslPinningConfig
    // optional: "standard", "false", "false" — sdkMode, externalAnalyticsEnabled, externalScreenshotsEnabled
  ]
);
```

Keep all credentials out of source control. For the full argument breakdown, see the [API Reference](/sdk-reference/cordova-api-reference/).

---

- Path: `sdk-reference/cordova-known-issues`
- URL: https://developer.incode.com/sdk-reference/cordova-known-issues/
- Markdown: https://developer.incode.com/sdk-reference/cordova-known-issues.md

# Known Issues

This page lists known issues with the Incode Onboarding Cordova Plugin, their status, and workarounds.

| # | Issue | Status | Platform |
|---|-------|--------|----------|
| 1 | [Virtual environment crash on Android](#virtual-environment-crash-on-android) | By design (security feature) | Android |
| 2 | [Emulator and simulator false security triggers](#emulator-and-simulator-false-security-triggers) | Workaround available | All |
| 3 | [iOS double initialization](#ios-double-initialization) | By design | iOS |

## Virtual environment crash on Android

**Status:** By design (security feature).

**Platform:** Android.

When running in a virtual or emulated environment, the app may crash with a `NullPointerException` originating in `ThemeConfiguration$Builder` and related repository classes. This crash is triggered by the SDK's hook and virtual-environment detection, which intentionally cause a native crash that application code cannot catch or handle.

As of 4.2.0, emulator and root detection no longer abort the flow; the onboarding continues normally. Hook and virtual-environment detection still trigger an unrecoverable native crash.

Example stack traces:

```java
java.lang.NullPointerException
    at com.incode.welcome_sdk.ThemeConfiguration$Builder.setLabelSmallStyle(SourceFile:1066)
    at com.incode.welcome_sdk.f.c(SourceFile:150)
    at com.incode.welcome_sdk.data.local.m.as(SourceFile:22)
    at com.incode.welcome_sdk.IncodeWelcome.startOnboardingSection(SourceFile:18)
```

```java
java.lang.NullPointerException: Attempt to get length of null array
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.d(SourceFile:320)
    at com.incode.welcome_sdk.data.IncodeWelcomeRepository.i(SourceFile:214)
```

**Workaround:** Do not run production builds in virtual environments. For development and testing on emulators, see [Emulator and simulator false security triggers](#emulator-and-simulator-false-security-triggers) below.

## Emulator and simulator false security triggers

**Status:** Workaround available.

**Platform:** All.

Running on simulators or emulators can trigger security checks that return errors such as `simulatorDetected`.

**Workaround:** Set `testMode` to `"true"` when calling [`initializeSDK()`](/sdk-reference/cordova-api-reference/#initializesdk) on simulators and emulators. Use `testMode: "false"` on real devices in production, otherwise you may receive a `testModeEnabled` error.

## iOS double initialization

**Status:** By design.

**Platform:** iOS.

The iOS SDK guards against double initialization. Calling `initializeSDK()` more than once per app lifecycle is a no-op on iOS.

**Workaround:** Initialize once per app lifecycle. Use [`isInitialized()`](/sdk-reference/cordova-api-reference/#isinitialized) to check state before attempting to reinitialize.

---

- Path: `sdk-reference/cordova-modules`
- URL: https://developer.incode.com/sdk-reference/cordova-modules/
- Markdown: https://developer.incode.com/sdk-reference/cordova-modules.md

# Modules

Modules are the building blocks of an onboarding flow. Add modules to `flowConfig` (for locally configured flows) to define what happens during onboarding, or configure them in a Flow or Workflow on the Incode Dashboard (for online-configured flows). See [Common Implementation Patterns](/sdk-reference/cordova-common-implementation-patterns/) for implementation options and instructions.

Every entry in `flowConfig` is an object with a `module` key plus any parameters:

```javascript
{ module: "addId", showIdTypeChooser: "false", idType: "PASSPORT" }
```

**Boolean and integer parameters are passed as strings.** Use `"true"` / `"false"` for booleans and quoted numerals (e.g. `"3"`) for integers. This matches how the native bridge expects them.

**Exception**: `Phone`, `Email`, `CurpValidation`, and `Geolocation` take real booleans and numbers (`true`, `52`). For these modules, a string value (`"true"`, `"52"`) is ignored and the native default applies. The plugin logs a warning that names the module and the key.

For the result object each module produces, see [Results](/sdk-reference/cordova-results/).

## Modules

### addAntifraud

Compares the current Session against prior Sessions and known identities to detect signs of fraud.

- No additional parameters.

```javascript
{ module: "addAntifraud" }
```

### approve

Finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. By default, it runs with no UI and approves silently, but you can toggle the UI, silent face match, and forced approval.

_This module runs without presenting a screen._

- No additional parameters.

```javascript
{ module: "approve" }
```

The same approval can be run on its own, outside a `flowConfig`, via the [`approve()`](/sdk-reference/cordova-api-reference/#approve) API. Both paths return the same [`approveData`](/sdk-reference/cordova-results/#approvedata) object.

### CurpValidation

Validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

- `validationEnabled` (optional, defaults to `true`): boolean. Enable server-side CURP validation. When `false`, the module captures a CURP in a valid format without checking it against RENAPO.

```javascript
{ module: "CurpValidation", validationEnabled: true }
```

The result is reported in [curpValidationData](/sdk-reference/cordova-results/#curpvalidationdata).

### addDocumentScan

Captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera.

| Parameter | Required | Default | Values | Description |
|---|---|---|---|---|
| `documentType` | No | `"ADDRESS_STATEMENT"` | `"ADDRESS_STATEMENT"`, `"PAYMENT_PROOF"`, `"MEDICAL_DOC"`, `"OTHER_DOCUMENT_1"`, `"OTHER_DOCUMENT_2"`, `"OTHER_DOCUMENT_3"` | The type of document to capture. |
| `documentSources` | No | Every source the `documentType` supports | An array containing any of `"camera"`, `"photoUpload"`, `"fileUpload"` | Limits the capture methods offered to the user. For example, `["camera"]` goes straight to capture, and `["photoUpload", "fileUpload"]` allows uploads only. <br>This is a real array of strings, not a stringified one. Unknown values are ignored, and an array that holds no recognized value falls back to the default. |





`fileUpload` (PDF) is only meaningful for document types that accept PDFs. It is dropped at runtime for types that don't, such as `"MEDICAL_DOC"`. Always keep another source in the list for those types.

```javascript
{ module: "addDocumentScan", documentType: "PAYMENT_PROOF" }
```

```javascript
{
  module: "addDocumentScan",
  documentType: "ADDRESS_STATEMENT",
  documentSources: ["camera", "photoUpload"]
}
```

### addEKYC

Collects and verifies a user's personal identity data against authoritative data sources. This data can include the user's name, email, address, phone, tax ID, date of birth, and nationality.

- `checkName` (optional, defaults to `"false"`): string. Verify name.
- `checkEmail` (optional, defaults to `"false"`): string. Verify email.
- `checkAddress` (optional, defaults to `"false"`): string. Verify address.
- `checkPhone` (optional, defaults to `"false"`): string. Verify phone.
- `checkSsn` (optional, defaults to `"false"`): string. Verify SSN or tax ID.
- `checkDob` (optional, defaults to `"false"`): string. Verify date of birth.
- `checkNationality` (optional, defaults to `"false"`): string. Verify nationality.

```javascript
{
  module: "addEKYC",
  checkName: "true",
  checkAddress: "true",
  checkDob: "true"
}
```

### Email

Collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

- `otpVerification` (optional): boolean. Enable OTP email verification. When omitted, the native SDK setting applies.

```javascript
{ module: "Email", otpVerification: true }
```

### addFaceAuthentication

Captures a returning user's face with their device’s camera and matches it against the face already enrolled for that user. It then returns a pass or fail result.

- `showTutorials` (optional, defaults to `"true"`): string. Show tutorials.
- `autoCaptureTimeout` (optional): string integer. Auto-capture timeout in seconds. Default is platform default.
- `captureAttempts` (optional): string integer. Maximum capture attempts. Default is platform default.
- `eyesClosedCheck` (optional, defaults to `"true"`): string. Check for closed eyes.&#x20;
- `headCoverCheck` (optional, defaults to `"true"`): string. Check for head coverings.&#x20;
- `lensesCheck` (optional, defaults to `"true"`): string. Check for glasses or lenses.
- `faceMaskCheck` (optional, defaults to `"true"`): string. Check for face mask.&#x20;

```javascript
{
  module: "addFaceAuthentication",
  showTutorials: "false",
  autoCaptureTimeout: "3",
  captureAttempts: "3"
}
```

To show your logo on all SDK screens, including the Face Authentication screens, call [setLogo()](/sdk-reference/cordova-api-reference/#setlogo) before you start the flow.

:::info
**Not the same as Face Login**
  The `addFaceAuthentication` module runs as a step inside an onboarding Flow or Workflow. To authenticate a user as a standalone capability (outside a Flow or Workflow), use [Face Login](/sdk-reference/cordova-face-login/) and its `startFaceLogin()` method.
:::

### addFaceMatch

Compare the captured selfie against the document or NFC face to confirm identity.

- `matchType` (optional, defaults to `"idSelfie"`): `"idSelfie"`, `"nfcSelfie"`, or `"nfc3Way"`.
- `showLivenessResult` (optional, Android only, defaults to `"false"`): string. Show the liveness result screen. Ignored on iOS.

```javascript
{ module: "addFaceMatch", matchType: "idSelfie", showLivenessResult: "true" }
```

`matchType: "nfcSelfie"` or `"nfc3Way"` requires `addNFC` to have run first (NFC plugin variant).

:::info
**Not the same as `faceMatch()`**
  The `addFaceMatch` module presents UI to the user. The non-UI [`faceMatch()`](/sdk-reference/cordova-api-reference/#facematch) API performs a server-side face match without any UI and is not a `flowConfig` module.
:::

### Geolocation

Requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city.

:::note
This module was previously named `addGeolocation`; that name still works but is deprecated.
:::



- `isSkippable` (optional, defaults to `false`): boolean. Allow the user to skip geolocation. When `true`, skipping or denying location permission advances the flow instead of ending the session with a permission error, and `geoLocationData` reports `status: "fail"`. When `false`, a failed step ends the session through `errorCallback`. On Android, the native SDK reports a `fail` result for the step first and then the error; the section still ends through `errorCallback`. A string value (`"true"`) is ignored, so the step is not skippable.

```javascript
{ module: "Geolocation", isSkippable: true }
```

This module is parsed by the Incode Hybrid Bridge, like `Phone`, `Email`, and `FullName`.





Requires the `cordova-plugin-geolocation` or `@capacitor/geolocation` companion plugin.

### addGovernmentValidation

Validates identity data extracted from a user's ID against an authoritative government registry. The process runs in the background and isn't visible to the user.

- No additional parameters.

```javascript
{ module: "addGovernmentValidation" }
```

### addId

Captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing.

- `showTutorials` (optional, defaults to `"true"`): string. Show capture tutorials.
- `waitForTutorials` (optional, Android only, defaults to `"true"`): string. Wait for tutorial animation. Ignored on iOS.
- `idCategory` (optional, defaults to `"FIRST"`): `"FIRST"` or `"SECOND"`.
- `idType` (optional): `"ID"` or `"PASSPORT"`. Default is not set (user chooses). Values are case-sensitive as shown.
- `showIdTypeChooser` (optional, defaults to `"true"`): string. Show the document type chooser screen. When `"false"`, hides the chooser and requires that `idType` is set or configured on the dashboard.
- `enableFrontShownAsBackCheck` (optional, defaults to `"false"`): string. Detect front shown as back.
- `enableBackShownAsFrontCheck` (optional, defaults to `"false"`): string. Detect back shown as front.

```javascript
{
  module: "addId",
  showTutorials: "true",
  waitForTutorials: "false",
  idCategory: "FIRST",
  idType: "PASSPORT",
  showIdTypeChooser: "false",
  enableFrontShownAsBackCheck: "true",
  enableBackShownAsFrontCheck: "true"
}
```

`addId` automatically adds `processId` internally. Do not add `processId` as a separate module. This module produces `frontIdData`, `backIdData`, and `processIdData` results.

Document chooser visibility is controlled only by `showIdTypeChooser` or the Dashboard setting. Setting `idType` alone does not hide the chooser.

### addMachineLearningConsent

Captures the user's consent to process their biometric data for machine-learning purposes. It records their response on the server. You choose the consent text variant (US or GDPR style) that matches your compliance needs.

- `consentType` (optional, Android only, defaults to `"US"`): `"US"` or `"GDPR"`. On iOS the Cordova plugin always uses the worldwide regulation type and ignores `consentType`.

```javascript
{ module: "addMachineLearningConsent", consentType: "GDPR" }
```

### addNFC

Reads the secure NFC chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image.

> **Available only in the NFC plugin variant** (`-nfc` suffix) and only on NFC-capable hardware. See [Installation](/sdk-reference/cordova-installation/) for how to install the NFC variant.

- `idType` (optional): `"id"` or `"passport"`. Default is platform default.
- `showNFCSymbolConfirmationScreen` (optional, defaults to `"true"`): string. Show NFC symbol screen.
- `showInitialDataConfirmationScreen` (optional, defaults to `"true"`): string. Show data confirmation screen.
- `processNFCData` (optional, defaults to `"true"`): string. Process NFC data server-side.

```javascript
{
  module: "addNFC",
  idType: "passport",
  showNFCSymbolConfirmationScreen: "false",
  showInitialDataConfirmationScreen: "false",
  processNFCData: "false"
}
```

### Phone

Collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS.

- `otpVerification` (optional): boolean. Enable OTP SMS verification. When omitted, the native SDK setting applies.
- `defaultRegionPrefix` (optional): number. Dialing-code override, `1`–`9999`, with no leading `+`. Values outside that range are ignored and the device's own region prefix is used.

```javascript
{ module: "Phone", otpVerification: true, defaultRegionPrefix: 52 }
```

### FullName

Collects the user's first and last name.

- No additional parameters.

```javascript
{ module: "FullName" }
```

### addSelfieScan

Captures a user’s face with their device’s camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using 1:1 or 1:N face authentication.

- `showTutorials` (optional, defaults to `"true"`): string. Show selfie tutorials.
- `waitForTutorials` (optional, Android only, defaults to `"true"`): string. Wait for tutorial animation. Ignored on iOS.
- `cameraFacing` (optional, defaults to `"FRONT"`): `"FRONT"` or `"BACK"`.
- `maskCheckEnabled` (optional, defaults to `"true"`): string. Enforce face mask check.&#x20;
- `lensesCheckEnabled` (optional, defaults to `"false"`): string. Check for glasses or lenses.
- `headCoverCheckEnabled` (optional, defaults to `"false"`): string. Check for head coverings.
- `eyesClosedCheckEnabled` (optional, defaults to `"false"`): string. Check for closed eyes.&#x20;

```javascript
{
  module: "addSelfieScan",
  showTutorials: "true",
  waitForTutorials: "false",
  maskCheckEnabled: "true",
  lensesCheckEnabled: "true",
  eyesClosedCheckEnabled: "true"
}
```

### addSignature

Captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent.

- No additional parameters.

```javascript
{ module: "addSignature" }
```

### addUserConsent

Shows a custom consent agreement for the user to accept or reject.

- `title` (required): string. Consent screen title.
- `content` (required): string. Consent body text.

```javascript
{ module: "addUserConsent", title: "Privacy Policy", content: "I agree to the terms..." }
```

### userScore

Fetch the identity verification score inline as part of a section.

_This module runs without presenting a screen._

- `mode` (optional): `"fast"` or `"accurate"`.

```javascript
{ module: "userScore", mode: "fast" }
```

The score can also be fetched outside a section via the [`getUserScore()`](/sdk-reference/cordova-api-reference/#getuserscore) API.

### addVideoSelfie

Records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent.

- `showTutorials` (optional, defaults to `"true"`): string. Show tutorials.
- `selfieLivenessCheckEnabled` (optional, defaults to `"true"`): string. Enable liveness detection.
- `selfieMode` (optional): `"faceMatch"` or `"selfieMatch"`. Default is platform default.
- `idScanEnabled` (optional, defaults to `"true"`): string. Enable ID scan during video.
- `idValidationEnabled` (optional): string. Enable ID validation. Default is platform default.
- `documentScanEnabled` (optional, defaults to `"false"`): string. Enable document scan.
- `voiceConsentEnabled` (optional, defaults to `"false"`): string. Enable voice consent questions.
- `voiceConsentQuestionCount` (optional): string integer. Number of voice consent questions. Set to `"0"` to disable.
- `minVideoLengthRequired` (optional): string. Require minimum video length. Default is platform default.
- `disableAudio` (optional, defaults to `"false"`): string. Disable audio recording.
- `enableFrontShownAsBackCheck` (optional, defaults to `"false"`): string. Detect front shown as back.
- `enableBackShownAsFrontCheck` (optional, defaults to `"false"`): string. Detect back shown as front.

```javascript
{
  module: "addVideoSelfie",
  showTutorials: "true",
  selfieLivenessCheckEnabled: "true",
  idScanEnabled: "true",
  voiceConsentEnabled: "true",
  voiceConsentQuestionCount: "2",
  disableAudio: "false"
}
```

Set the voice consent language via the `voiceConsentLanguage` field of `sessionConfig` (`"en"`, `"es"`, `"pt"`, `"he"`).

## Module interdependencies

The order of modules in `flowConfig` is the execution order.

- `addId` adds `processId` automatically. Do not add `processId` as a separate module.
- `addFaceMatch` with `matchType: "nfcSelfie"` or `"nfc3Way"` requires `addNFC` to have run first. The selfie and NFC data must already be captured.
- `addNFC` requires the NFC plugin variant (`-nfc` suffix) and NFC-capable hardware.
- `addFaceAuthentication` is a standalone authentication step, not a replacement for `addSelfieScan` in a fresh onboarding flow. Use `addSelfieScan` (plus `addFaceMatch`) for new-user enrollment and `addFaceAuthentication` to re-authenticate an existing user.

`finishOnboarding` is not a module. To finalize a session, call the [`finishOnboarding()`](/sdk-reference/cordova-api-reference/#finishonboarding) API directly.

---

- Path: `sdk-reference/cordova-results`
- URL: https://developer.incode.com/sdk-reference/cordova-results/
- Markdown: https://developer.incode.com/sdk-reference/cordova-results.md

# Results

This page catalogs the data returned by the plugin's APIs and modules, plus the typed error strings you may receive.

## How results and errors are delivered

Every plugin call takes a success callback and an error callback:

```javascript
cordova.exec(successCallback, errorCallback, "Cplugin", "methodName", [args]);
```

The success callback receives either a session-level result object or an aggregated result object containing per-module result payloads keyed by name. The error callback receives a typed error string.

The two sections below document both:

- [API results](#api-results): the shape of the success callback payload for each API method, and the error strings its error callback may deliver.
- [Module result objects](#module-result-objects): the shape of the per-module payload that each module contributes to the aggregated result of `startOnboarding()` and `startOnboardingSection()`.

## User cancellation

User cancellation is not a successful completion. When the user cancels a section or flow, the error callback fires with `"userCancelled"` on both platforms. When the system ends the flow, such as when it destroys the SDK screen in the background, the error callback fires with `"interrupted"` on both platforms. Handle both in your error callback alongside other typed errors.

## API results

### faceMatch()

Success callback receives the face match result as a flat object, identical on both platforms. `idCategory` is always included. Every other field appears only when the native SDK returns a value for it. A missing field means there's no result to report, which is not the same as `false` or `0`.

```javascript
{
  confidence: 0.99,             // 0–1 match confidence
  isExistingUser: true,         // whether this is a returning user
  existingInterviewId: "b3e2…", // interview ID of the existing user if found
  isFaceMatched: true,
  isNameMatched: true,
  idCategory: "primary",        // "primary" | "secondary" — always present
  nfcVsIdConfidence: 0.94,      // NFC vs ID face confidence (NFC flows only)
  nfcVsSelfieConfidence: 0.91,  // NFC vs selfie confidence (NFC flows only)
  secondIdConfidence: 0.88      // second-ID confidence, when a secondary ID was scanned
}
```

There is no `status` field. Derive it from `isFaceMatched` if you need one.

The fields that are always included differ by platform, because the Android and iOS SDKs handle
"unknown" differently:

| Field | Android | iOS |
|-------|---------|-----|
| `idCategory` | Always | Always |
| `isExistingUser`, `isFaceMatched`, `isNameMatched` | Always | Present only when the native SDK has a value; `isFaceMatched` is absent when no ID was uploaded, so there was nothing to compare |
| `confidence`, `existingInterviewId`, `nfcVsIdConfidence`, `nfcVsSelfieConfidence`, `secondIdConfidence` | Present when available | Present when available |

If your app runs on both platforms, write your code for the iOS behavior. Check whether a field exists, not whether it's truthy.

The error callback receives `{ code, message, cause }`. See [faceMatch() in the API reference](/sdk-reference/cordova-api-reference/#facematch) for the full list of codes.

This shape differs from the [`faceMatchData`](#facematchdata) object contributed by the `addFaceMatch` module, which retains its own legacy field names.

### finishOnboarding()

Success callback indicates the session was finalized successfully. The success string differs by platform (`"onOnboardingFinished"` on Android; `"flow finished successfully"` on iOS).

### getUserScore()

Pass `"fast"` or `"accurate"` as `fetchMode`. The success callback receives the score object below with identity verification scores.

```js
cordova.exec(
  function (result) {
    console.log("Score:", JSON.stringify(result));
  },
  function (error) {
    console.log("Error:", error);
  },
  "Cplugin",
  "getUserScore",
  ["fast"]
);
```

`overall` is always present; its `value` and `status` are `null` when the SDK returned no overall score. The other top-level sections—`idValidation`, `liveness`, `faceRecognition`, and `governmentValidation`—are present only when the SDK returned that section. Inside a present section, every sub-key is always present, `null` when the value is absent. Check lists are always arrays; they are `[]` when empty. `extendedUserScoreJsonData` is always present and is a raw JSON string (`"{}"` when unavailable), so it needs parsing.

`status` is one of `ok`, `warn`, `fail`, `unknown`, `manual`, or `null`. Entries whose status is `unknown` are omitted from `photoSecurityAndQuality` and `ocrValidation`; `idSpecific` is unfiltered.

```json
{
  "extendedUserScoreJsonData": "<raw JSON>",
  "overall": { "value": "80.5", "status": "ok" },
  "idValidation": {
    "overall": { "value": "92", "status": "ok" },
    "photoSecurityAndQuality": [ { "key": "tamperCheck", "value": "100", "status": "ok" } ],
    "idSpecific": [ { "key": "…", "value": "…", "status": "…" } ]
  },
  "liveness": {
    "overall": { "value": "88", "status": "ok" },
    "livenessScore": { "value": "88", "status": "ok" },
    "photoQuality": "70.5"
  },
  "faceRecognition": {
    "overall": { "value": "95", "status": "ok" },
    "existingUser": false
  },
  "governmentValidation": {
    "overall": { "value": "90", "status": "ok" },
    "recognitionConfidence": { "value": "91", "status": "ok" },
    "validationStatus": { "key": "…", "value": "VALID", "status": "ok" },
    "ocrValidation": [ { "key": "…", "value": "…", "status": "…" } ]
  }
}
```

### initializeSDK()

Success callback indicates the SDK was initialized successfully. The success string differs by platform (`"success"` on Android; `"Incode SDK init complete"` or `"Incode SDK is already initialized"` on iOS).

Errors are the same on Android and iOS, delivered as `"<code>: <message>"`. Match on the code prefix if you need typed handling.

| Code | Meaning |
|------|---------|
| `simulatorDetected` | Running on a simulator while `testMode` is `false`. |
| `testModeEnabled` | `testMode` is `true` in a production context. |
| `invalidInitParams` | Bad `apiKey` / `apiUrl`. |
| `configError` | Missing/invalid config (e.g. null config or empty `apiConfig.url`). |
| `unknown` | Unexpected error. |

### isInitialized()

Success callback receives a boolean: `true` if the native SDK is fully initialized, `false` otherwise.

```javascript
cordova.exec(
  function (isInitialized) { console.log("Initialized:", isInitialized); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "isInitialized",
  []
);
```

### setupOnboardingSession()

Success callback receives an object containing the created session identifiers:

```javascript
{
  interviewId: "string", // the session id
  token: "string"        // the session token
}
```

### startFaceLogin()

**iOS** success callback receives a mapped face login object:

```javascript
{
  faceMatched: true,           // boolean
  spoofAttempt: false,         // boolean
  image: {
    pngBase64: "",             // base64-encoded selfie
    encryptedBase64: ""        // E2EE-encrypted selfie (when E2EE is enabled)
  },
  customerUUID: "",            // string or null; null when faceMatched is false
  interviewId: "",             // string; session ID in which the user was approved
  interviewToken: "",          // string; session token in which the user was approved
  token: "",                   // string; token for further API calls
  transactionId: "",           // string; unique ID of this face login attempt
  hasFaceMask: false           // boolean; true when login failed because user wore a mask
}
```

**Android** success (and some failure) callbacks receive the native `SelfieScanResult` JSON from Gson.

Error callback receives a platform-specific value. Neither platform emits fixed strings.

- **iOS:** `"face login failed: <native error>"`, or another descriptive string from the SDK.
- **Android:** the native error message (or `"onError"` when none is available), `"onUserCancelled"` when the user cancels, or in some failure paths the face login result JSON is passed to the error callback.

### startOnboarding()

Success callback receives the aggregated result of the executed flow: a top-level object with one key per module that ran (for example, `frontIdData`, `selfieData`, `faceMatchData`). There is no top-level `status` field on this API — `status` is only added for [`startOnboardingSection()`](#startonboardingsection). See [Module result objects](#module-result-objects) below for each module's shape.

### startOnboardingSection()

The success callback receives a top-level object:

```javascript
{
  status: "success",
  sectionTag: "your-tag",       // the value of the sectionTag parameter you passed
  // ...plus one key per module that ran (see Module result objects below)
}
```

Each module that ran in the section contributes its own key—such as `frontIdData`, `selfieData`, and `faceMatchData`—to this object.

Before the section starts, the error callback receives `{ code, message, cause }`:

```javascript
{
  code: "configError",
  message: "sectionTag is required to start an onboarding section",
  cause: null
}
```

Start-up codes are `activityNotPresent`, `unknownModule`, `configError`, `sectionAlreadyRunning`, `noActiveSession` (Android), and `unknown`. `cause` is `null` or an object with `type` and `message`. Android also includes `stackTrace`. See the [API Reference](/sdk-reference/cordova-api-reference/#startonboardingsection) for each code.

A concurrent call fails with `sectionAlreadyRunning` on both platforms and leaves the running section's callback and results unchanged.

After the section starts, the error callback receives one of the following typed strings from native `onError` or user-cancel handlers:

| Error                     | Platform     | Meaning                                               |
| ------------------------- | ------------ | ----------------------------------------------------- |
| `permissionsDenied`       | Android, iOS | Required permissions denied, including a camera or microphone permission during Video Selfie. |
| `videoSelfieNotCompleted` | Android, iOS | Video Selfie could not be completed.                  |
| `faceAuthenticationFailed`| Android, iOS | Face authentication module failed.                    |
| `sslPinningFailed`        | Android, iOS | SSL pinning failure (MITM or bad certificate).        |
| `locationUnavailable`     | Android, iOS | Unable to determine location.                         |
| `storageUnavailable`      | Android      | No writable images directory available on the device. |
| `integrityCompromised`    | iOS          | Device integrity check failed.                        |
| `combinedConsentsNotReceived` | iOS      | A mandatory combined consent had no readable text or checkbox ID, so the flow stopped. |
| `userCancelled`           | Android, iOS | User cancelled the flow.                              |
| `interrupted`             | Android, iOS | The system ended the flow, for example when it destroyed the SDK screen in the background. |
| `sessionCreationFailed`   | iOS          | The onboarding session could not be created. |
| `captchaNotVerified`      | iOS          | The CAPTCHA could not be verified, so the flow ended. On Android a failed CAPTCHA fails with `unknown`. |
| `biometricConsentNotGiven` | Android, iOS | The user did not give consent to store biometric data. |
| `biometricConsentNotReceived` | Android, iOS | The biometric consent did not reach Incode. |
| `sectionAlreadyRunning`   | iOS          | A section was started while another one was running. |
| `noActiveSession`         | iOS          | The flow needs an onboarding session and there is none. |
| `insufficientDiskSpace`   | Android      | Not enough free disk space for the SDK's ML models. |
| `onDeviceProcessingNotCompatible` | Android | On-device processing is enabled together with a setting it does not support: for example, no end-to-end encryption, frame streaming, or screen recording. |
| `unknown`                 | Android, iOS | Unexpected or unmapped error.                         |

The error callback is called once per flow. The same post-start codes apply to `startOnboarding()`, `startFlow()` and `startWorkflow()`.

Detailed face-authentication failure reasons, such as `userIsNotRecognized`, appear on the module result as [`faceAuthenticationData.error`](#faceauthenticationdata), not as the section `errorCallback` string.

### startWorkflow()

Success callback receives the aggregated result of the workflow, in the same shape as [`startOnboarding()`](#startonboarding).

If the workflow cannot be started, the error callback receives an object:

```javascript
{
  code: "configError",
  message: "configurationId or token is required to start a workflow",
  cause: null
}
```

| Code | Platform | Meaning |
|------|----------|---------|
| `activityNotPresent` | Android, iOS | No host Activity (Android) or presenting view controller (iOS). Reported before the flow starts. |
| `configError` | Android, iOS | `sessionConfig` has neither a non-empty `configurationId` nor a non-empty `token`. Reported before the flow starts; no network request is made. |
| `unknown` | Android, iOS | The SDK threw while starting. |
| `bridgeFailure` | Android | The native call threw before producing a result. |

After the Workflow starts, errors are reported the same way as for [`startOnboardingSection()`](#startonboardingsection).

### startFlow()

Success callback receives the aggregated result of the flow, in the same shape as [startOnboarding()](#startonboarding).

If the flow cannot be started, the error callback receives an object:

```javascript
{
  code: "configError",
  message: "configurationId or token is required to start a flow",
  cause: null
}
```

| Code | Platform | Meaning |
|------|----------|---------|
| `activityNotPresent` | Android, iOS | No host Activity (Android) or presenting view controller (iOS). Reported before the flow starts. |
| `configError` | Android, iOS | `sessionConfig` has neither a non-empty `configurationId` nor a non-empty `token`. Reported before the flow starts. |
| `unknown` | Android, iOS | The SDK threw while starting. |
| `bridgeFailure` | Android | The native call threw before producing a result. |

An unknown or empty `moduleId` starts the flow from the first module. After the flow starts, errors are reported the same way as for [startOnboardingSection()](#startonboardingsection).

## Module result objects

Each module contributes a key to the `startOnboarding()` or `startOnboardingSection()` success callback payload. This section catalogs the shape of each key's value, alphabetized by key name.

### antifraudData

From `addAntifraud`.

```javascript
{ status: true } // boolean: true = antifraud check passed
```

### approveData

From the non-UI `approve` module. The [`approve()`](/sdk-reference/cordova-api-reference/#approve) API returns this same object directly.

```javascript
{
  success: true,            // boolean: true = user approved
  uuid: "<uuid>",           // string | null; customer ID of the created customer
  customerToken: "<token>", // string | null; customer token
  error: null               // string | null; iOS only, always null on Android
}
```

`error` carries a flow error code—`sslPinningFailed`, `integrityCompromised`, or `unknown`—when the iOS approval module reports one. Android's native `ApproveResult` has no error field, so the key is always `null` there.

### backIdData

From `addId`.

```javascript
{
  status: "ok",              // see status values below
  image: "<base64String>",   // base64-encoded image
  classifiedIdType: "ID",    // classified document type, e.g. "ID"
  idCategory: "primary",     // "primary" | "secondary"
  chosenIdType: "id",        // "id" | "passport"
  allAttemptsExhausted: false // true when no more retries available
}
```

`status` values:

| Value                 | Meaning                         |
| --------------------- | ------------------------------- |
| `ok`                  | Capture succeeded               |
| `unknown`             | Unknown error                   |
| `errorClassification` | Document classification failed  |
| `errorGlare`          | Glare detected                  |
| `errorSharpness`      | Image not sharp enough          |
| `errorReadability`    | Document not readable           |
| `errorInCapture`      | Capture error (iOS)             |
| `errorUnacceptableID` | ID not acceptable (iOS)         |
| `wrongSide`           | Wrong document side shown (iOS) |

### curpValidationData

From `CurpValidation`.

```javascript
{
  curp: "MXMO860324HDFRDM05", // the validated, generated, or entered CURP
  valid: true,                // true if RENAPO accepted the CURP
  data: { success: true, curp: "MXMO860324HDFRDM05" }, // raw response from the validation service
  status: "success",          // "success" | "fail"
  resultCode: "success"       // "success" | "error"
}
```

- `status` is `success` only when RENAPO accepted the CURP. A rejected CURP or a failed request gives `status: "fail"` and `resultCode: "error"`, on both platforms.
- `curp` and `data` are omitted when the SDK has no value: for example, after a network failure. `data` is an object. Keys inside it that the service returns as `null` stay `null`.
- With `validationEnabled: false`, no server check runs, so `valid` and `data` are omitted. `status` is `success` when a CURP was captured. When the step ends without one, `status` is `fail`, `resultCode` is `error`, and `curp` is omitted.
- When the user enters more than one CURP, only the final attempt is reported.
- Cancelling the step doesn't deliver `curpValidationData`. The error callback gets the [user-cancelled string](#user-cancellation) instead.

### documentData

From `addDocumentScan`. The data field's structure depends on the document type captured.

```javascript
{
  type: "addressStatement", // "addressStatement" | "medicalDoc" | "paymentProof" | "otherDocument1" | "otherDocument2" | "otherDocument3"
  image: "<base64String>",
  address: {
    city: "string",
    colony: "string",
    postalCode: "string",
    street: "string",
    state: "string"
  },
  data: "<rawData>"
}
```

### eKYC

From `addEKYC`. Note that the result key is `eKYC`, not `eKYCData`.

```javascript
{ status: true } // boolean: true = eKYC checks passed
```

### emailData

From `Email`.

```javascript
{
  email: "user@example.com",
  status: "success", // "success" | "fail"
  resultCode: "success" // success | error on both; userCancelled | emulatorDetected on Android
}
```

### faceAuthenticationData

From `addFaceAuthentication`.

```javascript
{
  status: "success",              // "success" | "fail"
  customerUUID: "string",         // UUID of the authenticated customer
  selfieBase64: "string",         // base64-encoded selfie image
  selfieEncryptedBase64: "string", // E2EE-encrypted selfie (when E2EE is enabled)
  error: null                     // null on success; typed string on failure (see below)
}
```

`error` values when `status` is `"fail"`:

| Error                   | Meaning                                  |
| ----------------------- | ---------------------------------------- |
| `inactiveSession`       | Session is no longer active              |
| `nonexistentCustomer`   | No enrolled face found for this user     |
| `lensesDetected`        | Glasses or lenses detected               |
| `faceMaskDetected`      | Face mask detected                       |
| `headCoverDetected`     | Head covering detected                   |
| `closedEyesDetected`    | Eyes are closed                          |
| `faceTooDark`           | Insufficient lighting                    |
| `spoofAttemptDetected`  | Liveness check failed                    |
| `userIsNotRecognized`   | Face does not match enrolled user        |
| `selfieImageLowQuality` | Selfie image quality too low             |
| `hintNotProvided`       | Required authentication hint was not set |
| `faceNotFound`          | No face detected in frame                |
| `faceCroppingFailed`    | Face region could not be extracted       |
| `faceTooSmall`          | Face is too far from the camera          |
| `faceTooBlurry`         | Image is too blurry                      |
| `badPhotoQuality`       | General photo quality failure            |
| `processingError`       | Server-side processing error             |
| `badRequest`            | Malformed request                        |
| `deniedCameraPermissions` | Camera permission denied (iOS)         |
| `userCancelled`         | User cancelled face authentication (iOS) |
| `unknown`               | Unexpected error                         |

### faceMatchData

From the `addFaceMatch` module. The standalone [`faceMatch()`](#facematch) API returns a
different, flat shape.

```javascript
{
  status: "match",              // "match" | "mismatch"
  confidence: 0.99,             // 0–1 match confidence
  existingUser: true,           // whether this is a returning user
  existingInterviewId: "",      // interview ID of the existing user if found
  isFaceMatched: true,
  isNameMatched: true,
  idCategory: "primary",        // "primary" | "secondary"
  nfcVsIdConfidence: 0,         // NFC vs ID face confidence (NFC flows only)
  nfcVsSelfieConfidence: 0      // NFC vs selfie confidence (NFC flows only)
}
```

Older documentation may refer to `existingUser` as `isExistingUser`; the current name is `existingUser`.

### frontIdAttemptData / backIdAttemptData

From `addId` attempt callbacks. **iOS only** — Android does not emit these keys.

Shape matches [frontIdData](#frontiddata) / [backIdData](#backiddata).

### frontIdData

From `addId`.

```javascript
{
  status: "ok",              // see status values below
  image: "<base64String>",   // base64-encoded image
  classifiedIdType: "ID",    // classified document type, e.g. "ID"
  idCategory: "primary",     // "primary" | "secondary"
  chosenIdType: "id",        // "id" | "passport"
  allAttemptsExhausted: false // true when no more retries available
}
```

`status` values:

| Value                 | Meaning                         |
| --------------------- | ------------------------------- |
| `ok`                  | Capture succeeded               |
| `unknown`             | Unknown error                   |
| `errorClassification` | Document classification failed  |
| `errorGlare`          | Glare detected                  |
| `errorSharpness`      | Image not sharp enough          |
| `errorReadability`    | Document not readable           |
| `errorInCapture`      | Capture error (iOS)             |
| `errorUnacceptableID` | ID not acceptable (iOS)         |
| `wrongSide`           | Wrong document side shown (iOS) |

### fullNameData

From `FullName`.

```javascript
{
  name: "Jane Doe",
  status: "success", // "success" | "fail"
  resultCode: "success" // success | error on both; userCancelled | emulatorDetected on Android
}
```

### geoLocationData

From `Geolocation`. Identical in shape on Android and iOS.

```javascript
{
  addressFields: {          // absent when no location was fetched
    street: "string",       // each field absent when the SDK has no value
    colony: "string",
    postalCode: "string",
    city: "string",         // falls back to the region when the city is unknown
    state: "string"         // the country name
  },
  latitude: 19.4326,        // absent when no location was fetched
  longitude: -99.1332,      // absent when no location was fetched
  status: "success",        // success only when a location was fetched, otherwise fail
  resultCode: "success",    // success | error on both; userCancelled on Android
  error: "locationUnavailable" // only when resultCode is error: permissionsDenied | locationUnavailable | sslPinningFailed | integrityCompromised | unknown
}
```

A skipped, denied, or unavailable location is reported here with `status: "fail"`, and the flow continues. When `isSkippable` is `false`, the flow ends through `errorCallback` instead, with `permissionsDenied` or `locationUnavailable`. On Android, the native SDK reports a `fail` result for the step first and then the error, so the section still ends through `errorCallback`. On iOS, a skip in the current UI is always reported as `locationUnavailable`, and a location whose address could not be fully resolved is reported as `fail` with `locationUnavailable` but still carries the partial `addressFields` and the coordinates.

### govresult / govValidationData

From `addGovernmentValidation`. The result key differs by platform:

- **Android:** `govresult`
- **iOS:** `govValidationData`

```javascript
{ status: true } // boolean
```

### machineLearningConsentData / MLConsentData

From `addMachineLearningConsent`. The result key differs by platform:

- **Android:** `machineLearningConsentData`
- **iOS:** `MLConsentData`

```javascript
{ status: true } // boolean: true = consent accepted, false = consent declined
```

The consent is optional and the flow continues either way, so treat `status: false` as
_declined_, not as a module failure. On iOS, `false` is also reported when the choice
could not be recorded.

### nfcData

From `addNFC`. All MRZ and chip fields are extracted from the document chip. Date fields (`birthDate`, `expireAt`) follow the MRZ `YYMMDD` format returned by the document chip.

```javascript
{
  birthDate: "",
  compositeCheckDigit: "",
  dateOfBirthCheckDigit: "",
  documentCode: "",
  documentNumber: "",
  documentNumberCheckDigit: "",
  expirationDateCheckDigit: "",
  expireAt: "",
  gender: "",
  issuingStateOrOrganization: "",
  nationality: "",
  optionalData1: "",
  optionalData2: "",
  personalNumber: "",
  personalNumberCheckDigit: "",
  primaryIdentifier: "",
  secondaryIdentifier: "",
  status: true // boolean
}
```

### phoneData

From `Phone`.

```javascript
{
  phone: "+1234567890",
  status: "success", // "success" | "fail"
  resultCode: "success" // success | error on both; userCancelled | emulatorDetected on Android
}
```

### processIdData

From `addId` (added automatically via `processId`).

```javascript
{
  extendedOcrData: "<jsonString>", // raw JSON string with full OCR data
  data: {
    address: {
      city: "string",
      colony: "string",
      postalCode: "string",
      street: "string",
      state: "string"
    },
    fullAddress: "string",
    birthDate: 0,        // Unix timestamp in milliseconds
    expirationDate: 0,   // Unix timestamp
    gender: "string",
    name: "string",
    issueDate: 0,        // Unix timestamp
    numeroEmisionCredencial: "string"
  }
}
```

### selfieAttemptData

From `addSelfieScan` attempt callbacks. Same shape as [`selfieData`](#selfiedata). Emitted on both Android and iOS when a selfie capture attempt completes (including retries).

```javascript
{
  status: "success",          // "success" | "unknown"
  image: "<base64String>",    // base64-encoded selfie
  spoofAttempt: false,
  allAttemptsExhausted: false
}
```

### selfieData

From `addSelfieScan`.

```javascript
{
  status: "success",          // "success" | "unknown"
  image: "<base64String>",    // base64-encoded selfie
  spoofAttempt: false,
  allAttemptsExhausted: false
}
```

### signatureData

From `addSignature`. Only fires when the signature is collected.

```javascript
{ status: "success" }
```

_Older documentation may refer to this key as `signaturePath`; the current name is `signatureData`._

### userConsentData

From `addUserConsent`.

- **iOS:** `{ status: true }` when consent is given (`status` is a boolean).
- **Android:** currently emits an empty object `{}` for this key.

### userScore result (inline)

When `userScore` is run inline via `{ module: "userScore", mode: "fast" }` in a `flowConfig`, the score is included in the section result under `userScoreData` in the same shape as [`getUserScore`](#getuserscore).

### videoSelfieData

From `addVideoSelfie`.

```javascript
{ status: true } // boolean: true = success, false = failed
```

### getUserScore errors (typed strings)

| Error | Meaning |
|-------|---------|
| `userScoreFailed` | Transport or HTTP failure, mapping failure, or submit-only mode. Also reported on iOS when the server returns a completely empty score, where Android instead reports success with an empty payload—a platform difference the underlying SDKs make unavoidable. |
| `userCancelled` | User cancelled. Android only. The call has no UI, so iOS never reports it. |

---

- Path: `sdk-reference/cordova-run-flows-configured-online`
- URL: https://developer.incode.com/sdk-reference/cordova-run-flows-configured-online/
- Markdown: https://developer.incode.com/sdk-reference/cordova-run-flows-configured-online.md

# Run Flows Configured Online

This pattern runs a flow whose modules and configuration are defined on the Incode Dashboard rather than in your app code. Your app supplies a `configurationId`, and the SDK pulls everything else from the dashboard.

Use this pattern when you want to change the onboarding configuration from the dashboard without releasing a new app version.

## Prerequisite

The SDK must be initialized before you start a flow. See [Installation](/sdk-reference/cordova-installation/) for the `initializeSDK()` call and its arguments.

## Workflows and Flows

Incode distinguishes between two dashboard-defined artifacts:

- **Workflows** are governed by Conditions and are started with `startWorkflow()`.
- **Flows** are governed by the Rules Engine and are started with `startFlow()`.

Which one you use depends on how the artifact was configured in Dashboard. Your app must know in advance which method to use; the SDK does not detect Workflow vs. Flow at runtime. If you're not sure which you have, check Dashboard or ask the team that configured it.

## Run a Workflow

Use `startWorkflow()` to run a dashboard-defined Workflow end to end.

```js
let sessionConfig = {
  configurationId: "your-workflow-id", // required
  region: "ALL"
};

cordova.exec(
  function (result) { console.log("Workflow result:", result); },
  function (error) { console.log("Workflow error:", error); },
  "Cplugin",
  "startWorkflow",
  [sessionConfig]
);
```

## Run a Flow

Use `startFlow()` to run a dashboard-defined Flow. You can optionally pass a `moduleId` to start from a specific module rather than the first one. See [Modules](/sdk-reference/cordova-modules) for the list of supported modules.

```js
let sessionConfig = {
  configurationId: "your-flow-id" // required
};
let moduleId = "EMAIL"; // optional; omit to start from the first module

cordova.exec(
  function (winParam) { console.log("Flow result:", winParam); },
  function (err) { console.log("Flow error:", err); },
  "Cplugin",
  "startFlow",
  [sessionConfig, moduleId]
);
```

## Results

Both `startWorkflow()` and `startFlow()` return results whose structure depends on which modules ran. See [Results](/sdk-reference/cordova-results/) for the full structure and the list of error strings.

## Related pages

- [Results](/sdk-reference/cordova-results/): the structure of workflow and flow results, and the list of error strings.
- [API Reference](/sdk-reference/cordova-api-reference): the full signatures of `startWorkflow()` and `startFlow()`, and every field on `sessionConfig`.

---

- Path: `sdk-reference/cordova-sdk`
- URL: https://developer.incode.com/sdk-reference/cordova-sdk/
- Markdown: https://developer.incode.com/sdk-reference/cordova-sdk.md

# Incode Cordova SDK

The Incode Onboarding Cordova Plugin adds end-to-end identity verification to your Cordova, Capacitor, or Ionic app: document and ID capture with OCR, selfie and video-selfie liveness, face match, and NFC e-passport reading. The UI is fully themeable, so onboarding looks and feels like your product. The plugin is distributed via the CordovaPluginReleases GitHub repository. Cordova apps install with the Cordova CLI; Capacitor and Ionic apps install via npm from the same repository, then sync native projects. Standard and NFC variants are available.&#x20;

## Start here

| If you want to...                      | Go to                                                            |
| -------------------------------------- | ---------------------------------------------------------------- |
| Add the plugin to your project         | [Installation](/sdk-reference/cordova-installation/)                                     |
| Get an onboarding flow running         | [Common Implementation Patterns](/sdk-reference/cordova-common-implementation-patterns/) |
| Authenticate a returning user          | [Face Login](/sdk-reference/cordova-face-login/)                                         |
| Browse available modules               | [Modules](/sdk-reference/cordova-modules/)                                               |
| See the result payloads modules return | [Results](/sdk-reference/cordova-results/)                                               |
| Customize colors, fonts, and text      | [Customization](/sdk-reference/cordova-customization/)                                   |
| Browse the full public API             | [API Reference](/sdk-reference/cordova-api-reference/)                                   |
| Solve a build problem                  | [Known Issues](/sdk-reference/cordova-known-issues/)                                     |

## Platform support

| Platform                      | Requirement                                                                            |
| ----------------------------- | -------------------------------------------------------------------------------------- |
| Cordova                       | Node.js 18+, Cordova CLI 11+                                                           |
| Ionic + Cordova               | Node.js 18+, Ionic CLI, Cordova CLI                                                    |
| Ionic + Capacitor / Capacitor | Node.js 18+, @capacitor/cli 7+                                                         |
| Android                       | minSdk 23+, `compileSdk` 36, AGP 8.9.1, Gradle 8.14.5, Kotlin 2.2.21, JDK 17+ to build |
| iOS                           | iOS 13+                                                                                |

## Quick install

Standard variant:

```bash Cordova
cordova plugin add "https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]"
cordova plugin add cordova-plugin-camera        # required (ID and face capture)
cordova plugin add cordova-plugin-geolocation   # only if using the geolocation module
```

```text Capacitor + Ionic
npm install github:Incode-Technologies-Example-Repos/CordovaPluginReleases#release/[VERSION]
npm install @capacitor/camera                   # required (ID and face capture)
npm install @capacitor/geolocation              # only if using the geolocation module
npx cap sync
```

```text Ionic + Cordova
ionic cordova plugin add "https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]"
ionic cordova plugin add cordova-plugin-camera        # required (ID and face capture)
ionic cordova plugin add cordova-plugin-geolocation   # only if using the geolocation module
```

NFC variant (NFC-capable hardware required):

```bash Cordova
cordova plugin add "https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]-nfc"
cordova plugin add cordova-plugin-camera        # required (ID and face capture)
cordova plugin add cordova-plugin-geolocation   # only if using the geolocation module
```

```text Capacitor + Ionic
npm install github:Incode-Technologies-Example-Repos/CordovaPluginReleases#release/[VERSION]-nfc
npm install @capacitor/camera                   # required (ID and face capture)
npm install @capacitor/geolocation              # only if using the geolocation module
npx cap sync
```

```text Ionic + Cordova
ionic cordova plugin add "https://github.com/Incode-Technologies-Example-Repos/CordovaPluginReleases.git#release/[VERSION]-nfc"
ionic cordova plugin add cordova-plugin-camera  # required (ID and face capture)
ionic cordova plugin add cordova-plugin-geolocation   # only if using the geolocation module
```

Android and iOS require additional per-platform setup.&#x20;

:::info
**Capacitor note**
  Cordova install hooks do not run. You must manually configure the Android Maven repository and iOS Podfile sources. See [Installation](/sdk-reference/cordova-installation/) for details.
:::

## How the SDK fits together

The plugin supports three integration patterns. They differ in where the flow is defined and how much control your app keeps while the flow runs.

### Pattern 1: Configure flows locally and run end to end

You build a `flowConfig` in app code describing the modules you want (ID scan, selfie, face match, and so on) and pass it to `startOnboarding()`. The SDK owns the UI from the first screen to the last and returns the aggregated result in the success callback. Use this pattern when you want the simplicity of a single SDK call and your app doesn't need to intervene between modules.

See [Configure Flows Locally and Run End to End](/sdk-reference/cordova-configure-flows-locally-and-run-end-to-end/) for the details.

### Pattern 2: Configure flows locally and run step by step

You run modules in named sections and return control to your app between sections. The SDK still owns each module screen (camera UI, capture experience, on-device guidance), but your app owns the shell around them: navigation, your own intro and transition screens, and when each section launches. Use this pattern when you need to interleave Incode steps with your own screens or run only part of a flow.

See [Configure Flows Locally and Run Step by Step](/sdk-reference/cordova-configure-flows-locally-and-run-step-by-step/) for the details.

### Pattern 3: Run Flows configured online

You build a Flow or Workflow on the Incode Dashboard and pass its `configurationId` to `startFlow()` or `startWorkflow()`. The SDK owns the UI from the first screen to the last and returns the result in the success callback. Use this pattern when you want to update flow behavior from the Dashboard without redeploying your app.

See [Run Flows Configured Online](/sdk-reference/cordova-run-flows-configured-online/) for the details.

## Variants

The plugin has two variants, so you only ship what you use.

| Variant  | Description                                                                   |
| -------- | ----------------------------------------------------------------------------- |
| Standard | Default variant. Covers all modules except NFC.                               |
| `-nfc`   | Adds NFC chip reading for ePassports and eIDs. Requires NFC-capable hardware. |

See [Installation](/sdk-reference/cordova-installation/) for how to install each variant.

## What the plugin can do

- **Identity capture:** ID scan, document capture, and OCR data extraction.
- **Liveness and biometrics:** selfie capture, video selfie, liveness detection, and face match.
- **NFC and e-passport:** reads the chip in passports and supported ID documents (`-nfc` variant only).
- **Authentication:** standalone Face Login for returning users. See [Face Login](/sdk-reference/cordova-face-login/).
- **Customization:** theming, localization, and custom assets so the experience matches your brand. See [Customization](/sdk-reference/cordova-customization/).

## Need help?

- Hit a build or runtime error? See [Known Issues](/sdk-reference/cordova-known-issues/).
- Looking for a specific method or parameter? See [API Reference](/sdk-reference/cordova-api-reference/).
- Still stuck? Contact your Incode representative or email [help@incode.com](mailto:help@incode.com).

---

- Path: `sdk-reference/cordova-sdk-modes`
- URL: https://developer.incode.com/sdk-reference/cordova-sdk-modes/
- Markdown: https://developer.incode.com/sdk-reference/cordova-sdk-modes.md

# SDK Modes

This page describes the SDK modes available for the Incode Onboarding Cordova Plugin and how to configure them. The SDK supports three modes that control whether captured images are uploaded and validated server-side.

## Available modes

- `standard`: The default. Captured images are uploaded to Incode's servers and validated. Use this mode for standard onboarding flows.
- `captureOnly`: Skips image upload and server validation for ID and Selfie scans. Use this mode when you want to capture images on the device without server-side processing.
- `submitOnly`: Submit previously captured data without performing new captures.

## Set the SDK mode

You can set the mode at [`initializeSDK()`](/sdk-reference/cordova-api-reference/#initializesdk) via the optional `sdkMode` argument, or call `setSdkMode()` after init. If you do neither, the SDK uses `standard`.

```javascript
cordova.exec(
  function () { console.log("SDK mode set"); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setSdkMode",
  ["captureOnly"]  // "standard" | "captureOnly" | "submitOnly"
);
```

### When to call `setSdkMode()`

Call `setSdkMode()` after initialization and before [`startOnboarding()`](./cordova-api-reference#startonboarding) (or [`startOnboardingSection()`](./cordova-api-reference#startonboardingsection)). Do not call `setSdkMode()` mid-session; doing so is not an error, but it can cause undefined behavior.

The SDK preserves the set mode for the next session.

---

- Path: `sdk-reference/cordova-token-based-setup`
- URL: https://developer.incode.com/sdk-reference/cordova-token-based-setup/
- Markdown: https://developer.incode.com/sdk-reference/cordova-token-based-setup.md

# Token-based Setup

<Component slug="sdk-token-based-setup" />

## Prerequisites

- A session `token` issued by your backend.
- The `apiUrl` provided by Incode.

## Set up the SDK with a token

Token-based setup has three steps: initialize the SDK with an empty `apiKey` and your `apiUrl`; create a `sessionConfig` with your backend token; then pass that config to your chosen flow API.

### 1. Initialize the SDK without an API key

Pass an empty string for `apiKey` and provide your `apiUrl` to `initializeSDK()`.

```javascript
cordova.exec(
  function () {
    console.log("SDK initialized — safe to start onboarding");
    setupSessionWithToken();
  },
  function (err) {
    console.log("Init error:", err);
  },
  "Cplugin",
  "initializeSDK",
  [
    "",                              // apiKey — empty for token-based setup
    "https://your.api.url",          // apiUrl
    "true",                          // loggingEnabled
    "false",                         // testMode
    null,                            // clientExperimentId
    null,                            // e2eeUrl (optional; set if using E2EE)
    { enabled: false, forceSSLPinning: false } // sslPinningConfig
    // optional: "standard", "false", "false" — sdkMode, externalAnalyticsEnabled, externalScreenshotsEnabled
  ]
);
```

### 2. Configure the session with a token

After initialization succeeds, create a `sessionConfig` and pass your session `token`.

```javascript
var sessionConfig = {
  token: "YOUR_TOKEN",
};
```

### 3. Start onboarding or set up a section-based flow

Pass the configured `sessionConfig` to `startOnboarding()`, `setupOnboardingSession()`, or any of the online-configured flow methods. Token-based setup works with all three [Common Implementation Patterns](/sdk-reference/cordova-common-implementation-patterns/).

```javascript
// Section-based — create/resume session first
cordova.exec(
  function (data) {
    console.log("Session ready:", data.interviewId, data.token);
  },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "setupOnboardingSession",
  [sessionConfig]
);

// End-to-end — pass token in sessionConfig to startOnboarding
cordova.exec(
  function (result) { console.log("Done:", result); },
  function (err) { console.log("Error:", err); },
  "Cplugin",
  "startOnboarding",
  [sessionConfig, flowConfig, recordSessionConfig]
);

// Dashboard flows — same sessionConfig
cordova.exec(..., "startFlow", [sessionConfig, "EMAIL"]);
cordova.exec(..., "startWorkflow", [sessionConfig]);
```

## Token expiration

Tokens are long-lived, so expiration during a session is unlikely. If a token does expire mid-session, the backend returns a 401 error, which is propagated to the SDK. Tokens cannot be refreshed; the user must start a new onboarding session, which generates a new token.

---

- Path: `sdk-reference/cordova-troubleshooting`
- URL: https://developer.incode.com/sdk-reference/cordova-troubleshooting/
- Markdown: https://developer.incode.com/sdk-reference/cordova-troubleshooting.md

# Troubleshooting

This page lists common issues you may hit while installing the Incode Onboarding Cordova Plugin or building your app and how to resolve them.

## Android: cannot resolve the Incode SDK

Verify `GITHUB_USERNAME` / `GITHUB_TOKEN` are set and the token has package read access, then re-add the platform:

```bash
cordova platform rm android && cordova platform add android@^14.0.1
```

## iOS: CocoaPods install fails

Run `pod repo update`, then re-add the iOS platform.

## Plugin changes not reflected

Run `cordova prepare`, or remove and re-add the plugin.

---

- Path: `sdk-reference/customization-2`
- URL: https://developer.incode.com/sdk-reference/customization-2/
- Markdown: https://developer.incode.com/sdk-reference/customization-2.md

# Customization
<Component slug="web-2-x-implementation-warning" />

The Incode Web SDK 2 gives you several ways to tailor the onboarding experience to your brand and product. Each page in this section covers one customization surface.

- [Theming & Styling](/sdk-reference/web-sdk-2-theming): Apply your brand's colors, typography, and visual styling to SDK screens.
- [Internationalization](/sdk-reference/web-sdk-2-i18n): Set the SDK language and override individual strings for your users.
- [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks): Hook into SDK lifecycle events to drive your own analytics, logging, or UI responses.
- [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides): Replace the SDK's default images, icons, and videos with your own assets.

---

- Path: `sdk-reference/digital-id-mdl-verification`
- URL: https://developer.incode.com/sdk-reference/digital-id-mdl-verification/
- Markdown: https://developer.incode.com/sdk-reference/digital-id-mdl-verification.md

# Digital ID: mDL Verification


<Component slug="web-2-x-implementation-warning" />

Verify a user with a mobile driver's license (mDL) presented from a phone wallet (such as Apple Wallet, Google Wallet, or a state DMV app like CA DMV Wallet) instead of capturing a photo of a physical ID.

You can offer this in three ways:

- In the Incode Hosted onboarding app, where the wallet option appears automatically on the ID chooser screen after it is enabled in your flow configuration.
- In your own custom web UI, using the Web SDK 2 ID manager to select an available digital-ID method from your own button.
- From your own wallet button, using `renderWallet()` or `createDeviceWalletManager()` without the ID Capture UI. See [Standalone integration](#standalone-integration).

For the full list of supported wallets, schemes, and attributes across regions, see [Supported Digital IDs](/general-reference/supported-digital-ids/).

## How it works

For mDL verification, the user must have their ID saved to their phone wallet. This is called a verifiable digital credential. Verification of a user's digital credential follows the same onboarding session model as the physical id verification:

1. Your application creates or opens an Incode onboarding session.
2. The user chooses to verify with their digital ID.
3. The browser launches the native wallet sheet with `navigator.credentials.get()`.
4. The user selects the credential and consents to share the requested attributes.
5. The encrypted wallet response is sent to Incode Server for decryption and verification.
6. Verification results are stored on the session and can be retrieved using the standard Incode result APIs.

The user's identity attributes are not returned directly to the web page from the wallet call. The wallet response is encrypted for Incode services and verified attributes are made available through the session's standard OCR data, score, and webhook result surfaces.

## Supported Wallets

| Platform | Wallet        | Browser | Path    |
| -------- | ------------- | ------- | ----------- |
| iOS      | Apple Wallet  | Safari  | `apple_web` |
| iOS      | CA DMV Wallet  | Safari  | `apple_web` |
| Android  | Google Wallet | Chrome  | `google`    |
| Android  | CA DMV Wallet | Chrome  | `google`    |


Incode supports CA DMV Wallet app on both platforms. The CA DMV Wallet app is presented through same path for iOS and Android as Apple and Google wallet

Apple requires approval for every individual client (relying party). Contact your Incode representative before going live with Apple Wallet.

Incode is an approved Google Verifier registrar and handles Google Wallet registration on your behalf. The user must still be on a supported Android Chrome environment with a compatible digital ID in Google Wallet. Contact your Incode representative before going live with Google Wallet.

## Prerequisites

### Before you go live

- **A wallet method enabled for your flow.** Enable Apple Wallet, Google Wallet, or CA DMV Wallet with the **Manage Digital IDs** setting in [ID Capture module configuration](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) in Dashboard. The flow configuration then carries it under `digitalIds.methods`.
- **Wallet approval.** Apple approves each relying party individually. For Google Wallet, Incode is a registered verifier and handles the registration for you. Contact your Incode Representative before going live with either wallet.
- **Registered domains.** Apple Wallet presents only on website domains approved for your integration. Send your Incode Representative every domain that opens the wallet — production, staging, and test — and allow time for approval. The same applies when you embed `<incode-flow>` on your own domain.

### Page requirements

- **An initialized session.** Activate the session token before you start the wallet — `setup({ apiURL, token })`, or `setup()` followed by `initializeSession()` (see [Headless Mode → Setup](/sdk-reference/web-sdk-2-headless-mode/#setup)). The wallet request and the response submission are both session-scoped.
- **HTTPS.** Browsers expose the Digital Credentials API only in secure contexts. On plain HTTP, the SDK reports `UNSUPPORTED_PLATFORM`.
- **A user gesture.** Start the wallet from a click or tap handler. Browsers open the wallet sheet only during the gesture's transient user activation, which expires shortly after the tap. Each wallet request consumes it, so a retry needs a new tap.
- **A top-level page, or an iframe that allows the wallet.** A cross-origin iframe can use the Digital Credentials API only when the embedding page grants it with `<iframe src="…" allow="digital-credentials-get">`. Without it, the browser rejects the wallet request.
- **The system browser.** In-app WebViews often don't expose the Digital Credentials API, so the SDK reports `UNSUPPORTED_PLATFORM` there. In a native app, use the Incode [iOS Apple Wallet](https://developer.incode.com/sdk-reference/ios-apple-wallet-id/) or [Android Google Wallet](https://developer.incode.com/sdk-reference/android-google-wallet-id/) integration instead.

## Option 1: Use the Incode Hosted onboarding app

If you use Incode's hosted or embedded onboarding app, no extra front-end integration is required after the flow is configured.

When the user reaches the ID chooser screen, the app shows a digital ID option alongside the normal document capture options, when all of the following are true:

- Digital IDs are enabled in the [flow configuration](/dashboard-platform-administration/id-capture-dashboard/).
- Apple Wallet or Google Wallet is enabled for the flow.
- The user's device and browser support the wallet method.
- The user has a compatible digital ID in their wallet.

The user taps the wallet option, confirms the wallet presentation in Apple Wallet or Google Wallet, and returns to the onboarding flow after the encrypted response is verified.

If the wallet flow cannot be completed, the user can continue with the regular ID capture fallback path depending on your flow configuration.

## Option 2: Use the Web SDK ID manager

Initialize an active Flow session containing the ID Capture module with digital IDs enabled. Resolve its complete configuration before creating the manager:

```typescript
import { setup } from '@incodetech/core';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';
import { createIdCaptureManager } from '@incodetech/core/id';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'YOUR_SESSION_TOKEN',
});
const config = await resolveDashboardModuleConfig({ moduleKey: 'ID' });
const manager = createIdCaptureManager({ config });
const unsubscribe = manager.subscribe((state) => {
  if (state.status === 'chooser') {
    // Offer a digital-ID button only if availableDocumentTypes includes 'digitalId'.
    // Render the other available types as fallback choices.
  } else if (state.status === 'deviceWallet') {
    // Show progress for requesting/decrypting; wait for the device sheet in presenting.
    // In failed, render state.failReason with retry and alternative-method actions.
  } else if (state.status === 'finished') {
    // This ID step completed. Obtain verified attributes through session results.
  } else if (state.status === 'error' || state.status === 'closed') {
    // Render the error or leave the verification surface.
  }
});
manager.load();

function selectDigitalId() {
  const state = manager.getState();
  if (state.status === 'chooser' && state.availableDocumentTypes.includes('digitalId')) {
    manager.selectDocument('digitalId');
  }
}

function retryWallet() {
  const state = manager.getState();
  if (state.status === 'deviceWallet' && state.phase === 'failed') {
    manager.deviceWalletRetry();
  }
}

function useAnotherMethod() {
  const state = manager.getState();
  if (state.status === 'deviceWallet' && state.phase === 'failed') {
    manager.deviceWalletUseAnotherMethod();
  }
}

function dispose() {
  unsubscribe();
  manager.stop();
}
```

Connect `selectDigitalId`, `retryWallet`, and `useAnotherMethod` to user actions. Call `dispose` when unmounting. Available methods depend on configuration and browser support; selection can use another supported digital-ID route where configured. For a wallet-only integration without the ID manager, use the [standalone APIs](#standalone-integration).

The [ID state reference](/sdk-reference/web-sdk-2-module-id-capture/#device-wallet-state-properties) describes wallet phases and failure values. Success reaches `finished`. Choosing another method returns to the chooser when available, otherwise `closed`.

## Standalone integration

Both entry points run the same handshake with no Incode UI:

| Entry point | Shape | Use it when |
| ----------- | ----- | ----------- |
| `renderWallet()` | One call with `onSuccess` / `onError` callbacks | You need a single button and a final outcome. Its callbacks and error codes mirror Web SDK 1.x `renderWallet`, which eases a port. |
| `createDeviceWalletManager()` | A manager with `subscribe()` / `getState()` over `requesting` → `presenting` → `decrypting`, plus `retry()` and `useAnotherMethod()` | You want your own screen for each phase, or a built-in retry. |

### `renderWallet()`

```typescript
import { setup } from '@incodetech/core';
import { renderWallet } from '@incodetech/core/id';

// Create the session before the tap, so the tap only has to open the wallet.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

const walletButton = document.querySelector<HTMLButtonElement>('#wallet-button');

walletButton?.addEventListener('click', () => {
  // Call it inside the handler: the wallet sheet needs the click's user activation.
  void renderWallet({
    onSuccess: (result) => {
      // The handshake completed. Read the final result from the session.
      console.log('Wallet decision:', result.decision);
    },
    onError: (error) => {
      // Show your own copy for error.code, then offer a retry or document capture.
      console.error(error.code, error.message);
    },
  });
});
```

#### Parameters

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `onSuccess` | `(result: DeviceWalletDecryptResponse) => void` | ✅ | Called when the handshake completes. A `'REJECTED'` decision arrives here too. |
| `onError` | `(error: RenderWalletError) => void` | ✅ | Called when the handshake fails. See [Error codes](#error-codes). |
| `provider` | `'apple_web' \| 'google'` | ❌ | Forces a wallet. Omit it to pick one from the browser — see [Provider detection](#provider-detection). |

`RenderWalletParams` also accepts `credentials` and `services`. These replace the browser's Digital Credentials access and Incode's network calls in unit tests. Production integrations omit them.

`renderWallet()` returns `Promise<void>`, which resolves after `onSuccess` or `onError` runs. Failures arrive through `onError`, not as a rejected promise. Each call runs one handshake and cleans up after itself. To retry, call `renderWallet()` again from a new user gesture.

#### Success result

```typescript
type DeviceWalletDecryptResponse = {
  success: boolean;
  decision?: 'ACCEPTED' | 'REJECTED';
  [key: string]: unknown;
};
```

`onSuccess` confirms that Incode received and processed the wallet response. It is not the final verification result, and it carries no identity attributes — read those from the session (see [Reading results](#reading-results)). Don't depend on response fields other than `success` and `decision`.

#### Error codes

```typescript
type RenderWalletError = {
  code: 'UNSUPPORTED_PLATFORM' | 'NO_CREDENTIAL' | 'WALLET_ERROR';
  message: string;
};
```

| `code` | Meaning | Suggested UX |
| ------ | ------- | ------------ |
| `UNSUPPORTED_PLATFORM` | The browser has no Digital Credentials API. Reported immediately, before any network call. | Hide the wallet option and offer document capture. |
| `NO_CREDENTIAL` | The wallet sheet closed without returning a credential. The user dismissed it or has no eligible ID. | Neutral copy. Offer a retry or another method. |
| `WALLET_ERROR` | Any other failure: an Incode request failed or the browser rejected the wallet request — for example, because the user activation expired or the page runs in an iframe without the wallet permission. | Offer a retry, then another method. |

Browsers report a dismissed sheet differently, so a user who cancels can surface as `NO_CREDENTIAL` or `WALLET_ERROR`. Treat both as retryable. `message` is an English developer message — show your own copy, keyed on `code`.

### `createDeviceWalletManager()`

```typescript
import { setup } from '@incodetech/core';
import {
  createDeviceWalletManager,
  type DeviceWalletManager,
  type DeviceWalletState,
} from '@incodetech/core/id';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

// walletButton, retryButton, and fallbackButton are your own <button> elements.
// showSpinner, showMessage, showDone, showRetry, and startDocumentCapture are your own UI functions.
let manager: DeviceWalletManager | undefined;

function render(state: DeviceWalletState) {
  switch (state.status) {
    case 'requesting':
    case 'decrypting':
      showSpinner();
      break;
    case 'presenting':
      showMessage('Choose your ID in the wallet.');
      break;
    case 'finished':
      manager?.stop();
      showDone(state.decision);
      break;
    case 'failed':
      showRetry(state.reason);
      break;
    case 'closed':
      manager?.stop();
      startDocumentCapture();
      break;
  }
}

walletButton.addEventListener('click', () => {
  manager?.stop();
  // Creating the manager starts the handshake, so create it inside the handler.
  manager = createDeviceWalletManager();
  manager.subscribe(render);
  // subscribe() reports later changes only. Render the first state yourself:
  // UNSUPPORTED_PLATFORM is already decided when the manager is created.
  render(manager.getState());
});

// retry() reopens the wallet sheet, so it needs a new user gesture too.
retryButton.addEventListener('click', () => manager?.retry());
fallbackButton.addEventListener('click', () => manager?.useAnotherMethod());
```

#### States

| `status` | Meaning | Properties |
| -------- | ------- | ---------- |
| `requesting` | Fetching the wallet request from Incode | `platform` |
| `presenting` | The OS wallet sheet is open | `platform` |
| `decrypting` | Incode is processing the wallet response | `platform` |
| `finished` | The handshake completed. Terminal. A `'REJECTED'` decision lands here too. | `platform`, `decision`, `response` |
| `failed` | The handshake failed. Recover with `retry()` or `useAnotherMethod()`. | `platform`, `reason` |
| `closed` | You called `useAnotherMethod()`. Terminal. | `platform` |

- `platform` is the resolved wallet backend: `'ios'` for Apple Wallet and `'android'` for Google Wallet. It follows [provider detection](#provider-detection), not the device OS.
- `decision` is `'ACCEPTED'`, `'REJECTED'`, or `undefined`. `response` is the full `DeviceWalletDecryptResponse`.
- `reason` uses the same three codes as `RenderWalletError` — see [Error codes](#error-codes).

#### Methods

| Method | Description | When to use |
| ------ | ----------- | ----------- |
| `retry()` | Restarts the handshake from the beginning | When `failed`. Call it from a user gesture. |
| `useAnotherMethod()` | Leaves the wallet path and moves to `closed` | When `failed`, to fall back to document capture |
| `getState()` | Returns the current state | Anytime |
| `subscribe(listener)` | Calls `listener` on every later state change. Returns an unsubscribe function. | Anytime |
| `stop()` | Stops the handshake, including in-flight requests, and releases resources | After `finished` or `closed`, or when unmounting |

`createDeviceWalletManager()` accepts the same `provider`, `credentials`, and `services` options as `renderWallet()`.

### Provider detection

Omit `provider` and the SDK picks the wallet from the browser. It uses `apple_web` on iOS, iPadOS, and Safari on macOS, and `google` everywhere else — including Chrome on macOS. Pass `provider` to force one.

## Retrieving results

Wallet verification writes to the onboarding session, not to your page. Read the results from your backend with the standard Incode result APIs:

- **OCR data** (`GET /omni/get/ocr-data`) — the verified identity attributes. For wallet verifications, `documentSubmissionMethod` is `IMPORTED_CREDENTIAL` and `credentialsProvider` names the wallet (for example, `APPLE` or `GOOGLE`).
- **Images** (`GET /omni/get/images`) — the mDL portrait.
- **Score** (`GET /omni/get/score`) — validation results for decisioning.
- **Webhooks** — session status transitions.

Treat `onSuccess` and the `finished` state as confirmation that the wallet response was submitted. Make the final decision from the session results.

## Recommended integration patterns

**For Incode Hosted onboarding app customers:**

1. Enable Digital IDs in the flow configuration.
2. Let the wallet option appear in the hosted chooser screen.
3. Use standard Incode session result and webhook handling after completion.


**For Web SDK customers using the built-in ID capture UI:**

1. Enable Digital IDs in the flow configuration.
2. Use the chooser wallet button by default.
3. Use the ID manager when you need to own the chooser and its entry points.




**For Web SDK customers with fully custom UI:**

1. Enable Digital IDs in the flow configuration.
2. Create your own wallet button.
3. Call `selectDocument('digitalId')` from the button handler when that option is available.
4. Subscribe to the ID manager's `deviceWallet`, `finished`, `error`, and `closed` states.
5. Fetch final results from the session using standard Incode result APIs.

## Error and fallback handling

Wallet presentation can fail when:

- The device or browser does not support Digital Credentials APIs.
- The user does not have a compatible digital ID in their wallet.
- The user cancels the wallet presentation.
- Apple Wallet domain approval is not complete.
- The wallet response cannot be decrypted or verified.

Your application should provide a fallback path, such as retrying wallet verification or continuing with physical ID capture.

## Testing

Test on a physical phone that has an ID in Apple Wallet or Google Wallet. The phone must load your page over HTTPS: a LAN address such as `http://192.168.1.20:5173` is not a secure context, so the SDK reports `UNSUPPORTED_PLATFORM`. For Apple Wallet, test on a domain approved for your integration.

- **Google Wallet** offers a sandbox with test ID passes. Follow Google's [sandbox](https://developers.google.com/wallet/identity/verify/sandbox) and [test ID pass](https://developers.google.com/wallet/identity/verify/create-test-id) guides, or the device setup in Incode's [Google Wallet ID testing steps](https://developer.incode.com/sdk-reference/android-google-wallet-id/#test-google-wallet-id). Use a dedicated test device and account — switching Google Wallet environments can affect existing Wallet data.
- **Apple Wallet** needs an ID provisioned in Wallet on the test iPhone. Ask your Incode Representative about Apple Wallet test options.

## Troubleshooting

| Symptom | Likely cause | Fix |
| ------- | ------------ | --- |
| `UNSUPPORTED_PLATFORM` on a phone that has an ID in the wallet | The page loads over plain HTTP, runs in an in-app WebView, or the browser lacks the Digital Credentials API | Open the page over HTTPS in a current Safari (iOS) or Chrome (Android) |
| `WALLET_ERROR` right after the tap | The wallet did not start inside the tap handler, or a cross-origin iframe lacks `allow="digital-credentials-get"` | Create the session before the tap, start the wallet in the handler, and grant the iframe permission |
| Apple Wallet works on one domain but not another | The failing domain is not approved for your integration yet | Confirm the domain with your Incode Representative |
| `NO_CREDENTIAL` although the wallet holds an ID | The ID does not match what Incode requests (issuing state or document type), or Google Wallet runs in a different environment (sandbox or production) than the ID | Check [Supported Digital IDs](https://developer.incode.com/general-reference/supported-digital-ids/) and the Google Wallet environment |

## Direct API integration

The SDK calls Incode's wallet endpoints for you. To run a wallet verification without the SDK, contact your Incode Representative — direct API access is available on request.

## Scope notes

- The integration model is flow-based. Requested attributes and enabled wallet methods are configured in Dashboard, not passed ad hoc from the browser.

## Related pages

- [Supported Digital IDs](/general-reference/supported-digital-ids/) for the full list of wallets, schemes, and attributes
- [ID Capture module configuration](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) for Dashboard setup

---

- Path: `sdk-reference/digital-id-redirect`
- URL: https://developer.incode.com/sdk-reference/digital-id-redirect/
- Markdown: https://developer.incode.com/sdk-reference/digital-id-redirect.md

# Digital ID: Bank Redirect
<Component slug="web-2-x-implementation-warning" />

The Digital ID bank redirect lets a user verify their identity with their bank instead of capturing a document. The SDK sends the user to the bank's own site in a **full-page redirect**; after the user authenticates, the bank returns them to your page and the flow resumes and completes. Verified identity data arrives as OCR-aligned interview data — no document capture, and no selfie-to-ID face match when the scheme returns no portrait.

Supported schemes:

| Scheme | Country | Portrait returned |
| ------ | ------- | ----------------- |
| iDIN (bank identification, PSD2-aligned) | Netherlands | No |
| FTN (bank IDs + Mobile ID, eIDAS) | Finland | No |

Because neither scheme returns a portrait, the flow skips the ID-to-selfie face match automatically for these verifications.

:::info
This is not a standalone step. It runs **inside the [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/) module**: every digital-ID method enabled for the flow gets **its own option** on the document chooser — one card per provider (for example **iDIN** and **Finnish Trust Network**), each with the provider's name and logo, alongside Identity Card and Passport. The list scrolls when many providers are enabled.
:::

## Prerequisites

- **Web SDK 2.0 enabled for the flow.** On a flow running the 1.x experience, the digital-ID configuration is ignored and the chooser never shows the option.
- **A digital-ID method on the flow's ID Capture module.** Enable iDIN or FTN for the flow in the dashboard. The flow configuration then carries it under `digitalIds.methods`.
- **A registered return URL.** The bank returns the user to your page's origin + path. Incode registers this per environment with the identity network — contact your Incode Representative with the exact URL (or origin wildcard) your integration uses. An unregistered return URL makes verification creation fail with HTTP 400.
- **A session that survives the redirect.** The round trip fully unloads your page. Launch the flow with a resumable session identifier (hosted onboarding links include one), or preserve one yourself — see [Surviving the redirect](#surviving-the-redirect).

## How the journey works

1. The user picks the provider's card (for example **iDIN**) in the ID Capture chooser (or the flow auto-starts it when it is the only method).
2. The SDK creates a verification and receives a bank `launchUrl`.
3. The SDK performs a full-page redirect to `launchUrl`. No popup, iframe, or webview is involved.
4. The user authenticates with their bank.
5. The bank redirects back to your return URL with `success`, `sessionId`, and `resultsAccessKey` appended as query parameters.
6. Your page re-mounts the flow and hands those parameters to the SDK, which resumes the step, submits the result, and shows a success screen. The user taps **Continue** and the flow proceeds.
7. On failure the user sees reason-specific copy with **Try again** and **Use another method** (falls back to the document chooser when the flow allows it).

## Configuration

Two config fields drive the redirect round trip. They have the same names and behavior on `<incode-flow>`, `<incode-workflow>`, and the standalone `<incode-id>` module:

| Option | Type | Required | Description |
| ------ | ---- | -------- | ----------- |
| `digitalIdReturnUrl` | `string` | ❌ | HTTPS page the bank returns the user to. Defaults to the current page (origin + pathname). Override it when your return route differs. Query parameters you add are preserved. |
| `digitalIdReturn` | `{ returnParams: RedirectReturnParams }` | ❌ | Pass on the **return leg only**. Hands the bank's return parameters to the SDK so it resumes the verification instead of starting the step fresh. |

```typescript
type RedirectReturnParams = {
  success: boolean;
  sessionId: string;
  resultsAccessKey: string;
};
```

### Return-leg wiring

Add your own marker to `digitalIdReturnUrl` so the return leg is detected unambiguously. A canceled verification can return **without** `sessionId` or `resultsAccessKey`, so detecting on those parameters misses cancellations:

```typescript
import type { FlowConfig } from '@incodetech/web/flow';

const config: FlowConfig = {
  clientId: 'YOUR_CLIENT_ID',
  configurationId: 'YOUR_FLOW_ID',
  // ...your existing options
  digitalIdReturnUrl: `${window.location.origin}${window.location.pathname}?digital_id_return=1`,
};
```

On the returning page load, detect the marker, hand the bank's parameters to the flow or workflow config, and remove them from the address bar (`resultsAccessKey` grants access to the result — do not let it linger in the URL or browser history):

```typescript
const params = new URLSearchParams(window.location.search);
const isDigitalIdReturn = params.get('digital_id_return') === '1';

if (isDigitalIdReturn) {
  config.digitalIdReturn = {
    returnParams: {
      success: params.get('success') === 'true',
      sessionId: params.get('sessionId') ?? '',
      resultsAccessKey: params.get('resultsAccessKey') ?? '',
    },
  };
  for (const p of ['digital_id_return', 'success', 'sessionId', 'resultsAccessKey']) {
    params.delete(p);
  }
  window.history.replaceState({}, '', `${window.location.pathname}?${params}`);
}
```

The bank may append additional parameters — read these three and ignore the rest.

## Surviving the redirect

The redirect unloads your page, so the returning page must re-attach to the **same** onboarding session. A fresh session does not know the verification and the resume fails.

- **Hosted onboarding links** (launched with a session identifier in the URL) resume automatically.
- **Self-hosted integrations**: persist a resumable session identifier before the flow mounts — for example in `sessionStorage`, which survives a same-tab redirect round trip — and pass it back into the flow or workflow config on the return leg.

The verification identifier itself is persisted by the SDK in browser storage and recovered on return; you only preserve the session.

## Failure handling

When the verification fails, the ID Capture state is `status: 'digitalIdRedirect'`, `phase: 'failed'`, with a `failureReason`:

| `failureReason` | Meaning |
| --------------- | ------- |
| `USER_CANCELED` / `RP_CANCELED` | The user backed out at the bank. Neutral copy — not an error. |
| `AUTHENTICATION_FAILED` | Bank authentication failed. Retry offered. |
| `VERIFICATION_FAILED` | The scheme could not verify the identity. |
| `SESSION_EXPIRED` / `SESSION_TOKEN_EXPIRED` | The verification session lapsed before completion. |
| `PROVIDER_INTERNAL_ERROR` / `RESULTS_EXCHANGE_FAILED` / `INVALID_REDIRECT_RESULT` | Technical error on the provider side. |

Drive recovery with the ID Capture manager: `digitalIdRedirectRetry()` starts a **new** verification, `digitalIdRedirectUseAnotherMethod()` returns to the document chooser, and `digitalIdRedirectContinue()` acknowledges the success screen.

> Each verification — including every retry — creates a new provider session, which is a billable event. Retries only happen on an explicit user action, never automatically.

## API endpoints

The module rides on the Digital ID Verification API. Direct API integrators use the same contract:

| Call | Purpose |
| ---- | ------- |
| `POST /omni/v2/digital-id/verifications` | Create a verification. Returns `verificationId` and `flowData.launchUrl` (billable moment). |
| `POST /omni/v2/digital-id/verifications/{id}/response` | Submit the bank's return parameters. |
| `GET /omni/v2/digital-id/verifications/{id}/status` | Poll verification status — fallback when results are delayed. |
| `POST /omni/v2/digital-id/verifications/{id}/refresh` | Refresh an expiring `launchUrl` without creating a new (billable) verification. |

Verification `status` values: `CREATED`, `IN_PROGRESS`, `COMPLETED`, `CANCELLED`, `FAILED`, `EXPIRED`.

## See also

- [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/): the module that hosts this sub-flow
- [Session Management](/sdk-reference/web-sdk-2-session-api/): session identifiers and re-attachment
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): `FlowConfig` reference

---

- Path: `sdk-reference/first-third-party-connections`
- URL: https://developer.incode.com/sdk-reference/first-third-party-connections/
- Markdown: https://developer.incode.com/sdk-reference/first-third-party-connections.md

# First/Third Party Connections

Use this table as a quick network dependency inventory for the Web SDK ecosystem. It identifies each external connection the code may make, explains why it is used, shows whether that connection is mandatory or conditional, and classifies it as first-party (Incode-owned domains) or third-party (vendor/external services). This helps with security/privacy reviews, vendor risk assessments, compliance documentation, and environment hardening by making it clear which integrations are required versus optional.

| Connection                          | Description                                                                                | Party           |
| ----------------------------------- | ------------------------------------------------------------------------------------------ | --------------- |
| `cdn.incodesmile.com`               | Hosts SDK WASM kit, FFmpeg assets, and translation fallback assets.                        | **First-party** |
| `sdk.incode.com`                    | Serves SDK tutorial/static assets.                                                         | **First-party** |
| `fingerprint.incodesmile.com`       | FingerprintJS Pro endpoint + loader host.                                                  | **First-party** |
| `demo-aps.incodesmile.com`          | Darwinium profiling script host.                                                           | **First-party** |
| `incode-production.firebaseapp.com` | Firebase app/auth domain used by raffle integration.                                       | **First-party** |
| `incode-production.firebaseio.com`  | Firebase Realtime DB endpoint used by raffle integration.                                  | **First-party** |
| `api.i18nexus.com`                  | Primary translations API for localization files.                                           | **Third-party** |
| `cdnjs.cloudflare.com`              | Serves PDF.js worker.                                                                      | **Third-party** |
| `cdn.jsdelivr.net`                  | Serves Lottie player script.                                                               | **Third-party** |
| `ingest.us.sentry.io`               | Sentry error/telemetry ingestion.                                                          | **Third-party** |
| `api.ipify.org`                     | Public IP lookup for fingerprint enrichment.                                               | **Third-party** |
| `api.sardine.ai`                    | Sardine risk SDK loader (production).                                                      | **Third-party** |
| `api.sandbox.sardine.ai`            | Sardine risk SDK loader (sandbox).                                                         | **Third-party** |
| `cdn.belvo.io`                      | Belvo widget script host.                                                                  | **Third-party** |
| `static.opentok.com`                | OpenTok browser SDK script host.                                                           | **Third-party** |
| `featureassets.org`                 | External asset host observed in network activity, not directly referenced. Used by Statsig | **Third-party** |
| `prodregistryv2.org`<br />          | External asset host observed in network activity, not directly referenced. Used by Statsig | **Third-party** |
| `static.opentok.com`                | OpenTok browser SDK script loaded for conferencing/video functionality.                    | **Third-party** |

<br />

---

- Path: `sdk-reference/flutter-api-reference`
- URL: https://developer.incode.com/sdk-reference/flutter-api-reference/
- Markdown: https://developer.incode.com/sdk-reference/flutter-api-reference.md

# API Reference

This page is the complete reference for every public API on the Flutter SDK's `IncodeOnboardingSdk` class. Each entry documents the method's signature, parameters, return value, and a short example.

For module-specific configuration parameters (those used when adding modules to a flow), see [Modules](./flutter-modules). For the shape of result objects and listener event payloads, see [Results](./flutter-results). For implementation patterns showing how methods compose into a full flow, see [Common Implementation Patterns](./flutter-common-implementation-patterns).

## init

Initializes the native Incode SDK. Must be called at least once per app lifecycle before any other operation.

**Signature**

```dart
IncodeOnboardingSdk.init({
bool loggingEnabled = true,
String? apiKey,
String? apiUrl,
String? e2eeUrl,
bool? testMode,
bool? externalAnalyticsEnabled,
bool? externalScreenshotsEnabled,
String? clientExperimentId,
SdkMode? sdkMode,
bool? sslPinningEnabled,
bool? forceSSLPinning,
bool? sendDiagnosticsData,
required Function() onSuccess,
required Function(String error) onError,
})
```

**Optional Parameters**

- `loggingEnabled`: If `true`, the SDK logs debug information to the console. Defaults to `true`.
- `apiKey`: API key provided by Incode.
- `apiUrl`: API base URL provided by Incode.
- `e2eeUrl`: E2EE base URL provided by Incode.
- `testMode`: Set to `true` when running the app on a simulator.
- `externalAnalyticsEnabled`: If `true`, the SDK sends analytics events to the external analytics provider. Defaults to `false`.
- `externalScreenshotsEnabled`: If `true`, the SDK allows screenshots to be taken. Defaults to `false`.
- `clientExperimentId`: If set, the SDK sends this value to the server for A/B testing. Defaults to `null`.
- `sdkMode`: Optional SDK operating mode applied during initialization (`SdkMode.standard`, `SdkMode.captureOnly`, or `SdkMode.submitOnly`). If omitted, the SDK uses `SdkMode.standard`. You can still change mode later with [setSdkMode](#setsdkmode). See [SDK Modes](./flutter-sdk-modes).
- `sslPinningEnabled`: If `true`, the SDK enables SSL pinning. Defaults to `false`.
- `forceSSLPinning`: If `true`, the SDK forces SSL pinning even if the server does not support it. Defaults to `false`.
- `sendDiagnosticsData` (iOS only): If `true`, the SDK collects and sends anonymized diagnostics data to Incode to help diagnose issues and improve reliability. If `false`, diagnostics data is not sent. If omitted (`null`), the native SDK default is used (`true`). Ignored on Android.

**Returns / Callbacks**

- `onSuccess()`: Called when the SDK is initialized successfully.
- `onError(String error)`: Called when initialization fails. The `error` String can be converted to an `IncodeSdkInitError` enum via `error.toIncodeSdkInitError()`. See [Results](./flutter-results). Tutorial screens are configured per module with `showTutorials`; see [Modules](./flutter-modules).

**Example**

```dart
IncodeOnboardingSdk.init(
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'YOUR_API_URL',
  testMode: false,
  sdkMode: SdkMode.standard,
  onError: (String error) {
    print('Incode init failed: $error');
  },
  onSuccess: () {
    print('Incode initialized successfully!');
  },
);
```

See [Installation](./flutter-installation).

## isInitialized

Checks whether the native Incode SDK has finished initialization. This method never throws; any platform error is handled internally and reported as `false`, so it is safe to use as a quick readiness check before starting a flow.

**Signature**

```dart
Future<bool> IncodeOnboardingSdk.isInitialized()
```

**Returns / Callbacks**

- Returns a `Future<bool>` that resolves to `true` when the SDK is ready to be used, and `false` otherwise.

**Example**

```dart
final bool ready = await IncodeOnboardingSdk.isInitialized();
if (ready) {
  // Safe to start onboarding
}
```

## startOnboarding

Creates a session and runs a complete, locally-defined onboarding flow end to end.

**Signature**

```dart
IncodeOnboardingSdk.startOnboarding({
  required OnboardingSessionConfiguration sessionConfig,
  required OnboardingFlowConfiguration flowConfig,
  OnboardingRecordSessionConfiguration? recordSessionConfig,
  required Function() onSuccess,
  required Function(String error) onError,
  Function(SelfieScanResult result)? onSelfieScanCompleted,
  Function(SelfieScanResult result)? onSelfieScanAttemptCompleted,
  Function(FaceMatchResult result)? onFaceMatchCompleted,
  Function(GeoLocationResult result)? onGeolocationCompleted,
  Function(PhoneNumberResult result)? onAddPhoneNumberCompleted,
  Function(VideoSelfieResult result)? onVideoSelfieCompleted,
  Function(OnboardingSessionResult result)? onOnboardingSessionCreated,
  Function(ApprovalResult result)? onApproveCompleted,
  Function(UserScoreResult result)? onUserScoreFetched,
  Function(GovernmentValidationResult result)? onGovernmentValidationCompleted,
  Function(AntifraudResult result)? onAntifraudCompleted,
  Function(DocumentScanResult result)? onDocumentScanCompleted,
  Function(SignatureResult result)? onSignatureCollected,
  Function(CaptchaResult result)? onCaptchaCompleted,
  Function(CurpValidationResult result)? onCurpValidationCompleted,
  Function(OCREditResult result)? onOCREditCompleted,
  Function(EKYBResult result)? onEKYBCompleted,
  Function(EKYCResult result)? onEKYCCompleted,
  Function(IdScanResult result)? onIdFrontCompleted,
  Function(IdScanResult result)? onIdBackCompleted,
  Function(IdScanResult result)? onIdFrontAttemptCompleted,
  Function(IdScanResult result)? onIdBackAttemptCompleted,
  Function(String ocrData)? onIdProcessed,
  Function(AddEmailResult result)? onAddEmailCompleted,
  Function(AddFullNameResult result)? onAddFullNameCompleted,
  Function(MLConsentResult result)? onMLConsentCompleted,
  Function(CustomWatchlistResult result)? onCustomWatchlistCompleted,
  Function(AesResult result)? onAesCompleted,
  Function(UserConsentResult result)? onUserConsentCompleted,
  Function(QRScanResult result)? onQRScanCompleted,
  Function(GlobalWatchlistResult result)? onGlobalWatchlistCompleted,
  Function(CombinedConsentResult result)? onCombinedConsentCompleted,
  Function(NFCScanResult result)? onNFCScanCompleted,
  Function(FaceAuthenticationResult result)? onFaceAuthenticationCompleted,
  Function()? onSSLPinningFailed,
  Function(OnEventsResult result)? onEvents,
  Function()? onUserCancelled,
})
```

**Required Parameters**

- `sessionConfig`: An `OnboardingSessionConfiguration` object that contains the configuration for the onboarding session.
- `flowConfig`: An `OnboardingFlowConfiguration` object that contains the configuration for the onboarding flow.

**Optional Parameters**

- `recordSessionConfig`: An `OnboardingRecordSessionConfiguration` object that contains the configuration for recording the onboarding session.

You can provide any of the following parameters to the `OnboardingSessionConfiguration` constructor:

- `region`: Region ISO code. Android only — iOS has no region parameter. No default; omit it to use the SDK default.
- `validationModules`: List of `OnboardingValidationModule` items. Determines which modules are used for verification and onboarding score calculation. If `null`, the defaults are used: id, faceRecognition, and liveness.
- `queue`: Name of the video conference queue. Defaults to `null`, which uses the default queue.
- `customFields`: Custom fields sent to the server.
- `externalId`: User identifier outside of the Incode Omni database. If a session with the same `externalId` already exists, it is resumed; otherwise, a new session is created.
- `externalCustomerId`: Identifier linking the onboarding session to an entity in an external system. Typically used to represent a prospect ID or customer ID from your own database.
- `interviewId`: Unique identifier of an existing session. Resumes that session.
- `token`: Token of an existing session. Resumes that session. See [Token-Based Setup](./flutter-token-based-setup).
- `configurationId`: Flow URL/ID from Dashboard. On this pattern, the locally configured flow still executes; the `configurationId` does not take precedence. To run a Dashboard-configured Flow, see [Run Flows Configured Online](./flutter-run-flows-configured-online).
- `e2eEncryptionEnabled`: Enables End-to-End Encryption for the session. See [End-to-End Encryption (E2EE)](./flutter-e2ee).
- `voiceConsentLanguage`: Language code used for the voice consent reading during the Video Selfie step. Supported values: `en`, `es`, `pt`, `he`. Other values fall back to `en`. Codes are mapped to specific locales: `en` → `en-US`, `es` → `es-ES`, `pt` → `pt-BR`, `he` → `he-IL`.

**Returns / Callbacks**

- `onSuccess()`: Called when the onboarding flow completes successfully.
- `onError(String error)`: Called when an error occurs. The `error` String can be converted to an `IncodeSdkFlowError` enum via `error.toIncodeSdkFlowError()`. See [Results](./flutter-results).
- `onUserCancelled()`: Called when the user cancels the onboarding flow.
- Per-module step callbacks: Add the callbacks for modules whose results you want to receive as they complete. See [Results](./flutter-results) for the full list of available listeners and their payloads.
- `onSSLPinningFailed()`: Called when SSL pinning fails.
- `onEvents(OnEventsResult result)`: Called when a tracking event occurs during the onboarding flow. See [Results](./flutter-results).

**Example**

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration();

OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
flowConfig.addIdScan();
flowConfig.addSelfieScan();
flowConfig.addFaceMatch();

OnboardingRecordSessionConfiguration recordSessionConfig = OnboardingRecordSessionConfiguration(
  recordSession: true,
  forcePermission: false,
);

IncodeOnboardingSdk.startOnboarding(
  sessionConfig: sessionConfig,
  flowConfig: flowConfig,
  recordSessionConfig: recordSessionConfig,
  onSuccess: () {
    print('Incode Onboarding completed!');
  },
  onError: (String error) {
    print('Incode onboarding error: $error');
  },
  onSelfieScanCompleted: (SelfieScanResult result) {
    print('Selfie completed result: $result');
  },
  onIdFrontCompleted: (IdScanResult result) {
    print('onIdFrontCompleted result: $result');
  },
  onIdBackCompleted: (IdScanResult result) {
    print('onIdBackCompleted result: $result');
  },
  onIdProcessed: (String ocrData) {
    print('onIdProcessed result: $ocrData');
  },
);
```

See [Configure Flows Locally and Run End to End](./flutter-configure-flows-locally-and-run-end-to-end).

## setupOnboardingSession

Creates an onboarding session without starting any flow. Before calling any other Onboarding SDK component that operates on a session (for example, [`startOnboardingSection`](/sdk-reference/flutter-api-reference/#startonboardingsection)), you must set up an onboarding session first.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setupOnboardingSession({
  required OnboardingSessionConfiguration sessionConfig,
  required Function(OnboardingSessionResult result) onSuccess,
  required Function(String error) onError,
})
```

**Required Parameters**

- `sessionConfig`: An `OnboardingSessionConfiguration` object. Can be configured in the same way as for [`startOnboarding`](./flutter-api-reference#startonboarding).

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(OnboardingSessionResult result)`: Delivers the created session details.
- `onError(String error)`: Delivers the error message on failure.

**Example**

```dart
OnboardingSessionConfiguration sessionConfiguration = OnboardingSessionConfiguration();

IncodeOnboardingSdk.setupOnboardingSession(
  sessionConfig: sessionConfiguration,
  onError: (String error) {
    print('Incode onboarding session error: $error');
  },
  onSuccess: (OnboardingSessionResult result) {
    print('Incode Onboarding session created! $result');
  },
);
```

See [Configure Flows Locally and Run Step by Step](./flutter-configure-flows-locally-and-run-step-by-step).

## startOnboardingSection

:::info
**Renamed in 4.23.0**. This method was called `startNewOnboardingSection`, and `sectionTag` was called `flowTag`. See the [Migration Guide](/release-notes/flutter-migration-guide/#startonboardingsection).
:::

Once a new onboarding session is created (see [`setupOnboardingSession`](/sdk-reference/flutter-api-reference/#setuponboardingsession)), you can separate the Onboarding SDK flow into multiple sections based on your needs. Each section runs the modules defined in its `flowConfig` and is identified by a `sectionTag`.

Only one section can run at a time. Start the next section from `onSuccess` of the previous one, or later. After a cancel, call `setupOnboardingSession` again before you start the next section.

**Signature**

```dart
IncodeOnboardingSdk.startOnboardingSection({
  required OnboardingFlowConfiguration flowConfig,
  required String sectionTag,
  OnboardingRecordSessionConfiguration? recordSessionConfig,
  Function(String sectionTag)? onSuccess,
  required Function(String error) onError,
  Function(String sectionTag)? onOnboardingSectionCompleted, // deprecated, use onSuccess
  Function()? onUserCancelled,
  // ...optional per-module step callbacks (see startOnboarding)
})
```

**Required Parameters**

- `flowConfig`: An `OnboardingFlowConfiguration` object that defines which modules run in this section.
- `sectionTag`: An identifier for the section. It must not be blank. Returned via `onSuccess`.

**Optional Parameters**

- `recordSessionConfig`: An `OnboardingRecordSessionConfiguration` object that contains the configuration for recording the session.

**Returns / Callbacks**

- `onSuccess(String sectionTag)`: Called once when the section finished, with the identifier of the finished section. Start the next section from here.
- `onOnboardingSectionCompleted(String sectionTag)`: **Deprecated**, use `onSuccess`. Called with the same tag just before `onSuccess`.
- `onError(String error)`: Called when the section could not start or ended with an error. Receives an `IncodeSdkFlowError` code; convert it with `error.toIncodeSdkFlowError()`. Codes reported before the section starts:

  | Code | Platform | Cause |
  |---|---|---|
  | `configError` | Both | `sectionTag` is blank, `recordSessionConfig` is invalid, or a module in `flowConfig` is configured incorrectly. |
  | `unknownModule` | Both | `flowConfig` names a module this SDK version does not support. |
  | `sectionAlreadyRunning` | Both | Another section has not finished yet. The running section is not affected. |
  | `activityNotPresent` | Both | There is no host Activity (Android) or view controller (iOS). |
  | `noActiveSession` | Both | There is no onboarding session. Call [`setupOnboardingSession`](/sdk-reference/flutter-api-reference/#setuponboardingsession) first. |

- `onUserCancelled()`: Called when the user cancels the section. Without it, a cancel calls `onError` with `userCancelled`.
- Per-module step callbacks: This method also accepts the same optional per-module step callbacks as [`startOnboarding`](./flutter-api-reference#startonboarding) (for example, `onSelfieScanCompleted`, `onIdFrontCompleted`, `onIdBackCompleted`, `onIdProcessed`, `onFaceMatchCompleted`, `onEvents`).

**Example**

```dart
OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
flowConfig.addIdScan();

IncodeOnboardingSdk.startOnboardingSection(
  flowConfig: flowConfig,
  sectionTag: 'idSection',
  onError: (String error) {
    print('Incode onboarding section error: $error');
  },
  onIdFrontCompleted: (IdScanResult result) {
    print('onIdFrontCompleted result: $result');
  },
  onIdBackCompleted: (IdScanResult result) {
    print('onIdBackCompleted result: $result');
  },
  onIdProcessed: (String ocrData) {
    print('onIdProcessed result: $ocrData');
  },
  onSuccess: (String sectionTag) {
    // The section finished: start the next one or call finishFlow.
  },
);
```

See [Configure Flows Locally and Run Step by Step](/sdk-reference/flutter-configure-flows-locally-and-run-step-by-step).

## finishFlow

Finishes the current onboarding session for section-based flows. Call `finishFlow()` at the end of the flow, when you are sure the user has finished all onboarding modules and you won't be reusing the same `interviewId` again.

`finishFlow()` is only required for section-based flows (those started with [`startOnboardingSection`](/sdk-reference/flutter-api-reference/#startonboardingsection)). Do not call it for flows started with [`startOnboarding`](./flutter-api-reference#startonboarding).

**Signature**

```dart
Future<void> IncodeOnboardingSdk.finishFlow({
  Function()? onSuccess,
  Function(String error)? onError,
})
```

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess()`: Called when the flow is finished successfully.
- `onError(String error)`: Called when finishing the flow fails.

**Example**

```dart
IncodeOnboardingSdk.finishFlow();
```

## startFlow

Starts a server-configured Flow based on the `OnboardingSessionConfiguration` provided. Specify the `configurationId`, and optionally the `interviewId` to resume a session and/or `moduleId` to start from a specific step within the flow.

**Signature**

```dart
IncodeOnboardingSdk.startFlow({
  required OnboardingSessionConfiguration sessionConfig,
  String? moduleId,
  required Function() onSuccess,
  required Function(String error) onError,
  Function()? onUserCancelled,
  // ...optional per-module step callbacks (see startOnboarding)
})
```

**Required Parameters**

- `sessionConfig`: An `OnboardingSessionConfiguration` object. Set its `configurationId` (or `token`) and optionally `interviewId`.

**Optional Parameters**

- `moduleId`: Identifier of the step to start from within the flow (for example, `"PHONE"`). See [Modules](./flutter-modules) for the list of valid module IDs. An unknown or empty value starts from the first step.

**Returns / Callbacks**

- `onSuccess()`: Called when the Flow completes successfully.
- `onError(String error)`: Called when an error occurs during the Flow. Receives an `IncodeSdkFlowError` code; convert it with `error.toIncodeSdkFlowError()`. If the Flow cannot start, it is called with `activityNotPresent` (no host Activity or view controller) or `configError` (`sessionConfig` has neither a `configurationId` nor a `token`).
- `onUserCancelled()`: Called when the user cancels the Flow.
- Per-module step callbacks: This method also accepts the same optional per-module step callbacks as [`startOnboarding`](./flutter-api-reference#startonboarding).

**Example**

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration(
  configurationId: "YOUR_CONFIGURATION_ID",
  interviewId: "YOUR_INTERVIEW_ID", // optional
);

IncodeOnboardingSdk.startFlow(
  sessionConfig: sessionConfig,
  moduleId: 'YOUR_MODULE_ID', // optional, e.g., "PHONE"
  onError: (String error) {
    print('Incode startFlow error: $error');
  },
  onSuccess: () {
    print('Incode startFlow completed!');
  },
  onUserCancelled: () {
    print('User cancelled');
  },
);
```

See [Run Flows Configured Online](./flutter-run-flows-configured-online).

## startWorkflow

Starts a server-defined Workflow for the provided `OnboardingSessionConfiguration`. The set of modules that run is determined by the Workflow configured in Dashboard, rather than by a locally-defined `flowConfig`.

**Signature**

```dart
IncodeOnboardingSdk.startWorkflow({
  required OnboardingSessionConfiguration sessionConfig,
  required Function() onSuccess,
  required Function(String error) onError,
  Function()? onUserCancelled,
  // ...optional per-module step callbacks (see startOnboarding)
})
```

**Required Parameters**

- `sessionConfig`: An `OnboardingSessionConfiguration` object. Set its `configurationId` to point at the Workflow configured in Dashboard, or set `token` to an external session token from your backend. At least one must be a non-empty string; `interviewId` alone is not enough.

**Optional session parameters**

- `mergeSessionRecordings`: `bool`. Merges the session recordings produced by the Workflow into a single recording. This parameter is honoured by `startWorkflow` only — the other entry points that take an `OnboardingSessionConfiguration` ignore it. Omit it to keep the native SDK default.

**Returns / Callbacks**

- `onSuccess()`: Called when the Workflow completes successfully.
- `onError(String error)`: Called when an error occurs during the Workflow. Receives an `IncodeSdkFlowError` code; convert it with `error.toIncodeSdkFlowError()`. If `sessionConfig` has neither a `configurationId` nor a `token`, it is called with `configError` before the Workflow starts, and no network request is made.
- `onUserCancelled()`: Called when the user cancels the Workflow.
- Per-module step callbacks: This method also accepts the same optional per-module step callbacks as [`startOnboarding`](./flutter-api-reference#startonboarding).

**Example**

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration(
  configurationId: "YOUR_CONFIGURATION_ID",
);

IncodeOnboardingSdk.startWorkflow(
  sessionConfig: sessionConfig,
  onError: (String error) {
    print('Incode startWorkflow error: $error');
  },
  onSuccess: () {
    print('Incode startWorkflow completed!');
  },
  onUserCancelled: () {
    print('User cancelled');
  },
);
```

See [Run Flows Configured Online](./flutter-run-flows-configured-online).

## startFlowFromDeepLink

Starts a flow from a deep link URL.

**Signature**

```dart
IncodeOnboardingSdk.startFlowFromDeepLink({
  required String url,
  required Function() onSuccess,
  required Function(String error) onError,
  Function()? onUserCancelled,
  // ...optional per-module step callbacks (see startOnboarding)
})
```

**Required Parameters**
* `url`: Deep link URL.

**Returns / Callbacks**

- `onSuccess()`: Called when the Flow completes successfully.
- `onError(String error)`: Called when an error occurs during the Flow.
- `onUserCancelled()`: Called when the user cancels the Flow.
- Per-module step callbacks: This method also accepts the same optional per-module step callbacks as [startOnboarding](./flutter-api-reference#startonboarding).

**Example**

```dart
IncodeOnboardingSdk.startFlowFromDeepLink(
  url: "YOUR_DEEP_LINK_URL",
  onSuccess: () {
    print('Incode startFlowFromDeepLink completed!');
  },
  onError: (String error) {
    print('Incode startFlowFromDeepLink error: $error');
  },
  onUserCancelled: () {
    print('User cancelled');
  },
);
```

## faceMatch

Programmatically initiates a face match between the photo from the ID and the selfie. Matches silently in the background, in contrast to the regular `FaceMatch` module that shows UI feedback to the user. This API can only be used during an active session.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.faceMatch({
  FaceMatchType? matchType,
  String? interviewId,
  IdCategory? idCategory,
  required Function() onSuccess,
  required Function(String code, String message, PlatformException? cause) onError,
  Function(FaceMatchResult faceMatchResult)? onFaceMatchCompleted,
  Function()? onUserCancelled,
})
```

**Optional Parameters**

- `matchType`: `FaceMatchType.idSelfie`, `FaceMatchType.nfcSelfie`, or `FaceMatchType.nfc3Way`. Selects which sources are compared.
- `interviewId`: Identifier of the session to run the match against.
- `idCategory`: `IdCategory.primary` or `IdCategory.secondary`. Selects which scanned ID to use.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess()`: Called when the face match completes successfully.
- `onError(String code, String message, PlatformException? cause)`: Called when the operation fails. `message` carries the native detail; `cause` wraps the underlying native exception when there is one, and is always `null` on iOS.

| `code` | Meaning | Platforms |
|--------|---------|-----------|
| `faceMatchError` | Any native failure. | both |
| `userCancelled` | The user dismissed the operation. Reported here only when no `onUserCancelled` callback is supplied. | Android only — the native iOS SDK has no distinct cancellation signal, so a cancellation there is reported as `faceMatchError`. |
| `methodNotSupportedByBridge` | The installed native bridge has no handler for this method — the plugin's native dependency is older than its Dart layer. | Android only |
| `bridgeFailure` | The native call threw before producing a result. | Android only |

- `onFaceMatchCompleted(FaceMatchResult result)`: Delivers the `FaceMatchResult` payload. See [Results](./flutter-results).
- `onUserCancelled()`: Called when the user cancels. **Android only** — the native iOS SDK has no distinct cancellation signal, so on iOS a cancellation reaches `onError` as `faceMatchError`. Supplying `onUserCancelled` is optional: without it, an Android cancellation arrives at `onError` as `userCancelled`, so you can branch there instead. Either way no platform check is needed.

**Example**

```dart
IncodeOnboardingSdk.faceMatch(
  onError: (String code, String message, PlatformException? cause) {
    print('FaceMatch error: $code - $message');
  },
  onSuccess: () {
    print('FaceMatch completed!');
  },
  onUserCancelled: () {
    print('FaceMatch cancelled by user.');
  },
  onFaceMatchCompleted: (FaceMatchResult result) {
    print('FaceMatch result: $result');
  },
);
```

## approve

Programmatically approves the user by running the approval section on its own, without displaying a user interface. This API can only be used during an active session, so call it after `setupOnboardingSession` (or after a `start` method) has succeeded.

**Signature**

```dart
void IncodeOnboardingSdk.approve({
  bool forceApproval = false,
  required Function(ApprovalResult result) onSuccess,
  required Function(String code, String message) onError,
  Function()? onUserCancelled,
})
```

**Optional Parameters**

- `forceApproval`: Approves the user regardless of the onboarding score. Defaults to `false`.

**Returns / Callbacks**

Exactly one callback fires per call.

- `onSuccess(ApprovalResult result)`: Called when the approval section completed. An approval that ran but did not approve the user is reported here with `result.success` set to `false`; it is not an error. See [Results](/sdk-reference/flutter-results/).
- `onUserCancelled()`: Called when the user dismissed the section. If omitted, cancellation is reported to `onError` with the code `userCancelled`.
- `onError(String code, String message)`: Called when the section failed. `code` is one of:

  | `code` | Platform | Meaning |
  |--------|----------|---------|
  | `userCancelled` | Both | The user dismissed the section and `onUserCancelled` was not provided. |
  | `approvalError` | Android | The approval flow could not be configured. |
  | `permissionsDenied`, `integrityCompromised`, `faceAuthenticationFailed`, `sslPinningFailed`, `unknown` | Both | An `IncodeSdkFlowError` value reported by the native SDK. |

  `message` is a human-readable description of the failure.

**Example**

```dart
IncodeOnboardingSdk.approve(
  onSuccess: (ApprovalResult result) {
    if (result.success) {
      print('User approved: ${result.uuid}');
    } else {
      print('User was not approved');
    }
  },
  onError: (String code, String message) {
    print('Approve error: $code — $message');
  },
  onUserCancelled: () {
    print('Approve cancelled by user.');
  },
);
```

## setTheme

Applies a custom theme to the SDK UI.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setTheme({
  required String theme,
})
```

**Required Parameters**

- `theme`: JSON string containing the theme configuration.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
import 'dart:convert';

await IncodeOnboardingSdk.setTheme(
  theme: jsonEncode({
    'primaryColor': '#0000FF',
  }),
);
```

See [Customization](./flutter-customization) for the full theme schema.

## setSdkMode

Sets the SDK operating mode, controlling whether the SDK captures data, submits it, or both.

You can also pass `sdkMode` to [init](#init) to set the mode during initialization. Use `setSdkMode` to change it later.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setSdkMode({
  required SdkMode sdkMode,
})
```

**Required Parameters**

- `sdkMode`: `SdkMode.captureOnly`, `SdkMode.submitOnly`, or `SdkMode.standard`.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
await IncodeOnboardingSdk.setSdkMode(sdkMode: SdkMode.standard);
```

See [SDK Modes](./flutter-sdk-modes).

## showCloseButton

Displays an 'X' button on the top right of each module so the user can cancel the flow at any point.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.showCloseButton({
  required bool allowUserToCancel,
})
```

**Required Parameters**

- `allowUserToCancel`: If `true`, the close button is shown and the user can cancel the flow.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
IncodeOnboardingSdk.showCloseButton(allowUserToCancel: true);
```

## setLocalizationLanguage

Overrides the language used for the SDK UI strings.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setLocalizationLanguage({
  required String language,
})
```

**Required Parameters**

- `language`: The language code to use (for example, `"en"` or `"es"`). See [Customization](./flutter-customization) for the full list of supported codes.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
await IncodeOnboardingSdk.setLocalizationLanguage(language: 'es');
```

## setString

Overrides individual UI strings by key, allowing custom copy without changing the localization language.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setString({
  required Map<String, dynamic> strings,
})
```

**Required Parameters**

- `strings`: A map of string keys to their override values.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
await IncodeOnboardingSdk.setString(strings: {
  'selfie_scan_title': 'Take a selfie',
});
```

Additionally, on Android, a new dependency needs to be added to your `app/build.gradle`:

```gradle
  implementation 'com.incode.sdk:extensions:1.2.1'
```

See [Customization](./flutter-customization) for platform-specific string key references.

## setQuantityStrings

Overrides pluralized (quantity) strings in runtime. This method is supported on Android only.

**Signature**

```dart
Future<void> setQuantityStrings({
  required String locale,
  required Map<String, Map<String, String>> quantityStrings,
  Function()? onSuccess,
  Function(String code, String message, PlatformException? cause)? onError
})
```

**Required Parameters**

- `locale`: A BCP 47 language tag such as `"en"`, `"es"`, or `"en-US"`.
- `quantityStrings`: A nested map, keyed first by plural name and then by quantity keyword: `plural name -> quantity keyword -> value`. Keywords are `'zero'`, `'one'`, `'two'`, `'few'`, `'many'` and `'other'`. They are not case-sensitive.


**Returns / Callbacks**
- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess()`: Called when the operation succeeds.
- `onError(String code, String message, PlatformException? cause)`: Called when the operation fails. `cause` is the optional underlying native exception.

**Example**

```dart
Map<String, Map<String, String>> quantityStrings = {
  'onboard_sdk_validation_attempts_remaining': {
    'one': '%d attempt remaining',
    'other': '%d attempts remaining',
  },
};
await IncodeOnboardingSdk.setQuantityStrings(locale: 'en', quantityStrings: quantityStrings);
```

Additionally, on Android, a new dependency needs to be added to your `app/build.gradle`:

```gradle
  implementation 'com.incode.sdk:extensions:1.2.1'
```

See [Customization](./flutter-customization) for platform-specific string key references.

## getUserScore

Fetches the current onboarding session user score at any point.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.getUserScore({
  UserScoreFetchMode? fetchMode,
  String? interviewId,
  required Function(UserScoreResult result) onSuccess,
  required Function(String error) onError,
})
```

**Optional Parameters**

- `fetchMode`: `UserScoreFetchMode.fast` or `UserScoreFetchMode.accurate`. Controls the trade-off between speed and accuracy. Defaults to `accurate` when omitted.
- `interviewId`: Targets a specific interview. When omitted, the current session is used.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(UserScoreResult result)`: Delivers the score. See [Results](/sdk-reference/flutter-results/#getuserscore) for the full `UserScoreResult` shape.
- `onError(String error)`: Called when the operation fails, with one of:
  - `userScoreFailed`: No score could be retrieved — a transport or HTTP failure, or a session that only submitted data without scoring it.
  - `userCancelled`: The user canceled. Android only; this call presents no UI on iOS.

**Example**

```dart
IncodeOnboardingSdk.getUserScore(
  fetchMode: UserScoreFetchMode.accurate,
  onSuccess: (UserScoreResult result) {
    print("userScore: $result");
  },
  onError: (String error) {
    print("userScore error: $error");
  },
);
```

## idProcess

Processes IDs programmatically without displaying a user interface (non-UI ID processing).

**Signature**

```dart
Future<void> IncodeOnboardingSdk.idProcess({
  IdCategory? idCategory,
  required Function(IdProcessResult result) onSuccess,
  required Function(String error) onError,
})
```

**Optional Parameters**

- `idCategory`: `IdCategory.primary` or `IdCategory.secondary`. Selects which ID to process.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(IdProcessResult result)`: Called when processing completes. See [Results](./flutter-results) for the `IdProcessResult` shape.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
IncodeOnboardingSdk.idProcess(
  idCategory: IdCategory.primary,
  onSuccess: (IdProcessResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

## startFaceLogin

Authenticates a returning user by their face. A prerequisite for successful Face Login is that the user has an approved account with an enrolled face. Pass a `customerUUID` on the `FaceLogin` object to perform a 1:1 comparison, or omit it to perform a 1:N database lookup.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.startFaceLogin({
  required FaceLogin faceLogin,
  required Function(FaceLoginResult result) onSuccess,
  required Function(String error) onError,
})
```

**Required Parameters**

- `faceLogin`: A `FaceLogin` object describing how the login should run. For the full set of configuration parameters (authentication modes, face mask check, lenses check, log authentication, E2EE), see [Face Login](./flutter-face-login).

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(FaceLoginResult result)`: Called when the login completes. See [Results](./flutter-results) for the full `FaceLoginResult` shape.
- `onError(String error)`: Called when the login fails.

**Example**

1:1 Face Login:

```dart
IncodeOnboardingSdk.startFaceLogin(
  faceLogin: FaceLogin(customerUUID: "yourCustomerUUID"),
  onSuccess: (FaceLoginResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

1:N Face Login:

```dart
IncodeOnboardingSdk.startFaceLogin(
  faceLogin: FaceLogin(),
  onSuccess: (FaceLoginResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

See [Face Login](./flutter-face-login).

## addNOM151Archive

Generates and fetches a NOM-151 archive for the current session.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.addNOM151Archive({
  required Function(AddNom151Result result) onSuccess,
  required Function(String error) onError,
})
```

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(AddNom151Result result)`: Called when the archive is generated. The result contains `signature` and `archiveUrl` String fields.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
IncodeOnboardingSdk.addNOM151Archive(
  onSuccess: (AddNom151Result addNom151Result) {
    String? signature = addNom151Result.signature;
    String? archiveUrl = addNom151Result.archiveUrl;
  },
  onError: (String error) {
    print('Incode addNOM151Archive error: $error');
  },
);
```

## addFace

Adds a single identity to the local database. Used with the SDK `-l` variant for 1:N `FaceAuthMode.local` Face Login.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.addFace({
  required FaceInfo faceInfo,
  required Function(bool result) onSuccess,
  required Function(String error) onError,
})
```

**Required Parameters**

- `faceInfo`: A `FaceInfo` object containing:
  - `faceTemplate`: String. Biometric representation of a user's face.
  - `customerUUID`: String. Unique customer identifier in Incode's database.
  - `templateId`: String. Unique identifier of the biometric face representation in Incode's database.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(bool result)`: Called when the identity is added. `result` is `true` on success.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
FaceInfo faceInfo = FaceInfo(template, uuid, templateId);

IncodeOnboardingSdk.addFace(
  faceInfo: faceInfo,
  onSuccess: (bool result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

See [Face Login](./flutter-face-login).

## removeFace

Removes a single identity from the local database.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.removeFace({
  required String customerUUID,
  required Function(bool result) onSuccess,
  required Function(String error) onError,
})
```

**Required Parameters**

- `customerUUID`: The unique customer identifier of the identity to remove.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(bool result)`: Called when the identity is removed. `result` is `true` on success.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
IncodeOnboardingSdk.removeFace(
  customerUUID: "your_customer_uuid",
  onSuccess: (bool result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

See [Face Login](./flutter-face-login).

## getFaces

Fetches all currently stored identities from the local database.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.getFaces({
  required Function(List<FaceInfo> result) onSuccess,
  required Function(String error) onError,
})
```

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(List<FaceInfo> result)`: Called with the list of stored identities.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
IncodeOnboardingSdk.getFaces(
  onSuccess: (List<FaceInfo> faceInfos) {
    print("faceInfos: $faceInfos");
  },
  onError: (String error) {
    print(error);
  },
);
```

See [Face Login](./flutter-face-login).

## setFaces

Replaces the local database with the provided list of identities. Wipes all currently stored identities before adding the new ones. Pass an empty list to clear the database.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setFaces({
  required List<FaceInfo> faces,
  required Function(bool result) onSuccess,
  required Function(String error) onError,
})
```

**Required Parameters**

- `faces`: The list of `FaceInfo` objects to store. Pass an empty list (`List.empty()`) to clear the database.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(bool result)`: Called when the identities are stored. `result` is `true` on success.
- `onError(String error)`: Called when the operation fails.

**Example**

Replace existing identities with a new set:

```dart
final faceInfos = <FaceInfo>[
  FaceInfo("your_face_template", "your_customer_uuid", "your_template"),
  FaceInfo("your_face_template2", "your_customer_uuid2", "your_template2"),
];

IncodeOnboardingSdk.setFaces(
  faces: faceInfos,
  onSuccess: (bool result) {
    print("result: $result");
  },
  onError: (String error) {
    print(error);
  },
);
```

Clear the local database by passing an empty list:

```dart
IncodeOnboardingSdk.setFaces(
  faces: List.empty(),
  onSuccess: (bool result) {
    print("result: $result");
  },
  onError: (String error) {
    print(error);
  },
);
```

See [Face Login](./flutter-face-login).

## getUserOCRData

Fetches the user OCR data for a specific session.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.getUserOCRData({
  String? token,
  required Function(GetUserOCRDataResult result) onSuccess,
  required Function(String error) onError,
})
```

**Optional Parameters**

- `token`: Session token identifying the session to fetch OCR data for.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess(GetUserOCRDataResult result)`: Called with the OCR data. The result's `ocrData` String field contains the full OCR data in JSON format.
- `onError(String error)`: Called when the operation fails.

**Example**

```dart
IncodeOnboardingSdk.getUserOCRData(
  token: "{SESSION_TOKEN}",
  onSuccess: (GetUserOCRDataResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

## setFaceAuthenticationHint

Provides an identity hint to speed up face authentication by indicating which identity is expected.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setFaceAuthenticationHint({
  required String identityId,
})
```

**Required Parameters**

- `identityId`: The identifier of the identity to hint at.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
await IncodeOnboardingSdk.setFaceAuthenticationHint(identityId: 'your_identity_id');
```

## setLogo

Sets a custom logo for the SDK screens. The logo shows on every UX V2 screen, for example `FaceAuthentication`, and on the legacy screens. Call it after `init` and before you start a flow. You can call it before or after `setTheme`: `setTheme` does not reset the logo.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setLogo({
  required String logo,
  Function()? onSuccess,
  Function(String code, String message)? onError,
})
```

**Required Parameters**

- `logo`: Name of an image of your app. Use the same name on both platforms.
  - Android: a drawable resource name (`res/drawable/<name>`). On V2 screens, use a vector drawable or a raster image (PNG, JPG, or WebP). V2 screens do not support other XML drawables, for example `layer-list`, `selector`, or `shape`. On legacy screens, the logo requires the Android `com.incode.sdk:extensions` dependency.
  - iOS: an image asset name from your asset catalog or main bundle.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.
- `onSuccess()`: Called when the logo is set.
- `onError(String code, String message)`: Called with `appearanceError` if `logo` is empty, or if the name does not match an image of your app. The SDK then keeps its current logo.

**Example**

```dart
await IncodeOnboardingSdk.setLogo(
  logo: 'my_logo',
  onError: (String code, String message) {
    print('setLogo failed: $code $message');
  },
);
```

**Android: keep the drawable in release builds**

On Android, the logo is a drawable resource of your app. The SDK finds it by name at runtime, so no code refers to it. When resource shrinking is on (`shrinkResources true`), the Android shrinker removes the drawable from release builds. `setLogo` then works in debug builds but calls `onError` with `appearanceError` in release builds. To keep the drawable, add it to `android/app/src/main/res/raw/keep.xml`:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

## setUXConfig

Applies a custom UX configuration to the SDK.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.setUXConfig({
  required String jsonConfig,
})
```

**Required Parameters**

- `jsonConfig`: JSON string containing the UX configuration.

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the native call resolves.

**Example**

```dart
import 'dart:convert';

await IncodeOnboardingSdk.setUXConfig(
  jsonConfig: jsonEncode({
    'showProgressBar': true,
  }),
);
```

For the supported UX configuration keys, see the [Android customization guide](/sdk-reference/android-customization/#configure-v2-theme-and-ux) or the [iOS customization guide](/sdk-reference/ios-customization/#configure-v2-theme-and-ux).


## deleteLocalUserData

Deletes all locally stored user data on the device.

**Signature**

```dart
Future<void> IncodeOnboardingSdk.deleteLocalUserData()
```

**Returns / Callbacks**

- Returns a `Future<void>` that completes once the data has been deleted.

**Example**

```dart
await IncodeOnboardingSdk.deleteLocalUserData();
```

See [Delete Local Session Data](./flutter-delete-local-session-data).

---

- Path: `sdk-reference/flutter-common-implementation-patterns`
- URL: https://developer.incode.com/sdk-reference/flutter-common-implementation-patterns/
- Markdown: https://developer.incode.com/sdk-reference/flutter-common-implementation-patterns.md

# Common Implementation Patterns

Once the SDK is installed and initialized (see [Installation](./flutter-installation)), the next decision is how you drive the onboarding flow. The Flutter SDK supports three integration patterns. They differ in two ways: where the flow is defined (in your app code versus on the Incode Dashboard) and how much control your host application keeps while the flow runs.

This page explains each pattern and when to use it. Pick the one that fits your product, then follow its dedicated page for the full walkthrough.

## Where flows are defined

The three patterns split into two configuration models:

- **Configured locally.** You build an `OnboardingFlowConfiguration` in code, adding the modules you want and the order they run in. Patterns 1 and 2 use this model. See [Modules](./flutter-modules) for the catalog of modules you can add and their per-module configuration parameters.
- **Configured online.** The flow is defined on the Incode Dashboard as a Flow or a Workflow. Your code references it by `configurationId`, so you can change the configuration on the Dashboard without shipping a new app build. Pattern 3 uses this model.

## The three patterns

### 1. Run flows configured online (recommended)

Define the flow on the Incode Dashboard as a Flow or a Workflow, then start it with `startFlow()` or `startWorkflow()`, respectively. The SDK pulls the modules and configuration from the Dashboard, so you do not define an `OnboardingFlowConfiguration` locally. Make sure the Flow or Workflow is activated on Dashboard before starting the session.

Use this when you want to change the onboarding flow from Dashboard without releasing a new app version.

Walkthrough: [Run Flows Configured Online](./flutter-run-flows-configured-online)

### 2. Configure flows locally and run end to end

Build an `OnboardingFlowConfiguration` in code, then hand the whole flow to the SDK with a single `startOnboarding()` call. The SDK runs every module in sequence and returns control to your app when the flow finishes.

Use this when you want the simplest integration and the SDK can own the full onboarding experience from start to finish.

Walkthrough: [Configure Flows Locally and Run End to End](./flutter-configure-flows-locally-and-run-end-to-end)

### 3. Configure flows locally and run step by step

Build the flow as one or more sections in code and run each section with `startOnboardingSection()`. Control returns to your host application between sections, so you can insert your own screens, run business logic, or branch the flow based on intermediate results before starting the next section.

Use this when you need to interleave your own UI or logic with the SDK modules, or split a long flow into discrete steps.

Walkthrough: [Configure Flows Locally and Run Step by Step](./flutter-configure-flows-locally-and-run-step-by-step)

## Choosing a pattern

| If you want to...                                         | Use                                 | Entry point                        |
| --------------------------------------------------------- | ----------------------------------- | ---------------------------------- |
| Change the flow from the Dashboard without an app release | Run flows configured online         | `startFlow()` or `startWorkflow()` |
| Run a full flow with the least code                       | Configure locally, run end to end   | `startOnboarding()`                |
| Insert your own screens or logic between SDK steps        | Configure locally, run step by step | `startOnboardingSection()`      |

## Example app

A working example app demonstrating these patterns is available on [GitHub](https://github.com/Incode-Technologies-Example-Repos/FlutterSampleApp). Contact your Customer Success Manager for access.

To run the example app, create a `.env` file in the example folder with your `apiKey` and `apiUrl` (provided by Incode). Run `flutter pub get`, then `flutter pub run build_runner build --delete-conflicting-outputs`, then launch the app. See the repo README for full setup details.

## Related pages

- [Modules](./flutter-modules): the module catalog for building an `OnboardingFlowConfiguration`.
- [Results](./flutter-results): the result and error objects returned when a flow finishes.
- [API Reference](./flutter-api-reference): the full specification of `startOnboarding()`, `startOnboardingSection()`, `startFlow()`, `startWorkflow()`, `OnboardingFlowConfiguration`, and `OnboardingSessionConfiguration`.

<br />

---

- Path: `sdk-reference/flutter-configure-flows-locally-and-run-end-to-end`
- URL: https://developer.incode.com/sdk-reference/flutter-configure-flows-locally-and-run-end-to-end/
- Markdown: https://developer.incode.com/sdk-reference/flutter-configure-flows-locally-and-run-end-to-end.md

# Configure Flows Locally and Run End to End

Use `startOnboarding()` when you want to configure the flow in your app code and run all modules end to end in a single call. This is the simplest pattern: configure the session, configure the flow, and start onboarding. The SDK handles every module in sequence and returns control to your app when the flow completes.

## When to use this pattern

Use this pattern when:

- You want to define your flow's modules in code rather than in Dashboard.
- You want all modules to run consecutively without intermediate control returned to your app.
- You don't need to interleave Incode SDK steps with your app's own screens.

For section-by-section execution with control returned between sections, see [Configure Flows Locally and Run Step by Step](./flutter-configure-flows-locally-and-run-step-by-step). For flows configured in Dashboard, see [Run Flows Configured Online](./flutter-run-flows-configured-online).

## Prerequisites

- The SDK is initialized. See [Installation](./flutter-installation).

## 1. Configure the onboarding session

Create an instance of `OnboardingSessionConfiguration`:

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration();
```

### Optional session parameters

You can pass any of the following parameters to the `OnboardingSessionConfiguration` constructor:

- `region`: Region ISO code. Android only — iOS has no region parameter. No default; omit it to use the SDK default.
- `validationModules`: List of `OnboardingValidationModule` items. Determines which modules are used for verification and onboarding score calculation. If `null`, the defaults are used: id, faceRecognition, and liveness.
- `queue`: Name of the video conference queue. Defaults to `null`, which uses the default queue.
- `customFields`: Custom fields sent to the server.
- `externalId`: User identifier outside of the Incode Omni database. If a session with the same `externalId` already exists, it is resumed; otherwise, a new session is created.
- `externalCustomerId`: Identifier linking the onboarding session to an entity in an external system. Typically used to represent a prospect ID or customer ID from your own database.
- `interviewId`: Unique identifier of an existing session. Resumes that session.
- `token`: Token of an existing session. Resumes that session. See [Token-Based Setup](./flutter-token-based-setup).
- `configurationId`: Flow `configurationId` from the Incode Dashboard. On this pattern, the locally configured flow still executes; the `configurationId` does not take precedence. To run a Dashboard-configured Flow, see [Run Flows Configured Online](./flutter-run-flows-configured-online).
- `e2eEncryptionEnabled`: Enables End-to-End Encryption for the session. See [End-to-End Encryption (E2EE)](./flutter-e2ee).

## 2. Configure the onboarding flow

Create an instance of `OnboardingFlowConfiguration` and add the modules you need. Modules execute in the order you add them.

```dart
OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
flowConfig.addIdScan();
flowConfig.addSelfieScan();
flowConfig.addFaceMatch();
```

For the full list of available modules, their configuration parameters, and their interdependencies, see [Modules](./flutter-modules).

## 3. Start onboarding

Call `startOnboarding` with the session and flow configurations. Add optional listener callbacks to receive results from individual modules as they complete.

```dart
IncodeOnboardingSdk.startOnboarding(
  sessionConfig: sessionConfig,
  flowConfig: flowConfig,
  onSuccess: () {
    print('Incode Onboarding completed!');
  },
  onError: (String error) {
    print('Incode onboarding error: $error');
    IncodeSdkFlowError? e = error.toIncodeSdkFlowError();
    switch (e) {
      case IncodeSdkFlowError.permissionsDenied:
        print('User denied permissions');
        break;
      case IncodeSdkFlowError.integrityCompromised:
        print('Compromised integrity detected');
        break;
      case IncodeSdkFlowError.faceAuthenticationFailed:
        print('Face authentication failed');
        break;
      case IncodeSdkFlowError.sslPinningFailed:
        print('SSL pinning failed');
        break;
      case IncodeSdkFlowError.unknown:
        print('Unknown error');
        break;
      default:
        print('Other error: $error');
        break;
    }
  },
  onUserCancelled: () {
    print('User cancelled onboarding');
  },
  onSelfieScanCompleted: (SelfieScanResult result) {
    print('Selfie completed result: $result');
  },
  onIdFrontCompleted: (IdScanResult result) {
    print('onIdFrontCompleted result: $result');
  },
  onIdBackCompleted: (IdScanResult result) {
    print('onIdBackCompleted result: $result');
  },
  onIdProcessed: (String ocrData) {
    print('onIdProcessed result: $ocrData');
  },
);
```

### Flow callbacks

- `onSuccess`: Called when all modules complete successfully.
- `onError`: Called when an error stops the flow. Receives an `error` String; possible values are listed in the `IncodeSdkFlowError` enum.
- `onUserCancelled`: Called when the user cancels the flow.
- Per-module completion callbacks (`onSelfieScanCompleted`, `onIdFrontCompleted`, `onIdBackCompleted`, `onIdProcessed`, and others): Optional. Add the callbacks for modules whose results you want to receive as they complete. See [Results](./flutter-results) for the full list of available listeners and their payloads.

### IncodeSdkFlowError enum values

- `permissionsDenied`: The user denied a required permission.
- `badEnvDetected` _(deprecated)_: No longer reported. The native SDK terminates the process when a compromised device environment is detected, so this case is never delivered.
- `integrityCompromised`: The device is jailbroken or rooted.
- `faceAuthenticationFailed`: Face authentication did not succeed.
- `sslPinningFailed`: SSL pinning failed.
- `combinedConsentsNotReceived` _(iOS only)_: A mandatory Combined Consent had no readable text or no checkbox id, so the flow stopped. [Edit the consent in Dashboard](/dashboard-platform-administration/configuration-consents-tab) so it includes text to resolve this error.
- `unknown`: An error that does not match any other enum case.

## Record the capture session (optional)

To store ID and Selfie capture session recordings, pass an `OnboardingRecordSessionConfiguration` to `startOnboarding` via the `recordSessionConfig` parameter.

```dart
OnboardingRecordSessionConfiguration recordSessionConfig = OnboardingRecordSessionConfiguration(
  recordSession: true,
  forcePermission: false,
);

IncodeOnboardingSdk.startOnboarding(
  sessionConfig: sessionConfig,
  flowConfig: flowConfig,
  recordSessionConfig: recordSessionConfig,
  onSuccess: () { /* ... */ },
  onError: (String error) { /* ... */ },
  // Add per-module listeners as needed
);
```

### Record session parameters

- `recordSession`: bool. Set to `true` to record ID and Selfie capture sessions.
- `forcePermission`: bool. If `true`, the user must accept recording permissions or the onboarding session is aborted. If `false`, the session continues without recording when permission is denied.

Recorded sessions are automatically uploaded to Incode's servers. You can access them in Dashboard in the single session view for each individual session.

<br />

---

- Path: `sdk-reference/flutter-configure-flows-locally-and-run-step-by-step`
- URL: https://developer.incode.com/sdk-reference/flutter-configure-flows-locally-and-run-step-by-step/
- Markdown: https://developer.incode.com/sdk-reference/flutter-configure-flows-locally-and-run-step-by-step.md

# Configure Flows Locally and Run Step by Step

Use this pattern when you want to configure the flow in your app code but run modules section by section, with control returned to your app between sections. This is useful when you need to interleave Incode SDK steps with your app's own screens, perform validation or business logic between steps, or split a long flow into logical phases.

## When to use this pattern

Use this pattern when:

- You want to define your flow's modules in code rather than in Dashboard.
- You need control returned to your app between groups of modules.
- You want to call individual SDK modules or group modules into named sections.

For a single end-to-end call that runs all modules consecutively, see [Configure Flows Locally and Run End to End](./flutter-configure-flows-locally-and-run-end-to-end). For flows configured in the Incode Dashboard, see [Run Flows Configured Online](./flutter-run-flows-configured-online).

## Prerequisites

- The SDK is initialized. See [Installation](./flutter-installation).

## 1. Set up the onboarding session

Before calling any other Onboarding SDK components, set up the onboarding session.

```dart
OnboardingSessionConfiguration sessionConfiguration = OnboardingSessionConfiguration();

IncodeOnboardingSdk.setupOnboardingSession(
  sessionConfig: sessionConfiguration,
  onError: (String error) {
    print('Incode onboarding session error: $error');
  },
  onSuccess: (OnboardingSessionResult result) {
    print('Incode Onboarding session created! $result');
  },
);
```

The `OnboardingSessionConfiguration` accepts the same parameters as the end-to-end pattern. See [Configure the onboarding session](./flutter-configure-flows-locally-and-run-end-to-end#1-configure-the-onboarding-session) on the end-to-end pattern page for the full parameter list.

## 2. Configure a section flow

Once the onboarding session is created, configure a section by creating an `OnboardingFlowConfiguration` and adding the modules for that section.

```dart
OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
flowConfig.addIdScan();
```

For the full list of available modules and their configuration parameters, see [Modules](./flutter-modules).

## 3. Start the onboarding section

Call `startOnboardingSection` and provide a `sectionTag` to identify the section. The `sectionTag` must not be blank. Add per-module listener callbacks to receive results as modules complete.

```dart
IncodeOnboardingSdk.startOnboardingSection(
  flowConfig: flowConfig,
  sectionTag: 'idSection',
  onError: (String error) {
    print('Incode onboarding section error: $error');
  },
  onUserCancelled: () {
    print('User cancelled section');
  },
  onIdFrontCompleted: (IdScanResult result) {
    print('onIdFrontCompleted result: $result');
  },
  onIdBackCompleted: (IdScanResult result) {
    print('onIdBackCompleted result: $result');
  },
  onIdProcessed: (String ocrData) {
    print('onIdProcessed result: $ocrData');
  },
  onSuccess: (String sectionTag) {
    print('Section finished: $sectionTag');
  },
);
```

### Section callbacks

- `onError`: Called when the section could not start or ended with an error. Receives an `IncodeSdkFlowError` code. See [`startOnboardingSection`](/sdk-reference/flutter-api-reference/#startonboardingsection) for the codes reported before the section starts.
- `onSuccess`: Called once when the section finished. Receives the `sectionTag` you provided. This is the equivalent of `onSuccess` on `startOnboarding`.
- `onUserCancelled`: Called when the user cancels the section.
- Per-module completion callbacks: Optional. Add the callbacks for modules whose results you want to receive as they complete. See [Results](./flutter-results) for the full list of available listeners and their payloads.

### Chain multiple sections

To run more than one section within the same session, call `startOnboardingSection` again with a new `flowConfig` and `sectionTag` from the previous section's `onSuccess` or later. Only one section can run at a time; a call made while a section runs, including from `onOnboardingSectionCompleted`, calls `onError` with `sectionAlreadyRunning`, and the running section continues.

Example:

```dart
IncodeOnboardingSdk.startOnboardingSection(
  flowConfig: idFlowConfig,
  sectionTag: 'idSection',
  onSuccess: (String sectionTag) {
    IncodeOnboardingSdk.startOnboardingSection(
      flowConfig: selfieFlowConfig,
      sectionTag: 'selfieSection',
      onSuccess: (String sectionTag) {
        // Continue chaining, or call finishFlow() when done.
      },
      onError: (String error) { /* ... */ },
    );
  },
  onError: (String error) { /* ... */ },
);
```

Once all sections are complete, call [`finishFlow()`](./flutter-api-reference#finishflow) to end the session.

## 4. Finish the onboarding session

Call `finishFlow()` when the user has completed all sections and you won't be reusing the same `interviewId` again. `finishFlow()` signals the end of the session so it can be closed server-side.

```dart
IncodeOnboardingSdk.finishFlow();
```

`finishFlow()` is only required for section-based flows. Do not call it for flows started with `startOnboarding()`.

If you do not call `finishFlow()`, the session remains open on the server. This does not cause issues for subsequent sessions.

---

- Path: `sdk-reference/flutter-customization`
- URL: https://developer.incode.com/sdk-reference/flutter-customization/
- Markdown: https://developer.incode.com/sdk-reference/flutter-customization.md

# Customization

The Flutter SDK supports customization of theme, text, images, and videos. The available options and the methods used to apply them differ between Android and iOS.

To change theme and resources (text, images, and videos) on Android, see the [Android customization guide](/sdk-reference/android-customization/).

To change resources on iOS, see the [iOS customization guide](/sdk-reference/ios-customization/).


## setTheme

Applies a custom theme to the SDK UI on both iOS and Android. `setTheme` accepts both the v1 and v2 theme schemas. Pass a JSON string. Encode a map with `jsonEncode` or pass file contents directly:

<Accordion title="View code block">

```dart
import 'dart:convert';

Map<String, dynamic> theme = {
 "colors": {
  "accent": "#00B2FD",
  "primary": "#20263D",
  "background": "#FFFFFF",
  "secondaryBackground": "#E9E9EB",
  "success": "#0CD5A2",
  "error": "#FF5C6F",
  "warning": "#F3AB3C",
  "cancel": "#20263D"
 },
 "fonts": {
  "buttonBig": {
   "name": "CircularXXTT-Black",
   "size": "20"
  },
  "buttonMedium": {
   "name": "CircularXXTT-Black",
   "size": "16"
  },
  "buttonSmall": {
   "name": "CircularXXTT-Black",
   "size": "12"
  },
  "title": {
   "name": "CircularXXTT-Black",
   "size": "25"
  },
  "hugeTitle": {
   "name": "CircularXXTT-Black",
   "size": "40"
  },
  "subtitle": {
   "name": "CircularXXTT-Black",
   "size": "18"
  },
  "boldedSubtitle": {
   "name": "CircularXXTT-Bold",
   "size": "18"
  },
  "smallSubtitle": {
   "name": "CircularXXTT-Black",
   "size": "14"
  },
  "info": {
   "name": "CircularXXTT-Black",
   "size": "16"
  },
  "body": {
   "name": "CircularXXTT-Medium",
   "size": "14"
  },
  "boldedBody": {
   "name": "CircularXXTT-Bold",
   "size": "14"
  },
  "textFieldBig": {
   "name": "CircularXXTT-Black",
   "size": "20"
  },
  "textFieldMedium": {
   "name": "CircularXXTT-Black",
   "size": "15"
  }
 },
 "buttons": {
  "primary": {
   "states": {
    "normal": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#00B2FD",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0.15,
     "shadowRadius": 9,
     "textColor": "#FFFFFF",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "highlighted": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#20263D",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0.15,
     "shadowRadius": 9,
     "textColor": "#00B2FD",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "disabled": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#E9E9EB",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0,
     "shadowRadius": 9,
     "textColor": "#FFFFFF",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    }
   },
   "big": {
    "height": 64,
    "minWidth": 200,
    "contentInsets": {
     "top": 19,
     "left": 32,
     "bottom": 19,
     "right": 32
    },
    "kerning": 0
   },
   "medium": {
    "height": 46,
    "minWidth": 0,
    "contentInsets": {
     "top": 12,
     "left": 24,
     "bottom": 12,
     "right": 24
    },
    "kerning": 0
   }
  },
  "secondary": {
   "states": {
    "normal": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#FFFFFF",
     "borderColor": "#20263D",
     "borderWidth": 1,
     "cornerRadius": 32,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#20263D",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "highlighted": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#20263D",
     "borderColor": "#20263D",
     "borderWidth": 1,
     "cornerRadius": 32,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#00B2FD",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "disabled": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#FFFFFF",
     "borderColor": "#E9E9EB",
     "borderWidth": 1,
     "cornerRadius": 32,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#E9E9EB",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    }
   },
   "big": {
    "height": 64,
    "minWidth": 200,
    "contentInsets": {
     "top": 19,
     "left": 32,
     "bottom": 19,
     "right": 32
    },
    "kerning": 0
   },
   "medium": {
    "height": 46,
    "minWidth": 0,
    "contentInsets": {
     "top": 12,
     "left": 24,
     "bottom": 12,
     "right": 24
    },
    "kerning": 0
   }
  },
  "text": {
   "states": {
    "normal": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 0,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#20263D",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "highlighted": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 0,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#00B2FD",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "disabled": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 0,
     "shadowColor": "",
     "shadowOffset": [0,0],
     "shadowOpacity": 0,
     "shadowRadius": 0,
     "textColor": "#E9E9EB",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    }
   },
   "big": {
    "height": 40,
    "minWidth": 200,
    "contentInsets": {
     "top": 8,
     "left": 16,
     "bottom": 8,
     "right": 16
    },
    "kerning": 0
   },
   "medium": {
    "height": 30,
    "minWidth": 0,
    "contentInsets": {
     "top": 12,
     "left": 24,
     "bottom": 12,
     "right": 24
    },
    "kerning": 0
   }
  },
  "help": {
   "states": {
    "normal": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#00B2FD",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0.15,
     "shadowRadius": 9,
     "textColor": "#FFFFFF",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "highlighted": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#20263D",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0.15,
     "shadowRadius": 9,
     "textColor": "#00B2FD",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    },
    "disabled": {
     "animateStateChange": true,
     "alpha": 1,
     "backgroundColor": "#E9E9EB",
     "borderColor": "",
     "borderWidth": 0,
     "cornerRadius": 32,
     "shadowColor": "#000000",
     "shadowOffset": [0,5],
     "shadowOpacity": 0,
     "shadowRadius": 9,
     "textColor": "#FFFFFF",
     "transform": {
      "a": 1,
      "b": 0,
      "c": 0,
      "d": 1,
      "tx": 0,
      "ty": 0
     }
    }
   },
   "big": {
    "height": 64,
    "minWidth": 200,
    "contentInsets": {
     "top": 19,
     "left": 32,
     "bottom": 19,
     "right": 32
    },
    "kerning": 0
   },
   "medium": {
    "height": 46,
    "minWidth": 0,
    "contentInsets": {
     "top": 12,
     "left": 24,
     "bottom": 12,
     "right": 24
    },
    "kerning": 0
   }
  }
 },
 "labels": {
  "title": {
   "textColor": "#20263D",
   "kerning": 0
  },
  "secondaryTitle": {
   "textColor": "#FFFFFF",
   "kerning": 0
  },
  "subtitle": {
   "textColor": "#20263D",
   "kerning": 0
  },
  "secondarySubtitle": {
   "textColor": "#FFFFFF",
   "kerning": 0
  },
  "smallSubtitle": {
   "textColor": "#20263D",
   "kerning": 0
  },
  "info": {
   "textColor": "#636670",
   "kerning": 0
  },
  "secondaryInfo": {
   "textColor": "#FFFFFF",
   "kerning": 0
  },
  "body": {
   "textColor": "#20263D",
   "kerning": 0
  },
  "secondaryBody": {
   "textColor": "#FFFFFF",
   "kerning": 0
  },
  "code": {
   "textColor": "#20263D",
   "kerning": 16
  }
 },
 "customComponents": {
  "cameraFeedback": {
   "alpha": 0.8,
   "backgroundColor": "#000000",
   "cornerRadius": 20,
   "textBackgroundColor": "",
   "textColor": "#FFFFFF"
  },
  "idCaptureHelp": {
   "commonIssueLayoutOrientation": "horizontal"
  },
  "idSideLabel": {
   "alpha": 1,
   "backgroundColor": "#FFFFFF",
   "borderColor": "",
   "borderWidth": 0,
   "cornerRadius": 5
  },
  "separator": {
   "alpha": 1.0,
   "color": "#20263D",
   "cornerRadius": 0,
   "padding": 24,
   "thickness": 1
  },
  "signature": {
   "signatureColor": "#04BD19",
   "canvasBorderColor": "#EC03FC"
  },
  "idAutocaptureCountdown": {
   "backgroundColor": "#00B2FD",
   "numberColor": "#FFFFFF"
  }
 },
};

IncodeOnboardingSdk.setTheme(theme: jsonEncode(theme));
```
</Accordion>

### ID v2 UX customization
Both platforms support customization of the ID v2 experience via `IncodeOnboardingSdk.setTheme(theme: jsonEncode(theme))`.

- Android: see the [ID V2 customization guide](/sdk-reference/android-customization/#configure-v2-theme-and-ux).
- iOS: see the [ID V2 customization guide](/sdk-reference/ios-customization/#configure-v2-theme-and-ux).

## setLogo

To show your logo on the SDK screens, call `IncodeOnboardingSdk.setLogo` with the name of an image of your app. The logo shows on every UX V2 screen, for example `FaceAuthentication`, and on the legacy screens.

**Parameters:**

- `logo`: String. On Android, a drawable resource name (`res/drawable/<name>`). On iOS, an image asset name from your asset catalog or main bundle. Use the same name on both platforms.

```dart
await IncodeOnboardingSdk.setLogo(logo: 'my_logo');
```

If the name does not match an image of your app, `onError` is called with `appearanceError`. For the details, see [`setLogo`](/sdk-reference/flutter-api-reference/#setlogo).

On Android, the logo is a resource image. Add it to `android/app/src/main/res/raw/keep.xml`, or the Android shrinker removes it from release builds:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

On the legacy Android screens, the logo requires the following dependency in your `app/build.gradle`:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

## setLocalizationLanguage

To set the localization language at runtime, call `IncodeOnboardingSdk.setLocalizationLanguage`.

**Parameters:**

- `language`: String. Language code used for runtime localization. Supported values are currently `en`, `es`, `pt`, and `he`.

```dart
IncodeOnboardingSdk.setLocalizationLanguage('es');
```

On Android, add the following dependency to your `app/build.gradle`:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

## setString

To programmatically set and update strings at runtime, call `IncodeOnboardingSdk.setString`.

**Parameters:**

- `strings`: Map\<String, dynamic>. Map of string keys and their values.

```dart
Map<String, dynamic> strings = {
  // iOS labels
  'incdOnboarding.idChooser.title': 'My Custom chooser title',

  // Android labels
  'onboard_sdk_id_type_chooser_title': 'My Custom chooser title',
};

await IncodeOnboardingSdk.setString(strings: strings);
```

On Android, add the following dependency to your `app/build.gradle`:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

For iOS string keys, see the [Localization Guide](/sdk-reference/ios-customization/#localize-display-text).

For Android string keys, see the [Dynamic Localization Guide](/sdk-reference/android-customization/#dynamic-localization).

## setQuantityStrings

To programmatically set and update pluralized (quantity) strings in runtime, call `IncodeOnboardingSdk.setQuantityStrings`.

This method is supported on Android only.

**Parameters:**

- `locale`: String. A BCP 47 language tag such as `"en"`, `"es"`, or `"en-US"`.
- `quantityStrings`: Map\<String, Map<String, String>>. A nested map, keyed first by plural name and then by quantity keyword: `plural name -> quantity keyword -> value`. Keywords are `'zero'`, `'one'`, `'two'`, `'few'`, `'many'` and `'other'`. They are not case-sensitive.

```dart
Map<String, Map<String, String>> quantityStrings = {
  'onboard_sdk_validation_attempts_remaining': {
    'one': '%d attempt remaining',
    'other': '%d attempts remaining',
  },
};
await IncodeOnboardingSdk.setQuantityStrings(locale: 'en', quantityStrings: quantityStrings);
```

On Android, add the following dependency to your `app/build.gradle`:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

For Android string keys, see the [Dynamic Localization Guide](/sdk-reference/android-customization/#dynamic-localization).

---

- Path: `sdk-reference/flutter-delete-local-session-data`
- URL: https://developer.incode.com/sdk-reference/flutter-delete-local-session-data/
- Markdown: https://developer.incode.com/sdk-reference/flutter-delete-local-session-data.md

# Delete Local Session Data

Delete all local user data that was collected during onboarding from the device by calling `deleteLocalUserData`. This method removes session-scoped data only; it does not affect locally stored identities added via `addFace` or `setFaces` for 1:N `FaceAuthMode.local` Face Login.

Use this method after onboarding completes to clear session data on the device, or when complying with data retention requirements.

## When to call deleteLocalUserData

Do not call `deleteLocalUserData` before `finishFlow()`. Calling it before `finishFlow()` will prevent the onboarding session from completing.

- **After startOnboarding, startFlow, or startWorkflow**: Call `deleteLocalUserData` after the user completes all steps in the flow. It is safe to call this method in the body of or after any of these callbacks: `onSuccess`, `onError`, and `onUserCancelled`.
- **After startOnboardingSection**: If you are using section-based flows, do not call `deleteLocalUserData` between sections or modules. Call it only after the user has completely finished the custom flow, and only after `finishFlow()`.

## Delete local user data

```dart
await IncodeOnboardingSdk.deleteLocalUserData();
```

`deleteLocalUserData` is asynchronous but returns no result. Your app can `await` the call to know when the deletion has completed, but there is no success or failure value to check and no error conditions to handle.

---

- Path: `sdk-reference/flutter-e2ee`
- URL: https://developer.incode.com/sdk-reference/flutter-e2ee/
- Markdown: https://developer.incode.com/sdk-reference/flutter-e2ee.md

# End-to-End Encryption (E2EE)

End-to-End Encryption (E2EE) adds a layer of security to communications between the client and Incode's servers by encrypting transmitted data. The client and server first exchange keys for encrypting and decrypting messages. After this exchange, all subsequent communications are encrypted, and only the intended server and client can decrypt them.

## Prerequisites

- A custom E2EE server URL provided by Incode.

## Enable End-to-End Encryption

End-to-End Encryption (E2EE) setup takes three steps: initialize the SDK with a custom server URL, enable E2EE on the session configuration, and pass the session configuration to the SDK.

### 1. Initialize the SDK with a custom E2EE server

Pass your `e2eeUrl` to the `init` method.

```dart
IncodeOnboardingSdk.init(
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'YOUR_API_URL',
  e2eeUrl: 'YOUR_E2EE_URL',
);
```

### 2. Enable E2EE on the session configuration

Set `e2eEncryptionEnabled` to `true` on your `OnboardingSessionConfiguration`.

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration(
  e2eEncryptionEnabled: true,
);
```

### 3. Pass the session configuration to the SDK

Pass the configured `OnboardingSessionConfiguration` to either `setupOnboardingSession` (for section-based flows):

```dart
IncodeOnboardingSdk.setupOnboardingSession(
  sessionConfig: sessionConfig,
);
```

or to `startOnboarding` (for end-to-end flows):

```dart
IncodeOnboardingSdk.startOnboarding(
  sessionConfig: sessionConfig,
  flowConfig: flowConfig,
);
```

## End-to-End Encryption in Face Login

Face Login has its own End-to-End Encryption (E2EE) parameter, `e2eeEncryptionEnabled` (note the two Es, distinct from the session config's `e2eEncryptionEnabled`). E2EE is disabled by default for Face Login and supported on Android only. See [Face Login](./flutter-face-login) for details.

## Verify End-to-End Encryption is working

If End-to-End Encryption (E2EE) is enabled but not properly configured, the SDK returns an error. If E2EE is working, the SDK sends and receives requests to and from the E2EE server, and the requests themselves are encrypted. Check your logs to confirm.

Contact your Incode representative if you need help diagnosing an E2EE issue.

---

- Path: `sdk-reference/flutter-face-login`
- URL: https://developer.incode.com/sdk-reference/flutter-face-login/
- Markdown: https://developer.incode.com/sdk-reference/flutter-face-login.md

# Face Login

Face Login authenticates a user by performing a face match between a captured selfie and a previously enrolled face. The SDK supports two authentication modes: **1:1**, which matches against a specific user identified by `customerUUID`, and **1:N**, which performs a database lookup to find a match.

## Prerequisites

- The SDK is initialized. See [Installation](./flutter-installation).
- The user has an approved account with an enrolled face.

Enrollment happens as a byproduct of a standard onboarding flow that includes the `FaceMatch` module. Alternatively, an admin can enroll a user by clicking **Add face to Database** in Dashboard.

## Face Login 1:1

1:1 Face Login performs a face comparison between the captured selfie and the face on file for a specific user, identified by their `customerUUID`. Returns a successful match if the faces match.

Use 1:1 when you already know which user is attempting to authenticate (for example, the user has logged in with a username or email first).

If the user was approved during onboarding on a mobile device, the `customerUUID` is returned as part of the [Approve module result](./flutter-results#approve).

```dart
IncodeOnboardingSdk.startFaceLogin(
  faceLogin: FaceLogin(customerUUID: "yourCustomerUUID"),
  onSuccess: (FaceLoginResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

## Face Login 1:N

1:N Face Login performs a database lookup across all of your enrolled users and returns a successful match if the captured face is found.

Use 1:N when you don't know which user is attempting to authenticate (for example, passwordless sign-in flows).

```dart
IncodeOnboardingSdk.startFaceLogin(
  faceLogin: FaceLogin(),
  onSuccess: (FaceLoginResult result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

## FaceLoginResult

`FaceLoginResult` contains the following fields:

- `image`: Selfie image captured during login.
- `spoofAttempt`: bool. `true` indicates the user tried to spoof the system (using a photo, screen, or other method). `false` indicates a real person.
- `base64Images`: Base64 representations of the selfie image.
- `faceMatched`: bool. `true` if the faces matched, `false` otherwise.
- `customerUUID`: String?. Unique user identifier if authentication succeeded. `null` if `faceMatched` is `false`.
- `interviewId`: String. Session ID in which the user was approved.
- `interviewToken`: String. Session token in which the user was approved.
- `token`: String. Token that can be used for further API calls.
- `transactionId`: String. Unique identifier of the Face Login attempt.
- `hasLenses`: bool. Indicator if the login attempt failed because the user was wearing lenses.
- `hasFaceMask`: bool. Indicator if the login attempt failed because the user was wearing a face mask.

## Configuration

Configure Face Login behavior by passing parameters to the `FaceLogin` object.

### Show tutorials

By default, Face Login shows a tutorial on how to capture a selfie before the actual scan. To disable this, set `showTutorials` to `false`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  showTutorials: false,
);
```

### Authentication modes

By default, Face Login performs spoof and face recognition checks on Incode's servers.

To perform both checks locally on the device, set `faceAuthMode` to `FaceAuthMode.local`. Local authentication enables offline use, but requires that the user was originally onboarded and approved on the same device.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  faceAuthMode: FaceAuthMode.local,
);
```

To use `FaceAuthMode.local` on Android, add the following dependencies to your `app/build.gradle`:

- `com.incode.sdk:model-liveness-detection:[VERSION]`
- `com.incode.sdk:model-face-recognition:[VERSION]`

See [Installation](./flutter-installation) for the full Android dependency setup.

### Fallback to server authentication

When using `FaceAuthMode.local`, you can fall back to a one-time server authentication if the user is not found locally on the device. Fallback works only in 1:1 Face Login mode. Set `faceAuthModeFallback` to `true`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  faceAuthMode: FaceAuthMode.local,
  faceAuthModeFallback: true,
);
```

### Local mode thresholds

When using `FaceAuthMode.local`, adjust the spoof and recognition thresholds by setting `spoofThreshold` and `recognitionThreshold` on the `FaceLogin` object. Both parameters accept values between `0.0` and `1.0`.

- `spoofThreshold`: Defaults to `0.5`.
- `recognitionThreshold`: Defaults to `0.6`.

### Face mask check

By default, Face Login does **not** detect face masks. To enable face mask detection, set `faceMaskCheck` to `true`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  faceMaskCheck: true,
);
```

### Lenses check

By default, Face Login detects lenses (glasses). To turn off lens detection, set `lensesCheck` to `false`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  lensesCheck: false,
);
```

### Authentication logging

By default, each authentication attempt is logged and device statistics are tracked. To turn off logging for faster authentications, set `logAuthenticationEnabled` to `false`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  logAuthenticationEnabled: false,
);
```

When logging is enabled, the following data is collected for each authentication attempt:

- Transaction ID (a random UUID for the attempt)
- Customer ID
- Face image
- Frame size (image width and height)
- Face detection data (face size and position, landmark coordinates for eyes and mouth)
- Device type
- Device name
- OS version
- Authentication type (1:1 or 1:N)
- Authentication method (`SERVER` or `LOCAL`)
- Brightness
- Blurriness
- Recognition confidence
- Liveness confidence
- `clientRecognitionThreshold` (sent only in `LOCAL` mode)
- `clientLivenessThreshold` (sent only in `LOCAL` mode)

### End-to-End Encryption (E2EE)

By default, Face Login does not use E2EE. To enable it, set `e2eeEncryptionEnabled` to `true`.

```dart
FaceLogin faceLogin = FaceLogin(
  customerUUID: "yourCustomerUUID",
  e2eeEncryptionEnabled: true,
);
```

Note that the parameter name on `FaceLogin` is `e2eeEncryptionEnabled` (two Es), which differs from the session-level parameter `e2eEncryptionEnabled` (one E) on `OnboardingSessionConfiguration`. See [End-to-End Encryption (E2EE)](./flutter-e2ee) for full E2EE setup.

E2EE for Face Login is supported on Android only.

## Manage locally stored identities

When using 1:N Face Login with `FaceAuthMode.local`, you must add user identities to the device's local database. This section describes the methods for adding, removing, retrieving, and replacing locally stored identities.

To use these methods, you must use the SDK `-l` variant. See [SDK variants](./flutter-installation#sdk-variants) on the Installation page.

### Add a face

Use `addFace` to add a single identity to the local database. Provide a `FaceInfo` object containing the face template, customer UUID, and template ID.

```dart
FaceInfo faceInfo = FaceInfo(
  faceTemplate: template,
  customerUUID: uuid,
  templateId: templateId,
);

IncodeOnboardingSdk.addFace(
  faceInfo: faceInfo,
  onSuccess: (bool result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

#### FaceInfo fields

- `faceTemplate`: String. Biometric representation of a user's face.
- `customerUUID`: String. Unique customer identifier in Incode's database.
- `templateId`: String. Unique identifier of the biometric face representation in Incode's database.

The `faceTemplate` and `templateId` values are generated during a user's onboarding process and can be retrieved through a backend API. Contact your Incode representative for details on how to obtain them.

### Remove a face

Use `removeFace` to remove a single identity from the local database by `customerUUID`.

```dart
IncodeOnboardingSdk.removeFace(
  customerUUID: "your_customer_uuid",
  onSuccess: (bool result) {
    print(result);
  },
  onError: (String error) {
    print(error);
  },
);
```

### Get all faces

Use `getFaces` to retrieve all currently stored identities.

```dart
IncodeOnboardingSdk.getFaces(
  onSuccess: (List<FaceInfo> faceInfos) {
    print("faceInfos: $faceInfos");
  },
  onError: (String error) {
    print(error);
  },
);
```

### Set multiple faces

Use `setFaces` to replace the entire local database with a list of `FaceInfo` objects.

<Callout icon="❗" theme="error">
  ### Warning

  `setFaces` wipes out all currently stored identities before adding the new ones. To add identities without clearing the database, use `addFace` individually.
</Callout>

```dart
final faceInfos = <FaceInfo>[
  FaceInfo("your_face_template", "your_customer_uuid", "your_template"),
  FaceInfo("your_face_template2", "your_customer_uuid2", "your_template2"),
];

IncodeOnboardingSdk.setFaces(
  faces: faceInfos,
  onSuccess: (bool result) {
    print("result: $result");
  },
  onError: (String error) {
    print(error);
  },
);
```

### Clear the face database

To clear the local database, call `setFaces` with an empty list.

```dart
IncodeOnboardingSdk.setFaces(
  faces: List.empty(),
  onSuccess: (bool result) {
    print("result: $result");
  },
  onError: (String error) {
    print(error);
  },
);
```

### Locally stored identities and deleteLocalUserData

Locally stored identities added via `addFace` or `setFaces` are not affected by calls to [`deleteLocalUserData`](./flutter-api-reference#deletelocaluserdata). That method only removes session-scoped data. To remove locally stored identities, use `removeFace` or `setFaces`.

---

- Path: `sdk-reference/flutter-getting-started`
- URL: https://developer.incode.com/sdk-reference/flutter-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/flutter-getting-started.md

# Getting Started

The Incode Flutter SDK adds identity verification, onboarding, and authentication flows to your Flutter app. This section walks you through installing the SDK, initializing it, and configuring it for your use case.

## Start Here

If you're new to the SDK, follow these steps in order:

1. **[Install the SDK](/sdk-reference/flutter-installation/)** in your Flutter project, including platform-specific setup for iOS and Android.
2. **[Choose an SDK mode](/sdk-reference/flutter-sdk-modes/)** based on whether your app captures and validates online, or captures only.
3. **[Choose an implementation pattern](/sdk-reference/flutter-common-implementation-patterns/)** based on where your onboarding flow is configured and how much control your app needs.

The remaining pages in this section cover specific setup options, advanced configurations, and maintenance tasks that you may or may not need depending on your integration.

## Your First Flow

Once the SDK is installed and initialized, a minimal onboarding flow looks like this:

```dart
IncodeOnboardingSdk.init(
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'YOUR_API_URL',
  testMode: false,
  onError: (String error) {
    print('Incode init failed: $error');
  },
  onSuccess: () {
    OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration();
    OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
    flowConfig.addIdScan();
    flowConfig.addSelfieScan();
    flowConfig.addFaceMatch();

    IncodeOnboardingSdk.startOnboarding(
      sessionConfig: sessionConfig,
      flowConfig: flowConfig,
      onSuccess: () {
        print('Incode Onboarding completed!');
      },
      onError: (String error) {
        print('Incode onboarding error: $error');
      },
    );
  },
);
```

To react to individual modules as they complete, add the corresponding optional callback to your `startOnboarding` call:

```dart
IncodeOnboardingSdk.startOnboarding(
  sessionConfig: sessionConfig,
  flowConfig: flowConfig,
  onSuccess: () { /* ... */ },
  onError: (String error) { /* ... */ },
  onSelfieScanCompleted: (SelfieScanResult result) {
    print(result);
  },
);
```

For the full integration walkthrough including session configuration, error handling, and the available listener callbacks, see [Configure Flows Locally and Run End to End](/sdk-reference/flutter-configure-flows-locally-and-run-end-to-end/).

## Optional and Advanced Setup

These pages cover specific scenarios you may or may not require:

- [End-to-End Encryption (E2EE)](/sdk-reference/flutter-e2ee/): Enable end-to-end encryption of capture artifacts.
- [Token-Based Setup](/sdk-reference/flutter-token-based-setup/): Use the SDK without an API key by passing a backend-created token.
- [Delete Local Session Data](/sdk-reference/flutter-delete-local-session-data/): Clean up locally stored onboarding data.

<br />

---

- Path: `sdk-reference/flutter-installation`
- URL: https://developer.incode.com/sdk-reference/flutter-installation/
- Markdown: https://developer.incode.com/sdk-reference/flutter-installation.md

# Installation

Install the Incode Onboarding Flutter SDK, configure the iOS and Android projects that consume it, and initialize the SDK. After initialization, see [Common Implementation Patterns](./flutter-common-implementation-patterns) to start an onboarding session.

## SDK variants

The SDK is distributed in several variants. Select a variant by pointing the `ref` field in your `pubspec.yaml` at the matching release branch (see [Add the SDK to your project](./flutter-installation#add-the-sdk-to-your-project)). Combined variants are not supported.

- **Standard:** The default variant. No modifier.
- `-vc`: Streams the camera feed during Selfie and ID scan.
- `-nfc`: Reads data from a passport or ID chip via NFC.
- `-l`: Manipulates locally stored identities. Required for 1:N `FaceAuthMode.local` [Face Login](/sdk-reference/flutter-face-login/).
- `-sna`: Adds support for Silent Network Authentication. Note that it is only available starting from version 4.19.0.

## Requirements

- Flutter 3.16 or higher (recommended)
- Flutter 1.20.0 minimum

### Access prerequisites

The SDK is distributed from private Incode repositories, so access must be granted before installation succeeds. Contact your Incode representative to request both of the following for the GitHub account you will build with:

- Access to the `Incode-Technologies-Example-Repos` GitHub organization, with GitHub authentication configured on your machine over SSH or HTTPS. `flutter pub get` resolves the SDK from a private Git repository, and iOS builds resolve the Incode CocoaPods podspec sources from the same organization.
- A GitHub token with the `read:packages` scope for the `android-omni-packages` registry. This is the value that replaces `GITHUB_TOKEN` in the Android setup step below.

## Add the SDK to your project

Add the SDK as a Git dependency in your `pubspec.yaml`. Use the block that matches the variant you need.

### Standard variant

```yaml
onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/FlutterSampleApp.git
    ref: release/[VERSION]
```

### Camera streaming variant (-vc)

```yaml
onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/FlutterSampleApp.git
    ref: release/[VERSION]-vc
```

### NFC variant (-nfc)

```yaml
onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/FlutterSampleApp.git
    ref: release/[VERSION]-nfc
```

### Local identities variant (-l)

```yaml
onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/FlutterSampleApp.git
    ref: release/[VERSION]-l
```

### Silent Network Authentication variant (-sna)

```yaml
onboarding_flutter_wrapper:
  git:
    url: git@github.com:Incode-Technologies-Example-Repos/FlutterSampleApp.git
    ref: release/[VERSION]-sna
```

Replace `[VERSION]` in the `ref` field with the release branch name (for example, `release/4.18.0`). To use an older version, replace `[VERSION]` with the specific release branch (for example, `release/4.2.0`).

## iOS setup

After adding the SDK to your project, complete the following iOS-specific setup steps.

### 1. Verify Git LFS is installed

The Incode iOS pods ship large binary assets through [Git LFS](https://git-lfs.com/). If Git LFS is not installed, those asset files are fetched as text pointers and the build fails later with an error that does not mention LFS. Install Git LFS and confirm it is active before running `pod install`:

```sh
git lfs install
git lfs version
```

### 2. Update the Podfile deployment target

In the `ios` folder, change your `Podfile` so it requires deployment target 13 or higher:

```diff
-platform :ios, '11.0'
+platform :ios, '13.0'
```
### 3. Add the Incode CocoaPods sources

At the top of the `Podfile` in the `ios` folder, add these source lines. CocoaPods uses them to resolve the Incode iOS pods, which requires the GitHub organization access described in [Access prerequisites](./flutter-installation#access-prerequisites).

```diff
+ source 'https://cdn.cocoapods.org/'
+ source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
+ source 'git@github.com:Incode-Technologies-Example-Repos/IncodeBridgeCommonPodspecs.git'
```

### 4. Install pods

Run `pod install` within the `ios` folder:

```sh
pod install
```

### 5. Add permission entries to Info.plist

Add the permission entries required by the modules you plan to use:

- `IdScan`, `SelfieScan`, `DocumentScan`, `VideoSelfie` (camera modules): require `NSCameraUsageDescription`.
- `Geolocation` module: requires `NSLocationWhenInUseUsageDescription`.
- `VideoSelfie` module voice consent step: requires `NSMicrophoneUsageDescription`.
- `NFCScan` module: requires `NFCReaderUsageDescription` and `NSNFCUsageDescription`.

### 6. Add the jailbreak detection URL schemes to Info.plist

The SDK checks whether known jailbreak tools are installed before it starts a flow. iOS only answers those checks for URL schemes the app declares in `LSApplicationQueriesSchemes`, so add the following entries to `Info.plist`. Without them the detection still runs, but it cannot use this check and the SDK logs a warning to the device console.

```xml
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>cydia</string>
  <string>undecimus</string>
  <string>sileo</string>
  <string>zbra</string>
  <string>filza</string>
  <string>activator</string>
  <string>installer</string>
  <string>saily</string>
  <string>xina</string>
  <string>dopamine</string>
</array>
```

If your app already declares `LSApplicationQueriesSchemes`, keep the existing array and add only the entries from this list that are missing from it. Keep the combined list within Apple's limit: 50 entries when linked with iOS 15–26 SDKs, or 25 with iOS 27 and later. See [Apple's query requirements](https://developer.apple.com/documentation/uikit/uiapplication/canopenurl(_:)).

## Android setup

After adding the SDK to your project, complete the following Android-specific setup steps.

### 1. Update app/build.gradle

In `app/build.gradle`, enable `multiDexEnabled` and set the minimum API level. Use API level 23, or API level 24 if you are using the video streaming dependency. Set `compileSdkVersion` to 36, which the SDK requires.

```diff
android {
+  compileSdkVersion 36

  defaultConfig {
    …
    multiDexEnabled true
    minSdkVersion 23
  }
}
```

Add the packaging exclusion required by the SDK's OkHttp 5.3.2 dependency:

```diff
android {
+  packaging {
+    resources {
+      excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
+    }
+  }
}
```

### 2. Configure the GitHub Packages repository

Modify your project's `build.gradle` to include the GitHub Packages repository. Replace `GITHUB_TOKEN` with the `read:packages` token from [Access prerequisites](./flutter-installation#access-prerequisites).

```diff
allprojects {
  repositories {
    ...
+    maven { url "https://jitpack.io" }
+    maven {
+      url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
+      credentials {
+        username = "incode-customers"
+        password = "GITHUB_TOKEN"
+      }
+    }
    ...
  }
}
```

### 3. Set the Kotlin, AGP and Gradle versions

The SDK is compiled with Kotlin `2.2.21`, so any module that compiles Kotlin source with the SDK on its classpath needs Kotlin Gradle plugin `2.2.21` or newer. `compileSdk 36` additionally requires Android Gradle Plugin `8.9.1`+ and Gradle `8.14.5`+.

In `android/settings.gradle`:

```diff
plugins {
    id "dev.flutter.flutter-plugin-loader"
+    id "com.android.application" version "8.9.1" apply false
+    id "org.jetbrains.kotlin.android" version "2.2.21" apply false
}
```

In `android/gradle/wrapper/gradle-wrapper.properties`:

```diff
+ distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.5-bin.zip
```

If you set the Kotlin plugin through a `buildscript` block instead:

```diff
buildscript {
+    ext.kotlin_version = '2.2.21'

    dependencies {
        ...
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}
```

### 4. Set the coroutines version (conditional)

The SDK requires `kotlinx-coroutines` `1.9.0` or newer. CameraX `1.6.1` pulls it in transitively, so no declaration is needed unless you pin coroutines explicitly:

```gradle
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
```

### 5. Add optional dependencies for Face Login (conditional)

If you plan to use 1:N Face Login with `FaceAuthMode.local`, add the following dependencies to your `app/build.gradle`:

- `com.incode.sdk:model-liveness-detection:[VERSION]`: enables local liveness detection.
- `com.incode.sdk:model-face-recognition:[VERSION]`: enables local face recognition.

See [Face Login](/sdk-reference/flutter-face-login/) for details on local authentication mode.

## Release builds

No extra configuration is required for App Store or Google Play releases. The SDK reports the wrapper platform and version (for example `Flutter [VERSION]`) to the Incode dashboard, which is how a session is identified as coming from the Flutter SDK rather than a native integration. The markers carrying that information are protected against release-build stripping on both platforms:

- **Android:** the wrapper identity is read by reflection, which R8 cannot see. The plugin ships a keep rule via `consumerProguardFiles`, and Gradle merges it into your app automatically, so the marker survives `minifyEnabled true` with shrinking and obfuscation. You do not need keep rules of your own. If your app replaces the merged consumer rules or runs a post-processing step that strips them, the dashboard will stop attributing sessions to Flutter.
- **iOS:** the wrapper identity is exposed as Objective-C class metadata, which lives in a Mach-O section the linker never dead-strips and the App Store symbol-stripping step never removes. It is resolved through the Objective-C runtime rather than the symbol table, so stripped release archives still report correctly.

## Update to the latest version

To update the SDK to the latest version, run one of the following:

```sh
flutter pub upgrade
```

or

```sh
flutter packages upgrade
```

If the iOS SDK version was updated, also run the following inside your `ios` folder:

```sh
pod install --repo-update
pod update IncdOnboarding
```

## Initialize the SDK

Initialize the SDK before calling any other SDK methods. Incode provides your `apiKey` and `apiUrl`.

```dart
IncodeOnboardingSdk.init(
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'YOUR_API_URL',
  testMode: false,
  onError: (String error) {
    IncodeSdkInitError? e = error.toIncodeSdkInitError();
    switch (e) {
      case IncodeSdkInitError.simulatorDetected:
        print('Incode init failed, simulator detected: $IncodeSdkInitError.simulatorDetected');
        break;
      case IncodeSdkInitError.testModeEnabled:
        print('Incode init failed, test mode enabled: $IncodeSdkInitError.testModeEnabled');
        break;
      default:
        print('Incode init failed: $error');
        break;
    }
  },
  onSuccess: () {
    // Update UI, safe to start Onboarding
    print('Incode initialize successfully!');
  },
);
```

### Init parameters

The parameters most commonly set during initial integration are:

- `apiKey`: String. Provided by Incode.
- `apiUrl`: String. Provided by Incode.
- `testMode`: bool. Set to `true` when running on a simulator.
- `onSuccess`: Callback invoked when initialization succeeds. Safe to start onboarding from here.
- `onError`: Callback invoked when initialization fails. Receives an error **code** `String`; possible values are listed in the `IncodeSdkInitError` enum: `simulatorDetected`, `testModeEnabled`, `invalidInitParams`, `configError`, and `unknown`.

The SDK supports additional optional parameters for logging, SDK mode, security, and analytics. See [`init`](./flutter-api-reference#init) on the API Reference page for the full parameter list. Tutorial screens are configured per module with `showTutorials` — see [Modules](./flutter-modules).

### Initializing without an API key

To initialize the SDK without an `apiKey`, provide only the `apiUrl` to the `init` method, then configure your `OnboardingSessionConfiguration` with a `token`. See [Token-Based Setup](./flutter-token-based-setup) for details.

---

- Path: `sdk-reference/flutter-known-issues`
- URL: https://developer.incode.com/sdk-reference/flutter-known-issues/
- Markdown: https://developer.incode.com/sdk-reference/flutter-known-issues.md

# Known Issues

This page documents known limitations of the Flutter SDK. If you run into an issue not listed here, contact your Incode representative.

## iOS Simulator from VSCode

Running the app on the iOS Simulator from VSCode isn't currently supported. Run the app from Xcode to test on the iOS Simulator. Set `testMode` to `true` before running the app.

## Simulators and emulators

Running on simulators or emulators can trigger security checks that return errors such as `simulatorDetected` or `testModeEnabled`. Set `testMode` to `true` when calling [`init`](./flutter-api-reference#init) on simulators or emulators, and set it to `false` on real devices in production.

---

- Path: `sdk-reference/flutter-modules`
- URL: https://developer.incode.com/sdk-reference/flutter-modules/
- Markdown: https://developer.incode.com/sdk-reference/flutter-modules.md

# Modules

A module is a self-contained step in an onboarding flow. Add modules to an `OnboardingFlowConfiguration` (for [locally configured flows](./flutter-configure-flows-locally-and-run-end-to-end)) to define what happens during onboarding, or configure them in a Flow or Workflow in Dashboard (for [online-configured flows](./flutter-run-flows-configured-online)).

All the modules supported by the Flutter SDK are listed here, with their configuration parameters. For implementation options and instructions, see [Common Implementation Patterns](./flutter-common-implementation-patterns).

Add modules to an `OnboardingFlowConfiguration` using the corresponding `add` method:

```dart
flowConfig.addIdScan();
flowConfig.addSelfieScan();
```

Modules execute in the order they are added. To skip a module, omit its `add` call.

For completion payloads, update events, and module error examples, see [Results](./flutter-results).

### Aes (Advanced Electronic Signature)

**Module ID:** `AES`

Shows the user documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant.

- `uploadDocument` (optional, defaults to `false`): bool?. If `true`, the module shows the AES upload screen before the normal AES screens.
- `downloadDocument` (optional, defaults to `false`): bool?. If `true`, the module downloads signed PDFs and shows the Confirmed Signature Details screen at the end of the AES flow.

### Antifraud

**Module ID:** `ANTIFRAUD`

Compares the current Session against prior Sessions and known identities to detect signs of fraud.

- No additional parameters.

### Approve

**Module ID:** `USER_APPROVAL`

Finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. By default, it runs with no UI and approves silently, but you can toggle the UI, silent face match, and forced approval.

- `forceApproval` (optional, defaults to `false`): bool?. If `true`, the user is approved regardless of score. Force-approved users still receive a valid `Approve` result and `customerUUID`. The SDK does not attach a flag to the result indicating force approval; whether the backend logs force-approved sessions distinctly is outside the SDK's scope. Regulated customers should contact their Incode representative for details on backend audit trails.

### Captcha

**Module ID:** `OTP`

Presents a CAPTCHA challenge during onboarding to verify human interaction and reduce automated abuse. Returns the user's response to your app.

- No additional parameters.

### CombinedConsent

**Module ID:** `COMBINED_CONSENT`

Asks the user for data sharing consent.

- `consentId` (required): String. The ID for the combined consent. You can create a consent in Dashboard at **Configuration** > **Consents**.

### CURP

**Module ID:** `CURP_VALIDATION`

Validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

- `validationEnabled` (optional, defaults to `true`): bool?. If `true`, the module validates the CURP against RENAPO. If `false`, the module only captures a CURP in a valid format and makes no RENAPO check.

### CustomWatchlist

**Module ID:** `INCODE_WATCHLIST`

Screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It runs as a background process and isn't visible to the end user.

- No additional parameters.

### DocumentScan

**Module ID:** `DOCUMENT_CAPTURE`

Captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera.

- `showTutorials` (optional, defaults to `true`): bool?. Shows a tutorial before document scan.
- `documentSources` (optional, defaults to the native SDK default): `List<DocumentSource>?`. Explicitly defines which capture sources are offered to the user. Supported in both the V1 and V2 UI. Possible values: `DocumentSource.camera`, `DocumentSource.photoUpload`, `DocumentSource.fileUpload`.
- `showDocumentProviderOptions` (**deprecated**, optional, defaults to `false`): bool?. Controls whether the V1 capture flow offers file or image upload alongside the camera. Applies to the V1 UI only and is ignored when `documentSources` is provided. Use `documentSources` instead.
- `documentType` (optional, defaults to `DocumentType.addressStatement`): The expected document type. Possible values: `addressStatement`, `paymentProof`, `medicalDoc`, `otherDocument1`, `otherDocument2`.

`DocumentSource.fileUpload` (PDF) is only honored for document types that support PDF uploads: `addressStatement`, `paymentProof`, `otherDocument1`, and `otherDocument2`. For `medicalDoc` it is ignored on both platforms, and if it was the only source in the list, the native SDK default applies instead. An empty list is treated the same as omitting the parameter.

```dart
final flowConfig = OnboardingFlowConfiguration();

flowConfig.addDocumentScan(
  documentType: DocumentType.addressStatement,
  documentSources: [
    DocumentSource.camera,
    DocumentSource.photoUpload,
    DocumentSource.fileUpload,
  ],
);
```

:::info
**Migration note:** `showDocumentProviderOptions` maps to the deprecated native chooser flags. Replace it with `documentSources`:
- `showDocumentProviderOptions: false` → `documentSources: [DocumentSource.camera]`
- `showDocumentProviderOptions: true` → `documentSources: [DocumentSource.camera, DocumentSource.photoUpload, DocumentSource.fileUpload]`.

See the [Android Migration guide](/release-notes/migration-guide/#4-documentscanbuilder-chooser-flags-deprecated-for-v2---migrate-to-setdocumentsources). 
:::


### eKYB

**Module ID:** `EKYB`

Collects and verifies a business entity's identity data, such as business name, address, and tax ID.

- `checkBusinessName` (optional, defaults to `true`): bool?
- `checkAddress` (optional, defaults to `true`): bool?
- `checkTaxId` (optional, defaults to `true`): bool?

### eKYC

**Module ID:** `EKYC`

Collects and verifies a user's personal identity data against authoritative data sources. This data can include the user's name, email, address, phone, tax ID, date of birth, and nationality.

- `checkName` (optional, defaults to `true`): bool?
- `checkEmail` (optional, defaults to `true`): bool?
- `checkAddress` (optional, defaults to `true`): bool?
- `checkPhone` (optional, defaults to `true`): bool?
- `checkSsn` (optional, defaults to `true`): bool?
- `checkDob` (optional, defaults to `true`): bool?
- `checkNationality` (optional, defaults to `true`): bool?

### Email

**Module ID:** `EMAIL`

Collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

- `otpVerification` (optional): bool?. Enables one-time password verification of the entered email.

### FaceAuthentication

**Module ID:** `AUTHENTICATION`

Captures a returning user's face with their device’s camera and matches it against the face already enrolled for that user. It then returns a pass or fail result.

:::info
**Not the same as Face Login**. The `FaceAuthentication` module runs as a step inside an onboarding Flow or Workflow. To authenticate a user as a standalone capability (outside a Flow or Workflow), use [Face Login](./flutter-face-login) and its `startFaceLogin` method.
:::

- `showTutorials` (optional, defaults to `true`): bool?. Shows a tutorial before face authentication.
- `autoCaptureTimeout` (optional, defaults to `16`): number?. Timeout in seconds for automatic face capture.
- `captureAttempts` (optional, defaults to `3`): number?. Number of allowed capture attempts before the step fails.
- `eyesClosedCheck` (optional, defaults to `true`): bool?. Checks whether the user's eyes are closed.
- `headCoverCheck` (optional, defaults to `true`): bool?. Checks for head coverings that may obstruct face recognition.
- `lensesCheck` (optional, defaults to `true`): bool?. Checks whether the user is wearing lenses or glasses.
- `faceMaskCheck` (optional, defaults to `true`): bool?. Checks whether the user is wearing a face mask.

To show your logo on all SDK screens, including the Face Authentication screens, call [`setLogo`](/sdk-reference/flutter-api-reference/#setlogo) before you start the flow.

### FaceMatch

**Module ID:** `FACE_MATCH`

Compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a confidence score.

Older documentation may refer to `faceMatchType` as `matchType`; the current name is `faceMatchType`.

This module must be added after the `IdScan` and `SelfieScan` modules.

- `idCategory` (optional, defaults to `primary`): `IdCategory.primary` or `IdCategory.secondary`.
- `showUserExists` (optional, defaults to `true`): bool.
- `faceMatchType` (optional): Determines which comparisons the SDK performs to verify the user's identity.

  | Value       | What it compares                                                 | Required modules                  | Assurance level                      |
  | ----------- | ---------------------------------------------------------------- | --------------------------------- | ------------------------------------ |
  | `idSelfie`  | Printed ID photo ↔ selfie                                        | `IdScan`, `SelfieScan`            | Standard                             |
  | `nfcSelfie` | NFC chip photo ↔ selfie                                          | `NFCScan`, `SelfieScan`           | Higher (chip photo is issuer-signed) |
  | `nfc3Way`   | All three: selfie ↔ chip, selfie ↔ printed ID, chip ↔ printed ID | `NFCScan`, `IdScan`, `SelfieScan` | Highest                              |

  `nfcSelfie` and `nfc3Way` require an NFC-capable document and a device with an NFC reader. Use `nfc3Way` for strict KYC/AML or high-risk onboarding where you need to verify the person, the physical document, and the chip are all mutually consistent.<br /><br />The `nfc3Way` chip-to-printed-ID comparison detects documents whose printed photo was altered but whose chip is genuine (or vice versa), which neither `idSelfie` nor `nfcSelfie` catches.

### FullName

**Module ID:** `NAME_CAPTURE`

Collects the user's name and sends it to the server. Older documentation may refer to this module as `Name`; the current name is `FullName`.

- No additional parameters.

### Geolocation

**Module ID:** `GEOLOCATION`

Requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city.

- `isSkippable` (optional, defaults to the native SDK default, `false`): bool. Allows the step to be skipped. When `true`, skipping or denying the location permission advances the flow instead of ending the session with a permission error, and `onGeolocationCompleted` receives a result with `status` `fail`.

### GlobalWatchlist

**Module ID:** `WATCHLIST`

Screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources.

- No additional parameters.

### GovernmentValidation

**Module ID:** `INE_VALIDATION`

Validates identity data extracted from a user's ID against an authoritative government registry. The process runs in the background and isn't visible to the user.

- `isBackgroundExecuted` (optional, defaults to `false`): bool?. If `true`, hides the module UI during execution.

### IdScan

**Module ID:** `ID`

Captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing.

- `showTutorials` (optional, defaults to `true`): bool?. Shows a tutorial before ID scan.
- `idType` (optional): `IdType.id` or `IdType.passport`. Preselects the document type. It doesn't hide the document chooser: set `showIdTypeChooser: false` for that.
- `idCategory` (optional): `IdCategory.primary` or `IdCategory.secondary`.
- `scanStep` (optional): Separates front and back ID captures. Specify `ScanStepType.front` or `ScanStepType.back` to capture one side; `ScanStepType.both` (default) captures both and processes the ID. If you specify `front` or `back`, you must add the `ProcessId` module after the captures.
- `showRetakeScreenForManualCapture` (optional, defaults to `true`): bool?. Set to `false` to omit the photo review screen for manual captures.
- `showRetakeScreenForAutoCapture` (optional, defaults to `false`): bool?. Set to `true` to show the photo review screen for auto captures.
- `enableFrontShownAsBackCheck` (optional, defaults to `false`): bool?. If `true`, shows real-time feedback during back ID capture if the user appears to be capturing the front side again.
- `enableBackShownAsFrontCheck` (optional, defaults to `false`): bool?. If `true`, shows real-time feedback during front ID capture if the user appears to be capturing the back side.
- `enableRotationOnRetakeScreen` (optional, defaults to `true`): bool?. Set to `false` to turn off image rotation when the user enters the photo review screen.
- `autocaptureUxMode` **(deprecated)**: Does not apply in V2. In V1, specifying `IdScanAutocaptureUXMode.countdown` introduces a 3-2-1 timer before auto-capture.
- `showIDOverlay` (optional, defaults to `false`): bool?. If `true`, shows an ID overlay during capture.
- `autoCaptureBestFrameTimeout` (optional, defaults to 25 seconds): Timer that starts when an ID is first detected. If the ID is not auto-captured successfully before the timer expires, manual capture mode is activated.
- `autoCaptureNoIdTimeout` (optional, defaults to 60 seconds): Timer that starts when ID scan auto-capture starts. If no ID is detected before the timer expires, manual capture mode is activated.
- `streamFrames` (optional, defaults to `false`): bool. Enables streaming of the camera feed. Requires the SDK `-vc` variant. See [SDK variants](./flutter-installation#sdk-variants).
- `showIdTypeChooser` (optional): bool?. Set to `false` to skip the document chooser screen. If omitted, the chooser is shown with `startOnboarding` and `startOnboardingSection`; with `startFlow` and `startWorkflow`, the Dashboard's **Show document chooser screen** setting applies.

### MLConsent

**Module ID:** `ML_CONSENT`

Captures the user's consent to process their biometric data for machine-learning purposes. It records their response on the server. You choose the consent text variant (US or GDPR style) that matches your compliance needs.

- `type` (required): `MLConsentType.gdpr` or `MLConsentType.us`.

### NFCScan

**Module ID:** `NFC_SCAN`

Reads the secure NFC chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image.

- `idType` (optional): `IdType.id` or `IdType.passport`. The ID type to use for NFC scanning. If unset and `IdScan` is enabled, the ID type from `IdScan` is reused; otherwise, an ID chooser screen is presented.
- `showNFCSymbolConfirmationScreen` (optional, defaults to `true`): bool?. If `true`, shows a screen asking the user whether their document contains an NFC chip. Disabling this is not recommended unless your app handles users without NFC documents, since they can otherwise get stuck.
- `showInitialDataConfirmationScreen` (optional, defaults to `true`): bool?. If `true`, shows the document OCR data confirmation screen before the first NFC scan.
- `processNFCData` (optional, defaults to `true`): bool?. If `true`, the data read from the NFC chip is used to validate identity. Behavior depends on how `FaceMatch` is configured.

### OCREdit

**Module ID:** `ID_OCR`

Reviews OCR data.

- `isEditable` (optional, defaults to `false`): bool?. If `true`, the user can edit the OCR data.

### Phone

**Module ID:** `PHONE`

Collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS.

- `defaultRegionPrefix` (optional): int?. Default region prefix for phone input. If set, overrides the default prefix based on the user's device region.
- `otpVerification` (optional): bool?. Enables one-time password verification of the entered phone number.

### ProcessId

**Module ID:** `PROCESS_ID`

Processes the ID when the `IdScan` module was separated into front and back captures (that is, when `ScanStepType.front` or `ScanStepType.back` was specified as `scanStep` for `IdScan`).

- `idCategory` (optional): `IdCategory.primary` or `IdCategory.secondary`.
- `enableIdSummaryScreen` **(deprecated)**: Does not apply in V2. In V1, defaults to `true`. Set to `false` to turn off the ID capture summary screen.

:::info
Call this module only after both `ScanStepType.front` and `ScanStepType.back` `IdScan` modules have completed.
:::

### QRScan

**Module ID:** `QR_SCAN`

Captures the QR code on the back of an ID, decodes its identity data, and sends it to the server.

- `showTutorials` (optional, defaults to `true`): bool?. Shows a tutorial before QR scan.

### SelfieScan

**Module ID:** `SELFIE`

Captures a user’s face with their device’s camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using 1:1 or 1:N face authentication.

- `showTutorials` (optional, defaults to `true`): bool?.
- `lensesCheck` (optional, defaults to `true`): bool?. Checks whether the user is wearing glasses during the selfie scan.
- `cameraFacing` (optional, defaults to `IdScanCameraFacing.front`): Specifies which camera is used during selfie capture. Set `IdScanCameraFacing.back` to use the back camera. `IdScanCameraFacing` is intentionally shared across the `IdScan`, `SelfieScan`, and `VideoSelfie` modules.
- `faceMaskCheck` (optional, defaults to `true`): bool?. Checks whether the user is wearing a face mask.
- `streamFrames` (optional, defaults to `false`): bool. Enables streaming of the camera feed. Requires the SDK `-vc` variant. See [SDK variants](./flutter-installation#sdk-variants).

### Signature

**Module ID:** `SIGNATURE`

Captures a signature the user hand-draws on screen. It is typically placed at the end of a verification journey to capture explicit consent.

- `title` (optional): String. Title displayed at the top of the screen.
- `description` (optional): String. Description displayed below the title.

### UserConsent

**Module ID:** `USER_CONSENT`

Shows a custom consent agreement for the user to accept or reject.

- `title` (required): String. Title for the user consent screen.
- `content` (required): String. Content for the user consent screen.

### UserScore

**Module ID:** `SHOW_RESULTS`

Shows the info and scoring for all the steps performed.

- `mode` (optional, defaults to `accurate`): `UserScoreFetchMode.accurate` or `UserScoreFetchMode.fast`. With `accurate`, results are fetched from the server (more reliable, some latency). With `fast`, on-device processing results are used.

### VideoSelfie

**Module ID:** `ACCEPT_VIDEO_SELFIE`

Records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent.

All parameters are optional.



- `showTutorials`: bool?. Shows a tutorial before video selfie. Defaults to `true`.
- `selfieScanMode`: `SelfieScanMode.selfieMatch` or `SelfieScanMode.faceMatch`. Selects whether to compare against a captured selfie or the photo from the ID. Defaults to `selfieMatch`.
- `selfieLivenessCheck`: bool?. Checks user liveness during the video selfie. Defaults to `false`.
- `enableFrontShownAsBackCheck`: bool?. If `true`, shows real-time feedback during back ID capture if the user appears to be capturing the front side. Defaults to `false`.
- `enableBackShownAsFrontCheck`: bool?. If `true`, shows real-time feedback during front ID capture if the user appears to be capturing the back side. Defaults to `false`.
- `showIdScan`: bool?. Asks for an ID scan during the video selfie. Defaults to `true`.
- `showDocumentScan`: bool?. Asks for proof of address during the video selfie. Defaults to `true`.
- `showVoiceConsent`: bool?. Asks for voice consent during the video selfie. Defaults to `true`.
- `voiceConsentQuestionsCount`: int?. Number of voice consent questions. Defaults to `3`.
- `showRandomQuestions`: bool?. If `true`, the module shows random questions the user must answer aloud during recording. If `false`, no random questions are shown. If not set, the module decides whether to show them.
- `randomQuestionsCount`: int?. The number of random questions to show when `showRandomQuestions` is `true`.
- `idScanCameraFacing`: `IdScanCameraFacing.front` or `IdScanCameraFacing.back`. Specifies which camera is used for ID scan during video selfie. `IdScanCameraFacing` is intentionally shared across the `IdScan`, `SelfieScan`, and `VideoSelfie` modules. Defaults to `back`.
- `minVideoLengthRequired`: bool?. Enforces the minimum video selfie recording length of 30 seconds. Set to `false` to let users submit a shorter recording. Defaults to `true`.

On Android, when the Video Selfie V2 experience is enabled for your account, the camera steps hide the close (X) button, so `showCloseButton(allowUserToCancel: true)` does not apply to them. The button still shows on the other screens, and Video Selfie V1 keeps it over the camera.

## Required ordering

Some modules must appear in a specific position relative to others. Add modules to your `OnboardingFlowConfiguration` in an order that satisfies all of the following:

- `ProcessId` must follow `IdScan` with both `ScanStepType.front` and `ScanStepType.back`.
- `FaceMatch` must follow both `IdScan` and `SelfieScan`.
- `VideoSelfie` requires `IdScan` (in `faceMatch` mode) or `SelfieScan` (in `selfieMatch` mode) to be present.
- `Aes` (Advanced Electronic Signature) must follow `Phone`, `IdScan`, and `SelfieScan`.
- `UserScore` must be at the end of the flow. Can be before or after `Approve`.
- `Approve` must be at the end of the flow. Can be before or after `UserScore`.

<br />

---

- Path: `sdk-reference/flutter-results`
- URL: https://developer.incode.com/sdk-reference/flutter-results/
- Markdown: https://developer.incode.com/sdk-reference/flutter-results.md

# Results

A Flutter SDK flow returns results in two ways: through per-API success, error, and cancellation behavior (delivered to the callbacks you pass to a `start` method), and through per-module result objects (delivered to optional listener callbacks as individual modules complete).

This page documents both. For how to register listeners and wire callbacks into a flow, see [Common Implementation Patterns](./flutter-common-implementation-patterns). For module configuration parameters, see [Modules](./flutter-modules).

## API results

This section lists the success results and errors returned by each top-level SDK API method. Per-module step results (delivered through callbacks such as `onSelfieScanCompleted`) are listed separately under [Module result objects](./flutter-results#module-result-objects).

### Error enums

Errors are delivered as a `String` to the `onError` callback. The `String` can be converted to one of the following enums.

`IncodeSdkInitError` (via `error.toIncodeSdkInitError()`) is returned by `init`:

- `simulatorDetected`
- `testModeEnabled`
- `invalidInitParams`
- `configError`
- `unknown`

`IncodeSdkFlowError` (via `error.toIncodeSdkFlowError()`) is returned by flow APIs such as `startOnboarding`:

- `permissionsDenied`
- `badEnvDetected` _(deprecated)_: No longer reported. The native SDK terminates the process when a compromised device environment is detected, so this case is never delivered.
- `integrityCompromised`
- `faceAuthenticationFailed`
- `sslPinningFailed`
- `locationUnavailable`
- `storageUnavailable` **(Android only)**: The device could not provide a writable images directory when the flow started.
- `combinedConsentsNotReceived` **(iOS only)**: A mandatory Combined Consent had no readable text or no checkbox id, so the flow stopped.
- `userScoreFailed`: Returned by `getUserScore` when no score is available for the session.
- `userCancelled`: The user dismissed the flow or section and the cancellation reached `onError` rather than `onUserCancelled`.
- `configError`: `startFlow` or `startWorkflow` was called with neither a `configurationId` nor a `token`, so the flow was not started.
- `activityNotPresent`: `startFlow` or `startWorkflow` was called without a host Activity (Android) or view controller (iOS), so the flow was not started.
- `unknown`

### init

- **Success:** `onSuccess` is called with no result object. Safe to start onboarding.
- **Error:** `onError(String error)`. Convert with `error.toIncodeSdkInitError()` to an `IncodeSdkInitError`.

### startOnboarding

- **Success:** `onSuccess` is called with no result object once all steps are completed.
- **Error:** `onError(String error)`. Convert with `error.toIncodeSdkFlowError()` to an `IncodeSdkFlowError`.
- **Cancellation:** `onUserCancelled` is called if the user cancels the flow.
- Per-step results are delivered through the optional module callbacks. See [Module result objects](./flutter-results#module-result-objects).

### startWorkflow

- **Success:** `onSuccess` is called with no result object once the Workflow completes.
- **Error:** `onError(String error)` receives the error code. Convert with `error.toIncodeSdkFlowError()` to an `IncodeSdkFlowError`. Returns `configError` when `sessionConfig` has neither a `configurationId` nor a `token`.
- **Cancellation:** `onUserCancelled` is called if the user cancels the Workflow.
- Per-step results are delivered through the optional module callbacks. See [Module result objects](./flutter-results#module-result-objects).

### setupOnboardingSession

- **Success:** `onSuccess(OnboardingSessionResult result)` is called once the onboarding session is created.
- **Error:** `onError(String error)`.

### startOnboardingSection

- **Success:** `onSuccess(String sectionTag)` is called once when the section finished, with the `sectionTag` identifier of the finished section. The deprecated `onOnboardingSectionCompleted(String sectionTag)` is called with the same tag just before it.
- **Error:** `onError(String error)` receives the error code. Convert with `error.toIncodeSdkFlowError()` to an `IncodeSdkFlowError`. Before the section starts it can be `configError`, `unknownModule`, `sectionAlreadyRunning`, `activityNotPresent`, or `noActiveSession`; see [API Reference](/sdk-reference/flutter-api-reference/#startonboardingsection).
- Per-step results are delivered through the optional module callbacks. See [Module result objects](./flutter-results#module-result-objects).

### finishFlow

- Returns no result and reports no errors.

### startFlow

- **Success:** `onSuccess` is called with no result object once the flow completes.
- **Error:** `onError(String error)`.
- **Cancellation:** `onUserCancelled` is called if the user cancels the flow.

### startFlowFromDeepLink

- **Success:** `onSuccess` is called with no result object once the flow completes.
- **Error:** `onError(String error)`.
- **Cancellation:** `onUserCancelled` is called if the user cancels the flow.

### faceMatch

- **Success:** `onSuccess` is called with no result object.
- **Result:** `onFaceMatchCompleted(FaceMatchResult result)` delivers the match result. See [FaceMatch](./flutter-results#facematch-1) under Module result objects.
- **Error:** `onError(String error)`.
- **Cancellation:** `onUserCancelled` is called if the user cancels.

### startFaceLogin

- **Success:** `onSuccess(FaceLoginResult result)`.
- **Error:** `onError(String error)`.

`FaceLoginResult` contains:

- `image`: Selfie image captured during login.
- `spoofAttempt`: bool. `true` indicates the user tried to spoof the system.
- `base64Images`: Base64 representations of the selfie image.
- `faceMatched`: bool. `true` if the faces matched, `false` otherwise.
- `customerUUID`: String?. Unique user identifier if authentication succeeded. `null` if `faceMatched` is `false`.
- `interviewId`: String. Session ID in which the user was approved.
- `interviewToken`: String. Session token in which the user was approved.
- `token`: String. Token that can be used for further API calls.
- `transactionId`: String. Unique identifier of the Face Login attempt.
- `hasLenses`: bool. Indicator if the login attempt failed because the user was wearing lenses.
- `hasFaceMask`: bool. Indicator if the login attempt failed because the user was wearing a face mask.

### idProcess

- **Success:** `onSuccess(IdProcessResult result)`.
- **Error:** `onError(String error)`.

`IdProcessResult` contains:

- `ocrData`: String?. Raw JSON containing full OCR data (for example, `exteriorNumber`, `interiorNumber`, `typeOfId`, `documentFrontSubtype`).

### addFace

- **Success:** `onSuccess(bool result)`.
- **Error:** `onError(String error)`.

### removeFace

- **Success:** `onSuccess(bool result)`.
- **Error:** `onError(String error)`.

### getFaces

- **Success:** `onSuccess(List<FaceInfo> faceInfos)`.
- **Error:** `onError(String error)`.

### setFaces

- **Success:** `onSuccess(bool result)`.
- **Error:** `onError(String error)`.

### deleteLocalUserData

- Returns a `Future` that completes once locally stored user data is deleted. No result object or error is reported.

### getUserScore

- **Success:** `onSuccess(UserScoreResult result)`.
- **Error:** `onError(String error)`.

`UserScoreResult` has an `extendedUserScoreJsonData` String field containing the full user data in JSON format. See [UserScore](./flutter-results#userscore) under Module result objects for the full structure.

### addNOM151Archive

- **Success:** `onSuccess(AddNom151Result addNom151Result)`.
- **Error:** `onError(String error)`.

`AddNom151Result` contains:

- `signature`: String?.
- `archiveUrl`: String?.

### getUserOCRData

- **Success:** `onSuccess(GetUserOCRDataResult result)`.
- **Error:** `onError(String error)`.

`GetUserOCRDataResult` contains:

- `ocrData`: String. Full OCR data in JSON format.

### isInitialized

- Returns a `Future<bool>` that resolves to `true` when the SDK is ready to be used, and `false` otherwise. The method never throws; any platform error is handled internally and reported as `false`.

### onEvents

When onboarding has been started, the optional `onEvents` callback delivers `OnEventsResult` for every tracked user step:

- `event`: String. Unique identifier of the event.
- `data`: String?. JSON string with additional event details.

### Methods without a result

The following methods return no result object and report no errors: `setSdkMode`, `setTheme`, `setString`, `setLocalizationLanguage`, and `showCloseButton`. `setUIConfigFromJson` reports errors through its `onError` callback.

## Module result objects

This section lists the result objects returned by individual modules. Alphabetized for direct lookup.

### Aes

Specify `onAesCompleted` to one of the `start` methods to receive `AesResult`:

- `success`: bool. `true` if Aes completed successfully, `false` otherwise.
- `error`: `AesError`. Possible values: `noDocuments`, `failedToSign`.

### Antifraud

Specify `onAntifraudCompleted` to one of the `start` methods to receive `AntifraudResult`:

- `success`: bool. `true` if the antifraud check passed successfully, `false` otherwise.

### Approve

Specify `onApproveCompleted` to one of the `start` methods to receive `ApprovalResult`. The same payload is delivered by the standalone [`approve`](/sdk-reference/flutter-api-reference/#approve) method:

- `success`: bool. `true` if the approval was successful, `false` otherwise.
- `uuid`: String?. Customer ID of the newly created customer if approval was successful; `null` otherwise.
- `customerToken`: String?. Customer token for the newly created customer if approval was successful; `null` otherwise.
- `error`: String?. Module-level error reported by the native SDK, using `IncodeSdkFlowError` values; `null` if there was none. Always `null` on Android, whose native result has no equivalent field.

### Captcha

Specify `onCaptchaCompleted` to one of the `start` methods to receive `CaptchaResult`:

- `captcha`: String?. The CAPTCHA value entered by the user.

### CombinedConsent

Specify `onCombinedConsentCompleted` to one of the `start` methods to receive `CombinedConsentResult`:

- `success`: bool. `true` if the user gave data sharing consent, `false` otherwise.

### CURP

Specify `onCurpValidationCompleted` to one of the `start` methods to receive `CurpValidationResult`:

- `curp`: String?. The validated, generated, or entered CURP. `null` if the SDK has none, for example when generating a CURP failed.
- `valid`: bool?. `true` if RENAPO accepted the CURP, `false` if it rejected it. `null` when `validationEnabled` is `false`, because no RENAPO check ran, or when the module failed.
- `data`: Map\<String, dynamic>?. The CURP validation response from the server. Its keys are server-defined. `null` when there is no server response: when `validationEnabled` is `false`, or on Android when the final validation request failed.
- `status`: String. `success` or `fail`, on both platforms. It follows `valid`: `success` only when RENAPO accepted the CURP. When `validationEnabled` is `false`, it is `success` when a CURP in a valid format was captured.
- `resultCode`: String. Finer outcome. Both platforms report `success` and `error`; Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback.

`onCurpValidationCompleted` is called once per module, on both platforms, with the final result. The number of attempts the user gets differs by platform.

### CustomWatchlist

Specify `onCustomWatchlistCompleted` to one of the `start` methods to receive `CustomWatchlistResult`:

- `success`: bool. `true` if the CustomWatchlist check completed successfully, `false` otherwise.

### Document

Specify `onDocumentScanCompleted` to one of the `start` methods to receive `DocumentScanResult`:

- `image`: Uint8List?. Document scan image.
- `documentType`: `DocumentType`. The type of scanned document.
- `address`: Map\<String, dynamic>?. Address fetched from the document. Available only for `DocumentType.addressStatement`.
- `ocrData`: Raw JSON containing full OCR data.

### EKYB

Specify `onEKYBCompleted` to one of the `start` methods to receive `EKYBResult`:

- `success`: bool. `true` if the eKYB scan completed successfully, `false` otherwise.

### EKYC

Specify `onEKYCCompleted` to one of the `start` methods to receive `EKYCResult`:

- `success`: bool. `true` if the eKYC scan completed successfully, `false` otherwise.

### Email

Specify `onAddEmailCompleted` to one of the `start` methods to receive `AddEmailResult`:

- `email`: String?. The email the user entered. `null` if the SDK captured none.
- `status`: String. `success` or `fail`, on both platforms.
- `resultCode`: String. Finer outcome. Both platforms report `success` and `error`; Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback.

### FaceAuthentication

Specify `onFaceAuthenticationCompleted` to one of the `start` methods to receive `FaceAuthenticationResult`:

- `status`: bool. `true` if face authentication succeeded, `false` otherwise.
- `customerUUID`: String?. Unique customer identifier if face authentication succeeded. `null` if `status` is `false`.
- `selfieBase64`: String?. Base64 representation of the selfie image captured during face authentication.
- `selfieEncryptedBase64`: String?. Encrypted base64 representation of the selfie image.
- `error`: String?. Description of the error if face authentication did not succeed.

### FaceMatch

Specify `onFaceMatchCompleted` to one of the `start` methods to receive `FaceMatchResult`:

- `confidence`: double?. Recognition confidence between selfie and ID photo.
  If it is higher than 0.6f, the person's selfie successfully matched with the front ID. If it is -1, the front ID image wasn't uploaded, so the face match service didn't have data to compare with the selfie. Valid range is `0.0` to `1.0`.
- `existingInterviewId`: String?. If the user is an existing user, the existing interview ID.
- `idCategory`: `IdCategory`. Category of the ID used for face match.
- `isExistingUser`: bool. Indicates whether the user is new or existing.
- `isFaceMatched`: bool. `true` if the user's selfie matched the front ID successfully. `false` if it did not match. `null` if the front ID image was not uploaded, so the face match service had no data to compare with.
- `isNameMatched`: bool?._&#x20;_`true` if the name of the already existing user matches the name of the current user. `false` otherwise.
- `nfcVsIdConfidence`: double?. Recognition confidence between ID and NFC photo.<br />If it is higher than 0.6f, the person's front ID photo successfully matched with the image in the NFC chip. If it is -1, either no front ID or NFC image was uploaded, so the face match service didn't have data to compare. Valid range is `0.0` to `1.0`.
- `nfcVsSelfieConfidence`: double?. Recognition confidence between selfie and NFC photo.<br />If it is higher than 0.6f, the person's selfie successfully matched with the image in the NFC chip. If it is -1, no NFC image was uploaded, so the face match service didn't have data to compare with the selfie. Valid range is `0.0` to `1.0`.
- `secondIdConfidence`: double?. Recognition confidence between the selfie and the secondary ID. Valid range is `0.0` to `1.0`.

Older documentation may refer to `isFaceMatched` as `faceMatched` and `isExistingUser` as `existingUser`; the current names are `isFaceMatched` and `isExistingUser`.

### FullName

Specify `onAddFullNameCompleted` to one of the `start` methods to receive `AddFullNameResult`:

- `name`: String?. The name the user entered. `null` if the SDK captured none.
- `status`: String. `success` or `fail`, on both platforms.
- `resultCode`: String. Finer outcome. Both platforms report `success` and `error`; Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback.

### Geolocation

Specify `onGeolocationCompleted` to one of the `start` methods to receive `GeoLocationResult`:

- `addressFields`: GeoLocationAddress?. The resolved address, `null` when no location was fetched. Its `street`, `colony`, `postalCode`, `city`, and `state` fields are each `null` when the SDK has no value. `state` holds the country name, and `city` falls back to the region when the city is unknown. On iOS, a location whose address could not be fully resolved is reported with `status` `fail` and `locationUnavailable`, but still carries the partial address and the coordinates.
- `latitude`: double?. `null` when no location was fetched.
- `longitude`: double?. `null` when no location was fetched.
- `status`: String. `success` only when a location was fetched, `fail` otherwise.
- `resultCode`: String. `success` or `error` on both platforms; Android can also report `userCancelled`.
- `error`: String?. Set exactly when `resultCode` is `error`, on both platforms: `permissionsDenied`, `locationUnavailable`, `sslPinningFailed`, `integrityCompromised`, or `unknown`. Convert with `error?.toIncodeSdkFlowError()` to an `IncodeSdkFlowError`. On iOS, a skip in the current UI is always reported as `locationUnavailable`.

A skipped, denied, or unavailable location is delivered here with `status` `fail`, and the flow continues. When the module isn't skippable, the flow ends through `onError` instead. On Android, a non-skippable failure first delivers this result with `status` `fail`, and then calls `onError`.

### GlobalWatchlist

Specify `onGlobalWatchlistCompleted` to one of the `start` methods to receive `GlobalWatchlistResult`:

- `success`: bool. `true` if the GlobalWatchlist check completed successfully, `false` otherwise.

### GovernmentValidation

Specify `onGovernmentValidationCompleted` to one of the `start` methods to receive `GovernmentValidationResult`:

- `success`: bool. `true` if government validation succeeded, `false` otherwise.

### IdScan

IdScan delivers results through two listener types.

#### Per-side capture

Specify `onIdFrontCompleted`, `onIdBackCompleted`, `onIdFrontAttemptCompleted`, `onIdBackAttemptCompleted`, or multiple of these to one of the `start` methods to receive `IdScanResult`:

- `image`: Captured ID image.
- `base64Image`: String?. Captured front ID image in base64 format.
- `croppedFace`: Cropped face from the captured ID image.
- `chosenIdType`: User-chosen type on the ID selection screen (`id` or `passport`).
- `classifiedIdType`: Type of the captured ID.
- `idCategory`: `IdCategory`. Category of the scanned ID.
- `failReason`: String?. Reason the ID scan failed.
- `issueName`: String?. Detailed type of the ID.
- `issueYear`: int?. Year the ID was issued.
- `countryCode`: String?. Country code where the ID was issued.
- `scanStatus`: `IdValidationStatus`. If the value is anything other than `ok`, the ID scan or validation did not complete successfully. Possible values include: `ok`, `errorClassification`, `noFacesFound`, `errorCropQuality`, `errorGlare`, `errorSharpness`, `errorTypeMismatch`, `userCancelled`, `unknownError`, `emulatorDetected`, `errorAddress`, `errorPassportClassification`, `errorUnacceptableID`.
- `allAttemptsExhausted`: bool. Indicates whether all retry attempts have been exhausted. Reflects the outcome of the current side (front or back) independently.

`onIdFrontCompleted` and `onIdBackCompleted` are called only on a successful scan, while `onIdFrontAttemptCompleted` and `onIdBackAttemptCompleted` are called on every scan, successful or not.

#### OCR data

Specify `onIdProcessed` to one of the `start` methods to receive a `String` OCR result:

- `ocrData`: String?. Raw JSON containing the full OCR data (for example, `exteriorNumber`, `interiorNumber`, `typeOfId`, `documentFrontSubtype`).

### MLConsent

Specify `onMLConsentCompleted` to one of the `start` methods to receive `MLConsentResult`:

- `success`: bool. `true` if the user accepted the machine learning consent, `false` if they declined it.

The consent is optional and the flow continues either way, so treat `success: false` as "declined", not as a module failure. On iOS, `false` is also reported in the rare case where the choice could not be recorded.

### NFCScan

Specify `onNFCScanCompleted` to one of the `start` methods to receive `NFCScanResult`:

- `success`: bool?. `true` if the NFC scan was successful.
- `birthDate`: String?. Date of birth of the document owner, in `yyMMdd` format.
- `compositeCheckDigit`: String?. Digit used to check the integrity of all data in the MRZ of the document.
- `dateOfBirthCheckDigit`: String?. Digit used to check the integrity of the `birthDate` field.
- `documentCode`: String?. Type of ICAO 9303-compliant document. For example, a passport booklet is `TD3`. Possible values: `TD1`, `TD2`, `TD3`, `MRVA`, `MVRB`.
- `documentNumber`: String?. The 9 most significant digits of the passport number, CIC, or equivalent.
- `documentNumberCheckDigit`: String?. Digit used to check the integrity of the `documentNumber` field.
- `expirationDateCheckDigit`: String?. Digit used to check the integrity of the `expireAt` field.
- `expireAt`: String?. Document expiration date, in `yyMMdd` format.
- `gender`: String?. Gender of the document owner. Possible values: `M`, `F`, `UNKNOWN`, `UNSPECIFIED`.
- `issuingStateOrOrganization`: String?. Three-letter code of the authority that issued the document. For example, US passports use `USA`.
- `nationality`: String?. Three-letter code of the document owner's nationality. For example, UK passports use `GBR`.
- `optionalData1`: String?. Contents of the first optional data field, for TD-1 and TD-3 style MRZs.
- `optionalData2`: String?. Contents of the second optional data field, for TD-1 style MRZs only.
- `personalNumber`: String?. Personal number of the document owner, if encoded in `optionalData1`.
- `personalNumberCheckDigit`: String?. Digit used to check the integrity of the `personalNumber` field. Populated only when `documentCode` is `TD3`.
- `primaryIdentifier`: String?. Primary means of identifying the document. Typically the document owner's last name.
- `secondaryIdentifier`: String?. Secondary means of identifying the document. Typically the document owner's other names.

### OCREdit

Specify `onOCREditCompleted` to one of the `start` methods to receive `OCREditResult`:

- `success`: bool. `true` if OCR edit completed successfully, `false` otherwise.

### Phone

Specify `onAddPhoneNumberCompleted` to one of the `start` methods to receive `PhoneNumberResult`:

- `phone`: String?. The phone number the user entered. `null` if the SDK captured none.
- `status`: String. `success` or `fail`, on both platforms.
- `resultCode`: String. Finer outcome. Both platforms report `success` and `error`; Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback.

### QRScan

Specify `onQRScanCompleted` to one of the `start` methods to receive `QRScanResult`:

- `success`: bool. `true` if the QR scan completed successfully, `false` otherwise.

### SelfieScan

Specify `onSelfieScanCompleted` and/or `onSelfieScanAttemptCompleted` to one of the `start` methods to receive `SelfieScanResult`:

- `image`: Uint8List?. Captured selfie image.
- `spoofAttempt`: bool. `false` indicates a real person. `true` indicates a spoof attempt (the user tried to deceive the system using paper, a digital photo, or other method). `null` indicates an unexpected error so spoof detection could not run.
- `base64Images`: `SelfieScanBase64Images`. Selfie image in different formats.
  - `selfieBase64`: String?. Captured selfie as a base64 image.
  - `selfieEncryptedBase64`: String?. Captured selfie as an encrypted base64 image.
- `allAttemptsExhausted`: bool. Indicates whether all retry attempts have been exhausted.

`onSelfieScanCompleted` is called only on a successful scan, while `onSelfieScanAttemptCompleted` is called on every scan, successful or not.

### Signature

Specify `onSignatureCollected` to one of the `start` methods to receive `SignatureResult`:

- `signature`: Uint8List?. The collected signature image.

### UserConsent

Specify `onUserConsentCompleted` to one of the `start` methods to receive `UserConsentResult`:

- `success`: bool. `true` if the user gave consent, `false` otherwise.

### UserScore

Specify `onUserScoreFetched` to one of the `start` methods to receive `UserScoreResult`:

- `extendedUserScoreJsonData`: String?. The full score payload as a JSON string, or `"{}"` when unavailable.
- `overall`: `UserScore?`.
- `idValidation`: `IdValidationScore?`.
  - `overall`: `UserScore`.
  - `photoSecurityAndQuality`: `List<UserScoreCheck>`. Never contains `unknown` entries.
  - `idSpecific`: `List<UserScoreCheck>`.
- `liveness`: `LivenessScore?`.
  - `overall`: `UserScore`.
  - `livenessScore`: `UserScore`.
  - `photoQuality`: String?.
- `faceRecognition`: `FaceRecognitionScore?`.
  - `overall`: `UserScore`.
  - `existingUser`: bool. `true` when the face matched an already-enrolled user. `false` when the field is absent.
- `governmentValidation`: `GovernmentValidationScore?`.
  - `overall`: `UserScore`.
  - `recognitionConfidence`: `UserScore`.
  - `validationStatus`: `UserScoreCheck`.
  - `ocrValidation`: `List<UserScoreCheck>`. Never contains `unknown` entries.

`UserScore` contains:
- `value`: `String?`.
- `status`: `UserScoreStatus?`. The field can have one of the following values: `warn`, `unknown`, `manual`, `fail`, `ok`.

`UserScoreCheck` adds `key` (String?), naming the individual check.

Example `UserScoreResult`:

```dart
{
  overall: {value: '80.5', status: 'ok'},
  idValidation: {
    overall: {value: '92', status: 'ok'},
    photoSecurityAndQuality: [{key: 'tamperCheck', value: '100', status: 'ok'}],
    idSpecific: [{key: 'barcodeVerified', value: '88', status: 'warn'}],
  },
  liveness: {
    overall: {value: '88', status: 'ok'},
    livenessScore: {value: '87', status: 'ok'},
    photoQuality: '70.5',
  },
  faceRecognition: {
    overall: {value: '95', status: 'ok'},
    existingUser: false,
  },
  governmentValidation: {
    overall: {value: '90', status: 'ok'},
    recognitionConfidence: {value: '91', status: 'ok'},
    validationStatus: {key: 'validationStatus', value: 'VALID', status: 'ok'},
    ocrValidation: [{key: 'firstName', value: 'MATCH', status: 'ok'}],
  },
}
```

### VideoSelfie

Specify `onVideoSelfieCompleted` to one of the `start` methods to receive `VideoSelfieResult`:

- `success`: bool. `true` if the video selfie completed successfully, `false` otherwise.

<br />

---

- Path: `sdk-reference/flutter-run-flows-configured-online`
- URL: https://developer.incode.com/sdk-reference/flutter-run-flows-configured-online/
- Markdown: https://developer.incode.com/sdk-reference/flutter-run-flows-configured-online.md

# Run Flows Configured Online

Use this pattern when your Flow or Workflow is configured online in the Incode Dashboard rather than in your app code. The SDK fetches the configuration from the Dashboard at runtime using a `configurationId`, so you can update the flow's modules and behavior without redeploying your app.

## When to use this pattern

Use this pattern when:

- Your Flow or Workflow is configured in the Incode Dashboard.
- You want to update flow behavior without app redeployment.
- You want to resume an existing session by `interviewId`, or start a Flow from a specific module.

For flows configured in app code, see [Configure Flows Locally and Run End to End](./flutter-configure-flows-locally-and-run-end-to-end) or [Configure Flows Locally and Run Step by Step](./flutter-configure-flows-locally-and-run-step-by-step).

## Workflows vs. Flows

Incode supports two distinct Dashboard artifacts:

- **Flows**: Simple and straightforward user journeys. Start a Flow with `startFlow()`.
- **Workflows**: Highly customizable user journeys, where the results of a module can alter what the user is presented with next. Start a Workflow with `startWorkflow()`.

The two methods are similar in shape but are not interchangeable. Use the method that matches the artifact configured in the Dashboard.

## Prerequisites

- The SDK is initialized. See [Installation](./flutter-installation).
- A `configurationId` from the Incode Dashboard for the Flow or Workflow you want to run.

## Start a Flow

Call `startFlow()` with an `OnboardingSessionConfiguration` that includes the `configurationId`. Optionally provide an `interviewId` to resume an existing session, and a `moduleId` to start from a specific module within the flow.

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration(
  configurationId: "YOUR_CONFIGURATION_ID",
  interviewId: "YOUR_INTERVIEW_ID", // optional
);

IncodeOnboardingSdk.startFlow(
  sessionConfig: sessionConfig,
  moduleId: 'YOUR_MODULE_ID', // optional, e.g., "PHONE"
  onError: (String error) {
    print('Incode startFlow error: $error');
  },
  onSuccess: () {
    print('Incode startFlow completed!');
  },
  onUserCancelled: () {
    print('User cancelled');
  },
);
```

### Start Flow parameters

- `sessionConfig`: Required. An `OnboardingSessionConfiguration` containing at minimum the `configurationId`. See [Configure the onboarding session](./flutter-configure-flows-locally-and-run-end-to-end#1-configure-the-onboarding-session) on the end-to-end pattern page for the full list of session parameters.
- `moduleId`: Optional String. Starts the Flow from a specific module. Useful when resuming a partially completed session. See [Modules](./flutter-modules) for the list of valid module IDs.
- `onSuccess`: Called when the Flow completes successfully.
- `onError`: Called when an error stops the Flow.
- `onUserCancelled`: Called when the user cancels the Flow.

You can also add optional per-module listener callbacks (for example, `onIdFrontCompleted`, `onSelfieScanCompleted`) to `startFlow`, the same way you can on `startOnboarding`. See [`startOnboarding`](./flutter-api-reference#startonboarding) on the API Reference page for the full callback inventory.

## Start a Workflow

Call `startWorkflow()` with an `OnboardingSessionConfiguration` that includes the `configurationId` of a Workflow configured in Dashboard.

`startWorkflow()` has the same signature as `startFlow()`, without the `moduleId` parameter. For the full signature and parameter list, see [`startWorkflow`](./flutter-api-reference#startworkflow) on the API Reference page.

```dart
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration(
  configurationId: "YOUR_CONFIGURATION_ID",
);

IncodeOnboardingSdk.startWorkflow(
  sessionConfig: sessionConfig,
  onError: (String error) {
    print('Incode startWorkflow error: $error');
  },
  onSuccess: () {
    print('Incode startWorkflow completed!');
  },
  onUserCancelled: () {
    print('User cancelled');
  },
);
```

You can also add optional per-module listener callbacks (for example, `onIdFrontCompleted`, `onSelfieScanCompleted`) to `startWorkflow`, the same way you can on `startOnboarding`. See [`startOnboarding`](./flutter-api-reference#startonboarding) on the API Reference page for the full callback inventory.

---

- Path: `sdk-reference/flutter-sdk`
- URL: https://developer.incode.com/sdk-reference/flutter-sdk/
- Markdown: https://developer.incode.com/sdk-reference/flutter-sdk.md

# Incode Flutter SDK Reference

The Incode Flutter SDK adds end-to-end identity verification to your app: document and ID capture with OCR, selfie and video-selfie liveness, face match, and NFC e-passport reading. The UI is fully themeable, so onboarding looks and feels like your product. The SDK ships through GitHub and supports Android and iOS. Multiple variants are available for different feature sets.

This page orients you to what the SDK does and routes you to the page you need next. If you are starting fresh, begin with [Getting Started](./flutter-getting-started) and [Common Implementation Patterns](./flutter-common-implementation-patterns).

## Start here

| If you want to...                      | Go to                                                                      |
| -------------------------------------- |----------------------------------------------------------------------------|
| Add the SDK to your project            | [Installation](./flutter-installation)                                     |
| Get an onboarding flow running         | [Common Implementation Patterns](./flutter-common-implementation-patterns) |
| Authenticate a returning user          | [Face Login](./flutter-face-login)                                         |
| Browse available modules               | [Modules](./flutter-modules)                                               |
| See the result payloads modules return | [Results](./flutter-results)                                               |
| Customize colors, fonts, and text      | [Customization](./flutter-customization)                                   |
| Browse the full public API             | [API Reference](./flutter-api-reference)                                   |
| Solve a build problem                  | [Known Issues](./flutter-known-issues)                                     |
| Migrate to a newer version             | [Migration Guide](./flutter-migration-guide)                               |

## How the SDK fits together

The SDK supports three integration patterns. They differ in how much of the UI and orchestration the SDK owns. The recommended starting point for most integrations is the online-configured flow.

### Pattern 1: Run Flows configured online (recommended)

You build a Flow or Workflow in Dashboard and pass its ID/URL (`configurationId`) to `startFlow()` or `startWorkflow()`. The SDK owns the UI from the first screen to the last and returns results through listener callbacks. Use this pattern when you want to update flow behavior from Dashboard without redeploying your app.

See [Run Flows Configured Online](./flutter-run-flows-configured-online) for the details.

### Pattern 2: Configure flows locally and run end to end

You build an `OnboardingFlowConfiguration` in app code describing the modules you want (ID scan, selfie, NFC, and so on) and pass it to `startOnboarding()`. The SDK owns the UI from the first screen to the last and returns results through listener callbacks. Use this pattern when you want the simplicity of a single SDK call but prefer defining your flow in code rather than in Dashboard.

See [Configure Flows Locally and Run End to End](./flutter-configure-flows-locally-and-run-end-to-end) for the details.

### Pattern 3: Configure flows locally and run step by step

You run modules in named sections and return control to your app between sections. The SDK still owns each module screen (camera UI, capture experience, on-device guidance), but your app owns the shell around them: navigation, your own intro and transition screens, and when each section launches. Use this pattern when you need to interleave Incode steps with your own screens or run only part of a flow.

See [Configure Flows Locally and Run Step by Step](./flutter-configure-flows-locally-and-run-step-by-step) for the details.

## Variants

The SDK has multiple variants, so you only ship what you use.

| Variant  | Description                                                                              |
| -------- | ---------------------------------------------------------------------------------------- |
| Standard | Default variant. No modifier.                                                            |
| `-vc`    | Streams the camera feed during Selfie and ID scan.                                       |
| `-nfc`   | Reads data from a passport or ID chip via NFC.                                           |
| `-l`     | Manipulates locally stored identities. Required for 1:N `FaceAuthMode.local` Face Login. |
| `-sna`   | Adds support for Silent Network Authentication. |

See [SDK variants](./flutter-installation/#sdk-variants) on the Installation page for details.

## What the SDK can do

- **Identity capture:** ID scan, document capture, and OCR data extraction.
- **Liveness and biometrics:** selfie capture, video selfie, liveness detection, and face match.
- **NFC / e-passport:** reads the chip in passports and supported ID documents.
- **Authentication:** standalone Face Login for returning users (1:1 or 1:N database lookup). See [Face Login](./flutter-face-login).
- **Customization:** theming, localization, and custom assets so the experience matches your brand. See [Customization](./flutter-customization).

## Need help?

- Hit a build or runtime error? See [Known Issues](./flutter-known-issues).
- Looking for a specific class, method, or parameter? See [API Reference](./flutter-api-reference).
- Still stuck? Contact your enterprise Customer Success Manager or email [help@incode.com](mailto:help@incode.com).

---

- Path: `sdk-reference/flutter-sdk-modes`
- URL: https://developer.incode.com/sdk-reference/flutter-sdk-modes/
- Markdown: https://developer.incode.com/sdk-reference/flutter-sdk-modes.md

# SDK Modes

The SDK supports three modes that control whether captured images are uploaded and validated server-side.

## Available modes

- `SdkMode.standard`: The default. Captured images are uploaded to Incode's servers and validated. Use this mode for standard onboarding flows.
- `SdkMode.captureOnly`: Skips image upload and server validation for ID and Selfie scans. Use this mode when you want to capture images on the device without server-side processing.
- `SdkMode.submitOnly`: Submit previously captured data without performing new captures.

## Set the SDK mode

Pass `sdkMode` to the `init` [method](./flutter-api-reference#init) or call `setSdkMode` after initialization. If you do neither, the SDK uses `SdkMode.standard`.

```dart
// Pass sdkMode to init:
IncodeOnboardingSdk.init(
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'YOUR_API_URL',
  sdkMode: SdkMode.captureOnly,
  onError: (String error) {},
  onSuccess: () {},
);

// Or change mode after init:
IncodeOnboardingSdk.setSdkMode(sdkMode: SdkMode.captureOnly);
```

### When to call setSdkMode

Call `setSdkMode` after [`init`](./flutter-api-reference#init) and before [`startOnboarding`](./flutter-api-reference#startonboarding) (or [`setupOnboardingSession`](./flutter-api-reference#setuponboardingsession)). Do not call `setSdkMode` mid-session; doing so is not an error, but it can cause undefined behavior.

The SDK preserves the set mode for the next session.

---

- Path: `sdk-reference/flutter-token-based-setup`
- URL: https://developer.incode.com/sdk-reference/flutter-token-based-setup/
- Markdown: https://developer.incode.com/sdk-reference/flutter-token-based-setup.md

# Token-based Setup

<Component slug="sdk-token-based-setup" />

Initialize the SDK without an API key by providing only an `apiUrl` to the `init` method, then using a session `token` to configure your onboarding session.



## Prerequisites

- A session `token` issued by your backend.
- The `apiUrl` provided by Incode.

## Set up the SDK with a token

Token-based setup has three steps: initialize the SDK with only an `apiUrl`, configure your session with a `token`, then start onboarding or set up a section-based flow.

### 1. Initialize the SDK without an API key

Provide only the `apiUrl` to the `init` method. Omit `apiKey`.

```dart
IncodeOnboardingSdk.init(
  apiUrl: 'https://demo-api.incodesmile.com/0/',
  onError: (String error) {
    print('Incode SDK init failed: $error');
  },
  onSuccess: () {
    // Update UI, safe to start Onboarding
    print('Incode initialize successfully!');
  },
);
```

### 2. Configure the session with a token

In your `onSuccess` callback, create an `OnboardingSessionConfiguration` and pass your session `token`.

```dart
OnboardingSessionConfiguration sessionConfiguration = OnboardingSessionConfiguration(
  token: 'YOUR_TOKEN',
);
```

### 3. Start onboarding or set up a section-based flow

Pass the configured `OnboardingSessionConfiguration` to `startOnboarding`, `setupOnboardingSession`, or any of the online-configured flow methods. Token-based setup works with all three [Common Implementation Patterns](./flutter-common-implementation-patterns).

## Token expiration

Tokens are long-lived, so expiration during a session is unlikely. If a token does expire mid-session, the backend returns a 401 error, which is propagated to the SDK. Tokens cannot be refreshed; the user must start a new onboarding session, which generates a new token.

---

- Path: `sdk-reference/incode-web-sdk-2-reference`
- URL: https://developer.incode.com/sdk-reference/incode-web-sdk-2-reference/
- Markdown: https://developer.incode.com/sdk-reference/incode-web-sdk-2-reference.md

# Incode WebSDK 2.0 Reference

The Incode Web SDK embeds identity verification — document capture, selfie liveness, phone/email OTP, eKYC, eKYB, and more — into any web application. It ships as web components, manager APIs, and a plug-and-play `<incode-flow>` element.

This documentation is for developers integrating with Incode's Platform using the Web SDK.

<Component slug="web-2-x-implementation-warning" />

## Start here

| If you want to…                  | Go to                                                      |
| -------------------------------- | ---------------------------------------------------------- |
| Get a working flow in 5 minutes  | [Getting Started](/sdk-reference/web-sdk-2-getting-started/)           |
| See every module the SDK exposes | [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)     |
| Use the all-in-one component     | [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/) |
| Build fully custom UI            | [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/)               |
| Customize colors and typography  | [Theming & Styling](/sdk-reference/web-sdk-2-theming/)                 |
| Reference for the public API     | [API Reference](/sdk-reference/web-sdk-2-reference/)                   |
| Solve a specific problem         | [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/)           |
| See what changed in a release    | [Release Notes](/release-notes/web-sdk-20-release-notes/)                   |
| Replace a branded illustration or animation | [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/) |

## How the SDK fits together

```mermaid
flowchart LR
    subgraph BE["Your backend"]
        ApiKey["API key + Configuration ID<br/>(server-side only)"]
    end

    subgraph Browser["Browser"]
        Init["setup&#40;apiURL, token&#41;"]

        subgraph P1["Path 1 — Drop-in"]
            Flow["&lt;incode-flow&gt;<br/><i>one element, full UI</i>"]
        end
        subgraph P2["Path 2 — Orchestrator"]
            Orch["createOrchestratedFlowManager"]
            WCs["&lt;incode-phone&gt;<br/>&lt;incode-selfie&gt;<br/>&lt;incode-id&gt; ..."]
            Orch -- "ready / step state" --> WCs
        end
        subgraph P3["Path 3 — Headless"]
            Mgrs["createPhoneManager<br/>createSelfieManager<br/>createIdCaptureManager ..."]
            CustomUI["Your UI<br/><i>any framework</i>"]
            Mgrs -- "subscribe" --> CustomUI
        end
    end

    ApiKey -- "createSession()" --> Init
    Init --> P1
    Init --> P2
    Init --> P3
```

Three integration paths, same SDK underneath. Pick the one that matches how much UI control you need:

- **Path 1: `<incode-flow>` drop-in.** One web component, full SDK UI, \~5 lines of code. Best when standard branding works for you and you want fastest time-to-value.
- **Path 2: Orchestrator + module web components.** You own the shell (landing page, transitions, completion screen). Incode owns each module's screen. \~30 lines of code.
- **Path 3: Headless Managers.** You own everything — every screen, every transition. The SDK supplies state machines and business logic. \~50+ lines of code, maximum flexibility.

[**→ Walk through all three in Getting Started**](/sdk-reference/web-sdk-2-getting-started/)

## Three-package architecture

The SDK is split across three npm packages. Most integrations only need to depend on two of them:

```mermaid
flowchart LR
    Customer["Your app"]
    Web["@incodetech/web<br/><i>L2 — UI components, CSS</i>"]
    Core["@incodetech/core<br/><i>L1 — managers, state machines, types</i>"]
    Infra["@incodetech/infra<br/><i>L0 — internal browser/WASM bridge</i>"]

    Customer --> Web
    Customer --> Core
    Web --> Core
    Core --> Infra

    style Infra fill:#fee2e2,stroke:#b91c1c,color:#7f1d1d
    style Core fill:#dcfce7,stroke:#15803d,color:#14532d
    style Web fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a
```

- `@incodetech/web`: UI components and CSS. Ships every consumer-facing element (`<incode-flow>`, `<incode-phone>`, `<incode-selfie>`, `<incode-id>`, …) as a standard Web Component plus the design-token CSS.
- `@incodetech/core`: framework-agnostic SDK core. Contains `setup()`, `createSession()`, all module managers, all the public TypeScript types.
- `@incodetech/infra`: internal layer. **Do not import from this package directly.** The SDK re-exports anything you need (e.g. `warmupWasm` lives at `@incodetech/core/wasm`).

## Framework integration

Every Incode UI module ships as a standard Web Component usable from vanilla HTML, React (with or without React 19's native custom-element support), Angular (`CUSTOM_ELEMENTS_SCHEMA`), and Vue 3 (`compilerOptions.isCustomElement`). The set-up is small but framework-specific.

[**→ Framework Integration**](/sdk-reference/web-sdk-2-framework-integration/) walks through each path with runnable examples, plus the React 18 vs 19 nuance (and the JSX augmentation TypeScript needs on React 18).

## What the SDK can do

- **Identity capture**: government IDs, passports, driver's licenses, generic document capture, OCR extraction, face match against ID photos.
- **Liveness & biometrics**: selfie capture in single-frame, multi-modal, and video-liveness modes (powered by Incode's Deepsight ML pipeline), face mask / lens / closed-eye / brightness validation.
- **Contact & consent**: phone OTP, email OTP, mandatory and optional consent capture, geolocation capture.
- **Compliance & risk**: antifraud signals, watchlists (sanctions, PEP), custom watchlists, business watchlists, government data validation, CURP validation (Mexico).
- **Signing**: handwritten signature, electronic signature, AE signature, QE signature.
- **Composite flows**: eKYC, eKYB, end-to-end orchestrated workflows configured from the Incode Dashboard, identity reuse, cross-document data matching.

[**→ Full module catalog**](/sdk-reference/web-sdk-2-individual-modules/)

## Browser support

For 2.3.0, the officially supported browsers are Chrome and Safari (Safari on Apple platforms). Native Android and iOS WebViews are also supported; third-party in-app browsers may restrict capture and are not supported.

The SDK's UI components check browser support before displaying a module. An unsupported browser, including Firefox or Edge, sees a full-screen browser-not-supported message. The user can choose **Continue anyway**; that choice is remembered for the session. Continuing does not make an unsupported browser a supported integration target.

### Hide the browser-not-supported screen

The `disableUnsupportedBrowserScreen` setting of your flow or workflow turns this screen off.

- `<incode-flow>` and `<incode-workflow>` always use the setting from the server. They do the browser check after the flow or workflow config loads, so a disabled screen never shows. The host options below do not apply to them.
- Standalone modules (for example, `<incode-selfie>`) also use the setting of the session's flow. They read the flow only when the browser is unsupported. You can override the flow value with the options below.

For standalone modules, the first value that is set applies:

| Order | Source                  | Example                                                           |
| ----- | ----------------------- | ----------------------------------------------------------------- |
| 1     | Per-element `config`    | `element.config = { disableUnsupportedBrowserScreen: true }`      |
| 2     | Global UI config        | `setup({ uiConfig: { disableUnsupportedBrowserScreen: true } })`  |
| 3     | The session's flow      | The `disableUnsupportedBrowserScreen` setting of the flow         |
| 4     | Default                 | The screen shows                                                  |

`true` hides the screen. `false` shows the screen, even if the flow hides it. If you call `setup({ flow: false })`, or if the flow does not load, standalone modules show the screen unless you set one of the options.

The build targets ES2021 and requires browser features such as `getUserMedia`, `MediaRecorder`, `fetch`, and WebAssembly for the relevant modules. Having these features is a technical prerequisite, not a support guarantee. See [Troubleshooting → Mobile Safari](/sdk-reference/web-sdk-2-troubleshooting/#mobile-safari).

:::note
**HTTPS required** for camera access in production. `localhost` is exempt during development.
:::

## Need help?

- [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/): common issues and solutions
- [API Reference](/sdk-reference/web-sdk-2-reference/): complete API surface
- [support@incode.com](mailto:support@incode.com): direct support

## All pages in this section

**Getting Started**

- [Getting Started](/sdk-reference/web-sdk-2-getting-started/)
- [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/)

**Components**

- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/)
- [Module Patterns](/sdk-reference/web-sdk-2-module-patterns/)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

_Identity capture modules_

- [Selfie](/sdk-reference/web-sdk-2-module-selfie-1/)
- [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/)
- [ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/)
- [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/)
- [Face Match](/sdk-reference/web-sdk-2-module-face-match/)

_Contact verification modules_

- [Phone](/sdk-reference/web-sdk-2-module-phone/)
- [Email](/sdk-reference/web-sdk-2-module-email/)

_Compliance & consent modules_

- [Consent](/sdk-reference/web-sdk-2-module-consent/)
- [Geolocation](/sdk-reference/web-sdk-2-module-geolocation/)
- [Antifraud](/sdk-reference/web-sdk-2-module-antifraud/)
- [Watchlist](/sdk-reference/web-sdk-2-module-watchlist/)
- [Custom Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/)
- [Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/)
- [Government Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/)
- [CURP Validation](/sdk-reference/web-sdk-2-module-curp-validation/)

_Authentication & identity reuse modules_

- [Authentication](/sdk-reference/web-sdk-2-module-authentication/)
- [Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/)

_Signing modules_

- [Signature](/sdk-reference/web-sdk-2-module-signature/)
- [Electronic Signature (AE / QE)](/sdk-reference/web-sdk-2-module-electronic-signature/)

_Composite & orchestration modules_

- [Workflow](/sdk-reference/web-sdk-2-module-workflow/)
- [eKYC](/sdk-reference/web-sdk-2-module-ekyc/)
- [eKYB](/sdk-reference/web-sdk-2-module-ekyb/)
- [Cross-Document Data Match](/sdk-reference/web-sdk-2-module-cross-doc-match/)
- [Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/)

_Utility modules_

- [Home Screen](/sdk-reference/web-sdk-2-module-home/)
- [Redirect to Mobile](/sdk-reference/web-sdk-2-module-redirect-to-mobile/)

**Use Cases**

- [Use Cases](/sdk-reference/web-sdk-2-use-cases/)
- [Digital ID: Bank Redirect](/sdk-reference/digital-id-redirect/)
- [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/)

**Customization**

- [Theming & Styling](/sdk-reference/web-sdk-2-theming/)
- [Internationalization](/sdk-reference/web-sdk-2-i18n/)
- [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/)

**Advanced**

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/)
- [Dashboard Events](/sdk-reference/web-sdk-2-events/)
- [Web Components](/sdk-reference/web-sdk-2-web-components/)
- [Session Management](/sdk-reference/web-sdk-2-session-api/)
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/)
- [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/)
- [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture)
- [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/)

**Reference**

- [API Reference](/sdk-reference/web-sdk-2-reference/)
- [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/)
- [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/)
- [Release Notes](/release-notes/web-sdk-20-release-notes/)

---

- Path: `sdk-reference/ios-api-key-rotation`
- URL: https://developer.incode.com/sdk-reference/ios-api-key-rotation/
- Markdown: https://developer.incode.com/sdk-reference/ios-api-key-rotation.md

# API Key Rotation

API keys used to initialize the iOS SDK can be rotated at any time for security reasons. This page shows how to detect a revoked key during an onboarding session, reinitialize the SDK with the replacement key, and resume onboarding so the user can continue.

You can revoke keys and generate new ones from [Dashboard](/dashboard-platform-administration/configuration-api-keys-tab/). The SDK does not rotate keys itself; it reacts to a key being revoked.

- The **API key** authenticates the SDK during `initIncdOnboarding`.
- A **session token** authenticates a single verification session. Your backend creates the session with Incode and passes the token to the app, which supplies it through `IncdOnboardingSessionConfiguration(token:)`. Alternatively, a `configurationId` can be used.

***

## Rotate Keys

When an API key is revoked from Dashboard, every onboarding session using that key is aborted. The SDK reports the revocation through the `onError(_ error: IncdFlowError)` method on your `IncdOnboardingDelegate`. That callback is where you detect the revocation and replace the key.

The rotation flow has three steps, explained below. Complete them in order.

### Detect the Revoked Key

In your error handler, API key revocation surfaces as `IncdFlowError.error(IncdError.apiKeyRevoked(key:))`. The revoked key is delivered as the associated `key` value. There's no separate `IncdFlowError.apiKeyRevoked` case to match on directly; instead, match `IncdFlowError.error` and check whether the wrapped `IncdError` is `.apiKeyRevoked`.

```swift
func onError(_ error: IncdFlowError) {
    if case let .error(.apiKeyRevoked(key)) = error { // associated value is the revoked API key
        // Your logic for the rotation of the key
    }
}
```

### Reinitialize with the New Key

When you have a new API key, reinitialize the SDK by calling `initIncdOnboarding(...)` on `IncdOnboardingManager.shared`. Pass the new key as the `apiKey` argument in place of the original and apply any optional configuration exactly as you did on first initialization.

```swift
IncdOnboardingManager.shared.initIncdOnboarding(url: url, apiKey: newApiKey) { (success: Bool?, error: IncdInitError?) in
    // SDK has been reinitialized successfully when success == true
}
```

### Resume or Restart Onboarding

After the SDK reinitializes, you can resume the old session or start a completely new onboarding session.

***

For help, see [API Reference](/sdk-reference/ios-api-reference/) or contact Incode support.

<br />

---

- Path: `sdk-reference/ios-api-reference`
- URL: https://developer.incode.com/sdk-reference/ios-api-reference/
- Markdown: https://developer.incode.com/sdk-reference/ios-api-reference.md

# API Reference

This is the API reference for the Incode iOS SDK. It is the authoritative source for the `IncdOnboarding` public API: the `IncdOnboardingManager` singleton, its methods and parameters, the `IncdOnboardingDelegate` callbacks, and the result models returned to your app. All symbols below are taken directly from the SDK's public headers.

***

## Current API Reference

The public API is reached through `IncdOnboardingManager.shared` and the `IncdOnboardingDelegate` you assign to it. Use the sections below for exact method signatures, parameter types, and result-model names. For step-by-step setup see [Installation](/sdk-reference/setup-ios/); for the ways to define and start a flow see [Integration Approaches](/sdk-reference/ios-flow-configuration/); for per-step capture/verification options see [Modules](/sdk-reference/ios-individual-modules/). For anything not covered here or in the rest of this documentation, contact your customer success manager or Incode support.

### Initialization

Initialize the SDK once before starting any flow:

```swift
public func initIncdOnboarding(
    url: String? = nil,
    e2eeURL: String? = nil,
    apiKey: String? = nil,
    clientExperimentId: String? = nil,
    loggingEnabled: Bool = false,
    testMode: Bool = false,
    _ completion: ((Bool?, IncdInitError?) -> Void)? = nil
)
```

The completion closure reports success (`Bool?`) and an `IncdInitError?` on failure.

Console logs are disabled by default. Pass `true` for `loggingEnabled` to enable SDK logs.

`testMode: true` runs the SDK in development test mode on both simulators and physical devices, and prints a console warning while enabled. `IncdInitError.testModeEnabled` remains available for source compatibility but is no longer reported. See [Enable Test Mode](/sdk-reference/setup-ios/#enable-test-mode).



### Starting a Flow

Flows are started through the manager. There are several entry points, all documented with their full signatures and Swift examples in the [Integration Approaches](/sdk-reference/ios-flow-configuration/) section.

- `startOnboarding`: Start the default onboarding flow.
- `startFlow(url:delegate:isShortened:)`: Start a Flow from a URL.
- `startFlow(sessionConfig:delegate:moduleId:)`: Start (or resume, via `moduleId`) a server-driven Flow from an `IncdOnboardingSessionConfiguration`.
- `startWorkflow(sessionConfig:delegate:)` : Start a Workflow-based session.
- `startOnboardingSection(flowConfig:sectionTag:delegate:)`: Start a single tagged section of a flow.

All of these deliver their results and lifecycle events through the `IncdOnboardingDelegate`.

***

## Headless & Programmatic APIs (No Capture UI)

These methods run capture/verification steps programmatically and return their result through a completion closure, without the SDK presenting its own capture UI. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/) for when to use them.

```swift
func faceMatch(
    matchType: FaceMatchType?,
    idCategory: IDCategory...,
    interviewId: String?,
    completion: @escaping (_ result: FaceMatchResult) -> Void
)

func idProcess(
    idCategory: IDCategory,
    interviewId: String?,
    completion: @escaping (_ result: IdProcessResult) -> Void
)

func geolocation(
    interviewId: String?,
    completion: @escaping (_ result: GeolocationResult) -> Void
)

func getUserScore(
    userScoreFetchMode: UserScoreFetchMode?,
    interviewId: String?,
    completion: @escaping (_ result: UserScore) -> Void
)

func getUserOCRData(
    _ token: String?,
    completion: @escaping (_ result: OmniGetOCRDataResult) -> Void
)
```

| Method                                                     | Result Model           |
| ---------------------------------------------------------- | ---------------------- |
| `faceMatch(matchType:idCategory:interviewId:completion:)`  | `FaceMatchResult`      |
| `idProcess(idCategory:interviewId:completion:)`            | `IdProcessResult`      |
| `geolocation(interviewId:completion:)`                     | `GeolocationResult`    |
| `getUserScore(userScoreFetchMode:interviewId:completion:)` | `UserScore`            |
| `getUserOCRData(_:completion:)`                            | `OmniGetOCRDataResult` |

`faceMatch` accepts a variadic `idCategory` argument, so you may pass zero or more `IDCategory` values.

***

## Common Types

Several error types are shared across modules and referenced from their individual sections rather than redefined each time.

### IncdError

The generic error type used by modules that don't define their own module-specific error. Conforms to `Equatable`, and exposes:

- A computed `description: String`: The human-readable message.
- A `rawValue: String`: The case name without associated values.

```swift
public enum IncdError: Equatable {
    case notInitialized
    case resourcesNotFound
    case unknown
    case noActiveSession
    case integrityCompromised
    case apiKeyRevoked(key: String?)
    case sslPinningFailed
}
```

### IncdFlowError

The error delivered through `onError(_ error: IncdFlowError)` on `IncdOnboardingDelegate` for failures that abort the entire onboarding flow, independent of any single module's own result or error. Exposes a computed `description: String`.

```swift
public enum IncdFlowError {
    case initError(_ error: IncdInitError)
    case error(_ error: IncdError)
    case sessionCreationFailed(_ errDesc: String)
    case permissionsDenied
    case fakePermissionsDenied
    case declinedToSignDocument
    case captchaNotVerified(_ errDesc: String)
    case videoSelfieNotCompleted(_ err: VideoSelfieError)
    case sectionAlreadyRunning(_ activeSectionTag: String)
    case watchlistProcessFailed(_ errDesc: String)
    case interrupted
    case biometricConsentNotGiven
    case biometricConsentNotReceived
    case combinedConsentsNotReceived
    case flowNotFetched
    case audioPermissionsDenied
    case authenticationFailed(_ errDesc: String)
    case locationUnavailable
}
```

### ModuleConfigurationError

The error thrown during flow configuration when a flow's module ordering or composition is invalid, before onboarding starts. Each case carries a human-readable description string.

`ModuleConfigurationError` is declared **internal** in the SDK. These errors are raised while building the flow configuration, but the type is not part of the public API and cannot be caught by name in integrator code.

```swift
enum ModuleConfigurationError: Error {
    case invalidOrder(_ errDesc: String)
    case missingModule(_ errDesc: String)
    case notAvailable(_ errDesc: String)
}
```

***

## Module Reference

Fine-grained options are set on the flow configuration and on individual capture steps. The full flow-level surface is documented in the [Integration Approaches](/sdk-reference/ios-flow-configuration/) section and per-module options in [Modules](/sdk-reference/ios-individual-modules/). The types below are the ones referenced from other pages.

### AES (Advanced Electronic Signature)

Adds the AES module to an `IncdOnboardingFlowConfiguration`.

`showCertificateOnSuccess` was removed in iOS SDK 5.47.0. Configure the signed-document action with `AESConfiguration.downloadDocument`; when it's enabled, the success screen offers a **Download document** action. See the [Migration Guide](/release-notes/migration_guide/#migration-to-5470) for the call-site change.



```swift
public func addAes(configuration: AESConfiguration? = nil)
```

Configures optional document upload and download behavior for the AES module.

```swift
public struct AESConfiguration {
    public let uploadDocument: Bool?
    public let downloadDocument: Bool?
}
```

Reports the outcome of the AES module through the `IncdOnboardingDelegate` callback.

```swift
func onAESCompleted(result: AESResult)
```

The result payload delivered to `onAESCompleted(result:)` and the signing errors returned in `AESResult.error`.

```swift
public struct AESResult {
    public let success: Bool
    public let error: AESError?
}

public enum AESError: Error, Equatable {
    case noDocuments
    case failedToSign
}
```

### Approval

Adds the Approval module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addApproval(forceApproval: Bool? = nil)
```

Reports the outcome of the Approval module through the `IncdOnboardingDelegate` callback.

```swift
func onApproveCompleted(_ result: ApprovalResult)
```

The result payload delivered to `onApproveCompleted(_:)`.

```swift
public struct ApprovalResult {
    public var uuid: String?
    public var customerToken: String?
    public var success: Bool
    public var error: IncdError?
}
```

Approval has no module-specific error type; failures surface through `ApprovalResult.error` as an `IncdError`.

### Captcha

Adds the Captcha module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addCaptcha()
```

Reports the outcome of the Captcha module through the `IncdOnboardingDelegate` callback:

```swift
func onCaptchaCompleted(_ result: CaptchaResult)
```

The result payload delivered to `onCaptchaCompleted(_:)` and the errors returned in `CaptchaResult.error`.

```swift
public struct CaptchaResult {
    public var captcha: String?
    public var error: CaptchaError?
}

public enum CaptchaError {
    case error(_ error: IncdError)
    case wrongCaptchaEntered
    case captchaNotGenerated
}
```

### Combined Consent

Adds the Combined Consent module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addCombinedConsents(configuration: CombinedConsentsConfiguration)
```

Configures the preconfigured consent and language presented by the Combined Consent module.

`combinedConsents` and `language` are write-only. You set them through the `CombinedConsentsConfiguration` initializer shown above, but you won't be able to read them back from an existing `CombinedConsentsConfiguration` instance.

```swift
public struct CombinedConsentsConfiguration: Decodable {
    public init(combinedConsents: String, language: String? = nil)
}
```

Reports the outcome of the Combined Consent module through the `IncdOnboardingDelegate` callback.

```swift
func onCombinedConsentsGiven(_ result: CombinedConsentResult)
```

The result payload delivered to `onCombinedConsentsGiven(_:)`.

```swift
public struct CombinedConsentResult {
    public let success: Bool?
    public let error: IncdError?
}
```

### Custom Module

Reports when a Custom Module node is reached and lets your app report back a `CustomModuleStatus` once your custom logic completes.

Custom Module has no client-side builder. It only exists inside Dashboard-defined Workflows, configured through the Workflow node's `callbackName`. The SDK delivers that name to your app through the delegate.

```swift
func onCustomModuleStarted(callbackName: String, onCustomModuleCompleted: @escaping (CustomModuleStatus) -> Void)
func onCustomModuleCompleted(_ result: IncdError?)
```

There is no result payload object and no module-specific error type. You report the outcome of your custom logic by calling the `onCustomModuleCompleted` completion handler, passed into `onCustomModuleStarted(callbackName:onCustomModuleCompleted:)`, with a `CustomModuleStatus`. Separately, the SDK invokes the delegate method `onCustomModuleCompleted(_ result: IncdError?)` after submitting that status and advancing the Workflow, with `result` set to an `IncdError` if something went wrong.

```swift
public enum CustomModuleStatus: String {
    case ok = "OK"
    case fail = "FAIL"
    case warn = "WARN"
    case unknown = "UNKNOWN"
}
```

### Dynamic Forms

Adds the Dynamic Forms module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addDynamicForms(configuration: DynamicFormConfiguration)
```

Configures the screens and questions presented by the Dynamic Forms module.

`DynamicFormConfiguration`, `DynamicFormScreen`, and `DynamicFormQuestion` expose only their initializer parameters below. The values aren't readable back from an existing instance.

```swift
public struct DynamicFormConfiguration: Decodable {
    public init(screens: [DynamicFormScreen]?)
}

public struct DynamicFormScreen: Decodable {
    public init(title: String, hideTitle: Bool, questions: [DynamicFormQuestion])
}

public struct DynamicFormQuestion: Decodable {
    public init(
        questionId: String,
        question: String,
        inputType: DynamicFormInputType,
        options: [String]? = nil,
        isOptional: Bool = false
    )
}

public enum DynamicFormInputType: String {
    case text = "TEXT"
    case date = "DATE"
    case number = "NUMBER"
    case country = "COUNTRY"
    case email = "EMAIL"
    case phone = "PHONE"
    case cpf = "CPF"
    case nationality = "NATIONALITY"
    case selection = "SELECT"
    case yesno = "YESNO"
}
```

Reports the outcome of the Dynamic Forms module through the `IncdOnboardingDelegate` callback.

```swift
func onDynamicFormCompleted(_ result: DynamicFormsResult)
```

The result payload delivered to `onDynamicFormCompleted(_:)`.

```swift
public struct DynamicFormsResult {
    public var answers: [DynamicFormQuestionnaireModel]
    public var error: IncdError?
}
```

Each entry in `answers` is a `DynamicFormQuestionnaireModel` and represents one answered question, carrying question metadata (`interviewId`, `questionId`, `question` text, `inputType`, `isOptional`) and answer data (`optionalAnswers`, `selectedAnswer`). These fields are internal to the SDK and aren't accessible from your app. They're included here for context on the model's structure, not as fields you interact with directly.

Dynamic Forms does not define a module-specific error type; failures surface through `DynamicFormsResult.error` as an `IncdError`.

### eKYB

Adds the eKYB module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addEKYB(configuration: ExternalVerificationEkybConfiguration)
```

Configures which business attributes the eKYB module verifies and where each value is sourced from.

Every parameter is optional and write-only, not readable back from an existing instance.

```swift
public struct ExternalVerificationEkybConfiguration: Decodable {
    public init(
        checkBusinessName: Bool? = nil,
        businessNameSource: String? = nil,
        checkAddress: Bool? = nil,
        address: String? = nil,
        checkTaxId: Bool? = nil,
        taxIdSource: String? = nil
    )
}
```

Reports the outcome of the eKYB module through the `IncdOnboardingDelegate` callback.

```swift
func onExternalValidationEkybCompleted(_ result: EkybResult)
```

The result payload delivered to `onExternalValidationEkybCompleted(_:)`.

```swift
public struct EkybResult {
    public let error: IncdError?
    public var externalVerification: [EkybVerificationStep]?
}

public struct EkybVerificationStep {
    public let stepName: String?
    public let status: String? //success, warning, or failure
    public let additionalInfo: String?
}
```

`EkybResult.error` is populated only when the module fails to produce a result at all; for example, a network or configuration failure. This is separate from individual check outcomes, which are reported via each `EkybVerificationStep.status` (see below).

### eKYC

Adds the eKYC module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addEKYC(configuration: ExternalVerificationConfiguration? = nil)
```

Configures which personal identity fields the eKYC module verifies and where each value is sourced from.

Every parameter is optional and write-only, not readable back from an existing instance.

```swift
public struct ExternalVerificationConfiguration: Decodable {
    public enum DataInputSource: String, Decodable {
        case userInput
        case document
        case poa
    }

    public init(
        checkName: Bool? = nil,
        nameSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkEmail: Bool? = nil,
        emailSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkAddress: Bool? = nil,
        addressSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkPhone: Bool? = nil,
        phoneSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkSsn: Bool? = nil,
        ssnSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkDob: Bool? = nil,
        dobSource: ExternalVerificationConfiguration.DataInputSource? = nil,
        checkNationality: Bool? = nil,
        nationalitySource: ExternalVerificationConfiguration.DataInputSource? = nil
    )
}
```

Reports the outcome of the eKYC module through the `IncdOnboardingDelegate` callback.

```swift
func onEKYCCompleted(_ result: EKYCResult)
```

The result payload delivered to `onEKYCCompleted(_:)`.

```swift
public struct EKYCResult {
    public var success: Bool
    public var error: IncdError?
}
```

eKYC does not define a module-specific error type; failures surface through `EKYCResult.error` as an `IncdError`.

### Face Authentication

Adds the Face Authentication module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addFaceAuthentication(configuration: FaceAuthenticationConfiguration)
```

Configures capture behavior and liveness checks for the Face Authentication module.

These are write-only. They are set at initialization, but not readable back from an existing instance. Any `Bool?` check left `nil` falls back to the corresponding manager-level `faceAuth*` default.

```swift
public struct FaceAuthenticationConfiguration {
    public init(
        deepsight: DeepsightConfiguration = .default,
        showTutorials: Bool? = nil,
        autoCaptureTimeout: Double? = nil,
        captureAttempts: Int? = nil,
        lensesCheck: Bool? = nil,
        faceMaskCheck: Bool? = nil,
        closedEyesCheck: Bool? = nil,
        headCoverCheck: Bool? = nil,
        imageQualitySeverity: ImageQualitySeverity = .defaultValue,
        occlusionCheck: OcclusionCheck = .disabled
    )
}
```

Reports the outcome of the Face Authentication module through the `IncdOnboardingDelegate` callback.

```swift
func onFaceAuthenticationCompleted(_ result: FaceAuthenticationResult)
```

The result payload delivered to `onFaceAuthenticationCompleted(_:)`.

```swift
public struct FaceAuthenticationResult {
    public var success: Bool?
    public var customerUUID: String?
    public var image: UIImage?
    public var selfieEncryptedBase64: String?
    public var selfieBase64: String?
    public var error: FaceAuthenticationError?
    public var videoRecordingError: FaceAuthenticationError?
}
```

The errors returned in `FaceAuthenticationResult.error` and `FaceAuthenticationResult.videoRecordingError`.

```swift
public enum FaceAuthenticationError: Equatable {
    case error(_ error: IncdError)
    case inactiveSession(String)
    case nonexistentCustomer(String)
    case lensesDetected(String)
    case faceMaskDetected(String)
    case headCoverDetected(String)
    case closedEyesDetected(String)
    case faceTooDark(String)
    case spoofAttemptDetected(String)
    case userIsNotRecognized(String)
    case selfieImageLowQuality(String)
    case hintNotProvided(String)
    case faceNotFound(String)
    case faceCroppingFailed(String)
    case faceTooSmall(String)
    case faceTooBlurry(String)
    case badPhotoQuality(String)
    case processingError(String)
    case badRequest(String)
    case deniedCameraPermissions
    case userCancelled
    case selfieFaceOccluded(String)
    case insufficientStorageForVideoRecording
    case videoRecordingFailed
    case unknown(String)
}
```

`insufficientStorageForVideoRecording` is non-fatal and only ever reported through `FaceAuthenticationResult.videoRecordingError`, never through `FaceAuthenticationResult.error`.

### Face Match

Adds the Face Match module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addFaceMatch(
    matchType: FaceMatchType? = nil,
    uiFlavor: UIFlavor? = nil,
    idCategory: IDCategory...,
    showUserExists: Bool? = nil,
    showLivenessStatus: Bool? = nil
)
```

Reports the outcome of the Face Match module through the `IncdOnboardingDelegate` callback.

```swift
func onFaceMatchCompleted(_ result: FaceMatchResult)
```

The result payload delivered to `onFaceMatchCompleted(_:)`.

```swift
public struct FaceMatchResult: Equatable {
    public var faceMatched: Bool?
    public var existingInterviewId: String?
    public var existingUser: Bool?
    public var confidence: Float?
    public var secondIdConfidence: Float?
    public var nfcSelfieConfidence: Float?
    public var nfcIdConfidence: Float?
    public var nameMatched: Bool?
    public var idCategories: Set<IDCategory>
    public var error: IncdError?
}
```

Face Match does not define a module-specific error type; failures surface through `FaceMatchResult.error` as an `IncdError`. It is also available [headlessly](/sdk-reference/module-face-match/#headless).

### Full Name

Adds the Full Name module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addFullName()
```

Full Name has no configurable options.

Reports the outcome of the Full Name module through the `IncdOnboardingDelegate` callback.

```swift
func onAddFullNameCompleted(_ result: UserNameInfoResult)
```

The result payload delivered to `onAddFullNameCompleted(_:)`.

```swift
public struct UserNameInfoResult {
    public var name: String?
    public var error: IncdError?
}
```

### Geolocation

Adds the Geolocation module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addGeolocation(isSkippable: Bool = false)
```

Reports the outcome of the Geolocation module through the `IncdOnboardingDelegate` callback.

```swift
func onGeolocationCompleted(_ result: GeolocationResult)
```

The result payload delivered to `onGeolocationCompleted(_:)` and the errors returned in `GeolocationResult.error`.

```swift
public struct GeolocationResult {
    public var addressFields: OCRDataAddress?
    public var coordinates: (latitude: Double, longitude: Double)?
    public var error: GeolocationError?
}

public enum GeolocationError {
    case error(_ error: IncdError)
    case permissionsDenied
    case noLocationExtracted
    case noNetworkError
    case locationUnavailable
}
```

Geolocation is also available [headlessly](/sdk-reference/module-geolocation/#headless) through `geolocation(interviewId:completion:)`.

### Government Validation

Adds the Government Validation module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addGovernmentValidation(isBackgroundExecuted: Bool = false)
```

Reports the outcome of the Government Validation module through the `IncdOnboardingDelegate` callback.

```swift
func onGovernmentValidationCompleted(_ result: GovernmentValidationResult)
```

The result payload delivered to `onGovernmentValidationCompleted(_:)`.

```swift
public struct GovernmentValidationResult {
    public var success: Bool
    public var error: IncdError?
}
```

Government Validation does not define a module-specific error type; failures surface through `GovernmentValidationResult.error` as an `IncdError`.

### ID Capture

`IDFrameAnalysisError` gains a new case:

```swift
case preparingCamera  // new
```

`preparingCamera` is reported through `IDCaptureFeedback.error` while the ID camera is getting ready, before the preview is shown. It is not an error: the capture continues normally once the camera is ready, and the SDK's own screens show the existing "Adjusting camera" copy for it, just like `settingUpStreaming`. If you `switch` exhaustively over `IDFrameAnalysisError`, add a handler for this case.

```swift
public struct IDCaptureFeedback {
    public let error: IDFrameAnalysisError
}
```

### ID OCR

Adds the ID OCR module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addOcr(isEditable: Bool, idRank: IDRank? = nil)
```

Specifies which captured ID the `addOcr` review screen applies to, when more than one ID has been captured.

```swift
public enum IDRank: String, Decodable {
    case firstID = "FIRST_ID"
    case secondID = "SECOND_ID"
}
```

Reports the outcome of the ID OCR module through the `IncdOnboardingDelegate` callback.

```swift
func onOcrCompleted()
```

`onOcrCompleted()` takes no parameters. The module also exposes a public result type.

```swift
public struct OcrResult {
    public var photo: UIImage?
    public var documentNumber: String?
    public var expiryDate: Date?
    public var dateOfBirth: Date?
    public var error: IncdError?
}
```

You can also fetch OCR data headlessly through `getUserOCRData(_:completion:)`.

### NFC

Adds the NFC module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addNfcScan(
    idType: IdType? = nil,
    showNFCSymbolConfirmationScreen: Bool? = nil,
    showInitialDataConfirmationScreen: Bool? = nil,
    showTutorials: Bool? = nil,
    nfcMaxRetries: Int? = nil,
    processNFCData: Bool? = nil,
    returnResultImmediately: Bool? = nil
)
```

Reports the outcome of the NFC module through the `IncdOnboardingDelegate` callback.

```swift
func onNFCScanCompleted(_ result: NFCScanResult)
```

The result payload delivered to `onNFCScanCompleted(_:)`.

```swift
public struct NFCScanResult {
    public var facePhoto: UIImage?
    public var dg1: NFCDataModel.DG1?
    public var error: NFCScanError?
}

public struct NFCDataModel {
    public struct DG1 {
        public let documentNumber: String?
        public let documentCode: String?
        public let nationality: String?
        public let issuingStateOrOrganization: String?
        public let birthDate: String?
        public let expireAt: String?
        public let gender: String?
        public let primaryIdentifier: String?
        public let secondaryIdentifier: String?
        public let optionalData1: String?
        public let optionalData2: String?
        public let personalNumber: String?
        public let compositeCheckDigit: String?
        public let dateOfBirthCheckDigit: String?
        public let documentNumberCheckDigit: String?
        public let expirationDateCheckDigit: String?
        public let personalNumberCheckDigit: String?
    }
}
```

The errors returned in `NFCScanResult.error`.

```swift
public enum NFCScanError {
    case error(_ error: IncdError)
    case notAvailable
    case userDocumentHasNoChip
    case noScanAttemptsRemaining
}
```

### QES (Qualified Electronic Signature)

Adds the QES module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addQes(configuration: QESConfiguration? = nil)
```

```swift
public struct QESConfiguration: Decodable {
    public let uploadDocument: Bool?
    public let downloadDocument: Bool?
    public let providerCode: String?
}
```

When `uploadDocument` is enabled, the user picks and uploads a PDF before the signing screen. `providerCode` selects the qualified signature provider for the session: for example, `QES_3` for Namirial. It is normally supplied by the Flow configuration in Dashboard.

```swift
func onQESCompleted(result: QESResult)

public struct QESResult {
    public let success: Bool
    public let error: QESError?
}

public enum QESError: Error, Equatable {
    case noDocuments
    case failedToSign
}
```

### QR Scan

Adds the QR Scan module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addQRScan(showTutorials: Bool? = nil)
```

Reports the outcome of the QR Scan module through the `IncdOnboardingDelegate` callback.

```swift
func onQRScanCompleted(_ result: QRScanResult)
```

The result payload delivered to `onQRScanCompleted(_:)`.

```swift
public struct QRScanResult {
    public var success: Bool?
    public var error: IncdError?
}
```

### Results

Adds the Results module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addUserScore(userScoreFetchMode: UserScoreFetchMode? = nil)
```

Selects how the Results module fetches the user's score.

```swift
public enum UserScoreFetchMode: Int, CaseIterable {
    case accurate = 0
    case fast = 1
}
```

Reports the outcome of the Results module through the `IncdOnboardingDelegate` callback.

```swift
func onUserScoreFetched(_ result: UserScore)
```

The result payload delivered to `onUserScoreFetched(_:)`.

```swift
public struct UserScore {
    public let idValidation: IDValidation?
    public let liveness: Liveness?
    public let faceRecognition: FaceRecognition?
    public let governmentValidation: GovernmentValidation?
    public let overall: Result?
    public let extendedUserScoreJsonData: Data?
    public var error: IncdError?
}
```

`Result` carries `value: String?` (for example, `"80.5/100"`) and `status: Status?`:

```swift
public enum Status: String {
    case ok = "OK"
    case warning = "WARN"
    case fail = "FAIL"
    case unknown = "UNKNOWN"
    case manual = "MANUAL"
}
```

The per-category structs expose their own `overall: Result?` plus category-specific detail: `IDValidation` (`photoSecurityAndQuality: [IDCheck]?`, `idSpecific: [IDCheck]?`), `Liveness` (`livenessScore: Result?`, `photoQuality: PhotoQuality?`), `FaceRecognition` (`croppedFace: String?`, `croppedIDFace: String?`, `existingUser: Bool?`), `GovernmentValidation` (`recognitionConfidence: Result?`, `validationStatus: IDCheck?`, `ocrValidation: [IDCheck]?`). Each `IDCheck` carries `key: String?`, `value: String?`, and `status: Status?`.

Errors surface through `UserScore.error` as an `IncdError`; see [Common Types](/sdk-reference/ios-api-reference/#common-types).

It is also available headlessly through `getUserScore(userScoreFetchMode:interviewId:completion:)`.

### Selfie

`SelfieScanResult` carries two independent error fields:

```swift
public var error: SelfieScanError?                // terminal capture failure
public var videoRecordingError: SelfieScanError?  // non-fatal
```

`SelfieScanError` includes `insufficientStorageForVideoRecording`, reported when Deepsight video recording is skipped because the device has less than 15 MB of free storage, and `videoRecordingFailed`, reported when the video could not be recorded or finalized. Both are non-fatal and only ever reported through `SelfieScanResult.videoRecordingError`, never through `SelfieScanResult.error`; the capture itself completes normally.

See [Selfie](/sdk-reference/module-selfie) for the full result payload and error list.

### Signature

Adds the Signature module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addSignature(descriptionMaxLines: Int? = nil, documents: [SignDocument] = [])
```

**Deprecated.** Use `addSignature(descriptionMaxLines:documents:)` above for new integrations. This overload remains available for existing code, but `title` and `description` should be set via `Localizable.strings` instead; see [Localize Display Text](/sdk-reference/ios-customization/#localize-display-text).

```swift
@available(*, deprecated, message: "Use addSignature(descriptionMaxLines:documents:) and set title/description via Localizable.strings instead.")
public func addSignature(title: String? = nil, description: String? = nil, descriptionMaxLines: Int? = nil, documents: [SignDocument] = [])
```

Configures document signing and (for the deprecated overload only) legacy title/description text for the Signature module.

```swift
public struct SignDocument {
    public let title: String
    public let fileURL: URL
    public let signaturePositions: [SignaturePosition]
}
```

Reports the outcome of the Signature module through the `IncdOnboardingDelegate` callback.

```swift
func onSignatureCollected(_ result: SignatureFormResult)
```

The result payload delivered to `onSignatureCollected(_:)`, and the errors returned in `SignatureFormResult.error`.

```swift
public struct SignatureFormResult {
    public var signature: UIImage?
    public var signedDocuments: [SignDocument]?
    public var error: SignatureError?
}

public enum SignatureError {
    case error(_ error: IncdError)
    case declinedToSignDocument
    case retryLimitReached
}
```

### User Consent

Adds the User Consent module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addUserConsent(title: String? = nil, content: String? = nil)
```

Reports the outcome of the User Consent module through the `IncdOnboardingDelegate` callback.

```swift
func onUserConsentGiven(_ result: UserConsentResult)
```

The result payload delivered to `onUserConsentGiven(_:)`.

```swift
public struct UserConsentResult {
    public var success: Bool?
    public var error: IncdError?
}
```

User Consent does not define a module-specific error type; failures surface through `UserConsentResult.error` as an `IncdError`.

### Video Conference

Adds the Video Conference module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addVideoConference(disableMicOnCallStarted: Bool? = nil)
```

Reports the outcome of the Video Conference module, along with queue and wait-time updates, through `IncdOnboardingVideoConferenceDelegate`.

```swift
public protocol IncdOnboardingVideoConferenceDelegate: AnyObject {
    func onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?)
    func onEstimatedWaitingTime(_ waitingTimeInSeconds: Int)
    func onQueuePositionChanged(_ newQueuePosition: Int)
    func onCaptchaCompleted(_ result: CaptchaResult)
}
```

The error returned in `onVideoConferenceCompleted(_:_:)`.

```swift
public enum VideoConferenceError {
    case error(_ error: IncdError)
}
```

Video Conference delivers no result payload; completion is reported through `onVideoConferenceCompleted(_:_:)` on the callback set above, which is also declared on `IncdOnboardingDelegate`.

### Video Selfie

Adds the Video Selfie module to an `IncdOnboardingFlowConfiguration`.

```swift
public func addVideoSelfie(videoSelfieConfiguration: VideoSelfieConfiguration)
```

Configures the guided actions, checks, and recording behavior for the Video Selfie module. Unlike other modules' configuration types, `VideoSelfieConfiguration` is built through its initializer and a mix of instance methods and settable properties, instead of only through initializer parameters.

`SelfieMode` and `VideoSelfieCodecType` are nested inside `VideoSelfieConfiguration`. Reference them as `VideoSelfieConfiguration.SelfieMode` and `VideoSelfieConfiguration.VideoSelfieCodecType`.

A deprecated `voiceConsent(enabled:questionsCount:randomQuestions:consent:faceRecognition:)` overload also exists; prefer the separate `voiceConsent(...)` and `randomQuestions(...)` methods instead.

```swift
public class VideoSelfieConfiguration {

    public enum SelfieMode: String, CaseIterable {
        case selfieMatch
        case faceMatch
    }

    public enum VideoSelfieCodecType: Int, CaseIterable {
        case hevc = 0
        case h264 = 1
    }

    public init(
        lensesCheck: Bool? = nil,
        faceMaskCheck: Bool? = nil,
        closedEyesCheck: Bool? = nil,
        headCoverCheck: Bool? = nil
    )

    public func selfieScan(
        enabled: Bool = true,
        performLivenessCheck: Bool = false,
        mode: SelfieMode = .selfieMatch,
        lensesCheck: Bool? = nil,
        faceMaskCheck: Bool? = nil,
        closedEyesCheck: Bool? = nil,
        headCoverCheck: Bool? = nil,
        performHeadMovementCheck: Bool = false
    )
    public func idScan(
        enabled: Bool,
        validateId: Bool? = nil,
        compareIdEnabled: Bool? = nil,
        compareOcrEnabled: Bool? = nil,
        compareBackIdEnabled: Bool? = nil,
        compareBackOcrEnabled: Bool? = nil
    )
    public func voiceConsent(enabled: Bool, consent: String? = nil, faceRecognition: Bool = false)
    public func randomQuestions(enabled: Bool, questionsCount: Int? = nil, questions: [String: String]? = nil)
    public func handGesture(enabled: Bool)
    public func tutorials(enabled: Bool)
    public func authorizationDialog(enabled: Bool, companyTitle: String)
    public func maxVideoLength(_ seconds: Int)
    public func showSelfieStepFirst(_ enabled: Bool)
    public func setLogo(_ logo: UIImage?)

    @available(*, deprecated, message: "Document scan step will be removed in a future version.")
    public func documentScan(enabled: Bool)

    public var cameraFacingConfig: CameraFacingConfiguration
    public var videoCodecType: VideoSelfieCodecType
    public var disableAudio: Bool
    public var minVideoLengthRequired: Bool
}
```

Reports the outcome of the Video Selfie module through the `IncdOnboardingDelegate` callback.

```swift
func onVideoSelfieCompleted(_ result: VideoSelfieResult)
```

The result payload delivered to `onVideoSelfieCompleted(_:)`.

```swift
public struct VideoSelfieResult {
    @available(*, deprecated, message: "Check if `error` is `nil` instead.")
    public var success: Bool { error == nil }

    public var selfie: UIImage?
    public var idFront: UIImage?
    public var idBack: UIImage?
    public var passport: UIImage?
    public var document: UIImage?
    public var voiceConsentSelfie: UIImage?
    public var audioData: Data?
    public var videoData: Data?
    public var error: VideoSelfieError?
}
```

The errors returned in `VideoSelfieResult.error`. Exposes a computed `rawValue: String`, the case name without associated values.

```swift
public enum VideoSelfieError {
    case error(_ error: IncdError)
    case internalError(String)
    case videoSelfieNotAuthorized
    case screenRecordingPermissionsDenied
    case recordingMicrophonePermissionsDenied
    case voiceConsentMicrophonePermissionsDenied
    case cameraPermissionsDenied
    case selfieNotMatched
    case idNotValid
    case idTypeNotMatched
    case idOCRNotValid
    case idFaceNotMatched
    case audioNotMatched
    case videoUploadError
    case spoofDetected
    case maxVideoLengthReached
}
```

<br />

---

- Path: `sdk-reference/ios-apple-wallet-id`
- URL: https://developer.incode.com/sdk-reference/ios-apple-wallet-id/
- Markdown: https://developer.incode.com/sdk-reference/ios-apple-wallet-id.md

# Apple Wallet ID

Apple Wallet verification lets a user share approved identity attributes from a supported credential in Apple Wallet instead of photographing a physical document. The Incode iOS SDK presents Apple's system authorization sheet, sends the encrypted Wallet response to Incode for validation, and then continues the onboarding flow.

Apple Wallet ID is available for:

- iOS 16.0 or later. Some credentials may require a newer iOS version.
- An Incode iOS SDK version that supports Apple Wallet identity verification.

:::warning

  Incode must enable and configure Apple Wallet for your account through Dashboard. Apple Wallet cannot currently be enabled or configured through a code-defined SDK flow.
:::

## How It Works

Apple Wallet appears as one option in the [ID Capture](/sdk-reference/module-id-scan/) module's document chooser. The integration is chooser-based:

1. Your app initializes the iOS SDK and starts a session.
2. The ID Capture module shows any configured physical-capture and file-upload choices immediately.

   At the same time, the SDK checks with PassKit whether Apple Wallet is available on the device. If it is, the chooser adds **Apple Wallet** as an option. If it isn't, the existing choices stay the same.
3. The user selects **Apple Wallet**.
4. The SDK requests a one-time challenge from Incode. The challenge lists the fields configured in Dashboard.
5. Apple shows the system authorization sheet. The user reviews the requested information and authorizes with Face ID or Touch ID.
6. PassKit returns an encrypted response. The SDK sends this response to Incode without inspecting it.
7. Incode decrypts and validates the response on the server. ID Capture completes, and onboarding continues.

The host app doesn't receive raw Wallet identity attributes through a client callback. Results stay part of the Incode session and its configured verification flow. The back end determines requested identity fields through the one-time challenge; the SDK doesn't choose them.


## Prerequisites

Before integrating Apple Wallet, confirm all of the following:

| Requirement       | Details                                                                                                                                                                                                                                                                                                                                                                                           |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Incode enablement | Incode has enabled Apple Wallet for the account and environment.                                                                                                                                                                                                                                                                                                                                  |
| SDK               | An Incode SDK version that supports Apple Wallet identity verification.                                                                                                                                                                                                                                                                                                                           |
| Device            | An eligible iPhone with a supported identity credential in Apple Wallet.                                                                                                                                                                                                                                                                                                                          |
| OS                | The SDK generally supports iOS 13.0 and newer, but Apple Wallet identity verification requires iOS 16.0 or newer. The [credential itself](#apple-credential-availability) may require a newer iOS version. The current implementation uses PassKit APIs available from iOS 16.0 and a driver's-license descriptor. The supported scope is a mobile driver's license (mDL) or equivalent state ID. |
| App ID            | Apple has granted Verify with Wallet access for the exact bundle ID.                                                                                                                                                                                                                                                                                                                              |
| Signing           | The installed build uses a provisioning profile containing both identity-presentment entitlements.                                                                                                                                                                                                                                                                                                |
| Merchant ID       | The app entitlement, SDK configuration, and Incode environment use the same merchant ID.                                                                                                                                                                                                                                                                                                          |
| Privacy           | `NSIdentityUsageDescription` is present in the host app's `Info.plist`.                                                                                                                                                                                                                                                                                                                           |
| Flow or Workflow  | The ID document chooser is enabled and Digital IDs with the Apple Wallet method are configured in Dashboard.                                                                                                                                                                                                                                                                                      |

### Apple Credential Availability

Apple controls the minimum device and OS for each credential, and these requirements can change. Verify them on Apple's [Verify with Wallet](https://developer.apple.com/wallet/get-started-with-verify-with-wallet/) page before planning a rollout.

| Credential                                   | Apple Minimum on iPhone                    | Incode iOS Scope    |
| -------------------------------------------- | ------------------------------------------ | ------------------- |
| Supported US driver's licenses and state IDs | iPhone 8 or later<br />iOS 16.5 and newer  | Supported mDL scope |
| California driver's license or state ID      | iPhone XS or later<br />iOS 17.5 and newer | Supported mDL scope |
| Puerto Rico driver's license or ID           | iPhone XS or later<br />iOS 18.1 and newer | Supported mDL scope |
| Japan My Number Card                         | iPhone XS or later<br />iOS 18.5 and newer | Coming Soon         |
| Digital ID created from a US passport        | iPhone 11 or later<br />iOS 26.1 and newer | Coming Soon         |
| Other national ID or PID credentials         | Varies by issuer and region                | Coming Soon         |

Passport-derived Digital ID and national ID support require additional PassKit descriptors and corresponding Incode back-end validation.


## Set Up Apple Wallet ID

Complete the following steps in order.

### Configure Incode

Apple Wallet configuration is server-driven. Ask Incode Support to configure the following for each environment:

- Enable Digital IDs and the **Apple Wallet** method for ID Capture.
- Enable the identity fields required by the use case.
- Configure the merchant ID and server-side identity certificate used to validate the encrypted response.
- Confirm that the merchant ID belongs to the same environment used by the SDK session.

| Configuration Source               | Apple Wallet Enablement                                                   | Requested Fields                                            |
| ---------------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------- |
| Dashboard-defined Flow or Workflow | **Enable Digital ID upload** setting and the **Apple Wallet** method in the ID Capture module | Returned with the one-time Wallet challenge after selection |
| Code-defined flow                  | Not supported in the initial version                                      | Not supported in the initial version                        |

The Flow or Workflow response supplies enablement but intentionally does not include [requested fields](#requested-fields). The one-time back-end challenge is the authoritative source for requested fields. The public `addIdScan()` [API](/sdk-reference/module-id-scan/#add-id-capture) doesn't expose Apple Wallet enablement or requested-field settings. This avoids a second client-side configuration that could conflict with the back-end challenge.

:::warning

  Do not copy a merchant ID from a sample or another environment. A mismatch between the app, provisioning profile, and Incode server configuration prevents the Wallet response from being validated.
:::

### Configure the Host App

#### Apple Developer Account

Follow Apple's [environment configuration](https://developer.apple.com/documentation/passkit/configuring-your-environment-for-the-verify-with-wallet-api) process.

1. Request access to Verify with Wallet for your exact bundle ID. Entitlement approval is granted per bundle ID.
2. Create or select the merchant ID coordinated with Incode.
3. Create the required Identity Access Certificate in coordination with Incode's server configuration.
4. Add **In App Identity Presentment** to the App ID.
5. Add **In App Identity Presentment Merchant IDs** and select the merchant ID.
6. Generate and install a new provisioning profile.

#### Entitlements

The app target must contain both identity-presentment entitlements. Include only document types and elements Apple approved for the app. This example shows a typical US mDL subset; replace the merchant placeholder with the value supplied for your environment.

```xml
<key>com.apple.developer.in-app-identity-presentment</key>
<dict>
    <key>document-types</key>
    <array>
        <string>us-drivers-license</string>
    </array>
    <key>elements</key>
    <array>
        <string>given-name</string>
        <string>family-name</string>
        <string>portrait</string>
        <string>address</string>
        <string>issuing-authority</string>
        <string>document-expiration-date</string>
        <string>document-number</string>
        <string>driving-privileges</string>
        <string>age</string>
        <string>date-of-birth</string>
        <string>document-issue-date</string>
    </array>
</dict>
<key>com.apple.developer.in-app-identity-presentment.merchant-identifiers</key>
<array>
    <string>merchant.your-company.identity</string>
</array>
```

The Apple Pay entitlement `com.apple.developer.in-app-payments` does **not** replace the identity-presentment merchant entitlement.

#### Privacy Usage Description

Add a user-facing explanation to the host app's `Info.plist`. Calling the Wallet identity API without this key causes iOS to terminate the app.

```xml
<key>NSIdentityUsageDescription</key>
<string>We use information from your ID in Apple Wallet to verify your identity.</string>
```

#### Merchant Configuration

Set the merchant ID on the shared manager before starting the onboarding session.

```swift
IncdOnboardingManager.shared.appleWalletMerchantID = "merchant.your-company.identity"
```

The value must exactly match an entry in `com.apple.developer.in-app-identity-presentment.merchant-identifiers` and the merchant configured by Incode for the active environment.

### Enable Apple Wallet in ID Capture

Configure Apple Wallet in Dashboard for the specific Flow or Workflow where it should be offered.

1. Open the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module in the Flow or Workflow.
2. Click Manage Digital IDs. In the dialog, find and enable **Apple Wallet**.
3. Click **View Details** on the Apple Wallet card. Select the identity fields required by the use case, then click **Done** to close the dialog.
4. Ensure the **Show document chooser screen** setting is enabled.
5. Turn on **Enable Digital ID upload**.
6. Click **Save configurations**.

The SDK does not expose a corresponding code-defined setting. When the chooser opens, it performs a general driver's-license availability check. Physical-capture and file-upload choices remain usable while the check runs. Apple Wallet appears only when PassKit confirms that the device has a requestable mDL. The availability check does not pre-validate every Dashboard-configured field, because those fields arrive later with the one-time challenge.

### Test with Apple's Sample mDL

You can test the integration on a physical iPhone without adding a personal government-issued ID to Apple Wallet. Apple's sample mDL is intended for development testing only.

1. Complete the Apple Developer, entitlement, provisioning profile, merchant, privacy usage description, and Incode environment setup described above for your own app.
2. On the test iPhone, open Apple's [Wallet profiles and logs](https://developer.apple.com/feedback-assistant/profiles-and-logs/?name=wallet) page, sign in if prompted, and install the test mDL.
3. Install a development build signed with the provisioning profile for the approved App ID.
4. Start a Dashboard-defined Flow or Workflow whose ID Capture configuration is set up as defined in the section above.
5. Select **Apple Wallet**, approve the system authorization sheet, and confirm that the encrypted response is validated and the onboarding flow continues.

The sample mDL replaces only the identity credential used for testing. It does not bypass Apple's entitlement approval, the required provisioning profile, merchant and certificate alignment, Incode back-end configuration, or the need to test on a physical iPhone. Do not treat results from the sample credential as production identity verification.

## Requested Fields

Every requested field must satisfy three conditions:

1. The field is enabled in the ID Capture configuration.
2. The SDK maps it to an Apple `PKIdentityElement`.
3. The host app's Apple entitlement and provisioning profile authorize the corresponding element.

Dashboard exposes the following choices. Challenge values are shown for troubleshooting only; integrators do not pass them through a public SDK API.

| Dashboard Field    | Challenge Value        | `PKIdentityElement` Mapping | Availability                                     |
| ------------------ | ---------------------- | --------------------------- | ------------------------------------------------ |
| Given name         | `given_name`           | `.givenName`                | iOS 16.0 and newer                               |
| Family name        | `family_name`          | `.familyName`               | iOS 16.0 and newer                               |
| Date of birth      | `birth_date`           | `.dateOfBirth`              | iOS 16.0 and newer                               |
| License number     | `document_number`      | `.documentNumber`           | iOS 16.0 and newer                               |
| Expiry date        | `expiry_date`          | `.documentExpirationDate`   | iOS 16.0 and newer                               |
| Portrait photo     | `portrait`             | `.portrait`                 | iOS 16.0 and newer                               |
| Issue date         | `document_issue_date`  | `.documentIssueDate`        | iOS 16.0 and newer                               |
| Issuing country    | `issuing_country`      | `.issuingAuthority`         | iOS 16.0 and newer                               |
| Issuing authority  | `issuing_authority`    | `.issuingAuthority`         | iOS 16.0 and newer                               |
| Driving privileges | `driving_privileges`   | `.drivingPrivileges`        | iOS 16.0 and newer                               |
| Full address       | `resident_address`     | `.address`                  | iOS 16.0 and newer                               |
| City               | `resident_city`        | `.address`                  | iOS 16.0 and newer                               |
| State/Province     | `resident_state`       | `.address`                  | iOS 16.0 and newer                               |
| Postal code        | `resident_postal_code` | `.address`                  | iOS 16.0 and newer                               |
| Age 18+            | `age_over_18`          | `.age(atLeast: 18)`         | Final validation in progress; iOS 16.0 and newer |
| Age 21+            | `age_over_21`          | `.age(atLeast: 21)`         | Final validation in progress; iOS 16.0 and newer |
| Gender             | `sex`                  | `.sex`                      | iOS 17.2 and newer                               |
| Height             | `height`               | `.height`                   | iOS 26.0 and newer                               |
| Nationality        | `nationality`          | `.nationality`              | iOS 26.4 and newer                               |

Both issuing-country and issuing-authority requests map to PassKit's `.issuingAuthority` element, and all four resident-address choices map to PassKit's single `.address` element. Unknown, unsupported, or OS-unavailable fields are logged and skipped. If no supported elements remain, the SDK shows the generic Wallet retry screen after the user selects Apple Wallet.

The client uses Apple's privacy-preserving threshold elements for `age_over_18` and `age_over_21`, but their final end-to-end validation is still in progress. A threshold request can fall back to the age element when the issuer does not provide that threshold. Confirm the resulting data and retention behavior for your environment before relying on a threshold-only use case. The SDK marks requested elements with Apple's `mayStore` intent. Make sure the fields you request and the retention described in your privacy policy match your approved use case.


## Sequence Diagram

The Wallet challenge is fetched after the user selects Apple Wallet. The SDK drives the PassKit authorization sheet, and the returned encrypted response is validated server-side.

```mermaid
sequenceDiagram
    autonumber
    participant App as Client app
    participant SDK as Incode SDK
    participant BE as Incode back-end
    participant Wallet as Apple Wallet (PassKit)

    App->>SDK: Start Flow or Workflow
    Note over App,SDK: SDK initialization and onboarding start
    SDK->>Wallet: Check driver's-license availability
    Wallet-->>SDK: Available / not available
    SDK-->>App: Render document chooser
    Note over App,SDK: Apple Wallet appears only when PassKit confirms availability
    App->>SDK: User selects Apple Wallet
    SDK->>BE: Request one-time challenge
    BE-->>SDK: nonce, merchantId, requestedFields
    SDK->>Wallet: Present authorization sheet (requested elements)
    Wallet->>Wallet: User authorizes with Face ID / Touch ID
    Wallet-->>SDK: Encrypted identity response (opaque)
    SDK->>BE: Send encrypted response for validation
    BE-->>SDK: Return verification result
    SDK-->>App: Continue onboarding
```

On cancellation, the user returns to the chooser. On failure, the SDK shows its generic Wallet retry screen. On success, the encrypted response is validated and onboarding continues.

## Cancellation and Errors

The current integration does not expose a Wallet-specific public error callback. Errors remain inside the chooser experience so the user can retry or select document capture instead.

| Situation                                             | SDK Behavior                                                                                     | What To Check                                                                                                                                 |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| User cancels Apple's authorization sheet              | Returns to the document chooser without reporting an error                                       | No action required                                                                                                                            |
| Apple Wallet option is absent                         | Other choices stay visible during the check; Wallet is added only after PassKit confirms support | Incode enablement<br />Dashboard document-chooser setting<br />iOS 16.0 or newer<br />Signed entitlements<br />A compatible mDL on the device |
| Availability changes after the chooser is shown       | PassKit can reject the request, and the SDK shows its generic retry screen                       | Device and credential eligibility<br />Whether another identity request is active                                                             |
| App terminates with an entitlement error              | iOS rejects the PassKit call                                                                     | Bundle ID approval<br />Signed entitlements<br />Regenerated provisioning profile                                                             |
| App terminates with a privacy usage-description error | iOS rejects the PassKit call                                                                     | Add `NSIdentityUsageDescription` to the host app                                                                                              |
| `appleWalletMerchantID` is missing                    | The SDK shows its generic Wallet retry screen                                                    | Set `IncdOnboardingManager.shared.appleWalletMerchantID` before starting onboarding                                                           |
| Merchant or challenge validation fails                | The SDK shows its generic Wallet retry screen                                                    | Confirm the merchant ID matches the entitlement and the Incode environment<br />Confirm network access                                        |
| A requested field is logged as unsupported            | The SDK skips that field and continues                                                           | Verify Dashboard field, device OS, and SDK build against the field table                                                                      |
| Every requested field is unsupported                  | The SDK shows the generic Wallet retry screen after challenge creation                           | Configure at least one supported, entitled field                                                                                              |
| Encrypted response validation or upload fails         | The SDK shows its generic Wallet retry screen                                                    | Confirm Incode environment enablement and merchant/certificate configuration with Support                                                     |

When contacting Support, include:

- SDK version
- App bundle ID
- iOS/device version
- Incode session identifier
- Approximate timestamp
- Whether the failure occurred before or after Apple's authorization sheet

Do not include raw identity data.

## External References

- [Get started with Verify with Wallet](https://developer.apple.com/wallet/get-started-with-verify-with-wallet/)
- [Configure your environment for the Verify with Wallet API](https://developer.apple.com/documentation/passkit/configuring-your-environment-for-the-verify-with-wallet-api)
- [PKIdentityAuthorizationController](https://developer.apple.com/documentation/passkit/pkidentityauthorizationcontroller)

---

- Path: `sdk-reference/ios-capture-only-integration`
- URL: https://developer.incode.com/sdk-reference/ios-capture-only-integration/
- Markdown: https://developer.incode.com/sdk-reference/ios-capture-only-integration.md

# Capture-Only End-to-End Integration

[Deepsight](/features-and-modules/deepsight/) is Incode's liveness technology. During capture, the device collects extra signals: depth data, a short selfie video, and motion data. The back end uses these signals to find spoofing attempts.

This page shows how to use Deepsight with Capture-Only Mode. In Capture-Only Mode, the iOS SDK captures the images and signals but does not send them to Incode; your integration sends them with the Omni API. Use this mode when your app needs to control when and how captures are sent to your own back end. This page gives the SDK configuration, the order of the API calls, and a sample request for each call, for two flows:

- **Basic flow**: An ID Capture module and a Selfie module. The user scans an ID and takes a selfie with Deepsight.
- **Video Selfie flow**: The basic flow plus a Video Selfie module. The user records a video that can hold a second ID scan, a selfie, and voice consent. The back end compares this recording with earlier captures.

You can also [run these flows without Deepsight](#flows-without-deepsight).

***

## Prerequisites

Before you start, ensure you have:

- The iOS SDK set to `.captureOnly`. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).
- iOS SDK 5.45.0 or later. Earlier versions do not have `DeepsightConfiguration` or the `motion` parameter of `addIdScan(...)`.
- A Dashboard flow (`configurationId`) with:
    - Deepsight turned on in its Settings tab.
    - The Deepsight settings of the Face Capture module configured to match the SDK `modality`.
    - Face Capture and ID Capture modules with Motion set to match the SDK `motion`.
- An [API key](/get-started-with-incode/getting-credentials/) for your environment.

:::warning
Set the Deepsight and Motion options in the SDK to the same values as the flow configuration in Dashboard. The two control different things: Dashboard tells the back end which signals to expect, and the SDK configuration decides which signals the device collects. If they differ, the back end rejects the call with `Invalid capture metadata`. The next section gives the two settings.
:::

The examples use `YOUR_API_URL` and `YOUR_API_KEY`, the same names as the [installation](/sdk-reference/setup-ios/) examples. Replace them with the API URL and the API key of your environment.

:::warning
Make these calls from your back end. The API key gives full access to your environment. Do not put the API key in the app, and do not call the Omni API from the device. The app sends the captures to your back end, and your back end makes the calls on this page.
:::

Every call to `YOUR_API_URL` after `omni/start` needs these headers. An upload to a pre-signed URL does not use them.

| Header | Value |
| --- | --- |
| `x-api-key` | `YOUR_API_KEY`, the API key of your environment. |
| `api-version` | `1.0` |
| `X-Incode-Hardware-Id` | The `token` value that `omni/start` returned. |
| `Content-Type` | `application/json` |

***

## SDK Configuration for Deepsight

Deepsight needs two changes in the SDK code, one for the [ID Capture](/sdk-reference/module-id-scan/) module and one for the [Selfie](/sdk-reference/module-selfie/) module.

### ID Capture

The `motion` parameter of `addIdScan(...)` is available in iOS SDK 5.45.0 and newer. It writes the motion flag into the capture metadata. The default value is `false`.

Set the same value as the Motion option of the ID Capture module in Dashboard. If the two differ, the back end rejects `omni/add/front-id/v2` with `Invalid capture metadata`.

```swift
let flowConfig = IncdOnboardingFlowConfiguration()
flowConfig.addIdScan(
    idType: .id,
    showIdTypeChooser: false,
    motion: true
)
```

### Selfie

The `addSelfieScan(deepsight:)` overload is available in iOS SDK 5.45.0 and newer. It replaces `addSelfieScan(requireDepthData:videoLivenessRecording:)`, which is deprecated. See the [Migration Guide](/release-notes/migration_guide/).

`DeepsightConfiguration` has three independent fields:

| Field | Default | Description |
| --- | --- | --- |
| `enabled` | `true` | Turns Deepsight on or off. When `false`, the capture behaves as a plain single frame and the SDK ignores the modality. |
| `modality` | `.singleFrameWithDepth` | The capture mode. It takes effect only when `enabled` is `true`. |
| `motion` | `false` | Turns motion collection on or off. This field is independent of the other two. |

The three modality values are:

| Modality | Depth Data | Video Recording |
| --- | --- | --- |
| `.singleFrame` | No | No |
| `.singleFrameWithDepth` | Yes | No |
| `.singleFrameWithDepthAndVideo` | Yes | Yes |

```swift
flowConfig.addSelfieScan(
    deepsight: DeepsightConfiguration(
        enabled: true,
        modality: .singleFrameWithDepthAndVideo,
        motion: true
    )
)
```

### Result Fields

Read these fields from the capture results and send them to the API:

| Callback | Result | Field | Send It To |
| --- | --- | --- | --- |
| `onIdFrontCompleted(_:)` | `IdScanResult` | `base64Image`, `metadata` | `omni/add/front-id/v2` |
| `onIdBackCompleted(_:)` | `IdScanResult` | `base64Image`, `metadata` | `omni/add/back-id/v2` |
| `onSelfieScanCompleted(_:)` | `SelfieScanResult` | `frameWithDepth`, `metadata` | `omni/add/face/third-party` |
| `onSelfieScanCompleted(_:)` | `SelfieScanResult` | `presignedVideoFileURL` | `omni/recordings/import` |
| `onVideoSelfieCompleted(_:)` | `VideoSelfieResult` | `videoData` | The URL from `omni/generateVideoSelfieUrl` |
| `onVideoSelfieCompleted(_:)` | `VideoSelfieResult` | `idFront` | `omni/videoselfie/compare-id/v2`, `omni/videoselfie/compare-ocr/v2` |
| `onVideoSelfieCompleted(_:)` | `VideoSelfieResult` | `idBack` | `omni/videoselfie/compare-back-id/v2`, `omni/videoselfie/compare-back-ocr/v2` |
| `onVideoSelfieCompleted(_:)` | `VideoSelfieResult` | `passport` | `omni/videoselfie/compare-id/v2`, `omni/videoselfie/compare-ocr/v2` |

`SelfieScanResult.frameWithDepth` holds the frame with depth data. A device with no TrueDepth camera gives `nil`. In that case, send `SelfieScanResult.selfieBase64`, which the same callback returns and which holds the frame without depth data.

`SelfieScanResult.presignedVideoFileURL` is set in `.captureOnly` only, and only when the modality is `.singleFrameWithDepthAndVideo`.

`VideoSelfieResult` gives each image as a `UIImage` and each recording as `Data`. Encode each image as base64 before you send it.

***

## Basic Flow

Use this flow for Deepsight with an ID Capture module and a Selfie module.

Call the endpoints in this order. A tag shows which capture module a step belongs to. Make a tagged step only when that module is in the flow. A step with no tag always applies.

1. `POST /omni/start`
2. `POST /omni/add/device-fingerprint`
3. **ID Capture, front side**: `POST /omni/add/front-id/v2?onlyFront=false`
:::warning
The `onlyFront` query parameter tells the back end whether a back image follows.

  - To scan both sides, use `addIdScan(scanStep: .both)`, send `onlyFront=false`, and make step 4.
  - To scan the front only, use `addIdScan(scanStep: .front)`, send `onlyFront=true`, and omit step 4.

  `.both` is the default.
:::
4. **ID Capture, back side**: `POST /omni/add/back-id/v2`
5. **ID Capture**: `POST /omni/process/id`
6. **Selfie with Deepsight video**: `POST /omni/recordings/import`
7. **Selfie**: `POST /omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID`
8. **Selfie**: `POST /omni/process/face?imageType=selfie`
9. `POST /omni/finish-status`

:::info
Send the device fingerprint with `omni/add/device-fingerprint` directly after `omni/start`, before any capture. The SDK does the same in `.standard` mode: it sends the device fingerprint as part of the session setup, before the first module starts. Send it once for each session.
:::

### Which Steps Apply

Each tagged step needs its module in the flow and its data in the result.

| Steps | Make Them When | Flow Configuration | Result Field |
| --- | --- | --- | --- |
| 3 | The flow scans the front of a document | `addIdScan(...)` | `IdScanResult.base64Image` from `onIdFrontCompleted(_:)` |
| 4 | The flow scans the back of a document | `addIdScan(scanStep: .both)`, the default | `IdScanResult.base64Image` from `onIdBackCompleted(_:)` |
| 5 | The flow scans a document | `addIdScan(...)` | None; this call carries no image |
| 6 | The selfie records a video for Deepsight | `addSelfieScan(deepsight:)` with `.singleFrameWithDepthAndVideo` | `SelfieScanResult.presignedVideoFileURL` |
| 7, 8 | The flow takes a selfie | `addSelfieScan(...)` | `SelfieScanResult.frameWithDepth` |

:::warning
A `nil` field is not always a skipped step. Your configuration decides which calls to make. The result field tells you what to send.

If you did not enable a step, its field is `nil` and you omit its calls. That is the normal case.

If you did enable a step and its field is `nil`, the capture did not complete. Do not treat this as a skipped step. Record the fault and examine it. The session continues without that check, and no error tells you so.

The SDK gives you the reason for Deepsight video. When `presignedVideoFileURL` is `nil` but the face capture completed, read `SelfieScanResult.videoRecordingError`. It reports `insufficientStorageForVideoRecording` or `videoRecordingFailed`.
:::

### Step 1: Start the Session

`omni/start` creates the interview. The response gives the `token` value for the `X-Incode-Hardware-Id` header of every later call.

```bash
curl --location 'YOUR_API_URL/omni/start' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
    "configurationId": "YOUR_FLOW_ID"
}'
```

### Step 2: Add the Device Fingerprint

Read the fingerprint from the SDK with `IncdOnboardingManager.shared.getDeviceFingerprint()`. `DeviceFingerprint` is `Encodable`. Encode it as JSON and send it without changes.

```swift
let fingerprint = IncdOnboardingManager.shared.getDeviceFingerprint()
let fingerprintJson = String(data: try JSONEncoder().encode(fingerprint), encoding: .utf8)
```

```bash
curl --location 'YOUR_API_URL/omni/add/device-fingerprint' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data "$FINGERPRINT_JSON"
```

The body has this shape. The values change with the device and the SDK version, so do not copy them.

```json
{
    "sdkVersion": "5.45.0",
    "hash": "1234-1234-1234",
    "ip": "10.11.11.11",
    "osVersion": "18.1.1",
    "deviceModel": "iPhone16,2",
    "data": "{\"crossApp\":true}",
    "deviceType": "IOS",
    "algorithmName": "identifierForVendor",
    "algorithmVersion": "1.0.0"
}
```

### Step 3: Add the Front of the ID

Send `base64Image` and `metadata` from the `IdScanResult` that `onIdFrontCompleted(_:)` returns.

```bash
curl --location 'YOUR_API_URL/omni/add/front-id/v2?onlyFront=false' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.base64Image",
    "metadata": "result.metadata"
}'
```

### Step 4: Add the Back of the ID

Send `base64Image` and `metadata` from the `IdScanResult` that `onIdBackCompleted(_:)` returns.

```bash
curl --location 'YOUR_API_URL/omni/add/back-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.base64Image",
    "metadata": "result.metadata"
}'
```

### Step 5: Process the ID

```bash
curl --location 'YOUR_API_URL/omni/process/id' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

### Step 6: Send the Deepsight Video

`SelfieScanResult.presignedVideoFileURL` is a file URL, not the video itself. Read that file as plain text. Then send the text in the `video` field without a change. The contents are already base64. Do not encode them again.

If `presignedVideoFileURL` is `nil`, there is no recording to send. Omit this step, and send the selfie without a `recordingId`.

```bash
curl --location 'YOUR_API_URL/omni/recordings/import' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "type": "selfie",
    "video": "CONTENTS_OF_PRESIGNED_VIDEO_FILE"
}'
```

The response gives a `recordingId`. Keep this value for the next call.

### Step 7: Send the Selfie Image

Send `frameWithDepth` and `metadata` from the `SelfieScanResult` that `onSelfieScanCompleted(_:)` returns. Add the `recordingId` from the previous step as a query parameter.

```bash
curl --location 'YOUR_API_URL/omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "result.frameWithDepth",
    "metadata": "result.metadata"
}'
```

### Step 8: Process the Selfie Image

This call runs the face checks on the selfie from step 7. The request body is empty.

```bash
curl --location 'YOUR_API_URL/omni/process/face?imageType=selfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

### Step 9: Finish the Session

This call closes the session. Make it after all the capture and process calls. The request body is empty.

```bash
curl --location 'YOUR_API_URL/omni/finish-status' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

***

## Video Selfie Flow

Use this flow for Deepsight with an [ID Capture](/sdk-reference/module-id-scan/) module, a [Selfie](/sdk-reference/module-selfie/) module, and a [Video Selfie](/sdk-reference/module-video-selfie/) module.

Call the endpoints in this order. A tag shows which capture module a step belongs to. Make a tagged step only when that module is in the flow. A step with no tag always applies.

1. `POST /omni/start`
2. `POST /omni/add/device-fingerprint`
3. **ID Capture, front side**: `POST /omni/add/front-id/v2?onlyFront=false`
4. **ID Capture, back side**: `POST /omni/add/back-id/v2`
5. **ID Capture**: `POST /omni/process/id`
6. **Selfie with Deepsight video**: `POST /omni/recordings/import`
7. **Selfie**: `POST /omni/add/face/third-party?imageType=selfie&recordingId=RECORDING_ID`
8. **Selfie**: `POST /omni/process/face?imageType=selfie`
9. **Video Selfie, document front side**: `POST /omni/videoselfie/compare-id/v2`
10. **Video Selfie, document front side**: `POST /omni/videoselfie/compare-ocr/v2`
11. **Video Selfie, document back side**: `POST /omni/videoselfie/compare-back-id/v2`
12. **Video Selfie, document back side**: `POST /omni/videoselfie/compare-back-ocr/v2`
13. **Video Selfie, taking a selfie**: `POST /omni/add/face/third-party?imageType=videoSelfie`
14. **Video Selfie, taking a selfie**: `POST /omni/process/face?imageType=videoSelfie`
15. **Video Selfie, audio recording, speech check**: `POST /omni/add/speech/v2`
16. **Video Selfie, consent, face check**: `POST /omni/videoselfie/voiceconsent/add/face`
17. `GET /omni/generateVideoSelfieUrl`
18. `PUT` the Video Selfie recording to the returned URL
19. `POST /omni/finish-status`

The questions and the consent phrase come from a call you make before the module starts. It is not part of this sequence. See [Get the Questions and the Consent Phrase](#get-the-questions-and-the-consent-phrase).

:::warning
Voice consent for the record needs no API call. Steps 15 and 16 ask the back end to check the consent. They are not what records it. The Video Selfie recording already holds the audio and the video of the user who speaks the phrase, and steps 17 and 18 send that recording.

  If you collect the consent as a record only, omit steps 15 and 16. Omit them even when `voiceConsent(enabled: true)` is set. Make step 15 to check the words the user said. Make step 16 to match the face of the user during the consent.
:::

Steps 1 through 8 are the same as the [Basic Flow](#basic-flow). Step 19 is step 9 in the Basic Flow.

### Which Steps Apply

Each tagged step needs its Video Selfie step to have run and put its data in the result. Steps 17 and 18 are not tagged because Video Selfie always records.

| Steps | Make Them When | Configuration | Default | Result Field |
| --- | --- | --- | --- | --- |
| 9, 10 | Video Selfie scans the front of the document | `idScan(enabled: true)` | on | `idFront` |
| 11, 12 | Video Selfie scans the back of the document | `idScan(enabled: true)` | on | `idBack` |
| 13, 14 | Video Selfie takes a selfie | `selfieScan(enabled: true)` | on | `selfie` |
| 15 | The recording has audio **and** you want the back end to check what the user said | `voiceConsent(enabled: true)` or `randomQuestions(enabled: true)` | off | `audioData` |
| 16 | The consent has a face frame **and** you want the back end to match that face | `voiceConsent(faceRecognition: true)` | off | `voiceConsentSelfie` |

:::info
Make the comparison calls, then send the recording last. This is the order the SDK uses in `.standard` mode: it compares the documents during the session, then sends the recording in a final upload step.
:::

### Get the Questions and the Consent Phrase

Make this call only if you want the back end to check the words the user said.

Make it before the Video Selfie module starts. It returns the question and answer pairs of your API key. Give that text to the SDK with `randomQuestions(...)` and `voiceConsent(...)`, so the user reads the same text that the back end scores in step 15. If the text on screen is not the same text, the check fails for a user who said the phrase correctly.

In `.captureOnly`, the SDK does not make this call. It shows only the text you give it. In `.standard` mode, the SDK makes the call itself at the start of the step and shows what it returns.

```bash
curl --location 'YOUR_API_URL/omni/get/questionAndAnswer?numberOfQuestions=1&returnVoiceConsentQuestion=true' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

The response gives a list of questions. The entry with `id` `0` is the consent phrase.

### Steps 9 through 12: Compare the Documents

The comparison calls use the ID frames that the Video Selfie module captured, not the frames from steps 3 and 4. `VideoSelfieResult` gives each frame as a `UIImage`. Encode it as base64 before you send it.

| Step | Endpoint | Image |
| --- | --- | --- |
| 9 | `omni/videoselfie/compare-id/v2` | `idFront` |
| 10 | `omni/videoselfie/compare-ocr/v2` | `idFront` |
| 11 | `omni/videoselfie/compare-back-id/v2` | `idBack` |
| 12 | `omni/videoselfie/compare-back-ocr/v2` | `idBack` |

Send each pair of calls only when the matching frame is in the result:

- If `idFront` is set, make steps 9 and 10.
- If `idBack` is set, make steps 11 and 12.
- If a field is `nil`, omit the two steps for that side. If the Video Selfie scanned that side, a `nil` value means the capture failed.

This is the same rule the SDK applies in `.standard` mode. There, the SDK gives the Video Selfie one scan step for each side of the document, then compares each side as it captures it.

:::info
A passport has one side. The Video Selfie module makes a single scan step for it and puts the frame in `VideoSelfieResult.passport`.

Send `passport` to the step 9 and step 10 endpoints, and omit steps 11 and 12. The back end treats a passport the same as the front of a document.
:::

### Step 9: Compare the ID

This call makes sure that the document in the Video Selfie matches the document from step 3.

```bash
curl --location 'YOUR_API_URL/omni/videoselfie/compare-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VIDEO_SELFIE_ID_FRONT_BASE64_IMAGE"
}'
```

Response (`200`):

```json
{
    "typeOfId": "DriversLicense",
    "idTypeMatched": true,
    "issueYear": 2017,
    "faceRecognitionConfidence": 1.0,
    "idSideMatched": true
}
```

Response (`400`):

```json
{
    "timestamp": 1775238442064,
    "status": 4020,
    "error": "Image to compare not found.",
    "message": "BadRequestException: Unable to compare images - template not found",
    "path": "/omni/videoselfie/compare-id/v2"
}
```

| Error Code | Description |
| --- | --- |
| `1003` | Face cropping failure. |
| `4019` | Face not found. |
| `4020` | Image to compare not found. |
| `5003` | Unsatisfied image size. |
| `5004` | Document alignment failed. |
| `5005` | Document not found. |

### Step 10: Compare the OCR Data

This call makes sure that the data on the document in the Video Selfie is the same as the data from step 3.

```bash
curl --location 'YOUR_API_URL/omni/videoselfie/compare-ocr/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VIDEO_SELFIE_ID_FRONT_BASE64_IMAGE"
}'
```

Response (`200`):

```json
{
    "success": true
}
```

A `400` response has the same shape as step 9. The error codes are `5003`, `5004`, and `5005`.

### Steps 11 and 12: Compare the Back of the Document

These two calls are the back-side counterparts of steps 9 and 10. Send the base64 of `VideoSelfieResult.idBack`.

```bash
curl --location 'YOUR_API_URL/omni/videoselfie/compare-back-id/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VIDEO_SELFIE_ID_BACK_BASE64_IMAGE"
}'
```

```bash
curl --location 'YOUR_API_URL/omni/videoselfie/compare-back-ocr/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VIDEO_SELFIE_ID_BACK_BASE64_IMAGE"
}'
```

The responses have the same shape as steps 9 and 10.

### Steps 13 and 14: Send the Video Selfie Image

These two calls are optional. Make them when `selfie` is set in the Video Selfie module.

Steps 13 and 14 use the same two endpoints as steps 7 and 8, but they send a different image. Step 7 sends the image from the Selfie module. Step 13 sends the image that the Video Selfie module captured during the video. The `imageType` query parameter tells the back end which image it receives.

| Steps | Module | Image | imageType |
| --- | --- | --- | --- |
| 7, 8 | Selfie | `SelfieScanResult.frameWithDepth` | `selfie` |
| 13, 14 | Video Selfie | `VideoSelfieResult.selfie` | `videoSelfie` |

```bash
curl --location 'YOUR_API_URL/omni/add/face/third-party?imageType=videoSelfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VIDEO_SELFIE_BASE64_IMAGE"
}'
```

Step 14 processes that frame. The response gives a `confidence` value. Keep it for step 16.

```bash
curl --location 'YOUR_API_URL/omni/process/face?imageType=videoSelfie' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{}'
```

Response (`200`):

```json
{
    "confidence": 1
}
```

### Step 15: Send the Voice Consent Audio

This call is optional. Make it to check the words the user said. It requires `audioData` to be set.

Omit it if you collect the consent as a record only. The recording in steps 17 and 18 holds the audio either way.

Before the module starts, get the questions and the consent phrase and give them to the SDK. See [Get the Questions and the Consent Phrase](#get-the-questions-and-the-consent-phrase).

Step 15 sends `VideoSelfieResult.audioData` as base64 in the `base64Media` field. Speech recognition runs inside this call. There is no process step after it.

```bash
curl --location 'YOUR_API_URL/omni/add/speech/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Media": "AUDIO_BASE64_DATA",
    "audioOnly": true
}'
```

:::warning
The Android SDK uses a different speech endpoint. The iOS SDK calls `omni/add/speech/v2` with a JSON body. The Android SDK calls `omni/add/speech?audioOnly=true` with the audio file as the request body. Use the iOS form on this page. If you write one back end for both platforms, make it accept the shape each platform sends.
:::

### Step 16: Send the Voice Consent Face

This call is optional. Make it to match the face of the user during the consent. It requires `voiceConsentSelfie` to be set.

Omit it if you do not want this second face check. The consent is still recorded.

Send `VideoSelfieResult.voiceConsentSelfie` as base64, with the `confidence` value from step 14. The `threshold` is the bar the score is measured against. The SDK sends the recognition threshold, which you set with `IncdOnboardingManager.shared.recognitionThreshold`. The default is `0.6`.

```bash
curl --location 'YOUR_API_URL/omni/videoselfie/voiceconsent/add/face' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "base64Image": "VOICE_CONSENT_SELFIE_BASE64_IMAGE",
    "confidence": 1,
    "threshold": 0.6
}'
```

### Step 17: Get the Upload URL

This call reserves a pre-signed Amazon S3 URL for the Video Selfie recording. Make it after the comparison and face calls, then send the recording to that URL in step 18.

```bash
curl --location 'YOUR_API_URL/omni/generateVideoSelfieUrl' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

The response gives the URL for the recording:

```json
{
    "url": "PRESIGNED_UPLOAD_URL"
}
```

### Step 18: Send the Recording

Send `VideoSelfieResult.videoData` to the `url` from step 17.

```bash
curl --location --request PUT 'PRESIGNED_UPLOAD_URL' \
--header 'Content-Type: video/mp4' \
--data-binary '@/path/to/videoSelfie.mp4'
```

To send the recording in parts instead of one request, read [Alternative: Upload the Video Selfie in Parts](#alternative-upload-the-video-selfie-in-parts).

***

## Alternative: Upload the Video Selfie in Parts

The Video Selfie flow sends the recording to a pre-signed S3 URL in one request. Three Omni endpoints send the same recording in parts instead.

Use this route in place of steps 17 and 18 of the [Video Selfie Flow](#video-selfie-flow). Use one route or the other, never both.

Select this route when one of these is true:

- Your security policy does not permit a direct upload to Amazon S3.
- The recording is large, and one request for the whole file is not reliable.

:::info
The SDK does not use this route. In `.standard` mode, the SDK always reserves one URL and sends the recording in a single request. The endpoints below are an API-only route for Capture-Only mode.
:::

### Start the Upload

The response gives an `uploadId`. Every later call needs this value.

```bash
curl --location --request POST 'YOUR_API_URL/omni/video-selfie/upload/initiate' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Send the Parts

The API gateway rejects a request larger than 10 MB. Divide the video into parts of about 7 MB. For example, `split -b 7000000 archive.mp4 chunk_` writes the files `chunk_aa`, `chunk_ab`, and `chunk_ac`. Do not send parts near the 10 MB limit. Each request carries more than the part itself, so parts of 9 MB can still fail. 7 MB is the tested value.

Send each part in its own call. Increase `partNumber` by 1 for each part.

```bash
curl --location 'YOUR_API_URL/omni/video-selfie/upload/part?uploadId=UPLOAD_ID&partNumber=1' \
--header 'Content-Type: application/octet-stream' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data-binary '@/path/to/chunk_aa'
```

Each response gives an `eTag`. Keep each `eTag` with its part number.

### Complete the Upload

This call tells the back end to put the parts together into one recording. Send the `uploadId` from the first call and the `partNumber` and `eTag` of each part.

```bash
curl --location 'YOUR_API_URL/omni/video-selfie/upload/complete' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "uploadId": "abc123",
    "parts": [
        { "partNumber": 1, "eTag": "bcae19" },
        { "partNumber": 2, "eTag": "d4f921" },
        { "partNumber": 3, "eTag": "a1b2c3" }
    ]
}'
```

Follow these rules for the upload in parts:

- Read the `uploadId` from the response of the first call. Do not write it into the code.
- Number the parts in sequence, from 1.
- Send the parts in the same order as the divided files.
- Put every part in the `parts` array. A missing part makes the assembly fail.

***

## Flows Without Deepsight

Every flow on this page uses Deepsight. To run the same flow without it, make these two changes:

1. In the SDK, set `enabled: false` and `motion: false` on `DeepsightConfiguration`, and set `motion: false` on `addIdScan(...)`. Set the same values in the Dashboard flow.
2. Omit Deepsight video. With `enabled: false`, the SDK records no video, so `presignedVideoFileURL` is `nil`. Omit `POST /omni/recordings/import` and omit the `recordingId` query parameter of `omni/add/face/third-party`.

Every other call stays, in the same order.

***

## Additional APIs

These calls are optional. They read data from a session that is complete.

### Get the Session Score

```bash
curl --location 'YOUR_API_URL/omni/get/score' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Get the OCR Data of the ID

```bash
curl --location 'YOUR_API_URL/omni/get/ocr-data/v2' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

### Get the Session Images

Base64 strings are large. Ask for the images that you need, in one call.

```bash
curl --location --request POST 'YOUR_API_URL/omni/get/images' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN' \
--data '{
    "images": [
        "fullFrameFrontID",
        "fullFrameBackID",
        "selfie",
        "signatureImageID",
        "ghostSignatureImageID",
        "ghostPortraitImageID"
    ]
}'
```

### Get the Deepsight Video

```bash
curl --location 'YOUR_API_URL/omni/generateSessionRecordingDownloadUrl?interviewId=INTERVIEW_ID&type=selfie' \
--header 'Accept: application/json' \
--header 'api-version: 1.0' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'X-Incode-Hardware-Id: SESSION_TOKEN'
```

***

## Clean Up Local Data

Call `IncdOnboardingManager.shared.deleteLocalUserData()` after the flow exits. Call it from the success, error, and cancellation paths. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

Send or copy every capture you need before you make this call. On the error and cancellation paths, the uploads can be incomplete, and the call removes the files permanently.

***

For help, see [API Reference](/sdk-reference/ios-api-reference/) or contact Incode support.

---

- Path: `sdk-reference/ios-capture-only-sdk`
- URL: https://developer.incode.com/sdk-reference/ios-capture-only-sdk/
- Markdown: https://developer.incode.com/sdk-reference/ios-capture-only-sdk.md

# Capture-Only Mode

Capture-Only mode presents Incode's capture UI and returns the captured media to your app without uploading that media to Incode for server-side processing. Use this mode when your app needs to control when and how captures are sent to your own back end.

The SDK still performs the local checks needed to guide capture, such as framing and image-quality checks. Server-side validation, OCR, face matching, and other processing do not run as part of the Capture-Only section.

:::info
Capture-Only mode is not available in the **Public** distribution variant. If you set `sdkMode` to `.captureOnly` in that variant, the SDK logs a warning and uses `.standard` mode instead.
:::

***

## Supported Modules

Capture-Only mode supports these capture modules:

| Module | Builder | Result callback |
| --- | --- | --- |
| [ID Capture](/sdk-reference/module-id-scan/) | `addIdScan(...)` | `onIdFrontCompleted(_:)` and `onIdBackCompleted(_:)` |
| [Selfie](/sdk-reference/module-selfie/) | `addSelfieScan(...)` | `onSelfieScanCompleted(_:)` |
| [Document Capture](/sdk-reference/module-document-scan/) | `addDocumentScan(...)` | `onDocumentScanCompleted(_:)` |
| [Video Selfie](/sdk-reference/module-video-selfie/) | `addVideoSelfie(videoSelfieConfiguration:)` | `onVideoSelfieCompleted(_:)` |

Do not add processing or non-capture modules to a Capture-Only flow. Note that:

- `addIdScan(scanStep: .both)` normally runs [Process ID](/sdk-reference/module-process-id/) automatically after ID Capture. In this mode, it does not; it adds ID Capture only.
- The [Process ID](/sdk-reference/module-process-id/) and [NFC](/sdk-reference/module-nfc-scan/) modules are not supported when `sdkMode` is `.captureOnly`.
- You can add the [Intro](/sdk-reference/module-intro/) module, but it shows a local screen only; it returns no capture result.
- Capture-Only mode does not support the [Full Name](/sdk-reference/module-full-name/), [Phone](/sdk-reference/module-phone/), [Email](/sdk-reference/module-email/), [Geolocation](/sdk-reference/module-geolocation/), or [Signature](/sdk-reference/module-signature/) modules.

Set `sdkMode` before creating an `IncdOnboardingFlowConfiguration`. Some builder behavior depends on the active SDK mode.

***

## How It Works

Use the Sections API to run one capture section at a time. A module-specific callback returns the capture result. After the section closes, `onOnboardingSectionCompleted(_:)` reports its tag and the next section can start.

```mermaid
sequenceDiagram
    autonumber
    participant App as Host App
    participant SDK as Incode SDK
    participant Server as Customer Server

    App->>SDK: Initialize and set sdkMode = .captureOnly
    App->>SDK: startOnboardingSection(...)
    SDK->>SDK: Local checks and capture
    SDK-->>App: Module result callback
    SDK-->>App: onOnboardingSectionCompleted(sectionTag)
    App->>Server: Send captured media and metadata
    Server-->>App: Accept or request another capture
    App->>SDK: Start the next section when needed
    App->>SDK: finishFlow(...)
    SDK-->>App: finishFlow completion
    Note over App,SDK: Diagnostics delivery is asynchronous and<br/>is not ordered with the completion
    SDK-->>App: onDiagnosticsDataReceived(data), when enabled and available
    App->>SDK: deleteLocalUserData()
```

Only one section can run at a time. Starting another section before the active one completes reports `IncdFlowError.sectionAlreadyRunning(activeSectionTag)` to the delegate supplied for the rejected request. The active section continues running.

`onOnboardingSectionCompleted(_:)` is the safe point to start another section. Do not start the next section from a module result callback.

***

## Set Up Capture-Only Mode

### 1. Initialize the SDK

Set the required presenting view controller, initialize the SDK, and then enable Capture-Only mode. The SDK manager is a singleton; the object that must remain available for presentation is your view controller because `presentingViewController` is a weak reference.

```swift
let manager = IncdOnboardingManager.shared
manager.presentingViewController = self

manager.initIncdOnboarding { success, _ in
    guard success == true else {
        // Handle IncdInitError.
        return
    }

    manager.sdkMode = .captureOnly
}
```

All `initIncdOnboarding(...)` configuration parameters are optional. Pass your normal `url`, `apiKey`, logging, or experiment settings when your integration requires them. Console logging is disabled by default; set `loggingEnabled: true` only when you need SDK console logs.

### 2. Build and Start a Capture Section

Create a separate `IncdOnboardingFlowConfiguration` for each section and pass your `IncdOnboardingDelegate` to `startOnboardingSection(flowConfig:sectionTag:delegate:)`.

#### ID Capture

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addIdScan(scanStep: .both)

IncdOnboardingManager.shared.startOnboardingSection(
    flowConfig: flow,
    sectionTag: "id-capture",
    delegate: self
)
```

For `.both`, the same section captures the front and then the back of an ID. It calls `onIdFrontCompleted(_:)`, then `onIdBackCompleted(_:)`, and finally calls `onOnboardingSectionCompleted("id-capture")`. A passport has no back capture.

Key `IdScanResult` capture fields are:

- `image: UIImage?`
- `base64Image: String?`
- `encryptedBase64Image: String?`
- `chosenIdType: IdType?`
- `idCategory: IDCategory`
- `metadata: String?`, populated for Capture-Only captures
- `error: IncdIdScanError?`

See [ID Capture](/sdk-reference/module-id-scan/) for all configuration options and result fields.

#### Selfie

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addSelfieScan()

IncdOnboardingManager.shared.startOnboardingSection(
    flowConfig: flow,
    sectionTag: "selfie",
    delegate: self
)
```

Key `SelfieScanResult` capture fields are:

- `image: UIImage?`
- `selfieBase64: String?`
- `selfieEncryptedBase64: String?`
- `metadata: String?`
- `frameWithDepth: String?`, when that capture option is enabled and supported
- `videoFileURL: URL?` and `presignedVideoFileURL: URL?`, when video capture is enabled
- `error: SelfieScanError?`

Read URL-backed results before deleting local user data. See [Selfie](/sdk-reference/module-selfie/) for all configuration options and result fields.

#### Document Capture

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addDocumentScan(
    documentType: .addressStatement,
    documentSources: [.camera, .photoUpload, .fileUpload]
)

IncdOnboardingManager.shared.startOnboardingSection(
    flowConfig: flow,
    sectionTag: "document-capture",
    delegate: self
)
```

Key `DocumentScanResult` capture fields are:

- `documentImage: UIImage?`
- `data: Data?`, containing image or PDF bytes when available
- `mimeType: String?`
- `documentType: DocumentType`
- `error: DocumentScanError?`

Server-generated OCR result fields are not produced by a Capture-Only section. See [Document Capture](/sdk-reference/module-document-scan/) for all configuration options and result fields.

#### Video Selfie

```swift
let configuration = VideoSelfieConfiguration()
configuration.tutorials(enabled: true)
configuration.selfieScan(enabled: true)
configuration.idScan(enabled: true, validateId: false)

let flow = IncdOnboardingFlowConfiguration()
flow.addVideoSelfie(videoSelfieConfiguration: configuration)

IncdOnboardingManager.shared.startOnboardingSection(
    flowConfig: flow,
    sectionTag: "video-selfie",
    delegate: self
)
```

`VideoSelfieResult` can contain:

- `selfie: UIImage?`
- `idFront: UIImage?`, `idBack: UIImage?`, and `passport: UIImage?`
- `document: UIImage?`
- `videoData: Data?` and `audioData: Data?`
- `voiceConsentSelfie: UIImage?`
- `error: VideoSelfieError?`

The SDK delivers `onVideoSelfieCompleted(_:)` when the result contains recorded video or audio. A fatal Video Selfie failure is also reported through `onError(_:)`. See [Video Selfie](/sdk-reference/module-video-selfie/) for all configuration options and result fields.

***

## Receive Results

Implement the callbacks for the modules you use. Copy or upload any result data your app needs before local cleanup.

```swift
extension MyCaptureViewController: IncdOnboardingDelegate {
    func onIdFrontCompleted(_ result: IdScanResult) {
        // Store or upload the front image and metadata.
    }

    func onIdBackCompleted(_ result: IdScanResult) {
        // Store or upload the back image and metadata.
    }

    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        // Store or upload the selfie, metadata, and optional video data.
    }

    func onDocumentScanCompleted(_ result: DocumentScanResult) {
        // Store or upload result.data and result.mimeType.
    }

    func onVideoSelfieCompleted(_ result: VideoSelfieResult) {
        // Store or upload the captured Video Selfie assets.
    }

    func onOnboardingSectionCompleted(_ flowTag: String) {
        // The section is closed. Start the next section when your app is ready.
    }

    func onSuccess() {
        // Successful Sections API cleanup is reported by finishFlow's completion.
    }

    func onError(_ error: IncdFlowError) {
        if case .sectionAlreadyRunning = error {
            // The original section is still active. Do not delete its local data.
            return
        }

        // Persist any capture data you need, then remove SDK-local user data.
        IncdOnboardingManager.shared.deleteLocalUserData()
    }

    func userCancelledSession() {
        IncdOnboardingManager.shared.deleteLocalUserData()
    }
}
```

### Forward Capture Metadata

When you submit ID or Selfie captures from your back end, include the corresponding `metadata` value from `IdScanResult` or `SelfieScanResult`. Forward it unchanged with the capture it describes. This metadata is part of the server-side capture-processing contract.

***

## Finish the Capture-Only Session

After the final section completes successfully and your app has retained the capture data it needs, call `finishFlow` once:

```swift
IncdOnboardingManager.shared.finishFlow { success, error in
    guard success else {
        // Handle IncdError.
        return
    }

    IncdOnboardingManager.shared.deleteLocalUserData()
}
```

In Capture-Only mode, `finishFlow` performs local flow cleanup and does not call the back end. For a successful Sections API integration, its completion is the success signal; it does not call `onSuccess()`.

### Forward Diagnostics Data

When diagnostics are enabled, the SDK returns a prepared diagnostics payload through `onDiagnosticsDataReceived(_:)` instead of uploading it. The callback can arrive asynchronously after `finishFlow` completes. Terminal SDK errors and user cancellation also finalize diagnostics automatically.

```swift
func onDiagnosticsDataReceived(_ data: Data) {
    // Forward the prepared payload without modifying it.
}
```

Use the diagnostics upload contract provided for your Incode server integration. If `sendDiagnosticsData` is `false`, the SDK does not produce this callback.

### Delete Local User Data

`deleteLocalUserData()` clears the current onboarding state and removes SDK-managed local capture files. Call it only after your app has copied or uploaded every capture it needs.

Use these terminal cleanup points:

- The `finishFlow` completion after a successful Capture-Only Sections flow.
- `onError(_:)` for a terminal flow error, excluding `.sectionAlreadyRunning`.
- `userCancelledSession()` after cancellation.

:::danger
Do not call `deleteLocalUserData()` while a section is active or before reading URL-backed capture results. Deleting local files is permanent.
:::

***

## Customization

Capture-Only mode uses the same theme, localization, tutorial, retake, and capture-quality options as the corresponding modules in other SDK modes. See [Customization](/sdk-reference/ios-customization/) and each supported [module page](/sdk-reference/ios-individual-modules/) for the available settings.

For related integration guidance, see [SDK Modes](/sdk-reference/ios-sdk-modes/), [Integration Approaches](/sdk-reference/ios-flow-configuration/), and [API Reference](/sdk-reference/ios-api-reference/).

---

- Path: `sdk-reference/ios-configure-flows-locally-and-run-step-by-step`
- URL: https://developer.incode.com/sdk-reference/ios-configure-flows-locally-and-run-step-by-step/
- Markdown: https://developer.incode.com/sdk-reference/ios-configure-flows-locally-and-run-step-by-step.md

# Configure Flows Locally and Run Step by Step

This iOS SDK integration pattern gives you full control over the onboarding experience. Instead of passing a single flow to the SDK and waiting for it to finish, you create an onboarding session, split the flow into sections, and run each section with `startOnboardingSection`. Control returns to your app between sections, so you can show your own screens, make decisions, or call your back end before continuing.

Use this pattern when you need to insert your own UI between capture steps, group modules into logical sections, or branch based on intermediate results. If you prefer to define the flow in Dashboard instead, see [Run Flows Configured in Dashboard](/sdk-reference/ios-run-flows-configured-in-dashboard/). If you want full control over the flow in client code, see [Configure Flows Locally and Run End to End](/sdk-reference/ios-configure-locally-end-to-end/). For more information about these patterns, see [Integration Approaches](/sdk-reference/ios-flow-configuration/).

This page covers session creation and section execution only. Ensure you have followed the steps to [install and initialize](/sdk-reference/setup-ios/) the Incode iOS SDK first.

***

## Set Up This Integration Pattern

Complete the following steps in order.

### Create a New Onboarding Session

Before running any section, create a session with `setupOnboardingSession`. The result is delivered through a completion closure; there is no session listener.

```swift
IncdOnboardingManager.shared.setupOnboardingSession(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>")
) { result in
    // result.token, result.interviewId, result.error
}
```

`OnboardingSessionResult` exposes `token`, `interviewId`, and `error`. You can optionally supply a list of `OnboardingValidationModule` values through `IncdOnboardingSessionConfiguration.validationModules` to determine which modules count toward the onboarding score. If omitted, the default modules `.id`, `.liveness`, and `.faceRecognition` are used.

### Create a Delegate to Receive SDK Results

Conform to `IncdOnboardingDelegate` to receive results from each module and the overall flow. Only `onSuccess()` and `onError(_:)` are required. Every other method has a default empty implementation. Override only the events for the modules your flow includes.

```swift
extension MyViewController: IncdOnboardingDelegate {
    func onOnboardingSessionCreated(_ result: OnboardingSessionResult) {
        // Session created: result.token, result.interviewId
    }

    func onIdProcessed(_ result: IdProcessResult) {
        // ID validation completed
    }

    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        // Selfie scan completed
    }

    func onFaceMatchCompleted(_ result: FaceMatchResult) {
        // Face match completed
    }

    func onOnboardingSectionCompleted(_ flowTag: String) {
        // Section finished — safe place to start the next section
    }

    func userCancelledSession() {
        // User cancelled the flow
    }

    func onSuccess() {
        // Onboarding finished successfully
    }

    func onError(_ error: IncdFlowError) {
        // Onboarding aborted due to an error
    }
}
```

For the shape and fields of each result object, see the corresponding page in [Modules](/sdk-reference/ios-individual-modules/).

### Run a Section

Build an `IncdOnboardingFlowConfiguration` for the section, add the modules it should run, and start it with `startOnboardingSection`. The section is tagged at call time with the `sectionTag` parameter instead of on the builder.

```swift
let section = IncdOnboardingFlowConfiguration()
section.addIntro(checks: [])
section.addPhone()
section.addIdScan(scanStep: .both)

IncdOnboardingManager.shared.startOnboardingSection(
    flowConfig: section,
    sectionTag: "id",
    delegate: self
)
```

Only one section can run at a time. Starting a second section while one is still running fails with `IncdFlowError.sectionAlreadyRunning`, which carries the tag of the section that is already active.

### Start Subsequent Sections from the Section-Complete Callback

`IncdOnboardingDelegate` reports the end of a section through `onOnboardingSectionCompleted(_ flowTag:)`. This is the documented signal that a section has finished, so start the next section from this callback rather than from an individual module callback such as `onIdFrontCompleted(_:)`.

```swift
func onOnboardingSectionCompleted(_ flowTag: String) {
    startNextSection()   // OK here
}

func startNextSection() {
    let next = IncdOnboardingFlowConfiguration()
    next.addSelfieScan()
    next.addFaceMatch(matchType: .idSelfie, idCategory: .primary)
    IncdOnboardingManager.shared.startOnboardingSection(
        flowConfig: next,
        sectionTag: "face",
        delegate: self
    )
}
```

### Finish the Flow and Delete Local Data

When you drive the flow section by section, call `finishFlow` after the last section to close the session on the server. Then call `deleteLocalUserData()` to remove all local user data. Both are instance methods on `IncdOnboardingManager.shared`.

```swift
IncdOnboardingManager.shared.finishFlow { success, error in
    IncdOnboardingManager.shared.deleteLocalUserData()
}
```

Deleting local user data is also recommended from the terminal delegate callbacks `onSuccess()`, `onError(_:)`, and `userCancelledSession()`.

### Resume an Existing Session

To resume a session—for example, after the app is relaunched mid-flow—create an `IncdOnboardingSessionConfiguration` with the existing `interviewId` or `token` and call `setupOnboardingSession` before any other API call.

```swift
let sessionConfig = IncdOnboardingSessionConfiguration(
    validationModules: [.id, .faceRecognition, .liveness],
    interviewId: "<EXISTING_INTERVIEW_ID>"
)

IncdOnboardingManager.shared.setupOnboardingSession(sessionConfig: sessionConfig) { result in
    // Safe to run sections again
}
```

<br />

---

- Path: `sdk-reference/ios-configure-locally-end-to-end`
- URL: https://developer.incode.com/sdk-reference/ios-configure-locally-end-to-end/
- Markdown: https://developer.incode.com/sdk-reference/ios-configure-locally-end-to-end.md

# Configure Flows Locally and Run End to End

This is the standard integration pattern for the Incode iOS SDK. It involves:

- Defining the onboarding flow locally in code with `IncdOnboardingFlowConfiguration`
- Implementing an `IncdOnboardingDelegate` to receive results
- Running the session with one call to `startOnboarding(sessionConfig:flowConfig:delegate:)`

The SDK presents the Incode UI for each module in turn.

Use this integration pattern when you want full control over the flow in client code. If you prefer to define the flow in Dashboard instead, see [Run Flows Configured in Dashboard](/sdk-reference/ios-run-flows-configured-in-dashboard/). If you need to insert your own screens or logic between SDK modules, see [Configure Flows Locally and Run Step by Step](/sdk-reference/ios-configure-flows-locally-and-run-step-by-step/). For more information about these patterns, see [Integration Approaches](/sdk-reference/ios-flow-configuration/).

This page covers building the flow, receiving results, and starting the session. Ensure you have followed the steps to [install and initialize](/sdk-reference/setup-ios/) the Incode iOS SDK first.


## Imports and Package Paths

The snippets below use short type names. The iOS SDK ships as a single module, so one import brings in the entry point, configuration, delegate, and result types:

```swift
import IncdOnboarding
```

The key types used on this page are:

- `IncdOnboardingManager`: The entry point. Access the shared instance with `IncdOnboardingManager.shared`.
- `IncdOnboardingFlowConfiguration`: Builds the flow with `addXxx(...)` calls. Most `addXxx(...)` methods add a single module, but a few differ: `addIdScan(scanStep: .both)`, for example, also appends the Process ID module, and some methods add nothing in certain SDK modes. For example, ID processing and user score are skipped in the Capture Only and Submit Only modes.
- `IncdOnboardingSessionConfiguration`: The session settings passed to every start call.
- `IncdOnboardingDelegate`: The protocol your object conforms to in order to receive results. Your class adopts this protocol directly.
- Result types (`IdScanResult`, `SelfieScanResult`, `FaceMatchResult`, …) are delivered to the delegate. Each is documented on its own page in [Modules](/sdk-reference/ios-individual-modules/).


## Set Up This Integration Pattern

The pattern uses five actions: initialize the SDK, set the presenting view controller, build an `IncdOnboardingFlowConfiguration`, implement an `IncdOnboardingDelegate`, and call `startOnboarding(sessionConfig:flowConfig:delegate:)`.

`startOnboarding(sessionConfig:flowConfig:delegate:)` takes a `sessionConfig` argument. The argument is required, but every field of `IncdOnboardingSessionConfiguration` is optional. Pass `IncdOnboardingSessionConfiguration()` if you don't need to customize the session. Session customization is covered in [Optional Configuration](#optional-configuration) below.

### Build a Flow Configuration

Build an `IncdOnboardingFlowConfiguration` and add the modules you want in the flow. Modules appear in the order you add them; omitted modules are not shown.

```swift
let flow = IncdOnboardingFlowConfiguration()      // or .init(waitForTutorials:)
flow.addIntro(checks: [])
flow.addPhone(otpVerification: true, defaultRegionPrefix: 1)
flow.addEmail(otpVerification: true)
flow.addIdScan(scanStep: .both)
flow.addSelfieScan()
flow.addFaceMatch(matchType: .idSelfie, idCategory: .primary)
flow.addApproval()

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)
```

Each module exposes its own configuration through the parameters of its `addXxx(...)` method. For example, `addIdScan(...)` accepts an `idType`, a `scanStep`, tutorial toggles, and more. Several builders take defaulted parameters; for example, `addApproval(forceApproval: Bool? = nil)` may be called with no arguments (`forceApproval` defaults to `nil`), as shown above. See [Modules](/sdk-reference/ios-individual-modules/) for the options, result type, and callbacks of each module.

:::warning

  Some modules have order dependencies. Some modules are required by others. For example, `addIntro(checks:)` is intended to be the first module added. Modules that consume data, such as Face Match, should come after the modules that collect data.

  The SDK defines these ordering and dependency rules per module but does not currently enforce them at session start: the `addXxx(...)` methods do not throw, and an invalid order or a missing module is not validated or rejected when the session begins. Add the modules in a valid order yourself; an invalid configuration is not caught for you.
:::

### Create a Delegate to Receive SDK Results

Conform to `IncdOnboardingDelegate` to receive results from each module and the overall flow. Only `onSuccess()` and `onError(_:)` are required. Every other method has a default empty implementation. Override only the events for the modules your flow includes.

```swift
final class VerificationCoordinator: IncdOnboardingDelegate {

    // MARK: Required

    func onSuccess() {
        // User successfully finished the whole onboarding flow.
    }

    func onError(_ error: IncdFlowError) {
        // Onboarding flow was aborted due to an error.
        print("Flow error: \(error.description)")
    }

    // MARK: Optional (each has a default empty implementation)

    func userCancelledSession() {
        // User backed out of the flow.
    }

    func onOnboardingSessionCreated(_ result: OnboardingSessionResult) {
        // Session created successfully.
    }

    func onAddPhoneNumberCompleted(_ result: PhoneNumberResult) {
        // Phone number step completed.
    }

    func onIdFrontCompleted(_ result: IdScanResult) {
        // Front of the ID captured.
    }

    func onIdBackCompleted(_ result: IdScanResult) {
        // Back of the ID captured.
    }

    func onIdProcessed(_ result: IdProcessResult) {
        // ID processing/validation completed.
    }

    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        // Selfie scan completed.
    }

    func onFaceMatchCompleted(_ result: FaceMatchResult) {
        // Face match completed.
    }

    func onApproveCompleted(_ result: ApprovalResult) {
        // Onboarding approval completed.
    }
}
```

The video-conference queue also reports progress through `onQueuePositionChanged(_:)` and `onEstimatedWaitingTime(_:)`. For the shape and fields of each result object, see the corresponding page in [Modules](/sdk-reference/ios-individual-modules/).

### Start the Onboarding Process

After building the flow configuration and your delegate, set the presenting view controller and call `startOnboarding(sessionConfig:flowConfig:delegate:)`. The `sessionConfig` argument is required; its contents are optional.

```swift
IncdOnboardingManager.shared.presentingViewController = self   // required for UI flows

let session = IncdOnboardingSessionConfiguration() // or a customized session (see below)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: session,
    flowConfig: flow,
    delegate: self
)
```


## Optional Configuration

These configuration points are optional. Use the session configuration to bind a Dashboard flow, resume a session, or set custom fields. Use the manager's UX properties to adjust presentation behavior.

### Session Configuration

Customize the onboarding session by constructing an `IncdOnboardingSessionConfiguration`, which configures the session for `startOnboardingSection`, `startFlow(sessionConfig:delegate:)`, and `startWorkflow(sessionConfig:delegate:)`, but not the URL-based `startFlow(url:delegate:isShortened:)`.

iOS uses a single initializer whose parameters are all optional. The table below highlights the most commonly used ones; see the full initializer signature at the end of this section.

If your backend creates the onboarding session and hands the app a token, see [Token-Based Setup](/sdk-reference/ios-token-based-setup/) for the complete integration, including initializing the SDK without an API key.

| Parameter            | Description                                                                                                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `configurationId`    | The flow ID from Dashboard, to apply the configuration set on that flow. You still add onboarding steps via `IncdOnboardingFlowConfiguration` to display the flow. |
| `validationModules`  | The list of `OnboardingValidationModule` values used for user scoring and approval. Defaults to `.id`, `.liveness`, `.faceRecognition`.                            |
| `customFields`       | A `[String: String]` of custom fields stored for this session.                                                                                                     |
| `interviewId`        | The ID of the onboarding session. Use it to resume an existing session.                                                                                            |
| `token`              | The JSON Web Token (JWT) of the onboarding session. Use it to resume an existing session, or to run the session entirely from a backend-issued token — see [Token-Based Setup](/sdk-reference/ios-token-based-setup/). |
| `externalId`         | An ID used outside of the Incode Platform. If the first session is interrupted and a session with the same `externalId` already exists, that session is resumed.   |
| `externalCustomerId` | Similar to `externalId`, but always creates a new session if interrupted, even if a session with the same `externalCustomerId` already exists.                     |
| `queue`              | The `ConferenceQueue` the user enters after the flow completes when using the Conference module. If none is specified, the user goes to the default queue.         |

Bind a Dashboard flow by its configuration ID:

```swift
let session = IncdOnboardingSessionConfiguration(configurationId: "xxxxxxxxxxxxxxxx")
```

Resume an existing session—for example, one started API to API—by its `interviewId`:

```swift
let session = IncdOnboardingSessionConfiguration(interviewId: "<INTERVIEW_ID>")
```

For reference, here is the complete `IncdOnboardingSessionConfiguration` initializer:

```swift
let session = IncdOnboardingSessionConfiguration(
    configurationId: nil,
	  validationModules: nil,
    customFields: ["partnerId": "abc123"],
    interviewId: nil,
    token: "<SESSION_TOKEN>",
    externalId: nil,
    externalCustomerId: nil,
  	queue: nil,
    downloadImagesEnabled: nil,
    e2eEncryptionEnabled: false,
    mergeSessionRecordings: nil,
    language: "en"
)
```

### Presentation and UX Configuration

On iOS, presentation and UX behaviors are set as properties on the shared `IncdOnboardingManager` rather than through a separate configuration object. Set them before starting the flow.

| Property                    | Default          | Description                                                                                                   |
| --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------- |
| `presentingViewController`  | `nil`            | The view controller the SDK presents its UI from. Required for UI flows.                                      |
| `dismissOnCompletion`       | `true`           | Whether the SDK dismisses its UI automatically when the flow finishes. Set to `false` to dismiss it yourself. |
| `modalTransitionStyle`      | `.coverVertical` | The `UIModalTransitionStyle` used when presenting the SDK UI.                                                 |
| `ageAssurance`              | `false`          | Enables the Age Assurance UX (privacy tutorials and customized capture screens).                              |
| `sendDiagnosticsData`       | `true`           | Whether the SDK sends diagnostics data.                                                                       |
| `externalAnalyticsEnabled`  | `true`           | Whether external analytics events are emitted.                                                                |
| `enableExternalScreenshots` | `false`          | Whether screenshots are allowed while the SDK UI is on screen.                                                |

```swift
let manager = IncdOnboardingManager.shared
manager.presentingViewController = self
manager.dismissOnCompletion = true
manager.modalTransitionStyle = .coverVertical
manager.ageAssurance = false
```

### Interrupt or Dismiss the Session

Use these to end a session before it reaches a terminal delegate callback, or to control the SDK's presented UI directly.

```swift
// Interrupt an in-progress flow (optionally try to finish it first)
IncdOnboardingManager.shared.forceInterrupt(tryFinishingFlow: true) { success, error in /* … */ }

// Dismiss the SDK UI
IncdOnboardingManager.shared.dismiss(forceInterrupt: false)
```

`allowUserToCancel` controls whether the SDK shows its own cancel button; `dismissOnCompletion` (see [Presentation and UX Configuration](#presentation-and-ux-configuration)) controls whether the SDK dismisses itself automatically when the flow ends.

---

- Path: `sdk-reference/ios-customization`
- URL: https://developer.incode.com/sdk-reference/ios-customization/
- Markdown: https://developer.incode.com/sdk-reference/ios-customization.md

# Customization

The Incode iOS SDK is highly customizable. You can match onboarding flows to your brand and product. This page covers what you can change, including:

- Theme colors and fonts
- Buttons, labels, and other UI elements
- A custom logo
- Runtime theme switching
- Localization, including dynamic and runtime language switching
- V2 theme and UX configuration


## Get Started

Most integrations only need colors, fonts, and a logo. Consult the other sections when you have a specific need.

On iOS, all theming is done in Swift at runtime. There is no build-time resource system (such as Android's `colors.xml` or `styles.xml`). Instead, you configure a small set of public types and assign them to `IncdTheme` (V1) or the V2 properties. The V1 (UIKit) screens read from `IncdTheme.current` (a `ThemeConfiguration`), while the newer V2 (SwiftUI) screens read from `IncdTheme.typography`, `IncdTheme.colorPalette`, `IncdTheme.displayMode`, and `IncdTheme.components`. A single JSON blob passed to `IncdTheme.loadJsonTheme(_:)` populates both systems. This page documents both.

| Task                                                      | Section                                                               |
| --------------------------------------------------------- | --------------------------------------------------------------------- |
| Recolor the SDK and apply your fonts                      | [Customize Theme Colors and Fonts](#customize-theme-colors-and-fonts) |
| Display your logo                                         | [Add a Custom Logo](#add-a-custom-logo)                               |
| Change button shape, size, color, and style               | [Customize Buttons](#customize-buttons)                               |
| Restyle labels, the selfie background, and other elements | [Customize Other UI Elements](#customize-other-ui-elements)           |
| Replace animations and icons, set automatic tinting, and define light vs. dark variants | [Customize Animations and Icons](#customize-animations-and-icons)           |
| Swap the theme at runtime based on user preference        | [Configure Runtime Styles](#configure-runtime-styles)                 |
| Change any on-screen text, particularly for translation   | [Localize Display Text](#localize-display-text)                       |
| Theme the V2 (SwiftUI) modules                            | [Configure V2 Theme and UX](#configure-v2-theme-and-ux)               |
| Apply theme and UX from one JSON                          | [Theme and UX Configuration from a single JSON](#theme-and-ux-configuration-from-a-single-json) |


## Customize Theme Colors and Fonts

The V1 (UIKit) screens read colors, fonts, buttons, and labels from `IncdTheme.current`, a `ThemeConfiguration`. To customize them, copy the current theme, change the properties you need, and assign it back before you start onboarding.

:::info

  Set the theme before you start a flow. Assigning `IncdTheme.current` (or any of the V2 properties) takes effect on screens presented afterward.
:::

### Colors

`ThemeConfiguration.colors` is a `ColorsConfiguration` with the following properties:

| Property              | Purpose                                                                     |
| --------------------- | --------------------------------------------------------------------------- |
| `primary`             | Primary color for all modules.                                              |
| `accent`              | Accent color for all modules.                                               |
| `background`          | Background color for all modules.                                           |
| `secondaryBackground` | Secondary background, used when a view sits on top of the background.       |
| `success`             | Success color.                                                              |
| `error`               | Error or destructive color.                                                 |
| `warning`             | Warning color.                                                              |
| `cancel`              | Color used for the cancel (X) button.                                       |
| `cancelDark`          | Cancel (X) button color on dark backgrounds, such as during a Video Selfie. |
| `disabled`            | Color for disabled controls.                                                |
| `primaryDark`         | Primary color for dark backgrounds.                                         |

```swift
import IncdOnboarding
import UIKit

var theme = IncdTheme.current
theme.colors.primary = UIColor(red: 0.12, green: 0.16, blue: 0.24, alpha: 1)
theme.colors.accent = UIColor(red: 0.0, green: 0.42, blue: 1.0, alpha: 1)
theme.colors.background = UIColor(red: 0.5, green: 0.5, blue: 0.5, alpha: 1.0)
theme.colors.success = UIColor(red: 0.05, green: 0.84, blue: 0.64, alpha: 1)
theme.colors.error = UIColor(red: 1.0, green: 0.36, blue: 0.44, alpha: 1)
theme.colors.warning = UIColor(red: 0.95, green: 0.67, blue: 0.24, alpha: 1)
IncdTheme.current = theme
```

### Fonts

`ThemeConfiguration.fonts` is a `FontsConfiguration`. Construct one with the roles you want to override; any role you omit keeps its default.

```swift
var theme = IncdTheme.current
theme.fonts = FontsConfiguration(
    title: UIFont(name: "YourFont-Bold", size: 24),
    subtitle: UIFont(name: "YourFont-Medium", size: 18),
    body: UIFont(name: "YourFont-Regular", size: 16),
    buttonBig: UIFont(name: "YourFont-Bold", size: 18)
)
IncdTheme.current = theme
```

`FontsConfiguration` exposes the following roles:

- `title`

- `bigTitle`

- `hugeTitle`

- `subtitle`

- `boldedSubtitle`

- `smallSubtitle`

- `smallBoldedSubtitle`

- `info`

- `body`

- `boldedBody`

- `buttonBig`

- `buttonMedium`

- `buttonSmall`

- `textFieldBig`

- `textFieldMedium`

- `feedbackSmall`

- `feedbackBig`



## Add a Custom Logo

Show a custom logo at the top of supported screens by setting `IncdTheme.logo`. It is a `UIImage?`. If you do not set it, the SDK uses the default Incode logo.

```swift
IncdTheme.logo = UIImage(named: "my_logo")
```

Alternatively, supply the logo at build time: add an image named `incdOnboardingLogo` to your app's asset catalog (usually `Assets.xcassets`). The SDK resizes it to fit a 35pt height. To hide the logo on screens that show it, add a fully transparent image under the same `incdOnboardingLogo` name.

The Video Selfie module lets you show a custom logo just for its own screens. Set it on the module's `VideoSelfieConfiguration` before adding the module to your flow:

```swift
let config = VideoSelfieConfiguration()
config.setLogo(UIImage(named: "my_video_selfie_logo"))
flowConfig.addVideoSelfie(videoSelfieConfiguration: config)
```

The Video Selfie logo applies only to that module's capture screens. All other supported screens use the generic `IncdTheme.logo`. See [Video Selfie](/sdk-reference/module-video-selfie/) for the full module configuration.



## Customize Buttons

`ThemeConfiguration.buttons` is a `ButtonsConfiguration` with one `ButtonConfiguration` per button role: `primary`, `secondary`, `text`, `help`, and `chooser`.

Each `ButtonConfiguration` has:

- `states`: per-state styling for `normal`, `highlighted`, and `disabled`, each a `ButtonThemedState`.
- `big` and `medium`: size variants, each a `ButtonSizeVariant`.

A `ButtonThemedState` exposes:

- `backgroundColor`

- `borderColor`

- `borderWidth`

- `cornerRadius`

- `textColor`

- `alpha`

- `shadowColor`

- `shadowOffset`

- `shadowOpacity`

- `shadowRadius`

- `iconImageName` (optional)

- `iconTintColor` (optional)

- `iconPosition` (optional)

- `iconPadding` (optional)

A `ButtonSizeVariant` exposes `height`, `minWidth`, `contentInsets`, and `kerning`.

```swift
var theme = IncdTheme.current

// Primary button: normal state
theme.buttons.primary.states.normal.backgroundColor = UIColor(red: 0.0, green: 0.42, blue: 1.0, alpha: 1)
theme.buttons.primary.states.normal.textColor = .white
theme.buttons.primary.states.normal.cornerRadius = 12
theme.buttons.primary.states.normal.borderWidth = 0

// Primary button: disabled state
theme.buttons.primary.states.disabled.backgroundColor = UIColor(white: 0.9, alpha: 1)
theme.buttons.primary.states.disabled.textColor = UIColor(white: 0.6, alpha: 1)

// Primary button: big size variant
theme.buttons.primary.big.height = 64
theme.buttons.primary.big.minWidth = 200

// Secondary button
theme.buttons.secondary.states.normal.backgroundColor = .white
theme.buttons.secondary.states.normal.borderColor = UIColor(red: 0.12, green: 0.16, blue: 0.24, alpha: 1)
theme.buttons.secondary.states.normal.borderWidth = 1
theme.buttons.secondary.states.normal.cornerRadius = 12

IncdTheme.current = theme
```



## Customize Other UI Elements

Colors, fonts, and buttons cover most use cases. If you need more control, the theme exposes label styling and per-component configuration.

### Labels

`ThemeConfiguration.labels` is a `LabelsConfiguration` with one `LabelConfiguration` per text role: `title`, `secondaryTitle`, `subtitle`, `secondarySubtitle`, `smallSubtitle`, `info`, `secondaryInfo`, `body`, `secondaryBody`, and `code`. Each `LabelConfiguration` exposes `textColor`, `textAlignment`, and `kerning`.

```swift
var theme = IncdTheme.current
theme.labels.title.textColor = UIColor(red: 0.12, green: 0.16, blue: 0.24, alpha: 1)
theme.labels.body.textColor = UIColor(white: 0.39, alpha: 1)
theme.labels.info.textAlignment = .center
IncdTheme.current = theme
```

### Selfie and Video Selfie

`ThemeConfiguration.customComponents` groups per-component styling. Two components are commonly customized:

- The [Selfie](/sdk-reference/module-selfie/) camera background is white by default, which helps in low-light conditions. Change it with `SelfieThemeConfiguration`:
  ```swift
  var theme = IncdTheme.current
  theme.customComponents.selfie = SelfieThemeConfiguration(background: .white)
  IncdTheme.current = theme
  ```

- The [Video Selfie](/sdk-reference/module-video-selfie/) overlay and progress bar are configured with `VideoSelfieThemeConfiguration`:
  ```swift
  var theme = IncdTheme.current
  theme.customComponents.videoSelfie = VideoSelfieThemeConfiguration(
      overlayColor: .black,
      overlayAlpha: 0.44,
      progressBarColor: UIColor.white.withAlphaComponent(0.5),
      progressBarSelectedColor: .white
  )
  IncdTheme.current = theme
  ```

### Other custom components

`ThemeConfiguration.customComponents` also exposes `cameraFeedback`, `idCaptureHelp`, `idSideLabel`, `separator`, `signature`, `idAutocaptureCountdownConfiguration`, and `idCaptureFrame`. Assign a configured instance of each type to change the matching component. For their individual properties, see [API Reference](/sdk-reference/ios-api-reference/).



## Customize Animations and Icons

The SDK uses Lottie animations for its tutorials, capture feedback, and loading screens. You can restyle them in two ways: let the SDK tint the built-in animations with your brand color or replace them with your own files.

### Automatic tinting

The V2 tutorial and capture-feedback animations are tinted automatically with your brand color (`brand500` from the V2 `colorPalette`). When you change `brand500`, these animations update to match. No extra work is required.

### Replace an animation

To replace a built-in animation, add a Lottie file (`.json` or `.lottie`) with the matching name to your app bundle. At runtime, the SDK looks in your app bundle first and falls back to its own version.

When you supply your own animation, the SDK uses it as-is and does not apply brand tinting because a custom file may have a different layer structure. Bake the final colors into your replacement.

| Name                          | Used for                                  |
| ----------------------------- | ----------------------------------------- |
| `id_scan_tutorial`            | Front ID scan tutorial (V2)               |
| `id_back_scan_tutorial`       | Back ID scan tutorial (V2)                |
| `passport_scan_tutorial`      | Passport scan tutorial (V2)               |
| `tutorial_selfie_v2`          | Selfie and face enrollment tutorial (V2)  |
| `tutorial_front`              | Front ID scan tutorial (V1)               |
| `tutorial_back`               | Back ID scan tutorial (V1)                |
| `tutorial_passport`           | Passport scan tutorial (V1)               |
| `incode-processing-animation` | Processing and loading screens            |

### Document chooser icons

The document chooser icons (`chooserId2`, `chooserPass2`, `chooserDigitalId`) are drawn with Lottie internally but are not replaceable with custom Lottie files. To change them, add a static image asset (for example, PNG or PDF) with the same name to your app's asset catalog.

### Light and dark image variants

For images you supply in your asset catalog, including the logo and the chooser icons, you can define separate light and dark artwork with Xcode's asset-catalog **Appearances** options. The SDK resolves these assets with the current interface style, so the matching variant is used.


## Configure Runtime Styles

Because the theme is plain Swift state, you can change it at runtime: for example, to switch styles based on a user's preference. Assign a new value to `IncdTheme.current` (or to the V2 properties) at any point before the next screen is presented.

```swift
func applyHighContrastTheme() {
    var theme = IncdTheme.current
    theme.colors.primary = .black
    theme.colors.accent = .black
    theme.colors.background = .white
    IncdTheme.current = theme
}
```

To load a full theme from JSON at runtime, use `IncdTheme.loadJsonTheme(_:)`. See [Configure V2 Theme and UX](#configure-v2-theme-and-ux) for the JSON format.

```swift
let jsonString = "<THEME_JSON_STRING>"
IncdTheme.loadJsonTheme(jsonString)
```

To reset everything back to Incode's defaults, call:

```swift
IncdTheme.loadDefaultTheme()
```

## Localize Display Text

There are three ways to change the text the SDK displays:

- [Override the bundled strings](#override-bundled-strings) at build time
- Replace strings programmatically with [dynamic localization](#dynamic-localization)
- [Switch](#runtime-localization) the SDK language at runtime

The SDK ships default text for five locales: German, English, Spanish, Hebrew, and Portuguese (`de`, `en`, `es`, `he`, `pt`).

String keys follow a dotted namespace, for example `incdOnboarding.global.button.continue`, `incdOnboarding.global.button.cancel`, and `incdOnboarding.global.dialog.ok`. For the complete list, see the drop-down below.

### Override Bundled Strings

To customize the text the SDK displays, create your own `Localizable.strings` file and point the SDK at it.

**Create the strings file in Xcode:**

1. In Xcode, select **File > New > File**, then select **Resource** in the iOS category in the sidebar.
2. Select **Strings File** from the files and click **Next**.
3. Name the file `Localizable` and click **Create**.
4. Add the keys you want to customize:

```swift
   // add a key and change the value to what you want
   "incdOnboarding.phone.title" = "Please enter your phone number";
```

5. Make sure the file is in the **Copy Bundle Resources** section of the **Build Phases** tab in Xcode.

To enable multi-language support, turn on **Use Base Internationalization** inside your project and add each language you want to support.

**Point the SDK at your strings:**

Set the bundle that contains your `Localizable.strings`, and optionally a custom file name (without the `.strings` extension):

```swift
IncdLocalization.localizationBundle = Bundle.main
IncdLocalization.localizationStringsFile = "IncodeStrings" // uses IncodeStrings.strings
```

If you set neither, the SDK reads `Localizable.strings` from the main bundle, then falls back to its own bundled strings.

### Dynamic Localization

Override strings programmatically by assigning values to `IncdLocalization.current`. Values in `IncdLocalization.current` take priority over the bundled localization.

**Override individual keys:**

```swift
IncdLocalization.current["incdOnboarding.idChooser.idButton"] = "Button 1"
```

**Replace all overrides with a dictionary:**

```swift
IncdLocalization.current = [
    "incdOnboarding.global.button.continue": "Proceed",
    "incdOnboarding.global.dialog.ok": "Got it"
]
```

Assigning a dictionary replaces any previously set overrides. Use the subscript form to add or update individual keys without clearing the rest.

By default, keys not present in `IncdLocalization.current` fall back to the bundled localization. You can disable that fallback, though this is recommended only for testing:

```swift
IncdLocalization.disableFallback = true
```

### Runtime Localization

Change the SDK language at runtime by setting the preferred language:

```swift
IncdLocalization.localizationLanguage = "pt"
```


Supported values are `en`, `es`, `pt`, `de`, and `he`. If the requested language is not bundled, the SDK uses the language preferred by the current locale, and falls back to English if that is also unavailable.

Full locale identifiers such as `he-IL` or `pt-BR` are also accepted. If no exact `lproj` match is found, the SDK falls back to the base language code (for example, `he-IL` resolves to `he.lproj`).

If you have overridden some texts in the `.strings` file used by the current locale but you still want to force the preferred language, specify the bundle as well:

```swift
  let path = Bundle.main.path(forResource: "es", ofType: "lproj")
  if let path = path,
     let bundle = Bundle(path: path) {
      IncdLocalization.localizationBundle = bundle
  }
```

`IncdOnboardingManager.localizationLanguage` is deprecated and forwards to `IncdLocalization.localizationLanguage`. Use `IncdLocalization.localizationLanguage` directly.

<Accordion title="List of Localizable texts">
  ```swift
    "incdOnboarding.global.button.cancel" = "Cancel";
    "incdOnboarding.global.button.continue" = "CONTINUE";
    "incdOnboarding.global.button.continue.lowerCase" = "Continue";
    "incdOnboarding.global.button.done" = "Done";
    "incdOnboarding.global.button.next" = "Next";
    "incdOnboarding.global.button.tryAgain" = "TRY AGAIN";
    "incdOnboarding.global.button.tryAgain.lowerCase" = "Try Again";
    "incdOnboarding.global.button.skipThisStep" = "SKIP THIS STEP";
    "incdOnboarding.global.button.skipThisStep.lowerCase" = "Skip this step";
    "incdOnboarding.global.button.quitProcess" = "Quit process";
    "incdOnboarding.global.dialog.cameraPermissionsBtnOpenSettings" = "OPEN SETTINGS";
    "incdOnboarding.global.dialog.cameraPermissionsBtnOpenAllow" = "Allow permission";
    "incdOnboarding.global.dialog.cameraPermissionsMandatorySubtitle" = "Please open Settings and enable Camera";
    "incdOnboarding.global.dialog.cameraPermissionsMandatoryTitle" = "Camera permission is mandatory";
    "incdOnboarding.global.dialog.continue" = "Continue";
    "incdOnboarding.global.dialog.quitConfirmation" = "Are you sure you want to quit the process?";
    "incdOnboarding.global.dialog.ok" = "OK";
    "incdOnboarding.global.dialog.permission.finishProcess" = "FINISH PROCESS";
    "incdOnboarding.global.dialog.quit" = "Quit";
    "incdOnboarding.global.error.generic.message" = "Please try again";
    "incdOnboarding.global.error.generic.title" = "Something went wrong";
    "incdOnboarding.global.processing" = "Processing…";
    "incdOnboarding.global.uploading" = "Uploading…";
    "incdOnboarding.global.verifying" = "Verifying…";
    "incdOnboarding.global.pleaseWait" = "Please wait";
    "incdOnboarding.global.buttonDisabled" = "disabled";
    "incdOnboarding.global.adjustingCamera" = "Adjusting camera…";
    "incdOnboarding.global.close" = "Close";
    "incdOnboarding.global.back" = "Back";
    "incdOnboarding.global.textField.clear" = "Clear text field";
    "incdOnboarding.autoCapture.detectionSuccess" = "Don’t move!\nTaking photo…";
    "incdOnboarding.barcodeTips.continue" = "Continue";
    "incdOnboarding.barcodeTips.subtitle" = "Photo will be taken automatically";
    "incdOnboarding.barcodeTips.title" = "Zoom the barcode inside the frame";
    "incdOnboarding.barcodeUploader.success" = "Success";
    "incdOnboarding.barcodeUploader.uploading" = "Uploading";
    "incdOnboarding.btnRetakePhoto" = "RETAKE PHOTO";
    "incdOnboarding.conference.btnSend" = "SEND";
    "incdOnboarding.conference.chatWith" = "Chat with %@";
    "incdOnboarding.conference.interviewerConnected" = "connected";
    "incdOnboarding.conference.subtitle" = "We’re connecting you\nwith a representative";
    "incdOnboarding.conference.title" = "Hang on";
    "incdOnboarding.conference.waitingTimeLabel" = "This usually takes 2 – 3 minutes.";
    "incdOnboarding.conference.writeMessageHint" = "Write a message";
    "incdOnboarding.creditCardTips.title" = "Place your Credit Card\nwithin the frame\nand take the photo";
    "incdOnboarding.curp.add.continue" = "Continue";
    "incdOnboarding.curp.add.curptextfield.placeholder" = "Your CURP";
    "incdOnboarding.curp.add.info" = "Invalid CURP";
    "incdOnboarding.curp.add.nocurp" = "I don’t have a CURP";
    "incdOnboarding.curp.add.title" = "Enter your CURP";
    "incdOnboarding.curp.add.title.confirm" = "Confirm your CURP";
    "incdOnboarding.curp.add.retry" = "Try again";
    "incdOnboarding.curp.generation.first.name.title" = "First name";
    "incdOnboarding.curp.generation.first.name.placeholder" = "Your first name";
    "incdOnboarding.curp.generation.first.last.name.title" = "First last name";
    "incdOnboarding.curp.generation.first.last.name.placeholder" = "Your first last name";
    "incdOnboarding.curp.generation.second.last.name.title" = "Second last name";
    "incdOnboarding.curp.generation.second.last.name.placeholder" = "Your second last name";
    "incdOnboarding.curp.generation.gender.title" = "Gender";
    "incdOnboarding.curp.generation.gender.placeholder" = "Choose gender";
    "incdOnboarding.curp.generation.gender.female" = "Female";
    "incdOnboarding.curp.generation.gender.male" = "Male";
    "incdOnboarding.curp.generation.gender.other" = "Non-binary/Other";
    "incdOnboarding.curp.generation.birthdate.title" = "Date of birth";
    "incdOnboarding.curp.generation.birthdate.placeholder" = "DD / MM / YYYY";
    "incdOnboarding.curp.generation.birth.state.title" = "Birth state";
    "incdOnboarding.curp.generation.birth.state.placeholder" = "Select state";
    "incdOnboarding.curp.generation.state.bornAbroad" = "Born Abroad";
    "incdOnboarding.curp.generation.failure" = "Couldn't generate your CURP";
    "incdOnboarding.curp.generation.generate" = "Generate";
    "incdOnboarding.curp.generation.info.failure" = "Please check entered information";
    "incdOnboarding.curp.generation.inprogress" = "Generating CURP…";
    "incdOnboarding.curp.generation.success" = "CURP verified!";
    "incdOnboarding.curp.generation.title" = "Generate your CURP";
    "incdOnboarding.curp.generation.retry" = "Edit information";
    "incdOnboarding.curp.validation.failure" = "CURP not verified";
    "incdOnboarding.curp.validation.inprogress" = "Verifying your CURP…";
    "incdOnboarding.curp.validation.success" = "CURP verified!";
    "incdOnboarding.document.addressStatement.subtitle" = "This can be any legal documentation that proves your address.";
    "incdOnboarding.document.addressStatement.title" = "Upload a document to verify your identity";
    "incdOnboarding.document.continue" = "Continue";
    "incdOnboarding.document.failUpload" = "Couldn't upload your document";
    "incdOnboarding.document.uploadFailed.continue" = "CONTINUE";
    "incdOnboarding.document.files" = "Files";
    "incdOnboarding.document.footer" = "Take a photo or upload PDF, JPG";
    "incdOnboarding.document.info.noDocumentDetected" = "No document detected";
    "incdOnboarding.document.info.showPaperStatement" = "Show the paper\nstatement";
    "incdOnboarding.document.info.tooBlurry" = "Statement out of focus";
    "incdOnboarding.document.info.tooDark" = "Too dark\nStatement not detected";
    "incdOnboarding.document.info.tooFar" = "Please move the statement\n closer";
    "incdOnboarding.document.medicalDoc.subtitle" = "This can be a document that shows you are medically insured.";
    "incdOnboarding.document.medicalDoc.title" = "Upload your medical document";
    "incdOnboarding.document.otherDocument1.subtitle" = "This can be any legal documentation that proves your identity";
    "incdOnboarding.document.otherDocument1.title" = "Upload a document to verify your identity";
    "incdOnboarding.document.otherDocument2.subtitle" = "This can be any legal documentation that proves your identity";
    "incdOnboarding.document.otherDocument2.title" = "Upload a document to verify your identity";
    "incdOnboarding.document.otherDocument3.subtitle" = "This can be any legal documentation that proves your identity";
    "incdOnboarding.document.otherDocument3.title" = "Upload a document to verify your identity";
    "incdOnboarding.document.paymentProof.subtitle" = "This can be a document from your bank or electronic invoice that shows a specific transaction.";
    "incdOnboarding.document.paymentProof.title" = "Upload your proof of payment";
    "incdOnboarding.document.photoLibrary" = "Photo Library";
    "incdOnboarding.document.takePhoto" = "Take Photo";
    "incdOnboarding.document.tutorial.subtitle" = "Make sure that entire document fits the view";
    "incdOnboarding.document.tutorial.title" = "Place your document within the frame and take the photo";
    "incdOnboarding.document.review.continue" = "CONTINUE";
    "incdOnboarding.document.review.retake" = "RETAKE";
    "incdOnboarding.document.review.subtitle" = "Make sure that the entire document fits the view, and that the text is readable";
    "incdOnboarding.document.review.title" = "Review your document";
    "incdOnboarding.faceEnroll.tutorial.ageVerification.title" = "Take a selfie to verify your age";
    "incdOnboarding.faceEnroll.tutorial.ageVerification.subtitle" = "Your image will not be stored or shared with any third-party to protect your privacy";
    "incdOnboarding.faceEnroll.tutorial.ageVerification.hint" = "Stay still, selfie will be taken automatically";
    "incdOnboarding.faceEnroll.tutorial.ageVerification.buttonTitle" = "Verify age";
    "incdOnboarding.faceEnroll.tutorial.title" = "Take a selfie";
    "incdOnboarding.faceEnroll.tutorial.subtitle" = "Keep a neutral expression, find balanced light and remove any glasses and hats";
    "incdOnboarding.faceEnroll.tutorial.hint" = "Stay still, photo will be taken automatically";
    "incdOnboarding.faceEnroll.tutorial.buttonTitle" = "Take selfie";
    "incdOnboarding.faceEnroll.noNetworkConnection.title" = "No internet connection";
    "incdOnboarding.faceEnroll.noNetworkConnection.subtitle" = "Wait for the internet to return to continue the process or connect to an available network.";
    "incdOnboarding.faceEnroll.noNetworkConnection.btnTitle" = "Refresh";
    "incdOnboarding.geolocation.btnContinue" = "CONTINUE";
    "incdOnboarding.geolocation.btnDontProvideLocation" = "Don’t provide location";
    "incdOnboarding.geolocation.btnGoToSettings" = "GO TO SETTINGS";
    "incdOnboarding.geolocation.title.allowLocation" = "Allow Location\nPermission to continue";
    "incdOnboarding.geolocation.title.intro" = "We need to determine\nyour current location";
    "incdOnboarding.geolocation.title.success" = "You are currently in:";
    "incdOnboarding.geolocation.title.allowAccess" = "Allow location access";
    "incdOnboarding.geolocation.subtitle.allowAccess" = "to complete the process";
    "incdOnboarding.geolocation.title.unableToVerify" = "Unable to verify your location.";
    "incdOnboarding.geolocation.subtitle.unableToVerify" = "Your location signal may be weak or not accurate enough. Please move to an area with better signal and try again.";
    "incdOnboarding.govValidation.error.connection" = "Government Check connection error";
    "incdOnboarding.govValidation.error.ineInfrastructure" = "Government Check infrastructure error";
    "incdOnboarding.govValidation.error.insufficientLookupData" = "Insufficient lookup data";
    "incdOnboarding.govValidation.error.missingDocumentIdentifier" = "Missing document identifier";
    "incdOnboarding.govValidation.error.missingSelfie" = "Missing selfie";
    "incdOnboarding.govValidation.error.moduleNotSupported" = "Module not supported error";
    "incdOnboarding.govValidation.error.userNotFound" = "User not found";
    "incdOnboarding.govValidation.error.userNotInDatabase" = "User not in government check DB";
    "incdOnboarding.govValidation.failure" = "Identity not verified";
    "incdOnboarding.govValidation.inProgress" = "Hang on\nWe are validating your documents";
    "incdOnboarding.govValidation.startedSuccessfully" = "Identity submitted for verification";
    "incdOnboarding.govValidation.success" = "Identity verified!";
    "incdOnboarding.id.documentType.unknown" = "Unknown";
    "incdOnboarding.id.documentType.passport" = "Passport";
    "incdOnboarding.id.documentType.visa" = "Visa";
    "incdOnboarding.id.documentType.driversLicense" = "Driver's License";
    "incdOnboarding.id.documentType.identificationCard" = "Identification Card";
    "incdOnboarding.id.documentType.permit" = "Permit";
    "incdOnboarding.id.documentType.currency" = "Currency";
    "incdOnboarding.id.documentType.residenceDocument" = "Residence Document";
    "incdOnboarding.id.documentType.travelDocument" = "Travel Document";
    "incdOnboarding.id.documentType.birthCertificate" = "Birth Certificate";
    "incdOnboarding.id.documentType.vehicleRegistration" = "Vehicle Registration";
    "incdOnboarding.id.documentType.other" = "Other";
    "incdOnboarding.id.documentType.weaponLicense" = "Weapon License";
    "incdOnboarding.id.documentType.tribalIdentification" = "Tribal Identification";
    "incdOnboarding.id.documentType.voterIdentification" = "Voter Identification";
    "incdOnboarding.id.documentType.military" = "Military";
    "incdOnboarding.id.documentType.taxIdentification" = "Tax Identification";
    "incdOnboarding.id.documentType.federalID" = "Federal ID";
    "incdOnboarding.id.documentType.medicalCard" = "Medical Card";
    "incdOnboarding.id.err.blurDesc" = "Photo\nis blurred";
    "incdOnboarding.id.err.classificationFailed" = "ID scan failed";
    "incdOnboarding.id.err.commonIssuesNoAttemptsRemaining" = "Maximum number of attempts reached";
    "incdOnboarding.id.err.commonIssuesAttemptRemaining" = "1 attempt remaining";
    "incdOnboarding.id.err.commonIssuesAttemptsRemaining" = "%d attempts remaining";
    "incdOnboarding.id.err.commonIssuesTitle" = "Common issues";
    "incdOnboarding.id.err.default" = "Couldn't capture";
    "incdOnboarding.id.err.fillFrame" = "Fill the rectangle with your ID";
    "incdOnboarding.id.err.glare" = "Glare detected";
    "incdOnboarding.id.err.readability" = "ID not readable";
    "incdOnboarding.id.err.shadowDesc" = "Shadows or\nglare present";
    "incdOnboarding.id.err.sharpness" = "ID out of focus";
    "incdOnboarding.id.err.tooDark" = "Too dark";
    "incdOnboarding.id.err.unreadableDesc" = "Info is\nnot readable";
    "incdOnboarding.id.err.unacceptable" = "ID type is not accepted";
    "incdOnboarding.id.err.unacceptableButton" = "Use another ID";
    "incdOnboarding.id.err.wrongSide.title" = "Wrong ID side captured";
    "incdOnboarding.id.err.wrongSide.subtitleFront" = "Please capture the front side of the ID";
    "incdOnboarding.id.err.wrongSide.subtitleBack" = "Please capture the back side of the ID";
    "incdOnboarding.id.err.uploadIssue.blur" = "Blur present";
    "incdOnboarding.id.err.uploadIssue.blur.hint" = "Move ID further away or closer to your phone until the image is focused";
    "incdOnboarding.id.err.uploadIssue.glare" = "Glare present";
    "incdOnboarding.id.err.uploadIssue.glare.hint" = "Tilt the ID slightly up or down to minimize the reflection";
    "incdOnboarding.id.err.uploadIssue.readablity" = "Info is not readable";
    "incdOnboarding.id.err.uploadIssue.readablity.hint" = "Minimize camera shake by holding your phone steady";
    "incdOnboarding.id.err.uploadIssue.unacceptableID" = "ID type is not accepted";
    "incdOnboarding.id.err.uploadIssue.unacceptableID.hint" = "Please try with a different document";
    "incdOnboarding.id.help.btnNeedHelp" = "HELP";
    "incdOnboarding.id.help.btnOk" = "Try again";
    "incdOnboarding.id.help.btnSwitchToManualCapture" = "I PREFER TO CAPTURE THE PHOTO MANUALLY";
    "incdOnboarding.id.help.title" = "Common issues";
    "incdOnboarding.id.capturingIn.voiceover" = "Capturing in";
    "incdOnboarding.id.holdStill.voiceover" = "Hold still";
    "incdOnboarding.id.intro.voiceover" = "Back camera has started and ready to scan.";
    "incdOnboarding.id.help.glare.title" = "Glare present";
    "incdOnboarding.id.help.glare.subtitle" = "Tilt the ID slightly up or down to minimize the reflection";
    "incdOnboarding.id.help.blur.title" = "Blur present";
    "incdOnboarding.id.help.blur.subtitle" = "Move ID further away or closer to your phone until the image is focused";
    "incdOnboarding.id.help.unreadable.title" = "Camera lens dirty";
    "incdOnboarding.id.help.unreadable.subtitle" = "Minimize camera shake by holding your phone steady";
    "incdOnboarding.id.help.attemptSingular" = "1 attempt remaining";
    "incdOnboarding.id.help.attemptPlural" = "%d attempts remaining";
    "incdOnboarding.id.help.noAttempts" = "No attempts remaining";
    "incdOnboarding.id.manualCaptureInfo" = "1. Put ID in the frame\n2. Press capture button";
    "incdOnboarding.id.manualCaptureInfo_v2" = "1. Fill the frame with your ID\n2. Press the button";
    "incdOnboarding.id.showBackIDSide" = "Show the back of the ID";
    //"incdOnboarding.id.showBackIDSideOnCountdown" = "Keep the camera still";
    "incdOnboarding.id.showFrontIDSide" = "Show the front of the ID";
    //"incdOnboarding.id.showFrontIDSideOnCountdown" = "Keep the camera still";
    "incdOnboarding.id.showPassport" = "Show passport page with your photo";
    "incdOnboarding.id.summary.backFail" = "Back ID scan fail";
    "incdOnboarding.id.summary.backSuccess" = "Back ID scan success";
    "incdOnboarding.id.summary.frontFail" = "Front ID scan fail";
    "incdOnboarding.id.summary.frontSuccess" = "Front ID scan success";
    "incdOnboarding.id.summary.mainButton" = "CONTINUE";
    "incdOnboarding.id.summary.passportFail" = "Passport scan fail";
    "incdOnboarding.id.summary.subtitle" = "We will notify you with the result";
    "incdOnboarding.id.summary.title" = "Referred to an executive";
    "incdOnboarding.id.userReview.continue" = "CONTINUE";
    "incdOnboarding.id.userReview.retake" = "RETAKE";
    "incdOnboarding.id.userReview.subtitle" = "• Ensure that the text on the ID is readable";
    "incdOnboarding.id.userReview.subtitle2" = "• The ID photo must be sharp and without glare";
    "incdOnboarding.id.userReview.hint" = "Ensure that the text on the ID is readable and that the photo is sharp and without glare";
    "incdOnboarding.id.userReview.title" = "Review your photo";
    "incdOnboarding.id.userReview.button.retake" = "Retake";
    "incdOnboarding.id.userReview.button.continue" = "Continue";
    "incdOnboarding.id.warn.showBackID" = "Show the back\nof the ID";
    "incdOnboarding.id.warn.showfrontID" = "Show the front\nof the ID";
    "incdOnboarding.id.dataEncrypted" = "All data is encrypted";
    "incdOnboarding.idBackTips.title" = "Now show the\nback side of your ID";
    "incdOnboarding.idBackTips.title.highlight" = "back side";
    "incdOnboarding.idChooser.idButton" = "Driver License\nID Card\nResident Card";
    "incdOnboarding.idChooser.passportButton" = "Passport \nVisa";
    "incdOnboarding.idChooser.title" = "Select what document\nyou want to scan";
    "incdOnboarding.idTips.btnNext" = "NEXT";
    "incdOnboarding.idTips.btnSkip" = "SKIP";
    "incdOnboarding.idTips.btnStart" = "START";
    "incdOnboarding.idTips.firstSubtitle" = "Avoid shadows and glare";
    "incdOnboarding.idTips.secondSubtitle" = "Photo will be taken automatically";
    "incdOnboarding.idTips0" = "Place your\nID inside the frame";
    "incdOnboarding.idTips1" = "Avoid\nshadows and glare";
    "incdOnboarding.idTips2" = "Make sure\nthe photo is sharp";
    "incdOnboarding.idTips3" = "Make sure\ninfo is readable";
    "incdOnboarding.idTips.voiceover" = "Place your ID up to the back camera of your phone and slowly move the ID while holding your phone in position. Once you feel the vibration, hold still, and the capture will happen automatically.";
    "incdOnboarding.idTips.ageAssurance.title" = "Age verification";
    "incdOnboarding.idTips.ageAssurance.subtitle" = "We need to scan your ID to know your age";
    "incdOnboarding.idTips.ageAssurance.tip1" = "Show your ID and scan it";
    "incdOnboarding.idTips.ageAssurance.tip2" = "We only use the date of birth information";
    "incdOnboarding.idTips.ageAssurance.tip3" = "The rest of your information will be deleted to ensure your privacy";
    "incdOnboarding.idTips.ageAssurance.idScan" = "Place your ID vertically inside the frame";
    "incdOnboarding.idTips.ageAssurance.calculatingAge" = "Calculating your age…";
    "incdOnboarding.id.tooClose.voiceOver" = "Move phone further from the ID";
    "incdOnboarding.id.tooFar.voiceOver" = "Move phone closer to the ID";
    "incdOnboarding.id.switchingToManualCapture" = "Double tap on the screen to capture, or bottom right button if you need help with capturing.";
    "incdOnboarding.intro.dataProtected" = "Your data is protected by Incode";
    "incdOnboarding.intro.dataProtected.highlight" = "Incode";
    "incdOnboarding.intro.title" = "For this process you will need:";
    "incdOnboarding.intro.continue" = "CONTINUE";
    "incdOnboarding.match.compact.title" = "Checking your photos";
    "incdOnboarding.match.compact.subtitle" = "This may take a few seconds";
    "incdOnboarding.match.fail" = "Faces do not match";
    "incdOnboarding.match.nfc.fail" = "Faces do not match";
    "incdOnboarding.match.livenessFailed" = "Liveness failed";
    "incdOnboarding.match.livenessSuccess" = "Liveness success";
    "incdOnboarding.match.success" = "Matched!";
    "incdOnboarding.match.title" = "Verifying identity";
    "incdOnboarding.match.userAlreadyExists" = "User already exists";
    "incdOnboarding.match.primaryID" = "First ID";
    "incdOnboarding.match.secondaryID" = "Second ID";
    "incdOnboarding.match.selfie" = "Selfie";
    "incdOnboarding.match.processing" = "Processing…";
    "incdOnboarding.match.done" = "Done!";
    "incdOnboarding.otp.btnSubmit" = "SUBMIT";
    "incdOnboarding.otp.generating" = "Generating new code..";
    "incdOnboarding.otp.timeLeft" = "%i second left";
    "incdOnboarding.otp.timeLeftPlural" = "%i seconds left";
    "incdOnboarding.otp.title" = "Please enter\nthe following code";
    "incdOnboarding.otp.wrongCode" = "Incorrect code, please try again.";
    "incdOnboarding.passport.err.classificationFailed" = "Passport scan failed";
    "incdOnboarding.passport.err.readability" = "Passport not readable";
    "incdOnboarding.passport.err.sharpness" = "Passport out of focus";
    "incdOnboarding.passport.manualCaptureInfo" = "1. Put passport in the frame\n2. Press capture button";
    "incdOnboarding.passport.manualCaptureInfo_v2" = "1. Fill the frame with your passport\n2. Press the button";
    "incdOnboarding.passportTips0" = "Place your Passport inside the\nframe and take a photo";
    "incdOnboarding.passportTips1" = "Avoid\nshadows and glare";
    "incdOnboarding.passportTips2" = "Make sure\nthe photo is sharp";
    "incdOnboarding.passportTips3" = "Make sure\ninfo is readable";
    "incdOnboarding.phone.numberExistsMsg" = "User with this phone number already exists. Please check and try again.";
    "incdOnboarding.phone.numberExistsTitle" = "User already exists";
    "incdOnboarding.phone.optin" = "Yes, I’d like to receive important messages from %@ on my phone";
    "incdOnboarding.phone.title" = "Please enter your phone number";
    "incdOnboarding.phone.continue" = "CONTINUE";
    "incdOnboarding.progressDetails.title" = "Your progress";
    "incdOnboarding.progressDetails.subtitle" = "Complete the following, it takes around 2-5 minutes to prove your identity";
    "incdOnboarding.progressDetails.dataProtected" = "Your data is protected by Incode";
    "incdOnboarding.progressDetails.dataProtected.highlight" = "Incode";
    "incdOnboarding.progressStep.intro.title" = "Intro";
    "incdOnboarding.progressStep.intro.subtitle" = "Intro";
    "incdOnboarding.progressStep.mobilePhone.title" = "Mobile Phone";
    "incdOnboarding.progressStep.mobilePhone.subtitle" = "Mobile Phone";
    "incdOnboarding.progressStep.email.title" = "Email";
    "incdOnboarding.progressStep.email.subtitle" = "Email";
    "incdOnboarding.progressStep.name.title" = "Name";
    "incdOnboarding.progressStep.name.subtitle" = "Name";
    "incdOnboarding.progressStep.barcode.title" = "Barcode";
    "incdOnboarding.progressStep.barcode.subtitle" = "Barcode";
    "incdOnboarding.progressStep.idFront.title" = "ID capture";
    "incdOnboarding.progressStep.idFront.subtitle" = "Scan your ID from both sides";
    "incdOnboarding.progressStep.idBack.title" = "ID Back";
    "incdOnboarding.progressStep.idBack.subtitle" = "ID Back";
    "incdOnboarding.progressStep.idProcessing.title" = "ID Processing";
    "incdOnboarding.progressStep.idProcessing.subtitle" = "ID Processing";
    "incdOnboarding.progressStep.qr.title" = "QR";
    "incdOnboarding.progressStep.qr.subtitle" = "QR";
    "incdOnboarding.progressStep.documentScan.title" = "Document Scan";
    "incdOnboarding.progressStep.documentScan.subtitle" = "Document Scan";
    "incdOnboarding.progressStep.creditCard.title" = "Credit Card Scan";
    "incdOnboarding.progressStep.creditCard.subtitle" = "Credit Card Scan";
    "incdOnboarding.progressStep.geolocation.title" = "Geolocation";
    "incdOnboarding.progressStep.geolocation.subtitle" = "Geolocation";
    "incdOnboarding.progressStep.curp.title" = "CURP";
    "incdOnboarding.progressStep.curp.subtitle" = "CURP";
    "incdOnboarding.progressStep.selfie.title" = "Selfie";
    "incdOnboarding.progressStep.selfie.subtitle" = "Selfie";
    "incdOnboarding.progressStep.faceMatch.title" = "Face Match";
    "incdOnboarding.progressStep.faceMatch.subtitle" = "Face Match";
    "incdOnboarding.progressStep.government.title" = "Government Validation";
    "incdOnboarding.progressStep.government.subtitle" = "Government Validation";
    "incdOnboarding.progressStep.signature.title" = "Signature";
    "incdOnboarding.progressStep.signature.subtitle" = "Signature";
    "incdOnboarding.progressStep.userConsent.title" = "User Consent";
    "incdOnboarding.progressStep.userConsent.subtitle" = "User Consent";
    "incdOnboarding.progressStep.videoConference.title" = "Video Conference";
    "incdOnboarding.progressStep.videoConference.subtitle" = "Video Conference";
    "incdOnboarding.progressStep.userScore.title" = "User Score";
    "incdOnboarding.progressStep.userScore.subtitle" = "User Score";
    "incdOnboarding.progressStep.approval.title" = "User Approval";
    "incdOnboarding.progressStep.approval.subtitle" = "User Approval";
    "incdOnboarding.progressStep.captchaOtp.title" = "Captcha/OTP";
    "incdOnboarding.progressStep.captchaOtp.subtitle" = "Captcha/OTP";
    "incdOnboarding.progressStep.videoSelfie.title" = "Video Selfie";
    "incdOnboarding.progressStep.videoSelfie.subtitle" = "Video Selfie";
    "incdOnboarding.processId.description" = "We’re verifying your identity";
    "incdOnboarding.processId.status" = "Hold on a sec…";
    "incdOnboarding.qr.btnTryAgain" = "TRY AGAIN";
    "incdOnboarding.qr.help.badCaptureAngleDesc" = "Bad capture angle";
    "incdOnboarding.qr.help.blurredDesc" = "Blurred or damaged QR";
    "incdOnboarding.qr.help.btnOk" = "Ok, try again";
    "incdOnboarding.qr.help.positionDesc" = "QR cropped out of frame";
    "incdOnboarding.qr.help.title" = "Common Issues";
    "incdOnboarding.qr.help.tooCloseOrTooFarDesc" = "QR too close or too far";
    "incdOnboarding.qr.processing" = "Processing…";
    "incdOnboarding.qr.scanningDone" = "Done!";
    "incdOnboarding.qr.scanningError" = "QR Scan\nUnsuccessful!";
    "incdOnboarding.qr.title" = "Place the QR code\ninside the box";
    "incdOnboarding.qrTips.subtitle" = "QR will be read automatically";
    "incdOnboarding.qrTips.title" = "Locate the QR inside\nthe document";
    "incdOnboarding.results.btnDone" = "DONE";
    "incdOnboarding.results.check.2DBarcodeRead" = "2D Barcode Read";
    "incdOnboarding.results.check.balancedLightBack" = "Balanced light (back side)";
    "incdOnboarding.results.check.balancedLightFront" = "Balanced light (front side)";
    "incdOnboarding.results.check.birthDateCheckDigit" = "Birth Date Check Digit";
    "incdOnboarding.results.check.birthDateCrosscheck" = "Birth Date Crosscheck";
    "incdOnboarding.results.check.birthDateValid" = "Birth Date Valid";
    "incdOnboarding.results.check.compositeCheckDigit" = "Composite Check Digit";
    "incdOnboarding.results.check.documentClassification" = "Document Classification";
    "incdOnboarding.results.check.documentCrosscheckAggregation" = "Document Crosscheck Aggregation";
    "incdOnboarding.results.check.documentExpired" = "Document Expired";
    "incdOnboarding.results.check.documentIdCheck" = "Document ID Check";
    "incdOnboarding.results.check.documentNumberCheckDigit" = "Document Number Check Digit";
    "incdOnboarding.results.check.documentNumberCrosscheck" = "Document Number Crosscheck";
    "incdOnboarding.results.check.electorsKey" = "Electors Key Valid";
    "incdOnboarding.results.check.emissionNumber" = "Emission Number Valid";
    "incdOnboarding.results.check.expirationDateCheckDigit" = "Expiration Date Check Digit";
    "incdOnboarding.results.check.expirationDateCrosscheck" = "Expiration Date Crosscheck";
    "incdOnboarding.results.check.expirationDateValid" = "Expiration Date Valid";
    "incdOnboarding.results.check.expirationDateValidity" = "Expiration Date Validity";
    "incdOnboarding.results.check.firstName" = "First Name Valid";
    "incdOnboarding.results.check.fullNameCrosscheck" = "Full Name Crosscheck";
    "incdOnboarding.results.check.idLiveness" = "ID Liveness";
    "incdOnboarding.results.check.imageTamperingCheck" = "Image Tampering Check";
    "incdOnboarding.results.check.incodeCrossCheck" = "Incode CrossCheck";
    "incdOnboarding.results.check.incodeFakeCheck" = "Incode FakeCheck";
    "incdOnboarding.results.check.incodeIdLiveness" = "Incode ID Liveness";
    "incdOnboarding.results.check.incodeTamperCheck" = "Incode TamperCheck";
    "incdOnboarding.results.check.issueDate" = "Issue Date Valid";
    "incdOnboarding.results.check.issueDateCheck" = "Issue Date Check";
    "incdOnboarding.results.check.issueDateValid" = "Issue Date Valid";
    "incdOnboarding.results.check.issueDateValidity" = "Issue Date Validity";
    "incdOnboarding.results.check.issuingStateValid" = "Issuing State Valid";
    "incdOnboarding.results.check.liveness_score" = "Liveness Score";
    "incdOnboarding.results.check.maternalLastName" = "Maternal Last Name Valid";
    "incdOnboarding.results.check.ocr" = "OCR Valid";
    "incdOnboarding.results.check.paternalLastName" = "Paternal Last Name Valid";
    "incdOnboarding.results.check.personalId" = "Personal Id Valid";
    "incdOnboarding.results.check.personalNumberCrosscheck" = "Personal Number Crosscheck";
    "incdOnboarding.results.check.photoPrinting" = "Photo Printing";
    "incdOnboarding.results.check.photo_comparison" = "Photo Comparison";
    "incdOnboarding.results.check.photo_quality" = "Photo Quality";
    "incdOnboarding.results.check.postitCheck" = "Postit Check";
    "incdOnboarding.results.check.qrCheck" = "QR check";
    "incdOnboarding.results.check.registrationDate" = "Registration Date Valid";
    "incdOnboarding.results.check.sexCrosscheck" = "Sex Crosscheck";
    "incdOnboarding.results.check.sharpnessBack" = "Sharpness (back side)";
    "incdOnboarding.results.check.sharpnessFront" = "Sharpness (front side)";
    "incdOnboarding.results.check.tamperCheck" = "Tamper Check";
    "incdOnboarding.results.check.user_already_in_database" = "User already in database";
    "incdOnboarding.results.check.visibleColorResponse" = "Visible Color Response";
    "incdOnboarding.results.check.visiblePattern" = "Visible Pattern";
    "incdOnboarding.results.check.visiblePhotoFeatures" = "Visible Photo Features";
    "incdOnboarding.results.frTitle" = "Facial Recognition";
    "incdOnboarding.results.governmentValidationOcrTitle" = "OCR Validation";
    "incdOnboarding.results.governmentValidationSelfieMatchingTitle" = "Photo Comparison";
    "incdOnboarding.results.governmentValidationTitle" = "Government + Incode Check";
    "incdOnboarding.results.idScanTitle" = "Incode ID";
    "incdOnboarding.results.idSpecificTitle" = "ID Specific";
    "incdOnboarding.results.idVerificationTitle" = "ID Verification";
    "incdOnboarding.results.ineTitle" = "Government Check Data";
    "incdOnboarding.results.ineValidation.faceMatch" = "It's a match!";
    "incdOnboarding.results.ineValidation.noFaceMatch" = "No match";
    "incdOnboarding.results.livenessScore" = "Liveness Score";
    "incdOnboarding.results.livenessTitle" = "Liveness Check";
    "incdOnboarding.results.manualCheckNeeded" = "Manual check needed";
    "incdOnboarding.results.photoQuality" = "Photo Quality";
    "incdOnboarding.results.photoSecurityQualityTitle" = "Photo security & quality";
    "incdOnboarding.results.selfieTitle" = "Incode Selfie";
    "incdOnboarding.results.userAlreadyInDB" = "User already in database";
    "incdOnboarding.selfie.cameraActivated" = "Front camera activated";
    "incdOnboarding.selfie.switchingToManualCapture" = "Double tap anywhere on the screen to capture";
    "incdOnboarding.selfie.adjustingCamera" = "Please wait, adjusting camera";
    "incdOnboarding.selfie.autoCapturing" = "Don't move!\nTaking photo…";
    "incdOnboarding.selfie.badAngleXY" = "Look straight";
    "incdOnboarding.selfie.badAngleZ" = "Don\'t tilt your head";
    "incdOnboarding.selfie.badAngleZ.voiceOver" = "Don\'t tilt your head";
    "incdOnboarding.selfie.badFaceQuality" = "Clean the camera and hold still";
    "incdOnboarding.selfie.button.takePhoto" = "TAKE PHOTO";
    "incdOnboarding.selfie.button.takePhoto.longTitle" = "Align your face within the silhouette and press the button to capture";
    "incdOnboarding.selfie.done" = "Success!";
    "incdOnboarding.selfie.eyesClosed" = "Keep your eyes open";
    "incdOnboarding.selfie.eyesClosed.voiceOver" = "Keep your eyes open";
    "incdOnboarding.selfie.faceOutsideBounds" = "Look at the camera";
    "incdOnboarding.selfie.getReady" = "Get ready…";
    "incdOnboarding.selfie.lowImageQuality" = "Ensure your face is clearly visible with no obstructions";
    "incdOnboarding.selfie.hasFaceMask" = "Take off the mask";
    "incdOnboarding.selfie.hasFaceMask.voiceOver" = "Take off your face mask";
    "incdOnboarding.selfie.hasFaceMask.title" = "Face mask detected";
    "incdOnboarding.selfie.hasFaceMask.subtitle" = "Take off your face mask to ensure a clear capture";
    "incdOnboarding.selfie.hasHeadwear.title" = "Head covered";
    "incdOnboarding.selfie.hasHeadwear.subtitle" = "Remove head coverings such as hats and caps";
    "incdOnboarding.selfie.hasLenses.title" = "Lenses detected";
    "incdOnboarding.selfie.hasLenses.subtitle" = "Take off your glasses to ensure a clear capture";
    "incdOnboarding.selfie.eyesClosed.title" = "Eyes closed";
    "incdOnboarding.selfie.eyesClosed.subtitle" = "Keep your eyes open during the capture";
    "incdOnboarding.selfie.tooDark.title" = "Too dark";
    "incdOnboarding.selfie.tooDark.subtitle" = "Adjust the lightning or move closer to a light source";
    "incdOnboarding.selfie.faceCaptured" = "Face captured!";
    "incdOnboarding.selfie.faceNotAligned.title" = "Face not aligned";
    "incdOnboarding.selfie.faceNotAligned.subtitle" = "Make sure you align your face with the white silhouette";
    "incdOnboarding.selfie.spoofDetected.title" = "Selfie processing failed";
    "incdOnboarding.selfie.spoofDetected.subtitle" = "We couldn’t process your selfie. Please try again";
    "incdOnboarding.selfie.faceOccluded.title" = "Face covered";
    "incdOnboarding.selfie.faceOccluded.subtitle" = "Make sure your face is clear and visible";
    "incdOnboarding.selfie.result.fail.buttonTitle.continue" = "Continue";
    "incdOnboarding.selfie.result.fail.buttonTitle.tryAgain" = "Try again";
    "incdOnboarding.selfie.result.fail.subtitle" = "Your selfie will be manually reviewed later";
    "incdOnboarding.selfie.hasHeadwear" = "Take your hat off";
    "incdOnboarding.selfie.hasLenses" = "Take off your glasses";
    "incdOnboarding.selfie.hasLenses.voiceOver" = "Take off your glasses";
    "incdOnboarding.selfie.login.fail" = "Access denied";
    "incdOnboarding.selfie.login.success" = "Success";
    "incdOnboarding.selife.login.manualFaceNotFound" = "Face not detected";
    "incdOnboarding.selfie.login.userNotFound" = "User not found";
    "incdOnboarding.selfie.lookAtTheCamera" = "Align your face within the white silhouette";
    "incdOnboarding.selfie.lookAtTheCameraManual" = "Align your face within the silhouette and press the button";
    "incdOnboarding.selfie.faceNotFound" = "Align your face within the silhouette and look at the camera";
    "incdOnboarding.selfie.ageAssurance.lookAtTheCamera" = "Look at the camera to estimate your age";
    "incdOnboarding.selfie.multipleFacesFound" = "Make sure you are the only person in the frame";
    "incdOnboarding.selfie.spoofDetected" = "Poor conditions for selfie,\ntry in another place";
    "incdOnboarding.selfie.tooBlurry" = "Too blurry";
    "incdOnboarding.selfie.tooBlurry.voiceOver" = "Image not focused, adjust";
    "incdOnboarding.selfie.tooClose" = "Move away";
    "incdOnboarding.selfie.tooClose.voiceOver" = "Move phone further, please";
    "incdOnboarding.selfie.tooDark" = "Too dark. Face not detected";
    "incdOnboarding.selfie.tooFar" = "Move closer";
    "incdOnboarding.selfie.tooFar.voiceOver" = "Move phone closer to you, please";
    "incdOnboarding.selfie.tryAgain" = "Try again";
    "incdOnboarding.selfie.unknown" = "Look at the camera";
    "incdOnboarding.selfie.customText" = "";
    "incdOnboarding.selfie.audioRecordingPermissionsDeclined" = "Audio permissions declined.";
    "incdOnboarding.selfieTips.subtitle" = "Keep a neutral expression, find balanced light and remove any glasses and hats";
    "incdOnboarding.selfieTips.title" = "Let's take a selfie";
    "incdOnboarding.selfieTips.voiceOver" = "Place your phone by arm distance in front of your face, and the image will be taken automatically";
    "incdOnboarding.selfieTips.ageAssurance.title" = "Age Verification";
    "incdOnboarding.selfieTips.ageAssurance.subtitle" = "Please take a selfie to estimate your age, your data is private, your face is not stored or shared";
    "incdOnboarding.selfieTips.ageAssurance.footer" = "Keep a neutral expression, find balanced light and remove any glasses and hats";
    "incdOnboarding.faceAuthentication.processingFailed.title" = "Selfie processing failed";
    "incdOnboarding.faceAuthentication.processingFailed.subtitle" = "We couldn't process your selfie. Please try again";
    "incdOnboarding.faceAuthentication.hasLenses.title" = "Lenses detected";
    "incdOnboarding.faceAuthentication.hasLenses.subtitle" = "Take off your glasses to ensure a clear capture";
    "incdOnboarding.faceAuthentication.hasFaceMask.title" = "Face mask detected";
    "incdOnboarding.faceAuthentication.hasFaceMask.subtitle" = "Take off your mask to ensure a clear capture";
    "incdOnboarding.faceAuthentication.hasHeadCover.title" = "Head covered";
    "incdOnboarding.faceAuthentication.hasHeadCover.subtitle" = "Remove head coverings such as hats and caps";
    "incdOnboarding.faceAuthentication.closedEyes.title" = "Eyes closed";
    "incdOnboarding.faceAuthentication.closedEyes.subtitle" = "Keep your eyes open during the capture";
    "incdOnboarding.faceAuthentication.tooDark.title" = "Too dark";
    "incdOnboarding.faceAuthentication.tooDark.subtitle" = "Adjust the lighting or move closer to a light source";
    "incdOnboarding.faceAuthentication.lowQuality.title" = "Low quality conditions";
    "incdOnboarding.faceAuthentication.lowQuality.subtitle" = "Stay still for the capture, and make sure your face is clear and visible";
    "incdOnboarding.faceAuthentication.notAligned.title" = "Face not aligned";
    "incdOnboarding.faceAuthentication.notAligned.subtitle" = "Make sure you align your face with the white silhouette";
    "incdOnboarding.faceAuthentication.faceOccluded.title" = "Face covered";
    "incdOnboarding.faceAuthentication.faceOccluded.subtitle" = "Make sure your face is clear and visible";
    "incdOnboarding.signature.btnClear" = "Clear canvas";
    "incdOnboarding.signature.title" = "Digital signature";
    "incdOnboarding.signature.description" = "Please sign in the box below to create your digital signature for signing the document.";
    "incdOnboarding.signature.signDocument.acceptButton" = "Sign And Continue";
    "incdOnboarding.signature.signDocument.declineButton" = "I don’t want to sign";
    "incdOnboarding.signature.signDocument.dialog.dontSign" = "Don't sign";
    "incdOnboarding.signature.signDocument.dialog.message" = "To be able to continue please sign the documents";
    "incdOnboarding.signature.signDocument.dialog.sign" = "Sign";
    "incdOnboarding.signature.signDocument.dialog.title" = "Signature is required";
    "incdOnboarding.signature.signHere" = "Please sign here";
    "incdOnboarding.signature.success" = "Signed successfully!";
    "incdOnboarding.stepUp.invalidDigits" = "Invalid last 4 digits";
    "incdOnboarding.stepUp.title" = "Enter last 4 digits of your phone";
    "incdOnboarding.screenRecordingsUpload.title" = "All good, one more thing";
    "incdOnboarding.screenRecordingsUpload.uploadCell.title" = "Session upload";
    "incdOnboarding.screenRecordingsUpload.uploadCell.subtitle" = "Uploading %@%%";
    "incdOnboarding.tips.continueButton" = "CONTINUE";
    "incdOnboarding.userConsent.acceptBtn" = "I Agree";
    "incdOnboarding.userConsent.checkboxLabel" = "I have read and agree to Incode’s [Privacy Policy](https://policies.incodesmile.com/privacy-policy/) and Incode’s [Terms of Use](https://policies.incodesmile.com/terms-of-use/).";
    "incdOnboarding.userConsent.dialog.continue" = "Continue";
    "incdOnboarding.userConsent.dialog.quitProcess" = "Quit";
    "incdOnboarding.userConsent.defaultTitle" = "Consent for Biometric Processing";
    "incdOnboarding.userConsent.defaultSubtitle" = "I consent to the capture, collection, enrollment, use, retention, processing, and disclosure of a scan of my face geometry (i.e. faceprint) and information derived from the barcode of the identification card I provide as follows:<br>
    <br>
    - **Purpose:** verifying my identity pursuant to Incode’s [Privacy Policy](https://policies.incodesmile.com/privacy-policy/)<br>
    <br>
    - **Data Collected:** facial geometry/faceprint/image; data contained in/obtained by scanning the barcode of a government-issued identification card provided by me (including, e.g., name, address, DOB, license type, sex, height, weight, eye color, ID number)<br>
    <br>
    - **Retention Period:** earliest of: (i) so long as necessary for identity verification purposes; or (ii) stated [Data Retention Period](https://policies.incodesmile.com/privacy-policy/#data-retention) (e.g. IL (3 yrs following last engagement), TX (1 yr following exhaustion of purpose)).";
    "incdOnboarding.videoSelfie.audioPermission.allowPermission" = "Allow permission";
    "incdOnboarding.videoSelfie.audioPermission.askTitle" = "We need your verbal confirmation of accepting the terms that require Microphone Permission";
    "incdOnboarding.videoSelfie.audioPermission.askTitleBold" = "Microphone Permission";
    "incdOnboarding.videoSelfie.audioPermission.continue" = "Continue";
    "incdOnboarding.videoSelfie.audioPermission.deniedTitle" = "We need your verbal confirmation that require Microphone Permission";
    "incdOnboarding.videoSelfie.audioPermission.deniedTitleBold" = "Microphone Permission";
    "incdOnboarding.videoSelfie.authorization.authorize" = "I authorize";
    "incdOnboarding.videoSelfie.authorization.dontAuthorize" = "Don’t authorize";
    "incdOnboarding.videoSelfie.authorization.title" = "Do you authorize %@\nto record you to validate\nyour information?";
    "incdOnboarding.videoSelfie.screenRecordingDenied.subtitle" = "All the progress will be lost.";
    "incdOnboarding.videoSelfie.screenRecordingDenied.quit" = "Quit";
    "incdOnboarding.videoSelfie.screenRecordingDenied.goBack" = "Go Back";
    "incdOnboarding.videoSelfie.btnContinue" = "CONTINUE";
    "incdOnboarding.videoSelfie.btnContinueUnderlined" = "Continue";
    "incdOnboarding.videoSelfie.btnTryAgain" = "TRY AGAIN";
    "incdOnboarding.videoSelfie.id.detected" = "All good!";
    "incdOnboarding.videoSelfie.id.frontFaceMatchFailed" = "ID photo verification failed, please try again";
    "incdOnboarding.videoSelfie.id.frontFaceMatchFailed.skip" = "ID photo verification failed";
    "incdOnboarding.videoSelfie.id.frontNotValid" = "ID scan failed, please try again";
    "incdOnboarding.videoSelfie.id.frontNotValid.skip" = "ID scan failed";
    "incdOnboarding.videoSelfie.id.ocrNotValid" = "Name verification failed, please try again";
    "incdOnboarding.videoSelfie.id.ocrNotValid.skip" = "Name verification failed";
    "incdOnboarding.videoSelfie.id.processing" = "Processing…";
    "incdOnboarding.videoSelfie.id.openingCamera" = "Opening camera…";
    "incdOnboarding.videoSelfie.id.showBack" = "Now show back of ID";
    "incdOnboarding.videoSelfie.id.showFront" = "Show front of ID";
    "incdOnboarding.videoSelfie.id.showPassport" = "Show passport page with photo";
    "incdOnboarding.videoSelfie.id.typeMatchFailed" = "ID type mismatch, please show the same ID";
    "incdOnboarding.videoSelfie.id.typeMatchFailed.skip" = "ID type mismatch";
    "incdOnboarding.videoSelfie.idScan.scanFailed.retry" = "ID scan failed, try again";
    "incdOnboarding.videoSelfie.idScan.scanFailed.exhausted" = "ID scan failed";
    "incdOnboarding.videoSelfie.idScan.photoVerificationFailed.retry" = "ID photo verification failed, try again";
    "incdOnboarding.videoSelfie.idScan.photoVerificationFailed.exhausted" = "ID photo verification failed";
    "incdOnboarding.videoSelfie.idScan.typeMismatch.retry" = "ID type mismatch, show the same ID";
    "incdOnboarding.videoSelfie.idScan.typeMismatch.exhausted" = "ID type mismatch";
    "incdOnboarding.videoSelfie.idScan.nameVerificationFailed.retry" = "Name verification failed, try again";
    "incdOnboarding.videoSelfie.idScan.nameVerificationFailed.exhausted" = "Name verification failed";
    "incdOnboarding.videoSelfie.poa.documentDescription" = "Proof of Address";
    "incdOnboarding.videoSelfie.poa.title" = "Show your %@\nand then press Continue";
    "incdOnboarding.videoSelfie.questions.tapToAnswer" = "Tap to answer";
    "incdOnboarding.videoSelfie.questions.tapWhenDone" = "Tap when done";
    "incdOnboarding.videoSelfie.questions.tapToSpeak" = "Tap to speak";
    "incdOnboarding.videoSelfie.questions.answerOutLoud" = "Please answer out loud";
    "incdOnboarding.videoSelfie.questions.sayOutLoud" = "Please say out loud";
    "incdOnboarding.videoSelfie.questions.onceAnsweredTap" = "Once you’ve answered tap continue:";
    "incdOnboarding.videoSelfie.questions.start.readyButton" = "IM READY TO ANSWER";
    "incdOnboarding.videoSelfie.questions.start.title" = "We need you to verbally confirm that you accept the terms";
    "incdOnboarding.videoSelfie.questions.terms.error.suggestion1" = "Be in a place with less ambient noise";
    "incdOnboarding.videoSelfie.questions.terms.error.suggestion2" = "Preferably use the microphone of your headphones";
    "incdOnboarding.videoSelfie.questions.terms.error.suggestion3" = "Be very clear with the pronunciation";
    "incdOnboarding.videoSelfie.questions.terms.error.title" = "Something went wrong";
    "incdOnboarding.videoSelfie.questions.terms.onceAnsweredTap" = "Once you’ve accepted tap continue:";
    "incdOnboarding.videoSelfie.questions.terms.processing" = "Processing…";
    "incdOnboarding.videoSelfie.questions.terms.success" = "All good!";
    "incdOnboarding.videoSelfie.questions.terms.title" = "Say\n“%@”\nout loud";
    "incdOnboarding.videoSelfie.questions.terms.title.default" = "I accept the terms";
    "incdOnboarding.videoSelfie.selfie.continueWithError" = "Continuing the flow, please wait…";
    "incdOnboarding.videoSelfie.selfie.error" = "Something wrong, try again";
    "incdOnboarding.videoSelfie.selfie.faceCamera" = "Face the camera";
    "incdOnboarding.videoSelfie.selfie.faceNotRecognized" = "No match, try again";
    "incdOnboarding.videoSelfie.selfie.faceRecognized" = "Looking good!";
    "incdOnboarding.videoSelfie.selfie.processing" = "Processing…";
    "incdOnboarding.videoSelfie.selfie.analyzing" = "Analyzing…";
    "incdOnboarding.videoSelfie.tutorial.continueButton" = "Start video selfie";
    "incdOnboarding.videoSelfie.tutorial.subtitle" = "For legal reasons, we must recheck your documents. You'll be requested to:";
    "incdOnboarding.videoSelfie.tutorial.title" = "Video selfie";
    "incdOnboarding.videoSelfie.tutorial.step.selfie" = "Look at your front camera";
    "incdOnboarding.videoSelfie.tutorial.step.idFront" = "Scan the front of ID";
    "incdOnboarding.videoSelfie.tutorial.step.idBack" = "Scan the back of ID";
    "incdOnboarding.videoSelfie.tutorial.step.passport" = "Scan the passport";
    "incdOnboarding.videoSelfie.tutorial.step.poa" = "Scan your proof of address";
    "incdOnboarding.videoSelfie.tutorial.step.recordingPermissions" = "Give recording permissions";
    "incdOnboarding.videoSelfie.tutorial.step.questions" = "Answer some questions out loud";
    "incdOnboarding.videoSelfie.tutorial.step.voiceConsent" = "Speak words displayed on the screen";
    "incdOnboarding.videoSelfie.tutorial.step.handGesture" = "Wave your hand across your face";
    "incdOnboarding.videoSelfie.handGesture.instruction" = "Wave your hand across each side of your face";
    "incdOnboarding.videoSelfie.headTurn.up" = "Turn your head upwards";
    "incdOnboarding.videoSelfie.headTurn.down" = "Turn your head downwards";
    "incdOnboarding.videoSelfie.headTurn.left" = "Turn your head to the left";
    "incdOnboarding.videoSelfie.headTurn.right" = "Turn your head to the right";
    "incdOnboarding.videoSelfie.alignFace" = "Align face to frame";
    "incdOnboarding.videoSelfie.turn.right" = "Turn right";
    "incdOnboarding.videoSelfie.turn.left" = "Turn left";
    "incdOnboarding.videoSelfie.videoUpload.error" = "Something went wrong";
    "incdOnboarding.videoSelfie.videoUpload.success" = "Video Successfully Uploaded";
    "incdOnboarding.videoSelfie.videoUpload.uploading" = "Uploading video…";
    "incdOnboarding.videoSelfie.videoUpload.switchingToBackCamera" = "Switching to back camera…";
    "incdOnboarding.videoSelfie.videoUpload.switchingToFrontCamera" = "Switching to front camera…";
    "incdOnboarding.videoSelfie.customText" = "";
    "incdOnboarding.videoSelfie.recordingPermissions.title1" = "For legal reasons, we need you to";
    "incdOnboarding.videoSelfie.recordingPermissions.title2" = "Allow Record Screen & Microphone";
    "incdOnboarding.videoSelfie.recordingPermissions.title2disabledAudio" = "Allow Record Screen";
    "incdOnboarding.videoSelfie.voiceConsent.recording" = "Recording…";
    "incdOnboarding.videoSelfie.voiceConsent.reminderTitle" = "Finished speaking?";
    "incdOnboarding.videoSelfie.voiceConsent.reminderInfo" = "Did you say \"I accept the Terms\"? If you haven’t, please try again";
    "incdOnboarding.videoSelfie.voiceConsent.reminderConfirmation" = "Yes, I'm done";
    "incdOnboarding.videoSelfie.voiceConsent.reminderTryAgain" = "Try again";
    "incdOnboarding.videoSelfie.voiceConsent.processing.processing" = "Processing…";
    "incdOnboarding.videoSelfie.voiceConsent.processing.allGood" = "All good!";
    "incdOnboarding.videoSelfie.voiceConsent.processing.tryAgain" = "Please, try again.";
    "incdOnboarding.videoSelfie.voiceConsent.faceCapture.prompt" = "Center your face in the frame to continue";
    "incdOnboarding.videoSelfie.voiceConsent.faceCapture.failure.faceNotDetected" = "Center your face in the frame to continue";
    "incdOnboarding.videoSelfie.voiceConsent.faceCapture.failure.notMatched" = "Faces do not match";
    "incdOnboarding.videoSelfie.processing.title" = "Processing…";
    "incdOnboarding.videoSelfie.processing.body" = "Kindly hold on and refrain from closing this, as it may take some time to finish..";
    "incdOnboarding.videoSelfie.processing.quitProcess" = "Quit process";
    "incdOnboarding.videoSelfie.processing.retry" = "Retry";
    "incdOnboarding.videoSelfie.processing.allGood" = "All good!";
    "incdOnboarding.videoSelfie.processing.somethingWentWrong" = "Something went wrong…";
    "incdOnboarding.videoSelfie.processing.noInternetConnection" = "No internet connection";
    "incdOnboarding.videoSelfie.processing.processingFailed.title" = "Processing failed…";
    "incdOnboarding.videoSelfie.processing.processingFailed.body" = "Something went wrong processing your video selfie, please try again";

    "incdOnboarding.watchlist.validation.failure" = "Couldn't process information";
    "incdOnboarding.watchlist.validation.inprogress" = "Processing information…";
    "incdOnboarding.watchlist.validation.success" = "Success";
    "incdOnboarding.mlConsent.checkboxLabel" = "I confirm that I have read and accept (optional)";
    "incdOnboarding.mlConsent.continueBtn" = "Continue";
    "incdOnboarding.snack.bar.no.internet.message" = "No internet connection";
    "incdOnboarding.snack.bar.no.internet.button" = "Retry";
    "incdOnboarding.intro.check.id" = "Valid ID or Passport";
    "incdOnboarding.intro.check.passport" = "Passport";
    "incdOnboarding.intro.check.insuranceCard" = "Valid Insurance Card";
    "incdOnboarding.intro.check.proofOfAddress" = "Recent Proof of Address";
    "incdOnboarding.intro.check.selfie" = "To take a Selfie";
    "incdOnboarding.ocr.title" = "Please check your data";
    "incdOnboarding.ocr.requiredSubTitle" = "All fields marked with * are required.";
    "incdOnboarding.ocr.documentNumber.title" = "Document number";
    "incdOnboarding.ocr.documentNumber.placeholder" = "";
    "incdOnboarding.ocr.expiryDate.title" = "Expiry date";
    "incdOnboarding.ocr.expiryDate.placeholder" = "Expiry date";
    "incdOnboarding.ocr.birthDate.title" = "Date of birth";
    "incdOnboarding.ocr.birthDate.placeholder" = "Date of birth";
    "incdOnboarding.ocr.fullName.title" = "Full name";
    "incdOnboarding.ocr.gender.title" = "Gender";
    "incdOnboarding.ocr.gender.female" = "Female";
    "incdOnboarding.ocr.gender.male" = "Male";
    "incdOnboarding.ocr.address.title" = "Address";
    "incdOnboarding.ocr.continueButton" = "Continue";
    "incdOnboarding.ocr.fieldEmptyError" = "Field can't be empty";
    "incdOnboarding.ocr.processing.title" = "Hold on a sec...";
    "incdOnboarding.ocr.processing.description" = "We're verifying your identity";
    "incdOnboarding.ocr.success.title" = "Identity successfully verified";
    "incdOnboarding.ocr.failure.title" = "Something went wrong";
    "incdOnboarding.nfc.id.symbolConfirmation.title" = "Is this symbol visible on the front or back of your ID?";
    "incdOnboarding.nfc.id.symbolConfirmation.yes" = "YES";
    "incdOnboarding.nfc.id.symbolConfirmation.no" = "NO";
    "incdOnboarding.nfc.id.tutorial.title" = "Read the chip on the ID";
    "incdOnboarding.nfc.id.tutorial.subtitle" = "Place your ID against your phone in the position shown below and hold them still.";
    "incdOnboarding.nfc.id.tutorial.instruction1.title" = "1. Hold the ID against the camera.";
    "incdOnboarding.nfc.id.tutorial.instruction1.highlighted" = "against the camera";
    "incdOnboarding.nfc.id.tutorial.instruction2.title" = "2. Make sure your ID and phone are touching.";
    "incdOnboarding.nfc.id.tutorial.instruction2.highlighted" = "touching";
    "incdOnboarding.nfc.id.tutorial.instruction3.title" = "3. Hold still until scanning is complete.";
    "incdOnboarding.nfc.id.tutorial.instruction3.highlighted" = "Hold still";
    "incdOnboarding.nfc.id.tutorial.scanButtonTitle" = "Start scanning";
    "incdOnboarding.nfc.id.tutorial.tryAgainButtonTitle" = "Try again";
    "incdOnboarding.nfc.id.tutorial.helpButtonTitle" = "Help";
    "incdOnboarding.nfc.id.help.title" = "Common issues";
    "incdOnboarding.nfc.id.help1" = "Phone is far away from the document";
    "incdOnboarding.nfc.id.help2" = "Moving the phone while scanning has initiated";
    "incdOnboarding.nfc.id.help3" = "Phone cover interferes with the scan";
    "incdOnboarding.nfc.id.help.tryAgainButton" = "Ok, try again";
    "incdOnboarding.nfc.passport.symbolConfirmation.title" = "Is this symbol visible on your passport cover?";
    "incdOnboarding.nfc.passport.symbolConfirmation.yes" = "YES";
    "incdOnboarding.nfc.passport.symbolConfirmation.no" = "NO";
    "incdOnboarding.nfc.passport.tutorial.title" = "Let’s scan your passport chip";
    "incdOnboarding.nfc.passport.tutorial.subtitle" = "Hold your phone close to the front cover.";
    "incdOnboarding.nfc.passport.tutorial.subtitleHighlighted" = "front cover.";
    "incdOnboarding.nfc.passport.tutorial.buttonTitle" = "Start scanning";
    "incdOnboarding.nfc.passport.carouselTutorial.helpButtonTitle" = "Help";
    "incdOnboarding.nfc.passport.carouselTutorial.page1.title" = "Let’s try again";
    "incdOnboarding.nfc.passport.carouselTutorial.page2.title" = "Scan the first page";
    "incdOnboarding.nfc.passport.carouselTutorial.page3.title" = "Scan the photo page";
    "incdOnboarding.nfc.passport.carouselTutorial.page4.title" = "Scan the back page";
    "incdOnboarding.nfc.passport.carouselTutorial.page1.subtitle" = "Remove your passport from any folder or cover, then hold your phone close to the front cover.";
    "incdOnboarding.nfc.passport.carouselTutorial.page2.subtitle" = "Slowly move your phone across the first page of your passport.";
    "incdOnboarding.nfc.passport.carouselTutorial.page3.subtitle" = "Slowly move your phone across the photo page of your passport.";
    "incdOnboarding.nfc.passport.carouselTutorial.page4.subtitle" = "Slowly move your phone across the inner back page of your passport.";
    "incdOnboarding.nfc.passport.carouselTutorial.page1.subtitle.highlighted" = "front cover";
    "incdOnboarding.nfc.passport.carouselTutorial.page2.subtitle.highlighted" = "first page";
    "incdOnboarding.nfc.passport.carouselTutorial.page3.subtitle.highlighted" = "photo page";
    "incdOnboarding.nfc.passport.carouselTutorial.page4.subtitle.highlighted" = "inner back";
    "incdOnboarding.nfc.passport.carouselTutorial.tryAgainButton" = "Try again";
    "incdOnboarding.nfc.passport.help.title" = "Common Issues";
    "incdOnboarding.nfc.passport.help1" = "Passport is in a cover";
    "incdOnboarding.nfc.passport.help2" = "Phone is far away from the passport";
    "incdOnboarding.nfc.passport.help3" = "Chip is on another page in the passport";
    "incdOnboarding.nfc.passport.help4" = "Moving the phone while scanning has initiated";
    "incdOnboarding.nfc.passport.help5" = "Phone cover interferes with the scan";
    "incdOnboarding.nfc.passport.help.tryAgainButton" = "Ok, try again";
    "incdOnboarding.nfc.scan.waitingForDocument" = "Once you see a change on the screen, keep the phone steady";
    "incdOnboarding.nfc.scan.reading" = "Processing, don’t move your phone";
    "incdOnboarding.nfc.scan.error" = "We couldn't scan the chip";
    "incdOnboarding.nfc.scan.successfulRead" = "Successfully scanned!";
    "incdOnboarding.nfc.scanning.scanning.title" = "Scanning..";
    "incdOnboarding.nfc.scanning.done.title" = "Done";
    "incdOnboarding.nfc.scanning.subtitle" = "Hold your phone steady until reading is finished";
    "incdOnboarding.nfc.scanning.holdStill" = "Hold still..";
    "incdOnboarding.nfc.success.title" = "Identity successfully verified";
    "incdOnboarding.nfc.processing.success" = "Document chip scan success";
    "incdOnboarding.nfc.processing.fail" = "Unable to authenticate document chip";
    "incdOnboarding.nfc.processing.description" = "We’re verifying your identity";
    "incdOnboarding.nfc.processing.status" = "Hold on a sec..";
    "incdOnboarding.nfc.processing.authentication" = "Authenticating…";
    "incdOnboarding.nfc.error.systemUnavailable.title" = "We’re sorry, you’re unable to continue the process";
    "incdOnboarding.nfc.error.systemUnavailable.subtitle" = "Only devices with NFC are allowed";
    "incdOnboarding.nfc.result.fail.message" = "Unable to authenticate chip";
    "incdOnboarding.nfc.result.fail.buttonTitle" = "Continue";
    "incdOnboarding.otp.verification.sms.title" = "Verify your phone number";
    "incdOnboarding.otp.verification.email.title" = "Verify your email address";
    "incdOnboarding.otp.verification.sms.subtitle" = "Please enter the code we’ve sent via SMS";
    "incdOnboarding.otp.verification.email.subtitle" = "Please enter the code we’ve sent via Email";
    "incdOnboarding.otp.verification.verifying" = "Verifying..";
    "incdOnboarding.otp.verification.code.incorrect" = "Incorrect code, please try again.";
    "incdOnboarding.otp.verification.try.again1" = "Didn’t receive the code? ";
    "incdOnboarding.otp.verification.try.again2" = "Try again in %.0f seconds";
    "incdOnboarding.otp.verification.try.again.button" = "Try again";
    "incdOnboarding.otp.verification.try.again.or.label" = "or";
    "incdOnboarding.otp.verification.change.phone.button" = "Change phone number";
    "incdOnboarding.otp.verification.change.email.button" = "Change email";
    "incdOnboarding.ekyb.input.title" = "Fill out your business credentials";
    "incdOnboarding.ekyb.input.businessName" = "Business name";
    "incdOnboarding.ekyb.input.address1" = "Street";
    "incdOnboarding.ekyb.input.address2" = "Address 2 (optional)";
    "incdOnboarding.ekyb.input.houseNo" = "House No.";
    "incdOnboarding.ekyb.input.city" = "City";
    "incdOnboarding.ekyb.input.state" = "State";
    "incdOnboarding.ekyb.input.postalCode" = "Postal code";
    "incdOnboarding.ekyb.input.taxId" = "Tax Id";
    "incdOnboarding.ekyb.input.country" = "Country";
    "incdOnboarding.ekyb.input.button" = "Continue";
    "incdOnboarding.ekyb.status.label.processing" = "Processing..";
    "incdOnboarding.ekyb.input.label.success" = "Success!";
    "incdOnboarding.ekyb.input.label.fail" = "Business not verified..";
    "incdOnboarding.aes.acceptSign.title" = "Accept and sign";
    "incdOnboarding.aes.acceptSign.subtitle" = "Please accept the terms below to complete your signature.";
    // Name of the document card. A single document uses "name"; several documents are numbered with "namePosition".
    "incdOnboarding.aes.document.name" = "Contract.pdf";
    "incdOnboarding.aes.document.namePosition" = "Contract %ld.pdf";
    "incdOnboarding.aes.document.view" = "View";
    "incdOnboarding.aes.downloadPdf" = "Download PDF";
    // Shown on the success screen when the AES module is configured with `downloadDocument`.
    "incdOnboarding.aes.downloadDocument" = "Download document";
    "incdOnboarding.aes.finishSigning" = "Finish signing";
    "incdOnboarding.aes.success.continue" = "Continue";
    "incdOnboarding.aes.success.title" = "Signed successfully!";
    // The three consent checkbox labels on the Accept & Sign screen, in the order they are rendered.
    // All of them have to be accepted before signing unlocks.
    "incdOnboarding.aes.terms1.title" = "I accept the Terms and Conditions of the [Trust Center](https://psc.incode.com/repositorio/).";
    "incdOnboarding.aes.terms2.title" = "I request to sign this contract electronically and to have the required digital certificate issued to me.";
    "incdOnboarding.aes.terms3.title" = "I confirm that I wish to sign this contract in a legally binding manner using the applicable electronic signature procedures.";
    "incdOnboarding.aes.confirmSignature.title" = "Confirm your signature";
    "incdOnboarding.aes.confirmSignature.subtitle" = "The following documents will be signed";
    "incdOnboarding.aes.confirmSignature.continue" = "Continue";
    "incdOnboarding.aes.confirmSignature.continueAndFinish" = "Continue and finish";
    "incdOnboarding.aes.confirmedSignature.title" = "Confirmed your signature";
    "incdOnboarding.aes.confirmedSignature.subtitle" = "The following documents were signed";
    "incdOnboarding.aes.viewDocument" = "View doc";
    "incdOnboarding.aes.result.success" = "Success!";
    "incdOnboarding.aes.result.failure" = "Something went wrong.";
    "incdOnboarding.aes.loading.title" = "Document signing in progress. Please wait, this may take some time.";
    "incdOnboarding.aes.pdfView.title" = "Contract";
    "incdOnboarding.aes.pdfView.close" = "Close";
    "incdOnboarding.ekyc.input.title" = "eKYC Verification";
    "incdOnboarding.ekyc.input.label.firstName" = "First Name";
    "incdOnboarding.ekyc.input.label.surname" = "Surname";
    "incdOnboarding.ekyc.input.label.email" = "Email";
    "incdOnboarding.ekyc.input.label.phone" = "Phone";
    "incdOnboarding.ekyc.input.label.street" = "Street";
    "incdOnboarding.ekyc.input.label.postalCode" = "Postal code";
    "incdOnboarding.ekyc.input.label.city" = "City";
    "incdOnboarding.ekyc.input.label.addressCountry" = "Country";
    "incdOnboarding.ekyc.input.label.state" = "State";
    "incdOnboarding.ekyc.input.label.ssn" = "Social security number";
    "incdOnboarding.ekyc.input.label.dateOfBirth" = "Date of birth";
    "incdOnboarding.ekyc.input.label.cpf" = "CPF";
    "incdOnboarding.ekyc.input.validation.phoneFormatNotValid" = "Invalid phone format";
    "incdOnboarding.ekyc.input.validation.phoneRequired" = "Phone is required";
    "incdOnboarding.ekyc.input.validation.emailFormatNotValid" = "Invalid email format";
    "incdOnboarding.ekyc.input.validation.firstNameRequired" = "Name is required";
    "incdOnboarding.ekyc.input.validation.surnameRequired" = "Surname is required";
    "incdOnboarding.ekyc.input.validation.emailRequired" = "Email is required";
    "incdOnboarding.ekyc.input.validation.streetRequired" = "Street is required";
    "incdOnboarding.ekyc.input.validation.cityRequired" = "City is required";
    "incdOnboarding.ekyc.input.validation.houseRequired" = "House number is required";
    "incdOnboarding.ekyc.input.validation.postalCodeIsRequired" = "Postal code is required";
    "incdOnboarding.ekyc.input.validation.postalCodeLimitUS" = "Please enter a 5 or 9 digit Postal Code";
    "incdOnboarding.ekyc.input.validation.postalCodeLimitBrasil" = "Please enter a 5 or 8 digit Postal Code";
    "incdOnboarding.ekyc.input.validation.stateRequired" = "State is required";
    "incdOnboarding.ekyc.input.validation.ssnRequired" = "SSN is required";
    "incdOnboarding.ekyc.input.validation.ssnFormatNotValid" = "Please enter a valid number";
    "incdOnboarding.ekyc.input.validation.dobRequired" = "Date of birth is required";
    "incdOnboarding.ekyc.input.validation.countryRequired" = "Country is required";
    "incdOnboarding.ekyc.input.label.nationality" = "Nationality";
    "incdOnboarding.ekyc.input.selector.nationality.brazilian" = "Brazilian";
    "incdOnboarding.ekyc.input.selector.nationality.naturalizedBrazilian" = "Naturalized Brazilian";
    "incdOnboarding.ekyc.input.selector.nationality.foreigner" = "Foreigner";
    "incdOnboarding.ekyc.input.selector.nationality.brazilianbornAbroad" = "Brazilian Born Abroad";
    "incdOnboarding.ekyc.success" = "eKYC verified!";
    "incdOnboarding.processing.loading.title" = "Processing!";
    "incdOnboarding.processing.success" = "Verified!";
    "incdOnboarding.processing.failure" = "Something went wrong";
    "incdOnboarding.processing.loading.subtitle" = "This might take a while, please keep the app opened..";
    "incdOnboarding.processing.loading.success" = "Success!";
    "incdOnboarding.aes.uploadDocument.title" = "Upload a document to sign";
    "incdOnboarding.aes.uploadDocument.subtitle" = "Supports PDF files";
    "incdOnboarding.aes.uploadDocument.uploadButton" = "Upload document";
    "incdOnboarding.aes.reviewDocument.title" = "Review your document";
    "incdOnboarding.aes.reviewDocument.subtitle" = "Make sure you've selected the correct file before you continue to sign.";
    "incdOnboarding.aes.reviewDocument.replaceButton" = "Replace";
    "incdOnboarding.biometricConsent.subtitle" = "Your verification is powered by Incode. To comply with state regulations, we need your consent for biometric processing.";
    "incdOnboarding.dynamicform.requiredSubTitle" = "All fields marked with * are required.";
    "incdOnboarding.dynamicform.textview.subtitle" = "Your answer";
    "incdOnboarding.dynamicform.textview.placeholder" = "Write your answer here..";
    "incdOnboarding.dynamicform.countryPicker.title" = "What is your nationality?";
    "incdOnboarding.dynamicform.countryPicker.subTitle" = "Country";
    "incdOnboarding.dynamicform.countryPicker.placeholder" = "Search for country";
    "incdOnboarding.dynamicform.yes" = "Yes";
    "incdOnboarding.dynamicform.no" = "No";
    "incdOnboarding.dynamicform.Picker.closedPlaceholder" = "Select an option";
    "incdOnboarding.dynamicform.datePicker.placeholder" = "DD/MM/YYYY";
    "incdOnboarding.dynamicform.datePicker.invalid" = "Invalid date format";
    "incdOnboarding.dynamicform.validation.required" = "This field is required";
    "incdOnboarding.dynamicform.validation.selectOption" = "Select an option";
    "incdOnboarding.dynamicform.validation.invalidFormat" = "Invalid format";
    "incdOnboarding.dynamicform.validation.enterFullName" = "Enter your full name";
    "incdOnboarding.dynamicform.validation.enterFirstName" = "Enter your first name";
    "incdOnboarding.dynamicform.validation.enterLastName" = "Enter your last name";
    "incdOnboarding.dynamicform.validation.invalidIdNumber" = "Invalid ID number.";
    "incdOnboarding.dynamicform.validation.completeRequiredFields" = "Complete required fields to continue";
    "incdOnboarding.dynamicform.cpf.placeholder" = "CPF number";
    "incdOnboarding.dynamicform.predefinedTitle.fullName" = "Full name";
    "incdOnboarding.dynamicform.predefinedTitle.firstName" = "First name";
    "incdOnboarding.dynamicform.predefinedTitle.lastName" = "Last name";
    "incdOnboarding.dynamicform.predefinedTitle.country" = "Country of residence";
    "incdOnboarding.dynamicform.predefinedTitle.dateOfBirth" = "Date of birth";
    "incdOnboarding.dynamicform.predefinedTitle.phone" = "Phone number";
    "incdOnboarding.dynamicform.predefinedTitle.email" = "Email address";
    "incdOnboarding.dynamicform.predefinedTitle.nationality" = "Nationality";
    "incdOnboarding.dynamicform.predefinedTitle.idNumber" = "ID number";
    "incdOnboarding.dynamicform.predefinedTitle.cpf" = "CPF";
    "incdOnboarding.dynamicform.result.success" = "Success!";
    "incdOnboarding.dynamicform.result.failure" = "Something went wrong";

     // The five consent checkbox labels on the Accept & Sign screen, in the order they are rendered.
    // All of them have to be accepted before signing unlocks.
    "incdOnboarding.qes.consent.qualifiedCertificate" = "I agree to the issuance of a Qualified Certificate for electronic signatures by Incode Czech Republic s.r.o., acting as a Qualified Trust Service Provider (QTSP).";
    "incdOnboarding.qes.consent.legalEffect" = "I acknowledge that this process will result in a Qualified Electronic Signature (QES), which has the same legal effect as a handwritten signature under EU law (eIDAS, Regulation (EU) 910/2014).";
    "incdOnboarding.qes.consent.qscd" = "I confirm that the signature is created using a Qualified Signature Creation Device (QSCD) and that I maintain exclusive control over the signing process.";
    "incdOnboarding.qes.consent.termsPrivacy" = "I have read, understood, and agree to the [Terms of Use](https://policies.incodesmile.com/terms-of-use/) and [Privacy Policy](https://policies.incodesmile.com/omni-privacy-mobile/) applicable to the issuance and use of this certificate.";
    "incdOnboarding.qes.consent.reviewedDocuments" = "I confirm that I have reviewed the documents to be signed listed above before proceeding with the signature.";
    // Name of the document card. A single document uses "name"; several documents are numbered with "namePosition".
    "incdOnboarding.qes.document.name" = "Contract.pdf";
    "incdOnboarding.qes.document.namePosition" = "Contract %ld.pdf";
    "incdOnboarding.qes.document.view" = "View";
    "incdOnboarding.qes.acceptSign.title" = "Accept and sign";
    "incdOnboarding.qes.acceptSign.subtitle" = "Please accept the terms below to complete your signature";
    "incdOnboarding.qes.finishSigning" = "Finish signing";
    "incdOnboarding.qes.success.title" = "Signed successfully!";
    "incdOnboarding.qes.success.continue" = "Continue";
    "incdOnboarding.qes.downloadPdf" = "Download PDF";
    // Heading of the failure screen shown when the signing attempt itself failed. A failure before that step uses "incdOnboarding.global.error.generic.title" instead.
    "incdOnboarding.qes.error.signatureFailed.title" = "Signature failed";

    // QES - provider (Namirial, provider code QES_3) Review & Sign, signing and success screens.
    // The three consent checkbox labels on this screen are served by the backend and are not
    // localizable through this file.
    "incdOnboarding.qes.reviewSign.title" = "Review and sign";
    "incdOnboarding.qes.reviewSign.subtitle" = "A qualified certificate will be issued in your name to create your signature";
    "incdOnboarding.qes.sign" = "Sign";
    "incdOnboarding.qes.creatingSignature" = "Creating your signature…";
    "incdOnboarding.qes.signingAs" = "Signing as %@";
    "incdOnboarding.qes.signedBy" = "Signed by %1$@ · %2$@";
    "incdOnboarding.qes.signedAt" = "Signed · %@";
    "incdOnboarding.qes.success.done" = "Done";
    "incdOnboarding.qes.downloadDocument" = "Download document";
    "incdOnboarding.qes.certificateApplicationForm" = "Certificate application form";

    // - New Capture Experience

    // Global
    "incdOnboarding.verifiedBy" = "verified by";

    // ID Wallet
    "incdOnboarding.id.wallet.error.title" = "Couldn't verify your ID";

    // IDDocumentSelection
    "incdOnboarding.idDocumentSelection.title" = "Select how to verify";
    "incdOnboarding.idDocumentSelection.id.title" = "Identity Card";
    "incdOnboarding.idDocumentSelection.passport.title" = "Passport";
    "incdOnboarding.idDocumentSelection.digitalID.title" = "Upload Digital ID";
    "incdOnboarding.idDocumentSelection.appleWallet.title" = "Apple Wallet";
    "incdOnboarding.idDocumentSelection.tag.instant" = "Instant";

    // IDDocumentTutorial
    "incdOnboarding.idDocumentTutorial.id.title" = "Show the front of your ID";
    "incdOnboarding.idDocumentTutorial.id.back.title" = "Show the back of your ID";
    "incdOnboarding.idDocumentTutorial.id.subtitle" = "Ensure your ID is readable";
    "incdOnboarding.idDocumentTutorial.passport.title" = "Scan your Passport";
    "incdOnboarding.idDocumentTutorial.passport.subtitle" = "Ensure your Passport is readable";
    "incdOnboarding.idDocumentTutorial.hint" = "The capture will happen automatically";
    "incdOnboarding.idDocumentTutorial.button" = "Let's scan";

    //IDDocumentPickerTutorial
    "incdOnboarding.idDocumentTutorial.digitalID.title" = "Upload Digital ID";
    "incdOnboarding.idDocumentTutorial.digitalID.subtitle" = "A government-issued PDF file with your details, picture and a QR code";
    "incdOnboarding.idDocumentTutorial.digitalID.button" = "Upload PDF";

    //IDDocumentPickerReview
    "incdOnboarding.idDocumentPickerReview.title" = "Review document";
    "incdOnboarding.idDocumentPickerReview.subtitle" = "Make sure this is the correct file before you continue verification process.";
    "incdOnboarding.idDocumentPickerReview.replaceFile" = "Replace file";
    "incdOnboarding.idDocumentPicker.fileTooLarge.title" = "File is too large";
    "incdOnboarding.idDocumentPicker.fileTooLarge.subtitle" = "The selected file is larger than 5 MB, please upload a smaller one";
    "incdOnboarding.idDocumentPicker.fileTooLarge.button" = "Choose another file";

    // IDDocumentPermission
    "incdOnboarding.IDDocumentPermission.initial.title" = "Allow camera access";
    "incdOnboarding.IDDocumentPermission.initial.subtitle" = "This lets you take a photo of your ID and face for verification purposes.";
    "incdOnboarding.IDDocumentPermission.initial.button.allow" = "Allow";
    "incdOnboarding.IDDocumentPermission.initial.button.deny" = "Don't allow";

    "incdOnboarding.IDDocumentPermission.learnMore.title" = "Camera permission is required";
    "incdOnboarding.IDDocumentPermission.learnMore.tip1" = "We only use the camera to capture your ID for secure verification";
    "incdOnboarding.IDDocumentPermission.learnMore.tip2" = "It helps verify document authenticity and prevent identity fraud";
    "incdOnboarding.IDDocumentPermission.learnMore.tip3" = "We protect your data, and it is only used for verification";
    "incdOnboarding.IDDocumentPermission.learnMore.tip4" = "This is required to verify your identity";
    "incdOnboarding.IDDocumentPermission.learnMore.button.allow" = "Allow permission";

    "incdOnboarding.IDDocumentPermission.denied.title" = "Allow %@ to access your camera";
    "incdOnboarding.IDDocumentPermission.denied.subtitle" = "This lets you capture your documents in\norder to complete the process";

    // IDRealTimeFeedback
    "incdOnboarding.IDRealTimeFeedback.blurry.title" = "ID too blurry";
    "incdOnboarding.IDRealTimeFeedback.blurry.subtitle" = "Zoom in and out, or tap on the ID";
    "incdOnboarding.IDRealTimeFeedback.glare.title" = "ID with glare";
    "incdOnboarding.IDRealTimeFeedback.glare.subtitle" = "Find a better lighting to avoid reflections";
    "incdOnboarding.IDRealTimeFeedback.frontSide.title" = "Show the back of ID";
    "incdOnboarding.IDRealTimeFeedback.frontSide.subtitle" = "Flip your ID to show its reverse side";
    "incdOnboarding.IDRealTimeFeedback.backSide.title" = "Show the front of ID";
    "incdOnboarding.IDRealTimeFeedback.backSide.subtitle" = "Flip your ID to show its front side";
    "incdOnboarding.IDRealTimeFeedback.align.title" = "ID is not aligned";
    "incdOnboarding.IDRealTimeFeedback.align.subtitle" = "Center your ID inside the frame";
    "incdOnboarding.IDRealTimeFeedback.tooDark.title" = "Image too dark";
    "incdOnboarding.IDRealTimeFeedback.tooDark.subtitle" = "Find a place with better lighting";

    // IDCaptureHelp
    "incdOnboarding.IDCaptureHelp.switchToManualCapture" = "Take the photo manually";
    "incdOnboarding.IDCaptureHelp.switchToAutomaticCapture" = "Take the photo automatically";

    // IDCaptureHeader
    "incdOnboarding.IDCaptureHeader.running.title.id.front" = "Frame the front of your ID";
    "incdOnboarding.IDCaptureHeader.running.title.id.back" = "Frame the back of your ID";
    "incdOnboarding.IDCaptureHeader.running.title.passport" = "Fill the frame with your Passport";
    "incdOnboarding.IDCaptureHeader.running.subtitle" = "The capture will happen automatically";
    "incdOnboarding.IDCaptureHeader.capturing.title" = "Taking photo…";
    "incdOnboarding.IDCaptureHeader.capturing.subtitle" = "Don't move your ID for a few seconds";
    // Shown in place of the countdown while the capture-result preview is active.
    "incdOnboarding.IDCaptureHeader.optimizing.title" = "Successfully captured";
    "incdOnboarding.IDCaptureHeader.optimizing.subtitle" = "Optimizing your capture…";

    // IDUploadScreen
    "incdOnboarding.idCapture.analyzing.title" = "Analyzing…";
    "incdOnboarding.idCapture.analyzing.success.title" = "Successfully processed!";
    "incdOnboarding.idCapture.analyzing.success.captureOnlyTitle" = "Successfully captured!";
    "incdOnboarding.idCapture.analyzing.success.frontId.subtitle" = "Now let's capture the back";
    "incdOnboarding.idCapture.analyzing.success.backId.subtitle" = "Now let's capture the front";
    "incdOnboarding.idCapture.analyzing.success.subtitle" = "Let's continue";
    "incdOnboarding.idCapture.analyzing.success.button.title" = "Scan the back";
    "incdOnboarding.idCapture.analyzing.success.button.back.title" = "Scan the front";
    "incdOnboarding.idCapture.analyzing.networkError.title" = "ID scan failed";
    "incdOnboarding.idCapture.analyzing.wrongSide.title" = "Wrong ID side captured";
    "incdOnboarding.idCapture.analyzing.wrongSide.front.subtitle" = "Capture front side of the ID";
    "incdOnboarding.idCapture.analyzing.wrongSide.back.subtitle" = "Capture back side of the ID";
    "incdOnboarding.idCapture.analyzing.glareDetected.title" = "Glare present";
    "incdOnboarding.idCapture.analyzing.glareDetected.subtitle" = "Tilt the ID slightly up or down to minimize the reflection";
    "incdOnboarding.idCapture.analyzing.blurDetected.title" = "Blur present";
    "incdOnboarding.idCapture.analyzing.blurDetected.subtitle" = "Move ID further away or closer to your phone until the image is focused";
    "incdOnboarding.idCapture.analyzing.unreadable.title" = "Info is not readable";
    "incdOnboarding.idCapture.analyzing.unreadable.subtitle" = "Minimize camera shake by holding your phone steady";
    "incdOnboarding.idCapture.analyzing.unacceptableType.title" = "ID document not accepted";
    "incdOnboarding.idCapture.analyzing.unacceptableType.subtitle" = "Scan another one from the accepted list";
    "incdOnboarding.idCapture.analyzing.unknownError.title" = "ID scan failed";
    "incdOnboarding.idCapture.analyzing.acceptedDocuments.title" = "Accepted documents for:";
    "incdOnboarding.idCapture.analyzing.acceptedDocuments.empty" = "No documents accepted\n for this country";

    // User Information
    "incdOnboarding.userInformation.email.title" = "Verify your email";
    "incdOnboarding.userInformation.email.subtitle" = "We’ll send you a code to ensure it’s yours";
    "incdOnboarding.userInformation.email.placeholder" = "Email";
    "incdOnboarding.userInformation.email.success" = "Email verified";
    "incdOnboarding.userInformation.email.wrongFormat" = "Invalid email format";

    "incdOnboarding.userInformation.fullName.title" = "Enter your name";
    "incdOnboarding.userInformation.fullName.subtitle" = "Please make sure to enter your name as shown on your ID";
    "incdOnboarding.userInformation.fullName.placeholder" = "Full name";
    "incdOnboarding.userInformation.fullName.success" = "Name verified";

    "incdOnboarding.userInformation.securityCode.title" = "Enter your security code";
    "incdOnboarding.userInformation.securityCode.placeholder" = "CVV";
    "incdOnboarding.userInformation.securityCode.success" = "Security code verified";

    "incdOnboarding.userInformation.continue" = "Continue";
    "incdOnboarding.userInformation.error" = "Something went wrong";
    "incdOnboarding.userInformation.processing" = "Processing...";
    "incdOnboarding.userInformation.retry" = "Try again";

    "incdOnboarding.otp.verification.continue" = "Continue";
    "incdOnboarding.otp.verification.resendCode" = "Resend code in %is";
    "incdOnboarding.otp.verification.email.title_v2" = "Enter the code we've sent to your email";
    "incdOnboarding.otp.verification.phone.title_v2" = "Enter the code we've sent via SMS";

    "incdOnboarding.otp.verification.email.noCode" = "Didn't receive the code? %@ or %@";
    "incdOnboarding.otp.verification.email.resend" = "Resend code";
    "incdOnboarding.otp.verification.email.change" = "Change email";
    "incdOnboarding.otp.verification.phone.change" = "Change phone number";
    "incdOnboarding.otp.verification.error" = "Something went wrong";

    // AddPhone
    "incdOnboarding.addPhone.title" = "Verify your phone number";
    "incdOnboarding.addPhone.subtitle" = "We’ll send you a code to ensure it’s yours";
    "incdOnboarding.addPhone.searchPlaceholder" = "Search for country";
    "incdOnboarding.addPhone.sna.processingTitle" = "Processing...";
    "incdOnboarding.addPhone.sna.successTitle" = "Phone verified!";
    "incdOnboarding.addPhone.sna.failTitle" = "Something went wrong";
    "incdOnboarding.addPhone.sna.tryAgainTitle" = "We couldn’t verify your request.";
    "incdOnboarding.addPhone.sna.tryAgainSubTitle" = "Please try again.";
    "incdOnboarding.addPhone.sna.tryAgainButton" = "Try again";
    "incdOnboarding.addPhone.error.addPhoneLimit" = "Add Phone Limit reached";
    "incdOnboarding.addPhone.error.invalidPhone" = "Invalid phone number";
    "incdOnboarding.addPhone.error.server" = "Add Phone error";

    // Document Capture
    "incdOnboarding.document.capture.chooser.title" = "Verify your document";
    "incdOnboarding.document.capture.chooser.subtitle" = "Take a photo or upload a PDF, JPG or PNG.";
    "incdOnboarding.document.capture.chooser.cta.continue" = "Continue";
    "incdOnboarding.document.capture.chooser.cta.capture" = "Capture document";
    "incdOnboarding.document.capture.chooser.cta.upload" = "Upload document";
    "incdOnboarding.document.capture.chooser.skip" = "Skip this step";
    "incdOnboarding.document.capture.chooser.option.capture" = "Take photo";
    "incdOnboarding.document.capture.chooser.option.imageUpload" = "Choose from camera roll";
    "incdOnboarding.document.capture.chooser.option.fileUpload" = "Choose file";

    "incdOnboarding.document.capture.camera.title" = "Show your full document";
    "incdOnboarding.document.capture.camera.subtitle" = "Make sure it’s fully visible and press the button";

    "incdOnboarding.document.capture.tutorial.title" = "Common issues";
    "incdOnboarding.document.capture.tutorial.tips.first.title" = "Document is too far or out of frame";
    "incdOnboarding.document.capture.tutorial.tips.first.subtitle" = "Make sure all edges are visible on screen.";
    "incdOnboarding.document.capture.tutorial.tips.second.title" = "Document is folded";
    "incdOnboarding.document.capture.tutorial.tips.second.subtitle" = "Flatten your document and make sure it’s fully open and straight.";
    "incdOnboarding.document.capture.tutorial.tips.third.title" = "Shadows on the document";
    "incdOnboarding.document.capture.tutorial.tips.third.subtitle" = "Move to a brighter area and avoid casting shadows over your document.";
    "incdOnboarding.document.capture.tutorial.tips.fourth.title" = "Camera lens is dirty";
    "incdOnboarding.document.capture.tutorial.tips.fourth.subtitle" = "Clean your camera lens for a sharper image.";
    "incdOnboarding.document.capture.tutorial.retry" = "Try again";

    "incdOnboarding.document.capture.review.title" = "Review your document";
    "incdOnboarding.document.capture.review.subtitle.photo" = "Make sure that entire document fits the view, and that the text is readable.";
    "incdOnboarding.document.capture.review.subtitle.file" = "Make sure you’ve selected the correct file before you continue the verification process.";
    "incdOnboarding.document.capture.review.replace" = "Replace";
    "incdOnboarding.document.capture.review.continue" = "Continue";

    "incdOnboarding.document.capture.processing.title.photo" = "Analyzing...";
    "incdOnboarding.document.capture.processing.title.file" = "Uploading...";
    "incdOnboarding.document.capture.processing.title.success" = "Successfully processed!";
    "incdOnboarding.document.capture.processing.continue" = "Continue";

    "incdOnboarding.document.capture.error.title.canRetry" = "Document needs to be recaptured";
    "incdOnboarding.document.capture.error.title.noRetry" = "Unable to process";
    "incdOnboarding.document.capture.error.subtitle.canRetry" = "Some pages were unclear or incomplete. Recapture all document pages to continue.";
    "incdOnboarding.document.capture.error.subtitle.noRetry" = "Maximum number of attempts reached.";
    "incdOnboarding.document.capture.error.attemptsRemaining" = "%d attempts remaining";
    "incdOnboarding.document.capture.error.oneAttemptRemaining" = "1 attempt remaining";
    "incdOnboarding.document.capture.error.cta.canRetry" = "Recapture document";
    "incdOnboarding.document.capture.error.cta.noRetry" = "Continue";


  ```
</Accordion>

<Accordion title="VoiceOver strings">
  ```swift
  "incdOnboarding.id.intro.voiceover" = "Back camera has started and ready to scan.";
  "incdOnboarding.id.capturingIn.voiceover" = "Capturing in";
  "incdOnboarding.id.holdStill.voiceover" = "Hold still";
  "incdOnboarding.id.tooClose.voiceOver" = "Move phone further from the ID";
  "incdOnboarding.id.tooFar.voiceOver" = "Move phone closer to the ID";
  "incdOnboarding.id.switchingToManualCapture" = "Double tap on the screen to capture, or bottom right button if you need help with capturing.";
  "incdOnboarding.selfie.cameraActivated" = "Front camera activated";
  "incdOnboarding.selfie.switchingToManualCapture" = "Double tap anywhere on the screen to capture";
  "incdOnboarding.selfie.badAngleZ.voiceOver" = "Don\'t tilt your head";
  "incdOnboarding.selfie.eyesClosed.voiceOver" = "Keep your eyes open";
  "incdOnboarding.selfie.hasFaceMask.voiceOver" = "Take off your face mask";
  "incdOnboarding.selfie.hasLenses.voiceOver" = "Take off your glasses";
  "incdOnboarding.selfie.tooBlurry.voiceOver" = "Image not focused, adjust";
  "incdOnboarding.selfie.tooClose.voiceOver" = "Move phone further, please";
  "incdOnboarding.selfie.tooFar.voiceOver" = "Move phone closer to you, please";
  "incdOnboarding.addPhone.picker.voiceOver" =  "Country code, ";
  "incdOnboarding.addPhone.input.label" = "Phone number";
  "incdOnboarding.addPhone.input.voiceOver" =  "Enter your local number without country code";
  "incdOnboarding.global.picker.accessibilityLabel" = "Select option";
  "incdOnboarding.global.picker.accessibilityHint" = "Double-tap to access available options";
  "incdOnboarding.global.picker.accessibilitySelected" = "selected";
  "incdOnboarding.global.picker.accessibilityNotSelected" = "option";
  "incdOnboarding.global.picker.accessibilityOptionPosition" = "%1$d of %2$d";
  "incdOnboarding.global.picker.accessibilityMatchedValuesCount" = "%d matched values";
  "incdOnboarding.global.picker.accessibilityMatchedValuesCountSingular" = "%d matched value";
  ```
</Accordion>



## Configure V2 Theme and UX

The V2 (SwiftUI) screens are themed separately from the V1 configuration described above. You configure them with JSON: a theme JSON passed to `IncdTheme.loadJsonTheme(_:)`, and a UX JSON passed to `IncdUXConfig.loadUXConfig(_:)`. To apply both from one JSON, see [Theme and UX Configuration from a single JSON](#theme-and-ux-configuration-from-a-single-json).

### Theme Configuration via JSON

The theme JSON supports `displayMode`, `typography`, `colorPalette`, and `components`. On iOS, font families are nested under an `ios` key.

<Accordion title="View an example theme JSON">
  ```swift
  let json = """
  {
    "displayMode": "light",
    "typography": {
      "family": {
        "text": {
          "ios": {
            "regular": "DMSans-Regular",
            "medium": "DMSans-Medium",
            "bold": "DMSans-Bold"
          }
        },
        "display": {
          "ios": {
            "extraBold": "DMSans-ExtraBold"
          }
        }
      },
      "letterSpacing": {
        "none": 0,
        "medium": -0.5,
        "large": -1.0,
        "extraLarge": -1.5
      }
    },
    "colorPalette": {
      "neutralLight": "#ffffff",
      "neutralDark": "#000000",
      "brand50": "#e5f0ff",
      "brand200": "#99CEFF",
      "brand300": "#66a6ff",
      "brand400": "#3388ff",
      "brand500": "#006aff",
      "brand600": "#0055cc",
      "brand900": "#21273b",
      "gray50": "#FCFCFD",
      "gray100": "#EBECEF",
      "gray200": "#C6C8D2",
      "gray300": "#A3A8B8",
      "gray500": "#60667C",
      "gray700": "#3A3E4B",
      "gray800": "#262831",
      "gray900": "#14151A",
      "gray1000": "#000000",
      "brandSecondary50": "#F2E2FE",
      "brandSecondary500": "#820AD1",
      "negative50": "#FFF0F0",
      "negative400": "#FF5A5F",
      "negative500": "#E71111",
      "negative950": "#240001",
      "warning50": "#FFF7EB",
      "warning400": "#FFB647",
      "warning500": "#FF9900",
      "warning950": "#271400",
      "positive50": "#E4FBF0",
      "positive400": "#45B380",
      "positive500": "#189F60",
      "positive950": "#03190E",
      "focus400": "#0099FF",
      "focus500": "#006AFF"
    },
    "components": {
      "buttons": [
        {
          "style": "primary",
          "surface": {
            "default": ["#000000", "#E8E8E8"],
            "hover": "#04FF5C",
            "pressed": "#00B540",
            "disabled": ["#EBECEF", "#000000"]
          },
          "text": {
            "default": ["#FFFFFF", "#000000"],
            "disabled": ["#959595", "#666666"]
          },
          "border": {
            "color": {
              "default": "#00D149"
            },
            "width": 0,
            "radius": 15
          }
        }
      ]
    }
  }
  """
  ```
</Accordion>

Apply it to the SDK:

```swift
IncdTheme.loadJsonTheme(json)
```


- `displayMode` can be `"light"`, `"dark"`, or `"system"`. If not set, the default is `"light"`.
- Font families are nested under `ios`. The font names must resolve to fonts available to your app (bundled and declared, or system fonts).
- Color tokens use hex strings. Both `#RRGGBB` and `#AARRGGBB` (with a leading alpha byte) are accepted.
- A `surface`, `text`, or `border` color can be either a single hex string or a two-element array `[light, dark]` for per-appearance colors.
- Button `style` can be `"primary"` or `"secondary"`.
- All properties are optional; anything you omit keeps its default.

:::info

  `IncdTheme.loadJsonTheme(_:)` reads the same JSON to populate both the V1 (`IncdTheme.current`) and V2 (`typography`, `colorPalette`, `displayMode`, `components`) state, so you can theme both systems from one blob.
:::

### UX Configuration via JSON

UX configuration controls layout and chrome for the V2 screens. Pass a JSON string to `IncdUXConfig.loadUXConfig(_:)`.

```swift
let jsonString = """
{
  "showFooter": true,
  "closeButtonPosition": "topLeft",
  "helpButtonPosition": "topRight",
  "headerAlignment": "center",
  "realtimeFeedbackMessageUIFlavor": "standard"
}
"""

IncdUXConfig.loadUXConfig(jsonString)
```

<Accordion title="View available properties and their possible values">
  | Property                          | Type    | Values                               | Default       | Description                                   |
  | --------------------------------- | ------- | ------------------------------------ | ------------- | --------------------------------------------- |
  | `showFooter`                      | Boolean | `true` or `false`                    | `true`        | Controls whether the SDK shows the footer.    |
  | `closeButtonPosition`             | String  | `topRight`, `topLeft`                | `topRight`    | Position of the close button.                 |
  | `helpButtonPosition`              | String  | `topRight`, `topLeft`, `bottomRight` | `bottomRight` | Position of the help button.                  |
  | `realtimeFeedbackMessageUIFlavor` | String  | `standard`, `minimal`                | `standard`    | Visual flavor of real-time feedback messages. |
  | `headerAlignment`                 | String  | `start`, `center`, `end`             | `center`      | Alignment of the header.                      |
</Accordion>

### Theme and UX Configuration from a single JSON

One JSON document can hold a `theme` object and a `ux` object. Use `IncdTheme.loadUIConfigFromJson(_:)` to apply both with one call.

```swift
let json = """
{
  "theme": {
    "displayMode": "light",
    "colorPalette": {
      "brand500": "#FF00AE",
      "brand600": "#CC008B"
    },
    "components": {
      "buttons": [
        {
          "style": "primary",
          "surface": { "default": "#FF00AE", "pressed": "#CC008B" },
          "text": { "default": "#FFFFFF" }
        }
      ]
    }
  },
  "ux": {
    "showFooter": true,
    "closeButtonPosition": "topRight",
    "helpButtonPosition": "bottomRight",
    "headerAlignment": "center",
    "realtimeFeedbackMessageUIFlavor": "standard"
  }
}
"""

IncdTheme.loadUIConfigFromJson(json)
```

The `theme` object accepts the same properties as [Theme Configuration via JSON](#theme-configuration-via-json). The `ux` object accepts the same properties as [UX Configuration via JSON](#ux-configuration-via-json).

- The document must contain both a `theme` and a `ux` object. If either is missing, nothing is applied and the SDK logs the reason as an error.
- A flat document, with theme and UX keys at the root, is not supported here. Pass it to `IncdTheme.loadJsonTheme(_:)` and `IncdUXConfig.loadUXConfig(_:)` instead.
- Each object is applied the same way as a standalone JSON: it replaces the whole theme or UX configuration, and anything you omit returns to its default.
- If one object contains an invalid value, the SDK logs the error with the key path: for example, `theme.colorPalette.brand500`. The other object is still applied. An invalid `ux` object is not applied. For an invalid `theme` object, the V2 theme is not applied.
- A number too large to represent, such as `1e400`, makes the whole document invalid. As with a JSON syntax error, nothing is applied and the SDK logs the reason.
- `IncdTheme.loadJsonTheme(_:)` and `IncdUXConfig.loadUXConfig(_:)` continue to work as before.

---

- Path: `sdk-reference/ios-example-implementation`
- URL: https://developer.incode.com/sdk-reference/ios-example-implementation/
- Markdown: https://developer.incode.com/sdk-reference/ios-example-implementation.md

# Example Implementation

The Incode iOS SDK ships with a full example app that demonstrates an end-to-end integration you can run, read, and adapt. It shows how to initialize the SDK and run an onboarding flow with a real, buildable project. Use it as a reference while you build your own flow.

The example app lives in a dedicated GitHub repository:

[Incode-Welcome-Example-iOS](https://github.com/Incode-Technologies-Example-Repos/Incode-Welcome-Example-iOS)

<Callout icon="📘" theme="info">
  ### Access

  The example repository is private. Reach out to your customer success manager to request access.
</Callout>

<br />

---

- Path: `sdk-reference/ios-flow-configuration`
- URL: https://developer.incode.com/sdk-reference/ios-flow-configuration/
- Markdown: https://developer.incode.com/sdk-reference/ios-flow-configuration.md

# Integration Approaches

After you've [installed and initialized](/sdk-reference/setup-ios/) the Incode iOS SDK, choose an integration approach. This involves choosing:

- **An integration path**: How much UI and orchestration the SDK owns.
- **An integration pattern**: Where the identity verification (IDV) flow is defined and how it runs.

Choose the path first, then the pattern that fits your product.

Every entry point takes an `IncdOnboardingDelegate`, and every session-based entry point additionally takes an `IncdOnboardingSessionConfiguration`; the exception is the URL-based `startFlow(url:delegate:isShortened:)`, which starts from a link instead.

***

## Integration Paths

The SDK supports three integration paths, each offering a different level of control. Start with the simplest path that meets your requirements.

### Path 1: Full Onboarding Flow

The SDK owns the UI from start to finish. You define the [modules](/sdk-reference/ios-individual-modules/) you want and pass them to the SDK. The SDK runs those modules in sequence and returns results through an `IncdOnboardingDelegate`.

This is the simplest path and the recommended starting point for most integrations.

### Path 2: Split Flow

The SDK owns each module screen: the camera UI, the capture experience, and the on-device guidance. You own the order of modules and the screens between them. Use this when you need to insert your own screens between Incode steps or run only part of an identity verification journey.

### Path 3: Capture-Only

The SDK owns only the capture UI. You own everything before and after capture. This path is not recommended unless your product has strict security or orchestration requirements.

See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

***

## Integration Patterns

The SDK supports three integration patterns. Each pattern determines where the flow is defined and how it runs.

### Pattern 1: Configure Flows Locally and Run End to End

Define the flow in code with `IncdOnboardingFlowConfiguration`. Pass it to `startOnboarding`. The SDK runs every module in sequence and returns control to your app when the flow finishes.

Use this pattern with **Integration Path 1: Full Onboarding Flow**.

See [Configure Flows Locally and Run End to End](/sdk-reference/ios-configure-locally-end-to-end/).

### Pattern 2: Configure Flows Locally and Run Step by Step

Define the flow in code as one or more sections. Run each section with `startOnboardingSection`. Control returns to your app between sections, so you can show your own screens or logic, branch based on intermediate results, or call your back end before continuing.

Use this pattern with **Integration Path 2: Split Flow**.

See [Configure Flows Locally and Run Step by Step](/sdk-reference/ios-configure-flows-locally-and-run-step-by-step/).

### Pattern 3: Run Flows Configured in Dashboard

Define the flow in Dashboard and start it by reference. The SDK pulls the modules and configuration from Dashboard; you don't build an `IncdOnboardingFlowConfiguration` locally. Activate the flow in Dashboard before starting the session. Use this when you want to update the flow without releasing a new app version.

Dashboard supports two flow types: Flows and Workflows. They behave differently depending on the integration path:

- **Flows** support **Integration Path 1: Full Onboarding Flow** only.

- **Workflows** support **Integration Path 1: Full Onboarding Flow** and **Integration Path 2: Split Flow**.

See [Run Flows Configured in Dashboard](/sdk-reference/ios-run-flows-configured-in-dashboard/).

***

## Choose Your Integration Approach

| Goal                                                              | Path                                                                                                     | Pattern                                                                                                            | Entry point                                                                                   |
| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| Run a full IDV flow with the least code                           | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow)                                             | [Pattern 1: Configure Flows Locally and Run End to End](#pattern-1-configure-flows-locally-and-run-end-to-end)     | `startOnboarding(sessionConfig:flowConfig:delegate:)`                                         |
| Insert your own screens or logic between SDK steps                | [Path 2: Split Flow](#path-2-split-flow)                                                                 | [Pattern 2: Configure Flows Locally and Run Step by Step](#pattern-2-configure-flows-locally-and-run-step-by-step) | `startOnboardingSection(flowConfig:sectionTag:delegate:)`                                     |
| Update the flow from Dashboard without an app release (Flows)     | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow)                                             | [Pattern 3: Run Flows Configured in Dashboard](#pattern-3-run-flows-configured-in-dashboard)                       | `startFlow(sessionConfig:delegate:moduleId:)`                                                 |
| Update the flow from Dashboard without an app release (Workflows) | [Path 1: Full Onboarding Flow](#path-1-full-onboarding-flow) or [Path 2: Split Flow](#path-2-split-flow) | [Pattern 3: Run Flows Configured in Dashboard](#pattern-3-run-flows-configured-in-dashboard)                       | `startWorkflow(sessionConfig:delegate:)`                                                      |
| Build a fully custom capture experience                           | [Path 3: Capture-Only](#path-3-capture-only)                                                             | N/A                                                                                                                | See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/) |

***

## What's Next

| Task                                                        | Page                                                                              |
| ----------------------------------------------------------- | --------------------------------------------------------------------------------- |
| View the module catalog for building a flow configuration   | [Modules](/sdk-reference/ios-individual-modules/) |
| View the result and error objects returned by each callback | [Results](/sdk-reference/ios-results/)            |

<br />

---

- Path: `sdk-reference/ios-getting-started`
- URL: https://developer.incode.com/sdk-reference/ios-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/ios-getting-started.md

# Getting Started

This section covers everything you need to set up the Incode iOS SDK. Follow the pages in this section in order, then add the optional and advanced features you need.

***

## Setup

Follow these steps to set up the SDK:

1. Ensure your devices meet the [device requirements](/sdk-reference/ios-sdk/#device-requirements).
2. Ensure your build environment meets the [build requirements](/sdk-reference/setup-ios/#build-requirements).
3. [Install](/sdk-reference/setup-ios/) the SDK: add the distribution package via Swift Package Manager (or the private specs repo via CocoaPods), pin the exact build variant version, declare the required permissions in your `Info.plist`, and initialize the SDK.
4. Choose an [integration approach](/sdk-reference/ios-flow-configuration/).
5. Run your first identity verification (IDV) flow.

***

## Optional and Advanced Features

Once your basic integration is running, add the features you need:

- [On-Demand Resources](/sdk-reference/setup-ios/#manage-on-demand-resources-odr): Download the SDK's machine learning (ML) resources at runtime instead of bundling them, reducing app size. Available with the static (`-s`) build variant.
- [End-to-End Encryption (E2EE)](/sdk-reference/ios-security/#enable-end-to-end-encryption): Enforce end-to-end encryption of capture artifacts.
- [API Key Rotation](/sdk-reference/ios-api-key-rotation/): Rotate the SDK API key at runtime.
- [Apple Wallet ID](/sdk-reference/ios-apple-wallet-id/): Verify identity with an Apple Wallet ID.
- [Risk Analysis](/sdk-reference/ios-risk-analysis/): Analyze device and behavioral risk.
- [Token-Based Setup](/sdk-reference/ios-token-based-setup/): Use the SDK without an API key by passing a backend-created token.

Also, browse the [full catalog of available modules](/sdk-reference/ios-individual-modules/).

---

- Path: `sdk-reference/ios-individual-modules`
- URL: https://developer.incode.com/sdk-reference/ios-individual-modules/
- Markdown: https://developer.incode.com/sdk-reference/ios-individual-modules.md

# Modules

The Incode iOS SDK is composed of single-purpose **modules**. You assemble an onboarding flow by adding modules to an `IncdOnboardingFlowConfiguration`, passing it to `startOnboarding(...)`, and receiving each module's output through your `IncdOnboardingDelegate`. This page lists each module by category.

<Callout icon="📘" theme="info">
  ### Terminology

  "Module" here refers to an onboarding **step**, such as ID Capture or Video Selfie. You add them in code with `flowConfig.addXxx(...)`.

  This is different from the SDK **build variants** (`-l`, `-nfc`, `-vc`, `-sna`) that you select at installation to include optional capabilities such as Login, NFC, Video Conference, or Silent Network Authentication. The **Variant** column below tells you which variant each module needs. Anything marked "All" ships with the core SDK.
</Callout>

Each module is configured through its `addXxx(...)` builder and returns its result through a dedicated callback on the delegate. The only required callbacks are `onSuccess()` and `onError(_:)`. The linked pages cover detailed configuration for each module. See [Flow Configuration](/sdk-reference/ios-flow-configuration/) for the full builder catalog.

Most modules ship a legacy (v1) and a new (v2) UI; the active one is selected by the SDK. See [Customization](/sdk-reference/ios-customization/).

<Callout icon="❗" theme="error">
  ### Ordering Matters

  Some modules depend on others running earlier in the flow. For example, ID OCR and Process ID run after ID Capture; NFC runs after ID Capture and Process ID; and Face Match runs after Selfie and at least one document-capturing module. See each module's page for its exact ordering requirements.
</Callout>

The following tables can help you choose which modules to use. They are divided by category. Module descriptions are general; exact behavior depends on your Flow or Workflow configuration.

***

## Collect Identity Data

These modules gather raw inputs from users. Most simply receive and record without a pass/fail outcome, though Phone and Email can optionally verify ownership with a one-time password (OTP).

| Module                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Variant                                        |
| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| [Document Capture](/sdk-reference/module-document-scan/) | Captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device's camera. In Dashboard, this is the [Document Capture](/dashboard-platform-administration/document-capture-dashboard/) module.                                                                                                                                                                     | All                                            |
| [Dynamic Forms](/sdk-reference/module-dynamic-forms/)    | Presents one or more custom screens to collect information from a user. In Dashboard, this is the [Forms and Data Entry](/dashboard-platform-administration/forms-and-data-entry-dashboard/) module.                                                                                                                                                                                                                                                                                      | All                                            |
| [Email](/sdk-reference/module-email/)                    | Collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address. In Dashboard, this is the [Email Input](/dashboard-platform-administration/email-input-dashboard/) module.                                                                                                                                                                                                                                                          | All                                            |
| [Full Name](/sdk-reference/module-full-name/)            | Collects the user's name and sends it to the server.                                                                                                                                                                                                                                                                                                                                                                                                                                                  | All                                            |
| [Geolocation](/sdk-reference/module-geolocation/)        | Requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city. In Dashboard, this is the [Geolocation](/dashboard-platform-administration/geolocation-dashboard/) module.                                                                                                                                                                               | All                                            |
| [ID Capture](/sdk-reference/module-id-scan/)             | Captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. It is the entry point for most identity-capture flows. Add it before ID OCR and Process ID. In Dashboard, this is the [ID Capture](/dashboard-platform-administration/id-capture-dashboard/) module.                                                                                                                                               | All                                            |
| [ID OCR](/sdk-reference/module-id-info/)                 | Extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr)​. It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields. Add it after Process ID, which must run after ID Capture. In Dashboard, this is [Review OCR Data](/dashboard-platform-administration/review-ocr-data-dashboard/) module. | All                                            |
| [NFC](/sdk-reference/module-nfc-scan/)                   | Reads the secure [NFC](/get-started-with-incode/glossary/#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the holder's data, including the chip portrait image. Add it after ID Capture and Process ID. When a flow captures multiple IDs, NFC applies only to the first ID. In Dashboard, this is the [NFC Scan](/dashboard-platform-administration/nfc-scan-dashboard/) module.                             | `-nfc` build, on NFC-capable devices           |
| [Phone](/sdk-reference/module-phone/)                    | Collects a user's phone number and can confirm ownership by sending a one-time password (OTP) via SMS. In Dashboard, this is the [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard/) module.                                                                                                                                                                                                                                                           | All; `-sna` adds Silent Network Authentication |
| [QR Scan](/sdk-reference/module-qr-scan/)                | Captures the QR code on the back of an ID, decodes its identity data, and sends it to the server.                                                                                                                                                                                                                                                                                                                                                                                                     | All                                            |
| [Selfie](/sdk-reference/module-selfie/)                  | Captures the user's face with the device camera and runs configurable liveness, face-recognition, and image-quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. Most flows include this module. In Dashboard, this is the [Face Capture](/dashboard-platform-administration/face-capture-dashboard/) module.                                                                                                       | All                                            |
| [Video Selfie](/sdk-reference/module-video-selfie/)      | Records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent. Add it after a module that captures a selfie, such as Selfie. In Dashboard, this is the [Video Selfie](/dashboard-platform-administration/video-selfie-dashboard/) module.                                                                                      | All                                            |

## Verify and Authenticate

These modules run checks against collected data to produce a pass/fail or match/no-match determination.

| Module                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Variant                                               |
| ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [Antifraud](/sdk-reference/module-antifraud/)                         | Compares the current Session against prior Sessions and known identities to detect signs of fraud. In Dashboard, this is the [Antifraud Check](/dashboard-platform-administration/antifraud-check-dashboard/) module.                                                                                                                                                                                                                                                                                                             | All                                                   |
| [CURP Validation](/sdk-reference/module-curp-validation/)             | Validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. Accepts a CURP extracted via OCR, entered manually, or generated from personal data. In Dashboard, this is the [CURP Validation](/dashboard-platform-administration/curp-validation-dashboard/) module.                                                                                                                                                                    | All (Mexico)                                          |
| [Custom Watchlist](/sdk-reference/module-custom-watchlist/)           | Screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. In Dashboard, this is the [Custom Watchlist](/dashboard-platform-administration/custom-watchlist-dashboard/) module.                                                                                                                                                                                                  | All                                                   |
| [eKYB (electronic Know Your Business)](/sdk-reference/module-ekyb/)   | Collects and verifies a business entity's identity data, such as business name, address, and tax ID. In Dashboard, this is the [eKYB](/dashboard-platform-administration/ekyb-dashboard/) module.                                                                                                                                                                                                                                                                                                                                 | All                                                   |
| [eKYC (electronic Know Your Customer)](/sdk-reference/module-ekyc/)   | Collects and verifies a user's personal identity data against authoritative data sources. This data can include the user's name, email, address, phone, tax ID, date of birth, and nationality. This module can prefill fields from data captured earlier in the flow, such as a scanned document, and validate them against your Incode configuration. In Dashboard, this is the [eKYC](/dashboard-platform-administration/ekyc-dashboard/) module.                                                                              | All                                                   |
| [Face Authentication](/sdk-reference/module-face-authentication/)     | Captures a returning user's face with the device camera and matches it against the face already enrolled for that user. It then returns a pass or fail result. In Dashboard, this is the [Face Authentication](/dashboard-platform-administration/face-authentication-dashboard/) module.                                                                                                                                                                                                                                         | All; local on-device matching requires the `-l` build |
| [Face Match](/sdk-reference/module-face-match/)                       | Compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a match decision and confidence score. Add it after Selfie and at least one document-capturing module. In Dashboard, this is the [Face Match](/dashboard-platform-administration/face-match-dashboard/) module.                                                                                                                                                                                                | All                                                   |
| [Global Watchlist](/sdk-reference/module-global-watchlist/)           | Screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. In Dashboard, this is the [Watchlist](/dashboard-platform-administration/watchlist-dashboard/) module.                                                                                                                                                                                                                                       | All                                                   |
| [Government Validation](/sdk-reference/module-government-validation/) | Validates identity data extracted from a user's ID against an authoritative government registry. It can also match the user's photo in the government database against their captured selfie. Add it after Selfie and one document-capturing module. In Dashboard, this is the [Government Record Verification](/dashboard-platform-administration/government-record-verification-dashboard/) module. | All (region-gated, Mexico)                            |
| [Process ID](/sdk-reference/module-process-id/)                       | Determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Capture](/sdk-reference/module-id-scan/) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result and the OCR data used by later steps. Add it before ID OCR and after ID Capture. In Dashboard, this is the [ID Validation](/dashboard-platform-administration/id-validation-dashboard/) module.                     | All                                                   |

## Capture Signatures and Consent

These modules capture legally binding signatures and record user consent.

| Module                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Variant |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [AES (Advanced Electronic Signature)](/sdk-reference/module-aes/)           | The AES (Advanced Electronic Signature) module shows the user the documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant. In Dashboard, this is the [Advanced Electronic Signature](/dashboard-platform-administration/advanced-electronic-signature-dashboard-1/) module.                                                                                                                                             | All     |
| [Combined Consent](/sdk-reference/module-combined-consent/)                 | Shows the user one preconfigured [consent](/dashboard-platform-administration/configuration-consents-tab/) to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey. In Dashboard, this is the [Data Sharing Consent](/dashboard-platform-administration/data-sharing-consent-dashboard/) module.                                                                                                            | All     |
| [Machine Learning Consent](/sdk-reference/module-machine-learning-consent/) | Captures the user's consent to process their biometric data for machine-learning purposes. You choose the consent text variant (US, GDPR, or worldwide) that matches your compliance needs.                                                                                                                                                                                                                                                                                                                                                                                               | All     |
| [QES (Qualified Electronic Signature)](/sdk-reference/module-qes/)          | Shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states. In Dashboard, this is the [Qualified Electronic Signature](/dashboard-platform-administration/qualified-electronic-signature-dashboard-1/) module. | All     |
| [Signature](/sdk-reference/module-signature/)                               | Captures a signature the user hand-draws on screen, optionally presenting documents to sign. It is typically placed at the end of a verification journey to capture explicit consent. In Dashboard, this is the [Electronic Signature](/dashboard-platform-administration/electronic-signature-dashboard/) module.                                                                                                                                                                                                                                                            | All     |
| [User Consent](/sdk-reference/module-user-consent/)                         | Shows a custom consent agreement for the user to review and accept.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | All     |

## Add Human-Assisted Verification

These modules introduce a live agent into the verification process.

| Module                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                       | Variant     |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [Video Conference](/sdk-reference/module-conference/) | Connects the user to a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements. In Dashboard, this is the [Video Conference](/dashboard-platform-administration/video-conference-dashboard/) module. | `-vc` build |

## Configure the User Experience

| Module                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                    | Variant |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [Custom Fields](/sdk-reference/module-custom-fields/) | Captures additional user-provided data and saves it to the session, making it available for reporting, server-side decisions, or cross-checking later in the journey. In Dashboard, this is the [Custom Fields](/dashboard-platform-administration/custom-fields-dashboard/) module. | All     |
| [Custom Module](/sdk-reference/module-custom-module/) | Pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues. It does this by handing your app a `callbackName`, then resuming the Workflow at the next node once you report a result. In Dashboard, this is the [Custom Module](/dashboard-platform-administration/custom-module-dashboard/). | All     |

## View Results

| Module                                                                    | Description                                                                                                                                                                                                                                                                                                                                                                               | Variant |
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [Results](/sdk-reference/module-results/) | Shows a screen summarizing the data captured during onboarding, including OCR fields, captured images, and identity scores. It returns an overall user score. Add it after the modules that add or process the data it summarizes, such as ID Capture and Selfie. In Dashboard this is the [Show Results](/dashboard-platform-administration/show-results-dashboard/) module. | All     |

## Configure iOS-Specific Experiences

These modules have no Dashboard equivalent. They exist only in the iOS SDK.

| Module                                                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                          | Variant |
| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [Approval](/sdk-reference/module-approval/) | Finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. Add it after the modules that add or process the data it summarizes, such as ID Capture and Selfie.                                                                                                                                                                                      | All     |
| [Captcha](/sdk-reference/module-captcha/)   | Presents a CAPTCHA challenge during onboarding to verify human interaction and reduce automated abuse. It then returns the user's response to your app. In Dashboard, this feature can be enabled when adding the [Email Input](/dashboard-platform-administration/email-input-dashboard/) or [Phone Number](/dashboard-platform-administration/phone-number-input-dashboard/) Input module. | All     |
| [Intro](/sdk-reference/module-intro/)       | Displays an introduction screen. It lists the documents and checks the user will need to complete.                                                                                                                                                                                                                                                                                                                   | All     |

***

## Additional Flow Steps

These public flow-builder steps exist for narrower use cases. They do not have a dedicated page yet; configure them with the matching `flowConfig.addXxx(...)` builder and read the result on the listed callback.

- **Barcode**: `addBarcodeScan(showTutorials:)`, `onBarcodeScanCompleted(_:)`
- **Credit card CCV**: `addCreditCardCCV()`, `onCreditCardCCVCompleted(_:)`

***

## Helpers Used by Every Integration

These aren't modules, but every integration uses them to configure a session and receive results. See [Integration Approaches](/sdk-reference/ios-flow-configuration/) for end-to-end usage and [API Reference](/sdk-reference/ios-api-reference/) for the full surface.

| Helper                                                           | Purpose                                                                                                                               |
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `IncdOnboardingSessionConfiguration`                             | Configures the onboarding session: Flow or Workflow ID, validation modules, session token or external ID, and custom fields.          |
| `IncdOnboardingFlowConfiguration`                                | Declares which modules run and in what order. Build it with the `addXxx(...)` methods shown on each individual module's page.         |
| `IncdOnboardingDelegate`                                         | The callback interface that delivers each module's result object and flow-level events. `onSuccess()` and `onError(_:)` are required. |
| `startOnboarding(...)` / `startFlow(...)` / `startWorkflow(...)` | Entry points on `IncdOnboardingManager` that launch a code-defined flow or a Dashboard-defined Flow or Workflow.                      |

***

## Non-UI Capture

You can run selected capture steps without showing Incode's UI. For example, [ID Capture](/sdk-reference/module-id-scan/) exposes a public non-UI builder (`addIdScanNonUI(...)`) that captures and delivers results through the normal callbacks without presenting the standard screens.

For a broader integration that keeps your own UI while still capturing and processing through the SDK, see [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

<br />

---

- Path: `sdk-reference/ios-known-issues`
- URL: https://developer.incode.com/sdk-reference/ios-known-issues/
- Markdown: https://developer.incode.com/sdk-reference/ios-known-issues.md

# Known Issues

This page lists the known issues, limitations, and intentional constraints you are most likely to run into with the Incode iOS SDK. Each entry describes a lasting, customer-facing behavior, not a temporary bug. The [release notes](/release-notes/releases-ios-sdk/) track and resolve temporary bugs.

This list is a quick summary. [Migration Guide](/release-notes/migration_guide/) holds the authoritative, version-specific notes. Check those pages for the exact release where a behavior changed, or a limitation started or ended.

***

## NFC

- **The SDK tries the PACE protocol first, then falls back to BAC.** When opening an NFC chip, the SDK attempts Password Authenticated Connection Establishment (PACE) when the document advertises support for it, and falls back to Basic Access Control (BAC) otherwise. See [NFC](/sdk-reference/module-nfc-scan/).

***

## Capture-Only Mode

- **Forward&#x20;**`metadata`**&#x20;to the Incode API.** In Capture-Only mode (`IncdOnboardingManager.shared.sdkMode = .captureOnly`), the SDK returns captures to your app without uploading them, and your app is responsible for submission. When you submit a capture yourself, forward the `metadata` field from the capture result—`IdScanResult.metadata` and `SelfieScanResult.metadata`—to the Incode API. This field carries proprietary capture metadata required by the Incode backend to process the capture. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

***

## On-Device Face Processing for Selfie Scan V2

- **Constrained configuration.** On-device face results submission for the Selfie module, configured through Dashboard/Workflows, is only honored when all of the following hold:

  - End-to-end encryption is active for the session,
  - The Login variant is included in the build, and
  - The module runs with a visible UI (headless mode is not supported).

  If any of these is not met, on-device submission is not used. Note that the iOS requirements differ from the Android SDK. See [Selfie](/sdk-reference/module-selfie/).

***

## Simulator

- **Camera and NFC are unavailable on the iOS Simulator.** Camera- and NFC-dependent modules cannot produce real captures on the Simulator; the SDK gates camera and NFC availability when running there. Run capture flows on a physical device. NFC additionally requires iOS 13.0 or later and NFC-capable hardware. On unsupported OS versions the SDK reports `NFCScanError.notAvailable`.

***

## Device Environment Detection

- **Environment signals are reported, not enforced.** The iOS SDK collects device-integrity signals: jailbreak, runtime-hooking/instrumentation, and, in release builds, debugger-attach detection. It reports them to the Incode backend as upload metadata for risk analysis. These signals are **non-blocking**: they do not stop onboarding, they do not surface as a catchable error or delegate callback, and they do not crash the app. You cannot disable them, and there is no integrator hook to handle them.

***

## Selfie Capture on iPad

- **Turning the iPad during selfie capture distorts the recorded video.** With Deepsight Video Liveness configured, the part of the recording made after the turn is stretched. Applies from iPadOS 18, where the screens follow the device orientation.

---

- Path: `sdk-reference/ios-licenses`
- URL: https://developer.incode.com/sdk-reference/ios-licenses/
- Markdown: https://developer.incode.com/sdk-reference/ios-licenses.md

# Licenses

The iOS SDK is proprietary software. Copyright 2026 Incode Technologies. All rights reserved. Its binary also includes some open-source components, used under the licenses identified below. Each entry lists a copyright notice and the component's source. Every section ends with a link to the full license text.

***

## Apache License Version 2.0

These components are included in the SDK binary under the Apache License, Version 2.0:

| Component   | Copyright            | Source                                                       |
| ----------- | -------------------- | ------------------------------------------------------------ |
| MarkdownKit | 2019-2021 Google LLC | file: `Modules/IncdCommons/Internal/MarkdownKit/Block.swift` |

Full license text: [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)

***

## BSD 3-Clause License

The SDK binary includes components under the BSD 3-Clause License. This license requires you to reproduce the copyright notice, list of conditions, and disclaimer verbatim in any documentation or materials you distribute. If your app includes an "Open Source Licenses" screen, include the relevant notices from the framework's bundled `NOTICE` file.

These components are bundled inside `OpenTok.xcframework`. Their full copyright notices, conditions, and disclaimers are reproduced verbatim in the framework's bundled `NOTICE` file:

| Component | Copyright                                                                     | Source                                                 |
| --------- | ----------------------------------------------------------------------------- | ------------------------------------------------------ |
| WebRTC    | 2011 The WebRTC project authors. All rights reserved.                         | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE` |
| libuuid   | 2007 Theodore Ts'o                                                            | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE` |
| libev     | 2007-2013 Marc Alexander Lehmann (dual-licensed: BSD-style or GPLv2 or later) | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE` |

Full license text: see `Frameworks/OpenTok.xcframework/NOTICE` (bundled with the SDK).

BSD 3-Clause reference: [https://opensource.org/license/bsd-3-clause](https://opensource.org/license/bsd-3-clause)

***

## MIT License

These components are included in the SDK binary under the MIT License:

| Component     | Copyright                                                                                     | Source                                                                                                                                                                               |
| ------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ZIPFoundation | 2017-2021 Thomas Zoechling and the ZIP Foundation project authors                             | [https://github.com/weichsel/ZIPFoundation](https://github.com/weichsel/ZIPFoundation); <br />file: `Modules/IncdUIKit/Lottie/Private/EmbeddedLibraries/ZipFoundation/Archive.swift` |
| LRUCache      | 2021 Nick Lockwood                                                                            | [https://github.com/nicklockwood/LRUCache](https://github.com/nicklockwood/LRUCache); <br />file: `Modules/IncdUIKit/Lottie/Private/EmbeddedLibraries/LRUCache/LRUCache.swift`       |
| libjansson    | 2009-2014 Petri Lehtinen                                                                      | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE`                                                                                                                               |
| libwslay      | 2011, 2012, 2015 Tatsuhiro Tsujikawa                                                          | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE`                                                                                                                               |
| http-parser   | Joyent, Inc. and other Node contributors (based on nginx's `ngx_http_parse.c`, © Igor Sysoev) | file: `Vendored Frameworks/OpenTok.xcframework/NOTICE`                                                                                                                               |

Full license text: [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)

---

- Path: `sdk-reference/ios-on-device-age-estimation`
- URL: https://developer.incode.com/sdk-reference/ios-on-device-age-estimation/
- Markdown: https://developer.incode.com/sdk-reference/ios-on-device-age-estimation.md

# On-Device Age Estimation

With an On-Device Age Estimation configuration, age estimation will run entirely on the user’s device during Face Capture. No selfie image, video, or any PII leaves the device. Only structured analysis results (for example: liveness, face quality, and the estimated age) are submitted to Incode.

Because the biometric capture never leaves the device, the feature also skips the normal selfie image upload, video/frame recording upload, and manual capture. Age decisioning is performed on the backend from the submitted results.

## **Prerequisites**

- Incode Welcome iOS SDK **5.43.0 or later**, `-l`**&#x20;(Login) variant** included. If you have not already done so, follow the steps to [install and set up](https://developer.incode.com/docs/sdk_installation_setup) the SDK.
- [**End-to-end encryption (E2EE)**](https://developer.incode.com/docs/user_guide_e2ee) enabled for your organization, plus your E2EE URL.
- A [**flow**](https://developer.incode.com/docs/using-flows) created in Dashboard. You will need its [**Flow ID**](https://developer.incode.com/docs/using-flows#other-flow-actions) - this is the `configurationID` on the session.

<Callout icon="⚠️" theme="warn">
  ### Important

  If a requirement is not met (wrong SDK variant, E2EE not active, or similar), the selfie module fails with a `notInitialized` error.
</Callout>

## **Dashboard configuration**

For server-driven flows, enable **On-Device Processing** on the Face Capture module in your Flow or Workflow configuration in Dashboard:

1. In the left menu, click **Flow Builder** > **Flows** OR **Workflows**.
2. Open your Flow or Workflow.&#x20;
3. Open the configuration panel for the Face Capture module.
4. Enable **On-Device Processing**. This ensures that liveness and age estimation run entirely on the user's device. No biometric images leave the SDK.
5. If using Workflows, click **Save configurations**. Flow configurations save automatically.
6. If using Workflows, click **Save & Publish**. If using Flows, clic&#x6B;**&#x20;Save Changes**.

The SDK reads this setting from the flow automatically. There is no code flag to set.

## **Integration steps**

### **1. Initialize the SDK**

Initialize with your API URL, E2EE URL, and API key (e.g. in AppDelegate):

```swift
import IncdOnboarding

IncdOnboardingManager.shared.initIncdOnboarding(
    url: "<YOUR_API_URL>",
    e2eeURL: "<YOUR_E2EE_URL>",
    apiKey: "<YOUR_API_KEY>"
)
```

### **2. Create the session configuration**

Use your Flow or Workflow ID and enable E2EE:

```swift
let sessionConfig = IncdOnboardingSessionConfiguration(
    configurationId: "<YOUR_FLOW_ID>",
    e2eEncryptionEnabled: true
)
```

### **3.&#x20;**&#x53;et presenting `ViewController` and start the flow

```swift
IncdOnboardingManager.shared.presentingViewController = self
IncdOnboardingManager.shared.startFlow(
    sessionConfig: sessionConfig,
    delegate: self
)
```

### **4. Handle the result in your delegate**

```swift
extension MyViewController: IncdOnboardingDelegate {
    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        if let error = result.error {
            // Capture failed or was cancelled
        }
        // Results are sent to Incode backend
        // and they are not returned to the app.
    }
}
```

<Callout icon="📘" theme="info">
  ### Note

  Since images never leave the device, `SelfieScanResult` does not contain a selfie image.
</Callout>

<br />

---

- Path: `sdk-reference/ios-results`
- URL: https://developer.incode.com/sdk-reference/ios-results/
- Markdown: https://developer.incode.com/sdk-reference/ios-results.md

# Results

Every module in an onboarding flow reports its outcome to your `IncdOnboardingDelegate`. Most modules deliver a **result object** through a dedicated callback. A few modules signal completion without a result object: for example, [Video Conference](/sdk-reference/module-conference/) reports a success `Bool` and an optional error.

This page lists every result and error object. The groups match the categories on [Modules](/sdk-reference/ios-individual-modules/). For the full field list of a result type, see its module page.

The flow's terminal callbacks are `onSuccess()` when the flow finishes, `userCancelledSession()` when the user cancels, and `onError(_:)` when it fails.

***

## Result Delivery

Results arrive on the module's success callback, such as `onIdProcessed(_ result: IdProcessResult)`. `IncdOnboardingDelegate` declares all of these result callbacks. The SDK also defines narrower delegate protocols for specific scenarios:

- `IDCaptureControllerDelegate`: Real-time callbacks while capturing an ID.
- `IncdLoginDelegate`: Face-login sync progress.
- `IncdOnboardingVideoConferenceDelegate`: Assisted-video-conference callbacks.

The iOS SDK has no single shared status type. Each result struct carries its own fields describing the module's outcome. For example, `GovernmentValidationResult` exposes `success: Bool` and `error: IncdError?`, while `IdScanResult` exposes `scanStatus: IncdIdScanStatus` (an enum with cases such as `ok`, `errorGlare`, and `errorSharpness`). See [each individual module's page](/sdk-reference/ios-individual-modules/).

A few modules do not return a result object. They signal completion with a callback that carries only a status: for example, `onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?)`.

***

## Error Delivery

Errors surface on the shared `onError(_ error: IncdFlowError)` path. `IncdFlowError` is a single enum with cases such as `initError(_:)`, `error(_:)` (wrapping an `IncdError`), `sessionCreationFailed(_:)`, `permissionsDenied`, `declinedToSignDocument`, `captchaNotVerified(_:)`, `videoSelfieNotCompleted(_:)`, `sectionAlreadyRunning(_:)`, `watchlistProcessFailed(_:)`, and `interrupted`.

Flow-level failures are reported through `IncdFlowError` on `onError(_:)`. In addition, several modules define their own error enum, carried by the `error` field of that module's result object: for example, `VideoSelfieResult.error` (`VideoSelfieError`), `IdScanResult.error` (`IncdIdScanError`), and `FaceAuthenticationResult.error` (`FaceAuthenticationError`). When a result object has such an `error` field, it carries that module's specific failure cause for the step.



### Face Capture and Face Authentication Video Recording Errors

`SelfieScanResult` and `FaceAuthenticationResult` gain a new optional field:

```swift
public var videoRecordingError: SelfieScanError?          // on SelfieScanResult
public var videoRecordingError: FaceAuthenticationError?  // on FaceAuthenticationResult
```

`SelfieScanError` and `FaceAuthenticationError` each define dedicated cases for it:

```swift
case insufficientStorageForVideoRecording  // new
case videoRecordingFailed
```

`insufficientStorageForVideoRecording` is reported when Deepsight video recording is skipped because the device has less than 15 MB of free storage. `videoRecordingFailed` is reported when the video could not be recorded or finalized — for example, when the hardware video encoder was invalidated while the app was in the background. Both are non-fatal: the face capture itself completes normally, and the problem is surfaced only via `videoRecordingError`. The `error` field remains reserved for terminal failures, so existing error handling is unaffected. If you `switch` exhaustively over `SelfieScanError` or `FaceAuthenticationError`, add handlers for these cases.



***

## Collect Identity Data

| Module                                                                                   | Result Object        | Delivered Via                                                                                                                                                                                                  |
| ---------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Document Capture](/sdk-reference/module-document-scan/) | `DocumentScanResult` | `onDocumentScanCompleted(_ result: DocumentScanResult)`                                                                                                                                                        |
| [Dynamic Forms](/sdk-reference/module-dynamic-forms/)    | `DynamicFormsResult` | `onDynamicFormCompleted(_ result: DynamicFormsResult)`                                                                                                                                                         |
| [Email](/sdk-reference/module-email/)                    | `EmailAddressResult` | `onAddEmailAddressCompleted(_ result: EmailAddressResult)`                                                                                                                                                     |
| [Full Name](/sdk-reference/module-full-name/)            | `UserNameInfoResult` | `onAddFullNameCompleted(_ result: UserNameInfoResult)`                                                                                                                                                         |
| [Geolocation](/sdk-reference/module-geolocation/)        | `GeolocationResult`  | `onGeolocationCompleted(_ result: GeolocationResult)`                                                                                                                                                          |
| [ID Capture](/sdk-reference/module-id-scan/)             | `IdScanResult`       | `onIdFrontCompleted(_ result: IdScanResult)`<br />`onIdFrontAttemptCompleted(_ result: IdScanResult)`<br />`onIdBackCompleted(_ result: IdScanResult)`<br />`onIdBackAttemptCompleted(_ result: IdScanResult)` |
| [ID OCR](/sdk-reference/module-id-info/)                 | `OcrResult`          | `onOcrCompleted()`                                                                                                                                                                                             |
| [NFC](/sdk-reference/module-nfc-scan/)                   | `NFCScanResult`      | `onNFCScanCompleted(_ result: NFCScanResult)`                                                                                                                                                                  |
| [Phone](/sdk-reference/module-phone/)                    | `PhoneNumberResult`  | `onAddPhoneNumberCompleted(_ result: PhoneNumberResult)`                                                                                                                                                       |
| [QR Scan](/sdk-reference/module-qr-scan/)                | `QRScanResult`       | `onQRScanCompleted(_ result: QRScanResult)`                                                                                                                                                                    |
| [Selfie](/sdk-reference/module-selfie/)                  | `SelfieScanResult`   | `onSelfieScanCompleted(_ result: SelfieScanResult)`<br />`onSelfieAttemptCompleted(_ result: SelfieScanResult)`                                                                                                |
| [Video Selfie](/sdk-reference/module-video-selfie/)      | `VideoSelfieResult`  | `onVideoSelfieCompleted(_ result: VideoSelfieResult)`                                                                                                                                                          |

### Module-Specific Errors

Unless noted below, a module's errors surface on the shared `onError(_:)` path.

- **Selfie**: `SelfieScanResult.error` remains the terminal selfie failure. `SelfieScanResult.videoRecordingError` reports a non-fatal Deepsight recording problem independently. If the device has less than 15 MB of free storage, capture continues without video and `videoRecordingError` is `insufficientStorageForVideoRecording`; if the video could not be recorded or finalized, it is `videoRecordingFailed`.
- **Video Selfie**: Unlike most modules, a Video Selfie failure ends the flow. `VideoSelfieResult.error` (`VideoSelfieError`) is delivered through `onVideoSelfieCompleted(_:)` whenever captured video or audio data exists; if `error` is non-`nil`, the SDK additionally calls `onError(_:)` with `IncdFlowError.videoSelfieNotCompleted(_:)`, wrapping that same `VideoSelfieError`. Cases include `videoSelfieNotAuthorized`, `screenRecordingPermissionsDenied`, `recordingMicrophonePermissionsDenied`, `voiceConsentMicrophonePermissionsDenied`, `internalError(_:)`, and `error(_:)` (wrapping an `IncdError`).

***

## Verify and Authenticate

| Module                                                                                                | Result Object                 | Delivered Via                                                           |
| ----------------------------------------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------- |
| [Antifraud](/sdk-reference/module-antifraud/)                         | `AntifraudResult`             | `onAntifraudCompleted(_ result: AntifraudResult)`                       |
| [CURP Validation](/sdk-reference/module-curp-validation/)             | `CURPValidationResult`        | `onCURPValidationCompleted(_ result: CURPValidationResult)`             |
| [Custom Watchlist](/sdk-reference/module-custom-watchlist/)           | `CustomWatchlistResult`       | `onCustomWatchlistCompleted(_ result: CustomWatchlistResult)`           |
| [eKYB (electronic Know-Your-Business)](/sdk-reference/module-ekyb/)   | `EkybResult`                  | `onExternalValidationEkybCompleted(_ result: EkybResult)`               |
| [eKYC (electronic Know-Your-Customer)](/sdk-reference/module-ekyc/)   | `EKYCResult`                  | `onEKYCCompleted(_ result: EKYCResult)`                                 |
| [Face Authentication](/sdk-reference/module-face-authentication/)     | `FaceAuthenticationResult`    | `onFaceAuthenticationCompleted(_ result: FaceAuthenticationResult)`     |
| [Face Match](/sdk-reference/module-face-match/)                       | `FaceMatchResult`             | `onFaceMatchCompleted(_ result: FaceMatchResult)`                       |
| [Global Watchlist](/sdk-reference/module-global-watchlist/)           | `GlobalWatchlistModuleResult` | `onGlobalWatchlistCompleted(_ result: GlobalWatchlistModuleResult)`     |
| [Government Validation](/sdk-reference/module-government-validation/) | `GovernmentValidationResult`  | `onGovernmentValidationCompleted(_ result: GovernmentValidationResult)` |
| [Process ID](/sdk-reference/module-process-id/)                       | `IdProcessResult`             | `onIdProcessed(_ result: IdProcessResult)`                              |

### Module-Specific Errors

Unless noted below, a module's errors surface on the shared `onError(_:)` path.

- **Face Authentication**: `FaceAuthenticationError` is a dedicated face-authentication error enum, carried by the `error` field of `FaceAuthenticationResult`. Its cases include `spoofAttemptDetected(_:)`, `userIsNotRecognized(_:)`, `faceMaskDetected(_:)`, `deniedCameraPermissions`, `userCancelled`, and `error(_:)` (wrapping an `IncdError`). `FaceAuthenticationResult.videoRecordingError` separately reports non-fatal Deepsight recording problems. If the device has less than 15 MB of free storage, authentication continues without video and `videoRecordingError` is `insufficientStorageForVideoRecording`; if the video could not be recorded or finalized, it is `videoRecordingFailed`.

***

## Capture Signatures and Consent

These modules' errors surface on the shared `onError(_:)` path.

| Module                                                                                                      | Result Object                  | Delivered Via                                                               |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------ | --------------------------------------------------------------------------- |
| [AES (Advanced Electronic Signature)](/sdk-reference/module-aes/)           | `AESResult`                    | `onAESCompleted(result: AESResult)`                                         |
| [Combined Consent](/sdk-reference/module-combined-consent/)                 | `CombinedConsentResult`        | `onCombinedConsentsGiven(_ result: CombinedConsentResult)`                  |
| [Machine Learning Consent](/sdk-reference/module-machine-learning-consent/) | `MachineLearningConsentResult` | `onMachineLearningConsentCompleted(_ result: MachineLearningConsentResult)` |
| [QES (Qualified Electronic Signature)](/sdk-reference/module-qes/)          | `QESResult`                    | `onQESCompleted(result: QESResult)`                                         |
| [Signature](/sdk-reference/module-signature/)                               | `SignatureFormResult`          | `onSignatureCollected(_ result: SignatureFormResult)`                       |
| [User Consent](/sdk-reference/module-user-consent/)                         | `UserConsentResult`            | `onUserConsentGiven(_ result: UserConsentResult)`                           |

***

## Add Human-Assisted Verification

This module's errors surface on the shared `onError(_:)` path.

| Module                                                                                | Result Object      | Delivered Via                                                                                                                                                                                                            |
| ------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Video Conference](/sdk-reference/module-conference/) | No result payload. | `onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?)`. Queue updates arrive through `onQueuePositionChanged(_ newQueuePosition: Int)` and `onEstimatedWaitingTime(_ waitingTimeInSeconds: Int)`. |

***

## Configure the User Experience

This module's errors surface on the shared `onError(_:)` path.

| Module                                                                                | Result Object      | Delivered Via                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Custom Module](/sdk-reference/module-custom-module/) | No result payload. | `onCustomModuleStarted(callbackName: String, onCustomModuleCompleted: @escaping (CustomModuleStatus) -> Void)`. You return a `CustomModuleStatus`: `ok`, `fail`, `warn`, or `unknown`. Completion is also reported through `onCustomModuleCompleted(_ result: IncdError?)`. |

***

## View Results

This module's errors surface on the shared `onError(_:)` path.

| Module                                                                    | Result Object | Delivered Via                             |
| ------------------------------------------------------------------------- | ------------- | ----------------------------------------- |
| [Results](/sdk-reference/module-results/) | `UserScore`   | `onUserScoreFetched(_ result: UserScore)` |

***

## Configure iOS-Specific Experiences

| Module                                                                      | Result Object      | Delivered Via                                                                                                                                                                                                |
| --------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Approval](/sdk-reference/module-approval/) | `ApprovalResult`   | `onApproveCompleted(_ result: ApprovalResult)`                                                                                                                                                               |
| [Captcha](/sdk-reference/module-captcha/)   | `CaptchaResult`    | `onCaptchaCompleted(_ result: CaptchaResult)`                                                                                                                                                                |
| [Intro](/sdk-reference/module-intro/)       | No result payload. | On success, the flow advances to the next module with no callback. If the user dismisses the step, `userCancelledSession()` is called; any other failure surfaces through `onError(_ error: IncdFlowError)`. |

<br />

---

- Path: `sdk-reference/ios-risk-analysis`
- URL: https://developer.incode.com/sdk-reference/ios-risk-analysis/
- Markdown: https://developer.incode.com/sdk-reference/ios-risk-analysis.md

# Risk Analysis

Risk Analysis is an optional Incode feature, built in collaboration with [Sardine](https://www.sardine.ai/), that adds fraud and risk signals to your onboarding flow.

On iOS, Risk Analysis is enabled by linking the Risk Analysis build variant. Once the feature is linked and the SDK runs in standard mode, setup is automatic: the SDK retrieves the Sardine configuration from Incode's backend, initializes Sardine's SDK internally, and results become available on the Sardine dashboard after the flow completes. No manual token exchange or additional integration code is required.

***

## Set Up Risk Analysis

To use Risk Analysis on iOS, you must link an SDK [build variant](/sdk-reference/ios-sdk/#distribution-and-variants) that includes the Risk Analysis feature: the `-ra` variant suffix. Risk Analysis code is compiled out of variants that do not include this feature. Choose the variant that includes Risk Analysis when [installing the SDK](/sdk-reference/setup-ios/#format-a-variant-version), then run the SDK in `.standard` mode.

No integrator code is required beyond linking the `-ra` variant.

### What Happens Automatically

When the `-ra` variant is linked and `sdkMode` is `.standard`, the SDK initializes Risk Analysis automatically during session setup:

1. It requests the Sardine configuration (client ID, session key, user ID, and environment) from Incode's backend.
2. It initializes Sardine's SDK internally with that configuration.
3. It reports screen activity to Sardine as the flow progresses.

In [Capture-Only mode](/sdk-reference/ios-capture-only-sdk/), the automatic Risk Analysis setup does not run.

### See Risk Analysis on the Sardine Dashboard

After the flow completes, Risk Analysis results are available in the [Sardine dashboard](https://dashboard.sandbox.sardine.ai/document-verifications). Contact your Incode representative for access.

***

For help, see [API Reference](/sdk-reference/ios-api-reference/) or contact your Incode representative. You can also view Sardine's [Getting Started documentation](https://docs.sardine.ai/docs/risk/getting-started) for background on the risk signals it provides. Accessing Sardine's documentation requires Sardine credentials; see their [getting API access](https://docs.sardine.ai/docs/risk/api-access) guide.

<br />

---

- Path: `sdk-reference/ios-run-flows-configured-in-dashboard`
- URL: https://developer.incode.com/sdk-reference/ios-run-flows-configured-in-dashboard/
- Markdown: https://developer.incode.com/sdk-reference/ios-run-flows-configured-in-dashboard.md

# Run Flows Configured in Dashboard

This integration pattern for the iOS SDK uses the Workflows API. The Workflows API runs onboarding flows defined in Dashboard instead of in your app. It uses modules and configurations you set up in Dashboard, so you don't need to define flows locally by adding `flowConfig` objects to your `IncdOnboardingFlowConfiguration`. You can change a Workflow's configuration in Dashboard without modifying your code.

Unlike the local patterns, where you assemble the flow and configure each module in code, flow content is configured in Dashboard. The modules included in the flow and their settings come from the activated Workflow. Your app only needs to reference it by ID. If you want full control over the flow in client code, see [Configure Flows Locally and Run End to End](/sdk-reference/ios-configure-locally-end-to-end/). If you need to insert your own screens or logic between SDK modules, see [Configure Flows Locally and Run Step by Step](/sdk-reference/ios-configure-flows-locally-and-run-step-by-step/). For more information about these patterns, see [Integration Approaches](/sdk-reference/ios-flow-configuration/).

This page covers session creation and section execution only. Ensure you have followed the steps to [install and initialize](/sdk-reference/setup-ios/) the Incode iOS SDK first.

For the modules a Workflow can include, see [Modules](/sdk-reference/ios-individual-modules/). For instructions on configuring Workflows in Dashboard, see [Configure Workflows](/dashboard-platform-administration/workflows-20/).


## Set Up This Integration Pattern

Complete the following steps in order.

### Create a Delegate to Receive SDK Results

Conform to `IncdOnboardingDelegate` to receive results from each module and the overall flow. Only `onSuccess()` and `onError(_:)` are required. Every other method has a default empty implementation. Override only the events for the modules your flow includes.

```swift
final class VerificationCoordinator: IncdOnboardingDelegate {

    // MARK: Required

    func onSuccess() {
        // User successfully finished the whole onboarding flow.
    }

    func onError(_ error: IncdFlowError) {
        // Onboarding flow was aborted due to an error.
        print("Flow error: \(error.description)")
    }

    // MARK: Optional (each has a default empty implementation)

    func userCancelledSession() {
        // User backed out of the flow.
    }

    func onOnboardingSessionCreated(_ result: OnboardingSessionResult) {
        // Session created successfully.
    }

    func onAddPhoneNumberCompleted(_ result: PhoneNumberResult) {
        // Phone number step completed.
    }

    func onQRScanCompleted(_ result: QRScanResult) {
        // QR scan completed.
    }

    func onIdFrontCompleted(_ result: IdScanResult) {
        // Front of the ID captured.
    }

    func onIdBackCompleted(_ result: IdScanResult) {
        // Back of the ID captured.
    }

    func onIdProcessed(_ result: IdProcessResult) {
        // ID processing/validation completed.
    }

    func onNFCScanCompleted(_ result: NFCScanResult) {
        // NFC chip read completed.
    }

    func onDocumentScanCompleted(_ result: DocumentScanResult) {
        // Supporting document (for example, proof of address) captured.
    }

    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        // Selfie scan completed.
    }

    func onFaceMatchCompleted(_ result: FaceMatchResult) {
        // Face match completed.
    }

    func onSignatureCollected(_ result: SignatureFormResult) {
        // Signature collected.
    }

    func onUserConsentGiven(_ result: UserConsentResult) {
        // User consent step completed.
    }

    func onVideoSelfieCompleted(_ result: VideoSelfieResult) {
        // Video selfie completed.
    }

    func onCaptchaCompleted(_ result: CaptchaResult) {
        // Captcha step completed.
    }

    func onGeolocationCompleted(_ result: GeolocationResult) {
        // Location captured.
    }

    func onApproveCompleted(_ result: ApprovalResult) {
        // Onboarding approval completed.
    }

    func onUserScoreFetched(_ result: UserScore) {
        // Aggregate results/score fetched.
    }

    func onQueuePositionChanged(_ newQueuePosition: Int) {
        // Position in the Video Conference queue changed.
    }

    func onEstimatedWaitingTime(_ waitingTimeInSeconds: Int) {
        // Estimated Video Conference wait time reported, in seconds.
    }

    func onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?) {
        // Video Conference call finished.
    }
}
```

The modules in the activated Workflow in Dashboard determine which of these events fire. There is no local `flowConfig` to check instead. For the shape and fields of each result object, see the corresponding page in [Modules](/sdk-reference/ios-individual-modules/).

### Create the Session Configuration

Dashboard offers two flow types, each with its own entry point:

- **Flow**: Start with `startFlow`.
- **Workflow**: The recommended Dashboard-driven orchestration, started with `startWorkflow`. It behaves like a Flow but with more customizable execution logic (branching, conditional steps, retries) maintained in Dashboard.

Use `IncdOnboardingSessionConfiguration` to specify the session token. For the full backend-issued-token integration, see [Token-Based Setup](/sdk-reference/ios-token-based-setup/).

```swift
let session = IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>")
```

Reference a specific Dashboard flow by passing its `configurationId` instead of a session token. Ensure the flow is activated in Dashboard before starting the session.

```swift
let session = IncdOnboardingSessionConfiguration(configurationId: "<FLOW_ID>")
```

If the flow fails to start, confirm the SDK is initialized and that the session configuration references a valid `configurationId`.

### Start the Onboarding Session

Before starting the session, set `presentingViewController` to the view controller the SDK presents from. This property is required. If it is not set or has been deallocated when the flow starts, the SDK reports a `presentingViewControllerNotSet` error through the delegate.

```swift
IncdOnboardingManager.shared.presentingViewController = self
```

Start the session using one of the following:

- `startFlow` runs the modules defined for the Flow in Dashboard and reports progress and results through the delegate.

  ```swift
  IncdOnboardingManager.shared.startFlow(sessionConfig: session, delegate: self)
  ```

- `startWorkflow` runs the modules defined for the Workflow in Dashboard and reports progress and results through the delegate.

  ```swift
  IncdOnboardingManager.shared.startWorkflow(sessionConfig: session, delegate: self)
  ```

#### Resume a Partially Completed Flow

Pass `moduleId` to resume a partially completed flow from a specific module:

```swift
public func startFlow(
    sessionConfig: IncdOnboardingSessionConfiguration,
    delegate: IncdOnboardingDelegate?,
    moduleId: String? = nil
)
```

#### Start a Flow from a Universal Link or URL

You can also start a flow from a universal link or URL:

```swift
public func startFlow(url: URL, delegate: IncdOnboardingDelegate?, isShortened: Bool = false)
```

---

- Path: `sdk-reference/ios-sdk`
- URL: https://developer.incode.com/sdk-reference/ios-sdk/
- Markdown: https://developer.incode.com/sdk-reference/ios-sdk.md

# Incode iOS SDK Reference

The Incode iOS SDK (`IncdOnboarding`) adds end-to-end identity verification (IDV) to your app. The UI supports custom themes, so IDV looks and feels like your product. The iOS SDK exposes a single public entry point, `IncdOnboardingManager.shared`, and is organized into **modules** (capture and verification steps). Those modules are orchestrated into **flows** and presented to the end user, with results delivered back to your app through the `IncdOnboardingDelegate`. The SDK ships as an `IncdOnboarding.xcframework` through Swift Package Manager, CocoaPods, or a manual binary. This page explains what the SDK can do and how it works.

***

## Capabilities

The Incode iOS SDK supports:

- **Identity capture**: ID scan, document capture, and [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr) data extraction.
- **Liveness and biometrics**: Selfie capture, video selfie, liveness detection, and face match.
- **NFC**: Data extraction from [Near Field Communication (NFC)](/get-started-with-incode/glossary/#nfc-scan) chips in passports and supported ID documents.
- **Compliance and risk**: Government validation, watchlist screening, and antifraud analysis.
- **Data collection**: Consents, electronic signatures, phone and email, geolocation, and custom forms.
- **Wallets**: IDV with an Apple Wallet ID.
- **Customization**: Theming, localization, and custom assets so the IDV experience matches your brand.

***

## Integration Approaches

The SDK supports three integration paths, each offering a different level of UI control. Start with the simplest path that meets your requirements.

- **Full Onboarding Flow**: The SDK owns the full UI from start to finish. Run a Dashboard-defined Flow or Workflow (`startFlow` / `startWorkflow`), or a flow you define in code (`startOnboarding`).
- **Section-by-Section**: You own the order of steps and the screens between them, running one section at a time (`startOnboardingSection`).
- **Capture-Only**: You own the UI before and after capture; Incode owns only the capture UI. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

For the full breakdown of how a flow is defined and executed, see [Integration Approaches](/sdk-reference/ios-flow-configuration/).

***

## Runtime Modes

The mode controls when and whether captured data is sent to Incode for processing. Regardless of the integration path you choose, the SDK runs in one of three modes, selected through the `SDKMode` value on `IncdOnboardingManager.shared`:

- **Standard** (`.standard`): Captures **and** submits to the Incode backend as IDV runs; results are returned through the delegate. The default.
- **Capture-Only** (`.captureOnly`): Captures on-device without sending anything to Incode. You submit from your back end.
- **Submit-Only** (`.submitOnly`): Submits previously captured data without showing capture UI.

```swift
IncdOnboardingManager.shared.sdkMode = .standard
```

In the **Public** distribution variant, `captureOnly` is restricted and reverts to `standard`.

See [SDK Modes](/sdk-reference/ios-sdk-modes/) for where `sdkMode` sits among the SDK's other configuration properties.

***

## Distribution and Variants

The SDK is distributed as `IncdOnboarding.xcframework` through three channels: Swift Package Manager, CocoaPods, or a manual binary. It ships in build variants. A variant is a linking type plus a set of optional features. Not every module is compiled into every variant, and calling an API for a feature that is not included triggers a runtime variant assertion. Pin the **exact variant version**; there is no Bill of Materials. Choose the smallest variant that includes the features your flow needs to keep binary size down.

| Variant Suffix | Type    | Description                                                                                                                                         |
| :------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-d`           | Linking | Dynamic linking. The default.                                                                                                                       |
| `-s`           | Linking | Static linking. Required for [On-Demand Resources (ODR)](/sdk-reference/setup-ios/#manage-on-demand-resources-odr). |
| `-vc`          | Feature | [Video Conference](/sdk-reference/module-conference/) and streaming.                                                |
| `-l`           | Feature | Local [face login and authentication](/sdk-reference/module-face-authentication/#standalone-face-login--l-variant). |
| `-nfc`         | Feature | [NFC](/sdk-reference/module-nfc-scan/) document scan.                                                               |
| `-ra`          | Feature | [Risk Analysis](/sdk-reference/ios-risk-analysis/).                                                                 |
| `-sna`         | Feature | [Silent Network Authentication](/sdk-reference/module-phone/#enable-silent-network-authentication).                 |
| `-m`           | Feature | Local face mask check (removed since 5.19.0; now included in all variants)                                                                          |


A variant version reads as `MAJOR.MINOR.PATCH-LinkingType[-Feature…]`: for example, `5.51.0-d` (dynamic) or `5.51.0-d-l` (dynamic + login). See [Installation](/sdk-reference/setup-ios/).

***

## Device Requirements

The SDK runs on physical iOS devices that meet the following minimum requirements:

- **Minimum iOS version:** iOS 13.0
- **Camera:** Required for the [ID Capture](/sdk-reference/module-id-scan/), [Selfie](/sdk-reference/module-selfie/), [Face Authentication](/sdk-reference/module-face-authentication/), [Video Conference](/sdk-reference/module-conference/), and [Video Selfie](/sdk-reference/module-video-selfie/) modules.
- **Microphone:** Required for the Video Conference module. Required for the Video Selfie module when audio or voice consent is enabled.
- **Location:** Required for the [Geolocation](/sdk-reference/module-geolocation/) module.
- **NFC hardware:** Required for the [NFC](/sdk-reference/module-nfc-scan/) module, on NFC-capable devices and only in the NFC (`-nfc`) variant.
- **Network:** An active HTTPS connection to the Incode Platform.

Declare the matching `Info.plist` usage keys for the capabilities your flow uses. See [Installation](/sdk-reference/setup-ios/).

***

## Data Handling and Privacy

The SDK runs the on-device half of identity verification. At a high level:

- **On-device capture and inference**: ID images, selfie and liveness video, and NFC chip data are captured on the device. On-device ML models extract their features locally. These models cover liveness detection, presentation-attack detection, face recognition, ID face detection, face occlusion, and age estimation.
- **Encrypted transmission**: Artifacts and verification requests are sent to the Incode Platform over an encrypted channel. You can also enforce end-to-end encryption, which uses Apple's native cryptography (RSA-OAEP with SHA-256 for key exchange and AES-GCM via CryptoKit for payloads). See [Security](/sdk-reference/ios-security/).
- **No sensitive logging**: The SDK does not log personally identifiable information (PII) or capture content. It ships a privacy manifest (`PrivacyInfo.xcprivacy`) declaring no tracking.
- **Server-authoritative result**: The Incode Platform holds the authoritative verification result for your back end to consume server-side. The SDK reports each module's outcome to your app through the `IncdOnboardingDelegate`.
- **Transient local state**: The SDK keeps only transient, encrypted session state on the device. Call `deleteLocalUserData()` when you are finished with a session.

***

## What's Next

Use the table below to find the page you need.

| Task                                               | Page                                                                                             |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Learn the correct order of steps to set up the SDK | [Getting Started](/sdk-reference/ios-getting-started/)           |
| Add the SDK to your project                        | [Installation](/sdk-reference/setup-ios/)                        |
| Choose how your flow is defined and executed       | [Integration Approaches](/sdk-reference/ios-flow-configuration/) |
| Capture data without sending it to Incode          | [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/)        |
| Integrate Apple Wallet Digital ID verification     | [Apple Wallet ID](/sdk-reference/ios-apple-wallet-id/)           |
| Browse modules and their configuration options     | [Modules](/sdk-reference/ios-individual-modules/)                |
| Read documents via NFC                             | [NFC](/sdk-reference/module-nfc-scan/)                           |
| Customize colors, fonts, and text                  | [Customization](/sdk-reference/ios-customization/)               |
| Add fraud and risk signals to your flow            | [Risk Analysis](/sdk-reference/ios-risk-analysis/)               |
| Solve a build problem                              | [Troubleshooting](/sdk-reference/ios-troubleshooting/)           |
| Browse the full public API                         | [API Reference](/sdk-reference/ios-api-reference/)               |
| Look up result and error objects by module         | [Results](/sdk-reference/ios-results/)                           |
| Secure the integration (E2EE, SSL pinning)         | [Security](/sdk-reference/ios-security/)                         |
| Upgrade an existing integration                    | [Migration Guide](/release-notes/migration_guide/)               |
| Check what changed in a release                    | [iOS SDK Release Notes](/release-notes/releases-ios-sdk/)        |

For help, contact your enterprise customer success manager or email [help@incode.com](mailto:help@incode.com).

---

- Path: `sdk-reference/ios-sdk-modes`
- URL: https://developer.incode.com/sdk-reference/ios-sdk-modes/
- Markdown: https://developer.incode.com/sdk-reference/ios-sdk-modes.md

# SDK Modes

The SDK runs in one of three modes, selected through the `sdkMode` property (type `SDKMode`) on `IncdOnboardingManager.shared`. The mode controls how and when captured data is sent to Incode. Choose the mode that matches your integration's network, privacy, and timing requirements.

| Mode             | What It Does                                                                                                                    | When To Use It                                                                                                                                                                                                          |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Standard**     | Captures data and sends it to Incode in real time as the flow runs. Results are returned through the delegate callbacks.        | The default. Use when the device has connectivity and you want server-side validation as each step completes.                                                                                                           |
| **Capture-Only** | Captures media on-device without sending it to Incode. You retain the captured data and submit it later from your own back end. | Use when capture and submission must be decoupled, or capture happens in an environment without a direct path to Incode. See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/). |
| **Submit-Only**  | Submits previously captured data to Incode without showing the capture UI.                                                      | Use as the counterpart to Capture-Only, once data has already been captured and needs to be submitted for verification.                                                                                                 |

The mode is set on the shared manager before a flow starts:

```swift
IncdOnboardingManager.shared.sdkMode = .standard
```

`initIncdOnboarding` authenticates the SDK and prepares it for use.

***

## Standard Mode

Standard mode is the default (`SDKMode.standard`). The SDK captures each module's data and sends it to Incode as the flow progresses. Server-side validation results are available in real time through the `IncdOnboardingDelegate` result callbacks. No additional configuration is required.

```swift
IncdOnboardingManager.shared.sdkMode = .standard
```

See [Getting Started](/sdk-reference/ios-getting-started/) for the standard integration.

***

## Capture-Only Mode

Capture-Only mode (`SDKMode.captureOnly`) runs the capture UI on the device without sending the captured data to Incode during the flow. The result objects include the raw capture data, and your back end submits it separately. This mode uses a dedicated integration path.

```swift
IncdOnboardingManager.shared.sdkMode = .captureOnly
```

In the **Public** distribution variant, `captureOnly` is restricted and the SDK reverts to `standard`.

See [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/) for the full guide, including how the raw captures and diagnostics are delivered to your app.

***

## Submit-Only Mode

Submit-Only mode (`SDKMode.submitOnly`) is the counterpart to Capture-Only: it submits previously captured data to Incode without showing the capture UI.

```swift
IncdOnboardingManager.shared.sdkMode = .submitOnly
```

For fully programmatic capture and verification without presenting any SDK UI, use the headless APIs described in the [API Reference](/sdk-reference/ios-api-reference/).

<br />

---

- Path: `sdk-reference/ios-security`
- URL: https://developer.incode.com/sdk-reference/ios-security/
- Markdown: https://developer.incode.com/sdk-reference/ios-security.md

# Security

This page describes security considerations for integrating the Incode iOS SDK.

***

## End-to-End Encryption (E2EE)

End-to-end encryption (E2EE) adds an extra layer of security by encrypting the data transmitted between the server and the client. The process begins with a key exchange: the client and server share keys for encrypting and decrypting messages. This exchange ensures all later communications are encrypted, so only the intended server and client can decrypt the messages.

For E2EE, the SDK uses Apple's native cryptography (CryptoKit) instead of OpenSSL:

- RSA-OAEP with SHA-256 asymmetric encryption for the secure key exchange.
- AES-GCM symmetric encryption (CryptoKit) for securing server requests and responses. AES stands for Advanced Encryption Standard.

### Enable End-to-End Encryption

Complete the following steps in order.

#### Initialize the SDK with a Custom E2EE Server

Provide your dedicated E2EE endpoint through the `e2eeURL` parameter when you initialize the SDK:

```swift
IncdOnboardingManager.shared.initIncdOnboarding(
    url: "<YOUR_API_URL>",
    e2eeURL: "<YOUR_E2EE_URL>",
    apiKey: "<YOUR_API_KEY>"
) { success, error in
    if let error = error {
        print("Incode init failed: \(error.description)")
        return
    }
    // SDK is ready.
}
```

#### Enable E2EE on the Session Configuration

Turn on E2EE when building your `IncdOnboardingSessionConfiguration`:

```swift
let session = IncdOnboardingSessionConfiguration(
    token: "<SESSION_TOKEN>",
    e2eEncryptionEnabled: true
)
```

#### Start the Flow

Pass the session configuration to your chosen start method, depending on your integration approach:

- `startFlow(sessionConfig:delegate:moduleId:)` runs the server-defined Dashboard flow directly from the session configuration.
- `setupOnboardingSession(sessionConfig:completion:)` creates the session without starting modules. This is useful when running SDK-defined sections.
- `startOnboarding` is a separate method for defining a flow in code rather than using a server-defined Dashboard flow. It requires an `IncdOnboardingFlowConfiguration` describing the steps to run. It is not interchangeable with `startFlow`.

```swift
IncdOnboardingManager.shared.startFlow(sessionConfig: session, delegate: self)
```

See [Configure Flows Locally and Run End to End](/sdk-reference/ios-configure-locally-end-to-end/) for running a flow end to end and [Integration Approaches](/sdk-reference/ios-flow-configuration/) for building a flow in code.

***

## Electronic Signatures: AES and QES

The iOS SDK supports the [Advanced Electronic Signature (AES)](/sdk-reference/module-aes/) and [Qualified Electronic Signature (QES)](/sdk-reference/module-qes/) modules.

***

## NFC

The NFC document reader uses AES/3DES (DESede) secure messaging to read passport and other electronic ID chips, matching standard BAC/PACE/Chip Authentication per ICAO 9303. Single DES is used only as an internal component of the ISO/IEC 9797-1 Retail MAC used by the 3DES suite, not as a standalone cipher.

***

## Jailbreak Detection

The SDK checks for jailbroken or tampered devices.

As of iOS SDK 5.45.0, the public `disableJailbreakDetection` flag is removed and the check cannot be disabled.

Add the `Info.plist` entries listed in [Installation](/sdk-reference/setup-ios/).

***

## Screen and Session Recording

When a flow is configured to record the session, such as for audit or regulatory purposes, the SDK manages screen recording internally and gates it on permission. Control session recording through the flow and session configuration (`recordSession`, `mergeSessionRecordings`).

***

## SSL Pinning

```swift
IncdOnboardingManager.shared.configureSSLPinning(enabled: true, forced: true)
```

Both parameters are optional (`Bool?`); pass `nil` for either to leave its current value unchanged. A pinning failure surfaces as an `IncdError.sslPinningFailed` error and triggers an `onSSLPinningFailed()` delegate callback.

***

## Diagnostics

`sendDiagnosticsData` defaults to `true`. Set it to `false` to disable diagnostic collection and delivery. In [Capture-Only mode](/sdk-reference/ios-capture-only-sdk/), enabled diagnostics are returned through `onDiagnosticsDataReceived(_:)`.

---

- Path: `sdk-reference/ios-third-party-libraries`
- URL: https://developer.incode.com/sdk-reference/ios-third-party-libraries/
- Markdown: https://developer.incode.com/sdk-reference/ios-third-party-libraries.md

# Third-Party Libraries

The Incode iOS SDK builds on a set of third-party libraries and services. This page groups them by purpose, not as a full dependency tree. Use it to complete your own privacy review, App Store App Privacy details, or internal SDK inventory.

This page covers only the SDK's own dependencies. Your app may add others. It omits build-only tooling, like the Swift compiler, Xcode, and Swift Package Manager, since these don't ship in your app. It also omits dependencies used only by the Incode sample app (Omni), since the sample app isn't part of the published SDK.

Most third-party components are vendored into the SDK as binary `.xcframework` libraries or as source. Exact pinned versions change with each release. For the current, per-version list, see the API changes and dependency sections of the [iOS SDK release notes](/release-notes/releases-ios-sdk/).

***

## How Data Is Handled

Capture and biometric processing happen on the device. The SDK sends capture artifacts and verification requests to the Incode Platform over an encrypted channel. It does not log PII or capture content.

For more detail, see [Security](/sdk-reference/ios-security/).

***

## Capture, Media, and On-Device Processing

| Library                                   | Purpose                                                                                                                                                                                               | Used by                                                                                                                                                                                                                                         |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OpenCV: `opencv2.xcframework` (vendored)  | Computer-vision primitives for the on-device ML and image-processing components: liveness and presentation-attack detection, face recognition, ID face detection, face occlusion, and age estimation. | [Selfie](/sdk-reference/module-selfie/), [ID Capture](/sdk-reference/module-id-scan/), [Document Capture](/sdk-reference/module-document-scan/) |
| OpenSSL: `OpenSSL.xcframework` (vendored) | Cryptography for the ePassport (eMRTD) chip protocol stack—BAC, PACE, and chip authentication—and X.509 certificate parsing.                                                                          | [NFC](/sdk-reference/module-nfc-scan/)                                                                                                                                                                          |

Camera and media capture are built on Apple's native iOS frameworks, so there is no third-party camera library to disclose.

The SDK also includes on-device machine-learning models for liveness and presentation-attack detection, face recognition, ID face detection, face occlusion, and age estimation. These are first-party Incode components, shipped in `IncdRecogKit`. They run locally on the device. OpenCV, above, provides the vision primitives they build on.

***

## Networking and Storage

The iOS SDK's networking and persistence are built on Apple's native frameworks rather than on third-party libraries.

| Concern                            | iOS implementation                                                                                                                                  |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Requests to the Incode Platform    | Apple's native networking stack.                                                                                                                    |
| Request and response serialization | Apple's native `Codable`.                                                                                                                           |
| Local and offline onboarding state | A first-party storage manager (`IncdOnboardingStorageManager`) backed by Apple's Core Data. This is the equivalent of Android's on-device database. |

For how data is protected in transit and at rest, see [Security](/sdk-reference/ios-security/).

***

## Platform Services

On iOS, device location and wallet and pass integration are handled by Apple's native platform frameworks, not by third-party libraries:

- **Device location** uses Apple's native Core Location. See [Geolocation](/sdk-reference/module-geolocation/).
- **Wallet and pass integration** uses Apple's native PassKit.

***

## Contact, Localization, and UI

| Library                             | Purpose                              | Used by                                                               |
| ----------------------------------- | ------------------------------------ | --------------------------------------------------------------------- |
| PhoneNumberKit (vendored as source) | Phone number parsing and validation. | [Phone](/sdk-reference/module-phone/) |

UI and theming use Apple's native UIKit and SwiftUI together with Incode's own theming layer. Runtime string localization uses Apple's native localization mechanisms. See [Customization](/sdk-reference/ios-customization/). No third-party UI or animation library is bundled.

***

## Real-Time Video

| Library or Service                                       | Purpose                                                                                                                                      |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| OpenTok (Vonage Video): `OpenTok.xcframework` (vendored) | Real-time video conferencing with a remote agent. See [Video Conference](/sdk-reference/module-conference/). |

***

## Telemetry and Diagnostics

| Service | Purpose                            | Notes                                                                             |
| ------- | ---------------------------------- | --------------------------------------------------------------------------------- |
| Statsig | Feature flags and experimentation. | Vendored into the SDK as source, rather than as the public Statsig Swift package. |

***

## Risk and Antifraud

| Capability                                                                  | Purpose                                                                         | Notes                                                                                                                                                                                                                     |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Device-risk provider—Sardine: `MobileIntelligence.xcframework` (vendored)   | Optional third-party device-risk and antifraud signals.                         | Present only in the `-ra` (risk-analysis) build variant and used only when device-risk analysis is provisioned for your configuration. See [Antifraud](/sdk-reference/module-antifraud/). |
| Silent Network Authentication—IDlayrKit: `IDlayrKit.xcframework` (vendored) | Optional telco-based (Silent Network Authentication) phone-number verification. | Present only in the `-sna` build variant. Used by the [Phone](/sdk-reference/module-phone/) module.                                                                                       |

***

## Framework and Utility Libraries

These support the SDK internally. They don't collect end-user data. On iOS, they are provided by Apple's native frameworks rather than by third-party libraries.

- **Dependency injection**: None. The SDK does not bundle a third-party dependency-injection container; wiring is done in first-party code.
- **Asynchronous and reactive**: Apple's native Swift Combine and async/await. No third-party reactive library is bundled.
- **Logging**: Handled in first-party code. The SDK does not log personally identifiable information (PII) or capture content.

***

## Release Hardening

The SDK's own code, including source-vendored dependencies like PhoneNumberKit and Statsig, compiles into the precompiled `IncdOnboarding.xcframework` you integrate. Other third-party components, such as OpenCV, OpenSSL, OpenTok, and the optional risk-analysis and SNA libraries, ship as their own separate `.xcframework` libraries. All are built with standard release optimizations at build time; this doesn't affect the runtime behavior your integration relies on.

<br />

---

- Path: `sdk-reference/ios-token-based-setup`
- URL: https://developer.incode.com/sdk-reference/ios-token-based-setup/
- Markdown: https://developer.incode.com/sdk-reference/ios-token-based-setup.md

# Token-Based Setup

Initialize the SDK without an API key by providing only a URL to `initIncdOnboarding`, then using a session `token` to configure your onboarding session.

Token-based setup is a security measure that avoids exposing your API key in the mobile app. Instead of embedding the API key or sending it to the app, your backend uses the API key to create a session token, then sends that token to the app to start the onboarding session. This prevents attackers from extracting the API key and calling Incode APIs on your behalf.

## Prerequisites

* A session `token` issued by your backend.
* The API URL provided by Incode, ending in `/0` — the environment that does not require an API key.

## Set up the SDK with a token

Token-based setup has three steps: initialize the SDK with only a URL, configure your session with a `token`, then start onboarding or set up a section-based flow.

### 1. Initialize the SDK without an API key

Provide only the `url` to `initIncdOnboarding` and omit `apiKey`. Use the URL ending in `/0`, which specifies the environment that does not require an API key.

```swift
IncdOnboardingManager.shared.initIncdOnboarding(
    url: "https://demo-api.incodesmile.com/0"
) { success, error in
    // `success` is `true` once the SDK is ready; `error` is an `IncdInitError` on failure.
}
```

See [Installation](/sdk-reference/setup-ios/#initialize-the-sdk) for the full parameter list.

### 2. Configure the session with a token

Create the onboarding session on your backend with the `omni/start` API method, which returns a `token`. Pass that token to `IncdOnboardingSessionConfiguration` before starting the flow.

```swift
let sessionConfig = IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>")
```

You do not need to set `interviewId` or `configurationId`. The `token` alone is enough, and all configuration set on that session is applied.

### 3. Start onboarding or set up a section-based flow

Pass the configured `IncdOnboardingSessionConfiguration` to `startOnboarding`, `setupOnboardingSession`, `startFlow`, or `startWorkflow`. Token-based setup works with all of the [integration patterns](/sdk-reference/ios-flow-configuration/).

Running the whole flow end to end with `startOnboarding`:

```swift
let flowConfig = IncdOnboardingFlowConfiguration()
flowConfig.addIdScan()
flowConfig.addSelfieScan()

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: sessionConfig,
    flowConfig: flowConfig,
    delegate: self
)
```

Running the flow step by step with `setupOnboardingSession` and sections:

```swift
IncdOnboardingManager.shared.setupOnboardingSession(sessionConfig: sessionConfig) { result in
    guard result.error == nil else {
        // The session could not be created. Read `result.error`.
        return
    }

    let flowConfig = IncdOnboardingFlowConfiguration()
    flowConfig.addIdScan()

    IncdOnboardingManager.shared.startOnboardingSection(
        flowConfig: flowConfig,
        sectionTag: "id",
        delegate: self
    )
}
```

## Token expiration

Tokens are long-lived, so expiration during a session is unlikely. If a token does expire mid-session, the backend returns a 401 error, which is propagated to the SDK. Tokens cannot be refreshed; the user must start a new onboarding session, which generates a new token.

---

- Path: `sdk-reference/ios-troubleshooting`
- URL: https://developer.incode.com/sdk-reference/ios-troubleshooting/
- Markdown: https://developer.incode.com/sdk-reference/ios-troubleshooting.md

# Troubleshooting

This page lists common iOS SDK integration issues and how to resolve them. If you need additional support, contact your Incode account representative or the support channel provided to your organization. When reporting an integration issue, include:

- SDK version, from `IncdOnboardingManager.version` (for example: `5.51.0`), and the variant you installed (for example: `-d-l`).
- iOS version and device model.
- The module/step where it occurs and the exact error case (`IncdInitError`/`IncdFlowError`/`IncdError`) and its `description`.
- Whether you're using a Dashboard Flow/Workflow or a code-defined flow.
- The `SDKMode`.
- Relevant SDK logs (enable with `loggingEnabled: true` at init).

Avoid sharing API keys, session tokens, or any end-user PII in bug reports.

## The App Crashes or a Feature "Isn't Included"

**Cause**: You're calling an API for a feature that isn't compiled into your [variant](/sdk-reference/ios-sdk/#distribution-and-variants). For example, `startFaceLogin` needs the `-l` variant, NFC needs `-nfc`, video conference needs `-vc`.

**Fix**: Switch to a variant that includes the feature.


## The Camera/Microphone Permission Prompt Never Appears, or the Flow Fails Immediately

**Cause**: A required `Info.plist` usage-description key is missing.

**Fix**: Add the keys for the modules you use; see [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions). Missing keys also cause App Store rejection.


## `onError` Reports `permissionsDenied`

**Cause**: The user declined camera, microphone, or location access.

**Fix**: Detect the case and route the user to **Settings** to re-enable it.


## Nothing Is Presented After I Start a Flow

**Cause**: `IncdOnboardingManager.shared.presentingViewController` was not set before starting the flow. Without it, UI flows fail with `presentingViewControllerNotSet`.

**Fix**: Set `presentingViewController` to a visible view controller **before** starting the flow.


## Initialization Behaves Differently on a Real Device and the Simulator

**Cause**: `IncdInitError.simulatorDetected` is returned on simulators for certain configurations, and `testModeEnabled` when `testMode: true`.

**Fix**: Verify `url`, `apiKey`, and that `testMode` is set as intended.


## IncdError.integrityCompromised

**Cause**: The device failed the SDK's runtime integrity check via `isSDKEntirelyInitialized`. It returns `flag == false` with `error` set to `IncdError.integrityCompromised` when runtime tampering is detected.

**Fix**: This check cannot be disabled; the `disableJailbreakDetection` flag was removed as of SDK 5.45.0. If you need to test on a jailbroken/tampered device, use a clean device or simulator instead.


## IncdError.resourcesNotFound

**Cause**: ML resources aren't available.

**Fix**: If you use the **static** variant with On-Demand Resources, download them first. See [Manage On-Demand Resources](/sdk-reference/setup-ios/#manage-on-demand-resources-odr).


## IncdFlowError.sectionAlreadyRunning

**Cause**: You started a new section while one was still active.

**Fix**: Wait for the current section to finish before calling `startOnboardingSection` again.


## Network/TLS Failures After Enabling Pinning

**Cause**: `IncdError.sslPinningFailed` indicates the server certificate didn't match.

**Fix**: Re-check `configureSSLPinning(enabled:forced:)` and your network environment. Proxies break pinning.


## ID/Selfie Capture Keeps Failing Quality Checks

**Cause**: Inspect the result objects: `IdScanResult.scanStatus` (`errorGlare`, `errorSharpness`, `errorReadability`, `wrongSide`) and `SelfieScanResult.error` (`spoofDetected`, `faceMaskDetected`, `lensesDetected`, `tooDark`).

**Fix**: Show guidance to the user and consider the relevant tutorial and retake options.


## Strings Are Wrong or in the Wrong Language

**Cause**: Runtime language or string customization isn't configured as expected.

**Fix**: See [Localize Display Text](/sdk-reference/ios-customization/#localize-display-text) for runtime language override and string customization.

---

- Path: `sdk-reference/module-aes`
- URL: https://developer.incode.com/sdk-reference/module-aes/
- Markdown: https://developer.incode.com/sdk-reference/module-aes.md

# AES (Advanced Electronic Signature)

The AES (Advanced Electronic Signature) module shows the user the documents to sign, collects their consent, and captures a certificate-backed electronic signature. That digital certificate verifies their identity, making the signed document legally binding and compliant.

For an overview of this module and how it works, see [Advanced Electronic Signature](/features-and-modules/advanced-electronic-signature/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability**: All variants.

AES uses the Incode Design System V2 experience.



## Add AES

Add the module to your `IncdOnboardingFlowConfiguration` with `addAes(configuration:)`:

```swift
// Default configuration
flowConfig.addAes()

// With a custom configuration
flowConfig.addAes(configuration: AESConfiguration(uploadDocument: true, downloadDocument: true))
```

- `configuration` is optional. It defaults to `nil`. Pass an `AESConfiguration` to control document upload and download. See [Configuration Options](#configuration-options). 
  - `uploadDocument` lets the user pick and upload the PDF to be signed before the signing screen. 
  - `downloadDocument` adds a **Download document** action to the success screen, which then waits for the user instead of closing automatically. The document card on the signing screen opens a read-only preview either way.
- `showCertificateOnSuccess` was removed in iOS SDK 5.47.0. See the [Migration Guide](migration_guide#migration-to-5470) for the required call-site change.

### Example

The example below builds a custom `AESConfiguration` that shows the upload screen and downloads the signed PDF, adds the AES module to the flow, starts onboarding, and receives the outcome through the `onAESCompleted` delegate callback.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addAes(
    configuration: AESConfiguration(uploadDocument: true, downloadDocument: true)
)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)

// ...

extension MyViewController: IncdOnboardingDelegate {
    func onAESCompleted(result: AESResult) {
        if let error = result.error {
            // Handle AESError
        } else if result.success {
            // Documents signed successfully
        }
    }
}
```

## Configuration Options

Configure the module by passing an `AESConfiguration` to `addAes(configuration:)`.

| Option             | Type    | Description                                                                                                                                      |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `uploadDocument`   | `Bool?` | When `true`, shows the AES upload screen before the standard AES screens. When left `nil`, treated as `false`.                                   |
| `downloadDocument` | `Bool?` | When `true`, the success screen offers a **Download document** action for the signed PDF. When left `nil`, treated as `false`.                  |



## Result

The module delivers an `AESResult` to the `onAESCompleted(result:)` callback on your `IncdOnboardingDelegate`. `onAESCompleted` is always called, whether or not signing succeeded, and the user then continues with the rest of the flow.

`AESResult` fields:

- `success: Bool`: `true` if the documents were signed successfully.
- `error: AESError?`: The signing error, or `nil` if there was no error.

## Errors

`AESError` cases:

- `noDocuments`: No documents were available for the session.
- `failedToSign`: Signing failed.

<br />

---

- Path: `sdk-reference/module-antifraud`
- URL: https://developer.incode.com/sdk-reference/module-antifraud/
- Markdown: https://developer.incode.com/sdk-reference/module-antifraud.md

# Antifraud

The Antifraud module compares the current session against prior sessions and known identities to detect signs of fraud. Its screen is designed to execute in the background; it only appears briefly while the check completes.

For an overview of this module and how it works, see [Antifraud Check](/features-and-modules/antifraud-check/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Antifraud

Add the module with `addAntifraud()`. Add Antifraud as the last module in your flow. The one exception is when you also use the Custom Watchlist module. In that case, call `addAntifraud()` first, then `addCustomWatchlist()`.

```swift
flowConfig.addAntifraud()
```

## Configuration Options

Antifraud has no configurable settings.

## Result

```swift
func onAntifraudCompleted(_ result: AntifraudResult)
```

`AntifraudResult` fields:

- `response: AntifraudResponse?`: The outcome of the antifraud check, including its result status and which check produced it; `nil` when no response was obtained. See `AntifraudResponse` below.
- `error: IncdError?`: The error that occurred while checking for fraud, if any; otherwise, `nil`.

`AntifraudResponse` fields:

- `result: AntifraudStatus`: The outcome of the antifraud check: `FAILED`, `PASSED`, `NOT_EXECUTED`, or `UNKNOWN`.

- `stepName: AntifraudStepName?`: The antifraud check that produced this result: `FuzzyFieldAntifraudExecutor`, `IdFaceAntifraudExecutor`, `SelfieFaceAntifraudExecutor`, or `UNKNOWN`.

## Headless

```swift
IncdOnboardingManager.shared.antifraudCheck { result in /* AntifraudResult? */ }
```

<br />

---

- Path: `sdk-reference/module-approval`
- URL: https://developer.incode.com/sdk-reference/module-approval/
- Markdown: https://developer.incode.com/sdk-reference/module-approval.md

# Approval

The Approval module finalizes an onboarding flow by deciding whether to approve the user, then registers approved users in the Incode database. The approval decision reflects the user's overall score across the capture and verification steps that ran before it. Approval has no UI; it runs silently at the end of the flow and reports its outcome through a delegate callback.

In Dashboard, Approval isn't a module. It's a flow setting you enable when building the flow. You can also add it to a flow configuration in code, as shown below. Either way, the SDK maps it internally to `IncdOnboardingFlowConfiguration.addApproval()` and reports the outcome the same way: iOS fires `onApproveCompleted(_:)` when the step completes, regardless of whether the flow came from Dashboard or from code. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Approval

1. Add Approval after the capture and verification modules it depends on, such as [Selfie](/sdk-reference/module-selfie/), [ID Capture](/sdk-reference/module-id-scan/), and [Face Match](/sdk-reference/module-face-match/) (or [Government Validation](/sdk-reference/module-government-validation/)). Because the decision reflects the user's overall score across those steps, Approval should be one of the last modules in the flow.
2. Add the module with `addApproval()`.
   ```swift
   flowConfig.addApproval(forceApproval: nil)   // forceApproval defaults to nil
   ```

Approval cannot be combined with the [Video Conference](/sdk-reference/module-conference/) module in the same flow. Configuration verification rejects any flow with both.

### Example

The example below adds the capture and verification modules Approval depends on, then adds Approval and listens for the result through `onApproveCompleted(_:)` on the delegate.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addIdScan(scanStep: .both)
flow.addSelfieScan()
flow.addFaceMatch(matchType: .idSelfie, idCategory: .primary)
flow.addApproval()

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)

// In your IncdOnboardingDelegate:
func onApproveCompleted(_ result: ApprovalResult) {
    if result.success {
        // User approved
    }
}
```

## Configuration Options

Approval exposes a single method, `addApproval(forceApproval:)`, configured through its one parameter. Calling `addApproval()` with no arguments doesn't invoke a separate, parameterless overload; it's the same method, with `forceApproval` left at its default value.

| Option          | Type    | Notes                                                                                                                                                                                                                                  |
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `forceApproval` | `Bool?` | If `true`, the user is approved regardless of score. If `false`, only users whose overall score is above the threshold are approved. Defaults to `nil`, which falls back to the persisted `IncdOnboardingManager.forceApproval` value. |

Score thresholds and approval decisions also depend on your Flow or Workflow configuration in Dashboard.

## Result

```swift
func onApproveCompleted(_ result: ApprovalResult)
```

`ApprovalResult` fields:

- `success: Bool`: `true` when the user was approved.
- `uuid: String?`: The session UUID; `nil` when unavailable.
- `customerToken: String?`: The session token; `nil` when unavailable.
- `error: IncdError?`: Set when the step failed.

<br />

---

- Path: `sdk-reference/module-captcha`
- URL: https://developer.incode.com/sdk-reference/module-captcha/
- Markdown: https://developer.incode.com/sdk-reference/module-captcha.md

# Captcha

The Captcha module presents a CAPTCHA challenge during onboarding to verify human interaction and reduce automated abuse. It then returns the user's response to your app.

In Dashboard, Captcha isn't a standalone module. Instead, enable one-time password (OTP) verification in the settings of the [Email Input](/dashboard-platform-administration/email-input-dashboard/) and [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard/) modules.

How you use this module depends on your integration pattern. When your app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Captcha

Add the module with `addCaptcha()`. It takes no parameters.

```swift
flowConfig.addCaptcha()
```

### Example

The example below adds Captcha as the only step in the flow and reads the result from the `onCaptchaCompleted(_:)` delegate callback.

```swift
let flowConfig = IncdOnboardingFlowConfiguration()
flowConfig.addCaptcha()

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flowConfig,
    delegate: self
)
```

```swift
// IncdOnboardingDelegate
func onCaptchaCompleted(_ result: CaptchaResult) {
    // CAPTCHA step completed. Process the result.
}
```

## Configuration Options

Captcha has no configurable options.

## Result

Captcha delivers a `CaptchaResult` to the `onCaptchaCompleted(_:)` callback on `IncdOnboardingDelegate`.

```swift
func onCaptchaCompleted(_ result: CaptchaResult)
```

`CaptchaResult` fields:

- `captcha: String?`: The entered CAPTCHA value. `nil` when the step did not complete successfully.
- `error: CaptchaError?`: Set when the step failed; otherwise, `nil`.

## Errors

Failures surface through `CaptchaResult.error` as a `CaptchaError`:

- `error(IncdError)`: Wraps an underlying `IncdError`.
- `wrongCaptchaEntered`: The value entered did not match.
- `captchaNotGenerated`: No CAPTCHA was generated for the session.

<br />

---

- Path: `sdk-reference/module-combined-consent`
- URL: https://developer.incode.com/sdk-reference/module-combined-consent/
- Markdown: https://developer.incode.com/sdk-reference/module-combined-consent.md

# Combined Consent

The Combined Consent module shows the user one preconfigured [consent](/dashboard-platform-administration/configuration-consents-tab/) to review and accept, then records their agreement. Consents obtain the user's permission to collect and process their data. Most jurisdictions require this at the start of an identity verification journey. Consents are [configured in Dashboard](/dashboard-platform-administration/configuration-consents-tab/); the module presents what your Flow or Workflow configuration provides.

For an overview of this module and how it works, see [Data Sharing Consent](/features-and-modules/combined-consent/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability**: All variants.

## Add Combined Consent

Add the module with `addCombinedConsents()`.

```swift
flowConfig.addCombinedConsents(
    configuration: CombinedConsentsConfiguration(
        combinedConsents: "YOUR_COMBINED_CONSENTS_ID",   // consent id from Dashboard
        language: "en"                                   // optional
    )
)
```

## Configuration Options

Configure the module by passing an `CombinedConsentsConfiguration` to `addCombinedConsents(configuration:)`.

| Option             | Type      | Notes                                                                                                                |
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------- |
| `combinedConsents` | `String`  | ID of the preconfigured consent to present. Fetch the consent ID from **Configuration** > **Consents** in Dashboard. |
| `language`         | `String?` | Language for the presented consents, as a two-letter code. Optional; if omitted, the SDK uses its own resolved language: the localization override, then the session language, then the device language. |

`combinedConsents` and `language` are write-only. You set them through the `CombinedConsentsConfiguration` initializer shown above, but you won't be able to read them back from an existing `CombinedConsentsConfiguration` instance.

## Result

```swift
func onCombinedConsentsGiven(_ result: CombinedConsentResult)
```

`CombinedConsentResult` fields:

- `success: Bool?`: `true` when the consent was submitted successfully.
- `error: IncdError?`

If a mandatory consent has no readable text or no checkbox id, the user cannot review and accept it. Text that is empty or only spaces counts the same as missing text. The module ends instead of showing the consent, and the flow stops with `IncdFlowError.combinedConsentsNotReceived` on `onError`. Give the consent a text in Dashboard to clear the error.

<br />

---

- Path: `sdk-reference/module-conference`
- URL: https://developer.incode.com/sdk-reference/module-conference/
- Markdown: https://developer.incode.com/sdk-reference/module-conference.md

# Video Conference

The Video Conference module connects the user to a live agent over video and audio to conduct an identity verification interview. The agent can request that documents be shown on camera and complete any verifications needed to meet regulatory or business requirements. The SDK manages the queue, waiting-time updates, and the call UI. It requires camera and microphone access. See [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions).

For an overview of this module and how it works, see [Video Conference](/features-and-modules/video-conference/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** The `-vc` variant. Calling it from a variant without `-vc` triggers a runtime variant assertion. This variant requires the vendored `OpenTok` dependency. See [Installation](/sdk-reference/setup-ios/).

**UI:** standalone.

Use this module when:

- Your verification process includes a human agent reviewing the user live.
- The agent needs to ask the user to show documents on camera during the call.
- You need queue and waiting-room behavior built into the flow.

## Add Video Conference

1. Add the following modules before Video Conference. The SDK throws if Video Conference is not placed after these modules.
   - A [Selfie](/sdk-reference/module-selfie/) module
   - Either of the following, with its matching validation:
     - An [ID Capture](/sdk-reference/module-id-scan/) module, validated with [Face Match](/sdk-reference/module-face-match/)
     - A [QR Scan](/sdk-reference/module-qr-scan/) module, validated with [Government Validation](/sdk-reference/module-government-validation/)
2. Add the module with `addVideoConference()`:
   ```swift
   // Default configuration
   flowConfig.addVideoConference()

   // Mute the microphone when the user enters the conference
   flowConfig.addVideoConference(disableMicOnCallStarted: true)
   ```

### Example

The example below adds Video Conference after the prerequisite capture and validation modules, mutes the microphone on entry, and listens for queue position, estimated wait time, and conference completion through `IncdOnboardingVideoConferenceDelegate`.

```swift
// Build the flow: prerequisite capture and validation modules first, then Conference.
flowConfig.addSelfieScan()
// ... add ID Capture + Face Match, or QR Scan + Government Validation ...
flowConfig.addVideoConference(disableMicOnCallStarted: true)

extension MyViewController: IncdOnboardingVideoConferenceDelegate {
    func onEstimatedWaitingTime(_ waitingTimeInSeconds: Int) {
        // Show the estimated wait before the agent connects.
    }

    func onQueuePositionChanged(_ newQueuePosition: Int) {
        // The user's position in the queue.
    }

    func onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?) {
        // The video conference has finished.
    }

    func onCaptchaCompleted(_ result: CaptchaResult) {
        // Captcha step result, when presented.
    }
}
```

## Configuration Options

Configure the module with `addVideoConference()`.

| Option                    | Type    | Notes                                                                                          |
| ------------------------- | ------- | ---------------------------------------------------------------------------------------------- |
| `disableMicOnCallStarted` | `Bool?` | When `true`, the user's microphone is muted when they enter the conference. Defaults to `nil`. |

A `ConferenceQueue` can be supplied through `IncdOnboardingSessionConfiguration(queue:)` to route the user to a specific queue once the user reaches this step; if no queue is specified, the user goes to the default queue.

## Result

Video Conference does not deliver a result payload. Completion is signaled by a delegate callback:

```swift
func onVideoConferenceCompleted(_ success: Bool, _ error: VideoConferenceError?)
```

This callback is declared on both `IncdOnboardingDelegate` and `IncdOnboardingVideoConferenceDelegate`. While the user waits for an agent, `IncdOnboardingVideoConferenceDelegate` also delivers `onEstimatedWaitingTime(_:)` and `onQueuePositionChanged(_:)`.

Errors surface through the `error` parameter as a `VideoConferenceError`, which wraps an underlying `IncdError`.

<br />

---

- Path: `sdk-reference/module-curp-validation`
- URL: https://developer.incode.com/sdk-reference/module-curp-validation/
- Markdown: https://developer.incode.com/sdk-reference/module-curp-validation.md

# CURP Validation

The CURP Validation module validates a person's CURP (Clave Única de Registro de Población), a personal identification number issued in Mexico, against Mexico's RENAPO registry. It accepts a CURP extracted via OCR, entered manually, or generated from personal data when the user doesn't know it.

For an overview of this module and how it works, see [CURP Validation](/features-and-modules/curp-validation/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants; Mexico only.

## Add CURP Validation

Add the module to an `IncdOnboardingFlowConfiguration` with `addCURPValidation(validationEnabled:)`.

```swift
flowConfig.addCURPValidation(validationEnabled: true)
```

## Configuration Options

Configure the module with `addCURPValidation()`.

| Option              | Type    | Description                                                                |
| ------------------- | ------- | -------------------------------------------------------------------------- |
| `validationEnabled` | `Bool?` | Controls whether the entered CURP is validated against the RENAPO service. |

## Result

CURP Validation delivers a `CURPValidationResult` to the `onCURPValidationCompleted(_:)` callback on the `IncdOnboardingDelegate`:

```swift
func onCURPValidationCompleted(_ result: CURPValidationResult)
```

`CURPValidationResult` (conforms to `UserInfoResult`) fields:

- `curp: String?`: The CURP string; `nil` when unavailable.
- `valid: Bool?`: `true` when the CURP was validated successfully; `false` on failed validation; `nil` when validation was skipped or disabled.
- `data: [String: Any]?`: Additional CURP validation data as key/value pairs. May be empty or `nil`.
- `error: IncdError?`: The error that occurred while producing this result, if any; otherwise, `nil`.

Errors for this module surface directly through the `error` field on `CURPValidationResult` rather than a separate exception type.

---

- Path: `sdk-reference/module-custom-fields`
- URL: https://developer.incode.com/sdk-reference/module-custom-fields/
- Markdown: https://developer.incode.com/sdk-reference/module-custom-fields.md

# Custom Fields

Custom Fields captures additional user-provided data and saves it to the session, making it available for reporting, server-side decisions, or cross-checking later in the journey.

In iOS, Custom Fields is **not a module**. There is no `addCustomFields` builder.

For an overview of this functionality and how it works, see [Custom Fields](/features-and-modules/custom-fields/).



**Availability:** All variants.

## Add Custom Fields

Attach metadata as string key/value pairs to the session at setup. The fields are stored on the session and sent to the back end.

```swift
let session = IncdOnboardingSessionConfiguration(
    customFields: ["partnerId": "abc123", "campaign": "summer"],
    token: "<SESSION_TOKEN>"
)
IncdOnboardingManager.shared.startFlow(sessionConfig: session, delegate: self)
```

- `customFields` is one of the optional named parameters (`[String: String]?`) of the single `IncdOnboardingSessionConfiguration` initializer, alongside others such as `token` and `configurationId`. There is no dedicated `(customFields:token:)` initializer.
- The session is started with `IncdOnboardingManager.shared.startFlow(sessionConfig:delegate:moduleId:)`; `moduleId` is optional (defaults to `nil`) and is not needed here.
- There is no dedicated result callback; any validation happens server-side.

---

- Path: `sdk-reference/module-custom-module`
- URL: https://developer.incode.com/sdk-reference/module-custom-module/
- Markdown: https://developer.incode.com/sdk-reference/module-custom-module.md

# Custom Module

The Custom Module pauses a Workflow and hands control to your application, which runs custom logic and returns a result that determines how the Workflow continues. The SDK hands your app a `callbackName`, then resumes the Workflow at the next node once you report a result. It exists only inside Dashboard-defined Workflows, not in locally built flows.

For an overview of this module and how it works, see [Custom Module](/features-and-modules/custom-module/).

**Availability:** Workflows API only (Dashboard-defined Workflows); not available via a local `IncdOnboardingFlowConfiguration`.

## Add Custom Module

Because the Custom Module lives on a Workflow node, there is no `flowConfig.addXxx(...)` builder for it. You configure it in Dashboard and start the session against the Workflow.

1. In Dashboard, [add a Custom Module node to your Workflow](/dashboard-platform-administration/custom-module-dashboard/) and set its `callbackName`. This is just a string the SDK delivers to your app. On iOS, there is no automatic function invocation. Your app decides how to interpret the value: for example, by mapping it to a method or branching on it.
2. Activate the Workflow and note its ID.
3. In your app, start the session against that Workflow. Set the Workflow ID via `configurationId`, which is one of the optional named parameters of the single `IncdOnboardingSessionConfiguration` initializer. Then call `IncdOnboardingManager.shared.startFlow(sessionConfig:delegate:moduleId:)`. `moduleId` is optional and defaults to `nil`.
4. Handle the module by overriding `onCustomModuleStarted(callbackName:onCustomModuleCompleted:)` on your `IncdOnboardingDelegate`. If you don't override it, the default implementation reports `.unknown`, and your custom logic never runs. Always provide an implementation that calls the `onCustomModuleCompleted` completion handler.

### Example

The example below starts a session with a `configurationId`, overrides `onCustomModuleStarted` to run custom logic based on `callbackName`, and reports the result through the `onCustomModuleCompleted` completion handler.

```swift
let session = IncdOnboardingSessionConfiguration(
    configurationId: "<WORKFLOW_ID>",
    token: "<SESSION_TOKEN>"
)
IncdOnboardingManager.shared.startFlow(sessionConfig: session, delegate: self)
```

```swift
extension MyViewController: IncdOnboardingDelegate {
    func onCustomModuleStarted(
        callbackName: String,
        onCustomModuleCompleted: @escaping (CustomModuleStatus) -> Void
    ) {
        // Run your custom logic based on callbackName, then report a result.
        let status = runCustomLogic(for: callbackName)
        onCustomModuleCompleted(status)
    }
}
```

## Configuration Options

Custom Module has no client-side builder options. Its only setting, the `callbackName`, is configured on the Custom Module node in the Workflow in Dashboard. The SDK delivers that name to your app at runtime through the delegate callback.

For `startFlow(sessionConfig:delegate:moduleId:)`, see [API Reference](/sdk-reference/ios-api-reference/#starting-a-flow).

## Result

There is no result payload object. The module signals through the `onCustomModuleStarted(callbackName:onCustomModuleCompleted:)` callback on your `IncdOnboardingDelegate`. You then call the `onCustomModuleCompleted` completion handler with a `CustomModuleStatus` to report the outcome of your custom logic. Once you report a status, the SDK submits it and advances the Workflow to the next node.

`CustomModuleStatus` is an enum with the following values:

- `ok` (`"OK"`)
- `fail` (`"FAIL"`)
- `warn` (`"WARN"`)
- `unknown` (`"UNKNOWN"`)

When the module finishes, the SDK also invokes `onCustomModuleCompleted(_ result: IncdError?)` on the delegate: `result` is `nil` on success or carries an `IncdError`. There is no module-specific error type for Custom Module; generic failures surface through `onError(_ error: IncdFlowError)` on your `IncdOnboardingDelegate`.

<br />

---

- Path: `sdk-reference/module-custom-watchlist`
- URL: https://developer.incode.com/sdk-reference/module-custom-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/module-custom-watchlist.md

# Custom Watchlist

The Custom Watchlist module screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the session outcome accordingly. The lists and matching criteria are driven by your Incode configuration. When the flow reaches this module, it shows a spinner during the check and then a brief success or failure screen. To show no UI, run Custom Watchlist as a headless API instead.

For an overview of this module and how it works, see [Custom Watchlist](/features-and-modules/custom-watchlist/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

**UI:** v1 and v2.

## Add Custom Watchlist

Add the module with `addCustomWatchlist()`. If you also use the [Antifraud](/sdk-reference/module-antifraud/) module, call `addAntifraud()` first, then `addCustomWatchlist()`, so Custom Watchlist runs after Antifraud.

```swift
flowConfig.addCustomWatchlist()
```

## Configuration Options

Custom Watchlist has no configurable options. The watchlist sources and matching behavior are controlled by your Incode Flow or Workflow configuration.

## Result

```swift
func onCustomWatchlistCompleted(_ result: CustomWatchlistResult)
```

`CustomWatchlistResult` fields:

- `success: Bool?`: `true` when the watchlist check completed cleanly. `false` is a single catch-all value covering both a non-clean backend result (which may include a match) and an operational failure (for example, a network error). The SDK does not expose a way to distinguish which occurred from this field alone. `nil` only reflects the type's unset default; the SDK does not currently deliver `nil` to signal a pending result.
- `error: IncdError?`: Populated for failures that prevent the check from starting at all, such as no active session. Not populated for a request-level failure or non-clean result during the check itself, which is instead reflected only in `success: false`.

## Headless

When you run Custom Watchlist as a headless API, it runs as a background process and isn't visible to the end user. It calls back with the result.

```swift
IncdOnboardingManager.shared.processCustomWatchlist { result in /* CustomWatchlistResult */ }
```

`processCustomWatchlist` has two parameters:

- `interviewId: String?`: The identifier of the session to run the watchlist check against. Defaults to `nil` when checking the current session.
- `completion: (CustomWatchlistResult) -> Void`: Called with the same `CustomWatchlistResult` type used by the flow-module `onCustomWatchlistCompleted(_:)` callback.

<br />

---

- Path: `sdk-reference/module-document-scan`
- URL: https://developer.incode.com/sdk-reference/module-document-scan/
- Markdown: https://developer.incode.com/sdk-reference/module-document-scan.md

# Document Capture

The Document Capture module captures a supplementary document, such as a proof of address document, medical document, or bank statement. Users can upload a file or take a photo of the document with their device’s camera. For some document types, the server performs [OCR](/get-started-with-incode/glossary/#ocr) and returns the extracted data.

For an overview of this module and how it works, see [Document Capture](/features-and-modules/document-capture/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

**UI:** v1 and v2

## Add Document Capture

Add the module with `addDocumentScan()`.

```swift
flowConfig.addDocumentScan(
    showTutorials: true,
    showDocumentProviderOptions: true,
    documentType: .addressStatement,
    showRetakeScreen: true,
    isSkippable: false,
    documentSources: [.camera, .photoUpload, .fileUpload]
)
```

## Configuration Options

Configure the module with `addDocumentScan()`.

| Option                        | Type                   | Description                                                                                                                                                                                                                                   |
| ----------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `documentType`                | `DocumentType`         | Sets the type of document the module looks for: for example, `.addressStatement`, `.paymentProof`, `.medicalDoc`, `.creditCard`, or `.otherDocument1`…`.otherDocument3`.                                                                      |
| `documentSources`             | `Set<DocumentSource>?` | Specifies the upload method for the document: `.camera`, `.photoUpload`, or `.fileUpload`. `.fileUpload` is only for PDF-capable types. `supportPDF` is `false` for `.medicalDoc` and `.creditCard`. See [Document Upload](#document-upload). |
| `showTutorials`               | `Bool?`                | Shows tutorials on how to capture the document.                                                                                                                                                                                               |
| `showRetakeScreen`            | `Bool?`                | Offers a retake screen after manual capture. Default: `true`.                                                                                                                                                                                 |
| `isSkippable`                 | `Bool`                 | Allows skipping. Default: `false`.                                                                                                                                                                                                            |
| `showDocumentProviderOptions` | `Bool?`                | Allows the user to choose between using the camera to scan the document and uploading its file. UI v1 only. Default: `true`.                                                                                                                  |

## Result

```swift
func onDocumentScanCompleted(_ result: DocumentScanResult)
```

`DocumentScanResult` fields:

- `documentImage: UIImage?`
- `data: Data?`
- `mimeType: String?`
- `documentType: DocumentType`
- `insuranceCardData: OmniGetMedicalOCRDataResponse?`
- `addressFieldsFromPoa: OCRDataAddress?`
- `error: DocumentScanError?`

OCR data maps to the field that matches the captured `documentType`:

- `addressFieldsFromPoa` is populated for `.addressStatement`.
- `insuranceCardData` is populated for medical and insurance-card captures.
- Fields that do not apply to the captured type are `nil`.

## Errors

`DocumentScanError` cases:

- `error`
- `permissionsDenied`
- `uploadError`
- `invalidConfiguration`

## Document Upload

Document Upload is **not a standalone module** on iOS. It is enabled as part of Document Capture.

ID documents have their own upload path: `addIdScan(..., digitalIdsUpload: true)` lets users upload an existing digital ID (PDF). See [ID Capture](/sdk-reference/module-id-scan/).

**Availability:** All variants (same as Document Capture).

**UI:** v1 and v2.

### Add Document Upload

Enable Document Upload by including upload sources in the `documentSources` set.

```swift
flowConfig.addDocumentScan(
    documentType: .addressStatement,
    documentSources: [.photoUpload, .fileUpload]  // omit .camera to make it upload-only
)
```

- `.camera`: Enable the user to capture an image of the document.
- `.photoUpload`: Enable the user to pick an image from the photo library.
- `.fileUpload`: Enable the user to pick a PDF file. This is only available for document types that support PDFs.

Combine `.photoUpload`, `.fileUpload`, or both with `.camera` to offer both live capture and upload.

### Result

The result is delivered through the same `onDocumentScanCompleted(_:)` callback and `DocumentScanResult` as Document Capture.

<br />

---

- Path: `sdk-reference/module-dynamic-forms`
- URL: https://developer.incode.com/sdk-reference/module-dynamic-forms/
- Markdown: https://developer.incode.com/sdk-reference/module-dynamic-forms.md

# Dynamic Forms

The Dynamic Forms module presents one or more custom form screens to collect information from a user.

For an overview of this module and how it works, see [Forms and Data Entry](/features-and-modules/forms-and-data-entry/).

How you use this module depends on your integration pattern. Screens and questions can be defined in code or configured in the Dashboard. In most integrations, they come from your Incode Flow or Workflow configuration, so you add the module to an `IncdOnboardingFlowConfiguration` with an empty configuration and let the Dashboard drive the content, referencing the flow by ID. Define screens in code only when you need them client-side. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants, iOS SDK version 5.31.0 or higher.

Use this module when:

- You need to collect additional structured data, such as typed questions and choices, during the flow.
- Your questionnaire varies by configuration and you do not want to ship an app update to change it.

For simple key/value session metadata that does not need a UI, use the [Custom Fields](/sdk-reference/module-custom-fields/) module instead.

## Add Dynamic Forms

Add the module to an `IncdOnboardingFlowConfiguration` with `addDynamicForms(configuration:)`. When the screens and questions are defined in your Incode Flow or Workflow configuration, pass a `DynamicFormConfiguration` with no screens and let Dashboard supply the content.

```swift
let config = DynamicFormConfiguration(screens: [
    DynamicFormScreen(
        title: "About you",
        hideTitle: false,
        questions: [
            DynamicFormQuestion(
                questionId: "occupation",
                question: "What is your occupation?",
                inputType: .text,
                isOptional: false
            )
        ]
    )
])

flowConfig.addDynamicForms(configuration: config)
```

## Configuration Options

The types below configure the module. The fields listed are the parameters of each type's public initializer.

| Type                       | Key Fields                                                                                                            |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `DynamicFormConfiguration` | `screens: [DynamicFormScreen]?`                                                                                       |
| `DynamicFormScreen`        | `title: String`, `hideTitle: Bool`, `questions: [DynamicFormQuestion]`                                                |
| `DynamicFormQuestion`      | `questionId: String`, `question: String`, `inputType: DynamicFormInputType`, `options: [String]?`, `isOptional: Bool` |

`DynamicFormConfiguration`, `DynamicFormScreen`, and `DynamicFormQuestion` expose only their initializer parameters below. The values aren't readable back from an existing instance.

## Prefilled Answers

Questions configured as prefillable in Dashboard are populated automatically from the user's session: for example, values extracted during ID capture. This works in both Flows and Workflows and needs no integration code:

- A loader is shown for a maximum of 5 seconds while the values are fetched.
- Answers marked in Dashboard as non-editable render as read-only fields; editable prefilled answers can be changed by the user before submitting.
- Prefill is best-effort: if the values can't be fetched, the form opens blank and fully editable.
- Prefilled answers are submitted with the rest of the form.

## Validation

On the v2 form, the **Continue** button is enabled by default and validates the whole form when it is tapped, rather than gating on each field as the user types.

- Typing never introduces an error message. It only clears one that the new value has resolved.
- Leaving a field reports a malformed value, but stays quiet about an empty required field until the user has tried to submit at least once.
- Tapping **Continue** validates everything, empty required fields included. From then on, leaving a field also reports an empty one.

## Result

The module reports completion through the onboarding delegate:

```swift
func onDynamicFormCompleted(_ result: DynamicFormsResult)
```

`DynamicFormsResult` fields:

- `answers: [DynamicFormQuestionnaireModel]`: The answered form entries, each pairing a question with its submitted answer.
- `error: IncdError?`: Set when the module could not complete; otherwise, `nil`.

Each entry in `answers` is a `DynamicFormQuestionnaireModel` and represents one answered question, carrying question metadata (`interviewId`, `questionId`, `question` text, `inputType`, `isOptional`) and answer data (`optionalAnswers`, `selectedAnswer`). These fields are internal to the SDK and aren't accessible from your app. They're included here for context on the model's structure, not as fields you interact with directly.

`inputType` is a `DynamicFormInputType`, one of:

| Field         | Field Value   |
| ------------- | ------------- |
| `text`        | `TEXT`        |
| `date`        | `DATE`        |
| `number`      | `NUMBER`      |
| `country`     | `COUNTRY`     |
| `email`       | `EMAIL`       |
| `phone`       | `PHONE`       |
| `cpf`         | `CPF`         |
| `nationality` | `NATIONALITY` |
| `selection`   | `SELECT`      |
| `yesno`       | `YESNO`       |

## Errors

Failures surface through the `error` field on `DynamicFormsResult`, typed as `IncdError`. This module does not define a module-specific error type.

---

- Path: `sdk-reference/module-ekyb`
- URL: https://developer.incode.com/sdk-reference/module-ekyb/
- Markdown: https://developer.incode.com/sdk-reference/module-ekyb.md

# eKYB (Electronic Know Your Business)

The eKYB module verifies a business entity's identity data, such as business name, address, and tax ID. The fields that are collected and how the checks are evaluated depend on your Incode Flow or Workflow configuration.

For an overview of the module and how it works, see [eKYB (electronic Know Your Business)](/features-and-modules/ekyb/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

**UI:** v1 (data-entry for the business attributes being verified, followed by a processing/status screen).

## Add eKYB

Add the module with `addEKYB(configuration:)`, passing an `ExternalVerificationEkybConfiguration`. Every parameter of the initializer is optional, so you configure only the checks you need.

```swift
flowConfig.addEKYB(
    configuration: ExternalVerificationEkybConfiguration(checkBusinessName: true)
)
```

### Example

The example below builds an `ExternalVerificationEkybConfiguration` that verifies all three attributes, adds the module to the flow, and reads the outcome from the `onExternalValidationEkybCompleted(_:)` delegate callback.

```swift
// Build the eKYB configuration
let ekybConfiguration = ExternalVerificationEkybConfiguration(
    checkBusinessName: true,
    checkAddress: true,
    checkTaxId: true
)

// Add the module to the flow configuration
flowConfig.addEKYB(configuration: ekybConfiguration)
```

```swift
// Receive the result on your IncdOnboardingDelegate
extension MyOnboardingHandler: IncdOnboardingDelegate {
    func onExternalValidationEkybCompleted(_ result: EkybResult) {
        // eKYB verification completed.
        // Inspect result.externalVerification for the per-check results.
    }
}
```

## Configuration Options

`ExternalVerificationEkybConfiguration` controls which attributes are verified and where each value is sourced from. Every field is optional and defaults to `nil`.

| Option               | Type      | Description                                                                   |
| -------------------- | --------- | ----------------------------------------------------------------------------- |
| `checkBusinessName`  | `Bool?`   | Whether to verify the business name.                                          |
| `businessNameSource` | `String?` | The source for the business name value.                                       |
| `checkAddress`       | `Bool?`   | Whether to verify the business address.                                       |
| `address`            | `String?` | The business address value to verify.                                         |
| `checkTaxId`         | `Bool?`   | Whether to verify the tax ID. See [Tax ID Validation](#tax-id-validation).    |
| `taxIdSource`        | `String?` | The source for the tax ID value. See [Tax ID Validation](#tax-id-validation). |

The attributes that are actually collected and how each check is evaluated ultimately depend on your Incode Flow or Workflow configuration.

## Result

eKYB delivers an `EkybResult` to the `onExternalValidationEkybCompleted(_:)` method on your `IncdOnboardingDelegate`.

```swift
func onExternalValidationEkybCompleted(_ result: EkybResult)
```

`EkybResult` fields:

- `externalVerification: [EkybVerificationStep]?`: The list of individual eKYB check results.
- `error: IncdError?`: Populated only when the module fails to produce a result at all; for example, a network or configuration failure. This is separate from individual check outcomes, which are reported via each `EkybVerificationStep.status` (see below).

Each `EkybVerificationStep` contains:

- `stepName: String?`: The identifier of the check performed; for example, `name`, `address_verification`, `address_deliverability`, or `address_property_type`.
- `status: String?`: The outcome of the check: `success`, `warning`, or `failure`.
- `additionalInfo: String?`: A secondary label describing the check.

## Tax ID Validation

Tax ID Validation is **not a standalone module** on iOS: there is no `addTaxIdValidation` builder, no `TaxIdValidationModule` type, and no `TaxIdValidationListener` or `onTaxIdValidationCompleted` callback. On iOS, tax ID checking is performed as part of the eKYB module: you enable it through fields on `ExternalVerificationEkybConfiguration`, and the outcome is delivered with the rest of the eKYB result.

**Availability:** all SDK build variants. The eKYB path (and therefore tax ID checking) is not gated behind a specific SDK build variant; `addEKYB` and `handleEKYBModule` perform no variant inclusion check.

### Add Tax ID Validation

Enable Tax ID Validation by setting the tax ID fields on `ExternalVerificationEkybConfiguration` when you add eKYB to the flow:

```swift
flowConfig.addEKYB(
    configuration: ExternalVerificationEkybConfiguration(
        checkTaxId: true,          // Bool? — run tax ID verification as part of eKYB
        taxIdSource: "<TAX_ID>"    // String? — the tax ID value to verify
    )
)
```

There is no dedicated tax ID builder to call and no tax-ID-specific step to add on its own; the check runs inside eKYB.

### Configuration Options

The tax ID fields live on `ExternalVerificationEkybConfiguration`:

| Option        | Type      | Description                      |
| ------------- | --------- | -------------------------------- |
| `checkTaxId`  | `Bool?`   | Whether to verify the tax ID.    |
| `taxIdSource` | `String?` | The source for the tax ID value. |

### Result

There is no tax-ID-specific result payload or callback. The tax ID outcome is delivered as part of the eKYB result, through the eKYB completion callback:

```swift
func onExternalValidationEkybCompleted(_ result: EkybResult)   // EkybResult carries the eKYB verification steps
```

Failures surface through standard error handling; there is no tax-ID-specific exception type.

---

- Path: `sdk-reference/module-ekyc`
- URL: https://developer.incode.com/sdk-reference/module-ekyc/
- Markdown: https://developer.incode.com/sdk-reference/module-ekyc.md

# eKYC (Electronic Know Your Customer)

The eKYC (electronic Know Your Customer) module collects and verifies a user's personal identity data against authoritative data sources. The data can include the user's name, email, address, phone, tax ID, date of birth, and nationality. The module can prefill fields from data captured earlier in the flow, such as a scanned document or a proof-of-address document, and validate them against your Incode configuration.

For an overview of this module and how it works, see [eKYC (electronic Know Your Customer)](/features-and-modules/ekyc/).

How you use this module depends on your integration pattern. When your app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add eKYC

Add the module with `addEKYC(...)` on your `IncdOnboardingFlowConfiguration`. Call it with no arguments for the default configuration. The default configuration sets every `check<Field>` flag to `false`, so no field is verified unless you explicitly enable it. Pass an `ExternalVerificationConfiguration` to control which fields are checked and where each field's value comes from.

```swift
// Default configuration
flowConfig.addEKYC()

// Custom configuration
flowConfig.addEKYC(
    configuration: ExternalVerificationConfiguration(
        checkName: true,
        nameSource: .document,
        checkAddress: true,
        addressSource: .userInput
    )
)
```

The fields that are shown and how they are verified can also depend on your eKYC module configuration in your Flow or Workflow in Dashboard.

## Configuration Options

`ExternalVerificationConfiguration` exposes the following for each field:

- A `check<Field>: Bool?` toggle: Whether to collect and verify the field. Left `nil`, it behaves as `false`.
- A `<field>Source: DataInputSource?`: Where the field's value is populated from. Optional and defaults to `nil`; when left unset, the user enters the value manually.

Every parameter is optional.

| Field         | Check toggle              | Source                                |
| ------------- | ------------------------- | ------------------------------------- |
| Name          | `checkName: Bool?`        | `nameSource: DataInputSource?`        |
| Email         | `checkEmail: Bool?`       | `emailSource: DataInputSource?`       |
| Address       | `checkAddress: Bool?`     | `addressSource: DataInputSource?`     |
| Phone         | `checkPhone: Bool?`       | `phoneSource: DataInputSource?`       |
| Tax ID/SSN    | `checkSsn: Bool?`         | `ssnSource: DataInputSource?`         |
| Date of birth | `checkDob: Bool?`         | `dobSource: DataInputSource?`         |
| Nationality   | `checkNationality: Bool?` | `nationalitySource: DataInputSource?` |

`DataInputSource` values include:

- `.userInput`: Allow the user to type the value.
- `.document`: Prefill the value from a scanned identity document.
- `.poa`: Prefill from a proof-of-address document.

For a field to prefill from `.document` or `.poa`, the source data must already be available in the flow: for example, an ID or proof-of-address capture must be added earlier. If that source data isn't available, the field is left blank instead of causing an error. The user can enter it manually; **Continue** remains disabled until they do.

## Result

The module delivers an `EKYCResult` to the delegate:

```swift
func onEKYCCompleted(_ result: EKYCResult)
```

`EKYCResult` fields:

- `success: Bool`: `true` when the eKYC checks completed successfully.
- `error: IncdError?`: Set when the operation did not complete successfully; `nil` otherwise.

eKYC does not define a module-specific error type; failures surface through `EKYCResult.error` as an `IncdError`, not through a separate error callback.

<br />

---

- Path: `sdk-reference/module-email`
- URL: https://developer.incode.com/sdk-reference/module-email/
- Markdown: https://developer.incode.com/sdk-reference/module-email.md

# Email

The Email module collects a user's email address and can confirm email ownership by sending a one-time password (OTP) to that address.

For an overview of this module and how it works, see [Email Input](/features-and-modules/email-input/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Email

Add the module with `addEmail()`. The `otpVerification` parameter is optional. Call `addEmail()` with no arguments to use the default configuration.

```swift
flowConfig.addEmail(otpVerification: true)
```

## Configuration Options

Configure the module with `addEmail()`.

| Option            | Type    | Notes                                                                                                                                                                       |
| ----------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `otpVerification` | `Bool?` | If `true`, shows OTP verification after the user enters an email address. When `nil` (the default), `addEmail` falls back to the manager flag `enableEmailOTPVerification`. |

OTP expiration and prefill are **not** configurable through the `addEmail` API: it always builds the module with no prefill and no expiration override. A flow defined in Dashboard and run by reference can carry a full OTP configuration, but the code-defined `addEmail` builder exposes only `otpVerification`.

## Validation

The **Continue** button is enabled by default and stays enabled until an error is shown.

- Typing never introduces an error message. It only clears one that the new value has resolved.
- Leaving a field reports a malformed value, but stays quiet about an empty required field until the user has tried to submit at least once.
- Tapping **Continue** validates everything, empty required fields included. From then on, leaving a field also reports an empty one.

## Result

Email delivers an `EmailAddressResult` to the `onAddEmailAddressCompleted(_:)` callback on your `IncdOnboardingDelegate`:

```swift
func onAddEmailAddressCompleted(_ result: EmailAddressResult)
```

`EmailAddressResult` fields:

- `email: String?`: The email address captured from the user; `nil` when unavailable.
- `error: IncdError?`: The error that occurred while capturing the email address, if any; otherwise, `nil`.

<br />

---

- Path: `sdk-reference/module-face-authentication`
- URL: https://developer.incode.com/sdk-reference/module-face-authentication/
- Markdown: https://developer.incode.com/sdk-reference/module-face-authentication.md

# Face Authentication

The Face Authentication module captures a returning user's face with the device camera and matches it against the face already enrolled for that user. It then returns a pass or fail result. iOS exposes two entry points: an in-flow **Face Authentication** step and a standalone **Face Login** API.

For an overview of this module and how it works, see [Face Authentication](/features-and-modules/face-authentication/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** The `-l` build variant.

## Add Face Authentication

Add the module with `addFaceAuthentication(configuration:)` on `IncdOnboardingFlowConfiguration`. Face Authentication runs against an existing enrolled user, so your session must identify that user. Every setting on `FaceAuthenticationConfiguration` has a default, so pass a default-initialized configuration for the standard behavior, or build a custom one.

```swift
// Default configuration
flowConfig.addFaceAuthentication(configuration: FaceAuthenticationConfiguration())

// Custom configuration
flowConfig.addFaceAuthentication(configuration: faceAuthConfig)
```

Face Authentication ships both a v1 (legacy) and a v2 capture UI; the active one is selected by the SDK based on your Incode configuration.

### Example

The example below builds a `FaceAuthenticationConfiguration` with tutorials and occlusion checks, adds it to the flow, and listens for the result through the `IncdOnboardingDelegate`.

```swift
let faceAuthConfig = FaceAuthenticationConfiguration(
    showTutorials: true,
    lensesCheck: true,
    faceMaskCheck: true
)

let flowConfig = IncdOnboardingFlowConfiguration()
flowConfig.addFaceAuthentication(configuration: faceAuthConfig)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flowConfig,
    delegate: self
)
```

```swift
// IncdOnboardingDelegate
func onFaceAuthenticationCompleted(_ result: FaceAuthenticationResult) {
    // Face authentication completed
}

func onError(_ error: IncdFlowError) {
    // Onboarding flow was aborted due to an error
}
```

## Configuration Options

Configure the module by passing named parameters to the `FaceAuthenticationConfiguration` initializer. These are write-only: set at initialization, but not readable back from an existing instance. The table below lists the most commonly used ones. Any `Bool?` check left `nil` falls back to the corresponding manager-level `faceAuth*` default.

| Option                 | Type                     | Description                                                                                                                                               |
| ---------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `deepsight`            | `DeepsightConfiguration` | Enables liveness/Deepsight configuration. Defaults to `.default`. The effective behavior can be governed by your back-end Flow or Workflow configuration. |
| `showTutorials`        | `Bool?`                  | Shows a tutorial before the scan. When `nil`, uses the manager's `faceAuthShowTutorials`.                                                                 |
| `autoCaptureTimeout`   | `Double?`                | Sets the auto-capture timeout, in seconds.                                                                                                                |
| `captureAttempts`      | `Int?`                   | Sets the number of capture attempts. When `nil`, uses the manager's `faceAuthMaxRetries`.                                                                 |
| `lensesCheck`          | `Bool?`                  | Enables eyeglass detection during capture. When `nil`, uses the manager's `faceAuthLensesCheck`.                                                          |
| `faceMaskCheck`        | `Bool?`                  | Enables face-mask detection during capture. When `nil`, uses the manager's `faceAuthFaceMaskCheck`.                                                       |
| `closedEyesCheck`      | `Bool?`                  | Enables closed-eyes detection during capture. When `nil`, uses the manager's `faceAuthClosedEyesCheck`.                                                   |
| `headCoverCheck`       | `Bool?`                  | Enables head-covering detection during capture. When `nil`, uses the manager's `faceAuthHeadCoverCheck`.                                                  |
| `imageQualitySeverity` | `ImageQualitySeverity`   | Sets how strict the image-quality check is during capture. Defaults to `.defaultValue`.                                                                   |
| `occlusionCheck`       | `OcclusionCheck`         | Enables a face occlusion check. Defaults to `.disabled`.                                                                                                  |

## Result

Face Authentication delivers a `FaceAuthenticationResult` to the `onFaceAuthenticationCompleted(_:)` callback on `IncdOnboardingDelegate`.

```swift
func onFaceAuthenticationCompleted(_ result: FaceAuthenticationResult)
```

`FaceAuthenticationResult` fields:

- `success: Bool?`: `true` if face authentication succeeded; otherwise, `false`.
- `customerUUID: String?`: The customer UUID associated with the authenticated face; `nil` when unavailable.
- `image: UIImage?`: The captured selfie image; `nil` when unavailable.
- `selfieBase64: String?`: The Base64-encoded selfie image; `nil` when unavailable.
- `selfieEncryptedBase64: String?`: The Base64-encoded encrypted selfie image; `nil` when unavailable.
- `error: FaceAuthenticationError?`: The module-specific error when authentication did not complete successfully; otherwise, `nil`.
- `videoRecordingError: FaceAuthenticationError?`: Set when video recording failed during capture, independent of the authentication outcome; `nil` when unavailable. Distinct from `error`; carries `insufficientStorageForVideoRecording` or `videoRecordingFailed`.

## Errors

Module errors surface through `result.error` as a `FaceAuthenticationError`. Pattern-match it to react to a specific case:

```swift
if case .spoofAttemptDetected = result.error {
    // A spoof attempt was detected
}
```

`FaceAuthenticationError` cases:

- `error`
- `inactiveSession`
- `nonexistentCustomer`
- `lensesDetected`
- `faceMaskDetected`
- `headCoverDetected`
- `closedEyesDetected`
- `faceTooDark`
- `spoofAttemptDetected`
- `userIsNotRecognized`
- `selfieImageLowQuality`
- `hintNotProvided`
- `faceNotFound`
- `faceCroppingFailed`
- `faceTooSmall`
- `faceTooBlurry`
- `badPhotoQuality`
- `processingError`
- `badRequest`
- `deniedCameraPermissions`
- `userCancelled`
- `selfieFaceOccluded`
- `insufficientStorageForVideoRecording`
- `videoRecordingFailed`
- `unknown`

Flow-level failures also arrive through the delegate's `onError(_:)`.

## Standalone: Face Login (`-l` variant)

### Basic Usage

Use `startFaceLogin` to authenticate a returning user outside a flow. Before you call it, set `IncdOnboardingManager.shared.presentingViewController` to the view controller that presents the capture UI.

For 1:1 verification, pass the user's `customerUUID`. For 1:N identification, pass `nil` for `customerUUID`.

Use `faceAuthMode` to select where matching happens: 

- `.server` for server-side matching.
- `.local` for on-device matching. `.local` requires the `-l` variant.

Only one Face Login can run at a time. If you call `startFaceLogin` while another Face Login is in progress, the SDK ignores the new call and never calls its completion handler.

```swift
IncdOnboardingManager.shared.startFaceLogin(
    customerUUID: nil,          // nil → 1:N; set → 1:1
    faceAuthMode: .server,      // .server or .local (.local needs -l)
    faceAuthModeFallback: true,
    lensesCheck: true,
    faceMaskCheck: true
) { result in
    // SelfieScanResult (see the Selfie module)
}
```

### Full Signature

The call above uses the most common parameters; every parameter has a default, so pass only the ones you need. The complete signature is:

```swift
func startFaceLogin(
    showTutorials: Bool? = nil,
    customerUUID: String? = nil,
    faceAuthMode: FaceAuthMode? = nil,
    faceAuthModeFallback: Bool? = nil,
    lensesCheck: Bool? = nil,
    faceMaskCheck: Bool? = nil,
    localLivenessCheck: Bool? = nil,
    localAgeEstimation: Bool? = nil,
    forceThemeBackground: Bool = false,
    logAuthenticationEnabled: Bool? = nil,
    customLogo: UIImage? = nil,
    uxMode: FaceLoginUXMode? = nil,
    streamFramesToken: String? = nil,
    completion: @escaping (_ result: SelfieScanResult) -> Void
)
```

| Parameter | Default | Description |
| --- | --- | --- |
| `localLivenessCheck` | `true` | Set to `false` to skip the on-device liveness check in `.local` logins. `.server` logins always check liveness on the server. |
| `localAgeEstimation` | `false` | Set to `true` to estimate the user's age on device and return it in `FaceLoginResult.estimatedAge`. Requires the `-l` variant. |
| `uxMode` | `.standard` | Sets the capture experience. See `FaceLoginUXMode` in [Supporting Types](#supporting-types). |

Additional optional parameters include: 

- `showTutorials`, which shows a tutorial before the scan
- `forceThemeBackground`
- `logAuthenticationEnabled`
- `customLogo`
- `streamFramesToken`



### Face Login Result

The completion closure receives a `SelfieScanResult`. For Face Login, read the outcome from its `faceLoginResult` property. Use `spoofAttempt` and `error` to tell a failed match apart from a liveness failure or an error.

```swift
IncdOnboardingManager.shared.startFaceLogin { result in
    guard let loginResult = result.faceLoginResult else {
        // An error occurred; inspect result.error
        return
    }

    if loginResult.success == true {
        let customerUUID = loginResult.customerUUID
        let token = loginResult.token
        let interviewId = loginResult.interviewId
    } else if result.spoofAttempt == true {
        // Liveness check failed
    } else {
        // The user's face was not recognized
    }
}
```



| FaceLoginResult Property | Type | Description |
|---|---|---|
| `success` | `Bool?` | `true` if Face Login succeeded, `false` if it failed, or `nil` if an error occurred. |
| `customerUUID` | `String?` | The matched user's customer UUID, or `nil` if no user was matched. |
| `token` | `String?` | The matched user's customer token. |
| `interviewId` | `String?` | The ID of the onboarding session interview in which the user was approved. |
| `interviewToken` | `String?` | The token of the onboarding session interview in which the user was approved. |
| `transactionId` | `String?` | The transaction ID of the Face Login attempt. |
| `estimatedAge` | `Float?` | The user's estimated age. Returned only when `localAgeEstimation` is `true` and the login completes. |

On the enclosing `SelfieScanResult`, `spoofAttempt` is `true` when the attempt was detected as a spoof, and `error` carries a `SelfieScanError` when Face Login did not complete.

### Manage the Local Face Database

When matching on device, manage the local face database directly.

```swift
IncdOnboardingManager.shared.addFace(FaceInfo(faceTemplate: "…", customerUUID: "…", templateId: "…"))
IncdOnboardingManager.shared.removeFace(customerUUID: "…")
IncdOnboardingManager.shared.setFaces([FaceInfo(faceTemplate: "…", customerUUID: "…", templateId: "…")])
let faces = IncdOnboardingManager.shared.getFaces()
IncdOnboardingManager.shared.syncFaceLoginAttempts(delegate: nil) { ok, error in /* ok: Bool?, error: IncdLoginError? */ }
```

### Supporting Types

- The cases of `FaceAuthMode` are:
    - `.server`: Checks liveness and matches the face on the server.
    - `.local`: Checks liveness and matches the face on device. Requires the `-l` variant.
- The properties of `FaceInfo` are `faceTemplate`, `customerUUID`, and `templateId`.
- The cases of `FaceLoginUXMode` are: 
    - `.standard`: The default capture experience.
    - `.fast`: Shows the camera immediately, skips the "Get ready" step, and accepts a face that is farther away, off-center, or at a greater angle than `.standard` allows.
    - `.ultraFast`: Shows no capture screen or tutorial, only a small progress indicator at the top of your app's UI. Captures the same way as `.fast`. It requires camera permission to already be granted. Otherwise, it behaves like `.fast`. If no face is captured within a few seconds, the login ends with `SelfieScanError.userNotFound`.

---

- Path: `sdk-reference/module-face-match`
- URL: https://developer.incode.com/sdk-reference/module-face-match/
- Markdown: https://developer.incode.com/sdk-reference/module-face-match.md

# Face Match

The Face Match module compares the user's selfie against their ID photo, their NFC chip photo, or both in a 3-way match. It then returns a match decision and confidence score. Matching is performed on the server. The module can also report whether the face already belongs to an existing user.

For an overview of this module and how it works, see [Face Match](/features-and-modules/face-match/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Face Match

1. Add an [ID Capture](/sdk-reference/module-id-scan/) or [QR Scan](/sdk-reference/module-qr-scan/) module, and a [Selfie](/sdk-reference/module-selfie/) module, before Face Match. Face Match depends on these earlier capture steps so there are two faces to compare.
2. Add the module with `addFaceMatch()`. Every parameter has a default, so a bare call uses the module defaults.
   ```swift
   // Default configuration
   flowConfig.addFaceMatch()

   // Custom configuration
   flowConfig.addFaceMatch(
       matchType: .idSelfie,     // .idSelfie (default), .nfcSelfie, .nfc3Way
       uiFlavor: .full,          // .full (default) or .compact
       idCategory: .primary,     // variadic; .primary and/or .secondary
       showUserExists: nil,      // defaults to true
       showLivenessStatus: nil   // defaults to true on v1, false on v2
   )
   ```

Face Match ships both a v1 (UIKit View) and a v2 (SwiftUI-style) UI.

### Example

The example below adds ID Capture and Selfie before Face Match, configures an ID-vs-selfie comparison, starts the flow, and reads the result in `onFaceMatchCompleted(_:)`.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addIdScan(scanStep: .both)
flow.addSelfieScan()
flow.addFaceMatch(matchType: .idSelfie, idCategory: .primary)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)

// In your IncdOnboardingDelegate:
func onFaceMatchCompleted(_ result: FaceMatchResult) {
    // Face match completed — inspect result.faceMatched, result.confidence, etc.
}
```

## Configuration Options

Configure the module with `addFaceMatch()`.

| Option               | Type             | Description                                                                                                                      |
| -------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `matchType`          | `FaceMatchType?` | Selects what to compare: `.idSelfie` (default), `.nfcSelfie`, or `.nfc3Way`. The NFC match types require captured NFC chip data. |
| `uiFlavor`           | `UIFlavor?`      | `.full` (default) or `.compact`. `.compact` is the reduced UI that disables the face-match animation.                            |
| `idCategory`         | `IDCategory...`  | Sets one or more IDs to match against: `.primary` (default), `.secondary`, or both.                                              |
| `showUserExists`     | `Bool?`          | Shows or hides the label indicating the user already exists. Default is `true`.                                                  |
| `showLivenessStatus` | `Bool?`          | Shows or hides the liveness result label. Default is `true` on UI v1 and `false` on UI v2.                                       |

The match type and the thresholds used to decide a pass or fail also depend on your Incode Flow or Workflow configuration, not just these options.

## Result

Face Match delivers a `FaceMatchResult` to the `onFaceMatchCompleted(_:)` callback on `IncdOnboardingDelegate`:

```swift
func onFaceMatchCompleted(_ result: FaceMatchResult)
```

`FaceMatchResult` fields:

- `faceMatched: Bool?`: If the faces matched.
- `confidence: Float?`: Recognition confidence between the selfie and the front ID photo. `nil` when no front ID was uploaded.
- `secondIdConfidence: Float?`: Recognition confidence against the second ID photo.
- `nfcSelfieConfidence: Float?`: Recognition confidence between the selfie and the NFC chip photo.
- `nfcIdConfidence: Float?`: Recognition confidence between the front ID photo and the NFC chip photo.
- `nameMatched: Bool?`: `true` if the existing user's name matches the current user's name (use together with `existingUser`); otherwise, `false`.
- `existingUser: Bool?`: `true` if the user already exists in the database; otherwise, `false`.
- `existingInterviewId: String?`: The interview ID of the existing user, if one exists; otherwise, `nil`.
- `idCategories: Set<IDCategory>`: The list of `IDCategory` values used in the face matching process.
- `error: IncdError?`: Set when the module produced an error; otherwise, `nil`.

## Headless

The headless entry point takes the same options as the module. `idCategory` is variadic; pass zero or more `IDCategory` values. `interviewId` is optional; pass a value to target a specific user session, or omit it to use the default.

```swift
public func faceMatch(
    matchType: FaceMatchType? = nil,
    idCategory: IDCategory...,
    interviewId: String? = nil,
    completion: @escaping (_ result: FaceMatchResult) -> Void
)
```

```swift
// interviewId is optional and omitted here; idCategory is variadic
IncdOnboardingManager.shared.faceMatch(matchType: .idSelfie, idCategory: .primary) { result in
    // FaceMatchResult
}
```

Requires an active session.

---

- Path: `sdk-reference/module-full-name`
- URL: https://developer.incode.com/sdk-reference/module-full-name/
- Markdown: https://developer.incode.com/sdk-reference/module-full-name.md

# Full Name

The Full Name module collects the user's name and sends it to the server.

You add this module in code by adding it to your `IncdOnboardingFlowConfiguration` (`flowConfig`), as shown on this page. See [Integration Approaches](/sdk-reference/ios-flow-configuration/) for how to define and run the flow.

**Availability**: All variants.

## Add Full Name

Add the module with `addFullName()`.

```swift
flowConfig.addFullName()
```

## Configuration Options

Full Name has no configurable options.

## Validation

The **Continue** button is enabled by default and stays enabled until an error is shown.

- Typing never introduces an error message. It only clears one that the new value has resolved.
- Leaving a field reports a malformed value, but stays quiet about an empty required field until the user has tried to submit at least once.
- Tapping **Continue** validates everything, empty required fields included. From then on, leaving a field also reports an empty one.

## Result

Full Name delivers a `UserNameInfoResult` to the `onAddFullNameCompleted(_:)` callback on your `IncdOnboardingDelegate`:

```swift
func onAddFullNameCompleted(_ result: UserNameInfoResult)
```

`UserNameInfoResult` fields:

- `name: String?`: The name captured from the user; `nil` when unavailable.
- `error: IncdError?`: The error that occurred while capturing the name, if any; otherwise, `nil`.

## Headless
Requires an active session.

```swift
IncdOnboardingManager.shared.startUserNameInfo { result in
    // UserNameInfoResult
}
```

---

- Path: `sdk-reference/module-geolocation`
- URL: https://developer.incode.com/sdk-reference/module-geolocation/
- Markdown: https://developer.incode.com/sdk-reference/module-geolocation.md

# Geolocation

The Geolocation module requests location permission, then captures the precise physical location of the user's device, using its GPS sensor to record coordinates and location fields such as country, state, and city. You can configure whether the user is allowed to skip the step when a location fix is not available.

For an overview of this module and how it works, see [Geolocation](/features-and-modules/geolocation-2/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

This module requires the `NSLocationWhenInUseUsageDescription` key. See [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions).

**Availability:** All variants.

## Add Geolocation

Add the module with `addGeolocation()`. Geolocation requests location permission at runtime. If the user denies permission, the outcome depends on whether you set the module as skippable. The single parameter is optional; call `addGeolocation()` with no arguments to use the default configuration, which sets the module as not skippable.

```swift
flowConfig.addGeolocation(isSkippable: false)
```

### Example

The example below builds a flow with a non-skippable Geolocation module, registers the delegate, and starts onboarding. The result is delivered through the `onGeolocationCompleted(_:)` delegate callback.

```swift
import IncdOnboarding

final class VerificationCoordinator: IncdOnboardingDelegate {

    func start(sessionToken: String) {
        let session = IncdOnboardingSessionConfiguration(token: sessionToken)

        let flowConfig = IncdOnboardingFlowConfiguration()
        flowConfig.addGeolocation(isSkippable: false)

        IncdOnboardingManager.shared.startOnboarding(
            sessionConfig: session,
            flowConfig: flowConfig,
            delegate: self
        )
    }

    // MARK: - IncdOnboardingDelegate

    func onGeolocationCompleted(_ result: GeolocationResult) {
        // Location step finished. Inspect the result.
        if let coordinates = result.coordinates {
            let latitude = coordinates.latitude
            let longitude = coordinates.longitude
        }
    }

    func onSuccess() { /* flow completed */ }
    func onError(_ error: IncdFlowError) { /* handle error */ }
}
```

## Configuration Options

Configure the module with `addGeolocation()`.

| Option        | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                       |
| ------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `isSkippable` | `Bool` | Controls the outcome when the user exits without a location fix, whether by denying permission and skipping, or by exhausting retries on the unavailable screen. When `true`, the user can skip and the flow continues, surfacing `GeolocationError.locationUnavailable` in the result. When `false`, a module that exhausts retries ends the flow with `IncdFlowError.locationUnavailable`. Defaults to `false`. |

## Result

Geolocation delivers a `GeolocationResult` to the `onGeolocationCompleted(_:)` callback on your `IncdOnboardingDelegate`:

```swift
func onGeolocationCompleted(_ result: GeolocationResult)
```

`GeolocationResult` fields:

- `addressFields: OCRDataAddress?`: The captured location broken down into address fields; `nil` when unavailable.
- `coordinates: (latitude: Double, longitude: Double)?`: The latitude and longitude of the captured location, in degrees; `nil` when no fix was obtained.
- `error: GeolocationError?`: The error that occurred while capturing the location, if any; otherwise, `nil`.

## Errors

iOS carries the failure path inline on the same `GeolocationResult`, through its `error` property, rather than through a separate failure callback. `GeolocationError` has the following cases:

- `error(_ error: IncdError)`: A wrapped underlying error.
- `permissionsDenied`: The user denied location permission.
- `noLocationExtracted`: No location could be extracted.
- `noNetworkError`: The location could not be resolved because of a network problem.
- `locationUnavailable`: No location fix was obtained.
  - A non-skippable module that exhausts retries reports `IncdFlowError.locationUnavailable`.
  - A skippable module that is skipped surfaces `GeolocationError.locationUnavailable` in the result.

## Headless

Run the module directly, outside a configured flow, with the manager's headless API, `geolocation(interviewId:completion:)`. The `interviewId` parameter is optional; if omitted, the module falls back to the `interviewId` of the currently active session. The result is delivered through the completion handler as a `GeolocationResult`:

```swift
IncdOnboardingManager.shared.geolocation { result in
    // GeolocationResult
}
```

Requires an active session.

<br />

---

- Path: `sdk-reference/module-global-watchlist`
- URL: https://developer.incode.com/sdk-reference/module-global-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/module-global-watchlist.md

# Global Watchlist

The Global Watchlist module screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. Watchlist sources and matching behavior are controlled by your Incode Flow or Workflow configuration. Screening matches and decisions are evaluated server-side.

For an overview of this module and how it works, see [Watchlist](/features-and-modules/watchlist/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Global Watchlist

Add the module to an `IncdOnboardingFlowConfiguration` with `addGlobalWatchlist()`.

```swift
flowConfig.addGlobalWatchlist()
```

## Configuration Options

Global Watchlist has no configurable options.

## Result

The iOS SDK reports the module's outcome to your delegate.

```swift
func onGlobalWatchlistCompleted(_ result: GlobalWatchlistModuleResult)
```

`GlobalWatchlistModuleResult` fields:

- `success: Bool`: `true` if the result completed; `false` if it failed for technical or processing reasons. This does not indicate whether the person matched a watchlist entry.
- `error: IncdError?`: Currently always `nil`.

<br />

---

- Path: `sdk-reference/module-government-validation`
- URL: https://developer.incode.com/sdk-reference/module-government-validation/
- Markdown: https://developer.incode.com/sdk-reference/module-government-validation.md

# Government Validation

The Government Validation module validates identity data extracted from a user's ID against an authoritative government registry. It can also match the user's photo in the government database against their captured selfie. Whether the validation runs and what it checks also depend on your Incode Flow or Workflow configuration. The module is region-restricted and is currently supported only for Mexico.

For an overview of this module and how it works, see [Government Record Verification](/features-and-modules/government-record-verification/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants; Mexico only.

**UI:** v1 + v2 (runs without a foreground screen when `isBackgroundExecuted` is `true`).

## Add Government Validation

1. Add an [ID Capture](/sdk-reference/module-id-scan/) or [QR Scan](/sdk-reference/module-qr-scan/) module, and a [Selfie](/sdk-reference/module-selfie/) module, before Government Validation. Government Validation depends on these earlier capture steps so there is document data and a face to validate. The SDK enforces this ordering when the flow is verified.
2. Add the module with `addGovernmentValidation()`.

   ```swift
   // Default configuration
   flowConfig.addGovernmentValidation()

   // Custom configuration — run without a foreground screen
   flowConfig.addGovernmentValidation(isBackgroundExecuted: true)
   ```

### Example

The example below adds ID Capture and Selfie before Government Validation, then listens for the result through `onGovernmentValidationCompleted(_:)`.

```swift
final class VerificationCoordinator: IncdOnboardingDelegate {

    func startVerification(sessionToken: String) {
        let session = IncdOnboardingSessionConfiguration(token: sessionToken)

        let flowConfig = IncdOnboardingFlowConfiguration()
        flowConfig.addIdScan(scanStep: .both)
        flowConfig.addSelfieScan()
        flowConfig.addGovernmentValidation(isBackgroundExecuted: false)

        IncdOnboardingManager.shared.startOnboarding(
            sessionConfig: session,
            flowConfig: flowConfig,
            delegate: self
        )
    }

    // MARK: - IncdOnboardingDelegate

    func onGovernmentValidationCompleted(_ result: GovernmentValidationResult) {
        // result.success indicates whether the validation passed
    }

    func onSuccess() { /* flow completed */ }

    func onError(_ error: IncdFlowError) {
        // Onboarding flow was aborted due to error
    }
}
```

## Configuration Options

Configure the module with `addGovernmentValidation()`.

| Option                 | Type   | Notes                                                                                                  |
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------ |
| `isBackgroundExecuted` | `Bool` | Determines if the service is run in the background without displaying a UI screen. Default is `false`. |

## Result

Government Validation signals completion through the `onGovernmentValidationCompleted(_:)` callback on `IncdOnboardingDelegate`. It does not return a result object from the `add` call.

```swift
func onGovernmentValidationCompleted(_ result: GovernmentValidationResult)
```

`GovernmentValidationResult` fields:

- `success: Bool`: `true` if government validation completed successfully; otherwise, `false`.
- `error: IncdError?`: The error when validation could not complete; otherwise, `nil`.

Errors that abort the whole onboarding flow, such as a network failure, surface through the delegate's `onError(_:)` callback with an `IncdFlowError`, not through this module callback.

---

- Path: `sdk-reference/module-id-info`
- URL: https://developer.incode.com/sdk-reference/module-id-info/
- Markdown: https://developer.incode.com/sdk-reference/module-id-info.md

# ID OCR

The ID OCR module extracts text from a captured identity document using [Optical Character Recognition (OCR)](/get-started-with-incode/glossary/#ocr)​. It then shows that text to the user to confirm it's correct before the session continues. When enabled, users can correct missing or misread fields.

The [Process ID](/sdk-reference/module-process-id/) module (`addIdProcess`) runs the server-side processing; ID OCR (`addOcr`) presents the optionally editable review screen to the user. When ID Capture uses `scanStep: .both`, processing runs automatically and a separate `addIdProcess` call is not required.

For an overview of this module and how it works, see [Review OCR Data](/features-and-modules/review-ocr-data/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add ID OCR

1. Add an [ID Capture](/sdk-reference/module-id-scan/) module before ID OCR. It runs against a document that has already been captured.
2. Add a [Process ID](/sdk-reference/module-process-id/) module after ID Capture and before ID OCR.
3. Add the ID OCR module's editable review screen with `addOcr()`:
   ```swift
   // Editable OCR review
   flowConfig.addOcr(isEditable: true, idRank: .firstID)
   ```

ID OCR ships both a v1 and a v2 UI. v2 omits the ID summary screen.

## Configuration Options

Configure the module with `addOcr()`.

| Option       | Type      | Description                             |
| ------------ | --------- | --------------------------------------- |
| `isEditable` | `Bool`    | Lets the user correct extracted values. |
| `idRank`     | `IDRank?` | `.firstID` (default) or `.secondID`.    |

## Result

Register the delegate callbacks to receive results:

```swift
func onOcrCompleted()
```

`OcrResult` (editable review) exposes:

- `photo: UIImage?`, `documentNumber: String?`, `expiryDate: Date?`, and `dateOfBirth: Date?`: `nil` when unavailable.
- `error: IncdError?`: Set when the step fails; otherwise, `nil`.

You can also fetch OCR data headlessly via `IncdOnboardingManager.shared.getUserOCRData(_:completion:)`, which returns an `OmniGetOCRDataResult`.

<br />

---

- Path: `sdk-reference/module-id-scan`
- URL: https://developer.incode.com/sdk-reference/module-id-scan/
- Markdown: https://developer.incode.com/sdk-reference/module-id-scan.md

# ID Capture

The ID Capture module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. It is the entry point for most identity-capture flows.

For an overview of this module and how it works, see [ID Capture](/features-and-modules/id-capture/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add ID Capture

1. Add the module with `addIdScan()`.
   ```swift
   flowConfig.addIdScan(
       idType: nil,                              // .id or .passport; nil shows the chooser
       scanStep: .both,                          // .front / .back / .both
       idCategory: .primary,                     // .primary or .secondary
       showTutorials: true,
       showRetakeScreenForManualCapture: nil,
       showRetakeScreenForAutoCapture: nil,
       autocaptureUxMode: nil,                   // .countdown or .holdStill(duration:)
       showIDOverlay: nil,
       streamFrames: nil,
       initialOrientation: nil,
       enableAudioStream: nil,
       showIdTypeChooser: nil,
       digitalIdsUpload: false,
       motion: false                             // collect motion data + run local motion-behavior calc
   )
   ```
2. Add [ID OCR/Process](/sdk-reference/module-id-info/) after ID Capture. ID Capture captures the document images, and processing then runs validation and OCR on what was captured. When `scanStep == .both`, processing runs automatically afterward.

## Configuration Options

Configure the module with `addIdScan()`.

| Option                             | Type                 | Description                                                                                                                                              |
| ---------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idType`                           | `IdType?`            | Sets the type of document: `.id` or `.passport`. `nil` lets the user select.                                                                             |
| `scanStep`                         | `ScanStep`           | Selects which sides are captured: `.front`, `.back`, or `.both`. Default: `.both`.                                                                       |
| `idCategory`                       | `IDCategory`         | `.primary` or `.secondary`.                                                                                                                              |
| `showTutorials`                    | `Bool?`              | Shows the tutorial screen that explains how to scan an ID.                                                                                               |
| `showIdTypeChooser`                | `Bool?`              | Shows or hides the document type selector.                                                                                                               |
| `showRetakeScreenForAutoCapture`   | `Bool?`              | Controls whether the review/retake screen appears after auto-capture.                                                                                    |
| `showRetakeScreenForManualCapture` | `Bool?`              | Controls whether the review/retake screen appears after manual capture.                                                                                  |
| `autocaptureUxMode`                | `AutocaptureUxMode?` | Specifies auto-capture behavior: `.countdown` or `.holdStill(duration:)`.                                                                                |
| `showIDOverlay`                    | `Bool?`              | Shows a visual overlay/frame guide on the camera preview to help the user align the ID within the capture area. Does not impact UI v2. Default: `false`. |
| `streamFrames`                     | `Bool?`              | Turns on frame streaming during capture. Only applies for the Video Conference (`-vc`) variant.                                                          |
| `initialOrientation`               | `IDOrientation?`     | Sets the orientation of the on-screen ID template: `.vertical` or `.horizontal`. Does not impact device rotation.                                        |
| `enableAudioStream`                | `Bool?`              | Enables audio capture alongside the video/image stream during scanning. Only applies if `streamFrames` is `true`.                                        |
| `digitalIdsUpload`                 | `Bool?`              | Allows uploading an existing digital ID (PDF).                                                                                                           |
| `motion`                           | `Bool`               | Enables motion data collection and local motion-behavior calculation for the capture. Default: `false`.                                                  |

ID Capture ships both a v1 (legacy) and a v2 (smart-capture) screen. The one that runs is not controlled by an `addIdScan` parameter; the SDK selects it automatically based on a remote UX experiment and, for the v2 US smart-capture back-scan path, the active flow's Workflow configuration in Dashboard. Neither condition is directly settable by the integrating app.

There is also a non-UI variant for headless capture: `addIdScanNonUI(scanStep:idCategory:streamFrames:enableAudioStream:)`.

The overload taking `showRetakeScreen`, `showAutoCaptureRetakeScreen`, and `enableRotationOnRetakeScreen` is deprecated. Use the renamed parameters shown above for `showRetakeScreen` (`showRetakeScreenForManualCapture`) and `showAutoCaptureRetakeScreen` (`showRetakeScreenForAutoCapture`). `enableRotationOnRetakeScreen` has no replacement; it was removed instead of renamed, and is retained in the deprecated overload only as an unused parameter.

## Result

ID Capture reports through the `IncdOnboardingDelegate` callbacks, with one pair per captured side plus the lifecycle and per-attempt variants:

```swift
func onIdFrontStarted(_ controller: any IDCaptureController)
func onIdFrontCompleted(_ result: IdScanResult)
func onIdFrontAttemptCompleted(_ result: IdScanResult)
func onIdBackStarted(_ controller: any IDCaptureController)
func onIdBackCompleted(_ result: IdScanResult)
func onIdBackAttemptCompleted(_ result: IdScanResult)
```

`onIdFrontCompleted(_:)` and `onIdBackCompleted(_:)` each deliver an `IdScanResult` for that side. Check `error` first: a non-`nil` value indicates a fatal, pre-upload failure (for example, the scan never reached the server) and takes precedence over the other fields. Otherwise, treat `scanStatus` as the authoritative validation outcome for the capture. `failReason` provides supplementary detail and is not derived from `scanStatus`. Both are independently reported from the same upload response.

`IdScanResult` fields:

- `image`: The captured ID or passport image.
- `base64Image`: The Base64-encoded string of the captured image.
- `encryptedBase64Image`: The encrypted Base64-encoded image, when encryption is enabled.
- `croppedFace`: The face photo cropped from the ID; `nil` when no face can be extracted.
- `chosenIdType`: The document type the user chose (`IdType`).
- `classifiedIdType`: The document type returned by the server.
- `idCategory`: Whether the document is a primary or secondary identification document (`IDCategory`: `.primary` or `.secondary`).
- `scanStatus`: The scan outcome; an `IncdIdScanStatus`: `unknown`, `ok`, `errorClassification`, `errorGlare`, `errorSharpness`, `errorReadability`, `errorInCapture`, `errorUnacceptableID`, or `wrongSide`.
- `failReason`: The reason the scan failed; `nil` when the scan succeeds.
- `issueName`: The legal name on the document.
- `issueYear`: The year the document was issued.
- `countryCode`: The country code of the document's issuing country.
- `allAttemptsExhausted`: `true` if all retry attempts are used up. This reflects the current side, front or back, independently.
- `metadata`: The proprietary capture metadata required by the SDK; populated only in [Capture-Only mode](/sdk-reference/ios-capture-only-sdk/).
- `idealCaptureEnvironmentTestResult`: The result of the ideal-capture-environment test.
- `deviceStats`: A `DeviceStats` snapshot of the device state when the result was produced. Its `motionStatus` (`MotionStatus`) reports device motion during capture. `MotionStatus` is a `CustomStringConvertible` enum (not a string-backed/`RawRepresentable` enum) with three cases; its `description`, and the value serialized to the wire, is the uppercase string shown in parentheses:
  - `.unclear` → `"UNCLEAR"`: Motion could not be determined; this is the fallback used when no motion result is available.
  - `.pass` → `"PASS"`: Device motion was within acceptable limits.
  - `.fail` → `"FAIL"`: Excessive device motion was detected.
- `error`: An `IncdIdScanError` when the capture failed; otherwise, `nil`.

Errors also surface through `IncdOnboardingDelegate.onError(_:)`. There is no ID-Capture-specific delegate error callback beyond the per-result `error` field.

### Real-Time Capture Feedback

`IDFrameAnalysisError` gains a new case:

```swift
case preparingCamera  // new
```

`preparingCamera` is reported through `IDCaptureFeedback.error` while the ID camera is getting ready, before the preview is shown. It is not an error: the capture continues normally once the camera is ready, and the SDK's own screens show the existing "Adjusting camera" copy for it, just like `settingUpStreaming`. If you `switch` exhaustively over `IDFrameAnalysisError`, add a handler for this case.

```swift
func idCaptureController(
    _ controller: any IDCaptureController,
    didReceive feedback: IDCaptureFeedback
) {
    if feedback.error == .preparingCamera {
        // The SDK is preparing the camera; no recovery action is required.
    }
}
```

## Custom-UI Capture with IDCaptureController

For headless capture where your app draws its own camera UI, add the module with `addIdScanNonUI(scanStep:idCategory:streamFrames:enableAudioStream:)` and drive capture yourself through an `IDCaptureController`. The SDK hands you the controller in `onIdFrontStarted(_:)` and `onIdBackStarted(_:)`; store it, set its `delegate`, and start it against a `CALayer` that hosts the camera preview.

```swift
func onIdFrontStarted(_ controller: any IDCaptureController) {
    self.idCaptureController = controller
    controller.delegate = self
    controller.start(
        in: cameraContainerView.layer,
        guidelineFrame: nil,   // nil uses the controller's internal default
        idType: nil,           // nil defaults to .id
        idOrientation: nil,    // nil defaults to .horizontal
        idSide: nil            // nil defaults to .front
    )
}
```

`IDCaptureController` is an `ObservableObject`, so its published state can back a SwiftUI view directly.

### State

- `isManualCapture` (`Bool`): Whether capture is currently in manual mode.
- `canUploadIDScan` (`Bool`): Whether a captured scan is ready to upload.
- `remainingUploadAttempts` (`Int`): Upload attempts left for the current side.
- `recommendedGuideline` (`CGRect?`): The controller's recommended guideline frame, if computed.
- `isRunning` (`Bool`): Whether the capture session is active.
- `currentIdType` (`IdType`): The document type currently being captured.
- `currentIdSide` (`IDSide`, get/set): The side being captured, `.front` or `.back`.
- `currentIdOrientation` (`IDOrientation`): The detected orientation, `.vertical` or `.horizontal`.
- `currentFeedback` (`IDCaptureFeedback?`): The latest real-time feedback.
- `currentGuidelineFrame` (`CGRect`): The guideline frame currently in effect.

### Lifecycle

```swift
func start(in layer: CALayer, guidelineFrame: CGRect?, idType: IdType?, idOrientation: IDOrientation?, idSide: IDSide?)
func pauseAnalyzing()
func continueAnalyzing()
func stop()
func cancel()
func finish()
```

- `start(in: guidelineFrame: idType: idOrientation: idSide:)` attaches the camera preview to the layer in aspect-fill mode and begins analyzing frames, stopping when an ideal frame is captured. 
- `pauseAnalyzing()` and `continueAnalyzing()` pause and resume analysis while keeping the camera feed running. 
- `stop()` ends the session and detaches the preview. 
- `cancel()` returns an empty result for the module and proceeds to the next one when possible. 
- `finish()` completes the ID Scan module and advances to the next one if available; call it once you are ready to move on.

### Manual Capture

```swift
func switchToManualCapture()
func switchToAutomaticCapture()
func triggerManualFrameCapture()
```

Call `switchToManualCapture()` to leave auto-capture, then `triggerManualFrameCapture()` to capture the current frame on demand. Call `switchToAutomaticCapture()` to return to auto-capture.

Unlike `switchToManualCapture()`, which takes effect immediately, `switchToAutomaticCapture()` only updates the mode: frame analysis. The auto-capture fallback timers restart when capture next resumes analysis. Pair it with a `continueAnalyzing()` call — calling it on a live capture without a following resume leaves analysis paused with no timer armed.

### Guideline Frame

The guideline frame defines the expected position and size of the ID within the preview and feeds the position, size, and visibility checks. It is expressed in the preview layer's coordinate space, not the camera frame.

```swift
func updateGuidelineFrame(_ frame: CGRect)
```

Push a new frame whenever your overlay moves or resizes, using the same preview space passed to `start(...)`. The controller also reports a recommended frame through `idCaptureControllerDidChangeIdAttributes(...)`; you can apply it or supply your own.

### Digital ID and Barcode

When you accept an existing digital document instead of a live scan, hand the data to the controller:

```swift
func setDigitalID(pdfDocumentData: Data)
func setBarcode(barcodeData: String)
```

### Upload

```swift
func startUpload()                                                  // results via delegate
func upload(onProgressUpdate: ((Float) -> Void)?) async -> IDUploadResult
```

`startUpload()` reports results and progress through the delegate. `upload(onProgressUpdate:)` returns the result directly and reports progress through the optional closure. `IDUploadResult` is `Result<Void, IDUploadError>`.

```swift
Task {
    let result = await controller.upload { progress in
        updateProgressBar(progress)
    }
    switch result {
    case .success:
        handleUploadSuccess()
    case .failure(let error):
        handleUploadError(error)
    }
}
```

### IDCaptureControllerDelegate

```swift
func idCaptureControllerDidStart(_ controller: any IDCaptureController)
func idCaptureControllerDidDetectID(_ controller: any IDCaptureController) async
func idCaptureController(_ controller: any IDCaptureController, didReceive feedback: IDCaptureFeedback)
func idCaptureControllerDidClearFeedback(_ controller: any IDCaptureController)
func idCaptureControllerDidChangeIdAttributes(_ controller: any IDCaptureController, orientation: IDOrientation, idType: IdType, recommendedGuidelineRect: CGRect?)
func idCaptureController(_ controller: any IDCaptureController, willCapturePhoto frame: UIImage, idCrop: UIImage) async
func idCaptureController(_ controller: any IDCaptureController, didCapturePhoto frame: UIImage, idCrop: UIImage) async
func idCaptureControllerDidSwitchToManualCapture(_ controller: any IDCaptureController)
func idCaptureControllerDidSwitchToAutomaticCapture(_ controller: any IDCaptureController)
func idCaptureController(_ controller: any IDCaptureController, captureAttemptInFlight: Bool)
func idCaptureController(_ controller: any IDCaptureController, didBecomeReadyToProceedWithId side: IDSide)
func idCaptureControllerDidCompleteIdScan(_ controller: any IDCaptureController)
func idCaptureController(_ controller: any IDCaptureController, didCaptureDigitalID: Data) async
func idCaptureController(_ controller: any IDCaptureController, didCaptureBarcode: String) async

// Uploading
func idCaptureControllerDidStartUploading(_ controller: any IDCaptureController)
func idCaptureController(_ controller: any IDCaptureController, didUpdateUploadProgress progress: Float)
func idCaptureController(_ controller: any IDCaptureController, didFinishUploading status: IDUploadResult, canRetry: Bool)
```

`idCaptureControllerDidClearFeedback(_:)`, `idCaptureControllerDidSwitchToAutomaticCapture(_:)` and `idCaptureController(_:captureAttemptInFlight:)` have default no-op implementations, so existing conformers do not need to add them. `idCaptureController(_:captureAttemptInFlight:)` reports `true` when a capture attempt is claimed and `false` when it is released, so UI that starts or leaves a capture can follow it. Real-time feedback arrives as an `IDCaptureFeedback`, whose `error` is an `IDFrameAnalysisError`; see [Real-Time Capture Feedback](#real-time-capture-feedback) for the case set and handling.

## Errors

`IncdIdScanError` cases:

- `error`
- `cameraSetupFailed`
- `permissionsDenied`
- `fakePermissionsDenied`
- `skipped`
- `streamAudioPermissionsDenied`

---

- Path: `sdk-reference/module-intro`
- URL: https://developer.incode.com/sdk-reference/module-intro/
- Markdown: https://developer.incode.com/sdk-reference/module-intro.md

# Intro

The Intro module displays an introduction screen. It lists the documents and checks the user will need to complete.

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Intro

Add the module with `addIntro()`. Intro is meant to run first, so add it before your capture modules.

```swift
flowConfig.addIntro(checks: [.id, .selfie])
```

### Example

The example below builds a flow whose Intro lists the ID and selfie checks, adds it as the first step, and then starts onboarding.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addIntro(checks: [.id, .selfie])   // add Intro first
flow.addIdScan(scanStep: .both)
flow.addSelfieScan()
// ... add the rest of your capture modules

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)
```

## Configuration Options

Configure the module with `addIntro(checks:)`. It takes a single argument; an empty array (`checks: []`) is accepted and simply renders an intro screen listing no checks.

| Option   | Type           | Notes                                                                                                                                                           |
| -------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `checks` | `[IntroCheck]` | Sets the list of documents and checks shown on the intro screen: `.id`, `.passport`, `.insuranceCard`, `.proofOfAddress`, `.selfie`, or a combination of these. |

The intro checks you list should reflect the capture modules you add to the same flow, so the screen matches what the user is actually asked to complete.

## Result

Intro has no dedicated completion callback that hands back `IntroResult` and `IntroError` directly; those types are public but are consumed only internally. On success, the flow simply advances to the next module. If the user cancels the intro step, the delegate's `userCancelledSession()` is called; any other Intro failure surfaces through the delegate's `onError(_ error: IncdFlowError)`.

## Errors

The module's typed error is `IntroError` (`.error(IncdError)` or `.userCancelled`). In a code-defined flow, it is not delivered to your delegate directly:

- If the user dismisses the step, the delegate's `userCancelledSession()` is called.
- Any other failure surfaces through the delegate's `onError(_ error: IncdFlowError)`, reported as a generic error rather than the underlying `IncdError`.

<br />

---

- Path: `sdk-reference/module-machine-learning-consent`
- URL: https://developer.incode.com/sdk-reference/module-machine-learning-consent/
- Markdown: https://developer.incode.com/sdk-reference/module-machine-learning-consent.md

# Machine Learning Consent

The Machine Learning Consent module captures the user's consent to process their biometric data for machine-learning purposes. You choose the consent text variant (US, GDPR, or worldwide) that matches your compliance needs.

You add this module in code by adding it to your `IncdOnboardingFlowConfiguration` (`flowConfig`), as shown on this page. See [Integration Approaches](/sdk-reference/ios-flow-configuration/) for how to define and run the flow.

**Availability**: All variants.

## Add Machine Learning Consent

Add the module to the flow with `addMachineLearningConsent(type:)`. The `type` argument is required. There is no default, so you always pass the regulation variant explicitly.

```swift
flowConfig.addMachineLearningConsent(type: .us)   // .us / .gdpr / .worldwide
```

### Example

The example below adds the module to the flow configuration and handles the result through `IncdOnboardingDelegate`.

```swift
flowConfig.addMachineLearningConsent(type: .us)

func onMachineLearningConsentCompleted(_ result: MachineLearningConsentResult) {
    // Consent step completed. Process the result.
}
```

## Configuration Options

Configure the module with `addMachineLearningConsent()`.

| Option | Type             | Description                                                                                                             |
| ------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `type` | `RegulationType` | Selects the consent text variant: `.us`, `.gdpr`, or `.worldwide`. Must be supplied on every call. There is no default. |

## Result

Machine Learning Consent delivers a `MachineLearningConsentResult` to the `onMachineLearningConsentCompleted(_:)` callback on your `IncdOnboardingDelegate`. Its fields are:

- `status: Bool?`: The consent choice the user made and Incode recorded. `true` if the user accepted the consent; `false` if the user declined it; `nil` if the choice could not be recorded, in which case `error` is set.
- `error: IncdError?`: The error that occurred, when present; otherwise, `nil`.

The consent is optional, so the user can continue with or without it. The flow always continues to the next module. Read `status` to know what the user chose, and apply your own policy if your compliance rules require the consent.

<br />

---

- Path: `sdk-reference/module-nfc-scan`
- URL: https://developer.incode.com/sdk-reference/module-nfc-scan/
- Markdown: https://developer.incode.com/sdk-reference/module-nfc-scan.md

# NFC

The NFC module reads the secure [NFC](/get-started-with-incode/glossary/#nfc-scan) chip embedded in ICAO 9303-compliant travel documents, such as e-passports. It then returns the document holder's data, including the chip's portrait image. When a flow captures multiple IDs, NFC Scan applies only to the first ID. Chip reading uses secure messaging; see [Security](/sdk-reference/ios-security/).

For an overview of this module and how it works, see [NFC Scan](/features-and-modules/nfc/).

This page covers the code-configured flow: building an `IncdOnboardingFlowConfiguration` in your app and calling `startOnboarding`. When the flow is defined in Dashboard instead and started with `startFlow` or `startWorkflow`, the NFC step is configured server-side. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

This module requires the `NFCReaderUsageDescription` key and the ISO 7816 application identifiers. See [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions).

**Availability:** The `-nfc` build variant, on NFC-capable devices running iOS 13 or later. Calling it from a non-NFC variant triggers a runtime variant assertion (`IncdOnboardingVariant.assertIncludes(.nfc)`).

**UI:** standalone (Apple's system NFC sheet).

Use this module when:

- You need a high-assurance read of the document chip, not just an OCR of the printed page.
- Your flow performs `.nfcSelfie` or `.nfc3Way` [Face Match](/sdk-reference/module-face-match/) against the chip photo. These match types become available when `processNFCData` is enabled.

## Add NFC

1. Build the SDK with the `-nfc` variant so the NFC module is linked in.
2. Add [ID Capture](/sdk-reference/module-id-scan/) (`addIdScan(scanStep: .both)`) then [Process ID](/sdk-reference/module-process-id/) (`addIdProcess()`), before NFC. NFC reads the chip after the document has been captured and processed.
3. Add the module with `addNfcScan()`. All parameters are optional; omitting one falls back to its default.
   ```swift
   flowConfig.addNfcScan(
       idType: nil,                              // .id or .passport; nil uses the captured/selected type
       showNFCSymbolConfirmationScreen: nil,     // ask the user to confirm the chip symbol (default true)
       showInitialDataConfirmationScreen: nil,   // confirm the key data before reading (default true)
       showTutorials: nil,                       // show scanning tutorials (default true)
       nfcMaxRetries: nil,                        // retry budget (default 5)
       processNFCData: nil,                       // process the read data on the backend (default true)
       returnResultImmediately: nil               // return as soon as the chip is read (default false)
   )
   ```

### Example

The example below adds NFC after ID Capture and ID OCR/Process, shows the NFC symbol confirmation screen, processes the chip data, and listens for the result through the `onNFCScanCompleted(_:)` delegate callback.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addIdScan(scanStep: .both)
// ID OCR runs automatically after a .both ID Capture
flow.addNfcScan(
    showNFCSymbolConfirmationScreen: true,
    processNFCData: true
)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)
```

```swift
extension MyViewController: IncdOnboardingDelegate {
    func onNFCScanCompleted(_ result: NFCScanResult) {
        // NFC scan completed. Process the result.
    }
}
```

## Configuration Options

Configure the module with `addNfcScan()`.

| Option                              | Type      | Description                                                                                                                                                                                                    |
| ----------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idType`                            | `IdType?` | `.id` or `.passport`; `nil` uses the document already captured or selected.                                                                                                                                    |
| `showNFCSymbolConfirmationScreen`   | `Bool?`   | Shows a screen asking whether the document contains an NFC chip. Default: `true`.                                                                                                                              |
| `showInitialDataConfirmationScreen` | `Bool?`   | Confirms the key data before reading the chip. Applies to the first entry into the module only. Default: `true`.                                                                                                                                                |
| `showTutorials`                     | `Bool?`   | Shows tutorials on how to scan the document. Default: `true`.                                                                                                                                                  |
| `nfcMaxRetries`                     | `Int?`    | Sets the maximum number of NFC scan attempts. Default: `5`.                                                                                                                                                    |
| `processNFCData`                    | `Bool?`   | Submits the chip data to the back end for identity validation. Enables the `.nfcSelfie` and `.nfc3Way` [Face Match](/sdk-reference/module-face-match/) types. Default: `true`. |
| `returnResultImmediately`           | `Bool?`   | Returns as soon as the chip is read. Default: `false`.                                                                                                                                                         |

For each NFC read, the SDK tries the PACE protocol first and falls back to BAC when PACE is unavailable or fails. PACE and BAC are alternatives, not both required. An NFC chip whose access protocol the device cannot complete fails the scan and routes through the retries configured using `nfcMaxRetries`.

### Retries

`showInitialDataConfirmationScreen` controls the first entry into the module. Where a retry goes depends on why the read failed:

- The chip rejected the key built from the document number, birth date and expiry date. One of those values is wrong, so the retry returns to the data confirmation screen for the user to correct it, then scans again.
- The read was interrupted, because the phone moved away from the chip, the user dismissed the system NFC sheet, or the session timed out. The confirmed data was never in question, so the retry goes straight back to scanning.

## Result

```swift
func onNFCScanCompleted(_ result: NFCScanResult)
```

`NFCScanResult` fields:

- `facePhoto: UIImage?`: The document holder's face image decoded from the chip.
- `dg1: NFCDataModel.DG1?`: The machine-readable zone (MRZ) data (DG1). Its fields include:
  - `documentNumber`: The nine most-significant digits of the document number.
  - `documentCode`: The MRZ document code. One of the following: `TD1`, `TD2`, `TD3`, `MRVA`, or `MRVB`. The default is `TD3`.
  - `nationality`: The document holder's nationality as a three-letter code.
  - `issuingStateOrOrganization`: The issuing state or organization as a three-letter code.
  - `birthDate`: The date of birth in `yyMMdd` format (DG1).
  - `expireAt`: The document expiry date in `yyMMdd` format (DG1).
  - `gender`: The document holder's gender. One of the following: `MALE`, `FEMALE`, `UNKNOWN`, or `UNSPECIFIED`.
  - `primaryIdentifier`: The document holder's last name.
  - `secondaryIdentifier`: The document holder's first name.
  - `optionalData1`: First optional data field (ID-1 and ID-3 style MRZs).
  - `optionalData2`: Second optional data field (ID-1 style MRZs only); may be `null`.
  - `personalNumber`: Personal number, if encoded in `optionalData1`.
  - The corresponding MRZ check-digit fields:
    - `compositeCheckDigit`: The MRZ composite check digit (DG1); `<` when unset.
    - `dateOfBirthCheckDigit`: The check digit for the date of birth; `<` when unset.
    - `documentNumberCheckDigit`: The check digit for the document number; `<` when unset.
    - `expirationDateCheckDigit`: The check digit for the expiration date; `<` when unset.
    - `personalNumberCheckDigit`: The check digit for the personal number (TD3 only); may be `null`.
- `error: NFCScanError?`: Set when the scan did not complete successfully.

## Errors

Errors surface on the completion callback as `result.error`. Wrong-variant calls fail immediately via `IncdOnboardingVariant.assertIncludes(.nfc)` instead of through this callback.

`NFCScanError` cases:

- `error`: A wrapped `IncdError`.
- `notAvailable`: NFC not available on this OS/device.
- `userDocumentHasNoChip`
- `noScanAttemptsRemaining`

<br />

---

- Path: `sdk-reference/module-phone`
- URL: https://developer.incode.com/sdk-reference/module-phone/
- Markdown: https://developer.incode.com/sdk-reference/module-phone.md

# Phone

The Phone module collects a user's phone number and can confirm phone ownership by sending a one-time password (OTP) via SMS.

For an overview of this module and how it works, see [Phone Number Input](/features-and-modules/phone-number-input/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants; the `-sna` build adds [Silent Network Authentication](/features-and-modules/silent-network-authentication-sna/) features.

**UI:** v1 and v2.

## Add Phone

Add the module with `addPhone()`. Both parameters are optional; call `addPhone()` with no arguments to use the default configuration.

```swift
flowConfig.addPhone(
    otpVerification: true,
    defaultRegionPrefix: 1     // optional dial code, 1…9999
)
```

### Example

The example below builds a flow with the Phone module, enables OTP verification, starts onboarding, and listens for the result through `onAddPhoneNumberCompleted(_:)` on `IncdOnboardingDelegate`.

```swift
final class VerificationCoordinator: IncdOnboardingDelegate {

    func startVerification(sessionToken: String) {
        let flow = IncdOnboardingFlowConfiguration()
        flow.addPhone(otpVerification: true)

        let session = IncdOnboardingSessionConfiguration(token: sessionToken)
        IncdOnboardingManager.shared.startOnboarding(
            sessionConfig: session,
            flowConfig: flow,
            delegate: self
        )
    }

    // MARK: - IncdOnboardingDelegate

    func onAddPhoneNumberCompleted(_ result: PhoneNumberResult) {
        // Phone number captured. Process the result.
        let phone = result.phone
    }
}
```

## Configuration Options

Configure the module with `addPhone()`.

| Option                | Type    | Description                                                                                                                                                                                                                                                         |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `otpVerification`     | `Bool?` | If `true`, shows OTP verification after the user enters a phone number. When `nil`, shows the value configured on the Workflow (via `OTPConfiguration`) or the manager flag.                                                                                        |
| `defaultRegionPrefix` | `Int?`  | Sets a dialing prefix that overrides the prefix derived from the carrier or the device's current region. Valid values are integers greater than `0`, up to four digits; invalid values are ignored and the default region prefix is used. Do not add a leading `+`. |

You can also enable SMS OTP globally on the manager with `enableSMSOTPVerification`: a `UserDefaults`-backed flag, `false` by default. OTP expiration and prefill are determined by the Workflow's `OTPConfiguration`.

## Validation

On the v2 screen, the **Continue** button is enabled by default and stays enabled until an error is shown.

- Typing never introduces an error message. It only clears one that the new value has resolved.
- Leaving a field reports a malformed value, but stays quiet about an empty required field until the user has tried to submit at least once.
- Tapping **Continue** validates everything, empty required fields included. From then on, leaving a field also reports an empty one.

## Enable Silent Network Authentication

[Silent Network Authentication](/features-and-modules/silent-network-authentication-sna/) (SNA) is a phone number verification method that authenticates users through their mobile network using real-time carrier signals. You can enable SNA for the Phone module. SNA Dashboard configuration is currently only available in Flows, not Workflows.

1. Use an iOS SDK variant that includes the `-sna` suffix: for example, `5.51.0-s-sna`.
2. In a Flow in Dashboard, turn on **_Enable SNA verification_** in the [Phone Number Input](/dashboard-platform-administration/phone-number-input-dashboard/) module.
3. Start the onboarding flow using one of the following approaches:
   - `startFlow` **or** `startOnboarding`: Specify `configurationId` inside `IncdOnboardingSessionConfiguration`, and provide it as `sessionConfig` to `startFlow` or `startOnboarding` method.
   - **Sections**: Specify `configurationId` inside `IncdOnboardingSessionConfiguration`, and provide it as `sessionConfig` to `setupOnboardingSession`. Then call `startOnboardingSection` with the Phone module provided to `IncdOnboardingSessionConfiguration`.

## Result

Phone delivers a `PhoneNumberResult` to the `onAddPhoneNumberCompleted(_:)` callback on your `IncdOnboardingDelegate`:

```swift
func onAddPhoneNumberCompleted(_ result: PhoneNumberResult)
```

`PhoneNumberResult` fields:

- `phone: String?`: The phone number captured from the user; `nil` when unavailable.
- `error: IncdError?`: The error that occurred while capturing the phone number, if any; otherwise, `nil`.

<br />

---

- Path: `sdk-reference/module-process-id`
- URL: https://developer.incode.com/sdk-reference/module-process-id/
- Markdown: https://developer.incode.com/sdk-reference/module-process-id.md

# Process ID

The Process ID module determines whether a submitted identity document is authentic. It analyzes the images captured by the [ID Capture](/sdk-reference/module-id-scan/) module against known parameters for the document type, runs a set of authenticity checks, and produces a validation result and the OCR data used by later steps. Process ID has no capture UI of its own; the user-facing capture happens in the ID Capture step that runs before it.

The Process ID module (`addIdProcess`) runs the server-side processing; the [ID OCR](/sdk-reference/module-id-info/) module (`addOcr`) presents the optionally editable review screen to the user. When ID Capture uses `scanStep: .both`, processing runs automatically and a separate `addIdProcess` call is not required.

For an overview of this module and how it works, see [ID Validation](/features-and-modules/id-validation-module/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Process ID

1. Add an [ID Capture](/sdk-reference/module-id-scan/) module before Process ID. Process ID validates the document captured there.
2. Add Process ID with `addIdProcess(idCategory:)`.
   ```swift
   let flow = IncdOnboardingFlowConfiguration()

   flow.addIdProcess(idCategory: .primary) // Validate a document captured in a previous step.
   ```
3. Add an [ID OCR](/sdk-reference/module-id-info/) module (`addOcr()`) after Process ID to read or edit the extracted fields.

### Example

The example below adds ID Capture, then Process ID, then ID OCR. It then listens for the validation result on `IncdOnboardingDelegate`.

```swift
let flow = IncdOnboardingFlowConfiguration()

// 1. Capture the document. With scanStep: .both, processing runs automatically.
flow.addIdScan(scanStep: .front, idCategory: .primary)

// 2. Validate a captured document explicitly (required when you capture a single side).
flow.addIdProcess(idCategory: .primary)

// 3. Read/edit the OCR data the processing step returns.
flow.addOcr(isEditable: true, idRank: .firstID)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)
```

```swift
extension MyViewController: IncdOnboardingDelegate {
    func onIdProcessed(_ result: IdProcessResult) {
        // ID validated. Read result.ocrData.
    }

    func onError(_ error: IncdFlowError) {
        // Validation could not be completed.
    }
}
```

## Configuration Options

Configure the module with `addIdProcess()`.

| Option       | Type         | Notes                                                                                   |
| ------------ | ------------ | --------------------------------------------------------------------------------------- |
| `idCategory` | `IDCategory` | Sets which captured document this step validates: `.primary` (default) or `.secondary`. |

When a flow captures two documents, use `addIdProcess(idCategory: .primary)` and `addIdProcess(idCategory: .secondary)` on separate steps to validate each captured document.

`addIdProcess(idCategory:enableIdSummaryScreen:)` is deprecated, and `enableIdSummaryScreen` will be removed. Use `addIdProcess(idCategory:)`.

## Result

Process ID delivers an `IdProcessResult` to `onIdProcessed(_:)` on the `IncdOnboardingDelegate`:

```swift
func onIdProcessed(_ result: IdProcessResult)
func onError(_ error: IncdFlowError)
```

`IdProcessResult` fields:

- `ocrData: OmniGetOCRDataResponse?`: The OCR data extracted from the processed ID, such as `name`, `address`, `birthDate`, `expirationDate`, `issueDate`, and `gender`; `nil` when unavailable.
- `extendedOcrJsonData: Data?`: The full extended OCR payload as raw JSON; `nil` when unavailable.

If validation cannot be completed, the error surfaces through `onError(_ error: IncdFlowError)`.

---

- Path: `sdk-reference/module-qes`
- URL: https://developer.incode.com/sdk-reference/module-qes/
- Markdown: https://developer.incode.com/sdk-reference/module-qes.md

# QES (Qualified Electronic Signature)

The QES (Qualified Electronic Signature) module shows the user documents to sign, collects their consent, and captures a Qualified Electronic Signature (QES), the highest-assurance electronic signature under the [EU eIDAS Regulation](https://eur-lex.europa.eu/eli/reg/2014/910/oj/eng). A qualified certificate from a Qualified Trust Service Provider (QTSP) backs the signature, making it legally equivalent to a handwritten signature across EU member states.

For an overview of this module and how it works, see [Qualified Electronic Signature](/features-and-modules/qualified-electronic-signature/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by ID. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add QES

1. Add identity check modules before QES. [ID Capture](/sdk-reference/module-id-scan/), [Phone](/sdk-reference/module-phone/), and [Selfie](/sdk-reference/module-selfie/) must come before QES when included in the flow.
2. Add the module with `addQes()`.
   ```swift
   flowConfig.addQes(configuration: QESConfiguration(uploadDocument: true, downloadDocument: true))
   ```

QES uses the Incode Design System V2 experience.

## Configuration Options

Configure the module by passing a `QESConfiguration` to `addQes(configuration:)`.

| Option             | Type      | Description                                                                |
| ------------------ | --------- | -------------------------------------------------------------------------- |
| `downloadDocument` | `Bool?`   | When `true`, offers the signed document for download. Defaults to `false`.                         |
| `providerCode`     | `String?` | The QTSP provider code used for the signature. Optional.                                           |
| `uploadDocument`   | `Bool?`   | When `true`, lets the user select and upload a PDF before the signing screen. Defaults to `false`. |

When `uploadDocument` is enabled, the user picks and uploads a PDF before the signing screen. `providerCode` selects the qualified signature provider for the session: for example, `QES_3` for Namirial. It is normally supplied by the Flow configuration in Dashboard.

## Provider Behavior

For Namirial (`providerCode`: `QES_3`), the back end supplies the consent checkbox labels. The Terms & Conditions and Privacy Policy appear as links on the Review and Sign screen; the previous separate Terms & Conditions screen is no longer shown. After signing, the module displays the signer's name and signing date.

If signing fails, the module shows "Signature failed". The back-end reason determines if the user can retry. An expired signing certificate can be retried. Mismatched or missing identity data and signing-provider failures close the module because retrying cannot resolve them.



## Result

`onQESCompleted` is called regardless of the outcome, and the user continues with any modules configured after QES.

```swift
func onQESCompleted(result: QESResult)
```

`QESResult` fields:

- `success: Bool`: `true` if the documents were signed successfully.
- `error: QESError?`: The signing error, or `nil` if there was no error.

`QESError` cases:

- `noDocuments`: No documents were available for the session.
- `failedToSign`: Signing failed.

<br />

---

- Path: `sdk-reference/module-qr-scan`
- URL: https://developer.incode.com/sdk-reference/module-qr-scan/
- Markdown: https://developer.incode.com/sdk-reference/module-qr-scan.md

# QR Scan

The QR Scan module captures the QR code on the back of an ID, decodes its identity data, and sends it to the server. Your Incode Flow or Workflow configuration determines whether the module runs and what the decoded payload is used for. QR Scan requires camera access; the SDK requests the camera permission during the flow. See [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions).

You add this module in code by adding it to your `IncdOnboardingFlowConfiguration` (`flowConfig`), as shown on this page. See [Integration Approaches](/sdk-reference/ios-flow-configuration/) for how to define and run the flow.

**Availability:** All variants.

## Add QR Scan

1. Add the module with `addQRScan()`.
   ```swift
   flowConfig.addQRScan(showTutorials: true)   // omit or pass nil to use the default
   ```
2. If your flow includes the Video Conference, User Consent, or Government Validation modules, add them after QR Scan. Adding any of those modules before QR Scan throws `ModuleConfigurationError.invalidOrder`.

## Configuration Options

Configure the module with `addQRScan()`.

| Option          | Type    | Notes                                                                                                                                                                      |
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `showTutorials` | `Bool?` | Shows tutorial screens that explain the QR scan process before capture. `nil` uses the manager default (`IncdOnboardingManager.shared.showQRTutorials`, `true` by default) |

## Result

```swift
func onQRScanCompleted(_ result: QRScanResult)
```

`QRScanResult` fields:

- `success: Bool?`: Whether the scan succeeded.
- `error: IncdError?`: The error when the scan did not succeed; otherwise, `nil`.

<br />

---

- Path: `sdk-reference/module-results`
- URL: https://developer.incode.com/sdk-reference/module-results/
- Markdown: https://developer.incode.com/sdk-reference/module-results.md

# Results

The Results module shows a screen summarizing the data captured during onboarding, including OCR fields, captured images, and identity scores. It returns an overall user score. The score includes ID validation, liveness, face recognition, and government validation, plus an overall value and status.


How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants. Adding Results while the SDK is in **Submit-Only Mode** has no effect; the step is silently skipped.

## Add Results

1. Add an [ID Capture](/sdk-reference/module-id-scan/) or [QR Scan](/sdk-reference/module-qr-scan/) module before Results. Results depends on the data those earlier steps produce.
2. Add a [Selfie](/sdk-reference/module-selfie/) module before Results. On iOS this is **required**. Flow configuration validation throws `ModuleConfigurationError.missingModule` if no Selfie module is present anywhere in the flow.
3. Add the module with `addUserScore()`:

   ```swift
   // Default fetch mode (Accurate)
   flowConfig.addUserScore()

   // Or choose how results are fetched
   flowConfig.addUserScore(userScoreFetchMode: .fast)
   ```

### Example

The example below adds ID Capture and Selfie before Results, then reads the overall score and status from `onUserScoreFetched(_:)` on the onboarding delegate.

```swift
flowConfig.addIdScan(scanStep: .both)
flowConfig.addSelfieScan()
flowConfig.addUserScore()

// IncdOnboardingDelegate
func onUserScoreFetched(_ result: UserScore) {
    let score = result.overall?.value   // for example, "80.5/100"
    let status = result.overall?.status
}
```

To fetch the score without presenting the results screen, use the headless API `IncdOnboardingManager.shared.getUserScore(userScoreFetchMode:interviewId:completion:)`, which returns the same `UserScore`.

## Configuration Options

Results has no builder. Its only option is the fetch mode passed to `addUserScore(userScoreFetchMode:)`.

| Option                        | Description                                                                             |
| ----------------------------- | --------------------------------------------------------------------------------------- |
| `UserScoreFetchMode.accurate` | Fetches the complete, precise score. This is the default (used when no mode is passed). |
| `UserScoreFetchMode.fast`     | Fetches results sooner, trading completeness for speed.                                 |

## Result

Results delivers a `UserScore` through the `onUserScoreFetched(_ result: UserScore)` callback on `IncdOnboardingDelegate`.

```swift
func onUserScoreFetched(_ result: UserScore)
```

`UserScore` fields:

- `overall: Result?`: The overall score and status; `nil` when unavailable.
- `idValidation: IDValidation?`: The ID verification checks.
- `liveness: Liveness?`: The liveness checks.
- `faceRecognition: FaceRecognition?`: The face recognition checks.
- `governmentValidation: GovernmentValidation?`: The government validation checks.
- `extendedUserScoreJsonData: Data?`: Additional score data as raw JSON.
- `error: IncdError?`: The error, if one occurred.

`Result` carries `value: String?` (for example, `"80.5/100"`) and `status: Status?`. `Status` is one of:

- `ok` (`"OK"`): Passed.
- `warning` (`"WARN"`): Passed with warnings.
- `fail` (`"FAIL"`): Failed.
- `unknown` (`"UNKNOWN"`): Status could not be determined.
- `manual` (`"MANUAL"`): Manual review needed.

The per-category structs expose their own `overall: Result?` plus category-specific detail:

- `IDValidation`: `overall`, `photoSecurityAndQuality: [IDCheck]?`, `idSpecific: [IDCheck]?`.
- `Liveness`: `overall`, `livenessScore: Result?`, `photoQuality: PhotoQuality?`.
- `FaceRecognition`: `overall`, `croppedFace: String?` (Base64-encoded), `croppedIDFace: String?` (Base64-encoded), `existingUser: Bool?`.
- `GovernmentValidation`: `overall`, `recognitionConfidence: Result?`, `validationStatus: IDCheck?`, `ocrValidation: [IDCheck]?`.

Each `IDCheck` carries `key: String?`, `value: String?`, and `status: Status?`.

Errors surface through `UserScore.error` as an `IncdError`; for the complete case list, see [Common Types](/sdk-reference/ios-api-reference/#common-types). This module does not deliver a module-specific error type.

<br />

---

- Path: `sdk-reference/module-selfie`
- URL: https://developer.incode.com/sdk-reference/module-selfie/
- Markdown: https://developer.incode.com/sdk-reference/module-selfie.md

# Selfie

The Selfie module captures the user's face with their device's camera and runs configurable liveness, face recognition, and image-quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can optionally capture depth and a video-liveness clip via Deepsight, and it backs the [Face Match](/sdk-reference/module-face-match/) and [Face Authentication](/sdk-reference/module-face-authentication/) modules.

For an overview of this module and how it works, see [Face Capture](/features-and-modules/face-capture/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it by session token and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/). For [1:1](/get-started-with-incode/glossary/#11-face-authentication) and [1:N](/get-started-with-incode/glossary/#1n-face-authentication) face login of returning users, iOS uses a separate `startFaceLogin` flow rather than a mode on this module; see [Face Authentication](/sdk-reference/module-face-authentication/).

**Availability:** All variants; the `-l` build adds extra local-liveness options.

## Add Selfie Scan

Add the module with `addSelfieScan()` on your `IncdOnboardingFlowConfiguration`. Call it with no arguments for the default configuration, or pass options to customize it. Most onboarding flows require Selfie, and some modules depend on ordering; for example, [Face Match](/sdk-reference/module-face-match/) needs Selfie and an ID or NFC capture added first.

```swift
// Default configuration
flowConfig.addSelfieScan()

// Custom configuration
flowConfig.addSelfieScan(
    showTutorials: true,
    lensesCheck: true,
    faceMaskCheck: true,
    closedEyesCheck: true,
    headCoverCheck: true,
    cameraFacing: .front,
    deepsight: DeepsightConfiguration(
        enabled: true,
        modality: .singleFrameWithDepthAndVideo,
        motion: true
    )
)
```

Selfie ships both a v1 and a v2 capture UI; the SDK selects the active one.

### Example

The example below builds a flow with a Selfie module with tutorials shown, starts onboarding, and receives the result through the `onSelfieScanCompleted` delegate callback.

```swift
let flow = IncdOnboardingFlowConfiguration()
flow.addSelfieScan(showTutorials: true)

IncdOnboardingManager.shared.startOnboarding(
    sessionConfig: IncdOnboardingSessionConfiguration(token: "<SESSION_TOKEN>"),
    flowConfig: flow,
    delegate: self
)

// ...

extension MyViewController: IncdOnboardingDelegate {
    func onSelfieScanCompleted(_ result: SelfieScanResult) {
        // Final selfie result
        if let error = result.error {
            // Handle SelfieScanError
        }
    }

    func onSelfieAttemptCompleted(_ result: SelfieScanResult) {
        // Optional: per-attempt result
    }
}
```

## Configuration Options

Pass these parameters to `addSelfieScan()`. Any parameter left `nil` falls back to the SDK/back-end default.

These options aren't the only factor. Your backend Flow or Workflow configuration can also determine where liveness and recognition run, as well as the effective Deepsight behavior for a given step.

| Option                 | Type                     | Description                                                                                                                                                                                    |
| ---------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `showTutorials`        | `Bool?`                  | Shows a tutorial before capture.                                                                                                                                                               |
| `lensesCheck`          | `Bool?`                  | Enables eyeglasses/contact lenses detection during capture.                                                                                                                                    |
| `faceMaskCheck`        | `Bool?`                  | Enables face-mask detection during capture.                                                                                                                                                    |
| `closedEyesCheck`      | `Bool?`                  | Enables closed eyes detection during capture.                                                                                                                                                  |
| `headCoverCheck`       | `Bool?`                  | Enables head covering detection during capture.                                                                                                                                                |
| `cameraFacing`         | `CameraFacing?`          | `.front` or `.back`.                                                                                                                                                                           |
| `streamFrames`         | `Bool?`                  | Enables frame streaming during capture.                                                                                                                                                        |
| `enableAudioStream`    | `Bool?`                  | Enables audio streaming during capture.                                                                                                                                                        |
| `customLogo`           | `UIImage?`               | Displays a custom logo on the capture screen.                                                                                                                                                  |
| `deepsight`            | `DeepsightConfiguration` | `enabled`, `modality` (`.singleFrame`, `.singleFrameWithDepth`, or `.singleFrameWithDepthAndVideo`), and `motion`. Defaults to `.default` (`enabled: false`, `.singleFrame`, `motion: false`). |
| `imageQualitySeverity` | `ImageQualitySeverity`   | `.ultraLow` (default), `.low`, `.medium`, `.high`, or `.ultraHigh`.                                                                                                                            |
| `occlusionCheck`       | `OcclusionCheck`         | `.disabled` (default) or `.enabled(severity)` where severity is `.low` (default), `.medium`, or `.high`.                                                                                       |

The `-l` build adds a `performLocalLiveness` parameter to `addSelfieScan()`.

The older `requireDepthData` and `videoLivenessRecording` parameters are deprecated. Use `deepsight` instead. `videoLivenessRecording: true` maps to `DeepsightModality.singleFrameWithDepthAndVideo`.

For flows where captured media stays on the device, see [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/).

## Result

Selfie delivers a `SelfieScanResult` to the delegate:

```swift
func onSelfieScanCompleted(_ result: SelfieScanResult)   // final result
func onSelfieAttemptCompleted(_ result: SelfieScanResult) // per attempt
```

Key fields include:

- `spoofAttempt: Bool?`: `true` if a spoof attempt was detected, `false` if the user appears to be a real person, `nil` when it couldn't be determined because an unexpected error occurred.
- `image: UIImage?`: The captured selfie image.
- `selfieBase64: String?`: The Base64-encoded selfie image.
- `selfieEncryptedBase64: String?`: The encrypted Base64-encoded selfie image.
- `frameWithDepth: String?`: The Base64-encoded frame with depth data (Deepsight).
- `metadata: String?`: Proprietary capture metadata.
- `videoFileURL: URL?`: The local URL of the video-liveness recording.
- `presignedVideoFileURL: URL?`: The URL of the video-liveness file prepared for backend transmission.
- `deviceStats: DeviceStats?`: The device state at capture; `deviceStats.motionStatus` (`MotionStatus`) is the device-motion assessment.
- `idealCaptureEnvironmentTestResult: Int?`: The result of the ideal-capture-environment test.
- `allAttemptsExhausted: Bool`: `true` if no further capture or upload retries are available.
- `faceLoginResult: FaceLoginResult?`: Populated for face-login operations. Sub-fields: `success: Bool?`, `customerUUID: String?`, `interviewId: String?`, `interviewToken: String?`, `token: String?`, `transactionId: String?`, `hasFaceMask: Bool?`, and `hasLenses: Bool?`.
- `error: SelfieScanError?`: Set when the scan did not complete successfully.
- `videoRecordingError: SelfieScanError?`: Non-fatal error describing why Deepsight video was not recorded even though the face capture itself completed. See `SelfieScanError.insufficientStorageForVideoRecording` and `SelfieScanError.videoRecordingFailed`.

## Errors

`SelfieScanError` cases:

- `error(IncdError)`
- `permissionsDenied`
- `spoofDetected`
- `lensesDetected`
- `faceMaskDetected`
- `tooDark`
- `closedEyesDetected`
- `headCoverDetected`
- `faceNotAligned`
- `faceOccluded`
- `userCancelled`
- `userNotFound`
- `noFaceTemplateStored`
- `userBlacklisted`
- `manualFaceNotFound`
- `secondFactorAuthorizationFailed`
- `streamAudioPermissionsDenied`
- `insufficientStorageForVideoRecording`
- `videoRecordingFailed`

<br />

---

- Path: `sdk-reference/module-signature`
- URL: https://developer.incode.com/sdk-reference/module-signature/
- Markdown: https://developer.incode.com/sdk-reference/module-signature.md

# Signature

The Signature module captures a signature the user hand-draws on screen, optionally presenting documents to sign. It is typically placed at the end of a verification journey to capture explicit consent.

For an overview of this module and how it works, see [Electronic Signature](/features-and-modules/electronic-signature-module/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

## Add Signature

Add the module with `addSignature()`. You can call it with no arguments to add the module with its defaults, or [pass values](#configuration-options) to customize it.

```swift
flowConfig.addSignature()
```

### Example

The example below adds a Signature module and presents documents for the user to sign.

```swift
flowConfig.addSignature(
    descriptionMaxLines: nil,
    documents: [
        SignDocument(
            title: "Terms",
            fileURL: contractURL,
            signaturePositions: [/* SignaturePosition */]
        )
    ]
)
```

## Configuration Options

Configure the module with `addSignature()`.

| Option                | Type             | Notes                                                                                                             |
| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| `descriptionMaxLines` | `Int?`           | Sets the maximum number of lines for the description text.                                                        |
| `documents`           | `[SignDocument]` | Presents documents for signing. Each `SignDocument` has a `title`, a `fileURL`, and its `signaturePositions`.     |
| `title`               | `String?`        | **Deprecated.** Sets the title shown on the Signature screen. Provide it via `Localizable.strings` instead.       |
| `description`         | `String?`        | **Deprecated.** Sets the description shown on the Signature screen. Provide it via `Localizable.strings` instead. |

The `addSignature(title:description:descriptionMaxLines:documents:)` overload is **deprecated**: the `title` and `description` parameters should be customized via `incdOnboarding.signature.title` and `incdOnboarding.signature.description` in your `Localizable.strings` (see [Localize Display Text](/sdk-reference/ios-customization/#localize-display-text)). Use `addSignature(descriptionMaxLines:documents:)` for new integrations.

## Result

The module delivers a `SignatureFormResult` to the `onSignatureCollected(_:)` callback on your `IncdOnboardingDelegate`.

```swift
func onSignatureCollected(_ result: SignatureFormResult)
```

`SignatureFormResult` fields:

- `signature: UIImage?`: The captured signature image. On iOS, the image data is returned directly, not as a file path or URI.
- `signedDocuments: [SignDocument]?`: The documents that were signed, if any were presented.
- `error: SignatureError?`: Set when the step did not complete successfully; otherwise, `nil`.

## Errors

Failures surface through the `error` field of the result.

`SignatureError` cases:

- `error(_ error: IncdError)`: An underlying error occurred.
- `declinedToSignDocument`: The user declined to sign a presented document.
- `retryLimitReached`: The user exceeded the maximum number of allowed signing attempts.

<br />

---

- Path: `sdk-reference/module-user-consent`
- URL: https://developer.incode.com/sdk-reference/module-user-consent/
- Markdown: https://developer.incode.com/sdk-reference/module-user-consent.md

# User Consent

The User Consent module shows a custom consent agreement for the user to review and accept. Use it to capture an explicit, recorded agreement at a chosen point in the flow. The SDK records acceptance against the current onboarding session; the exact downstream behavior depends on your Incode Flow or Workflow configuration.

You add this module in code by adding it to your `IncdOnboardingFlowConfiguration` (`flowConfig`), as shown on this page. See [Integration Approaches](/sdk-reference/ios-flow-configuration/) for how to define and run the flow.

For acceptance of multiple preconfigured statements on one screen, see [Combined Consent](/sdk-reference/module-combined-consent/). For biometric or machine-learning data consent, see [Machine Learning Consent](/sdk-reference/module-machine-learning-consent/).

**Availability:** All variants.

## Add User Consent

1. Add the module with `addUserConsent(title:content:)`. Both arguments are optional.

   ```swift
   flowConfig.addUserConsent(
       title: "Terms and conditions",
       content: "I agree to the terms and conditions."
   )
   ```

2. Add any [Approval](/sdk-reference/module-approval/) or [Results](/sdk-reference/module-results/) modules after User Consent.

### Example

The example below adds a User Consent module with a title and body to the flow configuration, then handles the result on your `IncdOnboardingDelegate`.

```swift
// Add the module to the flow configuration.
flowConfig.addUserConsent(
    title: "Terms and conditions",
    content: "I agree to the terms and conditions."
)

// Handle the outcome on your IncdOnboardingDelegate.
func onUserConsentGiven(_ result: UserConsentResult) {
    if let error = result.error {
        // A failure occurred while submitting the consent.
        return
    }
    // result.success == true when the user accepted the consent.
}
```

## Configuration Options

Configure the module with `addUserConsent()`.

| Option    | Type      | Description                                                                           |
| --------- | --------- | ------------------------------------------------------------------------------------- |
| `title`   | `String?` | Sets the heading shown above the consent body text. Optional; defaults to `nil`.      |
| `content` | `String?` | Sets the consent body text the user reviews and accepts. Optional; defaults to `nil`. |

## Result

User Consent reports its outcome through the `onUserConsentGiven(_:)` callback on your `IncdOnboardingDelegate`:

```swift
func onUserConsentGiven(_ result: UserConsentResult)
```

`UserConsentResult` fields:

- `success: Bool?`: `true` when the user accepted and the consent was submitted successfully.
- `error: IncdError?`: The error that occurred, when present; otherwise, `nil`.

Any failure is surfaced through the `error` field of the same result.

<br />

---

- Path: `sdk-reference/module-video-selfie`
- URL: https://developer.incode.com/sdk-reference/module-video-selfie/
- Markdown: https://developer.incode.com/sdk-reference/module-video-selfie.md

# Video Selfie

The Video Selfie module records a short video of the user performing a guided series of actions, including capturing their ID and selfie, to confirm physical presence and run liveness and face match checks. It can also capture voice consent. It requires camera access. It requires microphone access when audio or voice consent is enabled. See [Add Required Permissions](/sdk-reference/setup-ios/#add-required-permissions).

For an overview of this module and how it works, see [Video Selfie](/features-and-modules/video-selfie/).

How you use this module depends on your integration pattern. When the app defines the steps in code, you add the module to an `IncdOnboardingFlowConfiguration` as shown below; when the flow is defined in Dashboard, you reference it and let the back end drive the steps. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

**Availability:** All variants.

Use this module when:

- You need a recorded, narrated verification session for regulatory purposes.
- You want identity capture and a liveness check combined into one guided flow.

## Add Video Selfie

1. Add a selfie step before Video Selfie: either an [ID Capture](/sdk-reference/module-id-scan/) that captures a selfie, or the [Selfie](/sdk-reference/module-selfie/) module. The face captured here is matched against that selfie, so omitting it causes the module to fail with `selfieNotMatched`.
2. Add the module with the `VideoSelfieConfiguration()` initializer. The initializer takes the four occlusion and quality checks: lenses, face mask, closed eyes, and head covering. All the optional configuration options are set afterward on the `config` object, through a mix of instance methods and properties.
   ```swift
   let config = VideoSelfieConfiguration(
       lensesCheck: true,
       faceMaskCheck: true,
       closedEyesCheck: true,
       headCoverCheck: true
   )

   config.selfieScan(enabled: true, performLivenessCheck: true, mode: .selfieMatch)
   config.idScan(enabled: true, validateId: true)
   config.voiceConsent(enabled: true, faceRecognition: true)
   config.randomQuestions(enabled: true, questionsCount: 3)
   config.handGesture(enabled: true)
   config.tutorials(enabled: true)
   config.maxVideoLength(120)
   config.videoCodecType = .hevc

   let flowConfig = IncdOnboardingFlowConfiguration()
   flowConfig.addVideoSelfie(videoSelfieConfiguration: config)
   ```

## Configuration Options

Configure the module through a `VideoSelfieConfiguration` instance (`config` in the example above).

| Option                                               | Type                                                                    | Description                                                                                                                                                                                                                 |
| ---------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `selfieScan(enabled:performLivenessCheck:mode:...)`  | `enabled: Bool`, `performLivenessCheck: Bool`, `mode: SelfieMode`       | Configures the selfie step, its liveness check, and the comparison `mode`. `SelfieMode.selfieMatch` (default) matches the new selfie against a previously captured selfie; `.faceMatch` matches it against the captured ID. |
| `idScan(enabled:validateId:...)`                     | `enabled: Bool`, `validateId: Bool?`                                    | Adds an ID capture step and controls ID validation and OCR/image comparison against the captured ID.                                                                                                                        |
| `voiceConsent(enabled:consent:faceRecognition:)`     | `enabled: Bool`, `consent: String?`, `faceRecognition: Bool`            | Records spoken voice consent, with an optional consent string for the user to read aloud. Enables face recognition.                                                                                                         |
| `randomQuestions(enabled:questionsCount:questions:)` | `enabled: Bool`, `questionsCount: Int?`, `questions: [String: String]?` | Prompts the user with liveness questions during recording.                                                                                                                                                                  |
| `handGesture(enabled:)`                              | `Bool`                                                                  | Adds a hand-gesture liveness step.                                                                                                                                                                                          |
| `tutorials(enabled:)`                                | `Bool`                                                                  | Shows or hides the tutorial screen before recording.                                                                                                                                                                        |
| `authorizationDialog(enabled:companyTitle:)`         | `enabled: Bool`, `companyTitle: String`                                 | Shows an authorization dialog with the given company title.                                                                                                                                                                 |
| `maxVideoLength(_:)`                                 | `Int`                                                                   | Sets the maximum recording length, in seconds.                                                                                                                                                                              |
| `showSelfieStepFirst(_:)`                            | `Bool`                                                                  | Presents the selfie step before the other steps.                                                                                                                                                                            |
| `setLogo(_:)`                                        | `UIImage?`                                                              | Sets a `UIImage` logo shown during recording.                                                                                                                                                                               |
| `cameraFacingConfig`                                 | `CameraFacingConfiguration`                                             | `CameraFacingConfiguration` controlling the camera facing per step (selfie, ID front/back, document, random questions, voice consent).                                                                                      |
| `videoCodecType`                                     | `VideoSelfieCodecType`                                                  | `VideoSelfieCodecType`: `.hevc` (default) or `.h264`.                                                                                                                                                                       |
| `disableAudio`                                       | `Bool`                                                                  | Records video without audio.                                                                                                                                                                                                |
| `minVideoLengthRequired`                             | `Bool`                                                                  | When `true`, enforces a minimum recording length of 31 seconds.                                                                                                                                                             |

`documentScan(enabled:)` is deprecated; use `idScan(enabled:...)` instead.

### Global Defaults

These same configuration options can be set as app-wide defaults on `IncdOnboardingManager` instead of per-instance on `VideoSelfieConfiguration`.

| `VideoSelfieConfiguration` Option   | `IncdOnboardingManager` Property | Global Default |
| ----------------------------------- | -------------------------------- | -------------- |
| Liveness check in `selfieScan(...)` | `videoSelfieLivenessCheck`       | N/A            |
| The `mode` in `selfieScan(...)`     | `videoSelfieSelfieMode`          | `.selfieMatch` |
| `randomQuestions(questionsCount:)`  | `videoSelfieQuestionsCount`      | `3`            |
| `maxVideoLength(_:)`                | `videoSelfieMaxVideoLength`      | `300`          |
| `disableAudio`                      | `videoSelfieDisableAudio`        | `false`        |
| `videoCodecType`                    | `videoSelfieCodecType`           | `.hevc`        |
| `tutorials(enabled:)`               | `showVideoSelfieTutorials`       | `true`         |

## Result

```swift
func onVideoSelfieCompleted(_ result: VideoSelfieResult)
```

`VideoSelfieResult` fields:

- `selfie: UIImage?`
- `idFront: UIImage?`
- `idBack: UIImage?`
- `passport: UIImage?`
- `document: UIImage?`
- `voiceConsentSelfie: UIImage?`
- `audioData: Data?`
- `videoData: Data?`: The screen recording delivered to your app. Relevant in [Capture-Only Mode](/sdk-reference/ios-capture-only-sdk/) too.
- `error: VideoSelfieError?`

## Errors

`VideoSelfieError` covers permission, matching, and recording failures. For example:

- `videoSelfieNotAuthorized`
- `screenRecordingPermissionsDenied`
- `recordingMicrophonePermissionsDenied`
- `voiceConsentMicrophonePermissionsDenied`
- `cameraPermissionsDenied`
- `selfieNotMatched`
- `idNotValid`
- `idTypeNotMatched`
- `idOCRNotValid`
- `idFaceNotMatched`
- `audioNotMatched`
- `videoUploadError`
- `spoofDetected`
- `maxVideoLengthReached`

<br />

---

- Path: `sdk-reference/react-native-api-reference`
- URL: https://developer.incode.com/sdk-reference/react-native-api-reference/
- Markdown: https://developer.incode.com/sdk-reference/react-native-api-reference.md

# API Reference

This is the complete reference for every public API exposed by the React Native SDK default `IncodeSdk` export from `@incode-sdks/react-native-incode-sdk`.

## initialize

Initializes the native Incode SDK. Must be called at least once per app lifecycle before any other operation.

**Signature**

```ts
IncodeSdk.initialize({
  testMode?: boolean;
  apiConfig: {
    key?: string;
    url: string;
    e2eeUrl?: string;
  };
  sdkMode?: 'standard' | 'captureOnly' | 'submitOnly';
  sslPinningConfig?: { enabled: boolean; forceSSLPinning?: boolean };
  externalAnalyticsEnabled?: boolean;
  loggingEnabled?: boolean;
  externalScreenshotsEnabled?: boolean;
  clientExperimentId?: string | null;
  sendDiagnosticsData?: boolean;
}): Promise<void>
```

**Required Parameters**

- `apiConfig.url`: API URL provided by Incode.

**Optional Parameters**

- `testMode`: Set to `true` if running on simulators/emulators, `false` when running on devices. Default is `false`.
- `apiConfig.key`: API key provided by Incode. Omit this when using a backend-created token with the Sections API.
- `apiConfig.e2eeUrl`: Custom server URL used for End-to-End Encryption (E2EE).
- `sdkMode`: Specify `standard`, `captureOnly`, or `submitOnly`. Default is `standard`. `captureOnly` works completely offline and for ID and Selfie scan only captures images without validations. `submitOnly` submits previously captured data without performing new captures.
- `sslPinningConfig.enabled`: Set to `true` to enable SSL pinning, `false` otherwise.
- `sslPinningConfig.forceSSLPinning`: Set to `true` to force SSL pinning. Default is `false` when omitted.
- `externalAnalyticsEnabled`: Set to `true` to enable external analytics. Default is `true`.
- `loggingEnabled`: Set to `true` to enable logging. Default is `true`.
- `externalScreenshotsEnabled`: Set to `true` to enable external screenshots. Default is `false`.
- `clientExperimentId`: Used to enroll the customer into specific SDK experiences. Pass `experimentV2` to activate V2 on V2-enabled environments.
- `sendDiagnosticsData`: Enables or disables sending of SDK diagnostics to Incode. **iOS only** — accepted but ignored on Android. Native default is `true` when omitted.

**Returns / Callbacks**

- Returns `Promise<void>` when initialization succeeds.
- Rejects with `IncodeSdkInitError`. Exported `code` values are:
  - `simulatorDetected`: running on a simulator without passing `testMode: true`.
  - `testModeEnabled`: `testMode: true` was passed while running on a real device (test mode is only allowed on simulators).
  - `invalidInitParams`: the native project isn't configured correctly (for example, a malformed Incode config file).
  - `configError`: `apiConfig`/`url` is missing or incomplete.
  - `unknown`: catch-all for unrecognized native errors.

**Example**

```ts
try {
  await IncodeSdk.initialize({
    testMode: false,
    apiConfig: {
      key: 'YOUR_API_KEY',
      url: 'YOUR_API_URL',
    },
  });
  console.log('Incode initialized successfully');
} catch (error) {
  const e = error as IncodeSdkInitError;
  console.error(e.code + ' - ' + e.message);
}
```

## isInitialized

Checks whether the native Incode SDK has finished initialization.

**Signature**

```ts
IncodeSdk.isInitialized(): Promise<boolean>
```

**Parameters**

- None.

**Returns / Callbacks**

- Returns `Promise<boolean>` that resolves to `true` if the native SDK is initialized, otherwise `false`.

**Example**

```ts
const ready = await IncodeSdk.isInitialized();
if (ready) {
  // Safe to start onboarding.
}
```

## setSdkMode

Changes the SDK mode after initialization.

**Signature**

```ts
IncodeSdk.setSdkMode(
  sdkMode: 'standard' | 'captureOnly' | 'submitOnly'
): Promise<void>
```

**Required Parameters**

- `sdkMode`: One of `standard`, `captureOnly`, or `submitOnly`.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects if `sdkMode` is not one of the supported values.

**Example**

```ts
await IncodeSdk.setSdkMode('captureOnly');
```

## startOnboarding

Creates a session and runs a complete, locally-defined onboarding flow end to end.

**Signature**

```ts
IncodeSdk.startOnboarding({
  sessionConfig?: OnboardingSessionConfig;
  flowConfig?: OnboardingFlowConfig;
  recordSessionConfig?: OnboardingRecordSessionConfig;
}): Promise<OnboardingResponse>
```

**Optional Parameters**

- `sessionConfig`: [Session configuration](#shared-types). Use it to pass region, queue, Dashboard configuration, backend-created `interviewId`/`token`, custom fields, validation modules, E2EE, and recording settings.
- `flowConfig`: Ordered list of modules to execute. See [Modules](/sdk-reference/react-native-modules/).
- `recordSessionConfig`: Optional [recording configuration](#shared-types) for ID and Selfie capture.

**Returns / Callbacks**

- Returns [`Promise<OnboardingResponse>`](#shared-types).
- Resolves with `{ status: 'success' }` when the flow completes.
- Rejects with `code: 'userCancelled'` when the user cancels.
- Rejects with `IncodeSdkFlowError`. Exported `code` values include `permissionsDenied`, `videoSelfieNotCompleted`, `integrityCompromised`, `faceAuthenticationFailed`, `sslPinningFailed`, `locationUnavailable`, `storageUnavailable`, `combinedConsentsNotReceived`, `userCancelled`, `interrupted`, `biometricConsentNotGiven`, `biometricConsentNotReceived`, `configError` (`startWorkflow` only) and `unknown`. See the [error enums](/sdk-reference/react-native-results/#error-enums) for the full list and platform notes.
- Rejects with `unknownModule` when a `flowConfig` entry names a module that the SDK does not recognize, and with `Incd::StartOnboardingException` for other flow configuration errors.
- If the SDK cannot add a `Phone`, `Email`, or `FullName` step from its configuration, it logs `Module <name> was not added: <reason>`, omits the step, and the flow continues.

**Example**

```ts
const result = await IncodeSdk.startOnboarding({
  sessionConfig: {
    region: 'ALL',
  },
  flowConfig: [
    { module: 'IdScan' },
    { module: 'SelfieScan' },
    { module: 'FaceMatch' },
  ],
});
```

## setupOnboardingSession

Creates or attaches to an onboarding session for section-based flows.

**Signature**

```ts
IncodeSdk.setupOnboardingSession({
  sessionConfig?: OnboardingSessionConfig;
}): Promise<OnboardingSession>
```

**Optional Parameters**

- `sessionConfig`: Session configuration. Provide `token` or `interviewId` to attach to a backend-created session.

**Returns / Callbacks**

- Returns `Promise<OnboardingSession>`.
- `interviewId`: Unique identifier of the onboarding session.
- `token`: Token created for this onboarding session.

**Example**

```ts
const session = await IncodeSdk.setupOnboardingSession({
  sessionConfig: {
    token: 'YOUR_TOKEN',
  },
});

console.log(session.interviewId, session.token);
```

## startOnboardingSection

Starts one section in a section-based flow.

**Signature**

```ts
IncodeSdk.startOnboardingSection({
  flowConfig?: OnboardingFlowConfig;
  recordSessionConfig?: OnboardingSectionRecordSessionConfig;
  sectionTag: string;
}): Promise<OnboardingSectionResponse>
```

**Required Parameters**

- `sectionTag`: Unique identifier for the section you want to start. It must be a non-blank string. If it is missing or blank, the call rejects with `configError`.

**Optional Parameters**

- `flowConfig`: Ordered list of modules for this section. `startOnboardingSection` accepts the same modules as `startOnboarding`; see [Modules](/sdk-reference/react-native-modules/).
- `recordSessionConfig`: Optional [recording configuration](#shared-types) for ID and Selfie capture, of type `OnboardingSectionRecordSessionConfig`. The key is `forcePermission` (singular). `startOnboarding` still uses `OnboardingRecordSessionConfig` with `forcePermissions`. If the value is not an object, the call rejects with `configError`.

**Returns / Callbacks**

- Returns [`Promise<OnboardingSectionResponse>`](#shared-types).
- `status`: `success`. A cancelled section rejects with `code: 'userCancelled'`.
- `sectionTag`: Value of the `sectionTag` parameter passed in config.
- Rejects with `unknownModule` when a `flowConfig` entry names a module that the SDK does not recognize, and with `configError` for other configuration errors, such as a missing or blank `sectionTag`.
- Rejects with `sectionAlreadyRunning` when you call it while another section is running. The running section is not affected.
- Rejects with `noActiveSession` when no onboarding session is set up.
- If the SDK cannot add a `Phone`, `Email`, or `FullName` step from its configuration, it logs `Module <name> was not added: <reason>`, leaves the step out, and the flow continues.
- Rejects with `activityNotPresent` when no activity (Android) or view controller (iOS) is present.

**Example**

```ts
const idSection = await IncodeSdk.startOnboardingSection({
  flowConfig: [{ module: 'IdScan' }],
  sectionTag: 'idSection',
});

if (idSection.status === 'success') {
  await IncodeSdk.startOnboardingSection({
    flowConfig: [{ module: 'SelfieScan' }],
    sectionTag: 'selfieSection',
  });
}
```

You can start multiple sections, but only one at a time. Call `finishOnboardingFlow()` after all sections complete.

## finishOnboardingFlow

Finishes the current section-based onboarding session.

**Signature**

```ts
IncodeSdk.finishOnboardingFlow(): Promise<any>
```

**Parameters**

- None.

**Returns / Callbacks**

- Returns a promise that resolves after the current section-based onboarding session is finished.

**Example**

```ts
await IncodeSdk.finishOnboardingFlow();
```

## startFlow

Starts a Dashboard-configured flow.

**Signature**

```ts
IncodeSdk.startFlow({
  sessionConfig?: OnboardingSessionConfig;
  moduleId?: string;
}): Promise<OnboardingResponse>
```

**Required Parameters**

- `sessionConfig.configurationId`: Configuration ID of a flow on the Dashboard.

**Optional Parameters**

- `sessionConfig`: Same [session configuration](#shared-types) shape used by `startOnboarding`.
- `moduleId`: Module name to start the flow from, for example `EMAIL` or `PHONE`. If omitted, the flow starts from the first module in the configuration. See [valid `moduleId` values](#valid-moduleid-values) below.

**Returns / Callbacks**

- Returns [`Promise<OnboardingResponse>`](#shared-types).
- Resolves with `{ status: 'success' }`. Rejects with `code: 'userCancelled'` when the user cancels.
- Rejects with `IncodeSdkFlowError`.

**Example**

```ts
await IncodeSdk.startFlow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
  },
  moduleId: 'EMAIL',
});
```

### Valid moduleId values

`moduleId` values correspond to the modules documented in [Modules](/sdk-reference/react-native-modules/), using the module's underlying `moduleId` string rather than its `flowConfig` `module` name:

| Module               | `moduleId`                                                                              |
| -------------------- | --------------------------------------------------------------------------------------- |
| Phone                | `PHONE`                                                                                 |
| DocumentScan         | `DOCUMENT_CAPTURE`                                                                      |
| Geolocation          | `GEOLOCATION`                                                                           |
| UserConsent          | `USER_CONSENT`                                                                          |
| CombinedConsent      | `COMBINED_CONSENT`                                                                      |
| Signature            | `SIGNATURE`                                                                             |
| VideoSelfie          | `ACCEPT_VIDEO_SELFIE`                                                                   |
| IdScan               | `ID`                                                                                    |
| IdScanFront          | `ID_CAPTURE`                                                                            |
| IdScanBack           | `BACK_ID`                                                                               |
| ProcessId            | `PROCESS_ID`                                                                            |
| Conference           | `CONFERENCE`                                                                            |
| SelfieScan           | `SELFIE`                                                                                |
| FaceMatch            | `FACE_MATCH`                                                                            |
| QrScan               | `QR_SCAN`                                                                               |
| Captcha              | `OTP`                                                                                   |
| Email                | `EMAIL`                                                                                 |
| Approve              | `USER_APPROVAL`                                                                         |
| UserScore            | `SCORE`                                                                                 |
| MLConsent            | `ML_CONSENT` (or `ML_CONSENT_US_FORMAT` / `ML_CONSENT_GDPR_FORMAT` depending on `type`) |
| GovernmentValidation | `GOVERNMENT VALIDATION`                                                                 |
| Antifraud            | `ANTIFRAUD`                                                                             |
| GlobalWatchlist      | `INCODE_WATCHLIST`                                                                      |
| CustomWatchlist      | `WATCHLIST`                                                                             |
| Aes                  | `AES`                                                                                   |
| FullName             | `NAME_CAPTURE`                                                                          |
| CurpValidation       | `CURP_VALIDATION`                                                                       |
| OCREdit              | `EDITABLE_OCR`                                                                          |
| eKYB                 | `EKYB`                                                                                  |
| eKYC                 | `EKYC`                                                                                  |
| NFCScan              | `NFC_SCAN` (or `NFC_SCAN_SYMBOL_CHECK_SCREEN` / `NFC_SCAN_VALIDATION`)                  |
| FaceAuthentication   | `AUTHENTICATION`                                                                        |

## startWorkflow

Starts a Dashboard-configured workflow.

**Signature**

```ts
IncodeSdk.startWorkflow({
  sessionConfig?: OnboardingSessionConfig;
}): Promise<OnboardingResponse>
```

**Required Parameters**

- `sessionConfig.configurationId` or `sessionConfig.token`: the configuration ID of a workflow on Dashboard, or an external session token from your backend. At least one must be a non-empty string; `interviewId` alone is not enough.

**Optional Parameters**

- `sessionConfig`: Same [session configuration](#shared-types) shape used by `startOnboarding`.

**Returns / Callbacks**

- Returns [`Promise<OnboardingResponse>`](#shared-types).
- Resolves with `{ status: 'success' }`. Rejects with `code: 'userCancelled'` when the user cancels.
- Rejects with `IncodeSdkFlowError`. Rejects with `code: 'configError'` and the message `configurationId or token is required to start a workflow` when neither is set. This happens before the flow starts, and no network request is made.

**Example**

```ts
const result = await IncodeSdk.startWorkflow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
  },
});
```

## startFlowFromDeepLink

Starts a flow from a deep link URL.

**Signature**

```ts
IncodeSdk.startFlowFromDeepLink(
  url: string,
  isShortened?: boolean
): Promise<OnboardingResponse>
```

**Required Parameters**

- `url`: Deep link URL.

**Optional Parameters**

- `isShortened`: Specify whether the URL is shortened. Defaults to `false`.

**Returns / Callbacks**

- Returns [`Promise<OnboardingResponse>`](#shared-types).
- Rejects with `IncodeSdkFlowError`.

**Example**

```ts
await IncodeSdk.startFlowFromDeepLink('YOUR_DEEP_LINK_URL', false);
```

## onSessionCreated

Subscribes to onboarding session creation events.

**Signature**

```ts
IncodeSdk.onSessionCreated(
  listener: (session: OnboardingSession) => void
): () => void
```

**Required Parameters**

- `listener`: Callback that receives [`OnboardingSession`](#shared-types).

**Returns / Callbacks**

- Returns an unsubscriber function.
- Listener receives `interviewId` and `token`.

**Example**

```ts
const unsubscribe = IncodeSdk.onSessionCreated((session) => {
  console.log('Onboarding session created, interviewId: ' + session.interviewId);
});
```

## onStepCompleted

Subscribes to step completion events for a specific module.

**Signature**

```ts
IncodeSdk.onStepCompleted({
  module: string;
  listener: (event: StepCompletedEvent) => void;
}): () => void
```

**Required Parameters**

- `module`: Module name to listen for.
- `listener`: Callback invoked when the selected module completes.

**Returns / Callbacks**

- Returns an unsubscriber function.
- Listener payloads are documented in [Results](/sdk-reference/react-native-results/).

**Example**

```ts
const unsubscribe = IncodeSdk.onStepCompleted({
  module: 'SelfieScan',
  listener: (event) => {
    console.log('SELFIE SCAN completed', event.result);
  },
});
```

## onStepUpdated

Subscribes to in-progress step update events.

**Signature**

```ts
IncodeSdk.onStepUpdated({
  module: 'Conference' | 'IdScanFront' | 'IdScanBack' | 'SelfieScan';
  listener: (event: StepUpdatedEvent) => void;
}): () => void
```

**Required Parameters**

- `module`: Supported update module: `Conference`, `IdScanFront`, `IdScanBack`, or `SelfieScan`.
- `listener`: Callback invoked when the selected module emits an update.

**Returns / Callbacks**

- Returns an unsubscriber function.
- Fires for Conference queue/wait-time changes and after every individual capture attempt for `IdScanFront`, `IdScanBack`, and `SelfieScan`.

**Example**

```ts
const unsubscribe = IncodeSdk.onStepUpdated({
  module: 'IdScanFront',
  listener: (event) => {
    console.log('ID Scan Front Attempt: ', event.result);
    console.log('allAttemptsExhausted:', event.result.allAttemptsExhausted);
  },
});
```

## onStepError

Subscribes to module error events.

**Signature**

```ts
IncodeSdk.onStepError({
  module: string;
  listener: (event: StepErrorEvent) => void;
}): () => void
```

**Required Parameters**

- `module`: Module name to listen for.
- `listener`: Callback invoked when the selected module emits an error.

**Returns / Callbacks**

- Returns an unsubscriber function.
- Error payloads are documented in [Results](/sdk-reference/react-native-results/).

**Example**

```ts
const unsubscribe = IncodeSdk.onStepError({
  module: 'FaceMatch',
  listener: (event) => {
    console.log('FaceMatch error', event);
  },
});
```

## onEvents

Subscribes to tracking events.

**Signature**

```ts
IncodeSdk.onEvents(
  listener: (events: Events) => void
): () => void
```

**Required Parameters**

- `listener`: Callback invoked with `{ events: EventDetails[] }`.

**Returns / Callbacks**

- Returns an unsubscriber function.
- Register before starting the flow.

**Example**

```ts
const unsubscribe = IncodeSdk.onEvents((eventBatch) => {
  for (const event of eventBatch.events) {
    console.log(event.event, event.data);
  }
});
```

## approve

Programmatically initiates approval of the current user.

**Signature**

```ts
IncodeSdk.approve(args?: {
  forceApproval?: boolean;
}): Promise<ApprovalResult>
```

**Optional Parameters**

- `forceApproval`: If `true`, the user will be force-approved. Defaults to `false`.

Older text may call this setting `forceApprove`; in the React Native SDK config object the current parameter is `forceApproval`.

**Returns / Callbacks**

- Returns `Promise<ApprovalResult>`.
- Result contains `success`, `uuid`, `customerToken`, and `error`.
- `success` reports whether the user was approved. A `false` value is a normal, expected outcome, not an error.
- `uuid`, `customerToken`, and `error` are `null` when the SDK has no value for them. `error` is iOS only and is always `null` on Android.
- Rejects on failure with `userCancelled`, `approvalError` (Android only), or an `IncodeSdkFlowErrorCode` value. On Android, it also rejects with `methodNotSupportedByBridge` when the installed native bridge has no handler for `approve`, and with `bridgeFailure` when the native call throws.

**Example**

```ts
IncodeSdk.approve({ forceApproval: false })
  .then(({ success, uuid, customerToken }) => {
    console.log('approve finished: ', success, uuid, customerToken);
  })
  .catch((error) => {
    console.log('approve error: ', error);
  });
```

## getUserScore

Fetches the current user score programmatically.

**Signature**

```ts
IncodeSdk.getUserScore(config?: {
  fetchMode?: 'accurate' | 'fast';
  interviewId?: string;
}): Promise<UserScoreResult>
```

**Optional Parameters**

- `fetchMode`: `accurate` or `fast`. Defaults to `accurate`. `accurate` fetches server-side results and can take longer; `fast` uses on-device processing.
- `interviewId`: the interview to score. Omit to score the current session.

**Returns / Callbacks**

* Returns `Promise<UserScoreResult>` — the full score surface. See [Results](/sdk-reference/react-native-results/#getuserscore).
* Rejects with `userScoreFailed` when the score could not be fetched.

**Example**

```ts
IncodeSdk.getUserScore({ fetchMode: 'accurate' })
  .then((score) => console.log(score))
  .catch((error) => {
    console.error('Get user score failed', error);
  });
```

## faceMatch

Programmatically initiates face match between photo from the ID and Selfie.

**Signature**

```ts
IncodeSdk.faceMatch(config?: {
  interviewId?: string;
  matchType?: 'idSelfie' | 'nfcSelfie' | 'nfc3Way';
  idCategory?: 'primary' | 'secondary';
}): Promise<FaceMatchResult>
```

**Parameters**

- `interviewId` (optional): defaults to the current session's interview.
- `matchType` (optional): one of `idSelfie`, `nfcSelfie`, `nfc3Way`. Omit for the native SDK default.
- `idCategory` (optional): `primary` or `secondary`. Defaults to `primary`.

**Returns / Callbacks**

- Returns `Promise<FaceMatchResult>`:

```ts
interface FaceMatchResult {
  confidence?: number;
  existingInterviewId?: string;
  idCategory: 'primary' | 'secondary';   // always present
  isExistingUser?: boolean;
  isFaceMatched?: boolean;
  isNameMatched?: boolean;
  nfcVsIdConfidence?: number;
  nfcVsSelfieConfidence?: number;
  secondIdConfidence?: number;
}
```

- Apart from `idCategory`, a field is present only when the native SDK produced a value — omitted, not defaulted, and without rejecting. An absent `isFaceMatched` means no comparison was possible (e.g. no ID uploaded), which is distinct from a confirmed mismatch. On Android the booleans are non-nullable natively and always present; write cross-platform code against the iOS behavior and test for presence rather than truthiness.
- There is no `status` field — derive it from `isFaceMatched`. This result is identical to what the [Flutter](/sdk-reference/flutter-results/#facematch-1) and [Cordova](/sdk-reference/cordova-results/#facematch) SDKs return for the same call. The `FaceMatch` **module** event (`FaceMatchCompleteEvent`, from `startOnboarding`/`startFlow`) is a separate path with its own shape, and does report `status`.
- Rejects with an `error.code` of:

| `code` | Meaning | Platforms |
|---|---|---|
| `faceMatchError` | Any native failure. `error.message` carries the native detail. | both |
| `userCancelled` | The user dismissed the operation. | **Android only** — iOS has no distinct cancellation signal, so a cancellation there rejects with `faceMatchError`. |
| `methodNotSupportedByBridge` | The installed native bridge has no handler for this method — the native dependency is older than the JS layer. | Android only |
| `bridgeFailure` | The native call threw before producing a result. | Android only |

  Treat `userCancelled` as an optional refinement of `faceMatchError`, not a separate branch you must guard by platform. Handling both unconditionally works everywhere — the `userCancelled` check simply never matches on iOS:

```ts
.catch((error) => {
  if (error.code === 'userCancelled') return;   // never fires on iOS
  showError(error.message);                     // covers faceMatchError
});
```

- Runs silently in the background, compared to the regular `FaceMatch` module that shows UI feedback to the user.

**Example**

```ts
IncodeSdk.faceMatch({ idCategory: 'primary' })
  .then((result) => {
    if (result.isFaceMatched === undefined) {
      console.log('No comparison was possible');
    } else {
      console.log('Matched:', result.isFaceMatched, 'confidence:', result.confidence);
    }
  })
  .catch((error) => {
    if (error.code === 'userCancelled') return;
    console.error('Face match failed', error.code, error.message);
  });
```

## startFaceLogin

Starts Face Login authentication. A prerequisite for a successful Face Login is that the user has an approved account with an enrolled face.

**Signature**

```ts
IncodeSdk.startFaceLogin({
  showTutorials: boolean;
  customerUUID?: string;
  faceMaskCheck?: boolean;
  lensesCheck?: boolean;
  brightnessThreshold?: number;
  logAuthenticationEnabled?: boolean;
  e2eeEncryptionEnabled?: boolean;
}): Promise<FaceLoginResult>
```

**Required Parameters**

- `showTutorials`: Show tutorials before Face Login.

**Optional Parameters**

- `customerUUID`: Required for 1:1 Face Login. Omit for 1:N database lookup.
- `faceMaskCheck`: Specify `true` to prevent login for users wearing a face mask.
- `lensesCheck`: Specify whether the SDK should check for lenses/glasses.
- `brightnessThreshold`: Deprecated. Adjusts minimum lighting requirements.
- `logAuthenticationEnabled`: Enable authentication logging.
- `e2eeEncryptionEnabled`: Enable E2EE for the authentication flow.

**Returns / Callbacks**

- Returns `Promise<FaceLoginResult>`.
- Response fields are documented in [Results](/sdk-reference/react-native-results/#startfacelogin).

**Example**
1:1 Face Login performs a 1:1 face comparison and returns a successful match if the two faces match. For 1:1 Face Login, you need the user's `customerUUID`. If the user was approved during onboarding on the mobile device, you should have received `customerUUID` as a result of the `Approve` step.

```ts
const result = await IncodeSdk.startFaceLogin({
  showTutorials: true,
  customerUUID: 'YOUR_CUSTOMER_UUID',
  faceMaskCheck: false,
  lensesCheck: false,
  logAuthenticationEnabled: false,
  e2eeEncryptionEnabled: false,
});
```

1:N Face Login performs a database face lookup and returns a successful match if the face is found in the database. Omit `customerUUID` for 1:N Face Login.

```ts
const result = await IncodeSdk.startFaceLogin({
  showTutorials: true,
  faceMaskCheck: false,
  lensesCheck: false,
  logAuthenticationEnabled: false,
  e2eeEncryptionEnabled: false,
});
```

To enable `faceMaskCheck` on Android, add:

```gradle
implementation 'com.incode.sdk:model-mask-detection:2.0.0'
```

## deleteLocalUserData

Deletes locally stored onboarding session data on Android devices.

**Signature**

```ts
IncodeSdk.deleteLocalUserData(): Promise<any>
```

**Parameters**

- None.

**Returns / Callbacks**

- Returns a promise that resolves after local onboarding data is deleted.
- This can remove up to 5-6 MB of data stored locally during onboarding.

Older text may refer to this method as `deleteUserLocalData`; the current React Native SDK method is `deleteLocalUserData`. The method is exposed on both platforms, but it is currently a no-op on iOS - only the Android implementation deletes data.

**Example**

```ts
await IncodeSdk.deleteLocalUserData();
```

## showCloseButton

Shows or hides the close button during SDK flows.

**Signature**

```ts
IncodeSdk.showCloseButton(
  allowUserToCancel: boolean
): Promise<void>
```

**Required Parameters**

- `allowUserToCancel`: Set to `true` to show the close button, or `false` to hide it.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if `allowUserToCancel` is missing.
- When the user presses the close button, the flow is aborted.

**Example**

```ts
IncodeSdk.showCloseButton(true);
```

## setLocalizationLanguage

Sets runtime localization language.

**Signature**

```ts
IncodeSdk.setLocalizationLanguage(
  language: string
): Promise<void>
```

**Required Parameters**

- `language`: Language used for runtime localization. Supported values are currently `en`, `es`, and `pt`.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if applying the language fails. Omitted or unsupported values fall back to `en` and do not reject.

**Example**

```ts
await IncodeSdk.setLocalizationLanguage('en');
```

Android requires:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```


## setString

Sets and updates string resources at runtime.

**Signature**

```ts
IncodeSdk.setString(
  strings: { [key: string]: string }
): Promise<void>
```

**Required Parameters**

- `strings`: Map of string keys and values.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if `strings` is missing or any value is not a string.

Some native documentation writes this as `IncodeSDK.setString`; in React Native, call `IncodeSdk.setString`.

**Example**

For iOS:

```ts
IncodeSdk.setString({
  'incdOnboarding.idChooser.idButton': 'Id',
});
```

For Android:

```ts
IncodeSdk.setString({
  onboard_sdk_btn_passport: 'Passport',
});
```

Android requires:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

For iOS, see [Localization Guide](/sdk-reference/ios-customization#localize-display-text). For Android, see [Dynamic Localization](/sdk-reference/android-customization/#dynamic-localization).

## setQuantityStrings

**Android only.** This method has no effect on iOS.

Sets Android plural strings at runtime.

**Signature**
```ts
IncodeSdk.setQuantityStrings(
  locale: string,
  quantityStrings: { [key: string]: any }
): Promise<void>
```

**Required Parameters**
- `locale`: A BCP 47 language tag such as `"en"`, `"es"`, or `"en-US"`.
- `quantityStrings`: Map of plural string keys to plural values. Shaped as `plural name → quantity keyword → value`.

**Returns / Callbacks**

- Returns a promise that resolves after plural strings are updated.

**Example**
```ts
await IncodeSdk.setQuantityStrings(
  'en',
  {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d attempt remaining",
      other: "%d attempts remaining"
    }
  }
);
```

## setTheme

Applies a JSON theme.

**Signature**

```ts
IncodeSdk.setTheme({
  theme: string;
}): Promise<void>
```

**Required Parameters**

- `theme`: JSON string containing theme configuration.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if the theme JSON is missing or invalid.

**Example**

```ts
await IncodeSdk.setTheme({
  theme: JSON.stringify({
    colors: {
      accent: '#00B2FD',
      primary: '#20263D',
    },
  }),
});
```

## setUXConfig

Applies UX configuration for V2 ID scan and Selfie experiences.

**Signature**

```ts
IncodeSdk.setUXConfig({
  jsonConfig: string;
}): Promise<void>
```

**Required Parameters**

- `jsonConfig`: JSON string containing UX configuration.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if `jsonConfig` is missing.

**Example**

```ts
await IncodeSdk.setUXConfig({
  jsonConfig: JSON.stringify({
    showFooter: true,
    closeButtonPosition: 'topLeft',
    helpButtonPosition: 'bottomRight',
    headerAlignment: 'center',
    realtimeFeedbackMessageUIFlavor: 'standard',
  }),
});
```

For the full set of UX configuration properties and their possible values, see the platform customization guides: [Android](/sdk-reference/android-customization/) and [iOS](/sdk-reference/ios-customization/).

## setFaceAuthenticationHint

Provides a face authentication hint for the `FaceAuthentication` module.

**Signature**

```ts
IncodeSdk.setFaceAuthenticationHint({
  identityId: string;
}): Promise<void>
```

**Required Parameters**

- `identityId`: Identity id used as the face authentication hint.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if `identityId` is missing.

**Example**
```ts
await IncodeSdk.setFaceAuthenticationHint({
  identityId: 'customer@example.com',
});
```

## setLogo

Sets a custom logo for the SDK screens. The logo shows on every UX V2 screen, such `FaceAuthentication`, and on the UX V1 (legacy) screens. Call it after `initialize` and before you start a flow.

A `logo` set on the `SelfieScan` [module](/sdk-reference/react-native-modules/#selfiescan) or the `VideoSelfie` [module](/sdk-reference/react-native-modules/#videoselfie) has priority in that module.

**Signature**

```ts
IncodeSdk.setLogo({
  logo: string;
}): Promise<void>
```

**Required Parameters**

- `logo`: Name of an image of your app. Use the same name on both platforms.
  - Android: A drawable resource name (`res/drawable/<name>`). On V2 screens, use a vector drawable or a raster image (PNG, JPG, or WebP). V2 screens do not support other XML drawables, such as `layer-list`, `selector`, or `shape`. On legacy screens, the logo requires the Android extensions dependency.
  - iOS: An image asset name from your asset catalog or main bundle.

**Returns / Callbacks**

- Returns `Promise<void>`.
- Rejects with `appearanceError` if `logo` is missing, or if the name does not match an image of your app. The SDK then keeps its current logo.

**Example**
```ts
await IncodeSdk.setLogo({ logo: 'my_logo' });
```

**Android: keep the drawable in release builds**

On Android, the logo is a drawable resource of your app. The SDK finds it by name at runtime, so no code refers to it. When resource shrinking is on (`shrinkResources true`), the Android shrinker removes the drawable from release builds. `setLogo` then works in debug builds but rejects with `appearanceError` in release builds. To keep the drawable, add it to `res/raw/keep.xml`:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

## onResourceDownloadProgressUpdated

Subscribes to Dynamic Delivery resource download progress.

**Signature**

```ts
IncodeSdk.onResourceDownloadProgressUpdated(
  listener: (event: { progress: Number }) => void
): () => void
```

**Required Parameters**

- `listener`: Callback invoked with download progress.

**Returns / Callbacks**

- Returns an unsubscriber function.

**Example**

```ts
const unsubscribe = IncodeSdk.onResourceDownloadProgressUpdated(({ progress }) => {
  console.log(progress);
});
```

## checkOnDemandResourcesDownloaded

Checks whether Dynamic Delivery resources are already downloaded.

**Signature**

```ts
IncodeSdk.checkOnDemandResourcesDownloaded(config?: {
  moduleName: string;
}): Promise<any>
```

**Optional Parameters**

- `moduleName`: Module name to check resources for.

**Returns / Callbacks**

- Returns a promise that resolves with `{ status: 'true' | 'false' }` indicating whether the resources are already downloaded.

**Example**

```ts
await IncodeSdk.checkOnDemandResourcesDownloaded({ moduleName: 'IdScan' });
```

## downloadOnDemandResources

Downloads Dynamic Delivery resources.

**Signature**

```ts
IncodeSdk.downloadOnDemandResources(config?: {
  moduleName: string;
}): Promise<any>
```

**Optional Parameters**

- `moduleName`: Module name to download resources for.

**Returns / Callbacks**

- Returns a promise that resolves with `{ status: 'success' }` when the native download operation completes.

**Example**

```ts
await IncodeSdk.downloadOnDemandResources({ moduleName: 'IdScan' });
```

## removeOnDemandResources

Removes Dynamic Delivery resources.

**Signature**

```ts
IncodeSdk.removeOnDemandResources(config?: {
  moduleName: string;
}): Promise<any>
```

**Optional Parameters**

- `moduleName`: Module name to remove resources for.

**Returns / Callbacks**

- Returns a promise that resolves with `{ status: 'success' }` when the native remove operation completes.

**Example**

```ts
await IncodeSdk.removeOnDemandResources({ moduleName: 'IdScan' });
```

## Shared types

Common types used by multiple API methods.

**Signature**

```ts
type OnboardingSessionConfig = {
  region?: string;
  queue?: string;
  interviewId?: string;
  token?: string;
  configurationId?: string;
  externalId?: string;
  externalCustomerId?: string;
  customFields?: { [key: string]: string };
  validationModules?: ValidationModule[];
  e2eEncryptionEnabled?: boolean;
  mergeSessionRecordings?: boolean;
  voiceConsentLanguage?: string;
};

type OnboardingRecordSessionConfig = {
  recordSession: boolean;
  forcePermissions: boolean;
};

type OnboardingSectionRecordSessionConfig = {
  recordSession?: boolean;
  forcePermission?: boolean;
};

type OnboardingResponse = {
  status: 'success';
};

type OnboardingSession = {
  interviewId: string;
  token: string;
};

type OnboardingSectionResponse = OnboardingResponse & {
  sectionTag: string;
};
```

**OnboardingSessionConfig Fields**

- `region`: Region, currently `ALL` (covers all regions), `BR` (optimized for Brazil), or `IN` (optimized for India).
- `queue`: Queue to attach this onboarding session to.
- `interviewId`: Backend-created onboarding session interview ID.
- `configurationId`: Dashboard flow configuration ID.
- `token`: Backend-created onboarding session token.
- `externalId`: ID used outside of Incode Omni.
- `externalCustomerId`: Identifier that links the onboarding session to an external prospect or customer ID.
- `validationModules`: Validation modules enabled for this session.
- `customFields`: Custom data attached to this onboarding session.
- `e2eEncryptionEnabled`: Enable E2EE.
- `mergeSessionRecordings`: Merge recordings from ID capture and Face capture into a single video.
- `voiceConsentLanguage`: Language for `VideoSelfie` voice consent. Supported values are currently `en`, `es`, `pt`, and `he`.

**OnboardingRecordSessionConfig Fields**

Used by `startOnboarding`.

- `recordSession`: Set to `true` to enable ID and Selfie capture screen recording.
- `forcePermissions`: Set to `true` to abort the session if the user denies permissions, or `false` otherwise.

**OnboardingSectionRecordSessionConfig Fields**

Used by `startOnboardingSection`. Both fields are optional and default to `false`. Omit the object to record nothing.

- `recordSession`: Set to `true` to enable ID and Selfie capture screen recording.
- `forcePermission`: Set to `true` to abort the section if the user denies permissions, or `false` otherwise.

---

- Path: `sdk-reference/react-native-common-implementation-patterns`
- URL: https://developer.incode.com/sdk-reference/react-native-common-implementation-patterns/
- Markdown: https://developer.incode.com/sdk-reference/react-native-common-implementation-patterns.md

# Common Implementation Patterns

Once the SDK is installed and initialized (see [Getting Started](/sdk-reference/react-native-getting-started/)), the next decision is how you drive the onboarding flow. The React Native SDK supports three integration patterns. They differ in two ways: where the flow is defined (in your app code versus on the Incode Dashboard) and how much control your host application keeps while the flow runs.

This page explains each pattern and when to use it. Pick the one that fits your product, then follow its dedicated page for the full walkthrough.

## Where flows are defined

The three patterns split into two configuration models:

- **Configured locally.** You build a `flowConfig` array in code, adding the modules you want and the order they run in. Patterns 2 and 3 use this model. See [Modules](/sdk-reference/react-native-modules/) for the catalog of modules you can add and their per-module configuration parameters.
- **Configured online.** The flow is defined on the Incode Dashboard as a Flow or a Workflow. Your code references it by `configurationId`, so you can change the configuration on the Dashboard without shipping a new app build. Pattern 1 uses this model.

## The three patterns

### 1. Run flows configured online (recommended)

Define the flow on the Incode Dashboard as a Flow or a Workflow, then start it with `startFlow()`, `startFlowFromDeepLink()`, or `startWorkflow()`. The SDK pulls the modules and configuration from the Dashboard, so you do not define a `flowConfig` locally.

Make sure the Flow or Workflow is active on the Dashboard before starting the session:

- **Workflows** are automatically active when you click "Save & Publish." If a Workflow is paused, click the three dot menu in the Actions column > **Activate Workflow**.
- New **Flows** are saved as inactive by default. You can either click the three dot menu in the Actions column > **Activate Flow** or open the Flow and toggle **Live Flow** to activate it.

Active Flows and Workflows can also be paused on the Dashboard, which makes them unusable until they are re-activated.

Use this when you want to change the onboarding flow from Dashboard without releasing a new app version.

Walkthrough: [Run Flows Configured Online](/sdk-reference/react-native-run-flows-configured-online/)

### 2. Configure flows locally and run end to end

Build a `flowConfig` array in code, then hand the whole flow to the SDK with a single `startOnboarding()` call. The SDK runs every module in sequence and returns control to your app when the flow finishes.

Use this when you want the simplest integration and the SDK can own the full onboarding experience from start to finish.

Walkthrough: [Configure Flows Locally and Run End to End](/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end/)

### 3. Configure flows locally and run step by step

Build the flow as one or more sections in code and run each section with `startOnboardingSection()`. Control returns to your host application between sections, so you can insert your own screens or run business logic before starting the next section. The design also allows branching based on intermediate results, though this is not called out as an officially recommended pattern.

Use this when you need to interleave your own UI or logic with the SDK modules, or split a long flow into discrete steps.

Walkthrough: [Configure Flows Locally and Run Step by Step](/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step/)

## Choosing a pattern

| If you want to...                                         | Use                                 | Entry point                                                    |
| --------------------------------------------------------- | ----------------------------------- | -------------------------------------------------------------- |
| Change the flow from the Dashboard without an app release | Run flows configured online         | `startFlow()`, `startFlowFromDeepLink()`, or `startWorkflow()` |
| Run a full flow with the least code                       | Configure locally, run end to end   | `startOnboarding()`                                            |
| Insert your own screens or logic between SDK steps        | Configure locally, run step by step | `startOnboardingSection()`                                     |

## Related pages

- [Modules](/sdk-reference/react-native-modules/): the module catalog for building a `flowConfig`.
- [Results](/sdk-reference/react-native-results/): the result and error objects returned when a flow finishes.
- [API Reference](/sdk-reference/react-native-api-reference/): the full specification of `startOnboarding()`, `startOnboardingSection()`, `startFlow()`, `startWorkflow()`, and their configuration objects.
- [Face Login](/sdk-reference/react-native-face-login/): authenticate a returning user after onboarding, separate from these onboarding-flow patterns.

---

- Path: `sdk-reference/react-native-configure-flows-locally-and-run-end-to-end`
- URL: https://developer.incode.com/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end/
- Markdown: https://developer.incode.com/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end.md

# Configure Flows Locally and Run End to End

Use this path when the React Native app owns the module order. You define the onboarding flow locally in code with a `flowConfig` array, optionally register listeners to receive per-step results, and run the whole session in one call to `startOnboarding()`. The SDK presents the Incode UI for each module in turn.

Use this pattern when you want full control over the flow in client code. If you prefer to define the flow on the Incode Dashboard instead, see [Run Flows Configured Online](/sdk-reference/react-native-run-flows-configured-online/). For other patterns, start from [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/).

> **Before you start**
>
> Make sure the SDK is installed and initialized. See [Getting Started](/sdk-reference/react-native-getting-started/) for setup and initialization. Your API URL and API key are provided to you by Incode.

The common path is three objects and one call: build a `sessionConfig`, build a `flowConfig`, and call `startOnboarding()`. Optionally, register step listeners before the call to receive per-module results as they complete.

### Configure Onboarding session

`sessionConfig` is optional for `startOnboarding()`. If you don't need to bind a Dashboard flow, resume a session, or set custom fields, you can omit it.

```ts
const sessionConfig = {
  region: 'ALL',
  externalId: 'external-id',
  validationModules: ['id', 'liveness', 'faceRecognition'],
};

```

Useful `sessionConfig` fields include:

| Field                               | Use                                                                                                                                |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `region` | `ALL`, `BR`, or `IN`. |
| `queue`                             | Assign the session to a queue.                                                                                                     |
| `interviewId` / `token`             | Start from a backend-created session.                                                                                              |
| `configurationId`                   | Apply a dashboard flow configuration.                                                                                              |
| `externalId` / `externalCustomerId` | Link the Incode session to your own user/customer ID.                                                                              |
| `validationModules`                 | Select server-side validation modules.                                                                                             |
| `customFields`                      | Attach custom string data.                                                                                                         |
| `e2eEncryptionEnabled`              | Enable E2EE for the session. See [End-to-End Encryption](../react-native-getting-started/react-native-e2ee/) for the full setup. |
| `mergeSessionRecordings`            | Merge ID and Face recordings.                                                                                                      |
| `voiceConsentLanguage`              | Set `VideoSelfie` voice consent language: `en`, `es`, `pt`, or `he`.                                                               |

Available validation modules:

- `id`
- `liveness`
- `faceRecognition`
- `governmentValidation`
- `governmentFaceValidation`
- `governmentOcrValidation`
- `videoSelfie`

Default validation modules are `id`, `liveness`, and `faceRecognition`.

### Configure Onboarding Flow

```ts
const flowConfig = [
  { module: 'IdScan' },
  { module: 'SelfieScan' },
  { module: 'FaceMatch' },
];
```

Each module is an object with a `module` field and any module-specific configuration as sibling fields:

```ts
const flowConfig = [
  { module: 'IdScan', showTutorial: true, idType: 'id' },
  { module: 'SelfieScan', lensesCheck: false },
  { module: 'FaceMatch', matchType: 'idSelfie' },
];
```

If a module is omitted from the array, it is not shown in the flow. Modules run in the order they appear in the array.

Place dependent modules after the modules they need:

- `FaceMatch` should follow `IdScan` and `SelfieScan`.
- `ProcessId` should follow `IdScanFront` and `IdScanBack`.
- `VideoSelfie` should follow `IdScan` (in `faceMatch` mode) or `SelfieScan` (in `selfieMatch` mode).
- `Aes` should follow `Phone`, `IdScan`, and `SelfieScan`.
- `UserScore` and `Approve` should be at the end.

A few cross-cutting notes:

- Several modules show tutorials by default. Disable them per module by passing `showTutorial: false` (or the module-specific equivalent).
- To display results to the user at the end of the flow, include `{ module: 'UserScore' }`. Use `{ module: 'UserScore', mode: 'fast' }` to use on-device results instead of server-side results.
- To approve the user directly from the client at the end of the flow, include `{ module: 'Approve' }`. Use `{ module: 'Approve', forceApproval: true }` to force approval.

> For the full list of modules you can add and their configuration parameters, see [Modules](/sdk-reference/react-native-modules/).

### Start the onboarding

Call `startOnboarding()` with the `sessionConfig` and `flowConfig`. The call resolves with a result object when the flow finishes. The result only indicates the flow's final outcome (success or user cancellation). It does not contain per-module data. To receive per-module results, register listeners (see below).

```ts
const result = await IncodeSdk.startOnboarding({
  sessionConfig,
  flowConfig,
});

if (result.status === 'userCancelled') {
  console.log('User cancelled onboarding');
}
```

Errors are thrown rather than returned. Wrap the call in a try/catch to handle failures. `startOnboarding()` can throw the following error codes:

- `permissionsDenied`: the user denied a required permission.
- `faceAuthenticationFailed`: a face authentication step failed.
- `sslPinningFailed`: SSL pinning validation failed.
- `locationUnavailable`: required location data could not be obtained.
- `unknown`: an unrecognized native error occurred.

```ts
try {
  await IncodeSdk.startOnboarding({ sessionConfig, flowConfig });
} catch (error) {
  if (error.code === 'permissionsDenied') {
    console.log('User denied some mandatory permission during the flow');
  }
}
```

To listen for the results of the steps in the flow as soon as they're completed, register optional listeners before starting the flow. Each listener returns an unsubscribe function:

```ts
const unsubscribers = [
  IncodeSdk.onSessionCreated((session) => {
    console.log(session.interviewId);
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanFront',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanBack',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'ProcessId',
    listener: (event) => console.log(event.result.extendedOcrData),
  }),
  IncodeSdk.onStepCompleted({
    module: 'SelfieScan',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'FaceMatch',
    listener: (event) => console.log(event.result),
  }),
];
```

Listeners are optional: if you only need the final outcome of the flow, you can rely on the value returned by `startOnboarding()` and skip listener registration. For the shape and fields of each result object passed to listeners, see [Results](../react-native-results/).

Call each unsubscriber when the screen unmounts.

```ts
React.useEffect(() => {
  const unsubscribers = setupListeners();

  return () => {
    unsubscribers.forEach((unsubscriber) => unsubscriber());
  };
}, []);
```

### Enable session recording

To record ID and Selfie captures, add `recordSessionConfig` to the `startOnboarding()` call:

```ts
await IncodeSdk.startOnboarding({
  sessionConfig,
  flowConfig,
  recordSessionConfig: {
    recordSession: true,
    forcePermissions: false,
  },
});
```

On Android, session recording requires the `-vc` SDK package variant and the video-streaming dependency:

```gradle
implementation 'com.incode.sdk:video-streaming:1.5.5'
```

On iOS, no additional variant or dependency is required. Session recording is included in the main iOS SDK.

## Related pages

- [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/): overview of all integration patterns.
- [Configure Flows Locally and Run Step by Step](react-native-configure-flows-locally-and-run-step-by-step/): split the same locally configured flow into sections.
- [Run Flows Configured Online](react-native-run-flows-configured-online/): define the flow on the Dashboard instead of in code.
- [Modules](../react-native-modules/): the module catalog and per-module configuration parameters.
- [Results](../react-native-results/): result and error object reference.
- [API Reference](../react-native-api-reference/): full API specification.

---

- Path: `sdk-reference/react-native-configure-flows-locally-and-run-step-by-step`
- URL: https://developer.incode.com/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step/
- Markdown: https://developer.incode.com/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step.md

# Configure Flows Locally and Run Step by Step

Use the Sections API when your app needs custom screens or business logic between SDK modules. You create an onboarding session, split the flow into sections, and run each section with `startOnboardingSection()`. Control returns to your host application between sections, so you can show your own screens, make decisions, or call your backend before continuing.

Use this pattern when the default flow approach does not give you enough control - for example, when you need to interleave your own UI between capture steps, or group modules into logical sections.

> **Before you start**
>
> Make sure the SDK is installed and initialized. See [Getting Started](/sdk-reference/react-native-getting-started/) for setup and initialization.

The common path is four steps: set up the onboarding session, register step listeners if you want per-step results, configure and start each section, and finish the session when all sections are complete.

### Set up an onboarding session

`sessionConfig` is optional for `setupOnboardingSession()`. If you don't need to customize the session, you can omit it.

```ts
const session = await IncodeSdk.setupOnboardingSession({
  sessionConfig: {
    region: 'ALL',
  },
});

console.log(session.interviewId, session.token);

```

Useful `sessionConfig` fields include:

| Field                               | Use                                                                                                                                |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `region` | `ALL`, `BR`, or `IN`. |
| `queue`                             | Assign the session to a queue.                                                                                                     |
| `interviewId` / `token`             | Start from a backend-created session, or resume an existing session (see below).                                                   |
| `configurationId`                   | Apply a Dashboard flow configuration.                                                                                              |
| `externalId` / `externalCustomerId` | Link the Incode session to your own user/customer ID.                                                                              |
| `validationModules`                 | Select server-side validation modules.                                                                                             |
| `customFields`                      | Attach custom string data.                                                                                                         |
| `e2eEncryptionEnabled`              | Enable E2EE for the session. See [End-to-End Encryption](../react-native-getting-started/react-native-e2ee/) for the full setup. |
| `mergeSessionRecordings`            | Merge ID and Face recordings.                                                                                                      |
| `voiceConsentLanguage`              | Set `VideoSelfie` voice consent language: `en`, `es`, `pt`, or `he`.                                                               |

Available validation modules:

- `id`
- `liveness`
- `faceRecognition`
- `governmentValidation`
- `governmentFaceValidation`
- `governmentOcrValidation`
- `videoSelfie`

Default validation modules are `id`, `liveness`, and `faceRecognition`.

#### Resume an existing onboarding session

To continue an existing onboarding session (for example, one created by your backend), pass the existing `token` or `interviewId` to `setupOnboardingSession()`:

```ts
const session = await IncodeSdk.setupOnboardingSession({
  sessionConfig: {
    token: 'YOUR_TOKEN',
  },
});
```

### Register step listeners

If you want to react to individual modules as they complete, register listeners before starting any sections. If you only need section-level outcomes, you can rely on the value returned by `startOnboardingSection()` and skip this step.

```ts
const unsubscribers = [
  IncodeSdk.onSessionCreated((session) => {
    console.log(session.interviewId);
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanFront',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanBack',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'ProcessId',
    listener: (event) => console.log(event.result.extendedOcrData),
  }),
  IncodeSdk.onStepCompleted({
    module: 'SelfieScan',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'FaceMatch',
    listener: (event) => console.log(event.result),
  }),
];
```

Call each unsubscriber when the screen unmounts:

```ts
React.useEffect(() => {
  const unsubscribers = setupListeners();

  return () => {
    unsubscribers.forEach((unsubscriber) => unsubscriber());
  };
}, []);
```

For the shape and fields of each result object passed to these listeners, see [Results](../react-native-results/).

### Configure section flow

```ts
const idSectionConfig = {
  sectionTag: 'idSection',
  flowConfig: [{ module: 'IdScan' }],
};
```

`startOnboardingSection` accepts the same `flowConfig` shape and modules as `startOnboarding`. See [Modules](../react-native-modules/) for the catalog and per-module configuration parameters.

Some modules depend on the output of other modules and must appear after them in the `flowConfig` array:

- `FaceMatch` should follow `IdScan` and `SelfieScan`.
- `ProcessId` should follow `IdScanFront` and `IdScanBack`.
- `VideoSelfie` should follow `IdScan` (in `faceMatch` mode) or `SelfieScan` (in `selfieMatch` mode).
- `Aes` should follow `Phone`, `IdScan`, and `SelfieScan`.
- `UserScore` and `Approve` should be at the end.

### Start onboarding section

`startOnboardingSection()` resolves with a result indicating whether the section succeeded (`status` is `success` or `userCancelled`). Use the result to decide what to do next, including running your own logic before starting the next section.

```ts
const idSection = await IncodeSdk.startOnboardingSection(idSectionConfig);

if (idSection.status === 'success') {
  await IncodeSdk.startOnboardingSection({
    sectionTag: 'selfieSection',
    flowConfig: [{ module: 'SelfieScan' }],
  });
}
```

You can start multiple sections, but only one at a time. Wait for each `startOnboardingSection()` call to resolve before starting the next. Running a second call while another section runs rejects with `sectionAlreadyRunning`.

Each section needs a `sectionTag`, a non-blank string that identifies the section. Use it to distinguish sections in listener events or logs. If `sectionTag` is missing or blank, the call rejects with `configError`.

### Finish onboarding session

```ts
await IncodeSdk.finishOnboardingFlow();
```


To clean up local user data generated during the session, call `deleteLocalUserData()`. See [Delete Local Session Data](../react-native-getting-started/react-native-delete-local-session-data/) for details.

## Related pages

- [Configure Flows Locally and Run End to End](react-native-configure-flows-locally-and-run-end-to-end/): configure a single full flow locally and run it in one call.
- [Run Flows Configured Online](react-native-run-flows-configured-online/): define the flow on the Dashboard instead of in code.
- [Modules](../react-native-modules/): the module catalog and per-module configuration parameters.
- [Results](../react-native-results/): result and error objects returned by listeners and section calls.
- [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/): choose the integration pattern that fits your app.
- [API Reference](../react-native-api-reference/): full API specification.

---

- Path: `sdk-reference/react-native-customization`
- URL: https://developer.incode.com/sdk-reference/react-native-customization/
- Markdown: https://developer.incode.com/sdk-reference/react-native-customization.md

# Customization

The React Native SDK supports customization of text, localization, icons, videos, and visual themes. The available options and the methods used to apply them differ between Android and iOS for legacy (v1) screens - see the platform-specific sections below. 

## Android

The following covers v1 customization options for legacy screens. For v2 customization, see the intro above.

### Customization options

- **Text and localization**: Override SDK strings and add languages.
- **Icons and videos**: Replace SDK assets with your own.
- **Theme (ID Scan V2 only)**: `setTheme()` on Android currently supports customization exclusively for the ID Scan V2 feature.


For configuration details, see the full [Android customization guide](/sdk-reference/android-customization/).

### Method examples

To set the runtime localization language, call `setLocalizationLanguage()`. Supported values are currently `en`, `es`, and `pt`:

```ts
await IncodeSdk.setLocalizationLanguage('en');
```

To override an individual string, call `setString()`:

```ts
IncodeSdk.setString({
  onboard_sdk_btn_passport: 'Passport',
});
```

To localize plural strings, call `setQuantityStrings()`:

```ts
await IncodeSdk.setQuantityStrings(
  'en',
  {
    onboard_sdk_validation_attempts_remaining: {
      one: "%d attempt remaining",
      other: "%d attempts remaining"
    }
  }
);
```

### Dependency requirements

The `setLocalizationLanguage`, `setString`, and `setQuantityStrings` methods require the Android extensions dependency:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```

## iOS

The following covers v1 customization options for legacy screens. For v2 customization, see the intro above.

### Customization options

- **Icons and videos**: Replace SDK assets with your own.
- **Text and localization**: Override SDK strings and add languages.
- **Theme**: Customize colors, fonts, buttons, and other components.

For configuration details, see the full [iOS customization guide](/sdk-reference/ios-customization/).

### Method examples

`setLocalizationLanguage()` and `setString()` are also available on iOS, with the same behavior as Android.

`setQuantityStrings()` applies plural string overrides on Android only. The method exists on iOS for API compatibility but is currently a no-op—it resolves successfully without applying anything.

To change the theme, call `setTheme` with a stringified theme JSON:


```ts
const jsonTheme = JSON.stringify({
  colors: {
    accent: '#00B2FD',
    primary: '#20263D',
    background: '#FFFFFF',
  },
  // See the iOS customization guide for the full theme schema.
});

IncodeSdk.setTheme({ theme: jsonTheme })
```

### Dependency requirements

Unlike on Android, no additional native dependency is required for `setLocalizationLanguage`, `setString`, or `setQuantityStrings` on iOS.

## ID v2 Customization

Both platforms support the customization of ID v2 experience via `IncodeSdk.setTheme({ theme })`.



## Logo

To show your logo on the SDK screens, call `setLogo` with the name of an image of your app:

```ts
await IncodeSdk.setLogo({ logo: 'my_logo' });
```

The logo shows on every UX V2 screen, such as `FaceAuthentication`, and on the legacy screens.



On Android, the name is a drawable resource name. On iOS, it is an image asset name. A `logo` set on the `SelfieScan` or `VideoSelfie` module has priority in that module. For the details, see `setLogo` in the [API Reference](/sdk-reference/react-native-api-reference/#setlogo).

On Android, the logo is a resource image. Add it to `res/raw/keep.xml`, or the Android shrinker removes it from release builds:

```xml
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/my_logo" />
```

---

- Path: `sdk-reference/react-native-delete-local-session-data`
- URL: https://developer.incode.com/sdk-reference/react-native-delete-local-session-data/
- Markdown: https://developer.incode.com/sdk-reference/react-native-delete-local-session-data.md

# Delete Local Session Data

The Android SDK stores onboarding session data locally during a flow. When you are done with a session, call `deleteLocalUserData()` to remove this data. Each session can leave 5-6 MB of local data on the device.

```ts
await IncodeSdk.deleteLocalUserData();
```

Call this after a session completes, fails, or is cancelled by the user.

> `deleteLocalUserData()` is exposed on both platforms through the shared `IncodeSdk` API, but it is currently a no-op on iOS - only the Android implementation deletes data.

---

- Path: `sdk-reference/react-native-dynamic-delivery-usage-guide`
- URL: https://developer.incode.com/sdk-reference/react-native-dynamic-delivery-usage-guide/
- Markdown: https://developer.incode.com/sdk-reference/react-native-dynamic-delivery-usage-guide.md

# Dynamic Delivery Usage Guide

To optimize your app's download size and reduce the SDK's size impact, you can download additional SDK resources during your app's execution. Using APIs available in the React Native SDK, you can:

- Check if the resources are already downloaded. 
- Download the resources you need.
- Remove resources when you no longer need them.

## Check if the resources are downloaded

```js
IncodeSdk.checkOnDemandResourcesDownloaded()
        .then((result) => {
            console.log('resourcesAvailable: ', result.status);
            // if status is 'true' resources are avaiable, otherwise 'false' and they need to be downloaded
        })
        .catch((e) => {
            //
        });
```

## Download resources

Download resources using the following method:

```js
IncodeSdk.downloadOnDemandResources()
        .then((result) => {
            console.log('downloadCompleted, status: ', result.status);
            // if status is 'success' resources are downloaded, otherwise download has to be retried
        })
        .catch((e) => {
            // Check for specific error values and try retrying the download
        });
```

This method downloads the resources silently in the background. To be notified about the download progress, register this progress listener:

```js
IncodeSdk.onResourceDownloadProgressUpdated(({ progress }) => {
          console.log('download progress updated: ', progress); // progress value ranges from 0 - 1.
    });
```

`downloadOnDemandResources` can fail with the following error codes:

- `INTERNAL_ERROR`: An unknown error occurred. Contact your Incode representative with the error code to resolve the issue.
- `NETWORK_ERROR`: The download request failed because of a network error. Retry later.
- `ACCESS_DENIED`: The app could not register the request because of insufficient permissions. Retry after user accepts the permissions.

## Remove resources

When you no longer need the Incode SDK, you can notify the system that the download resources are no longer needed. They will be removed as soon as possible.

```js
IncodeSdk.removeOnDemandResources()
        .then((result) => {
          console.log("removeOnDemandResources result: ", result.status);
          //if status is 'success' system is notified that resources are no longer needed and will remove them as soon as possible
        })
        .catch( (e) => {
          //
        });
```

## Additional iOS setup

To use Dynamic Delivery inside your iOS app, add this line to the top of the Podfile for your target:

```
pod 'react-native-incode-sdk/ODR', :path => '../node_modules/react-native-incode-sdk/ios'
```

After you run `pod install`, the SDK uses the Dynamic Delivery version and the resources are no longer embedded in the app. You will need to download them using the method described in [Download resources](#download-resources).

## Additional Android setup

You must publish your app using the Android App Bundle format. Dynamic Feature Modules are supported on devices running Android 5.0 (API level 21) or higher. On older devices, dynamic modules are installed together with the app.

### Step 1: Set Java compatibility

In your module-level `app/build.gradle`, add the following code to `android{}` closure:

```gradle
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
```

### Step 2: Extend SplitCompatApplication

Make your `Application` class extend `SplitCompatApplication`:

```java
import com.google.android.play.core.splitcompat.SplitCompatApplication;

public class BaseApplication extends SplitCompatApplication {
    ...
}
```

`SplitCompatApplication` overrides `ContextWrapper.attachBaseContext()` to include `SplitCompat.install(Context applicationContext)`. If you don’t want your `Application` class to extend `SplitCompatApplication`, you can override the `attachBaseContext()` method manually:

```java
@Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    // Emulates installation of future on demand modules using SplitCompat.
    SplitCompat.install(this);
}
```

### Step 3: Enable MultiDex

If your `minSdkVersion` is 21 or higher, MultiDex is enabled by default; you can skip this step.

If your `minSdkVersion` is lower than 21, follow Google's guide to
[enable MultiDex](https://developer.android.com/studio/build/multidex#mdex-gradle).

### Step 4: Create a dynamic feature module

Create new Dynamic Module in Android Studio:

1. Go to **File** > **New** > **New Module**.
2. Select **Dynamic Feature Module**, then click **Next**.
3. Enter a _**Module Name**_, such as `incode_core`, then click **Next**.
4. Enter your desired _**Module Title**_, such as `Incode Core`. Set _**Install-time inclusion**_ to _Do not include module at install-time (on-demand only)_, and enable **Fusing**. 
5. Click **Finish** to create the module.

:::Info
The Incode SDK uses `incode_core` as the default name of the on-demand module. If you you use a different module name in this step, override the default `moduleName` parameter with the same value when you call `downloadOnDemandResources`.
:::

```js
IncodeSdk.downloadOnDemandResources({moduleName: 'MyCustomModuleName'})
        .then((result) => {
            console.log('downloadCompleted, status: ', result.status);
            // if status is 'success' resources are downloaded, otherwise download has to be retried
        })
        .catch((e) => {
            // Check for specific error values and try retrying the download
        });
```

### Step 5: Review the generated changes

Wait for Android Studio to finish syncing. When it completes, review the changes Android Studio made to the project:

- A new module has been created with the name you chose in Step 4 (for example, `incode_core`).
- In your module-level `app/build.gradle`, the following line has been added to `android{}` closure (using your module name):
  ```
  dynamicFeatures = [':incode_core']
  ```
- In your `app/res/values/strings.xml` file, a string has been added:
  ```xml
  <string name="title_incode_core">Incode Core</string>
  ```

### Step 6: Configure the module's build.gradle

Open the `build.gradle` for your module: for example, `incode_core/build.gradle`.

Add the following code to `android{}` closure:

```gradle
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
```

Add the required core dependency:

```gradle
implementation 'com.incode.sdk:core-light:2.0.0' // Required core dependency
```

The module does not need to contain any other code. The `core-light` dependency contains the image processing libraries used by the native Android Welcome SDK.

### Step 7: Enable APK splits

Enable splits to generate optimized APKs for each user's device configuration. If your app uses App Signing by Google Play, you can skip this step, since splits are enabled by default.

In your module-level `app/build.gradle`, add the following code to the `android{}` closure:

```gradle
splits {
    abi {
        reset()
        enable true
        universalApk false  // If true, also generate a universal APK
        include "armeabi-v7a", "x86", "arm64-v8a", "x86_64"
    }
}
```

For more information, see [App Signing by Google Play](https://reactnative.dev/docs/signed-apk-android#migrating-old-android-react-native-apps-to-use-app-signing-by-google-play) in React Native's developer documentation and [Configure APK Splits](https://developer.android.com/studio/build/configure-apk-splits) in Android's developer documentation.

### Step 8: Test your implementation

If you run your app from Android Studio, the dynamic module is installed together with the app, and the code for downloading and installing the module never executes. To test the download and install flow, you must locally simulate or use Google Play.

#### Local Testing

To locally simulate requesting, downloading, and installing modules from the Play Store, use bundletool. Download and install it from the [bundletool releases](https://github.com/google/bundletool/releases) page.

Use the following commands to build and install an APK for local testing:

```
./gradlew bundle
bundletool build-apks --local-testing
  --bundle app/build/outputs/bundle/release/app-release.aab
  --output my_app.apks
bundletool install-apks --apks my_app.apks
```

#### Testing Through Google Play

To fully test your implementation (downloading and installing the dynamic module), upload your App Bundle to Google Play. Google Play requires the Android App Bundle format so it can handle on-demand requests from the server side.

Publishing the project on the Play Console requires some graphic assets. For testing purposes, you can use the [sample assets from the Google codelab](https://github.com/googlecodelabs/android-dynamic-features/tree/master/graphic_assets).

To test quickly without waiting for approval, publish your application to the Internal Testing track. For a step-by-step guide, see [how to upload an app](https://support.google.com/googleplay/android-developer/answer/9859152) in the Play Console documentation.

---

- Path: `sdk-reference/react-native-e2ee`
- URL: https://developer.incode.com/sdk-reference/react-native-e2ee/
- Markdown: https://developer.incode.com/sdk-reference/react-native-e2ee.md

# End-to-End Encryption (E2EE)

End-to-End Encryption (E2EE) adds an extra layer of security by encrypting data transmitted between the client and the Incode server. The process begins with a key exchange where the client and server share keys for encrypting and decrypting messages.

E2EE is configured in two places:
- SDK initialization, to point the SDK at the E2EE server.
- The session, to enable encryption for a specific onboarding session.

## Configure the E2EE URL at initialization

Pass `e2eeUrl` in `apiConfig` when calling `initialize`:

```ts
await IncodeSdk.initialize({
  apiConfig: {
    key: 'YOUR_API_KEY',
    url: 'YOUR_API_URL',
    e2eeUrl: 'YOUR_E2EE_URL',
  },
});
```

## Enable E2EE on a session

Set `e2eEncryptionEnabled: true` on the `sessionConfig` for any session that should use end-to-end encryption:

```ts
const sessionConfig = {
  e2eEncryptionEnabled: true,
};
```

`sessionConfig` has the same shape across `startOnboarding()`, `startOnboardingSection()`, `startFlow()`, `startWorkflow()`, and `setupOnboardingSession()`, so this flag applies the same way to all of them. Pass it when setting up an onboarding session or when starting a flow:

```ts
await IncodeSdk.setupOnboardingSession({ sessionConfig });

await IncodeSdk.startOnboarding({
  sessionConfig,
  flowConfig,
});
```

## Enable E2EE for Face Login

`startFaceLogin()` is not part of the onboarding `sessionConfig` and takes its own `e2eeEncryptionEnabled` parameter directly in its config object (note the double "e" - this is a separate flag from the onboarding session's `e2eEncryptionEnabled`):

```ts
await IncodeSdk.startFaceLogin({
  showTutorials: true,
  e2eeEncryptionEnabled: true,
});
```

See [Face Login](/sdk-reference/react-native-face-login/) for the full API.

---

- Path: `sdk-reference/react-native-face-login`
- URL: https://developer.incode.com/sdk-reference/react-native-face-login/
- Markdown: https://developer.incode.com/sdk-reference/react-native-face-login.md

# Face Login

Face Login authenticates an existing user by capturing their face and matching it against an enrolled identity. Use it to grant access to your app, authorize high-value operations, or re-verify a returning user with low friction.

Face Login requires an approved customer with an enrolled face. There are two modes:

- **1:1 Face Login** compares the captured face against a specific user's enrolled face. Use this when you already know which user is logging in.
- **1:N Face Login** searches the captured face against all enrolled users in the database. Use this when you want to identify the user from their face alone.

For the full set of `startFaceLogin` parameters and the response shape, see [API Reference](/sdk-reference/react-native-api-reference/).

## Face Login 1:1

Use 1:1 Face Login when you already have the user's `customerUUID`.
If the user was approved during onboarding on the mobile device, you should have received `customerUUID` from the `Approve` step.

```ts
const result = await IncodeSdk.startFaceLogin({
  showTutorials: true,
  customerUUID: 'CUSTOMER_UUID',
  faceMaskCheck: false,
  lensesCheck: false,
  logAuthenticationEnabled: false,
  e2eeEncryptionEnabled: false,
});
```

## Face Login 1:N

Use 1:N Face Login when you want the SDK to search for the captured face in the enrolled database. Omit `customerUUID`.

```ts
const result = await IncodeSdk.startFaceLogin({
  showTutorials: true,
  faceMaskCheck: false,
  lensesCheck: false,
  logAuthenticationEnabled: false,
  e2eeEncryptionEnabled: false,
});
```

## Android dependency for face mask check

To use `faceMaskCheck` on Android, add the mask detection model dependency:

```gradle
implementation 'com.incode.sdk:model-mask-detection:2.0.0'
```

---

- Path: `sdk-reference/react-native-getting-started`
- URL: https://developer.incode.com/sdk-reference/react-native-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/react-native-getting-started.md

# Getting Started

The Incode React Native SDK adds identity verification, onboarding, and authentication flows to your React Native app. This section walks you through installing the SDK, initializing it, and configuring it for your use case.

## Start here

If you're new to the SDK, follow these steps in order:

1. **[Install the SDK](/sdk-reference/react-native-installation/)**, including platform-specific setup for iOS and Android, and Expo setup if applicable.
2. **[Choose an SDK mode](/sdk-reference/react-native-sdk-modes/)** based on whether your app captures and validates online, captures only, or submits previously captured data.
3. **[Choose an implementation pattern](/sdk-reference/react-native-common-implementation-patterns/)** based on where your onboarding flow is configured and how much control your app needs.

The remaining pages in this section cover specific setup options, advanced configurations, and maintenance tasks that you may or may not need depending on your integration.

## Initialize the SDK

Initialize once before launching any flow.

```ts
import IncodeSdk, { IncodeSdkInitError } from '@incode-sdks/react-native-incode-sdk';

try {
  await IncodeSdk.initialize({
    testMode: false,
    apiConfig: {
      key: 'YOUR_API_KEY',
      url: 'YOUR_API_URL',
    },
  });
} catch (error) {
  const e = error as IncodeSdkInitError;
  console.error(`Incode SDK initialize failed: ${e.code} - ${e.message}`);
}
```

Check initialization when app screens can be re-entered:

```ts
const initialized = await IncodeSdk.isInitialized();
```

## Your first flow

Once the SDK is initialized, a minimal onboarding flow looks like this:

```ts
import IncodeSdk from '@incode-sdks/react-native-incode-sdk';

await IncodeSdk.initialize({
  testMode: false,
  apiConfig: {
    key: 'YOUR_API_KEY',
    url: 'YOUR_API_URL',
  },
});

const result = await IncodeSdk.startOnboarding({
  flowConfig: [
    { module: 'IdScan' },
    { module: 'SelfieScan' },
    { module: 'FaceMatch' },
  ],
});

console.log(result.status);
```

Register listeners before starting the flow to react to individual modules as they complete:

```ts
const unsubscribe = IncodeSdk.onStepCompleted({
  module: 'SelfieScan',
  listener: (event) => {
    console.log(event.result);
  },
});
```

Return the unsubscriber from your component cleanup.

For the full integration walkthrough including session configuration, error handling, and the available listener callbacks, see [Configure Flows Locally and Run End to End](/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end/).

## Optional and advanced setup

These pages cover specific scenarios you may or may not require:

- [End-to-End Encryption (E2EE)](/sdk-reference/react-native-e2ee/): Enable end-to-end encryption of capture artifacts.
- [Token-Based Setup](/sdk-reference/react-native-token-based-setup/): Use the SDK without an API key by passing a backend-created token.
- [Delete Local Session Data](/sdk-reference/react-native-delete-local-session-data/): Clean up locally stored onboarding data.
- [Troubleshooting](/sdk-reference/react-native-troubleshooting/): Common build and setup problems.
- [Dynamic Delivery Usage Guide](/sdk-reference/react-native-dynamic-delivery-usage-guide/): Reduce the SDK's impact on your app's download size on Android and iOS.

---

- Path: `sdk-reference/react-native-installation`
- URL: https://developer.incode.com/sdk-reference/react-native-installation/
- Markdown: https://developer.incode.com/sdk-reference/react-native-installation.md

# Installation

This page covers everything you need to install and initialize the Incode React Native SDK in your app: choosing the right SDK variant, environment requirements, platform-specific setup for iOS and Android, and Expo configuration.

After installation is complete, initialize the SDK (see [Getting Started](/sdk-reference/react-native-getting-started/)), then see [SDK Modes](/sdk-reference/react-native-sdk-modes/) to choose how the SDK operates, and [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/) to choose how to drive the onboarding flow.

## SDK Variants

The SDK is published as `@incode-sdks/react-native-incode-sdk`. Pick the version suffix that matches your feature set.

| Variant | Example dependency | Use when you need |
|---------|--------------------|-------------------|
| Standard | `"[VERSION]"` | Base onboarding modules. |
| Streaming | `"[VERSION]-vc"` | Camera frame streaming for ID/Selfie capture. |
| Face Login | `"[VERSION]-l"` | `startFaceLogin()` and locally stored identity flows. |
| NFC | `"[VERSION]-nfc"` | `NFCScan` and NFC-based face match flows. |

## Environment Setup

### Requirements

#### Access prerequisites

Three separate credentials are required before the SDK will install and build:

- An NPM account that has accepted the invitation to the Incode React Native team. See [Get access to the private NPM package](#get-access-to-the-private-npm-package).
- GitHub authentication configured on your machine over SSH or HTTPS. The Incode CocoaPods podspec sources are hosted on GitHub and iOS builds cannot resolve them otherwise.
- A GitHub token with the `read:packages` scope for the `android-omni-packages` registry, used by Android builds.

Contact your Incode representative to request the NPM invitation and the GitHub Packages credentials.

#### Tooling

- React Native app with Android and/or iOS targets.
- Node 18+; Node 20+ recommended.
- Xcode 15.0.1+.
- Swift 5.5+.
- CocoaPods 1.11+.
- iOS 13+.
- Android `minSdkVersion` 23+; use 24+ when using the video-streaming dependency.
- Android `compileSdkVersion` 36+.
- Android Gradle Plugin 8.9.1+.
- Gradle 8.14.5+.
- Kotlin 2.2.21+.

## Installation

### Get access to the private NPM package

The React Native SDK is distributed as a private NPM package. Before you install it, you must have a free NPM account. Once your NPM account is set up, contact Incode and share your NPM username. We send an invitation to join our React Native team to the email address associated with your NPM account. You must accept this invitation within 7 days to access the SDK.

### Add an .npmrc file to your project

An `.npmrc` file customizes NPM's behavior, including access to private packages. In the root directory of your React Native project, create an `.npmrc` file with these contents:

```ini
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
@incode-sdks:registry=https://registry.npmjs.org/
```

Export the token in the shell you install from:

```sh
export NPM_TOKEN="<your-npm-token>"
```

NPM expands `${NPM_TOKEN}` from the environment at install time, so this `.npmrc` holds no secret and is safe to commit. Never commit a file containing the literal token value.

Create the token in your NPM account settings. See [Creating and viewing access tokens](https://docs.npmjs.com/creating-and-viewing-access-tokens) in the NPM documentation. Either token type works:

- A classic token with **Read-only** access.
- A granular access token with **Read** permission for the `@incode-sdks` scope. Granular tokens expire, so renew the token before its expiration date or installs start failing.

The `@incode-sdks:registry` line matters when your team installs through a mirror or proxy registry such as Artifactory or Verdaccio. It routes the Incode scope to npmjs.org while every other package keeps resolving through the mirror.

#### Yarn and pnpm

pnpm and Yarn Classic (1.x) read `.npmrc` as shown above. Yarn Berry (2.x and newer) ignores it, so configure the scope in `.yarnrc.yml` instead:

```yaml
npmScopes:
  incode-sdks:
    npmRegistryServer: "https://registry.npmjs.org"
    npmAuthToken: "${NPM_TOKEN}"
```

### Install the package

Install the standard package:

```sh
npm i @incode-sdks/react-native-incode-sdk
```

Or pin the dependency in `package.json`:

```json
{
  "dependencies": {
    "@incode-sdks/react-native-incode-sdk": "[VERSION]"
  }
}
```

Use a variant suffix when needed:

```json
{
  "dependencies": {
    "@incode-sdks/react-native-incode-sdk": "[VERSION]-vc"
  }
}
```

## Additional Setup Instructions

### iOS Setup

Set the deployment target to iOS 13 or higher:

```diff
-platform :ios, '10.0'
+platform :ios, '13.0'
```

Add the CocoaPods sources at the top of your `Podfile`:

```ruby
source 'https://cdn.cocoapods.org/'
source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
source 'git@github.com:Incode-Technologies-Example-Repos/IncodeBridgeCommonPodspecs.git'
```

For React Native 0.69 and newer, autolinking is enough. For older React Native versions, add the package path manually:

```ruby
pod 'react-native-incode-sdk', :path => '../node_modules/@incode-sdks/react-native-incode-sdk/'
```

Add an empty Swift file to the native project in Xcode. When prompted, create the bridging header.

Before running `pod install`, configure SSH or HTTPS GitHub authentication. The Incode podspec source is hosted on GitHub and requires authenticated access.

Run CocoaPods:

```sh
cd ios
pod install
cd ..
```

Add these `Info.plist` usage descriptions:

- `NSCameraUsageDescription`: The SDK uses the camera in order to verify the identity of the customer, for example in ID scan and Selfie scan.
- `NSLocationWhenInUseUsageDescription`: The SDK uses the current user location for the Geolocation step.
- `NSMicrophoneUsageDescription`: The SDK uses the microphone during video conference and video selfie flows.

Add these URL schemes to `LSApplicationQueriesSchemes` in your app's `Info.plist`. The SDK uses them for jailbreak detection:

```xml
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>cydia</string>
  <string>undecimus</string>
  <string>sileo</string>
  <string>zbra</string>
  <string>filza</string>
  <string>activator</string>
  <string>installer</string>
  <string>saily</string>
  <string>xina</string>
  <string>dopamine</string>
</array>
```

If your app already declares `LSApplicationQueriesSchemes`, keep the existing array and add only the missing entries. Keep the combined list within Apple's limit: 50 entries when linked with iOS 15–26 SDKs, or 25 with iOS 27 and later.

Add the required linker flags in the app target's Build Settings > Other Linker Flags:

```text
$(inherited) -all_load -ObjC -l "stdc++" -l "iconv"
```

### Android Setup

Set Android SDK versions:

```gradle
minSdkVersion = 23
compileSdkVersion = 36
```

Use `minSdkVersion = 24` when enabling video streaming.

Use Kotlin Gradle plugin `2.2.21` or higher when compiling Kotlin source with the SDK on the classpath:

```gradle
plugins {
  id 'org.jetbrains.kotlin.android' version '2.2.21'
}
```

If your app assembles an APK with the SDK, add the required OkHttp 5.3.2 packaging exclusion:

```gradle
android {
  packaging {
    resources {
      excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
    }
  }
}
```

When you manage Android build tooling yourself, use Android Gradle Plugin `8.9.1` or higher and Gradle `8.14.5` or higher.

If your app explicitly pins coroutines, use `org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0` or higher.

If you are on React Native `0.78.x` and encounter Kotlin toolchain/alignment issues while adopting Kotlin `2.2.x`, disable RNGP Java/Kotlin auto-alignment (`react.internal.disableJavaVersionAlignment=true`) and ensure Android modules compile with Java 17.

Enable multidex:

```diff
defaultConfig {
+  multiDexEnabled true
}
```

Add the multidex dependency:

```gradle
implementation 'com.android.support:multidex:1.0.3'
```

Make the application extend `MultiDexApplication`:

```java
import androidx.multidex.MultiDexApplication;

public class MyApplication extends MultiDexApplication implements ReactApplication {
}
```

Add the Incode Maven repository and credentials to the project `build.gradle`:

```gradle
allprojects {
  repositories {
    maven { url "https://jitpack.io" }
    maven {
      url = uri("https://maven.pkg.github.com/Incode-Technologies-Example-Repos/android-omni-packages")
      credentials {
        username = "incode-customers"
        password = "GITHUB_TOKEN"
      }
    }
  }
}
```

Prefer environment or Gradle properties for real credentials. Do not commit tokens.

**Troubleshooting tip**: If Gradle cannot resolve Incode dependencies, verify credentials and repository access with your Incode representative. See [Troubleshooting](/sdk-reference/react-native-troubleshooting/) for more build and setup issues.

## Expo SDK Installation

If your app is built with Expo, install the Expo configuration plugin instead of doing the iOS and Android setup steps above.

Install the plugin:

```sh
npx expo install @incode-sdks/expo-incode-sdk-configuration
```

Add it to `app.json` or `app.config.js`:

```json
{
  "expo": {
    "plugins": [
      [
        "@incode-sdks/expo-incode-sdk-configuration",
        {
          "cameraUsageDescription": "The SDK uses the camera in order to verify the identity of the customer.",
          "locationWhenInUseUsageDescription": "The SDK uses the current user location for Geolocation steps.",
          "microphoneUsageDescription": "The SDK uses the microphone for video conference or video selfie.",
          "allowBackupOverride": true,
          "koinVersion": "3.5.3",
          "iosPodspecSource": "ssh",
          "addStreaming": false,
          "addDynamicLocalization": false,
          "addVoiceConsentFaceRecognition": false,
          "addNfc": false
        }
      ]
    ]
  }
}
```

Android builds need GitHub Packages credentials:

```sh
export GITHUB_USERNAME="<github-username>"
export GITHUB_TOKEN="<github-token>"
```

Then prebuild and run:

```sh
npx expo prebuild --clean --platform android
npx expo run:android --device
```

`iosPodspecSource` can be `ssh` or `https`. When using HTTPS, configure GitHub authentication outside the project with GitHub CLI, Git Credential Manager, macOS Keychain, or `~/.netrc`.

---

- Path: `sdk-reference/react-native-known-issues`
- URL: https://developer.incode.com/sdk-reference/react-native-known-issues/
- Markdown: https://developer.incode.com/sdk-reference/react-native-known-issues.md

# Known Issues

This page documents known limitations of the React Native SDK. For build and setup problems, see [Troubleshooting](/sdk-reference/react-native-troubleshooting/). If you run into an issue not listed on either page, contact your Incode representative.

## Android virtual environments

Recent native SDK versions can intentionally fail when running in virtualized, rooted, hooked, or otherwise unsafe environments. Use `testMode: true` only for simulator/emulator development, and validate production flows on real devices.

---

- Path: `sdk-reference/react-native-modules`
- URL: https://developer.incode.com/sdk-reference/react-native-modules/
- Markdown: https://developer.incode.com/sdk-reference/react-native-modules.md

# Modules

A module is a self-contained step in an onboarding flow. Add modules to `flowConfig` for locally configured flows, or configure them in a Flow or Workflow on the Incode Dashboard for online-configured flows.

All the modules supported by the SDK are listed here, with their configuration parameters. For implementation options and instructions, see [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/).

Every entry in `flowConfig` includes:
- `module` (required): string. The module name.
- `enabled` (optional, defaults to `true`): boolean. Explicitly include or skip the module in the flow.

For completion payloads, update events, and module error examples, see [Results](/sdk-reference/react-native-results/).

### Phone
Ask the user to enter a phone number.
- `otpVerification` (optional): boolean. Ask for OTP verification. When omitted, the native SDK setting applies (`false` unless configured otherwise).
- `defaultRegionPrefix` (optional): number. Dialing-code override, `1`–`9999`, without a leading `+`. Values outside that range are ignored and the device's own region prefix is used.

### DocumentScan
Ask the user to capture a document.
- `showTutorial` (optional, defaults to `false`): boolean. Show the document scan tutorial. Only on iOS.
- `showDocumentProviderScreen` (optional, defaults to `true`): boolean. Specify `true` to show the document provider screen. Specify `false` to go directly to capture. **This parameter is deprecated.** Use `documentSources` instead. `false` is equivalent to `documentSources: ['camera']`. `true` preserves the behavior from before: every source on Android, the SDK default for the document `type` on iOS. When both are set, `documentSources` wins.
- `documentSources` (optional, defaults to every source the document `type` supports): array of `camera`, `photoUpload`, or `fileUpload`. Restricts the submission methods offered on the source chooser: for example, `['camera']` to go straight to capture or `['photoUpload', 'fileUpload']` to make the step upload-only. `fileUpload` (PDF) is only meaningful for document types that support PDFs; on iOS, it is dropped at runtime for types that don't support PDFs (for example, `medicalDoc`). Always keep another source in the list for those types. In V1, applies only if `showDocumentProviderOptions = true`. In V2, always used to determine the available sources.
- `type` (optional, defaults to `addressStatement`): `addressStatement`, `paymentProof`, `medicalDoc`, `otherDocument1`, `otherDocument2`, or `otherDocument3`.

### Geolocation
Get information about the user's current location.
- `isSkippable` (optional, defaults to `false`): boolean. Allows the geolocation step to be skipped. When set to `true`, skipping or denying location permission advances the flow instead of ending the session with a permission error. The skipped step is still reported through `onStepCompleted`, with `status: 'fail'`. Only a boolean is accepted; any other value is ignored and the default applies.

### UserConsent
Ask the user for consent.
- `title` (required): string. Title shown on the consent screen.
- `content` (required): string. Content shown on the consent screen.

### CombinedConsent
Ask the user for data-sharing consent.
- `consentId` (required): string. ID for the combined consent configured in the dashboard.

### Signature
Ask the user to draw a signature.
- `title` (optional): string. Optional title shown at the top of the screen.
- `description` (optional): string. Optional description shown below the title.
- `descriptionMaxLines` (optional): number. Maximum number of description text lines.

This module enables user to add a digital signature by signing on a canvas.

Besides specifying `title` and `description` keys, you must provide text for Android and iOS in their `res/values/strings.xml` and `Localizable.strings` files.

```js
{
  module: 'Signature',
  title: 'onboard_sdk_signature_title',
  description: 'onboard_sdk_signature_description',
  descriptionMaxLines: 2
}
```

For Android:

```
<string name="onboard_sdk_signature_title">Example title</string>
<string name="onboard_sdk_signature_description">Description example</string>
```

If your account has the Signature V2 experience enabled, override the dedicated V2 resources as well. V1 keeps using the resources above.

```
<string name="onboard_sdk_signature_capture_title">Example title</string>
<string name="onboard_sdk_signature_capture_description">Description example</string>
```

For iOS:

```
"onboard_sdk_signature_title" = "Example title";
"onboard_sdk_signature_description" = "Description example";
```

### VideoSelfie
Record a video selfie flow. Available only for Android API level 21+.
- `showTutorial` (optional, defaults to `true`): boolean. Show the video selfie tutorial.
- `selfieScanMode` (optional, defaults to `selfieMatch`): `selfieMatch` or `faceMatch`. Specify whether to compare the selfie directly or compare with the photo from the ID.
- `selfieLivenessCheck` (optional, defaults to `false`): boolean. Check user liveness during video selfie.
- `showIdScan` (optional, defaults to `true`): boolean. Ask for ID scan during video selfie.
- ~~`showDocumentScan`~~ (deprecated, optional): boolean. Kept in the TypeScript config for compatibility; the current SDK does not enable document scan from this flag.
- `showVoiceConsent` (optional, defaults to `true`): boolean. Ask for voice consent during video selfie.
- `voiceConsentQuestionsCount` (optional, defaults to `3`): number. Number of random questions for video selfie voice consent.
- `voiceConsentFR` (optional, defaults to `false`): boolean. Ask for face recognition during voice consent.
- `cameraFacingConfig` (optional): `CameraFacingConfig`. Set the camera for each step using `selfieCameraFacing`, `idFrontCameraFacing`, `idBackCameraFacing`, `documentScanCameraFacing`, `randomQuestionsCameraFacing`, and `voiceConsentCameraFacing`; each value is `front` or `back`.
- `questions` (optional): `VideoSelfieQuestion[]`. List of `{ question: string; answer: string }` entries to show in capture-only/random-question mode.
- `logo` (optional): string. Name of a native image resource of your app, shown as the logo on the video selfie screens. On Android, it is a drawable resource name (`res/drawable/<name>`). Add the drawable to `res/raw/keep.xml`, or the Android shrinker removes it from release builds and the SDK default logo shows instead. See the [keep.xml example](/sdk-reference/react-native-api-reference/#setlogo). On iOS, it is an image asset name from your asset catalog or main bundle. Use the same name on both platforms for consistency. When omitted, or when the name cannot be resolved, the SDK default logo is used.

On Android, when the Video Selfie V2 experience is enabled for your account, the camera steps hide the close (X) button, so `IncodeSdk.showCloseButton(true)` does not apply to them. The button still shows on the other screens, and Video Selfie V1 keeps it over the camera.

### IdScan
Ask the user to capture ID or passport.
- `showTutorial` (optional, defaults to `true`): boolean. Show the ID scan tutorial.
- `idType` (optional): `id` or `passport`. Preselects the document type. It doesn't hide the document chooser: set `showIdTypeChooser: false` for that.
- `showIdTypeChooser` (optional, defaults to `true`): boolean. Specify `false` to skip the document chooser screen.
- `idCategory` (optional, defaults to `primary`): `primary` or `secondary`.
- `showRetakeScreenForManualCapture` (optional, defaults to `true`): boolean. Show the photo review screen for manual captures.
- `showRetakeScreenForAutoCapture` (optional, defaults to `false`): boolean. Show the photo review screen after auto capture.
- `enableFrontShownAsBackCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the front side is shown during back capture.
- `enableBackShownAsFrontCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the back side is shown during front capture.
- ~~`autocaptureUxMode`~~ (deprecated, optional, defaults to `holdStill`): `countdown` or `holdStill`. This parameter applies only to V1.
- `showIDOverlay` (optional, defaults to `false`): boolean. Show the ID overlay during capture.
- `streamFrames` (optional, defaults to `false`): boolean. Enables camera frame streaming. Requires the RN SDK `-vc` variant and the Android `com.incode.sdk:video-streaming` dependency.

### IdScanFront
Ask the user to capture only the front side of an ID.
- `showTutorial` (optional, defaults to `true`): boolean. Show the ID scan tutorial.
- `idType` (optional): `id` or `passport`. Preselects the document type. It doesn't hide the document chooser: set `showIdTypeChooser: false` for that.
- `showIdTypeChooser` (optional, defaults to `true`): boolean. Specify `false` to skip the document chooser screen.
- `idCategory` (optional, defaults to `primary`): `primary` or `secondary`.
- `showRetakeScreenForManualCapture` (optional, defaults to `true`): boolean. Show the photo review screen for manual captures.
- `showRetakeScreenForAutoCapture` (optional, defaults to `false`): boolean. Show the photo review screen after auto capture.
- `enableFrontShownAsBackCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the front side is shown during back capture.
- `enableBackShownAsFrontCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the back side is shown during front capture.
- ~~`autocaptureUxMode`~~ (deprecated, optional, defaults to `holdStill`): `countdown` or `holdStill`. This parameter applies only to V1.
- `showIDOverlay` (optional, defaults to `false`): boolean. Show the ID overlay during capture.
- `streamFrames` (optional, defaults to `false`): boolean. Enables camera frame streaming. Requires the RN SDK `-vc` variant and the Android `com.incode.sdk:video-streaming` dependency.

### IdScanBack
Ask the user to capture only the back side of an ID.
- `showTutorial` (optional, defaults to `true`): boolean. Show the ID scan tutorial.
- `idCategory` (optional, defaults to `primary`): `primary` or `secondary`.
- `showRetakeScreenForManualCapture` (optional, defaults to `true`): boolean. Show the photo review screen for manual captures.
- `showRetakeScreenForAutoCapture` (optional, defaults to `false`): boolean. Show the photo review screen after auto capture.
- `enableFrontShownAsBackCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the front side is shown during back capture.
- `enableBackShownAsFrontCheck` (optional, defaults to `false`): boolean. Show real-time feedback when the back side is shown during front capture.
- ~~`autocaptureUxMode`~~ (deprecated, optional, defaults to `holdStill`): `countdown` or `holdStill`. This parameter applies only to V1.
- `showIDOverlay` (optional, defaults to `false`): boolean. Show the ID overlay during capture.
- `streamFrames` (optional, defaults to `false`): boolean. Enables camera frame streaming. Requires the RN SDK `-vc` variant and the Android `com.incode.sdk:video-streaming` dependency.

### ProcessId
Process the ID after separated front and back captures.
- `idCategory` (optional, defaults to `primary`): `primary` or `secondary`. Applied on Android.
- ~~`enableIdSummaryScreen`~~ (deprecated, optional, defaults to `true`): boolean. This parameter applies only to V1.

### Conference
Start a video conference call.
- `disableMicOnStart`: boolean. Disable the microphone when the call starts. Always pass this explicitly - the Android native module reads it without a default and can throw if it's omitted. On iOS, this flag is not currently wired up.

### SelfieScan
Ask the user to capture a selfie.
- `showTutorial` (optional, defaults to `true`): boolean. Show the selfie scan tutorial.
- `lensesCheck` (optional, defaults to `true`): boolean. Check if the user is wearing glasses.
- `cameraFacing` (optional, defaults to `front`): `front` or `back`. Camera used during selfie capture.
- `faceMaskCheck` (optional, defaults to `true`): boolean. Check if the user is wearing a face mask.
- ~~`brightnessThreshold`~~ (deprecated, optional): number. Kept in the TypeScript config for compatibility; not read by the current Android or iOS native SDK.
- `streamFrames` (optional, defaults to `false`): boolean. Enables camera frame streaming. Requires the RN SDK `-vc` variant and the Android `com.incode.sdk:video-streaming` dependency.
- `logo` (optional): string. Name of a native image resource of your app, shown as the logo on the selfie capture screen. On Android, it is a drawable resource name (`res/drawable/<name>`) Add the drawable to `res/raw/keep.xml`, or the Android shrinker removes it from release builds and the SDK default logo shows instead. See the [keep.xml example](/sdk-reference/react-native-api-reference/#setlogo). On iOS, it is an image asset name from your asset catalog or main bundle. Use the same name on both platforms for consistency. When omitted, or when the name cannot be resolved, the SDK default logo is used.

### FaceMatch
Perform a face match between the captured ID/passport and Selfie or NFC data.
- `idCategory` (optional, defaults to `primary`): `primary` or `secondary`.
- `matchType` (optional): `idSelfie`, `nfcSelfie`, or `nfc3Way`.
- `showUserExists` (optional, defaults to `false` on Android since the UxV2 migration): boolean. Show whether the user already exists.

### QrScan
Ask the user to scan a QR code.
- No additional parameters

### Captcha
Ask the user to enter the OTP generated for the current session.
- No additional parameters

### Email
Ask the user to enter an email.
- `otpVerification` (optional): boolean. Ask for OTP verification. When omitted, the native SDK setting applies (`false` unless configured otherwise).

### Approve
Approve the current onboarding session and add the user to the Omni database.
- `forceApproval` (optional, defaults to `false`): boolean. Force approval when set to `true`.

### UserScore
Show the info and scoring for all performed steps.
- `mode` (optional, defaults to `accurate`): `accurate` or `fast`. `accurate` fetches server-side results and can take longer; `fast` shows results based on on-device processing.

### MLConsent
Ask the user for Machine Learning consent.
- `type` (required): `gdpr` or `us`.

### GovernmentValidation
Perform government validation of the ID.
- `isBackgroundExecuted` (optional, defaults to `false`): boolean. Run the module without showing its UI.

### Antifraud
Compare the current interview with existing interviews and customers to detect possible fraud.
- No additional parameters

### GlobalWatchlist
Check customer identities against sanctions, PEP, and watchlist sources.
- No additional parameters

### CustomWatchlist
Check whether the user is present in an Incode Dashboard custom watchlist.
- No additional parameters

### Aes
Enable advanced electronic signature document handling.
- `uploadDocument` (optional, defaults to `false`): boolean. Upload the signed document.
- `downloadDocument` (optional, defaults to `false`): boolean. Download the signed document.

### FullName
Ask the user to enter a name.
- No additional parameters

:::info
Renamed from `Name` in [9.18.0](/release-notes/releases-rn-sdk/#9180). The completion event uses `FullName` too — see [Results](/sdk-reference/react-native-results/).
:::

### CurpValidation
Validate the user's CURP against RENAPO, or generate it from the user's personal data. Mexico only.
- `validationEnabled` (optional, defaults to `true`): boolean. Validate the CURP on the server. With `false`, the module only captures a CURP in a valid format. Workflows always validate.

The result is in [Results](/sdk-reference/react-native-results/#curpvalidation).

:::note
This module was renamed from `CURP` in [9.19.0](/release-notes/releases-rn-sdk/#9190). The completion event uses `CurpValidation` as well.
:::

### OCREdit
Review OCR data.
- `isEditable` (optional, defaults to `false`): boolean. Allow the user to edit OCR data.

### eKYB
Run KYB validation with business information.
- `checkBusinessName` (optional, defaults to `false`): boolean. Validate business name.
- `checkAddress` (optional, defaults to `false`): boolean. Validate address.
- `checkTaxId` (optional, defaults to `false`): boolean. Validate tax ID.

### eKYC
Run KYC validation with user information.
- `checkName` (optional, defaults to `false`): boolean. Validate name.
- `checkEmail` (optional, defaults to `false`): boolean. Validate email.
- `checkAddress` (optional, defaults to `false`): boolean. Validate address.
- `checkPhone` (optional, defaults to `false`): boolean. Validate phone.
- `checkSsn` (optional, defaults to `false`): boolean. Validate SSN.
- `checkDob` (optional, defaults to `false`): boolean. Validate date of birth.
- `checkNationality` (optional, defaults to `false`): boolean. Validate nationality.

### NFCScan
Ask the user to scan the NFC chip on their document.
- `idType` (optional): `id` or `passport`. ID type used for NFC scanning. If omitted, the SDK reuses the ID type from ID scan when available; otherwise, it can show a chooser.
- `showNFCSymbolConfirmationScreen` (optional, defaults to `true`): boolean. Show a screen asking whether the document contains an NFC chip.
- `showInitialDataConfirmationScreen` (optional, defaults to `true`): boolean. Show the document OCR data confirmation screen before the first NFC scan.
- `processNFCData` (optional, defaults to `true`): boolean. Use data read from the NFC chip to validate identity.

Please check special [NFC integration instructions for iOS](/sdk-reference/module-nfc-scan/) that need to be applied on app level.

### FaceAuthentication
Authenticate an existing user with face recognition.
- `showTutorials` (optional, defaults to `true`): boolean. Show the tutorial before face authentication.
- `autoCaptureTimeout` (optional, defaults to `16`): number. Timeout in seconds for automatic face capture.
- `captureAttempts` (optional, defaults to `3`): number. Number of allowed face capture attempts before failing the step.
- `eyesClosedCheck` (optional, defaults to `true`): boolean. Check whether the user's eyes are closed.
- `headCoverCheck` (optional, defaults to `true`): boolean. Check for head coverings that may obstruct face recognition.
- `lensesCheck` (optional, defaults to `true`): boolean. Check whether the user is wearing lenses or glasses.
- `faceMaskCheck` (optional, defaults to `true`): boolean. Check whether the user is wearing a face mask.

To show your logo on the Face Authentication screens, call [setLogo](/sdk-reference/react-native-api-reference/#setlogo) before you start the flow.

## Modules interdependencies

The order of modules in `flowConfig` is the execution order.

- `ProcessId` expects `IdScanFront` and `IdScanBack` to run before it.
- `FaceMatch` expects `IdScan` and `SelfieScan` to run before it.
- `VideoSelfie` expects `IdScan` in `faceMatch` mode, or `SelfieScan` in `selfieMatch` mode.
- `Aes` expects `Phone`, `IdScan`, and `SelfieScan` to run before it.
- `UserScore` should run after all modules that provide scoring inputs.
- `Approve` should run after all modules required for the approval decision.
- `UserScore` and `Approve` do not depend on each other, so their relative order can be chosen by the app.

---

- Path: `sdk-reference/react-native-results`
- URL: https://developer.incode.com/sdk-reference/react-native-results/
- Markdown: https://developer.incode.com/sdk-reference/react-native-results.md

# Results

Every module in an onboarding flow reports its outcome through the SDK's listeners or the value returned by the start call. Most modules deliver a dedicated result object through a step completion event; a few signal completion with only a status field. This page describes promise results, listener payloads, and common error codes.

For the full field list of any result type, see the [Modules](/sdk-reference/react-native-modules/) reference and the [API Reference](/sdk-reference/react-native-api-reference/).

## How results and errors are delivered

- **Per-step results** arrive through step completion events. Register a listener for a specific module with `IncodeSdk.onStepCompleted({ module, listener })`, and the listener receives a `result` object when that module finishes.
- **In-progress updates** arrive through `IncodeSdk.onStepUpdated({ module, listener })` for the modules that emit them (currently `Conference`, `IdScanFront`, `IdScanBack`, and `SelfieScan`).
- **Session-level outcomes** arrive as the resolved value of the start call. `startOnboarding()`, `startFlow()`, and `startWorkflow()` resolve with `{ status: 'success' }` on completion. `startOnboardingSection()` resolves with a similar object that also includes `sectionTag`. A cancelled flow rejects with `code: 'userCancelled'`.
- **Errors** surface as rejected promises. The start methods reject with `IncodeSdkFlowError`; `IncodeSdk.initialize()` rejects with `IncodeSdkInitError`.
- **Cleanup**: call `IncodeSdk.deleteLocalUserData()` once you are done with a session to remove locally stored onboarding data (Android only - see [Delete Local Session Data](/sdk-reference/react-native-delete-local-session-data/)).

## API results

### Error enums

`IncodeSdk.initialize()` can reject with `IncodeSdkInitError`.

```ts
type IncodeSdkInitErrorCode =
  | 'simulatorDetected'
  | 'testModeEnabled'
  | 'invalidInitParams'
  | 'configError'
  | 'unknown';
```

| Code | When it fires |
|------|----------------|
| `simulatorDetected` | Running on a simulator without `testMode: true`. |
| `testModeEnabled` | Running on a physical device with `testMode: true`; test mode is only for simulators/emulators. |
| `invalidInitParams` | The native project isn't configured correctly (for example, a missing or malformed `Incode-Info.plist` on iOS). |
| `configError` | `apiConfig` is missing or incomplete. |
| `unknown` | An unrecognized initialization failure. |

Flow APIs can reject with `IncodeSdkFlowError`.

```ts
type IncodeSdkFlowErrorCode =
  | 'permissionsDenied'
  | 'videoSelfieNotCompleted'
  | 'integrityCompromised'
  | 'faceAuthenticationFailed'
  | 'sslPinningFailed'
  | 'locationUnavailable'
  | 'storageUnavailable'
  | 'combinedConsentsNotReceived'
  | 'userCancelled'
  | 'interrupted'
  | 'sessionCreationFailed'
  | 'captchaNotVerified'
  | 'biometricConsentNotGiven'
  | 'biometricConsentNotReceived'
  | 'sectionAlreadyRunning'
  | 'noActiveSession'
  | 'insufficientDiskSpace'
  | 'onDeviceProcessingNotCompatible'
  | 'configError'
  | 'activityNotPresent'
  | 'unknown';
```

| Code                       | When it fires                                                                       |
| -------------------------- | ----------------------------------------------------------------------------------- |
| `permissionsDenied`        | The user denied a permission required by the flow (typically camera or microphone, also during Video Selfie). |
| `videoSelfieNotCompleted`  | The Video Selfie step could not be completed for a reason other than a denied permission. |
| `integrityCompromised` | The SDK detected a compromised device environment. Replaces `jailbreakDetected` as of 9.15.0. |
| `faceAuthenticationFailed` | A face authentication step failed.                                                  |
| `sslPinningFailed`         | SSL pinning validation failed.                                                      |
| `locationUnavailable`      | Required location data could not be obtained.                                       |
| `storageUnavailable`       | The device could not provide a writable images directory when the flow started. Android only. |
| `combinedConsentsNotReceived` | A mandatory Combined Consent could not be shown because it has no readable text or no checkbox id, so the flow stopped. iOS only. |
| `userCancelled`            | The user dismissed the flow or section. |
| `interrupted`              | The system ended the flow, for example by destroying the SDK screen while the app was in the background. |
| `sessionCreationFailed`    | The onboarding session could not be created. iOS only. |
| `captchaNotVerified`       | The CAPTCHA could not be verified, so the flow ended. iOS only. On Android, a failed CAPTCHA rejects with `unknown`. |
| `biometricConsentNotGiven` | The user did not give consent to store biometric data. |
| `biometricConsentNotReceived` | The biometric consent did not reach Incode. |
| `sectionAlreadyRunning`    | `startOnboardingSection` was called while another section was running. |
| `noActiveSession`          | The flow needs an onboarding session and there is none. On Android, only `startOnboardingSection` reports it. |
| `insufficientDiskSpace`    | The device does not have enough free space for the SDK's ML models. `error.message` shows the space available and required. Android only. |
| `onDeviceProcessingNotCompatible` | On-device processing is enabled together with a setting it does not support: for example, no end-to-end encryption, frame streaming, or screen recording. `error.message` shows the reason. Android only. |
| `configError`              | `startFlow` or `startWorkflow` was called with neither a non-empty `sessionConfig.configurationId` nor a non-empty `sessionConfig.token`. Rejected before the flow starts, so no network request is made. |
| `activityNotPresent`       | `startFlow` or `startWorkflow` was called without a host Activity (Android) or view controller (iOS). Rejected before the flow starts. |
| `unknown`                  | Catch-all for unrecognized flow failure.                

### startOnboarding, startFlow, and startWorkflow

Successful completion resolves with:

```json
{ "status": "success" }
```

User cancellation rejects the promise with `code: 'userCancelled'`.

### setupOnboardingSession

```ts
{
  interviewId: string;
  token: string;
}
```

### startOnboardingSection

```ts
{
  status: 'success';
  sectionTag: string;
}
```

### startFaceLogin

```ts
{
  faceMatched: boolean;
  spoofAttempt: boolean;
  image?: { pngBase64?: string; encryptedBase64?: string };
  customerUUID?: string;
  interviewId?: string;
  interviewToken?: string;
  token?: string;
  transactionId?: string;
  hasFaceMask?: boolean;
}
```

Example Face Login response:

```json
{
  "faceMatched": true,
  "spoofAttempt": false,
  "image": {
    "pngBase64": "...PNG Base 64 encoded",
    "encryptedBase64": "...PNG Encrypted Base 64 encoded"
  },
  "customerUUID": "exampleCustomerUUID",
  "interviewId": "exampleInterviewID",
  "interviewToken": "exampleInterviewToken",
  "token": "exampleToken",
  "transactionId": "Unique Authentication attempt ID",
  "hasFaceMask": false
}
```

For 1:1 Face Login, `faceMatched` can be `false` when faces do not match or when the user with the supplied customer token and `customerUUID` is not found. For 1:N Face Login, `faceMatched` can be `false` when the captured face is not associated with an approved user in the database.

`hasFaceMask` is available on iOS only; Android forces the user to remove the mask before login is performed.

### getUserScore

Returns a `UserScoreResult` — the full score surface:

```ts
{
  /** The raw score response as a JSON string. Parse it; do not compare it across platforms. */
  extendedUserScoreJsonData: string;
  overall: { value: string | null; status: UserScoreStatus | null };
  idValidation?: {
    overall: { value: string | null; status: UserScoreStatus | null };
    photoSecurityAndQuality: UserScoreCheck[];
    idSpecific: UserScoreCheck[];
  };
  liveness?: {
    overall: { value: string | null; status: UserScoreStatus | null };
    livenessScore: { value: string | null; status: UserScoreStatus | null };
    photoQuality: string | null;
  };
  faceRecognition?: {
    overall: { value: string | null; status: UserScoreStatus | null };
    existingUser: boolean;
  };
  governmentValidation?: {
    overall: { value: string | null; status: UserScoreStatus | null };
    recognitionConfidence: { value: string | null; status: UserScoreStatus | null };
    validationStatus: UserScoreCheck;
    ocrValidation: UserScoreCheck[];
  };
}

// UserScoreStatus = 'ok' | 'warn' | 'unknown' | 'fail' | 'manual'
// UserScoreCheck  = { key: string | null; value: string | null; status: UserScoreStatus | null }
```

A section key is present only when the server returned that section. `value` is the raw server string (`'80.5'`). `photoSecurityAndQuality` and `ocrValidation` never contain `unknown` entries; `idSpecific` may.

```ts
await IncodeSdk.getUserScore({ fetchMode: 'accurate' });
```

Compact form: `{fetchMode: 'accurate'}`.

The [`UserScore` module](#userscore) step-complete event delivers this same shape.

### approve

```ts
{
  success: boolean;
  uuid: string | null;
  customerToken: string | null;
  error: string | null;
}
```
- `success`: Whether the user was approved. A `false` value is a normal, expected outcome, not an error.
- `uuid`: The customer UUID.
- `customerToken`: The customer's session token.
- `error`: An approval error reported by the SDK. iOS only - always `null` on Android.

`uuid`, `customerToken`, and `error` are `null` when the SDK has no value for them.

Use the optional `forceApproval` argument when calling `approve()`; it defaults to `false`. Some older text called this `forceApprove`.

Failures reject the promise with an error code and message. The codes are `userCancelled` when the user dismisses the section, `approvalError` (Android only) when the approval flow could not be configured, and any `IncodeSdkFlowErrorCode` value such as `sslPinningFailed` or `unknown`.

### faceMatch

Returns a `FaceMatch` completion event payload.

### Methods without a meaningful payload

`finishOnboardingFlow`, `deleteLocalUserData`, `showCloseButton`, `setTheme`, `setUXConfig`, `setString`, `setQuantityStrings`, `setLocalizationLanguage`, `setFaceAuthenticationHint`, and `setSdkMode` are primarily command-style methods.

`checkOnDemandResourcesDownloaded`, `downloadOnDemandResources`, and `removeOnDemandResources` do return a meaningful payload on Android - a `{ status: string }` object (`"true"`/`"false"` for the check, `"success"` for download/remove; see `IncodeSdkModule.kt`). See [Dynamic Delivery Usage Guide](/sdk-reference/react-native-dynamic-delivery-usage-guide/) for usage.

## Listener results

The SDK offers several types of listeners:

- user cancellation
- tracking events
- step completion, for each module individually
- step error, for each module individually
- step update, for each module individually

### User cancellation

If the user cancels onboarding, `startOnboarding`, `startOnboardingSection`, `startFlow`, `startWorkflow`, and `startFlowFromDeepLink` reject with `code: 'userCancelled'`.
On both platforms, the user can cancel by pressing the close button that can be enabled using `IncodeSdk.showCloseButton(true)`. On Android, the user can also cancel by pressing the back key.

### Session created

When an onboarding session gets created, the information about the session can be obtained via `IncodeSdk.onSessionCreated`.

```ts
IncodeSdk.onSessionCreated((session) => {
  console.log('Onboarding session created, interviewId: ' + session.interviewId);
});
```

The session event includes:

- `interviewId`: string. Unique identifier of the onboarding session.
- `token`: string. Token created for this onboarding session.

### Tracking events

When onboarding has started, tracking events can be obtained using `onEvents`.

```ts
IncodeSdk.onEvents((eventBatch) => {
  for (const event of eventBatch.events) {
    console.log(event.event, event.data);
  }
});
```

The listener receives:

- `events`: `EventDetails[]`. Array of emitted events.
- `event`: string. Unique identifier of the event.
- `data`: string. JSON string with additional event details.

As of React Native SDK 9.17.0, all Android event names use the SDK's camelCase value form (for example, `userCanceled`, `moduleOpened`), matching iOS, instead of the SDK enum constant name (for example, `USER_CANCELLED`, `MODULE_OPENED`) used before that version. Update any comparison, Dashboard query, saved report, or server-side rule that matches an old constant-name string. The `status` value returned by the flow promises is unchanged and stays `userCancelled`.

### Step completion

When a step in the configured onboarding flow is completed, register a listener via `IncodeSdk.onStepCompleted`. The listener config takes the module name and callback.

```ts
const unsubscribe = IncodeSdk.onStepCompleted({
  module: 'SelfieScan',
  listener: (event) => {
    console.log(event.result);
  },
});
```

Step completion events are delivered through `onStepCompleted()`. In-progress events are delivered through `onStepUpdated()`.

### Step error

When a module in the flow emits an error, register a listener via `IncodeSdk.onStepError`. The listener config takes the module name and callback.

```ts
const unsubscribe = IncodeSdk.onStepError({
  module: 'FaceMatch',
  listener: (event) => {
    console.log('FaceMatch error', event);
  },
});
```

`onStepError` currently fires for `Phone`, `DocumentScan`, `Signature`, `VideoSelfie`, `IdScan`, `Conference`, `SelfieScan`, `FaceMatch`, `QrScan`, and `UserScore`.

The event shape isn't fully consistent across modules: most report a flat `status` value, `QrScan` and `Conference` nest it inside a `result` object, and `IdScan` nests separate front/back status values.

### Step update

When a step in the configured flow is updated, register a listener via `IncodeSdk.onStepUpdated`. The listener config takes the module name and callback.

```ts
IncodeSdk.onStepUpdated({
  module: 'IdScanFront',
  listener: (event) => {
    console.log('ID Scan Front Attempt: ', event.result);
    console.log('ID Scan Front Attempt allAttemptsExhausted:', event.result.allAttemptsExhausted);
  },
});
```

`onStepUpdated` currently emits updates for `Conference`, `IdScanFront`, `IdScanBack`, and `SelfieScan`.

## Module callback payloads

### Aes

This module enables an advanced electronic signature to ensure legally binding and compliant document signing with enhanced security and authentication measures.

Example success response:

```json
{
  "status": "success",
  "step": "Aes"
}
```

The field `status` can have one of the following values: `success` or `fail`.

Example failure response:

```json
{
  "status": "fail",
  "error": "noDocuments",
  "step": "Aes"
}
```

### Antifraud

This module gives the ability to compare the current interview with existing interviews and customers to detect anomalies that could be signs of fraud.

Example success response:

```json
{
  "status": "success",
  "step": "Antifraud"
}
```

The field `status` can have one of the following values: `success` or `fail`.

### Approve

Adding this module to the flow instructs the Incode server to perform the approval of the user.

Example response:

```json
{
  "result": { "success": true, "uuid": "customerUUID", "customerToken": "customerToken", "error": null },
  "module": "Approve"
}
```

The `result` object is the same payload the [`approve`](#approve) method resolves. A `success` of `false` is a normal, expected outcome, not an error.

### Captcha

This module asks the user to enter a one-time password (OTP) generated for the current session. If the user enters an incorrect OTP too many times, the flow is terminated.

Example success response:

```json
{
  "result": {
    "status": "success",
    "response": "ABCDEF"
  }
}
```

The step completed event fires only when the CAPTCHA is verified. If it cannot be verified, the SDK ends the flow and the flow method rejects with `captchaNotVerified` on iOS and with `unknown` on Android. The Android SDK reports a generic error.

### CombinedConsent

This module asks the user for data sharing consent.

Example success response:

```json
{
  "status": "success",
  "step": "CombinedConsent"
}
```

The `status` field can be `success` or `fail`.

If the user declines to give data sharing consent, the onboarding flow rejects with `code: 'userCancelled'`.

### Conference

This module starts a video conference call.

Example success response:

```json
{
  "step": "Conference",
  "result": {
    "status": "success"
  }
}
```

Example failure response:

```json
{
  "step": "Conference",
  "result": {
    "status": "error"
  }
}
```

The `result.status` field can be `success`, `userCancelled`, `invalidSession`, or `error`.

### CurpValidation

This module asks the user to input their CURP information for validation with the RENAPO service. CURP is a personal identifier used in Mexico.

Example success response:

```json
{
  "result": {
    "curp": "123456789101112134",
    "valid": true,
    "data": { "success": true, "curp": "123456789101112134" },
    "status": "success",
    "resultCode": "success"
  },
  "module": "CurpValidation"
}
```

- `curp`: The validated, generated, or entered CURP. Omitted when the SDK has none.
- `valid`: Whether RENAPO accepted the CURP. Omitted when `validationEnabled` is `false`, because no server check ran.
- `data`: The server response for the CURP check, as an object. Its keys are server-defined. Omitted when there is no server response, meaning validation is disabled, or, on Android, the final request failed.
- `status`: `success` only when RENAPO accepted the CURP (`valid: true`). Otherwise `fail`, with `resultCode: "error"`. With `validationEnabled: false`, a captured CURP is `success`.
- `resultCode`: The finer outcome, populated on both platforms: `success` or `error`. A cancellation ends the flow through the start method's error, not through this event.

The module emits one event, on both platforms, when the user finishes the step. Workflows always validate the CURP, whatever the module configuration.

Example failure response (RENAPO rejected the CURP):

```json
{
  "result": {
    "curp": "123456789101112134",
    "valid": false,
    "data": { "success": false, "curp": "123456789101112134" },
    "status": "fail",
    "resultCode": "error"
  },
  "module": "CurpValidation"
}
```

Example response with `validationEnabled: false`:

```json
{
  "result": { "curp": "123456789101112134", "status": "success", "resultCode": "success" },
  "module": "CurpValidation"
}
```

### CustomWatchlist

This module checks whether the user appears on a custom watchlist configured in the Incode Dashboard.

Example success response:

```json
{
  "status": "success",
  "step": "CustomWatchlist"
}
```

The `status` field can be `success` or `fail`. `success` means a match was found on the watchlist, which typically warrants further review. `fail` means no match was found.

### DocumentScan

This module captures a document and attempts to read the address from it.

If the user skips this step, the response contains blank values rather than nil or an error.

Example success response:

```json
{
  "result": {
    "address": { // parsed OCR data
      "city": "Springfield",
      "colony": "Springfield",
      "postalCode": "555555",
      "state": "Serbia",
      "street": "Evergreen terrace"
    },
    "data": {"raw JSON OCR data"},
    "type": "addressStatement",
    "image": {"pngBase64": "/9j/4AAQSkZJRgABAQAAAQABAAD/4..."}
  },
  "step": "DocumentScan"
}
```

The `result` object includes:

- `address`: parsed OCR data from the document.
- `data`: iOS only. A JSON string containing document-specific data, when available. This field is currently untyped in the SDK. On Android, there is no top-level `data` field; medical-document data is nested under `insuranceCard` instead.
- `type`: the document type captured.
- `image`: the captured document image as a base64-encoded PNG.

Example failure response:

```json
{
  "status": "permissionsDenied",
  "step": "DocumentScan"
}
```

The `status` field can be `permissionsDenied`, `simulatorDetected`, or `unknown`.

### eKYB

This module validates a business identity using business information. Sources can include business name, addresses, city, state, postal code, and bank account number.

Example success response:

```json
{
  "status": "success",
  "step": "eKYB"
}
```

The `status` field can be `success` or `fail`.

### eKYC

This module validates a user identity using the user's information. Sources can include data obtained from an ID, proof of address, or manual capture.

Example success response:

```json
{
  "status": "success",
  "step": "eKYC"
}
```

The `status` field can be `success` or `fail`.

### Email

This module asks the user to enter their email address.

Example success response:

```json
{
  "result": { "email": "email@example.com", "status": "success", "resultCode": "success" },
  "step": "Email"
}
```

`status` is `success` or `fail` on both platforms. `resultCode` carries the finer outcome and is populated on both platforms too: both report `success` and `error`, and Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback. The captured value is omitted when the SDK has none — check for the key rather than comparing to an empty string.


Example failure response:

```json
{
  "result": { "status": "fail", "resultCode": "error" },
  "step": "Email"
}
```

The captured value is absent. The `status` field can be `success` or `fail`.

### FaceAuthentication

This module identifies a previously registered user using face recognition. It can be used to grant access to parts of your application or authorize high-value operations with low friction.

Example success response:

```json
{
  "result": {
    "status": "success",
    "customerUUID": "1234567890",
    "selfieBase64": "abcdefg",
    "selfieEncryptedBase64": "abcdefg",
    "error": null
  },
  "step": "FaceAuthentication"
}
```

The `result.status` field can be `success` or `fail`. `result.error` can be one of 21 values: `inactiveSession`, `nonexistentCustomer`, `lensesDetected`, `faceMaskDetected`, `headCoverDetected`, `closedEyesDetected`, `faceTooDark`, `spoofAttemptDetected`, `userIsNotRecognized`, `selfieImageLowQuality`, `hintNotProvided`, `faceNotFound`, `faceCroppingFailed`, `faceTooSmall`, `faceTooBlurry`, `badPhotoQuality`, `processingError`, `badRequest`, `deniedCameraPermissions`, `userCancelled`, or `unknown`.

### FaceMatch

This module checks whether the face from the scanned ID or passport and the face obtained from the SelfieScan module are a match.

Example success response:

```json
{
  "result": {
    "status": "match",
    "confidence": 1,
    "nameMatched": false,
    "existingUser": false,
    "existingInterviewId": "exampleInterviewID",
    "idCategory": "primary"
  },
  "step": "FaceMatch"
}
```

The `result.status` field can be `match` or `mismatch`. FaceMatch uses this same `result` structure for both matches and mismatches.

### FullName

This module asks the user to enter their name.

Example success response:

```json
{
  "result": { "name": "exampleName", "status": "success", "resultCode": "success" },
  "step": "FullName"
}
```

`status` is `success` or `fail` on both platforms. `resultCode` carries the finer outcome
and is populated on both platforms too: both report `success` and `error`, and Android
additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is
reported at the session level rather than through a module callback.
The captured value is omitted when the SDK has none — check for the key rather than
comparing to an empty string.

Example failure response:

```json
{
  "result": { "status": "fail", "resultCode": "error" },
  "step": "FullName"
}
```

The captured value is absent. The `status` field can be `success` or `fail`.

### Geolocation

This module captures the current location of the user.

Example success response:

```json
{
  "result": {
    "addressFields": {
      "street": "Evergreen Terrace 742",
      "colony": "Springfield",
      "postalCode": "555555",
      "city": "Springfield",
      "state": "United States"
    },
    "latitude": 44.0462,
    "longitude": -123.0220,
    "status": "success",
    "resultCode": "success"
  },
  "step": "Geolocation"
}
```

Example response when the user skipped the step or no location could be determined:

```json
{
  "result": { "status": "fail", "resultCode": "error", "error": "locationUnavailable" },
  "step": "Geolocation"
}
```

- `status` is `success` only when a location was fetched. A skipped, denied, or unavailable location is reported here as `fail`, and the flow continues. When `isSkippable` is `false`, the flow ends through `onError` instead. On Android, the `fail` result arrives first, and then `onError` fires.
- `error` is present only when `resultCode` is `error`. It can be `permissionsDenied`, `locationUnavailable`, `sslPinningFailed`, `integrityCompromised`, or `unknown`. On iOS, a skip in the current UI is always reported as `locationUnavailable`.
- `addressFields`, `latitude`, and `longitude` are absent when no location was fetched, and each address field is absent when the SDK has no value for it. On iOS, a location whose address could not be fully resolved is reported as `fail` with `locationUnavailable`, but still carries the partial `addressFields` and the coordinates.
- `state` holds the country name, and `city` falls back to the region when the city is unknown.
- `resultCode` can also be `userCancelled` on Android when the user backs out.

### GlobalWatchlist

This module checks customer identities against sources of sanctions, Politically Exposed Persons (PEPs), and watchlists.

Example success response:

```json
{
  "status": "success",
  "step": "GlobalWatchlist"
}
```

The `status` field can be `success` or `fail`. `success` means a match was found on the watchlist, which typically warrants further review. `fail` means no match was found.

### GovernmentValidation

This module asks the user to input their information for validation against government services.

Example success response:

```json
{
  "status": "success",
  "step": "GovernmentValidation"
}
```

The `status` field can be `success` or `fail`.

### IdScan

Adding `{ module: 'IdScan' }` to a `flowConfig` captures both sides of the ID in one combined module. On success, it fires two separate step completion events, `IdScanFront` and `IdScanBack`, rather than a single combined `IdScan` event. `onStepCompleted` does not accept `IdScan` as a `module` value; listen for `IdScanFront` and `IdScanBack` instead.

On error, `IdScan` fires one combined error event covering both sides, distinct from the individual front/back success statuses. Register it with `IncodeSdk.onStepError({ module: 'IdScan', listener })`:

```json
{
  "module": "IdScan",
  "status": {
    "front": "ok",
    "back": "errorGlare"
  },
  "data": {"raw JSON OCR data"}
}
```

`status.front` and `status.back` can each be `ok` or one of several values indicating a scanning issue. The Incode UI informs the user about these errors and attempts the scan several times before responding with an error. Other values: `errorClassification`, `noFacesFound`, `errorCropQuality`, `errorGlare`, `errorReadability`, `errorSharpness`, `errorTypeMismatch`, `userCancelled`, `unknownError`, `shadow`, `errorAddress`, `errorPassportClassification`.

### IdScanBack

Captures the back side of an ID document.

Example success response:

```json
{
  "result": {
    "status": "ok",
    "classifiedIdType": "Voter Identification",
    "chosenIdType": "id",
    "idCategory": "primary",
    "image": { "pngBase64": "..." },
    "croppedFace": { "pngBase64": "..." }
  },
  "step": "IdScanBack"
}
```

The `result` object includes:

- `image`: `IncdImage` object containing `pngBase64` of the captured back ID.
- `croppedFace`: `IncdImage` object containing `pngBase64` of the cropped face from the back ID.
- `classifiedIdType`: string. The ID type as classified by Incode, for example `Voter Identification`.
- `chosenIdType`: string. The ID type the user chose to capture: `id` or `passport`.
- `idCategory`: string. The ID category: `primary` or `secondary`.
- `status`: string. The scan outcome. When the value is anything other than `ok`, the scan or validation did not complete successfully. The Incode UI informs the user and retries several times before responding with an error. Possible non-success values: `errorClassification`, `noFacesFound`, `errorGlare`, `errorReadability`, `errorSharpness`, `errorTypeMismatch`, `userCancelled`, `unknownError`, `errorShadow`, `errorPassportClassification`.
- `failReason`: string (optional). The reason for the scan failure, if applicable.
- `issueName`: string (optional). The name of the issuing authority of the document.
- `issueYear`: number (optional). The year the document was issued.
- `countryCode`: string (optional). The country code of the document.
- `allAttemptsExhausted`: boolean (optional). Indicates whether all capture attempts have been exhausted.

### IdScanFront

Captures the front side of an ID document.

Example success response:

```json
{
  "result": {
    "status": "ok",
    "classifiedIdType": "Voter Identification",
    "chosenIdType": "id",
    "idCategory": "primary",
    "image": { "pngBase64": "..." },
    "croppedFace": { "pngBase64": "..." }
  },
  "step": "IdScanFront"
}
```

The `result` object includes:

- `image`: `IncdImage` object containing `pngBase64` of the captured front ID.
- `croppedFace`: `IncdImage` object containing `pngBase64` of the cropped face from the front ID.
- `classifiedIdType`: string. The ID type as classified by Incode, for example `Voter Identification`.
- `chosenIdType`: string. The ID type the user chose to capture: `id` or `passport`.
- `idCategory`: string. The ID category: `primary` or `secondary`.
- `status`: string. The scan outcome. When the value is anything other than `ok`, the scan or validation did not complete successfully. The Incode UI informs the user and retries several times before responding with an error. Possible non-success values: `errorClassification`, `noFacesFound`, `errorGlare`, `errorReadability`, `errorSharpness`, `errorTypeMismatch`, `userCancelled`, `unknownError`, `errorShadow`, `errorPassportClassification`.
- `failReason`: string (optional). The reason for the scan failure, if applicable.
- `issueName`: string (optional). The name of the issuing authority of the document.
- `issueYear`: number (optional). The year the document was issued.
- `countryCode`: string (optional). The country code of the document.
- `allAttemptsExhausted`: boolean (optional). Indicates whether all capture attempts have been used.

### MLConsent

This module asks the user for machine learning consent.

Example success response:

```json
{
  "status": "success",
  "step": "MLConsent"
}
```

The `status` field can be `success` or `fail`.

### NFCScan

This module reads and verifies chip data from ePassports or ID cards to validate document authenticity, detect tampering, and enhance anti-spoofing.

Example success response:

```json
{
  "result": {
    "status": "success",
    "birthDate": "900101",
    "compositeCheckDigit": "7",
    "dateOfBirthCheckDigit": "3",
    "documentCode": "TD3",
    "documentNumber": "123456789",
    "documentNumberCheckDigit": "5",
    "expirationDateCheckDigit": "2",
    "expireAt": "300101",
    "gender": "M",
    "issuingStateOrOrganization": "USA",
    "nationality": "USA",
    "optionalData1": "ABCDEFGHI",
    "optionalData2": null,
    "personalNumber": "987654321",
    "personalNumberCheckDigit": "4",
    "primaryIdentifier": "DOE",
    "secondaryIdentifier": "JOHN MICHAEL"
  },
  "step": "NFCScan"
}
```

The `result.status` field can be `success` or `fail`.

Date fields such as `birthDate` and `expireAt` use `YYMMDD` format on Android. On iOS, they are returned as a native-formatted date string. All other fields are plain strings.

### OCREdit

This module shows the user the parsed OCR data from their ID, which they can optionally edit.

Example success response:

```json
{
  "status": "success",
  "step": "OCREdit"
}
```

The `status` field can be `success` or `fail`.

### Phone

This module asks the user to enter their phone number.

Example success response:

```json
{
  "result": { "phone": "+15555555555", "status": "success", "resultCode": "success" },
  "step": "Phone"
}
```

`status` is `success` or `fail` on both platforms. `resultCode` carries the finer outcome and is populated on both platforms too: both report `success` and `error`, and Android additionally reports `userCancelled` and `emulatorDetected`, since on iOS a cancellation is reported at the session level rather than through a module callback.
The captured value is omitted when the SDK has none — check for the key rather than comparing to an empty string.


Example failure response:

```json
{
  "result": { "status": "fail", "resultCode": "error" },
  "step": "Phone"
}
```

The captured value is absent. The `status` field can be `success` or `fail`.

### ProcessId

Processes the ID after the front and back captures. ProcessId does not have its own status or failure result; success or failure comes from the separate `IdScanFront` and `IdScanBack` events.

Example success response:

```json
{
  "result": {
    "data": {
      "fullAddress": "123 Evergreen Terrace, Springfield",
      "address": {
        "city": "Springfield",
        "colony": "Springfield",
        "postalCode": "555555",
        "state": "Serbia",
        "street": "Evergreen Terrace"
      },
      "birthDate": 631152000,
      "expirationDate": "300101",
      "gender": "M",
      "name": "JOHN DOE",
      "issueDate": "200101",
      "numeroEmisionCredencial": "01"
    },
    "extendedOcrData": "{...}"
  },
  "step": "ProcessId"
}
```

The `result` object includes:

- `data`: the `IdScanOcrData` object containing the parsed OCR data. Confirmed identical on iOS and Android:
  - `fullAddress`
  - `address`: nested object with `city`, `colony`, `postalCode`, `state`, `street`
  - `birthDate`
  - `expirationDate`
  - `gender`
  - `name`
  - `issueDate`
  - `numeroEmisionCredencial`
- `extendedOcrData`: string. Raw JSON containing the full OCR data, for example `exteriorNumber`, `interiorNumber`, `typeOfId`, `documentFrontSubtype`.

Notes:

- `result.data.birthDate` is in epoch time.

### QrScan

This module captures the QR code on the back of the ID, extracts the data from it, and sends it to the server.

Example success response:

```json
{
  "result": { "idCic": "exampleIdCic" },
  "step": "QrScan"
}
```

The `result` object contains a single field, `idCic` (a string). QrScan does not return a `status`.

### SelfieScan

This module captures a selfie from the user.

Example success response:

```json
{
  "result": { "spoofAttempt": false, "status": "success", "allAttemptsExhausted": false },
  "step": "SelfieScan",
  "image": {
    "pngBase64": "...PNG Base 64 encoded",
    "encryptedBase64": "...PNG Encrypted Base 64 encoded"
  }
}
```

The response includes:

- `result.spoofAttempt`: boolean. Indicates whether a spoof attempt was detected.
- `result.status`: string. The capture outcome.
- `result.allAttemptsExhausted`: boolean (optional). Indicates whether all capture attempts have been exhausted.
- `image.pngBase64`: the captured selfie as a base64-encoded PNG.
- `image.encryptedBase64`: the captured selfie as an encrypted base64-encoded PNG.

Example failure response:

```json
{
  "status": "permissionsDenied",
  "step": "SelfieScan"
}
```

The `status` field can be `none`, `permissionsDenied`, `simulatorDetected`, or `spoofDetected`.

### Signature

This module asks the user to add a digital signature by signing on a canvas.

Example success response:

```json
{
  "result": { "status": "success", "image": "...PNG Base 64 encoded" },
  "step": "Signature"
}
```

Example failure response:

```json
{ "status": "error", "step": "Signature" }
```

The `status` field can be `error` or `invalidSession`.

### UserConsent

This module asks the user to give consent.

Example success response:

```json
{
  "status": "success",
  "step": "UserConsent"
}
```

If the user declines to give consent, the onboarding flow rejects with `code: 'userCancelled'`.

### UserScore

This module displays the user score to the user.

Example success response:

```json
{
  "result": {
    "data": {
      "existingUser": true,
      "facialRecognitionScore": "0.0/100",
      "idVerificationScore": "79.0/100",
      "livenessOverallScore": "95.2/100",
      "overallScore": "0.0/100",
      "status": "fail"
    },
    "extendedUserScoreJsonData": "{..}"
  },
  "step": "UserScore"
}
```

The `result` object includes:

- `data`: the parsed user score data.
- `extendedUserScoreJsonData`: a raw JSON string containing the full user score data.

The `result.data.status` field can be `ok`, `warn`, `unknown`, `manual`, or `fail`.

### VideoSelfie

This module records the device's screen while the user takes a selfie, presents their ID, answers a series of questions, and accepts the terms and conditions. The recorded video is then uploaded and stored for later use.

On module completion, the result given to the listener will take the shape of:

```json
{
  "result": {
    "status": true
  }
}
```

`status` is a boolean, `true` when the video selfie was recorded and uploaded successfully.

---

- Path: `sdk-reference/react-native-run-flows-configured-online`
- URL: https://developer.incode.com/sdk-reference/react-native-run-flows-configured-online/
- Markdown: https://developer.incode.com/sdk-reference/react-native-run-flows-configured-online.md

# Run Flows Configured Online

Use this path when the module order and settings live on the Incode Dashboard rather than in your app. Instead of defining a `flowConfig` array locally, you reference a Workflow or Flow by ID and the SDK runs the modules and configuration applied to it on the Dashboard. This lets you change the configuration without shipping a new app build.

Workflows and Flows are different Dashboard artifacts, and the method you call depends on which one your configuration is: `startWorkflow()` requires a Workflow's `configurationId`, `startFlow()` requires a Flow's `configurationId`.

:::info
Before you start, make sure the SDK is installed and initialized. See [Getting Started](/sdk-reference/react-native-getting-started/) for setup and initialization.
:::

For the modules a Workflow or Flow can include, see [Modules](/sdk-reference/react-native-modules/). For the result and error objects delivered to listeners, see [Results](/sdk-reference/react-native-results/).

## Register step listeners

If you want to react to individual modules as they complete, register listeners before starting the session. If you only need the final outcome, you can rely on the value returned by the start call and skip this step.

```ts
const unsubscribers = [
  IncodeSdk.onSessionCreated((session) => {
    console.log(session.interviewId);
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanFront',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'IdScanBack',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'ProcessId',
    listener: (event) => console.log(event.result.extendedOcrData),
  }),
  IncodeSdk.onStepCompleted({
    module: 'SelfieScan',
    listener: (event) => console.log(event.result),
  }),
  IncodeSdk.onStepCompleted({
    module: 'FaceMatch',
    listener: (event) => console.log(event.result),
  }),
];
```

Call each unsubscriber when the screen unmounts:

```ts
React.useEffect(() => {
  const unsubscribers = setupListeners();

  return () => {
    unsubscribers.forEach((unsubscriber) => unsubscriber());
  };
}, []);
```

Because the modules are defined on the Dashboard, the listeners you register here should correspond to the modules included in the Workflow or Flow. For the shape and fields of each result object passed to these listeners, see [Results](/sdk-reference/react-native-results/).

## Configure the session

Build a `sessionConfig` with the `configurationId` of the Workflow or Flow to run. Ensure the Workflow or Flow is activated on the Dashboard before starting the session.

Useful `sessionConfig` fields for Dashboard-configured sessions include:

| Field                               | Use                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `configurationId`                   | The Workflow or Flow ID from the Dashboard. The modules and configuration applied to it are used for this session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `externalId` / `externalCustomerId` | Link the Incode session to your own user/customer ID. With `externalId`, if a session with the same ID already exists and the previous session was interrupted, that session is resumed instead of a new one being created. With `externalCustomerId`, a new session is always created even if one with the same ID already exists. |
| `interviewId` / `token`             | Start from a backend-created session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `queue`                             | Assign the session to a queue.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `validationModules`                 | Select server-side validation modules.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `customFields`                      | Attach custom string data to the session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `e2eEncryptionEnabled`              | Enable E2EE for the session. See [End-to-End Encryption](/sdk-reference/react-native-e2ee/) for the full setup.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `mergeSessionRecordings`            | Merge recordings from ID capture and Face capture into a single video.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `voiceConsentLanguage`              | Set `VideoSelfie` voice consent language: `en`, `es`, `pt`, or `he`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

Example:

```ts
const sessionConfig = {
  configurationId: 'YOUR_CONFIGURATION_ID',
  externalId: 'external-id',
};
```

## Start the session

The React Native SDK provides separate entry points for running a Workflow versus a Flow:

| Entry point               | Use when                                                                                                                  |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `startWorkflow()`         | Running a Workflow configured on the Dashboard.                                                                           |
| `startFlow()`             | Running a Flow configured on the Dashboard. Optionally start from a specific step using `moduleId`.                       |
| `startFlowFromDeepLink()` | Resuming a Flow from a deep link URL. The SDK reads the `configurationId`, `interviewId`, and starting step from the URL. |

If you're not sure whether your Dashboard configuration is a Workflow or a Flow, check under **Flow Builder > Flows** or **Flow Builder > Workflows** on the Dashboard.

#### Run a Workflow

```ts
const result = await IncodeSdk.startWorkflow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
  },
});
```

#### Run a Flow

```ts
const result = await IncodeSdk.startFlow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
    externalId: 'external-id',
  },
});
```

Start from a specific module by passing `moduleId`:

```ts
await IncodeSdk.startFlow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
  },
  moduleId: 'EMAIL',
});

await IncodeSdk.startFlow({
  sessionConfig: {
    configurationId: 'YOUR_CONFIGURATION_ID',
  },
  moduleId: 'PHONE',
});
```

For the full list of valid `moduleId` values, see the [API Reference](/sdk-reference/react-native-api-reference/#valid-moduleid-values).

#### Resume a Flow from a deep link

Use `startFlowFromDeepLink()` to resume a Flow from a deep link URL. Deep links work for Flows only, not Workflows:

```ts
const result = await IncodeSdk.startFlowFromDeepLink('YOUR_DEEPLINK_URL');
```

The deep link URL follows this format: `https://[host]/[path]/[flowId]?interviewId=[interviewId]&module=[module]`, where:

- `flowId` (required, path segment): the Flow's configuration ID.
- `interviewId` (optional, query parameter): the ID of the interview session to resume.
- `module` (optional, query parameter): the module to start from.

If your app receives a shortened URL, pass `true` as the second argument:

```ts
const result = await IncodeSdk.startFlowFromDeepLink('YOUR_DEEPLINK_URL', true);
```

Deep links are typically generated by your backend or the Incode Dashboard.

## Related pages

- [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/): choose the integration pattern that fits your app.
- [Configure Flows Locally and Run End to End](/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end/): define the full flow in code instead of on the Dashboard.
- [Configure Flows Locally and Run Step by Step](/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step/): split a locally configured flow into sections.
- [Modules](/sdk-reference/react-native-modules/): the modules a Workflow or Flow can include.
- [Results](/sdk-reference/react-native-results/): result and error objects returned by listeners and start calls.
- [API Reference](/sdk-reference/react-native-api-reference/): full API specification.

---

- Path: `sdk-reference/react-native-sdk`
- URL: https://developer.incode.com/sdk-reference/react-native-sdk/
- Markdown: https://developer.incode.com/sdk-reference/react-native-sdk.md

# Incode React Native SDK reference

Orientation and routing hub for the Incode React Native SDK - identity capture, liveness, NFC, face authentication, dashboard flows, and native UI modules for Android and iOS.

The Incode React Native SDK exposes Incode's native onboarding SDKs through a typed JavaScript API. Apps initialize `IncodeSdk`, configure a dashboard flow or local `flowConfig`, subscribe to step events, and then launch native UI for ID capture, selfie, face match, NFC, consent, scoring, approval, and other verification modules.

This page routes you to the page you need next. If you are starting fresh, begin with [Getting Started](/sdk-reference/react-native-getting-started/) and [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/).

## Start here

| If you want to...                 | Go to                                                               |
|-----------------------------------|---------------------------------------------------------------------|
| Add the SDK to your project       | [Getting Started](/sdk-reference/react-native-getting-started/)                               |
| Get an onboarding flow running    | [Common Implementation Patterns](/sdk-reference/react-native-common-implementation-patterns/) |
| Authenticate a returning user with their face | [Face Login](/sdk-reference/react-native-face-login/)                             |
| Upgrade an existing integration   | [Migration Guide](/release-notes/rn-migration-guide/)                           |
| Check the available modules       | [Modules](/sdk-reference/react-native-modules/)                                               |
| Check module results          | [Results](/sdk-reference/react-native-results/)                                               |
| Customize colors, text, and UI    | [Customization](/sdk-reference/react-native-customization/)                                   |
| Browse the full public API        | [API Reference](/sdk-reference/react-native-api-reference/)                                   |
| Solve a build problem             | [Troubleshooting](/sdk-reference/react-native-troubleshooting/)  |
| Check for known issues            | [Known Issues](/sdk-reference/react-native-known-issues/)                                     |

## How the SDK fits together

The SDK supports three integration paths. They differ in where the flow is configured and how much orchestration your app owns.

### Path 1: Online flow
Build a flow or workflow on the Incode Dashboard, pass its `configurationId` through `sessionConfig`, and call the corresponding start method (`startWorkflow()` for Workflows, `startFlow()` for Flows). The SDK owns the native UI from the first screen to the last and returns progress through listeners.

See [Run Flows Configured Online](/sdk-reference/react-native-run-flows-configured-online/).

### Path 2: Local full onboarding flow
Build a local `flowConfig` array with modules such as `IdScan`, `SelfieScan`, and `FaceMatch`, then pass it to `startOnboarding()`. The SDK runs the configured modules in order and returns the final flow status.

See [Configure Flows Locally and Run End to End](/sdk-reference/react-native-configure-flows-locally-and-run-end-to-end/).

### Path 3: Section-by-section flow
Create a session with `setupOnboardingSession()`, run one or more `startOnboardingSection()` calls, and close the session with `finishOnboardingFlow()`. Use this when your app needs to show custom screens or business logic between Incode modules. You can start multiple sections, but only one at a time; `startOnboardingSection` accepts the same config and modules as `startOnboarding`.

See [Configure Flows Locally and Run Step by Step](/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step/).

## Variants

Install the package variant that matches the features you need.

| Variant | Package Version Suffix | Description |
|---------|------------------------|-------------|
| Standard | none | Base SDK package. |
| Streaming | `-vc` | Enables streaming camera frames during ID and Selfie capture. |
| Face Login | `-l` | Adds Face Login APIs. |
| NFC | `-nfc` | Adds NFC scanning for passports or supported ID chips. |

For more information, see [Installation](/sdk-reference/react-native-installation/#sdk-variants).

## What the SDK can do

- **Identity capture** - ID scan, document capture, OCR extraction, and manual review screens.
- **Liveness and biometrics** - selfie, video selfie, face match, face authentication, and [Face Login](/sdk-reference/react-native-face-login/).
- **NFC / e-passport** - read and validate supported NFC chip data.
- **Compliance steps** - consent, government validation, watchlists, AES, user score, and approval.
- **Customization** - theming, localization, close-button behavior, UX config, and dynamic strings.

## Need help?

- Hit a build error? See [Troubleshooting](/sdk-reference/react-native-troubleshooting/).
- Hit a runtime limitation? See [Known Issues](/sdk-reference/react-native-known-issues/).
- Looking for a method or parameter? See [API Reference](/sdk-reference/react-native-api-reference/).
- Looking for a module payload? See [Results](/sdk-reference/react-native-results/).
- Still stuck? Contact your Incode representative or email [help@incode.com](mailto:help@incode.com).

---

- Path: `sdk-reference/react-native-sdk-modes`
- URL: https://developer.incode.com/sdk-reference/react-native-sdk-modes/
- Markdown: https://developer.incode.com/sdk-reference/react-native-sdk-modes.md

# SDK Modes

The SDK can operate in one of three modes. The mode controls how the SDK captures and processes data. The mode is set at initialization with the `sdkMode` parameter, and can be changed at runtime with `setSdkMode()`.

| Mode | Description |
|------|-------------|
| `standard` | Default capture and validation behavior. |
| `captureOnly` | Offline capture mode. For ID and Selfie scan, only captures images without validations. |
| `submitOnly` | Submit previously captured data without performing new capture steps. |

## Set the mode at initialization

```ts
await IncodeSdk.initialize({
  testMode: false,
  sdkMode: 'standard',
  apiConfig: {
    key: 'YOUR_API_KEY',
    url: 'YOUR_API_URL',
  },
});
```

If `sdkMode` is omitted, the SDK defaults to `standard`.

## Change the mode after initialization

```ts
await IncodeSdk.setSdkMode('captureOnly');
```

---

- Path: `sdk-reference/react-native-token-based-setup`
- URL: https://developer.incode.com/sdk-reference/react-native-token-based-setup/
- Markdown: https://developer.incode.com/sdk-reference/react-native-token-based-setup.md

# Token-Based Setup

By default, the React Native SDK initializes with an API key. If your back end creates onboarding sessions and provides session tokens to your app, you can initialize the SDK without an API key and use the Sections API to run the flow.

<Component slug="sdk-token-based-setup" />

This setup is useful when your back end manages session creation, you want to avoid embedding an API key in your app, or you need session tokens that are scoped to individual users.

## Initialize without an API key

Omit the `key` field from `apiConfig`:

```ts
try {
  await IncodeSdk.initialize({
    testMode: false,
    apiConfig: {
      url: 'YOUR_API_URL',
    },
  });
} catch (error) {
  const e = error as IncodeSdkInitError;
  console.error(`${e.code} - ${e.message}`);
}
```

## Set up the session with a token

Pass the backend-created token to `setupOnboardingSession`:

```ts
const session = await IncodeSdk.setupOnboardingSession({
  sessionConfig: {
    token: 'YOUR_TOKEN',
  },
});
```

## Run the flow with sections

After the session is set up, use the Sections API to run the flow. Call `startOnboardingSection()` for each section, then `finishOnboardingFlow()` when all sections are complete:

```ts
await IncodeSdk.startOnboardingSection({
  flowConfig: [
    { module: 'IdScan', showTutorial: false },
    { module: 'SelfieScan', showTutorial: false },
  ],
  sectionTag: 'idAndSelfie',
});

await IncodeSdk.faceMatch();

await IncodeSdk.finishOnboardingFlow();
```

For the full Sections API walkthrough, see [Configure Flows Locally and Run Step by Step](/sdk-reference/react-native-configure-flows-locally-and-run-step-by-step/).

---

- Path: `sdk-reference/react-native-troubleshooting`
- URL: https://developer.incode.com/sdk-reference/react-native-troubleshooting/
- Markdown: https://developer.incode.com/sdk-reference/react-native-troubleshooting.md

# Troubleshooting

This page covers common problems you may encounter while building or running the React Native SDK, and where to look for the fix. For setup instructions, see [Installation](/sdk-reference/react-native-installation/). For known runtime limitations of the SDK itself, see [Known Issues](/sdk-reference/react-native-known-issues/).

## `npm install` fails with `E404` for the Incode package

NPM returns `404 Not Found` instead of a permission error when you request a private package your account cannot see, so a missing, expired, or unauthorized token looks like a package that does not exist:

```text
npm error code E404
npm error 404 Not Found - GET https://registry.npmjs.org/@incode-sdks%2freact-native-incode-sdk
```

Verify:

- You accepted the invitation to the Incode React Native team within 7 days of receiving it. If it expired, ask your Incode representative to resend it.
- An `.npmrc` file in your project root sets `//registry.npmjs.org/:_authToken`.
- The token is exported in the shell you run the install from, if your `.npmrc` uses `${NPM_TOKEN}` expansion.
- The token has not expired and grants read access to the `@incode-sdks` scope.
- On Yarn Berry (2.x and newer), the scope is configured in `.yarnrc.yml`. Yarn Berry ignores `.npmrc`.

Run `npm whoami --registry=https://registry.npmjs.org/` to confirm the token authenticates. For the full NPM setup, see [Installation](/sdk-reference/react-native-installation/#add-an-npmrc-file-to-your-project).

## Android build fails resolving Incode dependencies

Android builds need access to Incode GitHub Packages artifacts. If Gradle cannot resolve Incode dependencies, verify:

- The Incode Maven repository is declared in your project `build.gradle`.
- `GITHUB_USERNAME` and `GITHUB_TOKEN` are set.
- The token or equivalent credential has `read:packages` scope for the `android-omni-packages` registry.

For the full Android setup, see [Installation](/sdk-reference/react-native-installation/#android-setup). If credentials are correct and the error persists, contact your Incode representative.

## iOS `pod install` fails on the Incode podspec source

If `pod install` fails when resolving the Incode podspec source, GitHub authentication is likely not configured on your machine.

The Incode podspec source is hosted on GitHub and requires authenticated access. Configure SSH or HTTPS GitHub authentication before running `pod install`.

For the full iOS setup, see [Installation](/sdk-reference/react-native-installation/#ios-setup).

## `setLocalizationLanguage`, `setString`, and `setQuantityStrings` fail at runtime on Android

These methods require the Android extensions dependency. If the dependency is missing, the calls fail at runtime.

Add the dependency to your app-level `build.gradle`:

```gradle
implementation 'com.incode.sdk:extensions:1.2.1'
```
For details on customization methods, see [Customization](/sdk-reference/react-native-customization/).

## `streamFrames` has no effect

The `streamFrames` parameter on `IdScan`, `IdScanFront`, `IdScanBack`, and `SelfieScan` requires:

- The `-vc` SDK package variant (see [SDK variants](/sdk-reference/react-native-installation/#sdk-variants) on Installation).
- The Android video-streaming dependency:

```gradle
implementation 'com.incode.sdk:video-streaming:1.5.5'
```
If either is missing, `streamFrames` has no effect.

---

- Path: `sdk-reference/reference`
- URL: https://developer.incode.com/sdk-reference/reference/
- Markdown: https://developer.incode.com/sdk-reference/reference.md

# Reference


<Component slug="web-2-x-implementation-warning" />

Lookup material for the Incode Web SDK 2. Use these pages when you need to confirm an API signature, check a type definition, or diagnose a problem in your integration.

- [Web SDK 2.0 API Reference](/sdk-reference/web-sdk-2-reference): Full reference for the SDK's public methods, parameters, and return values.
- [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types): Type definitions for use in TypeScript projects.
- [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting): Common issues, error messages, and how to resolve them.

---

- Path: `sdk-reference/sdk-reference`
- URL: https://developer.incode.com/sdk-reference/
- Markdown: https://developer.incode.com/sdk-reference.md

# SDK Reference

The SDK Reference documents the API surface of each Incode SDK — method signatures, parameter definitions, session configuration, result schemas, and runtime methods. This is reference material for developers who are already integrated and need to look something up, or who want deeper technical detail beyond what's covered in the integration guides.

For first-time setup and integration walkthroughs, see [Integrate by Platform](/integrate-by-platform/). For module behavior and per-module configuration parameters, see the Module Configuration Reference below.

## In this section

* [**Web SDK Reference**](/sdk-reference/web-sdk-reference): JavaScript API for the Incode Web SDK: `create`, `initialize`, `renderCaptureId`, `renderCaptureFace`, `renderCamera`, and all other methods.
* [**iOS SDK Reference**](/sdk-reference/ios-sdk/): `IncdOnboardingManager` API: initialization, session configuration, `startOnboarding`, `startWorkflow`, delegate protocol, and result types.
* [**Android SDK Reference**](/sdk-reference/android-sdk/): `OnboardingSessionConfiguration` parameters and `OnboardingListener` callback methods.
* [**React Native SDK Reference**](/sdk-reference/react-native-sdk/): `IncodeSdk` JavaScript API: `initialize`, `startOnboarding`, `startFlow`, `startWorkflow`, flow listeners, runtime methods, Sections API, and result schemas.
* [**Flutter SDK Reference**](/sdk-reference/flutter-sdk/): Dart wrapper API: `IncodeOnboardingSdk.init`, `startOnboarding`, and session configuration.
* [**Cordova SDK Reference**](/sdk-reference/cordova-sdk/): JavaScript plugin API: `IncodeSdk.initialize`, `startOnboarding`, and session configuration.
* [**Xamarin SDK Reference**](/sdk-reference/xamarin-sdk/): C# wrapper API: `IncodeOnboarding.Initialize`, `StartOnboarding`, and session configuration.

## What belongs here vs. elsewhere

This section covers **API-level reference material only** — method signatures, parameters, return values, and result schemas. It does not cover:

* **Module-level feature guides** (NFC, AES, Face Login, eKYC, eKYB, etc.) → [Features & Modules](/features-and-modules/features-and-modules/)
* **Theming and customization** → [Design & UX](/design-and-ux/design-and-experience/)
* **Platform release notes and migration guides** → [Release Notes](/release-notes/incode-releases/)

<br />

---

- Path: `sdk-reference/setup-ios`
- URL: https://developer.incode.com/sdk-reference/setup-ios/
- Markdown: https://developer.incode.com/sdk-reference/setup-ios.md

# Installation

This page covers everything you need to add the Incode iOS SDK to your project. It covers build requirements, variant versioning, distribution channels, On-Demand Resources, required permissions, NFC entitlements, the privacy manifest, initializing the SDK, and enabling test mode.


## Build Requirements

Ensure your build environment meets the following minimum requirements:

- **iOS deployment target**: 13.0.
- **Swift language mode**: 5.0 (`SWIFT_VERSION = 5.0`).
- **Xcode**: 15.0 or higher.
- **Swift Package Manager**: If used, SSH/Git credentials configured for authentication to the distribution repo.
- **CocoaPods**: 1.15+, if you're installing via CocoaPods. You must also have SSH access to the private specs repository.

Also, ensure your devices meet the [device requirements](/sdk-reference/ios-sdk/#device-requirements). Then complete the following steps in order.


## Format a Variant Version

The Incode iOS SDK ships in [build variants](/sdk-reference/ios-sdk/#distribution-and-variants). A variant is a linking type plus a set of optional features. Not every module is compiled into every variant, and calling an API for a feature that is not included triggers a runtime variant assertion. Pin the **exact variant version**; there is no Bill of Materials. Choose the smallest variant that includes the features your flow needs to keep binary size down.

`MAJOR.MINOR.PATCH-LinkingType[-Feature…]`

- `LinkingType` is `d` (dynamic, default) or `s` (static).
- Features are appended as suffixes: `vc`, `l`, `m`, `nfc`, `ra`, `sna`.

Examples: `5.51.0-d` (dynamic), `5.51.0-d-l` (dynamic + login), `5.51.0-s` (static).

## Choose a Distribution Channel

The Incode iOS SDK is distributed as `IncdOnboarding.xcframework` through three channels: Swift Package Manager, CocoaPods, or a manual binary. Pick the channel that matches your project's dependency management setup. Use the exact [variant version string](#format-a-variant-version) for whichever method you choose.

### Install via Swift Package Manager

Add the distribution package and pin the exact variant version:

`https://github.com/Incode-Technologies-Example-Repos/IncdOnboarding-distribution.git`

1. In Xcode, go to **File** > **Add Package Dependencies**.
2. Paste the URL above.
3. Select the version matching your variant: for example, `5.51.0-d`.

### Install via CocoaPods

The pods are published to a private specs repo. Reference both the specs source and the pod with the variant version.

1. Add the specs source and the pod to your `Podfile`:
   ```ruby
   source 'git@github.com:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
   source 'https://cdn.cocoapods.org/'

   target 'YourApp' do
     use_frameworks!
     pod 'IncdOnboarding', '5.51.0-d'
   end
   ```

2. Run:
   ```sh
   pod install
   ```

### Embed the Binary Manually

1. Download `IncdOnboarding.xcframework` for your variant.
2. Drag it into your target. Set the **_dynamic_** variant to _Embed & Sign_; set the **_static_** variant to _Do Not Embed_. Any additional frameworks that ship with the distribution (for example `opencv2.framework`) should be set to _Do Not Embed_.
3. For video variants (`-vc`), also add the required `OpenTok` dependency at the version pinned for your SDK release, and set `OpenTok.framework` to _Do Not Embed_. Verify the exact OpenTok version for the release you integrate.
4. Add the following to your target's **Other Linker Flags**:
   ```text
   -l "stdc++" -l "iconv" -l "z" -framework "VideoToolbox"
   ```

### Troubleshooting installation

- **CocoaPods, static variant**: add the framework slices to the **Import Paths** build setting, for example `"$(SRCROOT)/Pods/IncdOnboarding/IncdOnboarding.xcframework/ios-arm64"` and `"$(SRCROOT)/Pods/IncdOnboarding/IncdOnboarding.xcframework/ios-x86_64-simulator"`.
- **CocoaPods, video variants (`-vc`)**: CocoaPods can link `OpenTok` twice, causing a duplicate-interface error at runtime. Add a post-install script to your `Podfile` to strip the duplicate `-framework OpenTok` flag, or remove it from the generated pods `.xcconfig` after each `pod install`.
- **Apple Silicon Macs**: if `pod install` fails, install `ffi` and run under Rosetta:
  ```sh
  sudo arch -x86_64 gem install ffi
  arch -x86_64 pod install
  ```
- **Static variant `EXC_BAD_ACCESS` or duplicate OpenCV symbols**: another dependency in your project is also importing OpenCV. Switch to the dynamic variant, or integrate a single shared OpenCV framework manually. Known conflicting dependencies include PayPal and card.io.


## Manage On-Demand Resources (ODR)

The static variant can download its ML resources at runtime instead of bundling them, reducing app size. ODR requires the static variant; the dynamic variant bundles resources in the framework.

Before the runtime download works, enable ODR for your app target:

- **CocoaPods**: use the `ODR` subspec instead of the base pod:
  ```ruby
  pod 'IncdOnboarding/ODR', '5.51.0-s'
  ```
- **Manual**: set the **_Enable On Demand Resources_** (`ENABLE_ON_DEMAND_RESOURCES`) build setting to _Yes_, then select the `IncdOnboarding.bundle` file and tag it with `IncdOmniResources` in the File Inspector's **_On Demand Resource Tags_** field.

You must download the resources before calling any onboarding method. Calling one first returns an `IncdError.resourcesNotFound` error. If you build through a CI or distribution platform, review the **_Embed Asset Packs In Product Bundle_** (`EMBED_ASSET_PACKS_IN_PRODUCT_BUNDLE`) build setting. For App Store production, Apple hosts the tagged resources and serves them from its CDN after you upload the app.

1. Check whether resources are already available:
   ```swift
   let manager = IncdOnboardingManager.shared

   manager.checkOnDemandResourcesAvailablity { available in
       guard !available else { return }
           // proceed to download below
   }
   ```
   The "Availablity" spelling is the real, shipping method name.

2. Download the resources if they're not available:
   ```swift
       manager.downloadOnDemandResources(
           showUI: true,
           vc: self, // required when showUI is true, otherwise the download UI is not shown
           onProgress: { progress in /* 0.0…1.0 */ },
           onCompleted: { /* ready */ },
           onError: { error in /* handle */ }
       )
   ```
   `downloadOnDemandResources` parameters:
   | Parameter     | Type                  | Default | Notes                                                                           |
   | ------------- | --------------------- | ------- | ------------------------------------------------------------------------------- |
   | `showUI`      | `Bool?`               | `nil`   | Show the built-in downloading UI. When `true`, `vc` must also be set.           |
   | `vc`          | `UIViewController?`   | `nil`   | Parent view controller for the downloading UI. Only used if `showUI` is `true`. |
   | `onProgress`  | `((Double) -> Void)?` | `nil`   | Called as progress changes, from `0.0` to `1.0`.                                |
   | `onCompleted` | `(() -> Void)?`       | `nil`   | Called when the download completes or resources are already present.            |
   | `onError`     | `((Error) -> Void)?`  | `nil`   | Called when an error occurs.                                                    |

3. Free disk space when you're done with the resources:
   ```swift
   manager.removeOnDemandResources()
   ```


## Add Required Permissions

Add the following usage-description keys to your `Info.plist` for the modules your flow uses. iOS rejects the app at runtime and in App Review if a capability is used without its key.

| Key                                   | Required For                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NSCameraUsageDescription`            | [ID Capture](/sdk-reference/module-id-scan/), [Selfie](/sdk-reference/module-selfie/), [Face Authentication](/sdk-reference/module-face-authentication/), [QR Scan](/sdk-reference/module-qr-scan/), [Video Conference](/sdk-reference/module-conference/), and [Video Selfie](/sdk-reference/module-video-selfie/) |
| `NSMicrophoneUsageDescription`        | [Video Conference](/sdk-reference/module-conference/); [Video Selfie](/sdk-reference/module-video-selfie/) when audio or voice consent is enabled                                                                                                                                                                                                                                                                                                   |
| `NSLocationWhenInUseUsageDescription` | [Geolocation](/sdk-reference/module-geolocation/)                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `NFCReaderUsageDescription`           | [NFC](/sdk-reference/module-nfc-scan/)                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `NSPhotoLibraryAddUsageDescription`   | Saving captured images to the photo library                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

Example:

```xml
<key>NSCameraUsageDescription</key>
<string>We use the camera to capture your ID and a selfie for identity verification.</string>
<key>NSMicrophoneUsageDescription</key>
<string>We use the microphone to record your voice consent.</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>We use your location to verify your address.</string>
```

Provide your own wording. These strings are shown in the system permission prompt.


## URL Schemes

Add these URL schemes to `LSApplicationQueriesSchemes` in your app's `Info.plist`:

```xml
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>cydia</string>
  <string>undecimus</string>
  <string>sileo</string>
  <string>zbra</string>
  <string>filza</string>
  <string>activator</string>
  <string>installer</string>
  <string>saily</string>
  <string>xina</string>
  <string>dopamine</string>
</array>
```

If your app already declares `LSApplicationQueriesSchemes`, keep the existing array and add only the entries from this list that are missing from it. Keep the combined list within Apple's limit:
- 50 entries when linked with iOS 15–26.
- 25 entries when linked with iOS 27 and later.

See [Apple's query requirements](https://developer.apple.com/documentation/uikit/uiapplication/canopenurl(_:)).


## Enable NFC Entitlements (`-nfc` variant only)

For NFC reading, enable the **Near Field Communication Tag Reading** capability and declare the ISO 7816 application identifiers the SDK reads. For example:

```
A0000002471001
A0000002472001
00000000000000
```

The NFC module reads e-passport chips using AES/3DES (DESede) secure messaging; see [Security](/sdk-reference/ios-security/#nfc).


## Ship the Privacy Manifest (`PrivacyInfo.xcprivacy`)

The SDK ships a privacy manifest. It declares no tracking (`NSPrivacyTracking = false`) and the following collected data types, all linked to the user and used for app functionality (not tracking):

- Name
- Phone number
- Physical address
- Precise location
- Photos or videos
- User ID
- Device ID

Declared required-reason API usage:

- `NSPrivacyAccessedAPICategoryUserDefaults`: Reason `1C8F.1` (SDK preference storage)
- `NSPrivacyAccessedAPICategoryFileTimestamp`: Reasons `C617.1`, `3B52.1` (resource validation)

When you submit your app, make sure your app-level privacy disclosures on App Store Connect are consistent with the data your chosen flow collects.


## Initialize the SDK

Initialize the SDK once, early in the app lifecycle. The idiomatic place is `application(_:didFinishLaunchingWithOptions:)` in your `AppDelegate`, or your SwiftUI `App` startup. Call `initIncdOnboarding` on the shared manager:

```swift
import IncdOnboarding

func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
) -> Bool {
    IncdOnboardingManager.shared.initIncdOnboarding(
        url: "<YOUR_API_URL>",
        apiKey: "<YOUR_API_KEY>"
    ) { success, error in
        // `success` is `true` once the SDK is ready; `error` is an `IncdInitError` on failure.
    }
    return true
}
```

- `url`: Your Incode API base URL, provided by Incode.
- `apiKey`: Your API key, provided by Incode. If your backend issues the session token and the `url` ends in `/0`, omit it — see [Token-Based Setup](/sdk-reference/ios-token-based-setup/).
- `e2eeURL`: An optional separate endpoint for [end-to-end encryption](/sdk-reference/ios-security/#end-to-end-encryption-e2ee).
- `clientExperimentId`: An optional A/B experiment identifier.
- `loggingEnabled`: SDK console logging. Defaults to `false`; set to `true` to enable logs.
- `testMode`: Run in development test mode on simulators or physical devices. Defaults to `false`; see [Enable Test Mode](#enable-test-mode).

The trailing completion closure reports `(Bool?, IncdInitError?)`. You can only make SDK API calls after initialization succeeds.


```swift
public func initIncdOnboarding(
    url: String? = nil,
    e2eeURL: String? = nil,
    apiKey: String? = nil,
    clientExperimentId: String? = nil,
    loggingEnabled: Bool = false,
    testMode: Bool = false,
    _ completion: ((Bool?, IncdInitError?) -> Void)? = nil
)
```


### Initialize with an External Token

You can key a session to an identifier from your own system rather than relying only on a session token. On iOS, this is expressed as two properties on `IncdOnboardingSessionConfiguration`:

```swift
let session = IncdOnboardingSessionConfiguration(
    externalId: "<YOUR_EXTERNAL_ID>"
)
```

- `externalId`: An ID used outside the Incode Platform. If a session with the same `externalId` already exists, it is resumed instead of creating a new one.
- `externalCustomerId`: Similar to `externalId`, but always creates a new session instead of resuming.

Pass the configuration when you start a flow. See [Integration Approaches](/sdk-reference/ios-flow-configuration/).

### Check Initialization

```swift
let status = IncdOnboardingManager.shared.isSDKEntirelyInitialized
if !status.flag { print(status.error?.description ?? "") }
```
:::info
The old property, the misspelled `isSDKEntierlyInitialized`, is deprecated. It remains available and returns the same result, but use `isSDKEntirelyInitialized` instead.
:::
This checks SDK initialization, resource availability, and runtime integrity.


## Enable Test Mode

Test Mode lets you run the SDK on an iOS Simulator or physical device during development. Enable it by passing `testMode: true` to `initIncdOnboarding`:

```swift
IncdOnboardingManager.shared.initIncdOnboarding(
    url: "<YOUR_API_URL>",
    apiKey: "<YOUR_API_KEY>",
    testMode: true // enable Test Mode during development
)
```

`testMode` defaults to `false`. When enabled, the SDK prints a console warning. `IncdInitError.testModeEnabled` remains available for source compatibility but is no longer reported on physical devices.

:::warning
Remove `testMode: true` (or set it back to `false`) before you build for production. Test Mode is for development only.
:::


## What's Next

Choose your [integration approach](/sdk-reference/ios-flow-configuration/).

---

- Path: `sdk-reference/user_guide_kiosk`
- URL: https://developer.incode.com/sdk-reference/user_guide_kiosk/
- Markdown: https://developer.incode.com/sdk-reference/user_guide_kiosk.md

# Kiosk mode features

Kiosk mode is used for building iPad apps where an iPad is embedded into an Aila frame and positioned in a landscape orientation.

## Initialize IncdOnboarding SDK

Add the following line of code to your `AppDelegate` class:
```
IncdOnboardingManager.shared.initIncdOnboarding(url: url, apiKey: apiKey)
```

`url` and `apiKey` will be provided to you by Incode.
If you're running the app on a simulator, please set the `testMode` parameter to true.

## Kiosk 1:N Face Login - Identify a user

1:N Face login is suitable if you would like to identify a user by doing a face scan. 
This will do a face match comparison across your entire user database and check if the face corresponds to any of the approved users.

To execute 1:N Face Login call `startFaceLogin` method:

```swift
IncdOnboardingManager.shared.startKioskLogin() { selfieScanResult, firstName in
          guard let loginResult = selfieScanResult.faceLoginResult else {
            // Some error occured
            print(selfieScanResult.error)
            return
          }
          
          if loginResult.success == true {
            // Face auth successful
            let customerUUID = loginResult.customerUUID
            let token = loginResult.token
            let interviewId = loginResult.interviewId
          } else {
            if selfieScanResult.spoofAttempt == true {
              // Liveness failed
            } else {
              // User's face not found
            }
          }
        }
```

### Face Login result

Face Login result will have `SelfieScanResult` and `firstName` if there is a name associated to this user, otherwise `firstName` will be `nil`.

The resulting `SelfieScanResult` object will have:
* `faceLoginResult` - `FaceLoginResult` object that contains:
  * `success` - True if face login was successful, false otherwise.
  * `customerUUID` - Customer UUID of the matched user, nil otherwise.
  * `token` - Customer token of the matched user, nil otherwise.
  * `interviewId` - Session interviewId from which the user got approved.
  * `interviewToken` - Session interviewToken which was used during user approval.
  * `transactionId` - Transaction ID of the face login attempt.
* `spoofAttempt` - Specifies if it was a spoof attempt or not
* `image` - Selfie image taken during Selfie scan step
* `error` - `SelfieScanError` that describes the error that happened during face login

## Kiosk flow - Create an account for unrecognized users

Kiosk flow will first try to recognize a user by performing a selfie scan, and in case a user is recognized the flow will end and `onKioskFlowCompleted` method of the delegate will be called.

If a user isn't recognized, a new onboarding session is created and the user will be asked to scan their ID, after which a face math comparions will be performed between the front photo ID and Selfie. Afterwards, user approval will be performed and the result will be returned as `KioskFlowResult` via `onKioskFlowCompleted`delegate method.

```
IncdOnboardingManager.shared.startKioskFlow(delegate: self)
```

As the user is going through the steps, these methods of the delegate will be called:

```swift
  /**
   Called when user dismisses flow.
   */
  func userCancelledSession()

  /**
   Called when selfie scan is completed
   */
  func onSelfieScanCompleted(_ result: SelfieScanResult?)

  /**
   Called when Kiosk flow is completed
   */
  func onKioskFlowCompleted(_ result: KioskFlowResult)

  /**
   Called when ID front scan is completed
   */
  func onIdFrontCompleted(success: Bool)

  /**
   Called when ID back scan is completed
   */
  func onIdBackCompleted(success: Bool)

  /**
   Called when ID is processed
   */
  func onIdProcessed(success: Bool, ocrData: OmniGetOCRDataResponse?)

  /**
   Called when face match is performed
   */
  func onFaceMatchCompleted(success: Bool)

  /**
   Called when some error occured during Kiosk flow
   See IncdFlowError documentation for specific error descriptions
   */
  func onKioskError(_ error: IncdFlowError)
}
```

### Kiosk flow result

The resulting `KioskFlowResult` object will have:
  * `success` - True if flow was successful, false otherwise.
  * `customerUUID` -  ID of the user. Will be available only if the flow is completed successfully, nil otherwise.
  * `token` - Access token. WIll be available only if the flow is completed successfully, nil otherwise.
  * `name` - Name of the user. Will be available only if the flow is completed successfully, nil otherwise.
  * `existingUser` - Boolean indicator if the user was already in the database, or new user was created.

---

- Path: `sdk-reference/web-sdk-2-asset-overrides`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-asset-overrides/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-asset-overrides.md

# Asset Overrides

<Component slug="web-2-x-implementation-warning" />

Replace the SDK's built-in branded illustrations (SVG) and animations (Lottie) with your own artwork - no fork, no rebuild. Overrides are supplied at runtime through the same `setup()` / web-component `config` channels you already use for the rest of the SDK.

This is a different mechanism from [Theming & Styling](/sdk-reference/web-sdk-2-theming/): CSS tokens recolor functional UI chrome (buttons, inputs, the spinner track) via `currentColor`, while asset overrides replace whole decorative illustrations and animations — tutorial graphics, success/fail screens, and similar branding moments.

## Quick start

Pass `assets` and/or `animations` maps to the `uiConfig` option of `setup()`. Keys are type-checked — only allowlisted keys autocomplete, and an unknown key is a compile error:

```ts
import { setup } from '@incodetech/web';

await setup({
  apiURL: API_URL,
  token: session.token,
  uiConfig: {
    assets: {
      // A plain string is treated as a URL (or raw `<svg …>` markup if it starts with '<')
      'faceMatch.success': 'https://cdn.example.com/id/match-ok.svg',
    },
    animations: {
      'id.tutorial.front': { url: 'https://cdn.example.com/id/tutorial.json' },
    },
  },
});
```

Every SDK instance on the page picks up these overrides. To change overrides after `setup()` has already run, call `setUiConfig` directly:

```ts
import { setUiConfig } from '@incodetech/web';

setUiConfig({
  assets: { 'faceMatch.success': 'https://cdn.example.com/id/match-ok.svg' },
});
```

`setUiConfig` replaces the entire `UiConfig` object rather than merging into it — pass every field you want to keep (`logoSrc`, `assets`, `animations`, and so on) each time you call it.

Your `UiConfig` is held separately from the branding a tenant configures in the dashboard (logo, subtitle, footer branding). A dashboard theme never clears your `assets` / `animations`, and where both set the same branding field, the value you pass here wins; fields you leave unset fall through to the dashboard theme.

## How overrides resolve

An override wins in this order, most specific first:

1. **Per-instance**: the `assets` / `animations` maps on a single web component's `config` prop (see [Per-instance overrides](#per-instance-overrides) below).
2. **Global**: the `assets` / `animations` maps passed to `setup({ uiConfig })` or `setUiConfig`.
3. **Built-in default**: the SDK's own illustration or animation, unchanged.

If a key has no override at any tier, the SDK renders exactly what it renders today. A malformed override, a `{ url }` that fails to load, or an unknown key all fall back to the built-in default silently — an override never throws and never blocks rendering.

## What can be overridden

Overrides are **allowlist-only**. Only the keys listed below can be overridden; there is no override-by-path or wildcard. Every other SDK graphic stays fixed, including functional icons, form-control glyphs, and capture-critical overlays like camera frames or alignment guides. Recolor those through [CSS tokens](/sdk-reference/web-sdk-2-theming/) instead.

### SVG illustrations (`AssetKey`)

| Key                                | Screen                                    |
| ----------------------------------- | ------------------------------------------ |
| `faceMatch.success`                 | Face match success result                  |
| `faceMatch.fail`                    | Face match failure result                  |
| `documentCapture.tutorial`          | Document capture tutorial illustration     |
| `id.uploadScreen`                   | ID document upload screen                  |
| `id.ageVerification.dob`            | Age verification: date-of-birth step       |
| `id.ageVerification.scan`           | Age verification: scan step                |
| `id.ageVerification.privacy`        | Age verification: privacy step             |
| `videoSelfie.success`               | Video selfie success result                |
| `videoSelfie.fail`                  | Video selfie failure result                |
| `videoSelfie.tutorial.permission`   | Video selfie tutorial: camera permission   |
| `videoSelfie.tutorial.selfie`       | Video selfie tutorial: selfie step         |
| `videoSelfie.tutorial.frontId`      | Video selfie tutorial: front-of-ID step    |
| `videoSelfie.tutorial.backId`       | Video selfie tutorial: back-of-ID step     |
| `videoSelfie.tutorial.poa`          | Video selfie tutorial: proof-of-address    |
| `videoSelfie.tutorial.questions`    | Video selfie tutorial: questions step      |
| `videoSelfie.tutorial.speech`       | Video selfie tutorial: speech step         |
| `loader.spinner`                    | Replaces the default loading spinner (see [The loading spinner](#the-loading-spinner)) |

### Lottie animations (`AnimationKey`)

| Key                   | Screen                                                    |
| ---------------------- | ---------------------------------------------------------- |
| `id.tutorial.front`    | ID capture tutorial: front side                             |
| `id.tutorial.back`     | ID capture tutorial: back side                              |
| `id.tutorial.passport` | ID capture tutorial: passport                                |
| `id.flip`              | ID capture "flip the card" animation                        |
| `id.processing`        | ID analyzing / laser-scan loader                            |
| `selfie.tutorial`      | Selfie capture tutorial                                     |
| `loader.spinner`       | Replaces the default loading spinner (see below)            |

Only assets that are purely decorative or branding graphics are on this list. If a key you need isn't here, it's most likely functional chrome or a capture-critical overlay, and isn't a candidate for override.

## Override forms

### SVG overrides

`AssetOverride` accepts several shapes, so you can pick whichever is least work:

```ts
type AssetOverride =
  | string // a URL, or raw `<svg …>` markup (detected by a leading '<')
  | { url: string } // fetched and rendered via <img>; no script execution
  | { raw: string } // inline markup, sanitized before injection
  | { svg: SvgComponent }; // a precompiled Preact component (build-time integrations)
```

`{ raw }` markup is sanitized before it's injected into the page — scripts, event-handler attributes, `<foreignObject>`, and external `href` / `xlink:href` references are stripped (in-document `#fragment` references used for gradients and filters are preserved). If sanitizing strips everything, the SDK treats the override as failed and falls back to the built-in default.

### Animation overrides

```ts
type AnimationOverride =
  | LottieAnimationData // a parsed Lottie JSON object
  | { url: string } // fetched and cached at runtime
  | { animationData: LottieAnimationData };
```

An animation `{ url }` is fetched once and cached; a failed fetch falls back to the built-in default.

## Per-instance overrides

Every module web component's `config` prop also accepts `assets` and `animations`. This overrides the global `setup({ uiConfig })` values for that one element only. This is useful when a single flow instance on the page needs different branding than the rest of the app:

```ts
import type { ComponentProps } from 'preact';
import { Selfie } from '@incodetech/web/selfie';

type SelfieElement = HTMLElement & ComponentProps<typeof Selfie>;
const el = document.createElement('incode-selfie') as SelfieElement;
el.manager = selfieManager;
el.config = {
  token,
  assets: {
    'videoSelfie.success': 'https://cdn.example.com/id/selfie-done.svg',
  },
};
container.appendChild(el);
```

`<incode-flow>` takes the same two maps on its `FlowConfig`:

```ts
flow.config = {
  token: session.token,
  animations: {
    'loader.spinner': { url: 'https://cdn.example.com/id/spinner.json' },
  },
};
```

If the same key is set both globally and per-instance, the per-instance value wins for that element.

## The loading spinner

The default loading spinner (shown during flow initialization, module loading, and transitions) is CSS + inline SVG, not an asset — it stays fully customizable through the `--spinner-*` CSS tokens described in [Theming & Styling](/sdk-reference/web-sdk-2-theming/#spinner-customization), unaffected by this feature.

`loader.spinner` is a separate, optional override that _replaces_ the built-in spinner entirely with your own SVG or Lottie asset. Set it (as an `AssetOverride` for an SVG, or an `AnimationOverride` for a Lottie animation) and the SDK renders your asset instead of the CSS spinner everywhere the spinner appears. Leave it unset and the CSS spinner renders exactly as it does today.

## Accessibility & security

- **Accessible names and `aria-hidden` always come from the SDK's built-in catalog, never from your override.** Replacing an asset's pixels can't remove its accessible name.
- **The WCAG 2.2.2 five-second auto-stop on animations can't be bypassed by an override.** A customer-supplied Lottie animation is still subject to the same auto-stop as the built-in default.
- **Raw SVG markup is sanitized before injection** (see [Override forms](#override-forms) above). Prefer `{ url }` when you control the hosting and don't need inline theming.
- **The SDK never recolors a customer-supplied asset.** Color the asset yourself before handing it to the SDK.

## TypeScript

```ts
import type {
  AssetKey,
  AssetOverride,
  AssetOverrides,
  AnimationKey,
  AnimationOverride,
  AnimationOverrides,
  SvgComponent,
} from '@incodetech/web';
```

The same types are also available from `@incodetech/web/extensibility` if you're already importing shared components/hooks from that subpath.

## See Also

- [Theming & Styling](/sdk-reference/web-sdk-2-theming/): CSS-token recoloring of UI chrome
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): full `FlowConfig` reference, including `assets` / `animations`
- [Web Components](/sdk-reference/web-sdk-2-web-components/): setting per-instance `config` on any module element
- [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/): the full type catalog

---

- Path: `sdk-reference/web-sdk-2-bundle-optimization`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-bundle-optimization/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-bundle-optimization.md

# Bundle Optimization

<Component slug="web-2-x-implementation-warning" />

Reduce your bundle size with tree shaking and code splitting.

## Tree Shaking

Each module ships at its own subpath. Import only the subpaths you need; the SDK has no barrel re-exports that pull everything in.

### ✅ Good: Subpath imports

```typescript
// Side-effect import: registers <incode-phone>, ships only the Phone UI bundle
import '@incodetech/web/phone';
import '@incodetech/web/phone/styles.css';

// Headless: only the Phone manager and its dependencies
import { createPhoneManager } from '@incodetech/core/phone';
```

### ❌ Avoid: importing more modules than you use

```typescript
// Don't register every module if you only need one — each side-effect
// import bundles its UI. Import only what you mount.
import '@incodetech/web/phone';
import '@incodetech/web/email';
import '@incodetech/web/selfie';
import '@incodetech/web/id';
```

## Code Splitting

Use dynamic imports to register modules on demand.

### Lazy register a module

```typescript
import type { ComponentProps } from 'preact';
import type { Phone } from '@incodetech/web/phone';

type PhoneElement = HTMLElement & ComponentProps<typeof Phone>;

// Module registers itself only when this code runs
async function showPhone(goToSelfie: () => void) {
  await import('@incodetech/web/phone');
  await import('@incodetech/web/phone/styles.css');
  document.body.insertAdjacentHTML(
    'beforeend',
    '<incode-phone></incode-phone>',
  );
  const phone = document.querySelector<PhoneElement>('incode-phone');
  if (!phone) return;
  phone.config = {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  };
  phone.onFinish = () => goToSelfie();
}
```

### Prefetch the next module

Load the next step while the user interacts with the current one:

```typescript
// Start prefetching as soon as the current step begins
const prefetchSelfie = () => import('@incodetech/web/selfie');

function prefetchAfterPhone(phone: PhoneElement, goToSelfie: () => void) {
  phone.onFinish = goToSelfie;
  void prefetchSelfie();
}
```

## `<incode-flow>` optimization

`<incode-flow>` handles code splitting internally:

- Lazy-loads each module's UI chunk only when the orchestrator advances to that step
- Prefetches the next module while the user completes the current step
- Loads WASM only when a selfie or ID-capture step is reached (unless preloaded via `setup({ wasm })`)

You don't need to manage code-splitting yourself when using `<incode-flow>`.

## Bundle size reference

These numbers are a snapshot of the published `@incodetech/web` build. Your app's final cost depends on bundler, deduplication with framework dependencies, and which modules you actually import. Measure with your bundler's built-in size analyzer for an accurate per-app breakdown.

> _JavaScript figures below were last measured on 2026-04-30 against _`@incodetech/web@2.0.0-alpha`_ and cover each entry plus the chunks it pulls in. Treat them as indicative — two releases have shipped since. The stylesheet figures further down were measured on 2026-08-13 against the current build. Your bundler may produce different numbers depending on minifier and tree-shaking settings._

**Per-module entry chunks** — what gets pulled in when you side-effect-import a single module:

| Subpath                                | Entry chunk     | Gzipped         |
| -------------------------------------- | --------------- | --------------- |
| `@incodetech/web/phone`                | 3.8 KB          | 1.4 KB          |
| `@incodetech/web/email`                | 3.9 KB          | 1.5 KB          |
| `@incodetech/web/selfie`               | 1.7 KB          | 0.7 KB          |
| `@incodetech/web/id`                   | 16.0 KB         | 5.6 KB          |
| `@incodetech/web/flow`                 | 19.3 KB         | 4.5 KB          |
| `@incodetech/web/consent`              | 2.9 KB          | 1.2 KB          |
| `@incodetech/web/curp-validation`      | 9.1 KB          | 2.4 KB          |
| `@incodetech/web/document-capture`     | 34.4 KB         | 8.9 KB          |
| `@incodetech/web/face-match`           | 65.9 KB         | 45.5 KB         |
| `@incodetech/web/identity-reuse`       | 7.3 KB          | 1.6 KB          |
| `@incodetech/web/redirect-to-mobile`   | 41.4 KB         | 12.7 KB         |
| `@incodetech/web/signature`            | 24.7 KB         | 7.2 KB          |
| `@incodetech/web/electronic-signature` | 1454.8 KB       | 470.3 KB        |
| `@incodetech/web/workflow`             | 6.2 KB          | 2.3 KB          |
| `@incodetech/web/ekyc`, `/ekyb`        | 8.2 KB / 7.9 KB | 2.6 KB / 2.8 KB |
| `@incodetech/web/geolocation`          | 118.8 KB        | 32.5 KB         |

**Shared chunks** — loaded once and reused across modules. Most modules pull in some subset:

| Shared chunk                               | Size            | Gzipped |
| ------------------------------------------ | --------------- | ------- |
| `vendor-preact` (Preact + signals)         | 37.0 KB         | 12.4 KB |
| `i18n` (translation runtime)               | 79.1 KB         | 22.3 KB |
| `icons` (shared icon set)                  | 17.4 KB         | 5.6 KB  |
| `useModuleLoader` (module-loading runtime) | 14.7 KB         | 4.8 KB  |
| `homeScreen`                               | 12.1 KB         | 4.5 KB  |
| `verifiedByIncode`                         | 13.7 KB         | 5.6 KB  |
| `countries` (phone module dependency)      | 138.5 KB        | 27.0 KB |
| `AsYouType` (phone formatter)              | 82.6 KB         | 16.3 KB |
| `tutorial`, ID tutorial Lotties, etc.      | 100–230 KB each | 8–40 KB |

### Stylesheets

Budget for CSS separately. `base.css` is required by every integration. It used to be the heaviest file the SDK shipped because it carried the fonts inline as base64. The five `woff2` files now ship next to it in `dist/assets/` and `base.css` references them with relative `url()`s, so it gzips like the other sheets and the fonts are fetched in parallel, non-blocking (`font-display: swap`), and cached independently of the stylesheet. Still no third-party font request at runtime (see [Third-Party Dependencies](/sdk-reference/web-sdk-2-third-party-dependencies/)): the files come from wherever you serve the SDK. Bundlers (Vite, webpack `css-loader`, Next.js, Angular CLI) pick the files up automatically from the `url()`s; CDN `<link>` users get them relative to the stylesheet URL.

| Stylesheet                                        | Size       | Gzipped    |
| ------------------------------------------------- | ---------- | ---------- |
| `@incodetech/web/base.css` (required)             | 196.0 KB   | 14.5 KB    |
| `@incodetech/web/flow/styles.css`                 | 156.0 KB   | 15.4 KB    |
| `dist/assets/*.woff2` (5 font files)              | 73.2 KB    | N/A        |
| `@incodetech/web/workflow/styles.css`             | 127.5 KB   | 12.8 KB    |
| `@incodetech/web/themes/dark.css`                 | 53.1 KB    | 6.2 KB     |
| `@incodetech/web/themes/light.css`                | 47.9 KB    | 6.1 KB     |
| `@incodetech/web/id/styles.css`                   | 47.0 KB    | 5.5 KB     |
| `@incodetech/web/video-selfie/styles.css`         | 22.6 KB    | 3.4 KB     |
| `@incodetech/web/document-capture/styles.css`     | 13.1 KB    | 1.9 KB     |
| `@incodetech/web/redirect-to-mobile/styles.css`   | 11.5 KB    | 1.8 KB     |
| `@incodetech/web/electronic-signature/styles.css` | 11.1 KB    | 1.8 KB     |
| `@incodetech/web/face-match/styles.css`           | 10.3 KB    | 1.9 KB     |
| `@incodetech/web/selfie/styles.css`               | 6.9 KB     | 1.6 KB     |
| `@incodetech/web/geolocation/styles.css`          | 5.2 KB     | 1.2 KB     |
| Remaining per-module sheets                       | 0.1–4.8 KB | 0.1–0.9 KB |

Import one theme, not both. `light.css` and `dark.css` are alternatives, so pulling in both costs about 50 KB for nothing. The `ae-signature`, `qe-signature`, and `electronic-signature` subpaths resolve to one shared stylesheet, so importing more than one of them adds no weight.

**Notes:**

- The phone module entry is tiny (\~4 KB) but a real phone integration also pulls in `countries` (27 KB gzipped) and `AsYouType` (16 KB gzipped). Plan for 50–60 KB gzipped for a complete phone screen.
- ID and selfie pull in WASM ML model files separately (loaded over the network when capture begins, not bundled). Use `setup({ wasm: { pipelines: [...] } })` to preload them — see [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).
- The `electronic-signature` module includes a PDF rendering subsystem, which is why its entry chunk is so much larger. Lazy-load it.
- Headless managers from `@incodetech/core/<name>` are typically 1–10 KB each, since they ship state machines and HTTP services without UI. Pair them with your own UI when bundle size is paramount.

If you need the precise number for your build, your bundler is the source of truth. Run `vite build --mode analyze` (Vite/Rollup), `webpack-bundle-analyzer` (Webpack), or `esbuild --metafile=meta.json` (esbuild) and inspect the resulting report.

## Bundler Configuration

### Vite

```typescript
// vite.config.ts
export default {
  build: {
    rollupOptions: {
      output: {
        manualChunks: {
          'incode-phone': ['@incodetech/web/phone'],
          'incode-selfie': ['@incodetech/web/selfie'],
        },
      },
    },
  },
};
```

### Webpack

```javascript
// webpack.config.js
module.exports = {
  optimization: {
    splitChunks: {
      cacheGroups: {
        incode: {
          test: /[\\/]node_modules[\\/]@incodetech/,
          name: 'incode-sdk',
          chunks: 'async',
        },
      },
    },
  },
};
```

## Best Practices

1. **Use subpath imports**: `@incodetech/web/phone`, never the package root.
2. **Defer registration until you need the module**: wrap the side-effect import in `await import('@incodetech/web/<module>')` inside a click handler or route entry.
3. **Prefetch the next step**: fire the dynamic import for the next module while the user is still completing the current one, so it's cached by the time you mount it.
4. **Analyze your bundle**: use whatever size analyzer your bundler ships (`webpack-bundle-analyzer`, `rollup-plugin-visualizer`, `esbuild --metafile`, etc.).

## See Also

- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): Conditional WASM loading
- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Smaller bundle with core managers

---

- Path: `sdk-reference/web-sdk-2-e2ee`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-e2ee/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-e2ee.md

# End-to-End Encryption

<Component slug="web-2-x-implementation-warning" />

End-to-end encryption (E2EE) adds a second layer of encryption on top of HTTPS so that any intermediary that terminates TLS — corporate proxy, CDN, transparent firewall, attacker MITM with a trusted root — cannot read PII payloads (selfie images, ID photos, identity fields). The SDK exposes it as a single opt-in flag on `setup()`.

:::warning
E2EE must be provisioned for your account on the back end. Until it is, flipping encryption: true against a regular apiURL fails initialization at `setup()` and the SDK throws. Contact your Incode representative.
:::

## What you'll get from your Incode account team

When E2EE is enabled for your account, your account team will provide:

**A dedicated apiURL.** E2EE traffic is served from a different host than the regular API (typically *-e2ee-api.incodesmile.com). Pointing encryption: true at your standard apiURL fails initialization.
**The MGF1 scheme** the environment expects — 'sha1' (default; matches most existing Incode environments) or 'sha256' (some environments are explicitly provisioned for it).
Confirm both values before you start. They are dictated by the environment, not by you.

## Minimum integration

Two lines of `setup()` flip E2EE on:

```ts
import { setup } from '@incodetech/core';

await setup({
  apiURL: 'https://<your-incode-e2ee-host>/0', // see "API key transmission" below
  encryption: true,
});
```

The SDK initializes encrypted transport during `setup()`. Treat the session token returned by `createSession()` as an opaque string.

## API key transmission

Use the complete apiURL and authentication configuration supplied by your Incode account team. For session-based integrations, the provisioned URL can include a /0 suffix. Keep that suffix when instructed. Some environments instead require an x-api-key custom header; confirm the required integration form before deployment.

Do not embed production API keys in browser code. Confirm the supported browser authentication arrangement with your account team.

## MGF1 scheme

encryption accepts a boolean shorthand or an object form with `mgf1`:

```ts
// Default — MGF1 = SHA-1 (matches most existing Incode environments)
await setup({
  apiURL: 'https://<your-incode-e2ee-host>/0',
  encryption: true,
});

// Pin SHA-256 — only when your environment is provisioned for it
await setup({
  apiURL: 'https://<your-incode-e2ee-host>/0',
  encryption: { mgf1: 'sha256' },
});
```

`encryption: true` is equivalent to `encryption: {}`. Both enable encryption with the SHA-1 default.

The `mgf1` value must match what the environment expects. A mismatch causes encrypted requests to fail. Confirm the value with your account team.

## Constraints

- **Requires the binary (WASM) transport.** `setup({ wasm: false, encryption: true })` throws. Either omit wasm (the SDK provisions the binary transport with CDN defaults automatically) or pass a `WasmConfig` object alongside `encryption: true`. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).
- **Independent of token.** Encryption can be configured before a session token is available.
- **Locked at boot.** The first `setup()` call decides whether encryption is on and which mgf1 scheme is used. Subsequent `setup()` calls that would change either value throw. Call `reset()` first if you genuinely need to switch.
- **Required by on-device face capture.** Selfie / Authentication's `onDeviceFaceResultsSubmissionEnabled: true` only works against the E2EE-provisioned host. See [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/).
## Initialization failures

If initialization fails, `setup()` rejects with a descriptive error. There is no built-in retry — catch the error and re-call `setup()` (after `reset()` if needed) when your environment is known-flaky.

| Symptom                                            | Likely cause                                  | Fix                                                                                                       |
| -------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `setup()` rejects with an initialization error   | apiURL unreachable                          | Verify network / DNS, retry.                                                                              |
| Same, on a known-good network                      | Environment not provisioned for E2EE          | Reach out to your Incode account team. Confirm you're using the E2EE host they provided.                  |
| Encrypted requests fail after initialization    | mgf1 mismatch with what the env expects     | Confirm the expected scheme with your contact, pass encryption: `{ mgf1: 'sha256'}` (or 'sha1').       |
| Requests fail to identify the tenant | Missing API key                               | Confirm the provisioned URL and authentication configuration. See "API key transmission". |
| `setup({ encryption: ... })` throws on a re-call   | Encryption is locked at boot                  | Call `reset()` first.                                                                                     |
| `setup({ wasm: false, encryption: true })` throws  | Encryption requires the WASM binary transport | Omit `wasm: false`, or pass a `WasmConfig` object alongside `encryption: true`.                           |

## Full example: self-hosted WASM + E2EE

```ts
await setup({
  apiURL: 'https://<your-incode-e2ee-host>/0',
  encryption: { mgf1: 'sha256' }, // whichever your env expects
  wasm: {
    wasmPath: '/wasm/webLib.wasm',
    glueCodePath: '/wasm/webLib.js',
    modelsBasePath: '/wasm/models',
  },
});
```
## See also

- [API Reference → setup()](/sdk-reference/web-sdk-2-reference/#setup): the encryption option's full reference entry.
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): the binary transport E2EE rides on.
- [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/): depends on E2EE being configured.
- [Getting Started](/sdk-reference/web-sdk-2-getting-started/): the basic boot sequence (setup → createSession → initializeSession) you build on top of.

---

- Path: `sdk-reference/web-sdk-2-event-callbacks`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-event-callbacks/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-event-callbacks.md

# Event Callbacks

<Component slug="web-2-x-implementation-warning" />

The SDK provides callbacks to integrate with your application's logic.

> The snippets below show the callback shapes you'd assign to the element (e.g. `flow.onFinish = ...`) or set inside `config`. For full mounting examples (vanilla, React, Angular, Vue) see [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/) and [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

## IncodeFlow Callbacks

### onFinish

Called when the verification flow finishes. This is the **primary** callback you should set:

```ts
flow.onFinish = (result) => {
  console.log('Action:', result?.action); // 'approved' | 'rejected' | 'none'
  console.log('Status:', result?.scoreStatus); // 'OK' | 'WARN' | 'FAIL' | ...
  console.log('Redirect:', result?.redirectionUrl);

  if (result?.action === 'approved') {
    // Proceed with your flow
  }
};
```

`result` may be `undefined` (the signature is `(result?: FinishStatus, meta?: IncodeFinishMeta) => void`), so always null-check.

#### Knowing whether the SDK already drew a finish screen

`onFinish` receives an optional second argument. Read `meta.sdkOwnsTerminalScreen` to avoid stacking your own completion screen on top of one the SDK already rendered:

```ts
import type { IncodeFinishMeta } from '@incodetech/web/workflow';

workflow.onFinish = (result, meta) => {
  notifyBackend(result); // side effects always run

  if (!meta?.sdkOwnsTerminalScreen) {
    showMyCompletionScreen(result);
  }
};
```

It is `true` when the SDK has drawn its own terminal screen. Today, that means `<incode-workflow>` with the [status-specific finish screen](/sdk-reference/web-sdk-2-module-workflow/#status-specific-finish-screen) enabled. `onFinish` still fires either way, so side effects such as notifying a parent frame keep working.

The flag is **advisory**. The SDK cannot stop your page from rendering, so it only helps if you read it. Existing single-argument handlers keep working unchanged, and `meta` is `undefined` for modules that do not set it.

### onError

Called when an error occurs:

```ts
flow.onError = (error, code) => {
  console.error('Verification error:', error, code);
  // Show error UI or redirect
};
```

In 2.3.0, terminal Mandatory Consent/ML Consent cancellation uses the flow's generic error presentation and error code. Do not match the former `Mandatory consent error` text; messages can vary. Headless `errorModule(error?, moduleErrorCode?)` also accepts an omitted message.

### onModuleLoading / onModuleLoaded

Track lazy-loading of each module's UI chunk. These are config callbacks, not element callbacks:

```ts
flow.config = {
  token: session.token,
  onModuleLoading: (moduleKey) => setLoading(moduleKey),
  onModuleLoaded: (moduleKey) => setLoading(null),
};
```

### onWasmWarmup

Called when ML models begin loading:

```ts
flow.config = {
  token: session.token,
  onWasmWarmup: (pipelines) => console.log('Loading ML models:', pipelines),
};
```

### onFlowEvent

Subscribe to curated flow milestones. For raw analytics events such as `screenOpened` or `elementClicked`, use `subscribeEvent` from `@incodetech/core/events` instead.

```ts
flow.config = {
  token: session.token,
  onFlowEvent: (event) => console.log('Flow event:', event.type, event),
};
```

Branch on `event.type`. The `FlowEvent` union and its member types are exported from `@incodetech/core/flow-events`:

```ts
import type { FlowEvent } from '@incodetech/core/flow-events';

flow.config = {
  token: session.token,
  onFlowEvent: (event: FlowEvent) => {
    if (event.type === 'flow.module.started') {
      console.log(`Starting ${event.module}`);
    }
  },
};
```

| `event.type`             | Type                       | Additional fields                                                            |
| ------------------------ | -------------------------- | ---------------------------------------------------------------------------- |
| `flow.started`           | `FlowStartedEvent`         | –                                                                            |
| `flow.ready`             | `FlowReadyEvent`           | `payload`: `{ flow, steps, currentStep?, currentStepIndex }`                  |
| `flow.module.started`    | `FlowModuleStartedEvent`   | `module`, `payload`: `{ moduleIndex?, totalModules? }`                        |
| `flow.module.completed`  | `FlowModuleCompletedEvent` | `module`, `payload`: `{ moduleIndex?, totalModules? }`                        |
| `flow.completed`         | `FlowCompletedEvent`       | `payload?`: the finish status                                                 |
| `flow.error`             | `FlowErrorEvent`           | `error`: the error message                                                    |
| `flow.closed`            | `FlowClosedEvent`          | –                                                                            |

Every event also carries `timestamp` (epoch milliseconds) and an optional `interviewId`. All events except `flow.started` also carry an optional `flowId`.

`FlowEventListener` types the callback itself, and `FlowEventSubscribable` types a manager that exposes this stream.

### Headless flow events

Managers returned by `createFlowManager`, `createOrchestratedFlowManager`, and `createWorkflowManager` expose `subscribeFlowEvent(listener)`. It uses the curated `FlowEvent` union above; raw analytics remain a separate `subscribeEvent` stream.

```ts
import type { FlowEventSubscribable } from '@incodetech/core/flow-events';

function observeFlow(manager: FlowEventSubscribable): () => void {
  return manager.subscribeFlowEvent((event) => {
    if (event.type === 'flow.module.started') {
      console.log('Starting', event.module);
    }
  });
}
```

Call the returned unsubscribe function when your observer unmounts. When your host owns the manager, also call `manager.stop()` on teardown to release its resources.

## Individual Module Callbacks

The standalone module elements (`<incode-phone>`, `<incode-selfie>`, `<incode-id>`, …) follow the same property-assignment pattern.

### onFinish

```ts
phone.onFinish = () => console.log('Phone verified!');
```

### onError

```ts
selfie.onError = (error) => console.error('Selfie error:', error);
```

## Finish Status

The `onFinish` callback on `IncodeFlow` receives a `FinishStatus` object:

```typescript
import type { FinishStatus } from '@incodetech/core/flow';

// FinishStatus shape:
// {
//   redirectionUrl: string;
//   action: 'approved' | 'rejected' | 'none';
//   scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL';
//   endScreenTitle: string | null;
//   endScreenText: string | null;
// }
```

`FinishStatus` is also re-exported from `@incodetech/core/session` if you prefer that grouping.

| Field            | Description                      |
| ---------------- | -------------------------------- |
| `action`         | Final verification decision      |
| `scoreStatus`    | Detailed status from scoring     |
| `redirectionUrl` | Configured redirect URL (if any) |
| `endScreenTitle` | Dashboard completion title, or `null` |
| `endScreenText` | Dashboard completion text, or `null` |

The orchestrated Flow obtains this copy from session creation. The raw `getFinishStatus(flowId)` helper returns `null` for both fields. Hosts should provide a display fallback when copy is absent.

## Dashboard Events

For tracking events to the Incode dashboard (module opens, screen transitions, custom events), see [Dashboard Events](/sdk-reference/web-sdk-2-events/).

## See Also

- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): Full component reference
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Module-specific callbacks
- [Dashboard Events](/sdk-reference/web-sdk-2-events/): Tracking events to the dashboard

---

- Path: `sdk-reference/web-sdk-2-events`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-events/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-events.md

# Dashboard Events

<Component slug="web-2-x-implementation-warning" />

The SDK provides a fire-and-forget event tracking system for sending telemetry to the Incode dashboard. This allows you to track module lifecycle, screen transitions, and custom events throughout your verification flow.

## Overview

Events are sent automatically by the SDK's built-in modules, but you can also track custom events from your own code. All events are:

- **Fire-and-forget**: Never blocks execution, never throws errors
- **Headless-compatible**: Available in `@incodetech/core` with zero UI dependencies
- **Auto-queued**: Events sent before SDK is configured are queued and sent automatically when `setup()` is called

## Quick Start

```typescript
import { 
  addEvent, 
  moduleOpened, 
  moduleClosed,
  eventModuleNames,
} from '@incodetech/core/events';

// Track module lifecycle
useEffect(() => {
  moduleOpened(eventModuleNames.phone);
  return () => moduleClosed(eventModuleNames.phone);
}, []);

// Track custom events
addEvent({
  code: 'customButtonClicked',
  module: eventModuleNames.phone,
  payload: { buttonId: 'submit' },
});
```

### Event Logging

Subscribe to all events for custom logging or analytics:

```typescript
import { subscribeEvent } from '@incodetech/core/events';

// Custom logger - separate from API event sending
const unsubscribeLogger = subscribeEvent((event) => {
  console.log('[Event]', {
    code: event.code,
    module: event.module,
    screen: event.screen,
    payload: event.payload,
    timestamp: new Date(event.clientTimestamp ?? Date.now()).toISOString(),
  });
});

// Events are logged AND sent to API independently
addEvent({ code: 'test', module: 'PHONE' });
// → Logged to console via listener
// → Sent to API (automatic)

// Remove logger when done
unsubscribeLogger();
```

## API Reference

### Core Functions

#### `addEvent(event)`

Sends a single event to the dashboard. Fire-and-forget - never blocks or throws.

```typescript
addEvent({
  code: 'captureAttemptFinished',
  module: eventModuleNames.id,
  screen: eventScreenNames.frontCameraCapture,
  payload: { logs: [], attemptNumber: 1 },
  clientTimestamp: Date.now(), // Optional, defaults to now
});
```

**Parameters:**

| Field             | Type                      | Required | Description                                          |
| ----------------- | ------------------------- | -------- | ---------------------------------------------------- |
| `code`            | `string`                  | Yes      | Event code identifier                                |
| `module`          | `EventModule \| string`   | No       | Module name (use `eventModuleNames` constants)       |
| `screen`          | `EventScreen \| string`   | No       | Screen name (use `eventScreenNames` constants)       |
| `payload`         | `Record<string, unknown>` | No       | Additional event data                                |
| `clientTimestamp` | `number`                  | No       | Timestamp in milliseconds (defaults to `Date.now()`) |

#### `subscribeEvent(listener)`

Subscribes to all SDK events for logging, debugging, or custom analytics. Returns an unsubscribe function.

```typescript
const unsubscribe = subscribeEvent((event) => {
  console.log('[Event]', event.code, event.module);
  // Your custom logic here
});

// Later
unsubscribe();
```

**Parameters:**

| Field      | Type                     | Required | Description                                |
| ---------- | ------------------------ | -------- | ------------------------------------------ |
| `listener` | `(event: Event) => void` | Yes      | Callback function that receives each event |

**Returns:** Unsubscribe function to remove the listener

**Note:** Subscribers receive events **before** they're queued or sent to the API. Listener errors are silently caught and don't affect event sending.

#### Helper Functions

```typescript
// Module lifecycle
moduleOpened(module, screen?, payload?);
moduleClosed(module, screen?, payload?);

// Screen lifecycle
screenOpened(module, screen, payload?);
screenClosed(module, screen, payload?);

// Generic screen event
screenEvent({ module, screen, code, payload });
```

## Available Constants

### Module Names

```typescript
import { eventModuleNames } from '@incodetech/core/events';
```

| Constant                                  | Wire value                    |
| ----------------------------------------- | ----------------------------- |
| `eventModuleNames.selfie`                 | `'SELFIE'`                    |
| `eventModuleNames.authentication`         | `'AUTHENTICATION'`            |
| `eventModuleNames.authFace`               | `'AUTH_FACE'`                 |
| `eventModuleNames.mlConsent`              | `'ML_CONSENT'`                |
| `eventModuleNames.combinedConsent`        | `'COMBINED_CONSENT'`          |
| `eventModuleNames.curpValidation`         | `'CURP_VALIDATION'`           |
| `eventModuleNames.faceMatch`              | `'FACE_MATCH'`                |
| `eventModuleNames.qr`                     | `'QR'`                        |
| `eventModuleNames.videoSelfie`            | `'VIDEO_ONBOARDING'`          |
| `eventModuleNames.id`                     | `'ID'`                        |
| `eventModuleNames.front`                  | `'ID'` (alias)                |
| `eventModuleNames.back`                   | `'ID'` (alias)                |
| `eventModuleNames.passport`               | `'ID'` (alias)                |
| `eventModuleNames.idOcr`                  | `'ID_OCR'`                    |
| `eventModuleNames.document`               | `'DOCUMENT_CAPTURE'`          |
| `eventModuleNames.creditCard`             | `'CREDIT_CARD_FRONT'`         |
| `eventModuleNames.creditCardBack`         | `'CREDIT_CARD_BACK'`          |
| `eventModuleNames.conference`             | `'CONFERENCE'`                |
| `eventModuleNames.otp`                    | `'OTP'`                       |
| `eventModuleNames.signature`              | `'SIGNATURE'`                 |
| `eventModuleNames.ekyc`                   | `'EXTERNAL_VERIFICATION'`     |
| `eventModuleNames.watchlist`              | `'WATCHLIST'`                 |
| `eventModuleNames.globalWatchList`        | `'GLOBAL_WATCHLIST'`          |
| `eventModuleNames.customWatchList`        | `'CUSTOM_WATCHLIST'`          |
| `eventModuleNames.watchlistForBusiness`   | `'WATCHLIST_FOR_BUSINESS'`    |
| `eventModuleNames.email`                  | `'EMAIL'`                     |
| `eventModuleNames.phone`                  | `'PHONE'`                     |
| `eventModuleNames.instantVerifyEmail`     | `'INSTANT_VERIFY_EMAIL'`      |
| `eventModuleNames.instantVerifyConsent`   | `'INSTANT_VERIFY_CONSENT'`    |
| `eventModuleNames.forms`                  | `'FORMS'`                     |
| `eventModuleNames.customModule`           | `'CUSTOM_MODULE'`             |
| `eventModuleNames.customFields`           | `'CUSTOM_FIELDS'`             |
| `eventModuleNames.geolocation`            | `'GEOLOCATION'`               |
| `eventModuleNames.ekyb`                   | `'EKYB'`                      |
| `eventModuleNames.identityReuse`          | `'IDENTITY_REUSE'`            |
| `eventModuleNames.antifraud`              | `'ANTIFRAUD'`                 |
| `eventModuleNames.aeSignature`            | `'AE_SIGNATURE'`              |
| `eventModuleNames.qeSignature`            | `'QE_SIGNATURE'`              |
| `eventModuleNames.crossDocumentDataMatch` | `'CROSS_DOCUMENT_DATA_MATCH'` |

### Screen Names

```typescript
import { eventScreenNames } from '@incodetech/core/events';
```

Grouped by module for readability.

#### Selfie / Face Capture

| Constant                               | Wire value                  |
| -------------------------------------- | --------------------------- |
| `eventScreenNames.faceCaptureTutorial` | `'SELFIE_CAPTURE_TUTORIAL'` |
| `eventScreenNames.faceCaptureCamera`   | `'SELFIE_CAMERA_CAPTURE'`   |
| `eventScreenNames.faceCaptureError`    | `'SELFIE_ATTEMPT_FAILED'`   |
| `eventScreenNames.faceCaptureSuccess`  | `'SELFIE_UPLOAD_SUCCEEDED'` |
| `eventScreenNames.faceCaptureUpload`   | `'SELFIE_UPLOAD_PROGRESS'`  |
| `eventScreenNames.faceMatch`           | `'FACE_MATCH'`              |

#### Auth Face

| Constant                                 | Wire value                     |
| ---------------------------------------- | ------------------------------ |
| `eventScreenNames.authFace`              | `'AUTH_FACE'`                  |
| `eventScreenNames.authFaceTutorial`      | `'AUTH_FACE_TUTORIAL'`         |
| `eventScreenNames.authFaceError`         | `'AUTH_FACE_ATTEMPT_FAILED'`   |
| `eventScreenNames.authFaceUpload`        | `'AUTH_FACE_UPLOAD_PROGRESS'`  |
| `eventScreenNames.authFaceUploadSuccess` | `'AUTH_FACE_UPLOAD_SUCCEEDED'` |
| `eventScreenNames.authFaceUploadFailed`  | `'AUTH_FACE_UPLOAD_FAILED'`    |

#### Consent

| Constant                           | Wire value                   |
| ---------------------------------- | ---------------------------- |
| `eventScreenNames.mlConsent`       | `'MACHINE_LEARNING_CONSENT'` |
| `eventScreenNames.combinedConsent` | `'COMBINED_CONSENT'`         |

#### CURP

| Constant                                 | Wire value                    |
| ---------------------------------------- | ----------------------------- |
| `eventScreenNames.curpEnter`             | `'ENTER_CURP'`                |
| `eventScreenNames.curpValidate`          | `'VALIDATE_CURP'`             |
| `eventScreenNames.curpGenerate`          | `'GENERATE_CURP'`             |
| `eventScreenNames.curpValidation`        | `'CURP_VALIDATION_PROGRESS'`  |
| `eventScreenNames.curpValidationFailed`  | `'CURP_VALIDATION_FAILED'`    |
| `eventScreenNames.curpValidationSuccess` | `'CURP_VALIDATION_SUCCEEDED'` |

#### QR

| Constant                      | Wire value      |
| ----------------------------- | --------------- |
| `eventScreenNames.qrTutorial` | `'QR_TUTORIAL'` |
| `eventScreenNames.qrScan`     | `'QR_SCAN'`     |

#### OTP / Signature

| Constant                          | Wire value          |
| --------------------------------- | ------------------- |
| `eventScreenNames.smsOtp`         | `'OTP'`             |
| `eventScreenNames.simpleOTP`      | `'OTP'` (alias)     |
| `eventScreenNames.signatureInput` | `'SIGNATURE_INPUT'` |

#### ID — Front

| Constant                               | Wire value                    |
| -------------------------------------- | ----------------------------- |
| `eventScreenNames.frontTutorial`       | `'FRONT_ID_CAPTURE_TUTORIAL'` |
| `eventScreenNames.frontCameraCapture`  | `'FRONT_ID_CAMERA_CAPTURE'`   |
| `eventScreenNames.frontHelp`           | `'FRONT_ID_HELP'`             |
| `eventScreenNames.frontReviewPhoto`    | `'FRONT_ID_REVIEW_PHOTO'`     |
| `eventScreenNames.frontUploadProgress` | `'FRONT_ID_UPLOAD_PROGRESS'`  |
| `eventScreenNames.frontAttemptFailed`  | `'FRONT_ID_ATTEMPT_FAILED'`   |
| `eventScreenNames.frontUploadSuccess`  | `'FRONT_ID_UPLOAD_SUCCEEDED'` |

#### ID — Back

| Constant                              | Wire value                   |
| ------------------------------------- | ---------------------------- |
| `eventScreenNames.backTutorial`       | `'BACK_ID_CAPTURE_TUTORIAL'` |
| `eventScreenNames.backCameraCapture`  | `'BACK_ID_CAMERA_CAPTURE'`   |
| `eventScreenNames.backHelp`           | `'BACK_ID_HELP'`             |
| `eventScreenNames.backReviewPhoto`    | `'BACK_ID_REVIEW_PHOTO'`     |
| `eventScreenNames.backUploadProgress` | `'BACK_ID_UPLOAD_PROGRESS'`  |
| `eventScreenNames.backAttemptFailed`  | `'BACK_ID_ATTEMPT_FAILED'`   |
| `eventScreenNames.backUploadSuccess`  | `'BACK_ID_UPLOAD_SUCCEEDED'` |

#### Passport

| Constant                            | Wire value            |
| ----------------------------------- | --------------------- |
| `eventScreenNames.passportTutorial` | `'TUTORIAL_PASSPORT'` |

#### Document Capture

| Constant                                  | Wire value                      |
| ----------------------------------------- | ------------------------------- |
| `eventScreenNames.documentTutorial`       | `'DOCUMENT_CAPTURE_TUTORIAL'`   |
| `eventScreenNames.documentCameraCapture`  | `'DOCUMENT_CAMERA_CAPTURE'`     |
| `eventScreenNames.documentHelp`           | `'DOCUMENT_HELP'`               |
| `eventScreenNames.documentReviewPhoto`    | `'DOCUMENT_REVIEW_PHOTO'`       |
| `eventScreenNames.documentUploadProgress` | `'DOCUMENT_UPLOAD_IN_PROGRESS'` |
| `eventScreenNames.documentAttemptFailed`  | `'DOCUMENT_ATTEMPT_FAILED'`     |
| `eventScreenNames.documentUploadSuccess`  | `'DOCUMENT_UPLOAD_SUCCEEDED'`   |

#### Digital ID

| Constant                                        | Wire value                          |
| ----------------------------------------------- | ----------------------------------- |
| `eventScreenNames.digitalIdFileSelection`       | `'DIGITAL_ID_FILE_SELECTION'`       |
| `eventScreenNames.digitalIdFileReview`          | `'DIGITAL_ID_FILE_REVIEW'`          |
| `eventScreenNames.digitalIdUploadProgress`      | `'DIGITAL_ID_UPLOAD_PROGRESS'`      |
| `eventScreenNames.digitalIdUploadSuccess`       | `'DIGITAL_ID_UPLOAD_SUCCEEDED'`     |
| `eventScreenNames.digitalIdUploadFailed`        | `'DIGITAL_ID_UPLOAD_FAILED'`        |
| `eventScreenNames.digitalIdAnalysisProgress`    | `'DIGITAL_ID_ANALYSIS_PROGRESS'`    |
| `eventScreenNames.digitalIdVerificationSuccess` | `'DIGITAL_ID_VERIFICATION_SUCCESS'` |
| `eventScreenNames.digitalIdVerificationFailed`  | `'DIGITAL_ID_VERIFICATION_FAILED'`  |

#### Conference

| Constant                                 | Wire value                  |
| ---------------------------------------- | --------------------------- |
| `eventScreenNames.conferenceWait`        | `'CONFERENCE_WAIT'`         |
| `eventScreenNames.conferenceVideoChat`   | `'CONFERENCE_VIDEO_CHAT'`   |
| `eventScreenNames.conferenceMessageChat` | `'CONFERENCE_MESSAGE_CHAT'` |

#### Video Selfie

| Constant                                             | Wire value                                 |
| ---------------------------------------------------- | ------------------------------------------ |
| `eventScreenNames.videoSelfieTutorial`               | `'VIDEO_SELFIE_TUTORIAL'`                  |
| `eventScreenNames.videoSelfie`                       | `'VIDEO_SELFIE'`                           |
| `eventScreenNames.videoSelfieFaceCapture`            | `'VIDEO_SELFIE_FACE_CAPTURE'`              |
| `eventScreenNames.videoSelfieFaceUploadProgress`     | `'VIDEO_SELFIE_FACE_UPLOAD_PROGRESS'`      |
| `eventScreenNames.videoSelfieFaceAttemptFailed`      | `'VIDEO_SELFIE_FACE_ATTEMPT_FAILED'`       |
| `eventScreenNames.videoSelfieFaceUploadSucceeded`    | `'VIDEO_SELFIE_FACE_UPLOAD_SUCCEEDED'`     |
| `eventScreenNames.videoSelfieFrontIdCapture`         | `'VIDEO_SELFIE_FRONT_ID_CAPTURE'`          |
| `eventScreenNames.videoSelfieFrontIdUploadProgress`  | `'VIDEO_SELFIE_FRONT_ID_UPLOAD_PROGRESS'`  |
| `eventScreenNames.videoSelfieFrontIdAttemptFailed`   | `'VIDEO_SELFIE_FRONT_ID_ATTEMPT_FAILED'`   |
| `eventScreenNames.videoSelfieFrontIdUploadSucceeded` | `'VIDEO_SELFIE_FRONT_ID_UPLOAD_SUCCEEDED'` |
| `eventScreenNames.videoSelfieBackIdCapture`          | `'VIDEO_SELFIE_BACK_ID_CAPTURE'`           |
| `eventScreenNames.videoSelfieBackIdUploadProgress`   | `'VIDEO_SELFIE_BACK_ID_UPLOAD_PROGRESS'`   |
| `eventScreenNames.videoSelfieBackIdAttemptFailed`    | `'VIDEO_SELFIE_BACK_ID_ATTEMPT_FAILED'`    |
| `eventScreenNames.videoSelfieBackIdUploadSucceeded`  | `'VIDEO_SELFIE_BACK_ID_UPLOAD_SUCCEEDED'`  |
| `eventScreenNames.videoSelfieDocumentCapture`        | `'VIDEO_SELFIE_DOCUMENT_CAPTURE'`          |
| `eventScreenNames.videoSelfieVoiceQuestion`          | `'VIDEO_SELFIE_VOICE_QUESTION'`            |
| `eventScreenNames.videoSelfieVoiceFinalQuestion`     | `'VIDEO_SELFIE_VOICE_FINAL_QUESTION'`      |
| `eventScreenNames.videoSelfieVideoUpload`            | `'VIDEO SELFIE VIDEO UPLOAD'`              |

#### eKYC / eKYB / Forms

| Constant                         | Wire value         |
| -------------------------------- | ------------------ |
| `eventScreenNames.ekycInput`     | `'EKYC_INPUT'`     |
| `eventScreenNames.ekycProgress`  | `'EKYC_PROGRESS'`  |
| `eventScreenNames.ekycSucceeded` | `'EKYC_SUCCEEDED'` |
| `eventScreenNames.ekycFailed`    | `'EKYC_FAILED'`    |
| `eventScreenNames.ekybForm`      | `'EKYB_FORM'`      |
| `eventScreenNames.forms`         | `'FORMS'`          |

#### Watchlists

| Constant                                   | Wire value                     |
| ------------------------------------------ | ------------------------------ |
| `eventScreenNames.globalWatchListInput`    | `'GLOBAL_WATCHLIST_INPUT'`     |
| `eventScreenNames.globalWatchListProgress` | `'GLOBAL_WATCHLIST_PROGRESS'`  |
| `eventScreenNames.globalWatchListSuccess`  | `'GLOBAL_WATCHLIST_SUCCEEDED'` |
| `eventScreenNames.globalWatchListFailed`   | `'GLOBAL_WATCHLIST_FAILED'`    |
| `eventScreenNames.customWatchListInput`    | `'CUSTOM_WATCHLIST_INPUT'`     |
| `eventScreenNames.customWatchListProgress` | `'CUSTOM_WATCHLIST_PROGRESS'`  |
| `eventScreenNames.customWatchListSuccess`  | `'CUSTOM_WATCHLIST_SUCCEEDED'` |
| `eventScreenNames.customWatchListFailed`   | `'CUSTOM_WATCHLIST_FAILED'`    |

#### Phone / Email / Instant Verify

| Constant                         | Wire value         |
| -------------------------------- | ------------------ |
| `eventScreenNames.phoneInput`    | `'PHONE_INPUT'`    |
| `eventScreenNames.emailInput`    | `'EMAIL_INPUT'`    |
| `eventScreenNames.instantVerify` | `'INSTANT_VERIFY'` |

#### Custom Module

| Constant                                  | Wire value                   |
| ----------------------------------------- | ---------------------------- |
| `eventScreenNames.customModuleCallback`   | `'CUSTOM_MODULE_CALLBACK'`   |
| `eventScreenNames.customModuleProcessing` | `'CUSTOM_MODULE_PROCESSING'` |

### Video Selfie Events

```typescript
import { videoSelfieEvents } from '@incodetech/core/events';
```

| Constant                                             | Wire value                           |
| ---------------------------------------------------- | ------------------------------------ |
| `videoSelfieEvents.imageTooBlurry`                   | `'imageTooBlurry'`                   |
| `videoSelfieEvents.fillFrame`                        | `'fillFrame'`                        |
| `videoSelfieEvents.checkCameraOrLighting`            | `'checkCameraOrLighting'`            |
| `videoSelfieEvents.frontIdCaptureStarted`            | `'frontIdCaptureStarted'`            |
| `videoSelfieEvents.lookAtCamera`                     | `'lookAtCamera'`                     |
| `videoSelfieEvents.moveCloser`                       | `'moveCloser'`                       |
| `videoSelfieEvents.lookingForFrontId`                | `'lookingForFrontId'`                |
| `videoSelfieEvents.lookingForBackId`                 | `'lookingForBackId'`                 |
| `videoSelfieEvents.cameraSwitchToBack`               | `'cameraSwitchToBack'`               |
| `videoSelfieEvents.cameraSwitchToFront`              | `'cameraSwitchToFront'`              |
| `videoSelfieEvents.audioStreamOpened`                | `'audioStreamOpened'`                |
| `videoSelfieEvents.audioStreamClosed`                | `'audioStreamClosed'`                |
| `videoSelfieEvents.videoSelfieVideoUploadInProgress` | `'videoSelfieVideoUploadInProgress'` |
| `videoSelfieEvents.videoSelfieTosNotAccepted`        | `'videoSelfieTosNotAccepted'`        |
| `videoSelfieEvents.videoSelfieTosAccepted`           | `'videoSelfieTosAccepted'`           |
| `videoSelfieEvents.videoSelfieStreamCreated`         | `'videoSelfieStreamCreated'`         |
| `videoSelfieEvents.videoSelfieStreamDestroyed`       | `'videoSelfieStreamDestroyed'`       |
| `videoSelfieEvents.videoSelfieReconnecting`          | `'videoSelfieReconnecting'`          |
| `videoSelfieEvents.videoSelfieReconnected`           | `'videoSelfieReconnected'`           |

## Event Queue

Events sent before the SDK is configured (before `setup()` is called with a token) are automatically queued. When `setup()` is called with a token, all queued events are automatically flushed and sent.

```typescript
// This event will be queued
addEvent({ code: 'sdkLoading', payload: { timestamp: Date.now() } });

// Later, after setup with token
await setup({ apiURL: '...', token: 'session-token' });
// ^ Queued events are automatically sent here
```

## Common Event Codes

The SDK automatically sends these events from built-in modules:

| Code                         | Description                 | When Sent                        |
| ---------------------------- | --------------------------- | -------------------------------- |
| `moduleOpened`               | Module started              | When module component mounts     |
| `moduleClosed`               | Module ended                | When module component unmounts   |
| `screenOpened`               | Screen displayed            | When screen component mounts     |
| `screenClosed`               | Screen hidden               | When screen component unmounts   |
| `continue`                   | User continued              | When user clicks continue/submit |
| `tutorialSelfie`             | Selfie tutorial shown       | When selfie tutorial displays    |
| `tutorialVideoStarted`       | ID tutorial video started   | When ID tutorial video plays     |
| `captureAttemptFinished`     | Capture attempt completed   | After capture upload completes   |
| `strSessionDidConnect`       | Recording session connected | When video recording starts      |
| `strStreamVideoCaptureStart` | Video capture started       | When video recording begins      |

## Examples

### Track Custom Button Click

```typescript
import { addEvent, eventModuleNames } from '@incodetech/core/events';

function handleSubmit() {
  addEvent({
    code: 'customSubmitClicked',
    module: eventModuleNames.phone,
    payload: { timestamp: Date.now() },
  });
  
  // Your submit logic...
}
```

### Track Screen Transition

```typescript
import {
  screenEvent,
  eventModuleNames,
  eventScreenNames,
} from '@incodetech/core/events';

function navigateToTutorial() {
  screenEvent({
    module: eventModuleNames.id,
    screen: eventScreenNames.frontTutorial,
    code: 'screenOpened',
  });
  
  // Navigate...
}
```

### Track Module Lifecycle in Headless Mode

```typescript
import {
  moduleOpened,
  moduleClosed,
  eventModuleNames,
} from '@incodetech/core/events';

function MyCustomPhoneFlow() {
  useEffect(() => {
    moduleOpened(eventModuleNames.phone);
    
    return () => {
      moduleClosed(eventModuleNames.phone);
    };
  }, []);
  
  // Your custom implementation...
}
```

## Best Practices

1. **Use constants** - Always use `eventModuleNames` and `eventScreenNames` instead of hardcoded strings
2. **Fire-and-forget** - Don't await `addEvent()` - it's designed to never block
3. **Use hooks for lifecycle** - Use `useModuleEvents`/`useScreenEvents` for automatic tracking
4. **Include context** - Add relevant data in `payload` for debugging
5. **Don't track sensitive data** - Never include PII or sensitive information in event payloads
6. **Use subscribers for custom logging** - Use `subscribeEvent()` for custom analytics or logging needs
7. **Keep listeners lightweight** - Event listeners are called synchronously; avoid heavy operations

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Using events in headless mode
- [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/): SDK callbacks vs dashboard events
- [API Reference](/sdk-reference/web-sdk-2-reference/): Full API documentation

---

- Path: `sdk-reference/web-sdk-2-framework-integration`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-framework-integration/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-framework-integration.md

# Framework Integration

<Component slug="web-2-x-implementation-warning" />

Every Incode UI module ships as a [standard Web Component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) — registered via a side-effect import (`import '@incodetech/web/<module>'`) and consumed like any HTML element. Because the elements are framework-agnostic, the same SDK code runs from vanilla HTML, React, Angular, Vue, or any other web framework. The only difference is how each framework lets you mount custom elements and bind non-string properties.

This page documents the four mainstream paths. All of them share one rule:

> **Set `config`, `onFinish`, and `onError` as JavaScript properties on the element**, not as HTML attributes. They are object/function values, not strings, so they can't go through `setAttribute`. Each framework section below shows how to do that idiomatically.

## Vanilla HTML / TypeScript

```html
<incode-flow id="flow"></incode-flow>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/flow';
  import '@incodetech/web/flow/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: session.token,
  });

  const flow = document.getElementById('flow');
  flow.config = { token: session.token };
  flow.onFinish = (result) => {
    /* ... */
  };
</script>
```

The same shape applies to every other module — replace `flow` with `phone`, `selfie`, `id`, etc., and set the corresponding config / handlers on the element.

## React

### Universal pattern (works on React 16.8+)

Use the custom element directly with a ref. React renders custom elements as-is, and you assign non-string properties imperatively in `useEffect`. This works on every React version since hooks landed:

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

type FlowElement = HTMLElement & {
  config: FlowConfig;
  onFinish: (result?: FinishStatus) => void;
};

export function MyFlow({ token }: { token: string }) {
  const ref = useRef<FlowElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = { token };
    el.onFinish = (result) => console.log('Done:', result);
  }, [token]);

  return (
    <incode-flow ref={ref} style={{ display: 'block', height: '100vh' }} />
  );
}
```

### React 19+ shortcut

React 19 ships native custom-element support: it sets non-string JSX props as DOM properties and bridges `on*` props through `addEventListener`. If you're on React 19 you can drop the ref + `useEffect` ceremony entirely:

```tsx
import { setup } from '@incodetech/core';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

export function MyFlow({ token }: { token: string }) {
  return (
    <incode-flow
      config={{ token }}
      onFinish={(result) => console.log('Done:', result)}
      onError={(error, code) => console.error(error, code)}
      style={{ display: 'block', height: '100vh' }}
    />
  );
}
```

This shortcut **does not work on React 18 or earlier** — those versions serialize JSX props through `setAttribute`, which coerces `config={{token}}` to the string `"[object Object]"`. Use the universal pattern above unless you're certain every consumer of your code is on React 19+.

### TypeScript: JSX support for `incode-*` tags

**React 19+** treats unknown lowercase tags as HTML elements automatically — no extra TypeScript setup is needed.

**React 18 and earlier** strict-checks `JSX.IntrinsicElements`, so referencing `<incode-flow>` (or any other Incode tag) directly in JSX errors out. Add a one-time augmentation somewhere in your project (e.g. `src/types/incode.d.ts`) that covers every `incode-*` tag your app uses:

```ts
// src/types/incode.d.ts
import 'react';

type IncodeElementAttrs = React.DetailedHTMLProps<
  React.HTMLAttributes<HTMLElement>,
  HTMLElement
>;

declare global {
  namespace JSX {
    interface IntrinsicElements {
      'incode-flow': IncodeElementAttrs;
      'incode-flow-completed': IncodeElementAttrs;
      'incode-selfie': IncodeElementAttrs;
      'incode-id': IncodeElementAttrs;
      'incode-phone': IncodeElementAttrs;
      'incode-email': IncodeElementAttrs;
      'incode-document-capture': IncodeElementAttrs;
      'incode-face-match': IncodeElementAttrs;
      'incode-consent': IncodeElementAttrs;
      'incode-geolocation': IncodeElementAttrs;
      'incode-antifraud': IncodeElementAttrs;
      'incode-curp-validation': IncodeElementAttrs;
      'incode-identity-reuse': IncodeElementAttrs;
      'incode-redirect-to-mobile': IncodeElementAttrs;
      'incode-signature': IncodeElementAttrs;
      'incode-electronic-signature': IncodeElementAttrs;
      'incode-ae-signature': IncodeElementAttrs;
      'incode-qe-signature': IncodeElementAttrs;
      'incode-ekyc': IncodeElementAttrs;
      'incode-ekyb': IncodeElementAttrs;
      'incode-workflow': IncodeElementAttrs;
      'incode-cross-document-data-match': IncodeElementAttrs;
      // Add any other incode-* tags you mount; the shape is identical.
    }
  }
}
```

The element-specific properties (`config`, `onFinish`, `onError`) are set imperatively through the ref — that's why `IncodeElementAttrs` is just the standard HTML element shape. The full per-tag catalog lives in [Web Components](/sdk-reference/web-sdk-2-web-components/).

## Angular

Add `CUSTOM_ELEMENTS_SCHEMA` to the module that uses Incode tags:

```typescript
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';

@NgModule({
  declarations: [MyFlowComponent],
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
})
export class AppModule {}
```

Then bind to the element's properties from a template using property binding:

```html
<incode-flow
  [config]="flowConfig"
  (onFinish)="handleFinish($event)"
></incode-flow>
```

## Vue 3

Tell the template compiler to treat `incode-*` tags as custom elements:

```typescript
// vite.config.ts
import vue from '@vitejs/plugin-vue';

vue({
  template: {
    compilerOptions: {
      isCustomElement: (tag) => tag.startsWith('incode-'),
    },
  },
});
```

Then bind properties with `.prop` modifiers:

```vue
<incode-flow :config.prop="flowConfig" :onFinish.prop="handleFinish" />
```

## See also

- [Getting Started](/sdk-reference/web-sdk-2-getting-started/): three integration paths walked through end to end
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): the all-in-one component reference
- [Web Components](/sdk-reference/web-sdk-2-web-components/): full tag catalog
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): per-module reference pages
- [Troubleshooting → Build / TypeScript issues](/sdk-reference/web-sdk-2-troubleshooting/#build--typescript-issues): common JSX errors and fixes

---

- Path: `sdk-reference/web-sdk-2-getting-started`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-getting-started/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-getting-started.md

# Getting Started



This guide walks you through integrating the **Incode Web SDK** into your web application. It targets enterprise developers integrating Incode into their own product, and Incode Professional Services developers building custom integrations on a customer's behalf.

<Component slug="web-2-x-implementation-warning" />



The SDK supports three integration paths. Pick the one that matches how much UI control you need.

- **Path 1**: `<incode-flow>` drop-in
- **Path 2**: Orchestrator + module web components
- **Path 3**: Headless managers

```mermaid
flowchart TD
    A[Need identity verification?] --> B{Want any control over the UI?}
    B -->|No, just drop it in| P1["<b>Path 1</b><br/>incode-flow web component<br/>~5 lines of code"]
    B -->|Yes| C{Want to use Incode's UI for the modules themselves?}
    C -->|Yes: own the shell, use Incode's screens| P2["<b>Path 2</b><br/>Orchestrator + module web components<br/>~30 lines of code"]
    C -->|No: fully custom UI| P3["<b>Path 3</b><br/>Headless Managers<br/>~50+ lines of code"]

    style P1 fill:#e0f2fe,stroke:#0284c7,color:#0c4a6e
    style P2 fill:#fef3c7,stroke:#d97706,color:#78350f
    style P3 fill:#fce7f3,stroke:#be185d,color:#831843
```

***

## Prerequisites

Before you begin, ensure you have:

- **Incode Account**: access to the [Incode Dashboard](https://dashboard.incodesmile.com)
- **API Key**: found in the dashboard under Settings → API Keys
- **Configuration ID**: the flow ID from your dashboard configuration
- **Node.js 18+** and a modern bundler (Vite, Webpack, etc.) for module-aware imports

> **Production note:** Never expose your API key in client-side code. Create sessions from your backend and pass only the resulting token to the browser. See [Backend session creation](#production-backend-session-creation) below.

## Install

```bash
npm install @incodetech/web @incodetech/core
# or
pnpm add @incodetech/web @incodetech/core
# or
yarn add @incodetech/web @incodetech/core
```

`@incodetech/core` is the framework-agnostic SDK core (state machines, managers, business logic). `@incodetech/web` is the UI layer — every consumer-facing element ships as a standard Web Component plus its CSS.

## Initialize the SDK

Every integration path follows the same three steps: call `setup()`, create a session, then activate the session.

> **Two packages export a **`setup()`**, and you call one — never both.** `@incodetech/web`'s version calls `@incodetech/core`'s internally and adds the presentation options (`i18n`, `uiConfig`, `flow`, `theme`). The examples below use core's, because it lets `setup()` run before the session token exists so WASM warmup overlaps with your backend creating the session — the web wrapper requires `token` up front. If you render web components and already have the token, `setup()` from `@incodetech/web` wires both layers in one call. See [Which `setup()` do I call?](/sdk-reference/web-sdk-2-reference/#which-setup-do-i-call) for the full comparison, including what to call yourself when you use core's.

```ts
import { setup } from '@incodetech/core';
import { createSession, initializeSession } from '@incodetech/core/session';

// 1. Configure the SDK. Core takes apiURL, WASM, encryption, and telemetry
//    options — language and branding live on the @incodetech/web setup().
await setup({ apiURL: 'https://demo-api.incodesmile.com' });

// 2. Create a session — in production this should happen on your backend (see below)
const session = await createSession('YOUR_API_KEY', {
  configurationId: 'YOUR_CONFIGURATION_ID',
  language: 'en-US',
});

// 3. Activate the session token
await initializeSession({ token: session.token });
```

> **Why three calls?** `setup()` provisions the HTTP client and (optionally) warms up WASM; `createSession` opens the verification interview and returns a token; `initializeSession` activates the token and pre-loads session-scoped state (feature flags, device fingerprint). If your backend hands you the token directly, you can collapse steps 2 and 3 into one `initializeSession({ token })` call. `setup({ apiURL, token })` is also still supported as a one-shot convenience — it delegates to `initializeSession` for you — but the two-call form makes the boot / activation boundary explicit, which matters when you want to start `setup()` early (e.g. to warm up WASM) before the token is known.
>
> **End-to-end encryption.** Pass `encryption: true` to `setup()` to opt into encrypted transport for every SDK request. It's not a self-serve flag — your Incode account team provisions the environment and gives you a dedicated `apiURL`, an `mgf1` scheme, and an API-key transmission choice. See [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/) for the full walkthrough.

***

## Which path is right for me?

|                    | Path 1: `<incode-flow>`        | Path 2: Orchestrator + components       | Path 3: Headless                                        |
| ------------------ | ------------------------------ | --------------------------------------- | ------------------------------------------------------- |
| **UI you own**     | None                           | Shell only                              | Everything                                              |
| **UI Incode owns** | Everything                     | Module screens                          | None                                                    |
| **Lines of code**  | \~5                            | \~30                                    | \~50+                                                   |
| **Flow logic**     | Internal                       | Orchestrator                            | Manual or orchestrator                                  |
| **Best for**       | Fastest TTV, standard branding | Custom shell, Incode's tested module UX | Bespoke UI, native shells, accessibility customizations |
| **Branding**       | Theme tokens only              | Full shell, theme tokens for modules    | Full                                                    |

***

## Path 1: `<incode-flow>` drop-in

The simplest integration. Drop one custom element on the page, set its config, get a callback when verification finishes. Incode owns the entire UI: home screen, all module screens, transitions, completion.

### HTML / vanilla JS

```html
<!doctype html>
<html>
  <head>
    <style>
      html,
      body,
      #root,
      incode-flow {
        height: 100%;
        margin: 0;
      }
    </style>
  </head>
  <body>
    <div id="root"></div>

    <script type="module">
      import { setup } from '@incodetech/core';
      import {
        createSession,
        initializeSession,
      } from '@incodetech/core/session';
      import '@incodetech/web/themes/light.css';
      import '@incodetech/web/base.css';
      import '@incodetech/web/flow'; // registers <incode-flow>
      import '@incodetech/web/flow/styles.css';

      await setup({ apiURL: 'https://demo-api.incodesmile.com' });

      const session = await createSession('YOUR_API_KEY', {
        configurationId: 'YOUR_CONFIGURATION_ID',
        language: 'en-US',
      });

      await initializeSession({ token: session.token });

      const flow = document.createElement('incode-flow');
      flow.config = {
        token: session.token,
        lang: 'en-US',
        enableHome: true,
      };
      flow.onFinish = (result) => {
        console.log('Verification complete:', result);
        // result.action: 'approved' | 'rejected' | 'none'
        // result.scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | ...
        // result.redirectionUrl: string
      };
      flow.onError = (error, errorCode) => {
        console.error('Flow error:', error, errorCode);
      };

      document.getElementById('root').appendChild(flow);
    </script>
  </body>
</html>
```

### Optional: load Flow styles on demand (2.3.0)

Set `injectCss: true` to load the Flow shell and module styles as their screens become visible. It defaults to `false`, so the eager stylesheet imports above remain valid. For the opt-in path, keep theme and base CSS and omit `@incodetech/web/flow/styles.css`:

```ts
import '@incodetech/web/themes/light.css';
import '@incodetech/web/base.css';
import '@incodetech/web/flow';

const flow = document.createElement('incode-flow');
flow.config = {
  token: 'SESSION_TOKEN_FROM_YOUR_BACKEND',
  injectCss: true,
  // cssNonce: 'NONCE_FROM_YOUR_SERVER', // when required by your CSP
};
flow.onFinish = (result) => console.log(result?.action);
flow.onError = (error) => console.error(error);
document.body.appendChild(flow);
```

Initialize the SDK first, as shown above. `cssNonce` supplies the server-generated CSP nonce for injected styles; it does not replace your stylesheet or asset-host CSP rules.

### React

`<incode-flow>` is a standard custom element, so you can use it from React directly. Set non-string properties (`config`, `onFinish`, `onError`) imperatively via a ref — JSX attributes only support strings.

> **React 18 or earlier:** add the JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags) so TypeScript recognizes the Incode tags. React 19+ handles unknown lowercase tags automatically and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import '@incodetech/web/themes/light.css';
import '@incodetech/web/base.css';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

type FlowElement = HTMLElement & {
  config: FlowConfig;
  onFinish: (result?: FinishStatus) => void;
  onError: (error: string | undefined, code?: number) => void;
};

export function VerificationFlow({ token }: { token: string }) {
  const ref = useRef<FlowElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = { token, lang: 'en-US', enableHome: true };
    el.onFinish = (result) => console.log('Done:', result);
    el.onError = (error, code) => console.error(error, code);
  }, [token]);

  return (
    <incode-flow ref={ref} style={{ display: 'block', height: '100vh' }} />
  );
}
```

### What `<incode-flow>` config accepts

| Field                                | Type                           | Required | Notes                                                                   |
| ------------------------------------ | ------------------------------ | -------- | ----------------------------------------------------------------------- |
| `token`                              | `string`                       | ✅        | Session token from `createSession()`                                    |
| `lang`                               | `string`                       |          | Locale, e.g. `'en-US'`, `'es-MX'`                                       |
| `enableHome`                         | `boolean`                      |          | Show the SDK's built-in home screen                                     |
| `authHint`                           | `string`                       |          | QR/auth hint when re-entering a flow                                    |
| `redirectToMobileUrl`                | `string`                       |          | Override the destination URL for the Redirect to Mobile step            |
| `wasmConfig`                         | `WasmConfig`                   |          | Custom WASM paths (see [WASM Configuration](/sdk-reference/web-sdk-2-wasm/))        |
| `spinnerConfig`                      | `{ title?, subtitle?, size? }` |          | Customize the loading spinner copy                                      |
| `onFlowEvent`                        | `(event) => void`              |          | Stream of flow milestones (`flow.ready`, `flow.module.completed`, etc.) |
| `onModuleLoading` / `onModuleLoaded` | `(moduleKey) => void`          |          | Hooks around lazy-loaded module chunks                                  |

Self-loading variant: pass `apiKey` + `configurationId` instead of `token` and the component will create the session itself. Convenient for prototyping; **avoid in production** because it puts the API key in the browser.

***

## Path 2: Orchestrator + module web components

You own the shell — landing page, transitions, completion screen — but Incode owns each module's UI. Use the orchestrator to drive flow progression and render Incode's module web components in your own layout.

```tsx
import { useEffect, useState } from 'react';
import { setup } from '@incodetech/core';
import { createSession } from '@incodetech/core/session';
import {
  createOrchestratedFlowManager,
  type FlowModuleConfig,
  type OrchestratedFlowState,
} from '@incodetech/core/flow';
import { selfieMachine } from '@incodetech/core/selfie';
import { phoneMachine } from '@incodetech/core/phone';
import { emailMachine } from '@incodetech/core/email';
import { idCaptureMachine } from '@incodetech/core/id';
import '@incodetech/web/themes/light.css';
import '@incodetech/web/base.css';
import '@incodetech/web/selfie';
import '@incodetech/web/phone';
import '@incodetech/web/email';
import '@incodetech/web/id';

const flowManager = createOrchestratedFlowManager({
  modules: {
    SELFIE: selfieMachine,
    PHONE: phoneMachine,
    EMAIL: emailMachine,
    ID: idCaptureMachine,
  },
});

export function OrchestratedFlow({ token }: { token: string }) {
  const [state, setState] = useState<OrchestratedFlowState>(
    flowManager.getState(),
  );

  useEffect(() => {
    const unsubscribe = flowManager.subscribe(setState);
    flowManager.load();
    return () => {
      unsubscribe();
      flowManager.stop();
    };
  }, []);

  if (state.status === 'idle' || state.status === 'loading') {
    return <YourLoadingScreen />;
  }

  if (state.status === 'error') {
    return (
      <YourErrorScreen
        message={state.error}
        onRetry={() => flowManager.reset()}
      />
    );
  }

  if (state.status === 'finished') {
    return <YourCompletionScreen result={state.finishStatus} />;
  }

  if (state.status !== 'ready') {
    return <YourLoadingScreen />; // includes completion processing
  }

  // Narrowed to 'ready' — render the current module
  const { currentStep, config } = state;

  if (currentStep === 'PHONE') {
    return (
      <incode-phone
        ref={(el) => {
          if (!el) return;
          el.config = config as FlowModuleConfig['PHONE'];
          el.onFinish = () => flowManager.completeModule();
          el.onError = (err) => console.error(err);
        }}
      />
    );
  }

  if (currentStep === 'SELFIE') {
    return (
      <incode-selfie
        ref={(el) => {
          if (!el) return;
          el.config = config as FlowModuleConfig['SELFIE'];
          el.onFinish = () => flowManager.completeModule();
          el.onError = (err) => console.error(err);
        }}
      />
    );
  }

  // ... handle EMAIL, ID, etc.
  return null;
}
```

### What you control

- **The shell:** your landing page, your branding, your loading and error states, your completion view
- **When the flow starts:** call `flowManager.load()` only after the user clicks "Start"
- **When to advance:** call `flowManager.completeModule()` on each module's `onFinish`
- **Reset / retry:** `flowManager.reset()` returns to idle; the user can begin the flow again

### Orchestrator state shape

Every variant carries `homeScreen` (visibility of the SDK's built-in home screen, when enabled) and `presentation` (UI hints used by `<incode-flow>` for transition timing). For Path 2 you can usually ignore these and let your shell own the loading/transition UX.

```ts
type OrchestratedFlowHomeScreen = {
  visible: boolean;
  isContinueLoading: boolean;
};

type OrchestratedFlowPresentation = {
  isAwaitingReady: boolean;
  lazyModuleKey: string | undefined;
  shouldPrefetchHome: boolean;
};

type OrchestratedFlowState =
  | {
      status: 'idle';
      homeScreen: OrchestratedFlowHomeScreen;
      presentation: OrchestratedFlowPresentation;
    }
  | {
      status: 'loading';
      homeScreen: OrchestratedFlowHomeScreen;
      presentation: OrchestratedFlowPresentation;
    }
  | {
      status: 'ready';
      flow: Flow;
      steps: string[];
      currentStepIndex: number;
      currentStep: string | undefined;
      config: unknown;
      moduleState: unknown;
      homeScreen: OrchestratedFlowHomeScreen;
      presentation: OrchestratedFlowPresentation;
    }
  | {
      status: 'finished';
      flow: Flow;
      finishStatus: FinishStatus;
      homeScreen: OrchestratedFlowHomeScreen;
      presentation: OrchestratedFlowPresentation;
    }
  | {
      status: 'error';
      error: string;
      homeScreen: OrchestratedFlowHomeScreen;
      presentation: OrchestratedFlowPresentation;
    };
```

`config` and `moduleState` are typed as `unknown` because they vary by module. Cast via `FlowModuleConfig[<step>]` (e.g. `FlowModuleConfig['PHONE']`) when handing them to the corresponding component.

> **WASM warmup:** Path 2 lets you load WASM only for modules that actually need it. Use `getRequiredWasmPipelines(state.flow)` (from `@incodetech/core/flow`) plus `warmupWasm` (from `@incodetech/core/wasm`) on the `'ready'` transition. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).

***

## Path 3: Headless Managers

You own everything — including each module's UI. Use the per-module Manager APIs to drive state machines directly, subscribe to state, and render whatever interface you want (React Native via web view, AR overlay, server-rendered HTML, terminal UI, anything).

This is the most code, but also the most flexibility.

```ts
import { setup } from '@incodetech/core';
import { createSession, initializeSession } from '@incodetech/core/session';
import { createPhoneManager } from '@incodetech/core/phone';

await setup({ apiURL: 'https://demo-api.incodesmile.com' });

const session = await createSession('YOUR_API_KEY', {
  configurationId: 'YOUR_CONFIGURATION_ID',
});

await initializeSession({ token: session.token });

const phoneManager = createPhoneManager({
  config: {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
    maxOtpAttempts: 3,
  },
});

const unsubscribe = phoneManager.subscribe((state) => {
  switch (state.status) {
    case 'inputting':
      renderPhoneInputForm({
        countryCode: state.countryCode,
        onSubmit: (phone, isValid) => {
          phoneManager.setPhoneNumber(phone, isValid);
          phoneManager.submit();
        },
      });
      break;
    case 'awaitingOtp':
      renderOtpForm({
        canResend: state.canResend,
        timer: state.resendTimer,
        onSubmit: (otp) => phoneManager.submitOtp(otp),
        onResend: () => phoneManager.resendOtp(),
      });
      break;
    case 'finished':
      console.log('Phone verified!');
      unsubscribe();
      phoneManager.stop();
      break;
    case 'error':
      console.error('Phone error:', state.error);
      break;
  }
});

phoneManager.load();
```

### Manager API surface (every module)

All managers follow the same shape:

| Method                | Purpose                                                      |
| --------------------- | ------------------------------------------------------------ |
| `getState()`          | Snapshot of current state                                    |
| `subscribe(callback)` | Listen to state transitions; returns an unsubscribe function |
| Module-specific entry | Usually `load()`; Video Selfie uses `start()` |
| `stop()`              | Tear down — always call before unmount                       |

Plus module-specific methods (e.g. `setPhoneNumber`, `submit`, `submitOtp`, `requestPermission`, `capture`, `retryCapture`, etc.). See [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/) for per-module API references and state shapes.

### Composing modules headlessly

You can either drive each module manager directly (as above) or use `createOrchestratedFlowManager` _without_ rendering any of Incode's UI components — subscribe to the orchestrator's state and render your own UI for every module. Same pattern as Path 2; you just don't import `@incodetech/web/*` at all.

***

## Result handling

When verification finishes, you get a `FinishStatus`:

```ts
type FinishStatus = {
  redirectionUrl: string;
  action: 'approved' | 'rejected' | 'none';
  scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'MANUAL_FAIL' | 'FAIL' | 'UNKNOWN';
  endScreenTitle: string | null;
  endScreenText: string | null;
};
```

| `scoreStatus` | Meaning                              |
| ------------- | ------------------------------------ |
| `OK`          | Passed all checks                    |
| `WARN`        | Passed with minor concerns           |
| `MANUAL_OK`   | Needs manual review, leaning approve |
| `MANUAL_FAIL` | Needs manual review, leaning reject  |
| `FAIL`        | Failed verification                  |
| `UNKNOWN`     | Status not yet determined            |

`onFinish` on the client is a notification, not the source of truth. Always confirm the verification outcome from your backend by calling Incode's server API with the session token — client-side data can be tampered with.

***

## Production: backend session creation

`@incodetech/core` is a frontend SDK and shouldn't be imported on the server. Instead, call Incode's REST API directly from your backend with whichever HTTP client your stack uses. The endpoint your backend hits is the same one the frontend `createSession()` helper wraps:

```
POST {apiURL}/omni/start
Headers:
  x-api-key: <your API key>
  api-version: 1.0
  content-type: application/json
Body:
  { "configurationId": "<flow ID>", "externalId": "<your user reference>", "language": "en-US" }
```

The response is JSON with at least `{ token, interviewId }`. Forward only the `token` to the browser.

```ts
// Backend (Node.js 18+ — uses native fetch; works the same with axios or any HTTP client)
app.post('/api/incode/start', async (req, res) => {
  const response = await fetch('https://demo-api.incodesmile.com/omni/start', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.INCODE_API_KEY,
      'api-version': '1.0',
      'content-type': 'application/json',
    },
    body: JSON.stringify({
      configurationId: process.env.INCODE_CONFIG_ID,
      externalId: req.user.id, // link the session to your user
    }),
  });

  if (!response.ok) {
    return res
      .status(response.status)
      .json({ error: 'Failed to create Incode session' });
  }

  const { token } = await response.json();
  res.json({ token });
});
```

```ts
// Frontend
const response = await fetch('/api/incode/start', { method: 'POST' });
const { token } = await response.json();

await setup({ apiURL: 'https://demo-api.incodesmile.com' });
await initializeSession({ token });
// proceed with Path 1, 2, or 3
```

***

## Next steps

| Goal                                        | Where to look                                              |
| ------------------------------------------- | ---------------------------------------------------------- |
| See every module the SDK ships              | [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)     |
| Reference for the `<incode-flow>` component | [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/) |
| Per-module headless API                     | [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/)               |
| Customize colors and typography             | [Theming & Styling](/sdk-reference/web-sdk-2-theming/)                 |
| Configure WASM hosting                      | [WASM Configuration](/sdk-reference/web-sdk-2-wasm/)                   |
| Reduce bundle size                          | [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/)   |
| Localize the SDK                            | [Internationalization](/sdk-reference/web-sdk-2-i18n/)                 |
| Subscribe to flow events                    | [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/)           |
| Handle errors and edge cases                | [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/)           |

---

- Path: `sdk-reference/web-sdk-2-headless-mode`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-headless-mode/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-headless-mode.md

# Headless Mode

<Component slug="web-2-x-implementation-warning" />

Headless mode lets you use the SDK's core logic without any pre-built UI. This is perfect for:

- Custom UI implementations with your own design system
- Back-end-driven verification flows
- Automated testing
- React Native or other non-web platforms

## How It Works

Each verification module provides a **manager** that encapsulates state machine logic. You subscribe to state changes and call methods to drive the flow.

```mermaid
flowchart LR
    subgraph "Your Application"
        UI[Custom UI]
    end

    subgraph "@incodetech/core"
        Manager[Manager]
        StateMachine[State Machine]
        API[Incode API]
    end

    UI -->|"subscribe()"| Manager
    UI -->|"load(), submit(), etc."| Manager
    Manager -->|state updates| UI
    Manager <--> StateMachine
    StateMachine <--> API
```

## Available Managers

| Module            | Manager Factory                   | Import                    |
| ----------------- | --------------------------------- | ------------------------- |
| Phone             | `createPhoneManager()`            | `@incodetech/core/phone`  |
| Email             | `createEmailManager()`            | `@incodetech/core/email`  |
| Selfie            | `createSelfieManager()`           | `@incodetech/core/selfie` |
| ID Capture        | `createIdCaptureManager()`        | `@incodetech/core/id`     |
| Device Wallet (mDL) | `createDeviceWalletManager()` (or one-shot `renderWallet()`) | `@incodetech/core/id` |
| Orchestrated Flow | `createOrchestratedFlowManager()` | `@incodetech/core/flow`   |



## Setup

Before using any manager, configure the SDK and activate your session token.

Headless integrations call `setup()` from `@incodetech/core`. The `@incodetech/web` wrapper exists to configure the component layer, so a headless app has nothing to gain from it — and importing it pulls in UI code you do not render. See [Which `setup()` do I call?](/sdk-reference/web-sdk-2-reference/#which-setup-do-i-call).

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';

await setup({ apiURL: 'https://demo-api.incodesmile.com' });
await initializeSession({
  token: 'your-session-token' /* from createSession() */,
});
```

`setup` provisions the HTTP client and (optionally) warms up WASM; `initializeSession` activates the session token and pre-loads session-scoped state. The two-call form lets you start `setup` (including WASM warmup) before the token is known. The one-shot form `setup({ apiURL, token })` is still supported as a convenience — it delegates to `initializeSession` for you.

Flow-backed standalone configuration is lazy by default. Resolve a module's Flow configuration asynchronously, then pass the result to the existing synchronous manager factory. Enable both setup prefetch and supplied-config merging when you need both behaviors:

```typescript
import { setup } from '@incodetech/core';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';
import { createIdCaptureManager, type IdCaptureConfig } from '@incodetech/core/id';

await setup({
  apiURL,
  token,
  flow: { preload: true, mergeConfig: true },
});

const config = await resolveDashboardModuleConfig({
  moduleKey: 'ID',
  config: {
    showTutorial: false,
    captureAttempts: 5,
  },
});

const manager = createIdCaptureManager({ config });
manager.load();
```

Omitting `flow` or passing `{}` makes no setup request: supplied config is returned verbatim without a session requirement, while omitted config resolves Flow when requested.

`flow: { preload: true }` fetches and awaits Flow during setup but still returns supplied config verbatim. `flow: { mergeConfig: true }` merges supplied partial config over Flow config when the resolver runs and does not imply setup prefetch. Combine both flags for both behaviors.

`flow: false` prevents standalone Flow resolution; supplied config still works and omitted config errors. The resolver shares any prefetched request with orchestrated Flow, while each caller applies its own normalization. It strictly rejects Workflow-only sessions, missing Flows, and module keys absent from the active Flow. Duplicate modules can be selected with `occurrence`. Workflow child modules retain their orchestrator-provided configuration and do not trigger standalone fallback.



## Phone Verification

### Quick Start

```typescript
import { createPhoneManager } from '@incodetech/core/phone';

// 1. Create manager with configuration
const manager = createPhoneManager({
  config: {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  },
});

// 2. Subscribe to state changes
manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'finished') {
    console.log('Phone verified!');
    manager.stop();
  }
});

// 3. Start the flow
manager.load();

// 4. When state is 'inputting', set the phone number
manager.setPhoneNumber('+14155551234', true);
manager.submit();

// 5. When state is 'awaitingOtp', submit the OTP
manager.submitOtp('ABC123');
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| inputting
    inputting -->|submit| awaitingOtp
    awaitingOtp -->|submitOtp| finished
    awaitingOtp -.->|back| inputting
```

### States Reference

| Status              | Description               | Properties                                                  |
| ------------------- | ------------------------- | ----------------------------------------------------------- |
| `idle`              | Initial state             | –                                                           |
| `loadingPrefill`    | Fetching pre-filled phone | –                                                           |
| `inputting`         | Ready for phone input     | `countryCode`, `phonePrefix`, `phoneError?`                 |
| `submitting`        | Submitting phone number   | –                                                           |
| `sendingInitialOtp` | Sending first OTP         | –                                                           |
| `resendingOtp`      | Resending OTP             | –                                                           |
| `awaitingOtp`       | Waiting for OTP entry     | `resendTimer`, `canResend`, `attemptsRemaining`             |
| `verifyingOtp`      | Verifying OTP code        | `resendTimer`, `canResend`                                  |
| `otpError`          | OTP verification failed   | `otpError`, `attemptsRemaining`, `resendTimer`, `canResend` |
| `finished`          | Verification complete     | –                                                           |
| `error`             | Fatal error               | `error`                                                     |

### API Methods

| Method                           | Description                                    | When to Use                         |
| -------------------------------- | ---------------------------------------------- | ----------------------------------- |
| `load()`                         | Initializes the flow                           | Always call first                   |
| `setPhoneNumber(phone, isValid)` | Sets phone number and validation state         | When `inputting`, before `submit()` |
| `setOptInGranted(granted)`       | Sets marketing opt-in preference               | When `inputting`, if opt-in enabled |
| `submit()`                       | Submits the phone number                       | After setting valid phone           |
| `setOtpCode(code)`               | Sets OTP without submitting (controlled input) | When `awaitingOtp`                  |
| `submitOtp(code)`                | Sets and submits OTP                           | When `awaitingOtp` or `otpError`    |
| `resendOtp()`                    | Requests new OTP code                          | When `canResend` is true            |
| `back()`                         | Returns to phone input                         | When `awaitingOtp`                  |
| `reset()`                        | Resets to initial state                        | In `error`; create a new manager after `finished`         |
| `stop()`                         | Cleanup resources                              | When unmounting                     |
| `getState()`                     | Returns current state synchronously            | Anytime                             |
| `subscribe(callback)`            | Subscribe to state changes                     | Returns unsubscribe function        |

### Configuration Options

```typescript
type PhoneConfig = {
  otpVerification: boolean; // Require OTP verification (default: true)
  otpExpirationInMinutes: number; // OTP validity in minutes (default: 5)
  prefill: boolean; // Fetch pre-filled phone from back end
  isInstantVerify?: boolean; // Use instant verification API
  optinEnabled?: boolean; // Show marketing opt-in checkbox
  maxOtpAttempts?: number; // Max OTP attempts (default: 3)
};
```



## Email Verification

Email verification works identically to phone verification.

### Quick Start

```typescript
import { createEmailManager } from '@incodetech/core/email';

const manager = createEmailManager({
  config: {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  },
});

manager.subscribe((state) => {
  if (state.status === 'finished') {
    console.log('Email verified!');
    manager.stop();
  }
});

manager.load();
manager.setEmail('user@example.com', true);
manager.submit();

// When state is 'awaitingOtp'
manager.submitOtp('ABC123');
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| inputting
    inputting -->|submit| awaitingOtp
    awaitingOtp -->|submitOtp| finished
    awaitingOtp -.->|back| inputting
```

### States Reference

| Status              | Description               | Properties                                                  |
| ------------------- | ------------------------- | ----------------------------------------------------------- |
| `idle`              | Initial state             | –                                                           |
| `loadingPrefill`    | Fetching pre-filled email | –                                                           |
| `inputting`         | Ready for email input     | `prefilledEmail?`, `emailError?`                            |
| `submitting`        | Submitting email          | –                                                           |
| `sendingInitialOtp` | Sending first OTP         | –                                                           |
| `resendingOtp`      | Resending OTP             | –                                                           |
| `awaitingOtp`       | Waiting for OTP entry     | `resendTimer`, `canResend`, `attemptsRemaining`             |
| `verifyingOtp`      | Verifying OTP code        | `resendTimer`, `canResend`                                  |
| `otpError`          | OTP verification failed   | `otpError`, `attemptsRemaining`, `resendTimer`, `canResend` |
| `finished`          | Verification complete     | –                                                           |
| `error`             | Fatal error               | `error`                                                     |

### API Methods

| Method                     | Description                         | When to Use                         |
| -------------------------- | ----------------------------------- | ----------------------------------- |
| `load()`                   | Initializes the flow                | Always call first                   |
| `setEmail(email, isValid)` | Sets email and validation state     | When `inputting`, before `submit()` |
| `submit()`                 | Submits the email                   | After setting valid email           |
| `setOtpCode(code)`         | Sets OTP without submitting         | When `awaitingOtp`                  |
| `submitOtp(code)`          | Sets and submits OTP                | When `awaitingOtp` or `otpError`    |
| `resendOtp()`              | Requests new OTP code               | When `canResend` is true            |
| `back()`                   | Returns to email input              | When `awaitingOtp`                  |
| `reset()`                  | Resets to initial state             | In `error`; create a new manager after `finished`         |
| `stop()`                   | Cleanup resources                   | When unmounting                     |
| `getState()`               | Returns current state synchronously | Anytime                             |
| `subscribe(callback)`      | Subscribe to state changes          | Returns unsubscribe function        |



## Selfie Capture

Selfie capture is more complex due to camera handling and ML-powered face detection. **Requires WASM configuration.**

### Quick Start

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import { createSelfieManager } from '@incodetech/core/selfie';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';

// Preload the selfie WASM pipeline as part of setup() — Incode CDN
// defaults are used unless you override paths. See WASM Configuration
// for self-hosted paths and the lower-level warmupWasm() API.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['selfie'] },
});
await initializeSession({ token: 'your-token' });

const config = await resolveDashboardModuleConfig({ moduleKey: 'SELFIE' });
const manager = createSelfieManager({ config });

manager.subscribe((state) => {
  switch (state.status) {
    case 'tutorial':
      // Show your tutorial UI
      // Call manager.nextStep() when user is ready
      break;

    case 'permissions':
      // Show permission request UI
      if (state.permissionStatus === 'denied') {
        // Show instructions to enable camera
      }
      break;

    case 'capture':
      // Camera is active
      // state.stream - MediaStream for <video> element
      // state.detectionStatus - Current face detection feedback
      // state.captureStatus - 'detecting', 'capturing', 'uploading', etc.
      break;

    case 'finished':
      console.log('Selfie captured!', state.processResponse);
      manager.stop();
      break;

    case 'error':
      console.error('Error:', state.error);
      break;
  }
});

manager.load();
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| tutorial
    tutorial -->|nextStep| permissions
    permissions -->|granted| capture
    capture -->|upload done| processing
    processing -->|success| finished
```

### States Reference

| Status        | Description                                                                                                                                                                        | Properties                                                                        |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `idle`        | Initial state                                                                                                                                                                      | –                                                                                 |
| `loading`     | Checking permissions                                                                                                                                                               | –                                                                                 |
| `tutorial`    | Showing tutorial. Entered when `showTutorial` is `true` **or** `ageAssurance` is `true` (the age-assurance copy doubles as the privacy notice, so it survives a disabled tutorial) | –                                                                                 |
| `permissions` | Handling camera access                                                                                                                                                             | `permissionStatus`                                                                |
| `capture`     | Camera active                                                                                                                                                                      | `stream`, `captureStatus`, `detectionStatus`, `attemptsRemaining`, `uploadError?` |
| `processing`  | Server-side processing of the captured selfie                                                                                                                                      | –                                                                                 |
| `finished`    | Capture complete                                                                                                                                                                   | `processResponse?`                                                                |
| `closed`      | User closed flow                                                                                                                                                                   | –                                                                                 |
| `error`       | Fatal error                                                                                                                                                                        | `error`                                                                           |

### Capture State Properties

When `status === 'capture'`, the following properties are available:

| Property             | Type              | Description                                                                                |
| -------------------- | ----------------- | ------------------------------------------------------------------------------------------ |
| `stream` | `CameraStream \| undefined` | Camera stream for the video element; wait until it is available before attaching it. |
| `captureStatus`      | `string`          | Sub-state: `initializing`, `detecting`, `capturing`, `uploading`, `uploadError`, `success` |
| `detectionStatus`    | `DetectionStatus` | Face detection feedback (see below)                                                        |
| `attemptsRemaining`  | `number`          | Remaining capture attempts                                                                 |
| `uploadError`        | `string?`         | Error message if upload failed                                                             |
| `assistedOnboarding` | `boolean`         | Whether assisted onboarding mode was requested in config                                   |
| `usingBackCamera`    | `boolean`         | Whether `stream` is really a back camera — mirror your `<video>` when `false`              |
| `onDeviceMode` | `boolean` | When `true`, do not offer a manual capture button. |
| `obfuscateWithAvatar` | `boolean` | Whether a cosmetic concealment overlay is enabled. |
| `avatarCanvas` | `HTMLCanvasElement?` | Display-only canvas; unavailable until ready or when concealment is off. |
| `avatarVariant` | `'avatar-3d' \| 'avatar-2d' \| 'privacy-lens'` (optional) | Derived display variant. Keep the face outline for Privacy Lens; hide it for full avatars. This is not a host-settable config field. |

> **Note:** `processing` is a separate top-level state (`status === 'processing'`), not a `captureStatus` value.

> **Removed:** `debugFrame` (`ImageData?`) is gone from the selfie, authentication, and ID capture state types. It had already stopped carrying frames — the per-frame emission was dropped because storing a full-resolution frame roughly ten times a second re-rendered the capture screen and starved it on lower-tier devices. Reading `state.debugFrame` is now a type error rather than a silent `undefined`. If you relied on per-frame pipeline frames, contact Incode: an opt-in hook is the intended replacement.

These are read-only presentation fields. In `error`, `error: string` carries the message and `moduleErrorCode?: string` carries an optional code. Forward that code unchanged when reporting failure to a Flow or Workflow manager.

### Detection Status Values

Show these messages to guide the user during capture:

| Status             | User Instruction                                                       |
| ------------------ | ---------------------------------------------------------------------- |
| `idle`             | "Preparing camera..."                                                  |
| `detecting`        | "Detecting face..."                                                    |
| `noFace`           | "Position your face in the frame"                                      |
| `tooManyFaces`     | "Only one face should be visible"                                      |
| `tooClose`         | "Move back"                                                            |
| `tooFar`           | "Move closer"                                                          |
| `blur`             | "Hold still, image is blurry"                                          |
| `dark`             | "Improve lighting conditions"                                          |
| `faceAngle`        | "Face your camera directly"                                            |
| `headWear`         | "Remove head coverings"                                                |
| `lenses`           | "Remove glasses or lenses"                                             |
| `eyesClosed`       | "Open your eyes"                                                       |
| `faceMask`         | "Remove face mask"                                                     |
| `centerFace`       | "Center your face"                                                     |
| `getReady`         | "Get ready..."                                                         |
| `getReadyFinished` | "Hold still..."                                                        |
| `capturing`        | "Capturing photo..."                                                   |
| `manualCapture`    | "Tap to capture" (manual mode)                                         |
| `success`          | Capture succeeded — transitioning out                                  |
| `error`            | Detection error — surfaces alongside `captureStatus === 'uploadError'` |
| `offline`          | "No network connection"                                                |

### Permission Status Values

When `status === 'permissions'`:

| `permissionStatus` | Meaning                     |
| ------------------ | --------------------------- |
| `idle`             | Ready to request permission |
| `requesting`       | Permission dialog shown     |
| `denied`           | User denied camera access   |
| `learnMore`        | Showing help screen         |

### API Methods

| Method                | Description                     | When to Use                                        |
| --------------------- | ------------------------------- | -------------------------------------------------- |
| `load()`              | Starts the selfie flow          | Always call first                                  |
| `nextStep()`          | Advances to next step           | From `tutorial` to `permissions`                   |
| `requestPermission()` | Requests camera permission      | When `permissions.idle` or `permissions.learnMore` |
| `goToLearnMore()`     | Shows permission help           | When `permissions.idle`                            |
| `back()`              | Goes back from learn more       | When `permissions.learnMore`                       |
| `capture()`           | Manual capture (when available) | In `capture`, when `!onDeviceMode && detectionStatus === 'manualCapture'`         |
| `retryCapture()`      | Retry after upload error        | When `captureStatus === 'uploadError'`             |
| `close()`             | Closes the flow                 | Anytime                                            |
| `reset()`             | Resets to initial state         | In `error`; create a new manager after `finished`                        |
| `stop()`              | Cleanup resources               | When unmounting                                    |
| `getState()`          | Returns current state           | Anytime                                            |
| `subscribe(callback)` | Subscribe to state changes      | Returns unsubscribe function                       |

### Handling cancellation (`closed`)

When the user dismisses the selfie flow — either by calling `manager.close()` or by clicking the SDK's built-in close button — the manager transitions to `closed`. `closed`** is a final state**: the manager won't re-emit further updates, and `reset()` doesn't apply (it is only valid from `error`). Custom UIs need to decide what to do next.

**Inside an orchestrated flow** — call `flowManager.completeModule()` so the orchestrator advances past the cancelled step:

```typescript
selfieManager.subscribe((state) => {
  if (state.status === 'closed') {
    // Optional: render a brief "Cancelled — continuing…" screen, then advance.
    setTimeout(() => flowManager.completeModule(), 800);
  }
});
```

### Opt-in: on-device face-results submission

Both Selfie and Authentication accept `onDeviceFaceResultsSubmissionEnabled?: boolean` on their config. When `true`, face analysis runs entirely on-device and only the results are submitted to the server — the captured image never leaves the device. Has E2EE and WASM-pipeline prerequisites. See [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/) for the full walkthrough, including the setup-time prerequisites and code example.

**Standalone (no orchestrator)** — there's nowhere to advance to, so navigate the user out of the selfie surface entirely:

```typescript
selfieManager.subscribe((state) => {
  if (state.status === 'closed') {
    selfieManager.stop(); // tear down resources
    navigate('/onboarding/cancelled');
  }
});
```

Common UX choice: render a brief "Cancelled — continuing…" screen for \~800 ms before calling `flowManager.completeModule()`, so the cancellation isn't jarring.

### Capture-only variant

`createSelfieCaptureOnlyManager` (from `@incodetech/core/selfie`) exposes the same API surface as `createSelfieManager` with a supported subset of optional capture UX settings and a required `onCapture(response)` callback. It does not expose a recording flag. The flow delivers the captured face image locally to the integrator. Use it when you're building a hybrid pipeline (capture in browser, upload elsewhere). See [Module: Selfie → Capture-only flow](/sdk-reference/web-sdk-2-module-selfie-1/#capture-only-flow) for the full payload shape and the biometric-handling caveats.



## ID Capture

ID capture handles document scanning with ML-powered quality checks. **Requires WASM configuration.**

### Quick Start

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';
import { createIdCaptureManager, type IdCaptureConfig } from '@incodetech/core/id';

// Preload the idCapture WASM pipeline as part of setup() — Incode CDN
// defaults are used unless you override paths. See WASM Configuration
// for self-hosted paths and the lower-level warmupWasm() API.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['idCapture'] },
});
await initializeSession({ token: 'your-token' });

const config = await resolveDashboardModuleConfig({ moduleKey: 'ID' });
const manager = createIdCaptureManager({ config });

manager.subscribe((state) => {
  switch (state.status) {
    case 'chooser':
      // Show document type selection UI
      // Call manager.selectDocument('id') or manager.selectDocument('passport')
      break;

    case 'tutorial':
      // Show tutorial for the selected document type
      // state.selectedDocumentType - 'id' or 'passport'
      // Call manager.continueToPermission() directly from the Continue tap
      break;

    case 'permissions':
      // Handle camera permissions (same as selfie)
      break;

    case 'capture':
      // Camera is active
      // state.stream - MediaStream for <video> element
      // state.currentMode - 'front' or 'back'
      // state.detectionStatus - Document detection feedback
      // state.captureStatus - 'detecting', 'capturing', 'uploading', etc.
      // state.counterValue - Countdown timer value
      break;

    case 'frontFinished':
      // Front capture complete, transitioning to back
      break;

    case 'processing':
      // Document being processed on server
      break;

    case 'finished':
      console.log('ID captured successfully!');
      manager.stop();
      break;

    case 'error':
      console.error('Error:', state.error);
      break;
  }
});

manager.load();
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| chooser
    chooser -->|selectDocument| tutorial
    tutorial -->|continueToPermission| permissions
    permissions -->|granted| capture
    capture -->|front done| frontFinished
    frontFinished --> capture
    capture -->|back done| processing
    processing --> finished
```

### States Reference

| Status             | Description                                                                                                                   | Properties                                                                                                                                       |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `idle`             | Initial state                                                                                                                 | –                                                                                                                                                |
| `chooser`          | Document type selection                                                                                                       | `availableDocumentTypes`                                                                                                                         |
| `loading`          | Loading configuration or a transient permission/camera phase                                                                  | `phase`, `tutorialEnabled`, `selectedDocumentType`, `currentMode`, `requiresMotionPermissionUserGesture`                                         |
| `tutorial`         | Showing tutorial                                                                                                              | `phase`, `selectedDocumentType`, `currentMode`, `requiresMotionPermissionUserGesture`                                                            |
| `ageVerification`  | Regulation-required age-confirmation gate. Reached when `config.ageAssurance === true`. Advance with `nextStep()`.            | –                                                                                                                                                |
| `permissions`      | Camera permission request                                                                                                     | `permissionStatus`, `requiresMotionPermissionUserGesture`                                                                                        |
| `capture`          | Active capture                                                                                                                | `stream`, `currentMode`, `captureStatus`, `detectionStatus`, `counterValue`, `attemptsRemaining`, `uploadError?`, `needsBackCapture`, `canRetry` |
| `frontFinished`    | Front side captured                                                                                                           | –                                                                                                                                                |
| `backFinished`     | Back side captured                                                                                                            | –                                                                                                                                                |
| `mandatoryConsent` | Regulation-required consent screen                                                                                            | `regulationType` (see [Mandatory Consent](#mandatory-consent-state-properties))                                                                  |
| `processing`       | Server processing                                                                                                             | –                                                                                                                                                |
| `expiredExhausted` | Attempts exhausted; Continue calls `continueExhausted()` | – |
| `digitalIdRedirect` | Bank verification | `phase`, `launchUrl`, `failureReason`, `providerId` |
| `expired`          | Document expired after processing                                                                                             | –                                                                                                                                                |
| `digitalIdUpload`  | Digital ID upload sub-flow — PDF e-IDs uploaded by file picker (see [Digital ID Upload](#digital-id-upload-state-properties)) | full shape below                                                                                                                                 |
| `deviceWallet`     | Device-wallet (mDL) sub-flow — Apple Wallet / Google Wallet handshake (see [Device wallet](#device-wallet-mdl))               | `phase`, `failReason`, `platform`                                                                                                                |
| `finished`         | Capture complete                                                                                                              | –                                                                                                                                                |
| `closed`           | User closed flow                                                                                                              | –                                                                                                                                                |
| `error`            | Fatal error                                                                                                                   | `error`                                                                                                                                          |

### Loading, tutorial, and permission properties

| Property | Type | Available in |
| --- | --- | --- |
| `phase` | `'bootstrapping' \| 'permissionsIdle' \| 'checkingStream' \| 'initializingDeepsight' \| 'initializingCamera'` | `loading` |
| `phase` | `'checkingPermission' \| 'ready' \| 'initializingCamera' \| 'waitingForPermission' \| 'waitingForCamera'` | `tutorial` |
| `selectedDocumentType` | `IdDocumentType \| undefined` | `loading`, `tutorial`, `permissions` |
| `currentMode` | `'front' \| 'back'` | `loading`, `tutorial`, `permissions` |
| `tutorialEnabled` | `boolean` | `loading`, `permissions` |
| `permissionStatus` | `PermissionStatus` | `permissions` |
| `requiresMotionPermissionUserGesture` | `boolean` | `loading`, `tutorial`, `permissions`; start unresolved iOS motion permission from a user gesture with `continueToPermission()` |

Keep the document and side visible while waiting. `permissionsIdle` is a silent permission check; avoid flashing a new full-screen loader. Tutorial `ready` waits for Continue. `waitingForPermission` and `waitingForCamera` mean Continue was already requested; show a waiting state. Treat the other loading phases as preparation without exposing implementation details to the user.

The motion-gesture flag is exposed before the permission screen as well:

- When `status === 'tutorial'`, `phase` identifies `checkingPermission`, `ready`, `initializingCamera`, `waitingForPermission`, or `waitingForCamera`. Call `continueToPermission()` directly from the tutorial CTA's tap handler. It starts the iOS motion request in that same user activation when required and otherwise advances into normal permission orchestration.
- When `status === 'loading'`, `phase` identifies a transient SDK operation such as `bootstrapping`, `permissionsIdle`, `checkingStream`, `initializingDeepsight`, or `initializingCamera`. The same `requiresMotionPermissionUserGesture` value is carried for presentation continuity, but do not dispatch permission actions from these transient states.

### Capture State Properties

When `status === 'capture'`:

| Property                  | Type                | Description                                                                                                                             |
| ------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `captureFeedbackMode` | `'countdown' \| 'optimizing'` | Capture presentation discriminator. |
| `acceptedDocuments` | `string[]?` | Accepted-document names for upload-error UI. Entries are strings; hide absent/empty lists and tolerate unknown names. |
| `countryCode` | `string?` | Country from the current upload response. |
| `stream`                  | `MediaStream`       | Camera stream for `<video>` element                                                                                                     |
| `currentMode`             | `'front' \| 'back'` | Which side is being captured                                                                                                            |
| `captureStatus`           | `string`            | Sub-state: `initializing`, `detecting`, `capturing`, `optimizing`, `uploading`, `uploadError`, `success` (see important notes below) |
| `detectionStatus`         | `string`            | Document detection feedback (see below)                                                                                                 |
| `counterValue`            | `number`            | Auto-capture countdown (seconds)                                                                                                        |
| `countdownStepMs`         | `number`            | Milliseconds between `counterValue` steps (3 → 2 → 1 → 0). Lets you animate the whole countdown from its first value                    |
| `attemptsRemaining`       | `number`            | Remaining capture attempts                                                                                                              |
| `uploadError`             | `string?`           | Error code if upload failed                                                                                                             |
| `uploadErrorMessage`      | `string?`           | Human-readable error message                                                                                                            |
| `uploadErrorDescription`  | `string?`           | Detailed error description                                                                                                              |
| `needsBackCapture`        | `boolean`           | Whether back capture is needed                                                                                                          |
| `usingBackCamera` | `boolean` | Whether the active stream uses a rear camera. Mirror a front-camera preview; leave the rear-camera preview unmirrored. |
| `barcodeFastPathCaptured` | `boolean` | Render barcode-capture success without a captured-image preview when `true`. |
| `needsFrontCapture` | `boolean` | A front-side capture is required after the back. Use `continueToFront()` when the completed capture awaits that follow-up. |
| `showCaptureButtonInAuto` | `boolean`           | Show manual capture button in auto mode                                                                                                 |
| `canRetry`                | `boolean`           | Whether retry is available                                                                                                              |
| `orientation`             | `string?`           | Detected document orientation                                                                                                           |
| `idType`                  | `string?`           | Detected ID type                                                                                                                        |
| `previewImageUrl`         | `string?`           | URL of captured image preview                                                                                                           |
| `uploadProgress`          | `number?`           | Upload progress (0-100)                                                                                                                 |

### Mandatory Consent State Properties

When `status === 'mandatoryConsent'`:

| Property         | Type              | Description                                                                        |
| ---------------- | ----------------- | ---------------------------------------------------------------------------------- |
| `regulationType` | `RegulationTypes` | Which regional regulation triggered the consent screen. Used to pick consent copy. |

`RegulationTypes` is a string union:

```typescript
type RegulationTypes =
  | 'US'
  | 'Worldwide'
  | 'Other'
  | 'US_Illinois'
  | 'US_Texas'
  | 'US_California'
  | 'US_Washington';
```

`'Other'` is the fallback the SDK uses when the upload response doesn't pin a specific regulation. Drive your consent copy off this value, then call `acceptMandatoryConsent()` (proceed) or `cancelMandatoryConsent()` (abort the flow).

### Digital ID Upload State Properties

When `status === 'digitalIdUpload'`. Reached when the back end allows uploading a digital ID (typically an EU eID or similar government-issued PDF) instead of capturing a physical document. The sub-flow walks the user through a tutorial → file picker → preview → upload → success/failure cycle with a bounded retry budget (3 attempts).

| Property            | Type                              | Description                                                                                                                                                                                                                                 |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phase`             | union                             | `'tutorial'`, `'selecting'`, `'reviewing'`, `'uploading'`, `'holding'`, `'success'`, `'error'`, `'fileTooLarge'`, `'exhausted'`. `'holding'` is a brief stabilization step shown while the upload finishes; treat as `'uploading'` UI-wise. |
| `file`              | `File \| null`                    | The PDF the user picked (`null` outside `'reviewing'` / `'uploading'` / `'holding'`).                                                                                                                                                       |
| `fileName`          | `string \| undefined`             | The file's display name. Use this to render the preview row.                                                                                                                                                                                |
| `failReason`        | `DigitalUploadFailReason \| null` | Set when `phase === 'error'`. Union: `'DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED'`, `'ID_TYPE_UNACCEPTABLE'`, `'FILE_CHANGED_ERROR'`, `'INVALID_FILE_TYPE'`, `'NETWORK_ERROR'`, `'GENERIC'`.                                                  |
| `attemptsRemaining` | `number`                          | Remaining upload retries (starts at 3). Hits 0 → `phase === 'exhausted'`.                                                                                                                                                                   |
| `uploadProgress`    | `number`                          | Upload progress 0–100. Only meaningful in `'uploading'` / `'holding'`.                                                                                                                                                                      |
| `pickerRequestId`   | `number`                          | Monotonic counter — increments each time the SDK wants the host UI to open the file picker. Watch for changes and trigger your `<input type="file">` programmatically (the SDK never opens it itself).                                      |

**Accepted files.** PDF only (`application/pdf`), 5 MB maximum.

**Phase progression.** `tutorial` → `selecting` (host opens picker on each `pickerRequestId` change) → `reviewing` (user confirms or replaces) → `uploading` → `success` (auto-advances out of the sub-flow) or `error` → back to `selecting`, until `attemptsRemaining === 0` → `exhausted`. `fileTooLarge` is shown immediately when the user picks an oversized file and does not consume a retry.

Drive the screen with `digitalUploadNextStep()`, `digitalUploadPickFile(file)`, `digitalUploadConfirm()`, `digitalUploadReplace()`, `digitalUploadRetry()`, `digitalUploadChooseAnother()`, and `digitalUploadScanInstead()` (falls back to live capture when allowed).

### Digital ID redirect and wallet states

Digital methods must be enabled in Dashboard and supported by the current device. Render options from `chooser.availableDocumentTypes`; do not offer an unavailable wallet route.

| Status | Property | Type / behavior |
| --- | --- | --- |
| `digitalIdRedirect` | `phase` | `'loading' \| 'redirecting' \| 'success' \| 'failed' \| 'error'` |
| `digitalIdRedirect` | `launchUrl` | `string \| undefined`; navigate only when `phase === 'redirecting'` and a URL is present. |
| `digitalIdRedirect` | `failureReason`, `providerId` | Optional public failure/provider identifiers. See [Bank Redirect](/sdk-reference/digital-id-redirect/#failure-handling). |
| `deviceWallet` | `phase` | `'requesting' \| 'presenting' \| 'decrypting' \| 'failed'`. Show progress for requesting/decrypting and wait for the device sheet during presenting. |
| `deviceWallet` | `failReason` | `'UNSUPPORTED_PLATFORM' \| 'NO_CREDENTIAL' \| 'WALLET_ERROR' \| null`. Render localized recovery guidance. |
| `deviceWallet` | `platform` | `'ios' \| 'android' \| undefined` |

Wallet completion advances the ID manager to `finished`; identity attributes are retrieved through session results, not the wallet state. On failure, offer retry or another configured method. See the [mDL headless example](/sdk-reference/digital-id-mdl-verification/#option-2-use-the-web-sdk-id-manager).

### Expired-document recovery

`expired` exposes `attemptsRemaining` and `currentMode`. Once attempts are exhausted, render `expiredExhausted` with a Continue action calling `continueExhausted()`. The configured journey determines whether the SDK captures another side, completes processing, or finishes this module. Continue does not establish an approved verification; use the session result.

### Important: Capture State Transitions

When building custom UI, you must handle these critical state transitions:

#### Optional result preview (`captureStatus === 'optimizing'`)

The built-in web UI opts into an IDC-05 preview that runs *during* capture: partway through the frame-selection window it freezes the best frame found so far while the camera and frame analysis keep going. Headless integrations skip this state by default and continue directly from capture to upload.

Managers created by the built-in `IdCapture` component receive the SDK-owned experiment treatment when they declare the capability. Integrations that create an ID manager themselves, including custom components composed from the extensibility subpath, do not participate in SDK-driven experiments automatically unless they opt in with `supportsOptimizingStatus: true`.

To implement your own flash/frozen-preview treatment, create the manager with `supportsOptimizingStatus: true`. The `optimizing` state appears only when the SDK resolves the treatment arm — your integration must handle both the preview path and the direct capture-to-upload path. Pass `false` to opt out of the experiment entirely (no store read, no exposure, no assignment).

While in `optimizing`, `optimizingDwellMs` reports how long the SDK holds the state, and the frame to display depends on which capture path produced it:

| Capture path         | Preview runs          | Frame to display    |
| -------------------- | --------------------- | ------------------- |
| Automatic capture    | *before* the commit   | `candidateImageUrl` |
| Manual capture (tap) | *after* the commit    | `previewImageUrl`   |

Treat `optimizingDwellMs` as a **minimum**, not an exact duration. The SDK runs the dwell on its own timer on both paths; on automatic capture the state additionally waits for the frame-selection loop to commit a frame, which can take slightly longer than the dwell. Don't build layout or animation that assumes an exact duration; react to the state leaving `optimizing` instead.

Reading `state.candidateImageUrl ?? state.previewImageUrl` covers both without branching on the path. On the automatic path that image is **display-only** — detection has not finished, and the frame that actually uploads arrives later on `previewImageUrl`. The SDK leaves the state by itself in both cases; there is nothing to call:

```typescript
const idManager = createIdCaptureManager({
  config: {
    ...idConfig, // Complete IdCaptureConfig resolved from your active Flow
    supportsOptimizingStatus: true,
  },
});

idManager.subscribe((state) => {
  if (
    state.status === 'capture' &&
    state.captureStatus === 'optimizing'
  ) {
    // Automatic capture freezes the best frame so far; manual capture the
    // already-committed one.
    showResultPreview(state.candidateImageUrl ?? state.previewImageUrl);
  }
});
```

`optimizing` is not a waiting state: it is bounded by the SDK's frame-selection window on the automatic path and by an SDK-owned timer on the manual one, so it advances on its own either way. There is no callback to fire, and `nextStep()` has no effect here.

#### After Upload Success (`captureStatus === 'success'`)

When upload completes successfully, the state machine waits in `capture.success` state. **You must call **`nextStep()` to advance:

```typescript
idManager.subscribe((state) => {
  if (state.status === 'capture' && state.captureStatus === 'success') {
    // Upload successful - advance to next step (frontFinished or processing)
    idManager.nextStep();
  }
});
```

Without calling `nextStep()`, the state machine will appear stuck in the capture state.

#### Document Expired (`status === 'expired'`)

When a document is detected as expired after processing, the state goes to `expired`. **Use `retryCapture()`, not **`reset()`:

```typescript
idManager.subscribe((state) => {
  if (state.status === 'expired') {
    // Show "Document expired" UI with retry button
    // On retry click:
    idManager.retryCapture(); // ✅ Correct - returns to capture flow
    // NOT idManager.reset(); // ❌ Wrong - will not work in expired state
  }
});
```

The `expired` state only responds to `RETRY_CAPTURE` event. The `reset()` method (which sends `RESET`) only works in `error`. Create a new manager after the final `finished` state.

### Detection Status Values

Show these messages to guide the user during capture:

| Status          | User Instruction                |
| --------------- | ------------------------------- |
| `idle`          | "Preparing camera..."           |
| `idNotDetected` | "Position your ID in the frame" |
| `detecting`     | "Hold steady..."                |
| `farAway`       | "Move closer"                   |
| `blur`          | "Hold still, image is blurry"   |
| `glare`         | "Adjust angle to reduce glare"  |
| `wrongSide`     | "Please show the other side"    |
| `capturing`     | "Capturing..."                  |
| `manualCapture` | "Tap to capture" (manual mode)  |
| `offline`       | "No network connection"         |

### Error Codes

When `captureStatus === 'uploadError'`, check `uploadError`:

| Error Code                         | Description                 | User Action                |
| ---------------------------------- | --------------------------- | -------------------------- |
| `UPLOAD_ERROR`                     | Upload failed               | Retry capture              |
| `CLASSIFICATION_FAILED`            | Document not recognized     | Use a clearer image        |
| `LOW_SHARPNESS`                    | Image too blurry            | Hold device steadier       |
| `GLARE_DETECTED`                   | Glare on document           | Adjust lighting/angle      |
| `WRONG_DOCUMENT_SIDE`              | Wrong side shown            | Flip the document          |
| `ID_TYPE_UNACCEPTABLE`             | Document type not supported | Use a different ID         |
| `READABILITY_ISSUE`                | Cannot read document        | Improve lighting           |
| `RETRY_EXHAUSTED_CONTINUE_TO_BACK` | Front retries exhausted     | Auto-advances to back      |
| `RETRY_EXHAUSTED_SKIP_BACK`        | Back retries exhausted      | Auto-advances              |
| `NO_MORE_TRIES`                    | Max attempts reached        | Flow will end              |
| `UNEXPECTED_ERROR`                 | Internal error              | Retry or contact support   |
| `NO_TOKEN`                         | Session token missing       | Re-initialize SDK          |
| `PERMISSION_DENIED`                | Camera access denied        | Enable in browser settings |
| `USER_CANCELLED`                   | User cancelled              | Re-open module             |
| `SERVER_ERROR`                     | Server-side error           | Retry later                |

### API Methods

For an ID tutorial CTA, call `continueToPermission()` directly from the tap handler. You can call it unconditionally: it requests iOS motion only when `requiresMotionPermissionUserGesture` is `true`, then enters camera permission orchestration. `nextStep()` retains the legacy tutorial behavior, including motion priming when camera permission is already granted. Do not defer a gesture-dependent call through an effect or timer.

| Method                               | Description                                                                          | When to Use                                                                                                     |
| ------------------------------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| `continueExhausted()` | Continue after expired-document attempts are exhausted | `expiredExhausted` |
| `digitalIdRedirectRetry()` | Restart redirect verification | `digitalIdRedirect`, `failed` or `error` phase |
| `digitalIdRedirectUseAnotherMethod()` | Leave the redirect and use configured fallback | `digitalIdRedirect`, `failed` or `error` phase |
| `digitalIdRedirectContinue()` | Acknowledge the redirect success screen | `digitalIdRedirect`, `success` phase |
| `digitalIdRedirectRefresh()` | Refresh the pending launch URL | `digitalIdRedirect`, `redirecting` phase |
| `load()`                             | Starts the ID capture flow                                                           | Always call first                                                                                               |
| `selectDocument(type, options?)`     | Selects document type. For `'digitalIdRedirect'`, pass `{ providerId }` from `digitalIdRedirectOptions`; omitted, the first configured method is used. | When `chooser`, pass a value from `availableDocumentTypes` (`'id'`, `'passport'`, `'digitalId'`, …). Call it inside the tap handler for `'digitalId'` |
| `nextStep()`                         | Advances through the legacy tutorial path or advances a successful capture           | From `tutorial`, or from `captureStatus === 'success'` to `frontFinished`/`processing`                           |
| `requestPermission(options?)`        | Requests camera permission. Pass `{ trigger: 'automatic' }` when code, not a user action, initiates it, so it is not reported as a click | When `permissions.idle`                                                                                         |
| `continueToPermission()`             | Starts gesture-aware permission entry and requests unresolved iOS motion permission first | Directly from the ID tutorial CTA                                                                               |
| `goToLearnMore()`                    | Shows permission help                                                                | When `permissions.idle`                                                                                         |
| `back()`                             | Goes back                                                                            | When `permissions.learnMore`                                                                                    |
| `capture()`                          | Manual capture                                                                       | When `detectionStatus === 'manualCapture'`                                                                      |
| `switchToManualCapture()`            | Switch to manual mode                                                                | During auto-capture                                                                                             |
| `switchToAutoCapture()` | Restart automatic capture on the same side without consuming a retry | When `detectionStatus === 'manualCapture'`, before taking the photo |
| `openHelp()` | Pause detection and keep the camera stream open; returns `true` if Help opened, or `false` if capture has advanced | During live automatic or manual capture; display Help only when this returns `true` |
| `closeHelp()` | Resume capture in the current mode; automatic capture receives a fresh timeout | After `openHelp()`, when Help is dismissed |
| `retryCapture()`                     | Retry capture from beginning                                                         | When `captureStatus === 'uploadError'` **or **`status === 'expired'`                                       |
| `continueFromError()`                | Continue after non-fatal error                                                       | When error allows continuation                                                                                  |
| `continueToBack()`                   | Proceed to back capture                                                              | When `frontFinished`                                                                                            |
| `continueToFront()`                  | Flip back to front capture                                                           | When `backFinished`                                                                                             |
| `skipBack()`                         | Skip back capture                                                                    | When back is optional                                                                                           |
| `acceptMandatoryConsent()`           | Accept the regulation-required consent                                               | When `mandatoryConsent`                                                                                         |
| `cancelMandatoryConsent()`           | Decline the regulation-required consent                                              | When `mandatoryConsent`                                                                                         |
| `digitalUploadNextStep()`            | Advance from the digital-upload tutorial to the picker                               | When `digitalIdUpload` and `phase === 'tutorial'`                                                               |
| `digitalUploadPickFile(file)`        | Hand a picked PDF to the SDK for review                                              | When `digitalIdUpload` and `phase === 'selecting'`                                                              |
| `digitalUploadConfirm()`             | Confirm the previewed file and start uploading                                       | When `digitalIdUpload` and `phase === 'reviewing'`                                                              |
| `digitalUploadReplace()`             | Discard the previewed file and re-open the picker                                    | When `digitalIdUpload` and `phase === 'reviewing'`                                                              |
| `digitalUploadRetry()`               | Retry after an upload error (consumes one of `attemptsRemaining`)                    | When `digitalIdUpload` and `phase === 'error'`                                                                  |
| `digitalUploadChooseAnother()`       | Pick a different file after `fileTooLarge`                                           | When `digitalIdUpload` and `phase === 'fileTooLarge'`                                                           |
| `digitalUploadScanInstead()`         | Abandon digital upload and fall back to live capture                                 | When `digitalIdUpload` (any phase, if allowed by config)                                                        |
| `deviceWalletRetry()`                | Restart a failed wallet handshake. Call it from a user gesture                       | When `deviceWallet` and `phase === 'failed'`                                                                    |
| `deviceWalletUseAnotherMethod()`     | Leave the wallet and return to the chooser (or close)                                | When `deviceWallet` and `phase === 'failed'`                                                                    |
| `updateDetectionArea(area)`          | Update detection bounds                                                              | On resize/orientation change                                                                                    |
| `close()`                            | Closes the flow                                                                      | Anytime                                                                                                         |
| `reset()`                            | Resets to initial state                                                              | **Only** in `error` (not `expired` or final `finished`)                                                            |
| `stop()`                             | Cleanup resources                                                                    | When unmounting                                                                                                 |
| `getState()`                         | Returns current state                                                                | Anytime                                                                                                         |
| `subscribe(callback)`                | Subscribe to state changes                                                           | Returns unsubscribe function                                                                                    |

### Configuration Options

Import `IdCaptureConfig` from `@incodetech/core/id`. The core factory requires its complete Dashboard fields; use `resolveDashboardModuleConfig({ moduleKey: 'ID' })` after session activation or supply a complete object.

See [ID configuration](/sdk-reference/web-sdk-2-module-id-capture/#configuration-options) for all supported fields, including `digitalIds`, `digitalIdReturnUrl`, `digitalIdReturn`, and device-wallet availability. Do not replace the required core type with an optional-field copy.

### Capture-only variant

`createIdCaptureOnlyManager` (from `@incodetech/core/id`) exposes the same API surface as `createIdCaptureManager` with a supported subset of optional capture UX settings and a required `onCapture(response)` callback. The flow bypasses Incode's ID upload pipeline and delivers the captured front (and back, when applicable) images back to the integrator. Use it when you're building a hybrid pipeline. See [Module: ID Capture → Capture-only flow](/sdk-reference/web-sdk-2-module-id-capture/#capture-only-flow) for the full payload shape, including the `croppedImage` caveat.

### Device wallet (mDL)

Inside ID Capture, the wallet runs when the user picks `'digitalId'` from `availableDocumentTypes`. Call `selectDocument('digitalId')` inside the tap handler — browsers open the wallet sheet only during the tap's user activation. The manager then reports `status: 'deviceWallet'` (see [Module: ID Capture → Device Wallet State Properties](/sdk-reference/web-sdk-2-module-id-capture/#device-wallet-state-properties)).

To offer the wallet without ID Capture, use `createDeviceWalletManager()` or the one-shot `renderWallet()` from `@incodetech/core/id`. Both run the Apple Wallet / Google Wallet handshake with no Incode UI. See [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/) for both APIs, error codes, and how to read the results.

---

## Orchestrated Flow Manager

The Orchestrated Flow Manager coordinates multiple modules based on back-end configuration, automatically handling module sequencing and flow state.

### Quick Start

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import { createOrchestratedFlowManager } from '@incodetech/core/flow';
import { phoneMachine } from '@incodetech/core/phone';
import { emailMachine } from '@incodetech/core/email';
import { selfieMachine } from '@incodetech/core/selfie';
import { idCaptureMachine } from '@incodetech/core/id';

// Preload both ML pipelines via setup() — defaults to the Incode CDN.
// Omit `wasm` (or pass `wasm: false`) to skip preload and let the
// pipelines load lazily when the user reaches a camera step.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['selfie', 'idCapture'] },
});
await initializeSession({ token: 'your-session-token' });

// Create flow manager. Register every machine your flow needs.
const flowManager = createOrchestratedFlowManager({
  modules: {
    PHONE: phoneMachine,
    EMAIL: emailMachine,
    SELFIE: selfieMachine,
    ID: idCaptureMachine,
    SECOND_ID: idCaptureMachine, // only if your flow captures a second ID
  },
});

// Subscribe to flow state changes
flowManager.subscribe((flowState) => {
  console.log('Flow status:', flowState.status);
  if (flowState.status === 'ready') {
    console.log('Current step:', flowState.currentStep);
    console.log('Steps:', flowState.steps);
  } else if (flowState.status === 'error') {
    console.error(flowState.error);
  }
});

// Load the flow from back end
flowManager.load();
```

### Module Registration

Register a state machine for every module key your flow uses. The orchestrator looks each step's key up in your `modules` map; if it can't find a machine, the flow fails with `"No registered module found for flow"`.

#### ID capture step keys

The back end can return any of these keys depending on dashboard configuration:

| Step Key      | Description                                               | Need to register?                                                                                                                                                                                                        |
| ------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID`          | Standard ID capture.                                      | **Yes** — always register `ID: idCaptureMachine`.                                                                                                                                                                        |
| `SECOND_ID`   | Second ID document (when the flow is configured for two). | Yes, when your flow captures a second ID.                                                                                                                                                                                |
| `TUTORIAL_ID` | ID capture with tutorial — the legacy back-end variant.    | No. The SDK normalizes `TUTORIAL_ID` into `ID` (and `SECOND_ID` when configured) **before** your subscribe handler runs, so the orchestrator never emits `TUTORIAL_ID` as a step. Registering it is harmless but unused. |
| `THIRD_ID`    | Deprecated.                                               | No. The SDK ignores it; do not register it.                                                                                                                                                                              |

In practice this means registering `ID` (and `SECOND_ID` when relevant) is sufficient for any ID-capture flow.

:::warning
  ### **Common Error**: If you see `"No registered module found for flow"`, you're missing one of the keys your back-end flow uses. Read `flowState.steps` in a subscription after narrowing to `status === 'ready'` to see exactly which keys you need.
:::

### Flow States

Every variant also carries `homeScreen` (`{ visible, isContinueLoading }`) and `presentation` (`{ isAwaitingReady, lazyModuleKey, shouldPrefetchHome }`). These are UI hints used by `<incode-flow>` for transition timing; in custom-UI integrations you can usually ignore them and let your shell own the loading/transition UX.

| Status     | Description                | Properties (in addition to `homeScreen` and `presentation`)                 |
| ---------- | -------------------------- | --------------------------------------------------------------------------- |
| `idle`     | Initial state              | –                                                                           |
| `loading`  | Loading flow configuration | –                                                                           |
| `ready`    | Module is active           | `flow`, `currentStep`, `currentStepIndex`, `steps`, `config`, `moduleState` |
| `completing` | Completing the flow with the back end | – |
| `finished` | Flow complete              | `flow`, `finishStatus`                                                      |
| `error` | Flow failed | `error?: string`, `errorCode?: number`, `moduleErrorCode?: string` |

Narrow on `state.status` before reading variant fields. For example, read `state.moduleErrorCode` only when `state.status === 'error'`; it may still be `undefined`.

### API Methods

| Method                          | Description                                                                                                                                                                                                  |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `load()`                        | Load flow configuration from back end                                                                                                                                                                         |
| `cancel()`                      | Cancel an in-progress flow load                                                                                                                                                                              |
| `reset()`                       | Reset the flow to its initial `idle` state                                                                                                                                                                   |
| `completeModule()`              | Mark the current module as complete and advance to the next step. Call from the active module's `onFinish` callback.                                                                                         |
| `completeFlow()` | Complete early, skipping remaining steps and notifying the back end. |
| `finishFlow()` | Finish locally after an external handoff has already completed the flow, such as desktop-to-mobile. Does not ask the back end to complete again. |
| `errorModule(error?, moduleErrorCode?)` | Report a module failure. Supported module error codes can advance to the next step or completion; other failures enter `error`. Forward the module code unchanged so the SDK applies the appropriate behavior. |
| `continueFromHome()`            | Advance past the SDK's launch / home screen. Only meaningful when `enableHome: true` is set and `state.homeScreen.visible === true`. Awaits the orchestrator-ready handshake when called from `loading`.     |
| `shouldRenderHomeScreen()`      | Convenience getter returning `state.homeScreen.visible`. Used by `<incode-flow>` to decide whether to mount the launch screen; custom shells can do the same.                                                |
| `isAwaitingOrchestratorReady()` | `true` while the flow has loaded but the first module's machine isn't ready yet. Use to gate an initialization spinner.                                                                                      |
| `waitForReady()`                | Promise that resolves once the orchestrator has loaded the flow **and** the first module is ready to render. Pair with other parallel async work (theme fetch, asset preload, etc.) before unmasking the UI. |
| `getLazyModuleKey()`            | Returns the module key the orchestrator wants you to lazy-load next, or `undefined`. Drives module-chunk prefetching.                                                                                        |
| `getModuleConfig<T>()`          | Returns the current step's module configuration with workflow-level flags (e.g. `ds`) merged in. Typed via the generic parameter.                                                                            |
| `isModuleEnabled(moduleKey)`    | Returns whether the module key appears in the active flow's step list. Useful for "is this user going to hit ID capture?" gating.                                                                            |
| `canNext` _(getter)_            | `true` when `completeModule()` is safe to call right now (current module has finished and the orchestrator is ready to advance).                                                                             |
| `send(event)`                   | Send a raw event to the orchestrator state machine. Prefer the typed methods above; use this only for events that don't have a dedicated wrapper.                                                            |
| `getState()`                    | Get the current flow state synchronously                                                                                                                                                                     |
| `subscribe(callback)`           | Subscribe to flow state changes (returns an unsubscribe function)                                                                                                                                            |
| `subscribeFlowEvent(listener)` | Subscribe to curated flow milestones; returns an unsubscribe function. See [headless flow events](/sdk-reference/web-sdk-2-event-callbacks/#headless-flow-events). |

### Working with Individual Module Managers

When a module step is active, create the appropriate manager and handle its state:

```typescript
import { createIdCaptureManager, type IdCaptureConfig } from '@incodetech/core/id';

flowManager.subscribe((flowState) => {
  if (flowState.status !== 'ready') return;

  const { currentStep, config } = flowState;

  // ID and SECOND_ID are the only ID-capture step keys you'll actually
  // see — TUTORIAL_ID is normalized into ID before reaching subscribers,
  // and THIRD_ID is deprecated.
  const isIdStep = currentStep === 'ID' || currentStep === 'SECOND_ID';

  if (isIdStep) {
    // Create ID manager for this step
    const idManager = createIdCaptureManager({
      config: flowManager.getModuleConfig<IdCaptureConfig>(),
    });

    idManager.subscribe((idState) => {
      // Handle ID capture states...
      if (idState.status === 'finished') {
        flowManager.completeModule();
      }
    });

    idManager.load();
  }
});
```



## Legacy Flow manager

`createFlowManager` is a separate compatibility API, with `nextStep()`, `prevStep()`, `canNext`, `canPrev`, and keyed `getModuleConfig(moduleKey)`. It is not interchangeable with the modern orchestrator. See the [legacy API reference](/sdk-reference/web-sdk-2-reference/#legacy-flow-manager).

## Standalone mandatory consent

`createMandatoryConsentManager` uses a required `config.consentType`, optional `language`, and `type: 'MANDATORY' | 'ML'`. Its `display` state exposes the supplied consent text and acceptance state. Drive it with `toggle()`, `submit()`, and `cancel()`; these differ from ID's embedded consent actions. See [standalone mandatory consent](/sdk-reference/web-sdk-2-individual-modules/#standalone-mandatory-consent) for configuration, states, and action gates.

## Workflow Manager

The Workflow Manager runs **server-driven** multi-step onboarding workflows, where the next step (and its configuration) is chosen by the back end per session. Use it instead of the Orchestrated Flow Manager when the workflow is configured in the Incode Workflows engine (not in the dashboard Flow). Only one orchestrator — Workflow **or** Flow — should be active per session.

### Quick Start

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import { createWorkflowManager } from '@incodetech/core/workflow';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['selfie', 'idCapture'] },
});
await initializeSession({ token: 'your-session-token' });

const workflow = createWorkflowManager({
  interviewId: session.interviewId,
  isDesktop: matchMedia('(min-width: 768px)').matches,
  customModuleCallback: ({ name, interviewId, nodeId, onSuccess, onError }) => {
    // Run your custom business logic, then advance the workflow.
    onSuccess('handled');
  },
});

workflow.subscribe((state) => {
  switch (state.status) {
    case 'idle':
    case 'loading':
      if (state.homeScreen.visible) {
        // Render launch screen — advance with workflow.continueFromHome().
      }
      break;
    case 'ready':
      // Render the module for state.currentNode.moduleKey using the merged
      // module config from workflow.getModuleConfig(). Call completeModule()
      // / errorModule() from the module's onFinish / onError callbacks.
      break;
    case 'asyncResolution':
      // Server is processing — show a progress UI; next node arrives soon.
      break;
    case 'finished':
      workflow.stop();
      break;
  }
});

workflow.load();
```

### States Reference

| Status            | Description                                                                                                                                                                                                 | Properties                                                             |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `idle`            | Initial state before `load()`                                                                                                                                                                               | `homeScreen`                                                           |
| `loading`         | Fetching the next node from the workflow server (covers the transient `home`, `resolvingModule`, `handlingCustomModule`, `processingNode`, and score-resolution phases the consumer doesn't need to distinguish) | `homeScreen`                                                           |
| `ready`           | Current `WorkflowNode` is active. Render the matching module using `config` + `moduleState`.                                                                                                                | `workflowConfig`, `currentNode`, `config`, `moduleState`, `homeScreen` |
| `completing` | Completing the workflow before the terminal node arrives | `homeScreen` |
| `asyncResolution` | Server is processing an `ASYNC_RESOLUTION` node. UI shows progress until the next node arrives.                                                                                                             | `workflowConfig`, `currentNode`                                        |
| `finished`        | Terminal — workflow's final node was a `FINISH` node.                                                                                                                                                       | `workflowConfig`, `finishStatus`, `scoreStatus`                                       |
| `closed`          | User dismissed the workflow.                                                                                                                                                                                | –                                                                      |
| `error`           | Fatal error.                                                                                                                                                                                                | `error?`, `errorCode?`, `moduleErrorCode?` |

`homeScreen` is an `{ visible, isContinueLoading }` overlay surfaced on `idle`, `loading`, `ready`, and `completing`. When `visible === true`, the consumer renders the launch / intro screen and calls `continueFromHome()` on user confirmation. The flag is suppressed when the back end sets `WorkflowConfig.disableLaunchScreen === true` (see [Module: Workflow](/sdk-reference/web-sdk-2-module-workflow/)).

### API Methods

| Method                 | Description                                                                                                                            |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `load()`               | Start loading the workflow configuration and the first node from the back end.                                                          |
| `completeModule()`     | Mark the current module as complete. Call from the active module's `onFinish` callback to advance to the next node.                    |
| `errorModule(error?, moduleErrorCode?)` | Report a module failure. Supported module error codes can advance to the next step or completion; other failures enter `error`. Forward the module code unchanged so the SDK applies the appropriate behavior. |
| `completeFlow()` | Complete early, skipping remaining steps and notifying the back end. |
| `finishWorkflow()` | Finish locally after an external handoff has already completed the workflow, such as desktop-to-mobile. Does not ask the back end to complete again. |
| `continueFromHome()`   | Advance past the launch / home screen. No-op when the home screen isn't currently visible (e.g. when `disableLaunchScreen` is `true`). |
| `getModuleConfig<T>()` | Returns the current node's `moduleConfiguration` merged with workflow-level flags (`ds`). Typed via the generic parameter.             |
| `getState()`           | Get the current workflow state synchronously.                                                                                          |
| `subscribe(callback)`  | Subscribe to workflow state changes (returns an unsubscribe function).                                                                 |
| `subscribeFlowEvent(listener)` | Subscribe to curated flow milestones; returns an unsubscribe function. See [headless flow events](/sdk-reference/web-sdk-2-event-callbacks/#headless-flow-events). |

### Custom module callback

Workflows can include `CUSTOM_MODULE` nodes that hand control back to your code. Wire `customModuleCallback` to handle them — the callback receives `interviewId`, `nodeId`, and the configured `name`, plus `onSuccess` / `onError` hooks that advance the workflow.

```typescript
customModuleCallback: ({ interviewId, nodeId, name, onSuccess, onError }) => {
  // Run your custom check (call your back end, etc.). Then advance:
  onSuccess('Custom check passed');
  // or onError('Something went wrong');
},
```

Both `onSuccess` and `onError` advance the workflow to the next node — matching SDK 1 behavior. The manager method `errorModule(error?, moduleErrorCode?)` is separate: its outcome depends on the supplied module error code, as described above.

See [Module: Workflow](/sdk-reference/web-sdk-2-module-workflow/) for the `WorkflowConfig` shape and a deeper write-up of the lifecycle.



## Building Custom UI

### React Example: Phone Verification

```tsx
import { useState, useEffect } from 'react';
import { createPhoneManager, type PhoneState } from '@incodetech/core/phone';

function PhoneVerification() {
  const [manager] = useState(() =>
    createPhoneManager({
      config: {
        otpVerification: true,
        otpExpirationInMinutes: 5,
        prefill: false,
      },
    }),
  );
  const [state, setState] = useState<PhoneState>({ status: 'idle' });
  const [phone, setPhone] = useState('');
  const [otp, setOtp] = useState('');

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  const handlePhoneSubmit = () => {
    const isValid = phone.length >= 10; // Add real validation
    manager.setPhoneNumber(phone, isValid);
    manager.submit();
  };

  switch (state.status) {
    case 'inputting':
      return (
        <div>
          <input
            type="tel"
            value={phone}
            onChange={(e) => setPhone(e.target.value)}
            placeholder="Enter phone number"
          />
          {state.phoneError && <p className="error">{state.phoneError}</p>}
          <button onClick={handlePhoneSubmit}>Send OTP</button>
        </div>
      );

    case 'awaitingOtp':
      return (
        <div>
          <p>Enter the code sent to your phone</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value)}
            placeholder="Enter OTP"
            maxLength={6}
          />
          <button onClick={() => manager.submitOtp(otp)}>Verify</button>
          {state.canResend ? (
            <button onClick={() => manager.resendOtp()}>Resend</button>
          ) : (
            <p>Resend in {state.resendTimer}s</p>
          )}
          <button onClick={() => manager.back()}>Change phone</button>
        </div>
      );

    case 'otpError':
      return (
        <div>
          <p className="error">{state.otpError}</p>
          <p>Attempts remaining: {state.attemptsRemaining}</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value)}
            placeholder="Enter OTP"
          />
          <button onClick={() => manager.submitOtp(otp)}>Try Again</button>
        </div>
      );

    case 'finished':
      return <div>✅ Phone verified successfully!</div>;

    case 'error':
      return <div className="error">Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}
```

### React Example: Selfie Capture

```tsx
import { useState, useEffect, useRef } from 'react';
import { createSelfieManager, type SelfieState, type SelfieConfig } from '@incodetech/core/selfie';

function SelfieCapture({ config }: { config: SelfieConfig }) {
  const videoRef = useRef<HTMLVideoElement>(null);
  const [manager] = useState(() =>
    createSelfieManager({ config }),
  );
  const [state, setState] = useState<SelfieState>({ status: 'idle' });

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  // Connect stream to video element
  useEffect(() => {
    if (state.status === 'capture' && state.stream && videoRef.current) {
      videoRef.current.srcObject = state.stream;
    }
  }, [state]);

  switch (state.status) {
    case 'tutorial':
      return (
        <div>
          <h2>Take a Selfie</h2>
          <ul>
            <li>Ensure good lighting</li>
            <li>Remove glasses and hats</li>
            <li>Look directly at the camera</li>
          </ul>
          <button onClick={() => manager.nextStep()}>Continue</button>
        </div>
      );

    case 'permissions':
      if (state.permissionStatus === 'denied') {
        return (
          <div>
            <p>Camera access is required.</p>
            <p>Please enable camera in your browser settings.</p>
          </div>
        );
      }
      return (
        <div>
          <p>We need camera access to take your selfie.</p>
          <button onClick={() => manager.requestPermission()}>
            Allow Camera
          </button>
        </div>
      );

    case 'capture':
      return (
        <div>
          <video ref={videoRef} autoPlay playsInline muted />
          <p>{getDetectionMessage(state.detectionStatus)}</p>
          {!state.onDeviceMode && state.detectionStatus === 'manualCapture' && (
            <button onClick={() => manager.capture()}>Take Photo</button>
          )}
          {state.captureStatus === 'uploadError' && (
            <div>
              <p className="error">{state.uploadError}</p>
              <button onClick={() => manager.retryCapture()}>Retry</button>
            </div>
          )}
        </div>
      );

    case 'finished':
      return <div>✅ Selfie captured successfully!</div>;

    case 'error':
      return <div className="error">Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}

function getDetectionMessage(status: string): string {
  const messages: Record<string, string> = {
    noFace: 'Position your face in the frame',
    tooFar: 'Move closer',
    tooClose: 'Move back',
    centerFace: 'Center your face',
    blur: 'Hold still, image is blurry',
    dark: 'Improve lighting conditions',
    lenses: 'Remove glasses or lenses',
    faceMask: 'Remove face mask',
    capturing: 'Capturing...',
    manualCapture: 'Ready - tap to capture',
  };
  return messages[status] || 'Detecting face...';
}
```



## TypeScript Support

All managers provide full TypeScript support with discriminated unions:

```typescript
import { type PhoneState } from '@incodetech/core/phone';

function handleState(state: PhoneState) {
  switch (state.status) {
    case 'inputting':
      // TypeScript knows: state.countryCode, state.phonePrefix exist
      console.log(`Country: ${state.countryCode}`);
      break;
    case 'awaitingOtp':
      // TypeScript knows: state.resendTimer, state.canResend exist
      console.log(`Resend in: ${state.resendTimer}s`);
      break;
    case 'error':
      // TypeScript knows: state.error exists
      console.error(state.error);
      break;
  }
}
```



## Manager Lifecycle

All managers expose `subscribe()`, `getState()`, and `stop()`. Start and recovery methods vary: most use `load()`, while Video Selfie uses `start()`. After a final state, create a new manager instead of resetting it. The following diagram illustrates a manager that starts with `load()`:

```mermaid
sequenceDiagram
    participant App as Your App
    participant Manager
    participant API as Incode API

    App->>Manager: createXxxManager(config)
    App->>Manager: subscribe(callback)
    Manager-->>App: initial state

    App->>Manager: load()
    Manager->>API: fetch initial data
    API-->>Manager: response
    Manager-->>App: state update

    loop User Interaction
        App->>Manager: setXxx() / submit()
        Manager->>API: API call
        API-->>Manager: response
        Manager-->>App: state update
    end

    App->>Manager: stop()
    Note over Manager: cleanup resources
```



## Dashboard Event Tracking

Track events to the Incode dashboard from your custom UI:

```typescript
import {
  addEvent,
  moduleOpened,
  moduleClosed,
  eventModuleNames,
} from '@incodetech/core/events';

// Track module lifecycle
useEffect(() => {
  moduleOpened(eventModuleNames.phone);
  return () => moduleClosed(eventModuleNames.phone);
}, []);

// Track custom events
addEvent({
  code: 'customButtonClicked',
  module: eventModuleNames.phone,
  payload: { buttonId: 'submit' },
});
```

See [Dashboard Events](/sdk-reference/web-sdk-2-events/) for full documentation.



## Best Practices

1. **Always clean up** – Call `manager.stop()` when unmounting components
2. **Handle all states** – Show appropriate UI for loading, error, and edge cases
3. **Validate inputs** – Pass `isValid` to `setPhoneNumber()` / `setEmail()` before `submit()`
4. **Use **`getState()`** sparingly** – Prefer subscribing to state changes
5. **Show feedback** – Use `detectionStatus` to guide users during capture
6. **Handle retries** – Check `attemptsRemaining` and `canRetry` for error recovery



## See Also

- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Using pre-built UI components
- [Web Components](/sdk-reference/web-sdk-2-web-components/): Framework-agnostic components
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): Orchestrated flows with UI
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): Setting up WebAssembly for ML features

---

- Path: `sdk-reference/web-sdk-2-i18n`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-i18n/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-i18n.md

# Internationalization

<Component slug="web-2-x-implementation-warning" />

The SDK supports 80+ languages for UI text and error messages.

## Setting the Language

Pass the `lang` property inside the `i18n` option when you call `setup()`:

```ts
import { setup } from '@incodetech/web';

await setup({
  apiURL: API_URL,
  token: session.token,
  i18n: {
    lang: 'es', // Spanish
  },
});
```

When the URL contains `?lang=`, that value takes precedence for the current page load. Otherwise, a language previously stored by the SDK (for example, when a user picked one from a language selector) takes precedence over `lang`. Treat `lang` as the default when neither the URL nor a stored choice provides a language.

## How It Works

- The `lang` property sets the UI language for all SDK components within the flow.
- In published 2.3.0 packages, default translations load from bundled locale chunks served with your application. Earlier packages and SDK development builds may use i18nexus at runtime.
- Error messages and instructions are automatically translated.
- The language is also sent to the backend for server-side localization.

## Custom Translations

Provide your own translation strings through the `i18n` option in `setup()`. Pass a `translations` object keyed by language code, then by translation key.

```ts
import { setup } from '@incodetech/web';

await setup({
  apiURL: API_URL,
  token: session.token,
  i18n: {
    translations: {
      en: {
        phone: { verify: 'Verify your phone number' },
        email: { willSendCode: 'We will email you a one-time code.' },
      },
      es: {
        phone: { verify: 'Verifica tu número de teléfono' },
      },
    },
  },
});
```

By default, your strings merge on top of the built-in translations, so you only override the keys you list. Any key you omit keeps its default text.

**Keys** use dotted, camelCase paths in the form `module.description` (for example `phone.verify`). Write them as nested objects (above) or as flat dotted keys:

```ts
translations: {
  en: { 'phone.verify': 'Verify your phone number' },
}
```

Use `{{variableName}}` for values the SDK fills in at runtime — keep the placeholder name unchanged:

```ts
translations: {
  en: { selfie: { retryAttempts: 'You have {{count}} attempts left.' } },
}
```

Translation values are rendered without HTML escaping. Never interpolate user-controlled input directly into a translation string — doing so can introduce a cross-site scripting (XSS) vulnerability. Keep translation values as static, trusted content.

### Disable remote translation loading

Set `skipRemoteLoad: true` to disable the remote backend, including a custom `loadPath`, while applying your inline overrides:

```ts
await setup({
  apiURL: API_URL,
  token: session.token,
  i18n: {
    skipRemoteLoad: true,
    translations: {
      en: {
        /* your translation overrides */
      },
    },
  },
});
```

In 2.3.0, disabling remote loading doesn't create an inline-only mode. The SDK still loads its bundled translations. If a key isn't in your overrides or in any bundled translation (including the English fallback), the SDK shows the last segment of the key in title case: for example, `phone.verify` renders as `Verify`.

### Load translations from your own endpoint

To serve translation files from your own host or CDN, set `loadPath` to a URL template. The SDK fetches one file per language, replacing `{{lng}}` with the language code and `{{ns}}` with the namespace (always `default`):

```ts
await setup({
  apiURL: API_URL,
  token: session.token,
  i18n: {
    loadPath: 'https://cdn.example.com/locales/{{lng}}/{{ns}}.json',
  },
});
```

For example, loading Spanish requests `https://cdn.example.com/locales/es/default.json`. Each file must be a JSON object of translation keys, using the same `module.description` structure shown above.

Setting `loadPath` selects your endpoint instead of the bundled backend (or i18nexus in SDK development builds). Allow that host in your CSP and provide the languages your flow needs, including English fallback. Do not combine it with `skipRemoteLoad: true`, which disables the custom remote backend.

## Supported Languages

The SDK supports the language codes below. Published 2.3.0 packages include generated locale chunks; a custom `loadPath` uses your hosted files instead.

| Code      | Language                  |
| --------- | ------------------------- |
| `en`      | English (default)         |
| `en-DG`   | English (Diego Garcia)    |
| `es`      | Spanish                   |
| `es-ES`   | Spanish (Spain)           |
| `es-MX`   | Spanish (Mexico)          |
| `es-419`  | Spanish (Latin America)   |
| `pt`      | Portuguese                |
| `pt-BR`   | Portuguese (Brazil)       |
| `pt-PT`   | Portuguese (Portugal)     |
| `fr`      | French                    |
| `fr-CA`   | French (Canada)           |
| `de`      | German                    |
| `it`      | Italian                   |
| `nl`      | Dutch                     |
| `pl`      | Polish                    |
| `ru`      | Russian                   |
| `ru-RU`   | Russian (Russia)          |
| `tr`      | Turkish                   |
| `ar`      | Arabic                    |
| `ar-EG`   | Arabic (Egypt)            |
| `ar-AE`   | Arabic (UAE)              |
| `zh`      | Chinese (Simplified)      |
| `zh-CN`   | Chinese (China)           |
| `zh-TW`   | Chinese (Taiwan)          |
| `zh-HANT` | Chinese (Traditional)     |
| `ja`      | Japanese                  |
| `ja-JP`   | Japanese (Japan)          |
| `ko`      | Korean                    |
| `ko-KP`   | Korean (North Korea)      |
| `vi`      | Vietnamese                |
| `id`      | Indonesian                |
| `jv`      | Javanese                  |
| `th`      | Thai                      |
| `th-TH`   | Thai (Thailand)           |
| `hi`      | Hindi                     |
| `bn`      | Bengali                   |
| `ne`      | Nepali                    |
| `ur`      | Urdu                      |
| `fa-IR`   | Persian (Iran)            |
| `uk`      | Ukrainian                 |
| `uk-UA`   | Ukrainian (Ukraine)       |
| `he`      | Hebrew                    |
| `el`      | Greek                     |
| `el-GR`   | Greek (Greece)            |
| `sr`      | Serbian                   |
| `sr-Latn` | Serbian (Latin)           |
| `sr-YU`   | Serbian (Yugoslavia)      |
| `hr`      | Croatian                  |
| `bs`      | Bosnian                   |
| `sl`      | Slovenian                 |
| `mk`      | Macedonian                |
| `hu`      | Hungarian                 |
| `ro`      | Romanian                  |
| `cs`      | Czech                     |
| `cs-CZ`   | Czech (Czechia)           |
| `sk`      | Slovak                    |
| `et`      | Estonian                  |
| `lv`      | Latvian                   |
| `lt`      | Lithuanian                |
| `da-DK`   | Danish (Denmark)          |
| `fi-FI`   | Finnish (Finland)         |
| `nb-NO`   | Norwegian Bokmål (Norway) |
| `sv-SE`   | Swedish (Sweden)          |
| `ca`      | Catalan                   |
| `ms`      | Malay                     |
| `tl`      | Filipino/Tagalog          |
| `tl-PH`   | Filipino (Philippines)    |
| `ceb`     | Cebuano                   |
| `my`      | Burmese                   |
| `km`      | Khmer                     |
| `lo`      | Lao                       |
| `ka`      | Georgian                  |
| `az`      | Azerbaijani               |
| `kk`      | Kazakh                    |
| `ky`      | Kyrgyz                    |
| `uz`      | Uzbek                     |
| `mn`      | Mongolian                 |
| `am`      | Amharic                   |
| `so`      | Somali                    |
| `sw`      | Swahili                   |
| `af-ZA`   | Afrikaans (South Africa)  |
| `ht`      | Haitian Creole            |
| `hmn`     | Hmong                     |

## See Also

- [Theming & Styling](/sdk-reference/web-sdk-2-theming/): Customize appearance
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): Full props reference

---

- Path: `sdk-reference/web-sdk-2-incodeflow-component`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-incodeflow-component/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-incodeflow-component.md

# IncodeFlow Component

<Component slug="web-2-x-implementation-warning" />

`<incode-flow>` is the complete, orchestrated identity verification experience as a standard Web Component. It runs the flow sequence configured in Dashboard end-to-end.

**Important:** the recommended integration creates a session via `createSession()` (or your backend) and passes its token to `<incode-flow>`. The component also supports self-loading configuration with `configurationId` and either `apiKey` or `clientId`.

## Tag

```ts
// Side-effect import — registers the <incode-flow> custom element
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                                                                                  | Required | Description                           |
| ---------- | ------------------------------------------------------------------------------------- | -------- | ------------------------------------- |
| `config`   | `FlowConfig`                                                                          | ✅        | Flow configuration object (see below) |
| `onFinish` | `(result?: FinishStatus) => void`                                                     | ✅        | Called when the flow completes        |
| `onError`  | `(error: string \| undefined, errorCode?: number, machineErrorCode?: string) => void` | ❌        | Called on fatal errors                |

### FlowConfig

`FlowConfig` has two shapes — a token-based variant (recommended) and a self-loading variant. The two are mutually exclusive.

**Token variant (recommended)**: pass a token obtained from `createSession()` (ideally created on your backend):

| Property                | Type                            | Required | Description                                                                                                                                                                                                                                           |
| ----------------------- | ------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `token`                 | `string`                        | ✅       | Session token                                                                                                                                                                                                                                         |
| `lang`                  | `string`                        | ❌       | Language code (e.g., `'en-US'`, `'es-MX'`)                                                                                                                                                                                                            |
| `enableHome`            | `boolean`                       | ❌       | Show the SDK's built-in home screen                                                                                                                                                                                                                   |
| `authHint`              | `string`                        | ❌       | QR/auth hint when re-entering a flow                                                                                                                                                                                                                  |
| `redirectToMobileUrl`   | `string`                        | ❌       | Override the destination URL for the Redirect to Mobile step. The SDK adds the session parameters to this URL.                                                                                                                                        |
| `wasmConfig`            | `WasmConfig`                    | ❌       | WASM paths (see [WASM Configuration](/sdk-reference/web-sdk-2-wasm/))                                                                                                                                                                                             |
| `injectCss` | `boolean` | ❌ | 2.3.0: load Flow and module styles as screens become visible. Default `false`. Keep base and theme CSS; omit the eager Flow stylesheet when enabled |
| `cssNonce` | `string` | ❌ | CSP nonce for styles inserted by `injectCss` |
| `spinnerConfig`         | `SpinnerConfig`                 | ❌       | Loading spinner customization                                                                                                                                                                                                                         |
| `disableDashboardTheme` | `boolean`                       | ❌       | Skip applying Dashboard's theme tokens                                                                                                                                                                                                            |
| `urlUuid`               | `string`                        | ❌       | QR anti-phishing token from the URL (mobile leg)                                                                                                                                                                                                      |
| `useCPF`                | `boolean`                       | ❌       | Enable CPF-only fields on Dashboard's existing `ID_OCR` step. The step key and configuration are preserved, `cpfOnly: true` is added, and the standard ID OCR editing, validation, and submission lifecycle remains in use. Has no effect when the Dashboard flow has no `ID_OCR` step. |
| `onFlowEvent`           | `(event: FlowEvent) => void`    | ❌       | Curated flow milestones                                                                                                                                                                                                                               |
| `onModuleLoading`       | `(moduleKey: string) => void`   | ❌       | Module begins loading (lazy chunk)                                                                                                                                                                                                                    |
| `onModuleLoaded`        | `(moduleKey: string) => void`   | ❌       | Module loaded                                                                                                                                                                                                                                         |
| `onWasmWarmup`          | `(pipelines: string[]) => void` | ❌       | WASM warmup begins                                                                                                                                                                                                                                    |
| `onUrlUuidRefreshed`    | `(urlUuid: string) => void`     | ❌       | New `urlUuid` available — host should update the address bar                                                                                                                                                                                          |
| `assets`                | `AssetOverrides`                | ❌       | Per-instance branded-illustration overrides for this flow, keyed to the published allowlist. Overrides the global `setup({ uiConfig })` value for this flow instance only. See [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/)                                    |
| `animations`            | `AnimationOverrides`            | ❌       | Per-instance Lottie-animation overrides for this flow. Same precedence as `assets`. See [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/)                                                                                                                            |

Set `redirectToMobileUrl` to replace the Dashboard URL for the **Redirect to Mobile** step:

```ts
flow.config = {
  token: session.token,
  redirectToMobileUrl: 'https://yourapp.com/mobile-verification',
};
```

The SDK adds the session parameters to this URL. This property has no effect when the flow does not use **Redirect to Mobile**.

**Self-loading variant** — convenient for prototyping; **avoid in production** because it puts the API key in the browser:

| Property                                                                                             | Type     | Required | Description                    |
| ---------------------------------------------------------------------------------------------------- | -------- | -------- | ------------------------------ |
| `apiKey` (or `clientId`)                                                                             | `string` | ✅        | Auth key for session creation  |
| `configurationId`                                                                                    | `string` | ✅        | Dashboard flow ID              |
| `externalId`, `externalCustomerId`, `customFields`, `uuid`, `urlUuid`, `interviewId`                 | various  | ❌        | Forwarded to `createSession()` |
| Plus any of the optional fields from the token variant above (`lang`, `enableHome`, callbacks, etc.) |          |          |                                |

:::note
`apiURL` **is NOT in **`FlowConfig`**.** It belongs on the global `setup()` call. The component reuses the API URL configured there.
:::

## Basic Usage

### Step 1: Create the session

Create the session via `createSession()` (typically from your backend) and configure the SDK:

```tsx
import { setup } from '@incodetech/core';
import { createSession, initializeSession } from '@incodetech/core/session';

await setup({ apiURL: 'https://demo-api.incodesmile.com' });

const session = await createSession(apiKey, {
  configurationId: 'your-config-id',
  language: 'en-US',
  externalId: 'optional-external-id',
});

await initializeSession({ token: session.token });
```

The `token` is still passed to the component itself via `flowElement.config.token` (see Step 2) — `initializeSession` activates it on the SDK's HTTP client; the component reads it from its own config. `setup({ apiURL, token })` is also supported as a one-shot convenience and delegates to `initializeSession` internally.

### Step 2: Mount the component

**HTML / vanilla TypeScript:**

```html
<incode-flow id="flow"></incode-flow>

<script type="module">
  import '@incodetech/web/themes/light.css';
  import '@incodetech/web/base.css';
  import '@incodetech/web/flow';
  import '@incodetech/web/flow/styles.css';

  const flow = document.getElementById('flow');
  flow.config = { token: session.token, lang: 'en-US', enableHome: true };
  flow.onFinish = (result) => {
    // Only follow https redirects. See onFinish below.
    if (result?.redirectionUrl?.startsWith('https://')) {
      window.location.href = result.redirectionUrl;
    }
  };
  flow.onError = (error, code) => console.error('Flow error:', error, code);
</script>
```

**React:**

> **React 18 or earlier:** add a one-time JSX augmentation so TypeScript recognizes `<incode-flow>` and the other Incode tags. See [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need this.
>
> **React 19+:** you can also drop the ref ceremony entirely and pass `config`/`onFinish`/`onError` as ordinary JSX props. See [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

type FlowElement = HTMLElement & {
  config: FlowConfig;
  onFinish: (result?: FinishStatus) => void;
  onError: (
    error: string | undefined,
    code?: number,
    machineErrorCode?: string,
  ) => void;
};

export function FlowMount({ token }: { token: string }) {
  const ref = useRef<FlowElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = { token, lang: 'en-US', enableHome: true };
    el.onFinish = (result) => {
      if (result?.redirectionUrl?.startsWith('https://')) {
        window.location.href = result.redirectionUrl;
      }
    };
    el.onError = (error, code) => console.error('Flow error:', error, code);
  }, [token]);

  return (
    <incode-flow ref={ref} style={{ display: 'block', height: '100vh' }} />
  );
}
```

For Angular and Vue, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

### Complete React Example

> **React 18 or earlier:** add the JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it, and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useState, useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import { createSession, initializeSession } from '@incodetech/core/session';
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import '@incodetech/web/themes/light.css';
import '@incodetech/web/base.css';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

type FlowElement = HTMLElement & {
  config: FlowConfig;
  onFinish: (result?: FinishStatus) => void;
  onError: (
    error: string | undefined,
    code?: number,
    machineErrorCode?: string,
  ) => void;
};

function MyVerificationFlow() {
  const [sessionToken, setSessionToken] = useState<string | null>(null);
  const [error, setError] = useState<string | null>(null);
  const flowRef = useRef<FlowElement>(null);

  useEffect(() => {
    const initialize = async () => {
      try {
        await setup({ apiURL: 'https://demo-api.incodesmile.com' });
        const session = await createSession('your-api-key', {
          configurationId: 'your-config-id',
          language: 'en-US',
        });
        await initializeSession({ token: session.token });
        setSessionToken(session.token);
      } catch (err) {
        setError(
          err instanceof Error ? err.message : 'Failed to create session',
        );
      }
    };
    initialize();
  }, []);

  useEffect(() => {
    const el = flowRef.current;
    if (!el || !sessionToken) return;
    el.config = { token: sessionToken, lang: 'en-US', enableHome: true };
    el.onFinish = (result) => console.log('Flow completed:', result);
    el.onError = (error) => console.error('Flow error:', error);
  }, [sessionToken]);

  if (error) return <div>Error: {error}</div>;
  if (!sessionToken) return <div>Initializing...</div>;

  return (
    <incode-flow ref={flowRef} style={{ display: 'block', height: '100vh' }} />
  );
}
```

## Custom Start and Completion Screens

### Start screen

Set `enableHome: true` in the flow config to request the SDK launch screen. Dashboard configuration can suppress it. For a host-owned start screen, render your introduction and mount `<incode-flow>` when the user chooses to begin; omit `enableHome` or set it to `false` to avoid a second start screen.

### Completion screen

Render your own completion screen from `<incode-flow>`'s `onFinish` callback. Its optional `FinishStatus` result contains `redirectionUrl`, `action`, `scoreStatus`, `endScreenTitle`, and `endScreenText`. The end-screen copy can be `null`; provide your own fallback copy and handle an absent result. See [Finish Status](/sdk-reference/web-sdk-2-event-callbacks/#finish-status) for the full type.

Keep any session `interviewId` or Flow configuration ID your host needs from the original session/configuration inputs. These identifiers are not fields of the `onFinish` result. Completion alone does not mean approval; use the returned outcome when choosing your screen.

### Language

Set the UI language via the `lang` property in your config:

```ts
flow.config = { token: session.token, lang: 'es' /* Spanish */ };
```

The SDK ships translations for \~85 locales (including regional variants like `en-DG`, `es-MX`, `pt-BR`, `zh-TW`, `fr-CA`). See [Internationalization](/sdk-reference/web-sdk-2-i18n/) for the full list, fallback behavior, and Dashboard interaction.

## Event Callbacks

### onFinish

**Required callback** called when the flow finishes successfully. The component does not render a completion screen — you must handle the finish status yourself:

```ts
flow.onFinish = (result) => {
  console.log('Action:', result?.action); // 'approved' | 'rejected' | 'none'
  console.log('Status:', result?.scoreStatus); // 'OK' | 'WARN' | 'FAIL' | ...
  console.log('Redirect:', result?.redirectionUrl);

  const redirectUrl = result?.redirectionUrl;
  if (result?.action === 'approved' && redirectUrl?.startsWith('https://')) {
    window.location.href = redirectUrl;
  } else if (result?.action === 'rejected') {
    // Show rejection message
  }
};
```

`redirectionUrl` comes from your Dashboard configuration through the Incode API. Check that it starts with `https://` before you navigate to it, so an unexpected value such as a `javascript:` or `data:` URL is never followed. The SDK applies the same rule to the redirects it performs.

The `result` object (typed as `FinishStatus`) contains:

- `redirectionUrl`: URL to redirect to (if configured)
- `action`: `'approved' | 'rejected' | 'none'`
- `scoreStatus`: `'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL'`
- `endScreenTitle`, `endScreenText`: Dashboard completion copy (`string | null`)

Note that `result` may be `undefined` (the callback signature is `(result?: FinishStatus) => void`), so always null-check before reading fields.

### onError

Called when an error occurs:

```ts
flow.onError = (error, code, machineErrorCode) => {
  console.error('Verification error:', error, code, machineErrorCode);
};
```

When a flow does not allow multiple onboardings, `<incode-flow>` checks the session status before loading the first module. If that session is already complete, the component renders its localized finished-session screen and calls `onError` with `machineErrorCode` set to `SESSION_FINISHED`. This applies to token-based, self-loading, and preloaded configurations. Hosts that want to keep the SDK screen visible should not remove or replace the component from this callback.

### onModuleLoading / onModuleLoaded

Track lazy-loading of each module's UI chunk via config callbacks:

```ts
flow.config = {
  token: session.token,
  onModuleLoading: (moduleKey) => console.log(`Loading module: ${moduleKey}`),
  onModuleLoaded: (moduleKey) => console.log(`Loaded module: ${moduleKey}`),
};
```

### onWasmWarmup

Called when the flow requests background warmup, with only the pipelines needed for that request. It can fire multiple times during one flow: an ID → Selfie flow reports `['idCapture']` after Start, then `['selfie']` once ID is active and ready. Repeated state updates and already-ready pipelines do not produce additional notifications. This callback reports the request, not completion; capture modules still await readiness.

With Home enabled, automatic capture warmup waits for Start, then warms the first reachable capture requirement during consent, document selection, or tutorials. Flows without Home warm after mounting. Fast entry into capture may show its existing loading state while the shared warmup finishes. Progress warms the next requirement; a Redirect to Mobile step stops lookahead. `preloadIncodeFlow()` preloads metadata and UI only. Explicit `setup({ wasm: ... })` preloading remains eager.

```ts
flow.config = {
  token: session.token,
  onWasmWarmup: (pipelines) => {
    console.log('Warming up:', pipelines); // e.g., ['idCapture'], later ['selfie']
  },
};
```

## WASM Configuration

For ML-powered modules (selfie, ID capture), preload WASM with the `wasm` option on `setup()` so models are ready by the time the user reaches a camera step. The Incode CDN serves sensible defaults — you only need to pick which pipelines to preload:

```ts
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: session.token,
  wasm: { pipelines: ['selfie', 'idCapture'] },
});

// Then mount <incode-flow> as shown in Basic Usage above.
```

If you omit the `wasm` option, the SDK loads WASM lazily when the user reaches the first selfie or ID-capture step. Pass `wasm: false` to explicitly disable preload (useful when this page only runs phone/email flows). For self-hosted paths, custom model files, or the lower-level `warmupWasm()` API, see [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).

## Loading Spinner Customization

`<incode-flow>` shows a transition spinner during initialization, while a module's lazy chunk loads, and between flow steps. The same spinner is used in every phase.

**Default text behavior:** if you don't pass `spinnerConfig`, the spinner renders with **no title or subtitle** — only the spinning icon. As soon as you set either `spinnerConfig.title` or `spinnerConfig.subtitle`, the missing field falls back to the SDK's translated defaults (i18n keys `loadingCircle.holdOn` for the title, `loadingCircle.validating` for the subtitle, which display as "Hold on" / "Validating" in English).

### SpinnerConfig Options

| Property     | Type                                              | Description                                                   |
| ------------ | ------------------------------------------------- | ------------------------------------------------------------- |
| `renderMode` | `'spinnerAndText' \| 'spinnerOnly' \| 'textOnly'` | Which parts of the loader render.                             |
| `size`       | `'small' \| 'medium' \| 'large'`                  | Size of the spinner icon (default: `'medium'`)                |
| `title`      | `string`                                          | **Deprecated** — set copy via i18n instead. Removed in 2.3.0. |
| `subtitle`   | `string`                                          | **Deprecated** — set copy via i18n instead. Removed in 2.3.0. |

> **Deprecation:** `title` and `subtitle` still work in 2.2.0 but will be removed in 2.3.0. Change loader copy through translations instead — override `loadingCircle.holdOn` and `loadingCircle.validating` via [Custom Translations](/sdk-reference/web-sdk-2-i18n/#custom-translations). Copy set in translations follows a runtime language change; a literal string here does not.
>
> To control loader presentation across **every** SDK loader — including the module-internal ones this config never reached — use `spinner` in [Theming & Styling](/sdk-reference/web-sdk-2-theming/#loader-presentation).

### Custom Text

```ts
flow.config = {
  token: session.token,
  spinnerConfig: {
    title: 'Verifying your identity',
    subtitle: "This won't take long...",
    size: 'large',
  },
};
```

### CSS Variable Customization

You can also customize the spinner appearance using CSS variables:

```css
:root {
  /* Spinner colors */
  --spinner-surface-primary: #0066cc;
  --spinner-surface-secondary: #e6f0ff;

  /* Spinner text */
  --spinner-text-title: #1a1a1a;
  --spinner-text-subtitle: #666666;

  /* Spinner overlay background */
  --spinner-surface-overlay: #ffffff;
  --spinner-surface-overlay-opacity: 1;
}
```

See [Theming & Styling](/sdk-reference/web-sdk-2-theming/) for more details on CSS customization.

### Replacing the Spinner Graphic

The options above recolor and resize the built-in spinner. To replace it entirely with your own SVG or Lottie asset, set the `loader.spinner` key in `assets` or `animations` — see [Asset Overrides § The loading spinner](/sdk-reference/web-sdk-2-asset-overrides/#the-loading-spinner).

## Web Component

`IncodeFlow` is also available as a standard Web Component for framework-agnostic usage:

```html
<!DOCTYPE html>
<html>
  <head>
    <style>
      html,
      body,
      incode-flow {
        height: 100%;
        margin: 0;
      }
      incode-flow {
        display: block;
      }
    </style>
  </head>
  <body>
    <incode-flow></incode-flow>

    <script type="module">
      import { setup } from '@incodetech/core';
      import {
        createSession,
        initializeSession,
      } from '@incodetech/core/session';
      import '@incodetech/web/themes/light.css';
      import '@incodetech/web/base.css';
      import '@incodetech/web/flow';
      import '@incodetech/web/flow/styles.css';

      async function initializeFlow() {
        try {
          await setup({ apiURL: 'https://demo-api.incodesmile.com' });

          const session = await createSession('your-api-key', {
            configurationId: 'your-config-id',
            language: 'en-US',
          });

          await initializeSession({ token: session.token });

          const flow = document.querySelector('incode-flow');
          flow.config = {
            token: session.token,
            lang: 'en-US',
            enableHome: true,
          };
          flow.onFinish = (result) => {
            if (
              result.action === 'approved' &&
              result.redirectionUrl?.startsWith('https://')
            ) {
              window.location.href = result.redirectionUrl;
            }
          };
          flow.onError = (error, code) => console.error('Error:', error, code);
        } catch (error) {
          console.error('Failed to initialize:', error);
        }
      }

      initializeFlow();
    </script>
  </body>
</html>
```

## TypeScript

Full type definitions are included. Import `FlowConfig` from `@incodetech/web/flow` and `FinishStatus` from `@incodetech/core/flow`:

```typescript
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import '@incodetech/web/flow';

// Automatically typed via HTMLElementTagNameMap augmentation
const flow = document.createElement('incode-flow');
flow.config = {
  // ✅ typed as FlowConfig
  token: 'session-token-from-createSession',
  lang: 'en-US',
};
flow.onFinish = (result) => {
  // ✅ result typed as FinishStatus | undefined
  console.log(result?.action);
};
```

See [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/#web-component-element-types) for more details.

## Unsupported Modules

If the orchestrated flow returns a step whose UI module isn't bundled in this SDK build, `<incode-flow>` renders a fallback screen titled **"Module not available"** with a **Next** button. Clicking Next calls `flowManager.completeModule()` and advances the flow.

This keeps the rest of a multi-step flow working when one step is unrecognized — useful when Dashboard configuration runs ahead of the SDK release. It applies only to the `<incode-flow>` component; in headless mode (`createOrchestratedFlowManager` with your own UI), an unrecognized step key throws `"No registered module found for: <KEY>"`.

---

- Path: `sdk-reference/web-sdk-2-individual-modules`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-individual-modules/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-individual-modules.md

# Individual Modules Catalog

<Component slug="web-2-x-implementation-warning" />

The Incode Web SDK is composed of small, single-purpose modules. Each module ships independently and exposes (depending on the module) a web component, a headless Manager, or both.

This page is the **complete catalog**. For deep-dives, see the per-module reference pages linked below where they exist; otherwise consult [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/) for headless API patterns and [Web Components](/sdk-reference/web-sdk-2-web-components/) for the consumer-element API surface.

> **New here?** Most modules follow one of five implementation patterns (form-based, camera-capture, backend-process, document-signing, composite). [Module Patterns](/sdk-reference/web-sdk-2-module-patterns/) documents each pattern's lifecycle once so per-module pages can stay focused on what's actually unique. Read that first if you're orienting on the SDK.

## How to read this catalog

| Column               | Meaning                                                                                                                               |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **Web component**    | If present, registered automatically when you import the UI subpath. Use as a custom element (e.g. `<incode-phone>`).                 |
| **Headless manager** | If present, the factory function for the module's headless API (subscribe to state, drive the state machine yourself, render any UI). |
| **Core import**      | Where the module's TypeScript types and headless API live.                                                                            |
| **UI import**        | Side-effect import that registers the web component and lets you import its CSS. Empty when the module is headless-only.              |

For a tour of how to combine these into a full integration, start with [Getting Started](/sdk-reference/web-sdk-2-getting-started/).

## Flow-backed standalone modules

Standalone modules can read their configuration from the active Flow. This lets a host render modules such as ID, Selfie, or Phone without copying their configuration into application code.

> **Use **`setup()`** from **`@incodetech/web`** for standalone modules.** Both entry points support `flow`; standalone modules load the dashboard theme only from web setup. Set up through `@incodetech/core` instead and these modules render unbranded, with no error — see [Which `setup()` do I call?](/sdk-reference/web-sdk-2-reference/#which-setup-do-i-call).

Flow configuration and the session theme are independent:

- `flow` controls where standalone module configuration comes from and whether it is prefetched.
- `theme` controls whether the session theme is fetched and applied.

### ID followed by Selfie

The examples below preload one Flow, disable the session theme, and render the registered ID and Selfie web components directly in JSX. Both modules intentionally omit `config`.

#### React 19

React 19 passes function-valued custom element properties directly:

```jsx
import { setup } from '@incodetech/web';
import '@incodetech/web/id';
import '@incodetech/web/selfie';
import { useEffect, useState } from 'react';

export function Verification() {
  const [step, setStep] = useState('loading');

  useEffect(() => {
    void setup({
      apiURL,
      token,
      flow: {
        preload: true,
      },
      theme: false,
    }).then(() => setStep('id'));
  }, []);

  if (step === 'id') {
    return (
      <incode-id
        onFinish={() => setStep('selfie')}
        onError={(error) => console.error('ID failed', error)}
      />
    );
  }

  if (step === 'selfie') {
    return (
      <incode-selfie
        onFinish={() => setStep('finished')}
        onError={(error) => console.error('Selfie failed', error)}
      />
    );
  }

  return null;
}
```

#### React 18

React 18 renders custom elements directly, but function-valued properties must be assigned through refs:

```jsx
import { setup } from '@incodetech/web';
import '@incodetech/web/id';
import '@incodetech/web/selfie';
import { useEffect, useRef, useState } from 'react';

function ID({ onFinish, onError }) {
  const ref = useRef(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) {
      return;
    }
    element.onFinish = onFinish;
    element.onError = onError;

    return () => {
      element.onFinish = undefined;
      element.onError = undefined;
    };
  }, [onError, onFinish]);

  return <incode-id ref={ref} />;
}

function Selfie({ onFinish, onError }) {
  const ref = useRef(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) {
      return;
    }
    element.onFinish = onFinish;
    element.onError = onError;

    return () => {
      element.onFinish = undefined;
      element.onError = undefined;
    };
  }, [onError, onFinish]);

  return <incode-selfie ref={ref} />;
}

export function Verification() {
  const [step, setStep] = useState('loading');

  useEffect(() => {
    void setup({
      apiURL,
      token,
      flow: {
        preload: true,
      },
      theme: false,
    }).then(() => setStep('id'));
  }, []);

  if (step === 'id') {
    return (
      <ID
        onFinish={() => setStep('selfie')}
        onError={(error) => console.error('ID failed', error)}
      />
    );
  }

  if (step === 'selfie') {
    return (
      <Selfie
        onFinish={() => setStep('finished')}
        onError={(error) => console.error('Selfie failed', error)}
      />
    );
  }

  return null;
}
```

`setup` fetches Flow once and waits for it. ID reads the first `ID` module configuration from the cached Flow. Selfie later reads the first `SELFIE` configuration from the same cache, so mounting Selfie does not issue another Flow request. `theme: false` ensures that Flow configuration is used without changing the host application's colors, logo, subtitle, or footer.

The session token must belong to a Flow containing both `ID` and `SELFIE`. If either module is missing, that module reports an error instead of falling back to library defaults.

### Setup options

| Setup option                                 | Setup request | Supplied module `config`       | Omitted module `config` |
| -------------------------------------------- | ------------- | ------------------------------ | ----------------------- |
| Omit `flow` or use `flow: {}`                | None          | Used verbatim                  | Loaded from Flow        |
| `flow: false`                                | None          | Used verbatim                  | Error                   |
| `flow: { preload: true }`                    | Flow          | Used verbatim                  | Loaded from cached Flow |
| `flow: { mergeConfig: true }`                | None          | Merged over Flow on mount      | Loaded from Flow        |
| `flow: { preload: true, mergeConfig: true }` | Flow          | Merged over prefetched Flow    | Loaded from cached Flow |
| Omit `theme` or use `theme: {}`              | None          | Existing theme remains         | Theme loads on mount    |
| `theme: false`                               | None          | Session theme never applies    | Session theme disabled  |
| `theme: { preload: true }`                   | Theme         | Session theme applies in setup | Session theme applies   |

Flow and theme requests are independent. For example, `flow: { preload: true }, theme: false` preloads module configuration without fetching or applying the session theme.

### Override part of the Flow configuration

Enable merging when the Flow should provide defaults but the host needs to override selected fields. In React 19:

```jsx
await setup({
  apiURL,
  token,
  flow: {
    preload: true,
    mergeConfig: true,
  },
  theme: false,
});

<incode-selfie config={{ showTutorial: false }} />;
```

Objects merge recursively, arrays are replaced, and defined local values including `null` win. Without `mergeConfig: true`, any supplied `config` is used verbatim and Flow is not consulted for that module.

### Disable Flow configuration

Use a complete local config or a supported external manager when Flow-backed configuration is disabled. In React 19:

```jsx
await setup({
  apiURL,
  token,
  flow: false,
  theme: false,
});

<incode-id config={localIdConfig} />;
```

Rendering `<incode-id />` in this mode reports `Flow-backed module configuration is disabled; provide config or manager`.

Standalone Flow resolution requires an active Flow session. A Workflow-only token cannot supply standalone Flow configuration. Modules rendered inside Flow or Workflow orchestration already receive authoritative configuration from their orchestrator and do not use this standalone fallback.

Direct Core setup supports the same `flow` option and semantics. The `theme` option belongs to Web setup because Core does not render or apply UI themes.

***

## Identity capture

| Module               | Web component               | Headless manager                    | Core import                         | UI import                          |
| -------------------- | --------------------------- | ----------------------------------- | ----------------------------------- | ---------------------------------- |
| **Selfie**           | `<incode-selfie>`           | `createSelfieManager`               | `@incodetech/core/selfie`           | `@incodetech/web/selfie`           |
| **Video selfie**     | `<incode-video-selfie>`     | `createVideoSelfieRecordingManager` | `@incodetech/core/video-selfie`     | `@incodetech/web/video-selfie`     |
| **Personhood**       | Unavailable in 2.3.0        | —                                  | —                                  | —                                  |
| **ID document**      | `<incode-id>`               | `createIdCaptureManager`            | `@incodetech/core/id`               | `@incodetech/web/id`               |
| **ID OCR**           | —                           | `createIdOcrManager`                | `@incodetech/core/id-ocr`           | —                                  |
| **Document capture** | `<incode-document-capture>` | `createDocumentCaptureManager`      | `@incodetech/core/document-capture` | `@incodetech/web/document-capture` |
| **Face match**       | `<incode-face-match>`       | `createFaceMatchManager`            | `@incodetech/core/face-match`       | `@incodetech/web/face-match`       |

- **Selfie**: face capture with ML-powered liveness detection. Supports single-frame, multi-modal, and video-liveness modes. Validates against masks, glasses, headwear, closed eyes, lighting. See [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/).
- **Video selfie**: selfie, ID, and optional voice-consent capture in one continuous camera session, recorded on-device and uploaded alongside the captures. See [Module: Video Selfie](/sdk-reference/web-sdk-2-module-video-selfie/).
- **Personhood:** unavailable in Web SDK 2.3.0. Before upgrading, remove Personhood imports and `incode-personhood-widget` usage from your integration.
- **ID document**: government ID, passport, and driver's-license capture with quality checks (blur, glare, perspective). See [Module: ID](/sdk-reference/web-sdk-2-module-id-capture/).
- **ID OCR**: extracts structured data from a captured ID image (name, DOB, address, ID number, etc.). With `cpfOnly: true`, or when `<incode-flow>` receives `useCPF: true`, it shows and validates only the CPF document number field. See [Module: ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/).
- **Document capture**: generic document capture (utility bills, lease agreements, tax docs) with multi-page support and file-picker fallback. See [Module: Document Capture](/sdk-reference/web-sdk-2-module-document-capture/).
- **Face match**: compares a captured selfie against the face on a previously captured ID and returns a match score. See [Module: Face Match](/sdk-reference/web-sdk-2-module-face-match/).

### Video selfie step order

Standalone Video Selfie integrations can set `config.steps`. The array controls
the tutorial, camera order, WASM pipelines, progress UI, and recording manager.

```ts
import '@incodetech/web/video-selfie';
import type { VideoSelfie } from '@incodetech/web/video-selfie';
import type { ComponentProps } from 'preact';
import type {
  VideoSelfieConfig,
  VideoSelfieStep,
} from '@incodetech/core/video-selfie';

const steps: VideoSelfieStep[] = ['selfie', 'frontId', 'backId'];

export function mountVideoSelfie(config: VideoSelfieConfig) {
  const element = document.createElement('incode-video-selfie') as HTMLElement & ComponentProps<typeof VideoSelfie>;
  element.config = { ...config, steps };
  document.body.append(element);
}
```

The valid values are `selfie`, `frontId`, `backId`, `poa`, `questions`, and
`speech`. The SDK preserves the supplied order. The list can omit optional
steps, such as `backId`, `poa`, `questions`, or `speech`.

If `steps` is absent or empty, the SDK derives the default order from the
Video Selfie configuration. Flow and Workflow `VIDEO_ONBOARDING` modules keep
this default behavior.

The headless manager also accepts a top-level `steps` value. If both lists are
nonempty, the manager-level value takes precedence over `config.steps`.

## Contact verification

| Module    | Web component    | Headless manager     | Core import              | UI import               |
| --------- | ---------------- | -------------------- | ------------------------ | ----------------------- |
| **Phone** | `<incode-phone>` | `createPhoneManager` | `@incodetech/core/phone` | `@incodetech/web/phone` |
| **Email** | `<incode-email>` | `createEmailManager` | `@incodetech/core/email` | `@incodetech/web/email` |

- **Phone**: phone-number capture with optional SMS OTP verification. See [Module: Phone](/sdk-reference/web-sdk-2-module-phone/).
- **Email**: email capture with optional OTP verification. See [Module: Email](/sdk-reference/web-sdk-2-module-email/).

## Compliance & consent

| Module                     | Web component              | Headless manager                    | Core import                               | UI import                         |
| -------------------------- | -------------------------- | ----------------------------------- | ----------------------------------------- | --------------------------------- |
| **Consent**                | `<incode-consent>`         | `createConsentManager`              | `@incodetech/core/consent`                | `@incodetech/web/consent`         |
| **Mandatory consent**      | —                          | `createMandatoryConsentManager`     | `@incodetech/core/mandatory-consent`      | —                                 |
| **Geolocation**            | `<incode-geolocation>`     | `createGeolocationManager`          | `@incodetech/core/geolocation`            | `@incodetech/web/geolocation`     |
| **Antifraud**              | `<incode-antifraud>`       | `createAntifraudManager`            | `@incodetech/core/antifraud`              | `@incodetech/web/antifraud`       |
| **Watchlist**              | —                          | `createWatchlistManager`            | `@incodetech/core/watchlist`              | —                                 |
| **Custom watchlist**       | —                          | `createCustomWatchlistManager`      | `@incodetech/core/custom-watchlist`       | —                                 |
| **Watchlist for business** | —                          | `createWatchlistForBusinessManager` | `@incodetech/core/watchlist-for-business` | —                                 |
| **Government validation** | `<incode-government-validation>` | `createGovernmentValidationManager` | `@incodetech/core/government-validation` | `@incodetech/web/government-validation` |
| **CURP validation**        | `<incode-curp-validation>` | `createCurpValidationManager`       | `@incodetech/core/curp-validation`        | `@incodetech/web/curp-validation` |
| **Fiscal QR**              | `<incode-fiscal-qr>`       | `createFiscalQrManager`             | `@incodetech/core/fiscal-qr`              | `@incodetech/web/fiscal-qr`       |

- **Consent**: capture user consent with optional checkboxes for terms, privacy, marketing. See [Module: Consent](/sdk-reference/web-sdk-2-module-consent/).
- **Mandatory consent**: strict consent flow that gates downstream modules until the user accepts. See [Standalone mandatory consent](#standalone-mandatory-consent). The embedded ID consent state has a separate API.
- **Geolocation**: captures the user's coordinates with a permission prompt; useful for jurisdictional rules. See [Module: Geolocation](/sdk-reference/web-sdk-2-module-geolocation/).
- **Antifraud**: runs antifraud signal collection in the background. See [Module: Antifraud](/sdk-reference/web-sdk-2-module-antifraud/).
- **Watchlist** / **Custom watchlist** / **Watchlist for business**: sanctions, PEP, and custom-list screening. See [Module: Watchlist](/sdk-reference/web-sdk-2-module-watchlist/), [Module: Custom Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/), [Module: Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/).
- **Government validation**: submits ID data for backend government validation and displays a loader before advancing; it has no OTP UI. See [Module: Government Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/).
- **CURP validation**: validates Mexican CURP identity numbers (enter / confirm / generate). See [Module: CURP Validation](/sdk-reference/web-sdk-2-module-curp-validation/).
- **Fiscal QR**: scans a Mexican SAT fiscal QR code, resolves its URL, and submits the fiscal data for verification. No dedicated reference page yet. It takes **no configuration** — `FiscalQrConfig` is empty, because the backend sends no settings for this step. Its states are `idle`, `scanning`, `capturing`, `success`, `processing`, `verified`, `permissionDenied`, `error`, and `finished`; drive it with `load()`, `continue()`, and `skip()`. A scan can be rejected with a `2xx` response, so treat a failure result as a failure rather than checking only the HTTP status. In `permissionDenied`, show instructions to correct browser camera permissions and reload the page. `continue()`, `skip()`, and `reset()` do not retry that state.

### Standalone mandatory consent

Import `createMandatoryConsentManager`, `MandatoryConsentConfig`, and `MandatoryConsentState` from `@incodetech/core/mandatory-consent`.

| Config field | Type | Required | Description |
| --- | --- | --- | --- |
| `consentType` | `RegulationTypes` | Yes | Regulation supplied by the active session, such as `US`, `Worldwide`, `Other`, or the supported US regional variants. |
| `language` | `string` | No | Language for consent content; defaults to the active SDK language. |
| `type` | `'MANDATORY' \| 'ML'` | No | Regulatory consent category. Default `MANDATORY`; use `ML` for the configured ML consent step. |

`idle` waits for `load()`, then `loading` fetches the consent. In `display`, render `title: string`, `text: string`, `isSigned: boolean`, `canSubmit: boolean`, and optional `error: string`. In `submitting`, the same title/text/selection remain available, but `canSubmit` is `false` and `error` is absent. `finished` and `closed` are final; `error` exposes an error string.

| Method | Callable when | Purpose |
| --- | --- | --- |
| `load()` | `idle` | Load the required consent. |
| `toggle()` | `display` | Update the user's explicit acceptance selection. |
| `submit()` | `display`, with `canSubmit` true | Submit acceptance to the backend. |
| `cancel()` | `display`, `error` | Decline or leave; reaches `closed`. |
| `retry()` | `display`, `error` | Reload consent after a failure. |
| `reset()` | `error` | Return to `idle`. |

Do not auto-select consent or treat cancellation as acceptance. The server enforces consent requirements. Stop and recreate the manager after a final state. ID's embedded consent uses `acceptMandatoryConsent()` / `cancelMandatoryConsent()` instead of this standalone contract.

## Authentication & identity reuse

| Module             | Web component             | Headless manager              | Core import                       | UI import                        |
| ------------------ | ------------------------- | ----------------------------- | --------------------------------- | -------------------------------- |
| **Authentication** | —                         | `createAuthenticationManager` | `@incodetech/core/authentication` | —                                |
| **Identity reuse** | `<incode-identity-reuse>` | `createIdentityReuseManager`  | `@incodetech/core/identity-reuse` | `@incodetech/web/identity-reuse` |

- **Authentication**: re-authenticate a returning user via fresh selfie capture matched against their stored biometric. Same camera-capture flow as Selfie. See [Module: Authentication](/sdk-reference/web-sdk-2-module-authentication/).
- **Identity reuse**: recognizes a returning user via face match against their existing on-file biometric record and lets them choose to reuse the existing identity. See [Module: Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/).

## Signing

| Module                   | Web component                   | Headless manager                   | Core import                             | UI import                              |
| ------------------------ | ------------------------------- | ---------------------------------- | --------------------------------------- | -------------------------------------- |
| **Signature**            | `<incode-signature>`            | `createSignatureManager`           | `@incodetech/core/signature`            | `@incodetech/web/signature`            |
| **Electronic signature** | `<incode-electronic-signature>` | `createElectronicSignatureManager` | `@incodetech/core/electronic-signature` | `@incodetech/web/electronic-signature` |
| **AE signature**         | `<incode-ae-signature>`         | `createAeSignatureManager`         | `@incodetech/core/ae-signature`         | `@incodetech/web/ae-signature`         |
| **QE signature**         | `<incode-qe-signature>`         | `createQeSignatureManager`         | `@incodetech/core/qe-signature`         | `@incodetech/web/qe-signature`         |

- **Signature**: handwritten signature capture on a touch surface or mouse-driven canvas. See [Module: Signature](/sdk-reference/web-sdk-2-module-signature/).
- **Electronic signature**, **AE signature**, **QE signature**: eIDAS-aligned signing flows. AE and QE are thin wrappers around Electronic Signature (same state machine, different consent keys). All three covered in [Module: Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/).

## Composite & orchestration

| Module                        | Web component                        | Headless manager                                              | Core import                                  | UI import                                   |
| ----------------------------- | ------------------------------------ | ------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------- |
| **Flow (orchestrator)**       | `<incode-flow>`                      | `createOrchestratedFlowManager`, `createFlowManager` (legacy) | `@incodetech/core/flow`                      | `@incodetech/web/flow`                      |
| **Workflow**                  | `<incode-workflow>`                  | `createWorkflowManager`                                       | `@incodetech/core/workflow`                  | `@incodetech/web/workflow`                  |
| **eKYC**                      | `<incode-ekyc>`                      | `createEkycManager`                                           | `@incodetech/core/ekyc`                      | `@incodetech/web/ekyc`                      |
| **eKYB**                      | `<incode-ekyb>`                      | `createEkybManager`                                           | `@incodetech/core/ekyb`                      | `@incodetech/web/ekyb`                      |
| **Cross-document data match** | `<incode-cross-document-data-match>` | `createCrossDocumentDataMatchManager`                         | `@incodetech/core/cross-document-data-match` | `@incodetech/web/cross-document-data-match` |
| **Certificate issuance**      | `<incode-certificate-issuance>`      | `createCertificateIssuanceManager`                            | `@incodetech/core/certificate-issuance`      | `@incodetech/web/certificate-issuance`      |
| **Field comparison**          | `<incode-field-comparison>`          | `createFieldComparisonManager`                                | `@incodetech/core/field-comparison`          | `@incodetech/web/field-comparison`          |
| **Custom fields**             | —                                    | `createCustomFieldsManager`                                   | `@incodetech/core/custom-fields`             | —                                           |
| **Dynamic forms**             | `<incode-dynamic-forms>`             | `createDynamicFormsManager`                                   | `@incodetech/core/dynamic-forms`             | `@incodetech/web/dynamic-forms`             |
| **Trust graph**               | —                                    | `createTrustGraphManager`                                     | `@incodetech/core/trust-graph`               | —                                           |

- **Flow (orchestrator)**: drives a dashboard-configured sequence of modules end-to-end. The default for most integrations. `createOrchestratedFlowManager` is the modern API; `createFlowManager` is legacy and stays for back-compat. See [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/) and [Headless Mode → Orchestrated Flow Manager](/sdk-reference/web-sdk-2-headless-mode/#orchestrated-flow-manager).
- **Workflow**: server-driven multi-step workflows where step ordering and configuration come from the backend per session, including custom-module callbacks. See [Module: Workflow](/sdk-reference/web-sdk-2-module-workflow/).
- **eKYC**: Know Your Customer form module: collects identity verification data (name, DOB, address, etc.) with dashboard-driven field schema. See [Module: eKYC](/sdk-reference/web-sdk-2-module-ekyc/).
- **eKYB**: Know Your Business form module: business name, address, tax ID, plus UBOs. Country-aware schema. See [Module: eKYB](/sdk-reference/web-sdk-2-module-ekyb/).
- **Cross-document data match**: cross-references data across multiple captured documents to flag inconsistencies. See [Module: Cross-Document Data Match](/sdk-reference/web-sdk-2-module-cross-doc-match/).
- **Certificate issuance**: issues a digital certificate at the end of a verification flow: the user sets a protecting password, the backend issues the certificate, and the SDK offers it for download. See [Module: Certificate Issuance](/sdk-reference/web-sdk-2-module-certificate-issuance/).
- **Field comparison**: collects the user's first and last name and submits them for backend verification against the data already on file for the session. See [Module: Field Comparison](/sdk-reference/web-sdk-2-module-field-comparison/).
- **Custom fields**: collect arbitrary structured data (text, number, date, boolean) from a dashboard-defined schema. See [Module: Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/).
- **Dynamic forms**: server-driven multi-screen form module. Screen schema, fields, and validation rules come from the backend per session — useful for jurisdiction-specific questionnaires that change without an SDK release. Use `<incode-dynamic-forms>` standalone, let `<incode-flow>` mount it automatically, or drive the headless manager with your own UI. See [Module: Dynamic Forms](/sdk-reference/web-sdk-2-module-dynamic-forms/).
- **Trust graph**: backend-only risk-graph analysis. The orchestrator renders an empty shell while the server runs the analysis; the module advances to `finished` automatically once the backend reports done. No UI element, no config (`TrustGraphConfig = Record<string, never>`).

## Utility

| Module                 | Web component                 | Headless manager                | Core import                           | UI import                            |
| ---------------------- | ----------------------------- | ------------------------------- | ------------------------------------- | ------------------------------------ |
| **Home**               | —                             | `createHomeManager`             | `@incodetech/core/home`               | —                                    |
| **Redirect to mobile** | `<incode-redirect-to-mobile>` | `createRedirectToMobileManager` | `@incodetech/core/redirect-to-mobile` | `@incodetech/web/redirect-to-mobile` |

- **Home**: the SDK's built-in home screen presented before a flow starts. Wired automatically by `<incode-flow>` when `enableHome: true`. See [Module: Home](/sdk-reference/web-sdk-2-module-home/).
- **Redirect to mobile**: generates a QR code and a one-time URL that hands the user off from a desktop browser to their phone, where camera-bearing modules continue. See [Module: Redirect to Mobile](/sdk-reference/web-sdk-2-module-redirect-to-mobile/).

***

## Helpers used by every integration

These aren't modules per se — they're SDK-wide helpers you'll hit on day one.

| Helper                      | Import                           | What it does                                                                                                                                                                                                                                                                                                           |
| --------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setup`                     | `@incodetech/core`               | Configures the SDK (apiURL, token, optional WASM/i18n/UI options). Call before any module.                                                                                                                                                                                                                             |
| `createSession`             | `@incodetech/core/session`       | Opens a verification session, returns a session token. Production: call from your backend.                                                                                                                                                                                                                             |
| `warmupWasm`                | `@incodetech/core/wasm`          | Pre-warms the WASM ML pipelines (selfie, idCapture). Optional but reduces first-frame latency. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).                                                                                                                                                                           |
| `getRequiredWasmPipelines`  | `@incodetech/core/flow`          | Given the orchestrator's resolved flow, returns just the pipelines needed (so you don't warm up models you won't use).                                                                                                                                                                                                 |
| `subscribeEvent`            | `@incodetech/core/events`        | Subscribes to the SDK's raw analytics event stream. See [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/).                                                                                                                                                                                                              |
| `createFaceAvatar`          | `@incodetech/core/avatar`        | Renders a cosmetic avatar over a camera stream, for hosts building their own capture screen. Display-only — it never feeds detection, quality, liveness, or upload. The bundled modules use it via `selfieConcealmentOption`; see [Module: Selfie → Face concealment](/sdk-reference/web-sdk-2-module-selfie-1/#face-concealment). |
| `createXxxManagerFromActor` | `@incodetech/core/extensibility` | For advanced cases where you supply a pre-built XState actor (e.g., to mock services in tests or override actors in production).                                                                                                                                                                                       |

## Per-module reference pages

Every module has a dedicated reference page covering its tag, properties, configuration, state machine, and API methods. Pages cross-reference [Module Patterns](/sdk-reference/web-sdk-2-module-patterns/) for the shared lifecycle (subscribe / getState / stop and module-specific start and recovery transitions) so they stay focused on what's module-specific.

**Identity capture:** [Selfie](/sdk-reference/web-sdk-2-module-selfie-1/) · [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/) · [ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/) · [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/) · [Face Match](/sdk-reference/web-sdk-2-module-face-match/)

**Contact verification:** [Phone](/sdk-reference/web-sdk-2-module-phone/) · [Email](/sdk-reference/web-sdk-2-module-email/)

**Compliance & consent:** [Consent](/sdk-reference/web-sdk-2-module-consent/) · [Geolocation](/sdk-reference/web-sdk-2-module-geolocation/) · [Antifraud](/sdk-reference/web-sdk-2-module-antifraud/) · [Watchlist](/sdk-reference/web-sdk-2-module-watchlist/) · [Custom Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/) · [Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/) · [Government Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/) · [CURP Validation](/sdk-reference/web-sdk-2-module-curp-validation/)

**Authentication & identity reuse:** [Authentication](/sdk-reference/web-sdk-2-module-authentication/) · [Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/)

**Signing:** [Signature](/sdk-reference/web-sdk-2-module-signature/) · [Electronic Signature (covers AE / QE variants)](/sdk-reference/web-sdk-2-module-electronic-signature/)

**Composite & orchestration:** [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/) · [Workflow](/sdk-reference/web-sdk-2-module-workflow/) · [eKYC](/sdk-reference/web-sdk-2-module-ekyc/) · [eKYB](/sdk-reference/web-sdk-2-module-ekyb/) · [Cross-Document Data Match](/sdk-reference/web-sdk-2-module-cross-doc-match/) · [Certificate Issuance](/sdk-reference/web-sdk-2-module-certificate-issuance/) · [Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/)

**Utility:** [Home](/sdk-reference/web-sdk-2-module-home/) · [Redirect to Mobile](/sdk-reference/web-sdk-2-module-redirect-to-mobile/)

For niche fields not covered on a page, the TypeScript declarations shipped with each `@incodetech/core/<name>` subpath are authoritative — your editor's go-to-definition (or hover docs) takes you straight to them. If you need help, contact [support@incode.com](mailto:support@incode.com).

---

- Path: `sdk-reference/web-sdk-2-module-antifraud`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-antifraud/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-antifraud.md

# Antifraud Module

<Component slug="web-2-x-implementation-warning" />

The Antifraud module collects device, browser, and behavioral signals in the background and submits them to Incode's antifraud engine. Fire-and-forget — completes regardless of API outcome so the verification flow is never blocked.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules). See the patterns page for the shared lifecycle.

## Tag

`<incode-antifraud>` is a standard Web Component. Importing the UI subpath registers the custom element.

```ts
import '@incodetech/web/antifraud';
import '@incodetech/web/antifraud/styles.css';
```

The component is essentially invisible — it runs the check and emits `onFinish`. You can mount it during transitions while showing your own loading UI.

## Properties

| Property   | Type                      | Required | Description                                                           |
| ---------- | ------------------------- | -------- | --------------------------------------------------------------------- |
| `config`   | `AntifraudConfig`         | ❌       | No options — type is `Record<string, never>`                          |
| `onFinish` | `() => void`              | ❌       | Called when the check completes                                       |
| `onError`  | `(error: string) => void` | ❌       | Called on a fatal error (rare — module swallows API errors by design) |

## Configuration

The module takes no configuration:

```typescript
type AntifraudConfig = Record<string, never>;
```

## State machine

`AntifraudState` is minimal — a discriminated union over `status`:

| Status       | Description                                           |
| ------------ | ----------------------------------------------------- |
| `idle`       | Initial state.                                        |
| `processing` | Collecting signals and submitting to the backend.     |
| `finished`   | Terminal — check is done (success or silent failure). |

## See also

- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-authentication`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-authentication/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-authentication.md

# Authentication Module

<Component slug="web-2-x-implementation-warning" />

The Authentication module re-authenticates a returning user by capturing a fresh selfie and matching it against their previously stored biometric record. Used for re-entry into an existing identity (versus the first-time identity verification done by [Selfie](/sdk-reference/web-sdk-2-module-selfie-1/) + [Face Match](/sdk-reference/web-sdk-2-module-face-match/)).

This module follows the [camera-capture pattern](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules). The lifecycle and capture sub-states are identical to Selfie since both use the same underlying face-capture machinery (`BaseFaceCaptureConfig`).

## Availability

This module is headless-only — there is no public `<incode-authentication>` web component. Drive it with `createAuthenticationManager` from `@incodetech/core/authentication` and use the same UI patterns as Selfie.

## Configuration

`AuthenticationConfig` is the intersection of the dashboard-driven `FlowModuleConfig['AUTHENTICATION']` and the shared `BaseFaceCaptureConfig`:

```typescript
type AuthenticationConfig = FlowModuleConfig['AUTHENTICATION'] &
  BaseFaceCaptureConfig;
```

The dashboard fields are similar to Selfie's: `showTutorial`, `autoCaptureTimeout`, `numberOfAttempts`, `type` (always `'ONE_TO_ONE'` for re-auth), `deepsightLiveness`, plus the validate-\* booleans (`validateClosedEyes`, `validateFaceMask`, `validateHeadCover`, `validateLenses`).

**This page inherits the Selfie capture-config table.** `AuthenticationConfig` intersects `BaseFaceCaptureConfig`, the same type Selfie uses, so every shared capture field is valid here too — `showPreview`, `assistedOnboarding`, `enableFaceRecording`, `captureAttempts`, `validateBrightness`, `cameraResolution`, and `ageAssurance` among them. See [Module: Selfie → Configuration Options](/sdk-reference/web-sdk-2-module-selfie-1/#configuration-options) for their types and defaults rather than a second copy here.

The table below covers only the fields worth calling out for re-authentication; it is not the complete list.

| Option                                 | Type                                                                 | Required | Description                                                                                                                                                                                                                                                                                         |
| -------------------------------------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `onDeviceFaceResultsSubmissionEnabled` | `boolean`                                                            | ❌        | Opt-in. When `true`, face analysis runs entirely on-device and only the results are submitted to the server. Has E2EE and WASM-pipeline prerequisites — see [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/) for the full walkthrough. Leave off to keep the legacy server-side path. |
| `selfieConcealmentOption`              | `'OPTION_NONE' \| 'OPTION_SILHOUETTE' \| 'OPTION_2D' \| 'OPTION_3D'` | ❌        | Conceals the on-screen camera preview with a cosmetic avatar. Display-only — detection, quality, liveness, and upload run on the real frames. See [Module: Selfie → Face concealment](/sdk-reference/web-sdk-2-module-selfie-1/#face-concealment). Default `OPTION_NONE`.                                       |
| `avatarAssets`                         | `AvatarAssetsOverrides`                                              | ❌        | Where to load the avatar runtime from when `selfieConcealmentOption` selects an avatar. See [Module: Selfie → Self-hosting the avatar runtime](/sdk-reference/web-sdk-2-module-selfie-1/#self-hosting-the-avatar-runtime).                                                                                      |

## State machine

For read-only `onDeviceMode`, `obfuscateWithAvatar`, `avatarCanvas`, and `avatarVariant` presentation fields, plus the error-state `moduleErrorCode`, see [Selfie capture state properties](/sdk-reference/web-sdk-2-module-selfie-1/#capture-state-properties). Privacy Lens is the `OPTION_SILHOUETTE` concealment option.

`AuthenticationState` follows the same shape as `SelfieState` — see [Module: Selfie → States Reference](/sdk-reference/web-sdk-2-module-selfie-1/#states-reference) for the full list. The states are:

`idle`, `loading`, `tutorial`, `permissions`, `capture`, `processing`, `finished`, `closed`, `error`.

## API methods

Identical to the Selfie manager API: `load`, `nextStep`, `requestPermission`, `goToLearnMore`, `back`, `capture`, `retryCapture`, `close`, plus the universal lifecycle (`subscribe`, `getState`, `reset`, `stop`).

See [Module: Selfie → API Methods](/sdk-reference/web-sdk-2-module-selfie-1/#api-methods) for the full reference.

## WASM requirement

Authentication uses the same selfie ML pipeline as the Selfie module. Preload via `setup({ wasm: { pipelines: ['selfie'] } })`.

## See also

- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): first-time identity capture
- [Module: Face Match](/sdk-reference/web-sdk-2-module-face-match/): selfie ↔ ID comparison for first-time verification
- [Module: Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/): different flow for returning-user identification
- [Module Patterns → camera-capture](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules)
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/)

---

- Path: `sdk-reference/web-sdk-2-module-certificate-issuance`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-certificate-issuance/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-certificate-issuance.md

# Certificate Issuance Module

<Component slug="web-2-x-implementation-warning" />

The Certificate Issuance module issues a digital certificate at the end of a verification flow. The user sets a password that protects the certificate, the backend issues it, and the SDK offers the resulting file for download.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules) with a short form step for the password. See that page for the shared manager lifecycle; the rest of this page covers what's specific to certificate issuance.

## Tag

`<incode-certificate-issuance>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/certificate-issuance';
import '@incodetech/web/certificate-issuance/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                        | Required | Description                      |
| ---------- | --------------------------- | -------- | -------------------------------- |
| `config`   | `CertificateIssuanceConfig` | ✅        | Configuration options            |
| `onFinish` | `() => void`                | ❌        | Called when the module completes |
| `onError`  | `(error: string) => void`   | ❌        | Called when an error occurs      |

## Usage

### Vanilla HTML / TypeScript

```html
<incode-certificate-issuance></incode-certificate-issuance>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/certificate-issuance';
  import '@incodetech/web/certificate-issuance/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: 'your-session-token',
  });

  const el = document.querySelector('incode-certificate-issuance');
  el.config = {
    region: 'MX',
    type: 'LONG_TERM',
  };
  el.onFinish = () => console.log('Certificate issued!');
  el.onError = (err) => console.error('Certificate error:', err);
</script>
```

### React

> **React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it.

```typescript TSX
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { CertificateIssuanceConfig } from '@incodetech/core/certificate-issuance';
import '@incodetech/web/certificate-issuance';
import '@incodetech/web/certificate-issuance/styles.css';

type CertificateElement = HTMLElement & {
  config: CertificateIssuanceConfig;
  onFinish: () => void;
  onError: (error: string) => void;
};

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

export function CertificateIssuance() {
  const ref = useRef<CertificateElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = { region: 'MX', type: 'LONG_TERM' };
    el.onFinish = () => console.log('Certificate issued!');
    el.onError = (err) => console.error('Certificate error:', err);
  }, []);

  return <incode-certificate-issuance ref={ref} />;
}
```

For Angular (`CUSTOM_ELEMENTS_SCHEMA`) and Vue (`compilerOptions.isCustomElement`) setup, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

---

## Headless Mode

For complete UI control, use `createCertificateIssuanceManager` from `@incodetech/core/certificate-issuance`.

### Quick Start

```typescript TSX
import { setup } from '@incodetech/core';
import { createCertificateIssuanceManager } from '@incodetech/core/certificate-issuance';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

const manager = createCertificateIssuanceManager({
  config: { region: 'MX', type: 'LONG_TERM' },
});

manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'success') {
    // Offer state.blob for download, then report the outcome.
    triggerDownload(state.blob);
    manager.markDownloaded();
    manager.finish();
  }

  if (state.status === 'finished') {
    manager.stop();
  }
});

// Start the flow
manager.load();

// When state is 'password', collect input and submit once canSubmit is true.
manager.setPassword('Str0ngPass');
manager.submitPassword();
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| password
    password -->|submitPassword| processing
    processing -->|issued| success
    processing -->|failure| error
    success -->|markDownloaded| downloaded
    success -->|finish| finished
    success -.->|reportDownloadError| error
    downloaded -->|finish| finished
    error -.->|after 3s| finished
```

### States Reference

| Status       | Description                                                              | Key Properties                                 |
| ------------ | ------------------------------------------------------------------------ | ---------------------------------------------- |
| `idle`       | Initial state, waiting for `load()`                                      | –                                              |
| `password`   | Waiting for the user to set a valid certificate password                 | `password`, `passwordValidations`, `canSubmit` |
| `processing` | Issuing the certificate on the backend                                   | –                                              |
| `success`    | Certificate issued and ready to download                                 | `blob`                                         |
| `downloaded` | The certificate file has been downloaded                                 | –                                              |
| `error`      | Issuance or download failed; auto-advances to `finished` after 3 seconds | –                                              |
| `finished`   | Terminal state                                                           | –                                              |

### State Properties

**When `status === 'password'`:**

| Property              | Type                  | Description                                                                           |
| --------------------- | --------------------- | ------------------------------------------------------------------------------------- |
| `password`            | `string`              | The password entered so far (controlled-input value)                                  |
| `passwordValidations` | `PasswordValidations` | Per-requirement pass/fail flags (see [Password requirements](#password-requirements)) |
| `canSubmit`           | `boolean`             | `true` when every password requirement passes                                         |

**When `status === 'success'`:**

| Property | Type   | Description                                              |
| -------- | ------ | -------------------------------------------------------- |
| `blob`   | `Blob` | The issued certificate file, ready to offer for download |

### API Methods

| Method                  | Description                                            | When to Use                        |
| ----------------------- | ------------------------------------------------------ | ---------------------------------- |
| `load()`                | Starts the flow (moves `idle` → `password`)            | Always call first                  |
| `setPassword(password)` | Sets the password and recomputes `passwordValidations` | When `password` (controlled input) |
| `submitPassword()`      | Submits the password to issue the certificate          | When `canSubmit` is `true`         |
| `markDownloaded()`      | Reports that the certificate file was downloaded       | After downloading `blob`           |
| `reportDownloadError()` | Reports a failed download                              | When a download attempt fails      |
| `finish()`              | Completes the module                                   | From `success` or `downloaded`     |
| `getState()`            | Returns the current state synchronously                | Anytime                            |
| `subscribe(callback)`   | Subscribes to state changes                            | Returns an unsubscribe function    |
| `stop()`                | Releases resources                                     | When unmounting                    |

## Password requirements

The password the user sets must satisfy every requirement below. `passwordValidations` reports each one so you can render a live checklist, and `canSubmit` is `true` only when all pass.

| Requirement | Rule                          |
| ----------- | ----------------------------- |
| `length`    | At least 8 characters         |
| `uppercase` | At least one uppercase letter |
| `lowercase` | At least one lowercase letter |
| `number`    | At least one digit            |

## Configuration Options

`CertificateIssuanceConfig` shape:

| Option   | Type                                        | Required | Description                                                    |
| -------- | ------------------------------------------- | -------- | -------------------------------------------------------------- |
| `region` | `string`                                    | ✅        | Issuance region, supplied by the dashboard flow configuration. |
| `type`   | `'ONE_TIME' \| 'SHORT_TERM' \| 'LONG_TERM'` | ✅        | Certificate validity period.                                   |

Both values come from the dashboard flow configuration. When the module runs inside `<incode-flow>` or `createOrchestratedFlowManager`, the orchestrator passes them automatically.

---

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Headless API patterns
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Overview of all modules
- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)

---

- Path: `sdk-reference/web-sdk-2-module-consent`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-consent/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-consent.md

# Consent Module

<Component slug="web-2-x-implementation-warning" />

The Consent module renders a consent form (terms text plus configurable checkboxes) and submits the user's selections. Used to capture optional or required user consents before downstream modules run.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules), with an additional `display` state for showing the consent text and checkboxes.

## Tag

`<incode-consent>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/consent';
import '@incodetech/web/consent/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                      |
| ---------- | ------------------------- | -------- | -------------------------------- |
| `config`   | `ConsentConfig`           | ❌       | Configuration options            |
| `onFinish` | `() => void`              | ❌       | Called when consent is submitted |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs      |

## Configuration

```typescript
type ConsentConfig = {
  combinedConsents?: string;
  consentId?: string;
  language?: string;
};
```

| Option             | Type     | Required | Description                                                                           |
| ------------------ | -------- | -------- | ------------------------------------------------------------------------------------- |
| `combinedConsents` | `string` | ❌       | Identifier for a combined consents bundle from the dashboard. Backend-driven content. |
| `consentId`        | `string` | ❌       | Specific consent ID to load.                                                          |
| `language`         | `string` | ❌       | Language to fetch the consent text in. Defaults to the active SDK language from `setup({ i18n })`. Set it only to request consent copy in a different language than the rest of the flow. |

The actual consent text and checkbox definitions come from the backend (`fetchCombinedConsent`); the config just identifies which bundle to load.

## State machine

`ConsentState` is a discriminated union over `status`:

| Status       | Description                                                    |
| ------------ | -------------------------------------------------------------- |
| `idle`       | Initial state.                                                 |
| `loading`    | Fetching consent text + checkbox definitions from the backend. |
| `display`    | Rendering consents; user can toggle checkboxes.                |
| `submitting` | Sending the user's selections to the backend.                  |
| `finished`   | Terminal.                                                      |
| `error`      | Fatal error.                                                   |

### State properties

| Property | Type | Available in | Description |
| --- | --- | --- | --- |
| `title`, `richText` | `string` | `display`, `submitting` | Consent heading and formatted terms. |
| `checkboxes` | `ConsentCheckbox[]` | `display`, `submitting` | Each checkbox has `id`, `label`, `required`, and `checked`. |
| `canSubmit` | `boolean` | `display`, `submitting` | Whether submission is available; always `false` during submission. |
| `error` | `string?` | `display` | Inline submission feedback, when present. |

Import `ConsentState` and `ConsentCheckbox` from `@incodetech/core/consent`. Render the supplied consent and required selections before enabling submission.

## API methods

This module takes input through `toggleCheckbox`, not the `setField` shape the schema-driven form modules use.

| Method                       | Purpose                                                                      | Callable when       |
| ---------------------------- | ---------------------------------------------------------------------------- | ------------------- |
| `load()`                     | Fetch the consent text and checkbox definitions.                             | `idle`              |
| `toggleCheckbox(checkboxId)` | Flip one checkbox. Pass the `id` from the checkbox definitions on the state. | `display`           |
| `submit()`                   | Send the user's selections.                                                  | `display`           |
| `retry()`                    | Retry after a failed load or submit.                                         | `error`             |
| `reset()`                    | Return to `idle` after an error.                                      | `error` |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## See also

- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-cross-doc-match`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-cross-doc-match/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-cross-doc-match.md

# Cross-Document Data Match Module

<Component slug="web-2-x-implementation-warning" />

The Cross-Document Data Match module runs a backend comparison of OCR data across multiple captured documents (e.g., ID + proof-of-address) and flags inconsistencies. Fire-and-forget — completes after a minimum display duration so the user sees a confirmation spinner.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules). See the patterns page for the shared lifecycle.

## Tag

`<incode-cross-document-data-match>` is a standard Web Component. Importing the UI subpath registers the custom element; the module is bundled with `@incodetech/web/flow` (no separate UI subpath import).

```ts
import '@incodetech/web/cross-document-data-match';
```

## Properties

| Property   | Type                           | Required | Description                      |
| ---------- | ------------------------------ | -------- | -------------------------------- |
| `config`   | `CrossDocumentDataMatchConfig` | ❌       | No options                       |
| `onFinish` | `() => void`                   | ❌       | Called when comparison completes |
| `onError`  | `(error: string) => void`      | ❌       | Called when an error occurs      |

## Configuration

The module takes no configuration:

```typescript
type CrossDocumentDataMatchConfig = Record<string, never>;
```

Comparison rules and inconsistency thresholds are configured server-side per tenant.

## State machine

`CrossDocumentDataMatchState` is a discriminated union over `status`:

| Status       | Description                      |
| ------------ | -------------------------------- |
| `idle`       | Initial state.                   |
| `processing` | Backend comparison in progress.  |
| `finished`   | Terminal — comparison completed. |

The module deliberately holds the `processing` state for a minimum display duration so users see a confirmation spinner regardless of how fast the backend responds.

## See also

- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Module: ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/): provides one of the input data sets
- [Module: Document Capture](/sdk-reference/web-sdk-2-module-document-capture/): provides POA data
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-curp-validation`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-curp-validation/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-curp-validation.md

# CURP Validation Module

<Component slug="web-2-x-implementation-warning" />

The CURP Validation module verifies a Mexican CURP (Clave Única de Registro de Población) — either by accepting the user's CURP and validating it server-side, or by generating one from the user's identity data when missing.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) with three input variants (enter, confirm, generate).

## Tag

`<incode-curp-validation>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/curp-validation';
import '@incodetech/web/curp-validation/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                      |
| ---------- | ------------------------- | -------- | -------------------------------- |
| `config`   | `CurpValidationConfig`    | ❌       | Configuration options            |
| `onFinish` | `() => void`              | ❌       | Called when validation completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs      |

## Configuration

`CurpValidationConfig` extends `FlowModuleConfig['CURP_VALIDATION']` with two manager-level options:

```typescript
type CurpValidationConfig = FlowModuleConfig['CURP_VALIDATION'] & {
  maxRetries?: number; // Maximum validation retries before auto-advancing (default: 1)
  prefillFromOcr?: boolean; // Attempt OCR pre-fill on load (default: true)
};
```

| Option           | Type      | Required | Description                                                                    |
| ---------------- | --------- | -------- | ------------------------------------------------------------------------------ |
| `maxRetries`     | `number`  | ❌       | Auto-advance after this many failed validation attempts. Default `1`.          |
| `prefillFromOcr` | `boolean` | ❌       | Pre-fill the CURP field from prior ID OCR data when available. Default `true`. |

`FlowModuleConfig['CURP_VALIDATION']` contributes two more. Both are set on the module's dashboard configuration and arrive through the orchestrator, so consumer code passes them through rather than setting them:

| Option                       | Type      | Description                                                                                     |
| ---------------------------- | --------- | ----------------------------------------------------------------------------------------------- |
| `curpDataMatch`              | `boolean` | Check the CURP against the personal data already collected in the session, not just its format. |
| `deceasedStatusVerification` | `boolean` | Include the registry deceased-status check in validation. The server result determines how the module proceeds. |

## State machine

`CurpValidationState` is a discriminated union over `status`:

| Status          | Description                                                                       |
| --------------- | --------------------------------------------------------------------------------- |
| `idle`          | Initial state.                                                                    |
| `loading`       | Loading prior OCR data (when `prefillFromOcr` is `true`).                         |
| `enterCurp`     | User enters their CURP.                                                           |
| `verifying`     | Backend verifying the entered CURP.                                               |
| `confirmCurp` | User confirms a successfully generated CURP before verification. |
| `generateCurp`  | No CURP available; user fills the generate form (name, DOB, gender, birth state). |
| `generating`    | Backend generating a CURP from the form.                                          |
| `generateError` | Generate failed; user can retry.                                                  |
| `success` | CURP validated; automatically proceeds to `finished` after 3 seconds. |
| `failure`       | Validation failed (deceased status, mismatch, etc.).                              |
| `finished`      | Terminal.                                                                         |
| `closed`        | User dismissed.                                                                   |

### State properties

| Status | Properties | Meaning |
| --- | --- | --- |
| `enterCurp` | `curp: string`, `isValid: boolean`, `validationErrors?: CurpValidationErrors` | Current input and displayed validation errors. |
| `generateCurp` | `form: GenerateCurpForm`, `isValid: boolean`, `validationErrors?: CurpValidationErrors` | Current generation form and displayed validation errors. |
| `confirmCurp` | `curp: string` | Generated CURP to confirm. |
| `failure` | `retriesLeft: number`, `fromAutoVerify: boolean` | Remaining retries and whether the failed verification began automatically from OCR. |
| `generateError` | `retriesLeft: number` | Remaining generation retries. |

`GenerateCurpForm` has string fields `name`, `firstLastName`, `secondLastName`, `birthDate` (`YYYY-MM-DD`), and `birthState` (two-letter code), plus `gender: 'H' | 'M' | 'X' | ''`. `CurpValidationErrors` maps field names to translation-key strings. `isValid` is optimistic: it means no errors are currently displayed, not that a full validation has passed. Validate on blur with `validateField()`; submission validates the full form.

When OCR provides a CURP, loading proceeds directly to `verifying`; it does not enter `confirmCurp`. Without a usable OCR value, the user enters a CURP. Exhausted `failure` and `generateError` states automatically proceed to `finished` after 3 seconds; completion does not imply successful validation.

## API methods

The module has two input paths — verify an existing CURP, or generate one — and a separate setter for each.

| Method                  | Purpose                                                                        | Callable when                   |
| ----------------------- | ------------------------------------------------------------------------------ | ------------------------------- |
| `load()`                | Start the flow, pulling prior OCR data when `prefillFromOcr` is enabled.       | `idle`                          |
| `setCurp(curp)` | Set the CURP the user is typing. | `enterCurp` |
| `validateField(field)`  | Validate one field on blur. Takes `'curp'` or a key of the generate form.      | `enterCurp`, `generateCurp`     |
| `verify()` | Validate and submit the entered CURP. | `enterCurp` |
| `switchToGenerate()`    | Move to the generate path when the user has no CURP to enter.                  | `enterCurp`                     |
| `setGenerateForm(form)` | Update the generate form. Takes a partial, so you can set one field at a time. | `generateCurp`                  |
| `generate()`            | Submit the generate form.                                                      | `generateCurp`                  |
| `confirmGenerated()` | Submit the generated CURP for verification. | `confirmCurp` |
| `retry()` | Return to the relevant input form. | `failure` or `generateError`, with `retriesLeft > 0` |
| `close()`               | Dismiss the module.                                                            | any non-terminal state          |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## See also

- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Module: ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/): provides the OCR data this module pre-fills from
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-custom-fields`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-custom-fields/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-custom-fields.md

# Custom Fields Module

<Component slug="web-2-x-implementation-warning" />

The Custom Fields module renders a form generated from a dashboard-defined schema (text, number, boolean, date, double fields) and submits the user's responses. Useful for collecting tenant-specific data that doesn't fit the standard verification primitives.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules).

## Availability

This module is headless-only — there is no public `<incode-custom-fields>` web component. Drive it with `createCustomFieldsManager` from `@incodetech/core/custom-fields` and render your own form.

## Configuration

```typescript
type CustomField = {
  name: string; // Internal field name
  alias: string; // User-facing label
  type: 'INTEGER' | 'DOUBLE' | 'BOOLEAN' | 'STRING' | 'DATE';
};

type CustomFieldsConfig = {
  title: string;
  customFields: CustomField[];
};
```

| Option         | Type            | Required | Description                                                                                        |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| `title`        | `string`        | ✅       | Form title shown above the fields.                                                                 |
| `customFields` | `CustomField[]` | ✅       | Field schema. Each entry's `name` is the data key, `alias` is the label, `type` drives input type. |

The schema is defined in the Incode Dashboard and surfaced through the module's config.

## State machine

`CustomFieldsState` is a discriminated union over `status`:

| Status       | Description                          |
| ------------ | ------------------------------------ |
| `idle`       | Initial state.                       |
| `inputting`  | Form rendered; user fills fields.    |
| `submitting` | Sending field values to the backend. |
| `success`    | Submission accepted.                 |
| `finished`   | Terminal.                            |

### Validation state

In `inputting`, the manager exposes `title: string`, `customFields: MappedCustomField[]`, `validationErrors?: Record<string, string>`, and `canSubmit: boolean`.

`canSubmit` is optimistic: Continue starts enabled. Required-field errors appear after a failed submit and are keyed by field name. Render those translation keys beside the affected controls and use `setField()` to update values. `canSubmit` does not prove that the form is complete. In `submitting`, only `title` remains available.

## API methods

Fields come from your dashboard schema, so this module uses one keyed setter rather than a setter per field.

| Method                  | Purpose                                                                                                                         | Callable when |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `load()`                | Fetch the field schema.                                                                                                         | `idle`        |
| `setField(name, value)` | Set one field. `name` is the field's `name` from the schema; `value` is a `string`, `number`, or `boolean` matching its `type`. | `inputting`   |
| `submit()`              | Send the collected values.                                                                                                      | `inputting`   |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## See also

- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-custom-watchlist`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-custom-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-custom-watchlist.md

# Custom Watchlist Module

<Component slug="web-2-x-implementation-warning" />

<br />

The Custom Watchlist module screens the user's face against a customer-provided blocklist. Fire-and-forget — runs server-side using images already in the session.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules). See the patterns page for the shared lifecycle.

## Availability

This module is headless-only — there is no public `<incode-custom-watchlist>` web component. Drive it with `createCustomWatchlistManager` from `@incodetech/core/custom-watchlist`. Typically invoked from an orchestrated flow.

## Configuration

```typescript
type CustomWatchlistConfig = {
  failIfFaceOnBlocklist: boolean;
  addSuspectedFraudAutomatically: boolean;
  autoExecution: boolean;
};
```

| Option                           | Type      | Required | Description                                                                                  |
| -------------------------------- | --------- | -------- | -------------------------------------------------------------------------------------------- |
| `failIfFaceOnBlocklist`          | `boolean` | ✅       | Server-side behavior: mark the verification as failed if the face matches a blocklist entry. |
| `addSuspectedFraudAutomatically` | `boolean` | ✅       | Add the user to a suspected-fraud list automatically on a match.                             |
| `autoExecution`                  | `boolean` | ✅       | Auto-execute the check (vs. requiring an explicit trigger).                                  |

These fields are supplied by the backend flow configuration and shape backend behavior. The module itself is fire-and-forget from the client's perspective — the client doesn't need to read these values to drive its own UI.

## State machine

`CustomWatchlistState` is a discriminated union over `status`:

| Status       | Description                    |
| ------------ | ------------------------------ |
| `idle`       | Initial state.                 |
| `processing` | Backend screening in progress. |
| `success`    | Screening completed.           |
| `finished`   | Terminal.                      |

## See also

- [Module: Watchlist](/sdk-reference/web-sdk-2-module-watchlist/) — global sanctions / PEP screening
- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-document-capture`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-document-capture/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-document-capture.md

# Document Capture Module

<Component slug="web-2-x-implementation-warning" />

The Document Capture module captures generic documents (utility bills, lease agreements, tax documents, address proofs, vehicle logbooks, etc.) — anything that isn't an identity document but needs to be uploaded as part of verification. Supports both camera-based capture and file-picker upload, with optional multi-page support.

This module follows the [camera-capture pattern](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules), but extends it with file-upload alternatives and multi-page state.

## Tag

`<incode-document-capture>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/document-capture';
import '@incodetech/web/document-capture/styles.css';
```

## Properties

| Property   | Type                                   | Required | Description                   |
| ---------- | -------------------------------------- | -------- | ----------------------------- |
| `config`   | `DocumentCaptureConfig`                | ❌       | Configuration options         |
| `onFinish` | `() => void`                           | ❌       | Called when capture completes |
| `onError`  | `(error: string \| undefined) => void` | ❌       | Called when an error occurs   |

## Configuration

```typescript
type DocumentCaptureConfig = {
  processingType?: DocumentType; // Backend routing key (default 'addressStatement')
  captureMode?: 'file' | 'camera'; // 'camera' = capture only (hides upload); 'file' = upload only (hides camera); absent = capture + upload
  allowSkipDocumentCapture?: boolean; // Default false
  disableSkipPoa?: boolean; // Backend ADDRESS field; inverse of allowSkipDocumentCapture
  title?: string; // Tutorial screen title override
  text?: string; // Tutorial screen text override
  step2Title?: string; // Multi-page tutorial second-page title
  step2Text?: string; // Multi-page tutorial second-page text
  captureAttempts?: number; // Default 3
  sendBase64?: boolean; // Default false; OCR processing, v3 and CFDI endpoints always require base64 JSON
  maxFileSize?: number; // Default 10 MB
  onlyPdf?: boolean; // Default false. Restrict uploads to PDF; camera capture unaffected
};
```

`processingType` accepts: `addressStatement`, `otherDocument1`, `otherDocument2`, `otherDocument3`, `v5cMultiPageLogbook`, `circulationCard`, `financeSettlement`, `carInvoice`, `w8Ben`, `w8BenE`, plus `process*` variants for OCR-driven processing — including `processW8BenOcr` and `processW8BenEOcr` for the IRS W-8 tax forms. The multi-page types (`v5cMultiPageLogbook`, `circulationCard`, `financeSettlement`, `w8BenE`) trigger the `nextPage` flow described below. W-8BEN is single-page; W-8BEN-E is multi-page.

For address statements (`addressStatement` or `capture`) and generic documents (`otherDocument1`, `otherDocument2`, `otherDocument3`), `sendBase64: false` (the default) uploads raw file bytes to `/omni/add/document` with the file's MIME type as `Content-Type`. Setting `sendBase64: true` sends base64 JSON to their respective v2 endpoints.

OCR processing options `processPoaOcr`, `processLoaOcr`, `processAsylumSeekerVisaZaf`, `processBankStatementOCR`, `processBankCheck`, `processIneMex`, and `processColombiaRutForm` always use `/omni/add/address-statement/v2` with the selected processing option as the `type` query parameter and a base64 JSON payload, regardless of `sendBase64`.

Types that use `/omni/add/document/v3` or `/omni/process/cfdi` always send base64 JSON because those endpoints require it, regardless of `sendBase64`. These rules apply to camera captures, selected images, and PDFs.

Set `onlyPdf: true` when the document only makes sense as a PDF, such as a tax form the user downloads and re-uploads. It narrows the file picker and rejects non-PDF selections; it does not disable camera capture, so pair it with `captureMode: 'file'` for a PDF-only step.

## State machine

`DocumentCaptureState` is a discriminated union over `status`. The states extend the camera-capture pattern with file-upload and multi-page handling:

| Status               | Description                                                                          |
| -------------------- | ------------------------------------------------------------------------------------ |
| `tutorial`           | Initial guidance screen.                                                             |
| `permissions` | Camera permission check, prompt, or help. |
| `initializingCamera` | Camera starting up (when camera capture is offered and the user picks camera). |
| `capturing` | Camera preview or file selection, depending on `captureMethod`. |
| `preview`            | After capture or file pick, user reviews the image before accept/retake.             |
| `uploading`          | Uploading the (accepted) image to the backend.                                       |
| `success` | Upload accepted; call `continue()` to advance. |
| `nextPage` | Choose how to capture another page; offer completion only when the next page is optional. |
| `finalizing`         | Server-side finalization after all pages uploaded.                                   |
| `failure` | Upload or finalization failed; retry when attempts remain, otherwise continue. |
| `finished`           | Terminal — module complete.                                                          |
| `closed`             | User dismissed.                                                                      |

### State properties

| Property | Type | Available in | Description |
| --- | --- | --- | --- |
| `pageNumber` | `number` | `tutorial`, `capturing`, `nextPage` | Current document page. |
| `imageBase64` | `string` | `preview`, `uploading`, `success`, `nextPage` | Image for the current preview; keep it out of logs. |
| `fileType`, `fileName` | `string` | `preview`, `uploading`, `success`, `nextPage` | MIME type and display filename. |
| `progress` | `number` | `uploading` | Upload progress. |
| `nextPageType` | `'none' \| 'required' \| 'optional'` | `success` | Whether another page is expected. |
| `nextPageType` | `'required' \| 'optional'` | `nextPage` | Whether the next page is mandatory. |
| `permissionStatus` | See below | `permissions` | Permission presentation state. |

Additional properties for custom capture controls:

| Property | Type | Available in | Description |
| --- | --- | --- | --- |
| `stream` | `MediaStream \| undefined` | `capturing` | Live camera stream when available. |
| `captureMethod` | `'camera' \| 'file' \| 'gallery' \| undefined` | `capturing` | Current capture method. |
| `onlyCapture`, `onlyUpload`, `onlyPdf` | `boolean` | `tutorial`, `capturing`, `nextPage` | Resolved camera/upload restrictions. |
| `allowSkipDocumentCapture` | `boolean` | `tutorial` | Whether the first-page skip action is available. |
| `error` | `DocumentCaptureErrorCode \| undefined` | `tutorial`, `capturing` | Current file-selection feedback. |
| `error` | `DocumentCaptureErrorCode` | `failure` | Failure code. |
| `attemptsRemaining` | `number` | `failure` | Determines whether to offer retry or continuation. |

In a headless camera UI, attach `stream` to your video element, capture a frame in your host, then pass its `File` and preview data URL to `setFile()`. In `nextPage`, choose a capture method before submitting another file. `capture()` does not pull a frame from `capturing`.

The shared `permissionStatus` type includes `checking`, `idle`, `motionOnly`, `requesting`, `denied`, and `learnMore`. Document Capture currently emits `checking`, `idle`, `requesting`, `denied`, and `learnMore`. Show no prompt while `checking`; show the request action in `idle`, a busy state in `requesting`, and permission instructions after denial.

## API methods

| Method | Purpose | Callable when |
| --- | --- | --- |
| `requestPermission()` | Request camera access. | `permissions` with `idle`, `checking`, or `learnMore` |
| `goToLearnMore()` | Show permission help. | `permissions` with `idle` or `checking` |
| `back()` | Return to the permission check. | `permissions` with `learnMore` |
| `capture()` | Start camera permission/setup when camera capture is allowed. | `tutorial` |
| `setFile(file, imageBase64)` | Submit a selected file or a camera frame as a `File` with its preview data URL; accepted files move to `preview`. | `tutorial`, `capturing` |
| `accept()` | Accept the preview and upload it. | `preview` |
| `retake()` | Return to `tutorial` for file upload, or `capturing` for camera/gallery selection. | `preview` |
| `retry()` | Return to the tutorial and restart from the first page. | `failure` with `attemptsRemaining > 0` |
| `continue()` | Advance to `nextPage` or `finished` after success; finish after attempts are exhausted. | `success`, or `failure` with `attemptsRemaining <= 0` |
| `skip()` | Skip the document step. | First-page `tutorial` with resolved `allowSkipDocumentCapture: true` |
| `close()` | Dismiss the module. | `tutorial`, `permissions`, `initializingCamera`, `capturing`, `preview`, `success`, `nextPage`, `failure` |
| `captureNextPageFromCamera()` | Select camera for the next page and enter permissions. | `nextPage` |
| `captureNextPageFromFile()` | Select gallery/file capture for the next page and enter `capturing`; your host opens the picker. | `nextPage` |
| `finishPageCapture()` | Finish page collection. Supported multi-page document types enter `finalizing` when the next page is optional; otherwise the manager enters `finished` directly. Offer this action only for an optional next page. | `nextPage` |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

### Capture-method selection and help

When the step offers both camera and upload, the `tutorial` state lets the user choose between them, and the `capturing` state can show a "common issues" help overlay. Both are overlays over an existing state rather than states of their own, so each is driven by a boolean on the state you are already in:

| Method                   | Purpose                                                                  | Callable when             |
| ------------------------ | ------------------------------------------------------------------------ | ------------------------- |
| `openMethodSelection()`  | Open the camera-or-upload chooser. Sets `methodSelectionOpen` to `true`. | `tutorial`                |
| `closeMethodSelection()` | Dismiss the chooser without picking.                                     | `tutorial`, chooser open  |
| `selectUploadMethod()`   | Pick upload, which switches the chooser to its upload variant.           | `tutorial`, chooser open  |
| `deselectUploadMethod()` | Return to the camera-or-upload choice after picking upload.              | `tutorial`, upload picked |
| `openHelp()`             | Open the "common issues" overlay over the camera view. Sets `helpOpen`.  | `capturing`               |
| `closeHelp()`            | Dismiss the help overlay.                                                | `capturing`, help open    |

Read `methodSelectionOpen` from the `tutorial` state and `helpOpen` from the `capturing` state to decide what to render. Both default to `false`, so an integration that ignores them keeps the previous behavior.

## Camera and upload requirements

Camera capture requires a secure browser context (HTTPS in production) and camera permission. Users review the captured image or selected file before upload. Document Capture does not require warming up the ID Capture WASM pipeline. If your integration enables [end-to-end encryption](/sdk-reference/web-sdk-2-e2ee/), follow that feature's setup requirements separately.

## See also

- [Module Patterns → camera-capture](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules)
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-dynamic-forms`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-dynamic-forms/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-dynamic-forms.md

# Dynamic Forms Module

<Component slug="web-2-x-implementation-warning" />

The Dynamic Forms module steps the user through a multi-screen questionnaire whose screens, questions, and input types come from the backend per session. Use it for jurisdiction-specific questions that change without an SDK release.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) across multiple screens.

## Tag

`<incode-dynamic-forms>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/dynamic-forms';
import type { DynamicForms } from '@incodetech/web/dynamic-forms';
import type { ComponentProps } from 'preact';
import '@incodetech/web/dynamic-forms/styles.css';
```

This is the Web SDK 2.0 equivalent of Web SDK 1.x `renderForms`. SDK 2.0 uses the same Web Component integration pattern as the other standalone modules instead of an imperative render helper.

## Properties

| Property   | Type                                                | Required | Description                                                                                                                                                       |
| ---------- | --------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `config`   | `DynamicFormsConfig`                                | ❌        | Form configuration. If omitted, the component resolves the `DYNAMIC_FORMS` configuration from the active Dashboard Flow.                                         |
| `manager`  | `DynamicFormsManager`                               | ❌        | Advanced: a pre-built headless manager. Providing one bypasses standalone configuration resolution.                                                               |
| `onFinish` | `() => void`                                        | ❌        | Called when the module finishes.                                                                                                                                   |
| `onError`  | `(error?: string, errorCode?: number) => void`      | ❌        | Called when standalone Dashboard configuration cannot be resolved.                                                                                                 |

## Standalone example

This example mirrors the SDK 1.x `renderForms(container, options)` use case with a locally supplied screen definition:

```ts
import { setup } from '@incodetech/web';
import '@incodetech/web/base.css';
import '@incodetech/web/themes/light.css';
import '@incodetech/web/dynamic-forms';
import type { DynamicForms } from '@incodetech/web/dynamic-forms';
import type { ComponentProps } from 'preact';
import '@incodetech/web/dynamic-forms/styles.css';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: sessionToken,
  flow: false,
  theme: false,
});

const forms = document.createElement('incode-dynamic-forms') as HTMLElement & ComponentProps<typeof DynamicForms>;
forms.config = { screens };
forms.onFinish = () => showNextStep();
forms.onError = (error) => console.error(error);

document.querySelector('#forms-container')?.replaceChildren(forms);
```

| SDK 1.x `renderForms` input | SDK 2.0 equivalent                                                     |
| --------------------------- | ---------------------------------------------------------------------- |
| `element`                   | Mount or append `<incode-dynamic-forms>` in that container             |
| `token`                     | `setup({ token })`                                                      |
| `interviewId`               | No separate property; the session token identifies the onboarding     |
| `flowId`, `screens`         | `forms.config = { flowId, screens }`                                   |
| `onSuccess`                 | `forms.onFinish`                                                       |
| `onError`                   | `forms.onError`                                                        |

Recoverable submission failures stay inside the component and show a retry screen. They do not call `onError`.

To use the Dashboard-configured module instead, omit `forms.config`. The standard standalone bootstrap loads the `DYNAMIC_FORMS` configuration for the active session. Inside `<incode-flow>`, the orchestrator continues to mount and configure the same component automatically.

## Configuration

```typescript
type DynamicFormsConfig = {
  flowId?: string;
  screens?: Screen[];
  prefillValue?: string;
};
```

| Option         | Type       | Required | Description                                                                                                                                                                                                                                                                                          |
| -------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `flowId`       | `string`   | ❌        | Fetches the screen configuration from the backend. The orchestrator sets this.                                                                                                                                                                                                                       |
| `screens`      | `Screen[]` | ❌        | Pre-loaded screens. Providing them skips the fetch.                                                                                                                                                                                                                                                  |
| `prefillValue` | `string`   | ❌        | Prefills the answer on a single-question first screen — a login hint your page read from its own URL, for example. Applies only when the form is exactly one screen with one question, and is ignored otherwise. The field stays editable. Your code reads the value; the SDK never touches the URL. |

When bypassing Dashboard Flow resolution, supply `flowId` or `screens`. If neither value is available after configuration resolution, the module enters `misconfigured` rather than failing at runtime.

### Screens and questions

```typescript
type Screen = {
  title?: string;
  hideTitle?: boolean;
  questions: Question[];
};

type Question = {
  questionId: string;
  question: string;
  inputType?: InputType;
  overrides?: InputType;
  isPredefined?: boolean;
  isOptional?: boolean;
  options?: string[];
  prefillSource?: string | null;
  editable?: boolean;
};
```

| Property       | Type         | Description                                                                                |
| -------------- | ------------ | ------------------------------------------------------------------------------------------ |
| `questionId`   | `string`     | Stable identifier. Use it as the key for every answer and validation call.                 |
| `question`     | `string`     | The label to display.                                                                      |
| `inputType`    | `InputType?` | Which control to render. Absent values fall back to `overrides`, then to `TEXT`.           |
| `overrides`    | `InputType?` | Fallback type used when `inputType` is absent.                                             |
| `isPredefined` | `boolean?`   | Whether the question comes from Incode's predefined set rather than a tenant-authored one. |
| `isOptional`   | `boolean?`   | Whether the user can leave the answer empty.                                               |
| `prefillSource` | `string \| null` (optional) | Dashboard-selected source for a captured-ID value. |
| `editable` | `boolean?` | Whether a successfully prefilled value can be edited. Default `true`; meaningful with `prefillSource`. |
| `options`      | `string[]?`  | Choices for `SELECT` and `MULTISELECT`.                                                    |

`InputType` is `'TEXT'`, `'DATE'`, `'COUNTRY'`, `'NATIONALITY'`, `'NUMBER'`, `'EMAIL'`, `'PHONE'`, `'CPF'`, `'NAME'`, `'YESNO'`, `'SELECT'`, or `'MULTISELECT'`. Treat the union as open — an unrecognized value renders as text rather than breaking the screen.

### Prefill from captured ID

Questions with `prefillSource` can receive values from the customer's captured ID. `PHONE` and `MULTISELECT` inputs are excluded. If a source does not resolve, the question stays blank and editable.

In `inputting` and `submitting`, `prefilledQuestionIds: string[]` identifies populated questions and `nonEditableQuestionIds: string[]` identifies read-only ones. Render the latter read-only with a “from ID” marker. Their values still submit; do not remove them from the payload. Resolve display text with your translations.

## State machine

`DynamicFormsState` is a discriminated union over `status`:

| Status              | Description                                                                                                                                                                    |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `idle`              | Initial state, waiting for `load()`.                                                                                                                                           |
| `loadingScreens`    | Fetching the screen configuration from the backend.                                                                                                                            |
| `inputting`         | Current screen rendered; the user answers questions.                                                                                                                           |
| `submitting`        | Sending the current screen's answers. The screen stays available so you can show a spinner.                                                                                    |
| `submitFailed`      | An answer did not reach the backend because the server failed. Show an error screen with a Try again button that calls `retry()`.                                              |
| `success`           | All screens submitted. Shows briefly before `finished`.                                                                                                                        |
| `finished`          | Terminal. Carries `result`.                                                                                                                                                    |
| `misconfigured`     | Neither `screens` nor `flowId` was supplied. A configuration problem, not a runtime error.                                                                                     |
| `attemptsExhausted` | Terminal. The backend rejected the login hint too many times and locked the user out. Show the title and subtitle with no retry — the user has to contact their administrator. |
| `closed`            | The user dismissed the module.                                                                                                                                                 |

`attemptsExhausted` stays inside this module rather than routing through the orchestrator's terminal error screen, because that screen's retry would reload the flow and fail against a single-use token. An invalid hint that still has attempts left keeps the user on the screen with an inline field error instead.

When `status === 'inputting'`:

| Property           | Type                            | Description                                                                                         |
| ------------------ | ------------------------------- | --------------------------------------------------------------------------------------------------- |
| `currentScreen`    | `Screen`                        | The screen to render.                                                                               |
| `screenIndex`      | `number`                        | Zero-based index of the current screen.                                                             |
| `totalScreens`     | `number`                        | How many screens the form has. Use both to show progress.                                           |
| `prefilledQuestionIds` | `string[]` | Questions populated from captured ID. |
| `nonEditableQuestionIds` | `string[]` | Successfully prefilled questions that must render read-only. |
| `answers`          | `Record<string, string>`        | Current values, keyed by `questionId`.                                                              |
| `answerValidity`   | `Record<string, boolean>`       | Format validity you reported through `setAnswerValidity`.                                           |
| `validationErrors` | `DynamicFormsValidationErrors?` | Errors currently shown to the user, keyed by `questionId`. Each value is an i18n key; translate it for display. |
| `canSubmit`        | `boolean`                       | `true` when no validation error is displayed. See the note below.                                   |

`submitting` carries the same screen, answers, and validity, frozen at submission time.

`finished` carries `result`: `'completed'` when every screen was submitted, or `'skipped'` when the screen configuration could not be loaded. Loading failures skip the module rather than blocking the flow.

The module treats the two kinds of submission failure differently. If the server fails (HTTP 5xx) or the request does not complete, the module enters `submitFailed`. Call `retry()` to send the answers again. If the backend refuses the content of one answer (HTTP 4xx), the module drops that answer, submits the remaining ones and continues to the next screen, because the same request would fail again. Blank optional answers are not sent at all.

> `canSubmit`** is optimistic.** It starts `true` on an empty screen and only turns `false` after a submit attempt populates `validationErrors`. Binding a Continue button to `canSubmit` matches the SDK's own behavior; it does not mean every required answer is present.

## API methods

| Method                                   | Purpose                                                                                       |
| ---------------------------------------- | --------------------------------------------------------------------------------------------- |
| `load()`                                 | Starts the module. Call this before anything else.                                            |
| `setAnswer(questionId, value)`           | Record the raw user input for one question.                                                   |
| `setAnswerValidity(questionId, isValid)` | Report whether a format-constrained value is valid. Use for `PHONE`, `EMAIL`, and `CPF`.      |
| `validateField(questionId)`              | Validate one question, typically on blur. Sets or clears its `validationErrors` entry.        |
| `submit()`                               | Submit the current screen, then advance to the next screen or finish.                         |
| `retry()`                                | Send the current screen again after `submitFailed`. Skips answers the backend already took.  |
| `close()`                                | Dismiss the module from `misconfigured`. Fix the configuration rather than calling `reset()`. |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## Headless example

```typescript
import { setup } from '@incodetech/core';
import { createDynamicFormsManager } from '@incodetech/core/dynamic-forms';

const manager = createDynamicFormsManager({ config: { flowId } });

manager.subscribe((state) => {
  if (state.status === 'inputting') {
    renderScreen({
      screen: state.currentScreen,
      progress: `${state.screenIndex + 1} of ${state.totalScreens}`,
      answers: state.answers,
      // validationErrors values are i18n keys — resolve them for display.
      errors: state.validationErrors,
      canSubmit: state.canSubmit,
    });
  }

  if (state.status === 'misconfigured') {
    console.error('Dynamic Forms needs either screens or a flowId');
  }

  if (state.status === 'finished') {
    console.log('Dynamic Forms', state.result);
  }
});

manager.load();
```

## See also

- [Module: Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/): Dashboard-defined single-screen field schema
- [Module: eKYC](/sdk-reference/web-sdk-2-module-ekyc/): identity-data form with a fixed field catalog
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-ekyb`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-ekyb/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-ekyb.md

# eKYB Module

<Component slug="web-2-x-implementation-warning" />

:::danger
This module is not ready for implementation.
:::

The eKYB (electronic Know Your Business) module collects business verification data including country, business name, address, and tax ID, plus a list of UBOs (Ultimate Beneficial Owners). It then submits the package to Incode's business verification engine.

This module follows a [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) variant with country-aware field schemas and a UBO repeater.

## Tag

`<incode-ekyb>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/ekyb';
import '@incodetech/web/ekyb/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                          |
| ---------- | ------------------------- | -------- | ------------------------------------ |
| `config`   | `EkybConfig`              | ❌       | eKYB configuration                   |
| `onFinish` | `() => void`              | ❌       | Called when KYB submission completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs          |

## Configuration

```typescript
type EkybConfig = {
  flowId?: string;
  verificationFields?: string[];
  checkBusinessName?: boolean;
  checkAddress?: boolean;
  checkTaxId?: boolean;
  checkUniqueBeneficialOwner?: boolean;
};
```

| Option                       | Type       | Required | Description                                                  |
| ---------------------------- | ---------- | -------- | ------------------------------------------------------------ |
| `flowId`                     | `string`   | ❌       | Session flow ID; injected by the orchestrator.               |
| `verificationFields`         | `string[]` | ❌       | List of fields to verify (used by the backend's KYB checks). |
| `checkBusinessName`          | `boolean`  | ❌       | Run business-name verification.                              |
| `checkAddress`               | `boolean`  | ❌       | Run address verification.                                    |
| `checkTaxId`                 | `boolean`  | ❌       | Run tax-ID verification.                                     |
| `checkUniqueBeneficialOwner` | `boolean`  | ❌       | Validate that UBOs are unique.                               |

### Dashboard field configuration

`EkybConfig` above is what you set in application code. The dashboard sends its own shape, `FlowModuleConfig['EKYB']`, which the orchestrator resolves into the rendered form. You do not set it yourself.

It pairs each verifiable field with a source, the same way [eKYC](/sdk-reference/web-sdk-2-module-ekyc/#dashboard-field-configuration) does:

- `check<Field>` (`boolean`) — whether to verify that field at all.
- `<field>Source` (`'userInput'`) — where its value comes from.

The pairs cover business name (`checkBusinessName` / `businessNameSource`), tax ID (`checkTaxId` / `taxIdSource`), and unique beneficial owner (`checkUniqueBeneficialOwner` / `uniqueBeneficialOwnerSource`).

**Address breaks the naming pattern.** Its source field is `address`, not `addressSource` — so `checkAddress` pairs with `address`. Reach for the sibling name and you get `undefined`.

To change which fields a flow verifies, edit the eKYB module in your dashboard rather than passing config in code.

## Supported countries

Built-in country support: `BR`, `US`, `GB`, `ES`, `IT`, `FR`, `DE`, `IL`, `MX`, `CN`, `NG`, `CM`, `KE`. Each country drives a different field schema (which fields are shown, which are required) — the manager looks up the schema from `EkybCountry` on `country` change.

## State machine

`EkybState` is a discriminated union over `status`:

| Status       | Description                                              |
| ------------ | -------------------------------------------------------- |
| `loading`    | Fetching business field schema for the selected country. |
| `form`       | Rendering the form (business fields + UBO repeater).     |
| `submitting` | Submitting the package to the eKYB backend.              |
| `success`    | Submission accepted.                                     |
| `finished`   | Terminal.                                                |
| `closed`     | User dismissed.                                          |
| `error`      | Submission or load error.                                |

### Form-state properties

These fields exist only when `status === 'form'`; `submitting` carries no form payload.

| Property | Type | Description |
| --- | --- | --- |
| `country` | `string` | Selected country. |
| `availableCountries` | `readonly string[]` | Country choices supported by the form. |
| `fields` | `EkybFieldDef[]` | Field descriptors for the selected country. |
| `values` | `EkybFormValues` | Current country, business, address, and tax-ID values. |
| `validationErrors` | `EkybValidationErrors?` | Field-name map of `{ key: string, params?: Record<string, string \| number> }`. Translate each key with its parameters. |
| `isValid` | `boolean` | No displayed validation errors; initially optimistic, not proof of completeness. |
| `ubos` | `UboEntry[]` | Entries with `id`, `name`, and `surname` strings. |
| `canAddUbo` | `boolean` | Whether the Add owner action is available. |
| `addressSuggestions` | `AddressSuggestion[]` | Current address-search results. |

Use `EkybState` from `@incodetech/core/ekyb`. Render current `values` after a country change rather than retaining fields from the previous schema.

### Error feedback

After narrowing `state.status` to `error`, read `state.errorMessage` (`string`) for failure feedback. It can be empty, so provide a translated fallback. This field is only present in that error state; use the recovery actions below.

## API methods

Business fields come from the dashboard schema, so this module uses one keyed setter. It also owns the UBO (ultimate beneficial owner) repeater.

| Method                             | Purpose                                                                       | Callable when |
| ---------------------------------- | ----------------------------------------------------------------------------- | ------------- |
| `load()`                           | Fetch the business field schema for the selected country.                     | `loading`     |
| `setCountry(country)`              | Set the country. Changing it reloads the schema.                              | `form`        |
| `setField(name, value)`            | Set one business field, keyed by its name in the schema.                      | `form`        |
| `validateField(name)`              | Validate one field. Call it on blur.                                          | `form`        |
| `searchAddress(query)`             | Fetch address autocomplete suggestions. Debounce it yourself.                 | `form`        |
| `selectAddress(suggestion)`        | Apply one suggestion from `searchAddress`. A street-level result is required. | `form`        |
| `addUbo()`                         | Append a UBO entry. Caps at eight.                                            | `form`        |
| `removeUbo(index)`                 | Remove the UBO entry at that index.                                           | `form`        |
| `setUboField(index, field, value)` | Set `'name'` or `'surname'` on one UBO entry.                                 | `form`        |
| `submit()`                         | Submit the package.                                                           | `form`        |
| `retry()`                          | Return to the form after a submission error.                                  | `error`       |

## See also

- [Module: eKYC](/sdk-reference/web-sdk-2-module-ekyc/): equivalent for individual identity verification
- [Module: Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/): separate sanctions screening
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-ekyc`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-ekyc/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-ekyc.md

# eKYC Module

<Component slug="web-2-x-implementation-warning" />

:::danger
This module is not ready for implementation.
:::

The eKYC (electronic Know Your Customer) module collects identity verification data through a configurable form including name, address, phone, email, SSN/tax ID, date of birth, ID numbers, etc. and submits it to Incode's KYC verification engine. The displayed fields and their data sources (manual entry, document OCR, prior phone/email modules) are dashboard-driven.

This module follows a [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) variant — dashboard-driven dynamic field schema with optional pre-fill from earlier modules.

## Tag

`<incode-ekyc>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/ekyc';
import '@incodetech/web/ekyc/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                          |
| ---------- | ------------------------- | -------- | ------------------------------------ |
| `config`   | `EkycConfig`              | ❌       | eKYC configuration                   |
| `onFinish` | `() => void`              | ❌       | Called when KYC submission completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs          |

## Configuration

```typescript
type EkycConfig = {
  flowId?: string;
  verificationFields?: EkycVerificationFields;
  source?: string;
  fieldsCountry?: string;
  enablePhoneRisk?: boolean;
};
```

| Option               | Type                     | Required | Description                                                                                                                                              |
| -------------------- | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `flowId`             | `string`                 | ❌       | Session flow ID; injected by the orchestrator.                                                                                                           |
| `verificationFields` | `EkycVerificationFields` | ❌       | Per-field source map. Each value is `'user_input' \| 'document_scan' \| 'poa_document' \| 'phone_module_input' \| 'email_module_input' \| false` (omit). |
| `source`             | `string`                 | ❌       | Backend-side override for default field source.                                                                                                          |
| `fieldsCountry`      | `string`                 | ❌       | ISO country code; controls country-specific field rendering.                                                                                             |
| `enablePhoneRisk`    | `boolean`                | ❌       | Enable phone-risk subprocess on submit.                                                                                                                  |

The full list of `EkycVerificationFields` keys: `name`, `address`, `phone`, `email`, `SSN`, `taxId`, `nationality`, `'date of birth'`, `dlNumber`, `dlState`, `dlExpireAt`, `last4SSN`, `idNum`, `idNum1`, `gender`, `panNumber`. Each field can be sourced from manual entry, OCR'd ID data, POA document data, or a prior phone/email module.

### Dashboard field configuration

`EkycConfig` above is what you set in application code. The dashboard sends its own shape, `EkycModuleConfig`, which the orchestrator resolves into the rendered form. You do not set it yourself, but it is exported from `@incodetech/core/ekyc` so you can type a response you inspect.

It configures each verifiable field with a **pair** of properties:

- `check<Field>` (`boolean`): whether to verify that field at all.
- `<field>Source` (`string`): where its value comes from, using the same source names as `verificationFields`.

For example, `checkName` plus `nameSource`, and `checkDob` plus `dobSource`. The pairs cover `Name`, `Email`, `Address`, `Phone`, `Ssn`, `Dob`, `Nationality`, `DlNumber`, `DlState`, `DlExpireAt`, `Last4SSN`, `IdNum`, `IdNum1`, `Gender`, and `PanNumber`. A top-level `source` sets the default for fields with no explicit source, and `riskAddons` and `enablePhoneRisk` carry the risk configuration.

To change which fields a flow verifies, edit the eKYC module in your dashboard rather than passing config in code.

## Risk addons

The dashboard-driven module config exposes a `riskAddons` array (`RiskAddon`: `'phoneCheck' | 'advancedPhoneCheck' | 'emailCheck' | 'phoneProfile'`). A matching addon renders the corresponding input even when its `checkPhone` / `checkEmail` flag is off:

- `phoneCheck`, `advancedPhoneCheck` or `phoneProfile` renders the phone input.
- `emailCheck` renders the email input.

A module `source` of `RISK_ADDONS_ONLY` runs the eKYC form purely to collect the inputs the configured risk addons need, without a full identity-data check. These values come from the dashboard flow configuration, so most callers pass them through unmodified.

When `riskAddons` includes `phoneProfile` and the `source` is `RISK_ADDONS_ONLY`, the module submits with `source: 'PHONE_PROFILE'`. The phone input is required, and the user can change its country. The payload leaves out `countryCode`:

```json
{ "plugins": ["kyc"], "source": "PHONE_PROFILE", "phone": "+12025550101" }
```

Any other inputs that addons render (for example, email from `emailCheck`) are still sent with that payload.

## State machine

`EkycState` is a discriminated union over `status`:

| Status          | Description                                                                |
| --------------- | -------------------------------------------------------------------------- |
| `loading`       | Fetching field schema and any pre-fill data from prior modules.            |
| `form`          | Rendering the configured form fields; user enters / corrects data.         |
| `submitting`    | Submitting to the eKYC backend.                                            |
| `success`       | Submission accepted.                                                       |
| `finished`      | Terminal.                                                                  |
| `closed`        | User dismissed.                                                            |
| `error`         | Submission or load error.                                                  |
| `misconfigured` | The backend returned no usable field configuration; can't render the form. |

### Form-state properties

These fields exist only when `status === 'form'`; `submitting` carries no form payload.

| Property | Type | Description |
| --- | --- | --- |
| `fields` | `EkycFieldDef[]` | Ordered field descriptors for rendering. |
| `values` | `Record<string, string \| undefined>` | Current values, including available prefill. |
| `validationErrors` | `EkycValidationErrors?` | Field-name map of `{ key: string, params?: Record<string, string \| number> }`; translate each key with its parameters. |
| `isValid` | `boolean` | No validation errors currently displayed; initially optimistic, not proof of completeness. |
| `addressSuggestions` | `AddressSuggestion[]` | Current address-search results. |
| `prefilled` | `Record<string, boolean>` | Marks fields populated from earlier verification data. |
| `hideEmail` | `boolean` | Whether the email control should be hidden. |
| `fieldsCountry` | `string` | Country used to render the schema. |
| `submitError` | `string` | Submission feedback retained on the form. |

Use `EkycState` from `@incodetech/core/ekyc` for the complete union. Keep prefilled values editable where the supplied schema allows it.

### Error feedback

After narrowing `state.status` to `error`, read `state.errorMessage` (`string`) for failure feedback. It can be empty, so provide a translated fallback. This field is only present in that error state; use the recovery actions below.

## API methods

Fields come from the dashboard schema, so this module uses one keyed setter rather than a setter per field.

| Method                      | Purpose                                                                       | Callable when |
| --------------------------- | ----------------------------------------------------------------------------- | ------------- |
| `load()`                    | Fetch the field schema and any prefill from earlier modules.                  | `loading`     |
| `setField(name, value)`     | Set one field, keyed by its name in the schema.                               | `form`        |
| `validateField(name)`       | Validate one field. Call it on blur.                                          | `form`        |
| `searchAddress(query)`      | Fetch address autocomplete suggestions. Debounce it yourself.                 | `form`        |
| `selectAddress(suggestion)` | Apply one suggestion from `searchAddress`. A street-level result is required. | `form`        |
| `submit()`                  | Submit the form.                                                              | `form`        |
| `retry()`                   | Return to the form after a submission error.                                  | `error`       |
| `skip()`                    | Skip verification and continue the flow past the failure.                     | `error`       |

## See also

- [Module: eKYB](/sdk-reference/web-sdk-2-module-ekyb/): equivalent for businesses
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Module Patterns → composite](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-electronic-signature`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-electronic-signature/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-electronic-signature.md

# Electronic Signature Module

<Component slug="web-2-x-implementation-warning" />

The Electronic Signature module handles eIDAS-aligned electronic signing flows: render documents to be signed, collect compliance consents, capture the signature, and finalize. Three variants exist: base AES, Advanced Electronic Signature (AE), and Qualified Electronic Signature (QE). All three share a single state machine and manager API.

This module follows the [document-signing pattern](/sdk-reference/web-sdk-2-module-patterns/#4-document-signing-modules).

## Variants

`ae-signature` and `qe-signature` are thin wrappers around `electronic-signature`:

| Module                                  | Manager factory                    | Consent keys               |
| --------------------------------------- | ---------------------------------- | -------------------------- |
| `@incodetech/core/electronic-signature` | `createElectronicSignatureManager` | Caller-provided            |
| `@incodetech/core/ae-signature`         | `createAeSignatureManager`         | `AE_CONSENT_KEYS` (3 keys) |
| `@incodetech/core/qe-signature`         | `createQeSignatureManager`         | `QE_CONSENT_KEYS` (5 keys) |

The wrappers hardcode `variant: 'ae'` or `'qe'` and re-export the same state machine, state types, and helpers from the base module (`AeSignatureState` is `ElectronicSignatureState`, etc.).

Web components: `<incode-electronic-signature>`, `<incode-ae-signature>`, `<incode-qe-signature>`. All three import paths register their own tag and ship their own CSS.

```ts
// Base AES
import '@incodetech/web/electronic-signature';
import '@incodetech/web/electronic-signature/styles.css';

// Advanced Electronic Signature
import '@incodetech/web/ae-signature';
import '@incodetech/web/ae-signature/styles.css';

// Qualified Electronic Signature
import '@incodetech/web/qe-signature';
import '@incodetech/web/qe-signature/styles.css';
```

## Properties

| Property   | Type                        | Required | Description                   |
| ---------- | --------------------------- | -------- | ----------------------------- |
| `config`   | `ElectronicSignatureConfig` | ❌       | Configuration options         |
| `onFinish` | `() => void`                | ❌       | Called when signing completes |
| `onError`  | `(error: string) => void`   | ❌       | Called when the user dismisses (`closed`) |

## Configuration

```typescript
type ElectronicSignatureConfig = {
  variant?: 'ae' | 'qe'; // Hardcoded by the AE/QE wrapper modules
  uploadDocument?: boolean;
  downloadDocument?: boolean;
  providerCode?: string;
  language?: string;
};
```

| Option             | Type           | Required | Description                                                                                         |
| ------------------ | -------------- | -------- | --------------------------------------------------------------------------------------------------- |
| `variant`          | `'ae' \| 'qe'` | ❌        | Set automatically by the AE/QE wrapper modules. Omit for base AES.                                  |
| `uploadDocument`   | `boolean`      | ❌        | Allow the user to upload a custom document to be signed.                                            |
| `downloadDocument` | `boolean`      | ❌        | Allow the user to download the signed document afterwards.                                          |
| `providerCode`     | `string`       | ❌        | `QES_3` enables the Namirial QES terms flow. Other values preserve the existing QE consent flow.    |
| `language`         | `string`       | ❌        | Locale used to request Namirial terms. `en`, `it`, and `de` are supported; other values use English. |

When the QE Signature module runs inside an SDK Flow, `providerCode` comes from the flow configuration and `language` comes from the active SDK locale. Set them directly only when creating a standalone manager.

### Consent keys

The user must check all required consent boxes before signing. Each variant defines its own keys (re-exported from the variant's module):

```typescript
const AE_CONSENT_KEYS = [
  'terms',
  'signElectronically',
  'signDisplayed',
] as const;

const QE_CONSENT_KEYS = [
  'issuance',
  'qesAcknowledgement',
  'qscdConfirmation',
  'termsAgreement',
  'documentsReviewed',
] as const;

const NAMIRIAL_QES_CONSENT_KEYS = ['providerTerm0', 'providerTerm1'] as const;
```

Helpers from `@incodetech/core/electronic-signature` (also re-exported from the AE/QE wrappers): `getDefaultConsentChecks(variant)` returns a fresh `ConsentChecks` map for the given variant (`'ae' | 'qe'`); `areAllConsented(consents)` returns whether every key in that map is checked.

For `providerCode: 'QES_3'`, the SDK requests the certificate application and checkbox labels from the provider before loading documents. It renders exactly the two provider labels without adding SDK policy links. The user can open the provider's certificate application form in a plain-text viewer and must accept both statements before signing.

## State machine

`ElectronicSignatureState` is a discriminated union over `status`:

| Status       | Description                                                      |
| ------------ | ---------------------------------------------------------------- |
| `loading`    | Fetching the documents to be signed.                             |
| `uploading`  | User selects a document to upload (when `uploadDocument` is set). |
| `reviewing`  | Document preview before upload confirmation.                       |
| `signing`    | Documents shown; user toggles consent checkboxes.                |
| `processing` | Server-side signing in progress.                                 |
| `success`    | Signing accepted (auto-finishes after 3s unless download flow).  |
| `signError`  | Signing failed; error screen shown for 3s then auto-finishes.    |
| `finished`   | Terminal success.                                                  |
| `closed`     | User dismissed.                                                    |
| `error`      | Recoverable upload/fetch-docs failure (Try Again).               |

The `state.documents` array (when populated) carries the `ElectronicSignatureDocument[]` to render: `{ documentRef, documentUrl }`.

A few states carry additional fields beyond `documents`: `uploading` and `reviewing` add `fileName` (`reviewing` also adds `fileUrl`); `signing` adds `variant`, `consentChecks`, `allConsented`, `providerTerms`, `viewingDocumentUrl`, and `viewingApplicationForm`; `success` adds `signedDocuments: { signed: boolean; signedDocumentUrl?: string }[]` and `downloadDocument`. The base AES endpoint returns a signed URL immediately. Legacy QES returns only `{ success: true }`; Namirial QES fetches the signed document collection after all documents are signed.

`providerTerms.contractText` can contain personal holder information. Treat it as ephemeral UI state: do not log, persist, or emit it as telemetry.

### Error feedback

After narrowing `state.status` to `error` and `signError`, read `state.errorMessage` (`string`) for failure feedback. It can be empty, so provide a translated fallback. This field is only present in those error states; use the recovery actions below.

## API methods

| Method                                      | Purpose                                                      |
| ------------------------------------------- | ------------------------------------------------------------ |
| `load()`                                    | Fetch documents.                                             |
| `setConsent(name, checked)`                 | Toggle a consent checkbox by key.                            |
| `selectFile(fileName, fileData, fileUrl)`   | Provide a custom document (when `uploadDocument` is `true`). |
| `replaceFile()`                             | Clear the previously selected file.                          |
| `confirmFile()`                             | Confirm document selection and proceed to signing.           |
| `viewDocument(url)` / `closeDocumentView()` | Open / close the document preview.                           |
| `viewApplicationForm()` / `closeApplicationForm()` | Open / close the Namirial certificate application form.     |
| `sign()`                                    | Produce the signature once consents are checked.             |
| `finish()`                                  | Acknowledge `success` and finish.                            |
| `retry()`                                   | After `error`, restart.                                      |
| `close()`                                   | Dismiss (transitions to `closed`).                           |

Plus the base lifecycle: `subscribe`, `getState`, `stop`. Unlike the face-capture and ID-capture managers, this manager has no `reset()` — create a new manager instance to start over.

## See also

- [Module: Signature](/sdk-reference/web-sdk-2-module-signature/): handwritten signature on canvas (no document review)
- [Module Patterns → document-signing](/sdk-reference/web-sdk-2-module-patterns/#4-document-signing-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-email`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-email/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-email.md

# Email Module

<Component slug="web-2-x-implementation-warning" />

The Email module verifies a user's email address via OTP (One-Time Password).

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) (with the OTP sub-loop). See that page for the shared manager lifecycle and skeleton; the rest of this page covers Email-specific config, states, and methods.

## Tag

`<incode-email>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/email';
import '@incodetech/web/email/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                      | Required | Description                        |
| ---------- | ------------------------- | -------- | ---------------------------------- |
| `config`   | `EmailConfig`             | ✅       | Configuration options              |
| `onFinish` | `() => void`              | ❌       | Called when verification completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs        |

## Usage

### Vanilla HTML / TypeScript

```html
<incode-email></incode-email>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/email';
  import '@incodetech/web/email/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: 'your-session-token',
  });

  const email = document.querySelector('incode-email');
  email.config = {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  };
  email.onFinish = () => console.log('Email verified!');
  email.onError = (err) => console.error('Email error:', err);
</script>
```

### React

> **React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it, and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { EmailConfig } from '@incodetech/core/email';
import '@incodetech/web/email';
import '@incodetech/web/email/styles.css';

type EmailElement = HTMLElement & {
  config: EmailConfig;
  onFinish: () => void;
  onError: (error: string) => void;
};

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

export function EmailVerification() {
  const ref = useRef<EmailElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = {
      otpVerification: true,
      otpExpirationInMinutes: 5,
      prefill: false,
    };
    el.onFinish = () => console.log('Email verified!');
    el.onError = (err) => console.error('Email error:', err);
  }, []);

  return <incode-email ref={ref} />;
}
```

For Angular (`CUSTOM_ELEMENTS_SCHEMA`) and Vue (`compilerOptions.isCustomElement`) setup, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

---

## Headless Mode

For complete UI control, use the `createEmailManager` from `@incodetech/core/email`.

### Quick Start

```tsx
import { setup } from '@incodetech/core';
import { createEmailManager } from '@incodetech/core/email';

// Initialize SDK first
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

const manager = createEmailManager({
  config: {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  },
});

manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'finished') {
    console.log('Email verified!');
    manager.stop();
  }
});

// Start the flow
manager.load();

// When state is 'inputting', set the email and submit
manager.setEmail('user@example.com', true);
manager.submit();

// When state is 'awaitingOtp', submit the OTP code
manager.submitOtp('ABC123');
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| inputting
    inputting -->|submit| awaitingOtp
    awaitingOtp -->|submitOtp| finished
    awaitingOtp -.->|back| inputting
    awaitingOtp -.->|resendOtp| awaitingOtp
```

### States Reference

| Status              | Description                                   | Key Properties                                              |
| ------------------- | --------------------------------------------- | ----------------------------------------------------------- |
| `idle`              | Initial state, waiting for `load()`           | –                                                           |
| `loadingPrefill`    | Fetching pre-filled email from backend        | –                                                           |
| `inputting`         | Ready for email input                         | `prefilledEmail?`, `emailError?`, `validationErrors?`, `isValid`, `otpVerification?` |
| `submitting`        | Submitting email to backend                   | –                                                           |
| `sendingInitialOtp` | Sending OTP code via email for the first time | –                                                           |
| `resendingOtp`      | Resending OTP code via email                  | `otpCode`, `otpLength`                                      |
| `awaitingOtp`       | Waiting for user to enter OTP                 | `resendTimer`, `canResend`, `attemptsRemaining`, `otpCode`, `otpLength`, `otpValidationErrors?`, `isOtpValid` |
| `verifyingOtp`      | Verifying OTP code with backend               | `resendTimer`, `canResend`, `otpCode`, `otpLength`           |
| `otpError`          | OTP verification failed                       | `otpError`, `attemptsRemaining`, `resendTimer`, `canResend`, `otpCode`, `otpLength`, `otpValidationErrors?`, `isOtpValid` |
| `finished`          | Verification complete                         | –                                                           |
| `error`             | Fatal error occurred                          | `error`                                                     |

### State Properties

**When `status === 'inputting'`:**

| Property           | Type                     | Description                                                                          |
| ------------------ | ------------------------ | ------------------------------------------------------------------------------------- |
| `prefilledEmail`   | `string?`                | Pre-populated email address (if `prefill: true`)                                     |
| `emailError`       | `string?`                | Submission error message if the backend rejected the email address                    |
| `validationErrors` | `EmailValidationErrors?` | Client-side validation errors (e.g. invalid/empty email), surfaced on blur and submit |
| `isValid`          | `boolean`                | True iff `validationErrors` is empty. Optimistic — starts `true` on initial render.    |

**When `status === 'awaitingOtp'`, `'verifyingOtp'`, `'otpError'`, or `'resendingOtp'`:**

| Property              | Type                   | Description                                                                             |
| --------------------- | ---------------------- | ------------------------------------------------------------------------------------------ |
| `otpCode`             | `string`               | The OTP code entered so far (controlled-input value)                                    |
| `otpLength`           | `number`               | Expected OTP length (owned by Core — don't hardcode it)                                 |
| `resendTimer`         | `number`               | Seconds remaining before resend allowed (`awaitingOtp`, `verifyingOtp`, `otpError`)      |
| `canResend`           | `boolean`              | Whether resend button should be enabled (`awaitingOtp`, `verifyingOtp`, `otpError`)      |
| `attemptsRemaining`   | `number`               | OTP verification attempts left (`awaitingOtp`, `otpError`)                               |
| `otpValidationErrors` | `OtpValidationErrors?` | Client-side OTP errors (e.g. incomplete code), surfaced on blur and submit (`awaitingOtp`, `otpError`) |
| `isOtpValid`          | `boolean`              | True iff `otpValidationErrors` is empty (`awaitingOtp`, `otpError`)                       |
| `otpError`            | `string`               | Error message describing failure (`otpError` only)                                       |

### API Methods

| Method                     | Description                             | When to Use                           |
| -------------------------- | --------------------------------------- | ------------------------------------- |
| `load()`                   | Initializes the flow                    | Always call first                     |
| `setEmail(email, isValid)` | Sets email address and validation state | When `inputting`, before `submit()`   |
| `validateEmail()`          | Runs blur-style validation, populating or clearing `validationErrors.email` | When `inputting` |
| `submit()`                 | Submits the email address               | After setting valid email             |
| `setOtpCode(code)`         | Sets OTP without submitting             | When `awaitingOtp` (controlled input) |
| `validateOtp()`            | Runs blur-style OTP validation, populating or clearing `otpValidationErrors.otp` | When `awaitingOtp` or `otpError` |
| `submitOtp(code)`          | Sets and submits OTP code               | When `awaitingOtp` or `otpError`      |
| `resendOtp()`              | Requests new OTP code                   | When `canResend` is `true`            |
| `back()`                   | Returns to email input                  | When `awaitingOtp`                    |
| `reset()`                  | Resets to initial state                 | Only in `error`; create a new manager after final `finished` |
| `stop()`                   | Cleanup resources                       | When unmounting                       |
| `getState()`               | Returns current state synchronously     | Anytime                               |
| `subscribe(callback)`      | Subscribe to state changes              | Returns unsubscribe function          |

### React Example

```tsx
import { useState, useEffect } from 'react';
import { createEmailManager, type EmailState } from '@incodetech/core/email';

function CustomEmailVerification() {
  const [manager] = useState(() =>
    createEmailManager({
      config: {
        otpVerification: true,
        otpExpirationInMinutes: 5,
        prefill: false,
      },
    }),
  );
  const [state, setState] = useState<EmailState>({ status: 'idle' });
  const [email, setEmail] = useState('');
  const [otp, setOtp] = useState('');

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  const handleSubmitEmail = () => {
    // Simple email validation
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    const isValid = emailRegex.test(email);
    manager.setEmail(email, isValid);
    manager.submit();
  };

  switch (state.status) {
    case 'inputting':
      return (
        <div>
          <input
            type="email"
            value={email}
            onChange={(e) => setEmail(e.target.value)}
            placeholder="Enter email address"
          />
          {state.emailError && <p className="error">{state.emailError}</p>}
          <button onClick={handleSubmitEmail}>Send OTP</button>
        </div>
      );

    case 'submitting':
    case 'sendingInitialOtp':
    case 'resendingOtp':
      return <div>Sending OTP...</div>;

    case 'awaitingOtp':
      return (
        <div>
          <p>Enter the 6-character code sent to your email</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value.toUpperCase())}
            placeholder="ABC123"
            maxLength={6}
          />
          <button onClick={() => manager.submitOtp(otp)}>Verify</button>

          {state.canResend ? (
            <button onClick={() => manager.resendOtp()}>Resend Code</button>
          ) : (
            <p>Resend available in {state.resendTimer}s</p>
          )}

          <button onClick={() => manager.back()}>Change Email</button>
        </div>
      );

    case 'otpError':
      return (
        <div>
          <p className="error">{state.otpError}</p>
          <p>Attempts remaining: {state.attemptsRemaining}</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value.toUpperCase())}
            maxLength={6}
          />
          <button onClick={() => manager.submitOtp(otp)}>Try Again</button>
        </div>
      );

    case 'verifyingOtp':
      return <div>Verifying...</div>;

    case 'finished':
      return <div>Email verified successfully!</div>;

    case 'error':
      return <div className="error">Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}
```

---

## Configuration Options

`EmailConfig` shape:

| Option                   | Type      | Required | Description                                                                                            |
| ------------------------ | --------- | -------- | ------------------------------------------------------------------------------------------------------ |
| `otpVerification`        | `boolean` | ✅       | Require OTP (email code) verification. If `false`, the email is verified immediately after submission. |
| `otpExpirationInMinutes` | `number`  | ✅       | How long the OTP code remains valid. After expiration the user must request a new code.                |
| `prefill`                | `boolean` | ❌       | Pre-populate with the user's previously stored email. Useful for returning users. Default `false`.     |
| `maxOtpAttempts`         | `number`  | ❌       | Maximum OTP verification attempts before lockout. Default `3`.                                         |

## Troubleshooting

### OTP Not Received

- Check the spam/junk folder
- Verify the email address is correct
- Some corporate email filters may block OTP emails
- Add the sender to your contacts/allowlist

### Invalid OTP Error

- OTPs expire after the configured time (default 5 minutes)
- Each OTP can only be used once
- Request a new OTP if the current one expires
- Check `attemptsRemaining` before lockout

### Email Address Rejected

- Ensure the email format is valid
- Some disposable email domains may be blocked
- Corporate email addresses are generally accepted

---

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Complete headless API reference
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Overview of all modules

---

- Path: `sdk-reference/web-sdk-2-module-face-match`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-face-match/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-face-match.md

# Face Match Module

<Component slug="web-2-x-implementation-warning" />

The Face Match module compares the user's selfie with the face cropped from their ID document and returns a match decision plus a liveness verdict. Runs server-side using images already collected by the session.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules) with an additional `animating` state for the result-reveal animation. See the patterns page for the shared lifecycle.

## Tag

`<incode-face-match>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/face-match';
import '@incodetech/web/face-match/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                                  |
| ---------- | ------------------------- | -------- | -------------------------------------------- |
| `config`   | `FaceMatchConfig`         | ❌       | Configuration options                        |
| `onFinish` | `() => void`              | ❌       | Called when the result has been acknowledged |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs                  |

## Configuration

```typescript
type FaceMatchConfig = {
  matchingType?:
    | 'selfieVsId'
    | 'selfieVsNfc'
    | 'idVsNfc'
    | 'nfc3Way'
    | 'secondId';
  disableFaceMatchAnimation?: boolean;
};
```

| Option                      | Type               | Required | Description                                                                                                                                                                                                                                                              |
| --------------------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `matchingType`              | `FaceMatchVariant` | ❌        | Which images to compare. Default `'selfieVsId'`. Backend field name `matchingType`.                                                                                                                                                                                      |
| `disableFaceMatchAnimation` | `boolean`          | ❌        | When `true`, skip the reveal animation and auto-advance after fetching the result. Useful for headless / silent flows. Default `false`.                                                                                                                                  |
| `skipFaceMatch`             | `boolean`          | ❌        | When `true`, the module completes immediately on mount without fetching or rendering anything. Default `false`. **The Flow orchestrator sets this, not your code** — it applies when the ID was captured with no front image, so there is no ID face to compare against. |

## State machine

`FaceMatchState` is a discriminated union over `status`:

| Status      | Description                                                                       |
| ----------- | --------------------------------------------------------------------------------- |
| `idle`      | Initial state.                                                                    |
| `loading`   | Fetching face images and computing the match server-side.                         |
| `animating` | Playing the reveal animation. Skipped when `disableFaceMatchAnimation` is `true`. |
| `result`    | Animation finished; result is on `state.result` (`matched`, `liveness`).          |
| `finished`  | Terminal.                                                                         |
| `error`     | Fatal error.                                                                      |

The `result` state's data:

```typescript
type FaceMatchResult = {
  matched: boolean | null; // OK = true, FAIL = false, UNKNOWN = null
  liveness: boolean | null;
};
```

## API methods

| Method                | Purpose                                                     |
| --------------------- | ----------------------------------------------------------- |
| `load()`              | Fetch images and compute match.                             |
| `animationComplete()` | Tell the manager the animation finished (when `animating`). |
| `continue()`          | Acknowledge the result and finish.                          |
| `reset()`             | After `finished` or `error`, return to idle.                |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## See also

- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): captures the selfie this module compares against
- [Module: ID Capture](/sdk-reference/web-sdk-2-module-id-capture/): captures the ID this module compares against
- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-field-comparison`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-field-comparison/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-field-comparison.md

# Field Comparison Module

<Component slug="web-2-x-implementation-warning" />

The Field Comparison module collects the user's first and last name and submits them for backend verification against data already on file for the session.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules). See the patterns page for the shared lifecycle.

## Tag

`<incode-field-comparison>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/field-comparison';
import '@incodetech/web/field-comparison/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                            |
| ---------- | ------------------------- | -------- | -------------------------------------- |
| `config`   | `FieldComparisonConfig`   | ❌       | No options                             |
| `onFinish` | `() => void`              | ❌       | Called when the module completes        |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs             |

## Configuration

The module takes no configuration — the backend sends an empty module configuration for this step:

```typescript
type FieldComparisonConfig = Record<string, never>;
```

Which fields the backend compares, and how it scores the result, is configured server-side.

## State machine

`FieldComparisonState` is a discriminated union over `status`:

| Status       | Description                                                   |
| ------------ | ------------------------------------------------------------- |
| `idle`       | Initial state, waiting for `load()`.                          |
| `inputting`  | Form rendered; the user enters their name.                     |
| `submitting` | Sending the entered names to the backend.                     |
| `success`    | Submission accepted.                                          |
| `finished`   | Terminal.                                                     |
| `error`      | Submission failed; the user can retry or skip.                |

When `status === 'inputting'`:

| Property           | Type                              | Description                                                                                         |
| ------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------- |
| `fields`           | `FieldComparisonFields`           | Current values: `{ firstName, lastName }`.                                                           |
| `validationErrors` | `FieldComparisonValidationErrors` | Translation keys for fields with displayed errors. Absent before validation and when no errors remain. |
| `canSubmit`        | `boolean`                         | `true` when no validation errors are displayed. It starts `true` before validation runs.            |

Field Comparison uses optimistic validation. Continue starts enabled on an empty form. Calling `submit()` validates both required names. If either name is blank, the state remains `inputting`, `validationErrors` contains `dynamicForms.fieldRequired` for each blank field, and `canSubmit` becomes `false`. Calling `setField()` clears the error for that field.

`submitting` carries the same `fields`, frozen at submission time, so you can keep the form visible while the request is in flight.

## API methods

| Method                    | Purpose                                                                   |
| ------------------------- | ------------------------------------------------------------------------- |
| `load()`                  | Starts the module. Moves `idle` → `inputting`. Call this first.            |
| `setField(field, value)`  | Update one field. `field` is `'firstName'` or `'lastName'`.                |
| `submit()`                | Validate both names, then submit them when valid.                           |
| `retry()`                 | Retry after an `error`.                                                   |
| `skip()`                  | Skip the module and finish without submitting.                            |

Plus the universal lifecycle: `subscribe`, `getState`, `reset`, `stop`.

## Headless example

```typescript
import { setup } from '@incodetech/core';
import { createFieldComparisonManager } from '@incodetech/core/field-comparison';

const manager = createFieldComparisonManager({ config: {} });

manager.subscribe((state) => {
  if (state.status === 'inputting') {
    renderForm({
      fields: state.fields,
      validationErrors: state.validationErrors,
      canSubmit: state.canSubmit,
    });
  }
  if (state.status === 'finished') {
    console.log('Field comparison complete');
  }
});

manager.load();

// Wire your inputs to setField, then submit.
manager.setField('firstName', 'Ada');
manager.setField('lastName', 'Lovelace');
manager.submit();
```

## See also

- [Module: Cross-Document Data Match](/sdk-reference/web-sdk-2-module-cross-doc-match/): compares data across captured documents
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-geolocation`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-geolocation/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-geolocation.md

# Geolocation Module

<Component slug="web-2-x-implementation-warning" />

The Geolocation module captures the user's coordinates via the browser's geolocation API and submits them to the backend. Useful for jurisdictional rules and fraud signals.

This module follows a [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules) variant with a permission step. Requires a user gesture before the browser will prompt for permission.

## Tag

`<incode-geolocation>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/geolocation';
import '@incodetech/web/geolocation/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                                   |
| ---------- | ------------------------- | -------- | --------------------------------------------- |
| `config`   | `GeolocationConfig`       | ❌       | Configuration options                         |
| `onFinish` | `() => void`              | ❌       | Called when location is captured (or skipped) |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs                   |

## Configuration

```typescript
type GeolocationConfig = {
  allowUserToSkipGeolocation?: boolean;
  maxAttempts?: number;
};
```

| Option                       | Type      | Required | Description                                                                                                                                 |
| ---------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowUserToSkipGeolocation` | `boolean` | ❌        | When `true`, a Skip button is shown on the permission-denied screen. Default `false`. Backend-driven via flow config.                       |
| `maxAttempts`                | `number`  | ❌        | How many backend submit attempts the `error` screen offers before it stops showing "Try again" and falls back to skip or quit. Default `3`. |

## State machine

`GeolocationState` is a discriminated union over `status`:

| Status               | Description                                                                                                                         | Extra properties               |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `idle`               | Initial state.                                                                                                                      | –                              |
| `requestingLocation` | Browser permission prompt visible / location lookup in progress.                                                                    | –                              |
| `locationAcquired`   | Location submitted successfully; awaiting user confirmation.                                                                                           | `location`                     |
| `permissionDenied`   | The user actually denied permission. Show device-specific instructions, plus Skip when enabled.                                     | `deviceType`, `canSkip`        |
| `submitting`         | Sending coordinates to the backend.                                                                                                 | –                              |
| `error`              | A submit attempt failed and the user can try again. Offer "Try again" while `attemptsRemaining` is above zero, then Skip or Quit.   | `attemptsRemaining`, `canSkip` |
| `noNetwork`          | A backend request failed because the device lost connectivity. No manager action leaves this state; restore connectivity and reload the page. | –                              |
| `finished`           | Terminal.                                                                                                                           | –                              |
| `closed`             | User dismissed the module.                                                                                                          | –                              |

`permissionDenied`** means a real denial only.** Transient browser failures — position unavailable, lookup timeout — route to `error` instead, so branch on `error` if you want to offer a retry for those.

## API methods

| Method       | Purpose                                                            | Callable when                           |
| ------------ | ------------------------------------------------------------------ | --------------------------------------- |
| `request()`  | Start the browser permission request. Needs a user gesture.        | `idle`                                  |
| `continue()` | Confirm the acquired location and complete the module.             | `locationAcquired`                      |
| `retry()`    | Return to `idle`; then call `request()` again from a user gesture. | `error`, with attempts remaining                    |
| `skip()`     | Skip geolocation. Requires `allowUserToSkipGeolocation`.           | `permissionDenied`, `error` (`canSkip`) |
| `quit()`     | Give up and leave the module.                                      | `error`                                 |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

The built-in `noNetwork` screen offers a page reload. A headless host should provide the same recovery after connectivity returns; `retry()` does nothing in `noNetwork`.

## See also

- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)
- [Troubleshooting → CSP](/sdk-reference/web-sdk-2-troubleshooting/#content-security-policy): geolocation needs no special CSP, but may need feature-policy delegation in iframes

---

- Path: `sdk-reference/web-sdk-2-module-gov-validation-1`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-gov-validation-1/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-gov-validation-1.md

# Government Validation Module

<Component slug="web-2-x-implementation-warning" />

The Government Validation module (also called **INE Validation**) submits the user's identity data (typically post-ID-capture) to a government registry for verification. Multiple validation types can run simultaneously (facial, data, address). It runs as a backend-only step: the validation outcome (success, failure, or unavailable for the country) never blocks or alters the user-facing journey. The SDK shows a loader while the call resolves, then the flow advances — there is no result screen and no OTP sub-flow. Use backend verification results for decisions; reaching `finished` is not proof that the registry check passed.

The same module handles two flow variants that share one manager, state machine, and UI: `GOVT_VALIDATION_PROVISIONING` (the general government-registry check) and `INE_VALIDATION` (the Mexico INE check). Both variants are configured from the dashboard flow, so most callers pass the config through unmodified.

This module follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules).

## Tag

`<incode-government-validation>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/government-validation';
import '@incodetech/web/government-validation/styles.css';
```

For headless (no pre-built UI) control, drive it with `createGovernmentValidationManager` from `@incodetech/core/government-validation`. This module is typically invoked from an orchestrated flow rather than mounted standalone.

```ts
import { createGovernmentValidationManager } from '@incodetech/core/government-validation';

const manager = createGovernmentValidationManager({
  config: { facialValidation: true, dataValidation: true },
});
manager.subscribe((state) => {
  if (state.status === 'finished') manager.stop();
});
manager.load();
```

## Configuration

```typescript
type GovernmentValidationConfig = {
  validationCountries?: string[];
  facialValidation: boolean;
  dataValidation: boolean;
  faceAndDataValidation?: boolean;
  addressValidation?: boolean;
  faceMatchOverrideDataScore?: boolean;
  useCroppedIdFacePhoto?: boolean;
};
```

| Option                       | Type       | Required | Description                                                             |
| ----------------------------- | ---------- | -------- | ------------------------------------------------------------------------ |
| `validationCountries`        | `string[]` | ❌       | ISO country codes the backend should run against.                       |
| `facialValidation`           | `boolean`  | ✅       | Run facial validation (selfie ↔ government photo).                      |
| `dataValidation`             | `boolean`  | ✅       | Run data validation (name, DOB, etc.).                                  |
| `faceAndDataValidation`      | `boolean`  | ❌       | Combined face + data check.                                             |
| `addressValidation`          | `boolean`  | ❌       | Run address validation.                                                 |
| `faceMatchOverrideDataScore` | `boolean`  | ❌       | Advanced: face-match score overrides data-score for the final decision. |
| `useCroppedIdFacePhoto`      | `boolean`  | ❌       | Use the cropped ID face photo (vs. full ID image).                      |

These options are consumed **server-side** — the SDK passes them through from the dashboard flow configuration and does not branch on them.

:::warning
**Breaking change (in the 2.3.0 release):** `backgroundExecution` has been removed from `GovernmentValidationConfig`. The module now always runs as a backend-only step (loader, then done, no result screen) regardless of this flag's former value, so keeping a dead, always-required boolean around was more confusing than useful. Remove it from any config you pass explicitly.
:::

### INE validation options

These options apply to the Mexican INE check. Set them on the module's dashboard configuration rather than in application code:

| Option                        | Type      | Required | Description                                                                                     |
| ----------------------------- | --------- | -------- | ----------------------------------------------------------------------------------------------- |
| `alternativeFacialValidation` | `boolean` | ❌        | Use the alternative facial-validation route for INE.                                            |
| `fallbackEnabled`             | `boolean` | ❌        | Allow the backend to fall back to another validation route when the primary one is unavailable. |
| `scrapingMethod`              | `boolean` | ❌        | Select the scraping-based INE validation route.                                                 |
| `scrapingV2`                  | `boolean` | ❌        | Select version 2 of the scraping route.                                                         |
| `scrapingV3`                  | `boolean` | ❌        | Select version 3 of the scraping route.                                                         |
| `failUnsupportedId`           | `boolean` | ❌        | Ask the backend to record unsupported documents as a validation failure. The frontend still advances when the request resolves.             |

These fields come from the dashboard's flow configuration. Most callers pass them through unmodified from the orchestrator's `state.config`.

## State machine

`GovernmentValidationState` is a discriminated union over `status`:

| Status     | Description                                                                                                                                     |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------|
| `idle`     | Initial state, before `load()`.                                                                                                                  |
| `loading`  | Backend validation call in progress.                                                                                                             |
| `finished` | Terminal — reached regardless of the validation outcome (success, failure, or unavailable for the country). Nothing is surfaced to the end user. |

## See also

- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-home`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-home/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-home.md

# Home Module

<Component slug="web-2-x-implementation-warning" />

The Home module renders the SDK's built-in welcome screen. This is an optional intro screen that runs before a flow starts. Wired automatically by `<incode-flow>` when `enableHome: true`; rarely needed standalone.

> Effectively a [composite / utility module](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules) — the orchestrator drives it as part of the larger flow lifecycle. Ships no user inputs of its own.

## Availability

This module is headless-only — there is no public `<incode-home>` web component. Drive it with `createHomeManager` from `@incodetech/core/home`. Most consumers don't need to: pass `enableHome: true` in `FlowConfig` and `<incode-flow>` mounts the home screen for you.

## Configuration

The module takes no configuration:

```typescript
type HomeConfig = EmptyConfig; // no options
```

## State machine

`HomeState` is minimal:

| Status     | Description                                              |
| ---------- | -------------------------------------------------------- |
| `idle`     | Initial state.                                           |
| `main`     | Home screen visible. User can dismiss to start the flow. |
| `finished` | Terminal — user dismissed; flow continues.               |

## API methods

| Method       | Purpose                                                             | Callable when |
| ------------ | ------------------------------------------------------------------- | ------------- |
| `load()`     | Show the home screen.                                               | `idle`        |
| `complete()` | Dismiss the home screen so the flow starts. Advances to `finished`. | `main`        |

Plus the universal lifecycle: `subscribe`, `getState`.

## See also

- [IncodeFlow Component → enableHome](/sdk-reference/web-sdk-2-incodeflow-component/): the recommended way to use this module
- [Module Patterns → composite](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-id-capture`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-id-capture/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-id-capture.md

# ID Capture Module

<Component slug="web-2-x-implementation-warning" />

The ID Capture module captures front and back images of identity documents (ID cards, passports) with ML-powered quality checks and validation. It also supports digital ID verification through supported device wallets and bank redirects. For implementation details, see [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/) and [Digital ID: Bank Redirect](/sdk-reference/digital-id-redirect).

This module follows the [camera-capture pattern](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules), plus dedicated states for mandatory consent and digital IDs. See the patterns page for the shared lifecycle; the rest of this page covers ID-specific config, capture properties, and methods.

## Tag

`<incode-id>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/id';
import '@incodetech/web/id/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                                   | Required | Description                                |
| ---------- | -------------------------------------- | -------- | ------------------------------------------ |
| `config`   | `IdCaptureConfig`                      | ❌        | Configuration for ID capture behavior      |
| `manager`  | `IdCaptureManager`                     | ❌        | Optional pre-built manager (advanced use)  |
| `onFinish` | `() => void`                           | ❌        | Called when capture completes successfully |
| `onError`  | `(error: string \| undefined) => void` | ❌        | Called when an error occurs                |

## WASM Requirements

The ID Capture module uses WebAssembly for document detection, blur/glare quality checks, and perspective correction. Pre-warm WASM during `setup()` so models are ready before the user reaches the camera step:

```typescript
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
  wasm: { pipelines: ['idCapture'] },
});
```

See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/) for self-hosted paths and the lower-level `warmupWasm()` API.

## Usage

### Vanilla HTML / TypeScript

```html
<incode-id></incode-id>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/id';
  import '@incodetech/web/id/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: 'your-session-token',
    wasm: { pipelines: ['idCapture'] },
  });

  const id = document.querySelector('incode-id');
  id.config = {
    showTutorial: true,
    enableId: true,
    enablePassport: false,
    autoCaptureTimeout: 5,
    captureAttempts: 3,
  };
  id.onFinish = () => console.log('ID captured!');
  id.onError = (err) => console.error('ID error:', err);
</script>
```

### React

**React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it, and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { IdCaptureConfig } from '@incodetech/core/id';
import '@incodetech/web/id';
import '@incodetech/web/id/styles.css';

type IdElement = HTMLElement & {
  config: Partial<IdCaptureConfig>;
  onFinish: () => void;
  onError: (error: string | undefined) => void;
};

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
  wasm: { pipelines: ['idCapture'] },
});

export function IdCapture() {
  const ref = useRef<IdElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = {
      showTutorial: true,
      enableId: true,
      enablePassport: false,
      autoCaptureTimeout: 5,
      captureAttempts: 3,
    };
    el.onFinish = () => console.log('ID captured!');
    el.onError = (err) => console.error('ID error:', err);
  }, []);

  return <incode-id ref={ref} />;
}
```

For Angular (`CUSTOM_ELEMENTS_SCHEMA`) and Vue (`compilerOptions.isCustomElement`) setup, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

## Workflow vs Flow

In a Dashboard-driven Flow (`<incode-flow>` / `createOrchestratedFlowManager`), `ID` is a single step that captures the document **and** runs server-side processing (`/process/id`). This is what `<incode-id>` and `createIdCaptureManager` do by default.

In a server-driven Workflow (`<incode-workflow>` / `createWorkflowManager`), the workflow engine emits ID handling as two distinct nodes:

1. **`ID_CAPTURE`**: runs `idCaptureMachine` for the capture portion only, then advances without calling `/process/id`. Enabled by setting `IdCaptureConfig.skipProcessId = true` (the workflow engine sets this automatically on the `ID_CAPTURE` node's config).
2. **`ID`**: runs the headless `id-verification` module (`@incodetech/core/id-verification`, `createIdVerificationManager`) which invokes `/process/id` on its own. The orchestrator renders the corresponding `<incode-id-verification>` shell while the request is in flight. No UI work needed.`code`

This split lets the Workflow inject custom logic (manual review, retries, branching) between capture and verification. For a single-step capture+verify flow, keep using the standard `<incode-id>` / `createIdCaptureManager` path; `skipProcessId` defaults to `false`, so processing runs inline as before.

The `id-verification` module ships:

- `createIdVerificationManager` from `@incodetech/core/id-verification`: headless manager for the verification half (used by Workflow's `ID` node, also usable headlessly outside Workflow).
- `IdVerificationConfig`: config type for the manager.
- `<incode-id-verification>`: Preact UI shell registered automatically by the orchestrator; no public `@incodetech/web/id-verification` import path, since the orchestrator owns the mount.

### Standalone ID verification

After SDK setup and session activation, `createIdVerificationManager({ config })` can process an ID already captured in that session. An empty `config` uses the first ID.

| `IdVerificationConfig` option | Type | Meaning |
| --- | --- | --- |
| `isSecondId` | `boolean?` | Set `true` to process the second captured ID; default `false`. |
| `idRank` | `'FIRST_ID' \| 'SECOND_ID' \| 'THIRD_ID'` (deprecated) | Workflow-provided rank. `SECOND_ID` also selects the second ID. `THIRD_ID` is deprecated and does not enable third-ID processing. |
| `queueName` | `string?` | Processing queue name; defaults to an empty string. |

Either `isSecondId: true` or `idRank: 'SECOND_ID'` selects the second ID; otherwise the first ID is processed.

| Status | Action |
| --- | --- |
| `idle` | Call `load()` to begin processing. |
| `processing` | Show progress while the request runs. |
| `expired` | Show expiration feedback and call `continue()` on user confirmation. |
| `finished` | Module complete; this does not establish verification approval. |

The state variants carry only `status`. The manager also exposes `subscribe()`, `getState()`, and `stop()`. Unsubscribe and call `stop()` when your host tears down; create a new manager for a new run.

```ts
import { createIdVerificationManager } from '@incodetech/core/id-verification';

// After setup and activation of the session containing the captured ID:
const verification = createIdVerificationManager({ config: {} });
const unsubscribe = verification.subscribe((state) => {
  if (state.status === 'expired') {
    // Show expiration feedback; call verification.continue() on confirmation.
  }
});
verification.load();

function disposeVerification() {
  unsubscribe();
  verification.stop();
}
```

## Headless Mode

For complete UI control, use the `createIdCaptureManager` from `@incodetech/core/id`.

### Quick Start

```tsx
import { setup } from '@incodetech/core';
import { createIdCaptureManager } from '@incodetech/core/id';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';
import { warmupWasm } from '@incodetech/core/wasm';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

await warmupWasm({
  wasmPath: '/wasm/webLib.wasm',
  glueCodePath: '/wasm/webLib.js',
  modelsBasePath: '/wasm/models',
  pipelines: ['idCapture'],
});

const config = await resolveDashboardModuleConfig({ moduleKey: 'ID' });
const manager = createIdCaptureManager({ config });

manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'capture') {
    console.log('Mode:', state.currentMode); // 'front' or 'back'
    console.log('Detection:', state.detectionStatus);
    console.log('Counter:', state.counterValue); // Auto-capture countdown
  }

  if (state.status === 'finished') {
    console.log('ID captured successfully!');
    manager.stop();
  }
});

manager.load();
```

The core factory requires a complete `IdCaptureConfig`. Resolve it from an active Dashboard Flow containing ID, or supply all required fields. UI components accept partial overrides; core factories do not fill them automatically.

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| chooser
    chooser -->|selectDocument| tutorial
    tutorial -->|continueToPermission| permissions
    permissions -->|granted| capture
    capture -->|front done| frontFinished
    frontFinished --> capture
    capture -->|back done| processing
    processing --> finished
```

### States Reference

| Status             | Description                                                                                                                       | Key Properties                                                                  |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `idle`             | Initial state, waiting for `load()`                                                                                               | –                                                                               |
| `chooser`          | Document type selection. `digitalIdRedirectOptions` lists one entry per enabled digital-ID bank-redirect provider (iDIN, FTN, …); render each as its own option. | `availableDocumentTypes`, `digitalIdRedirectOptions`                            |
| `loading`          | Loading configuration or a transient permission/camera phase                                                                      | `phase`, `tutorialEnabled`, `selectedDocumentType`, `currentMode`, `requiresMotionPermissionUserGesture` |
| `tutorial`         | Showing tutorial                                                                                                                  | `phase`, `selectedDocumentType`, `currentMode`, `requiresMotionPermissionUserGesture` |
| `ageVerification`  | Regulation-required age-confirmation gate before capture. Reached when `config.ageAssurance === true`. Advance with `nextStep()`. | –                                                                               |
| `permissions`      | Camera permission handling                                                                                                        | `permissionStatus`, `requiresMotionPermissionUserGesture`                       |
| `capture`          | Active document capture                                                                                                           | `stream`, `currentMode`, `detectionStatus`, `counterValue`, `attemptsRemaining` |
| `frontFinished`    | Front side complete, transitioning to back                                                                                        | –                                                                               |
| `backFinished`     | Back side complete                                                                                                                | –                                                                               |
| `mandatoryConsent` | Regulation-required consent screen                                                                                                | `regulationType` (see [Mandatory Consent](#mandatory-consent-state-properties)) |
| `processing`       | Server-side document processing                                                                                                   | –                                                                               |
| `expiredExhausted` | Expired-document attempts exhausted; await Continue | – |
| `expired`          | Document expired after processing                                                                                                 | –                                                                               |
| `digitalIdUpload`  | Digital ID upload sub-flow — PDF e-IDs uploaded by file picker (see [Digital ID Upload](#digital-id-upload-state-properties))     | full shape below                                                                |
| `digitalIdRedirect` | Digital ID bank-redirect sub-flow — iDIN / FTN full-page redirect and resume (see [Digital ID — Bank Redirect](/sdk-reference/digital-id-redirect/)) | `phase`, `launchUrl`, `failureReason`, `providerId`                             |
| `finished`         | Capture complete                                                                                                                  | –                                                                               |
| `error`            | Fatal error occurred                                                                                                              | `error`                                                                         |
| `closed`           | User closed the flow                                                                                                              | –                                                                               |

### Loading, tutorial, and permission properties

| Property | Type | Available in |
| --- | --- | --- |
| `phase` | `'bootstrapping' \| 'permissionsIdle' \| 'checkingStream' \| 'initializingDeepsight' \| 'initializingCamera'` | `loading` |
| `phase` | `'checkingPermission' \| 'ready' \| 'initializingCamera' \| 'waitingForPermission' \| 'waitingForCamera'` | `tutorial` |
| `selectedDocumentType` | `IdDocumentType \| undefined` | `loading`, `tutorial`, `permissions` |
| `currentMode` | `'front' \| 'back'` | `loading`, `tutorial`, `permissions` |
| `tutorialEnabled` | `boolean` | `loading`, `permissions` |
| `permissionStatus` | `PermissionStatus` | `permissions` |
| `requiresMotionPermissionUserGesture` | `boolean` | `loading`, `tutorial`, `permissions`; start unresolved iOS motion permission from a user gesture with `continueToPermission()` |

Keep the document and side visible while waiting. `permissionsIdle` is a silent permission check; avoid flashing a new full-screen loader. Tutorial `ready` waits for Continue. `waitingForPermission` and `waitingForCamera` mean Continue was already requested; show a waiting state. Treat the other loading phases as preparation without exposing implementation details to the user.

When `status === 'tutorial'`, call `continueToPermission()` directly from the tutorial CTA's tap handler. This preserves the user activation required by the iOS DeviceMotion prompt. The `phase` is `checkingPermission`, `ready`, `initializingCamera`, `waitingForPermission`, or `waitingForCamera`. The state also exposes `selectedDocumentType`, `currentMode`, and `requiresMotionPermissionUserGesture`.

When `status === 'loading'`, the state exposes `phase`, `tutorialEnabled`, `selectedDocumentType`, `currentMode`, and `requiresMotionPermissionUserGesture`. The `phase` is `bootstrapping`, `permissionsIdle`, `checkingStream`, `initializingDeepsight`, or `initializingCamera`. Loading is transient. Use the motion flag to keep custom presentation consistent, not to dispatch another permission action.

### Capture State Properties

When `status === 'capture'`:

| Property             | Type                | Description                                                                                                                                                                                                                    |
| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `captureFeedbackMode` | `'countdown' \| 'optimizing'` | Which capture-feedback presentation to render. |
| `acceptedDocuments` | `string[]?` | Accepted document names returned with `ID_TYPE_UNACCEPTABLE`. Entries are strings; preserve unknown names. Hide the list when absent or empty. |
| `countryCode` | `string?` | Country associated with the upload response, when available. |
| `stream`             | `MediaStream`       | Camera stream for `<video>` element                                                                                                                                                                                            |
| `currentMode`        | `'front' \| 'back'` | Which side is being captured                                                                                                                                                                                                   |
| `captureStatus`      | `string`            | `'initializing'`, `'detecting'`, `'capturing'`, `'optimizing'`, `'uploading'`, `'uploadError'`, `'success'`. `optimizing` appears only when you opt in — see [Capture result preview](#capture-result-preview)                 |
| `detectionStatus`    | `string`            | Document detection feedback                                                                                                                                                                                                    |
| `counterValue`       | `number`            | Auto-capture countdown (seconds)                                                                                                                                                                                               |
| `countdownStepMs`    | `number`            | Milliseconds between `counterValue` steps (3 → 2 → 1 → 0). Lets you animate the whole countdown from its first value                                                                                                           |
| `attemptsRemaining`  | `number`            | Remaining capture attempts                                                                                                                                                                                                     |
| `uploadError`        | `string?`           | Error code if upload failed                                                                                                                                                                                                    |
| `uploadErrorMessage` | `string?`           | Human-readable error                                                                                                                                                                                                           |
| `needsBackCapture`   | `boolean`           | Whether back capture is needed                                                                                                                                                                                                 |
| `usingBackCamera` | `boolean` | Whether the active stream uses a rear camera. Mirror a front-camera preview; leave the rear-camera preview unmirrored. |
| `barcodeFastPathCaptured` | `boolean` | Render barcode-capture success without a captured-image preview when `true`. |
| `needsFrontCapture` | `boolean` | A front-side capture is required after the back. Use `continueToFront()` when the completed capture awaits that follow-up. |
| `idType` | `string \| undefined` | Detected document type, when available. |
| `canRetry`           | `boolean`           | Whether retry is available                                                                                                                                                                                                     |
| `previewImageUrl`    | `string?`           | Captured image preview URL                                                                                                                                                                                                     |
| `candidateImageUrl` | `string?`        | Best frame found so far, during `optimizing` only. Display-only — see [Capture result preview](#capture-result-preview)                                                                                                            |
| `optimizingDwellMs`     | `number?`        | How long the SDK holds the preview. A minimum, not an exact duration — see [Capture result preview](#capture-result-preview)                                                                                                   |

### Mandatory Consent State Properties

When `status === 'mandatoryConsent'`:

| Property         | Type              | Description                                                                        |
| ---------------- | ----------------- | ---------------------------------------------------------------------------------- |
| `regulationType` | `RegulationTypes` | Which regional regulation triggered the consent screen. Used to pick consent copy. |

`RegulationTypes` is a string union:

```typescript
type RegulationTypes =
  | 'US'
  | 'Worldwide'
  | 'Other'
  | 'US_Illinois'
  | 'US_Texas'
  | 'US_California'
  | 'US_Washington';
```

`'Other'` is the fallback the SDK uses when the upload response doesn't pin a specific regulation. Drive your consent copy off this value.

Drive the screen with `acceptMandatoryConsent()` (proceed) or `cancelMandatoryConsent()` (abort the flow).

### Digital ID Upload State Properties

When `status === 'digitalIdUpload'`. Reached when the backend allows uploading a digital ID (typically an EU eID or similar government-issued PDF) instead of capturing a physical document. The sub-flow walks the user through a tutorial → file picker → preview → upload → success/failure cycle with a bounded retry budget (3 attempts).

| Property            | Type                              | Description                                                                                                                                                                                                                                 |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phase`             | union                             | `'tutorial'`, `'selecting'`, `'reviewing'`, `'uploading'`, `'holding'`, `'success'`, `'error'`, `'fileTooLarge'`, `'exhausted'`. `'holding'` is a brief stabilization step shown while the upload finishes; treat as `'uploading'` UI-wise. |
| `file`              | `File \| null`                    | The PDF the user picked (`null` outside `'reviewing'` / `'uploading'` / `'holding'`).                                                                                                                                                       |
| `fileName`          | `string \| undefined`             | The file's display name. Use this to render the preview row.                                                                                                                                                                                |
| `failReason`        | `DigitalUploadFailReason \| null` | Set when `phase === 'error'`. Union: `'DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED'`, `'ID_TYPE_UNACCEPTABLE'`, `'FILE_CHANGED_ERROR'`, `'INVALID_FILE_TYPE'`, `'NETWORK_ERROR'`, `'GENERIC'`.                                                  |
| `attemptsRemaining` | `number`                          | Remaining upload retries (starts at 3). Hits 0 → `phase === 'exhausted'`.                                                                                                                                                                   |
| `uploadProgress`    | `number`                          | Upload progress 0–100. Only meaningful in `'uploading'` / `'holding'`.                                                                                                                                                                      |
| `pickerRequestId`   | `number`                          | Monotonic counter — increments each time the SDK wants the host UI to open the file picker. Watch for changes and trigger your `<input type="file">` programmatically (the SDK never opens it itself).                                      |

**Accepted files.** PDF only (`application/pdf`), 5 MB maximum.

**Phase progression.** `tutorial` → `selecting` (host opens picker on each `pickerRequestId` change) → `reviewing` (user confirms or replaces) → `uploading` → `success` (auto-advances out of the sub-flow) or `error` → back to `selecting`, until `attemptsRemaining === 0` → `exhausted`. `fileTooLarge` is shown immediately when the user picks an oversized file and does not consume a retry.

Drive the screen with `digitalUploadNextStep()`, `digitalUploadPickFile(file)`, `digitalUploadConfirm()`, `digitalUploadReplace()`, `digitalUploadRetry()`, `digitalUploadChooseAnother()`, and `digitalUploadScanInstead()` (falls back to live capture when allowed).

### Digital ID Redirect State Properties

Digital methods must be [enabled in Dashboard](/dashboard-platform-administration/id-capture-dashboard/#configuration-options) and supported by the current device. Render options from `chooser.availableDocumentTypes`; do not offer an unavailable wallet route.

| Status | Property | Type / behavior |
| --- | --- | --- |
| `digitalIdRedirect` | `phase` | `'loading' \| 'redirecting' \| 'success' \| 'failed' \| 'error'` |
| `digitalIdRedirect` | `launchUrl` | `string \| undefined`; navigate only when `phase === 'redirecting'` and a URL is present. |
| `digitalIdRedirect` | `failureReason`, `providerId` | Optional public failure/provider identifiers. See [Bank Redirect](/sdk-reference/digital-id-redirect/#failure-handling). |

### Device Wallet State Properties

When `status === 'deviceWallet'`. Reached when the user picks the wallet tile (`selectDocument('digitalId')`). The SDK fetches a wallet request, opens the OS wallet sheet, and forwards the encrypted response to Incode. See [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/) for prerequisites, supported wallets, and the standalone `renderWallet()` API.

| Property     | Type                                                        | Description                                                                                                        |
| ------------ | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `phase`      | `'requesting' \| 'presenting' \| 'decrypting' \| 'failed'` | `'requesting'` and `'decrypting'` are loading steps. `'presenting'` means the OS wallet sheet is open. `'failed'` is recoverable. |
| `failReason` | `DeviceWalletFailReason \| null`                            | Set when `phase === 'failed'`: `'UNSUPPORTED_PLATFORM'`, `'NO_CREDENTIAL'`, or `'WALLET_ERROR'`.                   |
| `platform`   | `'ios' \| 'android' \| undefined`                           | Wallet backend: `'ios'` for Apple Wallet, `'android'` for Google Wallet.                                           |

**User activation.** Call `selectDocument('digitalId')` inside your tap handler. Browsers open the wallet sheet only during the tap's user activation.

**Outcome.** A completed handshake moves to `finished` with no document upload — a `'REJECTED'` decision finishes too. Verified attributes, including the mDL portrait, land on the session, so Face Match still runs downstream. On `'failed'`, call `deviceWalletRetry()` from a new tap, or `deviceWalletUseAnotherMethod()` to return to the chooser (or reach `closed` when there is no chooser).

### Expired-document recovery

`expired` exposes `attemptsRemaining` and `currentMode`. Once attempts are exhausted, render `expiredExhausted` with a Continue action calling `continueExhausted()`. The configured journey determines whether the SDK captures another side, completes processing, or finishes this module. Continue does not establish an approved verification; use the session result.

### Detection Status Values

| Status          | User Instruction                |
| --------------- | ------------------------------- |
| `idle`          | "Preparing camera..."           |
| `idNotDetected` | "Position your ID in the frame" |
| `detecting`     | "Hold steady..."                |
| `farAway`       | "Move closer"                   |
| `blur`          | "Hold still, image is blurry"   |
| `glare`         | "Adjust angle to reduce glare"  |
| `wrongSide`     | "Please show the other side"    |
| `capturing`     | "Capturing..."                  |
| `manualCapture` | "Tap to capture"                |
| `offline`       | "No network connection"         |

### API Methods

For an ID tutorial CTA, call `continueToPermission()` directly from the tap handler. You can call it unconditionally: it requests iOS motion only when `requiresMotionPermissionUserGesture` is `true`, then enters camera permission orchestration. `nextStep()` retains the legacy tutorial behavior, including motion priming when camera permission is already granted. Do not defer a gesture-dependent call through an effect or timer.

| Method                               | Description                                                       | When to Use                                                  |
| ------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `continueExhausted()` | Continue after expired-document attempts are exhausted | `expiredExhausted` |
| `digitalIdRedirectRetry()` | Restart redirect verification | `digitalIdRedirect`, `failed` or `error` phase |
| `digitalIdRedirectUseAnotherMethod()` | Leave the redirect and use configured fallback | `digitalIdRedirect`, `failed` or `error` phase |
| `digitalIdRedirectContinue()` | Acknowledge the redirect success screen | `digitalIdRedirect`, `success` phase |
| `digitalIdRedirectRefresh()` | Refresh the pending launch URL | `digitalIdRedirect`, `redirecting` phase |
| `load()`                             | Starts the ID capture flow                                        | Always call first                                            |
| `selectDocument(type, options?)`     | Selects a type from `availableDocumentTypes` (`'id'`, `'passport'`, `'digitalId'`, …). For `'digitalIdRedirect'`, pass `{ providerId }` from `digitalIdRedirectOptions` to launch that provider; omitted, the first configured method is used. | When `chooser`. Call it inside the tap handler for `'digitalId'` |
| `nextStep()`                         | Advances through the legacy tutorial path                         | When `tutorial`                                              |
| `requestPermission(options?)`        | Requests camera access. Pass `{ trigger: 'automatic' }` when code, not a user action, initiates it, so it is not reported as a click | When `permissions.idle`                                      |
| `continueToPermission()`             | Starts gesture-aware permission entry and requests unresolved iOS motion permission first | Directly from the ID tutorial CTA                            |
| `goToLearnMore()`                    | Shows permission help                                             | When `permissions.idle`                                      |
| `back()`                             | Goes back from learn more                                         | When `permissions.learnMore`                                 |
| `capture()`                          | Manual capture trigger                                            | When `detectionStatus === 'manualCapture'`                   |
| `switchToManualCapture()`            | Switch from auto to manual mode                                   | During auto-capture                                          |
| `switchToAutoCapture()` | Restart automatic capture on the same side without consuming a retry | When `detectionStatus === 'manualCapture'`, before taking the photo |
| `openHelp()` | Pause detection and keep the camera stream open; returns `true` if Help opened, or `false` if capture has advanced | During live automatic or manual capture; display Help only when this returns `true` |
| `closeHelp()` | Resume capture in the current mode; automatic capture receives a fresh timeout | After `openHelp()`, when Help is dismissed |
| `retryCapture()`                     | Retry after upload error                                          | When `canRetry` is true                                      |
| `continueFromError()`                | Continue after non-fatal error                                    | When error allows continuation                               |
| `continueToBack()`                   | Proceed to back capture                                           | When `frontFinished`                                         |
| `continueToFront()`                  | Flip back to front capture                                        | When `backFinished`                                          |
| `skipBack()`                         | Skip back capture                                                 | When back is optional                                        |
| `acceptMandatoryConsent()`           | Accept the regulation-required consent                            | When `mandatoryConsent`                                      |
| `cancelMandatoryConsent()`           | Decline the regulation-required consent                           | When `mandatoryConsent`                                      |
| `digitalUploadNextStep()`            | Advance from the digital-upload tutorial to the picker            | When `digitalIdUpload` and `phase === 'tutorial'`            |
| `digitalUploadPickFile(file)`        | Hand a picked PDF to the SDK for review                           | When `digitalIdUpload` and `phase === 'selecting'`           |
| `digitalUploadConfirm()`             | Confirm the previewed file and start uploading                    | When `digitalIdUpload` and `phase === 'reviewing'`           |
| `digitalUploadReplace()`             | Discard the previewed file and re-open the picker                 | When `digitalIdUpload` and `phase === 'reviewing'`           |
| `digitalUploadRetry()`               | Retry after an upload error (consumes one of `attemptsRemaining`) | When `digitalIdUpload` and `phase === 'error'`               |
| `digitalUploadChooseAnother()`       | Pick a different file after `fileTooLarge`                        | When `digitalIdUpload` and `phase === 'fileTooLarge'`        |
| `digitalUploadScanInstead()`         | Abandon digital upload and fall back to live capture              | When `digitalIdUpload` (any phase, if allowed by config)     |
| `deviceWalletRetry()`                | Restart a failed wallet handshake. Call it from a user gesture    | When `deviceWallet` and `phase === 'failed'`                 |
| `deviceWalletUseAnotherMethod()`     | Leave the wallet and return to the chooser (or close)             | When `deviceWallet` and `phase === 'failed'`                 |
| `updateDetectionArea(area)`          | Update detection bounds                                           | On resize/orientation change                                 |
| `close()`                            | Close the flow                                                    | Anytime                                                      |
| `reset()`                            | Reset to initial state                                            | In `error`; create a new manager after `finished`                                  |
| `stop()`                             | Cleanup resources                                                 | When unmounting                                              |
| `getState()`                         | Returns current state                                             | Anytime                                                      |
| `subscribe(callback)`                | Subscribe to state changes                                        | Returns unsubscribe function                                 |

### React Example

```tsx
import { useState, useEffect, useRef } from 'react';
import {
  createIdCaptureManager,
  type IdCaptureState,
  type IdCaptureConfig,
} from '@incodetech/core/id';

function CustomIdCapture({ config }: { config: IdCaptureConfig }) {
  const videoRef = useRef<HTMLVideoElement>(null);
  const [manager] = useState(() =>
    createIdCaptureManager({
      config,
    }),
  );
  const [state, setState] = useState<IdCaptureState>({ status: 'idle' });

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  useEffect(() => {
    if (state.status === 'capture' && state.stream && videoRef.current) {
      videoRef.current.srcObject = state.stream;
    }
  }, [state]);

  switch (state.status) {
    case 'chooser':
      return (
        <div>
          <button onClick={() => manager.selectDocument('id')}>ID Card</button>
          <button onClick={() => manager.selectDocument('passport')}>
            Passport
          </button>
          {state.digitalIdRedirectOptions.map((option) => (
            <button
              key={option.providerId}
              onClick={() =>
                manager.selectDocument('digitalIdRedirect', {
                  providerId: option.providerId,
                })
              }
            >
              {option.displayName ?? option.providerId}
            </button>
          ))}
        </div>
      );

    case 'permissions':
      return (
        <div>
          <p>Camera access is required</p>
          <button onClick={() => manager.requestPermission()}>
            Allow Camera
          </button>
        </div>
      );

    case 'capture':
      return (
        <div>
          <video ref={videoRef} autoPlay playsInline muted />
          <p>Capturing: {state.currentMode} side</p>
          <p>{state.detectionStatus}</p>
          {state.captureStatus === 'detecting' && (
            <p>Auto-capture in: {state.counterValue}s</p>
          )}
          {state.detectionStatus === 'manualCapture' && (
            <button onClick={() => manager.capture()}>Capture</button>
          )}
          {state.captureStatus === 'uploadError' && state.canRetry && (
            <button onClick={() => manager.retryCapture()}>Retry</button>
          )}
        </div>
      );

    case 'finished':
      return <div>✅ ID captured successfully!</div>;

    case 'error':
      return <div>Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}
```

### Capture-only flow

`createIdCaptureOnlyManager` exposes the same state machine and API surface as `createIdCaptureManager`, but bypasses the Incode upload pipeline. Instead of submitting the captured frames to Incode and waiting on server-side processing, the manager invokes a customer-supplied `onCapture(response)` callback with the captured images and reaches `finished` locally. Use this when you want to capture in the browser but upload (or process) the bytes through your own pipeline.

The config contains supported optional capture UX fields plus a required `onCapture` callback. It is a subset of `IdCaptureConfig`, not the full Dashboard configuration:

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import {
  createIdCaptureOnlyManager,
  type IdCaptureOnlyConfig,
  type CaptureOnlyResponse,
} from '@incodetech/core/id';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['idCapture'] },
});
await initializeSession({ token: 'your-session-token' });

const config: IdCaptureOnlyConfig = {
  showTutorial: true,
  enableId: true,
  enablePassport: false,
  autoCaptureTimeout: 5,
  captureAttempts: 3,
  onCapture: async (response: CaptureOnlyResponse) => {
    // response.frontImage: IdCapturedImageData | undefined (undefined if onlyBack)
    // response.backImage: IdCapturedImageData | undefined (undefined if onlyFront)
    await uploadToMyBackend(
      response.frontImage?.blob,
      response.backImage?.blob,
    );
  },
};

const manager = createIdCaptureOnlyManager({ config });
manager.subscribe((state) => {
  if (state.status === 'finished') manager.stop();
});
manager.load();
```

The `CaptureOnlyResponse` payload is:

```typescript
// `frontImage` is undefined only for a back-only capture (`onlyBack: true`).
type CaptureOnlyResponse =
  | { frontImage: IdCapturedImageData; backImage: IdCapturedImageData | undefined }
  | { frontImage: undefined; backImage: IdCapturedImageData };

type IdCapturedImageData = {
  imageBase64: string; // Always present — the unprocessed full frame
  blob: Blob; // Same content as Blob
  url: string; // Object-URL for direct rendering
  metadata: string; // Capture metadata (serialized)
  croppedImage?: {
    // Best-effort document crop (see caveat below)
    imageBase64: string;
    blob: Blob;
    url: string;
  };
};
```

**About **`croppedImage`**.** This is a _best-effort_ approximate crop produced by a bilinear quad mapping — **not** a true perspective/homography warp. It is populated only when on-device quad detection succeeds, and it will visibly diverge from the correct projective result for strongly tilted captures. Prefer `imageBase64` (the unprocessed full frame) when fidelity matters; treat `croppedImage` as a preview hint.

`createIdCaptureOnlyManagerFromActor` is also exported for advanced cases where you supply a pre-built XState actor (e.g. to swap services in tests).

## Configuration Options

`IdCaptureConfig` is `TutorialIdConfig & { ...extras }` — `TutorialIdConfig` is the Dashboard-driven shape (almost all fields are required), and the extras are advanced overrides.

**Orchestrated vs headless:** `<incode-flow>` and `createOrchestratedFlowManager` supply the complete Dashboard configuration. `createIdCaptureManager({ config })` also requires a complete configuration. The standalone `<incode-id>.config` property accepts partial overrides and resolves remaining Dashboard fields when configuration merging is enabled (the default).

### Document selection

| Option                      | Type      | Required | Description                                   |
| --------------------------- | --------- | -------- | --------------------------------------------- |
| `enableId`                  | `boolean` | ✅        | Enable ID-card capture                        |
| `enablePassport`            | `boolean` | ✅        | Enable passport capture                       |
| `deviceWallet`              | `boolean` | ✅       | Enable the device-wallet (mDL) flow — Apple Wallet (web) / Google Wallet. A wallet method enabled in `digitalIds` also turns it on. See [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/) |
| `digitalIdsUpload`          | `boolean` | ✅        | Allow uploading digital IDs as an alternative |
| `showDocumentChooserScreen` | `boolean` | ✅        | Render the document-type chooser screen       |

### Digital ID configuration

| Option | Type | Required | Description |
| --- | --- | --- | --- |
| `digitalIds` | `IdCaptureDigitalIdMethod[]` | No | Resolved Dashboard methods. Redirect entries use `REDIRECT` or `WEB_REDIRECT` flow types. An absent or empty list offers no redirect option. |
| `digitalIdReturnUrl` | `string` | No | Registered HTTPS return page for bank verification. |
| `digitalIdReturn` | `{ returnParams: RedirectReturnParams }` | No | Pass only when resuming the return leg. |

Import these types from `@incodetech/core/id`. A method has required `provider` and `flowType`, plus optional `method`, `country`, and `displayName`. Use the Dashboard-resolved configuration for your provisioned methods. See [Bank Redirect](/sdk-reference/digital-id-redirect/) for return-route wiring.

### Capture behavior

| Option                    | Type      | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `showTutorial`            | `boolean` | ✅        | Show tutorial before capture                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `onlyFront`               | `boolean` | ✅        | Declares that the document is one-sided (like a passport). Forwarded to the front-upload endpoint as the [`onlyFront`](/api-reference/add-front-id-v2/) query param. **Not a client-side override:** the server weighs it against its own classification of the uploaded image and answers with `skipBackIdCapture`, so a genuinely two-sided document will still ask for the back — passports included, since they are not always single-sided. For guaranteed front-only capture, [configure it on Dashboard](/dashboard-platform-administration/id-capture-dashboard/#configuration-options). Deliberately not symmetric with `onlyBack`, which is honored client-side. |
| `onlyBack`                | `boolean` | ✅        | Capture the back side only. The document chooser is skipped and capture starts on the back side.                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `barcodeCapture`          | `boolean` | ✅        | Use barcode scanning when applicable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `fetchAdditionalPage`     | `boolean` | ✅        | Capture an additional page after the main scan                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `autoCaptureTimeout`      | `number`  | ✅        | Seconds before auto-capture triggers                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `deviceIdleTimeout`       | `number`  | ✅        | Seconds of device idleness before timing out                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `captureAttempts`         | `number`  | ✅        | Maximum retry attempts                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `enableIdRecording`       | `boolean` | ✅        | Enable client-side front/back video recording streamed through multipart upload                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `usSmartCapture`          | `boolean` | ✅        | US-specific smart-capture mode                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `secondId`                | `boolean` | ✅        | Capture a second ID document after the first                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `showCaptureButtonInAuto` | `boolean` | ❌        | Show a manual capture button during auto-capture                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `alwaysCaptureBackOfId`   | `boolean` | ❌        | Always capture the back of the ID, even when the front response would normally skip it                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `extractIdFace`           | `boolean` | ❌        | Set `false` to skip biometric face extraction from the ID: no biometric template is created for the session. Use it in jurisdictions with biometric-consent restrictions. Face match is then unavailable for that session. Omit or set `true` to keep the default behavior.                                                                                                                                                                                                                                                                                                                                              |

### Per-country / per-document overrides

| Option                      | Type   | Required | Description                                                                                                                                                                                                                                             |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `perCountryPerDocOverrides` | object | ✅        | Nested map keyed by country code → document type → `{ onlyFront, onlyBack, fetchAdditionalPage }`. **Not read by the SDK** — per-document capture policy is resolved server-side and returned as `skipBackIdCapture` on the upload response. Pass `{}`. |

### Extras (from `IdCaptureConfig` beyond `TutorialIdConfig`)

| Option                         | Type      | Required  | Description                                                                                                     |
| ------------------------------ | --------- | --------- | --------------------------------------------------------------------------------------------------------------- |
| `ageAssurance`                 | `boolean` | ❌        | Enable age assurance features                                                                                   |
| `mergeSessionRecordings`       | `boolean` | ❌        | Merge per-step recordings into a single session-level recording                                                 |
| `isDeepsightEnabled`           | `boolean` | ❌        | Override Deepsight enablement (otherwise driven by the session)                                                 |
| `supportsOptimizingStatus`     | `boolean` | ❌        | Opt into the mid-capture result preview — see [Capture result preview](#capture-result-preview) below. |

### Capture result preview

The built-in `<incode-id>` component reassures the user mid-capture: partway through the frame-selection window it flashes and freezes the best frame found so far under a "Successfully captured" heading, while the camera and frame analysis keep running. If the user keeps holding the document steady, the frame that actually uploads may be a better one than the one they were shown. Headless integrations skip that preview by default.

To render your own version of it, create the manager with `supportsOptimizingStatus: true`. `captureStatus` then reaches `optimizing` partway through capture, carrying the best-frame-so-far on `candidateImageUrl`, and leaves it on its own once the frame is committed — at which point `previewImageUrl` carries the frame that will upload.

Read `state.candidateImageUrl ?? state.previewImageUrl`, not `candidateImageUrl` alone: on manual capture (the user taps the button) the preview runs *after* the frame is committed, so only `previewImageUrl` is set and a host reading just `candidateImageUrl` renders nothing. See [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/#optional-result-preview-capturestatus-optimizing) for the per-path table.

```ts
const manager = createIdCaptureManager({
  config: { ...idConfig, supportsOptimizingStatus: true },
});

manager.subscribe((state) => {
  if (state.status === 'capture' && state.captureStatus === 'optimizing') {
    // Covers both paths: automatic capture sets `candidateImageUrl`,
    // manual capture only `previewImageUrl`. On the automatic path the image is
    // display-only — detection is still running and may find a better frame.
    showPreview(state.candidateImageUrl ?? state.previewImageUrl);
  }
});
```

`optimizingDwellMs` reports how long the SDK holds the preview. Treat it as a **minimum**: the SDK runs the dwell on its own timer on both paths, and on automatic capture the state additionally waits for the frame-selection loop to commit a frame, which can take slightly longer. React to `captureStatus` leaving `optimizing` rather than assuming an exact duration.

Nothing waits on you: the SDK bounds the state itself, so there is no callback to fire. Your integration should still handle the direct capture-to-upload path, because the preview does not appear on every session. Pass `false` to opt out explicitly. See [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/#optional-result-preview-capturestatus-optimizing) for the full walkthrough.

`IdCaptureConfig` also exposes a few advanced fields reserved for Incode-internal tooling. They aren't part of the public integration surface and aren't documented here.

## Error Codes

| Code                               | Description                                 | User Action               |
| ---------------------------------- | ------------------------------------------- | ------------------------- |
| `UPLOAD_ERROR`                     | Upload failed                               | Retry capture             |
| `CLASSIFICATION_FAILED`            | Document not recognized                     | Use clearer image         |
| `LOW_SHARPNESS`                    | Image too blurry                            | Hold device steadier      |
| `GLARE_DETECTED`                   | Glare on document                           | Adjust lighting           |
| `WRONG_DOCUMENT_SIDE`              | Wrong side shown                            | Flip document             |
| `ID_TYPE_UNACCEPTABLE`             | Document not supported                      | Use different ID          |
| `READABILITY_ISSUE`                | Cannot read document fields                 | Improve lighting or angle |
| `RETRY_EXHAUSTED_CONTINUE_TO_BACK` | Front retries exhausted; proceeding to back | Auto-advances             |
| `RETRY_EXHAUSTED_SKIP_BACK`        | Back retries exhausted; skipping back       | Auto-advances             |
| `NO_MORE_TRIES`                    | Max attempts reached                        | Flow ends                 |
| `UNEXPECTED_ERROR`                 | Unexpected internal error                   | Retry or contact support  |
| `NO_TOKEN`                         | Session token missing                       | Re-initialize SDK         |
| `PERMISSION_DENIED`                | Camera access denied                        | Enable in settings        |
| `USER_CANCELLED`                   | User cancelled the flow                     | Re-open module            |
| `SERVER_ERROR`                     | Server-side error                           | Retry later               |

## Examples

Each example shows a config object you can assign to `<incode-id>.config` (or pass through your framework's property binding). Plug it into the React or vanilla pattern shown in [Usage](#usage).

### ID Card Only

```ts
const config: Partial<IdCaptureConfig> = {
  enableId: true,
  enablePassport: false,
  showTutorial: true,
  autoCaptureTimeout: 5,
};
```

### Passport Only

```ts
const config: Partial<IdCaptureConfig> = {
  enableId: false,
  enablePassport: true,
  showTutorial: false,
};
```

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Complete headless API reference
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): Setting up WebAssembly
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Overview of all modules

---

- Path: `sdk-reference/web-sdk-2-module-id-ocr`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-id-ocr/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-id-ocr.md

# ID OCR Module

<Component slug="web-2-x-implementation-warning" />

The ID OCR module extracts structured data (name, address, document number, dates, etc.) from a captured ID image. Typically runs after [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules), with an additional `readonly` state when `editableOcr` is `false` (display extracted data without letting the user edit).

## Availability

This module is headless-only; there is no public `<incode-id-ocr>` web component. Drive it with `createIdOcrManager` from `@incodetech/core/id-ocr` and render your own UI (form fields, validation messages, etc.).

## Configuration

```typescript
type IdOcrConfig = {
  editableOcr?: boolean; // Allow user to edit OCR data (default: false)
  cpfOnly?: boolean; // Show and validate only the CPF document number field
  secondId?: boolean; // After first ID OCR step, load second captured ID's OCR (orchestrated flow only)
  flowId?: string; // Session flow ID; when listed in CPFFlowIds, only the CPF field is shown
};
```

| Option        | Type      | Required | Description                                                                                 |
| ------------- | --------- | -------- | ------------------------------------------------------------------------------------------- |
| `editableOcr` | `boolean` | ❌       | When `true`, the user can edit extracted fields before submitting. Default `false`.         |
| `cpfOnly`     | `boolean` | ❌       | When `true`, only the CPF document number field is shown and CPF validation is applied.     |
| `secondId`    | `boolean` | ❌       | Used in orchestrated flows when a second ID was captured. Loads OCR for that document next. |
| `flowId`      | `string`  | ❌       | Set by the orchestrator. CPF flows render only the CPF field; otherwise full OCR fields.    |

When `<incode-flow>` receives `useCPF: true`, it keeps the dashboard's `ID_OCR` step and configuration, then adds `cpfOnly: true`. The module continues to use the standard ID OCR lifecycle: `editableOcr` is respected, edited values are sent to the editable OCR endpoint, and values are not automatically formatted or submitted.

## State machine

`IdOcrState` is a discriminated union over `status`:

| Status       | Description                                                                                      |
| ------------ | ------------------------------------------------------------------------------------------------ |
| `idle`       | Initial state.                                                                                   |
| `loading`    | Fetching OCR data from the backend.                                                              |
| `readonly`   | Display extracted data; no edits allowed (`editableOcr === false`). User can confirm to advance. |
| `inputting`  | Editable form rendered. User can edit fields and validate.                                       |
| `submitting` | Sending the (possibly edited) data back to the backend.                                          |
| `success`    | Server accepted the submission.                                                                  |
| `finished`   | Terminal — the module is done.                                                                   |
| `error`      | Fatal error.                                                                                     |

### State properties

| Property | Type | Available in | Description |
| --- | --- | --- | --- |
| `formData` | `UpdateOcrDataParams` | `readonly`, `inputting` | Extracted values for display or editing. |
| `editedFields` | `UpdateOcrDataParams` | `inputting` | User edits to the extracted values. |
| `editableOcr` | `boolean` | `readonly`, `inputting` | Whether editing is configured. |
| `ocrDocument` | `'first' \| 'second'` | `loading`, `readonly`, `inputting`, `submitting` | Which captured document supplies the data. |
| `validationErrors` | `Partial<Record<keyof UpdateOcrDataParams, string>>?` | `inputting` | Field-specific translation keys. |

Narrow `IdOcrState` before reading these properties. `submitting` exposes `ocrDocument`, not the form values. Start from `formData` when rendering prefilled OCR information and send changes through `setField()`.

## Field descriptors

The manager exposes the fields it wants rendered as `OcrFieldConfig[]`, so a headless host can build the form without hard-coding a field list:

```typescript
type OcrFieldConfig = {
  key: keyof UpdateOcrDataParams;
  labelKey: string;
  type: 'text' | 'date' | 'radio';
  options?: { label: string; value: string }[];
  validation?: ValidationRule[];
  required: boolean;
};
```

| Property     | Type                                  | Description                                                                              |
| ------------ | ------------------------------------- | ---------------------------------------------------------------------------------------- |
| `key`        | `keyof UpdateOcrDataParams`           | The OCR field this descriptor drives. Pass it to `setField()` and `validateField()`.     |
| `labelKey`   | `string`                              | Translation key for the field's label. Resolve it through your i18n setup rather than displaying it directly. |
| `type`       | `'text' \| 'date' \| 'radio'`         | Which control to render.                                                                 |
| `options`    | `{ label: string; value: string }[]?` | Choices for a `radio` field.                                                             |
| `validation` | `ValidationRule[]?`                   | Rules `validateField()` applies to this field.                                           |
| `required`   | `boolean`                             | Whether the field must have a value before submitting.                                   |

`OcrFieldConfig`, `UpdateOcrDataParams`, and `ValidationRule` are exported from `@incodetech/core/id-ocr`.

## API methods

| Method                   | Purpose                                                                         |
| ------------------------ | ------------------------------------------------------------------------------- |
| `load()`                 | Fetch the OCR data and transition to `readonly` or `inputting`.                 |
| `setField(field, value)` | Update a field while in `inputting`. `field` is a key of `UpdateOcrDataParams`. |
| `validateField(field)`   | Run validation (required, minimum age, CPF format) on a single field.           |
| `continue()`             | Confirm and submit. Transitions to `submitting`.                                |
| `retry()`                | After `error`, restart the OCR fetch.                                           |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

## Headless example

```typescript
import { createIdOcrManager } from '@incodetech/core/id-ocr';

const manager = createIdOcrManager({
  config: { editableOcr: true },
});

manager.subscribe((state) => {
  switch (state.status) {
    case 'readonly':
      // Render state.formData read-only with a "Confirm" button → manager.continue()
      break;
    case 'inputting':
      // Render editable form. On change: manager.setField('firstName', value)
      // On submit: manager.continue()
      // state.validationErrors lists per-field error keys
      break;
    case 'finished':
      manager.stop();
      break;
  }
});

manager.load();
```

## See also

- [Module: ID Capture](/sdk-reference/web-sdk-2-module-id-capture/): typically runs before this module
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-identity-reuse`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-identity-reuse/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-identity-reuse.md

# Identity Reuse Module

<Component slug="web-2-x-implementation-warning" />

The Identity Reuse module offers a returning user the identity documents they already verified with partner organizations, so they can reuse one instead of capturing a fresh ID and selfie.

The built-in UI lists each document as a card, with the first one tagged **Recommended**, followed by a **Scan a new document** card. Tapping a card submits that choice immediately. The screen also opens a **What data will be shared?** sheet and links to Incode's Privacy Policy. When the backend provides it, the name of the organization receiving the document appears in the copy.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) with a selection state. Picking a document submits it in one step. See the patterns page for the shared lifecycle.

## Tag

`<incode-identity-reuse>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/identity-reuse';
import '@incodetech/web/identity-reuse/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                                |
| ---------- | ------------------------- | -------- | ------------------------------------------ |
| `config`   | `IdentityReuseConfig`     | ❌       | No options                                 |
| `onFinish` | `() => void`              | ❌       | Called when the user's choice is submitted |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs                |

## Configuration

The module takes no configuration:

```typescript
type IdentityReuseConfig = {};
```

Which prior documents are offered is configured server-side.

## State machine

`IdentityReuseState` is a discriminated union over `status`. The selection state (`documentsFound`) is unique to this module:

| Status           | Description                                                                                                                                                        |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `idle`           | Initial state, waiting for `load()`.                                                                                                                               |
| `loading`        | Fetching reusable documents and the receiving organization's name in parallel. The name lookup can't keep this state going past one second after loading starts. |
| `documentsFound` | Documents are available; picking one submits it.                                                                                                                   |
| `submitting`     | Submitting the chosen document for reuse.                                                                                                                          |
| `finished`       | Terminal.                                                                                                                                                          |
| `error`          | Recoverable error; the user can retry or skip. Carries `error`.                                                                                                    |

When `status === 'documentsFound'`:

| Property             | Type                              | Description                                                                                                                   |
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `documents`          | `ReusableDocument[]`              | Ordered documents; index `0` is the best match. Render the first entry as recommended — position is the only signal.          |
| `selectedDocumentId` | `SelectedDocumentId \| undefined` | The current selection, or `'scanNew'` when the user chose to scan a new document. Populated with `documents[0].id` on entry.  |
| `companyName`        | `string` (optional)               | Name of the organization receiving the reused document. Absent when the backend doesn't provide one. Use it in your own copy. |

Each `ReusableDocument` carries `id`, `documentType` (camelCase, for example `driversLicense`), `maskedNumber` (for example `00*****29`), `countryCode` (ISO 3166-1 alpha-3), and `verifiedAt` (Unix epoch in seconds). Format `countryCode` and `verifiedAt` in your own UI — the module passes both through unchanged.

## API methods

| Method                       | Purpose                                                                                                                                                                                                                     |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `load()`                     | Fetch reusable documents. Moves `idle` → `loading`.                                                                                                                                                                         |
| `chooseDocument(documentId)` | Select a document by `id` or pass the `SCAN_NEW_DOCUMENT` sentinel (`'scanNew'`) without submitting. Only needed for two-step UIs. Ids that aren't among `documents` are ignored.                                         |
| `submit(documentId?)`        | Submit a document for reuse. Pass an `id` or `SCAN_NEW_DOCUMENT` to select and submit in one call. Omit it to submit the current selection. Ids that aren't among `documents` are ignored. |
| `skip()`                     | Skip identity reuse entirely and finish the module.                                                                                                                                                                         |
| `retry()`                    | Reload documents after an `error`.                                                                                                                                                                                          |

Plus the universal lifecycle: `subscribe`, `getState`, `reset`, `stop`.

`SCAN_NEW_DOCUMENT`, the `SelectedDocumentId` type, and `ReusableDocument` are exported from `@incodetech/core/identity-reuse`:

```typescript
import {
  createIdentityReuseManager,
  SCAN_NEW_DOCUMENT,
} from '@incodetech/core/identity-reuse';

const manager = createIdentityReuseManager({ config: {} });

manager.subscribe((state) => {
  if (state.status === 'documentsFound') {
    // Reuse the recommended document in one step.
    manager.submit(state.documents[0].id);
    // Or scan a new document instead: manager.submit(SCAN_NEW_DOCUMENT);
  }
});

manager.load();
```

## See also

- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): fallback when reuse is skipped or no candidates found
- [Module: Authentication](/sdk-reference/web-sdk-2-module-authentication/): different re-auth flow (selfie ↔ stored biometric)
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-patterns`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-patterns/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-patterns.md

# Module Patterns

<Component slug="web-2-x-implementation-warning" />

Most SDK modules fall into one of five implementation patterns. Each pattern dictates how the manager state machine is shaped, which API methods exist, and what UI affordances you'll need to build (or which screens the SDK ships).

This page is the shared lifecycle reference. Per-module pages link here for the pattern they follow, then only document what's specific to that module, like config shape, custom states, error codes, without repeating the lifecycle prose.

> If you're skimming, the [universal lifecycle](#universal-lifecycle) section is the only thing every module shares. The five patterns below describe how that lifecycle is filled in.

## Universal lifecycle

Every manager regardless of pattern exposes the same lifecycle methods:

| Method                | Purpose                                                                                   |
| --------------------- | ----------------------------------------------------------------------------------------- |
| `subscribe(callback)` | Listen to state transitions. Returns an unsubscribe function.                             |
| `getState()`          | Current state synchronously, without subscribing.                                         |
| `stop()`              | Tear down resources (camera streams, timers, server polling). Always call before unmount. |


Every state has a `status: string` discriminator. Use TypeScript's discriminated-union narrowing:

```ts
manager.subscribe((state) => {
  switch (state.status) {
    case 'idle':
      // initial state, before load()
      break;
    case 'finished':
      // success — TypeScript knows the success-state shape here
      manager.stop();
      break;
  }
});
```

**Start and recovery.** Consult each manager's API: most start with `load()`, while Video Selfie starts with `start()`. `reset()` is module-specific and is not available on every manager.

**Final states.** When a manager reaches a final state, stop it and create a new instance for another attempt. This applies to Phone's `finished` and Selfie/ID's `finished` or `closed`. Final states accept no reset. Error recovery can use `retry()`, `retryCapture()`, or `reset()` only where the module documents it. The legacy Flow manager has a non-final `finished` state that explicitly supports reset.

**Lifecycle events.** Managers emit lifecycle events according to their module transitions; start methods and completion paths vary. Subscribe via `subscribeEvent` from `@incodetech/core/events` if you want to track them. See [Dashboard Events](/sdk-reference/web-sdk-2-events/).

## 1. Form-based modules

The user fills inputs, clicks submit, the server validates, and the flow advances. The simplest, most common pattern.

**Modules using this pattern:** [Phone](/sdk-reference/web-sdk-2-module-phone/), [Email](/sdk-reference/web-sdk-2-module-email/), [ID OCR](/sdk-reference/web-sdk-2-module-id-ocr/), [Consent](/sdk-reference/web-sdk-2-module-consent/), [CURP Validation](/sdk-reference/web-sdk-2-module-curp-validation/), [Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/), [Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/), [Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/) (with a candidate-selection variant).

### State progression

```mermaid
flowchart LR
    idle -->|load| inputting
    inputting -->|submit| submitting
    submitting --> finished
    submitting -.->|error| error
```

When `prefill` is enabled, `load` transitions through an extra `loadingPrefill` state before reaching `inputting`.

For modules with OTP verification (Phone, Email), the `submitting` state expands into an OTP sub-loop:

```mermaid
flowchart LR
    submitting --> sendingInitialOtp
    sendingInitialOtp --> awaitingOtp
    awaitingOtp -->|submitOtp| verifyingOtp
    verifyingOtp --> finished
    verifyingOtp -.->|wrong code| otpError
    otpError -->|submitOtp| verifyingOtp
    awaitingOtp -->|resendOtp| resendingOtp
    resendingOtp --> awaitingOtp
```

Identity Reuse exposes `documentsFound` when documents are available for selection. An empty result finishes without a candidate-selection state. See the [Identity Reuse reference](/sdk-reference/web-sdk-2-module-identity-reuse/) for its actions.

### Common API methods

| Method                                 | Purpose                                                                                 |
| -------------------------------------- | --------------------------------------------------------------------------------------- |
| `load()`                               | Start the machine. Fetches prefill data if `prefill` is enabled in config.              |
| `submit()`                             | Submit the form. Transitions to `submitting`.                                           |
| `setOtpCode(code)` / `submitOtp(code)` | OTP-specific. `setOtpCode` updates without submitting; `submitOtp` updates and submits. |
| `resendOtp()`                          | Re-request the OTP. Only valid when `state.canResend === true`.                         |
| `back()`                               | Return to a previous step (e.g. `awaitingOtp` → `inputting`).                           |
| `reset()`                              | Available only on managers and recovery states documented by the module; never use to revive a final state.                                         |

#### Setting field values

Form modules take input two different ways, depending on whether their fields are fixed or defined by your dashboard. Check the module's own page for which it uses — the two are not interchangeable.

| Shape                                                     | Methods                                        | Modules                                                                                                                                                                     |
| --------------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Fixed fields**<br />_one setter each_                   | `set<Field>(value, isValid?)`                  | [Phone](/sdk-reference/web-sdk-2-module-phone/) (`setPhoneNumber`), [Email](/sdk-reference/web-sdk-2-module-email/) (`setEmail`), [Signature](/sdk-reference/web-sdk-2-module-signature/) (`setSignatureValid`) |
| **Schema-driven** <br />_one setter, keyed by field name_ | `setField(name, value)`, `validateField(name)` | [Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/), [eKYC](/sdk-reference/web-sdk-2-module-ekyc/), [eKYB](/sdk-reference/web-sdk-2-module-ekyb/)                                                   |

Pass `isValid` on the fixed-field setters so the manager knows when submit can be enabled. On the schema-driven ones, call `validateField(name)` on blur instead — the manager tracks validity itself and exposes it on the state.

Two form modules take input their own way and are documented on their pages: [Consent](/sdk-reference/web-sdk-2-module-consent/) uses `toggleCheckbox(checkboxId)`, and [CURP Validation](/sdk-reference/web-sdk-2-module-curp-validation/) uses `setCurp(curp)` plus `setGenerateForm(form)` for its generate path.

### Skeleton

```ts
const manager = createPhoneManager({
  config: { otpVerification: true, otpExpirationInMinutes: 5, prefill: false },
});

manager.subscribe((state) => {
  switch (state.status) {
    case 'inputting':
      // render input form, hook setPhoneNumber + submit
      break;
    case 'awaitingOtp':
      // render OTP entry form, hook submitOtp + resendOtp
      break;
    case 'finished':
      manager.stop();
      break;
  }
});

manager.load();
```

## 2. Camera-capture modules

Real-time camera feed with on-device ML detection, capture (auto or manual), upload, and server-side processing. The SDK handles the camera and ML; you handle the layout and instructions.

**Modules using this pattern:** [Selfie](/sdk-reference/web-sdk-2-module-selfie-1/), [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/), [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/), [Authentication](/sdk-reference/web-sdk-2-module-authentication/) (re-auth via selfie).

### State progression

```mermaid
flowchart LR
    idle -->|load| loading
    loading --> tutorial
    tutorial -->|nextStep| permissions
    permissions -->|granted| capture
    capture -->|upload done| processing
    processing -->|success| finished
    capture -->|retryCapture| capture
    capture -->|close| closed
```

The `capture` state has rich internal sub-state exposed as flat properties on the state object:

| Property            | Meaning                                                                                                           |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `stream`            | The `MediaStream` to bind to your `<video>` element.                                                              |
| `captureStatus`     | Sub-state: `initializing`, `detecting`, `capturing`, `uploading`, `uploadError`, `success`.                       |
| `detectionStatus`   | Per-frame feedback: `noFace`, `tooClose`, `blur`, `glare`, `manualCapture`, etc. Use to drive on-screen guidance. |
| `attemptsRemaining` | Capture attempts left before the module errors out.                                                               |

Specific modules add their own properties (Selfie has `assistedOnboarding`; ID adds `currentMode: 'front' | 'back'` and `counterValue` for the auto-capture countdown; Document Capture has multi-page state). Per-module pages document the diffs.

### Common API methods

| Method                      | Purpose                                                                                                                                       |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `load()`                    | Start. Goes to `tutorial` if `showTutorial: true`, else straight to `permissions`.                                                            |
| `nextStep()`                | Advance from `tutorial` → `permissions`. For ID capture, also advance from `capture.success` → `frontFinished` / `processing`.                |
| `requestPermission()`       | Prompt the user for camera access. Only effective in `permissions.idle` / `permissions.learnMore`.                                            |
| `goToLearnMore()`, `back()` | Help-screen navigation when permission is denied.                                                                                             |
| `capture()`                 | Manual capture. Only effective when `detectionStatus === 'manualCapture'`.                                                                    |
| `retryCapture()`            | Retry after upload error or expiration.                                                                                                       |
| `close()`                   | User dismisses; transitions to `closed` (terminal — see [Handling cancellation](/sdk-reference/web-sdk-2-module-selfie-1/#handling-cancellation-closed)). |

### WASM requirement

Camera-capture modules need WASM for face/document detection and quality scoring. Preload via `setup({ wasm: { pipelines: ['selfie', 'idCapture'] } })`. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).

### Skeleton

```ts
import { createSelfieManager } from '@incodetech/core/selfie';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';

// After setup and activation of a Flow session containing SELFIE:
const config = await resolveDashboardModuleConfig({ moduleKey: 'SELFIE' });
const manager = createSelfieManager({ config });

manager.subscribe((state) => {
  switch (state.status) {
    case 'tutorial':
      // render tutorial; nextStep() to advance
      break;
    case 'permissions':
      // prompt; requestPermission() on user click
      break;
    case 'capture':
      // bind state.stream to a <video> element with playsinline + muted + autoplay
      // render guidance based on state.detectionStatus
      if (state.detectionStatus === 'manualCapture') {
        // show a tap-to-capture button → manager.capture()
      }
      break;
    case 'processing':
      // server-side ML processing — show a spinner
      break;
    case 'finished':
      manager.stop();
      break;
    case 'closed':
      // user cancelled — see Handling cancellation
      break;
  }
});

manager.load();
```

## 3. Backend-process modules

No live user interaction. The module runs a server-side check using data already collected (by the session, by previous modules, or from the user's device) and reports a result. Often runs as a background step in an orchestrated flow rather than standalone.

**Modules using this pattern:** [Face Match](/sdk-reference/web-sdk-2-module-face-match/), [Antifraud](/sdk-reference/web-sdk-2-module-antifraud/), [Watchlist](/sdk-reference/web-sdk-2-module-watchlist/), [Custom Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/), [Geolocation](/sdk-reference/web-sdk-2-module-geolocation/), [Cross-Document Data Match](/sdk-reference/web-sdk-2-module-cross-doc-match/), [Government Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/).

### State progression

```mermaid
flowchart LR
    idle -->|load| loading
    loading --> result
    result -->|continue| finished
    loading -.->|error| error
```

Some modules add a transition state (Face Match has `animating` for its result reveal animation) but the core shape is minimal. The result data is on the state when `status === 'result'`.

### Common API methods

| Method                    | Purpose                                                                       |
| ------------------------- | ----------------------------------------------------------------------------- |
| `load()`                  | Trigger the backend call. Result lands in `state` when `status === 'result'`. |
| `continue()` / `submit()` | Acknowledge the result and finish. Naming varies by module.                   |
| `reset()`                 | Module-specific recovery; check the module reference before calling.                                 |

These modules typically need no user input. They're often invoked from an orchestrated flow that calls `load()` automatically when the step starts.

### Skeleton

```ts
const manager = createFaceMatchManager({ config: {} });

manager.subscribe((state) => {
  switch (state.status) {
    case 'result':
      // Render state.result.matched and state.result.liveness; either can be null.
      // call manager.continue() to acknowledge
      break;
    case 'finished':
      manager.stop();
      break;
  }
});

manager.load();
```

See [Face Match state properties](/sdk-reference/web-sdk-2-module-face-match/#state-machine) for the result fields.

## 4. Document-signing modules

Render documents to be signed, collect consent checkboxes, capture a signature (handwritten on canvas or accept-via-button), submit. Used for legal/compliance signing flows.

**Modules using this pattern:** [Signature](/sdk-reference/web-sdk-2-module-signature/) (handwritten on canvas), [Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/) (multi-document PDF flow, plus AE and QE variants on the same page).

:::note
**AE / QE are variants.** `createAeSignatureManager` and `createQeSignatureManager` are thin wrappers around `createElectronicSignatureManager` that hardcode `variant: 'ae'` or `'qe'` — same state machine, same API, different consent keys (`AE_CONSENT_KEYS` vs `QE_CONSENT_KEYS`). One mental model covers all three.
:::

### State progression

```mermaid
flowchart LR
    loading --> reviewing
    reviewing -->|sign| signing
    signing --> uploading
    uploading --> processing
    processing --> finished
    reviewing -->|close| closed
    signing -.->|error| error
```

The handwritten signature module is structurally simpler — it skips the multi-document review and goes straight from `idle` → `capture` (canvas drawing) → `submitting` → `finished`.

### Common API methods

| Method                                                             | Purpose                                                                  |
| ------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `load()`                                                           | Fetch the documents to sign.                                             |
| `setConsent(name, checked)`                                        | Toggle a consent checkbox.                                               |
| `confirmFile()`, `selectFile()`, `replaceFile()`, `viewDocument()` | Document review interactions (Electronic Signature).                     |
| `setSignatureValid(isValid)`, `submit(image)`                      | Canvas signature interactions (Signature).                               |
| `sign()`                                                           | Trigger signing once consents are checked and the document is confirmed. |
| `finish()`, `retry()`, `close()`                                   | Terminal transitions.                                                    |

### Skeleton

```ts
import { createElectronicSignatureManager } from '@incodetech/core/electronic-signature';
import { areAllConsented } from '@incodetech/core/electronic-signature';

const manager = createElectronicSignatureManager({
  config: { variant: 'ae', uploadDocument: false, downloadDocument: true },
});

manager.subscribe((state) => {
  switch (state.status) {
    case 'reviewing':
      // Render state.fileName / state.fileUrl; confirmFile() accepts the document.
      break;
    case 'signing':
      // Render state.documents and state.consentChecks.
      // Call setConsent(name, checked) on user selection.
      // Enable Sign when areAllConsented(state.consentChecks); call manager.sign().
      break;
    case 'finished':
      manager.stop();
      break;
  }
});

manager.load();
```

## 5. Composite / orchestrator modules

These don't capture data themselves — they sequence other modules based on a flow definition (from the dashboard or a workflow definition). The state describes which sub-module is currently active, and your code instantiates that sub-module and drives its lifecycle.

**Modules using this pattern:** [Flow / Orchestrated Flow](/sdk-reference/web-sdk-2-incodeflow-component/), [Workflow](/sdk-reference/web-sdk-2-module-workflow/), [eKYC](/sdk-reference/web-sdk-2-module-ekyc/), [eKYB](/sdk-reference/web-sdk-2-module-ekyb/).

### State progression

```mermaid
flowchart LR
    idle -->|load| loading
    loading --> ready
    ready -->|completeModule| ready
    ready -->|all steps done| finished
    ready -.->|error| error
```

The `ready` state cycles back to itself once per sub-module: the orchestrator emits a new `ready` snapshot with an updated `currentStep` each time you call `completeModule()`. The `ready` state exposes:

| Property           | Meaning                                                                                         |
| ------------------ | ----------------------------------------------------------------------------------------------- |
| `flow`             | The full flow configuration from the backend.                                                   |
| `steps`            | Ordered list of step keys.                                                                      |
| `currentStep`      | Step key currently active (e.g. `'PHONE'`, `'ID'`, `'SELFIE'`).                                 |
| `currentStepIndex` | Position in `steps`.                                                                            |
| `config`           | Sub-module config for the current step. Type is `unknown`; cast via `FlowModuleConfig[<step>]`. |
| `moduleState`      | Sub-module state if the orchestrator is also driving the sub-module.                            |

As each sub-module finishes, you call `flowManager.completeModule()` and the orchestrator advances to the next step.

### Common API methods

| Method                                                  | Purpose                                                   |
| ------------------------------------------------------- | --------------------------------------------------------- |
| `load()`                                                | Fetch flow configuration from the backend.                |
| `completeModule()`                                      | Mark the current sub-module as complete; advance to next. |
| `getModuleConfig<T>()` / `isModuleEnabled(stepKey)` | Query the resolved flow definition.                       |
| `reset()`                                               | Return to `idle`.                                         |

### Where to learn more

[Headless Mode → Orchestrated Flow Manager](/sdk-reference/web-sdk-2-headless-mode/#orchestrated-flow-manager) is the canonical reference. [Module Registration](/sdk-reference/web-sdk-2-headless-mode/#module-registration) covers how to wire sub-module state machines into the orchestrator.

## See also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): full per-module reference for the four documented modules
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): catalog of every module in the SDK
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): required for camera-capture modules
- [Dashboard Events](/sdk-reference/web-sdk-2-events/): automatic and custom event tracking
- [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/): common integration issues

---

- Path: `sdk-reference/web-sdk-2-module-phone`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-phone/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-phone.md

# Phone Module

<Component slug="web-2-x-implementation-warning" />

The Phone module verifies a user's phone number via SMS OTP (One-Time Password).

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules) (with the OTP sub-loop). See that page for the shared manager lifecycle and skeleton; the rest of this page covers Phone-specific config, states, and methods.

## Tag

`<incode-phone>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/phone';
import '@incodetech/web/phone/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                      | Required | Description                        |
| ---------- | ------------------------- | -------- | ---------------------------------- |
| `config`   | `PhoneConfig`             | ✅       | Configuration options              |
| `onFinish` | `() => void`              | ❌       | Called when verification completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs        |

## Usage

### Vanilla HTML / TypeScript

```html
<incode-phone></incode-phone>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/phone';
  import '@incodetech/web/phone/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: 'your-session-token',
  });

  const phone = document.querySelector('incode-phone');
  phone.config = {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  };
  phone.onFinish = () => console.log('Phone verified!');
  phone.onError = (err) => console.error('Phone error:', err);
</script>
```

### React

> **React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it, and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { PhoneConfig } from '@incodetech/core/phone';
import '@incodetech/web/phone';
import '@incodetech/web/phone/styles.css';

type PhoneElement = HTMLElement & {
  config: PhoneConfig;
  onFinish: () => void;
  onError: (error: string) => void;
};

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

export function PhoneVerification() {
  const ref = useRef<PhoneElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = {
      otpVerification: true,
      otpExpirationInMinutes: 5,
      prefill: false,
    };
    el.onFinish = () => console.log('Phone verified!');
    el.onError = (err) => console.error('Phone error:', err);
  }, []);

  return <incode-phone ref={ref} />;
}
```

For Angular (`CUSTOM_ELEMENTS_SCHEMA`) and Vue (`compilerOptions.isCustomElement`) setup, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

---

## Headless Mode

For complete UI control, use the `createPhoneManager` from `@incodetech/core/phone`.

### Quick Start

```tsx
import { setup } from '@incodetech/core';
import { createPhoneManager } from '@incodetech/core/phone';

// Initialize SDK first
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

const manager = createPhoneManager({
  config: {
    otpVerification: true,
    otpExpirationInMinutes: 5,
    prefill: false,
  },
});

manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'finished') {
    console.log('Phone verified!');
    manager.stop();
  }
});

// Start the flow
manager.load();

// When state is 'inputting', set the phone number and submit
manager.setPhoneNumber('+14155551234', true);
manager.submit();

// When state is 'awaitingOtp', submit the OTP code
manager.submitOtp('ABC123');
```

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| inputting
    inputting -->|submit| awaitingOtp
    awaitingOtp -->|submitOtp| finished
    awaitingOtp -.->|back| inputting
    awaitingOtp -.->|resendOtp| awaitingOtp
```

### States Reference

| Status              | Description                                 | Key Properties                                                                                      |
| ------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `idle`              | Initial state, waiting for `load()`         | –                                                                                                   |
| `loadingPrefill`    | Fetching pre-filled phone from backend      | –                                                                                                   |
| `loadingStartInfo`  | Fetching start info (`ipIsoCode`, `phonePrefix`) before the field is interactive | `prefilledPhone?`, `otpVerification?`, `optinEnabled?` |
| `inputting`         | Ready for phone input                       | `countryCode`, `phonePrefix`, `prefilledPhone?`, `phoneError?`, `validationErrors?`, `isValid`, `otpVerification?`, `optinEnabled?` |
| `submitting`        | Submitting phone number to backend          | –                                                                                                   |
| `sendingInitialOtp` | Sending OTP code via SMS for the first time | –                                                                                                   |
| `resendingOtp`      | Resending OTP code via SMS                  | `otpCode`, `otpLength`                                                                              |
| `awaitingOtp`       | Waiting for user to enter OTP               | `resendTimer`, `canResend`, `attemptsRemaining`, `otpCode`, `otpLength`, `otpValidationErrors?`, `isOtpValid` |
| `verifyingOtp`      | Verifying OTP code with backend             | `resendTimer`, `canResend`, `otpCode`, `otpLength`                                                   |
| `otpError`          | OTP verification failed                     | `otpError`, `attemptsRemaining`, `resendTimer`, `canResend`, `otpCode`, `otpLength`, `otpValidationErrors?`, `isOtpValid` |
| `finished`          | Verification complete                       | –                                                                                                   |
| `error`             | Fatal error occurred                        | `error`                                                                                             |

### State Properties

**When `status === 'inputting'`:**

| Property           | Type                     | Description                                                                          |
| ------------------ | ------------------------ | ------------------------------------------------------------------------------------- |
| `countryCode`      | `string`                 | ISO country code (e.g., `'US'`, `'MX'`)                                              |
| `phonePrefix`      | `string`                 | International dialing prefix (e.g., `'+1'`)                                          |
| `prefilledPhone`   | `string?`                | Pre-populated phone number (if `prefill: true`)                                      |
| `phoneError`       | `string?`                | Submission error message if the backend rejected the phone number                    |
| `validationErrors` | `PhoneValidationErrors?` | Client-side validation errors (e.g. invalid/empty phone), surfaced on blur and submit |
| `isValid`          | `boolean`                | True iff `validationErrors` is empty. Optimistic — starts `true` on initial render.   |

**When `status === 'awaitingOtp'`, `'verifyingOtp'`, `'otpError'`, or `'resendingOtp'`:**

| Property              | Type                   | Description                                                                             |
| --------------------- | ---------------------- | ------------------------------------------------------------------------------------------ |
| `otpCode`             | `string`               | The OTP code entered so far (controlled-input value)                                    |
| `otpLength`           | `number`               | Expected OTP length (owned by Core — don't hardcode it)                                 |
| `resendTimer`         | `number`               | Seconds remaining before resend allowed (`awaitingOtp`, `verifyingOtp`, `otpError`)      |
| `canResend`           | `boolean`              | Whether resend button should be enabled (`awaitingOtp`, `verifyingOtp`, `otpError`)      |
| `attemptsRemaining`   | `number`               | OTP verification attempts left (`awaitingOtp`, `otpError`)                               |
| `otpValidationErrors` | `OtpValidationErrors?` | Client-side OTP errors (e.g. incomplete code), surfaced on blur and submit (`awaitingOtp`, `otpError`) |
| `isOtpValid`          | `boolean`              | True iff `otpValidationErrors` is empty (`awaitingOtp`, `otpError`)                       |
| `otpError`            | `string`               | Error message describing failure (`otpError` only)                                       |

### API Methods

| Method                           | Description                            | When to Use                           |
| -------------------------------- | -------------------------------------- | ------------------------------------- |
| `load()`                         | Initializes the flow                   | Always call first                     |
| `setPhoneNumber(phone, isValid)` | Sets phone number and validation state | When `inputting`, before `submit()`   |
| `validatePhone()`                | Runs blur-style validation, populating or clearing `validationErrors.phone` | When `inputting` |
| `setOptInGranted(granted)`       | Sets marketing opt-in preference       | When `inputting`, if opt-in enabled   |
| `submit()`                       | Submits the phone number               | After setting valid phone             |
| `setOtpCode(code)`               | Sets OTP without submitting            | When `awaitingOtp` (controlled input) |
| `validateOtp()`                  | Runs blur-style OTP validation, populating or clearing `otpValidationErrors.otp` | When `awaitingOtp` or `otpError` |
| `submitOtp(code)`                | Sets and submits OTP code              | When `awaitingOtp` or `otpError`      |
| `resendOtp()`                    | Requests new OTP code                  | When `canResend` is `true`            |
| `back()`                         | Returns to phone input                 | When `awaitingOtp`                    |
| `reset()`                        | Resets to initial state                | Only in `error`; create a new manager after final `finished` |
| `stop()`                         | Cleanup resources                      | When unmounting                       |
| `getState()`                     | Returns current state synchronously    | Anytime                               |
| `subscribe(callback)`            | Subscribe to state changes             | Returns unsubscribe function          |

### React Example

```tsx
import { useState, useEffect } from 'react';
import { createPhoneManager, type PhoneState } from '@incodetech/core/phone';

function CustomPhoneVerification() {
  const [manager] = useState(() =>
    createPhoneManager({
      config: {
        otpVerification: true,
        otpExpirationInMinutes: 5,
        prefill: false,
      },
    }),
  );
  const [state, setState] = useState<PhoneState>({ status: 'idle' });
  const [phone, setPhone] = useState('');
  const [otp, setOtp] = useState('');

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  const handleSubmitPhone = () => {
    // Use a phone validation library like libphonenumber-js
    const isValid = phone.length >= 10;
    manager.setPhoneNumber(phone, isValid);
    manager.submit();
  };

  switch (state.status) {
    case 'inputting':
      return (
        <div>
          <p>
            Country: {state.countryCode} ({state.phonePrefix})
          </p>
          <input
            type="tel"
            value={phone}
            onChange={(e) => setPhone(e.target.value)}
            placeholder="Enter phone number"
          />
          {state.phoneError && <p className="error">{state.phoneError}</p>}
          <button onClick={handleSubmitPhone}>Send OTP</button>
        </div>
      );

    case 'submitting':
    case 'sendingInitialOtp':
    case 'resendingOtp':
      return <div>Sending OTP...</div>;

    case 'awaitingOtp':
      return (
        <div>
          <p>Enter the 6-character code sent to your phone</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value.toUpperCase())}
            placeholder="ABC123"
            maxLength={6}
          />
          <button onClick={() => manager.submitOtp(otp)}>Verify</button>

          {state.canResend ? (
            <button onClick={() => manager.resendOtp()}>Resend Code</button>
          ) : (
            <p>Resend available in {state.resendTimer}s</p>
          )}

          <button onClick={() => manager.back()}>Change Phone Number</button>
        </div>
      );

    case 'otpError':
      return (
        <div>
          <p className="error">{state.otpError}</p>
          <p>Attempts remaining: {state.attemptsRemaining}</p>
          <input
            type="text"
            value={otp}
            onChange={(e) => setOtp(e.target.value.toUpperCase())}
            maxLength={6}
          />
          <button onClick={() => manager.submitOtp(otp)}>Try Again</button>
        </div>
      );

    case 'verifyingOtp':
      return <div>Verifying...</div>;

    case 'finished':
      return <div>Phone verified successfully!</div>;

    case 'error':
      return <div className="error">Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}
```

---

## Configuration Options

`PhoneConfig` shape:

| Option                   | Type      | Required | Description                                                                                                 |
| ------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `otpVerification`        | `boolean` | ✅       | Require OTP (SMS code) verification. If `false`, the phone is verified immediately after submission.        |
| `otpExpirationInMinutes` | `number`  | ✅       | How long the OTP code remains valid. After expiration the user must request a new code.                     |
| `prefill`                | `boolean` | ✅       | Pre-populate with the user's previously stored phone number. Useful for returning users.                    |
| `isInstantVerify`        | `boolean` | ❌       | Use carrier-based instant verification instead of OTP. Not available in all regions. Default `false`.       |
| `optinEnabled`           | `boolean` | ❌       | Show a marketing opt-in checkbox. The user's preference is sent with the phone submission. Default `false`. |
| `maxOtpAttempts`         | `number`  | ❌       | Maximum OTP verification attempts before lockout. Default `3`.                                              |

## Troubleshooting

### OTP Not Received

- Verify the phone number is correct (include country code)
- Check the phone can receive SMS
- Some VoIP numbers may not receive SMS
- Check with your carrier if SMS is blocked

### Invalid OTP Error

- OTPs expire after the configured time (default 5 minutes)
- Each OTP can only be used once
- Request a new OTP if the current one expires
- Check `attemptsRemaining` before lockout

### Phone Number Rejected

- Ensure the number includes country code
- Some numbers may be blocked
- Corporate or VoIP numbers may not be accepted

---

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Complete headless API reference
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Overview of all modules

---

- Path: `sdk-reference/web-sdk-2-module-redirect-to-mobile`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-redirect-to-mobile/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-redirect-to-mobile.md

# Redirect to Mobile Module

<Component slug="web-2-x-implementation-warning" />

The Redirect to Mobile module bridges desktop-initiated verifications to mobile devices: it generates a QR code (and optional SMS link) that hands the user off to their phone, where camera-bearing modules (selfie, ID capture) continue. Used when desktop browsers can't deliver the verification experience the customer needs.

This  module combines [composite / orchestrator](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules) and [backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules) traits. It fetches the redirect URL, polls onboarding status, and emits `finished` once the mobile device completes the flow.

## Tag

`<incode-redirect-to-mobile>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/redirect-to-mobile';
import '@incodetech/web/redirect-to-mobile/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                           |
| ---------- | ------------------------- | -------- | ------------------------------------- |
| `config`   | `RedirectToMobileConfig`  | ❌        | Configuration options                 |
| `onFinish` | `() => void`              | ❌        | Called when the mobile flow completes |
| `onError`  | `(error: string) => void` | ❌        | Called when an error occurs           |

## Configuration

```typescript
type RedirectToMobileConfig = {
  flowId?: string;
  url?: string;
  disableSmsOption?: boolean;
  addContinueToDesktop?: boolean;
  qrPhishingResistance?: boolean;
  authHint?: string;
  externalId?: string;
  lang?: string;
};
```

| Option                 | Type      | Required | Description                                                                                      |
| ---------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------ |
| `flowId`               | `string`  | ❌        | Session flow ID; injected by the orchestrator.                                                   |
| `url`                  | `string`  | ❌        | Pre-computed redirect URL. When omitted, the module fetches one from the backend.                |
| `disableSmsOption`     | `boolean` | ❌        | Hide the SMS-link option (QR only).                                                              |
| `addContinueToDesktop` | `boolean` | ❌        | Show a "Continue on desktop" affordance for users who'd rather not switch.                       |
| `qrPhishingResistance` | `boolean` | ❌ | Enable QR phishing protection for the mobile handoff. |
| `authHint`             | `string`  | ❌        | QR/auth hint for the mobile leg.                                                                 |
| `externalId`           | `string`  | ❌        | Forwarded to the new mobile session.                                                             |
| `lang`                 | `string`  | ❌        | Forwarded language code.                                                                         |

When `<incode-flow>` renders this module, set `redirectToMobileUrl` on `FlowConfig`. The flow maps that value to this module's `url` option.

## State machine

`RedirectToMobileState` is a discriminated union over `status`:

| Status        | Description                                                                                                                    |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `idle`        | Initial state.                                                                                                                 |
| `loading`     | Fetching the redirect URL (or warming the QR).                                                                                 |
| `redirecting` | QR / SMS option visible; polling onboarding status. User completes flow on mobile.                                             |
| `finished`    | Mobile flow completed (status moved to `ONBOARDING_FINISHED`).                                                                 |
| `continue`    | The user chose to stay on desktop instead of switching devices. Terminal, and deliberately separate from `closed` and `error`. |
| `closed`      | User dismissed.                                                                                                                |
| `error`       | Fatal error.                                                                                                                   |

Behind the scenes the module polls onboarding status (`ONBOARDING_NOT_STARTED` → `ONBOARDING_IN_PROGRESS` → `ONBOARDING_FINISHED`) and surfaces only the user-relevant transitions.

`continue` exists so you can wire "keep going on desktop" to its own handler. Treat it as a deliberate user choice, not a dismissal or a failure. It appears only when `addContinueToDesktop` is enabled.

### Redirecting-state properties

| Property | Type | Description |
| --- | --- | --- |
| `redirectUrl` | `string` | Link to encode in the QR code or display as the mobile handoff. |
| `phonePrefix` | `string` | Initial phone prefix for the SMS input. |
| `smsSent` | `boolean` | Show confirmation after a successful send. |
| `smsFailed` | `boolean` | Show SMS failure feedback. |
| `smsResendTimer` | `number` | Remaining resend cooldown in seconds. |
| `canResendSms` | `boolean` | Whether to offer resend. |
| `error` | `string \| undefined` | Current SMS error, when present. |

Read these fields only in `redirecting`. Use `canResendSms` to enable resend, display `smsResendTimer` during cooldown, and keep the QR handoff visible if SMS fails.

## API methods

Beyond the shared [composite / orchestrator](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules) set:

| Method                | Purpose                                                     | Callable when                                         |
| --------------------- | ----------------------------------------------------------- | ----------------------------------------------------- |
| `sendSms(phone)`      | Text the handoff link to that number.                       | `redirecting`                                         |
| `resetSms()`          | Clear the SMS state so the user can re-enter their number.  | `redirecting`, after a send                           |
| `continueOnDesktop()` | Skip the handoff and continue here. Advances to `continue`. | `redirecting`, when `addContinueToDesktop` is enabled |
| `retry()`             | Retry after a failed URL fetch or send.                     | `error`                                               |

## See also

- [Session Management](/sdk-reference/web-sdk-2-session-api/): how the desktop and mobile legs share a session token
- [Module Patterns → composite](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-selfie-1`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-selfie-1/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-selfie-1.md

# Selfie Module

<Component slug="web-2-x-implementation-warning" />

The Selfie module captures a user's face with ML-powered liveness detection to prevent spoofing.

This module follows the [camera-capture pattern](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules). See that page for the shared manager lifecycle, capture sub-states, and skeleton; the rest of this page covers Selfie-specific config, detection statuses, and methods.

## Tag

`<incode-selfie>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/selfie';
import '@incodetech/web/selfie/styles.css';
```

## Properties

Set these as JavaScript properties on the element (not as HTML attributes):

| Property   | Type                      | Required | Description                                     |
| ---------- | ------------------------- | -------- | ----------------------------------------------- |
| `config`   | `SelfieConfig`            | ❌        | Configuration options (validation flags, modes) |
| `onFinish` | `() => void`              | ❌        | Called when capture completes successfully      |
| `onError`  | `(error: string) => void` | ❌        | Called when an error occurs                     |

## WASM Requirements

The Selfie module uses WebAssembly for face detection and liveness analysis. Pre-warm WASM during `setup()` so models are ready before the user reaches the camera step:

```typescript
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
  wasm: { pipelines: ['selfie'] },
});
```

See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/) for self-hosted paths and the lower-level `warmupWasm()` API.

## Usage

### Vanilla HTML / TypeScript

```html
<incode-selfie></incode-selfie>

<script type="module">
  import { setup } from '@incodetech/core';
  import '@incodetech/web/selfie';
  import '@incodetech/web/selfie/styles.css';

  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: 'your-session-token',
    wasm: { pipelines: ['selfie'] },
  });

  const selfie = document.querySelector('incode-selfie');
  selfie.onFinish = () => console.log('Selfie captured!');
  selfie.onError = (err) => console.error('Selfie error:', err);
</script>
```

### React

**React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need it, and can also use the simpler form from [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut).

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import type { SelfieConfig } from '@incodetech/core/selfie';
import '@incodetech/web/selfie';
import '@incodetech/web/selfie/styles.css';

type SelfieElement = HTMLElement & {
  config?: SelfieConfig;
  onFinish: () => void;
  onError: (error: string) => void;
};

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
  wasm: { pipelines: ['selfie'] },
});

export function SelfieCapture() {
  const ref = useRef<SelfieElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.onFinish = () => console.log('Selfie captured!');
    el.onError = (err) => console.error('Selfie error:', err);
  }, []);

  return <incode-selfie ref={ref} />;
}
```

For Angular (`CUSTOM_ELEMENTS_SCHEMA`) and Vue (`compilerOptions.isCustomElement`) setup, see [Framework Integration](/sdk-reference/web-sdk-2-framework-integration/).

## Headless Mode

For complete UI control, use the `createSelfieManager` from `@incodetech/core/selfie`.

### Quick Start

```tsx
import { setup } from '@incodetech/core';
import { createSelfieManager } from '@incodetech/core/selfie';
import { resolveDashboardModuleConfig } from '@incodetech/core/flow';
import { warmupWasm } from '@incodetech/core/wasm';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: 'your-session-token',
});

await warmupWasm({
  wasmPath: '/wasm/webLib.wasm',
  glueCodePath: '/wasm/webLib.js',
  modelsBasePath: '/wasm/models',
  pipelines: ['selfie'],
});

const config = await resolveDashboardModuleConfig({ moduleKey: 'SELFIE' });
const manager = createSelfieManager({ config });

manager.subscribe((state) => {
  console.log('Status:', state.status);

  if (state.status === 'capture') {
    console.log('Detection:', state.detectionStatus);
    console.log('Stream ready:', !!state.stream);
  }

  if (state.status === 'finished') {
    console.log('Selfie captured!', state.processResponse);
    manager.stop();
  }
});

manager.load();
```

The core factory requires a complete `SelfieConfig`. This example resolves it from the active dashboard Flow, which must contain a SELFIE module. Standalone UI components accept partial overrides; those are not a complete core-manager config.

### State Machine Flow

```mermaid
flowchart LR
    idle -->|load| tutorial
    tutorial -->|nextStep| permissions
    permissions -->|granted| capture
    capture -->|upload done| processing
    processing -->|success| finished
```

### States Reference

| Status        | Description                                                                                                                                                                                                     | Key Properties                                                                                     |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `idle`        | Initial state, waiting for `load()`                                                                                                                                                                             | –                                                                                                  |
| `loading`     | Checking permissions (when no tutorial)                                                                                                                                                                         | –                                                                                                  |
| `tutorial`    | Showing tutorial. Entered when `showTutorial` is `true` **or** `ageAssurance` is `true` — the age-assurance variant doubles as the compliance/privacy notice, so it is shown even when the tutorial is disabled | `ageAssurance` (boolean; mirrors `config.ageAssurance` and selects the age-assurance copy variant) |
| `permissions` | Camera permission handling                                                                                                                                                                                      | `permissionStatus`                                                                                 |
| `capture`     | Camera active, detecting face                                                                                                                                                                                   | `stream`, `captureStatus`, `detectionStatus`, `attemptsRemaining`                                  |
| `processing`  | Server-side processing of the captured selfie                                                                                                                                                                   | –                                                                                                  |
| `finished`    | Capture complete                                                                                                                                                                                                | `processResponse?`                                                                                 |
| `closed`      | User closed the flow                                                                                                                                                                                            | –                                                                                                  |
| `error`       | Fatal error occurred                                                                                                                                                                                            | `error`                                                                                            |

In a Workflow, Selfie does not run face matching, so `processResponse` on `finished` is empty. The Workflow's Face Match step produces the match result. Flow and standalone Selfie captures return `processResponse` as before.

### Capture State Properties

When `status === 'capture'`:

| Property             | Type              | Description                                                                                 |
| -------------------- | ----------------- | ------------------------------------------------------------------------------------------- |
| `stream` | `CameraStream \| undefined` | Camera stream for the video element; wait until it is available before attaching it. |
| `captureStatus`      | `string`          | `'initializing'`, `'detecting'`, `'capturing'`, `'uploading'`, `'uploadError'`, `'success'` |
| `detectionStatus`    | `DetectionStatus` | Face detection feedback (see below)                                                         |
| `attemptsRemaining`  | `number`          | Remaining capture attempts                                                                  |
| `uploadError`        | `string?`         | Error message if upload failed                                                              |
| `assistedOnboarding` | `boolean`         | Whether assisted onboarding mode was requested in config                                    |
| `usingBackCamera`    | `boolean`         | Whether `stream` is really a back camera — mirror your `<video>` when `false`               |
| `onDeviceMode` | `boolean` | When `true`, do not offer a manual capture button. |
| `obfuscateWithAvatar` | `boolean` | Whether a cosmetic concealment overlay is enabled. |
| `avatarCanvas` | `HTMLCanvasElement?` | Display-only canvas; unavailable until ready or when concealment is off. |
| `avatarVariant` | `'avatar-3d' \| 'avatar-2d' \| 'privacy-lens'` (optional) | Derived display variant. Keep the face outline for Privacy Lens; hide it for full avatars. This is not a host-settable config field. |

:::note
`processing` is a separate top-level state (`status === 'processing'`), not a `captureStatus` value.
:::

**Removed:** `debugFrame` (`ImageData?`) is gone from the selfie, authentication, and ID capture state types. It had already stopped carrying frames — the per-frame emission was dropped because storing a full-resolution frame roughly ten times a second re-rendered the capture screen and starved it on lower-tier devices. Reading `state.debugFrame` is now a type error rather than a silent `undefined`. If you relied on per-frame pipeline frames, contact Incode: an opt-in hook is the intended replacement.

These are read-only presentation fields. In `error`, `error: string` carries the message and `moduleErrorCode?: string` carries an optional code. Forward that code unchanged when reporting failure to a Flow or Workflow manager.

### Detection Status Values

| Status             | User Instruction                  |
| ------------------ | --------------------------------- |
| `idle`             | "Preparing camera..."             |
| `detecting`        | "Detecting face..."               |
| `noFace`           | "Position your face in the frame" |
| `tooManyFaces`     | "Only one face should be visible" |
| `tooClose`         | "Move back"                       |
| `tooFar`           | "Move closer"                     |
| `blur`             | "Hold still, image is blurry"     |
| `dark`             | "Improve lighting conditions"     |
| `faceAngle`        | "Face your camera directly"       |
| `headWear`         | "Remove head coverings"           |
| `lenses`           | "Remove glasses or lenses"        |
| `eyesClosed`       | "Open your eyes"                  |
| `faceMask`         | "Remove face mask"                |
| `centerFace`       | "Center your face"                |
| `getReady`         | "Get ready..."                    |
| `getReadyFinished` | "Hold still..."                   |
| `capturing`        | "Capturing photo..."              |
| `manualCapture`    | "Tap to capture"                  |
| `offline`          | "No network connection"           |

### Permission Status Values

When `status === 'permissions'`:

| `permissionStatus` | Description                 |
| ------------------ | --------------------------- |
| `idle`             | Ready to request permission |
| `requesting`       | Permission dialog shown     |
| `denied`           | User denied camera access   |
| `learnMore`        | Showing help screen         |

### Handling cancellation (`closed`)

When the user dismisses the selfie flow either by calling `manager.close()` or by clicking the SDK's built-in close button, the manager transitions to `closed`. `closed`** is a final state**: the manager won't re-emit further updates from there, and `reset()` doesn't apply (it is only valid from `error`). Custom UIs need to decide what to do next.

The two common patterns:

**Inside an orchestrated flow**: call `flowManager.completeModule()` to skip the selfie step and let the orchestrator advance:

```ts
selfieManager.subscribe((state) => {
  if (state.status === 'closed') {
    // Optional: render a brief "Cancelled — continuing…" screen, then advance.
    setTimeout(() => flowManager.completeModule(), 800);
  }
});
```

**Standalone (no orchestrator)**: there's nowhere to advance to, so navigate the user out of the selfie surface entirely:

```ts
selfieManager.subscribe((state) => {
  if (state.status === 'closed') {
    selfieManager.stop(); // tear down resources
    navigate('/onboarding/cancelled');
  }
});
```

Common UX choice: render a brief "Cancelled — continuing…" screen for \~800 ms before calling `flowManager.completeModule()`, so the cancellation isn't jarring.

### API Methods

| Method                | Description                           | When to Use                                        |
| --------------------- | ------------------------------------- | -------------------------------------------------- |
| `load()`              | Starts the selfie flow                | Always call first                                  |
| `nextStep()`          | Advances from tutorial to permissions | When `tutorial`                                    |
| `requestPermission()` | Requests camera access                | When `permissions.idle` or `permissions.learnMore` |
| `goToLearnMore()`     | Shows permission help screen          | When `permissions.idle`                            |
| `back()`              | Goes back from learn more             | When `permissions.learnMore`                       |
| `capture()`           | Manual capture trigger                | In `capture`, when `!onDeviceMode && detectionStatus === 'manualCapture'`         |
| `retryCapture()`      | Retry after upload error              | When `captureStatus === 'uploadError'`             |
| `close()`             | Close the flow                        | Anytime                                            |
| `reset()`             | Reset to initial state                | In `error`; create a new manager after `finished`                        |
| `stop()`              | Cleanup resources                     | When unmounting                                    |
| `getState()`          | Returns current state                 | Anytime                                            |
| `subscribe(callback)` | Subscribe to state changes            | Returns unsubscribe function                       |

### React Example

```tsx
import { useState, useEffect, useRef } from 'react';
import { createSelfieManager, type SelfieState, type SelfieConfig } from '@incodetech/core/selfie';

function CustomSelfie({ config }: { config: SelfieConfig }) {
  const videoRef = useRef<HTMLVideoElement>(null);
  const [manager] = useState(() =>
    createSelfieManager({ config }),
  );
  const [state, setState] = useState<SelfieState>({ status: 'idle' });

  useEffect(() => {
    const unsubscribe = manager.subscribe(setState);
    manager.load();
    return () => {
      unsubscribe();
      manager.stop();
    };
  }, [manager]);

  useEffect(() => {
    if (state.status === 'capture' && state.stream && videoRef.current) {
      videoRef.current.srcObject = state.stream;
    }
  }, [state]);

  switch (state.status) {
    case 'tutorial':
      return (
        <div>
          <h2>Take a Selfie</h2>
          <ul>
            <li>Ensure good lighting</li>
            <li>Remove glasses and hats</li>
            <li>Look directly at the camera</li>
          </ul>
          <button onClick={() => manager.nextStep()}>Continue</button>
        </div>
      );

    case 'permissions':
      if (state.permissionStatus === 'denied') {
        return (
          <div>
            <p>Camera access is required.</p>
            <p>Please enable camera in your browser settings.</p>
          </div>
        );
      }
      return (
        <div>
          <p>We need camera access to take your selfie.</p>
          <button onClick={() => manager.requestPermission()}>
            Allow Camera
          </button>
        </div>
      );

    case 'capture':
      return (
        <div>
          <video ref={videoRef} autoPlay playsInline muted />
          <p>{getDetectionMessage(state.detectionStatus)}</p>
          {state.captureStatus === 'uploading' && <p>Uploading...</p>}
          {!state.onDeviceMode && state.detectionStatus === 'manualCapture' && (
            <button onClick={() => manager.capture()}>Take Photo</button>
          )}
          {state.captureStatus === 'uploadError' && (
            <div>
              <p className="error">{state.uploadError}</p>
              <button onClick={() => manager.retryCapture()}>Retry</button>
            </div>
          )}
        </div>
      );

    case 'processing':
      return <div>Processing...</div>;

    case 'finished':
      return <div>✅ Selfie captured successfully!</div>;

    case 'error':
      return <div className="error">Error: {state.error}</div>;

    default:
      return <div>Loading...</div>;
  }
}

function getDetectionMessage(status: string): string {
  const messages: Record<string, string> = {
    idle: 'Preparing camera...',
    detecting: 'Detecting face...',
    noFace: 'Position your face in the frame',
    tooManyFaces: 'Only one face should be visible',
    tooFar: 'Move closer',
    tooClose: 'Move back',
    blur: 'Hold still, image is blurry',
    dark: 'Improve lighting conditions',
    faceAngle: 'Face your camera directly',
    centerFace: 'Center your face',
    lenses: 'Remove glasses or lenses',
    faceMask: 'Remove face mask',
    capturing: 'Capturing...',
    manualCapture: 'Ready - tap to capture',
  };
  return messages[status] || 'Detecting face...';
}
```

### Capture-only flow

`createSelfieCaptureOnlyManager` exposes the same state machine and API surface as `createSelfieManager`, but bypasses Incode's `/omni/add/face` upload. Instead of submitting the captured frame and waiting on server-side processing, the manager invokes a customer-supplied `onCapture(response)` callback with the raw face image  and reaches `finished` locally. Use it when you want to capture in the browser but route the bytes through your own pipeline.

The config exposes supported capture UX options plus a required `onCapture` callback. It omits `assistedOnboarding`, `enableFaceRecording`, and `deepsightLiveness`:

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import {
  createSelfieCaptureOnlyManager,
  type SelfieCaptureOnlyConfig,
  type FaceCaptureOnlyResponse,
} from '@incodetech/core/selfie';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['selfie'] },
});
await initializeSession({ token: 'your-session-token' });

const config: SelfieCaptureOnlyConfig = {
  showTutorial: true,
  showPreview: false,
  autoCaptureTimeout: 10,
  captureAttempts: 3,
  validateLenses: true,
  validateFaceMask: true,
  validateHeadCover: true,
  validateClosedEyes: true,
  validateBrightness: true,
  onCapture: async (response: FaceCaptureOnlyResponse) => {
    const { image } = response;
    await uploadToMyBackend(image.blob);
  },
};

const manager = createSelfieCaptureOnlyManager({ config });
manager.subscribe((state) => {
  if (state.status === 'finished') manager.stop();
});
manager.load();
```

The `FaceCaptureOnlyResponse` payload is:

```typescript
type FaceCaptureOnlyResponse = {
  image: FaceCapturedImageData;
};

type FaceCapturedImageData = {
  imageBase64: string; // The unprocessed full frame, base64-encoded
  blob: Blob; // Same content as Blob
  url: string; // Object-URL for direct rendering
  metadata: string; // Capture metadata (serialized)
  videoBase64: string | undefined; // Local-recording bytes — see note below
};
```

:::warning
  ### **Sensitive biometric payload.** Capture-only delivers **unprocessed biometric data** directly to your code. The standard selfie flow encrypts the upload payload at the transport layer; capture-only does not — the bytes leave the SDK as plain base64 / Blob and you are responsible for handling and transmitting them securely.

  The standard capture-only factory does not enable recording and has no recording flag. Its shared response type includes `videoBase64`, but this path normally leaves it `undefined`; do not depend on a video artifact. Protect image data in transit and storage.
:::

`createSelfieCaptureOnlyManagerFromActor` is also exported for advanced cases where you supply a pre-built XState actor.

## Configuration Options

`SelfieConfig` is `FlowModuleConfig['SELFIE'] & BaseFaceCaptureConfig`. The `FlowModuleConfig` half is the dashboard-driven shape and its fields are required from your perspective; `BaseFaceCaptureConfig` adds a few optional UI overrides.

> **Orchestrated vs headless:** when `<incode-selfie>` runs inside `<incode-flow>` (or `createOrchestratedFlowManager`), the orchestrator supplies the complete dashboard configuration. `createSelfieManager({ config })` also requires a complete configuration. The standalone `<incode-selfie>.config` property accepts partial overrides and resolves remaining dashboard fields when configuration merging is enabled (the default).

| Option                                 | Type                                                                 | Required | Description                                                                                                                                                                                                                                                                                                                                                                    |
| -------------------------------------- | -------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `showTutorial`                         | `boolean`                                                            | ✅        | Show tutorial before capture                                                                                                                                                                                                                                                                                                                                                   |
| `showPreview`                          | `boolean`                                                            | ✅        | Show preview after capture                                                                                                                                                                                                                                                                                                                                                     |
| `assistedOnboarding`                   | `boolean`                                                            | ✅        | Staff-assisted mode: use the back camera with no mirroring. Devices without a back camera keep the front camera and stay mirrored — read `usingBackCamera` from capture state to know which applies                                                                                                                                                                            |
| `enableFaceRecording`                  | `boolean`                                                            | ✅        | Enable client-side video recording streamed through multipart upload                                                                                                                                                                                                                                                                                                            |
| `autoCaptureTimeout`                   | `number`                                                             | ✅        | Seconds before auto-capture triggers                                                                                                                                                                                                                                                                                                                                           |
| `captureAttempts`                      | `number`                                                             | ✅        | Maximum capture attempts                                                                                                                                                                                                                                                                                                                                                       |
| `validateLenses`                       | `boolean`                                                            | ✅        | Reject captures with glasses/lenses                                                                                                                                                                                                                                                                                                                                            |
| `validateFaceMask`                     | `boolean`                                                            | ✅        | Reject captures with face mask                                                                                                                                                                                                                                                                                                                                                 |
| `validateHeadCover`                    | `boolean`                                                            | ✅        | Reject captures with head coverings                                                                                                                                                                                                                                                                                                                                            |
| `validateClosedEyes`                   | `boolean`                                                            | ✅        | Reject captures with eyes closed                                                                                                                                                                                                                                                                                                                                               |
| `validateBrightness`                   | `boolean`                                                            | ✅        | Reject captures with poor lighting                                                                                                                                                                                                                                                                                                                                             |
| `deepsightLiveness`                    | `'SINGLE_FRAME' \| 'MULTIMODAL' \| 'VIDEOLIVENESS'`                  | ✅        | Liveness detection mode                                                                                                                                                                                                                                                                                                                                                        |
| `numberOfAttempts`                     | `number`                                                             | ❌        | Legacy alias for `captureAttempts`. Prefer `captureAttempts`.                                                                                                                                                                                                                                                                                                                  |
| `cameraResolution`                     | `{ width?: number; height?: number }`                                | ❌        | Preferred camera resolution                                                                                                                                                                                                                                                                                                                                                    |
| `ageAssurance`                         | `boolean`                                                            | ❌        | Show the age-assurance copy variant in the tutorial. Mirrors the flow-level age-assurance flag — when `true`, the `tutorial` state surfaces `ageAssurance: true` so the UI renders the alternate copy. Because this copy is the age-assurance privacy notice, the tutorial is shown even when `showTutorial` is `false` (matching the ID module's `ageVerification` behavior). |
| `onDeviceFaceResultsSubmissionEnabled` | `boolean`                                                            | ❌        | Opt-in. When `true`, face analysis runs entirely on-device and only the results are submitted to the server. Has E2EE and WASM-pipeline prerequisites — see [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/) for the full walkthrough. Leave off to keep the legacy server-side pipeline.                                                                        |
| `selfieConcealmentOption`              | `'OPTION_NONE' \| 'OPTION_SILHOUETTE' \| 'OPTION_2D' \| 'OPTION_3D'` | ❌        | Conceals the on-screen camera preview with a cosmetic avatar. See [Face concealment](#face-concealment) below. Default `OPTION_NONE` (live preview).                                                                                                                                                                                                                           |
| `avatarAssets`                         | `AvatarAssetsOverrides`                                              | ❌        | Where to load the avatar runtime from. Only read when `selfieConcealmentOption` selects an avatar. See [Self-hosting the avatar runtime](#self-hosting-the-avatar-runtime) below.                                                                                                                                                                                              |

## Face concealment

**Privacy Lens** is the `OPTION_SILHOUETTE` concealment option. `selfieConcealmentOption` replaces the live camera preview with a cosmetic stand-in, for flows where users are reluctant to see themselves on screen:

| Value               | On-screen preview                          |
| ------------------- | ------------------------------------------ |
| `OPTION_NONE`       | The live camera feed. This is the default. |
| `OPTION_SILHOUETTE` | A frosted-glass treatment over the feed.   |
| `OPTION_2D`         | A stylized 2D face.                        |
| `OPTION_3D`         | A 3D character.                            |

The option is **display-only**. Face detection, quality checks, liveness, age estimation, and upload all continue to run on the real camera frames, so concealment never changes the verification result. An absent or unrecognized value renders the live preview.

Inside `<incode-flow>` or `createOrchestratedFlowManager`, the value comes from the SELFIE node configuration in your dashboard and the orchestrator passes it through — you do not set it yourself. Standalone integrators set the field on `config` directly.

### Self-hosting the avatar runtime

The avatar options load their runtime — a face-tracking library and the avatar assets — from Incode's CDN. Deployments that block third-party origins can serve them from their own host with `avatarAssets`:

```ts
const config: Partial<SelfieConfig> = {
  selfieConcealmentOption: 'OPTION_2D',
  avatarAssets: { basePath: 'https://your-cdn.example.com/incode-avatar' },
};
```

| Field      | Type     | Description                                                                |
| ---------- | -------- | -------------------------------------------------------------------------- |
| `basePath` | `string` | Serves every avatar asset from this directory instead of the default host. |
| `version`  | `string` | Selects a specific asset release within `basePath`.                        |

Per-asset path overrides also exist for deployments that cannot keep the expected directory layout. Ask your Incode account team for the asset manifest and required headers before mirroring — the file set differs per avatar option, and a partial mirror falls back to the live camera preview rather than failing loudly.

Omit `avatarAssets` and the SDK uses its defaults. The field is read only when `selfieConcealmentOption` selects an avatar, so it has no effect on `OPTION_NONE`.

## Troubleshooting

### Face Not Detected

- Ensure good lighting (avoid backlighting)
- Remove glasses or hats if possible
- Position face within the outline
- Check WASM is properly initialized

### Camera Issues

- Ensure HTTPS (camera requires secure context)
- Check browser permissions
- Try closing other apps using camera
- See [Troubleshooting – Camera Issues](/sdk-reference/web-sdk-2-troubleshooting/#camera-issues)

### Upload Errors

- Check network connectivity
- Verify session token is valid
- Check WASM files are accessible

## See Also

- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Complete headless API reference
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): Setting up WebAssembly
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Overview of all modules

---

- Path: `sdk-reference/web-sdk-2-module-signature`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-signature/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-signature.md

# Signature Module

<Component slug="web-2-x-implementation-warning" />

The Signature module captures a handwritten signature on a touch surface or mouse-driven canvas and uploads it to the backend.

> Follows a slim variant of the [document-signing pattern](/sdk-reference/web-sdk-2-module-patterns/#4-document-signing-modules) — there's no document review or consent step, just capture-and-submit. See the patterns page for the shared lifecycle.

## Tag

`<incode-signature>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/signature';
import '@incodetech/web/signature/styles.css';
```

## Properties

| Property   | Type                      | Required | Description                            |
| ---------- | ------------------------- | -------- | -------------------------------------- |
| `config`   | `SignatureConfig`         | ❌       | Configuration options                  |
| `onFinish` | `() => void`              | ❌       | Called when the signature is submitted |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs            |

## Configuration

```typescript
type SignatureConfig = {
  type?: string;
  title?: string;
  subTitle?: string;
  sendBase64?: boolean;
  canvasBackgroundColor?: string;
  penStrokeWidth?: number;
  penColor?: string;
  canvasBorderColor?: string;
};
```

| Option                  | Type      | Required | Description                                                                                          |
| ----------------------- | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `type`                  | `string`  | ❌       | Backend-side signature type identifier.                                                              |
| `title`                 | `string`  | ❌       | Optional header title. Defaults to a translated "Draw your signature" copy.                          |
| `subTitle`              | `string`  | ❌       | Optional subtitle. Note the capital T (matches the backend field).                                   |
| `sendBase64`            | `boolean` | ❌       | When `true`, upload as base64 JSON (Omni v2). When `false` (default), upload raw `image/jpeg` bytes. |
| `canvasBackgroundColor` | `string`  | ❌       | CSS color or `var(--token)` for the drawing area background.                                         |
| `penStrokeWidth`        | `number`  | ❌       | Maximum stroke width in CSS pixels (passed through to `signature_pad`'s `maxWidth`).                 |
| `penColor`              | `string`  | ❌       | Ink color.                                                                                           |
| `canvasBorderColor`     | `string`  | ❌       | Border color of the drawing surface.                                                                 |

## State machine

`SignatureState` is a discriminated union over `status`:

| Status       | Description                             |
| ------------ | --------------------------------------- |
| `idle`       | Initial state.                          |
| `capture`    | User is drawing on the canvas.          |
| `submitting` | Uploading the captured signature image. |
| `success`    | Upload accepted.                        |
| `finished`   | Terminal.                               |
| `error`      | Fatal error.                            |

## API methods

| Method                       | Purpose                                                                      |
| ---------------------------- | ---------------------------------------------------------------------------- |
| `load()`                     | Start the machine; transitions to `capture`.                                 |
| `setSignatureValid(isValid)` | Update validity (e.g., enabled when the canvas has at least one stroke).     |
| `submit(image)`              | Submit the signature. `image` is a base64 string or `Blob` per `sendBase64`. |

Plus the universal lifecycle: `subscribe`, `getState`, `reset`, `stop`.

## See also

- [Module: Electronic Signature](/sdk-reference/web-sdk-2-module-electronic-signature/): multi-document PDF flow with consent checkboxes
- [Module Patterns → document-signing](/sdk-reference/web-sdk-2-module-patterns/#4-document-signing-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-video-selfie`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-video-selfie/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-video-selfie.md

# Video Selfie Module

<Component slug="web-2-x-implementation-warning" />

The Video Selfie module runs selfie, ID, and optional voice-consent capture as one continuous camera session, recorded on-device and uploaded alongside the captures. The camera switches between front and rear while a single composited recording follows it, so the user sees one uninterrupted experience instead of a sequence of separate capture screens.

This module combines [camera-capture](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules) and [composite / orchestrator](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules) traits: it owns several capture steps and drives its own step progression.

## Tag

`<incode-video-selfie>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/video-selfie';
import '@incodetech/web/video-selfie/styles.css';
```

## Properties

| Property   | Type                                   | Required | Description                       |
| ---------- | -------------------------------------- | -------- | --------------------------------- |
| `config`   | `VideoSelfieConfig`                    | ❌        | Configuration options             |
| `onFinish` | `() => void`                           | ❌        | Called when the session completes |
| `onError`  | `(error: string \| undefined) => void` | ❌        | Called when an error occurs       |

## Configuration

`VideoSelfieConfig` mirrors the backend `VIDEO_ONBOARDING` workflow module, so inside `<incode-flow>` or `<incode-workflow>` the orchestrator supplies it from Dashboard. Standalone integrators set it on `config` directly.

`config.steps` can explicitly select and order the capture steps. When absent or empty, the SDK derives the order from options such as `checkIdScan` and `checkVoiceConsent`.

| Option                      | Type      | Description                                                                                      |
| --------------------------- | --------- | ------------------------------------------------------------------------------------------------ |
| `steps` | `VideoSelfieStep[]` | Optional ordered capture steps. An absent or empty list uses the derived order. |
| `maxWaitingVideoSelfieFile` | `number` | Maximum recording duration in seconds, supplied by Dashboard. It is not an upload timeout. |
| `useAsSelfie`               | `boolean` | Treat the captured selfie as the session's selfie, so a separate Selfie step is unnecessary.     |
| `showTutorials`             | `boolean` | Show the tutorial screen before capture. When `false`, the module starts at the permission step. |
| `companyName`               | `string`  | Company name shown in the consent copy.                                                          |
| `checkLiveness`             | `boolean` | Run liveness checks on the selfie step.                                                          |
| `checkIdScan`               | `boolean` | Add the front and back ID capture steps.                                                         |
| `checkDocumentScan`         | `boolean` | Add the proof-of-address document step.                                                          |
| `compareIdEnabled`          | `boolean` | Compare the captured face against the ID portrait.                                               |
| `compareOcrEnabled`         | `boolean` | Compare OCR data from the front of the ID.                                                       |
| `compareBackIdEnabled`      | `boolean` | Compare against the back of the ID.                                                              |
| `compareBackOcrEnabled`     | `boolean` | Compare OCR data from the back of the ID.                                                        |
| `checkVoiceConsent`         | `boolean` | Add the spoken-consent step.                                                                     |
| `voiceConsentQuestions`     | `number`  | How many consent questions to ask.                                                               |
| `numberOfTries`             | `number`  | Validation attempts per capture and voice step. Default `3`; `-1` means unlimited.               |
| `speechToTextCheck`         | `boolean` | Validate the consent audio server-side. Default `true`.                                          |
| `selfieQualityAffectsScore` | `boolean` | Let selfie quality contribute to the session score.                                              |
| `validateClosedEyes`        | `boolean` | Reject frames where the eyes are closed.                                                         |
| `validateFaceMask`          | `boolean` | Reject frames where a face mask is present.                                                      |
| `validateHeadCover`         | `boolean` | Reject frames where a head covering obscures the face.                                           |
| `validateLenses`            | `boolean` | Reject frames where glasses or lenses interfere.                                                 |

Pass Dashboard-provided quality-check settings through unmodified. The recording duration limit applies to the active recording, including capture steps.

## Steps

`VideoSelfieStep` is the set of capture steps a session can run, in flow order:

| Step        | Camera | Description                                    |
| ----------- | ------ | ---------------------------------------------- |
| `selfie`    | Front  | Face capture with liveness and quality checks. |
| `frontId`   | Rear   | Front of the ID document.                      |
| `backId`    | Rear   | Back of the ID document.                       |
| `poa`       | Rear   | Proof-of-address document.                     |
| `questions` | Front  | On-screen consent questions.                   |
| `speech`    | Front  | Spoken consent, recorded for verification.     |

For example, `steps: ['selfie', 'frontId', 'backId']` keeps that order. A nonempty top-level `steps` option on `createVideoSelfieRecordingManager` takes precedence over `config.steps`. If both are absent or empty, the derived order is ID sides, optional proof of address, Selfie, then configured questions and speech.

## State machine

`VideoSelfieRecordingState` carries a `status` plus live step and detection detail:

| Status               | Description                                                                      |
| -------------------- | -------------------------------------------------------------------------------- |
| `idle`               | Initial state, waiting for `start()`.                                            |
| `starting`           | Acquiring the first camera and opening the upload.                               |
| `recording`          | Capturing the active step.                                                       |
| `validationFeedback` | A validation check failed; the module dwells to show the reason before retrying. |
| `flippingId`         | Prompting the user to turn the ID over between the front and back steps.         |
| `switchingCamera`    | Moving between front and rear cameras for the next step.                         |
| `finalizing`         | Finishing the upload after the last step.                                        |
| `success`            | Upload accepted. Carries `recordingId`.                                          |
| `finished`           | Terminal.                                                                        |
| `error`              | Failed. Carries `error` and `errorKind`.                                         |
| `aborted`            | The session was abandoned without finalizing.                                    |

State properties:

| Property            | Type                          | Description                                                                                                                         |
| ------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `step`              | `VideoSelfieStep?`            | The active capture step.                                                                                                            |
| `stepIndex`         | `number`                      | Zero-based index of the active step.                                                                                                |
| `isLastStep`        | `boolean`                     | Whether advancing finalizes the session.                                                                                            |
| `stream`            | `MediaStream?`                | The raw camera for the active step. Render this as the preview.                                                                     |
| `composite`         | `MediaStream?`                | The composited recording output that follows camera switches. Not for preview.                                                      |
| `detectionStatus`   | `string?`                     | Live capture feedback for the active step — show it as guidance.                                                                    |
| `orientation`       | `DetectionOrientation?`       | Document orientation when the detector reports one, so an ID mask can follow a rotated document. `undefined` keeps the fixed frame. |
| `validationFailure` | `object?`                     | Why the current attempt failed, during a `validationFeedback` dwell.                                                                |
| `attemptsRemaining` | `number`                      | Attempts left on the active step. `-1` means unlimited.                                                                             |
| `recordingId`       | `string \| null`              | The completed upload id, available during `success` and `finished`.                                                                 |
| `error`             | `string?`                     | Failure detail when `status === 'error'`.                                                                                           |
| `errorKind`         | `'connection' \| 'technical' \| 'maxVideoLengthReached' \| 'validationAttemptsExhausted'` | Failure category; the duration-limit and exhausted-validation kinds cannot retry.                                         |

## API methods

| Method       | Purpose                                                                         | Callable when                 |
| ------------ | ------------------------------------------------------------------------------- | ----------------------------- |
| `start()`    | Acquire the camera, open the upload, and begin recording.                       | `idle`                        |
| `nextStep()` | Advance to the next step, switching cameras when needed. Finalizes on the last. | `recording`                   |
| `retry()`    | Retry the active step after a validation failure or error.                      | `validationFeedback`; `error` only for recoverable `connection` or `technical` failures |
| `abort()`    | Abandon the session without finalizing the upload.                              | Any active status             |

Plus the universal lifecycle: `subscribe`, `getState`, `stop`.

### Terminal errors

`maxVideoLengthReached` means the configured recording duration has elapsed. Do not offer retry. The SDK completes the recorded upload, briefly displays the limit message, then reaches `finished` so Flow can advance.

`validationAttemptsExhausted` means the allowed validation attempts have ended. Do not retry or restart that attempt in place. A standalone component reports it through `onError` with `moduleErrorCode: 'VIDEO_SELFIE_VALIDATION_ATTEMPTS_EXHAUSTED'`. Flow handles that terminal module outcome by advancing the configured journey; it is not a successful verification result.

Headless hosts should branch on `errorKind`, preserve session-result handling, and stop the manager when leaving the surface.

## Headless usage

```typescript
import { setup } from '@incodetech/core';
import { createVideoSelfieRecordingManager } from '@incodetech/core/video-selfie';

await setup({ apiURL, token });

const manager = createVideoSelfieRecordingManager({ config });

manager.subscribe((state) => {
  if (state.status === 'recording') {
    renderPreview(state.stream, {
      step: state.step,
      guidance: state.detectionStatus,
      attemptsLeft: state.attemptsRemaining,
    });
  }
  if (state.status === 'finished') {
    onDone(state.recordingId);
  }
});

manager.start();
```

Render `state.stream` as the preview, not `state.composite` — the composite exists to keep one continuous recording across camera switches.

Creating the manager starts its required WASM warmup. `manager.start()` waits for that warmup before it acquires the camera, and reports a retryable technical error if warmup fails.

`@incodetech/core/video-selfie` also exports helpers for building your own capture screen: `resolveVideoSelfieSteps` (which steps a config runs), `facingModeForStep`, `createVideoSelfieCameraWarmer` (warm the camera before the user reaches the step), `getVideoSelfieQuestions` and `getVoiceConsentPhrase` (consent copy), and `createConsentRecorder`.

## App background recovery

When the browser moves to the background, the module pauses recording and capture validation. The open upload and completed video chunks remain unchanged.

When the browser returns, the module waits for a new camera frame before it resumes recording. The module acquires the video camera again if necessary.

If the audio track or recorder cannot recover, the module reports a technical error. The user can retry with a new recording.

The module does not complete a recording with a frozen background interval.

## WASM requirement

The resolved steps determine pipelines: `selfie` needs `videoSelfie`; `frontId` or `backId` needs `videoSelfieId`. This also applies to explicit step lists. The Core recording manager automatically loads exactly what its config needs. You can still call `warmupVideoSelfieWasm(config, steps)` earlier for explicit preloading, or derive the list with `videoSelfieWasmPipelines(config, steps)` and pass it to `setup({ wasm: { pipelines } })`.

## See also

- [Module Patterns → camera-capture](/sdk-reference/web-sdk-2-module-patterns/#2-camera-capture-modules)
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/)
- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): the single-step selfie capture module
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-watchlist`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-watchlist/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-watchlist.md

# Watchlist Module

<Component slug="web-2-x-implementation-warning" />

The Watchlist module runs a backend sanctions / PEP / global watchlist screening on the user's identity data already collected in the session. Fire-and-forget — completes regardless of API outcome.

> Follows the [backend-process pattern](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules). See the patterns page for the shared lifecycle.

## Availability

This module is headless-only — there is no public `<incode-watchlist>` web component. Drive it with `createWatchlistManager` from `@incodetech/core/watchlist`. It's typically invoked from an orchestrated flow rather than mounted standalone.

## Configuration

The module takes no configuration:

```typescript
type WatchlistConfig = Record<string, never>;
```

The watchlist sources (OFAC, PEP, etc.) and threshold rules are configured in the Incode Dashboard, not on the client.

## State machine

`WatchlistState` is a discriminated union over `status`:

| Status       | Description                              |
| ------------ | ---------------------------------------- |
| `idle`       | Initial state.                           |
| `processing` | Backend screening in progress.           |
| `success`    | Screening completed; data is on `state`. |
| `finished`   | Terminal.                                |

## Related modules

- **Custom Watchlist** ([Module-Custom-Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/)): checks the user's face against a customer-provided blocklist.
- **Watchlist for Business** ([Module-Watchlist-For-Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/)): collects business name + country and screens against the business watchlist endpoint. Form-based, not pure backend-process.

## See also

- [Module Patterns → backend-process](/sdk-reference/web-sdk-2-module-patterns/#3-backend-process-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-watchlist-for-business`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-watchlist-for-business/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-watchlist-for-business.md

# Watchlist for Business Module

<Component slug="web-2-x-implementation-warning" />

The Watchlist for Business module collects a country and business name from the user, then screens against Incode's business-watchlist endpoint. Differs from the personal Watchlist modules in that it has user input — it's a form-based flow followed by a backend submit.

This module follows the [form-based pattern](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules).

## Availability

This module is headless-only — there is no public `<incode-watchlist-for-business>` web component. Drive it with `createWatchlistForBusinessManager` from `@incodetech/core/watchlist-for-business`.

## Configuration

The module takes no configuration:

```typescript
type WatchlistForBusinessConfig = Record<string, never>;
```

Country list and threshold rules are configured server-side.

## State machine

`WatchlistForBusinessState` is a discriminated union over `status`:

| Status       | Description                                          |
| ------------ | ---------------------------------------------------- |
| `idle`       | Initial state.                                       |
| `form`       | Rendering the form (country + business name inputs). |
| `submitting` | Submitting the form to the backend.                  |
| `success`    | Submission accepted.                                 |
| `finished`   | Terminal.                                            |

### Form-state properties

| Property | Type | Description |
| --- | --- | --- |
| `country` | `string` | Selected ISO country code. |
| `businessName` | `string` | Current business name. |
| `isValid` | `boolean` | Current input validity. |
| `validationErrors` | `{ businessName?: string }` (optional) | Translation key for the required-name error. |
| `canSubmit` | `boolean` | Whether Continue is enabled. |

These properties exist only in `form`. In 2.3.0, `canSubmit` is optimistic: Continue starts enabled and required-field errors appear after a failed submit. It does not prove completeness.

## API methods

| Method | Purpose | Callable when |
| --- | --- | --- |
| `load()` | Enter the form. Call this before setting inputs. | `idle` |
| `setCountry(country)` | Set the ISO country code. | `form` |
| `setBusinessName(value)` | Set the business name. | `form` |
| `submit()` | Validate and submit the inputs. | `form` |

```typescript
import { createWatchlistForBusinessManager } from '@incodetech/core/watchlist-for-business';

const manager = createWatchlistForBusinessManager();
manager.load();
if (manager.getState().status === 'form') {
  manager.setCountry('US');
  manager.setBusinessName('Example Business');
  // Submit in response to the user's Continue action:
  manager.submit();
}
```

Subscribe before loading to render state changes. On teardown, unsubscribe and call `stop()`; create a new manager for a new verification.

## See also

- [Module: Watchlist](/sdk-reference/web-sdk-2-module-watchlist/): personal sanctions / PEP screening
- [Module: Custom Watchlist](/sdk-reference/web-sdk-2-module-custom-watchlist/): face-based blocklist
- [Module Patterns → form-based](/sdk-reference/web-sdk-2-module-patterns/#1-form-based-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-module-workflow`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-module-workflow/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-module-workflow.md

# Workflow Module

<Component slug="web-2-x-implementation-warning" />

The Workflow module runs server-driven multi-step workflows where step ordering and configuration come from the backend per session. Unlike the dashboard-defined Flow, a Workflow lets the server emit nodes dynamically — including custom-module nodes that callbacks back into your code.

This module follows the [composite / orchestrator pattern](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules), with an additional `asyncResolution` state for server-side processing nodes.

## Tag

`<incode-workflow>` is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

```ts
import '@incodetech/web/workflow';
import '@incodetech/web/workflow/styles.css';
```

## Self-loading vs. token mode

`<incode-workflow>` supports two bootstrap modes.

**Token mode**: create the session on your backend, then pass the resulting token to the component. This is the recommended production path because the API key stays server-side.

```ts
<incode-workflow config={{ token: sessionToken }} onFinish={handleFinish} />
```

**Self-loading mode**: the component creates its own session by calling `/omni/start` with a `configurationId` and either an `apiKey` or a `clientId`. The API key is exposed in the browser, so this mode is suitable for prototyping and internal tools only.

```ts
<incode-workflow
  config={{ apiKey: process.env.INCODE_API_KEY, configurationId: 'cfg-id' }}
  onFinish={handleFinish}
/>
```

When self-loading mode receives a 4028 error (workflow not activated), the SDK renders its built-in terminal error screen. No additional error handling is required from the host page.

## Properties

| Property   | Type                      | Required | Description                        |
| ---------- | ------------------------- | -------- | ---------------------------------- |
| `config`   | `WorkflowComponentConfig` | ❌       | Token-mode or self-loading config  |
| `onFinish` | `() => void`              | ❌       | Called when the workflow completes |
| `onError`  | `(error: string) => void` | ❌       | Called when an error occurs        |

## Configuration

`WorkflowConfig` is fetched from the backend via `GET /omni/workflow/info`:

```typescript
type WorkflowConfig = {
  id: string;
  name: string;
  redirectDesktopToMobile: boolean;
  disableSmsOption?: boolean;
  addContinueToDesktop?: boolean;
  qrPhishingResistance?: boolean;
  disableUnsupportedBrowserScreen?: boolean;
  oauth2Secured?: boolean;
  ds?: boolean; // Deepsight enabled
  mergeSessionRecordings?: boolean;
  ageAssurance?: boolean;
  disableLaunchScreen?: boolean;
  showFinishScreenBySessionStatus?: boolean;
};
```

The shape is largely informational — the workflow nodes themselves drive what runs. The boolean flags propagate to sub-modules (e.g., `mergeSessionRecordings` and `ageAssurance` to ID Capture; `ds` to Selfie).

`disableLaunchScreen` controls the SDK's built-in launch / home screen. When the backend sets it to `true`, the SDK skips the launch screen and goes straight to the first workflow node. When `false` (or omitted), the workflow surfaces a `homeScreen.visible === true` state — the consumer must render the launch screen and call `continueFromHome()` on user confirmation.

`disableUnsupportedBrowserScreen` controls the browser-not-supported screen. `<incode-workflow>` always uses this server value and ignores the host `uiConfig` and per-element options. It does the browser check after the workflow config loads but before the launch screen. In headless mode, the `loading` state carries `workflowConfig` after the config loads, so your UI can read this flag while the launch screen shows. See [Browser support](/sdk-reference/incode-web-sdk-2-reference/#hide-the-browser-not-supported-screen).

### Digital ID bank redirect

When a workflow's ID Capture node offers a bank-redirect digital ID such as iDIN or FTN, pass `digitalIdReturnUrl` in the component `config` and `digitalIdReturn` on the page load that follows the bank's redirect back. These are the same two fields with the same wiring as on `<incode-flow>`. The return URL defaults to the current page. See [Digital ID — Bank Redirect](/sdk-reference/digital-id-redirect/#configuration).

When `digitalIdReturn` is set, the workflow resumes on the node the user left from. The launch screen and the desktop-to-mobile handoff are skipped because the user already went through both before the redirect. Headless integrations get the same behavior by passing `isReturnLeg: true` to `createWorkflowManager`.

### Status-specific finish screen

With `showFinishScreenBySessionStatus` enabled, `<incode-workflow>` renders one of three built-in terminal screens based on the session's overall result instead of a single generic completion screen. Enable it per workflow in Dashboard, not in code.

The public status is `loading`, carrying `homeScreen` while resolving the session result on the desktop-QR path. Render a loading presentation. `completing` is a separate public status for completing the workflow before its terminal node arrives.

The session's score maps to one of three variants:

| Variant   | Session score                    | Meaning                                             |
| --------- | -------------------------------- | --------------------------------------------------- |
| `success` | `OK`, `WARN`, `MANUAL_OK`        | Verification passed.                                |
| `error`   | `FAIL`, `UNKNOWN`, `MANUAL_FAIL` | Verification failed. An absent score maps here too. |
| `review`  | `MANUAL`, `MANUAL_PENDING`       | Awaiting manual review.                             |

To classify the result yourself, to render your own screens, or to branch after `onFinish`, `@incodetech/core/flow` exports the same helpers the SDK uses:

```ts
import {
  getTotalScoreStatus,
  classifyScoreStatus,
  type TotalScore,
  type FinishScreenVariant,
} from '@incodetech/core/flow';

const score: TotalScore = await getTotalScoreStatus();
const variant: FinishScreenVariant = classifyScoreStatus(score); // 'success' | 'error' | 'review'
```

`classifyScoreStatus` is pure and returns `'error'` for an unknown or absent score, so it always yields a variant you can render.

## State machine

`WorkflowState` is a discriminated union over `status`. `idle`, `loading`, and `ready` additionally carry a `homeScreen: { visible: boolean; isContinueLoading: boolean }` property — see [Launch screen](#launch-screen) below.

| Status            | Description                                                                                                                                                                                                    | Properties                                                             |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `idle`            | Initial state before `load()`                                                                                                                                                                                  | `homeScreen`                                                           |
| `loading`         | Fetching the next node from the workflow server                                                                                                                                                                | `homeScreen`                                                           |
| `completing`      | Finishing up after the last module completes, just before the terminal node arrives. Shown as its own status so the UI can render a "Hold on…" processing screen instead of a text-less transition spinner.    | `homeScreen`                                                           |
| `ready`           | Current `WorkflowNode` is active. Render the corresponding sub-module.                                                                                                                                         | `workflowConfig`, `currentNode`, `config`, `moduleState`, `homeScreen` |
| `asyncResolution` | Server is processing async; UI shows progress until the next node arrives.                                                                                                                                     | `workflowConfig`, `currentNode`                                        |
| `finished`        | Terminal — workflow's last node was a `FINISH` node.                                                                                                                                                           | `workflowConfig`, `finishStatus`, `scoreStatus`                                       |
| `closed`          | User dismissed                                                                                                                                                                                                 | –                                                                      |
| `error`           | Fatal error                                                                                                                                                                                                    | `error?`, `errorCode?`, `moduleErrorCode?` |

### Launch screen

When the backend does not set `WorkflowConfig.disableLaunchScreen`, the workflow exposes a launch / home screen overlay before running the first node. The overlay is signalled via `state.homeScreen.visible`:

- Render your launch screen when `homeScreen.visible === true`.
- Call `manager.continueFromHome()` on user confirmation; `homeScreen.isContinueLoading` becomes `true` while the orchestrator finishes loading the first module.
- When `disableLaunchScreen` is `true`, the SDK never sets `homeScreen.visible` and you can skip rendering the overlay entirely.
- On a return leg (`isReturnLeg: true`, set by `<incode-workflow>` whenever `digitalIdReturn` is passed), the launch screen is not shown again. See [Digital ID bank redirect](#digital-id-bank-redirect).

Each `WorkflowNode` carries:

```typescript
type WorkflowNode = {
  id: string;
  nodeType: 'MODULE' | 'FINISH' | 'ASYNC_RESOLUTION';
  moduleKey: string; // e.g., 'PHONE', 'SELFIE', 'CUSTOM_MODULE'
  moduleConfiguration: Record<string, unknown>;
  status: string;
  workflowId: string;
};
```

## API methods

| Method                 | Description                                                                                                                                                                                                                                                  |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `load()`               | Start loading the workflow configuration and the first node from the backend. Call once.                                                                                                                                                                     |
| `completeModule()`     | Mark the current module as complete. Call from the active module's `onFinish` callback to advance to the next node.                                                                                                                                          |
| `errorModule(error?, moduleErrorCode?)` | Report a module failure. Supported module error codes can advance to the next step or completion; other failures enter `error`. Forward the module code unchanged so the SDK applies the appropriate behavior. |
| `completeFlow()` | Complete early, skipping remaining steps and notifying the backend. |
| `finishWorkflow()`     | Land on the completion screen without asking the backend for a finish status. Call this — not `completeFlow()` — from `REDIRECT_TO_MOBILE`'s `onFinish`, because mobile already reported completion and the desktop's current node is not the `FINISH` node. |
| `continueFromHome()`   | Advance past the SDK's launch / home screen. Only meaningful when `state.homeScreen.visible === true`; no-op otherwise (e.g. when `disableLaunchScreen` is `true`).                                                                                          |
| `getModuleConfig<T>()` | Returns the current node's `moduleConfiguration` merged with workflow-level flags (`ds`). Typed via the generic parameter.                                                                                                                                   |
| `getState()`           | Get the current workflow state synchronously.                                                                                                                                                                                                                |
| `subscribe(callback)`  | Subscribe to workflow state changes (returns an unsubscribe function).                                                                                                                                                                                       |
| `subscribeFlowEvent(listener)` | Subscribe to curated flow milestones; returns an unsubscribe function. See [headless flow events](/sdk-reference/web-sdk-2-event-callbacks/#headless-flow-events). |

Call `stop()` to release resources on teardown. Start a new manager after a final state; `reset()` is not a universal manager method.

## Custom module callback

Workflows can include `CUSTOM_MODULE` nodes that hand control back to your code. Wire a `CustomModuleCallback` to handle them — it receives `interviewId`, `nodeId`, and the configured `name`, plus `onSuccess` / `onError` hooks that advance the workflow.

```typescript
import { createWorkflowManager } from '@incodetech/core/workflow';

const manager = createWorkflowManager({
  interviewId: 'YOUR_SESSION_INTERVIEW_ID',
  customModuleCallback: ({ interviewId, nodeId, name, onSuccess, onError }) => {
    // Run your custom logic here, then call one of:
    onSuccess('Custom check passed');
    // or onError('Something went wrong');
  },
});
```

Pass the interview ID from the active session when using custom-module callbacks. The manager fetches workflow configuration itself; it does not accept a `config` option.

## See also

- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): the dashboard-driven flow alternative
- [Module Patterns → composite](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules)
- [Headless Mode → Orchestrated Flow Manager](/sdk-reference/web-sdk-2-headless-mode/#orchestrated-flow-manager)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)

---

- Path: `sdk-reference/web-sdk-2-on-device-face-capture`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-on-device-face-capture/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-on-device-face-capture.md

# On-Device Face Capture

<Component slug="web-2-x-implementation-warning" />

On-device face capture runs the full face-analysis pipeline (detection, positioning feedback, liveness, age estimation) inside the user's browser via WebAssembly. The captured selfie image **never leaves the device** — the SDK submits only the analysis results JSON to the server. Video recording is skipped on this path.

> Opt-in. Default Selfie / Authentication runs server-side face analysis, where the captured frame is encrypted and uploaded for the backend pipeline to score.

## When to enable it

Reach for on-device face capture when:

- **Privacy or data-residency posture** requires keeping biometric image bytes off Incode's infrastructure.
- **Bandwidth-sensitive** environments (slow / unstable networks) make image upload unreliable but result JSON is small enough to send.
- **Regulatory** requirements bar the raw image from leaving the client.

If none of those apply, the server-side default is the recommended path — the backend pipeline has access to additional anti-spoof signals that aren't replicated on-device.

## Requirements

Four things must line up. Missing any one of them and the path fails — usually at submission time, when the server rejects the request.

1. **E2EE configured at `setup()`**: On-device face results require the E2EE-provisioned host. You need both:
   - `encryption: true` (or `{ mgf1: 'sha256' }`, whichever your environment expects)
   - The dedicated E2EE `apiURL` Incode provisioned for your account
   - The `/0` suffix on `apiURL` **or** `customHeaders: { 'x-api-key': '<api key>' }` so the tenant can be identified
     See [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/) for provisioning requirements.
2. **WASM binary transport**: implied by E2EE, but worth stating. The on-device pipeline runs inside the same WASM binary as the encrypted transport. `setup({ wasm: false, ... })` is incompatible.
3. **The `onDeviceSelfie` WASM pipeline.** Optional preload: pass `wasm: { pipelines: ['selfie', 'onDeviceSelfie'] }` to `setup()` so the models are warm before the user reaches the camera step. If you omit `'onDeviceSelfie'`, the SDK lazy-loads it on first camera open — fine for slow flows, noticeable for fast ones.
4. **The config flag.** Set `onDeviceFaceResultsSubmissionEnabled: true` on the Selfie or Authentication config:
   ```ts
   import type { IncodeModuleProps } from '@incodetech/web/extensibility';
   import type { SelfieConfig, SelfieManager } from '@incodetech/core/selfie';

   type SelfieElement = HTMLElement & IncodeModuleProps<Partial<SelfieConfig>, void, SelfieManager>;
   const selfie = document.querySelector<SelfieElement>('incode-selfie');
   if (selfie) selfie.config = { onDeviceFaceResultsSubmissionEnabled: true };
   ```

## Full integration example

Use the standard `<incode-selfie>` web component and set `onDeviceFaceResultsSubmissionEnabled: true` on its `config`. The component drives capture and submission; you only need to wire `onFinish` / `onError`.

### Vanilla HTML / JavaScript

```html
<incode-selfie></incode-selfie>

<script type="module">
  import { setup } from '@incodetech/core';
  import { initializeSession } from '@incodetech/core/session';
  import '@incodetech/web/selfie';
  import '@incodetech/web/selfie/styles.css';

  // 1. Configure the SDK with E2EE + the on-device pipeline pre-warmed.
  await setup({
    apiURL: 'https://<your-incode-e2ee-host>/0', // Use the complete provisioned URL
    encryption: { mgf1: 'sha256' }, // pin SHA-256 when your E2EE env is provisioned for it
    wasm: { pipelines: ['selfie', 'onDeviceSelfie'] },
  });

  // 2. Activate your session token.
  await initializeSession({ token: 'your-session-token' });

  // 3. Configure <incode-selfie> with the on-device flag enabled.
  const selfie = document.querySelector('incode-selfie');
  selfie.config = {
    showTutorial: true,
    showPreview: false,
    assistedOnboarding: false,
    enableFaceRecording: false, // ignored on the on-device path anyway
    autoCaptureTimeout: 10,
    captureAttempts: 3,
    validateLenses: true,
    validateFaceMask: true,
    validateHeadCover: true,
    validateClosedEyes: true,
    validateBrightness: true,
    deepsightLiveness: 'SINGLE_FRAME',
    onDeviceFaceResultsSubmissionEnabled: true, // opt in
  };
  selfie.onFinish = () => console.log('On-device face capture complete');
  selfie.onError = (err) => console.error('Selfie error:', err);
</script>
```

### React

> **React 18 or earlier:** add the one-time JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags) so TypeScript recognizes the Incode tags. The example below uses a ref + `useEffect` to assign `config` / `onFinish` / `onError` because JSX attributes only accept strings. React 19+ doesn't need this — see [Framework Integration → React 19+ shortcut](/sdk-reference/web-sdk-2-framework-integration/#react-19-shortcut) for the simpler inline-prop form.

```tsx
import { useEffect, useRef } from 'react';
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';
import type { SelfieConfig } from '@incodetech/core/selfie';
import '@incodetech/web/selfie';
import '@incodetech/web/selfie/styles.css';

type SelfieElement = HTMLElement & {
  config?: SelfieConfig;
  onFinish: () => void;
  onError: (error: string) => void;
};

await setup({
  apiURL: 'https://<your-incode-e2ee-host>/0',
  encryption: { mgf1: 'sha256' }, // pin SHA-256 when your E2EE env is provisioned for it
  wasm: { pipelines: ['selfie', 'onDeviceSelfie'] },
});
await initializeSession({ token: 'your-session-token' });

export function OnDeviceSelfie() {
  const ref = useRef<SelfieElement>(null);

  useEffect(() => {
    const el = ref.current;
    if (!el) return;
    el.config = {
      showTutorial: true,
      showPreview: false,
      assistedOnboarding: false,
      enableFaceRecording: false,
      autoCaptureTimeout: 10,
      captureAttempts: 3,
      validateLenses: true,
      validateFaceMask: true,
      validateHeadCover: true,
      validateClosedEyes: true,
      validateBrightness: true,
      deepsightLiveness: 'SINGLE_FRAME',
      onDeviceFaceResultsSubmissionEnabled: true,
    };
    el.onFinish = () => console.log('On-device face capture complete');
    el.onError = (err) => console.error('Selfie error:', err);
  }, []);

  return <incode-selfie ref={ref} />;
}
```

> **Inside `<incode-flow>`?** When `<incode-selfie>` runs as part of `<incode-flow>` (or `createOrchestratedFlowManager`), the orchestrator passes the dashboard-configured `FlowModuleConfig['SELFIE']` to the component automatically — you do not set `selfie.config` yourself. Enable `onDeviceFaceResultsSubmissionEnabled` on the SELFIE module configuration in the Incode dashboard instead, and the flag flows through.

> **Going fully custom UI, or using Authentication?** The same `onDeviceFaceResultsSubmissionEnabled: true` flag works on the headless managers. See [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/).

## What changes on this path

| Aspect                            | Default (server-side)                                                       | On-device                                                                                |
| --------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Image bytes leave the device      | Yes — encrypted upload                                                      | No — only analysis results JSON                                                          |
| Video recording (`enableFaceRecording`) | Honored — local recording is assembled and uploaded if configured     | Skipped — the recording service is never created                                         |
| Required WASM pipelines           | `selfie`                                                                    | `selfie` + `onDeviceSelfie`                                                              |
| Setup complexity                  | Standard `setup({ apiURL, token })`                                         | E2EE provisioning + dedicated `apiURL` + `/0` or `x-api-key` + the `onDeviceSelfie` pipe |

## Caveats

- **Video recording is skipped.** The recording service is never created on this path, so `enableFaceRecording: true` is silently ignored. If you need a local video artifact, the on-device path isn't compatible — use a supported recording flow. The capture-only factory does not expose a recording configuration flag.
- **Locked at boot with E2EE.** You cannot flip between on-device and server-side at runtime in the same SDK boot — see [End-to-End Encryption → Constraints to know about](/sdk-reference/web-sdk-2-e2ee/#constraints-to-know-about).

## See also

- [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/): required prerequisite.
- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): config catalogue and full Selfie reference.
- [Module: Authentication](/sdk-reference/web-sdk-2-module-authentication/): same flag, returning-user re-auth.
- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/#when-wasm-is-required): the `onDeviceSelfie` pipeline entry.
- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): driving the Selfie / Authentication managers from custom UI.

---

- Path: `sdk-reference/web-sdk-2-reference`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-reference/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-reference.md

# Web SDK 2.0 API Reference

<Component slug="web-2-x-implementation-warning" />

## Setup

### setup()

Initialize the SDK before using any components.

### Which `setup()` do I call?

**You call one, never both.** Two packages export a `setup()`, and `@incodetech/web`'s version calls `@incodetech/core`'s for you:

```
your app ──▶ setup() from '@incodetech/web' ──calls──▶ setup() from '@incodetech/core'
                adds i18n, uiConfig, theme               apiURL, token, wasm, encryption, …

your app ──▶ setup() from '@incodetech/core'            (headless — the web layer is never loaded)
```

Start from what you render:

| You render                                              | Call                              | Why                                                                                |
| ------------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------- |
| Your own UI, driving headless managers                  | `setup()` from `@incodetech/core` | Nothing in the web layer needs configuring.                                        |
| Web components, and you have the session token          | `setup()` from `@incodetech/web`  | One call wires both layers, including language, branding, and the dashboard theme. |
| Web components, but you need `setup()` before the token | `setup()` from `@incodetech/core` | The web wrapper requires `token`; core's does not. See the trade-off below.        |

The web wrapper forwards every shared option to core unchanged, then adds `i18n`, `uiConfig`, and `theme`. Both entry points support `flow`; their feature-management option types differ as described below.

#### When you deliberately use core's `setup()` with web components

Two things pull integrators back to the core entry point even when they render components:

- **You want `setup()` to run before the session token exists**, so WASM warmup overlaps with your back end creating the session. Core's `setup()` accepts optional `apiURL` and `token` properties. `setup()` pairs with [`initializeSession()`](#initializesession); the web wrapper requires `token` up front.
- **You need an option the web wrapper does not accept** — `encryption`, `tri`, or `trueSight`. End-to-end encryption is the common case; see [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/).

That combination works, and the examples throughout these docs use it. Just wire the presentation layer yourself, because core's `setup()` cannot:

| What web's `setup()` would have done        | Do this instead                                                                                                                                                                                                                    |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `i18n` — language and translations          | Call `setI18nInstance(createI18n({ lang, translations }))` from `@incodetech/web`. Text still renders without it, in English defaults. See [Internationalization](/sdk-reference/web-sdk-2-i18n/).                                           |
| `uiConfig` — logo, subtitle, assets, loader | Call `setUiConfig({ … })` from `@incodetech/web`. See [Theming & Styling](/sdk-reference/web-sdk-2-theming/).                                                                                                                                    |
| `theme` — the dashboard theme               | `<incode-flow>` and `<incode-workflow>` fetch it themselves from their `config.token`, so they are unaffected. **Standalone module components do not** — they render unbranded. Apply your branding through `setUiConfig` instead. |
| `flow` — Flow-backed standalone config      | Core accepts `flow` with the same `preload` and `mergeConfig` semantics. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/).                                                                                       |

The silent case is worth repeating: a standalone `<incode-selfie>` or `<incode-id>` set up through core skips the dashboard theme with no error. If your branding comes from the Incode dashboard rather than `setUiConfig`, use the web `setup()`.

#### setup() from `@incodetech/core`

```typescript
import { setup } from '@incodetech/core';

await setup({
  apiURL?: string;                                     // API base URL
  token?: string;                                      // Session token (one-shot convenience — delegates to initializeSession)
  customHeaders?: Record<string, string>;
  timeout?: number;                                    // Request timeout (ms). No deadline when omitted.
  wasm?: WasmConfig | false;                           // WASM warmup (see WASM Configuration)
  encryption?: boolean | { mgf1?: 'sha1' | 'sha256' }; // End-to-end encryption (locked at boot)
  ipLookup?: boolean;                                  // Default true. Set false to skip the third-party IP lookup (api.ipify.org).
  fingerprint?: boolean;                               // Default true. Set false to skip device-fingerprint submission (transition flag).
  flow?: false | { preload?: boolean; mergeConfig?: boolean }; // Flow-backed config for standalone modules
  devMode?: boolean;                                   // Default false. Use true only during local development.
  tri?: { token: string; apiURL: string; autostart?: boolean }; // Optional TRI telemetry config
  trueSight?: { enabled?: boolean };                   // Default enabled. Set { enabled: false } to opt out of diagnostics.
  featureManagement?: boolean | FeatureManagementSetupOptions; // Default true. Set false to opt out entirely.
  environment?: 'development' | 'staging' | 'production';      // Default 'production'. Feature-management targeting only.
});
```

The canonical activation pattern is two calls — `setup({ apiURL })` first, then `initializeSession({ token })` once the session token is known. See [`initializeSession()`](#initializesession) below. Passing `token` to `setup` is a one-shot convenience that delegates to `initializeSession` internally.

| Option              | Type                                                     | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------- | -------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `apiURL`            | `string`                                                 | ❌       | API base URL. Omit when every API actor is overridden via `.provide()` (advanced).                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `token`             | `string`                                                 | ❌       | Session token. One-shot convenience that delegates to `initializeSession({ token })`. Prefer the explicit two-call form: `setup({ apiURL })` then [`initializeSession({ token })`](#initializesession). The two-call form lets you start `setup` (including WASM warmup) before the token is known.                                                                                                                                                                                                                            |
| `customHeaders`     | `Record<string, string>`                                 | ❌       | Headers to attach to every SDK request.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `timeout`           | `number`                                                 | ❌       | Request timeout in milliseconds. **There is no default deadline** — omit it and a request runs until it succeeds, fails at the network layer, or the API gateway ends it. That keeps large uploads alive on slow mobile connections, where a fixed timeout cut them off mid-transfer. Set this when your integration needs a bounded request.                                                                                                                                                                                  |
| `wasm`              | `WasmConfig \| false`                                    | ❌       | WASM warmup. Omit to skip preload (loads lazily on first selfie/ID capture). Pass an object to warm up with CDN defaults plus any overrides. Pass `false` to explicitly disable. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/).                                                                                                                                                                                                                                                                                                 |
| `encryption`        | `boolean \| { mgf1?: 'sha1' \| 'sha256' }`               | ❌       | Enable end-to-end encryption for SDK traffic. Independent of `token` — can be enabled before a session token is known. Not a self-serve flag — your Incode account team provisions the environment and gives you the dedicated `apiURL` and `mgf1` scheme. Locked at boot (call `reset()` to change later) and requires the WASM binary transport. See [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/) for the full walkthrough including API-key transmission, MGF1 schemes, and failure modes.                                |
| `ipLookup`          | `boolean`                                                | ❌       | Controls the third-party public-IP lookup (`api.ipify.org`). Default `true` (lookup enabled). Set `false` to opt out: no external call to ipify, at the cost of a less-precise fingerprint. Privacy-friendly for deployments where outbound calls to third-party services are restricted.                                                                                                                                                                                                                                     |
| `fingerprint` | `boolean` | ❌ | Controls client-side device-fingerprint submission. Default `true`; set `false` to skip submission. With `false`, Flows and Workflows do not automatically add mandatory consent; your integration must handle any required consent. |
| `devMode` | `boolean` | ❌ | Development mode. Default `false`; use `true` only for local development; keep it `false` in production. WASM console logging is controlled separately by `wasm.showLogs`; see [WASM Configuration](/sdk-reference/web-sdk-2-wasm/). |
| `tri`               | `{ token: string; apiURL: string; autostart?: boolean }` | ❌       | Transactional Risk Intelligence (TRI) telemetry. Provide `token` (an SDK token from `createTRISession`, not the org API key) and `apiURL` (the TRI ingest endpoint). TRI starts automatically unless `autostart: false` — use `false` to defer collection until after a consent gate, then call `startTRI()` from `@incodetech/core/tri`. Omitting this field opts out; no collectors start.                                                                                                                        |
| `flow`              | `false \| { preload?: boolean; mergeConfig?: boolean }`  | ❌       | Controls whether standalone modules resolve their configuration from your Dashboard Flow. Omit it (or pass `{}`) for lazy resolution on mount. `preload: true` fetches flow during `setup()`. `mergeConfig: true` merges the config you supply over the flow config. `false` disables flow-backed resolution. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/) for the full matrix.                                                                                                                                                |
| `trueSight`         | `{ enabled?: boolean }`                                  | ❌       | Incode-internal SDK-health diagnostics, used to debug capture issues you report. **Enabled by default.** During a session the SDK buffers diagnostic breadcrumbs, sanitized to exclude personal data and never including captured images, and uploads a single compressed record over HTTPS when the session ends. While the session runs, a compressed copy of the record is kept in `localStorage` (`incode.truesight.pending.*`) so it survives a closed tab or a cancelled upload; a copy left behind may be sent on a later page load, and copies older than 7 days are deleted without being sent. Fire-and-forget: it never blocks or affects your flow. Set `{ enabled: false }` to opt out entirely. Incode can also disable collection remotely. The value is fixed by the first `setup()` of the lifecycle; call `reset()` to change it. |
| `featureManagement` | `boolean \| FeatureManagementSetupOptions`               | ❌       | Controls the feature-management integration, which decides gate and experiment values for the session. **Enabled by default**, loaded as a separate chunk, and served by a third party—see [Third-Party Dependencies](/sdk-reference/web-sdk-2-third-party-dependencies/). Pass `false` for a full opt-out: no chunk, no feature-management network traffic. Reads from `@incodetech/core/feature-management` keep working when disabled and resolve to their defaults. Only the first enabling `setup()` initializes it. See the option table below.  |
| `environment`       | `'development' \| 'staging' \| 'production'`             | ❌       | Coarse deployment tier used for feature-management targeting, with no finer granularity. Default `'production'`. Read by the first enabling `setup()` only, and inert when `featureManagement` is `false`.                                                                                                                                                                                                                                                                                                                     |

##### `FeatureManagementSetupOptions`

Pass this object form instead of `true` to configure identity and privacy. The defaults are already conservative: no customer API key is used, and identity starts from an SDK-generated ID rather than anything you supply.

| Option                | Type                                | Default                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| --------------------- | ----------------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `awaitInitialization` | `boolean`                           | `false`                  | Whether `setup()` waits for gate and experiment values to load before it resolves. By default, `setup()` resolves as soon as the HTTP client is ready (typically 150–250 ms sooner) while values load in the background; reads made before that settle return their defaults (`status: 'uninitialized'`). Await `getIsFeatureManagementInitialized()` when you need one that early, or set `true` to block `setup()` until they are loaded. `<incode-flow>`, `<incode-workflow>`, and the SDK's own modules are unaffected. |
| `clientExperimentId`  | `string`                            | —                        | Integrator-scoped targeting unit, agreed with your Incode representative. Use it to bucket gates for one integrator, such as a pilot rollout.                                                                                                                                                                                                                                                                                                                                                                               |
| `disableStableId`     | `boolean`                           | `false`                  | Stops the integration from generating a per-user ID at all. The strongest privacy control. Evaluations resolve to control values until session identity arrives later in the flow.                                                                                                                                                                                                                                                                                                                                              |
| `disablePersistence`  | `boolean`                           | `false`                  | Keeps identity in memory only, so it is never linkable across page loads. Trades away the local bootstrap cache, so every session fetches on boot.                                                                                                                                                                                                                                                                                                                                                                          |
| `custom`              | `Record<string, unknown>`           | —                        | Attributes attached for targeting rules and analytics. They do not bucket experiments. Keep personal data and secrets out—these reach the provider's logs as-is.                                                                                                                                                                                                                                                                                                                                                          |
| `redactedUserInfo`    | `FeatureManagementRedactedUserInfo` | `ip`, `country` redacted | Which auto-collected fields to blank before they leave the browser. IP address and country are redacted by default; pass `false` for either to send it, or `true` for another field to redact that too.                                                                                                                                                                                                                                                                                                                     |

#### setup() from `@incodetech/web`

Use this one with the web components. `apiURL` and `token` are both required here, so create the session before you call it.

```typescript
import { setup } from '@incodetech/web';

await setup({
  apiURL: string;                                    // Required
  token: string;                                     // Required: session token from createSession()
  customHeaders?: Record<string, string>;
  timeout?: number;
  wasm?: WasmConfig | false;
  ipLookup?: boolean;
  fingerprint?: boolean;
  devMode?: boolean;
  featureManagement?: boolean | { clientExperimentId?: string; disableStableId?: boolean; disablePersistence?: boolean; redactedUserInfo?: FeatureManagementRedactedUserInfo };
  environment?: 'development' | 'staging' | 'production';
  i18n?: I18nOptions;                                // Language and translation overrides
  uiConfig?: UiConfig;                               // Logo, subtitle, asset/animation and loader overrides
  flow?: false | { preload?: boolean; mergeConfig?: boolean };
  theme?: false | { preload?: boolean };             // Dashboard theme, independent of flow
});
```

| Option                                                                                                               | Type                             | Required | Description                                                                                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiURL`                                                                                                             | `string`                         | ✅       | API base URL.                                                                                                                                                                                                 |
| `token`                                                                                                              | `string`                         | ✅       | Session token from `createSession()`. Unlike the core `setup()`, the web wrapper needs it up front.                                                                                                           |
| `i18n`                                                                                                               | `I18nOptions`                    | ❌       | Language selection and translation overrides. See [Internationalization](/sdk-reference/web-sdk-2-i18n/).                                                                                                               |
| `uiConfig`                                                                                                           | `UiConfig`                       | ❌       | Global branding and presentation: logo, subtitle, asset and animation overrides, loader presentation. See [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/) and [Theming & Styling](/sdk-reference/web-sdk-2-theming/).                    |
| `theme`                                                                                                              | `false \| { preload?: boolean }` | ❌       | Controls the dashboard theme independently of `flow`. Omit for lazy loading, `{ preload: true }` to fetch and apply during `setup()`, or `false` to disable it. See [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/). |
| `customHeaders`, `timeout`, `wasm`, `ipLookup`, `fingerprint`, `devMode`, `environment`, `flow` | same as core                     | ❌       | Forwarded to the core `setup()` unchanged — see the table above.                                                                                                                                              |

Web setup accepts only `clientExperimentId`, `disableStableId`, `disablePersistence`, and `redactedUserInfo` in its feature-management object. Core additionally accepts `custom`, `appVersion`, and `awaitInitialization`. Use core setup when you need those fields, and configure presentation as described above; they are not accepted in a web setup object literal in 2.3.0.

### createSession()

Create a verification session (call from your backend for production):

```typescript
import { createSession } from '@incodetech/core/session';

const session = await createSession(apiKey, {
  configurationId: string;   // Required: Flow configuration ID from dashboard
  language?: string;         // Optional: Language code (e.g., 'en-US')
  externalId?: string;       // Optional: Your user reference ID
});

// Returns: { token: string; interviewId: string; ... }
```

### initializeSession()

Activate a session by attaching the token to the HTTP client and pre-loading session-scoped state (feature flags, device fingerprint, analytics flush). Call once you have a session token — typically right after `createSession()` (or after your backend returns the token).

```typescript
import { initializeSession } from '@incodetech/core/session';

await initializeSession({
  token: string;            // Required in application code: the session token from createSession()
  signal?: AbortSignal;     // Optional: abort the activation (e.g. on unmount)
  preloadFlow?: boolean;    // Optional: fetch the flow configuration alongside activation
  awaitFingerprint?: boolean; // Optional: false resolves before the device fingerprint finishes (default true)
});

// Returns: { features, disableIpify, fingerprintSuccess, fingerprintResult }
```

| Option             | Type          | Required | Description                                                                                                                                                                                                                                                                                      |
| ------------------ | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `token`            | `string`      | ✅       | Session token returned by `createSession()`. Application code should always pass this explicitly.                                                                                                                                                                                                |
| `signal`           | `AbortSignal` | ❌       | Cancellation signal; useful for unmount-aborts in single-page apps.                                                                                                                                                                                                                             |
| `preloadFlow`      | `boolean`     | ❌       | Fetch the flow configuration in the same request wave as activation, so a later `getFlow()` or flow manager `load()` hits the cache. Default `false`.                                                                                                                                             |
| `awaitFingerprint` | `boolean`     | ❌       | `false` resolves as soon as the feature config is in and lets device-fingerprint submission finish in the background. `fingerprintSuccess` / `fingerprintResult` on the result are then not yet known; read them via `whenSessionFingerprintSettled()`. Default `true`. |

Results are cached per token: calling `initializeSession` again with the same token is a no-op; calling with a different token resets the cache and re-initializes from scratch. Idempotent across concurrent callers — a second in-flight call with the same arguments awaits the first.

#### whenSessionFingerprintSettled()

Use with to `awaitFingerprint: false`. Resolves with the `DeviceFingerprintResult` after the background fingerprint finishes, or `undefined` when fingerprinting failed or was skipped. Never rejects. If the fingerprint was already awaited, it resolves immediately with the cached result.

```typescript
import { initializeSession, whenSessionFingerprintSettled } from '@incodetech/core/session';

const { features } = await initializeSession({ token, awaitFingerprint: false });
renderHome(features);

const fingerprint = await whenSessionFingerprintSettled();
if (fingerprint?.showMandatoryConsent) showConsent(fingerprint.regulationType);
```

## Feature management

`@incodetech/core/feature-management` is the read surface for the gates, experiments, layers, and dynamic configs evaluated for the current session. The SDK handles initialization and identity itself during `setup()` and session activation — this subpath only reads. It ships as a separate subpath so integrations that never read a gate do not pay for it.

Incode agrees the gate and experiment keys with you; they are not self-serve.

```typescript
import {
  getFeatureGate,
  getExperiment,
  getLayer,
  getFeatureDynamicConfig,
  subscribeFeatureManagement,
} from '@incodetech/core/feature-management';

if (getFeatureGate('your_gate_key').enabled) {
  // gated behavior
}

const experiment = getExperiment('your_experiment_key');
const variant = experiment.get('variantName', 'control');

const layer = getLayer('your_layer_key');
const timeoutMs = layer.get('timeoutMs', 10_000);
```

| Function                               | Returns                           | Description                                                                  |
| -------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------- |
| `getFeatureGate(key)`                  | `FeatureManagementGate`           | Reads a boolean gate. Check `.enabled`.                                      |
| `getExperiment(key)`                   | `FeatureManagementExperiment`     | Reads an experiment. Call `.get(param, fallback)` per parameter.             |
| `getLayer(key)`                        | `FeatureManagementLayer`          | Reads a layer. Call `.get(param, fallback)` per parameter.                   |
| `getFeatureParameterStore(key, opts?)` | `FeatureManagementParameterStore` | Reads a parameter store.                                                     |
| `getFeatureDynamicConfig(key)`         | object or `null`                  | Reads a dynamic config.                                                      |
| `subscribeFeatureManagement(fn)`       | unsubscribe function              | Notifies you when values change during the session, as identity is enriched. |
| `updateFeatureManagementUser(update)`  | `void`                            | Adds your own custom IDs to the evaluation identity.                         |
| `getIsFeatureManagementInitialized()`  | `boolean`                         | Whether initialization has finished.                                         |
| `logEvent(...)`                        | `void`                            | Records a custom event against the current identity.                         |

**Every function here is graceful and none of them throw.** `setup()` does not wait for gate and experiment values to load: it resolves as soon as the HTTP client is ready and the values arrive in the background, so a read made immediately after `await setup()` may still see the defaults below. When you need a real value that early, call `await getIsFeatureManagementInitialized()` first, or pass `setup({ featureManagement: { awaitInitialization: true } })` to make `setup()` block until values are loaded. `<incode-flow>`, `<incode-workflow>`, and the SDK's own modules never need either: they read after the session identity update, which waits for loading itself. Before values load, and whenever `setup({ featureManagement: false })` disabled the integration, reads resolve to documented defaults: gates return `false`, experiments and layers return your fallback, and dynamic configs return `null`. Code that reads a gate stays correct with the integration switched off, so you can disable it without branching.

## Components

### `<incode-flow>`

Complete verification flow as a standard Web Component.

```ts
// Side-effect import registers the custom element
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';
```

| Property   | Type                                                       | Required | Description                 |
| ---------- | ---------------------------------------------------------- | -------- | --------------------------- |
| `config`   | `FlowConfig`                                               | ✅       | Flow configuration object   |
| `onFinish` | `(result?: FinishStatus) => void`                          | ✅       | Called when flow completes  |
| `onError`  | `(error: string \| undefined, errorCode?: number) => void` | ❌       | Called when an error occurs |

#### FlowConfig

`apiURL` is configured via `setup()`, not in `FlowConfig`.

| Property                                     | Type                            | Required | Description                                                                    |
| -------------------------------------------- | ------------------------------- | -------- | ------------------------------------------------------------------------------ |
| `token`                                      | `string`                        | ✅       | Session token from `createSession()` (token-based variant)                     |
| `apiKey` (or `clientId`) + `configurationId` | `string`                        | ✅ (alt) | Self-loading variant — component creates its own session. Avoid in production. |
| `lang`                                       | `string`                        | ❌       | Language code (e.g. `'en-US'`)                                                 |
| `enableHome`                                 | `boolean`                       | ❌       | Show the SDK's built-in home screen                                            |
| `authHint`                                   | `string`                        | ❌       | QR/auth hint when re-entering a flow                                           |
| `redirectToMobileUrl`                        | `string`                        | ❌       | Override the destination URL for the Redirect to Mobile step                   |
| `urlUuid`                                    | `string`                        | ❌       | QR anti-phishing token from URL                                                |
| `injectCss` | `boolean` | ❌ | Opt into automatic Flow and lazy module stylesheet loading. Default `false`. Keep base/theme CSS imports. |
| `cssNonce` | `string` | ❌ | CSP nonce for stylesheets injected when `injectCss` is enabled. |
| `wasmConfig`                                 | `WasmConfig`                    | ❌       | WASM configuration for ML features                                             |
| `spinnerConfig`                              | `SpinnerConfig`                 | ❌       | Loading spinner customization                                                  |
| `disableDashboardTheme`                      | `boolean`                       | ❌       | Disable dashboard theme                                                        |
| `onFlowEvent`                                | `(event: FlowEvent) => void`    | ❌       | Curated flow milestones                                                        |
| `onModuleLoading`                            | `(moduleKey: string) => void`   | ❌       | Called when module starts loading                                              |
| `onModuleLoaded`                             | `(moduleKey: string) => void`   | ❌       | Called when module finishes loading                                            |
| `onWasmWarmup`                               | `(pipelines: string[]) => void` | ❌       | Called when WASM warmup begins                                                 |
| `onUrlUuidRefreshed`                         | `(urlUuid: string) => void`     | ❌       | New `urlUuid` available                                                        |

### Other components

The SDK ships 20+ web components in addition to `IncodeFlow` — selfie, ID capture, phone, email, signature, consent, eKYC/eKYB orchestrators, and more. Rather than duplicate them here, see:

- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): complete catalog of every web component and headless manager with import paths
- [Web Components](/sdk-reference/web-sdk-2-web-components/): tag-table reference for vanilla / framework-agnostic usage
- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/), [Module: ID](/sdk-reference/web-sdk-2-module-id-capture/), [Module: Phone](/sdk-reference/web-sdk-2-module-phone/), [Module: Email](/sdk-reference/web-sdk-2-module-email/): deep-dive reference pages for the four most-used capture modules, including config tables, state machines, and full API surfaces

## Headless Managers

Every module ships a corresponding `createXxxManager` factory for headless integrations. The full catalog (manager name, core import, what it does) lives in [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/); detailed lifecycle, state, and method documentation for each manager lives in [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/).

For the four most-used headless APIs, see:

- [Module: Selfie § API Methods](/sdk-reference/web-sdk-2-module-selfie-1/#api-methods)
- [Module: ID § API Methods](/sdk-reference/web-sdk-2-module-id-capture/#api-methods)
- [Module: Phone § API Methods](/sdk-reference/web-sdk-2-module-phone/#api-methods)
- [Module: Email § API Methods](/sdk-reference/web-sdk-2-module-email/#api-methods)

### Legacy Flow manager

The manager also provides `subscribeFlowEvent(listener)` for curated milestones. It returns an unsubscribe function; see [headless flow events](/sdk-reference/web-sdk-2-event-callbacks/#headless-flow-events) for subscription and teardown.

`createFlowManager()` from `@incodetech/core/flow` loads a Flow and exposes manual step navigation. Prefer `createOrchestratedFlowManager` for automatic module orchestration.

| Method/Getter | Contract |
| --- | --- |
| `load()` | Start loading in `idle`. |
| `cancel()` | Cancel in `loading`, returning to `idle`. |
| `nextStep()` | Advance in `ready`; the last step reaches `finished`. |
| `prevStep()` | Move backward in `ready` when not on the first step. |
| `canNext` | True in `ready` when another step follows. False on the last step, although `nextStep()` can finish it. |
| `canPrev` | True in `ready` when a previous step exists. |
| `getModuleConfig<T>(moduleKey)` | Configuration for the named module, or `undefined` when absent or outside `ready`. |
| `isModuleEnabled(moduleKey)` | Whether the named module exists; false outside `ready`. |
| `reset()` | Return to `idle` from `ready`, `error`, or this legacy manager's non-final `finished` state. |

The modern orchestrator instead uses `completeModule()` and `getModuleConfig<T>()` for the current module; it has no legacy `prevStep()`/`canPrev` contract. Both support `getState()`, `subscribe()`, and `stop()`.

## See Also

- [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/): Type definitions
- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Detailed headless API
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): Complete module catalog

---

- Path: `sdk-reference/web-sdk-2-session-api`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-session-api/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-session-api.md

# Session Management

<Component slug="web-2-x-implementation-warning" />

Sessions authenticate users with the Incode API. Sessions must be created before rendering any SDK component.

## Creating a Session

Use `createSession()` from `@incodetech/core/session`:

```typescript
import { createSession } from '@incodetech/core/session';
import { setup } from '@incodetech/core';

// Create session (typically on your backend, or client-side for dev)
const session = await createSession('your-api-key', {
  configurationId: 'your-config-id',
  language: 'en-US',
  externalId: 'optional-user-id', // Links session to your own user record
});

// Setup SDK with the token
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: session.token,
});
```

> **Security note**: Embedding your API key in client-side code is acceptable for development, but for production you should create the session on your backend and pass only the token to the frontend.

## Server-Side Session Creation (Recommended for Production)

Create the session token on your backend, then pass it to the frontend:

### Backend (Node.js example)

```javascript
const response = await fetch('https://demo-api.incodesmile.com/omni/start', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.INCODE_API_KEY,
    'api-version': '1.0',
  },
  body: JSON.stringify({
    configurationId: 'your-config-id',
    language: 'en-US',
  }),
});

if (!response.ok) {
  throw new Error(`Failed to create Incode session: ${response.status}`);
}

const { token } = await response.json();
// Send token to frontend
```

### Frontend

```ts
import { setup } from '@incodetech/core';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';

// Token received from your backend
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  token: sessionToken,
});

const flow = document.querySelector('incode-flow');
if (flow) {
  flow.config = { token: sessionToken, lang: 'en-US' };
  flow.onFinish = (result) => {
    /* ... */
  };
}
```

## Session Lifecycle

- Sessions expire after a configured timeout (set in your dashboard)
- Each verification step updates the session state on the backend
- Create a new session for each new verification attempt

## External ID

Associate sessions with your own user identifiers by passing `externalId` to `createSession()`:

```typescript
import { createSession } from '@incodetech/core/session';

const session = await createSession('your-api-key', {
  configurationId: 'your-config-id',
  externalId: 'your-user-id-123',
});
```

This allows you to link Incode sessions to users in your system.

## Getting the Finish Status

After a flow completes, retrieve the final verification result:

```typescript
import { getFinishStatus } from '@incodetech/core/session';

const result = await getFinishStatus('YOUR_CONFIGURATION_ID');
// Or: await getFinishStatus(undefined) to omit the flow filter.
// Optional cancellation: getFinishStatus('YOUR_CONFIGURATION_ID', signal).
// result.action: 'approved' | 'rejected' | 'none'
// result.scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL'
// result.redirectionUrl: string
```

The first argument is required and accepts `string | undefined | null`; the second is an optional `AbortSignal`.

`result.endScreenTitle` and `result.endScreenText` are always `null` from this helper. The orchestrated Flow's `onFinish` result fills these nullable fields from Dashboard copy received at session creation. Use that callback result when rendering the configured completion text.

## See Also

- [Getting Started](/sdk-reference/web-sdk-2-getting-started/): Basic integration
- [API Reference](/sdk-reference/web-sdk-2-reference/): Full API documentation
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): Rendering the flow

---

- Path: `sdk-reference/web-sdk-2-theming`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-theming/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-theming.md

# Theming & Styling

<Component slug="web-2-x-implementation-warning" />

The Incode Web SDK uses CSS custom properties (variables) for theming, making it easy to match your brand.

> To replace a built-in branded illustration or animation (tutorial graphics, success/fail screens) instead of recoloring it, see [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/).

## Quick Start

Import the base tokens and override the variables you want to customize:

```css
/* Import the SDK theme (defines all CSS variables you can override) */
@import '@incodetech/web/themes/light.css';

/* Override with your brand color — easiest path */
:root {
  --primitive-color-brand-500: #0066cc;
  --primitive-color-brand-400: #1f7fdf; /* slightly lighter, used on hover */
  --primitive-color-brand-600: #0052a3; /* slightly darker, used on press */
}
```

> **Note:** The SDK ships two themes: `@incodetech/web/themes/light.css` and `@incodetech/web/themes/dark.css`. Pick one as your base, then override variables to match your brand. Component layout/structure CSS lives separately in `@incodetech/web/base.css` and per-module CSS such as `@incodetech/web/flow/styles.css`. The full token catalog is documented below.

## Token Hierarchy

The SDK uses a layered token system:

```
Primitives → Semantic → Component-specific
```

Each layer references the layer above. Most overrides target the primitive or component layer; touching the semantic layer cascades broadly so use it intentionally.

### 1. Primitive Tokens

Concrete values that nothing else customizes:

```css
:root {
  /* Color scales (50, 100, 200, ..., 900, 1000) for: gray, brand, brand-secondary, positive, warning, negative */
  --primitive-color-gray-0: #ffffff;
  --primitive-color-gray-500: #6b7280;
  --primitive-color-gray-900: #1f2937;
  --primitive-color-brand-500: #0066cc;

  /* Spacing scale (--primitive-scale-*) and the friendly --spacing-* aliases */
  --primitive-scale-4: 4px;
  --spacing-4: var(--primitive-scale-4);
  --spacing-16: var(--primitive-scale-16);

  /* Typography */
  --primitive-typography-family-rethink-sans: 'Rethink Sans';
  --primitive-typography-size-16: 16px;
  --primitive-typography-weight-regular: 400;
  --primitive-typography-weight-medium: 500;

  /* Border radius scale (--primitive-border-radius-0/4/8/16/24/40/64/9999) and aliases */
  --border-radius-medium: var(--primitive-border-radius-16);
  --border-radius-full: var(--primitive-border-radius-9999);
}
```

### 2. Semantic Tokens

Purpose-based names that reference primitives. Different values resolve in `@incodetech/web/themes/light.css` vs. `dark.css`, so overriding a semantic token affects whichever theme you're on:

```css
:root {
  /* Surfaces — backgrounds */
  --surface-neutral-0: var(--primitive-color-gray-0); /* base background */
  --surface-neutral-50: var(
    --primitive-color-gray-50
  ); /* subtle elevated surface */
  --surface-neutral-900: var(--primitive-color-gray-900); /* highest contrast */
  --surface-brand-500: var(--primitive-color-brand-500); /* brand fill */
  --surface-status-negative-500: var(--primitive-color-negative-500);
  --surface-status-warning-500: var(--primitive-color-warning-500);
  --surface-status-positive-500: var(--primitive-color-positive-500);

  /* Text — foreground colors */
  --text-body-800-primary: var(
    --primitive-color-gray-800
  ); /* primary body text */
  --text-body-500-secondary: var(
    --primitive-color-gray-500
  ); /* secondary / muted */
  --text-body-400: var(--primitive-color-gray-400); /* placeholders, disabled */
  --text-link-default: var(--primitive-color-brand-500);
  --text-link-hover: var(--primitive-color-brand-300);
  --text-accent-brand: var(--primitive-color-brand-500);

  /* Borders */
  --border-neutral-100: var(--primitive-color-gray-100);
  --border-neutral-400: var(--primitive-color-gray-400);
  --border-status-negative: var(--primitive-color-negative-500);
  --border-status-focus: var(--primitive-color-brand-500);
}
```

Many tokens have a `-static` variant that stays fixed across light/dark themes (used for elements that should look identical regardless of theme, like a brand-coloured button). For example `--surface-brand-500-static` does not switch in dark mode the way `--surface-brand-500` might.

### 3. Component Tokens

Specific to individual components. These reference semantic tokens, so overriding a component token gives you targeted control without affecting other components:

```css
:root {
  /* Primary button */
  --button-primary-surface-default: var(--surface-brand-500-static);
  --button-primary-surface-hover: var(
    --surface-brand-400-static
  ); /* lighter on hover */
  --button-primary-surface-pressed: var(
    --surface-brand-600-static
  ); /* darker on press */
  --button-primary-surface-disabled: var(--surface-neutral-100);
  --button-primary-text-default: var(--text-body-0-static);
  --button-primary-border-radius: var(--border-radius-medium);

  /* Inputs */
  --input-surface-default: var(--surface-neutral-50);
  --input-surface-disabled: var(--surface-neutral-100);
  --input-border-default: var(--border-neutral-400);
  --input-border-focused: var(--border-status-focus);
  --input-border-negative: var(--border-status-negative);
  --input-text-field-default: var(--text-body-800-primary);
  --input-text-field-placeholder: var(--text-body-400);

  /* Spinner */
  --spinner-surface-primary: var(--surface-brand-500-static);
  --spinner-surface-secondary: var(--surface-brand-50);
  --spinner-text-title: var(--text-body-800-primary);
  --spinner-text-subtitle: var(--text-body-500-secondary);
}
```

`button-*` tokens come in `primary`, `secondary`, and `tertiary` variants, each with `surface`, `text`, and `border` properties across `default` / `hover` / `pressed` / `disabled` states.

## Common Customizations

### Brand colors

The simplest path is to override the primitive brand scale. Everything semantic (`--surface-brand-*`, `--text-accent-brand`, button colors, focus rings, etc.) inherits automatically:

```css
:root {
  --primitive-color-brand-50: #e6f0ff;
  --primitive-color-brand-100: #cce0ff;
  --primitive-color-brand-300: #4d9aff;
  --primitive-color-brand-400: #1f7fdf; /* button hover */
  --primitive-color-brand-500: #0066cc; /* main brand */
  --primitive-color-brand-600: #0052a3; /* button pressed */
}
```

If you need finer control, override the component tokens directly:

```css
:root {
  --button-primary-surface-default: #0066cc;
  --button-primary-surface-hover: #1f7fdf;
  --button-primary-surface-pressed: #0052a3;
}
```

### Dark mode

The SDK already ships a dark theme. Import it instead of rolling your own:

```css
@import '@incodetech/web/themes/dark.css';
```

If you want to switch themes per user preference, gate the import or apply it conditionally:

```css
/* Default to light, switch to dark when the user prefers dark */
@import '@incodetech/web/themes/light.css';

@media (prefers-color-scheme: dark) {
  @import '@incodetech/web/themes/dark.css';
}
```

### Typography

The SDK uses Rethink Sans by default. Override the primitive family if you want a different font everywhere:

```css
:root {
  --primitive-typography-family-rethink-sans:
    'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
}
```

Sizes (`--primitive-typography-size-12` through `--primitive-typography-size-80`) and weights (`--primitive-typography-weight-regular`, `--primitive-typography-weight-medium`, `--primitive-typography-weight-semibold`, `--primitive-typography-weight-bold`) are also override-able primitive tokens.

### Border radius

The radius scale is `--border-radius-{none,x-small,small,medium,large,x-large,xx-large,full}`. Components reference these via component tokens:

```css
:root {
  /* Round all primary buttons more aggressively */
  --button-primary-border-radius: var(--border-radius-large);

  /* Or change the underlying scale */
  --primitive-border-radius-16: 12px; /* shrinks --border-radius-medium */
}
```

## Container Styling

The SDK elements fill their container. Style the parent for layout control:

```html
<!-- Full viewport height -->
<div style="height: 100vh;">
  <incode-flow></incode-flow>
</div>

<!-- Fixed height modal -->
<div style="height: 600px; width: 400px;">
  <incode-flow></incode-flow>
</div>
```

## Direct CSS Overrides

CSS variables cover color, typography, spacing, and border radius. Some properties — text alignment, for example — have no dedicated token, because most integrations never need to change them. For those, override the component's CSS class directly.

The SDK's web components render without Shadow DOM: every custom element registers with `shadow: false`, so your page's CSS cascades into components exactly as it cascades into any other element on the page. There's no encapsulation boundary to work around.

Every component also renders plain, `Incode`-prefixed CSS classes on its root and key child elements — for example `.IncodeButton`, `.IncodeInput`, `.IncodeFlowCompletedTitle`. These class names are stable across releases, so your stylesheet can target them directly.

### Matching selector specificity

Some classes are flat and override with a single selector:

```css
.IncodeFlowStartSubtitle {
  text-align: right;
}
```

Others are nested under an ancestor, or qualified with a tag name, for extra specificity. Match or exceed that specificity in your override, or fall back to `!important`:

```css
/* Overrides .IncodeComponent .IncodeFlowCompleted h1.IncodeFlowCompletedTitle */
.IncodeComponent .IncodeFlowCompleted h1.IncodeFlowCompletedTitle,
.IncodeComponent .IncodeFlowCompleted p.IncodeFlowCompletedSubtitle {
  text-align: right;
}
```

> **Note:** Some styles switch at a breakpoint. `IncodeFlowCompletedTitle` left-aligns by default and centers above 992px width, for example. Override the base rule and any matching `@media` rule together, so your alignment holds at every screen size.

### Common classes to target

This is a starting point, not a full inventory — inspect the rendered element in your browser's devtools for anything not listed here.

| Component              | Root class             | Notable child classes                                                              |
| ----------------------- | ----------------------- | ----------------------------------------------------------------------------------- |
| Button                  | `.IncodeButton`         | `.IncodeButtonPrimary` / `Secondary` / `Link`, `.IncodeButtonL` / `M` / `S`, `.IncodeButtonLoading` |
| Input                   | `.IncodeInput`          | State reflected via `[aria-invalid]`, `:disabled`, `[type='date']`                   |
| Typography              | `.IncodeTypographyH1`–`H5`, `.IncodeTypographyP` | Nested under `.IncodeComponent`                                    |
| Flow start screen       | `.IncodeFlowStart`      | `.IncodeFlowStartSubtitle`, `.IncodeFlowStartLogo`                                   |
| Flow completed screen   | `.IncodeFlowCompleted`  | `.IncodeFlowCompletedTitle`, `.IncodeFlowCompletedSubtitle`                          |
| Spinner                 | `.IncodeSpinner`        | See [Spinner Customization](#spinner-customization) below                           |

## Global UI Config

CSS variables and class overrides change how components look. `setUiConfig` changes what they show, for branding elements that aren't worth a CSS override — the logo, the subtitle text, and whether the default header or footer renders at all.

Call it directly, or pass the same shape to `setup({ uiConfig })`:

```ts
import { setUiConfig } from '@incodetech/web';

setUiConfig({
  logoSrc: 'https://your-cdn.com/logo.svg',
  logoHeight: '32px',
  subtitle: 'Verify your identity to continue',
  hideHeader: false,
  hideFooterBranding: true,
});
```

| Option               | Type      | Description                                        |
| --------------------- | --------- | --------------------------------------------------- |
| `logoSrc`             | `string`  | Replaces the default Incode logo.                   |
| `logoHeight`          | `string`  | Sets the rendered height of `logoSrc` (a CSS length, e.g. `'32px'`). |
| `subtitle`            | `string`  | Replaces the default subtitle text under the logo.   |
| `hideHeader`          | `boolean` | Hides the default header entirely.                   |
| `hideFooterBranding`  | `boolean` | Hides the default "Powered by Incode" footer branding. |
| `helpButtonPosition`  | `'bottomRight' \| 'topRight' \| 'topLeft'` | Moves the capture help button (the "?" that opens the common-issues modal) on the ID and document capture screens. Defaults to `'bottomRight'`, inside the capture footer; the `top*` values float it beside the header. |
| `showCloseButton`     | `boolean` | Shows an "X" close button that lets the user quit. Off by default. After the user confirms, the SDK stops the module and calls `onError(undefined, undefined, 'USER_CANCELLED')` once; remove the element in that callback. Not shown on screens that hide the header. |
| `closeButtonPosition` | `'topRight' \| 'topLeft'` | Corner for the close button once `showCloseButton` is `true`. Defaults to `'topRight'`. Can't match `helpButtonPosition` — on a collision the help button falls back to its own default and a dev warning is logged. |
| `realtimeFeedbackMessageUIFlavor` | `'standard' \| 'minimal'` | How the ID capture realtime feedback message renders (live cues: not aligned, too blurry, glare, show front, show back). Defaults to `'standard'` — copy with the animation beside it. `'minimal'` drops the animation and centers the copy, which reads better on small screens. The cues, copy, and screen-reader announcements are the same either way. |
| `disableUnsupportedBrowserScreen` | `boolean` | `true` hides the browser-not-supported screen in standalone modules. `false` shows it, even if the session's flow hides it. When you omit it, each module uses the setting of the session's flow. A per-element `config.disableUnsupportedBrowserScreen` overrides this value. `<incode-flow>` and `<incode-workflow>` ignore it and always use the server setting. See [Browser support](/sdk-reference/incode-web-sdk-2-reference/#hide-the-browser-not-supported-screen). |

All options are optional — pass only the ones you want to change.

### Your config versus the dashboard theme

`<incode-flow>` and `<incode-workflow>` fetch your Incode dashboard's theme when they initialize. Your own config and that theme are separate tiers, composed per field on read:

1. **What you set** via `setup({ uiConfig })` or `setUiConfig` — wins.
2. **The dashboard theme** — fills the fields you left unset.
3. **Built-in defaults.**

Two consequences worth knowing:

- **The theme contributes only `logoSrc`, `subtitle`, and `hideFooterBranding`.** It cannot touch `assets`, `animations`, `spinner`, `hideHeader`, or `logoHeight`, so a theme arriving mid-flow never disturbs those.
- **A field you leave `undefined` counts as unspecified**, so the theme still supplies it. Set a field explicitly to keep the dashboard out of it.

Set `disableDashboardTheme: true` in the flow or workflow config (see [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/#properties)) to skip the theme fetch altogether. You no longer need it to protect your own values — set the fields you care about and they hold.

`setUiConfig` still replaces your tier rather than merging into it, so pass every field you want to keep on each call.

## Spinner Customization

This follows the same override pattern described in [Direct CSS Overrides](#direct-css-overrides) above. The loading spinner displayed during flow initialization, module loading, and transitions exposes four tokens:

```css
:root {
  /* Spinner icon colors */
  --spinner-surface-primary: #0066cc; /* foreground arc */
  --spinner-surface-secondary: #e6f0ff; /* track */

  /* Spinner text */
  --spinner-text-title: #1a1a1a;
  --spinner-text-subtitle: #666666;
}
```

The full-screen overlay background uses `--surface-neutral-0` from the active theme — override that primitive (or the corresponding `--primitive-color-gray-0`) if you want a different overlay color, rather than reaching for a dedicated token (there isn't one).

### Loader presentation

Set `spinner` to control what every SDK loader renders — including the ones inside modules, such as the ID module's camera-prep screen and the camera-permission screen, which a flow-level `spinnerConfig` never reached.

```ts
import { setup } from '@incodetech/web';

await setup({
  apiURL: API_URL,
  token: session.token,
  uiConfig: {
    spinner: { renderMode: 'textOnly', size: 'large' },
  },
});
```

| Option       | Type                                              | Description                                          |
| ------------ | ------------------------------------------------- | ---------------------------------------------------- |
| `renderMode` | `'spinnerAndText' \| 'spinnerOnly' \| 'textOnly'` | Which parts of the loader render.                    |
| `size`       | `'small' \| 'medium' \| 'large'`                  | Icon size — 24px / 48px / 64px. Defaults to `large`. |

`renderMode: 'textOnly'` drops the spinning icon and keeps the copy, for when you want to animate the text yourself. The container gains an `IncodeSpinnerTextOnly` class to target.

Set the same shape on a single element's config to override the global value for that element only:

```ts
idElement.config = { ...idConfig, spinner: { renderMode: 'spinnerOnly' } };
```

Precedence is per-instance `config` → global `setup({ uiConfig })` → built-in default, matching [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/).

> **Changing loader text?** That comes from i18n, not from `spinner`. Override the `loadingCircle.holdOn`, `loadingCircle.validating`, and `loadingCircle.preparingCamera` keys — see [Internationalization](/sdk-reference/web-sdk-2-i18n/#custom-translations). Keeping copy in translations is what lets it follow a runtime language change.

### CSS Class Targeting

You can also target spinner classes directly:

```css
/* Main spinner container */
.IncodeSpinner {
  /* your styles */
}

/* Full-screen spinner overlay */
.IncodeSpinnerFullScreen {
  /* your styles */
}

/* Spinner content wrapper */
.IncodeSpinnerContent {
  /* your styles */
}

/* Wrapper around title + subtitle */
.IncodeSpinnerText {
  /* your styles */
}

/* Title and subtitle text */
.IncodeSpinnerTitle {
  /* your styles */
}

.IncodeSpinnerSubtitle {
  /* your styles */
}
```

## Key CSS Variables

A high-level cheat sheet of the categories you'll most often override. The full inventory ships in `@incodetech/web/themes/light.css` and `@incodetech/web/themes/dark.css` — inspect them in your browser's devtools or your bundler's source view to see every variable.

| Category     | Examples                                                                                                                                                            |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Brand**    | `--primitive-color-brand-{50..600}` (override these to re-skin everything)                                                                                          |
| **Surfaces** | `--surface-neutral-{0..1000}`, `--surface-brand-{50,100,500,500-static,600-static}`, `--surface-status-{negative,warning,positive}-{50,500}`                        |
| **Text**     | `--text-body-{0,400,500-secondary,800-primary}`, `--text-link-{default,hover,visited,disabled}`, `--text-accent-brand`, `--text-status-{negative,warning,positive}` |
| **Borders**  | `--border-neutral-{100,400}`, `--border-status-{negative,warning,positive,focus}`                                                                                   |
| **Buttons**  | `--button-{primary,secondary,tertiary}-{surface,text,border}-{default,hover,pressed,disabled}`, `--button-*-border-radius`                                          |
| **Inputs**   | `--input-{surface,border,icon,text-field,text-helper,text-label}-{default,focused,disabled,negative}`                                                               |
| **Spinner**  | `--spinner-surface-{primary,secondary}`, `--spinner-text-{title,subtitle}`                                                                                          |
| **Layout**   | `--spacing-{2..96}`, `--border-radius-{none,x-small,small,medium,large,x-large,xx-large,full}`                                                                      |
| **Type**     | `--primitive-typography-family-*`, `--primitive-typography-size-{12..80}`, `--primitive-typography-weight-{regular,medium,semibold,bold}`                           |

---

- Path: `sdk-reference/web-sdk-2-third-party-dependencies`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-third-party-dependencies/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-third-party-dependencies.md

# Third-Party Dependencies

<Component slug="web-2-x-implementation-warning" />

The Incode Web SDK loads some resources from domains outside your configured `apiURL`. This page lists those external network requests — what they're for, and how to remove, replace, or self-host them. Use it to configure Content-Security-Policy allowlists or to run a fully self-hosted deployment.

## Summary

| Resource           | Domain                    | Package            | Default                    | Override                                                        |
| ------------------ | ------------------------- | ------------------ | -------------------------- | --------------------------------------------------------------- |
| WASM + ML models   | `cdn.incodesmile.com`     | `@incodetech/core` | Loaded for capture or explicit warm-up  | `setup({ wasm: { wasmPath, modelsBasePath, ... } })`            |
| Public IP lookup   | `api.ipify.org`           | `@incodetech/core` | Enabled                    | `setup({ ipLookup: false })`                                    |
| Translations | Application asset host in 2.3.0; `api.i18nexus.com` in SDK development builds | `@incodetech/web` | Bundled locale chunks in published 2.3.0 packages | `setup({ i18n: { loadPath \| skipRemoteLoad, translations } })` |
| Feature management | Statsig-managed endpoints | internal layer     | **Enabled**                | `setup({ featureManagement: false })`                           |
| Digital-ID logos   | `content.trinsic.id`      | `@incodetech/web`  | Only with digital-ID cards | None — allowlist the domain or accept a blank logo              |

Fonts and animations are bundled in `@incodetech/web`. The Video Selfie voice-consent MP3 encoder (lamejs) ships in `@incodetech/core` as a separate file. It loads only in flows with voice consent from the same host as your other SDK files. None of these request third-party domains, so the table doesn't list them. In 2.3.0 and earlier releases, voice consent loads the encoder from `cdnjs.cloudflare.com`.

`@incodetech/web`'s `setup()` forwards `ipLookup`, `fingerprint`, `featureManagement`, and `environment` to `@incodetech/core`, and applies `i18n` internally.

## WASM / ML models

**What:** WASM binaries, glue JavaScript, and ML models for face and ID capture.

**Default domain:** `cdn.incodesmile.com`

Override individual paths, or point at your own host entirely:

```ts
import { setup } from '@incodetech/core';

await setup({
  apiURL: 'https://api.incode.com',
  wasm: {
    wasmPath: '/wasm/webLib.wasm',
    glueCodePath: '/wasm/webLib.js',
    modelsBasePath: '/wasm/models',
  },
});
```

See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/) for the full self-hosting walkthrough, including required headers and SIMD variants.

## Public IP lookup (ipify)

**What:** Fetches the client's public IP address, used to enrich the device-fingerprint submission.

**Default domain:** `api.ipify.org`

```ts
import { setup } from '@incodetech/core';

await setup({
  apiURL: 'https://api.incode.com',
  ipLookup: false,
});
```

Set `ipLookup: false` to skip the third-party call entirely — useful for deployments where outbound calls to third-party services are restricted. See the `ipLookup` and `fingerprint` options in [API Reference](/sdk-reference/web-sdk-2-reference/) for the full behavior, including what each flag does to fingerprint submission.

## Translations

Published 2.3.0 packages load the built-in translations as locale chunks from the host serving your application's SDK assets. The default no longer needs an i18nexus CSP allowance. Earlier packages and SDK development builds can fetch translations from `api.i18nexus.com`.

A custom `i18n.loadPath` uses your translation endpoint instead;. Allow its host for translation requests. Inline `translations` override the loaded strings. `skipRemoteLoad: true` disables remote loading but still permits bundled locales in 2.3.0. See [Internationalization](/sdk-reference/web-sdk-2-i18n/#custom-translations).

## Feature management (Statsig)

**What:** Decides feature-gate and experiment values for the session, so Incode can roll changes out progressively and run capture experiments. Served by [Statsig](https://statsig.com) via the `@statsig/js-client` package, loaded as a separate chunk during `setup()`.

**Default:** enabled. Include its network requirements when configuring your application CSP.

**Domains:** the client uses Statsig's own default endpoints. The SDK does not override or proxy them, and exposes no option to redirect them, so take the current hostnames from Statsig's CSP guidance when you build an allowlist.

Opt out completely:

```ts
import { setup } from '@incodetech/core';

await setup({
  apiURL: 'https://api.incode.com',
  featureManagement: false,
});
```

With `featureManagement: false` the chunk is never fetched and no feature-management request leaves the browser. Reads from `@incodetech/core/feature-management` keep working and resolve to their defaults, so opting out does not break code that checks a gate.

**What identity is sent.** No customer API key is involved. The integration generates its own anonymous identifier (a "StableID") and enriches it over the session with hashed session, flow, and workflow identifiers. Two privacy defaults are already conservative, and two flags tighten them further:

- IP address and country are **redacted by default** before anything is sent. Use `redactedUserInfo` to redact more fields, or to send those two deliberately.
- `disableStableId: true` stops the identifier being generated at all — the strongest control. Evaluations then resolve to control values until session identity arrives.
- `disablePersistence: true` keeps identity in memory only, so it is never linkable across page loads.

See [`FeatureManagementSetupOptions`](/sdk-reference/web-sdk-2-reference/#featuremanagementsetupoptions) for the full option table, and [Feature management](/sdk-reference/web-sdk-2-reference/#feature-management) for the read API.

## Digital-ID provider logos (Trinsic)

**What:** Brand logos for the providers on the ID Capture document chooser. When a flow enables digital-ID bank redirects, the chooser shows one card per provider (for example iDIN or Finnish Trust Network) and each card loads its logo as an `<img>`. A flow with no digital-ID methods never requests this domain.

**Default domain:** `content.trinsic.id`

There is no `setup()` option for this. To allow it, add `content.trinsic.id` to your `img-src` Content-Security-Policy directive.

If the domain is blocked, the provider cards still render and stay selectable — the logo is decorative and carries an empty `alt`, so nothing is announced to screen readers and no functionality is lost. The card's icon area is simply blank; it does **not** fall back to the SDK's built-in digital-ID glyph.

When the Incode API supplies an absolute `logoUrl` for a method, that URL takes precedence and the request goes to whichever host the API named instead of this default.

## API-driven externals

These URLs come from Incode API responses, not hardcoded SDK constants. Most of them are presigned links to Incode storage, for example on `*.s3.amazonaws.com`. Take the exact hosts from the responses in your environment when you build an allowlist.

- **Theme and logo assets.** To skip them, set `disableDashboardTheme: true` in the `<incode-flow>` or `<incode-workflow>` config. For standalone modules, call `setup({ theme: false })`. The SDK then uses its default theme.
- **Face Match photos.** The Face Match animation shows the cropped ID face and the selfie as images from presigned links. Allow their host in `img-src`, or turn off the animation (`disableFaceMatchAnimation`) for the Face Match step in your flow configuration.
- Presigned upload URLs (electronic signature document uploads)
- Signed PDF document URLs
- Recording upload URLs (when video recording is enabled). For 2.3.0, allow HTTPS uploads to the destinations supplied for the session. A recording-specific WebSocket allowance is no longer required.

Configure the remaining items in Dashboard or with your Incode account team.

The API supplies the desktop-to-mobile redirect URL by default. Set `FlowConfig.redirectToMobileUrl` to replace this URL for one `<incode-flow>` instance.

## Content-Security-Policy

In addition to the hosts on this page, the SDK needs these CSP allowances:

| Directive    | Value           | Why                                                                                                                                                                                    |
| ------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `script-src` | `'unsafe-eval'` | The WASM runtime generates its JavaScript bindings with `new Function`. Without this value, WASM initialization fails and capture can't start. It also allows WebAssembly compilation. |
| `script-src` | `blob:` | The SDK checks the WASM glue code against its release digest and then runs those exact bytes from a `blob:` URL. Without this value, WASM initialization fails and capture can't start. |
| `worker-src` | `blob:`         | The SDK runs some work in workers that it creates from `blob:` URLs, for example the voice-consent MP3 encoder and the PDF viewer (Digital ID upload, electronic signature).           |

## Navigation-only links

Some modules link to Incode policy pages (for example, terms-of-service or privacy-policy links in consent screens). These are user-initiated navigation, not requests the SDK makes on its own.

## See Also

- [WASM Configuration](/sdk-reference/web-sdk-2-wasm/): self-hosting WASM and ML models
- [Internationalization](/sdk-reference/web-sdk-2-i18n/): self-hosting or bundling translations
- [API Reference](/sdk-reference/web-sdk-2-reference/): the full `setup()` options reference
- [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/): routing SDK traffic through your own dedicated host

---

- Path: `sdk-reference/web-sdk-2-troubleshooting`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-troubleshooting/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-troubleshooting.md

# Troubleshooting

<Component slug="web-2-x-implementation-warning" />

Common issues integrators hit and how to resolve them. Also see the per-module pages and [Getting Started](/sdk-reference/web-sdk-2-getting-started/) for setup-level questions.

## Camera issues

| Issue                                 | Solution                                                                                                                                                                                                                            |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Black screen / no camera preview      | Use HTTPS (or `localhost` during development) — `getUserMedia` is gated behind a secure context.                                                                                                                                    |
| Permission denied                     | User must grant camera access in the browser. Surface the SDK's `permissions.denied` state and link them to browser-specific instructions.                                                                                          |
| Camera in use / `NotReadableError`    | Another tab or app holds the camera. The SDK can't release a camera held by another process; instruct the user to close other camera consumers.                                                                                     |
| Camera freezes when remounting        | Tear down the previous module before mounting a new camera-using module. Call `manager.stop()` on the old manager / unmount the old element.                                                                                        |
| iOS Safari: video doesn't play inline | The SDK's own `<video>` elements are tagged `playsinline`/`muted`/`autoPlay`. If you build a custom UI in headless mode, replicate those attributes — without `playsinline`, iOS opens video full-screen and breaks face detection. |

## WASM issues

| Issue                                        | Solution                                                                                                                                                                                                             |
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| WASM not loading                             | Confirm `setup({ wasm: ... })` actually ran. With CDN defaults, paths are optional; with `setup({ wasm: false })` (or omitted), WASM only loads lazily when a selfie or ID-capture step starts.                      |
| WASM 404                                     | When self-hosting, verify `wasmPath`, `glueCodePath`, and `modelsBasePath` resolve. The defaults assume `models/` lives next to the WASM binary.                                                                     |
| `CompileError: WebAssembly.compile()`        | Server is returning the WASM file with the wrong MIME type. Configure your host to return `Content-Type: application/wasm` for `.wasm` files (Nginx: add to `mime.types`; Apache: `AddType application/wasm .wasm`). |
| `RangeError`, `Failed to load module script` | Browser is too old or doesn't support WASM SIMD. Check browser support; fall back to non-SIMD by setting `setup({ wasm: { useSimd: false } })`.                                                                      |
| `WASM_INTEGRITY_MISMATCH` | A WASM binary, glue file, or model is not the official file for this SDK release. When self-hosting, deploy the unmodified release-matched distribution and don't mix files from other SDK releases. Clear stale caches after an upgrade. |
| `WASM_ASSET_NOT_BINARY` | The host returned an HTML page instead of a WASM file, usually because the file is missing at its configured URL. Check the path. |
| `WASM_GLUE_BLOCKED_BY_CSP` | Your Content-Security-Policy blocks the WASM glue, which the SDK loads from a `blob:` URL after verifying it. Add `blob:` to `script-src`. |
| Face/document detection never triggers       | Model files are missing. Check the network tab for failing requests under `modelsBasePath`.                                                                                                                          |

See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/) for the full surface.

## Session issues

| Issue                                                        | Solution                                                                                                                                                                                                                                                                                                                   |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `"SDK not configured. Call setup({ apiURL: '...' }) first."` | Call `setup({ apiURL })` before `createSession()` or any module manager method.                                                                                                                                                                                                                                            |
| `"Token is required"`                                        | Provide `token` (from `createSession()`) on `<incode-flow>`'s config, or use the self-loading variant with `apiKey` + `configurationId` (prototyping only).                                                                                                                                                                |
| Token expired mid-flow                                       | Tokens have a TTL set per-tenant in the Dashboard. Long verification sessions can outlive the token. Either bump the TTL in the Dashboard or restart the flow with a fresh session.                                                                                                                                        |
| Invalid API key                                              | Verify the key in the Incode Dashboard under Settings → API Keys. Ensure your domain is allowed under CORS.                                                                                                                                                                                                                |
| Invalid configuration                                        | Make sure the `configurationId` exists, is active, and matches the tenant the API key belongs to.                                                                                                                                                                                                                          |
| `"No registered module found for: <KEY>"`                    | A backend-driven step doesn't have a state machine registered in `createOrchestratedFlowManager({ modules: ... })`. Log `flowState.steps` after `flowManager.load()` to see which keys the backend emitted, and register them. See [Headless Mode → Module Registration](/sdk-reference/web-sdk-2-headless-mode/#module-registration). |

## Iframe embedding

| Issue                                      | Solution                                                                                                                                                                                                                                                                                          |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Camera prompt doesn't appear in iframe     | Add `allow="camera; microphone"` to the iframe element. `getUserMedia` requires explicit feature-policy delegation across iframe boundaries.                                                                                                                                                      |
| `<incode-flow-completed>` redirect blocked | The default redirect uses `window.location.href`, which fails if the iframe doesn't have `allow-top-navigation` (or `allow-top-navigation-by-user-activation`). Either grant the sandbox permission or set `disable-redirect` on `<incode-flow-completed>` and handle navigation from the parent. |
| Cookies / storage isolation                | The SDK uses `localStorage` for some state (e.g. Deepsight session). Browsers in strict-tracking-prevention mode partition third-party iframe storage; if the iframe is cross-origin, plan for state to be scoped per-iframe and not shared with the host.                                        |

## Mobile Safari

| Issue                                     | Solution                                                                                                                                                                                                                             |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Camera prompt requires a user gesture     | Don't auto-trigger `manager.requestPermission()` (or auto-mount `<incode-selfie>` / `<incode-id>`) on page load. iOS Safari blocks `getUserMedia` outside of user-gesture handlers. Wire it to a tap on a "Continue" button.         |
| Camera fails after device rotation        | Some iOS versions invalidate the existing `MediaStream` on orientation change. Listen for `orientationchange` (or use a `screen.orientation`-based hook) and call `manager.reset()` or remount the module to acquire a fresh stream. |
| Tutorial Lottie animations don't autoplay | iOS suspends `requestAnimationFrame` in background tabs and after user inactivity. Re-trigger the tutorial on focus if needed.                                                                                                       |

## Content Security Policy

If your app uses a strict CSP, the SDK needs:

| Directive                                                               | Why                                                                 |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `script-src 'wasm-unsafe-eval'` (or `'unsafe-eval'` for older browsers) | WASM compilation/instantiation needs eval-style permissions.        |
| `script-src blob:` | The SDK verifies the WASM glue and then loads it from a `blob:` URL. |
| `worker-src blob:`                                                      | Some ML model loading paths spawn workers from blob URLs.           |
| `connect-src https://*.incodesmile.com` (replace with your environment) | XHR/fetch to Incode API endpoints.                                  |
| `img-src 'self' blob: data:`                                            | Captured frames are rendered to canvas/`<img>` from blob/data URIs. |
| `media-src 'self' blob:`                                                | Camera streams.                                                     |
| `style-src 'self' 'unsafe-inline'` (or hash/nonce)                      | Some module styles inline values during render.                     |

Test against your CSP before deploying. Browsers fail silently for some directives, especially WASM-related ones.

## Styling issues

| Issue                               | Solution                                                                                                                                                                                                                 |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Styles not applied                  | Import `@incodetech/web/base.css` plus a theme (`@incodetech/web/themes/light.css` or `dark.css`), plus per-module CSS like `@incodetech/web/flow/styles.css`.                                                           |
| Overrides not taking effect         | Override at `:root` with `--variable: value;`. Make sure the override loads after the SDK theme.                                                                                                                         |
| Component not visible               | Parent container needs explicit dimensions. The element has `display: block` but no intrinsic size — use `height: 100vh` (or any height) on the parent or a `style="display:block; height:100vh"` on the element itself. |
| Brand color tweak doesn't propagate | Override the `--primitive-color-brand-*` scale rather than individual component tokens — semantic and component tokens cascade from the primitives. See [Theming & Styling](/sdk-reference/web-sdk-2-theming/).                      |

## Build / TypeScript issues

| Issue                                                                   | Solution                                                                                                                                                                                                                                                                                                     |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Property 'incode-flow' does not exist on type 'JSX.IntrinsicElements'` | React 18 strict-checks JSX. Add the JSX augmentation from [Framework Integration → TypeScript: JSX support for `incode-*` tags](/sdk-reference/web-sdk-2-framework-integration/#typescript-jsx-support-for-incode--tags). React 19+ doesn't need this.                                                                   |
| `<incode-flow config={{token}}>` renders nothing on React 18            | React 18 serializes JSX props through `setAttribute`, so object/function props become `"[object Object]"`. Use the ref + `useEffect` pattern from [Framework Integration → Universal pattern](/sdk-reference/web-sdk-2-framework-integration/#universal-pattern-works-on-react-168). React 19+ can use the simpler form. |
| Bundle too large                                                        | Use subpath imports (`@incodetech/web/selfie`, never the package root). See [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/).                                                                                                                                                                        |
| Tree-shaking not working                                                | Use subpath imports (`@incodetech/web/<module>`), not the package root. Verify with your bundler's size analyzer.                                                                                                                                                                                            |
| Circular import or `Cannot find module '@incodetech/infra'`             | `@incodetech/infra` is internal — never import from it directly. Use the `@incodetech/core/<subpath>` re-exports.                                                                                                                                                                                            |

See [Bundle Optimization](/sdk-reference/web-sdk-2-bundle-optimization/) for performance details.

## Network issues

| Issue                                                 | Solution                                                                                                                                   |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| CORS errors on `/omni/start` (or other API endpoints) | Allowlist your domain in the Incode Dashboard.                                                                                             |
| API requests failing                                  | Verify the `apiURL` matches the environment your API key was issued for (demo vs. production tenants are separate).                        |
| Firewall blocking                                     | Allow `*.incodesmile.com` in your egress allow-list (and the CDN domain you point WASM paths at, if self-hosting).                         |
| Upload progress stuck at 0%                           | Older browsers don't expose upload progress on `fetch`. The SDK falls back to `XMLHttpRequest` when an `onUploadProgress` callback is set. |

## Flow-level edge cases

| Issue                                                       | Solution                                                                                                                                                                                                                                                                               |
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Selfie ends in `closed` state and the flow doesn't continue | `closed` is final — the manager won't transition further on its own. In orchestrated flows, call `flowManager.completeModule()`. In standalone usage, navigate the user out. See [Module: Selfie → Handling cancellation](/sdk-reference/web-sdk-2-module-selfie-1/#handling-cancellation-closed). |
| ID capture stuck on `capture.success`                       | Call `idManager.nextStep()` to advance to `frontFinished` or `processing`. The state machine waits for the explicit advance.                                                                                                                                                           |
| `expired` state — `reset()` does nothing                    | The `expired` state only responds to `RETRY_CAPTURE`. Call `idManager.retryCapture()`.                                                                                                                                                                                                 |
| Mandatory consent screen shows for every flow               | The screen only renders when the upload response sets `showMandatoryConsent: true`, which is driven by `regulationType` in the session. Verify the configuration in the Dashboard.                                                                                                     |

## Getting help

1. Check the browser console for SDK errors. The SDK prefixes most warnings/errors clearly.
2. Inspect the Network tab. Failing API requests usually have a meaningful error body.
3. Subscribe to flow events via `subscribeEvent` from `@incodetech/core/events` to capture the SDK's analytics stream. This is useful when reproducing issues for support.
4. Contact [support@incode.com](mailto:support@incode.com) with SDK alpha version, browser + OS, the failing flow's `configurationId`, and the steps to reproduce.

---

- Path: `sdk-reference/web-sdk-2-typescript-types`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-typescript-types/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-typescript-types.md

# TypeScript Types

<Component slug="web-2-x-implementation-warning" />

The SDK is written in TypeScript and provides full type definitions.

## Importing Types

```typescript
import type { FlowConfig } from '@incodetech/web/flow';
import type { FinishStatus } from '@incodetech/core/flow';
import type {
  PhoneConfig,
  PhoneState,
  PhoneManager,
} from '@incodetech/core/phone';
import type {
  EmailConfig,
  EmailState,
  EmailManager,
} from '@incodetech/core/email';
import type {
  SelfieConfig,
  SelfieState,
  SelfieManager,
} from '@incodetech/core/selfie';
import type {
  IdCaptureConfig,
  IdCaptureState,
  IdCaptureManager,
} from '@incodetech/core/id';
```

Each module's `@incodetech/core/<name>` subpath ships the canonical types — `Config`, `State`, and `Manager` for headless usage. Per-module deep-dives ([Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/), [Module: ID](/sdk-reference/web-sdk-2-module-id-capture/), [Module: Phone](/sdk-reference/web-sdk-2-module-phone/), [Module: Email](/sdk-reference/web-sdk-2-module-email/)) cover the property-level breakdowns; the rest of this page focuses on patterns and SDK-wide types.

## Web Component Element Types

The SDK augments `HTMLElementTagNameMap` for `<incode-flow>` and `<incode-workflow>` so that `document.createElement('incode-flow')` and `document.querySelector('incode-flow')` return a fully typed element with `.config`, `.onFinish`, and `.onError` properties:

```typescript
import '@incodetech/web/flow'; // registers the custom element + brings the type augmentation

const flow = document.createElement('incode-flow');
flow.config = {
  // ✅ typed as FlowConfig
  token: 'session-token',
  lang: 'en-US',
  enableHome: true,
};
flow.onFinish = (result) => {
  // ✅ result typed as FinishStatus | undefined
  console.log(result?.action);
};
flow.onError = (error, code) => {
  // ✅ error: string | undefined, code: number | undefined
  console.error(error, code);
};
```

Other module tags do not augment `HTMLElementTagNameMap`. Use the exported `IncodeModuleProps` to type their properties, and check selector results before assignment:

```typescript
import type { IncodeModuleProps } from '@incodetech/web/extensibility';
import type { PhoneConfig, PhoneManager } from '@incodetech/core/phone';
import '@incodetech/web/phone';

type PhoneElement = HTMLElement & IncodeModuleProps<Partial<PhoneConfig>, void, PhoneManager>;
const phone = document.querySelector<PhoneElement>('incode-phone');
if (phone) {
  phone.config = { otpVerification: true };
  phone.onFinish = () => console.log('Phone verification complete');
}
```

Use the corresponding module's config and manager types for other tags. Component `config` accepts partial configuration; core manager factories can require complete configuration. See [Web Components](/sdk-reference/web-sdk-2-web-components/).

## Configuration Types

Per-module config types (`PhoneConfig`, `EmailConfig`, `SelfieConfig`, `IdCaptureConfig`, `FlowConfig`, etc.) are documented in their respective deep-dive pages with full property tables. Import them from `@incodetech/core/<module>` (or `@incodetech/web/flow` for `FlowConfig`). Your editor's go-to-definition (or hover docs) takes you straight to the canonical declarations.

The remaining types in this section are SDK-wide and don't belong on a single module page.

### WASM configuration

Import the supported configuration type instead of maintaining a local copy:

```typescript
import type { WasmConfig, WasmPipeline, WasmSource, DefineWasmOptions } from '@incodetech/core/wasm';
```

`WasmPipeline` supports `selfie`, `idCapture`, `onDeviceSelfie`, `videoSelfie`, and `videoSelfieId`. The default warmup set is `selfie` and `idCapture`.

`WasmConfig` includes the self-hosting and source-loading options available in 2.3.0. See [WASM Configuration](/sdk-reference/web-sdk-2-wasm/) for supported deployment choices.

### Session initialization types

Define a `SessionInitOptions` object with your session token and any optional settings:

```typescript
import type { SessionInitOptions, SessionInitResult } from '@incodetech/core/session';

const options: SessionInitOptions = {
  token: 'YOUR_SESSION_TOKEN',
  preloadFlow: true,
  awaitFingerprint: false,
  signal: new AbortController().signal,
};
```

Application code should pass `token` explicitly. `preloadFlow` optionally loads Flow configuration during initialization; `signal` supports cancellation.

`awaitFingerprint` defaults to `true`. With `false`, initialization resolves while fingerprint submission continues in the background. The initial result's `fingerprintSuccess` and `fingerprintResult` do not yet represent its final outcome; use `whenSessionFingerprintSettled()` to await that outcome. `fingerprintResult` is also `undefined` when fingerprint submission is disabled. See [API Reference](/sdk-reference/web-sdk-2-reference/#initializesession).

### Features

```typescript
type FeatureName = 
  | 'VIDEO_SELFIE_V2' 
  | 'USE_CLIENT_GLARE' 
  | 'USE_OPEN_VIDU' 
  | 'DISABLE_IPIFY';

type FeatureConfig = {
  enabled: boolean;
  feature: FeatureName;
  config?: number | string;
};

type Features = {
  features?: FeatureConfig[];
  sessionIdentifier: string;
};
```

### SpinnerConfig

```typescript
type SpinnerSize = 'small' | 'medium' | 'large';

type SpinnerRenderMode = 'spinnerAndText' | 'spinnerOnly' | 'textOnly';

/** Loader presentation. Settable globally via `setup({ uiConfig: { spinner } })`
 *  or per element via `config.spinner`. Copy comes from i18n, not from here. */
type SpinnerPresentation = {
  /** Which parts of the loader render */
  renderMode?: SpinnerRenderMode;
  /** Size of the spinner icon (default: 'medium') */
  size?: SpinnerSize;
};

type SpinnerConfig = SpinnerPresentation & {
  /** @deprecated Set copy via i18n translations. Still supported in 2.3.0. */
  title?: string;
  /** @deprecated Set copy via i18n translations. Still supported in 2.3.0. */
  subtitle?: string;
};
```

### Asset override types

```typescript
type AssetKey =
  | 'faceMatch.success'
  | 'faceMatch.fail'
  | 'documentCapture.tutorial'
  | 'id.uploadScreen'
  | 'id.ageVerification.dob'
  | 'id.ageVerification.scan'
  | 'id.ageVerification.privacy'
  | 'videoSelfie.success'
  | 'videoSelfie.fail'
  | 'videoSelfie.tutorial.permission'
  | 'videoSelfie.tutorial.selfie'
  | 'videoSelfie.tutorial.frontId'
  | 'videoSelfie.tutorial.backId'
  | 'videoSelfie.tutorial.poa'
  | 'videoSelfie.tutorial.questions'
  | 'videoSelfie.tutorial.speech'
  | 'loader.spinner';

type AnimationKey =
  | 'id.tutorial.front'
  | 'id.tutorial.back'
  | 'id.tutorial.passport'
  | 'id.flip'
  | 'id.processing'
  | 'selfie.tutorial'
  | 'loader.spinner';

type AssetOverride =
  | string // URL, or raw `<svg …>` markup (leading '<')
  | { url: string }
  | { raw: string } // sanitized before injection
  | { svg: SvgComponent }; // precompiled Preact component

type AnimationOverride =
  | LottieAnimationData
  | { url: string }
  | { animationData: LottieAnimationData };

type AssetOverrides = Partial<Record<AssetKey, AssetOverride>>;
type AnimationOverrides = Partial<Record<AnimationKey, AnimationOverride>>;
```

Import from `@incodetech/web` (or `@incodetech/web/extensibility`). `AssetOverrides` / `AnimationOverrides` are the maps accepted by `UiConfig.assets` / `UiConfig.animations` (global) and by `FlowConfig` / any module `config` prop (per-instance). See [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/) for the full allowlist and precedence rules.

## State Types

Every module's state is a discriminated union keyed on `status`. Import the canonical type and narrow it before reading state-specific fields:

```typescript
import type { PhoneState } from '@incodetech/core/phone';
```

The [Phone module reference](/sdk-reference/web-sdk-2-module-phone/#state-machine-flow) documents loading, input validation, and OTP payloads. Avoid copying a shortened union into application code.

### Using Discriminated Unions

```typescript
function handleState(state: PhoneState) {
  switch (state.status) {
    case 'inputting':
      // TypeScript knows state.countryCode exists here
      console.log(state.countryCode);
      break;
    case 'awaitingOtp':
      // TypeScript knows state.resendTimer exists here
      console.log(state.resendTimer);
      break;
  }
}
```

## Completion Result

The result delivered to the `IncodeFlow` `onFinish` callback, and to your code via the `getFinishStatus` helper, is `FinishStatus`, exported from `@incodetech/core/flow`:

```typescript
import type { FinishStatus } from '@incodetech/core/flow';

// type FinishStatus = {
//   redirectionUrl: string;
//   action: 'approved' | 'rejected' | 'none';
//   scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL';
//   endScreenTitle: string | null;
//   endScreenText: string | null;
// };
```

`endScreenTitle` and `endScreenText` contain Dashboard completion copy captured at session creation by the orchestrated Flow. Each is `null` when unconfigured. Apply your own display fallback. The raw `getFinishStatus(flowId)` helper always returns `null` for both fields; it does not restore session-creation copy.

## Manager Types

Every headless manager guarantees these observation and cleanup methods:

```typescript
type Manager<TState> = {
  getState(): TState;
  subscribe(listener: (state: TState) => void): () => void;
  // module-specific methods (e.g. setPhoneNumber, submitOtp, capture, retryCapture, ...)
  stop(): void;
};
```

Start and recovery methods are module-specific: most managers use `load()`, while Video Selfie uses `start()`. A final state cannot be reset; stop that manager and create a new one for another attempt. Use `reset()` only in the states documented by the module.

The module-specific method set is the actionable API. See each module's per-page deep-dive for the full table:

- [Selfie module](/sdk-reference/web-sdk-2-module-selfie-1/#api-methods)
- [ID Capture module](/sdk-reference/web-sdk-2-module-id-capture/#api-methods)
- [Phone module](/sdk-reference/web-sdk-2-module-phone/#api-methods)
- [Email module](/sdk-reference/web-sdk-2-module-email/#api-methods)

Or import the manager type directly: `import type { PhoneManager } from '@incodetech/core/phone'` (and equivalents for `EmailManager`, `SelfieManager`, `IdCaptureManager`).

## See Also

- [API Reference](/sdk-reference/web-sdk-2-reference/): Full API documentation
- [Headless Mode](/sdk-reference/web-sdk-2-headless-mode/): Using managers
- [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/): Replacing branded illustrations and animations

---

- Path: `sdk-reference/web-sdk-2-upgrade-2-3-0`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-upgrade-2-3-0/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-upgrade-2-3-0.md

# Upgrade to Web SDK 2.3.0

This guide covers changes from 2.2.0 to 2.3.0. The replacement behavior below targets **2.3.0 or later**. Keep core and web on matching versions. Removed APIs have no compatibility period in 2.3.0; complete the applicable migration before upgrading. No later removal or restoration date is implied.

<Component slug="web-2-x-implementation-warning" />



Review the sections that apply to your configuration, custom UI, deployment, or event consumers. Applications using SDK components still need to check removed imports and setup options.

## Feature-management readiness

**Before:** `await setup()` waited for feature-management initialization. A host could read a gate immediately afterward.

**In 2.3.0:** initialization runs in the background by default. Early reads can return defaults while initialization is pending. To preserve blocking behavior, use core setup with `awaitInitialization: true`:

```typescript
import { setup } from '@incodetech/core';
import { getFeatureGate } from '@incodetech/core/feature-management';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  featureManagement: { awaitInitialization: true },
});
const gate = getFeatureGate('YOUR_GATE_NAME');
```

Alternatively, keep background initialization and await `getIsFeatureManagementInitialized()` from `@incodetech/core/feature-management` before a dependent read. It resolves to `false` if initialization is unavailable or fails; handle your configured fallback. SDK Flow, Workflow, and module-owned reads already wait where required.

If switching a component integration to core setup, retain its presentation setup as described in [Which setup do I call?](/sdk-reference/web-sdk-2-reference/#when-you-deliberately-use-cores-setup-with-web-components).

## Government Validation

**Before:** custom integrations could configure `backgroundExecution` and `maxOtpAttempts`, render OTP/result screens, and call OTP or retry methods.

**In 2.3.0:** remove those two configuration properties. The public states are `idle`, `loading`, and `finished`; `load()` starts the request. The manager still provides `subscribe()`, `getState()`, and `stop()`.

Remove calls to `submitOtp()`, `setOtpCode()`, `validateOtp()`, `resendOtp()`, and `retry()`. Remove handlers for `awaitingOtp`, `verifyingOtp`, `displaySuccess`, and `error`, and stop reading `otpResponse`.

```typescript
import { createGovernmentValidationManager } from '@incodetech/core/government-validation';

const manager = createGovernmentValidationManager({
  config: { facialValidation: true, dataValidation: true },
});
const unsubscribe = manager.subscribe((state) => {
  if (state.status === 'loading') {
    // Show progress.
  } else if (state.status === 'finished') {
    // Advance the UI; completion does not establish verification approval.
  }
});
manager.load();

function disposeGovernmentValidation() {
  unsubscribe();
  manager.stop();
}
```

The module advances after the request regardless of the validation outcome. Use your supported server-side verification result to make business decisions. See [Government Validation / INE Validation](/sdk-reference/web-sdk-2-module-gov-validation-1/).

## Form validation

**Before:** Custom Fields and Watchlist for Business gated Continue on completed input. Custom UIs could follow that completeness check.

**In 2.3.0:** Continue starts enabled, and submission validates required fields. Render the manager's validation feedback and let the manager validate submission. The optimistic `canSubmit` value means no errors are currently displayed; it does not establish that all required input is present. Watchlist for Business still exposes `isValid` separately; use `canSubmit` to enable Continue. Avoid adding a separate validation gate that hides the manager's feedback.

See [Custom Fields](/sdk-reference/web-sdk-2-module-custom-fields/) and [Watchlist for Business](/sdk-reference/web-sdk-2-module-watchlist-for-business/).

## Headless states and test fixtures

**Before:** exhaustive switches and typed fixtures could rely on the 2.2.0 unions and required fields.

**In 2.3.0:** add the following cases and fields. Read them only after narrowing `state.status`; use the linked reference for each complete payload.

| Module | Update |
| --- | --- |
| Selfie | Handle `manualUpload`, with `phase`, `uploaded`, `canContinue`, `errorKey`, and `attemptsRemaining`. Add required `showManualUploadLink` to tutorial fixtures. Offer `goToManualUpload()` only from the tutorial when the flag is true. Submit files with `manualUploadSelectFile(file)` and call `manualUploadContinue()` when `canContinue` is true. |
| ID Capture | Update `loading`, `tutorial`, and `permissions` fixtures with their new presentation fields. Render from `phase`, `selectedDocumentType`, `currentMode`, and `tutorialEnabled` where present; read `usingBackCamera` for mirroring. See [ID Capture state properties](/sdk-reference/web-sdk-2-module-id-capture/). |
| ID digital methods | Handle the `digitalIdRedirect` and `deviceWallet` states when those methods are enabled. Show redirect success until the user calls `digitalIdRedirectContinue()`. Follow the method-specific actions in [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/). |
| Fiscal QR | Handle `permissionDenied` with browser-permission instructions and a page reload after correction. It is not a retryable scan-error state. |
| Dynamic Forms | Handle `submitFailed` with failure feedback and call `retry()` on user request. |

For example, a 2.2.0 Selfie tutorial fixture could contain only `status: 'tutorial'`. Its 2.3.0 replacement includes the upload-link flag:

```typescript
import type { SelfieState } from '@incodetech/core/selfie';

const tutorial: Extract<SelfieState, { status: 'tutorial' }> = {
  status: 'tutorial',
  showManualUploadLink: false,
};
```

Authentication and Selfie capture-only share face state types, but do not support the Selfie manual-upload journey. Do not enable upload controls for them. See [Selfie](/sdk-reference/web-sdk-2-module-selfie-1/), [Fiscal QR](/sdk-reference/web-sdk-2-individual-modules/#compliance-consent), and [Dynamic Forms](/sdk-reference/web-sdk-2-module-dynamic-forms/).

## Accepted document types

**Before:** `UploadIdResponse.acceptedDocuments` was declared as objects with `type` and `name`. Code could read `entry.name`.

**In 2.3.0:** each entry is a string. Read the entry directly, tolerate unknown values, and hide the list when it is absent or empty. The capture state exposes `acceptedDocuments` and `countryCode` for error presentation:

```typescript
import type { IdCaptureState } from '@incodetech/core/id';

function acceptedDocumentNames(state: IdCaptureState): string[] {
  if (state.status !== 'capture') return [];
  return state.acceptedDocuments ?? [];
}
```

See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/) for the full error-state presentation.

## Self-hosted assets and fonts

**Before:** custom deployments could copy only `base.css`, inject its text without resolving asset URLs, or reuse a flattened on-device asset mirror.

**In 2.3.0:** deploy the complete release-matched asset distribution with its directory layout intact. Refresh the full distribution rather than replacing selected files, and invalidate stale caches. Keep all supplied compatibility assets. Obtain the supported distribution and import configuration from your Incode representative; see [Hosting WASM Files](/sdk-reference/web-sdk-2-wasm/#hosting-wasm-files).

Fonts now load separately through URLs relative to the stylesheet. If you copy `base.css`, also deploy its accompanying `assets/` directory in the same relative location. If you inject stylesheet text, resolve its font URLs against the deployed asset location first. Standard bundler imports and stylesheet links that preserve the package layout need no change.

## Document Capture uploads

**Before:** Document Capture could ignore `sendBase64`, so custom upload handling might receive base64 data even when the flag was false or omitted.

**In 2.3.0:** `false` or omission uses file uploads; `true` requests base64 uploads. To retain base64 handling, explicitly set `sendBase64: true`:

```typescript
import { createDocumentCaptureManager } from '@incodetech/core/document-capture';

const manager = createDocumentCaptureManager({
  config: { processingType: 'addressStatement', sendBase64: true },
});
// Subscribe and drive the capture UI, then call manager.stop() on teardown.
```

Check any custom request adapters against the mode you select. See [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/) for supported document types and upload behavior.

## Event and error handling

**Before:** interview-event consumers could filter `code === 'experimentsAssigned'`.

**In 2.3.0:** filter `code === 'experimentAssigned'`. Consumers processing events from several SDK versions should accept both names while older integrations remain active.

Flow and Workflow module-error messages are now optional. Replace unconditional string operations on `state.error` with a fallback after narrowing to `status === 'error'`. `errorCode` and `moduleErrorCode` are optional too. For example:

```typescript
import type { OrchestratedFlowState } from '@incodetech/core/flow';

function flowErrorText(state: OrchestratedFlowState): string | undefined {
  if (state.status !== 'error') return undefined;
  return state.error || 'Verification could not continue.';
}
```

Use localized fallback copy in your application. Stop matching the former `Mandatory consent error` message. Consent cancellation uses the shared error presentation; messages are not stable identifiers. Forward module codes unchanged when calling `errorModule(error?, moduleErrorCode?)`. See [Event Callbacks](/sdk-reference/web-sdk-2-event-callbacks/).

## Video Selfie terminal outcomes

**Before:** custom hosts could assume the recording continued beyond the configured duration or that exhausted validation attempts remained retryable.

**In 2.3.0:** the configured maximum recording duration is enforced. Expiration shows timeout feedback, completes the current recording, and advances after the feedback screen. Exhausted ID or face validation attempts end the attempt; standalone components report an error, while Flow advances the configured journey.

Handle these outcomes in your custom UI and callbacks; do not automatically restart an exhausted attempt. Completion or journey advancement does not establish verification approval. Review the terminal states and actions in [Video Selfie](/sdk-reference/web-sdk-2-module-video-selfie/#terminal-errors).

## Browser support screens

**Before:** an unsupported browser could enter a module without the SDK's browser-support screen.

**In 2.3.0:** SDK components show guidance for unsupported browser environments, including a link-copy action and a choice to continue. Continuing does not make that browser supported. Test any embedded-browser integration against the [Browser Support](/sdk-reference/incode-web-sdk-2-reference/#browser-support) guidance; native WebViews and third-party in-app browsers are treated differently.

## TrueSight diagnostics

**Before:** an enabled TrueSight configuration could collect diagnostics.

**In 2.3.0:** diagnostics are unavailable, and the accepted setup option has no effect. Remove any operational dependency on receiving those diagnostics. Regular SDK analytics remain available. No restoration date or replacement diagnostic collector is specified.

## Removed APIs

These removals take effect in 2.3.0. Imports, custom configuration, or direct calls must be updated before upgrading.

| Previous usage | Replacement or required action |
| --- | --- |
| `@incodetech/core/personhood` and `createPersonhoodManager()` | Remove the import and the Personhood integration. Personhood is unavailable in this release; no equivalent replacement is provided. Do not present another capture module as the same verification capability. |
| `@incodetech/core/document-upload`, its manager, machine, and related types | Use `@incodetech/core/document-capture` for supported generic-document capture/upload. This is not a drop-in replacement for third-ID verification; third-ID capture remains unsupported. |
| `recording.capability` in ID, Selfie, or Authentication config | Remove the custom provider option and its associated contract imports. Use the supported `enableIdRecording` or `enableFaceRecording` option for SDK-managed recording. A custom-provider replacement is not provided. |
| `getVersions()` on `WasmUtilProvider` imported from `@incodetech/core/extensibility` | Remove the call. There is no replacement runtime-version lookup. |

For Document Upload migration, replace `DocumentUploadConfig.documentType` with a supported `DocumentCaptureConfig.processingType` for your actual document use case. Replace `createDocumentUploadManager()` with `createDocumentCaptureManager({ config })`. The old `capture(imageBase64)` submission becomes `setFile(file, previewDataUrl)` in `tutorial` or `capturing`, followed by `accept()` in `preview` and `continue()` after upload success.

The new manager begins in `tutorial`; do not copy the old `load()` call. It does not expose a `load()` method. Use the action/state table in [Document Capture](/sdk-reference/web-sdk-2-module-document-capture/) and update your old `initializing` / `error` handling to its supported states.

---

- Path: `sdk-reference/web-sdk-2-upgrade-2-4-0`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-upgrade-2-4-0/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-upgrade-2-4-0.md

# Upgrade to Web SDK 2.4.0

This guide covers changes from 2.3.x to 2.4.0. The replacement behavior below targets **2.4.0 or later**. Keep core and web on matching versions. Removed APIs have no compatibility period in 2.4.0; complete the applicable migration before upgrading.

<Component slug="web-2-x-implementation-warning" />

Review the sections that apply to your configuration, custom UI, deployment, or styles. Applications using SDK components still need to check removed configuration options.

## Manual upload removal

**Before:** `manualUploadIdCapture` and `manualUploadSelfieCapture` let the user upload an ID or selfie image from a file. Custom UIs handled the `manualUpload` state and called the manual-upload methods.

**In 2.4.0:** both options are removed, together with their states, methods, and fields. Use camera capture or [Digital ID](/sdk-reference/web-sdk-2-module-id-capture/) for supported documents.

| Previous usage | Required action |
| --- | --- |
| `manualUploadIdCapture` in ID Capture configuration | Remove the option. |
| ID Capture `manualUpload` state, `manualUploadChangeTab(tab)`, `manualUploadSelectFile(side, file)`, `manualUploadContinue()`, and `manualUploadReset()` | Remove the state handler and the calls. |
| `manualUploadSelfieCapture` in Selfie configuration | Remove the option. |
| Selfie `manualUpload` state, `goToManualUpload()`, `manualUploadSelectFile(file)`, and `manualUploadContinue()` | Remove the state handler and the calls. |
| `showManualUploadLink` in Selfie `tutorial` state fixtures | Remove the field from typed fixtures. |

## WASM integrity checks

**Before:** the SDK ran the WASM binaries, glue files, and models that it downloaded.

**In 2.4.0:** the SDK checks each WASM file against the official files for its release before it runs the file. The check applies wherever the files are hosted: the Incode CDN or a self-hosted copy. If a file does not match, the SDK does not run it and WASM initialization fails.

- **Strict Content-Security-Policy:** the SDK loads the verified glue from a `blob:` URL. Add `blob:` to your `script-src` directive.
- **Self-hosted WASM:** serve the unmodified distribution that matches your SDK version. Files from another release no longer load, so refresh the full distribution each time you upgrade. See [Hosting WASM Files](/sdk-reference/web-sdk-2-wasm/#hosting-wasm-files).
- **Secure pages:** the check needs `crypto.subtle`, which browsers expose only on pages served over HTTPS or from `localhost`.

For each integrity error code and its fix, see [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/#wasm-issues).

## Capture-only ID responses

**Before:** `CaptureOnlyResponse.frontImage` was always present, and a back-only capture (`onlyBack: true`) did not call `onCapture`. With an `onCapture` callback, `createIdCaptureManager` and `<incode-id>` could run the regular upload flow instead of the capture-only flow.

**In 2.4.0:** `CaptureOnlyResponse` is a union. `frontImage` is `undefined` for a back-only capture, which now calls `onCapture` with the back image. TypeScript code that reads `response.frontImage.blob` no longer compiles. Check `frontImage` first:

```typescript
import type { CaptureOnlyResponse } from '@incodetech/core/id';

declare function uploadToMyBackend(front?: Blob, back?: Blob): Promise<void>;

async function handleCapture(response: CaptureOnlyResponse) {
  await uploadToMyBackend(response.frontImage?.blob, response.backImage?.blob);
}
```

An ID configuration with `onCapture` now always runs the capture-only flow. Nothing is uploaded, and only the capture-only fields apply: `showTutorial`, `captureAttempts`, `autoCaptureTimeout`, `deviceIdleTimeout`, `enableId`, `enablePassport`, `onlyFront`, `onlyBack`, and `showDocumentChooserScreen`. Runtime behavior for front and front-and-back captures does not change. See [ID Capture](/sdk-reference/web-sdk-2-module-id-capture/).

## Identity Reuse

**Before:** the user selected a document on a radio card, then confirmed with a separate button.

**In 2.4.0:** a tap on a document card or on "Scan a new document" submits that choice at once. The screen also adds a "What data will be shared?" sheet and a link to Incode's Privacy Policy.

- **Custom UIs:** call `submit(documentId)` with a document id or `SCAN_NEW_DOCUMENT`. `submit()` without an argument still submits the current selection, and `chooseDocument(documentId)` still works for two-step UIs. Both ignore ids that are not among the offered documents.
- **Organization name:** the `documentsFound` state has an optional `companyName`. Name the receiving organization when it is present and use generic copy when it is absent.
- **Loading state:** `loading` is now a parallel state, so its `snapshot.value` is an object. Use `snapshot.matches('loading')` instead of a value comparison.
- **Machine overrides:** if you override actors with `identityReuseMachine.provide()`, also provide the new `fetchCompanyName` actor, typed with `FetchCompanyNameResponse`. Otherwise, the real request runs.
- **Styles and tests:** the radio-picker class names `IncodeIdentityReuseCardSelected`, `IncodeIdentityReuseRadio`, `IncodeIdentityReuseRadioChecked`, `IncodeIdentityReuseRadioInner`, `IncodeIdentityReuseCardBody`, `IncodeIdentityReuseCardHeaderLeft`, and `IncodeIdentityReuseScanNewBody` are removed. The `identity-reuse-confirm-button` test id is removed. Update stylesheets and tests that target them.

```typescript
import {
  createIdentityReuseManager,
  SCAN_NEW_DOCUMENT,
} from '@incodetech/core/identity-reuse';

const manager = createIdentityReuseManager({ config: {} });

// Call from the "Scan a new document" card.
function scanNewDocument() {
  manager.submit(SCAN_NEW_DOCUMENT);
}
```

See [Identity Reuse](/sdk-reference/web-sdk-2-module-identity-reuse/).

## Flow completion redirects

**Before:** the flow completion screen navigated to any `redirectionUrl`.

**In 2.4.0:** the SDK navigates only to an absolute `https` URL. For any other value, the completion screen shows, and the console logs a warning. For local development, an `http://localhost` URL is allowed while the page itself runs on `localhost`. The [Digital ID bank redirect](/sdk-reference/digital-id-redirect) uses the same rule.

Change any `http` redirect URL in your flow configuration to `https`.

## Session expiry

**Before:** when the current session expired, the next request failed inside the module, and each module handled that failure separately.

**In 2.4.0:** when a request for the current session returns HTTP 401, the SDK ends every mounted module, Flow, and Workflow, and releases the camera. It then calls `onError` once, with `SESSION_EXPIRED` as the third argument and the error object as the fourth:

```typescript
onError('Session expired', 401, 'SESSION_EXPIRED', error);
```

- **Components:** handle `SESSION_EXPIRED` in `onError`, for example by starting a new session and mounting a new element.
- **Host-supplied managers:** the SDK stops a manager that you pass through the `manager` prop. A stopped manager cannot be reused, so create a new one for the replacement session.
- **Headless integrations:** subscribe with `onSessionExpired()`. Each subscription is called once.

```typescript
import { onSessionExpired } from '@incodetech/core/session';

const unsubscribe = onSessionExpired((error) => {
  // error.code is 'SESSION_EXPIRED' and error.statusCode is 401.
  // Stop your managers, start a new session, and create new managers.
});

// Call unsubscribe() when the owner of the subscription unmounts.
```

A connection failure with no HTTP status does not expire the session. Requests that do not carry the session token do not expire it either.

## Workflow completion copy

**Before:** `onFinish` for `<incode-workflow>` returned `endScreenTitle` and `endScreenText` as `null`, even when Dashboard had custom completion copy.

**In 2.4.0:** self-loading Workflows fill both fields from Dashboard. In token mode, the SDK does not see your session response. Forward both values from the response to the component:

```ts
<incode-workflow
  config={{ token: sessionToken, endScreenTitle, endScreenText }}
  onFinish={handleFinish}
/>
```

See [Workflow](/sdk-reference/web-sdk-2-module-workflow/#self-loading-vs-token-mode).

## Field Comparison validation

**Before:** Field Comparison enabled Continue only after the user completed the first and last name.

**In 2.4.0:** Continue starts enabled. Submitting a blank first or last name shows a required-field error for each missing value and disables Continue until the user corrects them. In a custom UI, render the manager's validation feedback and do not add a separate completeness gate. See [Field Comparison](/sdk-reference/web-sdk-2-module-field-comparison/).

---

- Path: `sdk-reference/web-sdk-2-use-cases`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-use-cases/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-use-cases.md

# Use Cases



This section contains integration guides for specific Web SDK 2.0 scenarios, covering configuration, code, and the user journey.

<Component slug="web-2-x-implementation-warning" />



## [Digital ID: Bank Redirect](/sdk-reference/digital-id-redirect/)


Verify a user with their bank instead of capturing a document. Runs inside the ID Capture module and uses a full-page redirect to schemes like iDIN (Netherlands) and FTN (Finland).

## [Digital ID: mDL Verification](/sdk-reference/digital-id-mdl-verification/)

Verify a user with a mobile driver's license presented from a phone wallet (Apple Wallet, Google Wallet, or CA DMV Wallet). Available through the Hosted onboarding app, the built-in ID component, or the Web SDK 2 ID manager for custom UIs.

---

- Path: `sdk-reference/web-sdk-2-wasm`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-wasm/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-wasm.md

# WASM Configuration

<Component slug="web-2-x-implementation-warning" />

WebAssembly (WASM) powers the SDK's on-device ML pipelines: face detection and liveness for the Selfie module, document detection and quality scoring for the ID Capture module.

## When WASM is Required

The SDK ships the following ML pipelines, all delivered as WebAssembly:

| Pipeline         | Used by                                                                                                 | Default warmup?             | What it does                                                                                                             |
| ---------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `selfie`         | `<incode-selfie>`, `<incode-authentication>` (via `createAuthenticationManager`), `createSelfieManager` | Yes, when `pipelines` is omitted | Face detection, positioning feedback, liveness analysis.                                                                 |
| `idCapture`      | `<incode-id>`, `createIdCaptureManager`                                                                 | Yes, when `pipelines` is omitted | Document detection plus blur / glare / barcode quality checks during capture.                                            |
| `onDeviceSelfie` | Selfie / Authentication when `onDeviceFaceResultsSubmissionEnabled: true`                               | No, opt-in only                 | On-device face-results pipeline. Computes the face analysis client-side; the SDK submits the results to the server only. |
| `videoSelfie`    | `<incode-video-selfie>`, `createVideoSelfieRecordingManager`                                             | No, opt-in only                 | Face detection tuned for the video-selfie flow.                                                                          |
| `videoSelfieId`  | `<incode-video-selfie>`, `createVideoSelfieRecordingManager`                                             | No, opt-in only                 | Document detection tuned for the video-selfie flow.                                                                      |

`onDeviceSelfie` is **opt-in** — it is not in the default `pipelines` set. Enabling it has prerequisites beyond just the WASM pipeline (E2EE-provisioned `apiURL`, the `onDeviceFaceResultsSubmissionEnabled` config flag, and an API-key transmission choice); see [On-Device Face Capture](/sdk-reference/web-sdk-2-on-device-face-capture/) for the full walkthrough.

`videoSelfie` and `videoSelfieId` are also opt-in. The Core Video Selfie recording manager automatically warms the pipelines its config needs; `warmupVideoSelfieWasm` (`@incodetech/core/video-selfie`) remains available for explicit earlier preloading.

WASM is **not** needed for phone verification, email verification, consent, redirect-to-mobile, or any flow that doesn't include the selfie or ID-capture modules — unless you enable [End-to-end encryption](#end-to-end-encryption), which routes all SDK traffic through the WASM transport.

## Configuration

The simplest integration is the `wasm` option on `setup()`. It accepts a `WasmConfig` object, the literal `false`, or can be omitted entirely:

```typescript
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';

// 1. Default: omit the option — the SDK does NOT preload WASM.
//    It loads lazily on first selfie or ID capture.
await setup({ apiURL: 'https://demo-api.incodesmile.com' });
await initializeSession({ token: 'your-session-token' });

// 2. Preload using Incode's CDN defaults (recommended for most apps).
//    Paths and model files come from the CDN; you only choose pipelines.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: { pipelines: ['selfie'] }, // or ['selfie', 'idCapture']
});
await initializeSession({ token: 'your-session-token' });

// 3. Hybrid configuration: override selected paths. Anything omitted
//    continues to use the Incode CDN.
await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: {
    wasmPath: '/wasm/webLib.wasm',
    glueCodePath: '/wasm/webLib.js',
    modelsBasePath: '/wasm/models',
  },
});
await initializeSession({ token: 'your-session-token' });

// 4. Explicitly disable WASM warmup (e.g. when this page only runs
//    phone or email verification, and you want to skip the bundle cost).
await setup({ apiURL: 'https://demo-api.incodesmile.com', wasm: false });
await initializeSession({ token: 'your-session-token' });
```

Each snippet pairs `setup({ apiURL, wasm? })` (which provisions the HTTP client and optionally warms up WASM) with `initializeSession({ token })` (which activates the session). The one-shot form `setup({ apiURL, token })` is still supported and delegates to `initializeSession` internally — splitting them out lets you start `setup` before the session token exists, e.g. to begin WASM warmup while `createSession` is still in flight.

### Advanced: `warmupWasm()` directly

For headless integrations or callers that want to pre-warm WASM before `setup()` runs (or with stricter typing), import the underlying helper from `@incodetech/core/wasm`:

```typescript
import { warmupWasm } from '@incodetech/core/wasm';

await warmupWasm({
  wasmPath: '/wasm/webLib.wasm',
  wasmSimdPath: '/wasm/webLibSimd.wasm', // optional SIMD variant
  glueCodePath: '/wasm/webLib.js',
  modelsBasePath: '/wasm/models', // default: inferred from wasmPath
  pipelines: ['selfie', 'idCapture'], // default: both pipelines
});
```

`WarmupConfig` (the type that `warmupWasm` accepts) requires `wasmPath` and `glueCodePath`. `WasmConfig` (the type `setup({ wasm })` accepts) makes those optional and fills missing fields from the Incode CDN.

### `WasmConfig` properties

`WasmConfig` accepts every `WarmupConfig` property below as optional. It also accepts these setup properties:

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `basePath` | `string` | No | Root URL that contains the binaries, glue modules, and `models/` directory. It derives `wasmPath`, `glueCodePath`, and `modelsBasePath`. |
| `selfHosted` | `boolean` | No | Enables strict asset resolution: a required model that is not supplied throws before any request is made. `defineWasm` sets it automatically; with `basePath`, set it yourself. |

### `WarmupConfig` properties

| Property           | Type             | Required | Description                                                                                                                                                                                                                    |
| ------------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `wasmPath`         | `WasmSource`     | Yes      | URL, data URI, `ArrayBuffer`, or `Uint8Array` for the standard binary                                                                                                                                                           |
| `glueCodePath`     | `string`         | Yes      | Path to the standard JavaScript glue                                                                                                                                                                                            |
| `wasmSimdPath`     | `WasmSource`     | No       | SIMD binary source. Falls back to `wasmPath`                                                                                                                                                                                    |
| `glueCodeSimdPath` | `string`         | No       | Path to the SIMD glue. Defaults to a sibling `.js` derived from `wasmSimdPath`                                                                                                                                                 |
| `useSimd`          | `boolean`        | No       | Use SIMD when available. Default `true`                                                                                                                                                                                        |
| `showLogs` | `boolean` | No | Enables WASM console output, including native errors. Default `false`. Set before the first WASM load; use only for local diagnosis |
| `pipelines`        | `WasmPipeline[]` | No       | Pipelines to preload. Default `['selfie', 'idCapture']`                                                                                                                                                                        |
| `modelsBasePath`   | `string`         | No       | Root URL for model files. Defaults to a directory beside `wasmPath`                                                                                                                                                            |
| `pipelineModels`   | `object`         | No       | Override model filenames per pipeline                                                                                                                                                                                          |
| `modelUrls`        | `object`         | No       | Fully resolved source for each model filename. Used verbatim; the SDK never rewrites these URLs                                                                                                                                |
| `legacyModelUrls`  | `object`         | No       | Non-SIMD counterparts of `modelUrls`, keyed by the same filenames. Used only when SIMD initialization falls back to the standard binary. Also used verbatim                                                                     |
| `loadGlue`         | `function`       | No       | Lazy ES-module loader for standard glue                                                                                                                                                                                         |
| `loadGlueSimd`     | `function`       | No       | Lazy ES-module loader for SIMD glue                                                                                                                                                                                             |

`WasmPipeline` is `'selfie' | 'idCapture' | 'onDeviceSelfie' | 'videoSelfie' | 'videoSelfieId'`. Add `'onDeviceSelfie'` only when you've also enabled `onDeviceFaceResultsSubmissionEnabled` on the relevant Selfie or Authentication config; add `'videoSelfie'` / `'videoSelfieId'` only when your flow includes the video-selfie module.

## End-to-end encryption

`setup({ encryption: true })` opts the SDK into end-to-end-encrypted transport for every request. The encrypted transport runs over the WASM binary channel — the legacy plain `fetch` / XHR transport does **not** support E2EE.

E2EE is a one-flag enable but has provisioning prerequisites (dedicated `apiURL`, MGF1 scheme, and an API-key transmission choice) that can't be guessed. See [End-to-End Encryption](/sdk-reference/web-sdk-2-e2ee/) for the full walkthrough, including the `/0` vs `customHeaders: { 'x-api-key': ... }` choice and failure-mode troubleshooting.

## Hosting WASM Files

The SDK uses `cdn.incodesmile.com` by default. Existing integrations do not need to change.

Use one of these self-hosting routes when the Incode CDN is not permitted:

| Route | Use it when |
| ----- | ----------- |
| `basePath` | You use a customer CDN, an air-gapped mirror, a script tag, or a server-driven Flow or Workflow. |
| Explicit imports | Your bundler must hash and deploy a known module set with the application. |

Self-hosting is available in 2.3.0. Obtain the release-matched asset distribution and deployment instructions from your Incode representative. Deploy the complete distribution without renaming files or changing its directory layout; keep it separate from assets for other SDK releases.

The SDK checks every WASM binary, glue file, and model it loads against the official files for its release, wherever they are hosted. A modified file or a file from another SDK release stops initialization with `WASM_INTEGRITY_MISMATCH`. The check also requires `blob:` in your `script-src` Content-Security-Policy directive; see [Third-Party Dependencies](/sdk-reference/web-sdk-2-third-party-dependencies/).

### Customer CDN or mirror

Point `basePath` at the root of that distribution. Core setup can run before you receive a session token:

```ts
import { setup } from '@incodetech/core';
import { initializeSession } from '@incodetech/core/session';

await setup({
  apiURL: 'https://demo-api.incodesmile.com',
  wasm: {
    basePath: 'https://mycdn.example.com/assets/incode/release-assets',
    selfHosted: true,
    pipelines: ['idCapture'],
  },
});

// Activate the token obtained from your backend before starting verification.
await initializeSession({ token: 'SESSION_TOKEN_FROM_YOUR_BACKEND' });
```

Use a versioned directory or replace the whole distribution atomically and invalidate stale caches. Keep all compatibility assets supplied with the distribution. A missing asset must fail visibly; do not rely on a fallback to the Incode CDN.

Flow and Workflow reuse the WASM configuration from `setup()`. A component-level `wasmConfig` overrides that stored configuration.

### Bundler-managed assets

`defineWasm` from `@incodetech/core/wasm` accepts explicit asset sources and lazy JavaScript loaders and produces a `WasmConfig`. It sets `selfHosted: true` and checks that the declared pipelines have their required assets. Use the release-matched import configuration provided with your asset distribution; the asset inventory is not maintained in this guide.

Configure your bundler to emit the supplied binary assets as URLs and preserve lazy JavaScript imports. `WasmSource` also accepts data URIs, `ArrayBuffer`, and `Uint8Array`; emitted URLs generally avoid retaining the binary in your application's JavaScript memory.

### Missing assets

Treat initialization or download failures as deployment errors. Check that every required asset is available at its configured URL, that CORS permits your application, and that your deployment has not mixed SDK releases. Contact your Incode representative if the supplied distribution does not satisfy the selected pipelines.

### Server Configuration

Serve WASM files with the correct header:

```
Content-Type: application/wasm
```

**Nginx:**

```nginx
types {
  application/wasm wasm;
}
```

**Apache:**

```apache
AddType application/wasm .wasm
```

For a cross-origin CDN, allow the application origin through CORS. Serve model files as `application/octet-stream`.

If the server normally returns `index.html` for unknown paths, exclude the WASM directory. A missing binary must return an error status, not HTML with status `200`.

Versioned asset directories can use:

```text
Cache-Control: public, max-age=31536000, immutable
```

## SIMD Support

The SDK automatically uses SIMD-optimized WASM when the browser supports it, falling back to standard WASM otherwise. Provide both files for best compatibility.

## Lazy Loading

If you don't pass a `wasm` option to `setup()`, WASM stays unloaded until the first `<incode-selfie>` or `<incode-id>` (or their headless `createSelfieManager` / `createIdCaptureManager` counterparts) actually needs it. The Workflow also waits to load the Selfie or ID pipeline until that capture step starts instead of loading both at startup. This keeps the initial bundle small for flows that only run phone, email, consent, or other non-capture steps. For latency-sensitive selfie/ID flows, prefer `wasm: { pipelines: [...] }` so warmup runs while the user is on earlier steps.

## Troubleshooting

| Issue                      | Solution                                  |
| -------------------------- | ----------------------------------------- |
| WASM not loading           | Check file paths and server MIME types    |
| 404 errors                 | Verify files are in your public directory |
| Face detection not working | Ensure models are in the correct path     |

## See Also

- [Module: Selfie](/sdk-reference/web-sdk-2-module-selfie-1/): Selfie capture documentation
- [Troubleshooting](/sdk-reference/web-sdk-2-troubleshooting/): Common issues

---

- Path: `sdk-reference/web-sdk-2-web-components`
- URL: https://developer.incode.com/sdk-reference/web-sdk-2-web-components/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-2-web-components.md

# Web Components

<Component slug="web-2-x-implementation-warning" />

All SDK consumer components ship as standard Web Components, enabling framework-agnostic integration. For the complete catalog see [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/); the table below is the most-used subset.

## Available Components

| Tag name                             | Description                                             | Side-effect import                                                 |
| ------------------------------------ | ------------------------------------------------------- | ------------------------------------------------------------------ |
| `<incode-flow>`                      | Complete orchestrated flow                              | `@incodetech/web/flow`                                             |
| `<incode-flow-completed>`            | Optional post-flow completion screen with auto-redirect | `@incodetech/web/flow` (auto-registered alongside `<incode-flow>`) |
| `<incode-id>`                        | ID document capture                                     | `@incodetech/web/id`                                               |
| `<incode-selfie>`                    | Selfie capture                                          | `@incodetech/web/selfie`                                           |
| `<incode-phone>`                     | Phone verification                                      | `@incodetech/web/phone`                                            |
| `<incode-email>`                     | Email verification                                      | `@incodetech/web/email`                                            |
| `<incode-document-capture>`          | Generic document capture                                | `@incodetech/web/document-capture`                                 |
| `<incode-face-match>`                | Selfie ↔ ID face match                                  | `@incodetech/web/face-match`                                       |
| `<incode-consent>`                   | Consent capture                                         | `@incodetech/web/consent`                                          |
| `<incode-geolocation>`               | Geolocation capture                                     | `@incodetech/web/geolocation`                                      |
| `<incode-antifraud>`                 | Antifraud signals                                       | `@incodetech/web/antifraud`                                        |
| `<incode-curp-validation>`           | CURP validation (Mexico)                                | `@incodetech/web/curp-validation`                                  |
| `<incode-identity-reuse>`            | Identity reuse                                          | `@incodetech/web/identity-reuse`                                   |
| `<incode-redirect-to-mobile>`        | Desktop → mobile handoff                                | `@incodetech/web/redirect-to-mobile`                               |
| `<incode-signature>`                 | Handwritten signature                                   | `@incodetech/web/signature`                                        |
| `<incode-electronic-signature>`      | Electronic signature                                    | `@incodetech/web/electronic-signature`                             |
| `<incode-ae-signature>`              | Advanced Electronic Signature                           | `@incodetech/web/ae-signature`                                     |
| `<incode-qe-signature>`              | Qualified Electronic Signature                          | `@incodetech/web/qe-signature`                                     |
| `<incode-ekyc>`                      | KYC composite                                           | `@incodetech/web/ekyc`                                             |
| `<incode-ekyb>`                      | KYB composite                                           | `@incodetech/web/ekyb`                                             |
| `<incode-workflow>`                  | Server-driven multi-step workflow                       | `@incodetech/web/workflow`                                         |
| `<incode-dynamic-forms>`             | Server-driven multi-screen forms                        | `@incodetech/web/dynamic-forms`                                    |
| `<incode-cross-document-data-match>` | Multi-document cross-check                              | `@incodetech/web/cross-document-data-match`                        |
| `<incode-certificate-issuance>`      | Verifiable certificate issuance                         | `@incodetech/web/certificate-issuance`                             |
| `<incode-field-comparison>`          | First / last name comparison                            | `@incodetech/web/field-comparison`                                 |
| `<incode-government-validation>`     | Government registry validation                          | `@incodetech/web/government-validation`                            |
| `<incode-fiscal-qr>`                 | Mexican Fiscal QR scan                                  | `@incodetech/web/fiscal-qr`                                        |
| `<incode-video-selfie>`              | Recorded multi-step video selfie                        | `@incodetech/web/video-selfie`                                     |

## Usage

Import the module's UI subpath to register the custom element (a side-effect import), then use it in HTML:

```html
<incode-flow id="flow"></incode-flow>

<script type="module">
  import { setup } from '@incodetech/core';
  import { createSession } from '@incodetech/core/session';
  import '@incodetech/web/themes/light.css';
  import '@incodetech/web/base.css';
  import '@incodetech/web/flow';
  import '@incodetech/web/flow/styles.css';

  // Create session (move to backend for production)
  await setup({ apiURL: 'https://demo-api.incodesmile.com', token: '' });
  const session = await createSession('your-api-key', {
    configurationId: 'your-config-id',
  });
  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: session.token,
  });

  const flow = document.getElementById('flow');
  flow.config = {
    token: session.token, // ← the FlowConfig accepts `token`, not `apiURL`
    lang: 'en-US',
    enableHome: true,
  };
  flow.onFinish = (result) => console.log(result);
</script>
```

> **Note:** `apiURL` belongs on the global `setup()` call, _not_ inside the `<incode-flow>` component config. The component's `config` accepts `token` (or `apiKey` + `configurationId` for self-loading), plus optional flags like `lang`, `enableHome`, `authHint`, `wasmConfig`, `spinnerConfig`, and event callbacks (`onFlowEvent`, `onModuleLoading`, etc.).

## Setting Properties

Properties can be set via JavaScript:

```javascript
const element = document.querySelector('incode-phone');

// Object properties (config)
element.config = {
  otpVerification: true,
  otpExpirationInMinutes: 5,
  prefill: false,
};

// Every module's config prop also accepts `assets` / `animations` overrides,
// scoped to this element only — see Asset Overrides.

// Callback properties
element.onFinish = () => console.log('Done!');
element.onError = (err) => console.error(err);
```

## TypeScript Support

Flows and Workflows augment `HTMLElementTagNameMap` through their respective subpath imports. Other module tags need an explicit element type:

```typescript
import '@incodetech/web/flow';

// Automatically typed - no cast needed!
const flow = document.createElement('incode-flow');
flow.config = {
  token: 'session-token',
  lang: 'en-US',
};
flow.onFinish = (result) => {
  // ✅ result is typed
  console.log(result?.action); // 'approved' | 'rejected' | 'none'
};
```

For module components, infer the public props from the exported component. The reusable `ModuleElement` type adds them to the DOM element:

```typescript
import '@incodetech/web/phone';
import type { Phone } from '@incodetech/web/phone';
import type { ComponentProps } from 'preact';

type ModuleElement<Props> = HTMLElement & Props;
type PhoneElement = ModuleElement<ComponentProps<typeof Phone>>;
const phone = document.createElement('incode-phone') as PhoneElement;
phone.config = {
  otpVerification: true,
  otpExpirationInMinutes: 5,
  prefill: false,
};
phone.onFinish = () => console.log('Verified!');
phone.onError = (error) => console.error(error);
```

See [TypeScript Types](/sdk-reference/web-sdk-2-typescript-types/#web-component-element-types) for the full list of available element types.

## Styling

Web Components inherit CSS variables from your page:

```css
:root {
  --button-primary-surface-default: #0066cc;
  --text-title: #333333;
}
```

They also render without Shadow DOM, so any CSS you write against their internal classes applies too — see [Theming & Styling → Direct CSS Overrides](/sdk-reference/web-sdk-2-theming/#direct-css-overrides) for the class-naming convention and specificity rules.

See [Theming & Styling](/sdk-reference/web-sdk-2-theming/) for all available variables.

## Framework Integration

### Vue

`onFinish`/`onError` are properties (not DOM events), so use `.prop` binding to set them — the regular `@event` syntax binds to events, not properties.

```vue
<template>
  <incode-flow ref="flowEl" />
</template>

<script setup>
import '@incodetech/web/themes/light.css';
import '@incodetech/web/base.css';
import '@incodetech/web/flow';
import '@incodetech/web/flow/styles.css';
import { ref, onMounted } from 'vue';
import { setup } from '@incodetech/core';
import { createSession } from '@incodetech/core/session';

const flowEl = ref(null);

onMounted(async () => {
  await setup({ apiURL: 'https://demo-api.incodesmile.com', token: '' });
  const session = await createSession('your-api-key', {
    configurationId: 'your-config-id',
  });
  await setup({
    apiURL: 'https://demo-api.incodesmile.com',
    token: session.token,
  });

  flowEl.value.config = { token: session.token, lang: 'en-US' };
  flowEl.value.onFinish = (result) => console.log('Done!', result);
  flowEl.value.onError = (error) => console.error(error);
});
</script>
```

### Angular

`onFinish` / `onError` are properties on the element, so use property binding (`[onFinish]="..."`) — `(eventName)` binds DOM events, which the SDK does not dispatch.

```typescript
// app.module.ts
import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import '@incodetech/web/flow';

@NgModule({
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
})
export class AppModule {}
```

```html
<incode-flow #flow [config]="flowConfig"></incode-flow>
```

```typescript
// component.ts
@ViewChild('flow', { static: true }) flow!: ElementRef<HTMLElementTagNameMap['incode-flow']>;

ngAfterViewInit() {
  this.flow.nativeElement.onFinish = (result) => this.handleFinish(result);
  this.flow.nativeElement.onError = (error) => this.handleError(error);
}
```

## See Also

- [Getting Started](/sdk-reference/web-sdk-2-getting-started/): three integration paths walked end-to-end
- [IncodeFlow Component](/sdk-reference/web-sdk-2-incodeflow-component/): full `<incode-flow>` reference
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/): every module the SDK ships
- [Asset Overrides](/sdk-reference/web-sdk-2-asset-overrides/): per-instance `config.assets` / `config.animations`

---

- Path: `sdk-reference/web-sdk-reference`
- URL: https://developer.incode.com/sdk-reference/web-sdk-reference/
- Markdown: https://developer.incode.com/sdk-reference/web-sdk-reference.md

# Incode WebSDK Reference

This page documents the JavaScript API of the Incode Web SDK. The SDK is initialized by calling `create`, which returns an `incode` instance that exposes all SDK methods.

For the error codes that `onError` callbacks can receive, see [error codes](#error-codes).



## create

Initializes the SDK and returns an `incode` instance. Call this before any other SDK methods.

```jsx
const onBoarding = OnBoarding.create({
  apiURL: "YOUR_API_URL",
  lang: "en",
});
```

**Parameters:**

| Name                | Type    | Required | Default | Description                                                                    |
| ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `apiKey`            | String  | No       |         | API key provided by Incode.                                                    |
| `apiURL`            | String  | Yes      |         | API URL provided by Incode.                                                    |
| `lang`              | String  | No       |         | Language code, such as `en` or `es`.                                           |
| `encrypt`           | Boolean | No       | `false` | Enables encryption.                                                            |
| `translations`      | Object  | No       |         | Custom translations object. Contact Incode support for the required structure. |
| `opencvURL`         | String  | No       |         | Custom URL for the OpenCV library.                                             |
| `facefinderURL`     | String  | No       |         | Custom URL for the face finder library.                                        |
| `darkMode`          | Boolean | No       | `false` | Shows dark variants for all tutorials.                                         |
| `fingerprintApiKey` | String  | No       |         | Fingerprint API key.                                                           |
| `useSha256`         | Boolean | No       |         | Enables SHA-256 encryption.                                                    |

**Returns:** The SDK instance (`incode` object).



## initialize

> Required beginning with version 1.83.0.

Ensures proper loading of the Web SDK, including the correct translation loading order. Call this after `create`.

```jsx
const Onboarding = await create({
  apiURL: apiURL,
  translations: en,
});

await Onboarding.initialize();
```
## createSession

Start an onboarding session with the Incode Web SDK. Call this after you initialize the SDK and before you render capture modules or run a flow.

### Overview

`createSession` creates a new verification session on Incode’s backend and returns a `Session` object. The most important field is `session.token`: you pass it into every subsequent SDK method (`renderCamera`, `executeFlow`, `executeWorkflow`, and so on).

You must call `initialize()` before creating a session.

```js
const session = await incode.createSession('ALL', null, {
  configurationId: 'YOUR_FLOW_ID',
});

console.log(session.token); // use this for all later SDK calls
```

> Always pass a string as the first argument (for example `'ALL'`). Do not call `createSession({ configurationId })` — that object-only shape belongs to [`createNewSession`](#createnewsession-recommended).

### Method signature

```ts
incode.createSession(
  externalId?: string,
  options?: CreateSessionOptions,
): Promise<Session>
```

### Parameters

#### Positional arguments

| Argument     | Type     | Required | Description                                                                                 |
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------- |
| `externalId` | `string` | No       | Your own identifier for this session (for example a user or application ID in your system). |

#### Options object

| Option               | Type     | Required    | Description                                                                                                 |
| -------------------- | -------- | ----------- | ----------------------------------------------------------------------------------------------------------- |
| `configurationId`    | `string` | Recommended | Flow or workflow ID from the Incode dashboard. Required for almost all integrations.                        |
| `externalCustomerId` | `string` | No          | Your customer / end-user ID.                                                                                |
| `uuid`               | `string` | No          | UUID when linking or resuming an identity.                                                                  |
| `interviewId`        | `string` | No          | Interview ID when continuing an existing interview.                                                         |
| `customFields`       | `object` | No          | Custom key/value data stored on the session.                                                                |
| `language`           | `string` | No          | Session language (for example `en-US`, `es-ES`, `pt-BR`). If omitted, the SDK uses the current UI language. |
| `urlUuid`            | `string` | No          | UUID used with QR redirect / phishing-resistance flows.                                                     |

### Session response

`createSession` resolves to a `Session` object. Fields you typically use:

| Field                  | Type      | Description                                        |
| ---------------------- | --------- | -------------------------------------------------- |
| `token`                | `string`  | Session token. Pass this to all later SDK methods. |
| `interviewId`          | `string`  | Interview identifier for the session.              |
| `interviewCode`        | `string`  | Human-readable interview code.                     |
| `clientId`             | `string`  | Your Incode client ID.                             |
| `existingSession`      | `boolean` | `true` if an existing session was reused.          |
| `showMandatoryConsent` | `boolean` | Whether mandatory consent should be shown.         |
| `regulationType`       | `string`  | Regulation context for consent (when available).   |

Capture timeouts, retry limits, and face-check flags may also be present depending on your flow configuration. Keep the full `session` object if your UI needs those values; at minimum, persist `session.token` for the lifetime of the onboarding.

### Using the session

Pass `session.token` into the module or flow you want to run.

### Error handling

On failure, `createSession` rejects with an error that typically includes:

```ts
type CreateSessionError = {
  status: number;
  message: string;
};
```

Handle failures by checking the status code (for example invalid API key, missing flow ID, or network errors). Do not rely on `message` alone for branching logic in production.

```js
try {
  const session = await incode.createSession('ALL', null, {
    configurationId: 'YOUR_FLOW_ID',
  });
  // continue onboarding…
} catch (error) {
  console.error('Could not start session', error?.status, error);
  // Show a retry or support message to the user
}
```

## createNewSession (recommended)

For new integrations, prefer [`createNewSession`](#create-new-session). It uses a single options object and exposes additional fields.

```js
const session = await incode.createNewSession({
  configurationId: 'YOUR_FLOW_ID',
  externalId: 'user-123',
  language: 'en-US',
});
```

|                | `createSession`                        | `createNewSession`                                                   |
| -------------- | -------------------------------------- | -------------------------------------------------------------------- |
| Call style     | `(countryCode, externalId?, options?)` | `{ ...options }`                                                     |
| First argument | Required string (unused; use `'ALL'`)  | Not applicable                                                       |
| Extra options  | —                                      | `loginHint`, `integrationReference`, `disableFingerprint`, `version` |
| Recommendation | Existing integrations                  | New integrations                                                     |

Both methods create the same kind of session and return the same `Session` shape. Choose one style and stay consistent in your app.

#### Extra `createNewSession` options

| Option                 | Description                                                    |
| ---------------------- | -------------------------------------------------------------- |
| `loginHint`            | Optional auth hint for workflow-based sessions.                |
| `integrationReference` | Reference string for your integration.                         |
| `disableFingerprint`   | Set `true` to skip device fingerprinting during session start. |
| `version`              | Optional version string associated with fingerprinting.        |

### Common patterns

#### Attach your user ID

```js
const session = await incode.createSession('ALL', 'order-98765', {
  configurationId: 'YOUR_FLOW_ID',
  externalCustomerId: 'customer-42',
});
```

#### Set language explicitly

```js
const session = await incode.createNewSession({
  configurationId: 'YOUR_FLOW_ID',
  language: 'es-ES',
});
```

#### Store the token for later steps

```js
const session = await incode.createNewSession({
  configurationId: 'YOUR_FLOW_ID',
});

// Keep token in app state for the rest of onboarding
setSession(session);

// Later modules reuse the same token
incode.renderCamera('selfie', container, {
  token: session.token,
  onSuccess,
  onError,
});
```

## isDesktop

Returns `true` if the user is on a desktop or laptop. Returns `false` if they are using a mobile device. Use this to conditionally render desktop or mobile flows.

```jsx
if (onBoarding.isDesktop()) {
  onBoarding.renderRedirectToMobile(containerRef.current, { ... });
} else {
  renderFrontId();
}
```



## renderRedirectToMobile

Renders the Redirect to Mobile component. This prompts desktop users to continue on their mobile phone.

```jsx
onBoarding.renderRedirectToMobile(containerRef.current, {
  session: session,
  flowId: flowId,
  onSuccess: () => renderFinishScreen(),
});
```

**Options:**

| Name                | Type     | Required | Description                                        |
| ------------------- | -------- | -------- | -------------------------------------------------- |
| `session`           | Object   | Yes      | Session object from `createSession`.               |
| `flowId`            | String   | No       | ID of the flow to use on mobile.                   |
| `onSuccess`         | Function | Yes      | Callback when mobile onboarding completes.         |
| `url`               | String   | No       | URL to redirect to.                                |
| `showSms`           | Boolean  | No       | Shows the SMS component.                           |
| `allowReEnrollment` | Boolean  | No       | Allows user re-enrollment.                         |
| `externalId`        | String   | No       | External ID to add to the URL.                     |
| `assets`            | Object   | No       | Assets from Dashboard.                             |
| `expired`           | Boolean  | No       | Indicates if the session expired.                  |
| `smsText`           | String   | No       | Custom SMS text. The URL is added after this text. |



## renderCombinedConsent

Renders a combined consent interface configured in Dashboard.

```jsx
renderCombinedConsent(consentElement, {
  token: session,
  onSuccess: () => console.log("Consent given"),
  consentId: "someConsentId",
});
```

**Parameters:**

| Name        | Type        | Required | Description                              |
| ----------- | ----------- | -------- | ---------------------------------------- |
| `element`   | HTMLElement | Yes      | DOM element to render into.              |
| `consentId` | String      | Yes      | ID of a consent configured in Dashboard. |
| `token`     | Object      | Yes      | Session object from `createSession`.     |
| `onSuccess` | Function    | Yes      | Callback when consent is given.          |



## sendGeolocation

Requests the user's coordinates and sends them to the session.

```jsx
onBoarding.sendGeolocation({ token }).then((res) => res);
```

**Parameters:**

| Name    | Type   | Description           |
| ------- | ------ | --------------------- |
| `token` | String | Session access token. |

**Returns:** `{ "location": "City, Country" }`



## sendFingerprint

Sends device and browser information for the session. This includes browser version, device model, OS, SDK version, and IP address.

```jsx
onBoarding.sendFingerprint({ token: session.token }).then((response) => {
  console.log(response.success);
});
```

**Parameters:**

| Name    | Type   | Description           |
| ------- | ------ | --------------------- |
| `token` | String | Session access token. |

**Returns:** `{ success: boolean, sessionStatus: string }`



## renderCaptureId

> Introduced in version 1.80.0.

Initializes and renders the ID Capture module. This includes the document type selector, capture tutorials, and capture UI for both double-sided and single-sided documents, such as driver's licenses and passports. `renderCaptureId` captures both sides of double-sided documents in a single call.

Most module options—such as capture attempts, manual capture timeout, and tutorials—are configured in Dashboard, not in code.

```jsx
const { close } = renderCaptureId(myElement, {
  session: { token: 'YOUR_TOKEN' },
  onSuccess: () => console.log('ID capture successful'),
  onError: (error) => console.error('ID capture failed:', error),
});
```

**Props:**

| Name          | Type     | Required | Default | Description                                                                            |
| ------------- | -------- | -------- | ------- | -------------------------------------------------------------------------------------- |
| `session`     | Object   | Yes      |         | Session object containing `token`.                                                     |
| `onSuccess`   | Function | Yes      |         | Callback after ID Capture completes. The component is unmounted before this is called. |
| `onError`     | Function | Yes      |         | Callback if an error occurs. Receives an `IdError` object or a standard `Error`.       |
| `forceIdV2`   | Boolean  | No       | `false` | Forces the ID Capture v2 experience.                                                   |
| `captureOnly` | Boolean  | No       | `false` | Forces capture-only mode: local capture, no upload.                                    |

**Returns:** `{ close: function }`. Call `close()` to unmount the component.

**Error codes (**`IdError.code`**):** `onError` can receive `NO_MORE_TRIES`, `PERMISSION_DENIED`, `PERMISSION_REFRESH`, `MODULE_NOT_FOUND`, `WEBCAM_ERROR`, `FETCH_FLOW_ERROR`, `USER_CANCELLED`, or `UNKNOWN_ERROR`. See [error codes](#error-codes).



## renderCaptureFace

> Introduced in version 1.81.0.

Initializes and renders the Face Capture module.

> 📘 Note
>
> Starting in version 1.83.0, `processFace` is no longer called automatically at the end of `renderCaptureFace`. You must call it explicitly.

```jsx
const { close } = renderCaptureFace(container, {
  session: { token: 'YOUR_TOKEN' },
  onSuccess: (response) => console.log('Face capture successful', response),
  onError: (error) => console.error('Face capture failed:', error.message),
});
```

**Props:**

| Name          | Type     | Required | Default | Description                                                                       |
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `session`     | Object   | Yes      |         | Session object containing `token`                                                 |
| `onSuccess`   | Function | Yes      |         | Callback after successful capture. The component is unmounted first.              |
| `onError`     | Function | Yes      |         | Callback if an error occurs. Receives a `FaceError` object or a standard `Error`. |
| `forceV2`     | Boolean  | No       | `false` | Forces the Face Capture v2 experience.                                            |
| `captureOnly` | Boolean  | No       | `false` | Forces capture-only mode: local capture, no upload.                               |

**Returns:** `{ close: function }`. Call `close()` to unmount the component.

**Error codes (**`FaceError.code`**):** `onError` can receive `NO_MORE_TRIES`, `PERMISSION_DENIED`, `PERMISSION_REFRESH`, `MODULE_NOT_FOUND`, `WEBCAM_ERROR`, `FETCH_FLOW_ERROR`, `USER_CANCELLED`, or `UNKNOWN_ERROR`. See [error codes](#error-codes).



## renderDocumentSelector

Renders a Document Selector in a given container. Accepts the same parameters as `renderCamera`, excluding `type`.

```jsx
renderDocumentSelector(element, {
  onSuccess: () => { /* success handler */ },
  onError: () => { /* error handler */ },
});
```

**Key Options:**

| Name                | Type     | Default | Description                                              |
| ------------------- | -------- | ------- | -------------------------------------------------------- |
| `onSuccess`         | Function |         | Callback when selection is successful.                   |
| `onError`           | Function |         | Callback when an error occurs.                           |
| `token`             | Object   |         | Session token.                                           |
| `numberOfTries`     | Number   | `3`     | Number of allowed attempts.                              |
| `timeout`           | Number   | `40000` | Timeout in milliseconds.                                 |
| `showTutorial`      | Boolean  | `false` | Shows a tutorial.                                        |
| `nativeCamera`      | Boolean  | `false` | Uses the native camera; this allows PDF or image upload. |
| `sendBase64`        | Boolean  | `true`  | Send the image as base64.                                |
| `fullScreen`        | Boolean  | `true`  | Enables full-screen mode.                                |
| `disableFullScreen` | Boolean  | `false` | Uses container width and height instead of full screen.  |
| `scanPdf417`        | Boolean  | `false` | Scans for PDF417 barcodes.                               |
| `isSecondId`        | Boolean  | `false` | Indicates this is a second ID.                           |



## renderCamera

> For new integrations, use `renderCaptureId` and `renderCaptureFace` instead.

Enables the device camera to capture an ID, selfie, or proof of address document.

```jsx
incode.renderCamera("front", container, {
  onSuccess: myCallback,
  onError: console.log,
  numberOfTries: 3,
  token: session.token,
});
```

**Type Values (Capture Modes):**

| Value                    | Description              |
| ------------------------ | ------------------------ |
| `front`                  | Front side of ID         |
| `back`                   | Back side of ID          |
| `selfie`                 | Face capture             |
| `document`               | Proof of address capture |
| `passport`               | Passport photo page      |
| `processCarInvoice`      | Mexican car invoice      |
| `processCirculationCard` | Mexican circulation card |

**Key Options:**

| Name                               | Type     | Default | Description                                                                 |
| ---------------------------------- | -------- | ------- | --------------------------------------------------------------------------- |
| `onSuccess`                        | Function |         | Callback after successful capture.                                          |
| `onError`                          | Function |         | Callback when the maximum number of tries is reached.                       |
| `token`                            | Object   |         | Session object.                                                             |
| `numberOfTries`                    | Number   |         | Number of allowed capture attempts. Minimum: `1`.                           |
| `timeout`                          | Number   |         | Milliseconds before enabling manual capture.                                |
| `showTutorial`                     | Boolean  | `false` | Shows a capture tutorial.                                                   |
| `nativeCamera`                     | Boolean  |         | Uses the rear camera and allows PDF or image upload (`document` mode only). |
| `assistedOnboarding`               | Boolean  |         | Uses the rear camera for selfie. For assisted capture.                      |
| `isRecordingEnabled`               | Boolean  | `false` | Records the capture session.                                                |
| `showCustomCameraPermissionScreen` | Boolean  |         | Shows custom permission instructions when camera access is denied.          |
| `hatCheckEnabled`                  | Boolean  |         | Checks for hats.                                                            |
| `lensesCheckEnabled`               | Boolean  |         | Checks for lenses.                                                          |
| `maskCheckEnabled`                 | Boolean  |         | Checks for face masks.                                                      |
| `eyesClosedCheckEnabled`           | Boolean  |         | Checks for closed eyes.                                                     |

**Returns:** `{ close: function }`. Call `close()` to unmount the component.



## processId

Processes the uploaded ID document. Runs Incode's validations, tests, and OCR parsing. Call this after both the front and back uploads are complete. After calling this, the user cannot upload the ID again.

```jsx
const response = await onBoarding.processId({ token });
```

**Returns:** `{ success: true }`



## processFace

Processes the selfie after the user uploads both their selfie and the front of their ID.

```jsx
const response = await onBoarding.processFace({ token });
```

**Returns:**

| Field          | Type    | Description                                    |
| -------------- | ------- | ---------------------------------------------- |
| `confidence`   | Nnumber | Face recognition confidence score from 0 to 1. |
| `existingUser` | Boolean | Whether the user is already enrolled.          |



## renderVideoSelfie

Renders the Video Selfie module. The user takes a selfie, shows their ID, answers questions, and confirms acceptance.

> **Note:** Localization is not supported for the Video Selfie module. You must set a fixed language during session creation using `{"language": "en-US"}`.

```jsx
onBoarding.renderVideoSelfie(
  container,
  {
    token: session,
    showTutorial: true,
    modules: ["front", "back", "speech", "selfie"],
    speechToTextCheck: true,
  },
  {
    onSuccess: () => alert("speech detected"),
    onError: () => alert("speech not detected"),
    numberOfTries: 3,
  }
);
```

**Options:**

| Name                     | Type    | Default | Description                                                                      |
| ------------------------ | ------- | ------- | -------------------------------------------------------------------------------- |
| `token`                  | Object  |         | Session object (required).                                                       |
| `showTutorial`           | Boolean | `false` | Shows a tutorial.                                                                |
| `modules`                | Array   | all     | Modules to include: `selfie`, `front`, `back`, `poa`, `questions`, and `speech`. |
| `speechToTextCheck`      | Boolean | `true`  | Performs a speech-to-text check.                                                 |
| `performLiveness`        | Boolean | `false` | Enables liveness check.                                                          |
| `videoSelfieAsSelfie`    | Boolean |         | Uses the video selfie image for face check instead of the selfie.                |
| `compareOCREnabled`      | Boolean | `false` | Enables front OCR check.                                                         |
| `compareIDEnabled`       | Boolean | `true`  | Enables front ID check.                                                          |
| `questionsCount`         | Number  | `3`     | Number of questions.                                                             |
| `hatCheckEnabled`        | Boolean |         | Checks for hats.                                                                 |
| `lensesCheckEnabled`     | Boolean |         | Checks for lenses.                                                               |
| `maskCheckEnabled`       | Boolean |         | Checks for face masks.                                                           |
| `eyesClosedCheckEnabled` | Boolean |         | Checks for closed eyes.                                                          |



## renderConference

Renders the Video Conference module.

```jsx
onBoarding.renderConference(
  container,
  { token: token, showOTP: false },
  {
    onSuccess: (status) => {
      // status: 'close', 'deny', or 'approve'
    },
  }
);
```

**Options:**

| Name            | Type    | Default | Description                                             |
| --------------- | ------- | ------- | ------------------------------------------------------- |
| `token`         | Object  |         | Session object (required).                              |
| `showOTP`       | Boolean |         | Shows the OTP screen before the conference.             |
| `numberOfTries` | Number  | `3`     | Number of OTP attempts allowed. Pass `-1` for no limit. |
| `queue`         | String  | `''`    | Conference queue.                                       |

**Callbacks:** `onSuccess(status)`, `onError`, `onConnect`, `onLog`



## renderAuthFace

> Available from SDK version 1.84.0. Replaces the deprecated `renderLogin`.

Renders the Face Authentication UI. Supports 1:1 and 1:N authentication modes.

```jsx
IncodeSDK.renderAuthFace(container, {
  session: session,
  authHint: 'customer-uuid-12345', // omit for 1:N
  onSuccess: mySuccessCallbackFn,
  onError: myErrorCallbackFn,
});
```

**Options:**

| Name        | Type     | Description                                        |
| ----------- | -------- | -------------------------------------------------- |
| `session`   | object   | Session object (required)                          |
| `authHint`  | string   | Customer UUID for 1:1 authentication. Omit for 1:N |
| `onSuccess` | function | Callback after successful capture                  |
| `onError`   | function | Callback after max capture attempts reached        |

**Error codes**: `onError` can receive `HINT_NOT_PROVIDED` and `NONEXISTENT_CUSTOMER`. See [error codes](#error-codes).



## renderLogin

> **Deprecated.** Use `renderAuthFace` instead.



## renderEnterCurp

Renders the CURP entry and validation component (Mexico only).

```jsx
incode.renderEnterCurp(document.getElementById('app'), {
  token: session.token,
  onSuccess: console.log,
  onError: console.log,
});
```



## renderSignature

Renders the Signature component for digital signature capture.

```jsx
onBoarding.renderSignature(document.getElementById("app"), {
  token: session.token,
  onSuccess: console.log,
  onError: console.log,
});
```

**Options:**

| Name                    | Type     | Description                                           |
| ----------------------- | -------- | ----------------------------------------------------- |
| `token`                 | string   | Session token (required)                              |
| `onSuccess`             | function | Callback when signature upload succeeds               |
| `onError`               | function | Callback when signature upload fails                  |
| `type`                  | string   | Signature type (for contract signing)                 |
| `initials`              | boolean  | If `true`, capture initials instead of full signature |
| `title`                 | jsx      | Title element                                         |
| `subtitle`              | jsx      | Subtitle element                                      |
| `canvasBackgroundColor` | string   | Canvas background color. Default: `#fff`              |
| `canvasBorderColor`     | string   | Canvas border color. Default: `#20263d`               |
| `penColor`              | string   | Pen color. Default: `#20263d`                         |



## addPhone

Adds a phone number to the current session. Throws an error if a customer with that phone number already exists.

```jsx
onBoarding.addPhone({ token, phone }).then((res) => res);
```

**Returns:** `{ success: true }`



## addCustomFields

Adds custom fields to the current onboarding session.

```jsx
incode.addCustomFields({
  token: session.token,
  fields: { watchlistName: name },
});
```

**Returns:** `{ success: true }`



## renderBiometricConsent

Renders the biometric consent screen. Should be shown as the first screen if `createSession` returns `showMandatoryConsent: true`.

```jsx
incode.renderBiometricConsent(document.getElementById("app"), {
  token: session,
  onSuccess: console.log,
  onCancel: console.log,
  regulationType: "US_Illinois",
});
```

**Options:**

| Name             | Type     | Description                                                                                            |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| `token`          | object   | Session object from `createSession`                                                                    |
| `onSuccess`      | function | Callback after consent is given                                                                        |
| `onCancel`       | function | Callback after consent is cancelled                                                                    |
| `regulationType` | string   | State string from `createSession`. Values: `US_California`, `US_Texas`, `US_Illinois`, `US_Washington` |



## renderMlConsent

Renders the ML Consent component.

```jsx
onBoarding.renderMlConsent(document.getElementById("app"), {
  token: session,
  type: "Worldwide",
  onSuccess() { console.log("ML accepted"); },
});
```


## renderQr

Renders a QR code that, when scanned, opens a specified URL or web flow on mobile.

```jsx
onBoarding.renderQr(containerRef.current, {
  session: session,
  flowId: flowId,
  onSuccess: () => showFinishScreen(),
});
```

**Options:**

| Name             | Type     | Description                               |
| ---------------- | -------- | ----------------------------------------- |
| `session`        | object   | Session object (required)                 |
| `flowId`         | string   | Flow ID to use on mobile                  |
| `onSuccess`      | function | Callback when mobile onboarding completes |
| `url`            | string   | URL to redirect to                        |
| `primaryColor`   | string   | Hex color string for styling              |
| `secondaryColor` | string   | Hex color string for styling              |
| `sizePx`         | number   | QR code size in pixels (width and height) |



## renderQrScanner

Renders a universal QR code scanner. Stores the QR value in the session as the `qrCodeText` custom field.

```jsx
onBoarding.renderQrScanner(document.getElementById("app"), {
  session: session,
  onSuccess() { console.log("QR scanned"); },
});
```



## renderUserConsent

> **Deprecated.** Use `renderCombinedConsent` instead.



## renderFiscalQr

Renders a QR scanner to retrieve information from the URL in the QR code. Mexico only.

```jsx
onBoarding.renderFiscalQr(document.getElementById("app"), {
  session: session,
  onSuccess() { console.log("Fiscal QR scanned"); },
});
```



## Error Codes

When an error occurs, render methods that accept an `onError` callback pass it an error object. The object is either a typed SDK error with a `code` property (for example, `IdError` or `FaceError`) or a standard JavaScript `Error`. Check `error.code` to decide how to respond.

```js
onError: (error) => {
  switch (error?.code) {
    case 'PERMISSION_DENIED':
      // Tell the user how to allow camera access
      break;
    case 'NO_MORE_TRIES':
      // Tell the user they reached the attempt limit
      break;
    default:
      // Show a generic error or retry message
  }
}
```


| Code | Description | Property | Returned by |
| --- | --- | --- | --- |
| `FACE_AUTH_ERROR` | Face authentication failed. | `type` | `executeFlow` |
| `FETCH_FLOW_ERROR` | The SDK couldn't fetch the module configuration. A `401` is reported as `SESSION_EXPIRED`. | `code` | `renderCaptureId`, `renderCaptureFace`, `renderAuthFace` |
| `FLOW_LOAD_FAILED` | The SDK couldn't load the flow. | `type` | `executeFlow` |
| `HINT_NOT_PROVIDED` | No customer identity hint was provided. | `code` | `renderAuthFace` |
| `INCONSISTENT_FLOW_CONFIGURATION` | The ID configuration enables no capture method, or it enables a digital-ID wallet without the document chooser. | `code` | `renderCaptureId` |
| `INVALID_TOKEN` | Reserved for future use. | — | Not currently returned. |
| `MODULE_NOT_FOUND` | The flow configuration doesn't include this module. | `code` | `renderCaptureId`, `renderCaptureFace`, `renderAuthFace` |
| `NO_MORE_ATTEMPTS` | The user reached the maximum number of face-capture attempts. | `code` | `renderCaptureFace`, `renderAuthFace` |
| `NO_MORE_TRIES` | The user reached the maximum number of ID or document attempts. | `code` on `renderCaptureId`; `type` on `renderCamera('document')` | `renderCaptureId`, `renderCamera('document')` |
| `NONEXISTENT_CUSTOMER` | The hint doesn't match any customer. | `code` | `renderAuthFace` |
| `PERMISSION_DENIED` | The user denied camera permissions. Inside `executeFlow`, closing the Payments or eKYC module also reports this code. | `code` on the capture renders; `type` on `executeFlow` and `renderCamera('document')` | `executeFlow`, `renderCaptureId`, `renderCaptureFace`, `renderAuthFace`, `renderCamera('document')` |
| `PERMISSION_REFRESH` | The user is on the denied-permission screen and must refresh the page. V2 only. | `code` on the capture renders; `type` on `executeFlow` | `executeFlow`, `renderCaptureId`, `renderCaptureFace`, `renderAuthFace` |
| `SESSION_EXPIRED` | The session expired or isn't authorized. Start a new session. | `code` and `type` | `executeFlow`, `renderCaptureId`, `renderCaptureFace`, `renderAuthFace`, and any other live `render*` or `execute*` method |
| `UNKNOWN_ERROR` | Reserved for future use. | — | Not currently returned. |
| `USER_CANCELLED` | The user canceled the capture. Inside `executeFlow`, only the ID module forwards this to `onError`. A selfie cancel does not end the flow. | `code` on the capture renders; `type` on `executeFlow` | `executeFlow`, `renderCaptureId`, `renderCaptureFace`, `renderAuthFace` |
| `WEBCAM_ERROR` | The camera failed to start or wasn't found. | `code` | `renderCaptureId`, `renderCaptureFace`, `renderAuthFace` |


:::note
`createSession` doesn't use these codes. It rejects with a `{ status, message }` object. See [Error handling](#error-handling) under `createSession`.
:::

---

- Path: `sdk-reference/xamarin-sdk`
- URL: https://developer.incode.com/sdk-reference/xamarin-sdk/
- Markdown: https://developer.incode.com/sdk-reference/xamarin-sdk.md

# Incode Xamarin SDK Reference

The Incode Xamarin SDK is a wrapper around the native iOS and Android SDKs. This page documents its C# API — initialization, session configuration, and result callbacks.


For iOS- and Android-specific behavior, refer to the [iOS SDK Reference](/sdk-reference/ios-sdk/) and [Android SDK Reference](/sdk-reference/android-sdk/).

## IncodeOnboarding.Initialize

```csharp
IncodeOnboarding.Initialize(
    apiUrl: "YOUR_API_URL",
    apiKey: "YOUR_API_KEY"
);
```

**Parameters:**

| Parameter  | Type   | Required | Description                                                      |
| ---------- | ------ | -------- | ---------------------------------------------------------------- |
| `apiUrl`   | string | Yes      | API URL provided by Incode                                       |
| `apiKey`   | string | No       | API key provided by Incode. Omit when using token-based sessions |
| `testMode` | bool   | No       | Set to `true` when running on a simulator or emulator            |

## OnboardingSessionConfiguration

```csharp
var sessionConfig = new OnboardingSessionConfiguration
{
    ConfigurationId = "YOUR_WORKFLOW_ID",
    ExternalCustomerId = "your-user-id"
};
```

**Properties:**

| Property                 | Type       | Description                                              |
| ------------------------ | ---------- | -------------------------------------------------------- |
| `ConfigurationId`        | string     | Workflow or Flow ID from the Incode Dashboard            |
| `RegionCode`             | string     | User's region (`ALL`, `BR`, `IN`)                        |
| `Queue`                  | string     | Queue to attach this session to                          |
| `InterviewId`            | string     | Resume an existing session by ID                         |
| `Token`                  | string     | Resume an existing session by token                      |
| `ExternalId`             | string     | ID used outside the Incode Omni platform                 |
| `ExternalCustomerId`     | string     | Links the session to an entity in an external system     |
| `ValidationModules`      | List       | Validation modules for scoring                           |
| `CustomFields`           | Dictionary | Custom fields stored for this session                    |
| `E2eEncryptionEnabled`   | bool       | Enable end-to-end encryption                             |
| `MergeSessionRecordings` | bool       | Merge ID and face capture recordings into a single video |

## IncodeOnboarding.StartOnboarding

```csharp
await IncodeOnboarding.StartOnboarding(
    sessionConfig: sessionConfig,
    onSuccess: (result) => Console.WriteLine($"Complete: {result.InterviewId}"),
    onError: (error) => Console.WriteLine($"Failed: {error}")
);
```

**Callbacks:**

| Callback                                  | Description                                                  |
| ----------------------------------------- | ------------------------------------------------------------ |
| `onSuccess(OnboardingResult)`             | Flow completed. `result.InterviewId` contains the session ID |
| `onError(string)`                         | An error occurred                                            |
| `onUserCancelled()`                       | User cancelled the flow                                      |
| `onIdFrontCompleted(IdScanResult)`        | Front ID scan completed                                      |
| `onIdBackCompleted(IdScanResult)`         | Back ID scan completed                                       |
| `onIdProcessed(IdProcessResult)`          | ID processing completed                                      |
| `onSelfieScanCompleted(SelfieScanResult)` | Selfie scan completed                                        |
| `onFaceMatchCompleted(FaceMatchResult)`   | Face match completed                                         |